chore: api-reports

Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2024-08-15 16:32:09 +02:00
parent 4a8b94ee93
commit af7be32e90
14 changed files with 1195 additions and 63 deletions
+54 -1
View File
@@ -3,10 +3,63 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { AnyRouteRefParams } from '@backstage/frontend-plugin-api';
import { BackstagePlugin } from '@backstage/frontend-plugin-api';
import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
import { IconComponent } from '@backstage/core-plugin-api';
import { default as React_2 } from 'react';
import { RouteRef } from '@backstage/frontend-plugin-api';
// @public (undocumented)
const visualizerPlugin: BackstagePlugin<{}, {}, {}>;
const visualizerPlugin: BackstagePlugin<
{},
{},
{
'page:app-visualizer': ExtensionDefinition<
{
path: string | undefined;
},
{
path?: string | undefined;
},
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<string, 'core.routing.path', {}>
| ConfigurableExtensionDataRef<
RouteRef<AnyRouteRefParams>,
'core.routing.ref',
{
optional: true;
}
>,
{},
'page',
undefined,
undefined
>;
'nav-item:app-visualizer': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<
{
title: string;
icon: IconComponent;
routeRef: RouteRef<undefined>;
},
'core.nav-item.target',
{}
>,
{},
'nav-item',
undefined,
undefined
>;
}
>;
export default visualizerPlugin;
// (No @packageDocumentation comment for this package)
+134 -1
View File
@@ -3,8 +3,16 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { AnyExtensionDataRef } from '@backstage/frontend-plugin-api';
import { AnyRouteRefParams } from '@backstage/frontend-plugin-api';
import { BackstagePlugin } from '@backstage/frontend-plugin-api';
import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api';
import { Direction } from '@backstage/plugin-catalog-graph';
import { Entity } from '@backstage/catalog-model';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
import { ExtensionInput } from '@backstage/frontend-plugin-api';
import { ExternalRouteRef } from '@backstage/frontend-plugin-api';
import { default as React_2 } from 'react';
import { RouteRef } from '@backstage/frontend-plugin-api';
// @public (undocumented)
@@ -19,7 +27,132 @@ const _default: BackstagePlugin<
namespace: string;
}>;
},
{}
{
'entity-card:catalog-graph/relations': ExtensionDefinition<
{
kinds: string[] | undefined;
relations: string[] | undefined;
maxDepth: number | undefined;
unidirectional: boolean | undefined;
mergeRelations: boolean | undefined;
direction: Direction | undefined;
relationPairs: [string, string][] | undefined;
zoom: 'disabled' | 'enabled' | 'enable-on-click' | undefined;
curve: 'curveStepBefore' | 'curveMonotoneX' | undefined;
title: string | undefined;
height: number | undefined;
} & {
filter: string | undefined;
},
{
height?: number | undefined;
curve?: 'curveStepBefore' | 'curveMonotoneX' | undefined;
direction?: Direction | undefined;
title?: string | undefined;
zoom?: 'disabled' | 'enabled' | 'enable-on-click' | undefined;
relations?: string[] | undefined;
maxDepth?: number | undefined;
kinds?: string[] | undefined;
unidirectional?: boolean | undefined;
mergeRelations?: boolean | undefined;
relationPairs?: [string, string][] | undefined;
} & {
filter?: string | undefined;
},
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<
(entity: Entity) => boolean,
'catalog.entity-filter-function',
{
optional: true;
}
>
| ConfigurableExtensionDataRef<
string,
'catalog.entity-filter-expression',
{
optional: true;
}
>,
{
[x: string]: ExtensionInput<
AnyExtensionDataRef,
{
optional: boolean;
singleton: boolean;
}
>;
},
'entity-card',
undefined,
'relations'
>;
'page:catalog-graph': ExtensionDefinition<
{
selectedKinds: string[] | undefined;
selectedRelations: string[] | undefined;
rootEntityRefs: string[] | undefined;
maxDepth: number | undefined;
unidirectional: boolean | undefined;
mergeRelations: boolean | undefined;
direction: Direction | undefined;
showFilters: boolean | undefined;
curve: 'curveStepBefore' | 'curveMonotoneX' | undefined;
kinds: string[] | undefined;
relations: string[] | undefined;
relationPairs: [string, string][] | undefined;
zoom: 'disabled' | 'enabled' | 'enable-on-click' | undefined;
} & {
path: string | undefined;
},
{
curve?: 'curveStepBefore' | 'curveMonotoneX' | undefined;
direction?: Direction | undefined;
zoom?: 'disabled' | 'enabled' | 'enable-on-click' | undefined;
relations?: string[] | undefined;
rootEntityRefs?: string[] | undefined;
maxDepth?: number | undefined;
kinds?: string[] | undefined;
unidirectional?: boolean | undefined;
mergeRelations?: boolean | undefined;
relationPairs?: [string, string][] | undefined;
selectedRelations?: string[] | undefined;
selectedKinds?: string[] | undefined;
showFilters?: boolean | undefined;
} & {
path?: string | undefined;
},
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<string, 'core.routing.path', {}>
| ConfigurableExtensionDataRef<
RouteRef<AnyRouteRefParams>,
'core.routing.ref',
{
optional: true;
}
>,
{
[x: string]: ExtensionInput<
AnyExtensionDataRef,
{
optional: boolean;
singleton: boolean;
}
>;
},
'page',
undefined,
undefined
>;
}
>;
export default _default;
+1 -1
View File
@@ -25,7 +25,7 @@ import {
} from '@backstage/core-compat-api';
import { EntityCardBlueprint } from '@backstage/plugin-catalog-react/alpha';
import { catalogGraphRouteRef, catalogEntityRouteRef } from './routes';
import { Direction } from './components';
import { Direction } from '@backstage/plugin-catalog-graph';
const CatalogGraphEntityCard = EntityCardBlueprint.makeWithOverrides({
name: 'relations',
+41 -1
View File
@@ -3,7 +3,12 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { AnyApiFactory } from '@backstage/core-plugin-api';
import { AnyRouteRefParams } from '@backstage/frontend-plugin-api';
import { BackstagePlugin } from '@backstage/frontend-plugin-api';
import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
import { default as React_2 } from 'react';
import { RouteRef } from '@backstage/frontend-plugin-api';
// @alpha (undocumented)
@@ -12,7 +17,42 @@ const _default: BackstagePlugin<
importPage: RouteRef<undefined>;
},
{},
{}
{
'api:catalog-import': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<AnyApiFactory, 'core.api.factory', {}>,
{},
'api',
undefined,
undefined
>;
'page:catalog-import': ExtensionDefinition<
{
path: string | undefined;
},
{
path?: string | undefined;
},
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<string, 'core.routing.path', {}>
| ConfigurableExtensionDataRef<
RouteRef<AnyRouteRefParams>,
'core.routing.ref',
{
optional: true;
}
>,
{},
'page',
undefined,
undefined
>;
}
>;
export default _default;
+261
View File
@@ -5,6 +5,8 @@
```ts
/// <reference types="react" />
import { AnyApiFactory } from '@backstage/frontend-plugin-api';
import { AnyExtensionDataRef } from '@backstage/frontend-plugin-api';
import { AnyExtensionInputMap } from '@backstage/frontend-plugin-api';
import { AnyRouteRefParams } from '@backstage/frontend-plugin-api';
import { BackstagePlugin } from '@backstage/frontend-plugin-api';
@@ -14,10 +16,13 @@ import { ExtensionBlueprint } from '@backstage/frontend-plugin-api';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
import { ExtensionInput } from '@backstage/frontend-plugin-api';
import { ExternalRouteRef } from '@backstage/frontend-plugin-api';
import { IconComponent } from '@backstage/core-plugin-api';
import { JSX as JSX_2 } from 'react';
import { PortableSchema } from '@backstage/frontend-plugin-api';
import { default as React_2 } from 'react';
import { RouteRef } from '@backstage/frontend-plugin-api';
import { SearchResultItemExtensionComponent } from '@backstage/plugin-search-react/alpha';
import { SearchResultItemExtensionPredicate } from '@backstage/plugin-search-react/alpha';
import { TranslationRef } from '@backstage/core-plugin-api/alpha';
// @alpha
@@ -164,6 +169,41 @@ const _default: BackstagePlugin<
unregisterRedirect: ExternalRouteRef<undefined>;
},
{
'nav-item:catalog': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<
{
title: string;
icon: IconComponent;
routeRef: RouteRef<undefined>;
},
'core.nav-item.target',
{}
>,
{},
'nav-item',
undefined,
undefined
>;
'api:catalog/starred-entities': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<AnyApiFactory, 'core.api.factory', {}>,
{},
'api',
undefined,
'starred-entities'
>;
'api:catalog/entity-presentation': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<AnyApiFactory, 'core.api.factory', {}>,
{},
'api',
undefined,
'entity-presentation'
>;
'entity-card:catalog/about': ExtensionDefinition<
{
filter: string | undefined;
@@ -500,6 +540,227 @@ const _default: BackstagePlugin<
undefined,
'overview'
>;
'catalog-filter:catalog/tag': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>,
{},
'catalog-filter',
undefined,
'tag'
>;
'catalog-filter:catalog/kind': ExtensionDefinition<
{
initialFilter: string;
},
{
initialFilter?: string | undefined;
},
ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>,
{
[x: string]: ExtensionInput<
AnyExtensionDataRef,
{
optional: boolean;
singleton: boolean;
}
>;
},
'catalog-filter',
undefined,
'kind'
>;
'catalog-filter:catalog/type': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>,
{},
'catalog-filter',
undefined,
'type'
>;
'catalog-filter:catalog/mode': ExtensionDefinition<
{
mode: 'all' | 'owners-only' | undefined;
},
{
mode?: 'all' | 'owners-only' | undefined;
},
ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>,
{
[x: string]: ExtensionInput<
AnyExtensionDataRef,
{
optional: boolean;
singleton: boolean;
}
>;
},
'catalog-filter',
undefined,
'mode'
>;
'catalog-filter:catalog/namespace': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>,
{},
'catalog-filter',
undefined,
'namespace'
>;
'catalog-filter:catalog/lifecycle': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>,
{},
'catalog-filter',
undefined,
'lifecycle'
>;
'catalog-filter:catalog/processing-status': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>,
{},
'catalog-filter',
undefined,
'processing-status'
>;
'catalog-filter:catalog/list': ExtensionDefinition<
{
initialFilter: 'all' | 'owned' | 'starred';
},
{
initialFilter?: 'all' | 'owned' | 'starred' | undefined;
},
ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>,
{
[x: string]: ExtensionInput<
AnyExtensionDataRef,
{
optional: boolean;
singleton: boolean;
}
>;
},
'catalog-filter',
undefined,
'list'
>;
'page:catalog': ExtensionDefinition<
{
[x: string]: any;
} & {
path: string | undefined;
},
{
[x: string]: any;
} & {
path?: string | undefined;
},
| ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>
| ConfigurableExtensionDataRef<string, 'core.routing.path', {}>
| ConfigurableExtensionDataRef<
RouteRef<AnyRouteRefParams>,
'core.routing.ref',
{
optional: true;
}
>,
{
filters: ExtensionInput<
ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>,
{
singleton: false;
optional: false;
}
>;
},
'page',
undefined,
undefined
>;
'page:catalog/entity': ExtensionDefinition<
{
[x: string]: any;
} & {
path: string | undefined;
},
{
[x: string]: any;
} & {
path?: string | undefined;
},
| ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>
| ConfigurableExtensionDataRef<string, 'core.routing.path', {}>
| ConfigurableExtensionDataRef<
RouteRef<AnyRouteRefParams>,
'core.routing.ref',
{
optional: true;
}
>,
{
contents: ExtensionInput<
| ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>
| ConfigurableExtensionDataRef<string, 'core.routing.path', {}>
| ConfigurableExtensionDataRef<
RouteRef<AnyRouteRefParams>,
'core.routing.ref',
{
optional: true;
}
>
| ConfigurableExtensionDataRef<
string,
'catalog.entity-content-title',
{}
>
| ConfigurableExtensionDataRef<
(entity: Entity) => boolean,
'catalog.entity-filter-function',
{
optional: true;
}
>
| ConfigurableExtensionDataRef<
string,
'catalog.entity-filter-expression',
{
optional: true;
}
>,
{
singleton: false;
optional: false;
}
>;
},
'page',
undefined,
'entity'
>;
'search-result-list-item:catalog': ExtensionDefinition<
{
noTrack: boolean;
},
{
noTrack?: boolean | undefined;
},
ConfigurableExtensionDataRef<
{
predicate?: SearchResultItemExtensionPredicate | undefined;
component: SearchResultItemExtensionComponent;
},
'search.search-result-list-item.item',
{}
>,
{},
'search-result-list-item',
undefined,
undefined
>;
}
>;
export default _default;
+1 -4
View File
@@ -21,10 +21,7 @@ import {
storageApiRef,
} from '@backstage/core-plugin-api';
import { CatalogClient } from '@backstage/catalog-client';
import {
ApiBlueprint,
createApiExtension,
} from '@backstage/frontend-plugin-api';
import { ApiBlueprint } from '@backstage/frontend-plugin-api';
import {
catalogApiRef,
entityPresentationApiRef,
-1
View File
@@ -15,7 +15,6 @@
*/
import React from 'react';
import { createSchemaFromZod } from '@backstage/frontend-plugin-api';
import { CatalogFilterBlueprint } from './blueprints';
const catalogTagCatalogFilter = CatalogFilterBlueprint.make({
+59 -1
View File
@@ -3,7 +3,13 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { AnyApiFactory } from '@backstage/frontend-plugin-api';
import { AnyRouteRefParams } from '@backstage/frontend-plugin-api';
import { BackstagePlugin } from '@backstage/frontend-plugin-api';
import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
import { IconComponent } from '@backstage/core-plugin-api';
import { default as React_2 } from 'react';
import { RouteRef } from '@backstage/frontend-plugin-api';
// @alpha (undocumented)
@@ -12,7 +18,59 @@ const _default: BackstagePlugin<
root: RouteRef<undefined>;
},
{},
{}
{
'api:devtools': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<AnyApiFactory, 'core.api.factory', {}>,
{},
'api',
undefined,
undefined
>;
'page:devtools': ExtensionDefinition<
{
path: string | undefined;
},
{
path?: string | undefined;
},
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<string, 'core.routing.path', {}>
| ConfigurableExtensionDataRef<
RouteRef<AnyRouteRefParams>,
'core.routing.ref',
{
optional: true;
}
>,
{},
'page',
undefined,
undefined
>;
'nav-item:devtools': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<
{
title: string;
icon: IconComponent;
routeRef: RouteRef<undefined>;
},
'core.nav-item.target',
{}
>,
{},
'nav-item',
undefined,
undefined
>;
}
>;
export default _default;
+69
View File
@@ -5,9 +5,11 @@
```ts
/// <reference types="react" />
import { AnyApiFactory } from '@backstage/frontend-plugin-api';
import { AnyRouteRefParams } from '@backstage/frontend-plugin-api';
import { BackstagePlugin } from '@backstage/frontend-plugin-api';
import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api';
import { Entity } from '@backstage/catalog-model';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
import { JSX as JSX_2 } from 'react';
import { RouteRef } from '@backstage/frontend-plugin-api';
@@ -40,6 +42,73 @@ const _default: BackstagePlugin<
undefined,
undefined
>;
'entity-content:kubernetes/kubernetes': ExtensionDefinition<
{
path: string | undefined;
title: string | undefined;
filter: string | undefined;
},
{
filter?: string | undefined;
title?: string | undefined;
path?: string | undefined;
},
| ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>
| ConfigurableExtensionDataRef<string, 'core.routing.path', {}>
| ConfigurableExtensionDataRef<
RouteRef<AnyRouteRefParams>,
'core.routing.ref',
{
optional: true;
}
>
| ConfigurableExtensionDataRef<string, 'catalog.entity-content-title', {}>
| ConfigurableExtensionDataRef<
(entity: Entity) => boolean,
'catalog.entity-filter-function',
{
optional: true;
}
>
| ConfigurableExtensionDataRef<
string,
'catalog.entity-filter-expression',
{
optional: true;
}
>,
{},
'entity-content',
undefined,
'kubernetes'
>;
'api:kubernetes/proxy': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<AnyApiFactory, 'core.api.factory', {}>,
{},
'api',
undefined,
'proxy'
>;
'api:kubernetes/auth-providers': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<AnyApiFactory, 'core.api.factory', {}>,
{},
'api',
undefined,
'auth-providers'
>;
'api:kubernetes/cluster-link-formatter': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<AnyApiFactory, 'core.api.factory', {}>,
{},
'api',
undefined,
'cluster-link-formatter'
>;
}
>;
export default _default;
+130 -1
View File
@@ -4,7 +4,11 @@
```ts
import { BackstagePlugin } from '@backstage/frontend-plugin-api';
import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api';
import { Entity } from '@backstage/catalog-model';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
import { ExternalRouteRef } from '@backstage/frontend-plugin-api';
import { default as React_2 } from 'react';
// @alpha (undocumented)
const _default: BackstagePlugin<
@@ -12,7 +16,132 @@ const _default: BackstagePlugin<
{
catalogIndex: ExternalRouteRef<undefined>;
},
{}
{
'entity-card:org/group-profile': ExtensionDefinition<
{
filter: string | undefined;
},
{
filter?: string | undefined;
},
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<
(entity: Entity) => boolean,
'catalog.entity-filter-function',
{
optional: true;
}
>
| ConfigurableExtensionDataRef<
string,
'catalog.entity-filter-expression',
{
optional: true;
}
>,
{},
'entity-card',
undefined,
'group-profile'
>;
'entity-card:org/members-list': ExtensionDefinition<
{
filter: string | undefined;
},
{
filter?: string | undefined;
},
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<
(entity: Entity) => boolean,
'catalog.entity-filter-function',
{
optional: true;
}
>
| ConfigurableExtensionDataRef<
string,
'catalog.entity-filter-expression',
{
optional: true;
}
>,
{},
'entity-card',
undefined,
'members-list'
>;
'entity-card:org/ownership': ExtensionDefinition<
{
filter: string | undefined;
},
{
filter?: string | undefined;
},
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<
(entity: Entity) => boolean,
'catalog.entity-filter-function',
{
optional: true;
}
>
| ConfigurableExtensionDataRef<
string,
'catalog.entity-filter-expression',
{
optional: true;
}
>,
{},
'entity-card',
undefined,
'ownership'
>;
'entity-card:org/user-profile': ExtensionDefinition<
{
filter: string | undefined;
},
{
filter?: string | undefined;
},
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<
(entity: Entity) => boolean,
'catalog.entity-filter-function',
{
optional: true;
}
>
| ConfigurableExtensionDataRef<
string,
'catalog.entity-filter-expression',
{
optional: true;
}
>,
{},
'entity-card',
undefined,
'user-profile'
>;
}
>;
export default _default;
+58 -1
View File
@@ -3,11 +3,16 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { AnyApiFactory } from '@backstage/frontend-plugin-api';
import { AnyRouteRefParams } from '@backstage/frontend-plugin-api';
import { BackstagePlugin } from '@backstage/frontend-plugin-api';
import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
import { ExternalRouteRef } from '@backstage/frontend-plugin-api';
import { FieldExtensionOptions } from '@backstage/plugin-scaffolder-react';
import type { FormProps as FormProps_2 } from '@rjsf/core';
import { FormProps as FormProps_3 } from '@backstage/plugin-scaffolder-react';
import { IconComponent } from '@backstage/core-plugin-api';
import { LayoutOptions } from '@backstage/plugin-scaffolder-react';
import { PathParams } from '@backstage/core-plugin-api';
import { default as React_2 } from 'react';
@@ -37,7 +42,59 @@ const _default: BackstagePlugin<
namespace: string;
}>;
},
{}
{
'api:scaffolder': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<AnyApiFactory, 'core.api.factory', {}>,
{},
'api',
undefined,
undefined
>;
'page:scaffolder': ExtensionDefinition<
{
path: string | undefined;
},
{
path?: string | undefined;
},
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<string, 'core.routing.path', {}>
| ConfigurableExtensionDataRef<
RouteRef<AnyRouteRefParams>,
'core.routing.ref',
{
optional: true;
}
>,
{},
'page',
undefined,
undefined
>;
'nav-item:scaffolder': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<
{
title: string;
icon: IconComponent;
routeRef: RouteRef<undefined>;
},
'core.nav-item.target',
{}
>,
{},
'nav-item',
undefined,
undefined
>;
}
>;
export default _default;
+133 -26
View File
@@ -3,10 +3,17 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { AnyExtensionDataRef } from '@backstage/frontend-plugin-api';
import { AnyApiFactory } from '@backstage/core-plugin-api';
import { AnyRouteRefParams } from '@backstage/frontend-plugin-api';
import { BackstagePlugin } from '@backstage/frontend-plugin-api';
import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
import { ExtensionInput } from '@backstage/frontend-plugin-api';
import { IconComponent } from '@backstage/core-plugin-api';
import { default as React_2 } from 'react';
import { RouteRef } from '@backstage/frontend-plugin-api';
import { SearchResultItemExtensionComponent } from '@backstage/plugin-search-react/alpha';
import { SearchResultItemExtensionPredicate } from '@backstage/plugin-search-react/alpha';
// @alpha (undocumented)
const _default: BackstagePlugin<
@@ -14,7 +21,78 @@ const _default: BackstagePlugin<
root: RouteRef<undefined>;
},
{},
{}
{
'api:search': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<AnyApiFactory, 'core.api.factory', {}>,
{},
'api',
undefined,
undefined
>;
'nav-item:search': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<
{
title: string;
icon: IconComponent;
routeRef: RouteRef<undefined>;
},
'core.nav-item.target',
{}
>,
{},
'nav-item',
undefined,
undefined
>;
'page:search': ExtensionDefinition<
{
noTrack: boolean;
} & {
path: string | undefined;
},
{
noTrack?: boolean | undefined;
} & {
path?: string | undefined;
},
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<string, 'core.routing.path', {}>
| ConfigurableExtensionDataRef<
RouteRef<AnyRouteRefParams>,
'core.routing.ref',
{
optional: true;
}
>,
{
items: ExtensionInput<
ConfigurableExtensionDataRef<
{
predicate?: SearchResultItemExtensionPredicate | undefined;
component: SearchResultItemExtensionComponent;
},
'search.search-result-list-item.item',
{}
>,
{
singleton: false;
optional: false;
}
>;
},
'page',
undefined,
undefined
>;
}
>;
export default _default;
@@ -22,43 +100,72 @@ export default _default;
export const searchApi: ExtensionDefinition<
{},
{},
never,
never,
string | undefined,
string | undefined,
string | undefined
ConfigurableExtensionDataRef<AnyApiFactory, 'core.api.factory', {}>,
{},
'api',
undefined,
undefined
>;
// @alpha (undocumented)
export const searchNavItem: ExtensionDefinition<
{
title: string;
},
{
title?: string | undefined;
},
never,
never,
string | undefined,
string | undefined,
string | undefined
{},
{},
ConfigurableExtensionDataRef<
{
title: string;
icon: IconComponent;
routeRef: RouteRef<undefined>;
},
'core.nav-item.target',
{}
>,
{},
'nav-item',
undefined,
undefined
>;
// @alpha (undocumented)
export const searchPage: ExtensionDefinition<
{
path: string;
noTrack: boolean;
} & {
path: string | undefined;
},
{
path: string;
noTrack: boolean;
noTrack?: boolean | undefined;
} & {
path?: string | undefined;
},
AnyExtensionDataRef,
{},
string | undefined,
string | undefined,
string | undefined
| ConfigurableExtensionDataRef<React_2.JSX.Element, 'core.reactElement', {}>
| ConfigurableExtensionDataRef<string, 'core.routing.path', {}>
| ConfigurableExtensionDataRef<
RouteRef<AnyRouteRefParams>,
'core.routing.ref',
{
optional: true;
}
>,
{
items: ExtensionInput<
ConfigurableExtensionDataRef<
{
predicate?: SearchResultItemExtensionPredicate | undefined;
component: SearchResultItemExtensionComponent;
},
'search.search-result-list-item.item',
{}
>,
{
singleton: false;
optional: false;
}
>;
},
'page',
undefined,
undefined
>;
// (No @packageDocumentation comment for this package)
+174 -13
View File
@@ -3,9 +3,19 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { AnyApiFactory } from '@backstage/frontend-plugin-api';
import { AnyExtensionDataRef } from '@backstage/frontend-plugin-api';
import { AnyRouteRefParams } from '@backstage/frontend-plugin-api';
import { BackstagePlugin } from '@backstage/frontend-plugin-api';
import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api';
import { Entity } from '@backstage/catalog-model';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
import { ExtensionInput } from '@backstage/frontend-plugin-api';
import { IconComponent } from '@backstage/core-plugin-api';
import { default as React_2 } from 'react';
import { RouteRef } from '@backstage/frontend-plugin-api';
import { SearchResultItemExtensionComponent } from '@backstage/plugin-search-react/alpha';
import { SearchResultItemExtensionPredicate } from '@backstage/plugin-search-react/alpha';
// @alpha (undocumented)
const _default: BackstagePlugin<
@@ -19,31 +29,182 @@ const _default: BackstagePlugin<
entityContent: RouteRef<undefined>;
},
{},
{}
{
'nav-item:techdocs': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<
{
title: string;
icon: IconComponent;
routeRef: RouteRef<undefined>;
},
'core.nav-item.target',
{}
>,
{},
'nav-item',
undefined,
undefined
>;
'api:techdocs/storage': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<AnyApiFactory, 'core.api.factory', {}>,
{},
'api',
undefined,
'storage'
>;
'search-result-list-item:techdocs': ExtensionDefinition<
{
title: string | undefined;
lineClamp: number;
asLink: boolean;
asListItem: boolean;
} & {
noTrack: boolean;
},
{
title?: string | undefined;
lineClamp?: number | undefined;
asListItem?: boolean | undefined;
asLink?: boolean | undefined;
} & {
noTrack?: boolean | undefined;
},
ConfigurableExtensionDataRef<
{
predicate?: SearchResultItemExtensionPredicate | undefined;
component: SearchResultItemExtensionComponent;
},
'search.search-result-list-item.item',
{}
>,
{
[x: string]: ExtensionInput<
AnyExtensionDataRef,
{
optional: boolean;
singleton: boolean;
}
>;
},
'search-result-list-item',
undefined,
undefined
>;
'page:techdocs/reader': ExtensionDefinition<
{
path: string | undefined;
},
{
path?: string | undefined;
},
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<string, 'core.routing.path', {}>
| ConfigurableExtensionDataRef<
RouteRef<AnyRouteRefParams>,
'core.routing.ref',
{
optional: true;
}
>,
{},
'page',
undefined,
'reader'
>;
'entity-content:techdocs': ExtensionDefinition<
{
path: string | undefined;
title: string | undefined;
filter: string | undefined;
},
{
filter?: string | undefined;
title?: string | undefined;
path?: string | undefined;
},
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<string, 'core.routing.path', {}>
| ConfigurableExtensionDataRef<
RouteRef<AnyRouteRefParams>,
'core.routing.ref',
{
optional: true;
}
>
| ConfigurableExtensionDataRef<string, 'catalog.entity-content-title', {}>
| ConfigurableExtensionDataRef<
(entity: Entity) => boolean,
'catalog.entity-filter-function',
{
optional: true;
}
>
| ConfigurableExtensionDataRef<
string,
'catalog.entity-filter-expression',
{
optional: true;
}
>,
{},
'entity-content',
undefined,
undefined
>;
}
>;
export default _default;
// @alpha (undocumented)
export const techDocsSearchResultListItemExtension: ExtensionDefinition<
{
title: string | undefined;
lineClamp: number;
noTrack: boolean;
asListItem: boolean;
asLink: boolean;
title?: string | undefined;
asListItem: boolean;
} & {
noTrack: boolean;
},
{
lineClamp: number;
noTrack: boolean;
asListItem: boolean;
asLink: boolean;
title?: string | undefined;
lineClamp?: number | undefined;
asListItem?: boolean | undefined;
asLink?: boolean | undefined;
} & {
noTrack?: boolean | undefined;
},
never,
never,
string | undefined,
string | undefined,
string | undefined
ConfigurableExtensionDataRef<
{
predicate?: SearchResultItemExtensionPredicate | undefined;
component: SearchResultItemExtensionComponent;
},
'search.search-result-list-item.item',
{}
>,
{
[x: string]: ExtensionInput<
AnyExtensionDataRef,
{
optional: boolean;
singleton: boolean;
}
>;
},
'search-result-list-item',
undefined,
undefined
>;
// (No @packageDocumentation comment for this package)
+80 -12
View File
@@ -3,8 +3,13 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { AnyRouteRefParams } from '@backstage/frontend-plugin-api';
import { BackstagePlugin } from '@backstage/frontend-plugin-api';
import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
import { ExtensionInput } from '@backstage/frontend-plugin-api';
import { IconComponent } from '@backstage/core-plugin-api';
import { default as React_2 } from 'react';
import { RouteRef } from '@backstage/frontend-plugin-api';
import { TranslationRef } from '@backstage/core-plugin-api/alpha';
@@ -14,23 +19,86 @@ const _default: BackstagePlugin<
root: RouteRef<undefined>;
},
{},
{}
{
'nav-item:user-settings': ExtensionDefinition<
{},
{},
ConfigurableExtensionDataRef<
{
title: string;
icon: IconComponent;
routeRef: RouteRef<undefined>;
},
'core.nav-item.target',
{}
>,
{},
'nav-item',
undefined,
undefined
>;
'page:user-settings': ExtensionDefinition<
{
[x: string]: any;
} & {
path: string | undefined;
},
{
[x: string]: any;
} & {
path?: string | undefined;
},
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<string, 'core.routing.path', {}>
| ConfigurableExtensionDataRef<
RouteRef<AnyRouteRefParams>,
'core.routing.ref',
{
optional: true;
}
>,
{
providerSettings: ExtensionInput<
ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>,
{
singleton: true;
optional: true;
}
>;
},
'page',
undefined,
undefined
>;
}
>;
export default _default;
// @alpha (undocumented)
export const settingsNavItem: ExtensionDefinition<
{
title: string;
},
{
title?: string | undefined;
},
never,
never,
string | undefined,
string | undefined,
string | undefined
{},
{},
ConfigurableExtensionDataRef<
{
title: string;
icon: IconComponent;
routeRef: RouteRef<undefined>;
},
'core.nav-item.target',
{}
>,
{},
'nav-item',
undefined,
undefined
>;
// @alpha (undocumented)