From 6070fcfefc46e462963b0667b9f518a094562943 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Sat, 8 Mar 2025 11:35:44 +0100 Subject: [PATCH] update API reports for TypeScript 5.6 Signed-off-by: Patrik Oldsberg --- .../app-next-example-plugin/report.api.md | 2 +- .../backend-defaults/report-database.api.md | 2 - .../backend-defaults/report-httpRouter.api.md | 2 - .../report-rootHttpRouter.api.md | 3 - .../backend-defaults/report-urlReader.api.md | 2 - .../report-testUtils.api.md | 2 - packages/backend-openapi-utils/report.api.md | 2 +- packages/backend-plugin-api/report.api.md | 2 - packages/backend-test-utils/report.api.md | 5 - packages/canon/report.api.md | 6 +- packages/core-app-api/report.api.md | 2 +- packages/core-components/report.api.md | 26 +- packages/core-plugin-api/report-alpha.api.md | 6 +- packages/core-plugin-api/report.api.md | 6 +- packages/dev-utils/report.api.md | 2 - packages/frontend-plugin-api/report.api.md | 24 +- packages/frontend-test-utils/report.api.md | 2 - packages/test-utils/report.api.md | 25 +- packages/version-bridge/report.api.md | 2 +- plugins/api-docs/report-alpha.api.md | 51 +-- plugins/api-docs/report.api.md | 34 +- plugins/app-visualizer/report.api.md | 2 +- plugins/app/report.api.md | 10 +- .../report.api.md | 2 - .../report.api.md | 2 - plugins/auth-backend/report.api.md | 146 +++--- .../src/providers/azure-easyauth/provider.ts | 6 +- .../report.api.md | 2 - plugins/catalog-backend/report.api.md | 10 +- plugins/catalog-graph/report-alpha.api.md | 8 +- plugins/catalog-graph/report.api.md | 32 +- plugins/catalog-import/report-alpha.api.md | 2 +- plugins/catalog-import/report.api.md | 2 - plugins/catalog-node/report.api.md | 2 - plugins/catalog-react/report-alpha.api.md | 20 +- plugins/catalog-react/report.api.md | 50 +- .../report-alpha.api.md | 2 +- .../report.api.md | 2 - plugins/catalog/report-alpha.api.md | 63 ++- plugins/catalog/report.api.md | 53 +-- plugins/config-schema/report.api.md | 2 - plugins/devtools/report-alpha.api.md | 2 +- plugins/devtools/report.api.md | 2 - plugins/events-node/report.api.md | 2 - plugins/example-todo-list/report.api.md | 2 - plugins/home/report-alpha.api.md | 2 +- plugins/home/report.api.md | 33 +- plugins/kubernetes-cluster/report.api.md | 2 - plugins/kubernetes/report-alpha.api.md | 17 +- plugins/kubernetes/report.api.md | 2 - plugins/notifications/report-alpha.api.md | 2 +- plugins/notifications/report.api.md | 4 +- plugins/org/report-alpha.api.md | 16 +- plugins/org/report.api.md | 34 +- .../report.api.md | 14 +- .../report.api.md | 26 +- .../report.api.md | 30 +- .../report.api.md | 22 +- .../report.api.md | 10 +- .../report.api.md | 20 +- .../report.api.md | 12 +- .../report.api.md | 426 ++++++++---------- .../report.api.md | 119 +++-- .../report.api.md | 12 +- .../report.api.md | 6 +- .../report.api.md | 4 +- .../report.api.md | 4 +- plugins/scaffolder-backend/report.api.md | 99 ++-- .../scaffolder-node-test-utils/report.api.md | 2 +- plugins/scaffolder-node/report-alpha.api.md | 6 +- plugins/scaffolder-node/report.api.md | 14 +- plugins/scaffolder-react/report-alpha.api.md | 8 +- plugins/scaffolder-react/report.api.md | 2 - plugins/scaffolder/report-alpha.api.md | 6 +- plugins/scaffolder/report.api.md | 6 +- .../report.api.md | 2 - .../report.api.md | 2 - .../report.api.md | 2 - .../report.api.md | 2 - plugins/search-backend-node/report.api.md | 2 - plugins/search-common/report.api.md | 2 - plugins/search-react/report-alpha.api.md | 6 +- plugins/search-react/report.api.md | 2 - plugins/search/report-alpha.api.md | 8 +- plugins/search/report.api.md | 4 +- .../report.api.md | 2 - plugins/techdocs-node/report.api.md | 12 +- plugins/techdocs/report-alpha.api.md | 21 +- plugins/techdocs/report.api.md | 28 +- plugins/user-settings/report-alpha.api.md | 2 +- plugins/user-settings/report.api.md | 4 +- 91 files changed, 702 insertions(+), 993 deletions(-) diff --git a/packages/app-next-example-plugin/report.api.md b/packages/app-next-example-plugin/report.api.md index 1fc58dfc17..7a680d8917 100644 --- a/packages/app-next-example-plugin/report.api.md +++ b/packages/app-next-example-plugin/report.api.md @@ -42,7 +42,7 @@ const examplePlugin: FrontendPlugin< params: { defaultPath: string; loader: () => Promise; - routeRef?: RouteRef | undefined; + routeRef?: RouteRef; }; }>; } diff --git a/packages/backend-defaults/report-database.api.md b/packages/backend-defaults/report-database.api.md index 05c5ab251c..9c07338264 100644 --- a/packages/backend-defaults/report-database.api.md +++ b/packages/backend-defaults/report-database.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { DatabaseService } from '@backstage/backend-plugin-api'; import { LifecycleService } from '@backstage/backend-plugin-api'; import { LoggerService } from '@backstage/backend-plugin-api'; diff --git a/packages/backend-defaults/report-httpRouter.api.md b/packages/backend-defaults/report-httpRouter.api.md index 55c3f0b208..484d71325e 100644 --- a/packages/backend-defaults/report-httpRouter.api.md +++ b/packages/backend-defaults/report-httpRouter.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { AuthService } from '@backstage/backend-plugin-api'; import express from 'express'; import { HttpAuthService } from '@backstage/backend-plugin-api'; diff --git a/packages/backend-defaults/report-rootHttpRouter.api.md b/packages/backend-defaults/report-rootHttpRouter.api.md index 41830ebf17..826d592e8b 100644 --- a/packages/backend-defaults/report-rootHttpRouter.api.md +++ b/packages/backend-defaults/report-rootHttpRouter.api.md @@ -3,9 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// -/// - import { Config } from '@backstage/config'; import { CorsOptions } from 'cors'; import { ErrorRequestHandler } from 'express'; diff --git a/packages/backend-defaults/report-urlReader.api.md b/packages/backend-defaults/report-urlReader.api.md index 72e8f0bfbe..03a112abc7 100644 --- a/packages/backend-defaults/report-urlReader.api.md +++ b/packages/backend-defaults/report-urlReader.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { AwsCredentialsManager } from '@backstage/integration-aws-node'; import { AwsS3Integration } from '@backstage/integration'; import { AzureBlobStorageIntergation } from '@backstage/integration'; diff --git a/packages/backend-openapi-utils/report-testUtils.api.md b/packages/backend-openapi-utils/report-testUtils.api.md index 471ff5a3c1..874549ba65 100644 --- a/packages/backend-openapi-utils/report-testUtils.api.md +++ b/packages/backend-openapi-utils/report-testUtils.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { Express as Express_2 } from 'express'; import { Server } from 'http'; diff --git a/packages/backend-openapi-utils/report.api.md b/packages/backend-openapi-utils/report.api.md index 9d8b8e975e..6606f88b4a 100644 --- a/packages/backend-openapi-utils/report.api.md +++ b/packages/backend-openapi-utils/report.api.md @@ -96,7 +96,7 @@ export function createValidatedOpenApiRouter( validatorOptions?: Partial['0']>; middleware?: RequestHandler[]; }, -): ApiRouter; +): ApiRouter; // @public export function createValidatedOpenApiRouterFromGeneratedEndpointMap< diff --git a/packages/backend-plugin-api/report.api.md b/packages/backend-plugin-api/report.api.md index 384ae31481..30678f124f 100644 --- a/packages/backend-plugin-api/report.api.md +++ b/packages/backend-plugin-api/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { AuthorizePermissionRequest } from '@backstage/plugin-permission-common'; import { AuthorizePermissionResponse } from '@backstage/plugin-permission-common'; import { Config } from '@backstage/config'; diff --git a/packages/backend-test-utils/report.api.md b/packages/backend-test-utils/report.api.md index b358b268dc..77fbba5ccf 100644 --- a/packages/backend-test-utils/report.api.md +++ b/packages/backend-test-utils/report.api.md @@ -3,11 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// -/// -/// -/// - import { AuditorService } from '@backstage/backend-plugin-api'; import { AuthService } from '@backstage/backend-plugin-api'; import { Backend } from '@backstage/backend-app-api'; diff --git a/packages/canon/report.api.md b/packages/canon/report.api.md index f36a53be6e..5ad27f537a 100644 --- a/packages/canon/report.api.md +++ b/packages/canon/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { Context } from 'react'; import type { CSSProperties } from 'react'; import { Field as Field_2 } from '@base-ui-components/react/field'; @@ -279,8 +277,8 @@ export const Field: { children, className, ...props - }: Field_2.Validity.Props & { - className?: string | undefined; + }: React_2.ComponentPropsWithoutRef & { + className?: string; }) => React_2.JSX.Element; }; diff --git a/packages/core-app-api/report.api.md b/packages/core-app-api/report.api.md index 3d2c44a148..b2a276e6d4 100644 --- a/packages/core-app-api/report.api.md +++ b/packages/core-app-api/report.api.md @@ -365,7 +365,7 @@ export class ErrorAlerter implements ErrorApi { // (undocumented) error$(): Observable<{ error: ErrorApiError; - context?: ErrorApiErrorContext | undefined; + context?: ErrorApiErrorContext; }>; // (undocumented) post(error: ErrorApiError, context?: ErrorApiErrorContext): void; diff --git a/packages/core-components/report.api.md b/packages/core-components/report.api.md index c706eef2bb..2a845d7bfa 100644 --- a/packages/core-components/report.api.md +++ b/packages/core-components/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { ApiRef } from '@backstage/core-plugin-api'; import { BackstageIdentityApi } from '@backstage/core-plugin-api'; import { BackstagePalette } from '@backstage/theme'; @@ -968,10 +966,8 @@ export type SidebarContextType = { // Warning: (ae-missing-release-tag) "SidebarDivider" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) -export const SidebarDivider: React_2.ComponentType< - React_2.ClassAttributes & - React_2.HTMLAttributes & - StyledComponentProps<'root'> +export const SidebarDivider: ComponentType< + ComponentProps<'hr'> & StyledComponentProps<'root'> >; // Warning: (ae-missing-release-tag) "SidebarDividerClassKey" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) @@ -1088,10 +1084,8 @@ export type SidebarProps = { // Warning: (ae-missing-release-tag) "SidebarScrollWrapper" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) -export const SidebarScrollWrapper: React_2.ComponentType< - React_2.ClassAttributes & - React_2.HTMLAttributes & - StyledComponentProps<'root'> +export const SidebarScrollWrapper: ComponentType< + ComponentProps<'div'> & StyledComponentProps<'root'> >; // Warning: (ae-forgotten-export) The symbol "SidebarSearchFieldProps" needs to be exported by the entry point index.d.ts @@ -1105,10 +1099,8 @@ export function SidebarSearchField( // Warning: (ae-missing-release-tag) "SidebarSpace" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) -export const SidebarSpace: React_2.ComponentType< - React_2.ClassAttributes & - React_2.HTMLAttributes & - StyledComponentProps<'root'> +export const SidebarSpace: ComponentType< + ComponentProps<'div'> & StyledComponentProps<'root'> >; // Warning: (ae-missing-release-tag) "SidebarSpaceClassKey" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) @@ -1119,10 +1111,8 @@ export type SidebarSpaceClassKey = 'root'; // Warning: (ae-missing-release-tag) "SidebarSpacer" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) -export const SidebarSpacer: React_2.ComponentType< - React_2.ClassAttributes & - React_2.HTMLAttributes & - StyledComponentProps<'root'> +export const SidebarSpacer: ComponentType< + ComponentProps<'div'> & StyledComponentProps<'root'> >; // Warning: (ae-missing-release-tag) "SidebarSpacerClassKey" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) diff --git a/packages/core-plugin-api/report-alpha.api.md b/packages/core-plugin-api/report-alpha.api.md index 281d943e50..888c0ffea0 100644 --- a/packages/core-plugin-api/report-alpha.api.md +++ b/packages/core-plugin-api/report-alpha.api.md @@ -231,11 +231,7 @@ export type TranslationSnapshot< }; // @alpha (undocumented) -export const useTranslationRef: < - TMessages extends { - [x: string]: string; - }, ->( +export const useTranslationRef: ( translationRef: TranslationRef, ) => { t: TranslationFunction; diff --git a/packages/core-plugin-api/report.api.md b/packages/core-plugin-api/report.api.md index 9924d816da..762d07ff36 100644 --- a/packages/core-plugin-api/report.api.md +++ b/packages/core-plugin-api/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { BackstagePlugin as BackstagePlugin_2 } from '@backstage/core-plugin-api'; import { ComponentType } from 'react'; import { Config } from '@backstage/config'; @@ -791,9 +789,7 @@ export function withApis( ): ( WrappedComponent: React_2.ComponentType, ) => { - ( - props: React_2.PropsWithChildren>, - ): React_2.JSX.Element; + (props: PropsWithChildren>): React_2.JSX.Element; displayName: string; }; ``` diff --git a/packages/dev-utils/report.api.md b/packages/dev-utils/report.api.md index 1a7b765fab..6a92e2bcbc 100644 --- a/packages/dev-utils/report.api.md +++ b/packages/dev-utils/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { ApiFactory } from '@backstage/core-plugin-api'; import { AppTheme } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; diff --git a/packages/frontend-plugin-api/report.api.md b/packages/frontend-plugin-api/report.api.md index 0acb2c4bb8..94b467322d 100644 --- a/packages/frontend-plugin-api/report.api.md +++ b/packages/frontend-plugin-api/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { AlertApi } from '@backstage/core-plugin-api'; import { alertApiRef } from '@backstage/core-plugin-api'; import { AlertMessage } from '@backstage/core-plugin-api'; @@ -263,7 +261,7 @@ export const AppRootWrapperBlueprint: ExtensionBlueprint<{ }; output: ConfigurableExtensionDataRef< React_2.ComponentType<{ - children?: React_2.ReactNode; + children?: React_2.ReactNode | undefined; }>, 'app.root.wrapper', {} @@ -274,7 +272,7 @@ export const AppRootWrapperBlueprint: ExtensionBlueprint<{ dataRefs: { component: ConfigurableExtensionDataRef< React_2.ComponentType<{ - children?: React_2.ReactNode; + children?: React_2.ReactNode | undefined; }>, 'app.root.wrapper', {} @@ -1285,9 +1283,7 @@ export const IconBundleBlueprint: ExtensionBlueprint<{ kind: 'icon-bundle'; name: undefined; params: { - icons: { - [x: string]: IconComponent; - }; + icons: { [key in string]: IconComponent }; }; output: ConfigurableExtensionDataRef< { @@ -1376,8 +1372,8 @@ export const NavLogoBlueprint: ExtensionBlueprint<{ }; output: ConfigurableExtensionDataRef< { - logoIcon?: JSX.Element | undefined; - logoFull?: JSX.Element | undefined; + logoIcon?: JSX.Element; + logoFull?: JSX.Element; }, 'core.nav-logo.logo-elements', {} @@ -1388,8 +1384,8 @@ export const NavLogoBlueprint: ExtensionBlueprint<{ dataRefs: { logoElements: ConfigurableExtensionDataRef< { - logoIcon?: JSX.Element | undefined; - logoFull?: JSX.Element | undefined; + logoIcon?: JSX.Element; + logoFull?: JSX.Element; }, 'core.nav-logo.logo-elements', {} @@ -1422,7 +1418,7 @@ export const PageBlueprint: ExtensionBlueprint<{ params: { defaultPath: string; loader: () => Promise; - routeRef?: RouteRef | undefined; + routeRef?: RouteRef; }; output: | ConfigurableExtensionDataRef @@ -1580,7 +1576,7 @@ export const RouterBlueprint: ExtensionBlueprint<{ }; output: ConfigurableExtensionDataRef< ComponentType<{ - children?: ReactNode; + children?: ReactNode | undefined; }>, 'app.router.wrapper', {} @@ -1591,7 +1587,7 @@ export const RouterBlueprint: ExtensionBlueprint<{ dataRefs: { component: ConfigurableExtensionDataRef< ComponentType<{ - children?: ReactNode; + children?: ReactNode | undefined; }>, 'app.router.wrapper', {} diff --git a/packages/frontend-test-utils/report.api.md b/packages/frontend-test-utils/report.api.md index 1982315a35..fd6aba0223 100644 --- a/packages/frontend-test-utils/report.api.md +++ b/packages/frontend-test-utils/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { AnalyticsApi } from '@backstage/frontend-plugin-api'; import { AnalyticsEvent } from '@backstage/frontend-plugin-api'; import { AnyExtensionDataRef } from '@backstage/frontend-plugin-api'; diff --git a/packages/test-utils/report.api.md b/packages/test-utils/report.api.md index 126b7236b3..3fbd2a9c91 100644 --- a/packages/test-utils/report.api.md +++ b/packages/test-utils/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { AnalyticsApi } from '@backstage/core-plugin-api'; import { AnalyticsEvent } from '@backstage/core-plugin-api'; import { ApiFactory } from '@backstage/core-plugin-api'; @@ -106,7 +104,7 @@ export namespace mockApis { const factory: ( options?: | { - data?: JsonObject | undefined; + data?: JsonObject; } | undefined, ) => ApiFactory; @@ -118,7 +116,7 @@ export namespace mockApis { factory: ( options?: | { - baseUrl?: string | undefined; + baseUrl?: string; } | undefined, ) => ApiFactory; @@ -140,12 +138,12 @@ export namespace mockApis { factory: ( options?: | { - userEntityRef?: string | undefined; - ownershipEntityRefs?: string[] | undefined; - token?: string | undefined; - email?: string | undefined; - displayName?: string | undefined; - picture?: string | undefined; + userEntityRef?: string; + ownershipEntityRefs?: string[]; + token?: string; + email?: string; + displayName?: string; + picture?: string; } | undefined, ) => ApiFactory; @@ -168,12 +166,11 @@ export namespace mockApis { options?: | { authorize?: - | AuthorizeResult.DENY | AuthorizeResult.ALLOW + | AuthorizeResult.DENY | (( request: EvaluatePermissionRequest, - ) => AuthorizeResult.DENY | AuthorizeResult.ALLOW) - | undefined; + ) => AuthorizeResult.ALLOW | AuthorizeResult.DENY); } | undefined, ) => ApiFactory; @@ -188,7 +185,7 @@ export namespace mockApis { factory: ( options?: | { - data?: JsonObject | undefined; + data?: JsonObject; } | undefined, ) => ApiFactory; diff --git a/packages/version-bridge/report.api.md b/packages/version-bridge/report.api.md index 7dd88b1a34..9d99125806 100644 --- a/packages/version-bridge/report.api.md +++ b/packages/version-bridge/report.api.md @@ -14,7 +14,7 @@ export function createVersionedContext< // @public export function createVersionedContextForTesting(key: string): { - set(versions: { [x: number]: unknown }): void; + set(versions: { [version in number]: unknown }): void; reset(): void; }; diff --git a/plugins/api-docs/report-alpha.api.md b/plugins/api-docs/report-alpha.api.md index 73c1fc3ae9..0108d94e49 100644 --- a/plugins/api-docs/report-alpha.api.md +++ b/plugins/api-docs/report-alpha.api.md @@ -7,6 +7,7 @@ import { AnyApiFactory } from '@backstage/frontend-plugin-api'; import { AnyExtensionDataRef } from '@backstage/frontend-plugin-api'; import { AnyRouteRefParams } from '@backstage/frontend-plugin-api'; import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api'; +import { defaultEntityContentGroups } from '@backstage/plugin-catalog-react/alpha'; import { Entity } from '@backstage/catalog-model'; import { EntityCardType } from '@backstage/plugin-catalog-react/alpha'; import { EntityPredicate } from '@backstage/plugin-catalog-react/alpha'; @@ -83,8 +84,8 @@ const _default: FrontendPlugin< inputs: {}; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; }>; 'entity-card:api-docs/consuming-components': ExtensionDefinition<{ @@ -128,8 +129,8 @@ const _default: FrontendPlugin< inputs: {}; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; }>; 'entity-card:api-docs/definition': ExtensionDefinition<{ @@ -173,8 +174,8 @@ const _default: FrontendPlugin< inputs: {}; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; }>; 'entity-card:api-docs/has-apis': ExtensionDefinition<{ @@ -218,8 +219,8 @@ const _default: FrontendPlugin< inputs: {}; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; }>; 'entity-card:api-docs/provided-apis': ExtensionDefinition<{ @@ -263,8 +264,8 @@ const _default: FrontendPlugin< inputs: {}; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; }>; 'entity-card:api-docs/providing-components': ExtensionDefinition<{ @@ -308,8 +309,8 @@ const _default: FrontendPlugin< inputs: {}; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; }>; 'entity-content:api-docs/apis': ExtensionDefinition<{ @@ -372,15 +373,9 @@ const _default: FrontendPlugin< loader: () => Promise; defaultPath: string; defaultTitle: string; - defaultGroup?: - | (string & {}) - | 'documentation' - | 'development' - | 'deployment' - | 'observability' - | undefined; - routeRef?: RouteRef | undefined; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; + defaultGroup?: keyof defaultEntityContentGroups | (string & {}); + routeRef?: RouteRef; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); }; }>; 'entity-content:api-docs/definition': ExtensionDefinition<{ @@ -443,15 +438,9 @@ const _default: FrontendPlugin< loader: () => Promise; defaultPath: string; defaultTitle: string; - defaultGroup?: - | (string & {}) - | 'documentation' - | 'development' - | 'deployment' - | 'observability' - | undefined; - routeRef?: RouteRef | undefined; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; + defaultGroup?: keyof defaultEntityContentGroups | (string & {}); + routeRef?: RouteRef; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); }; }>; 'nav-item:api-docs': ExtensionDefinition<{ @@ -514,7 +503,7 @@ const _default: FrontendPlugin< params: { defaultPath: string; loader: () => Promise; - routeRef?: RouteRef | undefined; + routeRef?: RouteRef; }; }>; } diff --git a/plugins/api-docs/report.api.md b/plugins/api-docs/report.api.md index 0249479ef9..68b5fd0df9 100644 --- a/plugins/api-docs/report.api.md +++ b/plugins/api-docs/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { ApiEntity } from '@backstage/catalog-model'; import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; @@ -133,38 +131,38 @@ export const EntityApiDefinitionCard: () => JSX_2.Element; // @public (undocumented) export const EntityConsumedApisCard: (props: { - variant?: InfoCardVariants | undefined; - title?: string | undefined; - columns?: TableColumn[] | undefined; - tableOptions?: TableOptions<{}> | undefined; + variant?: InfoCardVariants; + title?: string; + columns?: TableColumn[]; + tableOptions?: TableOptions; }) => JSX_2.Element; // @public (undocumented) export const EntityConsumingComponentsCard: (props: { - variant?: InfoCardVariants | undefined; - columns?: TableColumn[] | undefined; + variant?: InfoCardVariants; + columns?: TableColumn[]; }) => JSX_2.Element; // @public (undocumented) export const EntityHasApisCard: (props: { - variant?: InfoCardVariants | undefined; - title?: string | undefined; - columns?: TableColumn[] | undefined; - tableOptions?: TableOptions<{}> | undefined; + variant?: InfoCardVariants; + title?: string; + columns?: TableColumn[]; + tableOptions?: TableOptions; }) => JSX_2.Element; // @public (undocumented) export const EntityProvidedApisCard: (props: { - variant?: InfoCardVariants | undefined; - title?: string | undefined; - columns?: TableColumn[] | undefined; - tableOptions?: TableOptions<{}> | undefined; + variant?: InfoCardVariants; + title?: string; + columns?: TableColumn[]; + tableOptions?: TableOptions; }) => JSX_2.Element; // @public (undocumented) export const EntityProvidingComponentsCard: (props: { - variant?: InfoCardVariants | undefined; - columns?: TableColumn[] | undefined; + variant?: InfoCardVariants; + columns?: TableColumn[]; }) => JSX_2.Element; // @public (undocumented) diff --git a/plugins/app-visualizer/report.api.md b/plugins/app-visualizer/report.api.md index f0855c9531..00470e6044 100644 --- a/plugins/app-visualizer/report.api.md +++ b/plugins/app-visualizer/report.api.md @@ -64,7 +64,7 @@ const visualizerPlugin: FrontendPlugin< params: { defaultPath: string; loader: () => Promise; - routeRef?: RouteRef | undefined; + routeRef?: RouteRef; }; }>; } diff --git a/plugins/app/report.api.md b/plugins/app/report.api.md index 811960eb39..3654a3965a 100644 --- a/plugins/app/report.api.md +++ b/plugins/app/report.api.md @@ -3,8 +3,6 @@ > 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'; @@ -105,8 +103,8 @@ const appPlugin: FrontendPlugin< logos: ExtensionInput< ConfigurableExtensionDataRef< { - logoIcon?: JSX.Element | undefined; - logoFull?: JSX.Element | undefined; + logoIcon?: JSX.Element; + logoFull?: JSX.Element; }, 'core.nav-logo.logo-elements', {} @@ -133,7 +131,7 @@ const appPlugin: FrontendPlugin< router: ExtensionInput< ConfigurableExtensionDataRef< ComponentType<{ - children?: ReactNode; + children?: ReactNode | undefined; }>, 'app.router.wrapper', {} @@ -171,7 +169,7 @@ const appPlugin: FrontendPlugin< wrappers: ExtensionInput< ConfigurableExtensionDataRef< ComponentType<{ - children?: ReactNode; + children?: ReactNode | undefined; }>, 'app.root.wrapper', {} diff --git a/plugins/auth-backend-module-aws-alb-provider/report.api.md b/plugins/auth-backend-module-aws-alb-provider/report.api.md index b3a9ce4517..567bff993c 100644 --- a/plugins/auth-backend-module-aws-alb-provider/report.api.md +++ b/plugins/auth-backend-module-aws-alb-provider/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { BackendFeature } from '@backstage/backend-plugin-api'; import { JWTHeaderParameters } from 'jose'; import { KeyObject } from 'crypto'; diff --git a/plugins/auth-backend-module-oauth2-proxy-provider/report.api.md b/plugins/auth-backend-module-oauth2-proxy-provider/report.api.md index 5c5cefd734..aa360bc9c5 100644 --- a/plugins/auth-backend-module-oauth2-proxy-provider/report.api.md +++ b/plugins/auth-backend-module-oauth2-proxy-provider/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { BackendFeature } from '@backstage/backend-plugin-api'; import { IncomingHttpHeaders } from 'http'; import { ProxyAuthenticator } from '@backstage/plugin-auth-node'; diff --git a/plugins/auth-backend/report.api.md b/plugins/auth-backend/report.api.md index 00b1c43bc0..fb35ea2905 100644 --- a/plugins/auth-backend/report.api.md +++ b/plugins/auth-backend/report.api.md @@ -372,12 +372,10 @@ export const providers: Readonly<{ create: ( options?: | { - authHandler?: AuthHandler | undefined; - signIn?: - | { - resolver: SignInResolver_2; - } - | undefined; + authHandler?: AuthHandler; + signIn?: { + resolver: SignInResolver_2; + }; } | undefined, ) => AuthProviderFactory_2; @@ -387,12 +385,10 @@ export const providers: Readonly<{ create: ( options?: | { - authHandler?: AuthHandler | undefined; - signIn?: - | { - resolver: SignInResolver_2; - } - | undefined; + authHandler?: AuthHandler; + signIn?: { + resolver: SignInResolver_2; + }; } | undefined, ) => AuthProviderFactory_2; @@ -402,7 +398,7 @@ export const providers: Readonly<{ create: ( options?: | { - authHandler?: AuthHandler | undefined; + authHandler?: AuthHandler; signIn: { resolver: SignInResolver_2; }; @@ -415,12 +411,10 @@ export const providers: Readonly<{ create: ( options?: | { - authHandler?: AuthHandler | undefined; - signIn?: - | { - resolver: SignInResolver_2; - } - | undefined; + authHandler?: AuthHandler; + signIn?: { + resolver: SignInResolver_2; + }; } | undefined, ) => AuthProviderFactory_2; @@ -433,12 +427,10 @@ export const providers: Readonly<{ create: ( options?: | { - authHandler?: AuthHandler | undefined; - signIn?: - | { - resolver: SignInResolver_2; - } - | undefined; + authHandler?: AuthHandler; + signIn?: { + resolver: SignInResolver_2; + }; } | undefined, ) => AuthProviderFactory_2; @@ -448,19 +440,19 @@ export const providers: Readonly<{ }>; cfAccess: Readonly<{ create: (options: { - authHandler?: AuthHandler | undefined; + authHandler?: AuthHandler; signIn: { resolver: SignInResolver_2; }; - cache?: CacheService | undefined; + cache?: CacheService; }) => AuthProviderFactory_2; resolvers: Readonly; }>; gcpIap: Readonly<{ create: (options: { - authHandler?: AuthHandler | undefined; + authHandler?: AuthHandler; signIn: { - resolver: SignInResolver_2; + resolver: SignInResolver_2; }; }) => AuthProviderFactory_2; resolvers: never; @@ -469,13 +461,11 @@ export const providers: Readonly<{ create: ( options?: | { - authHandler?: AuthHandler | undefined; - signIn?: - | { - resolver: SignInResolver_2; - } - | undefined; - stateEncoder?: StateEncoder | undefined; + authHandler?: AuthHandler; + signIn?: { + resolver: SignInResolver_2; + }; + stateEncoder?: StateEncoder; } | undefined, ) => AuthProviderFactory_2; @@ -487,12 +477,10 @@ export const providers: Readonly<{ create: ( options?: | { - authHandler?: AuthHandler | undefined; - signIn?: - | { - resolver: SignInResolver_2; - } - | undefined; + authHandler?: AuthHandler; + signIn?: { + resolver: SignInResolver_2; + }; } | undefined, ) => AuthProviderFactory_2; @@ -502,12 +490,10 @@ export const providers: Readonly<{ create: ( options?: | { - authHandler?: AuthHandler | undefined; - signIn?: - | { - resolver: SignInResolver_2; - } - | undefined; + authHandler?: AuthHandler; + signIn?: { + resolver: SignInResolver_2; + }; } | undefined, ) => AuthProviderFactory_2; @@ -521,12 +507,10 @@ export const providers: Readonly<{ create: ( options?: | { - authHandler?: AuthHandler | undefined; - signIn?: - | { - resolver: SignInResolver_2; - } - | undefined; + authHandler?: AuthHandler; + signIn?: { + resolver: SignInResolver_2; + }; } | undefined, ) => AuthProviderFactory_2; @@ -541,12 +525,10 @@ export const providers: Readonly<{ create: ( options?: | { - authHandler?: AuthHandler | undefined; - signIn?: - | { - resolver: SignInResolver_2; - } - | undefined; + authHandler?: AuthHandler; + signIn?: { + resolver: SignInResolver_2; + }; } | undefined, ) => AuthProviderFactory_2; @@ -554,7 +536,7 @@ export const providers: Readonly<{ }>; oauth2Proxy: Readonly<{ create: (options: { - authHandler?: AuthHandler | undefined; + authHandler?: AuthHandler; signIn: { resolver: SignInResolver_2; }; @@ -565,12 +547,10 @@ export const providers: Readonly<{ create: ( options?: | { - authHandler?: AuthHandler | undefined; - signIn?: - | { - resolver: SignInResolver_2; - } - | undefined; + authHandler?: AuthHandler; + signIn?: { + resolver: SignInResolver_2; + }; } | undefined, ) => AuthProviderFactory_2; @@ -583,12 +563,10 @@ export const providers: Readonly<{ create: ( options?: | { - authHandler?: AuthHandler | undefined; - signIn?: - | { - resolver: SignInResolver_2; - } - | undefined; + authHandler?: AuthHandler; + signIn?: { + resolver: SignInResolver_2; + }; } | undefined, ) => AuthProviderFactory_2; @@ -602,12 +580,10 @@ export const providers: Readonly<{ create: ( options?: | { - authHandler?: AuthHandler | undefined; - signIn?: - | { - resolver: SignInResolver_2; - } - | undefined; + authHandler?: AuthHandler; + signIn?: { + resolver: SignInResolver_2; + }; } | undefined, ) => AuthProviderFactory_2; @@ -617,12 +593,10 @@ export const providers: Readonly<{ create: ( options?: | { - authHandler?: AuthHandler | undefined; - signIn?: - | { - resolver: SignInResolver_2; - } - | undefined; + authHandler?: AuthHandler; + signIn?: { + resolver: SignInResolver_2; + }; } | undefined, ) => AuthProviderFactory_2; @@ -634,7 +608,7 @@ export const providers: Readonly<{ create: ( options?: | { - authHandler?: AuthHandler | undefined; + authHandler?: AuthHandler; signIn: { resolver: SignInResolver_2; }; diff --git a/plugins/auth-backend/src/providers/azure-easyauth/provider.ts b/plugins/auth-backend/src/providers/azure-easyauth/provider.ts index 5e61b8bf8a..202f99a7e1 100644 --- a/plugins/auth-backend/src/providers/azure-easyauth/provider.ts +++ b/plugins/auth-backend/src/providers/azure-easyauth/provider.ts @@ -25,8 +25,6 @@ import { azureEasyAuthAuthenticator, } from '@backstage/plugin-auth-backend-module-azure-easyauth-provider'; -export type EasyAuthResult = AzureEasyAuthResult; - /** * Auth provider integration for Azure EasyAuth * @@ -39,7 +37,7 @@ export const easyAuth = createAuthProviderIntegration({ * The profile transformation function used to verify and convert the auth response * into the profile that will be presented to the user. */ - authHandler?: AuthHandler; + authHandler?: AuthHandler; /** * Configure sign-in for this provider, without it the provider can not be used to sign users in. @@ -48,7 +46,7 @@ export const easyAuth = createAuthProviderIntegration({ /** * Maps an auth result to a Backstage identity for the user. */ - resolver: SignInResolver; + resolver: SignInResolver; }; }) { return createProxyAuthProviderFactory({ diff --git a/plugins/catalog-backend-module-incremental-ingestion/report.api.md b/plugins/catalog-backend-module-incremental-ingestion/report.api.md index b4979b1e37..df77a254c8 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/report.api.md +++ b/plugins/catalog-backend-module-incremental-ingestion/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { BackendFeature } from '@backstage/backend-plugin-api'; import { CatalogBuilder } from '@backstage/plugin-catalog-backend'; import { DatabaseService } from '@backstage/backend-plugin-api'; diff --git a/plugins/catalog-backend/report.api.md b/plugins/catalog-backend/report.api.md index 06f3ca6390..3a47cc4354 100644 --- a/plugins/catalog-backend/report.api.md +++ b/plugins/catalog-backend/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { AnalyzeLocationEntityField as AnalyzeLocationEntityField_2 } from '@backstage/plugin-catalog-common'; import { AnalyzeLocationExistingEntity as AnalyzeLocationExistingEntity_2 } from '@backstage/plugin-catalog-common'; import { AnalyzeLocationGenerateEntity as AnalyzeLocationGenerateEntity_2 } from '@backstage/plugin-catalog-common'; @@ -479,11 +477,9 @@ export const processingResult: Readonly<{ readonly entity: ( atLocation: LocationSpec_2, newEntity: Entity, - options?: - | { - locationKey?: string | null | undefined; - } - | undefined, + options?: { + locationKey?: string | null; + }, ) => CatalogProcessorResult_2; readonly relation: (spec: EntityRelationSpec_2) => CatalogProcessorResult_2; readonly refresh: (key: string) => CatalogProcessorResult_2; diff --git a/plugins/catalog-graph/report-alpha.api.md b/plugins/catalog-graph/report-alpha.api.md index fcc9265cb4..4cc884e7d7 100644 --- a/plugins/catalog-graph/report-alpha.api.md +++ b/plugins/catalog-graph/report-alpha.api.md @@ -51,8 +51,8 @@ const _default: FrontendPlugin< height?: number | undefined; curve?: 'curveStepBefore' | 'curveMonotoneX' | undefined; direction?: Direction | undefined; - title?: string | undefined; zoom?: 'disabled' | 'enabled' | 'enable-on-click' | undefined; + title?: string | undefined; relations?: string[] | undefined; maxDepth?: number | undefined; kinds?: string[] | undefined; @@ -103,8 +103,8 @@ const _default: FrontendPlugin< name: 'relations'; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; }>; 'page:catalog-graph': ExtensionDefinition<{ @@ -170,7 +170,7 @@ const _default: FrontendPlugin< params: { defaultPath: string; loader: () => Promise; - routeRef?: RouteRef | undefined; + routeRef?: RouteRef; }; }>; } diff --git a/plugins/catalog-graph/report.api.md b/plugins/catalog-graph/report.api.md index 3f2dff2560..925b95e6d4 100644 --- a/plugins/catalog-graph/report.api.md +++ b/plugins/catalog-graph/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { BackstagePlugin } from '@backstage/core-plugin-api'; import { CompoundEntityRef } from '@backstage/catalog-model'; import { DependencyGraphTypes } from '@backstage/core-components'; @@ -25,19 +23,17 @@ export const ALL_RELATION_PAIRS: RelationPairs; // @public export const CatalogGraphPage: ( props: { - initialState?: - | { - selectedRelations?: string[] | undefined; - selectedKinds?: string[] | undefined; - rootEntityRefs?: string[] | undefined; - maxDepth?: number | undefined; - unidirectional?: boolean | undefined; - mergeRelations?: boolean | undefined; - direction?: Direction | undefined; - showFilters?: boolean | undefined; - curve?: 'curveStepBefore' | 'curveMonotoneX' | undefined; - } - | undefined; + initialState?: { + selectedRelations?: string[]; + selectedKinds?: string[]; + rootEntityRefs?: string[]; + maxDepth?: number; + unidirectional?: boolean; + mergeRelations?: boolean; + direction?: Direction; + showFilters?: boolean; + curve?: 'curveStepBefore' | 'curveMonotoneX'; + }; } & Partial, ) => JSX_2.Element; @@ -78,9 +74,9 @@ export enum Direction { // @public export const EntityCatalogGraphCard: ( props: Partial & { - variant?: InfoCardVariants | undefined; - height?: number | undefined; - title?: string | undefined; + variant?: InfoCardVariants; + height?: number; + title?: string; action?: ReactNode; }, ) => JSX_2.Element; diff --git a/plugins/catalog-import/report-alpha.api.md b/plugins/catalog-import/report-alpha.api.md index 1706404b94..91c0e05d30 100644 --- a/plugins/catalog-import/report-alpha.api.md +++ b/plugins/catalog-import/report-alpha.api.md @@ -60,7 +60,7 @@ const _default: FrontendPlugin< params: { defaultPath: string; loader: () => Promise; - routeRef?: RouteRef | undefined; + routeRef?: RouteRef; }; }>; } diff --git a/plugins/catalog-import/report.api.md b/plugins/catalog-import/report.api.md index c61aa97b06..e31ef8defe 100644 --- a/plugins/catalog-import/report.api.md +++ b/plugins/catalog-import/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { CatalogApi } from '@backstage/catalog-client'; diff --git a/plugins/catalog-node/report.api.md b/plugins/catalog-node/report.api.md index ddfac756b4..a51212e412 100644 --- a/plugins/catalog-node/report.api.md +++ b/plugins/catalog-node/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { AddLocationRequest } from '@backstage/catalog-client'; import { AddLocationResponse } from '@backstage/catalog-client'; import { AnalyzeLocationExistingEntity } from '@backstage/plugin-catalog-common'; diff --git a/plugins/catalog-react/report-alpha.api.md b/plugins/catalog-react/report-alpha.api.md index 6c7a31c54f..c191e55f2a 100644 --- a/plugins/catalog-react/report-alpha.api.md +++ b/plugins/catalog-react/report-alpha.api.md @@ -3,8 +3,6 @@ > 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 { ComponentType } from 'react'; import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api'; @@ -110,8 +108,8 @@ export const EntityCardBlueprint: ExtensionBlueprint<{ name: undefined; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; output: | ConfigurableExtensionDataRef @@ -175,15 +173,9 @@ export const EntityContentBlueprint: ExtensionBlueprint<{ loader: () => Promise; defaultPath: string; defaultTitle: string; - defaultGroup?: - | (string & {}) - | 'documentation' - | 'development' - | 'deployment' - | 'observability' - | undefined; - routeRef?: RouteRef | undefined; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; + defaultGroup?: keyof typeof defaultEntityContentGroups | (string & {}); + routeRef?: RouteRef; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); }; output: | ConfigurableExtensionDataRef @@ -259,7 +251,7 @@ export const EntityContentLayoutBlueprint: ExtensionBlueprint<{ kind: 'entity-content-layout'; name: undefined; params: { - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); loader: () => Promise< (props: EntityContentLayoutProps) => React_2.JSX.Element >; diff --git a/plugins/catalog-react/report.api.md b/plugins/catalog-react/report.api.md index 106eff689d..a0e2d22141 100644 --- a/plugins/catalog-react/report.api.md +++ b/plugins/catalog-react/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { ApiRef } from '@backstage/core-plugin-api'; import { AutocompleteProps } from '@material-ui/lab/Autocomplete'; import { CATALOG_FILTER_EXISTS } from '@backstage/catalog-client'; @@ -170,20 +168,20 @@ export const columnFactories: Readonly<{ createEntityRefColumn(options: { defaultKind?: string; }): TableColumn; - createEntityRelationColumn(options: { + createEntityRelationColumn(options: { title: string; relation: string; defaultKind?: string; filter?: { kind: string; }; - }): TableColumn; - createOwnerColumn(): TableColumn; - createDomainColumn(): TableColumn; - createSystemColumn(): TableColumn; - createMetadataDescriptionColumn(): TableColumn; - createSpecLifecycleColumn(): TableColumn; - createSpecTypeColumn(): TableColumn; + }): TableColumn; + createOwnerColumn(): TableColumn; + createDomainColumn(): TableColumn; + createSystemColumn(): TableColumn; + createMetadataDescriptionColumn(): TableColumn; + createSpecLifecycleColumn(): TableColumn; + createSpecTypeColumn(): TableColumn; }>; // @public (undocumented) @@ -555,25 +553,23 @@ export type EntitySourceLocation = { export const EntityTable: { (props: EntityTableProps): React_2.JSX.Element; columns: Readonly<{ - createEntityRefColumn(options: { - defaultKind?: string | undefined; - }): TableColumn; - createEntityRelationColumn(options: { + createEntityRefColumn(options: { + defaultKind?: string; + }): TableColumn; + createEntityRelationColumn(options: { title: string; relation: string; - defaultKind?: string | undefined; - filter?: - | { - kind: string; - } - | undefined; - }): TableColumn; - createOwnerColumn(): TableColumn; - createDomainColumn(): TableColumn; - createSystemColumn(): TableColumn; - createMetadataDescriptionColumn(): TableColumn; - createSpecLifecycleColumn(): TableColumn; - createSpecTypeColumn(): TableColumn; + defaultKind?: string; + filter?: { + kind: string; + }; + }): TableColumn; + createOwnerColumn(): TableColumn; + createDomainColumn(): TableColumn; + createSystemColumn(): TableColumn; + createMetadataDescriptionColumn(): TableColumn; + createSpecLifecycleColumn(): TableColumn; + createSpecTypeColumn(): TableColumn; }>; systemEntityColumns: TableColumn[]; componentEntityColumns: TableColumn[]; diff --git a/plugins/catalog-unprocessed-entities/report-alpha.api.md b/plugins/catalog-unprocessed-entities/report-alpha.api.md index b50a992370..b5b9938801 100644 --- a/plugins/catalog-unprocessed-entities/report-alpha.api.md +++ b/plugins/catalog-unprocessed-entities/report-alpha.api.md @@ -82,7 +82,7 @@ const _default: FrontendPlugin< params: { defaultPath: string; loader: () => Promise; - routeRef?: RouteRef | undefined; + routeRef?: RouteRef; }; }>; } diff --git a/plugins/catalog-unprocessed-entities/report.api.md b/plugins/catalog-unprocessed-entities/report.api.md index 7d8f6299da..4de30d2cb6 100644 --- a/plugins/catalog-unprocessed-entities/report.api.md +++ b/plugins/catalog-unprocessed-entities/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { Entity } from '@backstage/catalog-model'; diff --git a/plugins/catalog/report-alpha.api.md b/plugins/catalog/report-alpha.api.md index 113fa5b6a1..ca6d01b0ac 100644 --- a/plugins/catalog/report-alpha.api.md +++ b/plugins/catalog/report-alpha.api.md @@ -3,12 +3,11 @@ > 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 { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api'; +import { defaultEntityContentGroups } from '@backstage/plugin-catalog-react/alpha'; import { Entity } from '@backstage/catalog-model'; import { EntityCardType } from '@backstage/plugin-catalog-react/alpha'; import { EntityContentLayoutProps } from '@backstage/plugin-catalog-react/alpha'; @@ -387,8 +386,8 @@ const _default: FrontendPlugin< inputs: {}; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; }>; 'entity-card:catalog/depends-on-components': ExtensionDefinition<{ @@ -428,8 +427,8 @@ const _default: FrontendPlugin< inputs: {}; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; }>; 'entity-card:catalog/depends-on-resources': ExtensionDefinition<{ @@ -469,8 +468,8 @@ const _default: FrontendPlugin< inputs: {}; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; }>; 'entity-card:catalog/has-components': ExtensionDefinition<{ @@ -510,8 +509,8 @@ const _default: FrontendPlugin< inputs: {}; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; }>; 'entity-card:catalog/has-resources': ExtensionDefinition<{ @@ -551,8 +550,8 @@ const _default: FrontendPlugin< inputs: {}; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; }>; 'entity-card:catalog/has-subcomponents': ExtensionDefinition<{ @@ -592,8 +591,8 @@ const _default: FrontendPlugin< inputs: {}; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; }>; 'entity-card:catalog/has-subdomains': ExtensionDefinition<{ @@ -633,8 +632,8 @@ const _default: FrontendPlugin< inputs: {}; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; }>; 'entity-card:catalog/has-systems': ExtensionDefinition<{ @@ -674,8 +673,8 @@ const _default: FrontendPlugin< inputs: {}; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; }>; 'entity-card:catalog/labels': ExtensionDefinition<{ @@ -715,8 +714,8 @@ const _default: FrontendPlugin< inputs: {}; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; }>; 'entity-card:catalog/links': ExtensionDefinition<{ @@ -756,8 +755,8 @@ const _default: FrontendPlugin< inputs: {}; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; }>; 'entity-content:catalog/overview': ExtensionDefinition<{ @@ -826,7 +825,7 @@ const _default: FrontendPlugin< } > | ConfigurableExtensionDataRef< - (props: EntityContentLayoutProps) => JSX_2.Element, + (props: EntityContentLayoutProps) => React.JSX.Element, 'catalog.entity-content-layout.component', {} >, @@ -870,15 +869,9 @@ const _default: FrontendPlugin< loader: () => Promise; defaultPath: string; defaultTitle: string; - defaultGroup?: - | (string & {}) - | 'documentation' - | 'development' - | 'deployment' - | 'observability' - | undefined; - routeRef?: RouteRef | undefined; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; + defaultGroup?: keyof defaultEntityContentGroups | (string & {}); + routeRef?: RouteRef; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); }; }>; 'nav-item:catalog': ExtensionDefinition<{ @@ -933,7 +926,7 @@ const _default: FrontendPlugin< params: { defaultPath: string; loader: () => Promise; - routeRef?: RouteRef | undefined; + routeRef?: RouteRef; }; }>; 'page:catalog/entity': ExtensionDefinition<{ @@ -1032,7 +1025,7 @@ const _default: FrontendPlugin< params: { defaultPath: string; loader: () => Promise; - routeRef?: RouteRef | undefined; + routeRef?: RouteRef; }; }>; 'search-result-list-item:catalog': ExtensionDefinition<{ @@ -1046,7 +1039,7 @@ const _default: FrontendPlugin< }; output: ConfigurableExtensionDataRef< { - predicate?: SearchResultItemExtensionPredicate | undefined; + predicate?: SearchResultItemExtensionPredicate; component: SearchResultItemExtensionComponent; }, 'search.search-result-list-item.item', diff --git a/plugins/catalog/report.api.md b/plugins/catalog/report.api.md index 05972eecad..e0e5ff72d6 100644 --- a/plugins/catalog/report.api.md +++ b/plugins/catalog/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { ApiHolder } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { CatalogApi } from '@backstage/plugin-catalog-react'; @@ -161,13 +159,9 @@ export interface CatalogSearchResultListItemProps { export const CatalogTable: { (props: CatalogTableProps): React_2.JSX.Element; columns: Readonly<{ - createNameColumn( - options?: - | { - defaultKind?: string | undefined; - } - | undefined, - ): TableColumn; + createNameColumn(options?: { + defaultKind?: string; + }): TableColumn; createSystemColumn(): TableColumn; createOwnerColumn(): TableColumn; createSpecTargetsColumn(): TableColumn; @@ -177,21 +171,15 @@ export const CatalogTable: { createSpecLifecycleColumn(): TableColumn; createMetadataDescriptionColumn(): TableColumn; createTagsColumn(): TableColumn; - createTitleColumn( - options?: - | { - hidden?: boolean | undefined; - } - | undefined, - ): TableColumn; + createTitleColumn(options?: { + hidden?: boolean; + }): TableColumn; createLabelColumn( key: string, - options?: - | { - title?: string | undefined; - defaultValue?: string | undefined; - } - | undefined, + options?: { + title?: string; + defaultValue?: string; + }, ): TableColumn; createNamespaceColumn(): TableColumn; }>; @@ -459,7 +447,7 @@ export type EntityLinksEmptyStateClassKey = 'code'; // @public @deprecated (undocumented) export const EntityListContainer: (props: { - children: ReactNode; + children: React.ReactNode; }) => JSX_2.Element; // @public @@ -508,20 +496,11 @@ export interface EntitySwitchProps { // @public @deprecated (undocumented) export const FilterContainer: (props: { - children: ReactNode; - options?: - | { - drawerBreakpoint?: - | number - | 'xs' - | 'sm' - | 'md' - | 'lg' - | 'xl' - | undefined; - drawerAnchor?: 'left' | 'top' | 'bottom' | 'right' | undefined; - } - | undefined; + children: React.ReactNode; + options?: { + drawerBreakpoint?: 'xs' | 'sm' | 'md' | 'lg' | 'xl' | number; + drawerAnchor?: 'left' | 'right' | 'top' | 'bottom'; + }; }) => JSX_2.Element; // @public @deprecated (undocumented) diff --git a/plugins/config-schema/report.api.md b/plugins/config-schema/report.api.md index 16630ae8d0..1491f3cb89 100644 --- a/plugins/config-schema/report.api.md +++ b/plugins/config-schema/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { JSX as JSX_2 } from 'react'; diff --git a/plugins/devtools/report-alpha.api.md b/plugins/devtools/report-alpha.api.md index d76ac7c54f..23167bb42c 100644 --- a/plugins/devtools/report-alpha.api.md +++ b/plugins/devtools/report-alpha.api.md @@ -82,7 +82,7 @@ const _default: FrontendPlugin< params: { defaultPath: string; loader: () => Promise; - routeRef?: RouteRef | undefined; + routeRef?: RouteRef; }; }>; } diff --git a/plugins/devtools/report.api.md b/plugins/devtools/report.api.md index bba36a5a9a..ae81aa123b 100644 --- a/plugins/devtools/report.api.md +++ b/plugins/devtools/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { BackstagePlugin } from '@backstage/core-plugin-api'; import { default as default_2 } from 'react'; import { JSX as JSX_2 } from 'react'; diff --git a/plugins/events-node/report.api.md b/plugins/events-node/report.api.md index f53bb251ec..8bc3145dd5 100644 --- a/plugins/events-node/report.api.md +++ b/plugins/events-node/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { AuthService } from '@backstage/backend-plugin-api'; import { DiscoveryService } from '@backstage/backend-plugin-api'; import { LifecycleService } from '@backstage/backend-plugin-api'; diff --git a/plugins/example-todo-list/report.api.md b/plugins/example-todo-list/report.api.md index 2feeeb903d..699712c062 100644 --- a/plugins/example-todo-list/report.api.md +++ b/plugins/example-todo-list/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { BackstagePlugin } from '@backstage/core-plugin-api'; import { JSX as JSX_2 } from 'react'; import { RouteRef } from '@backstage/core-plugin-api'; diff --git a/plugins/home/report-alpha.api.md b/plugins/home/report-alpha.api.md index 429af86a12..7787c96ff0 100644 --- a/plugins/home/report-alpha.api.md +++ b/plugins/home/report-alpha.api.md @@ -64,7 +64,7 @@ const _default: FrontendPlugin< params: { defaultPath: string; loader: () => Promise; - routeRef?: RouteRef | undefined; + routeRef?: RouteRef; }; }>; } diff --git a/plugins/home/report.api.md b/plugins/home/report.api.md index 1cff56f50c..ef5a0d5a7a 100644 --- a/plugins/home/report.api.md +++ b/plugins/home/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { CardConfig as CardConfig_2 } from '@backstage/plugin-home-react'; @@ -48,12 +46,13 @@ export type ClockConfig = { // @public (undocumented) export const ComponentAccordion: (props: { - title?: string | undefined; - expanded?: boolean | undefined; + title?: string; + expanded?: boolean; Content: () => JSX.Element; - Actions?: (() => JSX.Element) | undefined; - Settings?: (() => JSX.Element) | undefined; - ContextProvider?: ((props: any) => JSX.Element) | undefined; + Actions?: () => JSX.Element; + Settings?: () => JSX./** @public */ + Element; + ContextProvider?: (props: any) => JSX.Element; }) => JSX_2.Element; // @public @deprecated (undocumented) @@ -66,7 +65,7 @@ export type ComponentRenderer = ComponentRenderer_2; export const ComponentTab: (props: { title: string; Content: () => JSX.Element; - ContextProvider?: ((props: any) => JSX.Element) | undefined; + ContextProvider?: (props: any) => JSX.Element; }) => JSX_2.Element; // @public (undocumented) @@ -119,25 +118,25 @@ export type FeaturedDocsCardProps = { // @public export const HeaderWorldClock: (props: { clockConfigs: ClockConfig[]; - customTimeFormat?: Intl.DateTimeFormatOptions | undefined; + customTimeFormat?: Intl.DateTimeFormatOptions; }) => JSX_2.Element | null; // @public export const HomePageCompanyLogo: (props: { - logo?: ReactNode; - className?: string | undefined; + logo?: React.ReactNode; + className?: string; }) => JSX_2.Element; // @public (undocumented) export const HomepageCompositionRoot: (props: { - title?: string | undefined; + title?: string; children?: ReactNode; }) => JSX_2.Element; // @public (undocumented) export const HomePageRandomJoke: ( props: CardExtensionProps_2<{ - defaultCategory?: 'any' | 'programming' | undefined; + defaultCategory?: 'any' | 'programming'; }>, ) => JSX_2.Element; @@ -210,7 +209,7 @@ export type RendererProps = RendererProps_2; export const SettingsModal: (props: { open: boolean; close: Function; - componentName?: string | undefined; + componentName?: string; children: JSX.Element; }) => JSX_2.Element; @@ -272,10 +271,8 @@ export const VisitListener: ({ visitName, }: { children?: React_2.ReactNode; - toEntityRef?: - | (({ pathname }: { pathname: string }) => string | undefined) - | undefined; - visitName?: (({ pathname }: { pathname: string }) => string) | undefined; + toEntityRef?: ({ pathname }: { pathname: string }) => string | undefined; + visitName?: ({ pathname }: { pathname: string }) => string; }) => JSX.Element; // @public diff --git a/plugins/kubernetes-cluster/report.api.md b/plugins/kubernetes-cluster/report.api.md index 10d248097a..1fd607295a 100644 --- a/plugins/kubernetes-cluster/report.api.md +++ b/plugins/kubernetes-cluster/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { Entity } from '@backstage/catalog-model'; import { default as React_2 } from 'react'; diff --git a/plugins/kubernetes/report-alpha.api.md b/plugins/kubernetes/report-alpha.api.md index 0cca232bf6..e6cc199ae8 100644 --- a/plugins/kubernetes/report-alpha.api.md +++ b/plugins/kubernetes/report-alpha.api.md @@ -3,11 +3,10 @@ > 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 { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api'; +import { defaultEntityContentGroups } from '@backstage/plugin-catalog-react/alpha'; import { Entity } from '@backstage/catalog-model'; import { EntityPredicate } from '@backstage/plugin-catalog-react/alpha'; import { ExtensionDefinition } from '@backstage/frontend-plugin-api'; @@ -139,15 +138,9 @@ const _default: FrontendPlugin< loader: () => Promise; defaultPath: string; defaultTitle: string; - defaultGroup?: - | (string & {}) - | 'documentation' - | 'development' - | 'deployment' - | 'observability' - | undefined; - routeRef?: RouteRef | undefined; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; + defaultGroup?: keyof defaultEntityContentGroups | (string & {}); + routeRef?: RouteRef; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); }; }>; 'page:kubernetes': ExtensionDefinition<{ @@ -173,7 +166,7 @@ const _default: FrontendPlugin< params: { defaultPath: string; loader: () => Promise; - routeRef?: RouteRef | undefined; + routeRef?: RouteRef; }; }>; } diff --git a/plugins/kubernetes/report.api.md b/plugins/kubernetes/report.api.md index 64b56cf786..5eb1b456a7 100644 --- a/plugins/kubernetes/report.api.md +++ b/plugins/kubernetes/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { BackstagePlugin } from '@backstage/core-plugin-api'; import { Entity } from '@backstage/catalog-model'; import { default as React_2 } from 'react'; diff --git a/plugins/notifications/report-alpha.api.md b/plugins/notifications/report-alpha.api.md index 2038b2c873..a14cb89f3f 100644 --- a/plugins/notifications/report-alpha.api.md +++ b/plugins/notifications/report-alpha.api.md @@ -60,7 +60,7 @@ const _default: FrontendPlugin< params: { defaultPath: string; loader: () => Promise; - routeRef?: RouteRef | undefined; + routeRef?: RouteRef; }; }>; } diff --git a/plugins/notifications/report.api.md b/plugins/notifications/report.api.md index 8b4553cf42..aacee54329 100644 --- a/plugins/notifications/report.api.md +++ b/plugins/notifications/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { DiscoveryApi } from '@backstage/core-plugin-api'; @@ -105,7 +103,7 @@ export class NotificationsClient implements NotificationsApi { // @public (undocumented) export const NotificationsPage: ( - props?: NotificationsPageProps | undefined, + props?: NotificationsPageProps, ) => JSX_2.Element; // @public (undocumented) diff --git a/plugins/org/report-alpha.api.md b/plugins/org/report-alpha.api.md index 508c0ed04e..f85e7090dd 100644 --- a/plugins/org/report-alpha.api.md +++ b/plugins/org/report-alpha.api.md @@ -60,8 +60,8 @@ const _default: FrontendPlugin< inputs: {}; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; }>; 'entity-card:org/members-list': ExtensionDefinition<{ @@ -105,8 +105,8 @@ const _default: FrontendPlugin< inputs: {}; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; }>; 'entity-card:org/ownership': ExtensionDefinition<{ @@ -150,8 +150,8 @@ const _default: FrontendPlugin< inputs: {}; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; }>; 'entity-card:org/user-profile': ExtensionDefinition<{ @@ -195,8 +195,8 @@ const _default: FrontendPlugin< inputs: {}; params: { loader: () => Promise; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; - type?: EntityCardType | undefined; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); + type?: EntityCardType; }; }>; } diff --git a/plugins/org/report.api.md b/plugins/org/report.api.md index af03687240..bbe4a36b8f 100644 --- a/plugins/org/report.api.md +++ b/plugins/org/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { BackstagePlugin } from '@backstage/core-plugin-api'; import { ExternalRouteRef } from '@backstage/core-plugin-api'; import { IconComponent } from '@backstage/core-plugin-api'; @@ -14,28 +12,28 @@ import { default as React_2 } from 'react'; // @public (undocumented) export const EntityGroupProfileCard: (props: { - variant?: InfoCardVariants | undefined; - showLinks?: boolean | undefined; + variant?: InfoCardVariants; + showLinks?: boolean; }) => JSX_2.Element; // @public (undocumented) export const EntityMembersListCard: (props: { - memberDisplayTitle?: string | undefined; - pageSize?: number | undefined; - showAggregateMembersToggle?: boolean | undefined; - relationType?: string | undefined; - relationsType?: EntityRelationAggregation | undefined; - relationAggregation?: EntityRelationAggregation | undefined; + memberDisplayTitle?: string; + pageSize?: number; + showAggregateMembersToggle?: boolean; + relationType?: string; + relationsType?: EntityRelationAggregation; + relationAggregation?: EntityRelationAggregation; }) => JSX_2.Element; // @public (undocumented) export const EntityOwnershipCard: (props: { - variant?: InfoCardVariants | undefined; - entityFilterKind?: string[] | undefined; - hideRelationsToggle?: boolean | undefined; - relationsType?: EntityRelationAggregation | undefined; - relationAggregation?: EntityRelationAggregation | undefined; - entityLimit?: number | undefined; + variant?: InfoCardVariants; + entityFilterKind?: string[]; + hideRelationsToggle?: boolean; + relationsType?: EntityRelationAggregation; + relationAggregation?: EntityRelationAggregation; + entityLimit?: number; }) => JSX_2.Element; // @public (undocumented) @@ -43,8 +41,8 @@ export type EntityRelationAggregation = 'direct' | 'aggregated'; // @public (undocumented) export const EntityUserProfileCard: (props: { - variant?: InfoCardVariants | undefined; - showLinks?: boolean | undefined; + variant?: InfoCardVariants; + showLinks?: boolean; }) => JSX_2.Element; // @public (undocumented) diff --git a/plugins/scaffolder-backend-module-azure/report.api.md b/plugins/scaffolder-backend-module-azure/report.api.md index f61fff9b0f..e15aba0fa4 100644 --- a/plugins/scaffolder-backend-module-azure/report.api.md +++ b/plugins/scaffolder-backend-module-azure/report.api.md @@ -20,13 +20,13 @@ export function createPublishAzureAction(options: { }): TemplateAction< { repoUrl: string; - description?: string | undefined; - defaultBranch?: string | undefined; - sourcePath?: string | undefined; - token?: string | undefined; - gitCommitMessage?: string | undefined; - gitAuthorName?: string | undefined; - gitAuthorEmail?: string | undefined; + description?: string; + defaultBranch?: string; + sourcePath?: string; + token?: string; + gitCommitMessage?: string; + gitAuthorName?: string; + gitAuthorEmail?: string; }, JsonObject >; diff --git a/plugins/scaffolder-backend-module-bitbucket-cloud/report.api.md b/plugins/scaffolder-backend-module-bitbucket-cloud/report.api.md index b853023b07..ad74479b6e 100644 --- a/plugins/scaffolder-backend-module-bitbucket-cloud/report.api.md +++ b/plugins/scaffolder-backend-module-bitbucket-cloud/report.api.md @@ -20,8 +20,8 @@ export const createBitbucketPipelinesRunAction: (options: { { workspace: string; repo_slug: string; - body?: object | undefined; - token?: string | undefined; + body?: object; + token?: string; }, JsonObject >; @@ -33,12 +33,12 @@ export function createPublishBitbucketCloudAction(options: { }): TemplateAction< { repoUrl: string; - description?: string | undefined; - defaultBranch?: string | undefined; - repoVisibility?: 'private' | 'public' | undefined; - gitCommitMessage?: string | undefined; - sourcePath?: string | undefined; - token?: string | undefined; + description?: string; + defaultBranch?: string; + repoVisibility?: 'private' | 'public'; + gitCommitMessage?: string; + sourcePath?: string; + token?: string; }, JsonObject >; @@ -51,12 +51,12 @@ export function createPublishBitbucketCloudPullRequestAction(options: { { repoUrl: string; title: string; - description?: string | undefined; - targetBranch?: string | undefined; + description?: string; + targetBranch?: string; sourceBranch: string; - token?: string | undefined; - gitAuthorName?: string | undefined; - gitAuthorEmail?: string | undefined; + token?: string; + gitAuthorName?: string; + gitAuthorEmail?: string; }, JsonObject >; diff --git a/plugins/scaffolder-backend-module-bitbucket-server/report.api.md b/plugins/scaffolder-backend-module-bitbucket-server/report.api.md index 546a2d3834..e92c85b284 100644 --- a/plugins/scaffolder-backend-module-bitbucket-server/report.api.md +++ b/plugins/scaffolder-backend-module-bitbucket-server/report.api.md @@ -20,15 +20,15 @@ export function createPublishBitbucketServerAction(options: { }): TemplateAction< { repoUrl: string; - description?: string | undefined; - defaultBranch?: string | undefined; - repoVisibility?: 'private' | 'public' | undefined; - sourcePath?: string | undefined; - enableLFS?: boolean | undefined; - token?: string | undefined; - gitCommitMessage?: string | undefined; - gitAuthorName?: string | undefined; - gitAuthorEmail?: string | undefined; + description?: string; + defaultBranch?: string; + repoVisibility?: 'private' | 'public'; + sourcePath?: string; + enableLFS?: boolean; + token?: string; + gitCommitMessage?: string; + gitAuthorName?: string; + gitAuthorEmail?: string; }, JsonObject >; @@ -41,13 +41,13 @@ export function createPublishBitbucketServerPullRequestAction(options: { { repoUrl: string; title: string; - description?: string | undefined; - targetBranch?: string | undefined; + description?: string; + targetBranch?: string; sourceBranch: string; - reviewers?: string[] | undefined; - token?: string | undefined; - gitAuthorName?: string | undefined; - gitAuthorEmail?: string | undefined; + reviewers?: string[]; + token?: string; + gitAuthorName?: string; + gitAuthorEmail?: string; }, JsonObject >; diff --git a/plugins/scaffolder-backend-module-bitbucket/report.api.md b/plugins/scaffolder-backend-module-bitbucket/report.api.md index 952b1665fb..b90f2f8483 100644 --- a/plugins/scaffolder-backend-module-bitbucket/report.api.md +++ b/plugins/scaffolder-backend-module-bitbucket/report.api.md @@ -22,8 +22,8 @@ export const createBitbucketPipelinesRunAction: (options: { { workspace: string; repo_slug: string; - body?: object | undefined; - token?: string | undefined; + body?: object; + token?: string; }, JsonObject >; @@ -35,15 +35,15 @@ export function createPublishBitbucketAction(options: { }): TemplateAction< { repoUrl: string; - description?: string | undefined; - defaultBranch?: string | undefined; - repoVisibility?: 'private' | 'public' | undefined; - sourcePath?: string | undefined; - enableLFS?: boolean | undefined; - token?: string | undefined; - gitCommitMessage?: string | undefined; - gitAuthorName?: string | undefined; - gitAuthorEmail?: string | undefined; + description?: string; + defaultBranch?: string; + repoVisibility?: 'private' | 'public'; + sourcePath?: string; + enableLFS?: boolean; + token?: string; + gitCommitMessage?: string; + gitAuthorName?: string; + gitAuthorEmail?: string; }, JsonObject >; diff --git a/plugins/scaffolder-backend-module-cookiecutter/report.api.md b/plugins/scaffolder-backend-module-cookiecutter/report.api.md index 8321ac505c..36339ea722 100644 --- a/plugins/scaffolder-backend-module-cookiecutter/report.api.md +++ b/plugins/scaffolder-backend-module-cookiecutter/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { BackendFeature } from '@backstage/backend-plugin-api'; import { JsonObject } from '@backstage/types'; import { ScmIntegrations } from '@backstage/integration'; @@ -50,11 +48,11 @@ export function createFetchCookiecutterAction(options: { }): TemplateAction< { url: string; - targetPath?: string | undefined; + targetPath?: string; values: JsonObject; - copyWithoutRender?: string[] | undefined; - extensions?: string[] | undefined; - imageName?: string | undefined; + copyWithoutRender?: string[]; + extensions?: string[]; + imageName?: string; }, JsonObject >; diff --git a/plugins/scaffolder-backend-module-gerrit/report.api.md b/plugins/scaffolder-backend-module-gerrit/report.api.md index 128f80954e..a3f23d7aa7 100644 --- a/plugins/scaffolder-backend-module-gerrit/report.api.md +++ b/plugins/scaffolder-backend-module-gerrit/report.api.md @@ -17,11 +17,11 @@ export function createPublishGerritAction(options: { { repoUrl: string; description: string; - defaultBranch?: string | undefined; - gitCommitMessage?: string | undefined; - gitAuthorName?: string | undefined; - gitAuthorEmail?: string | undefined; - sourcePath?: string | undefined; + defaultBranch?: string; + gitCommitMessage?: string; + gitAuthorName?: string; + gitAuthorEmail?: string; + sourcePath?: string; }, JsonObject >; @@ -33,11 +33,11 @@ export function createPublishGerritReviewAction(options: { }): TemplateAction< { repoUrl: string; - branch?: string | undefined; - sourcePath?: string | undefined; - gitCommitMessage?: string | undefined; - gitAuthorName?: string | undefined; - gitAuthorEmail?: string | undefined; + branch?: string; + sourcePath?: string; + gitCommitMessage?: string; + gitAuthorName?: string; + gitAuthorEmail?: string; }, JsonObject >; diff --git a/plugins/scaffolder-backend-module-gitea/report.api.md b/plugins/scaffolder-backend-module-gitea/report.api.md index 6d021bdf12..8456b7183c 100644 --- a/plugins/scaffolder-backend-module-gitea/report.api.md +++ b/plugins/scaffolder-backend-module-gitea/report.api.md @@ -17,12 +17,12 @@ export function createPublishGiteaAction(options: { { repoUrl: string; description: string; - defaultBranch?: string | undefined; - repoVisibility?: 'private' | 'public' | undefined; - gitCommitMessage?: string | undefined; - gitAuthorName?: string | undefined; - gitAuthorEmail?: string | undefined; - sourcePath?: string | undefined; + defaultBranch?: string; + repoVisibility?: 'private' | 'public'; + gitCommitMessage?: string; + gitAuthorName?: string; + gitAuthorEmail?: string; + sourcePath?: string; }, JsonObject >; diff --git a/plugins/scaffolder-backend-module-github/report.api.md b/plugins/scaffolder-backend-module-github/report.api.md index 7e8759db60..e2d124eb6f 100644 --- a/plugins/scaffolder-backend-module-github/report.api.md +++ b/plugins/scaffolder-backend-module-github/report.api.md @@ -25,12 +25,10 @@ export function createGithubActionsDispatchAction(options: { repoUrl: string; workflowId: string; branchOrTagName: string; - workflowInputs?: - | { - [key: string]: string; - } - | undefined; - token?: string | undefined; + workflowInputs?: { + [key: string]: string; + }; + token?: string; }, JsonObject >; @@ -44,8 +42,8 @@ export function createGithubAutolinksAction(options: { repoUrl: string; keyPrefix: string; urlTemplate: string; - isAlphanumeric?: boolean | undefined; - token?: string | undefined; + isAlphanumeric?: boolean; + token?: string; }, JsonObject >; @@ -56,11 +54,11 @@ export function createGithubBranchProtectionAction(options: { }): TemplateAction< { repoUrl: string; - branch?: string | undefined; - enforceAdmins?: boolean | undefined; - requiredApprovingReviewCount?: number | undefined; - requireCodeOwnerReviews?: boolean | undefined; - dismissStaleReviews?: boolean | undefined; + branch?: string; + enforceAdmins?: boolean; + requiredApprovingReviewCount?: number; + requireCodeOwnerReviews?: boolean; + dismissStaleReviews?: boolean; bypassPullRequestAllowances?: | { users?: string[]; @@ -75,13 +73,13 @@ export function createGithubBranchProtectionAction(options: { apps?: string[]; } | undefined; - requiredStatusCheckContexts?: string[] | undefined; - requireBranchesToBeUpToDate?: boolean | undefined; - requiredConversationResolution?: boolean | undefined; - requireLastPushApproval?: boolean | undefined; - requiredCommitSigning?: boolean | undefined; - requiredLinearHistory?: boolean | undefined; - token?: string | undefined; + requiredStatusCheckContexts?: string[]; + requireBranchesToBeUpToDate?: boolean; + requiredConversationResolution?: boolean; + requireLastPushApproval?: boolean; + requiredCommitSigning?: boolean; + requiredLinearHistory?: boolean; + token?: string; }, JsonObject >; @@ -95,8 +93,8 @@ export function createGithubDeployKeyAction(options: { publicKey: string; privateKey: string; deployKeyName: string; - privateKeySecretName?: string | undefined; - token?: string | undefined; + privateKeySecretName?: string; + token?: string; }, JsonObject >; @@ -110,28 +108,22 @@ export function createGithubEnvironmentAction(options: { { repoUrl: string; name: string; - deploymentBranchPolicy?: - | { - protected_branches: boolean; - custom_branch_policies: boolean; - } - | undefined; - customBranchPolicyNames?: string[] | undefined; - customTagPolicyNames?: string[] | undefined; - environmentVariables?: - | { - [key: string]: string; - } - | undefined; - secrets?: - | { - [key: string]: string; - } - | undefined; - token?: string | undefined; - waitTimer?: number | undefined; - preventSelfReview?: boolean | undefined; - reviewers?: string[] | undefined; + deploymentBranchPolicy?: { + protected_branches: boolean; + custom_branch_policies: boolean; + }; + customBranchPolicyNames?: string[]; + customTagPolicyNames?: string[]; + environmentVariables?: { + [key: string]: string; + }; + secrets?: { + [key: string]: string; + }; + token?: string; + waitTimer?: number; + preventSelfReview?: boolean; + reviewers?: string[]; }, JsonObject >; @@ -145,7 +137,7 @@ export function createGithubIssuesLabelAction(options: { repoUrl: string; number: number; labels: string[]; - token?: string | undefined; + token?: string; }, JsonObject >; @@ -157,10 +149,10 @@ export function createGithubPagesEnableAction(options: { }): TemplateAction< { repoUrl: string; - buildType?: 'legacy' | 'workflow' | undefined; - sourceBranch?: string | undefined; - sourcePath?: '/' | '/docs' | undefined; - token?: string | undefined; + buildType?: 'legacy' | 'workflow'; + sourceBranch?: string; + sourcePath?: '/' | '/docs'; + token?: string; }, JsonObject >; @@ -199,87 +191,69 @@ export function createGithubRepoCreateAction(options: { }): TemplateAction< { repoUrl: string; - description?: string | undefined; - homepage?: string | undefined; - access?: string | undefined; - deleteBranchOnMerge?: boolean | undefined; - gitAuthorName?: string | undefined; - gitAuthorEmail?: string | undefined; - allowRebaseMerge?: boolean | undefined; - allowSquashMerge?: boolean | undefined; - squashMergeCommitTitle?: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE' | undefined; - squashMergeCommitMessage?: - | 'PR_BODY' - | 'COMMIT_MESSAGES' - | 'BLANK' - | undefined; - allowMergeCommit?: boolean | undefined; - allowAutoMerge?: boolean | undefined; - requireCodeOwnerReviews?: boolean | undefined; - bypassPullRequestAllowances?: + description?: string; + homepage?: string; + access?: string; + deleteBranchOnMerge?: boolean; + gitAuthorName?: string; + gitAuthorEmail?: string; + allowRebaseMerge?: boolean; + allowSquashMerge?: boolean; + squashMergeCommitTitle?: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE'; + squashMergeCommitMessage?: 'PR_BODY' | 'COMMIT_MESSAGES' | 'BLANK'; + allowMergeCommit?: boolean; + allowAutoMerge?: boolean; + requireCodeOwnerReviews?: boolean; + bypassPullRequestAllowances?: { + users?: string[]; + teams?: string[]; + apps?: string[]; + }; + requiredApprovingReviewCount?: number; + restrictions?: { + users: string[]; + teams: string[]; + apps?: string[]; + }; + requiredStatusCheckContexts?: string[]; + requireBranchesToBeUpToDate?: boolean; + requiredConversationResolution?: boolean; + repoVisibility?: 'private' | 'internal' | 'public'; + collaborators?: Array< | { - users?: string[] | undefined; - teams?: string[] | undefined; - apps?: string[] | undefined; + user: string; + access: string; } - | undefined; - requiredApprovingReviewCount?: number | undefined; - restrictions?: | { - users: string[]; - teams: string[]; - apps?: string[] | undefined; + team: string; + access: string; } - | undefined; - requiredStatusCheckContexts?: string[] | undefined; - requireBranchesToBeUpToDate?: boolean | undefined; - requiredConversationResolution?: boolean | undefined; - repoVisibility?: 'internal' | 'private' | 'public' | undefined; - collaborators?: - | ( - | { - user: string; - access: string; - } - | { - team: string; - access: string; - } - | { - username: string; - access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage'; - } - )[] - | undefined; - hasProjects?: boolean | undefined; - hasWiki?: boolean | undefined; - hasIssues?: boolean | undefined; - token?: string | undefined; - topics?: string[] | undefined; - repoVariables?: | { - [key: string]: string; + username: string; + access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage'; } - | undefined; - secrets?: - | { - [key: string]: string; - } - | undefined; - oidcCustomization?: - | { - useDefault: boolean; - includeClaimKeys?: string[] | undefined; - } - | undefined; - requireCommitSigning?: boolean | undefined; - requiredLinearHistory?: boolean | undefined; - customProperties?: - | { - [key: string]: string; - } - | undefined; - subscribe?: boolean | undefined; + >; + hasProjects?: boolean; + hasWiki?: boolean; + hasIssues?: boolean; + token?: string; + topics?: string[]; + repoVariables?: { + [key: string]: string; + }; + secrets?: { + [key: string]: string; + }; + oidcCustomization?: { + useDefault: boolean; + includeClaimKeys?: string[]; + }; + requireCommitSigning?: boolean; + requiredLinearHistory?: boolean; + customProperties?: { + [key: string]: string; + }; + subscribe?: boolean; }, JsonObject >; @@ -292,15 +266,15 @@ export function createGithubRepoPushAction(options: { }): TemplateAction< { repoUrl: string; - description?: string | undefined; - defaultBranch?: string | undefined; - protectDefaultBranch?: boolean | undefined; - protectEnforceAdmins?: boolean | undefined; - gitCommitMessage?: string | undefined; - gitAuthorName?: string | undefined; - gitAuthorEmail?: string | undefined; - requireCodeOwnerReviews?: boolean | undefined; - dismissStaleReviews?: boolean | undefined; + description?: string; + defaultBranch?: string; + protectDefaultBranch?: boolean; + protectEnforceAdmins?: boolean; + gitCommitMessage?: string; + gitAuthorName?: string; + gitAuthorEmail?: string; + requireCodeOwnerReviews?: boolean; + dismissStaleReviews?: boolean; bypassPullRequestAllowances?: | { users?: string[]; @@ -308,7 +282,7 @@ export function createGithubRepoPushAction(options: { apps?: string[]; } | undefined; - requiredApprovingReviewCount?: number | undefined; + requiredApprovingReviewCount?: number; restrictions?: | { users: string[]; @@ -316,14 +290,14 @@ export function createGithubRepoPushAction(options: { apps?: string[]; } | undefined; - requiredStatusCheckContexts?: string[] | undefined; - requireBranchesToBeUpToDate?: boolean | undefined; - requiredConversationResolution?: boolean | undefined; - sourcePath?: string | undefined; - token?: string | undefined; - requiredCommitSigning?: boolean | undefined; - requiredLinearHistory?: boolean | undefined; - requireLastPushApproval?: boolean | undefined; + requiredStatusCheckContexts?: string[]; + requireBranchesToBeUpToDate?: boolean; + requiredConversationResolution?: boolean; + sourcePath?: string; + token?: string; + requiredCommitSigning?: boolean; + requiredLinearHistory?: boolean; + requireLastPushApproval?: boolean; }, JsonObject >; @@ -337,12 +311,12 @@ export function createGithubWebhookAction(options: { { repoUrl: string; webhookUrl: string; - webhookSecret?: string | undefined; - events?: string[] | undefined; - active?: boolean | undefined; - contentType?: 'form' | 'json' | undefined; - insecureSsl?: boolean | undefined; - token?: string | undefined; + webhookSecret?: string; + events?: string[]; + active?: boolean; + contentType?: 'form' | 'json'; + insecureSsl?: boolean; + token?: string; }, JsonObject >; @@ -355,27 +329,23 @@ export function createPublishGithubAction(options: { }): TemplateAction< { repoUrl: string; - description?: string | undefined; - homepage?: string | undefined; - access?: string | undefined; - defaultBranch?: string | undefined; - protectDefaultBranch?: boolean | undefined; - protectEnforceAdmins?: boolean | undefined; - deleteBranchOnMerge?: boolean | undefined; - gitCommitMessage?: string | undefined; - gitAuthorName?: string | undefined; - gitAuthorEmail?: string | undefined; - allowRebaseMerge?: boolean | undefined; - allowSquashMerge?: boolean | undefined; - squashMergeCommitTitle?: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE' | undefined; - squashMergeCommitMessage?: - | 'PR_BODY' - | 'COMMIT_MESSAGES' - | 'BLANK' - | undefined; - allowMergeCommit?: boolean | undefined; - allowAutoMerge?: boolean | undefined; - sourcePath?: string | undefined; + description?: string; + homepage?: string; + access?: string; + defaultBranch?: string; + protectDefaultBranch?: boolean; + protectEnforceAdmins?: boolean; + deleteBranchOnMerge?: boolean; + gitCommitMessage?: string; + gitAuthorName?: string; + gitAuthorEmail?: string; + allowRebaseMerge?: boolean; + allowSquashMerge?: boolean; + squashMergeCommitTitle?: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE'; + squashMergeCommitMessage?: 'PR_BODY' | 'COMMIT_MESSAGES' | 'BLANK'; + allowMergeCommit?: boolean; + allowAutoMerge?: boolean; + sourcePath?: string; bypassPullRequestAllowances?: | { users?: string[]; @@ -383,7 +353,7 @@ export function createPublishGithubAction(options: { apps?: string[]; } | undefined; - requiredApprovingReviewCount?: number | undefined; + requiredApprovingReviewCount?: number; restrictions?: | { users: string[]; @@ -391,58 +361,48 @@ export function createPublishGithubAction(options: { apps?: string[]; } | undefined; - requireCodeOwnerReviews?: boolean | undefined; - dismissStaleReviews?: boolean | undefined; - requiredStatusCheckContexts?: string[] | undefined; - requireBranchesToBeUpToDate?: boolean | undefined; - requiredConversationResolution?: boolean | undefined; - requireLastPushApproval?: boolean | undefined; - repoVisibility?: 'internal' | 'private' | 'public' | undefined; - collaborators?: - | ( - | { - user: string; - access: string; - } - | { - team: string; - access: string; - } - | { - username: string; - access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage'; - } - )[] - | undefined; + requireCodeOwnerReviews?: boolean; + dismissStaleReviews?: boolean; + requiredStatusCheckContexts?: string[]; + requireBranchesToBeUpToDate?: boolean; + requiredConversationResolution?: boolean; + requireLastPushApproval?: boolean; + repoVisibility?: 'private' | 'internal' | 'public'; + collaborators?: Array< + | { + user: string; + access: string; + } + | { + team: string; + access: string; + } + | { + username: string; + access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage'; + } + >; hasProjects?: boolean | undefined; hasWiki?: boolean | undefined; hasIssues?: boolean | undefined; - token?: string | undefined; - topics?: string[] | undefined; - repoVariables?: - | { - [key: string]: string; - } - | undefined; - secrets?: - | { - [key: string]: string; - } - | undefined; - oidcCustomization?: - | { - useDefault: boolean; - includeClaimKeys?: string[] | undefined; - } - | undefined; - requiredCommitSigning?: boolean | undefined; - requiredLinearHistory?: boolean | undefined; - customProperties?: - | { - [key: string]: string; - } - | undefined; - subscribe?: boolean | undefined; + token?: string; + topics?: string[]; + repoVariables?: { + [key: string]: string; + }; + secrets?: { + [key: string]: string; + }; + oidcCustomization?: { + useDefault: boolean; + includeClaimKeys?: string[]; + }; + requiredCommitSigning?: boolean; + requiredLinearHistory?: boolean; + customProperties?: { + [key: string]: string; + }; + subscribe?: boolean; }, JsonObject >; @@ -454,22 +414,22 @@ export const createPublishGithubPullRequestAction: ( { title: string; branchName: string; - targetBranchName?: string | undefined; + targetBranchName?: string; description: string; repoUrl: string; - draft?: boolean | undefined; - targetPath?: string | undefined; - sourcePath?: string | undefined; - token?: string | undefined; - reviewers?: string[] | undefined; - teamReviewers?: string[] | undefined; - commitMessage?: string | undefined; - update?: boolean | undefined; - forceFork?: boolean | undefined; - gitAuthorName?: string | undefined; - gitAuthorEmail?: string | undefined; - forceEmptyGitAuthor?: boolean | undefined; - createWhenEmpty?: boolean | undefined; + draft?: boolean; + targetPath?: string; + sourcePath?: string; + token?: string; + reviewers?: string[]; + teamReviewers?: string[]; + commitMessage?: string; + update?: boolean; + forceFork?: boolean; + gitAuthorName?: string; + gitAuthorEmail?: string; + forceEmptyGitAuthor?: boolean; + createWhenEmpty?: boolean; }, JsonObject >; diff --git a/plugins/scaffolder-backend-module-gitlab/report.api.md b/plugins/scaffolder-backend-module-gitlab/report.api.md index aae92a0278..d50104e98e 100644 --- a/plugins/scaffolder-backend-module-gitlab/report.api.md +++ b/plugins/scaffolder-backend-module-gitlab/report.api.md @@ -121,10 +121,10 @@ export const createGitlabRepoPushAction: (options: { repoUrl: string; branchName: string; commitMessage: string; - sourcePath?: string | undefined; - targetPath?: string | undefined; - token?: string | undefined; - commitAction?: 'update' | 'delete' | 'create' | undefined; + sourcePath?: string; + targetPath?: string; + token?: string; + commitAction?: 'create' | 'delete' | 'update'; }, JsonObject >; @@ -136,58 +136,45 @@ export function createPublishGitlabAction(options: { }): TemplateAction< { repoUrl: string; - defaultBranch?: string | undefined; - repoVisibility?: 'internal' | 'private' | 'public' | undefined; - sourcePath?: string | boolean | undefined; - skipExisting?: boolean | undefined; - token?: string | undefined; - gitCommitMessage?: string | undefined; - gitAuthorName?: string | undefined; - gitAuthorEmail?: string | undefined; - setUserAsOwner?: boolean | undefined; - topics?: string[] | undefined; - settings?: - | { - path?: string | undefined; - auto_devops_enabled?: boolean | undefined; - ci_config_path?: string | undefined; - description?: string | undefined; - merge_method?: 'merge' | 'ff' | 'rebase_merge' | undefined; - squash_option?: - | 'always' - | 'never' - | 'default_on' - | 'default_off' - | undefined; - topics?: string[] | undefined; - visibility?: 'internal' | 'private' | 'public' | undefined; - only_allow_merge_if_all_discussions_are_resolved?: - | boolean - | undefined; - only_allow_merge_if_pipeline_succeeds?: boolean | undefined; - allow_merge_on_skipped_pipeline?: boolean | undefined; - } - | undefined; - branches?: - | { - name: string; - protect?: boolean | undefined; - create?: boolean | undefined; - ref?: string | undefined; - }[] - | undefined; - projectVariables?: - | { - key: string; - value: string; - description?: string | undefined; - variable_type?: string | undefined; - protected?: boolean | undefined; - masked?: boolean | undefined; - raw?: boolean | undefined; - environment_scope?: string | undefined; - }[] - | undefined; + defaultBranch?: string; + repoVisibility?: 'private' | 'internal' | 'public'; + sourcePath?: string | boolean; + skipExisting?: boolean; + token?: string; + gitCommitMessage?: string; + gitAuthorName?: string; + gitAuthorEmail?: string; + setUserAsOwner?: boolean; + topics?: string[]; + settings?: { + path?: string; + auto_devops_enabled?: boolean; + ci_config_path?: string; + description?: string; + merge_method?: 'merge' | 'rebase_merge' | 'ff'; + squash_option?: 'default_off' | 'default_on' | 'never' | 'always'; + topics?: string[]; + visibility?: 'private' | 'internal' | 'public'; + only_allow_merge_if_all_discussions_are_resolved?: boolean; + only_allow_merge_if_pipeline_succeeds?: boolean; + allow_merge_on_skipped_pipeline?: boolean; + }; + branches?: Array<{ + name: string; + protect?: boolean; + create?: boolean; + ref?: string; + }>; + projectVariables?: Array<{ + key: string; + value: string; + description?: string; + variable_type?: string; + protected?: boolean; + masked?: boolean; + raw?: boolean; + environment_scope?: string; + }>; }, JsonObject >; @@ -201,16 +188,16 @@ export const createPublishGitlabMergeRequestAction: (options: { title: string; description: string; branchName: string; - targetBranchName?: string | undefined; - sourcePath?: string | undefined; - targetPath?: string | undefined; - token?: string | undefined; - commitAction?: 'auto' | 'update' | 'delete' | 'create' | 'skip' | undefined; - projectid?: string | undefined; - removeSourceBranch?: boolean | undefined; - assignee?: string | undefined; - reviewers?: string[] | undefined; - assignReviewersFromApprovalRules?: boolean | undefined; + targetBranchName?: string; + sourcePath?: string; + targetPath?: string; + token?: string; + commitAction?: 'create' | 'delete' | 'update' | 'skip' | 'auto'; + projectid?: string; + removeSourceBranch?: boolean; + assignee?: string; + reviewers?: string[]; + assignReviewersFromApprovalRules?: boolean; }, JsonObject >; diff --git a/plugins/scaffolder-backend-module-notifications/report.api.md b/plugins/scaffolder-backend-module-notifications/report.api.md index 091782449f..1c2bcf5f64 100644 --- a/plugins/scaffolder-backend-module-notifications/report.api.md +++ b/plugins/scaffolder-backend-module-notifications/report.api.md @@ -15,13 +15,13 @@ export function createSendNotificationAction(options: { }): TemplateAction< { recipients: string; - entityRefs?: string[] | undefined; + entityRefs?: string[]; title: string; - info?: string | undefined; - link?: string | undefined; - severity?: NotificationSeverity | undefined; - scope?: string | undefined; - optional?: boolean | undefined; + info?: string; + link?: string; + severity?: NotificationSeverity; + scope?: string; + optional?: boolean; }, JsonObject >; diff --git a/plugins/scaffolder-backend-module-rails/report.api.md b/plugins/scaffolder-backend-module-rails/report.api.md index ef45922221..846e2fe77f 100644 --- a/plugins/scaffolder-backend-module-rails/report.api.md +++ b/plugins/scaffolder-backend-module-rails/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { BackendFeature } from '@backstage/backend-plugin-api'; import { JsonObject } from '@backstage/types'; import { ScmIntegrations } from '@backstage/integration'; @@ -47,9 +45,9 @@ export function createFetchRailsAction(options: { }): TemplateAction< { url: string; - targetPath?: string | undefined; + targetPath?: string; values: JsonObject; - imageName?: string | undefined; + imageName?: string; }, JsonObject >; diff --git a/plugins/scaffolder-backend-module-sentry/report.api.md b/plugins/scaffolder-backend-module-sentry/report.api.md index a857d10fdd..ff31bd62c3 100644 --- a/plugins/scaffolder-backend-module-sentry/report.api.md +++ b/plugins/scaffolder-backend-module-sentry/report.api.md @@ -16,8 +16,8 @@ export function createSentryCreateProjectAction(options: { organizationSlug: string; teamSlug: string; name: string; - slug?: string | undefined; - authToken?: string | undefined; + slug?: string; + authToken?: string; }, JsonObject >; diff --git a/plugins/scaffolder-backend-module-yeoman/report.api.md b/plugins/scaffolder-backend-module-yeoman/report.api.md index 9980dc2152..ac262abcf6 100644 --- a/plugins/scaffolder-backend-module-yeoman/report.api.md +++ b/plugins/scaffolder-backend-module-yeoman/report.api.md @@ -11,8 +11,8 @@ import { TemplateAction } from '@backstage/plugin-scaffolder-node'; export function createRunYeomanAction(): TemplateAction< { namespace: string; - args?: string[] | undefined; - options?: JsonObject | undefined; + args?: string[]; + options?: JsonObject; }, JsonObject >; diff --git a/plugins/scaffolder-backend/report.api.md b/plugins/scaffolder-backend/report.api.md index 3e58f8c4db..18813154f2 100644 --- a/plugins/scaffolder-backend/report.api.md +++ b/plugins/scaffolder-backend/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { ActionContext as ActionContext_2 } from '@backstage/plugin-scaffolder-node'; import { AuditorService } from '@backstage/backend-plugin-api'; import { AuthService } from '@backstage/backend-plugin-api'; @@ -81,7 +79,6 @@ import { TemplateParametersV1beta3 } from '@backstage/plugin-scaffolder-common'; import { UrlReaderService } from '@backstage/backend-plugin-api'; import { WorkspaceProvider } from '@backstage/plugin-scaffolder-node/alpha'; import { ZodType } from 'zod'; -import { ZodTypeDef } from 'zod'; // @public @deprecated (undocumented) export type ActionContext = ActionContext_2; @@ -121,12 +118,12 @@ export function createCatalogRegisterAction(options: { }): TemplateAction_2< | { catalogInfoUrl: string; - optional?: boolean | undefined; + optional?: boolean; } | { repoContentsUrl: string; - catalogInfoPath?: string | undefined; - optional?: boolean | undefined; + catalogInfoPath?: string; + optional?: boolean; }, JsonObject >; @@ -143,8 +140,8 @@ export function createCatalogWriteAction(): TemplateAction_2< // @public export function createDebugLogAction(): TemplateAction_2< { - message?: string | undefined; - listWorkspace?: boolean | 'with-contents' | 'with-filenames' | undefined; + message?: string; + listWorkspace?: boolean | 'with-filenames' | 'with-contents'; }, JsonObject >; @@ -174,8 +171,8 @@ export function createFetchPlainAction(options: { }): TemplateAction_2< { url: string; - targetPath?: string | undefined; - token?: string | undefined; + targetPath?: string; + token?: string; }, JsonObject >; @@ -188,7 +185,7 @@ export function createFetchPlainFileAction(options: { { url: string; targetPath: string; - token?: string | undefined; + token?: string; }, JsonObject >; @@ -202,16 +199,16 @@ export function createFetchTemplateAction(options: { }): TemplateAction_2< { url: string; - targetPath?: string | undefined; + targetPath?: string; values: any; - templateFileExtension?: string | boolean | undefined; - copyWithoutRender?: string[] | undefined; - copyWithoutTemplating?: string[] | undefined; - cookiecutterCompat?: boolean | undefined; - replace?: boolean | undefined; - trimBlocks?: boolean | undefined; - lstripBlocks?: boolean | undefined; - token?: string | undefined; + templateFileExtension?: string | boolean; + copyWithoutRender?: string[]; + copyWithoutTemplating?: string[]; + cookiecutterCompat?: boolean; + replace?: boolean; + trimBlocks?: boolean; + lstripBlocks?: boolean; + token?: string; }, JsonObject >; @@ -227,11 +224,11 @@ export function createFetchTemplateFileAction(options: { url: string; targetPath: string; values: any; - cookiecutterCompat?: boolean | undefined; - replace?: boolean | undefined; - trimBlocks?: boolean | undefined; - lstripBlocks?: boolean | undefined; - token?: string | undefined; + cookiecutterCompat?: boolean; + replace?: boolean; + trimBlocks?: boolean; + lstripBlocks?: boolean; + token?: string; }, JsonObject >; @@ -332,22 +329,22 @@ export const createPublishGithubPullRequestAction: ( { title: string; branchName: string; - targetBranchName?: string | undefined; + targetBranchName?: string; description: string; repoUrl: string; - draft?: boolean | undefined; - targetPath?: string | undefined; - sourcePath?: string | undefined; - token?: string | undefined; - reviewers?: string[] | undefined; - teamReviewers?: string[] | undefined; - commitMessage?: string | undefined; - update?: boolean | undefined; - forceFork?: boolean | undefined; - gitAuthorName?: string | undefined; - gitAuthorEmail?: string | undefined; - forceEmptyGitAuthor?: boolean | undefined; - createWhenEmpty?: boolean | undefined; + draft?: boolean; + targetPath?: string; + sourcePath?: string; + token?: string; + reviewers?: string[]; + teamReviewers?: string[]; + commitMessage?: string; + update?: boolean; + forceFork?: boolean; + gitAuthorName?: string; + gitAuthorEmail?: string; + forceEmptyGitAuthor?: boolean; + createWhenEmpty?: boolean; }, JsonObject >; @@ -364,16 +361,16 @@ export const createPublishGitlabMergeRequestAction: (options: { title: string; description: string; branchName: string; - targetBranchName?: string | undefined; - sourcePath?: string | undefined; - targetPath?: string | undefined; - token?: string | undefined; - commitAction?: 'auto' | 'update' | 'delete' | 'create' | 'skip' | undefined; - projectid?: string | undefined; - removeSourceBranch?: boolean | undefined; - assignee?: string | undefined; - reviewers?: string[] | undefined; - assignReviewersFromApprovalRules?: boolean | undefined; + targetBranchName?: string; + sourcePath?: string; + targetPath?: string; + token?: string; + commitAction?: 'create' | 'delete' | 'update' | 'skip' | 'auto'; + projectid?: string; + removeSourceBranch?: boolean; + assignee?: string; + reviewers?: string[]; + assignReviewersFromApprovalRules?: boolean; }, JsonObject >; @@ -385,8 +382,8 @@ export function createRouter(options: RouterOptions): Promise; export const createTemplateAction: < TInputParams extends JsonObject = JsonObject, TOutputParams extends JsonObject = JsonObject, - TInputSchema extends ZodType | Schema = {}, - TOutputSchema extends ZodType | Schema = {}, + TInputSchema extends Schema | ZodType = {}, + TOutputSchema extends Schema | ZodType = {}, TActionInput extends JsonObject = TInputSchema extends ZodType< any, any, diff --git a/plugins/scaffolder-node-test-utils/report.api.md b/plugins/scaffolder-node-test-utils/report.api.md index d6cda70b48..b95d4cef0c 100644 --- a/plugins/scaffolder-node-test-utils/report.api.md +++ b/plugins/scaffolder-node-test-utils/report.api.md @@ -11,7 +11,7 @@ export const createMockActionContext: < TActionInput extends JsonObject = JsonObject, TActionOutput extends JsonObject = JsonObject, >( - options?: Partial> | undefined, + options?: Partial>, ) => ActionContext; // (No @packageDocumentation comment for this package) diff --git a/plugins/scaffolder-node/report-alpha.api.md b/plugins/scaffolder-node/report-alpha.api.md index b561fe93e1..8ecc54f031 100644 --- a/plugins/scaffolder-node/report-alpha.api.md +++ b/plugins/scaffolder-node/report-alpha.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { ExtensionPoint } from '@backstage/backend-plugin-api'; import { JsonValue } from '@backstage/types'; import { TaskBroker } from '@backstage/plugin-scaffolder-node'; @@ -94,7 +92,7 @@ export type CreatedTemplateGlobalValue = { export const createTemplateFilter: < TSchema extends TemplateFilterSchema | undefined, TFunctionSchema extends TSchema extends TemplateFilterSchema - ? z.TypeOf> + ? z.infer> : (arg: JsonValue, ...rest: JsonValue[]) => JsonValue | undefined, >( filter: CreatedTemplateFilter, @@ -104,7 +102,7 @@ export const createTemplateFilter: < export const createTemplateGlobalFunction: < TSchema extends TemplateGlobalFunctionSchema | undefined, TFilterSchema extends TSchema extends TemplateGlobalFunctionSchema - ? z.TypeOf> + ? z.infer> : (...args: JsonValue[]) => JsonValue | undefined, >( fn: CreatedTemplateGlobalFunction, diff --git a/plugins/scaffolder-node/report.api.md b/plugins/scaffolder-node/report.api.md index 2d3e418efb..333b47a6d1 100644 --- a/plugins/scaffolder-node/report.api.md +++ b/plugins/scaffolder-node/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { BackstageCredentials } from '@backstage/backend-plugin-api'; import { JsonObject } from '@backstage/types'; import { JsonValue } from '@backstage/types'; @@ -154,8 +152,8 @@ export function createBranch(options: { export const createTemplateAction: < TInputParams extends JsonObject = JsonObject, TOutputParams extends JsonObject = JsonObject, - TInputSchema extends z.ZodType | Schema = {}, - TOutputSchema extends z.ZodType | Schema = {}, + TInputSchema extends Schema | z.ZodType = {}, + TOutputSchema extends Schema | z.ZodType = {}, TActionInput extends JsonObject = TInputSchema extends z.ZodType< any, any, @@ -255,10 +253,10 @@ export const parseRepoUrl: ( ) => { repo: string; host: string; - owner?: string | undefined; - organization?: string | undefined; - workspace?: string | undefined; - project?: string | undefined; + owner?: string; + organization?: string; + workspace?: string; + project?: string; }; // @public (undocumented) diff --git a/plugins/scaffolder-react/report-alpha.api.md b/plugins/scaffolder-react/report-alpha.api.md index 9af439f15a..a242b100bb 100644 --- a/plugins/scaffolder-react/report-alpha.api.md +++ b/plugins/scaffolder-react/report-alpha.api.md @@ -3,8 +3,6 @@ > 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 { AnyApiRef } from '@backstage/core-plugin-api'; import { ApiHolder } from '@backstage/core-plugin-api'; @@ -463,15 +461,15 @@ export const useFormDataFromQuery: ( // @alpha (undocumented) export const useTemplateParameterSchema: (templateRef: string) => { - manifest?: TemplateParameterSchema | undefined; + manifest?: TemplateParameterSchema; loading: boolean; - error?: Error | undefined; + error?: Error; }; // @alpha export const useTemplateSchema: (manifest: TemplateParameterSchema) => { steps: ParsedTemplateSchema[]; - presentation?: TemplatePresentationV1beta3 | undefined; + presentation?: TemplatePresentationV1beta3; }; // @alpha (undocumented) diff --git a/plugins/scaffolder-react/report.api.md b/plugins/scaffolder-react/report.api.md index a357ff3176..d62a2b43d4 100644 --- a/plugins/scaffolder-react/report.api.md +++ b/plugins/scaffolder-react/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { ApiHolder } from '@backstage/core-plugin-api'; import { ApiRef } from '@backstage/frontend-plugin-api'; import { ComponentType } from 'react'; diff --git a/plugins/scaffolder/report-alpha.api.md b/plugins/scaffolder/report-alpha.api.md index e5b370f2e2..6c4ab666c4 100644 --- a/plugins/scaffolder/report-alpha.api.md +++ b/plugins/scaffolder/report-alpha.api.md @@ -3,8 +3,6 @@ > 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 { ApiRef } from '@backstage/frontend-plugin-api'; @@ -178,7 +176,7 @@ const _default: FrontendPlugin< params: { defaultPath: string; loader: () => Promise; - routeRef?: RouteRef | undefined; + routeRef?: RouteRef; }; }>; 'scaffolder-form-field:scaffolder/repo-url-picker': ExtensionDefinition<{ @@ -326,8 +324,8 @@ export const scaffolderTranslationRef: TranslationRef< readonly 'fields.repoUrlPicker.repository.inputTitle': 'Repository'; readonly 'actionsPage.content.emptyState.title': 'No information to display'; readonly 'actionsPage.content.emptyState.description': 'There are no actions installed or there was an issue communicating with backend.'; - readonly 'actionsPage.content.tableCell.type': 'Type'; readonly 'actionsPage.content.tableCell.name': 'Name'; + readonly 'actionsPage.content.tableCell.type': 'Type'; readonly 'actionsPage.content.tableCell.title': 'Title'; readonly 'actionsPage.content.tableCell.description': 'Description'; readonly 'actionsPage.content.searchFieldPlaceholder': 'Search for an action'; diff --git a/plugins/scaffolder/report.api.md b/plugins/scaffolder/report.api.md index 453b482ce2..c51423ed83 100644 --- a/plugins/scaffolder/report.api.md +++ b/plugins/scaffolder/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { ApiHolder } from '@backstage/core-plugin-api'; import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; @@ -580,7 +578,7 @@ export type ScaffolderDryRunResponse = ScaffolderDryRunResponse_2; // @public @deprecated (undocumented) export const ScaffolderFieldExtensions: ComponentType<{ - children?: ReactNode; + children?: ReactNode | undefined; }>; // @public @deprecated (undocumented) @@ -593,7 +591,7 @@ export type ScaffolderGetIntegrationsListResponse = // @public @deprecated (undocumented) export const ScaffolderLayouts: ComponentType<{ - children?: ReactNode; + children?: ReactNode | undefined; }>; // @public @deprecated (undocumented) diff --git a/plugins/search-backend-module-elasticsearch/report.api.md b/plugins/search-backend-module-elasticsearch/report.api.md index 74e70af364..cf7615541d 100644 --- a/plugins/search-backend-module-elasticsearch/report.api.md +++ b/plugins/search-backend-module-elasticsearch/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { ApiResponse } from '@opensearch-project/opensearch'; import { ApiResponse as ApiResponse_2 } from '@elastic/elasticsearch'; import { BackendFeature } from '@backstage/backend-plugin-api'; diff --git a/plugins/search-backend-module-explore/report.api.md b/plugins/search-backend-module-explore/report.api.md index 1b764129b2..6866de9eec 100644 --- a/plugins/search-backend-module-explore/report.api.md +++ b/plugins/search-backend-module-explore/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { AuthService } from '@backstage/backend-plugin-api'; import { BackendFeature } from '@backstage/backend-plugin-api'; import { Config } from '@backstage/config'; diff --git a/plugins/search-backend-module-stack-overflow-collator/report.api.md b/plugins/search-backend-module-stack-overflow-collator/report.api.md index 3b9b79c597..a4b731d52e 100644 --- a/plugins/search-backend-module-stack-overflow-collator/report.api.md +++ b/plugins/search-backend-module-stack-overflow-collator/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { BackendFeature } from '@backstage/backend-plugin-api'; import { Config } from '@backstage/config'; import { DocumentCollatorFactory } from '@backstage/plugin-search-common'; diff --git a/plugins/search-backend-module-techdocs/report.api.md b/plugins/search-backend-module-techdocs/report.api.md index ef041e6900..fadcd5578f 100644 --- a/plugins/search-backend-module-techdocs/report.api.md +++ b/plugins/search-backend-module-techdocs/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { AuthService } from '@backstage/backend-plugin-api'; import { BackendFeature } from '@backstage/backend-plugin-api'; import { CatalogApi } from '@backstage/catalog-client'; diff --git a/plugins/search-backend-node/report.api.md b/plugins/search-backend-node/report.api.md index 4e769d0eae..a5e3dea7d4 100644 --- a/plugins/search-backend-node/report.api.md +++ b/plugins/search-backend-node/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { BackstageCredentials } from '@backstage/backend-plugin-api'; import { Config } from '@backstage/config'; import { DocumentCollatorFactory } from '@backstage/plugin-search-common'; diff --git a/plugins/search-common/report.api.md b/plugins/search-common/report.api.md index 497defc46d..dac1ae1b25 100644 --- a/plugins/search-common/report.api.md +++ b/plugins/search-common/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { JsonObject } from '@backstage/types'; import { Permission } from '@backstage/plugin-permission-common'; import { Readable } from 'stream'; diff --git a/plugins/search-react/report-alpha.api.md b/plugins/search-react/report-alpha.api.md index 9e3cc4b9b8..98a3c533db 100644 --- a/plugins/search-react/report-alpha.api.md +++ b/plugins/search-react/report-alpha.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api'; import { ExtensionBlueprint } from '@backstage/frontend-plugin-api'; import { ListItemProps } from '@material-ui/core/ListItem'; @@ -115,7 +113,7 @@ export const SearchResultListItemBlueprint: ExtensionBlueprint<{ params: SearchResultListItemBlueprintParams; output: ConfigurableExtensionDataRef< { - predicate?: SearchResultItemExtensionPredicate | undefined; + predicate?: SearchResultItemExtensionPredicate; component: SearchResultItemExtensionComponent; }, 'search.search-result-list-item.item', @@ -131,7 +129,7 @@ export const SearchResultListItemBlueprint: ExtensionBlueprint<{ dataRefs: { item: ConfigurableExtensionDataRef< { - predicate?: SearchResultItemExtensionPredicate | undefined; + predicate?: SearchResultItemExtensionPredicate; component: SearchResultItemExtensionComponent; }, 'search.search-result-list-item.item', diff --git a/plugins/search-react/report.api.md b/plugins/search-react/report.api.md index 3efed073d8..ce80b8a363 100644 --- a/plugins/search-react/report.api.md +++ b/plugins/search-react/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { ApiRef } from '@backstage/core-plugin-api'; import { AsyncState } from 'react-use/esm/useAsync'; import { AutocompleteProps } from '@material-ui/lab/Autocomplete'; diff --git a/plugins/search/report-alpha.api.md b/plugins/search/report-alpha.api.md index ad9b86c244..538c9dcd2b 100644 --- a/plugins/search/report-alpha.api.md +++ b/plugins/search/report-alpha.api.md @@ -88,7 +88,7 @@ const _default: FrontendPlugin< items: ExtensionInput< ConfigurableExtensionDataRef< { - predicate?: SearchResultItemExtensionPredicate | undefined; + predicate?: SearchResultItemExtensionPredicate; component: SearchResultItemExtensionComponent; }, 'search.search-result-list-item.item', @@ -133,7 +133,7 @@ const _default: FrontendPlugin< params: { defaultPath: string; loader: () => Promise; - routeRef?: RouteRef | undefined; + routeRef?: RouteRef; }; }>; } @@ -202,7 +202,7 @@ export const searchPage: ExtensionDefinition<{ items: ExtensionInput< ConfigurableExtensionDataRef< { - predicate?: SearchResultItemExtensionPredicate | undefined; + predicate?: SearchResultItemExtensionPredicate; component: SearchResultItemExtensionComponent; }, 'search.search-result-list-item.item', @@ -247,7 +247,7 @@ export const searchPage: ExtensionDefinition<{ params: { defaultPath: string; loader: () => Promise; - routeRef?: RouteRef | undefined; + routeRef?: RouteRef; }; }>; diff --git a/plugins/search/report.api.md b/plugins/search/report.api.md index a47c11b194..32ba0d7ce0 100644 --- a/plugins/search/report.api.md +++ b/plugins/search/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { BackstagePlugin } from '@backstage/core-plugin-api'; import { IconComponent } from '@backstage/core-plugin-api'; import { JSX as JSX_2 } from 'react'; @@ -16,7 +14,7 @@ import { SearchResultSet } from '@backstage/plugin-search-common'; // @public (undocumented) export const HomePageSearchBar: ( - props: Partial>, + props: HomePageSearchBarProps, ) => JSX_2.Element; // @public diff --git a/plugins/techdocs-module-addons-contrib/report.api.md b/plugins/techdocs-module-addons-contrib/report.api.md index 48e6b2bcdc..dc8d7c1019 100644 --- a/plugins/techdocs-module-addons-contrib/report.api.md +++ b/plugins/techdocs-module-addons-contrib/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { BackstagePlugin } from '@backstage/core-plugin-api'; // @public diff --git a/plugins/techdocs-node/report.api.md b/plugins/techdocs-node/report.api.md index 945f6d8bb3..0e208edff1 100644 --- a/plugins/techdocs-node/report.api.md +++ b/plugins/techdocs-node/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { CompoundEntityRef } from '@backstage/catalog-model'; import { Config } from '@backstage/config'; import { DiscoveryService } from '@backstage/backend-plugin-api'; @@ -100,12 +98,10 @@ export const getLocationForEntity: ( // @public @deprecated (undocumented) export const getMkDocsYml: ( inputDir: string, - options?: - | { - name?: string | undefined; - mkdocsConfigFileName?: string | undefined; - } - | undefined, + options?: { + name?: string; + mkdocsConfigFileName?: string; + }, ) => Promise<{ path: string; content: string; diff --git a/plugins/techdocs/report-alpha.api.md b/plugins/techdocs/report-alpha.api.md index 0dcca55c73..21ce86464a 100644 --- a/plugins/techdocs/report-alpha.api.md +++ b/plugins/techdocs/report-alpha.api.md @@ -7,6 +7,7 @@ import { AnyApiFactory } from '@backstage/frontend-plugin-api'; import { AnyExtensionDataRef } from '@backstage/frontend-plugin-api'; import { AnyRouteRefParams } from '@backstage/frontend-plugin-api'; import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api'; +import { defaultEntityContentGroups } from '@backstage/plugin-catalog-react/alpha'; import { Entity } from '@backstage/catalog-model'; import { EntityPredicate } from '@backstage/plugin-catalog-react/alpha'; import { ExtensionDefinition } from '@backstage/frontend-plugin-api'; @@ -171,15 +172,9 @@ const _default: FrontendPlugin< loader: () => Promise; defaultPath: string; defaultTitle: string; - defaultGroup?: - | (string & {}) - | 'documentation' - | 'development' - | 'deployment' - | 'observability' - | undefined; - routeRef?: RouteRef | undefined; - filter?: EntityPredicate | ((entity: Entity) => boolean) | undefined; + defaultGroup?: keyof defaultEntityContentGroups | (string & {}); + routeRef?: RouteRef; + filter?: string | EntityPredicate | ((entity: Entity) => boolean); }; }>; 'nav-item:techdocs': ExtensionDefinition<{ @@ -230,7 +225,7 @@ const _default: FrontendPlugin< params: { defaultPath: string; loader: () => Promise; - routeRef?: RouteRef | undefined; + routeRef?: RouteRef; }; }>; 'page:techdocs/reader': ExtensionDefinition<{ @@ -272,7 +267,7 @@ const _default: FrontendPlugin< params: { defaultPath: string; loader: () => Promise; - routeRef?: RouteRef | undefined; + routeRef?: RouteRef; }; }>; 'search-result-list-item:techdocs': ExtensionDefinition<{ @@ -294,7 +289,7 @@ const _default: FrontendPlugin< }; output: ConfigurableExtensionDataRef< { - predicate?: SearchResultItemExtensionPredicate | undefined; + predicate?: SearchResultItemExtensionPredicate; component: SearchResultItemExtensionComponent; }, 'search.search-result-list-item.item', @@ -337,7 +332,7 @@ export const techDocsSearchResultListItemExtension: ExtensionDefinition<{ }; output: ConfigurableExtensionDataRef< { - predicate?: SearchResultItemExtensionPredicate | undefined; + predicate?: SearchResultItemExtensionPredicate; component: SearchResultItemExtensionComponent; }, 'search.search-result-list-item.item', diff --git a/plugins/techdocs/report.api.md b/plugins/techdocs/report.api.md index 12496bb5bd..a439b963a3 100644 --- a/plugins/techdocs/report.api.md +++ b/plugins/techdocs/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { CompoundEntityRef } from '@backstage/catalog-model'; @@ -106,13 +104,9 @@ export type DocsGroupConfig = { export const DocsTable: { (props: DocsTableProps): React_2.JSX.Element | null; columns: { - createTitleColumn( - options?: - | { - hidden?: boolean | undefined; - } - | undefined, - ): TableColumn; + createTitleColumn(options?: { + hidden?: boolean; + }): TableColumn; createNameColumn(): TableColumn; createOwnerColumn(): TableColumn; createKindColumn(): TableColumn; @@ -162,8 +156,8 @@ export type DocsTableRow = { export const EmbeddedDocsRouter: ({ children, withSearch, -}: React_2.PropsWithChildren<{ - withSearch?: boolean | undefined; +}: PropsWithChildren<{ + withSearch?: boolean; }>) => React_2.JSX.Element; // @public @@ -180,13 +174,9 @@ export type EntityListDocsGridPageProps = { export const EntityListDocsTable: { (props: EntityListDocsTableProps): React_2.JSX.Element; columns: { - createTitleColumn( - options?: - | { - hidden?: boolean | undefined; - } - | undefined, - ): TableColumn; + createTitleColumn(options?: { + hidden?: boolean; + }): TableColumn; createNameColumn(): TableColumn; createOwnerColumn(): TableColumn; createKindColumn(): TableColumn; @@ -224,7 +214,7 @@ export const EntityTechdocsContent: ({ children, withSearch, }: PropsWithChildren<{ - withSearch?: boolean | undefined; + withSearch?: boolean; }>) => JSX_2.Element; // @public diff --git a/plugins/user-settings/report-alpha.api.md b/plugins/user-settings/report-alpha.api.md index 63db1defe0..4f7ee7f59f 100644 --- a/plugins/user-settings/report-alpha.api.md +++ b/plugins/user-settings/report-alpha.api.md @@ -80,7 +80,7 @@ const _default: FrontendPlugin< params: { defaultPath: string; loader: () => Promise; - routeRef?: RouteRef | undefined; + routeRef?: RouteRef; }; }>; } diff --git a/plugins/user-settings/report.api.md b/plugins/user-settings/report.api.md index cee35724bb..08115fd375 100644 --- a/plugins/user-settings/report.api.md +++ b/plugins/user-settings/report.api.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { BackstageUserIdentity } from '@backstage/core-plugin-api'; @@ -102,7 +100,7 @@ export const UserSettingsMenu: () => React_2.JSX.Element; // @public (undocumented) export const UserSettingsPage: (props: { - providerSettings?: JSX.Element | undefined; + providerSettings?: JSX.Element; }) => JSX_2.Element; // @public (undocumented)