wip

Signed-off-by: bnechyporenko <bnechyporenko@bol.com>
2022-07-08 11:57:49 +02:00
parent 50423a30ba
commit 5bb73faa54
63 changed files with 103 additions and 28 deletions
@@ -147,7 +147,7 @@ export type AppComponents = {

 // @public
 export type AppContext = {
-  getPlugins(): BackstagePlugin_2<any, any>[];
+  getPlugins(): BackstagePlugin_2<any, any, any>[];
  getSystemIcon(key: string): IconComponent_2 | undefined;
  getComponents(): AppComponents;
 };
@@ -214,6 +214,7 @@ export type BackstageIdentityResponse = {
 export type BackstagePlugin<
  Routes extends AnyRoutes = {},
  ExternalRoutes extends AnyExternalRoutes = {},
+  PluginInputOptions extends {} = {},
 > = {
  getId(): string;
  getApis(): Iterable<AnyApiFactory>;
@@ -221,6 +222,7 @@ export type BackstagePlugin<
  provide<T>(extension: Extension<T>): T;
  routes: Routes;
  externalRoutes: ExternalRoutes;
+  __experimentalReconfigure(options: PluginInputOptions): void;
 };

 // @public
@@ -303,9 +305,10 @@ export function createExternalRouteRef<
 export function createPlugin<
  Routes extends AnyRoutes = {},
  ExternalRoutes extends AnyExternalRoutes = {},
+  PluginInputOptions extends {} = {},
 >(
-  config: PluginConfig<Routes, ExternalRoutes>,
-): BackstagePlugin<Routes, ExternalRoutes>;
+  config: PluginConfig<Routes, ExternalRoutes, PluginInputOptions>,
+): BackstagePlugin<Routes, ExternalRoutes, PluginInputOptions>;

 // @public
 export function createReactExtension<
@@ -401,7 +404,7 @@ export type ErrorBoundaryFallbackProps = {

 // @public
 export type Extension<T> = {
-  expose(plugin: BackstagePlugin<any, any>): T;
+  expose(plugin: BackstagePlugin<any, any, any>): T;
 };

 // @public
@@ -621,12 +624,14 @@ export type PendingOAuthRequest = {
 export type PluginConfig<
  Routes extends AnyRoutes,
  ExternalRoutes extends AnyExternalRoutes,
+  PluginInputOptions extends {},
 > = {
  id: string;
  apis?: Iterable<AnyApiFactory>;
  routes?: Routes;
  externalRoutes?: ExternalRoutes;
  featureFlags?: PluginFeatureFlagConfig[];
+  __experimentalConfigure?(options?: PluginInputOptions): {};
 };

 // @public
@@ -634,6 +639,15 @@ export type PluginFeatureFlagConfig = {
  name: string;
 };

+// Warning: (ae-forgotten-export) The symbol "PluginOptionsProviderProps" needs to be exported by the entry point index.d.ts
+// Warning: (ae-missing-release-tag) "PluginProvider" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const PluginProvider: ({
+  children,
+  plugin,
+}: PluginOptionsProviderProps) => JSX.Element;
+
 // @public
 export type ProfileInfo = {
  email?: string;
@@ -734,6 +748,11 @@ export function useElementFilter<T>(
  dependencies?: any[],
 ): T;

+// @alpha
+export function usePluginOptions<
+  TPluginOptions extends {} = {},
+>(): TPluginOptions;
+
 // @public
 export function useRouteRef<Optional extends boolean, Params extends AnyParams>(
  routeRef: ExternalRouteRef<Params, Optional>,
@@ -25,6 +25,7 @@ export const adrPlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;

@@ -13,6 +13,7 @@ export const airbrakePlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;

@@ -21,6 +21,7 @@ export const allurePlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;

@@ -10,7 +10,7 @@ import { Config } from '@backstage/config';
 import { IdentityApi } from '@backstage/core-plugin-api';

 // @public @deprecated (undocumented)
-export const analyticsModuleGA: BackstagePlugin<{}, {}>;
+export const analyticsModuleGA: BackstagePlugin<{}, {}, {}>;

 // @public
 export class GoogleAnalytics implements AnalyticsApi {
@@ -10,8 +10,8 @@ import { RouteRef } from '@backstage/core-plugin-api';

 // @public
 export const ApacheAirflowDagTable: ({
-                                       dagIds,
-                                     }: {
+  dagIds,
+}: {
  dagIds?: string[] | undefined;
 }) => JSX.Element;

@@ -27,6 +27,7 @@ export const apacheAirflowPlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 ```
@@ -47,7 +47,8 @@ const apiDocsPlugin: BackstagePlugin<
  },
  {
    registerApi: ExternalRouteRef<undefined, true>;
-  }
+  },
+  {}
 >;
 export { apiDocsPlugin };
 export { apiDocsPlugin as plugin };
@@ -170,7 +170,7 @@ export class AzureDevOpsClient implements AzureDevOpsApi {
 // Warning: (ae-missing-release-tag) "azureDevOpsPlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export const azureDevOpsPlugin: BackstagePlugin<{}, {}>;
+export const azureDevOpsPlugin: BackstagePlugin<{}, {}, {}>;

 // Warning: (ae-missing-release-tag) "AzurePullRequestsIcon" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
@@ -10,7 +10,7 @@ import { BackstagePlugin } from '@backstage/core-plugin-api';
 // Warning: (ae-missing-release-tag) "badgesPlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export const badgesPlugin: BackstagePlugin<{}, {}>;
+export const badgesPlugin: BackstagePlugin<{}, {}, {}>;

 // Warning: (ae-missing-release-tag) "EntityBadgesDialog" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
@@ -20,6 +20,7 @@ export const bazaarPlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;

@@ -11,7 +11,7 @@ import { Entity } from '@backstage/catalog-model';
 // Warning: (ae-missing-release-tag) "bitrisePlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export const bitrisePlugin: BackstagePlugin<{}, {}>;
+export const bitrisePlugin: BackstagePlugin<{}, {}, {}>;

 // Warning: (ae-missing-release-tag) "EntityBitriseContent" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
@@ -0,0 +1,9 @@
+## API Report File for "@internal/plugin-catalog-customized"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+export * from '@backstage/plugin-catalog';
+
+// (No @packageDocumentation comment for this package)
+```
@@ -48,7 +48,8 @@ export const catalogGraphPlugin: BackstagePlugin<
      },
      true
    >;
-  }
+  },
+  {}
 >;

 // @public
@@ -133,6 +133,7 @@ const catalogImportPlugin: BackstagePlugin<
  {
    importPage: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 export { catalogImportPlugin };
@@ -79,6 +79,8 @@ export interface CatalogKindHeaderProps {
  initialFilter?: string;
 }

+// Warning: (ae-forgotten-export) The symbol "CatalogInputPluginOptions" needs to be exported by the entry point index.d.ts
+//
 // @public (undocumented)
 export const catalogPlugin: BackstagePlugin<
  {
@@ -99,7 +101,8 @@ export const catalogPlugin: BackstagePlugin<
      },
      true
    >;
-  }
+  },
+  CatalogInputPluginOptions
 >;

 // @public (undocumented)
@@ -107,6 +107,7 @@ export const cicdStatisticsPlugin: BackstagePlugin<
  {
    entityContent: RouteRef<undefined>;
  },
+  {},
  {}
 >;

@@ -75,7 +75,7 @@ export const circleCIBuildRouteRef: SubRouteRef<PathParams<'/:buildId'>>;
 // Warning: (ae-missing-release-tag) "circleCIPlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-const circleCIPlugin: BackstagePlugin<{}, {}>;
+const circleCIPlugin: BackstagePlugin<{}, {}, {}>;
 export { circleCIPlugin };
 export { circleCIPlugin as plugin };

@@ -141,6 +141,7 @@ const cloudbuildPlugin: BackstagePlugin<
  {
    entityContent: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 export { cloudbuildPlugin };
@@ -48,6 +48,7 @@ export const codeClimatePlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;

@@ -14,6 +14,7 @@ export const codeCoveragePlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;

@@ -23,6 +23,7 @@ export const codescenePlugin: BackstagePlugin<
      projectId: string;
    }>;
  },
+  {},
  {}
 >;

@@ -38,6 +38,7 @@ export const configSchemaPlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;

@@ -382,6 +382,7 @@ const costInsightsPlugin: BackstagePlugin<
    growthAlerts: RouteRef<undefined>;
    unlabeledDataflowAlerts: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 export { costInsightsPlugin };
@@ -9,7 +9,7 @@ import { BackstagePlugin } from '@backstage/core-plugin-api';
 import { Entity } from '@backstage/catalog-model';

 // @public
-export const dynatracePlugin: BackstagePlugin<{}, {}>;
+export const dynatracePlugin: BackstagePlugin<{}, {}, {}>;

 // @public
 export const DynatraceTab: () => JSX.Element;
@@ -16,6 +16,7 @@ export const todoListPlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;

@@ -68,7 +68,8 @@ const explorePlugin: BackstagePlugin<
      },
      true
    >;
-  }
+  },
+  {}
 >;
 export { explorePlugin };
 export { explorePlugin as plugin };
@@ -20,6 +20,7 @@ export const firehydrantPlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 ```
@@ -40,6 +40,7 @@ export const fossaPlugin: BackstagePlugin<
  {
    fossaOverview: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 ```
@@ -65,6 +65,7 @@ export const gcalendarPlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;

@@ -57,6 +57,7 @@ const gcpProjectsPlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 export { gcpProjectsPlugin };
@@ -203,6 +203,7 @@ export const gitReleaseManagerPlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;

@@ -198,6 +198,7 @@ const githubActionsPlugin: BackstagePlugin<
  {
    entityContent: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 export { githubActionsPlugin };
@@ -47,7 +47,7 @@ export const EntityGithubDeploymentsCard: (props: {
 // Warning: (ae-missing-release-tag) "githubDeploymentsPlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export const githubDeploymentsPlugin: BackstagePlugin<{}, {}>;
+export const githubDeploymentsPlugin: BackstagePlugin<{}, {}, {}>;

 // Warning: (ae-forgotten-export) The symbol "GithubDeploymentsTableProps" needs to be exported by the entry point index.d.ts
 // Warning: (ae-missing-release-tag) "GithubDeploymentsTable" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -149,6 +149,7 @@ const gitopsProfilesPlugin: BackstagePlugin<
    }>;
    createPage: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 export { gitopsProfilesPlugin };
@@ -15,7 +15,7 @@ export const EntityGoCdContent: () => JSX.Element;
 export const GOCD_PIPELINES_ANNOTATION = 'gocd.org/pipelines';

 // @public
-export const gocdPlugin: BackstagePlugin<{}, {}>;
+export const gocdPlugin: BackstagePlugin<{}, {}, {}>;

 // @public
 export const isGoCdAvailable: (entity: Entity) => boolean;
@@ -39,7 +39,7 @@ export const GraphiQLIcon: IconComponent;
 export const GraphiQLPage: () => JSX.Element;

 // @public (undocumented)
-const graphiqlPlugin: BackstagePlugin<{}, {}>;
+const graphiqlPlugin: BackstagePlugin<{}, {}, {}>;
 export { graphiqlPlugin };
 export { graphiqlPlugin as plugin };

@@ -107,6 +107,7 @@ export const homePlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;

@@ -249,6 +249,7 @@ const ilertPlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 export { ilertPlugin };
@@ -108,6 +108,7 @@ const jenkinsPlugin: BackstagePlugin<
  {
    entityContent: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 export { jenkinsPlugin };
@@ -34,6 +34,7 @@ const kafkaPlugin: BackstagePlugin<
  {
    entityContent: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 export { kafkaPlugin };
@@ -322,6 +322,7 @@ const kubernetesPlugin: BackstagePlugin<
  {
    entityContent: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 export { kubernetesPlugin };
@@ -175,6 +175,7 @@ const lighthousePlugin: BackstagePlugin<
    root: RouteRef<undefined>;
    entityContent: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 export { lighthousePlugin };
@@ -42,6 +42,7 @@ export const newRelicDashboardPlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;

@@ -20,6 +20,7 @@ const newRelicPlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 export { newRelicPlugin };
@@ -58,7 +58,8 @@ const orgPlugin: BackstagePlugin<
  {},
  {
    catalogIndex: ExternalRouteRef<undefined, false>;
-  }
+  },
+  {}
 >;
 export { orgPlugin };
 export { orgPlugin as plugin };
@@ -166,7 +166,7 @@ export type PagerDutyOnCallsResponse = {
 // Warning: (ae-missing-release-tag) "pagerDutyPlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-const pagerDutyPlugin: BackstagePlugin<{}, {}>;
+const pagerDutyPlugin: BackstagePlugin<{}, {}, {}>;
 export { pagerDutyPlugin };
 export { pagerDutyPlugin as plugin };

@@ -119,7 +119,7 @@ export class PeriskopClient implements PeriskopApi {
 }

 // @public (undocumented)
-export const periskopPlugin: BackstagePlugin<{}, {}>;
+export const periskopPlugin: BackstagePlugin<{}, {}, {}>;

 // @public (undocumented)
 export interface RequestHeaders {
@@ -91,6 +91,7 @@ const rollbarPlugin: BackstagePlugin<
  {
    entityContent: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 export { rollbarPlugin as plugin };
@@ -365,7 +365,8 @@ export const scaffolderPlugin: BackstagePlugin<
  },
  {
    registerComponent: ExternalRouteRef<undefined, true>;
-  }
+  },
+  {}
 >;

 // @public
@@ -194,6 +194,7 @@ const searchPlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 export { searchPlugin as plugin };
@@ -145,6 +145,7 @@ const sentryPlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 export { sentryPlugin as plugin };
@@ -62,7 +62,7 @@ export const shortcutsApiRef: ApiRef<ShortcutApi>;
 // Warning: (ae-missing-release-tag) "shortcutsPlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export const shortcutsPlugin: BackstagePlugin<{}, {}>;
+export const shortcutsPlugin: BackstagePlugin<{}, {}, {}>;

 // @public
 export interface ShortcutsProps {
@@ -44,7 +44,7 @@ export const SonarQubeCard: ({
 // Warning: (ae-missing-release-tag) "sonarQubePlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-const sonarQubePlugin: BackstagePlugin<{}, {}>;
+const sonarQubePlugin: BackstagePlugin<{}, {}, {}>;
 export { sonarQubePlugin as plugin };
 export { sonarQubePlugin };

@@ -98,6 +98,7 @@ const splunkOnCallPlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 export { splunkOnCallPlugin as plugin };
@@ -20,7 +20,7 @@ export const HomePageStackOverflowQuestions: (
 export const StackOverflowIcon: () => JSX.Element;

 // @public
-export const stackOverflowPlugin: BackstagePlugin<{}, {}>;
+export const stackOverflowPlugin: BackstagePlugin<{}, {}, {}>;

 // @public
 export type StackOverflowQuestion = {
@@ -112,6 +112,7 @@ export const techInsightsPlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;

@@ -126,6 +126,7 @@ const techRadarPlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 export { techRadarPlugin as plugin };
@@ -33,7 +33,7 @@ export type ReportIssueTemplateBuilder = ({
 }) => ReportIssueTemplate;

 // @public
-export const techdocsModuleAddonsContribPlugin: BackstagePlugin<{}, {}>;
+export const techdocsModuleAddonsContribPlugin: BackstagePlugin<{}, {}, {}>;

 // @public
 export const TextSize: () => JSX.Element | null;
@@ -288,6 +288,7 @@ const techdocsPlugin: BackstagePlugin<
    }>;
    entityContent: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 export { techdocsPlugin as plugin };
@@ -84,6 +84,7 @@ export const todoPlugin: BackstagePlugin<
  {
    entityContent: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 ```
@@ -102,6 +102,7 @@ const userSettingsPlugin: BackstagePlugin<
  {
    settingsPage: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 export { userSettingsPlugin as plugin };
@@ -27,7 +27,7 @@ export interface VaultApi {
 export const vaultApiRef: ApiRef<VaultApi>;

 // @public
-export const vaultPlugin: BackstagePlugin<{}, {}>;
+export const vaultPlugin: BackstagePlugin<{}, {}, {}>;

 // @public
 export type VaultSecret = {
@@ -20,6 +20,7 @@ export const xcmetricsPlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
+  {},
  {}
 >;
 ```