From 8ae3cffb854153ab58397e2c00b00cd6d1ab54ec Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Sun, 11 Jul 2021 16:38:26 +0200 Subject: [PATCH] recreate all api-reports with latest version of api-extractor Signed-off-by: Patrik Oldsberg --- packages/backend-common/api-report.md | 10 +++++---- packages/core-app-api/api-report.md | 27 +++++++++++------------ packages/core-plugin-api/api-report.md | 3 ++- packages/dev-utils/api-report.md | 3 ++- packages/integration-react/api-report.md | 3 ++- packages/techdocs-common/api-report.md | 7 +++--- plugins/api-docs/api-report.md | 19 ++++++++-------- plugins/badges/api-report.md | 5 +++-- plugins/bitrise/api-report.md | 5 +++-- plugins/catalog-import/api-report.md | 9 ++++---- plugins/circleci/api-report.md | 11 ++++----- plugins/cloudbuild/api-report.md | 17 ++++++-------- plugins/code-coverage/api-report.md | 9 ++++---- plugins/config-schema/api-report.md | 9 ++++---- plugins/cost-insights/api-report.md | 15 ++++++------- plugins/explore/api-report.md | 27 +++++++++++------------ plugins/fossa/api-report.md | 9 ++++---- plugins/gcp-projects/api-report.md | 9 ++++---- plugins/git-release-manager/api-report.md | 7 +++--- plugins/github-actions/api-report.md | 21 ++++++++---------- plugins/gitops-profiles/api-report.md | 19 ++++++++-------- plugins/graphiql/api-report.md | 7 +++--- plugins/ilert/api-report.md | 11 ++++----- plugins/jenkins/api-report.md | 15 +++++-------- plugins/kafka/api-report.md | 13 +++++------ plugins/kubernetes/api-report.md | 13 +++++------ plugins/lighthouse/api-report.md | 17 ++++++-------- plugins/newrelic/api-report.md | 9 ++++---- plugins/org/api-report.md | 21 +++++++++--------- plugins/pagerduty/api-report.md | 9 +++----- plugins/register-component/api-report.md | 9 ++++---- plugins/rollbar/api-report.md | 15 +++++-------- plugins/scaffolder-backend/api-report.md | 5 +++-- plugins/scaffolder/api-report.md | 11 +++++---- plugins/search/api-report.md | 11 +++++---- plugins/sentry/api-report.md | 11 +++++---- plugins/shortcuts/api-report.md | 5 +++-- plugins/sonarqube/api-report.md | 11 +++++---- plugins/splunk-on-call/api-report.md | 11 +++++---- plugins/tech-radar/api-report.md | 9 ++++---- plugins/techdocs/api-report.md | 13 +++++------ plugins/todo/api-report.md | 5 +++-- plugins/user-settings/api-report.md | 9 ++++---- plugins/welcome/api-report.md | 7 +++--- 44 files changed, 228 insertions(+), 263 deletions(-) diff --git a/packages/backend-common/api-report.md b/packages/backend-common/api-report.md index 22eac06ed2..b89bdd1bef 100644 --- a/packages/backend-common/api-report.md +++ b/packages/backend-common/api-report.md @@ -4,6 +4,9 @@ ```ts +/// +/// + import { AzureIntegration } from '@backstage/integration'; import { BitbucketIntegration } from '@backstage/integration'; import { Config } from '@backstage/config'; @@ -79,7 +82,7 @@ export interface CacheClient { export class CacheManager { forPlugin(pluginId: string): PluginCacheManager; static fromConfig(config: Config, options?: CacheManagerOptions): CacheManager; - } +} // @public (undocumented) export const coloredFormat: winston.Logform.Format; @@ -109,7 +112,7 @@ export function createStatusCheckRouter(options: StatusCheckRouterOptions): Prom export class DatabaseManager { forPlugin(pluginId: string): PluginDatabaseManager; static fromConfig(config: Config): DatabaseManager; - } +} // @public (undocumented) export class DockerContainerRunner implements ContainerRunner { @@ -359,7 +362,7 @@ export class SingleHostDiscovery implements PluginEndpointDiscovery { getBaseUrl(pluginId: string): Promise; // (undocumented) getExternalBaseUrl(pluginId: string): Promise; - } +} // @public (undocumented) export type StatusCheck = () => Promise; @@ -392,7 +395,6 @@ export function useHotCleanup(_module: NodeModule, cancelEffect: () => void): vo // @public export function useHotMemoize(_module: NodeModule, valueFactory: () => T): T; - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/core-app-api/api-report.md b/packages/core-app-api/api-report.md index 8cb18cf1ce..ea3198d677 100644 --- a/packages/core-app-api/api-report.md +++ b/packages/core-app-api/api-report.md @@ -61,7 +61,7 @@ export class AlertApiForwarder implements AlertApi { alert$(): Observable; // (undocumented) post(alert: AlertMessage): void; - } +} // @public (undocumented) export type ApiFactoryHolder = { @@ -168,7 +168,7 @@ export class AppThemeSelector implements AppThemeApi { getInstalledThemes(): AppTheme[]; // (undocumented) setActiveThemeId(themeId?: string): void; - } +} // @public (undocumented) export class Auth0Auth { @@ -207,13 +207,13 @@ export const defaultConfigLoader: AppConfigLoader; export class ErrorAlerter implements ErrorApi { constructor(alertApi: AlertApi, errorApi: ErrorApi); // (undocumented) - error$(): Observable<{ - error: { - name: string; - message: string; - stack?: string | undefined; - }; - context?: ErrorContext | undefined; + error$(): Observable< { + error: { + name: string; + message: string; + stack?: string | undefined; + }; + context?: ErrorContext | undefined; }>; // (undocumented) post(error: Error, context?: ErrorContext): void; @@ -228,7 +228,7 @@ export class ErrorApiForwarder implements ErrorApi { }>; // (undocumented) post(error: Error, context?: ErrorContext): void; - } +} // @public (undocumented) export type ErrorBoundaryFallbackProps = { @@ -353,7 +353,7 @@ export class OAuthRequestManager implements OAuthRequestApi { authRequest$(): Observable; // (undocumented) createAuthRequester(options: AuthRequesterOptions): AuthRequester; - } +} // @public (undocumented) export class OktaAuth { @@ -407,7 +407,7 @@ export class UrlPatternDiscovery implements DiscoveryApi { static compile(pattern: string): UrlPatternDiscovery; // (undocumented) getBaseUrl(pluginId: string): Promise; - } +} // @public (undocumented) export class WebStorage implements StorageApi { @@ -424,8 +424,7 @@ export class WebStorage implements StorageApi { remove(key: string): Promise; // (undocumented) set(key: string, data: T): Promise; - } - +} // (No @packageDocumentation comment for this package) diff --git a/packages/core-plugin-api/api-report.md b/packages/core-plugin-api/api-report.md index 90ea1f5e46..cb1bfe1280 100644 --- a/packages/core-plugin-api/api-report.md +++ b/packages/core-plugin-api/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { BackstageTheme } from '@backstage/theme'; import { ComponentType } from 'react'; import { Config } from '@backstage/config'; @@ -550,7 +552,6 @@ export function withApis(apis: TypesToApiRefs):

(WrappedCompo displayName: string; }; - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/dev-utils/api-report.md b/packages/dev-utils/api-report.md index d3852b1c95..1c44b55dac 100644 --- a/packages/dev-utils/api-report.md +++ b/packages/dev-utils/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiFactory } from '@backstage/core-plugin-api'; import { ComponentType } from 'react'; import { createPlugin } from '@backstage/core-plugin-api'; @@ -20,7 +22,6 @@ export const EntityGridItem: ({ entity, classes, ...rest }: Omit JSX.Element; - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/integration-react/api-report.md b/packages/integration-react/api-report.md index fee08efe6f..e3866d7932 100644 --- a/packages/integration-react/api-report.md +++ b/packages/integration-react/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { Config } from '@backstage/config'; import { ScmIntegrationRegistry } from '@backstage/integration'; @@ -22,7 +24,6 @@ export class ScmIntegrationsApi { // @public (undocumented) export const scmIntegrationsApiRef: ApiRef; - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/techdocs-common/api-report.md b/packages/techdocs-common/api-report.md index d25f55bf3a..07bfcafd00 100644 --- a/packages/techdocs-common/api-report.md +++ b/packages/techdocs-common/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { AzureIntegrationConfig } from '@backstage/integration'; import { Config } from '@backstage/config'; import { ContainerRunner } from '@backstage/backend-common'; @@ -34,7 +36,7 @@ export class DirectoryPreparer implements PreparerBase { constructor(config: Config, logger: Logger_2, reader: UrlReader); // (undocumented) prepare(entity: Entity): Promise; - } +} // @public (undocumented) export type GeneratorBase = { @@ -175,8 +177,7 @@ export class UrlPreparer implements PreparerBase { prepare(entity: Entity, options?: { etag?: string; }): Promise; - } - +} // (No @packageDocumentation comment for this package) diff --git a/plugins/api-docs/api-report.md b/plugins/api-docs/api-report.md index c7d3fdc694..ee19bba69f 100644 --- a/plugins/api-docs/api-report.md +++ b/plugins/api-docs/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiEntity } from '@backstage/catalog-model'; import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; @@ -30,14 +32,12 @@ export type ApiDefinitionWidget = { export const apiDocsConfigRef: ApiRef; // @public (undocumented) -const apiDocsPlugin: BackstagePlugin<{ - root: RouteRef; +const apiDocsPlugin: BackstagePlugin< { +root: RouteRef; }, { - createComponent: ExternalRouteRef; +createComponent: ExternalRouteRef; }>; - export { apiDocsPlugin } - export { apiDocsPlugin as plugin } // @public (undocumented) @@ -67,13 +67,13 @@ export const EntityApiDefinitionCard: (_: { // @public (undocumented) export const EntityConsumedApisCard: ({ variant }: { - entity?: Entity| undefined; + entity?: Entity | undefined; variant?: "gridItem" | undefined; }) => JSX.Element; // @public (undocumented) export const EntityConsumingComponentsCard: ({ variant }: { - entity?: Entity| undefined; + entity?: Entity | undefined; variant?: "gridItem" | undefined; }) => JSX.Element; @@ -84,13 +84,13 @@ export const EntityHasApisCard: ({ variant }: { // @public (undocumented) export const EntityProvidedApisCard: ({ variant }: { - entity?: Entity| undefined; + entity?: Entity | undefined; variant?: "gridItem" | undefined; }) => JSX.Element; // @public (undocumented) export const EntityProvidingComponentsCard: ({ variant }: { - entity?: Entity| undefined; + entity?: Entity | undefined; variant?: "gridItem" | undefined; }) => JSX.Element; @@ -109,7 +109,6 @@ export const ProvidedApisCard: ({ variant }: Props_4) => JSX.Element; // @public (undocumented) export const ProvidingComponentsCard: ({ variant }: Props_7) => JSX.Element; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/badges/api-report.md b/plugins/badges/api-report.md index 1dbb256fd1..df54a19a76 100644 --- a/plugins/badges/api-report.md +++ b/plugins/badges/api-report.md @@ -4,10 +4,12 @@ ```ts +/// + import { BackstagePlugin } from '@backstage/core-plugin-api'; // @public (undocumented) -export const badgesPlugin: BackstagePlugin<{}, {}>; +export const badgesPlugin: BackstagePlugin< {}, {}>; // @public (undocumented) export const EntityBadgesDialog: ({ open, onClose }: { @@ -15,7 +17,6 @@ export const EntityBadgesDialog: ({ open, onClose }: { onClose?: (() => any) | undefined; }) => JSX.Element; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/bitrise/api-report.md b/plugins/bitrise/api-report.md index 15c3c74c99..e4244aa5d2 100644 --- a/plugins/bitrise/api-report.md +++ b/plugins/bitrise/api-report.md @@ -4,11 +4,13 @@ ```ts +/// + import { BackstagePlugin } from '@backstage/core-plugin-api'; import { Entity } from '@backstage/catalog-model'; // @public (undocumented) -export const bitrisePlugin: BackstagePlugin<{}, {}>; +export const bitrisePlugin: BackstagePlugin< {}, {}>; // @public (undocumented) export const EntityBitriseContent: () => JSX.Element; @@ -16,7 +18,6 @@ export const EntityBitriseContent: () => JSX.Element; // @public (undocumented) export const isBitriseAvailable: (entity: Entity) => boolean; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-import/api-report.md b/plugins/catalog-import/api-report.md index f388c24a55..57f1fba943 100644 --- a/plugins/catalog-import/api-report.md +++ b/plugins/catalog-import/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { CatalogApi } from '@backstage/catalog-client'; @@ -89,12 +91,10 @@ export class CatalogImportClient implements CatalogImportApi { export const CatalogImportPage: (opts: StepperProviderOpts) => JSX.Element; // @public (undocumented) -const catalogImportPlugin: BackstagePlugin<{ - importPage: RouteRef; +const catalogImportPlugin: BackstagePlugin< { +importPage: RouteRef; }, {}>; - export { catalogImportPlugin } - export { catalogImportPlugin as plugin } // @public @@ -124,7 +124,6 @@ export const StepInitAnalyzeUrl: ({ onAnalysis, analysisUrl, disablePullRequest, // @public (undocumented) export const StepPrepareCreatePullRequest: ({ analyzeResult, onPrepare, onGoBack, renderFormFields, defaultTitle, defaultBody, }: Props_8) => JSX.Element; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/circleci/api-report.md b/plugins/circleci/api-report.md index 00b575efb8..3bb2c79140 100644 --- a/plugins/circleci/api-report.md +++ b/plugins/circleci/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { BuildStepAction } from 'circleci-api'; @@ -49,10 +51,8 @@ export const circleCIApiRef: ApiRef; export const circleCIBuildRouteRef: RouteRef; // @public (undocumented) -const circleCIPlugin: BackstagePlugin<{}, {}>; - +const circleCIPlugin: BackstagePlugin< {}, {}>; export { circleCIPlugin } - export { circleCIPlugin as plugin } // @public (undocumented) @@ -60,22 +60,19 @@ export const circleCIRouteRef: RouteRef; // @public (undocumented) export const EntityCircleCIContent: (_props: { - entity?: Entity| undefined; + entity?: Entity | undefined; }) => JSX.Element; export { GitType } // @public (undocumented) const isCircleCIAvailable: (entity: Entity) => boolean; - export { isCircleCIAvailable } - export { isCircleCIAvailable as isPluginApplicableToEntity } // @public (undocumented) export const Router: (_props: Props) => JSX.Element; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/cloudbuild/api-report.md b/plugins/cloudbuild/api-report.md index 2ebc1eb737..441cc4f3f5 100644 --- a/plugins/cloudbuild/api-report.md +++ b/plugins/cloudbuild/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { Entity } from '@backstage/catalog-model'; @@ -100,28 +102,26 @@ export class CloudbuildClient implements CloudbuildApi { } // @public (undocumented) -const cloudbuildPlugin: BackstagePlugin<{ - entityContent: RouteRef; +const cloudbuildPlugin: BackstagePlugin< { +entityContent: RouteRef; }, {}>; - export { cloudbuildPlugin } - export { cloudbuildPlugin as plugin } // @public (undocumented) export const EntityCloudbuildContent: (_props: { - entity?: Entity| undefined; + entity?: Entity | undefined; }) => JSX.Element; // @public (undocumented) export const EntityLatestCloudbuildRunCard: ({ branch, }: { - entity?: Entity| undefined; + entity?: Entity | undefined; branch: string; }) => JSX.Element; // @public (undocumented) export const EntityLatestCloudbuildsForBranchCard: ({ branch, }: { - entity?: Entity| undefined; + entity?: Entity | undefined; branch: string; }) => JSX.Element; @@ -135,9 +135,7 @@ export interface FETCHSOURCE { // @public (undocumented) const isCloudbuildAvailable: (entity: Entity) => boolean; - export { isCloudbuildAvailable } - export { isCloudbuildAvailable as isPluginApplicableToEntity } // @public (undocumented) @@ -277,7 +275,6 @@ export interface Volume { path: string; } - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/code-coverage/api-report.md b/plugins/code-coverage/api-report.md index dffbaeec2a..c850f0cb48 100644 --- a/plugins/code-coverage/api-report.md +++ b/plugins/code-coverage/api-report.md @@ -4,13 +4,15 @@ ```ts +/// + import { BackstagePlugin } from '@backstage/core-plugin-api'; import { Entity } from '@backstage/catalog-model'; import { RouteRef } from '@backstage/core-plugin-api'; // @public (undocumented) -export const codeCoveragePlugin: BackstagePlugin<{ - root: RouteRef; +export const codeCoveragePlugin: BackstagePlugin< { +root: RouteRef; }, {}>; // @public (undocumented) @@ -18,15 +20,12 @@ export const EntityCodeCoverageContent: () => JSX.Element; // @public (undocumented) const isCodeCoverageAvailable: (entity: Entity) => boolean; - export { isCodeCoverageAvailable } - export { isCodeCoverageAvailable as isPluginApplicableToEntity } // @public (undocumented) export const Router: () => JSX.Element; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/config-schema/api-report.md b/plugins/config-schema/api-report.md index f623789076..fee63e9f23 100644 --- a/plugins/config-schema/api-report.md +++ b/plugins/config-schema/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { Observable } from '@backstage/core-plugin-api'; @@ -23,8 +25,8 @@ export const configSchemaApiRef: ApiRef; export const ConfigSchemaPage: () => JSX.Element; // @public (undocumented) -export const configSchemaPlugin: BackstagePlugin<{ - root: RouteRef; +export const configSchemaPlugin: BackstagePlugin< { +root: RouteRef; }, {}>; // @public @@ -34,8 +36,7 @@ export class StaticSchemaLoader implements ConfigSchemaApi { }); // (undocumented) schema$(): Observable; - } - +} // (No @packageDocumentation comment for this package) diff --git a/plugins/cost-insights/api-report.md b/plugins/cost-insights/api-report.md index 97dd33e5ad..a679715671 100644 --- a/plugins/cost-insights/api-report.md +++ b/plugins/cost-insights/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePalette } from '@backstage/theme'; import { BackstagePlugin } from '@backstage/core-plugin-api'; @@ -278,14 +280,12 @@ export type CostInsightsPalette = BackstagePalette & CostInsightsPaletteAddition export type CostInsightsPaletteOptions = PaletteOptions & CostInsightsPaletteAdditions; // @public (undocumented) -const costInsightsPlugin: BackstagePlugin<{ - root: RouteRef; - growthAlerts: RouteRef; - unlabeledDataflowAlerts: RouteRef; +const costInsightsPlugin: BackstagePlugin< { +root: RouteRef; +growthAlerts: RouteRef; +unlabeledDataflowAlerts: RouteRef; }, {}>; - export { costInsightsPlugin } - export { costInsightsPlugin as plugin } // @public (undocumented) @@ -393,7 +393,7 @@ export class ExampleCostInsightsClient implements CostInsightsApi { getProjectDailyCost(project: string, intervals: string): Promise; // (undocumented) getUserGroups(userId: string): Promise; - } +} // @public (undocumented) export type Group = { @@ -615,7 +615,6 @@ export interface UnlabeledDataflowData { unlabeledCost: number; } - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/explore/api-report.md b/plugins/explore/api-report.md index 6755b0cfc2..4084c6a203 100644 --- a/plugins/explore/api-report.md +++ b/plugins/explore/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { BackstagePlugin } from '@backstage/core-plugin-api'; import { default } from 'react'; import { ExternalRouteRef } from '@backstage/core-plugin-api'; @@ -11,10 +13,10 @@ import { RouteRef } from '@backstage/core-plugin-api'; import { TabProps } from '@material-ui/core'; // @public (undocumented) -export const catalogEntityRouteRef: ExternalRouteRef<{ - name: string; - kind: string; - namespace: string; +export const catalogEntityRouteRef: ExternalRouteRef< { +name: string; +kind: string; +namespace: string; }, false>; // @public (undocumented) @@ -32,18 +34,16 @@ export const ExploreLayout: { export const ExplorePage: () => JSX.Element; // @public (undocumented) -const explorePlugin: BackstagePlugin<{ - explore: RouteRef; +const explorePlugin: BackstagePlugin< { +explore: RouteRef; }, { - catalogEntity: ExternalRouteRef<{ - name: string; - kind: string; - namespace: string; - }, false>; +catalogEntity: ExternalRouteRef< { +name: string; +kind: string; +namespace: string; +}, false>; }>; - export { explorePlugin } - export { explorePlugin as plugin } // @public (undocumented) @@ -59,7 +59,6 @@ export const ToolExplorerContent: ({ title }: { title?: string | undefined; }) => JSX.Element; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/fossa/api-report.md b/plugins/fossa/api-report.md index a02fba732f..2ecb1bc161 100644 --- a/plugins/fossa/api-report.md +++ b/plugins/fossa/api-report.md @@ -4,24 +4,25 @@ ```ts +/// + import { BackstagePlugin } from '@backstage/core-plugin-api'; import { InfoCardVariants } from '@backstage/core-components'; import { RouteRef } from '@backstage/core-plugin-api'; // @public (undocumented) export const EntityFossaCard: ({ variant }: { - variant?: InfoCardVariants| undefined; + variant?: InfoCardVariants | undefined; }) => JSX.Element; // @public (undocumented) export const FossaPage: () => JSX.Element; // @public (undocumented) -export const fossaPlugin: BackstagePlugin<{ - fossaOverview: RouteRef; +export const fossaPlugin: BackstagePlugin< { +fossaOverview: RouteRef; }, {}>; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/gcp-projects/api-report.md b/plugins/gcp-projects/api-report.md index bbe8d3edac..dde26fd0bc 100644 --- a/plugins/gcp-projects/api-report.md +++ b/plugins/gcp-projects/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { OAuthApi } from '@backstage/core-plugin-api'; @@ -42,12 +44,10 @@ export class GcpClient implements GcpApi { export const GcpProjectsPage: () => JSX.Element; // @public (undocumented) -const gcpProjectsPlugin: BackstagePlugin<{ - root: RouteRef; +const gcpProjectsPlugin: BackstagePlugin< { +root: RouteRef; }, {}>; - export { gcpProjectsPlugin } - export { gcpProjectsPlugin as plugin } // @public (undocumented) @@ -80,7 +80,6 @@ export type Status = { details: string[]; }; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/git-release-manager/api-report.md b/plugins/git-release-manager/api-report.md index 2948f441bc..d3e2daa349 100644 --- a/plugins/git-release-manager/api-report.md +++ b/plugins/git-release-manager/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { RouteRef } from '@backstage/core-plugin-api'; @@ -15,11 +17,10 @@ export const gitReleaseManagerApiRef: ApiRef; export const GitReleaseManagerPage: GitReleaseManager; // @public (undocumented) -export const gitReleaseManagerPlugin: BackstagePlugin<{ - root: RouteRef; +export const gitReleaseManagerPlugin: BackstagePlugin< { +root: RouteRef; }, {}>; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/github-actions/api-report.md b/plugins/github-actions/api-report.md index d3fe532c7b..e4e984d03b 100644 --- a/plugins/github-actions/api-report.md +++ b/plugins/github-actions/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { ConfigApi } from '@backstage/core-plugin-api'; @@ -27,21 +29,21 @@ export enum BuildStatus { // @public (undocumented) export const EntityGithubActionsContent: (_props: { - entity?: Entity| undefined; + entity?: Entity | undefined; }) => JSX.Element; // @public (undocumented) export const EntityLatestGithubActionRunCard: ({ branch, variant, }: { - entity?: Entity| undefined; + entity?: Entity | undefined; branch: string; - variant?: InfoCardVariants| undefined; + variant?: InfoCardVariants | undefined; }) => JSX.Element; // @public (undocumented) export const EntityLatestGithubActionsForBranchCard: ({ branch, variant, }: { - entity?: Entity| undefined; + entity?: Entity | undefined; branch: string; - variant?: InfoCardVariants| undefined; + variant?: InfoCardVariants | undefined; }) => JSX.Element; // @public (undocumented) @@ -152,19 +154,15 @@ export class GithubActionsClient implements GithubActionsApi { } // @public (undocumented) -const githubActionsPlugin: BackstagePlugin<{ - entityContent: RouteRef; +const githubActionsPlugin: BackstagePlugin< { +entityContent: RouteRef; }, {}>; - export { githubActionsPlugin } - export { githubActionsPlugin as plugin } // @public (undocumented) const isGithubActionsAvailable: (entity: Entity) => boolean; - export { isGithubActionsAvailable } - export { isGithubActionsAvailable as isPluginApplicableToEntity } // @public (undocumented) @@ -207,7 +205,6 @@ export type Step = { completed_at: string; }; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/gitops-profiles/api-report.md b/plugins/gitops-profiles/api-report.md index 4690e41414..42534fbb7c 100644 --- a/plugins/gitops-profiles/api-report.md +++ b/plugins/gitops-profiles/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { RouteRef } from '@backstage/core-plugin-api'; @@ -113,17 +115,15 @@ export const GitopsProfilesClusterPage: () => JSX.Element; export const GitopsProfilesCreatePage: () => JSX.Element; // @public (undocumented) -const gitopsProfilesPlugin: BackstagePlugin<{ - listPage: RouteRef; - detailsPage: RouteRef<{ - owner: string; - repo: string; - }>; - createPage: RouteRef; +const gitopsProfilesPlugin: BackstagePlugin< { +listPage: RouteRef; +detailsPage: RouteRef< { +owner: string; +repo: string; +}>; +createPage: RouteRef; }, {}>; - export { gitopsProfilesPlugin } - export { gitopsProfilesPlugin as plugin } // @public (undocumented) @@ -191,7 +191,6 @@ export interface StatusResponse { status: string; } - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/graphiql/api-report.md b/plugins/graphiql/api-report.md index 4e78e34f6a..50c86eeeca 100644 --- a/plugins/graphiql/api-report.md +++ b/plugins/graphiql/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { ErrorApi } from '@backstage/core-plugin-api'; @@ -38,10 +40,8 @@ export const GraphiQLIcon: IconComponent; export const GraphiQLPage: () => JSX.Element; // @public (undocumented) -const graphiqlPlugin: BackstagePlugin<{}, {}>; - +const graphiqlPlugin: BackstagePlugin< {}, {}>; export { graphiqlPlugin } - export { graphiqlPlugin as plugin } // @public (undocumented) @@ -76,7 +76,6 @@ export class GraphQLEndpoints implements GraphQLBrowseApi { // @public (undocumented) export const Router: () => JSX.Element; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/ilert/api-report.md b/plugins/ilert/api-report.md index 376e7e4dfd..3b5d6a8e9d 100644 --- a/plugins/ilert/api-report.md +++ b/plugins/ilert/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { ConfigApi } from '@backstage/core-plugin-api'; @@ -172,12 +174,10 @@ export const ILertIcon: IconComponent; export const ILertPage: () => JSX.Element; // @public (undocumented) -const ilertPlugin: BackstagePlugin<{ - root: RouteRef; +const ilertPlugin: BackstagePlugin< { +root: RouteRef; }, {}>; - export { ilertPlugin } - export { ilertPlugin as plugin } // @public (undocumented) @@ -185,9 +185,7 @@ export const iLertRouteRef: RouteRef; // @public (undocumented) const isPluginApplicableToEntity: (entity: Entity) => boolean; - export { isPluginApplicableToEntity as isILertAvailable } - export { isPluginApplicableToEntity } // @public (undocumented) @@ -199,7 +197,6 @@ export type TableState = { pageSize: number; }; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/jenkins/api-report.md b/plugins/jenkins/api-report.md index 1a1c77479d..2071ecf49f 100644 --- a/plugins/jenkins/api-report.md +++ b/plugins/jenkins/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { DiscoveryApi } from '@backstage/core-plugin-api'; @@ -13,20 +15,18 @@ import { RouteRef } from '@backstage/core-plugin-api'; // @public (undocumented) export const EntityJenkinsContent: (_props: { - entity?: Entity| undefined; + entity?: Entity | undefined; }) => JSX.Element; // @public (undocumented) export const EntityLatestJenkinsRunCard: ({ branch, variant, }: { branch: string; - variant?: InfoCardVariants| undefined; + variant?: InfoCardVariants | undefined; }) => JSX.Element; // @public (undocumented) const isJenkinsAvailable: (entity: Entity) => boolean; - export { isJenkinsAvailable } - export { isJenkinsAvailable as isPluginApplicableToEntity } // @public (undocumented) @@ -60,12 +60,10 @@ export class JenkinsApi { export const jenkinsApiRef: ApiRef; // @public (undocumented) -const jenkinsPlugin: BackstagePlugin<{ - entityContent: RouteRef; +const jenkinsPlugin: BackstagePlugin< { +entityContent: RouteRef; }, {}>; - export { jenkinsPlugin } - export { jenkinsPlugin as plugin } // @public (undocumented) @@ -77,7 +75,6 @@ export const LatestRunCard: ({ branch, variant, }: { // @public (undocumented) export const Router: (_props: Props) => JSX.Element; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/kafka/api-report.md b/plugins/kafka/api-report.md index 66551aa71e..ba26dbecb0 100644 --- a/plugins/kafka/api-report.md +++ b/plugins/kafka/api-report.md @@ -4,38 +4,35 @@ ```ts +/// + import { BackstagePlugin } from '@backstage/core-plugin-api'; import { Entity } from '@backstage/catalog-model'; import { RouteRef } from '@backstage/core-plugin-api'; // @public (undocumented) export const EntityKafkaContent: (_props: { - entity?: Entity| undefined; + entity?: Entity | undefined; }) => JSX.Element; // @public (undocumented) const isPluginApplicableToEntity: (entity: Entity) => boolean; - export { isPluginApplicableToEntity as isKafkaAvailable } - export { isPluginApplicableToEntity } // @public (undocumented) export const KAFKA_CONSUMER_GROUP_ANNOTATION = "kafka.apache.org/consumer-groups"; // @public (undocumented) -const kafkaPlugin: BackstagePlugin<{ - entityContent: RouteRef; +const kafkaPlugin: BackstagePlugin< { +entityContent: RouteRef; }, {}>; - export { kafkaPlugin } - export { kafkaPlugin as plugin } // @public (undocumented) export const Router: (_props: Props) => JSX.Element; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/kubernetes/api-report.md b/plugins/kubernetes/api-report.md index 9c8a1fe537..561e5ea56c 100644 --- a/plugins/kubernetes/api-report.md +++ b/plugins/kubernetes/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { Entity } from '@backstage/catalog-model'; @@ -13,7 +15,7 @@ import { RouteRef } from '@backstage/core-plugin-api'; // @public (undocumented) export const EntityKubernetesContent: (_props: { - entity?: Entity| undefined; + entity?: Entity | undefined; }) => JSX.Element; // @public (undocumented) @@ -23,24 +25,21 @@ export class KubernetesAuthProviders implements KubernetesAuthProvidersApi { }); // (undocumented) decorateRequestBodyForAuth(authProvider: string, requestBody: KubernetesRequestBody): Promise; - } +} // @public (undocumented) export const kubernetesAuthProvidersApiRef: ApiRef; // @public (undocumented) -const kubernetesPlugin: BackstagePlugin<{ - entityContent: RouteRef; +const kubernetesPlugin: BackstagePlugin< { +entityContent: RouteRef; }, {}>; - export { kubernetesPlugin } - export { kubernetesPlugin as plugin } // @public (undocumented) export const Router: (_props: Props) => JSX.Element; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/lighthouse/api-report.md b/plugins/lighthouse/api-report.md index 1a2295f891..2d437a3c94 100644 --- a/plugins/lighthouse/api-report.md +++ b/plugins/lighthouse/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { Config } from '@backstage/config'; @@ -46,12 +48,12 @@ export const EmbeddedRouter: (_props: Props) => JSX.Element; // @public (undocumented) export const EntityLastLighthouseAuditCard: ({ dense, variant, }: { dense?: boolean | undefined; - variant?: InfoCardVariants| undefined; + variant?: InfoCardVariants | undefined; }) => JSX.Element; // @public (undocumented) export const EntityLighthouseContent: (_props: { - entity?: Entity| undefined; + entity?: Entity | undefined; }) => JSX.Element; // @public (undocumented) @@ -64,9 +66,7 @@ export class FetchError extends Error { // @public (undocumented) const isLighthouseAvailable: (entity: Entity) => boolean; - export { isLighthouseAvailable } - export { isLighthouseAvailable as isPluginApplicableToEntity } // @public (undocumented) @@ -124,13 +124,11 @@ export type LighthouseCategoryId = 'pwa' | 'seo' | 'performance' | 'accessibilit export const LighthousePage: () => JSX.Element; // @public (undocumented) -const lighthousePlugin: BackstagePlugin<{ - root: RouteRef; - entityContent: RouteRef; +const lighthousePlugin: BackstagePlugin< { +root: RouteRef; +entityContent: RouteRef; }, {}>; - export { lighthousePlugin } - export { lighthousePlugin as plugin } // @public (undocumented) @@ -180,7 +178,6 @@ export interface Website { // @public (undocumented) export type WebsiteListResponse = LASListResponse; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/newrelic/api-report.md b/plugins/newrelic/api-report.md index db5dd073df..ad61c72d61 100644 --- a/plugins/newrelic/api-report.md +++ b/plugins/newrelic/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { BackstagePlugin } from '@backstage/core-plugin-api'; import { RouteRef } from '@backstage/core-plugin-api'; @@ -11,15 +13,12 @@ import { RouteRef } from '@backstage/core-plugin-api'; export const NewRelicPage: () => JSX.Element; // @public (undocumented) -const newRelicPlugin: BackstagePlugin<{ - root: RouteRef; +const newRelicPlugin: BackstagePlugin< { +root: RouteRef; }, {}>; - export { newRelicPlugin } - export { newRelicPlugin as plugin } - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/org/api-report.md b/plugins/org/api-report.md index fa8d3ea80e..bf714dc81e 100644 --- a/plugins/org/api-report.md +++ b/plugins/org/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { BackstagePlugin } from '@backstage/core-plugin-api'; import { Entity } from '@backstage/catalog-model'; import { GroupEntity } from '@backstage/catalog-model'; @@ -12,25 +14,25 @@ import { UserEntity } from '@backstage/catalog-model'; // @public (undocumented) export const EntityGroupProfileCard: ({ variant, }: { - entity?: GroupEntity| undefined; - variant?: InfoCardVariants| undefined; + entity?: GroupEntity | undefined; + variant?: InfoCardVariants | undefined; }) => JSX.Element; // @public (undocumented) export const EntityMembersListCard: (_props: { - entity?: GroupEntity| undefined; + entity?: GroupEntity | undefined; }) => JSX.Element; // @public (undocumented) export const EntityOwnershipCard: ({ variant, }: { - entity?: Entity| undefined; - variant?: InfoCardVariants| undefined; + entity?: Entity | undefined; + variant?: InfoCardVariants | undefined; }) => JSX.Element; // @public (undocumented) export const EntityUserProfileCard: ({ variant, }: { - entity?: UserEntity| undefined; - variant?: InfoCardVariants| undefined; + entity?: UserEntity | undefined; + variant?: InfoCardVariants | undefined; }) => JSX.Element; // @public (undocumented) @@ -45,10 +47,8 @@ export const MembersListCard: (_props: { }) => JSX.Element; // @public (undocumented) -const orgPlugin: BackstagePlugin<{}, {}>; - +const orgPlugin: BackstagePlugin< {}, {}>; export { orgPlugin } - export { orgPlugin as plugin } // @public (undocumented) @@ -63,7 +63,6 @@ export const UserProfileCard: ({ variant, }: { variant?: InfoCardVariants | undefined; }) => JSX.Element; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/pagerduty/api-report.md b/plugins/pagerduty/api-report.md index bb3853ae49..e5d7cc212c 100644 --- a/plugins/pagerduty/api-report.md +++ b/plugins/pagerduty/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { ConfigApi } from '@backstage/core-plugin-api'; @@ -16,9 +18,7 @@ export const EntityPagerDutyCard: () => JSX.Element; // @public (undocumented) const isPluginApplicableToEntity: (entity: Entity) => boolean; - export { isPluginApplicableToEntity as isPagerDutyAvailable } - export { isPluginApplicableToEntity } // @public (undocumented) @@ -43,10 +43,8 @@ export class PagerDutyClient implements PagerDutyApi { } // @public (undocumented) -const pagerDutyPlugin: BackstagePlugin<{}, {}>; - +const pagerDutyPlugin: BackstagePlugin< {}, {}>; export { pagerDutyPlugin } - export { pagerDutyPlugin as plugin } // @public (undocumented) @@ -56,7 +54,6 @@ export function TriggerButton({ children, }: PropsWithChildren + import { BackstagePlugin } from '@backstage/core-plugin-api'; import { RouteRef } from '@backstage/core-plugin-api'; @@ -13,12 +15,10 @@ export const RegisterComponentPage: ({ catalogRouteRef, }: { }) => JSX.Element; // @public (undocumented) -const registerComponentPlugin: BackstagePlugin<{ - root: RouteRef; +const registerComponentPlugin: BackstagePlugin< { +root: RouteRef; }, {}>; - export { registerComponentPlugin as plugin } - export { registerComponentPlugin } // @public @deprecated @@ -26,7 +26,6 @@ export const Router: ({ catalogRouteRef }: { catalogRouteRef: RouteRef; }) => JSX.Element; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/rollbar/api-report.md b/plugins/rollbar/api-report.md index 44bd9d0d5e..c112b430f8 100644 --- a/plugins/rollbar/api-report.md +++ b/plugins/rollbar/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { DiscoveryApi } from '@backstage/core-plugin-api'; @@ -16,14 +18,12 @@ export const EntityPageRollbar: (_props: Props) => JSX.Element; // @public (undocumented) export const EntityRollbarContent: (_props: { - entity?: Entity| undefined; + entity?: Entity | undefined; }) => JSX.Element; // @public (undocumented) const isPluginApplicableToEntity: (entity: Entity) => boolean; - export { isPluginApplicableToEntity } - export { isPluginApplicableToEntity as isRollbarAvailable } // @public (undocumented) @@ -58,21 +58,18 @@ export class RollbarClient implements RollbarApi { getProjectItems(project: string): Promise; // (undocumented) getTopActiveItems(project: string, hours?: number, environment?: string): Promise; - } +} // @public (undocumented) -const rollbarPlugin: BackstagePlugin<{ - entityContent: RouteRef; +const rollbarPlugin: BackstagePlugin< { +entityContent: RouteRef; }, {}>; - export { rollbarPlugin as plugin } - export { rollbarPlugin } // @public (undocumented) export const Router: (_props: Props_2) => JSX.Element; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/scaffolder-backend/api-report.md b/plugins/scaffolder-backend/api-report.md index cca05b3333..b0e3795d19 100644 --- a/plugins/scaffolder-backend/api-report.md +++ b/plugins/scaffolder-backend/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { CatalogApi } from '@backstage/catalog-client'; import { Config } from '@backstage/config'; import { ContainerRunner } from '@backstage/backend-common'; @@ -121,7 +123,7 @@ export function createRouter(options: RouterOptions): Promise; // @public (undocumented) export const createTemplateAction: | undefined; + [name: string]: JsonValue | Partial | undefined; }>>(templateAction: TemplateAction) => TemplateAction; // @public (undocumented) @@ -177,7 +179,6 @@ export class TemplateActionRegistry { register(action: TemplateAction): void; } - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/scaffolder/api-report.md b/plugins/scaffolder/api-report.md index 7982ad997e..1df280404e 100644 --- a/plugins/scaffolder/api-report.md +++ b/plugins/scaffolder/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiHolder } from '@backstage/core-plugin-api'; import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; @@ -109,17 +111,14 @@ export const ScaffolderFieldExtensions: React_2.ComponentType; export const ScaffolderPage: () => JSX.Element; // @public (undocumented) -const scaffolderPlugin: BackstagePlugin<{ - root: RouteRef; +const scaffolderPlugin: BackstagePlugin< { +root: RouteRef; }, { - registerComponent: ExternalRouteRef; +registerComponent: ExternalRouteRef; }>; - export { scaffolderPlugin as plugin } - export { scaffolderPlugin } - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search/api-report.md b/plugins/search/api-report.md index 5451ed9adb..02391f4d42 100644 --- a/plugins/search/api-report.md +++ b/plugins/search/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { AsyncState } from 'react-use/lib/useAsync'; import { BackstagePlugin } from '@backstage/core-plugin-api'; @@ -74,13 +76,11 @@ export const SearchPage: () => JSX.Element; export const SearchPageNext: () => JSX.Element; // @public (undocumented) -const searchPlugin: BackstagePlugin<{ - root: RouteRef; - nextRoot: RouteRef; +const searchPlugin: BackstagePlugin< { +root: RouteRef; +nextRoot: RouteRef; }, {}>; - export { searchPlugin as plugin } - export { searchPlugin } // @public (undocumented) @@ -96,7 +96,6 @@ export const SidebarSearch: () => JSX.Element; // @public (undocumented) export const useSearch: () => SearchContextValue; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/sentry/api-report.md b/plugins/sentry/api-report.md index c3cce9ed7c..69e1f0238b 100644 --- a/plugins/sentry/api-report.md +++ b/plugins/sentry/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { DiscoveryApi } from '@backstage/core-plugin-api'; @@ -28,7 +30,7 @@ export class ProductionSentryApi implements SentryApi { constructor(discoveryApi: DiscoveryApi, organization: string); // (undocumented) fetchIssues(project: string, statsFor: string): Promise; - } +} // @public (undocumented) export const Router: ({ entity }: { @@ -86,15 +88,12 @@ export const SentryIssuesWidget: ({ entity, statsFor, variant, }: { }) => JSX.Element; // @public (undocumented) -const sentryPlugin: BackstagePlugin<{ - root: RouteRef; +const sentryPlugin: BackstagePlugin< { +root: RouteRef; }, {}>; - export { sentryPlugin as plugin } - export { sentryPlugin } - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/shortcuts/api-report.md b/plugins/shortcuts/api-report.md index b29328d2e6..862af42e5e 100644 --- a/plugins/shortcuts/api-report.md +++ b/plugins/shortcuts/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { Observable } from '@backstage/core-plugin-api'; @@ -48,8 +50,7 @@ export const Shortcuts: () => JSX.Element; export const shortcutsApiRef: ApiRef; // @public (undocumented) -export const shortcutsPlugin: BackstagePlugin<{}, {}>; - +export const shortcutsPlugin: BackstagePlugin< {}, {}>; // (No @packageDocumentation comment for this package) diff --git a/plugins/sonarqube/api-report.md b/plugins/sonarqube/api-report.md index 46bffb0a44..657eea0c66 100644 --- a/plugins/sonarqube/api-report.md +++ b/plugins/sonarqube/api-report.md @@ -4,14 +4,16 @@ ```ts +/// + import { BackstagePlugin } from '@backstage/core-plugin-api'; import { Entity } from '@backstage/catalog-model'; import { InfoCardVariants } from '@backstage/core-components'; // @public (undocumented) export const EntitySonarQubeCard: ({ variant, duplicationRatings, }: { - entity?: Entity| undefined; - variant?: InfoCardVariants| undefined; + entity?: Entity | undefined; + variant?: InfoCardVariants | undefined; duplicationRatings?: { greaterThan: number; rating: "1.0" | "2.0" | "3.0" | "4.0" | "5.0"; @@ -29,13 +31,10 @@ export const SonarQubeCard: ({ variant, duplicationRatings, }: { }) => JSX.Element; // @public (undocumented) -const sonarQubePlugin: BackstagePlugin<{}, {}>; - +const sonarQubePlugin: BackstagePlugin< {}, {}>; export { sonarQubePlugin as plugin } - export { sonarQubePlugin } - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/splunk-on-call/api-report.md b/plugins/splunk-on-call/api-report.md index 8ffe13660d..f8940e6f52 100644 --- a/plugins/splunk-on-call/api-report.md +++ b/plugins/splunk-on-call/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { ConfigApi } from '@backstage/core-plugin-api'; @@ -37,7 +39,7 @@ export class SplunkOnCallClient implements SplunkOnCallApi { getUsers(): Promise; // (undocumented) incidentAction({ routingKey, incidentType, incidentId, incidentDisplayName, incidentMessage, incidentStartTime, }: TriggerAlarmRequest): Promise; - } +} // @public (undocumented) export const SplunkOnCallPage: { @@ -50,19 +52,16 @@ export const SplunkOnCallPage: { }; // @public (undocumented) -const splunkOnCallPlugin: BackstagePlugin<{ - root: RouteRef; +const splunkOnCallPlugin: BackstagePlugin< { +root: RouteRef; }, {}>; - export { splunkOnCallPlugin as plugin } - export { splunkOnCallPlugin } // @public (undocumented) export class UnauthorizedError extends Error { } - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/tech-radar/api-report.md b/plugins/tech-radar/api-report.md index 8b98f1e494..985084c913 100644 --- a/plugins/tech-radar/api-report.md +++ b/plugins/tech-radar/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { RouteRef } from '@backstage/core-plugin-api'; @@ -110,15 +112,12 @@ export const TechRadarPage: { }; // @public (undocumented) -const techRadarPlugin: BackstagePlugin<{ - root: RouteRef; +const techRadarPlugin: BackstagePlugin< { +root: RouteRef; }, {}>; - export { techRadarPlugin as plugin } - export { techRadarPlugin } - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/techdocs/api-report.md b/plugins/techdocs/api-report.md index dbd5e3ab26..d6bb4b80ea 100644 --- a/plugins/techdocs/api-report.md +++ b/plugins/techdocs/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { Config } from '@backstage/config'; @@ -31,7 +33,7 @@ export const EmbeddedDocsRouter: (_props: Props) => JSX.Element; // @public (undocumented) export const EntityTechdocsContent: (_props: { - entity?: Entity| undefined; + entity?: Entity | undefined; }) => JSX.Element; // @public (undocumented) @@ -87,13 +89,11 @@ export const TechDocsCustomHome: ({ tabsConfig, }: { export const TechdocsPage: () => JSX.Element; // @public (undocumented) -const techdocsPlugin: BackstagePlugin<{ - root: RouteRef; - entityContent: RouteRef; +const techdocsPlugin: BackstagePlugin< { +root: RouteRef; +entityContent: RouteRef; }, {}>; - export { techdocsPlugin as plugin } - export { techdocsPlugin } // @public (undocumented) @@ -143,7 +143,6 @@ export class TechDocsStorageClient implements TechDocsStorageApi { syncEntityDocs(entityId: EntityName): Promise; } - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/todo/api-report.md b/plugins/todo/api-report.md index bdfea8b8f9..7763642c65 100644 --- a/plugins/todo/api-report.md +++ b/plugins/todo/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { Entity } from '@backstage/catalog-model'; @@ -15,8 +17,7 @@ export const EntityTodoContent: () => JSX.Element; export const todoApiRef: ApiRef; // @public (undocumented) -export const todoPlugin: BackstagePlugin<{}, {}>; - +export const todoPlugin: BackstagePlugin< {}, {}>; // (No @packageDocumentation comment for this package) diff --git a/plugins/user-settings/api-report.md b/plugins/user-settings/api-report.md index dc85df0d3d..47ecf012d5 100644 --- a/plugins/user-settings/api-report.md +++ b/plugins/user-settings/api-report.md @@ -4,6 +4,8 @@ ```ts +/// + import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { IconComponent } from '@backstage/core-plugin-api'; @@ -47,12 +49,10 @@ export const UserSettingsPage: ({ providerSettings }: { export const UserSettingsPinToggle: () => JSX.Element; // @public (undocumented) -const userSettingsPlugin: BackstagePlugin<{ - settingsPage: RouteRef; +const userSettingsPlugin: BackstagePlugin< { +settingsPage: RouteRef; }, {}>; - export { userSettingsPlugin as plugin } - export { userSettingsPlugin } // @public (undocumented) @@ -70,7 +70,6 @@ export const useUserProfile: () => { displayName: string; }; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/welcome/api-report.md b/plugins/welcome/api-report.md index 727be3ad75..8ad4a57c6d 100644 --- a/plugins/welcome/api-report.md +++ b/plugins/welcome/api-report.md @@ -4,19 +4,18 @@ ```ts +/// + import { BackstagePlugin } from '@backstage/core-plugin-api'; // @public (undocumented) export const WelcomePage: () => JSX.Element; // @public (undocumented) -const welcomePlugin: BackstagePlugin<{}, {}>; - +const welcomePlugin: BackstagePlugin< {}, {}>; export { welcomePlugin as plugin } - export { welcomePlugin } - // (No @packageDocumentation comment for this package) ```