diff --git a/packages/app-defaults/api-report.api.md b/packages/app-defaults/report.api.md similarity index 100% rename from packages/app-defaults/api-report.api.md rename to packages/app-defaults/report.api.md diff --git a/packages/app-next-example-plugin/api-report.api.md b/packages/app-next-example-plugin/report.api.md similarity index 96% rename from packages/app-next-example-plugin/api-report.api.md rename to packages/app-next-example-plugin/report.api.md index ededab5e471c8..842e58aeb51e6 100644 --- a/packages/app-next-example-plugin/api-report.api.md +++ b/packages/app-next-example-plugin/report.api.md @@ -55,7 +55,7 @@ export const ExampleSidebarItem: () => React_2.JSX.Element; // Warnings were encountered during analysis: // // src/ExampleSidebarItem.d.ts:3:22 - (ae-undocumented) Missing documentation for "ExampleSidebarItem". -// src/plugin.d.ts:5:22 - (ae-undocumented) Missing documentation for "examplePlugin". +// src/plugin.d.ts:7:22 - (ae-undocumented) Missing documentation for "examplePlugin". // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-app-api/api-report-alpha.api.md b/packages/backend-app-api/report-alpha.api.md similarity index 100% rename from packages/backend-app-api/api-report-alpha.api.md rename to packages/backend-app-api/report-alpha.api.md diff --git a/packages/backend-app-api/api-report.api.md b/packages/backend-app-api/report.api.md similarity index 100% rename from packages/backend-app-api/api-report.api.md rename to packages/backend-app-api/report.api.md diff --git a/packages/backend-defaults/api-report-auth.api.md b/packages/backend-defaults/report-auth.api.md similarity index 100% rename from packages/backend-defaults/api-report-auth.api.md rename to packages/backend-defaults/report-auth.api.md diff --git a/packages/backend-defaults/api-report-cache.api.md b/packages/backend-defaults/report-cache.api.md similarity index 100% rename from packages/backend-defaults/api-report-cache.api.md rename to packages/backend-defaults/report-cache.api.md diff --git a/packages/backend-defaults/api-report-database.api.md b/packages/backend-defaults/report-database.api.md similarity index 100% rename from packages/backend-defaults/api-report-database.api.md rename to packages/backend-defaults/report-database.api.md diff --git a/packages/backend-defaults/api-report-discovery.api.md b/packages/backend-defaults/report-discovery.api.md similarity index 100% rename from packages/backend-defaults/api-report-discovery.api.md rename to packages/backend-defaults/report-discovery.api.md diff --git a/packages/backend-defaults/api-report-httpAuth.api.md b/packages/backend-defaults/report-httpAuth.api.md similarity index 100% rename from packages/backend-defaults/api-report-httpAuth.api.md rename to packages/backend-defaults/report-httpAuth.api.md diff --git a/packages/backend-defaults/api-report-httpRouter.api.md b/packages/backend-defaults/report-httpRouter.api.md similarity index 100% rename from packages/backend-defaults/api-report-httpRouter.api.md rename to packages/backend-defaults/report-httpRouter.api.md diff --git a/packages/backend-defaults/api-report-lifecycle.api.md b/packages/backend-defaults/report-lifecycle.api.md similarity index 100% rename from packages/backend-defaults/api-report-lifecycle.api.md rename to packages/backend-defaults/report-lifecycle.api.md diff --git a/packages/backend-defaults/api-report-logger.api.md b/packages/backend-defaults/report-logger.api.md similarity index 100% rename from packages/backend-defaults/api-report-logger.api.md rename to packages/backend-defaults/report-logger.api.md diff --git a/packages/backend-defaults/api-report-permissions.api.md b/packages/backend-defaults/report-permissions.api.md similarity index 100% rename from packages/backend-defaults/api-report-permissions.api.md rename to packages/backend-defaults/report-permissions.api.md diff --git a/packages/backend-defaults/api-report-rootConfig.api.md b/packages/backend-defaults/report-rootConfig.api.md similarity index 100% rename from packages/backend-defaults/api-report-rootConfig.api.md rename to packages/backend-defaults/report-rootConfig.api.md diff --git a/packages/backend-defaults/api-report-rootHealth.api.md b/packages/backend-defaults/report-rootHealth.api.md similarity index 100% rename from packages/backend-defaults/api-report-rootHealth.api.md rename to packages/backend-defaults/report-rootHealth.api.md diff --git a/packages/backend-defaults/api-report-rootHttpRouter.api.md b/packages/backend-defaults/report-rootHttpRouter.api.md similarity index 98% rename from packages/backend-defaults/api-report-rootHttpRouter.api.md rename to packages/backend-defaults/report-rootHttpRouter.api.md index 672844a98eeb9..9a435f5c270f4 100644 --- a/packages/backend-defaults/api-report-rootHttpRouter.api.md +++ b/packages/backend-defaults/report-rootHttpRouter.api.md @@ -159,6 +159,7 @@ export const rootHttpRouterServiceFactory: (( // src/entrypoints/rootHttpRouter/DefaultRootHttpRouter.d.ts:23:5 - (ae-undocumented) Missing documentation for "create". // src/entrypoints/rootHttpRouter/DefaultRootHttpRouter.d.ts:25:5 - (ae-undocumented) Missing documentation for "use". // src/entrypoints/rootHttpRouter/DefaultRootHttpRouter.d.ts:26:5 - (ae-undocumented) Missing documentation for "handler". +// src/entrypoints/rootHttpRouter/createHealthRouter.d.ts:6:1 - (ae-undocumented) Missing documentation for "createHealthRouter". // src/entrypoints/rootHttpRouter/http/MiddlewareFactory.d.ts:9:5 - (ae-undocumented) Missing documentation for "config". // src/entrypoints/rootHttpRouter/http/MiddlewareFactory.d.ts:10:5 - (ae-undocumented) Missing documentation for "logger". // src/entrypoints/rootHttpRouter/http/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "start". diff --git a/packages/backend-defaults/api-report-rootLifecycle.api.md b/packages/backend-defaults/report-rootLifecycle.api.md similarity index 100% rename from packages/backend-defaults/api-report-rootLifecycle.api.md rename to packages/backend-defaults/report-rootLifecycle.api.md diff --git a/packages/backend-defaults/api-report-rootLogger.api.md b/packages/backend-defaults/report-rootLogger.api.md similarity index 100% rename from packages/backend-defaults/api-report-rootLogger.api.md rename to packages/backend-defaults/report-rootLogger.api.md diff --git a/packages/backend-defaults/api-report-scheduler.api.md b/packages/backend-defaults/report-scheduler.api.md similarity index 100% rename from packages/backend-defaults/api-report-scheduler.api.md rename to packages/backend-defaults/report-scheduler.api.md diff --git a/packages/backend-defaults/api-report-urlReader.api.md b/packages/backend-defaults/report-urlReader.api.md similarity index 100% rename from packages/backend-defaults/api-report-urlReader.api.md rename to packages/backend-defaults/report-urlReader.api.md diff --git a/packages/backend-defaults/api-report-userInfo.api.md b/packages/backend-defaults/report-userInfo.api.md similarity index 100% rename from packages/backend-defaults/api-report-userInfo.api.md rename to packages/backend-defaults/report-userInfo.api.md diff --git a/packages/backend-defaults/api-report.api.md b/packages/backend-defaults/report.api.md similarity index 100% rename from packages/backend-defaults/api-report.api.md rename to packages/backend-defaults/report.api.md diff --git a/packages/backend-dev-utils/api-report.api.md b/packages/backend-dev-utils/report.api.md similarity index 100% rename from packages/backend-dev-utils/api-report.api.md rename to packages/backend-dev-utils/report.api.md diff --git a/packages/backend-dynamic-feature-service/api-report.api.md b/packages/backend-dynamic-feature-service/report.api.md similarity index 100% rename from packages/backend-dynamic-feature-service/api-report.api.md rename to packages/backend-dynamic-feature-service/report.api.md diff --git a/packages/backend-openapi-utils/api-report.api.md b/packages/backend-openapi-utils/report.api.md similarity index 100% rename from packages/backend-openapi-utils/api-report.api.md rename to packages/backend-openapi-utils/report.api.md diff --git a/packages/backend-plugin-api/api-report-alpha.api.md b/packages/backend-plugin-api/report-alpha.api.md similarity index 100% rename from packages/backend-plugin-api/api-report-alpha.api.md rename to packages/backend-plugin-api/report-alpha.api.md diff --git a/packages/backend-plugin-api/api-report-testUtils.api.md b/packages/backend-plugin-api/report-testUtils.api.md similarity index 100% rename from packages/backend-plugin-api/api-report-testUtils.api.md rename to packages/backend-plugin-api/report-testUtils.api.md diff --git a/packages/backend-plugin-api/api-report.api.md b/packages/backend-plugin-api/report.api.md similarity index 100% rename from packages/backend-plugin-api/api-report.api.md rename to packages/backend-plugin-api/report.api.md diff --git a/packages/backend-test-utils/api-report.api.md b/packages/backend-test-utils/report.api.md similarity index 100% rename from packages/backend-test-utils/api-report.api.md rename to packages/backend-test-utils/report.api.md diff --git a/packages/catalog-client/api-report.api.md b/packages/catalog-client/report.api.md similarity index 100% rename from packages/catalog-client/api-report.api.md rename to packages/catalog-client/report.api.md diff --git a/packages/catalog-model/api-report-alpha.api.md b/packages/catalog-model/report-alpha.api.md similarity index 100% rename from packages/catalog-model/api-report-alpha.api.md rename to packages/catalog-model/report-alpha.api.md diff --git a/packages/catalog-model/api-report.api.md b/packages/catalog-model/report.api.md similarity index 100% rename from packages/catalog-model/api-report.api.md rename to packages/catalog-model/report.api.md diff --git a/packages/cli-common/api-report.api.md b/packages/cli-common/report.api.md similarity index 100% rename from packages/cli-common/api-report.api.md rename to packages/cli-common/report.api.md diff --git a/packages/cli-node/api-report.api.md b/packages/cli-node/report.api.md similarity index 100% rename from packages/cli-node/api-report.api.md rename to packages/cli-node/report.api.md diff --git a/packages/config-loader/api-report.api.md b/packages/config-loader/report.api.md similarity index 97% rename from packages/config-loader/api-report.api.md rename to packages/config-loader/report.api.md index 42b6dcab96bcd..0bb88a67b30d4 100644 --- a/packages/config-loader/api-report.api.md +++ b/packages/config-loader/report.api.md @@ -293,9 +293,9 @@ export type TransformFunc = ( // src/sources/ConfigSources.d.ts:42:5 - (ae-undocumented) Missing documentation for "watch". // src/sources/ConfigSources.d.ts:43:5 - (ae-undocumented) Missing documentation for "rootDir". // src/sources/ConfigSources.d.ts:44:5 - (ae-undocumented) Missing documentation for "remote". -// src/sources/ConfigSources.d.ts:60:5 - (ae-undocumented) Missing documentation for "targets". -// src/sources/ConfigSources.d.ts:68:5 - (ae-undocumented) Missing documentation for "argv". -// src/sources/ConfigSources.d.ts:69:5 - (ae-undocumented) Missing documentation for "env". +// src/sources/ConfigSources.d.ts:65:5 - (ae-undocumented) Missing documentation for "targets". +// src/sources/ConfigSources.d.ts:73:5 - (ae-undocumented) Missing documentation for "argv". +// src/sources/ConfigSources.d.ts:74:5 - (ae-undocumented) Missing documentation for "env". // src/sources/EnvConfigSource.d.ts:46:5 - (ae-undocumented) Missing documentation for "readConfigData". // src/sources/EnvConfigSource.d.ts:47:5 - (ae-undocumented) Missing documentation for "toString". // src/sources/FileConfigSource.d.ts:40:5 - (ae-undocumented) Missing documentation for "readConfigData". diff --git a/packages/config/api-report.api.md b/packages/config/report.api.md similarity index 100% rename from packages/config/api-report.api.md rename to packages/config/report.api.md diff --git a/packages/core-app-api/api-report.api.md b/packages/core-app-api/report.api.md similarity index 100% rename from packages/core-app-api/api-report.api.md rename to packages/core-app-api/report.api.md diff --git a/packages/core-compat-api/api-report.api.md b/packages/core-compat-api/report.api.md similarity index 100% rename from packages/core-compat-api/api-report.api.md rename to packages/core-compat-api/report.api.md diff --git a/packages/core-components/api-report-alpha.api.md b/packages/core-components/report-alpha.api.md similarity index 100% rename from packages/core-components/api-report-alpha.api.md rename to packages/core-components/report-alpha.api.md diff --git a/packages/core-components/api-report-testUtils.api.md b/packages/core-components/report-testUtils.api.md similarity index 100% rename from packages/core-components/api-report-testUtils.api.md rename to packages/core-components/report-testUtils.api.md diff --git a/packages/core-components/api-report.api.md b/packages/core-components/report.api.md similarity index 100% rename from packages/core-components/api-report.api.md rename to packages/core-components/report.api.md diff --git a/packages/core-plugin-api/api-report-alpha.api.md b/packages/core-plugin-api/report-alpha.api.md similarity index 100% rename from packages/core-plugin-api/api-report-alpha.api.md rename to packages/core-plugin-api/report-alpha.api.md diff --git a/packages/core-plugin-api/api-report.api.md b/packages/core-plugin-api/report.api.md similarity index 100% rename from packages/core-plugin-api/api-report.api.md rename to packages/core-plugin-api/report.api.md diff --git a/packages/dev-utils/api-report.api.md b/packages/dev-utils/report.api.md similarity index 100% rename from packages/dev-utils/api-report.api.md rename to packages/dev-utils/report.api.md diff --git a/packages/e2e-test-utils/api-report-playwright.api.md b/packages/e2e-test-utils/report-playwright.api.md similarity index 100% rename from packages/e2e-test-utils/api-report-playwright.api.md rename to packages/e2e-test-utils/report-playwright.api.md diff --git a/packages/errors/api-report.api.md b/packages/errors/report.api.md similarity index 100% rename from packages/errors/api-report.api.md rename to packages/errors/report.api.md diff --git a/packages/frontend-app-api/api-report.api.md b/packages/frontend-app-api/report.api.md similarity index 100% rename from packages/frontend-app-api/api-report.api.md rename to packages/frontend-app-api/report.api.md diff --git a/packages/frontend-plugin-api/api-report.api.md b/packages/frontend-plugin-api/report.api.md similarity index 60% rename from packages/frontend-plugin-api/api-report.api.md rename to packages/frontend-plugin-api/report.api.md index 9afcb1b91e9b3..24aa1d5b52db0 100644 --- a/packages/frontend-plugin-api/api-report.api.md +++ b/packages/frontend-plugin-api/report.api.md @@ -89,6 +89,8 @@ import { useTranslationRef } from '@backstage/core-plugin-api/alpha'; import { vmwareCloudAuthApiRef } from '@backstage/core-plugin-api'; import { withApis } from '@backstage/core-plugin-api'; import { z } from 'zod'; +import { ZodSchema } from 'zod'; +import { ZodTypeDef } from 'zod'; export { AlertApi }; @@ -146,13 +148,26 @@ export { AnyApiFactory }; export { AnyApiRef }; // @public (undocumented) -export type AnyExtensionDataRef = ExtensionDataRef< - unknown, - string, - { - optional?: true; - } ->; +export type AnyExtensionDataMap = { + [name in string]: ExtensionDataRef< + unknown, + string, + { + optional?: true; + } + >; +}; + +// @public (undocumented) +export type AnyExtensionInputMap = { + [inputName in string]: ExtensionInput< + AnyExtensionDataMap, + { + optional: boolean; + singleton: boolean; + } + >; +}; // @public (undocumented) export type AnyExternalRoutes = { @@ -171,26 +186,6 @@ export type AnyRoutes = { [name in string]: RouteRef | SubRouteRef; }; -// @public -export const ApiBlueprint: ExtensionBlueprint<{ - kind: 'api'; - name: undefined; - params: { - factory: AnyApiFactory; - }; - output: ConfigurableExtensionDataRef; - inputs: {}; - config: {}; - configInput: {}; - dataRefs: { - factory: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - }; -}>; - export { ApiFactory }; export { ApiHolder }; @@ -239,51 +234,9 @@ export interface AppNodeSpec { // (undocumented) readonly id: string; // (undocumented) - readonly source?: FrontendPlugin; + readonly source?: BackstagePlugin; } -// @public -export const AppRootElementBlueprint: ExtensionBlueprint<{ - kind: 'app-root-element'; - name: undefined; - params: { - element: JSX.Element | (() => JSX.Element); - }; - output: ConfigurableExtensionDataRef; - inputs: {}; - config: {}; - configInput: {}; - dataRefs: never; -}>; - -// @public -export const AppRootWrapperBlueprint: ExtensionBlueprint<{ - kind: 'app-root-wrapper'; - name: undefined; - params: { - Component: ComponentType>; - }; - output: ConfigurableExtensionDataRef< - React_2.ComponentType<{ - children?: React_2.ReactNode; - }>, - 'app.root.wrapper', - {} - >; - inputs: {}; - config: {}; - configInput: {}; - dataRefs: { - component: ConfigurableExtensionDataRef< - React_2.ComponentType<{ - children?: React_2.ReactNode; - }>, - 'app.root.wrapper', - {} - >; - }; -}>; - export { AppTheme }; export { AppThemeApi }; @@ -317,6 +270,21 @@ export { BackstageIdentityApi }; export { BackstageIdentityResponse }; +// @public (undocumented) +export interface BackstagePlugin< + Routes extends AnyRoutes = AnyRoutes, + ExternalRoutes extends AnyExternalRoutes = AnyExternalRoutes, +> { + // (undocumented) + readonly $$type: '@backstage/BackstagePlugin'; + // (undocumented) + readonly externalRoutes: ExternalRoutes; + // (undocumented) + readonly id: string; + // (undocumented) + readonly routes: Routes; +} + export { BackstageUserIdentity }; export { bitbucketAuthApiRef }; @@ -350,19 +318,17 @@ export { configApiRef }; // @public (undocumented) export interface ConfigurableExtensionDataRef< - TData, TId extends string, + TData, TConfig extends { optional?: true; } = {}, > extends ExtensionDataRef { - // (undocumented) - (t: TData): ExtensionDataValue; // (undocumented) optional(): ConfigurableExtensionDataRef< - TData, TId, - TConfig & { + TData, + TData & { optional: true; } >; @@ -377,7 +343,7 @@ export const coreComponentRefs: { // @public (undocumented) export type CoreErrorBoundaryFallbackProps = { - plugin?: FrontendPlugin; + plugin?: BackstagePlugin; error: Error; resetError: () => void; }; @@ -385,14 +351,14 @@ export type CoreErrorBoundaryFallbackProps = { // @public (undocumented) export const coreExtensionData: { reactElement: ConfigurableExtensionDataRef< - JSX_2.Element, 'core.reactElement', + JSX_2.Element, {} >; - routePath: ConfigurableExtensionDataRef; + routePath: ConfigurableExtensionDataRef<'core.routing.path', string, {}>; routeRef: ConfigurableExtensionDataRef< - RouteRef, 'core.routing.ref', + RouteRef, {} >; }; @@ -405,56 +371,133 @@ export type CoreNotFoundErrorPageProps = { // @public (undocumented) export type CoreProgressProps = {}; +// @public (undocumented) +export function createApiExtension< + TConfig extends {}, + TInputs extends AnyExtensionInputMap, +>( + options: ( + | { + api: AnyApiRef; + factory: (options: { + config: TConfig; + inputs: Expand>; + }) => AnyApiFactory; + } + | { + factory: AnyApiFactory; + } + ) & { + configSchema?: PortableSchema; + inputs?: TInputs; + }, +): ExtensionDefinition; + +// @public (undocumented) +export namespace createApiExtension { + const // (undocumented) + factoryDataRef: ConfigurableExtensionDataRef< + 'core.api.factory', + AnyApiFactory, + {} + >; +} + export { createApiFactory }; export { createApiRef }; +// @public +export function createAppRootElementExtension< + TConfig extends {}, + TInputs extends AnyExtensionInputMap, +>(options: { + namespace?: string; + name?: string; + attachTo?: { + id: string; + input: string; + }; + configSchema?: PortableSchema; + disabled?: boolean; + inputs?: TInputs; + element: + | JSX_2.Element + | ((options: { + inputs: Expand>; + config: TConfig; + }) => JSX_2.Element); +}): ExtensionDefinition; + +// @public +export function createAppRootWrapperExtension< + TConfig extends {}, + TInputs extends AnyExtensionInputMap, +>(options: { + namespace?: string; + name?: string; + attachTo?: { + id: string; + input: string; + }; + configSchema?: PortableSchema; + disabled?: boolean; + inputs?: TInputs; + Component: ComponentType< + PropsWithChildren<{ + inputs: Expand>; + config: TConfig; + }> + >; +}): ExtensionDefinition; + +// @public (undocumented) +export namespace createAppRootWrapperExtension { + const // (undocumented) + componentDataRef: ConfigurableExtensionDataRef< + 'app.root.wrapper', + React_2.ComponentType<{ + children?: React_2.ReactNode; + }>, + {} + >; +} + // @public (undocumented) -export function createComponentExtension(options: { +export function createComponentExtension< + TProps extends {}, + TConfig extends {}, + TInputs extends AnyExtensionInputMap, +>(options: { ref: ComponentRef; name?: string; disabled?: boolean; + inputs?: TInputs; + configSchema?: PortableSchema; loader: | { - lazy: () => Promise>; + lazy: (values: { + config: TConfig; + inputs: Expand>; + }) => Promise>; } | { - sync: () => ComponentType; + sync: (values: { + config: TConfig; + inputs: Expand>; + }) => ComponentType; }; -}): ExtensionDefinition<{ - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - { - ref: ComponentRef; - impl: ComponentType; - }, - 'core.component.component', - {} - >; - inputs: { - [x: string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - }; - params: never; - kind: 'component'; - name: string; -}>; +}): ExtensionDefinition; // @public (undocumented) export namespace createComponentExtension { const // (undocumented) componentDataRef: ConfigurableExtensionDataRef< + 'core.component.component', { ref: ComponentRef; impl: ComponentType; }, - 'core.component.component', {} >; } @@ -466,189 +509,142 @@ export function createComponentRef(options: { // @public (undocumented) export function createExtension< - UOutput extends AnyExtensionDataRef, - TInputs extends { - [inputName in string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - }, + TOutput extends AnyExtensionDataMap, + TInputs extends AnyExtensionInputMap, + TConfig, + TConfigInput, TConfigSchema extends { [key: string]: (zImpl: typeof z) => z.ZodType; }, - UFactoryOutput extends ExtensionDataValue, - const TKind extends string | undefined = undefined, - const TName extends string | undefined = undefined, >( options: CreateExtensionOptions< - TKind, - TName, - UOutput, + TOutput, TInputs, - TConfigSchema, - UFactoryOutput + TConfig, + TConfigInput, + TConfigSchema >, -): ExtensionDefinition<{ - config: string extends keyof TConfigSchema - ? {} - : { - [key in keyof TConfigSchema]: z.infer>; - }; - configInput: string extends keyof TConfigSchema - ? {} - : z.input< - z.ZodObject<{ - [key in keyof TConfigSchema]: ReturnType; - }> - >; - output: UOutput; - inputs: TInputs; - params: never; - kind: string | undefined extends TKind ? undefined : TKind; - name: string | undefined extends TName ? undefined : TName; -}>; +): ExtensionDefinition< + TConfig & + (string extends keyof TConfigSchema + ? {} + : { + [key in keyof TConfigSchema]: z.infer>; + }), + TConfigInput & + (string extends keyof TConfigSchema + ? {} + : z.input< + z.ZodObject<{ + [key in keyof TConfigSchema]: ReturnType; + }> + >) +>; // @public export function createExtensionBlueprint< - TParams extends object, - UOutput extends AnyExtensionDataRef, - TInputs extends { - [inputName in string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - }, + TParams, + TInputs extends AnyExtensionInputMap, + TOutput extends AnyExtensionDataMap, TConfigSchema extends { [key in string]: (zImpl: typeof z) => z.ZodType; }, - UFactoryOutput extends ExtensionDataValue, - TKind extends string, - TName extends string | undefined = undefined, - TDataRefs extends { - [name in string]: AnyExtensionDataRef; - } = never, + TDataRefs extends AnyExtensionDataMap = never, >( options: CreateExtensionBlueprintOptions< - TKind, - TName, TParams, - UOutput, TInputs, + TOutput, TConfigSchema, - UFactoryOutput, TDataRefs >, -): ExtensionBlueprint<{ - kind: TKind; - name: TName; - params: TParams; - output: UOutput; - inputs: string extends keyof TInputs ? {} : TInputs; - config: string extends keyof TConfigSchema +): ExtensionBlueprint< + TParams, + TInputs, + TOutput, + string extends keyof TConfigSchema ? {} : { [key in keyof TConfigSchema]: z.infer>; - }; - configInput: string extends keyof TConfigSchema + }, + string extends keyof TConfigSchema ? {} : z.input< z.ZodObject<{ [key in keyof TConfigSchema]: ReturnType; }> - >; - dataRefs: TDataRefs; -}>; + >, + TDataRefs +>; // @public (undocumented) -export type CreateExtensionBlueprintOptions< - TKind extends string, - TName extends string | undefined, +export interface CreateExtensionBlueprintOptions< TParams, - UOutput extends AnyExtensionDataRef, - TInputs extends { - [inputName in string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - }, + TInputs extends AnyExtensionInputMap, + TOutput extends AnyExtensionDataMap, TConfigSchema extends { [key in string]: (zImpl: typeof z) => z.ZodType; }, - UFactoryOutput extends ExtensionDataValue, - TDataRefs extends { - [name in string]: AnyExtensionDataRef; - }, -> = { - kind: TKind; + TDataRefs extends AnyExtensionDataMap, +> { + // (undocumented) attachTo: { id: string; input: string; }; - disabled?: boolean; - inputs?: TInputs; - output: Array; - name?: TName; + // (undocumented) config?: { schema: TConfigSchema; }; + // (undocumented) + dataRefs?: TDataRefs; + // (undocumented) + disabled?: boolean; + // (undocumented) factory( params: TParams, context: { node: AppNode; - apis: ApiHolder; config: { [key in keyof TConfigSchema]: z.infer>; }; inputs: Expand>; }, - ): Iterable; - dataRefs?: TDataRefs; -} & VerifyExtensionFactoryOutput; + ): Expand>; + // (undocumented) + inputs?: TInputs; + // (undocumented) + kind: string; + // (undocumented) + namespace?: string; + // (undocumented) + output: TOutput; +} // @public @deprecated (undocumented) export function createExtensionDataRef( id: string, -): ConfigurableExtensionDataRef; +): ConfigurableExtensionDataRef; // @public (undocumented) export function createExtensionDataRef(): { with(options: { id: TId; - }): ConfigurableExtensionDataRef; + }): ConfigurableExtensionDataRef; }; // @public (undocumented) export function createExtensionInput< - UExtensionData extends ExtensionDataRef< - unknown, - string, - { - optional?: true; - } - >, + TExtensionData extends AnyExtensionDataMap, TConfig extends { singleton?: boolean; optional?: boolean; }, >( - extensionData: Array, - config?: TConfig & { - replaces?: Array<{ - id: string; - input: string; - }>; - }, + extensionData: TExtensionData, + config?: TConfig, ): ExtensionInput< - UExtensionData, + TExtensionData, { singleton: TConfig['singleton'] extends true ? true : false; optional: TConfig['optional'] extends true ? true : false; @@ -656,45 +652,57 @@ export function createExtensionInput< >; // @public (undocumented) -export type CreateExtensionOptions< - TKind extends string | undefined, - TName extends string | undefined, - UOutput extends AnyExtensionDataRef, - TInputs extends { - [inputName in string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - }, +export interface CreateExtensionOptions< + TOutput extends AnyExtensionDataMap, + TInputs extends AnyExtensionInputMap, + TConfig, + TConfigInput, TConfigSchema extends { [key: string]: (zImpl: typeof z) => z.ZodType; }, - UFactoryOutput extends ExtensionDataValue, -> = { - kind?: TKind; - name?: TName; +> { + // (undocumented) attachTo: { id: string; input: string; }; - disabled?: boolean; - inputs?: TInputs; - output: Array; + // (undocumented) config?: { schema: TConfigSchema; }; + // @deprecated (undocumented) + configSchema?: PortableSchema; + // (undocumented) + disabled?: boolean; + // (undocumented) factory(context: { node: AppNode; - apis: ApiHolder; - config: { - [key in keyof TConfigSchema]: z.infer>; - }; + config: TConfig & + (string extends keyof TConfigSchema + ? {} + : { + [key in keyof TConfigSchema]: z.infer< + ReturnType + >; + }); inputs: Expand>; - }): Iterable; -} & VerifyExtensionFactoryOutput; + }): Expand>; + // (undocumented) + inputs?: TInputs; + // (undocumented) + kind?: string; + // (undocumented) + name?: string; + // (undocumented) + namespace?: string; + // (undocumented) + output: TOutput; +} + +// @public (undocumented) +export function createExtensionOverrides( + options: ExtensionOverridesOptions, +): ExtensionOverrides; // @public export function createExternalRouteRef< @@ -703,11 +711,13 @@ export function createExternalRouteRef< [param in TParamKeys]: string; } | undefined = undefined, + TOptional extends boolean = false, TParamKeys extends string = string, >(options?: { readonly params?: string extends TParamKeys ? (keyof TParams)[] : TParamKeys[]; + optional?: TOptional; defaultTarget?: string; }): ExternalRouteRef< keyof TParams extends never @@ -716,57 +726,110 @@ export function createExternalRouteRef< ? TParams : { [param in TParamKeys]: string; - } + }, + TOptional >; -// @public (undocumented) -export function createFrontendModule< - TId extends string, - TExtensions extends readonly ExtensionDefinition[] = [], ->(options: CreateFrontendModuleOptions): FrontendModule; - -// @public (undocumented) -export interface CreateFrontendModuleOptions< - TPluginId extends string, - TExtensions extends readonly ExtensionDefinition[], -> { - // (undocumented) - extensions?: TExtensions; - // (undocumented) - featureFlags?: FeatureFlagConfig[]; - // (undocumented) - pluginId: TPluginId; -} - -// @public (undocumented) -export function createFrontendPlugin< - TId extends string, - TRoutes extends AnyRoutes = {}, - TExternalRoutes extends AnyExternalRoutes = {}, - TExtensions extends readonly ExtensionDefinition[] = [], ->( - options: PluginOptions, -): FrontendPlugin< - TRoutes, - TExternalRoutes, +// @public +export function createNavItemExtension(options: { + namespace?: string; + name?: string; + routeRef: RouteRef; + title: string; + icon: IconComponent_2; +}): ExtensionDefinition< { - [KExtension in TExtensions[number] as ResolveExtensionId< - KExtension, - TId - >]: KExtension; + title: string; + }, + { + title?: string | undefined; } >; +// @public (undocumented) +export namespace createNavItemExtension { + const // (undocumented) + targetDataRef: ConfigurableExtensionDataRef< + 'core.nav-item.target', + { + title: string; + icon: IconComponent_2; + routeRef: RouteRef; + }, + {} + >; +} + // @public -export function createRouteRef< - TParams extends - | { - [param in TParamKeys]: string; - } - | undefined = undefined, - TParamKeys extends string = string, ->(config?: { - readonly params: string extends TParamKeys ? (keyof TParams)[] : TParamKeys[]; +export function createNavLogoExtension(options: { + name?: string; + namespace?: string; + logoIcon: JSX.Element; + logoFull: JSX.Element; +}): ExtensionDefinition<{}, {}>; + +// @public (undocumented) +export namespace createNavLogoExtension { + const // (undocumented) + logoElementsDataRef: ConfigurableExtensionDataRef< + 'core.nav-logo.logo-elements', + { + logoIcon?: JSX.Element | undefined; + logoFull?: JSX.Element | undefined; + }, + {} + >; +} + +// @public +export function createPageExtension< + TConfig extends { + path: string; + }, + TInputs extends AnyExtensionInputMap, +>( + options: ( + | { + defaultPath: string; + } + | { + configSchema: PortableSchema; + } + ) & { + namespace?: string; + name?: string; + attachTo?: { + id: string; + input: string; + }; + disabled?: boolean; + inputs?: TInputs; + routeRef?: RouteRef; + loader: (options: { + config: TConfig; + inputs: Expand>; + }) => Promise; + }, +): ExtensionDefinition; + +// @public (undocumented) +export function createPlugin< + Routes extends AnyRoutes = {}, + ExternalRoutes extends AnyExternalRoutes = {}, +>( + options: PluginOptions, +): BackstagePlugin; + +// @public +export function createRouteRef< + TParams extends + | { + [param in TParamKeys]: string; + } + | undefined = undefined, + TParamKeys extends string = string, +>(config?: { + readonly params: string extends TParamKeys ? (keyof TParams)[] : TParamKeys[]; }): RouteRef< keyof TParams extends never ? undefined @@ -777,6 +840,75 @@ export function createRouteRef< } >; +// @public +export function createRouterExtension< + TConfig extends {}, + TInputs extends AnyExtensionInputMap, +>(options: { + namespace?: string; + name?: string; + attachTo?: { + id: string; + input: string; + }; + configSchema?: PortableSchema; + disabled?: boolean; + inputs?: TInputs; + Component: ComponentType< + PropsWithChildren<{ + inputs: Expand>; + config: TConfig; + }> + >; +}): ExtensionDefinition; + +// @public (undocumented) +export namespace createRouterExtension { + const // (undocumented) + componentDataRef: ConfigurableExtensionDataRef< + 'app.router.wrapper', + React_2.ComponentType<{ + children?: React_2.ReactNode; + }>, + {} + >; +} + +// @public @deprecated (undocumented) +export function createSchemaFromZod( + schemaCreator: (zImpl: typeof z) => ZodSchema, +): PortableSchema; + +// @public (undocumented) +export function createSignInPageExtension< + TConfig extends {}, + TInputs extends AnyExtensionInputMap, +>(options: { + namespace?: string; + name?: string; + attachTo?: { + id: string; + input: string; + }; + configSchema?: PortableSchema; + disabled?: boolean; + inputs?: TInputs; + loader: (options: { + config: TConfig; + inputs: Expand>; + }) => Promise>; +}): ExtensionDefinition; + +// @public (undocumented) +export namespace createSignInPageExtension { + const // (undocumented) + componentDataRef: ConfigurableExtensionDataRef< + 'core.sign-in-page.component', + React_2.ComponentType, + {} + >; +} + // @public export function createSubRouteRef< Path extends string, @@ -786,6 +918,44 @@ export function createSubRouteRef< parent: RouteRef; }): MakeSubRouteRef, ParentParams>; +// @public (undocumented) +export function createThemeExtension( + theme: AppTheme, +): ExtensionDefinition<{}, {}>; + +// @public (undocumented) +export namespace createThemeExtension { + const // (undocumented) + themeDataRef: ConfigurableExtensionDataRef< + 'core.theme.theme', + AppTheme, + {} + >; +} + +// @public (undocumented) +export function createTranslationExtension(options: { + name?: string; + resource: TranslationResource | TranslationMessages; +}): ExtensionDefinition<{}, {}>; + +// @public (undocumented) +export namespace createTranslationExtension { + const // (undocumented) + translationDataRef: ConfigurableExtensionDataRef< + 'core.translation.translation', + | TranslationResource + | TranslationMessages< + string, + { + [x: string]: string; + }, + boolean + >, + {} + >; +} + export { createTranslationMessages }; export { createTranslationRef }; @@ -823,154 +993,87 @@ export interface Extension { // @public (undocumented) export interface ExtensionBlueprint< - T extends ExtensionBlueprintParameters = ExtensionBlueprintParameters, + TParams, + TInputs extends AnyExtensionInputMap, + TOutput extends AnyExtensionDataMap, + TConfig extends { + [key in string]: unknown; + }, + TConfigInput extends { + [key in string]: unknown; + }, + TDataRefs extends AnyExtensionDataMap, > { // (undocumented) - dataRefs: T['dataRefs']; - // (undocumented) - make(args: { - name?: TNewName; - attachTo?: { - id: string; - input: string; - }; - disabled?: boolean; - params: T['params']; - }): ExtensionDefinition<{ - kind: T['kind']; - name: string | undefined extends TNewName ? T['name'] : TNewName; - config: T['config']; - configInput: T['configInput']; - output: T['output']; - inputs: T['inputs']; - params: T['params']; - }>; - makeWithOverrides< - TNewName extends string | undefined, + dataRefs: TDataRefs; + make< TExtensionConfigSchema extends { [key in string]: (zImpl: typeof z) => z.ZodType; }, - UFactoryOutput extends ExtensionDataValue, - UNewOutput extends AnyExtensionDataRef, - TExtraInputs extends { - [inputName in string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - }, - >(args: { - name?: TNewName; - attachTo?: { - id: string; - input: string; - }; - disabled?: boolean; - inputs?: TExtraInputs & { - [KName in keyof T['inputs']]?: `Error: Input '${KName & - string}' is already defined in parent definition`; - }; - output?: Array; - config?: { - schema: TExtensionConfigSchema & { - [KName in keyof T['config']]?: `Error: Config key '${KName & - string}' is already defined in parent schema`; + >( + args: { + namespace?: string; + name?: string; + attachTo?: { + id: string; + input: string; }; - }; - factory( - originalFactory: ( - params: T['params'], - context?: { - config?: T['config']; - inputs?: ResolveInputValueOverrides>; - }, - ) => ExtensionDataContainer>, - context: { - node: AppNode; - apis: ApiHolder; - config: T['config'] & { - [key in keyof TExtensionConfigSchema]: z.infer< - ReturnType - >; + disabled?: boolean; + inputs?: TInputs; + output?: TOutput; + config?: { + schema: TExtensionConfigSchema & { + [KName in keyof TConfig]?: `Error: Config key '${KName & + string}' is already defined in parent schema`; }; - inputs: Expand>; - }, - ): Iterable & - VerifyExtensionFactoryOutput< - AnyExtensionDataRef extends UNewOutput - ? NonNullable - : UNewOutput, - UFactoryOutput + }; + } & ( + | { + factory( + originalFactory: ( + params: TParams, + context?: { + config?: TConfig; + inputs?: Expand>; + }, + ) => Expand>, + context: { + node: AppNode; + config: TConfig & { + [key in keyof TExtensionConfigSchema]: z.infer< + ReturnType + >; + }; + inputs: Expand>; + }, + ): Expand>; + } + | { + params: TParams; + } + ), + ): ExtensionDefinition< + { + [key in keyof TExtensionConfigSchema]: z.infer< + ReturnType >; - }): ExtensionDefinition<{ - config: (string extends keyof TExtensionConfigSchema - ? {} - : { - [key in keyof TExtensionConfigSchema]: z.infer< - ReturnType - >; - }) & - T['config']; - configInput: (string extends keyof TExtensionConfigSchema - ? {} - : z.input< - z.ZodObject<{ - [key in keyof TExtensionConfigSchema]: ReturnType< - TExtensionConfigSchema[key] - >; - }> - >) & - T['configInput']; - output: AnyExtensionDataRef extends UNewOutput ? T['output'] : UNewOutput; - inputs: T['inputs'] & TExtraInputs; - kind: T['kind']; - name: string | undefined extends TNewName ? T['name'] : TNewName; - params: T['params']; - }>; + } & TConfig, + z.input< + z.ZodObject<{ + [key in keyof TExtensionConfigSchema]: ReturnType< + TExtensionConfigSchema[key] + >; + }> + > & + TConfigInput + >; } -// @public (undocumented) -export type ExtensionBlueprintParameters = { - kind: string; - name?: string; - params?: object; - configInput?: { - [K in string]: any; - }; - config?: { - [K in string]: any; - }; - output?: AnyExtensionDataRef; - inputs?: { - [KName in string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - }; - dataRefs?: { - [name in string]: AnyExtensionDataRef; - }; -}; - // @public (undocumented) export function ExtensionBoundary( props: ExtensionBoundaryProps, ): React_2.JSX.Element; -// @public (undocumented) -export namespace ExtensionBoundary { - // (undocumented) - export function lazy( - appNode: AppNode, - lazyElement: () => Promise, - ): JSX.Element; -} - // @public (undocumented) export interface ExtensionBoundaryProps { // (undocumented) @@ -980,28 +1083,6 @@ export interface ExtensionBoundaryProps { routable?: boolean; } -// @public (undocumented) -export type ExtensionDataContainer = - Iterable< - UExtensionData extends ExtensionDataRef< - infer IData, - infer IId, - infer IConfig - > - ? IConfig['optional'] extends true - ? never - : ExtensionDataValue - : never - > & { - get( - ref: ExtensionDataRef, - ): UExtensionData extends ExtensionDataRef - ? IConfig['optional'] extends true - ? IData | undefined - : IData - : never; - }; - // @public (undocumented) export type ExtensionDataRef< TData, @@ -1010,154 +1091,51 @@ export type ExtensionDataRef< optional?: true; } = {}, > = { - readonly $$type: '@backstage/ExtensionDataRef'; - readonly id: TId; - readonly T: TData; - readonly config: TConfig; + id: TId; + T: TData; + config: TConfig; + $$type: '@backstage/ExtensionDataRef'; }; -// @public (undocumented) -export type ExtensionDataRefToValue = - TDataRef extends ExtensionDataRef - ? ExtensionDataValue - : never; - -// @public (undocumented) -export type ExtensionDataValue = { - readonly $$type: '@backstage/ExtensionDataValue'; - readonly id: TId; - readonly value: TData; +// @public +export type ExtensionDataValues = { + [DataName in keyof TExtensionData as TExtensionData[DataName]['config'] extends { + optional: true; + } + ? never + : DataName]: TExtensionData[DataName]['T']; +} & { + [DataName in keyof TExtensionData as TExtensionData[DataName]['config'] extends { + optional: true; + } + ? DataName + : never]?: TExtensionData[DataName]['T']; }; // @public (undocumented) -export type ExtensionDefinition< - T extends ExtensionDefinitionParameters = ExtensionDefinitionParameters, -> = { +export interface ExtensionDefinition { + // (undocumented) $$type: '@backstage/ExtensionDefinition'; - readonly T: T; - override< - TExtensionConfigSchema extends { - [key in string]: (zImpl: typeof z) => z.ZodType; - }, - UFactoryOutput extends ExtensionDataValue, - UNewOutput extends AnyExtensionDataRef, - TExtraInputs extends { - [inputName in string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - }, - >( - args: Expand< - { - attachTo?: { - id: string; - input: string; - }; - disabled?: boolean; - inputs?: TExtraInputs & { - [KName in keyof T['inputs']]?: `Error: Input '${KName & - string}' is already defined in parent definition`; - }; - output?: Array; - config?: { - schema: TExtensionConfigSchema & { - [KName in keyof T['config']]?: `Error: Config key '${KName & - string}' is already defined in parent schema`; - }; - }; - factory?( - originalFactory: ( - context?: Expand< - { - config?: T['config']; - inputs?: ResolveInputValueOverrides>; - } & ([T['params']] extends [never] - ? {} - : { - params?: Partial; - }) - >, - ) => ExtensionDataContainer>, - context: { - node: AppNode; - apis: ApiHolder; - config: T['config'] & { - [key in keyof TExtensionConfigSchema]: z.infer< - ReturnType - >; - }; - inputs: Expand>; - }, - ): Iterable; - } & ([T['params']] extends [never] - ? {} - : { - params?: Partial; - }) - > & - VerifyExtensionFactoryOutput< - AnyExtensionDataRef extends UNewOutput - ? NonNullable - : UNewOutput, - UFactoryOutput - >, - ): ExtensionDefinition<{ - kind: T['kind']; - name: T['name']; - output: AnyExtensionDataRef extends UNewOutput ? T['output'] : UNewOutput; - inputs: T['inputs'] & TExtraInputs; - config: T['config'] & { - [key in keyof TExtensionConfigSchema]: z.infer< - ReturnType - >; - }; - configInput: T['configInput'] & - z.input< - z.ZodObject<{ - [key in keyof TExtensionConfigSchema]: ReturnType< - TExtensionConfigSchema[key] - >; - }> - >; - }>; -}; - -// @public (undocumented) -export type ExtensionDefinitionParameters = { - kind?: string; - name?: string; - configInput?: { - [K in string]: any; - }; - config?: { - [K in string]: any; - }; - output?: AnyExtensionDataRef; - inputs?: { - [KName in string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; + // (undocumented) + readonly attachTo: { + id: string; + input: string; }; - params?: object; -}; + // (undocumented) + readonly configSchema?: PortableSchema; + // (undocumented) + readonly disabled: boolean; + // (undocumented) + readonly kind?: string; + // (undocumented) + readonly name?: string; + // (undocumented) + readonly namespace?: string; +} // @public (undocumented) export interface ExtensionInput< - UExtensionData extends ExtensionDataRef< - unknown, - string, - { - optional?: true; - } - >, + TExtensionData extends AnyExtensionDataMap, TConfig extends { singleton: boolean; optional: boolean; @@ -1168,12 +1146,7 @@ export interface ExtensionInput< // (undocumented) config: TConfig; // (undocumented) - extensionData: Array; - // (undocumented) - replaces?: Array<{ - id: string; - input: string; - }>; + extensionData: TExtensionData; } // @public (undocumented) @@ -1182,13 +1155,24 @@ export interface ExtensionOverrides { readonly $$type: '@backstage/ExtensionOverrides'; } +// @public (undocumented) +export interface ExtensionOverridesOptions { + // (undocumented) + extensions: ExtensionDefinition[]; + // (undocumented) + featureFlags?: FeatureFlagConfig[]; +} + // @public export interface ExternalRouteRef< TParams extends AnyRouteRefParams = AnyRouteRefParams, + TOptional extends boolean = boolean, > { // (undocumented) readonly $$type: '@backstage/ExternalRouteRef'; // (undocumented) + readonly optional: TOptional; + // (undocumented) readonly T: TParams; } @@ -1211,42 +1195,8 @@ export { FetchApi }; export { fetchApiRef }; -// @public @deprecated (undocumented) -export type FrontendFeature = FrontendPlugin | ExtensionOverrides; - // @public (undocumented) -export interface FrontendModule { - // (undocumented) - readonly $$type: '@backstage/FrontendModule'; - // (undocumented) - readonly pluginId: string; -} - -// @public (undocumented) -export interface FrontendPlugin< - TRoutes extends AnyRoutes = AnyRoutes, - TExternalRoutes extends AnyExternalRoutes = AnyExternalRoutes, - TExtensionMap extends { - [id in string]: ExtensionDefinition; - } = { - [id in string]: ExtensionDefinition; - }, -> { - // (undocumented) - readonly $$type: '@backstage/FrontendPlugin'; - // (undocumented) - readonly externalRoutes: TExternalRoutes; - // (undocumented) - getExtension(id: TId): TExtensionMap[TId]; - // (undocumented) - readonly id: string; - // (undocumented) - readonly routes: TRoutes; - // (undocumented) - withOverrides(options: { - extensions: Array; - }): FrontendPlugin; -} +export type FrontendFeature = BackstagePlugin | ExtensionOverrides; export { githubAuthApiRef }; @@ -1255,34 +1205,40 @@ export { gitlabAuthApiRef }; export { googleAuthApiRef }; // @public (undocumented) -export const IconBundleBlueprint: ExtensionBlueprint<{ - kind: 'icon-bundle'; - name: undefined; - params: { +export const IconBundleBlueprint: ExtensionBlueprint< + { icons: { [x: string]: IconComponent; }; - }; - output: ConfigurableExtensionDataRef< - { - [x: string]: IconComponent; - }, - 'core.icons', - {} - >; - inputs: {}; - config: {}; - configInput: {}; - dataRefs: { + }, + AnyExtensionInputMap, + { icons: ConfigurableExtensionDataRef< + 'core.icons', { [x: string]: IconComponent; }, + {} + >; + }, + { + icons: string; + test: string; + }, + { + test: string; + icons?: string | undefined; + }, + { + icons: ConfigurableExtensionDataRef< 'core.icons', + { + [x: string]: IconComponent; + }, {} >; - }; -}>; + } +>; // @public export type IconComponent = ComponentType< @@ -1311,71 +1267,6 @@ export { identityApiRef }; export { microsoftAuthApiRef }; -// @public -export const NavItemBlueprint: ExtensionBlueprint<{ - kind: 'nav-item'; - name: undefined; - params: { - title: string; - icon: IconComponent_2; - routeRef: RouteRef; - }; - output: ConfigurableExtensionDataRef< - { - title: string; - icon: IconComponent_2; - routeRef: RouteRef; - }, - 'core.nav-item.target', - {} - >; - inputs: {}; - config: {}; - configInput: {}; - dataRefs: { - target: ConfigurableExtensionDataRef< - { - title: string; - icon: IconComponent_2; - routeRef: RouteRef; - }, - 'core.nav-item.target', - {} - >; - }; -}>; - -// @public -export const NavLogoBlueprint: ExtensionBlueprint<{ - kind: 'nav-logo'; - name: undefined; - params: { - logoIcon: JSX.Element; - logoFull: JSX.Element; - }; - output: ConfigurableExtensionDataRef< - { - logoIcon?: JSX.Element | undefined; - logoFull?: JSX.Element | undefined; - }, - 'core.nav-logo.logo-elements', - {} - >; - inputs: {}; - config: {}; - configInput: {}; - dataRefs: { - logoElements: ConfigurableExtensionDataRef< - { - logoIcon?: JSX.Element | undefined; - logoFull?: JSX.Element | undefined; - }, - 'core.nav-logo.logo-elements', - {} - >; - }; -}>; - export { OAuthApi }; export { OAuthRequestApi }; @@ -1394,54 +1285,23 @@ export { oneloginAuthApiRef }; export { OpenIdConnectApi }; -// @public -export const PageBlueprint: ExtensionBlueprint<{ - kind: 'page'; - name: undefined; - params: { - defaultPath: string; - loader: () => Promise; - routeRef?: RouteRef | undefined; - }; - output: - | ConfigurableExtensionDataRef - | ConfigurableExtensionDataRef - | ConfigurableExtensionDataRef< - RouteRef, - 'core.routing.ref', - { - optional: true; - } - >; - inputs: {}; - config: { - path: string | undefined; - }; - configInput: { - path?: string | undefined; - }; - dataRefs: never; -}>; - export { PendingOAuthRequest }; // @public (undocumented) export interface PluginOptions< - TId extends string, - TRoutes extends AnyRoutes, - TExternalRoutes extends AnyExternalRoutes, - TExtensions extends readonly ExtensionDefinition[], + Routes extends AnyRoutes, + ExternalRoutes extends AnyExternalRoutes, > { // (undocumented) - extensions?: TExtensions; + extensions?: ExtensionDefinition[]; // (undocumented) - externalRoutes?: TExternalRoutes; + externalRoutes?: ExternalRoutes; // (undocumented) featureFlags?: FeatureFlagConfig[]; // (undocumented) - id: TId; + id: string; // (undocumented) - routes?: TRoutes; + routes?: Routes; } // @public (undocumented) @@ -1455,13 +1315,11 @@ export { ProfileInfo }; export { ProfileInfoApi }; // @public -export type ResolvedExtensionInput< - TExtensionInput extends ExtensionInput, -> = TExtensionInput['extensionData'] extends Array - ? { - node: AppNode; - } & ExtensionDataContainer - : never; +export type ResolvedExtensionInput = + { + node: AppNode; + output: ExtensionDataValues; + }; // @public export type ResolvedExtensionInputs< @@ -1470,79 +1328,14 @@ export type ResolvedExtensionInputs< }, > = { [InputName in keyof TInputs]: false extends TInputs[InputName]['config']['singleton'] - ? Array>> + ? Array>> : false extends TInputs[InputName]['config']['optional'] - ? Expand> - : Expand | undefined>; + ? Expand> + : Expand< + ResolvedExtensionInput | undefined + >; }; -// @public (undocumented) -export type ResolveInputValueOverrides< - TInputs extends { - [inputName in string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - } = { - [inputName in string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - }, -> = Expand< - { - [KName in keyof TInputs as TInputs[KName] extends ExtensionInput< - any, - { - optional: infer IOptional extends boolean; - singleton: boolean; - } - > - ? IOptional extends true - ? never - : KName - : never]: TInputs[KName] extends ExtensionInput< - infer IDataRefs, - { - optional: boolean; - singleton: infer ISingleton extends boolean; - } - > - ? ISingleton extends true - ? Iterable> - : Array>> - : never; - } & { - [KName in keyof TInputs as TInputs[KName] extends ExtensionInput< - any, - { - optional: infer IOptional extends boolean; - singleton: boolean; - } - > - ? IOptional extends true - ? KName - : never - : never]?: TInputs[KName] extends ExtensionInput< - infer IDataRefs, - { - optional: boolean; - singleton: infer ISingleton extends boolean; - } - > - ? ISingleton extends true - ? Iterable> - : Array>> - : never; - } ->; - // @public export type RouteFunc = ( ...[params]: TParams extends undefined @@ -1550,34 +1343,6 @@ export type RouteFunc = ( : readonly [params: TParams] ) => string; -// @public (undocumented) -export const RouterBlueprint: ExtensionBlueprint<{ - kind: 'app-router-component'; - name: undefined; - params: { - Component: ComponentType>; - }; - output: ConfigurableExtensionDataRef< - ComponentType<{ - children?: ReactNode; - }>, - 'app.router.wrapper', - {} - >; - inputs: {}; - config: {}; - configInput: {}; - dataRefs: { - component: ConfigurableExtensionDataRef< - ComponentType<{ - children?: ReactNode; - }>, - 'app.router.wrapper', - {} - >; - }; -}>; - // @public export interface RouteRef< TParams extends AnyRouteRefParams = AnyRouteRefParams, @@ -1595,7 +1360,7 @@ export interface RouteResolutionApi { anyRouteRef: | RouteRef | SubRouteRef - | ExternalRouteRef, + | ExternalRouteRef, options?: RouteResolutionApiResolveOptions, ): RouteFunc | undefined; } @@ -1612,30 +1377,6 @@ export { SessionApi }; export { SessionState }; -// @public -export const SignInPageBlueprint: ExtensionBlueprint<{ - kind: 'sign-in-page'; - name: undefined; - params: { - loader: () => Promise>; - }; - output: ConfigurableExtensionDataRef< - React_2.ComponentType, - 'core.sign-in-page.component', - {} - >; - inputs: {}; - config: {}; - configInput: {}; - dataRefs: { - component: ConfigurableExtensionDataRef< - React_2.ComponentType, - 'core.sign-in-page.component', - {} - >; - }; -}>; - export { StorageApi }; export { storageApiRef }; @@ -1654,60 +1395,6 @@ export interface SubRouteRef< readonly T: TParams; } -// @public -export const ThemeBlueprint: ExtensionBlueprint<{ - kind: 'theme'; - name: undefined; - params: { - theme: AppTheme; - }; - output: ConfigurableExtensionDataRef; - inputs: {}; - config: {}; - configInput: {}; - dataRefs: { - theme: ConfigurableExtensionDataRef; - }; -}>; - -// @public -export const TranslationBlueprint: ExtensionBlueprint<{ - kind: 'translation'; - name: undefined; - params: { - resource: TranslationResource | TranslationMessages; - }; - output: ConfigurableExtensionDataRef< - | TranslationResource - | TranslationMessages< - string, - { - [x: string]: string; - }, - boolean - >, - 'core.translation.translation', - {} - >; - inputs: {}; - config: {}; - configInput: {}; - dataRefs: { - translation: ConfigurableExtensionDataRef< - | TranslationResource - | TranslationMessages< - string, - { - [x: string]: string; - }, - boolean - >, - 'core.translation.translation', - {} - >; - }; -}>; - export { TranslationMessages }; export { TranslationMessagesOptions }; @@ -1734,13 +1421,18 @@ export function useComponentRef( ref: ComponentRef, ): ComponentType; +// @public +export function useRouteRef< + TOptional extends boolean, + TParams extends AnyRouteRefParams, +>( + routeRef: ExternalRouteRef, +): TOptional extends true ? RouteFunc | undefined : RouteFunc; + // @public export function useRouteRef( - routeRef: - | RouteRef - | SubRouteRef - | ExternalRouteRef, -): RouteFunc | undefined; + routeRef: RouteRef | SubRouteRef, +): RouteFunc; // @public export function useRouteRefParams( @@ -1771,12 +1463,12 @@ export { withApis }; // src/apis/definitions/RouteResolutionApi.d.ts:30:5 - (ae-undocumented) Missing documentation for "resolve". // src/components/ExtensionBoundary.d.ts:4:1 - (ae-undocumented) Missing documentation for "ExtensionBoundaryProps". // src/components/ExtensionBoundary.d.ts:5:5 - (ae-undocumented) Missing documentation for "node". -// src/components/ExtensionBoundary.d.ts:6:5 - (ae-undocumented) Missing documentation for "routable". -// src/components/ExtensionBoundary.d.ts:7:5 - (ae-undocumented) Missing documentation for "children". -// src/components/ExtensionBoundary.d.ts:10:1 - (ae-undocumented) Missing documentation for "ExtensionBoundary". +// src/components/ExtensionBoundary.d.ts:12:5 - (ae-undocumented) Missing documentation for "children". +// src/components/ExtensionBoundary.d.ts:15:1 - (ae-undocumented) Missing documentation for "ExtensionBoundary". // src/components/coreComponentRefs.d.ts:3:22 - (ae-undocumented) Missing documentation for "coreComponentRefs". // src/components/createComponentRef.d.ts:2:1 - (ae-undocumented) Missing documentation for "ComponentRef". // src/components/createComponentRef.d.ts:7:1 - (ae-undocumented) Missing documentation for "createComponentRef". +// src/extensions/IconBundleBlueprint.d.ts:3:22 - (ae-undocumented) Missing documentation for "IconBundleBlueprint". // src/extensions/createApiExtension.d.ts:7:1 - (ae-undocumented) Missing documentation for "createApiExtension". // src/extensions/createApiExtension.d.ts:20:1 - (ae-undocumented) Missing documentation for "createApiExtension". // src/extensions/createApiExtension.d.ts:21:11 - (ae-undocumented) Missing documentation for "factoryDataRef". @@ -1785,8 +1477,8 @@ export { withApis }; // src/extensions/createComponentExtension.d.ts:7:1 - (ae-undocumented) Missing documentation for "createComponentExtension". // src/extensions/createComponentExtension.d.ts:26:1 - (ae-undocumented) Missing documentation for "createComponentExtension". // src/extensions/createComponentExtension.d.ts:27:11 - (ae-undocumented) Missing documentation for "componentDataRef". -// src/extensions/createNavItemExtension.d.ts:17:1 - (ae-undocumented) Missing documentation for "createNavItemExtension". -// src/extensions/createNavItemExtension.d.ts:18:11 - (ae-undocumented) Missing documentation for "targetDataRef". +// src/extensions/createNavItemExtension.d.ts:19:1 - (ae-undocumented) Missing documentation for "createNavItemExtension". +// src/extensions/createNavItemExtension.d.ts:20:11 - (ae-undocumented) Missing documentation for "targetDataRef". // src/extensions/createNavLogoExtension.d.ts:13:1 - (ae-undocumented) Missing documentation for "createNavLogoExtension". // src/extensions/createNavLogoExtension.d.ts:14:11 - (ae-undocumented) Missing documentation for "logoElementsDataRef". // src/extensions/createRouterExtension.d.ts:28:1 - (ae-undocumented) Missing documentation for "createRouterExtension". @@ -1808,37 +1500,51 @@ export { withApis }; // src/routing/SubRouteRef.d.ts:13:5 - (ae-undocumented) Missing documentation for "$$type". // src/routing/SubRouteRef.d.ts:14:5 - (ae-undocumented) Missing documentation for "T". // src/routing/SubRouteRef.d.ts:15:5 - (ae-undocumented) Missing documentation for "path". -// src/schema/createSchemaFromZod.d.ts:4:1 - (ae-undocumented) Missing documentation for "createSchemaFromZod". +// src/schema/createSchemaFromZod.d.ts:7:1 - (ae-undocumented) Missing documentation for "createSchemaFromZod". // src/schema/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "PortableSchema". // src/types.d.ts:11:1 - (ae-undocumented) Missing documentation for "CoreProgressProps". // src/types.d.ts:13:1 - (ae-undocumented) Missing documentation for "CoreNotFoundErrorPageProps". // src/types.d.ts:17:1 - (ae-undocumented) Missing documentation for "CoreErrorBoundaryFallbackProps". // src/wiring/coreExtensionData.d.ts:4:22 - (ae-undocumented) Missing documentation for "coreExtensionData". -// src/wiring/createExtension.d.ts:7:1 - (ae-undocumented) Missing documentation for "AnyExtensionDataMap". -// src/wiring/createExtension.d.ts:13:1 - (ae-undocumented) Missing documentation for "AnyExtensionInputMap". -// src/wiring/createExtension.d.ts:50:1 - (ae-undocumented) Missing documentation for "CreateExtensionOptions". -// src/wiring/createExtension.d.ts:51:5 - (ae-undocumented) Missing documentation for "kind". -// src/wiring/createExtension.d.ts:52:5 - (ae-undocumented) Missing documentation for "namespace". -// src/wiring/createExtension.d.ts:53:5 - (ae-undocumented) Missing documentation for "name". -// src/wiring/createExtension.d.ts:54:5 - (ae-undocumented) Missing documentation for "attachTo". -// src/wiring/createExtension.d.ts:58:5 - (ae-undocumented) Missing documentation for "disabled". -// src/wiring/createExtension.d.ts:59:5 - (ae-undocumented) Missing documentation for "inputs". -// src/wiring/createExtension.d.ts:60:5 - (ae-undocumented) Missing documentation for "output". -// src/wiring/createExtension.d.ts:61:5 - (ae-undocumented) Missing documentation for "configSchema". -// src/wiring/createExtension.d.ts:62:5 - (ae-undocumented) Missing documentation for "factory". -// src/wiring/createExtension.d.ts:69:1 - (ae-undocumented) Missing documentation for "ExtensionDefinition". -// src/wiring/createExtension.d.ts:70:5 - (ae-undocumented) Missing documentation for "$$type". -// src/wiring/createExtension.d.ts:71:5 - (ae-undocumented) Missing documentation for "kind". -// src/wiring/createExtension.d.ts:72:5 - (ae-undocumented) Missing documentation for "namespace". -// src/wiring/createExtension.d.ts:73:5 - (ae-undocumented) Missing documentation for "name". -// src/wiring/createExtension.d.ts:74:5 - (ae-undocumented) Missing documentation for "attachTo". -// src/wiring/createExtension.d.ts:78:5 - (ae-undocumented) Missing documentation for "disabled". -// src/wiring/createExtension.d.ts:79:5 - (ae-undocumented) Missing documentation for "configSchema". -// src/wiring/createExtension.d.ts:82:1 - (ae-undocumented) Missing documentation for "createExtension". +// src/wiring/createExtension.d.ts:8:1 - (ae-undocumented) Missing documentation for "AnyExtensionDataMap". +// src/wiring/createExtension.d.ts:14:1 - (ae-undocumented) Missing documentation for "AnyExtensionInputMap". +// src/wiring/createExtension.d.ts:51:1 - (ae-undocumented) Missing documentation for "CreateExtensionOptions". +// src/wiring/createExtension.d.ts:54:5 - (ae-undocumented) Missing documentation for "kind". +// src/wiring/createExtension.d.ts:55:5 - (ae-undocumented) Missing documentation for "namespace". +// src/wiring/createExtension.d.ts:56:5 - (ae-undocumented) Missing documentation for "name". +// src/wiring/createExtension.d.ts:57:5 - (ae-undocumented) Missing documentation for "attachTo". +// src/wiring/createExtension.d.ts:61:5 - (ae-undocumented) Missing documentation for "disabled". +// src/wiring/createExtension.d.ts:62:5 - (ae-undocumented) Missing documentation for "inputs". +// src/wiring/createExtension.d.ts:63:5 - (ae-undocumented) Missing documentation for "output". +// src/wiring/createExtension.d.ts:65:5 - (ae-undocumented) Missing documentation for "configSchema". +// src/wiring/createExtension.d.ts:66:5 - (ae-undocumented) Missing documentation for "config". +// src/wiring/createExtension.d.ts:69:5 - (ae-undocumented) Missing documentation for "factory". +// src/wiring/createExtension.d.ts:78:1 - (ae-undocumented) Missing documentation for "ExtensionDefinition". +// src/wiring/createExtension.d.ts:79:5 - (ae-undocumented) Missing documentation for "$$type". +// src/wiring/createExtension.d.ts:80:5 - (ae-undocumented) Missing documentation for "kind". +// src/wiring/createExtension.d.ts:81:5 - (ae-undocumented) Missing documentation for "namespace". +// src/wiring/createExtension.d.ts:82:5 - (ae-undocumented) Missing documentation for "name". +// src/wiring/createExtension.d.ts:83:5 - (ae-undocumented) Missing documentation for "attachTo". +// src/wiring/createExtension.d.ts:87:5 - (ae-undocumented) Missing documentation for "disabled". +// src/wiring/createExtension.d.ts:88:5 - (ae-undocumented) Missing documentation for "configSchema". +// src/wiring/createExtension.d.ts:91:1 - (ae-undocumented) Missing documentation for "createExtension". +// src/wiring/createExtensionBlueprint.d.ts:8:1 - (ae-undocumented) Missing documentation for "CreateExtensionBlueprintOptions". +// src/wiring/createExtensionBlueprint.d.ts:11:5 - (ae-undocumented) Missing documentation for "kind". +// src/wiring/createExtensionBlueprint.d.ts:12:5 - (ae-undocumented) Missing documentation for "namespace". +// src/wiring/createExtensionBlueprint.d.ts:13:5 - (ae-undocumented) Missing documentation for "attachTo". +// src/wiring/createExtensionBlueprint.d.ts:17:5 - (ae-undocumented) Missing documentation for "disabled". +// src/wiring/createExtensionBlueprint.d.ts:18:5 - (ae-undocumented) Missing documentation for "inputs". +// src/wiring/createExtensionBlueprint.d.ts:19:5 - (ae-undocumented) Missing documentation for "output". +// src/wiring/createExtensionBlueprint.d.ts:20:5 - (ae-undocumented) Missing documentation for "config". +// src/wiring/createExtensionBlueprint.d.ts:23:5 - (ae-undocumented) Missing documentation for "factory". +// src/wiring/createExtensionBlueprint.d.ts:30:5 - (ae-undocumented) Missing documentation for "dataRefs". +// src/wiring/createExtensionBlueprint.d.ts:35:1 - (ae-undocumented) Missing documentation for "ExtensionBlueprint". +// src/wiring/createExtensionBlueprint.d.ts:40:5 - (ae-undocumented) Missing documentation for "dataRefs". // src/wiring/createExtensionDataRef.d.ts:2:1 - (ae-undocumented) Missing documentation for "ExtensionDataRef". // src/wiring/createExtensionDataRef.d.ts:11:1 - (ae-undocumented) Missing documentation for "ConfigurableExtensionDataRef". // src/wiring/createExtensionDataRef.d.ts:14:5 - (ae-undocumented) Missing documentation for "optional". -// src/wiring/createExtensionDataRef.d.ts:19:1 - (ae-undocumented) Missing documentation for "createExtensionDataRef". +// src/wiring/createExtensionDataRef.d.ts:22:1 - (ae-undocumented) Missing documentation for "createExtensionDataRef". +// src/wiring/createExtensionDataRef.d.ts:24:1 - (ae-undocumented) Missing documentation for "createExtensionDataRef". // src/wiring/createExtensionInput.d.ts:3:1 - (ae-undocumented) Missing documentation for "ExtensionInput". // src/wiring/createExtensionInput.d.ts:7:5 - (ae-undocumented) Missing documentation for "$$type". // src/wiring/createExtensionInput.d.ts:8:5 - (ae-undocumented) Missing documentation for "extensionData". diff --git a/packages/frontend-test-utils/api-report.api.md b/packages/frontend-test-utils/report.api.md similarity index 100% rename from packages/frontend-test-utils/api-report.api.md rename to packages/frontend-test-utils/report.api.md diff --git a/packages/integration-aws-node/api-report.api.md b/packages/integration-aws-node/report.api.md similarity index 100% rename from packages/integration-aws-node/api-report.api.md rename to packages/integration-aws-node/report.api.md diff --git a/packages/integration-react/api-report.api.md b/packages/integration-react/report.api.md similarity index 100% rename from packages/integration-react/api-report.api.md rename to packages/integration-react/report.api.md diff --git a/packages/integration/api-report.api.md b/packages/integration/report.api.md similarity index 100% rename from packages/integration/api-report.api.md rename to packages/integration/report.api.md diff --git a/packages/release-manifests/api-report.api.md b/packages/release-manifests/report.api.md similarity index 100% rename from packages/release-manifests/api-report.api.md rename to packages/release-manifests/report.api.md diff --git a/packages/test-utils/api-report-alpha.api.md b/packages/test-utils/report-alpha.api.md similarity index 100% rename from packages/test-utils/api-report-alpha.api.md rename to packages/test-utils/report-alpha.api.md diff --git a/packages/test-utils/api-report.api.md b/packages/test-utils/report.api.md similarity index 100% rename from packages/test-utils/api-report.api.md rename to packages/test-utils/report.api.md diff --git a/packages/theme/api-report.api.md b/packages/theme/report.api.md similarity index 100% rename from packages/theme/api-report.api.md rename to packages/theme/report.api.md diff --git a/packages/types/api-report.api.md b/packages/types/report.api.md similarity index 100% rename from packages/types/api-report.api.md rename to packages/types/report.api.md diff --git a/packages/version-bridge/api-report.api.md b/packages/version-bridge/report.api.md similarity index 100% rename from packages/version-bridge/api-report.api.md rename to packages/version-bridge/report.api.md diff --git a/packages/yarn-plugin/api-report.api.md b/packages/yarn-plugin/report.api.md similarity index 100% rename from packages/yarn-plugin/api-report.api.md rename to packages/yarn-plugin/report.api.md diff --git a/plugins/api-docs-module-protoc-gen-doc/api-report.api.md b/plugins/api-docs-module-protoc-gen-doc/report.api.md similarity index 100% rename from plugins/api-docs-module-protoc-gen-doc/api-report.api.md rename to plugins/api-docs-module-protoc-gen-doc/report.api.md diff --git a/plugins/api-docs/api-report-alpha.api.md b/plugins/api-docs/report-alpha.api.md similarity index 100% rename from plugins/api-docs/api-report-alpha.api.md rename to plugins/api-docs/report-alpha.api.md diff --git a/plugins/api-docs/api-report.api.md b/plugins/api-docs/report.api.md similarity index 100% rename from plugins/api-docs/api-report.api.md rename to plugins/api-docs/report.api.md diff --git a/plugins/app-backend/api-report-alpha.api.md b/plugins/app-backend/report-alpha.api.md similarity index 100% rename from plugins/app-backend/api-report-alpha.api.md rename to plugins/app-backend/report-alpha.api.md diff --git a/plugins/app-backend/api-report.api.md b/plugins/app-backend/report.api.md similarity index 100% rename from plugins/app-backend/api-report.api.md rename to plugins/app-backend/report.api.md diff --git a/plugins/app-node/api-report.api.md b/plugins/app-node/report.api.md similarity index 100% rename from plugins/app-node/api-report.api.md rename to plugins/app-node/report.api.md diff --git a/plugins/app-visualizer/api-report.api.md b/plugins/app-visualizer/report.api.md similarity index 97% rename from plugins/app-visualizer/api-report.api.md rename to plugins/app-visualizer/report.api.md index 7466ff24f65cd..7495797a79a21 100644 --- a/plugins/app-visualizer/api-report.api.md +++ b/plugins/app-visualizer/report.api.md @@ -73,7 +73,7 @@ export default visualizerPlugin; // Warnings were encountered during analysis: // -// src/plugin.d.ts:5:22 - (ae-undocumented) Missing documentation for "visualizerPlugin". +// src/plugin.d.ts:7:22 - (ae-undocumented) Missing documentation for "visualizerPlugin". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/auth-backend-module-atlassian-provider/api-report.api.md b/plugins/auth-backend-module-atlassian-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-atlassian-provider/api-report.api.md rename to plugins/auth-backend-module-atlassian-provider/report.api.md diff --git a/plugins/auth-backend-module-aws-alb-provider/api-report.api.md b/plugins/auth-backend-module-aws-alb-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-aws-alb-provider/api-report.api.md rename to plugins/auth-backend-module-aws-alb-provider/report.api.md diff --git a/plugins/auth-backend-module-azure-easyauth-provider/api-report.api.md b/plugins/auth-backend-module-azure-easyauth-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-azure-easyauth-provider/api-report.api.md rename to plugins/auth-backend-module-azure-easyauth-provider/report.api.md diff --git a/plugins/auth-backend-module-bitbucket-provider/api-report.api.md b/plugins/auth-backend-module-bitbucket-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-bitbucket-provider/api-report.api.md rename to plugins/auth-backend-module-bitbucket-provider/report.api.md diff --git a/plugins/auth-backend-module-cloudflare-access-provider/api-report.api.md b/plugins/auth-backend-module-cloudflare-access-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-cloudflare-access-provider/api-report.api.md rename to plugins/auth-backend-module-cloudflare-access-provider/report.api.md diff --git a/plugins/auth-backend-module-gcp-iap-provider/api-report.api.md b/plugins/auth-backend-module-gcp-iap-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-gcp-iap-provider/api-report.api.md rename to plugins/auth-backend-module-gcp-iap-provider/report.api.md diff --git a/plugins/auth-backend-module-github-provider/api-report.api.md b/plugins/auth-backend-module-github-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-github-provider/api-report.api.md rename to plugins/auth-backend-module-github-provider/report.api.md diff --git a/plugins/auth-backend-module-gitlab-provider/api-report.api.md b/plugins/auth-backend-module-gitlab-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-gitlab-provider/api-report.api.md rename to plugins/auth-backend-module-gitlab-provider/report.api.md diff --git a/plugins/auth-backend-module-google-provider/api-report.api.md b/plugins/auth-backend-module-google-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-google-provider/api-report.api.md rename to plugins/auth-backend-module-google-provider/report.api.md diff --git a/plugins/auth-backend-module-guest-provider/api-report.api.md b/plugins/auth-backend-module-guest-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-guest-provider/api-report.api.md rename to plugins/auth-backend-module-guest-provider/report.api.md diff --git a/plugins/auth-backend-module-microsoft-provider/api-report.api.md b/plugins/auth-backend-module-microsoft-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-microsoft-provider/api-report.api.md rename to plugins/auth-backend-module-microsoft-provider/report.api.md diff --git a/plugins/auth-backend-module-oauth2-provider/api-report.api.md b/plugins/auth-backend-module-oauth2-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-oauth2-provider/api-report.api.md rename to plugins/auth-backend-module-oauth2-provider/report.api.md diff --git a/plugins/auth-backend-module-oauth2-proxy-provider/api-report.api.md b/plugins/auth-backend-module-oauth2-proxy-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-oauth2-proxy-provider/api-report.api.md rename to plugins/auth-backend-module-oauth2-proxy-provider/report.api.md diff --git a/plugins/auth-backend-module-oidc-provider/api-report.api.md b/plugins/auth-backend-module-oidc-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-oidc-provider/api-report.api.md rename to plugins/auth-backend-module-oidc-provider/report.api.md diff --git a/plugins/auth-backend-module-okta-provider/api-report.api.md b/plugins/auth-backend-module-okta-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-okta-provider/api-report.api.md rename to plugins/auth-backend-module-okta-provider/report.api.md diff --git a/plugins/auth-backend-module-onelogin-provider/api-report.api.md b/plugins/auth-backend-module-onelogin-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-onelogin-provider/api-report.api.md rename to plugins/auth-backend-module-onelogin-provider/report.api.md diff --git a/plugins/auth-backend-module-pinniped-provider/api-report.api.md b/plugins/auth-backend-module-pinniped-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-pinniped-provider/api-report.api.md rename to plugins/auth-backend-module-pinniped-provider/report.api.md diff --git a/plugins/auth-backend-module-vmware-cloud-provider/api-report.api.md b/plugins/auth-backend-module-vmware-cloud-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-vmware-cloud-provider/api-report.api.md rename to plugins/auth-backend-module-vmware-cloud-provider/report.api.md diff --git a/plugins/auth-backend/api-report.api.md b/plugins/auth-backend/report.api.md similarity index 100% rename from plugins/auth-backend/api-report.api.md rename to plugins/auth-backend/report.api.md diff --git a/plugins/auth-node/api-report.api.md b/plugins/auth-node/report.api.md similarity index 100% rename from plugins/auth-node/api-report.api.md rename to plugins/auth-node/report.api.md diff --git a/plugins/auth-react/api-report.api.md b/plugins/auth-react/report.api.md similarity index 100% rename from plugins/auth-react/api-report.api.md rename to plugins/auth-react/report.api.md diff --git a/plugins/bitbucket-cloud-common/api-report.api.md b/plugins/bitbucket-cloud-common/report.api.md similarity index 100% rename from plugins/bitbucket-cloud-common/api-report.api.md rename to plugins/bitbucket-cloud-common/report.api.md diff --git a/plugins/catalog-backend-module-aws/api-report-alpha.api.md b/plugins/catalog-backend-module-aws/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-aws/api-report-alpha.api.md rename to plugins/catalog-backend-module-aws/report-alpha.api.md diff --git a/plugins/catalog-backend-module-aws/api-report.api.md b/plugins/catalog-backend-module-aws/report.api.md similarity index 100% rename from plugins/catalog-backend-module-aws/api-report.api.md rename to plugins/catalog-backend-module-aws/report.api.md diff --git a/plugins/catalog-backend-module-azure/api-report-alpha.api.md b/plugins/catalog-backend-module-azure/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-azure/api-report-alpha.api.md rename to plugins/catalog-backend-module-azure/report-alpha.api.md diff --git a/plugins/catalog-backend-module-azure/api-report.api.md b/plugins/catalog-backend-module-azure/report.api.md similarity index 100% rename from plugins/catalog-backend-module-azure/api-report.api.md rename to plugins/catalog-backend-module-azure/report.api.md diff --git a/plugins/catalog-backend-module-backstage-openapi/api-report.api.md b/plugins/catalog-backend-module-backstage-openapi/report.api.md similarity index 100% rename from plugins/catalog-backend-module-backstage-openapi/api-report.api.md rename to plugins/catalog-backend-module-backstage-openapi/report.api.md diff --git a/plugins/catalog-backend-module-bitbucket-cloud/api-report-alpha.api.md b/plugins/catalog-backend-module-bitbucket-cloud/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-bitbucket-cloud/api-report-alpha.api.md rename to plugins/catalog-backend-module-bitbucket-cloud/report-alpha.api.md diff --git a/plugins/catalog-backend-module-bitbucket-cloud/api-report.api.md b/plugins/catalog-backend-module-bitbucket-cloud/report.api.md similarity index 100% rename from plugins/catalog-backend-module-bitbucket-cloud/api-report.api.md rename to plugins/catalog-backend-module-bitbucket-cloud/report.api.md diff --git a/plugins/catalog-backend-module-bitbucket-server/api-report-alpha.api.md b/plugins/catalog-backend-module-bitbucket-server/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-bitbucket-server/api-report-alpha.api.md rename to plugins/catalog-backend-module-bitbucket-server/report-alpha.api.md diff --git a/plugins/catalog-backend-module-bitbucket-server/api-report.api.md b/plugins/catalog-backend-module-bitbucket-server/report.api.md similarity index 100% rename from plugins/catalog-backend-module-bitbucket-server/api-report.api.md rename to plugins/catalog-backend-module-bitbucket-server/report.api.md diff --git a/plugins/catalog-backend-module-gcp/api-report-alpha.api.md b/plugins/catalog-backend-module-gcp/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-gcp/api-report-alpha.api.md rename to plugins/catalog-backend-module-gcp/report-alpha.api.md diff --git a/plugins/catalog-backend-module-gcp/api-report.api.md b/plugins/catalog-backend-module-gcp/report.api.md similarity index 100% rename from plugins/catalog-backend-module-gcp/api-report.api.md rename to plugins/catalog-backend-module-gcp/report.api.md diff --git a/plugins/catalog-backend-module-gerrit/api-report-alpha.api.md b/plugins/catalog-backend-module-gerrit/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-gerrit/api-report-alpha.api.md rename to plugins/catalog-backend-module-gerrit/report-alpha.api.md diff --git a/plugins/catalog-backend-module-gerrit/api-report.api.md b/plugins/catalog-backend-module-gerrit/report.api.md similarity index 100% rename from plugins/catalog-backend-module-gerrit/api-report.api.md rename to plugins/catalog-backend-module-gerrit/report.api.md diff --git a/plugins/catalog-backend-module-github-org/api-report.api.md b/plugins/catalog-backend-module-github-org/report.api.md similarity index 100% rename from plugins/catalog-backend-module-github-org/api-report.api.md rename to plugins/catalog-backend-module-github-org/report.api.md diff --git a/plugins/catalog-backend-module-github/api-report-alpha.api.md b/plugins/catalog-backend-module-github/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-github/api-report-alpha.api.md rename to plugins/catalog-backend-module-github/report-alpha.api.md diff --git a/plugins/catalog-backend-module-github/api-report.api.md b/plugins/catalog-backend-module-github/report.api.md similarity index 100% rename from plugins/catalog-backend-module-github/api-report.api.md rename to plugins/catalog-backend-module-github/report.api.md diff --git a/plugins/catalog-backend-module-gitlab-org/api-report.api.md b/plugins/catalog-backend-module-gitlab-org/report.api.md similarity index 100% rename from plugins/catalog-backend-module-gitlab-org/api-report.api.md rename to plugins/catalog-backend-module-gitlab-org/report.api.md diff --git a/plugins/catalog-backend-module-gitlab/api-report-alpha.api.md b/plugins/catalog-backend-module-gitlab/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-gitlab/api-report-alpha.api.md rename to plugins/catalog-backend-module-gitlab/report-alpha.api.md diff --git a/plugins/catalog-backend-module-gitlab/api-report.api.md b/plugins/catalog-backend-module-gitlab/report.api.md similarity index 100% rename from plugins/catalog-backend-module-gitlab/api-report.api.md rename to plugins/catalog-backend-module-gitlab/report.api.md diff --git a/plugins/catalog-backend-module-incremental-ingestion/api-report-alpha.api.md b/plugins/catalog-backend-module-incremental-ingestion/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-incremental-ingestion/api-report-alpha.api.md rename to plugins/catalog-backend-module-incremental-ingestion/report-alpha.api.md diff --git a/plugins/catalog-backend-module-incremental-ingestion/api-report.api.md b/plugins/catalog-backend-module-incremental-ingestion/report.api.md similarity index 100% rename from plugins/catalog-backend-module-incremental-ingestion/api-report.api.md rename to plugins/catalog-backend-module-incremental-ingestion/report.api.md diff --git a/plugins/catalog-backend-module-ldap/api-report.api.md b/plugins/catalog-backend-module-ldap/report.api.md similarity index 100% rename from plugins/catalog-backend-module-ldap/api-report.api.md rename to plugins/catalog-backend-module-ldap/report.api.md diff --git a/plugins/catalog-backend-module-logs/api-report.api.md b/plugins/catalog-backend-module-logs/report.api.md similarity index 100% rename from plugins/catalog-backend-module-logs/api-report.api.md rename to plugins/catalog-backend-module-logs/report.api.md diff --git a/plugins/catalog-backend-module-msgraph/api-report-alpha.api.md b/plugins/catalog-backend-module-msgraph/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-msgraph/api-report-alpha.api.md rename to plugins/catalog-backend-module-msgraph/report-alpha.api.md diff --git a/plugins/catalog-backend-module-msgraph/api-report.api.md b/plugins/catalog-backend-module-msgraph/report.api.md similarity index 100% rename from plugins/catalog-backend-module-msgraph/api-report.api.md rename to plugins/catalog-backend-module-msgraph/report.api.md diff --git a/plugins/catalog-backend-module-openapi/api-report.api.md b/plugins/catalog-backend-module-openapi/report.api.md similarity index 100% rename from plugins/catalog-backend-module-openapi/api-report.api.md rename to plugins/catalog-backend-module-openapi/report.api.md diff --git a/plugins/catalog-backend-module-puppetdb/api-report-alpha.api.md b/plugins/catalog-backend-module-puppetdb/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-puppetdb/api-report-alpha.api.md rename to plugins/catalog-backend-module-puppetdb/report-alpha.api.md diff --git a/plugins/catalog-backend-module-puppetdb/api-report.api.md b/plugins/catalog-backend-module-puppetdb/report.api.md similarity index 100% rename from plugins/catalog-backend-module-puppetdb/api-report.api.md rename to plugins/catalog-backend-module-puppetdb/report.api.md diff --git a/plugins/catalog-backend-module-scaffolder-entity-model/api-report.api.md b/plugins/catalog-backend-module-scaffolder-entity-model/report.api.md similarity index 100% rename from plugins/catalog-backend-module-scaffolder-entity-model/api-report.api.md rename to plugins/catalog-backend-module-scaffolder-entity-model/report.api.md diff --git a/plugins/catalog-backend-module-unprocessed/api-report.api.md b/plugins/catalog-backend-module-unprocessed/report.api.md similarity index 100% rename from plugins/catalog-backend-module-unprocessed/api-report.api.md rename to plugins/catalog-backend-module-unprocessed/report.api.md diff --git a/plugins/catalog-backend/api-report-alpha.api.md b/plugins/catalog-backend/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend/api-report-alpha.api.md rename to plugins/catalog-backend/report-alpha.api.md diff --git a/plugins/catalog-backend/api-report.api.md b/plugins/catalog-backend/report.api.md similarity index 100% rename from plugins/catalog-backend/api-report.api.md rename to plugins/catalog-backend/report.api.md diff --git a/plugins/catalog-common/api-report-alpha.api.md b/plugins/catalog-common/report-alpha.api.md similarity index 100% rename from plugins/catalog-common/api-report-alpha.api.md rename to plugins/catalog-common/report-alpha.api.md diff --git a/plugins/catalog-common/api-report.api.md b/plugins/catalog-common/report.api.md similarity index 100% rename from plugins/catalog-common/api-report.api.md rename to plugins/catalog-common/report.api.md diff --git a/plugins/catalog-graph/api-report-alpha.api.md b/plugins/catalog-graph/report-alpha.api.md similarity index 100% rename from plugins/catalog-graph/api-report-alpha.api.md rename to plugins/catalog-graph/report-alpha.api.md diff --git a/plugins/catalog-graph/api-report.api.md b/plugins/catalog-graph/report.api.md similarity index 100% rename from plugins/catalog-graph/api-report.api.md rename to plugins/catalog-graph/report.api.md diff --git a/plugins/catalog-import/api-report-alpha.api.md b/plugins/catalog-import/report-alpha.api.md similarity index 100% rename from plugins/catalog-import/api-report-alpha.api.md rename to plugins/catalog-import/report-alpha.api.md diff --git a/plugins/catalog-import/api-report.api.md b/plugins/catalog-import/report.api.md similarity index 100% rename from plugins/catalog-import/api-report.api.md rename to plugins/catalog-import/report.api.md diff --git a/plugins/catalog-node/api-report-alpha.api.md b/plugins/catalog-node/report-alpha.api.md similarity index 100% rename from plugins/catalog-node/api-report-alpha.api.md rename to plugins/catalog-node/report-alpha.api.md diff --git a/plugins/catalog-node/api-report.api.md b/plugins/catalog-node/report.api.md similarity index 100% rename from plugins/catalog-node/api-report.api.md rename to plugins/catalog-node/report.api.md diff --git a/plugins/catalog-react/api-report-alpha.api.md b/plugins/catalog-react/report-alpha.api.md similarity index 100% rename from plugins/catalog-react/api-report-alpha.api.md rename to plugins/catalog-react/report-alpha.api.md diff --git a/plugins/catalog-react/api-report.api.md b/plugins/catalog-react/report.api.md similarity index 100% rename from plugins/catalog-react/api-report.api.md rename to plugins/catalog-react/report.api.md diff --git a/plugins/catalog-unprocessed-entities-common/api-report.api.md b/plugins/catalog-unprocessed-entities-common/report.api.md similarity index 100% rename from plugins/catalog-unprocessed-entities-common/api-report.api.md rename to plugins/catalog-unprocessed-entities-common/report.api.md diff --git a/plugins/catalog-unprocessed-entities/api-report.api.md b/plugins/catalog-unprocessed-entities/report.api.md similarity index 100% rename from plugins/catalog-unprocessed-entities/api-report.api.md rename to plugins/catalog-unprocessed-entities/report.api.md diff --git a/plugins/catalog/api-report-alpha.api.md b/plugins/catalog/report-alpha.api.md similarity index 100% rename from plugins/catalog/api-report-alpha.api.md rename to plugins/catalog/report-alpha.api.md diff --git a/plugins/catalog/api-report.api.md b/plugins/catalog/report.api.md similarity index 100% rename from plugins/catalog/api-report.api.md rename to plugins/catalog/report.api.md diff --git a/plugins/config-schema/api-report.api.md b/plugins/config-schema/report.api.md similarity index 100% rename from plugins/config-schema/api-report.api.md rename to plugins/config-schema/report.api.md diff --git a/plugins/devtools-backend/api-report.api.md b/plugins/devtools-backend/report.api.md similarity index 100% rename from plugins/devtools-backend/api-report.api.md rename to plugins/devtools-backend/report.api.md diff --git a/plugins/devtools-common/api-report.api.md b/plugins/devtools-common/report.api.md similarity index 100% rename from plugins/devtools-common/api-report.api.md rename to plugins/devtools-common/report.api.md diff --git a/plugins/devtools/api-report-alpha.api.md b/plugins/devtools/report-alpha.api.md similarity index 97% rename from plugins/devtools/api-report-alpha.api.md rename to plugins/devtools/report-alpha.api.md index 5db9e75117574..dbf690bc09907 100644 --- a/plugins/devtools/api-report-alpha.api.md +++ b/plugins/devtools/report-alpha.api.md @@ -91,7 +91,7 @@ export default _default; // Warnings were encountered during analysis: // -// src/alpha/plugin.d.ts:12:15 - (ae-undocumented) Missing documentation for "_default". +// src/alpha/plugin.d.ts:16:15 - (ae-undocumented) Missing documentation for "_default". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/devtools/api-report.api.md b/plugins/devtools/report.api.md similarity index 100% rename from plugins/devtools/api-report.api.md rename to plugins/devtools/report.api.md diff --git a/plugins/events-backend-module-aws-sqs/api-report-alpha.api.md b/plugins/events-backend-module-aws-sqs/report-alpha.api.md similarity index 100% rename from plugins/events-backend-module-aws-sqs/api-report-alpha.api.md rename to plugins/events-backend-module-aws-sqs/report-alpha.api.md diff --git a/plugins/events-backend-module-aws-sqs/api-report.api.md b/plugins/events-backend-module-aws-sqs/report.api.md similarity index 100% rename from plugins/events-backend-module-aws-sqs/api-report.api.md rename to plugins/events-backend-module-aws-sqs/report.api.md diff --git a/plugins/events-backend-module-azure/api-report-alpha.api.md b/plugins/events-backend-module-azure/report-alpha.api.md similarity index 100% rename from plugins/events-backend-module-azure/api-report-alpha.api.md rename to plugins/events-backend-module-azure/report-alpha.api.md diff --git a/plugins/events-backend-module-azure/api-report.api.md b/plugins/events-backend-module-azure/report.api.md similarity index 100% rename from plugins/events-backend-module-azure/api-report.api.md rename to plugins/events-backend-module-azure/report.api.md diff --git a/plugins/events-backend-module-bitbucket-cloud/api-report-alpha.api.md b/plugins/events-backend-module-bitbucket-cloud/report-alpha.api.md similarity index 100% rename from plugins/events-backend-module-bitbucket-cloud/api-report-alpha.api.md rename to plugins/events-backend-module-bitbucket-cloud/report-alpha.api.md diff --git a/plugins/events-backend-module-bitbucket-cloud/api-report.api.md b/plugins/events-backend-module-bitbucket-cloud/report.api.md similarity index 100% rename from plugins/events-backend-module-bitbucket-cloud/api-report.api.md rename to plugins/events-backend-module-bitbucket-cloud/report.api.md diff --git a/plugins/events-backend-module-gerrit/api-report-alpha.api.md b/plugins/events-backend-module-gerrit/report-alpha.api.md similarity index 100% rename from plugins/events-backend-module-gerrit/api-report-alpha.api.md rename to plugins/events-backend-module-gerrit/report-alpha.api.md diff --git a/plugins/events-backend-module-gerrit/api-report.api.md b/plugins/events-backend-module-gerrit/report.api.md similarity index 100% rename from plugins/events-backend-module-gerrit/api-report.api.md rename to plugins/events-backend-module-gerrit/report.api.md diff --git a/plugins/events-backend-module-github/api-report-alpha.api.md b/plugins/events-backend-module-github/report-alpha.api.md similarity index 100% rename from plugins/events-backend-module-github/api-report-alpha.api.md rename to plugins/events-backend-module-github/report-alpha.api.md diff --git a/plugins/events-backend-module-github/api-report.api.md b/plugins/events-backend-module-github/report.api.md similarity index 100% rename from plugins/events-backend-module-github/api-report.api.md rename to plugins/events-backend-module-github/report.api.md diff --git a/plugins/events-backend-module-gitlab/api-report-alpha.api.md b/plugins/events-backend-module-gitlab/report-alpha.api.md similarity index 100% rename from plugins/events-backend-module-gitlab/api-report-alpha.api.md rename to plugins/events-backend-module-gitlab/report-alpha.api.md diff --git a/plugins/events-backend-module-gitlab/api-report.api.md b/plugins/events-backend-module-gitlab/report.api.md similarity index 100% rename from plugins/events-backend-module-gitlab/api-report.api.md rename to plugins/events-backend-module-gitlab/report.api.md diff --git a/plugins/events-backend-test-utils/api-report.api.md b/plugins/events-backend-test-utils/report.api.md similarity index 100% rename from plugins/events-backend-test-utils/api-report.api.md rename to plugins/events-backend-test-utils/report.api.md diff --git a/plugins/events-backend/api-report-alpha.api.md b/plugins/events-backend/report-alpha.api.md similarity index 100% rename from plugins/events-backend/api-report-alpha.api.md rename to plugins/events-backend/report-alpha.api.md diff --git a/plugins/events-backend/api-report.api.md b/plugins/events-backend/report.api.md similarity index 100% rename from plugins/events-backend/api-report.api.md rename to plugins/events-backend/report.api.md diff --git a/plugins/events-node/api-report-alpha.api.md b/plugins/events-node/report-alpha.api.md similarity index 100% rename from plugins/events-node/api-report-alpha.api.md rename to plugins/events-node/report-alpha.api.md diff --git a/plugins/events-node/api-report.api.md b/plugins/events-node/report.api.md similarity index 100% rename from plugins/events-node/api-report.api.md rename to plugins/events-node/report.api.md diff --git a/plugins/example-todo-list-backend/api-report.api.md b/plugins/example-todo-list-backend/report.api.md similarity index 100% rename from plugins/example-todo-list-backend/api-report.api.md rename to plugins/example-todo-list-backend/report.api.md diff --git a/plugins/example-todo-list-common/api-report.api.md b/plugins/example-todo-list-common/report.api.md similarity index 100% rename from plugins/example-todo-list-common/api-report.api.md rename to plugins/example-todo-list-common/report.api.md diff --git a/plugins/example-todo-list/api-report.api.md b/plugins/example-todo-list/report.api.md similarity index 100% rename from plugins/example-todo-list/api-report.api.md rename to plugins/example-todo-list/report.api.md diff --git a/plugins/home-react/api-report.api.md b/plugins/home-react/report.api.md similarity index 100% rename from plugins/home-react/api-report.api.md rename to plugins/home-react/report.api.md diff --git a/plugins/home/api-report-alpha.api.md b/plugins/home/report-alpha.api.md similarity index 100% rename from plugins/home/api-report-alpha.api.md rename to plugins/home/report-alpha.api.md diff --git a/plugins/home/api-report.api.md b/plugins/home/report.api.md similarity index 100% rename from plugins/home/api-report.api.md rename to plugins/home/report.api.md diff --git a/plugins/kubernetes-backend/api-report-alpha.api.md b/plugins/kubernetes-backend/report-alpha.api.md similarity index 100% rename from plugins/kubernetes-backend/api-report-alpha.api.md rename to plugins/kubernetes-backend/report-alpha.api.md diff --git a/plugins/kubernetes-backend/api-report.api.md b/plugins/kubernetes-backend/report.api.md similarity index 100% rename from plugins/kubernetes-backend/api-report.api.md rename to plugins/kubernetes-backend/report.api.md diff --git a/plugins/kubernetes-cluster/api-report.api.md b/plugins/kubernetes-cluster/report.api.md similarity index 100% rename from plugins/kubernetes-cluster/api-report.api.md rename to plugins/kubernetes-cluster/report.api.md diff --git a/plugins/kubernetes-common/api-report.api.md b/plugins/kubernetes-common/report.api.md similarity index 100% rename from plugins/kubernetes-common/api-report.api.md rename to plugins/kubernetes-common/report.api.md diff --git a/plugins/kubernetes-node/api-report.api.md b/plugins/kubernetes-node/report.api.md similarity index 100% rename from plugins/kubernetes-node/api-report.api.md rename to plugins/kubernetes-node/report.api.md diff --git a/plugins/kubernetes-react/api-report.api.md b/plugins/kubernetes-react/report.api.md similarity index 100% rename from plugins/kubernetes-react/api-report.api.md rename to plugins/kubernetes-react/report.api.md diff --git a/plugins/kubernetes/api-report-alpha.md b/plugins/kubernetes/report-alpha.api.md similarity index 97% rename from plugins/kubernetes/api-report-alpha.md rename to plugins/kubernetes/report-alpha.api.md index 9ba748577fd08..f257d56587662 100644 --- a/plugins/kubernetes/api-report-alpha.md +++ b/plugins/kubernetes/report-alpha.api.md @@ -162,5 +162,9 @@ const _default: FrontendPlugin< >; export default _default; +// Warnings were encountered during analysis: +// +// src/alpha/plugin.d.ts:1:15 - (ae-undocumented) Missing documentation for "_default". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/kubernetes/api-report.api.md b/plugins/kubernetes/report.api.md similarity index 100% rename from plugins/kubernetes/api-report.api.md rename to plugins/kubernetes/report.api.md diff --git a/plugins/notifications-backend-module-email/api-report.api.md b/plugins/notifications-backend-module-email/report.api.md similarity index 100% rename from plugins/notifications-backend-module-email/api-report.api.md rename to plugins/notifications-backend-module-email/report.api.md diff --git a/plugins/notifications-backend/api-report.api.md b/plugins/notifications-backend/report.api.md similarity index 100% rename from plugins/notifications-backend/api-report.api.md rename to plugins/notifications-backend/report.api.md diff --git a/plugins/notifications-common/api-report.api.md b/plugins/notifications-common/report.api.md similarity index 100% rename from plugins/notifications-common/api-report.api.md rename to plugins/notifications-common/report.api.md diff --git a/plugins/notifications-node/api-report.api.md b/plugins/notifications-node/report.api.md similarity index 100% rename from plugins/notifications-node/api-report.api.md rename to plugins/notifications-node/report.api.md diff --git a/plugins/notifications/api-report.api.md b/plugins/notifications/report.api.md similarity index 100% rename from plugins/notifications/api-report.api.md rename to plugins/notifications/report.api.md diff --git a/plugins/org-react/api-report.api.md b/plugins/org-react/report.api.md similarity index 100% rename from plugins/org-react/api-report.api.md rename to plugins/org-react/report.api.md diff --git a/plugins/org/api-report-alpha.api.md b/plugins/org/report-alpha.api.md similarity index 100% rename from plugins/org/api-report-alpha.api.md rename to plugins/org/report-alpha.api.md diff --git a/plugins/org/api-report.api.md b/plugins/org/report.api.md similarity index 100% rename from plugins/org/api-report.api.md rename to plugins/org/report.api.md diff --git a/plugins/permission-backend-module-policy-allow-all/api-report.api.md b/plugins/permission-backend-module-policy-allow-all/report.api.md similarity index 100% rename from plugins/permission-backend-module-policy-allow-all/api-report.api.md rename to plugins/permission-backend-module-policy-allow-all/report.api.md diff --git a/plugins/permission-backend/api-report-alpha.api.md b/plugins/permission-backend/report-alpha.api.md similarity index 100% rename from plugins/permission-backend/api-report-alpha.api.md rename to plugins/permission-backend/report-alpha.api.md diff --git a/plugins/permission-backend/api-report.api.md b/plugins/permission-backend/report.api.md similarity index 100% rename from plugins/permission-backend/api-report.api.md rename to plugins/permission-backend/report.api.md diff --git a/plugins/permission-common/api-report.api.md b/plugins/permission-common/report.api.md similarity index 100% rename from plugins/permission-common/api-report.api.md rename to plugins/permission-common/report.api.md diff --git a/plugins/permission-node/api-report-alpha.api.md b/plugins/permission-node/report-alpha.api.md similarity index 100% rename from plugins/permission-node/api-report-alpha.api.md rename to plugins/permission-node/report-alpha.api.md diff --git a/plugins/permission-node/api-report.api.md b/plugins/permission-node/report.api.md similarity index 100% rename from plugins/permission-node/api-report.api.md rename to plugins/permission-node/report.api.md diff --git a/plugins/permission-react/api-report.api.md b/plugins/permission-react/report.api.md similarity index 100% rename from plugins/permission-react/api-report.api.md rename to plugins/permission-react/report.api.md diff --git a/plugins/proxy-backend/api-report-alpha.api.md b/plugins/proxy-backend/report-alpha.api.md similarity index 100% rename from plugins/proxy-backend/api-report-alpha.api.md rename to plugins/proxy-backend/report-alpha.api.md diff --git a/plugins/proxy-backend/api-report.api.md b/plugins/proxy-backend/report.api.md similarity index 100% rename from plugins/proxy-backend/api-report.api.md rename to plugins/proxy-backend/report.api.md diff --git a/plugins/scaffolder-backend-module-azure/api-report.api.md b/plugins/scaffolder-backend-module-azure/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-azure/api-report.api.md rename to plugins/scaffolder-backend-module-azure/report.api.md diff --git a/plugins/scaffolder-backend-module-bitbucket-cloud/api-report.api.md b/plugins/scaffolder-backend-module-bitbucket-cloud/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-bitbucket-cloud/api-report.api.md rename to plugins/scaffolder-backend-module-bitbucket-cloud/report.api.md diff --git a/plugins/scaffolder-backend-module-bitbucket-server/api-report.api.md b/plugins/scaffolder-backend-module-bitbucket-server/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-bitbucket-server/api-report.api.md rename to plugins/scaffolder-backend-module-bitbucket-server/report.api.md diff --git a/plugins/scaffolder-backend-module-bitbucket/api-report.api.md b/plugins/scaffolder-backend-module-bitbucket/report.api.md similarity index 90% rename from plugins/scaffolder-backend-module-bitbucket/api-report.api.md rename to plugins/scaffolder-backend-module-bitbucket/report.api.md index 34c9eb8c672d7..8721760248c35 100644 --- a/plugins/scaffolder-backend-module-bitbucket/api-report.api.md +++ b/plugins/scaffolder-backend-module-bitbucket/report.api.md @@ -59,8 +59,8 @@ export const createPublishBitbucketServerPullRequestAction: typeof bitbucketServ // Warnings were encountered during analysis: // -// src/deprecated.d.ts:7:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketCloudAction". -// src/deprecated.d.ts:11:22 - (ae-undocumented) Missing documentation for "createBitbucketPipelinesRunAction". -// src/deprecated.d.ts:22:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerAction". -// src/deprecated.d.ts:26:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerPullRequestAction". +// src/deprecated.d.ts:8:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketCloudAction". +// src/deprecated.d.ts:13:22 - (ae-undocumented) Missing documentation for "createBitbucketPipelinesRunAction". +// src/deprecated.d.ts:29:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerAction". +// src/deprecated.d.ts:34:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerPullRequestAction". ``` diff --git a/plugins/scaffolder-backend-module-confluence-to-markdown/api-report.api.md b/plugins/scaffolder-backend-module-confluence-to-markdown/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-confluence-to-markdown/api-report.api.md rename to plugins/scaffolder-backend-module-confluence-to-markdown/report.api.md diff --git a/plugins/scaffolder-backend-module-cookiecutter/api-report.api.md b/plugins/scaffolder-backend-module-cookiecutter/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-cookiecutter/api-report.api.md rename to plugins/scaffolder-backend-module-cookiecutter/report.api.md diff --git a/plugins/scaffolder-backend-module-gcp/api-report.api.md b/plugins/scaffolder-backend-module-gcp/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-gcp/api-report.api.md rename to plugins/scaffolder-backend-module-gcp/report.api.md diff --git a/plugins/scaffolder-backend-module-gerrit/api-report.api.md b/plugins/scaffolder-backend-module-gerrit/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-gerrit/api-report.api.md rename to plugins/scaffolder-backend-module-gerrit/report.api.md diff --git a/plugins/scaffolder-backend-module-gitea/api-report.api.md b/plugins/scaffolder-backend-module-gitea/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-gitea/api-report.api.md rename to plugins/scaffolder-backend-module-gitea/report.api.md diff --git a/plugins/scaffolder-backend-module-github/api-report.api.md b/plugins/scaffolder-backend-module-github/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-github/api-report.api.md rename to plugins/scaffolder-backend-module-github/report.api.md diff --git a/plugins/scaffolder-backend-module-gitlab/api-report.api.md b/plugins/scaffolder-backend-module-gitlab/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-gitlab/api-report.api.md rename to plugins/scaffolder-backend-module-gitlab/report.api.md diff --git a/plugins/scaffolder-backend-module-notifications/api-report.api.md b/plugins/scaffolder-backend-module-notifications/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-notifications/api-report.api.md rename to plugins/scaffolder-backend-module-notifications/report.api.md diff --git a/plugins/scaffolder-backend-module-rails/api-report.api.md b/plugins/scaffolder-backend-module-rails/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-rails/api-report.api.md rename to plugins/scaffolder-backend-module-rails/report.api.md diff --git a/plugins/scaffolder-backend-module-sentry/api-report.api.md b/plugins/scaffolder-backend-module-sentry/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-sentry/api-report.api.md rename to plugins/scaffolder-backend-module-sentry/report.api.md diff --git a/plugins/scaffolder-backend-module-yeoman/api-report.api.md b/plugins/scaffolder-backend-module-yeoman/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-yeoman/api-report.api.md rename to plugins/scaffolder-backend-module-yeoman/report.api.md diff --git a/plugins/scaffolder-backend/api-report-alpha.api.md b/plugins/scaffolder-backend/report-alpha.api.md similarity index 100% rename from plugins/scaffolder-backend/api-report-alpha.api.md rename to plugins/scaffolder-backend/report-alpha.api.md diff --git a/plugins/scaffolder-backend/api-report.api.md b/plugins/scaffolder-backend/report.api.md similarity index 96% rename from plugins/scaffolder-backend/api-report.api.md rename to plugins/scaffolder-backend/report.api.md index 082e0baaa5d4b..f51d75652810a 100644 --- a/plugins/scaffolder-backend/api-report.api.md +++ b/plugins/scaffolder-backend/report.api.md @@ -848,25 +848,25 @@ export type TemplatePermissionRuleInput< // src/scaffolder/actions/TemplateActionRegistry.d.ts:9:5 - (ae-undocumented) Missing documentation for "get". // src/scaffolder/actions/TemplateActionRegistry.d.ts:10:5 - (ae-undocumented) Missing documentation for "list". // src/scaffolder/actions/builtin/createBuiltinActions.d.ts:37:5 - (ae-undocumented) Missing documentation for "additionalTemplateGlobals". -// src/scaffolder/actions/deprecated.d.ts:11:22 - (ae-undocumented) Missing documentation for "createGithubActionsDispatchAction". -// src/scaffolder/actions/deprecated.d.ts:15:22 - (ae-undocumented) Missing documentation for "createGithubDeployKeyAction". -// src/scaffolder/actions/deprecated.d.ts:19:22 - (ae-undocumented) Missing documentation for "createGithubEnvironmentAction". -// src/scaffolder/actions/deprecated.d.ts:23:22 - (ae-undocumented) Missing documentation for "createGithubIssuesLabelAction". -// src/scaffolder/actions/deprecated.d.ts:27:1 - (ae-undocumented) Missing documentation for "CreateGithubPullRequestActionOptions". -// src/scaffolder/actions/deprecated.d.ts:31:22 - (ae-undocumented) Missing documentation for "createGithubRepoCreateAction". -// src/scaffolder/actions/deprecated.d.ts:35:22 - (ae-undocumented) Missing documentation for "createGithubRepoPushAction". -// src/scaffolder/actions/deprecated.d.ts:39:22 - (ae-undocumented) Missing documentation for "createGithubWebhookAction". -// src/scaffolder/actions/deprecated.d.ts:43:22 - (ae-undocumented) Missing documentation for "createPublishGithubAction". -// src/scaffolder/actions/deprecated.d.ts:47:22 - (ae-undocumented) Missing documentation for "createPublishGithubPullRequestAction". -// src/scaffolder/actions/deprecated.d.ts:69:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketAction". -// src/scaffolder/actions/deprecated.d.ts:73:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketCloudAction". -// src/scaffolder/actions/deprecated.d.ts:77:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerAction". -// src/scaffolder/actions/deprecated.d.ts:81:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerPullRequestAction". -// src/scaffolder/actions/deprecated.d.ts:85:22 - (ae-undocumented) Missing documentation for "createPublishAzureAction". -// src/scaffolder/actions/deprecated.d.ts:89:22 - (ae-undocumented) Missing documentation for "createPublishGerritAction". -// src/scaffolder/actions/deprecated.d.ts:93:22 - (ae-undocumented) Missing documentation for "createPublishGerritReviewAction". -// src/scaffolder/actions/deprecated.d.ts:97:22 - (ae-undocumented) Missing documentation for "createPublishGitlabAction". -// src/scaffolder/actions/deprecated.d.ts:101:22 - (ae-undocumented) Missing documentation for "createPublishGitlabMergeRequestAction". +// src/scaffolder/actions/deprecated.d.ts:12:22 - (ae-undocumented) Missing documentation for "createGithubActionsDispatchAction". +// src/scaffolder/actions/deprecated.d.ts:17:22 - (ae-undocumented) Missing documentation for "createGithubDeployKeyAction". +// src/scaffolder/actions/deprecated.d.ts:22:22 - (ae-undocumented) Missing documentation for "createGithubEnvironmentAction". +// src/scaffolder/actions/deprecated.d.ts:27:22 - (ae-undocumented) Missing documentation for "createGithubIssuesLabelAction". +// src/scaffolder/actions/deprecated.d.ts:32:1 - (ae-undocumented) Missing documentation for "CreateGithubPullRequestActionOptions". +// src/scaffolder/actions/deprecated.d.ts:37:22 - (ae-undocumented) Missing documentation for "createGithubRepoCreateAction". +// src/scaffolder/actions/deprecated.d.ts:42:22 - (ae-undocumented) Missing documentation for "createGithubRepoPushAction". +// src/scaffolder/actions/deprecated.d.ts:47:22 - (ae-undocumented) Missing documentation for "createGithubWebhookAction". +// src/scaffolder/actions/deprecated.d.ts:52:22 - (ae-undocumented) Missing documentation for "createPublishGithubAction". +// src/scaffolder/actions/deprecated.d.ts:57:22 - (ae-undocumented) Missing documentation for "createPublishGithubPullRequestAction". +// src/scaffolder/actions/deprecated.d.ts:79:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketAction". +// src/scaffolder/actions/deprecated.d.ts:84:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketCloudAction". +// src/scaffolder/actions/deprecated.d.ts:89:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerAction". +// src/scaffolder/actions/deprecated.d.ts:94:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerPullRequestAction". +// src/scaffolder/actions/deprecated.d.ts:99:22 - (ae-undocumented) Missing documentation for "createPublishAzureAction". +// src/scaffolder/actions/deprecated.d.ts:104:22 - (ae-undocumented) Missing documentation for "createPublishGerritAction". +// src/scaffolder/actions/deprecated.d.ts:109:22 - (ae-undocumented) Missing documentation for "createPublishGerritReviewAction". +// src/scaffolder/actions/deprecated.d.ts:114:22 - (ae-undocumented) Missing documentation for "createPublishGitlabAction". +// src/scaffolder/actions/deprecated.d.ts:119:22 - (ae-undocumented) Missing documentation for "createPublishGitlabMergeRequestAction". // src/scaffolder/tasks/DatabaseTaskStore.d.ts:41:5 - (ae-undocumented) Missing documentation for "create". // src/scaffolder/tasks/DatabaseTaskStore.d.ts:48:5 - (ae-undocumented) Missing documentation for "list". // src/scaffolder/tasks/DatabaseTaskStore.d.ts:53:5 - (ae-undocumented) Missing documentation for "getTask". diff --git a/plugins/scaffolder-common/api-report-alpha.api.md b/plugins/scaffolder-common/report-alpha.api.md similarity index 100% rename from plugins/scaffolder-common/api-report-alpha.api.md rename to plugins/scaffolder-common/report-alpha.api.md diff --git a/plugins/scaffolder-common/api-report.api.md b/plugins/scaffolder-common/report.api.md similarity index 100% rename from plugins/scaffolder-common/api-report.api.md rename to plugins/scaffolder-common/report.api.md diff --git a/plugins/scaffolder-node-test-utils/api-report.api.md b/plugins/scaffolder-node-test-utils/report.api.md similarity index 100% rename from plugins/scaffolder-node-test-utils/api-report.api.md rename to plugins/scaffolder-node-test-utils/report.api.md diff --git a/plugins/scaffolder-node/api-report-alpha.api.md b/plugins/scaffolder-node/report-alpha.api.md similarity index 100% rename from plugins/scaffolder-node/api-report-alpha.api.md rename to plugins/scaffolder-node/report-alpha.api.md diff --git a/plugins/scaffolder-node/api-report.api.md b/plugins/scaffolder-node/report.api.md similarity index 100% rename from plugins/scaffolder-node/api-report.api.md rename to plugins/scaffolder-node/report.api.md diff --git a/plugins/scaffolder-react/api-report-alpha.api.md b/plugins/scaffolder-react/report-alpha.api.md similarity index 100% rename from plugins/scaffolder-react/api-report-alpha.api.md rename to plugins/scaffolder-react/report-alpha.api.md diff --git a/plugins/scaffolder-react/api-report.api.md b/plugins/scaffolder-react/report.api.md similarity index 100% rename from plugins/scaffolder-react/api-report.api.md rename to plugins/scaffolder-react/report.api.md diff --git a/plugins/scaffolder/api-report-alpha.api.md b/plugins/scaffolder/report-alpha.api.md similarity index 100% rename from plugins/scaffolder/api-report-alpha.api.md rename to plugins/scaffolder/report-alpha.api.md diff --git a/plugins/scaffolder/api-report.api.md b/plugins/scaffolder/report.api.md similarity index 100% rename from plugins/scaffolder/api-report.api.md rename to plugins/scaffolder/report.api.md diff --git a/plugins/search-backend-module-catalog/api-report-alpha.api.md b/plugins/search-backend-module-catalog/report-alpha.api.md similarity index 100% rename from plugins/search-backend-module-catalog/api-report-alpha.api.md rename to plugins/search-backend-module-catalog/report-alpha.api.md diff --git a/plugins/search-backend-module-catalog/api-report.api.md b/plugins/search-backend-module-catalog/report.api.md similarity index 100% rename from plugins/search-backend-module-catalog/api-report.api.md rename to plugins/search-backend-module-catalog/report.api.md diff --git a/plugins/search-backend-module-elasticsearch/api-report-alpha.api.md b/plugins/search-backend-module-elasticsearch/report-alpha.api.md similarity index 100% rename from plugins/search-backend-module-elasticsearch/api-report-alpha.api.md rename to plugins/search-backend-module-elasticsearch/report-alpha.api.md diff --git a/plugins/search-backend-module-elasticsearch/api-report.api.md b/plugins/search-backend-module-elasticsearch/report.api.md similarity index 100% rename from plugins/search-backend-module-elasticsearch/api-report.api.md rename to plugins/search-backend-module-elasticsearch/report.api.md diff --git a/plugins/search-backend-module-explore/api-report-alpha.api.md b/plugins/search-backend-module-explore/report-alpha.api.md similarity index 100% rename from plugins/search-backend-module-explore/api-report-alpha.api.md rename to plugins/search-backend-module-explore/report-alpha.api.md diff --git a/plugins/search-backend-module-explore/api-report.api.md b/plugins/search-backend-module-explore/report.api.md similarity index 100% rename from plugins/search-backend-module-explore/api-report.api.md rename to plugins/search-backend-module-explore/report.api.md diff --git a/plugins/search-backend-module-pg/api-report-alpha.api.md b/plugins/search-backend-module-pg/report-alpha.api.md similarity index 100% rename from plugins/search-backend-module-pg/api-report-alpha.api.md rename to plugins/search-backend-module-pg/report-alpha.api.md diff --git a/plugins/search-backend-module-pg/api-report.api.md b/plugins/search-backend-module-pg/report.api.md similarity index 100% rename from plugins/search-backend-module-pg/api-report.api.md rename to plugins/search-backend-module-pg/report.api.md diff --git a/plugins/search-backend-module-stack-overflow-collator/api-report.api.md b/plugins/search-backend-module-stack-overflow-collator/report.api.md similarity index 100% rename from plugins/search-backend-module-stack-overflow-collator/api-report.api.md rename to plugins/search-backend-module-stack-overflow-collator/report.api.md diff --git a/plugins/search-backend-module-techdocs/api-report-alpha.api.md b/plugins/search-backend-module-techdocs/report-alpha.api.md similarity index 100% rename from plugins/search-backend-module-techdocs/api-report-alpha.api.md rename to plugins/search-backend-module-techdocs/report-alpha.api.md diff --git a/plugins/search-backend-module-techdocs/api-report.api.md b/plugins/search-backend-module-techdocs/report.api.md similarity index 100% rename from plugins/search-backend-module-techdocs/api-report.api.md rename to plugins/search-backend-module-techdocs/report.api.md diff --git a/plugins/search-backend-node/api-report-alpha.api.md b/plugins/search-backend-node/report-alpha.api.md similarity index 100% rename from plugins/search-backend-node/api-report-alpha.api.md rename to plugins/search-backend-node/report-alpha.api.md diff --git a/plugins/search-backend-node/api-report.api.md b/plugins/search-backend-node/report.api.md similarity index 100% rename from plugins/search-backend-node/api-report.api.md rename to plugins/search-backend-node/report.api.md diff --git a/plugins/search-backend/api-report-alpha.api.md b/plugins/search-backend/report-alpha.api.md similarity index 100% rename from plugins/search-backend/api-report-alpha.api.md rename to plugins/search-backend/report-alpha.api.md diff --git a/plugins/search-backend/api-report.api.md b/plugins/search-backend/report.api.md similarity index 100% rename from plugins/search-backend/api-report.api.md rename to plugins/search-backend/report.api.md diff --git a/plugins/search-common/api-report.api.md b/plugins/search-common/report.api.md similarity index 100% rename from plugins/search-common/api-report.api.md rename to plugins/search-common/report.api.md diff --git a/plugins/search-react/api-report-alpha.api.md b/plugins/search-react/report-alpha.api.md similarity index 100% rename from plugins/search-react/api-report-alpha.api.md rename to plugins/search-react/report-alpha.api.md diff --git a/plugins/search-react/api-report.api.md b/plugins/search-react/report.api.md similarity index 100% rename from plugins/search-react/api-report.api.md rename to plugins/search-react/report.api.md diff --git a/plugins/search/api-report-alpha.api.md b/plugins/search/report-alpha.api.md similarity index 97% rename from plugins/search/api-report-alpha.api.md rename to plugins/search/report-alpha.api.md index 36c703a669717..052340c432228 100644 --- a/plugins/search/api-report-alpha.api.md +++ b/plugins/search/report-alpha.api.md @@ -198,8 +198,8 @@ export const searchPage: ExtensionDefinition<{ // // src/alpha.d.ts:2:22 - (ae-undocumented) Missing documentation for "searchApi". // src/alpha.d.ts:4:22 - (ae-undocumented) Missing documentation for "searchPage". -// src/alpha.d.ts:9:22 - (ae-undocumented) Missing documentation for "searchNavItem". -// src/alpha.d.ts:13:15 - (ae-undocumented) Missing documentation for "_default". +// src/alpha.d.ts:12:22 - (ae-undocumented) Missing documentation for "searchNavItem". +// src/alpha.d.ts:18:15 - (ae-undocumented) Missing documentation for "_default". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search/api-report.api.md b/plugins/search/report.api.md similarity index 100% rename from plugins/search/api-report.api.md rename to plugins/search/report.api.md diff --git a/plugins/signals-backend/api-report.api.md b/plugins/signals-backend/report.api.md similarity index 100% rename from plugins/signals-backend/api-report.api.md rename to plugins/signals-backend/report.api.md diff --git a/plugins/signals-node/api-report.api.md b/plugins/signals-node/report.api.md similarity index 100% rename from plugins/signals-node/api-report.api.md rename to plugins/signals-node/report.api.md diff --git a/plugins/signals-react/api-report.api.md b/plugins/signals-react/report.api.md similarity index 100% rename from plugins/signals-react/api-report.api.md rename to plugins/signals-react/report.api.md diff --git a/plugins/signals/api-report.api.md b/plugins/signals/report.api.md similarity index 100% rename from plugins/signals/api-report.api.md rename to plugins/signals/report.api.md diff --git a/plugins/techdocs-addons-test-utils/api-report.api.md b/plugins/techdocs-addons-test-utils/report.api.md similarity index 100% rename from plugins/techdocs-addons-test-utils/api-report.api.md rename to plugins/techdocs-addons-test-utils/report.api.md diff --git a/plugins/techdocs-backend/api-report-alpha.api.md b/plugins/techdocs-backend/report-alpha.api.md similarity index 100% rename from plugins/techdocs-backend/api-report-alpha.api.md rename to plugins/techdocs-backend/report-alpha.api.md diff --git a/plugins/techdocs-backend/api-report.api.md b/plugins/techdocs-backend/report.api.md similarity index 100% rename from plugins/techdocs-backend/api-report.api.md rename to plugins/techdocs-backend/report.api.md diff --git a/plugins/techdocs-module-addons-contrib/api-report.api.md b/plugins/techdocs-module-addons-contrib/report.api.md similarity index 100% rename from plugins/techdocs-module-addons-contrib/api-report.api.md rename to plugins/techdocs-module-addons-contrib/report.api.md diff --git a/plugins/techdocs-node/api-report.api.md b/plugins/techdocs-node/report.api.md similarity index 100% rename from plugins/techdocs-node/api-report.api.md rename to plugins/techdocs-node/report.api.md diff --git a/plugins/techdocs-react/api-report.api.md b/plugins/techdocs-react/report.api.md similarity index 100% rename from plugins/techdocs-react/api-report.api.md rename to plugins/techdocs-react/report.api.md diff --git a/plugins/techdocs/api-report-alpha.api.md b/plugins/techdocs/report-alpha.api.md similarity index 99% rename from plugins/techdocs/api-report-alpha.api.md rename to plugins/techdocs/report-alpha.api.md index 8a9ce1e1dc938..c2f75be11e5f7 100644 --- a/plugins/techdocs/api-report-alpha.api.md +++ b/plugins/techdocs/report-alpha.api.md @@ -317,7 +317,7 @@ export const techDocsSearchResultListItemExtension: ExtensionDefinition<{ // Warnings were encountered during analysis: // // src/alpha.d.ts:2:22 - (ae-undocumented) Missing documentation for "techDocsSearchResultListItemExtension". -// src/alpha.d.ts:10:15 - (ae-undocumented) Missing documentation for "_default". +// src/alpha.d.ts:16:15 - (ae-undocumented) Missing documentation for "_default". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/techdocs/api-report.api.md b/plugins/techdocs/report.api.md similarity index 100% rename from plugins/techdocs/api-report.api.md rename to plugins/techdocs/report.api.md diff --git a/plugins/user-settings-backend/api-report-alpha.api.md b/plugins/user-settings-backend/report-alpha.api.md similarity index 100% rename from plugins/user-settings-backend/api-report-alpha.api.md rename to plugins/user-settings-backend/report-alpha.api.md diff --git a/plugins/user-settings-backend/api-report.api.md b/plugins/user-settings-backend/report.api.md similarity index 100% rename from plugins/user-settings-backend/api-report.api.md rename to plugins/user-settings-backend/report.api.md diff --git a/plugins/user-settings-common/api-report.api.md b/plugins/user-settings-common/report.api.md similarity index 100% rename from plugins/user-settings-common/api-report.api.md rename to plugins/user-settings-common/report.api.md diff --git a/plugins/user-settings/api-report-alpha.api.md b/plugins/user-settings/report-alpha.api.md similarity index 97% rename from plugins/user-settings/api-report-alpha.api.md rename to plugins/user-settings/report-alpha.api.md index 0a5dbde28d63a..299bbc3498d6a 100644 --- a/plugins/user-settings/api-report-alpha.api.md +++ b/plugins/user-settings/report-alpha.api.md @@ -130,7 +130,7 @@ export const userSettingsTranslationRef: TranslationRef< // Warnings were encountered during analysis: // // src/alpha.d.ts:3:22 - (ae-undocumented) Missing documentation for "settingsNavItem". -// src/alpha.d.ts:9:15 - (ae-undocumented) Missing documentation for "_default". +// src/alpha.d.ts:11:15 - (ae-undocumented) Missing documentation for "_default". // src/translation.d.ts:2:22 - (ae-undocumented) Missing documentation for "userSettingsTranslationRef". // (No @packageDocumentation comment for this package) diff --git a/plugins/user-settings/api-report.api.md b/plugins/user-settings/report.api.md similarity index 100% rename from plugins/user-settings/api-report.api.md rename to plugins/user-settings/report.api.md