From 3109c24cb3753c2901a4084e679846986db5fc46 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Fri, 11 Oct 2024 16:09:23 +0200 Subject: [PATCH] promote all backend feature exports to main entry point Signed-off-by: Patrik Oldsberg --- .changeset/lovely-jokes-breathe.md | 32 +++++++++++++++++++ packages/backend/src/index.ts | 24 +++++++------- plugins/app-backend/report.api.md | 6 ++++ plugins/app-backend/src/index.ts | 6 ++++ .../catalog-backend-module-aws/report.api.md | 9 ++++++ .../catalog-backend-module-aws/src/index.ts | 6 ++++ .../report.api.md | 9 ++++++ .../catalog-backend-module-azure/src/index.ts | 6 ++++ .../report.api.md | 9 ++++++ .../src/index.ts | 6 ++++ .../report.api.md | 9 ++++++ .../src/index.ts | 6 ++++ .../report.api.md | 6 ++++ .../src/index.ts | 6 ++++ .../report.api.md | 9 ++++++ .../src/index.ts | 6 ++++ .../report.api.md | 9 ++++++ .../src/index.ts | 6 ++++ .../report.api.md | 9 ++++++ .../src/index.ts | 6 ++++ .../report.api.md | 9 ++++++ .../src/index.ts | 6 ++++ plugins/catalog-backend/report.api.md | 6 ++++ plugins/catalog-backend/src/index.ts | 6 ++++ .../report.api.md | 9 ++++++ .../src/index.ts | 6 ++++ .../events-backend-module-azure/report.api.md | 9 ++++++ .../events-backend-module-azure/src/index.ts | 6 ++++ .../report.api.md | 9 ++++++ .../src/index.ts | 6 ++++ .../report.api.md | 9 ++++++ .../events-backend-module-gerrit/src/index.ts | 6 ++++ plugins/events-backend/report.api.md | 6 ++++ plugins/events-backend/src/index.ts | 6 ++++ plugins/kubernetes-backend/report.api.md | 6 ++++ plugins/kubernetes-backend/src/index.ts | 6 ++++ plugins/permission-backend/report.api.md | 6 ++++ plugins/permission-backend/src/index.ts | 6 ++++ plugins/proxy-backend/report.api.md | 6 ++++ plugins/proxy-backend/src/index.ts | 6 ++++ plugins/scaffolder-backend/report.api.md | 6 ++++ plugins/scaffolder-backend/src/index.ts | 6 ++++ .../report.api.md | 6 ++++ .../src/index.ts | 6 ++++ .../report.api.md | 9 ++++++ .../src/index.ts | 6 ++++ .../report.api.md | 6 ++++ .../src/index.ts | 6 ++++ .../search-backend-module-pg/report.api.md | 9 ++++++ plugins/search-backend-module-pg/src/index.ts | 6 ++++ .../report.api.md | 6 ++++ .../src/index.ts | 6 ++++ plugins/search-backend/report.api.md | 6 ++++ plugins/search-backend/src/index.ts | 6 ++++ plugins/techdocs-backend/report.api.md | 12 +++++-- plugins/techdocs-backend/src/index.ts | 5 +++ plugins/user-settings-backend/report.api.md | 9 ++++++ plugins/user-settings-backend/src/index.ts | 6 ++++ 58 files changed, 427 insertions(+), 15 deletions(-) create mode 100644 .changeset/lovely-jokes-breathe.md diff --git a/.changeset/lovely-jokes-breathe.md b/.changeset/lovely-jokes-breathe.md new file mode 100644 index 0000000000..f5782832eb --- /dev/null +++ b/.changeset/lovely-jokes-breathe.md @@ -0,0 +1,32 @@ +--- +'@backstage/plugin-search-backend-module-elasticsearch': minor +'@backstage/plugin-scaffolder-backend': minor +'@backstage/plugin-techdocs-backend': minor +'@backstage/plugin-catalog-backend': minor +'@backstage/plugin-search-backend': minor +'@backstage/plugin-catalog-backend-module-incremental-ingestion': patch +'@backstage/plugin-catalog-backend-module-bitbucket-server': patch +'@backstage/plugin-catalog-backend-module-bitbucket-cloud': patch +'@backstage/plugin-events-backend-module-bitbucket-cloud': patch +'@backstage/plugin-catalog-backend-module-msgraph': patch +'@backstage/plugin-search-backend-module-techdocs': patch +'@backstage/plugin-catalog-backend-module-gerrit': patch +'@backstage/plugin-catalog-backend-module-github': patch +'@backstage/plugin-catalog-backend-module-gitlab': patch +'@backstage/plugin-events-backend-module-aws-sqs': patch +'@backstage/plugin-search-backend-module-catalog': patch +'@backstage/plugin-search-backend-module-explore': patch +'@backstage/plugin-catalog-backend-module-azure': patch +'@backstage/plugin-events-backend-module-gerrit': patch +'@backstage/plugin-events-backend-module-azure': patch +'@backstage/plugin-catalog-backend-module-aws': patch +'@backstage/plugin-search-backend-module-pg': patch +'@backstage/plugin-user-settings-backend': patch +'@backstage/plugin-kubernetes-backend': patch +'@backstage/plugin-permission-backend': patch +'@backstage/plugin-events-backend': patch +'@backstage/plugin-proxy-backend': patch +'@backstage/plugin-app-backend': patch +--- + +The export for the new backend system at the `/alpha` export is now also available via the main entry point, which means that you can remove the `/alpha` suffix from the import. diff --git a/packages/backend/src/index.ts b/packages/backend/src/index.ts index 3e8c2910b1..b9130d452f 100644 --- a/packages/backend/src/index.ts +++ b/packages/backend/src/index.ts @@ -23,37 +23,37 @@ const backend = createBackend(); // access root-scoped services by adding `deps`. const searchLoader = createBackendFeatureLoader({ *loader() { - yield import('@backstage/plugin-search-backend/alpha'); - yield import('@backstage/plugin-search-backend-module-catalog/alpha'); - yield import('@backstage/plugin-search-backend-module-explore/alpha'); - yield import('@backstage/plugin-search-backend-module-techdocs/alpha'); + yield import('@backstage/plugin-search-backend'); + yield import('@backstage/plugin-search-backend-module-catalog'); + yield import('@backstage/plugin-search-backend-module-explore'); + yield import('@backstage/plugin-search-backend-module-techdocs'); }, }); backend.add(import('@backstage/plugin-auth-backend')); backend.add(import('./authModuleGithubProvider')); backend.add(import('@backstage/plugin-auth-backend-module-guest-provider')); -backend.add(import('@backstage/plugin-app-backend/alpha')); +backend.add(import('@backstage/plugin-app-backend')); backend.add(import('@backstage/plugin-catalog-backend-module-unprocessed')); backend.add( import('@backstage/plugin-catalog-backend-module-scaffolder-entity-model'), ); -backend.add(import('@backstage/plugin-catalog-backend/alpha')); -backend.add(import('@backstage/plugin-events-backend/alpha')); +backend.add(import('@backstage/plugin-catalog-backend')); +backend.add(import('@backstage/plugin-events-backend')); backend.add(import('@backstage/plugin-devtools-backend')); -backend.add(import('@backstage/plugin-kubernetes-backend/alpha')); +backend.add(import('@backstage/plugin-kubernetes-backend')); backend.add( import('@backstage/plugin-permission-backend-module-allow-all-policy'), ); -backend.add(import('@backstage/plugin-permission-backend/alpha')); -backend.add(import('@backstage/plugin-proxy-backend/alpha')); -backend.add(import('@backstage/plugin-scaffolder-backend/alpha')); +backend.add(import('@backstage/plugin-permission-backend')); +backend.add(import('@backstage/plugin-proxy-backend')); +backend.add(import('@backstage/plugin-scaffolder-backend')); backend.add(import('@backstage/plugin-scaffolder-backend-module-github')); backend.add( import('@backstage/plugin-catalog-backend-module-backstage-openapi'), ); backend.add(searchLoader); -backend.add(import('@backstage/plugin-techdocs-backend/alpha')); +backend.add(import('@backstage/plugin-techdocs-backend')); backend.add(import('@backstage/plugin-signals-backend')); backend.add(import('@backstage/plugin-notifications-backend')); diff --git a/plugins/app-backend/report.api.md b/plugins/app-backend/report.api.md index ab36eb95d3..b1a3eaa9a7 100644 --- a/plugins/app-backend/report.api.md +++ b/plugins/app-backend/report.api.md @@ -4,6 +4,7 @@ ```ts import { AuthService } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { ConfigSchema } from '@backstage/config-loader'; import { DatabaseService } from '@backstage/backend-plugin-api'; import express from 'express'; @@ -14,6 +15,10 @@ import { RootConfigService } from '@backstage/backend-plugin-api'; // @public @deprecated (undocumented) export function createRouter(options: RouterOptions): Promise; +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // @public @deprecated (undocumented) export interface RouterOptions { appPackageName: string; @@ -33,6 +38,7 @@ export interface RouterOptions { // Warnings were encountered during analysis: // +// src/index.d.ts:8:15 - (ae-undocumented) Missing documentation for "_feature". // src/service/router.d.ts:9:1 - (ae-undocumented) Missing documentation for "RouterOptions". // src/service/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "config". // src/service/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "logger". diff --git a/plugins/app-backend/src/index.ts b/plugins/app-backend/src/index.ts index c91416eac1..f59fcb7da5 100644 --- a/plugins/app-backend/src/index.ts +++ b/plugins/app-backend/src/index.ts @@ -14,6 +14,8 @@ * limitations under the License. */ +import { appPlugin as feature } from './service/appPlugin'; + /** * A Backstage backend plugin that serves the Backstage frontend app * @@ -21,3 +23,7 @@ */ export * from './service/router'; + +/** @public */ +const _feature = feature; +export default _feature; diff --git a/plugins/catalog-backend-module-aws/report.api.md b/plugins/catalog-backend-module-aws/report.api.md index 3d24c71035..ed0eac9864 100644 --- a/plugins/catalog-backend-module-aws/report.api.md +++ b/plugins/catalog-backend-module-aws/report.api.md @@ -5,6 +5,7 @@ ```ts import { AwsCredentialIdentity } from '@aws-sdk/types'; import { AwsCredentialsManager } from '@backstage/integration-aws-node'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { CatalogProcessor } from '@backstage/plugin-catalog-node'; import { CatalogProcessorEmit } from '@backstage/plugin-catalog-node'; import { CatalogProcessorParser } from '@backstage/plugin-catalog-node'; @@ -113,8 +114,14 @@ export type EksClusterEntityTransformer = ( accountId: string, ) => Promise; +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // Warnings were encountered during analysis: // +// src/index.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". +// src/index.d.ts:4:1 - (ae-misplaced-package-tag) The @packageDocumentation comment must appear at the top of entry point *.d.ts file // src/processors/AwsEKSClusterProcessor.d.ts:18:5 - (ae-undocumented) Missing documentation for "fromConfig". // src/processors/AwsEKSClusterProcessor.d.ts:26:5 - (ae-undocumented) Missing documentation for "getProcessorName". // src/processors/AwsEKSClusterProcessor.d.ts:27:5 - (ae-undocumented) Missing documentation for "readLocation". @@ -125,4 +132,6 @@ export type EksClusterEntityTransformer = ( // src/processors/AwsS3DiscoveryProcessor.d.ts:16:5 - (ae-undocumented) Missing documentation for "readLocation". // src/providers/AwsS3EntityProvider.d.ts:20:5 - (ae-undocumented) Missing documentation for "fromConfig". // src/providers/AwsS3EntityProvider.d.ts:31:5 - (ae-undocumented) Missing documentation for "refresh". + +// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-aws/src/index.ts b/plugins/catalog-backend-module-aws/src/index.ts index de8f9fd7b2..8fbc7e3b87 100644 --- a/plugins/catalog-backend-module-aws/src/index.ts +++ b/plugins/catalog-backend-module-aws/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +import { default as feature } from './alpha'; + +/** @public */ +const _feature = feature; +export default _feature; + /** * A Backstage catalog backend module that helps integrate towards AWS * diff --git a/plugins/catalog-backend-module-azure/report.api.md b/plugins/catalog-backend-module-azure/report.api.md index f3121296a5..00a18ee604 100644 --- a/plugins/catalog-backend-module-azure/report.api.md +++ b/plugins/catalog-backend-module-azure/report.api.md @@ -3,6 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts +import { BackendFeature } from '@backstage/backend-plugin-api'; import { CatalogProcessor } from '@backstage/plugin-catalog-node'; import { CatalogProcessorEmit } from '@backstage/plugin-catalog-node'; import { Config } from '@backstage/config'; @@ -54,11 +55,19 @@ export class AzureDevOpsEntityProvider implements EntityProvider { refresh(logger: LoggerService): Promise; } +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // Warnings were encountered during analysis: // +// src/index.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". +// src/index.d.ts:4:1 - (ae-misplaced-package-tag) The @packageDocumentation comment must appear at the top of entry point *.d.ts file // src/processors/AzureDevOpsDiscoveryProcessor.d.ts:26:5 - (ae-undocumented) Missing documentation for "fromConfig". // src/processors/AzureDevOpsDiscoveryProcessor.d.ts:33:5 - (ae-undocumented) Missing documentation for "getProcessorName". // src/processors/AzureDevOpsDiscoveryProcessor.d.ts:34:5 - (ae-undocumented) Missing documentation for "readLocation". // src/providers/AzureDevOpsEntityProvider.d.ts:18:5 - (ae-undocumented) Missing documentation for "fromConfig". // src/providers/AzureDevOpsEntityProvider.d.ts:29:5 - (ae-undocumented) Missing documentation for "refresh". + +// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-azure/src/index.ts b/plugins/catalog-backend-module-azure/src/index.ts index a71c40ee6c..f844d9a7b6 100644 --- a/plugins/catalog-backend-module-azure/src/index.ts +++ b/plugins/catalog-backend-module-azure/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +import { default as feature } from './alpha'; + +/** @public */ +const _feature = feature; +export default _feature; + /** * A Backstage catalog backend module that helps integrate towards Azure * diff --git a/plugins/catalog-backend-module-bitbucket-cloud/report.api.md b/plugins/catalog-backend-module-bitbucket-cloud/report.api.md index d0248b3973..2ddf5f5401 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/report.api.md +++ b/plugins/catalog-backend-module-bitbucket-cloud/report.api.md @@ -4,6 +4,7 @@ ```ts import { AuthService } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { CatalogApi } from '@backstage/catalog-client'; import { Config } from '@backstage/config'; import { EntityProvider } from '@backstage/plugin-catalog-node'; @@ -37,9 +38,17 @@ export class BitbucketCloudEntityProvider implements EntityProvider { refresh(logger: LoggerService): Promise; } +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // Warnings were encountered during analysis: // +// src/index.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". +// src/index.d.ts:4:1 - (ae-misplaced-package-tag) The @packageDocumentation comment must appear at the top of entry point *.d.ts file // src/providers/BitbucketCloudEntityProvider.d.ts:26:5 - (ae-undocumented) Missing documentation for "fromConfig". // src/providers/BitbucketCloudEntityProvider.d.ts:42:5 - (ae-undocumented) Missing documentation for "refresh". // src/providers/BitbucketCloudEntityProvider.d.ts:44:5 - (ae-undocumented) Missing documentation for "onRepoPush". + +// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-bitbucket-cloud/src/index.ts b/plugins/catalog-backend-module-bitbucket-cloud/src/index.ts index d730d8618d..ef693fedc3 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/src/index.ts +++ b/plugins/catalog-backend-module-bitbucket-cloud/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +import { default as feature } from './alpha'; + +/** @public */ +const _feature = feature; +export default _feature; + /** * A Backstage catalog backend module that helps integrate towards Bitbucket Cloud * diff --git a/plugins/catalog-backend-module-bitbucket-server/report.api.md b/plugins/catalog-backend-module-bitbucket-server/report.api.md index a7febe8e7a..33acd9a926 100644 --- a/plugins/catalog-backend-module-bitbucket-server/report.api.md +++ b/plugins/catalog-backend-module-bitbucket-server/report.api.md @@ -3,6 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts +import { BackendFeature } from '@backstage/backend-plugin-api'; import { BitbucketServerIntegrationConfig } from '@backstage/integration'; import { Config } from '@backstage/config'; import { Entity } from '@backstage/catalog-model'; @@ -110,8 +111,14 @@ export type BitbucketServerRepository = { archived: boolean; }; +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // Warnings were encountered during analysis: // +// src/index.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". +// src/index.d.ts:4:1 - (ae-misplaced-package-tag) The @packageDocumentation comment must appear at the top of entry point *.d.ts file // src/lib/BitbucketServerClient.d.ts:11:5 - (ae-undocumented) Missing documentation for "fromConfig". // src/lib/BitbucketServerClient.d.ts:17:5 - (ae-undocumented) Missing documentation for "listProjects". // src/lib/BitbucketServerClient.d.ts:20:5 - (ae-undocumented) Missing documentation for "listRepositories". @@ -124,4 +131,6 @@ export type BitbucketServerRepository = { // src/lib/types.d.ts:14:1 - (ae-undocumented) Missing documentation for "BitbucketServerProject". // src/providers/BitbucketServerEntityProvider.d.ts:20:5 - (ae-undocumented) Missing documentation for "fromConfig". // src/providers/BitbucketServerEntityProvider.d.ts:32:5 - (ae-undocumented) Missing documentation for "refresh". + +// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-bitbucket-server/src/index.ts b/plugins/catalog-backend-module-bitbucket-server/src/index.ts index 34ac3a9966..7bc1737803 100644 --- a/plugins/catalog-backend-module-bitbucket-server/src/index.ts +++ b/plugins/catalog-backend-module-bitbucket-server/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +import { default as feature } from './alpha'; + +/** @public */ +const _feature = feature; +export default _feature; + /** * A Backstage catalog backend module that helps integrate towards Bitbucket Server * diff --git a/plugins/catalog-backend-module-gerrit/report.api.md b/plugins/catalog-backend-module-gerrit/report.api.md index 56930f3357..5d78cba9aa 100644 --- a/plugins/catalog-backend-module-gerrit/report.api.md +++ b/plugins/catalog-backend-module-gerrit/report.api.md @@ -3,6 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts +import { BackendFeature } from '@backstage/backend-plugin-api'; import { Config } from '@backstage/config'; import { EntityProvider } from '@backstage/plugin-catalog-node'; import { EntityProviderConnection } from '@backstage/plugin-catalog-node'; @@ -10,6 +11,10 @@ import { LoggerService } from '@backstage/backend-plugin-api'; import { SchedulerService } from '@backstage/backend-plugin-api'; import { SchedulerServiceTaskRunner } from '@backstage/backend-plugin-api'; +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // @public (undocumented) export class GerritEntityProvider implements EntityProvider { // (undocumented) @@ -31,6 +36,7 @@ export class GerritEntityProvider implements EntityProvider { // Warnings were encountered during analysis: // +// src/index.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". // src/providers/GerritEntityProvider.d.ts:5:1 - (ae-undocumented) Missing documentation for "GerritEntityProvider". // src/providers/GerritEntityProvider.d.ts:11:5 - (ae-undocumented) Missing documentation for "fromConfig". // src/providers/GerritEntityProvider.d.ts:17:5 - (ae-undocumented) Missing documentation for "getProviderName". diff --git a/plugins/catalog-backend-module-gerrit/src/index.ts b/plugins/catalog-backend-module-gerrit/src/index.ts index 133772d4b1..177932685e 100644 --- a/plugins/catalog-backend-module-gerrit/src/index.ts +++ b/plugins/catalog-backend-module-gerrit/src/index.ts @@ -14,4 +14,10 @@ * limitations under the License. */ +import { default as feature } from './alpha'; + +/** @public */ +const _feature = feature; +export default _feature; + export { GerritEntityProvider } from './providers/GerritEntityProvider'; diff --git a/plugins/catalog-backend-module-github/report.api.md b/plugins/catalog-backend-module-github/report.api.md index 4ffe434615..52c061c8a5 100644 --- a/plugins/catalog-backend-module-github/report.api.md +++ b/plugins/catalog-backend-module-github/report.api.md @@ -5,6 +5,7 @@ ```ts import { AnalyzeOptions } from '@backstage/plugin-catalog-node'; import { AuthService } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { CatalogApi } from '@backstage/catalog-client'; import { CatalogProcessor } from '@backstage/plugin-catalog-node'; import { CatalogProcessorEmit } from '@backstage/plugin-catalog-node'; @@ -37,6 +38,10 @@ export const defaultUserTransformer: ( _ctx: TransformerContext, ) => Promise; +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // @public export class GithubDiscoveryProcessor implements CatalogProcessor { constructor(options: { @@ -333,6 +338,8 @@ export type UserTransformer = ( // src/deprecated.d.ts:29:5 - (ae-undocumented) Missing documentation for "connect". // src/deprecated.d.ts:30:5 - (ae-undocumented) Missing documentation for "getProviderName". // src/deprecated.d.ts:31:5 - (ae-undocumented) Missing documentation for "refresh". +// src/index.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". +// src/index.d.ts:4:1 - (ae-misplaced-package-tag) The @packageDocumentation comment must appear at the top of entry point *.d.ts file // src/lib/defaultTransformers.d.ts:10:5 - (ae-undocumented) Missing documentation for "client". // src/lib/defaultTransformers.d.ts:11:5 - (ae-undocumented) Missing documentation for "query". // src/lib/defaultTransformers.d.ts:12:5 - (ae-undocumented) Missing documentation for "org". @@ -355,4 +362,6 @@ export type UserTransformer = ( // src/providers/GithubEntityProvider.d.ts:102:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // src/providers/GithubMultiOrgEntityProvider.d.ts:84:5 - (ae-undocumented) Missing documentation for "fromConfig". // src/providers/GithubOrgEntityProvider.d.ts:71:5 - (ae-undocumented) Missing documentation for "fromConfig". + +// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-github/src/index.ts b/plugins/catalog-backend-module-github/src/index.ts index ee6b061034..e7a96d8a3f 100644 --- a/plugins/catalog-backend-module-github/src/index.ts +++ b/plugins/catalog-backend-module-github/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +import { default as feature } from './alpha'; + +/** @public */ +const _feature = feature; +export default _feature; + /** * A Backstage catalog backend module that helps integrate towards Github * diff --git a/plugins/catalog-backend-module-gitlab/report.api.md b/plugins/catalog-backend-module-gitlab/report.api.md index 0cc2f93ce1..ac7624986d 100644 --- a/plugins/catalog-backend-module-gitlab/report.api.md +++ b/plugins/catalog-backend-module-gitlab/report.api.md @@ -3,6 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts +import { BackendFeature } from '@backstage/backend-plugin-api'; import { CatalogProcessor } from '@backstage/plugin-catalog-node'; import { CatalogProcessorEmit } from '@backstage/plugin-catalog-node'; import { Config } from '@backstage/config'; @@ -18,6 +19,10 @@ import { SchedulerServiceTaskRunner } from '@backstage/backend-plugin-api'; import { SchedulerServiceTaskScheduleDefinition } from '@backstage/backend-plugin-api'; import { UserEntity } from '@backstage/catalog-model'; +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // @public export class GitlabDiscoveryEntityProvider implements EntityProvider { // (undocumented) @@ -177,6 +182,8 @@ export interface UserTransformerOptions { // src/GitLabDiscoveryProcessor.d.ts:14:5 - (ae-undocumented) Missing documentation for "fromConfig". // src/GitLabDiscoveryProcessor.d.ts:20:5 - (ae-undocumented) Missing documentation for "getProcessorName". // src/GitLabDiscoveryProcessor.d.ts:21:5 - (ae-undocumented) Missing documentation for "readLocation". +// src/index.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". +// src/index.d.ts:4:1 - (ae-misplaced-package-tag) The @packageDocumentation comment must appear at the top of entry point *.d.ts file // src/lib/types.d.ts:48:1 - (ae-undocumented) Missing documentation for "GitLabGroupSamlIdentity". // src/lib/types.d.ts:234:5 - (ae-undocumented) Missing documentation for "group". // src/lib/types.d.ts:235:5 - (ae-undocumented) Missing documentation for "providerConfig". @@ -196,4 +203,6 @@ export interface UserTransformerOptions { // src/providers/GitlabOrgDiscoveryEntityProvider.d.ts:21:5 - (ae-undocumented) Missing documentation for "fromConfig". // src/providers/GitlabOrgDiscoveryEntityProvider.d.ts:31:5 - (ae-undocumented) Missing documentation for "getProviderName". // src/providers/GitlabOrgDiscoveryEntityProvider.d.ts:32:5 - (ae-undocumented) Missing documentation for "connect". + +// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-gitlab/src/index.ts b/plugins/catalog-backend-module-gitlab/src/index.ts index cedcb828d6..fa2de998b7 100644 --- a/plugins/catalog-backend-module-gitlab/src/index.ts +++ b/plugins/catalog-backend-module-gitlab/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +import { default as feature } from './alpha'; + +/** @public */ +const _feature = feature; +export default _feature; + /** * A Backstage catalog backend module that helps integrate towards GitLab * diff --git a/plugins/catalog-backend-module-incremental-ingestion/report.api.md b/plugins/catalog-backend-module-incremental-ingestion/report.api.md index 7160ff504f..70a96ade80 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/report.api.md +++ b/plugins/catalog-backend-module-incremental-ingestion/report.api.md @@ -5,6 +5,7 @@ ```ts /// +import { BackendFeature } from '@backstage/backend-plugin-api'; import { CatalogBuilder } from '@backstage/plugin-catalog-backend'; import type { Config } from '@backstage/config'; import type { DeferredEntity } from '@backstage/plugin-catalog-node'; @@ -31,6 +32,10 @@ export type EntityIteratorResult = cursor?: T; }; +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // @public (undocumented) export class IncrementalCatalogBuilder { // (undocumented) @@ -97,9 +102,13 @@ export type PluginEnvironment = { // Warnings were encountered during analysis: // +// src/index.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". +// src/index.d.ts:4:1 - (ae-misplaced-package-tag) The @packageDocumentation comment must appear at the top of entry point *.d.ts file // src/service/IncrementalCatalogBuilder.d.ts:6:1 - (ae-undocumented) Missing documentation for "IncrementalCatalogBuilder". // src/service/IncrementalCatalogBuilder.d.ts:20:5 - (ae-undocumented) Missing documentation for "build". // src/service/IncrementalCatalogBuilder.d.ts:23:5 - (ae-undocumented) Missing documentation for "addIncrementalEntityProvider". // src/types.d.ts:106:1 - (ae-undocumented) Missing documentation for "IncrementalEntityProviderOptions". // src/types.d.ts:145:1 - (ae-undocumented) Missing documentation for "PluginEnvironment". + +// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-incremental-ingestion/src/index.ts b/plugins/catalog-backend-module-incremental-ingestion/src/index.ts index f381572149..fcd7670245 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/src/index.ts +++ b/plugins/catalog-backend-module-incremental-ingestion/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +import { default as feature } from './alpha'; + +/** @public */ +const _feature = feature; +export default _feature; + /** * Provides efficient incremental ingestion of entities into the catalog. * diff --git a/plugins/catalog-backend-module-msgraph/report.api.md b/plugins/catalog-backend-module-msgraph/report.api.md index 3df99752db..3e29ed76df 100644 --- a/plugins/catalog-backend-module-msgraph/report.api.md +++ b/plugins/catalog-backend-module-msgraph/report.api.md @@ -3,6 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts +import { BackendFeature } from '@backstage/backend-plugin-api'; import { CatalogProcessor } from '@backstage/plugin-catalog-node'; import { CatalogProcessorEmit } from '@backstage/plugin-catalog-node'; import { Config } from '@backstage/config'; @@ -36,6 +37,10 @@ export function defaultUserTransformer( userPhoto?: string, ): Promise; +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // @public export type GroupMember = | (MicrosoftGraph.Group & { @@ -293,6 +298,8 @@ export type UserTransformer = ( // Warnings were encountered during analysis: // +// src/index.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". +// src/index.d.ts:4:1 - (ae-misplaced-package-tag) The @packageDocumentation comment must appear at the top of entry point *.d.ts file // src/microsoftGraph/client.d.ts:109:5 - (ae-undocumented) Missing documentation for "getUserPhoto". // src/microsoftGraph/client.d.ts:129:5 - (ae-undocumented) Missing documentation for "getGroupPhoto". // src/microsoftGraph/client.d.ts:176:5 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-catalog-backend-module-msgraph" does not have an export "entityName" @@ -300,4 +307,6 @@ export type UserTransformer = ( // src/processors/MicrosoftGraphOrgReaderProcessor.d.ts:18:5 - (ae-undocumented) Missing documentation for "fromConfig". // src/processors/MicrosoftGraphOrgReaderProcessor.d.ts:31:5 - (ae-undocumented) Missing documentation for "getProcessorName". // src/processors/MicrosoftGraphOrgReaderProcessor.d.ts:32:5 - (ae-undocumented) Missing documentation for "readLocation". + +// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-msgraph/src/index.ts b/plugins/catalog-backend-module-msgraph/src/index.ts index f98cb907ec..4dd70d32e8 100644 --- a/plugins/catalog-backend-module-msgraph/src/index.ts +++ b/plugins/catalog-backend-module-msgraph/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +import { default as feature } from './alpha'; + +/** @public */ +const _feature = feature; +export default _feature; + /** * A Backstage catalog backend module that helps integrate towards Microsoft Graph * diff --git a/plugins/catalog-backend/report.api.md b/plugins/catalog-backend/report.api.md index 6fff29f6f8..dcd0319c49 100644 --- a/plugins/catalog-backend/report.api.md +++ b/plugins/catalog-backend/report.api.md @@ -12,6 +12,7 @@ import { AnalyzeLocationRequest as AnalyzeLocationRequest_2 } from '@backstage/p import { AnalyzeLocationResponse as AnalyzeLocationResponse_2 } from '@backstage/plugin-catalog-common'; import { AnalyzeOptions as AnalyzeOptions_2 } from '@backstage/plugin-catalog-node'; import { AuthService } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { CatalogApi } from '@backstage/catalog-client'; import { CatalogCollatorEntityTransformer as CatalogCollatorEntityTransformer_2 } from '@backstage/plugin-search-backend-module-catalog'; import { CatalogEntityDocument } from '@backstage/plugin-catalog-common'; @@ -349,6 +350,10 @@ export type EntityProviderMutation = EntityProviderMutation_2; // @public @deprecated (undocumented) export type EntityRelationSpec = EntityRelationSpec_2; +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // @public (undocumented) export class FileReaderProcessor implements CatalogProcessor_2 { // (undocumented) @@ -516,6 +521,7 @@ export class UrlReaderProcessor implements CatalogProcessor_2 { // src/deprecated.d.ts:207:22 - (ae-undocumented) Missing documentation for "defaultCatalogCollatorEntityTransformer". // src/deprecated.d.ts:212:1 - (ae-undocumented) Missing documentation for "DefaultCatalogCollatorFactoryOptions". // src/deprecated.d.ts:217:1 - (ae-undocumented) Missing documentation for "CatalogCollatorEntityTransformer". +// src/index.d.ts:14:15 - (ae-undocumented) Missing documentation for "_feature". // src/processing/types.d.ts:31:5 - (ae-undocumented) Missing documentation for "start". // src/processing/types.d.ts:32:5 - (ae-undocumented) Missing documentation for "stop". // src/processors/AnnotateLocationEntityProcessor.d.ts:6:1 - (ae-undocumented) Missing documentation for "AnnotateLocationEntityProcessor". diff --git a/plugins/catalog-backend/src/index.ts b/plugins/catalog-backend/src/index.ts index e3374a6a8b..a55a5eb687 100644 --- a/plugins/catalog-backend/src/index.ts +++ b/plugins/catalog-backend/src/index.ts @@ -14,6 +14,8 @@ * limitations under the License. */ +import { catalogPlugin as feature } from './service/CatalogPlugin'; + /** * The Backstage backend plugin that provides the Backstage catalog * @@ -27,3 +29,7 @@ export * from './service'; export * from './deprecated'; export * from './constants'; export * from './util'; + +/** @public */ +const _feature = feature; +export default _feature; diff --git a/plugins/events-backend-module-aws-sqs/report.api.md b/plugins/events-backend-module-aws-sqs/report.api.md index eee183519d..6957a3036d 100644 --- a/plugins/events-backend-module-aws-sqs/report.api.md +++ b/plugins/events-backend-module-aws-sqs/report.api.md @@ -3,6 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts +import { BackendFeature } from '@backstage/backend-plugin-api'; import { Config } from '@backstage/config'; import { EventsService } from '@backstage/plugin-events-node'; import { LoggerService } from '@backstage/backend-plugin-api'; @@ -21,8 +22,16 @@ export class AwsSqsConsumingEventPublisher { start(): Promise; } +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // Warnings were encountered during analysis: // +// src/index.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". +// src/index.d.ts:4:1 - (ae-misplaced-package-tag) The @packageDocumentation comment must appear at the top of entry point *.d.ts file // src/publisher/AwsSqsConsumingEventPublisher.d.ts:21:5 - (ae-undocumented) Missing documentation for "fromConfig". // src/publisher/AwsSqsConsumingEventPublisher.d.ts:28:5 - (ae-undocumented) Missing documentation for "start". + +// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/events-backend-module-aws-sqs/src/index.ts b/plugins/events-backend-module-aws-sqs/src/index.ts index 57f409c044..a16bc9be04 100644 --- a/plugins/events-backend-module-aws-sqs/src/index.ts +++ b/plugins/events-backend-module-aws-sqs/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +import { default as feature } from './alpha'; + +/** @public */ +const _feature = feature; +export default _feature; + /** * The module "sqs" for the Backstage backend plugin "events" * adding an AWS SQS-based publisher, diff --git a/plugins/events-backend-module-azure/report.api.md b/plugins/events-backend-module-azure/report.api.md index 0ad4d4e9fd..0109bad0e3 100644 --- a/plugins/events-backend-module-azure/report.api.md +++ b/plugins/events-backend-module-azure/report.api.md @@ -3,6 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts +import { BackendFeature } from '@backstage/backend-plugin-api'; import { EventParams } from '@backstage/plugin-events-node'; import { EventsService } from '@backstage/plugin-events-node'; import { SubTopicEventRouter } from '@backstage/plugin-events-node'; @@ -16,8 +17,16 @@ export class AzureDevOpsEventRouter extends SubTopicEventRouter { protected getSubscriberId(): string; } +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // Warnings were encountered during analysis: // +// src/index.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". +// src/index.d.ts:4:1 - (ae-misplaced-package-tag) The @packageDocumentation comment must appear at the top of entry point *.d.ts file // src/router/AzureDevOpsEventRouter.d.ts:13:5 - (ae-undocumented) Missing documentation for "getSubscriberId". // src/router/AzureDevOpsEventRouter.d.ts:14:5 - (ae-undocumented) Missing documentation for "determineSubTopic". + +// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/events-backend-module-azure/src/index.ts b/plugins/events-backend-module-azure/src/index.ts index a1d56dc536..523673c562 100644 --- a/plugins/events-backend-module-azure/src/index.ts +++ b/plugins/events-backend-module-azure/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +import { default as feature } from './alpha'; + +/** @public */ +const _feature = feature; +export default _feature; + /** * The module "azure" for the Backstage backend plugin "events-backend" * adding an event router for Azure DevOps. diff --git a/plugins/events-backend-module-bitbucket-cloud/report.api.md b/plugins/events-backend-module-bitbucket-cloud/report.api.md index 51aa7f27cb..08c953f96b 100644 --- a/plugins/events-backend-module-bitbucket-cloud/report.api.md +++ b/plugins/events-backend-module-bitbucket-cloud/report.api.md @@ -3,6 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts +import { BackendFeature } from '@backstage/backend-plugin-api'; import { EventParams } from '@backstage/plugin-events-node'; import { EventsService } from '@backstage/plugin-events-node'; import { SubTopicEventRouter } from '@backstage/plugin-events-node'; @@ -16,8 +17,16 @@ export class BitbucketCloudEventRouter extends SubTopicEventRouter { protected getSubscriberId(): string; } +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // Warnings were encountered during analysis: // +// src/index.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". +// src/index.d.ts:4:1 - (ae-misplaced-package-tag) The @packageDocumentation comment must appear at the top of entry point *.d.ts file // src/router/BitbucketCloudEventRouter.d.ts:13:5 - (ae-undocumented) Missing documentation for "getSubscriberId". // src/router/BitbucketCloudEventRouter.d.ts:14:5 - (ae-undocumented) Missing documentation for "determineSubTopic". + +// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/events-backend-module-bitbucket-cloud/src/index.ts b/plugins/events-backend-module-bitbucket-cloud/src/index.ts index 77aa9798ef..d7f0cfa4d7 100644 --- a/plugins/events-backend-module-bitbucket-cloud/src/index.ts +++ b/plugins/events-backend-module-bitbucket-cloud/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +import { default as feature } from './alpha'; + +/** @public */ +const _feature = feature; +export default _feature; + /** * The module "bitbucket-cloud" for the Backstage backend plugin "events-backend" * adding an event router for Bitbucket Cloud. diff --git a/plugins/events-backend-module-gerrit/report.api.md b/plugins/events-backend-module-gerrit/report.api.md index 7a3f75ca6f..58981896a9 100644 --- a/plugins/events-backend-module-gerrit/report.api.md +++ b/plugins/events-backend-module-gerrit/report.api.md @@ -3,10 +3,15 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts +import { BackendFeature } from '@backstage/backend-plugin-api'; import { EventParams } from '@backstage/plugin-events-node'; import { EventsService } from '@backstage/plugin-events-node'; import { SubTopicEventRouter } from '@backstage/plugin-events-node'; +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // @public export class GerritEventRouter extends SubTopicEventRouter { constructor(options: { events: EventsService }); @@ -18,6 +23,10 @@ export class GerritEventRouter extends SubTopicEventRouter { // Warnings were encountered during analysis: // +// src/index.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". +// src/index.d.ts:4:1 - (ae-misplaced-package-tag) The @packageDocumentation comment must appear at the top of entry point *.d.ts file // src/router/GerritEventRouter.d.ts:13:5 - (ae-undocumented) Missing documentation for "getSubscriberId". // src/router/GerritEventRouter.d.ts:14:5 - (ae-undocumented) Missing documentation for "determineSubTopic". + +// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/events-backend-module-gerrit/src/index.ts b/plugins/events-backend-module-gerrit/src/index.ts index dfc314667f..4f2ba573ba 100644 --- a/plugins/events-backend-module-gerrit/src/index.ts +++ b/plugins/events-backend-module-gerrit/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +import { default as feature } from './alpha'; + +/** @public */ +const _feature = feature; +export default _feature; + /** * The module `gerrit` for the Backstage backend plugin "events-backend" * adding an event router for Gerrit. diff --git a/plugins/events-backend/report.api.md b/plugins/events-backend/report.api.md index 5511d8c410..8d39a28774 100644 --- a/plugins/events-backend/report.api.md +++ b/plugins/events-backend/report.api.md @@ -3,6 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts +import { BackendFeature } from '@backstage/backend-plugin-api'; import { Config } from '@backstage/config'; import { EventBroker } from '@backstage/plugin-events-node'; import { EventParams } from '@backstage/plugin-events-node'; @@ -42,6 +43,10 @@ export class EventsBackend { start(): Promise; } +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // @public export class HttpPostIngressEventPublisher { // (undocumented) @@ -59,6 +64,7 @@ export class HttpPostIngressEventPublisher { // Warnings were encountered during analysis: // +// src/index.d.ts:9:15 - (ae-undocumented) Missing documentation for "_feature". // src/service/DefaultEventBroker.d.ts:21:5 - (ae-undocumented) Missing documentation for "publish". // src/service/DefaultEventBroker.d.ts:22:5 - (ae-undocumented) Missing documentation for "subscribe". // src/service/EventsBackend.d.ts:14:5 - (ae-undocumented) Missing documentation for "setEventBroker". diff --git a/plugins/events-backend/src/index.ts b/plugins/events-backend/src/index.ts index 63dfa5d252..425de752fd 100644 --- a/plugins/events-backend/src/index.ts +++ b/plugins/events-backend/src/index.ts @@ -14,6 +14,8 @@ * limitations under the License. */ +import { eventsPlugin as feature } from './service/EventsPlugin'; + /** * The Backstage backend plugin "events" that provides the event management. * @@ -22,3 +24,7 @@ export * from './deprecated'; export { HttpPostIngressEventPublisher } from './service/http'; + +/** @public */ +const _feature = feature; +export default _feature; diff --git a/plugins/kubernetes-backend/report.api.md b/plugins/kubernetes-backend/report.api.md index e01ada7e1c..694d0b2695 100644 --- a/plugins/kubernetes-backend/report.api.md +++ b/plugins/kubernetes-backend/report.api.md @@ -6,6 +6,7 @@ import { AuthenticationStrategy as AuthenticationStrategy_2 } from '@backstage/plugin-kubernetes-node'; import { AuthMetadata as AuthMetadata_2 } from '@backstage/plugin-kubernetes-node'; import { AuthService } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { BackstageCredentials } from '@backstage/backend-plugin-api'; import { CatalogApi } from '@backstage/catalog-client'; import { ClusterDetails as ClusterDetails_2 } from '@backstage/plugin-kubernetes-node'; @@ -121,6 +122,10 @@ export type DispatchStrategyOptions = { }; }; +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // @public @deprecated (undocumented) export type FetchResponseWrapper = k8sAuthTypes.FetchResponseWrapper; @@ -467,6 +472,7 @@ export type SigningCreds = { // src/auth/ServiceAccountStrategy.d.ts:9:5 - (ae-undocumented) Missing documentation for "presentAuthMetadata". // src/auth/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "AuthenticationStrategy". // src/auth/types.d.ts:9:1 - (ae-undocumented) Missing documentation for "KubernetesCredential". +// src/index.d.ts:10:15 - (ae-undocumented) Missing documentation for "_feature". // src/service/KubernetesBuilder.d.ts:14:1 - (ae-undocumented) Missing documentation for "KubernetesEnvironment". // src/service/KubernetesBuilder.d.ts:15:5 - (ae-undocumented) Missing documentation for "logger". // src/service/KubernetesBuilder.d.ts:16:5 - (ae-undocumented) Missing documentation for "config". diff --git a/plugins/kubernetes-backend/src/index.ts b/plugins/kubernetes-backend/src/index.ts index d32dfc24be..186337cb81 100644 --- a/plugins/kubernetes-backend/src/index.ts +++ b/plugins/kubernetes-backend/src/index.ts @@ -14,6 +14,8 @@ * limitations under the License. */ +import { kubernetesPlugin as feature } from './plugin'; + /** * A Backstage backend plugin that integrates towards Kubernetes * @@ -23,3 +25,7 @@ export * from './auth'; export * from './service'; export * from './types'; + +/** @public */ +const _feature = feature; +export default _feature; diff --git a/plugins/permission-backend/report.api.md b/plugins/permission-backend/report.api.md index 11d5ca7d62..78e08d9873 100644 --- a/plugins/permission-backend/report.api.md +++ b/plugins/permission-backend/report.api.md @@ -4,6 +4,7 @@ ```ts import { AuthService } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { DiscoveryService } from '@backstage/backend-plugin-api'; import express from 'express'; import { HttpAuthService } from '@backstage/backend-plugin-api'; @@ -16,6 +17,10 @@ import { UserInfoService } from '@backstage/backend-plugin-api'; // @public @deprecated export function createRouter(options: RouterOptions): Promise; +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // @public @deprecated export interface RouterOptions { // (undocumented) @@ -38,6 +43,7 @@ export interface RouterOptions { // Warnings were encountered during analysis: // +// src/index.d.ts:7:15 - (ae-undocumented) Missing documentation for "_feature". // src/service/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "logger". // src/service/router.d.ts:14:5 - (ae-undocumented) Missing documentation for "discovery". // src/service/router.d.ts:15:5 - (ae-undocumented) Missing documentation for "policy". diff --git a/plugins/permission-backend/src/index.ts b/plugins/permission-backend/src/index.ts index 877b9070c3..29fca17cf3 100644 --- a/plugins/permission-backend/src/index.ts +++ b/plugins/permission-backend/src/index.ts @@ -14,8 +14,14 @@ * limitations under the License. */ +import { permissionPlugin as feature } from './plugin'; + /** * Backend for Backstage authorization and permissions. * @packageDocumentation */ export * from './service'; + +/** @public */ +const _feature = feature; +export default _feature; diff --git a/plugins/proxy-backend/report.api.md b/plugins/proxy-backend/report.api.md index bf6ac6ae39..f299986239 100644 --- a/plugins/proxy-backend/report.api.md +++ b/plugins/proxy-backend/report.api.md @@ -3,6 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts +import { BackendFeature } from '@backstage/backend-plugin-api'; import { DiscoveryService } from '@backstage/backend-plugin-api'; import express from 'express'; import { Logger } from 'winston'; @@ -11,6 +12,10 @@ import { RootConfigService } from '@backstage/backend-plugin-api'; // @public @deprecated export function createRouter(options: RouterOptions): Promise; +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // @public @deprecated (undocumented) export interface RouterOptions { // (undocumented) @@ -27,6 +32,7 @@ export interface RouterOptions { // Warnings were encountered during analysis: // +// src/index.d.ts:8:15 - (ae-undocumented) Missing documentation for "_feature". // src/service/router.d.ts:9:1 - (ae-undocumented) Missing documentation for "RouterOptions". // src/service/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "logger". // src/service/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "config". diff --git a/plugins/proxy-backend/src/index.ts b/plugins/proxy-backend/src/index.ts index 8f5d5c79dc..4da38f069c 100644 --- a/plugins/proxy-backend/src/index.ts +++ b/plugins/proxy-backend/src/index.ts @@ -14,6 +14,8 @@ * limitations under the License. */ +import { default as feature } from './alpha'; + /** * A Backstage backend plugin that helps you set up proxy endpoints in the backend * @@ -21,3 +23,7 @@ */ export * from './service'; + +/** @public */ +const _feature = feature; +export default _feature; diff --git a/plugins/scaffolder-backend/report.api.md b/plugins/scaffolder-backend/report.api.md index e791762416..979c8ddad3 100644 --- a/plugins/scaffolder-backend/report.api.md +++ b/plugins/scaffolder-backend/report.api.md @@ -9,6 +9,7 @@ import { ActionContext as ActionContext_2 } from '@backstage/plugin-scaffolder-n import { AuthService } from '@backstage/backend-plugin-api'; import { AutocompleteHandler } from '@backstage/plugin-scaffolder-node/alpha'; import * as azure from '@backstage/plugin-scaffolder-backend-module-azure'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { BackstageCredentials } from '@backstage/backend-plugin-api'; import * as bitbucket from '@backstage/plugin-scaffolder-backend-module-bitbucket'; import * as bitbucketCloud from '@backstage/plugin-scaffolder-backend-module-bitbucket-cloud'; @@ -504,6 +505,10 @@ export type DatabaseTaskStoreOptions = { // @public @deprecated export const executeShellCommand: typeof executeShellCommand_2; +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // @public @deprecated export const fetchContents: typeof fetchContents_2; @@ -846,6 +851,7 @@ export type TemplatePermissionRuleInput< // src/deprecated.d.ts:13:22 - (ae-undocumented) Missing documentation for "createTemplateAction". // src/deprecated.d.ts:18:1 - (ae-undocumented) Missing documentation for "TaskSecrets". // src/deprecated.d.ts:23:1 - (ae-undocumented) Missing documentation for "TemplateAction". +// src/index.d.ts:10:15 - (ae-undocumented) Missing documentation for "_feature". // src/lib/templating/SecureTemplater.d.ts:6:1 - (ae-undocumented) Missing documentation for "TemplateFilter". // src/lib/templating/SecureTemplater.d.ts:11:1 - (ae-undocumented) Missing documentation for "TemplateGlobal". // src/scaffolder/actions/TemplateActionRegistry.d.ts:8:5 - (ae-undocumented) Missing documentation for "register". diff --git a/plugins/scaffolder-backend/src/index.ts b/plugins/scaffolder-backend/src/index.ts index 649a5df233..e53a9a9044 100644 --- a/plugins/scaffolder-backend/src/index.ts +++ b/plugins/scaffolder-backend/src/index.ts @@ -14,6 +14,8 @@ * limitations under the License. */ +import { scaffolderPlugin as feature } from './ScaffolderPlugin'; + /** * The Backstage backend plugin that helps you create new things * @@ -24,4 +26,8 @@ export * from './scaffolder'; export * from './service/router'; export * from './lib'; +/** @public */ +const _feature = feature; +export default _feature; + export * from './deprecated'; diff --git a/plugins/search-backend-module-catalog/report.api.md b/plugins/search-backend-module-catalog/report.api.md index 9ab87b31fe..63ecce93e1 100644 --- a/plugins/search-backend-module-catalog/report.api.md +++ b/plugins/search-backend-module-catalog/report.api.md @@ -6,6 +6,7 @@ /// import { AuthService } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { CatalogApi } from '@backstage/catalog-client'; import { CatalogEntityDocument } from '@backstage/plugin-catalog-common'; import { Config } from '@backstage/config'; @@ -52,6 +53,10 @@ export type DefaultCatalogCollatorFactoryOptions = { entityTransformer?: CatalogCollatorEntityTransformer; }; +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // Warnings were encountered during analysis: // // src/collators/CatalogCollatorEntityTransformer.d.ts:4:1 - (ae-undocumented) Missing documentation for "CatalogCollatorEntityTransformer". @@ -61,4 +66,5 @@ export type DefaultCatalogCollatorFactoryOptions = { // src/collators/DefaultCatalogCollatorFactory.d.ts:51:5 - (ae-undocumented) Missing documentation for "fromConfig". // src/collators/DefaultCatalogCollatorFactory.d.ts:53:5 - (ae-undocumented) Missing documentation for "getCollator". // src/collators/defaultCatalogCollatorEntityTransformer.d.ts:3:22 - (ae-undocumented) Missing documentation for "defaultCatalogCollatorEntityTransformer". +// src/index.d.ts:7:15 - (ae-undocumented) Missing documentation for "_feature". ``` diff --git a/plugins/search-backend-module-catalog/src/index.ts b/plugins/search-backend-module-catalog/src/index.ts index 7998562311..91726fb716 100644 --- a/plugins/search-backend-module-catalog/src/index.ts +++ b/plugins/search-backend-module-catalog/src/index.ts @@ -14,9 +14,15 @@ * limitations under the License. */ +import { default as feature } from './alpha'; + /** * @packageDocumentation * A module for the search backend that exports Catalog modules. */ export * from './collators'; + +/** @public */ +const _feature = feature; +export default _feature; diff --git a/plugins/search-backend-module-elasticsearch/report.api.md b/plugins/search-backend-module-elasticsearch/report.api.md index 5cb0671a54..9843582b13 100644 --- a/plugins/search-backend-module-elasticsearch/report.api.md +++ b/plugins/search-backend-module-elasticsearch/report.api.md @@ -7,6 +7,7 @@ import { ApiResponse } from '@opensearch-project/opensearch'; import { ApiResponse as ApiResponse_2 } from '@elastic/elasticsearch'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { BatchSearchEngineIndexer } from '@backstage/plugin-search-backend-node'; import { BulkHelper } from '@elastic/elasticsearch/lib/Helpers'; import { BulkStats } from '@elastic/elasticsearch/lib/Helpers'; @@ -391,6 +392,10 @@ export interface ElasticSearchTransportConstructor { }; } +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // @public export const isOpenSearchCompatible: ( opts: ElasticSearchClientOptions, @@ -552,4 +557,8 @@ export interface OpenSearchNodeOptions { // src/engines/ElasticSearchSearchEngineIndexer.d.ts:39:5 - (ae-undocumented) Missing documentation for "initialize". // src/engines/ElasticSearchSearchEngineIndexer.d.ts:40:5 - (ae-undocumented) Missing documentation for "index". // src/engines/ElasticSearchSearchEngineIndexer.d.ts:41:5 - (ae-undocumented) Missing documentation for "finalize". +// src/index.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". +// src/index.d.ts:4:1 - (ae-misplaced-package-tag) The @packageDocumentation comment must appear at the top of entry point *.d.ts file + +// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search-backend-module-elasticsearch/src/index.ts b/plugins/search-backend-module-elasticsearch/src/index.ts index e0b05014cc..a25ef80260 100644 --- a/plugins/search-backend-module-elasticsearch/src/index.ts +++ b/plugins/search-backend-module-elasticsearch/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +import { default as feature } from './alpha'; + +/** @public */ +const _feature = feature; +export default _feature; + /** * A module for the search backend that implements search using ElasticSearch * diff --git a/plugins/search-backend-module-explore/report.api.md b/plugins/search-backend-module-explore/report.api.md index 8738ad2c86..2d8c907c00 100644 --- a/plugins/search-backend-module-explore/report.api.md +++ b/plugins/search-backend-module-explore/report.api.md @@ -6,6 +6,7 @@ /// import { AuthService } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { Config } from '@backstage/config'; import { DiscoveryService } from '@backstage/backend-plugin-api'; import { DocumentCollatorFactory } from '@backstage/plugin-search-common'; @@ -15,6 +16,10 @@ import { LoggerService } from '@backstage/backend-plugin-api'; import { Readable } from 'stream'; import { TokenManager } from '@backstage/backend-common'; +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // @public export interface ToolDocument extends IndexableDocument, ExploreTool {} @@ -48,4 +53,5 @@ export type ToolDocumentCollatorFactoryOptions = { // src/collators/ToolDocumentCollatorFactory.d.ts:37:5 - (ae-undocumented) Missing documentation for "fromConfig". // src/collators/ToolDocumentCollatorFactory.d.ts:38:5 - (ae-undocumented) Missing documentation for "getCollator". // src/collators/ToolDocumentCollatorFactory.d.ts:39:5 - (ae-undocumented) Missing documentation for "execute". +// src/index.d.ts:7:15 - (ae-undocumented) Missing documentation for "_feature". ``` diff --git a/plugins/search-backend-module-explore/src/index.ts b/plugins/search-backend-module-explore/src/index.ts index ea94071984..520ae90e96 100644 --- a/plugins/search-backend-module-explore/src/index.ts +++ b/plugins/search-backend-module-explore/src/index.ts @@ -14,9 +14,15 @@ * limitations under the License. */ +import { default as feature } from './alpha'; + /** * @packageDocumentation * A module for the search backend that exports Explore modules. */ export * from './collators'; + +/** @public */ +const _feature = feature; +export default _feature; diff --git a/plugins/search-backend-module-pg/report.api.md b/plugins/search-backend-module-pg/report.api.md index 36346491fa..380d1cdb7b 100644 --- a/plugins/search-backend-module-pg/report.api.md +++ b/plugins/search-backend-module-pg/report.api.md @@ -3,6 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts +import { BackendFeature } from '@backstage/backend-plugin-api'; import { BatchSearchEngineIndexer } from '@backstage/plugin-search-backend-node'; import { Config } from '@backstage/config'; import { DatabaseService } from '@backstage/backend-plugin-api'; @@ -80,6 +81,10 @@ export interface DocumentResultRow { type: string; } +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // @public (undocumented) export class PgSearchEngine implements SearchEngine { // @deprecated @@ -235,4 +240,8 @@ export interface RawDocumentRow { // src/database/types.d.ts:30:5 - (ae-undocumented) Missing documentation for "document". // src/database/types.d.ts:31:5 - (ae-undocumented) Missing documentation for "type". // src/database/types.d.ts:32:5 - (ae-undocumented) Missing documentation for "highlight". +// src/index.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". +// src/index.d.ts:4:1 - (ae-misplaced-package-tag) The @packageDocumentation comment must appear at the top of entry point *.d.ts file + +// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search-backend-module-pg/src/index.ts b/plugins/search-backend-module-pg/src/index.ts index fbc52735dd..eedb819593 100644 --- a/plugins/search-backend-module-pg/src/index.ts +++ b/plugins/search-backend-module-pg/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +import { default as feature } from './alpha'; + +/** @public */ +const _feature = feature; +export default _feature; + /** * A module for the search backend that implements search using PostgreSQL * diff --git a/plugins/search-backend-module-techdocs/report.api.md b/plugins/search-backend-module-techdocs/report.api.md index ce9500a5f6..90a4fa9479 100644 --- a/plugins/search-backend-module-techdocs/report.api.md +++ b/plugins/search-backend-module-techdocs/report.api.md @@ -6,6 +6,7 @@ /// import { AuthService } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { CatalogApi } from '@backstage/catalog-client'; import { Config } from '@backstage/config'; import { DiscoveryService } from '@backstage/backend-plugin-api'; @@ -36,6 +37,10 @@ export class DefaultTechDocsCollatorFactory implements DocumentCollatorFactory { readonly visibilityPermission: Permission; } +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // @public (undocumented) export interface MkSearchIndexDoc { // (undocumented) @@ -98,4 +103,5 @@ export type TechDocsCollatorFactoryOptions = { // src/collators/TechDocsCollatorDocumentTransformer.d.ts:10:1 - (ae-undocumented) Missing documentation for "TechDocsCollatorDocumentTransformer". // src/collators/TechDocsCollatorEntityTransformer.d.ts:4:1 - (ae-undocumented) Missing documentation for "TechDocsCollatorEntityTransformer". // src/collators/defaultTechDocsCollatorEntityTransformer.d.ts:3:22 - (ae-undocumented) Missing documentation for "defaultTechDocsCollatorEntityTransformer". +// src/index.d.ts:7:15 - (ae-undocumented) Missing documentation for "_feature". ``` diff --git a/plugins/search-backend-module-techdocs/src/index.ts b/plugins/search-backend-module-techdocs/src/index.ts index c28175fd61..c8f9a93c6a 100644 --- a/plugins/search-backend-module-techdocs/src/index.ts +++ b/plugins/search-backend-module-techdocs/src/index.ts @@ -14,9 +14,15 @@ * limitations under the License. */ +import { default as feature } from './alpha'; + /** * @packageDocumentation * A module for the search backend that exports TechDocs modules. */ export * from './collators'; + +/** @public */ +const _feature = feature; +export default _feature; diff --git a/plugins/search-backend/report.api.md b/plugins/search-backend/report.api.md index 42714f5070..e770c0276e 100644 --- a/plugins/search-backend/report.api.md +++ b/plugins/search-backend/report.api.md @@ -4,6 +4,7 @@ ```ts import { AuthService } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { Config } from '@backstage/config'; import { DiscoveryService } from '@backstage/backend-plugin-api'; import { DocumentTypeInfo } from '@backstage/plugin-search-common'; @@ -17,6 +18,10 @@ import { SearchEngine } from '@backstage/plugin-search-backend-node'; // @public @deprecated (undocumented) export function createRouter(options: RouterOptions): Promise; +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // @public @deprecated (undocumented) export type RouterOptions = { engine: SearchEngine; @@ -31,6 +36,7 @@ export type RouterOptions = { // Warnings were encountered during analysis: // +// src/index.d.ts:8:15 - (ae-undocumented) Missing documentation for "_feature". // src/service/router.d.ts:11:1 - (ae-undocumented) Missing documentation for "RouterOptions". // src/service/router.d.ts:25:1 - (ae-undocumented) Missing documentation for "createRouter". ``` diff --git a/plugins/search-backend/src/index.ts b/plugins/search-backend/src/index.ts index 851efd1875..69c2b1483d 100644 --- a/plugins/search-backend/src/index.ts +++ b/plugins/search-backend/src/index.ts @@ -14,6 +14,8 @@ * limitations under the License. */ +import { default as feature } from './alpha'; + /** * The Backstage backend plugin that provides your backstage app with search * @@ -21,3 +23,7 @@ */ export * from './service/router'; + +/** @public */ +const _feature = feature; +export default _feature; diff --git a/plugins/techdocs-backend/report.api.md b/plugins/techdocs-backend/report.api.md index 6b84666e50..f61518b587 100644 --- a/plugins/techdocs-backend/report.api.md +++ b/plugins/techdocs-backend/report.api.md @@ -4,6 +4,7 @@ ```ts import { AuthService } from '@backstage/backend-plugin-api'; +import { BackendFeature } from '@backstage/backend-plugin-api'; import { CatalogApi } from '@backstage/catalog-client'; import { Config } from '@backstage/config'; import { DefaultTechDocsCollatorFactory as DefaultTechDocsCollatorFactory_2 } from '@backstage/plugin-search-backend-module-techdocs'; @@ -53,6 +54,10 @@ export const DefaultTechDocsCollatorFactory: typeof DefaultTechDocsCollatorFacto // @public @deprecated (undocumented) export type DocsBuildStrategy = DocsBuildStrategy_2; +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // @public export type OutOfTheBoxDeploymentOptions = { preparers: PreparerBuilder; @@ -115,9 +120,10 @@ export * from '@backstage/plugin-techdocs-node'; // Warnings were encountered during analysis: // -// src/index.d.ts:16:1 - (ae-undocumented) Missing documentation for "DocsBuildStrategy". -// src/index.d.ts:21:1 - (ae-undocumented) Missing documentation for "ShouldBuildParameters". -// src/index.d.ts:28:1 - (ae-undocumented) Missing documentation for "TechDocsDocument". +// src/index.d.ts:13:15 - (ae-undocumented) Missing documentation for "_feature". +// src/index.d.ts:19:1 - (ae-undocumented) Missing documentation for "DocsBuildStrategy". +// src/index.d.ts:24:1 - (ae-undocumented) Missing documentation for "ShouldBuildParameters". +// src/index.d.ts:31:1 - (ae-undocumented) Missing documentation for "TechDocsDocument". // src/search/DefaultTechDocsCollator.d.ts:32:5 - (ae-undocumented) Missing documentation for "type". // src/search/DefaultTechDocsCollator.d.ts:33:5 - (ae-undocumented) Missing documentation for "visibilityPermission". // src/search/DefaultTechDocsCollator.d.ts:35:5 - (ae-undocumented) Missing documentation for "fromConfig". diff --git a/plugins/techdocs-backend/src/index.ts b/plugins/techdocs-backend/src/index.ts index 6dc68a4d44..eb047ec4f0 100644 --- a/plugins/techdocs-backend/src/index.ts +++ b/plugins/techdocs-backend/src/index.ts @@ -25,6 +25,7 @@ import { DocsBuildStrategy as _DocsBuildStrategy, TechDocsDocument as _TechDocsDocument, } from '@backstage/plugin-techdocs-node'; +import { techdocsPlugin as feature } from './plugin'; export { createRouter } from './service'; export type { @@ -42,6 +43,10 @@ export type { TechDocsCollatorOptions, } from './search'; +/** @public */ +const _feature = feature; +export default _feature; + /** * @public * @deprecated import from `@backstage/plugin-techdocs-node` instead diff --git a/plugins/user-settings-backend/report.api.md b/plugins/user-settings-backend/report.api.md index 04aecca574..df35f0cd82 100644 --- a/plugins/user-settings-backend/report.api.md +++ b/plugins/user-settings-backend/report.api.md @@ -3,6 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts +import { BackendFeature } from '@backstage/backend-plugin-api'; import { DatabaseService } from '@backstage/backend-plugin-api'; import express from 'express'; import { IdentityApi } from '@backstage/plugin-auth-node'; @@ -11,6 +12,10 @@ import { SignalsService } from '@backstage/plugin-signals-node'; // @public @deprecated export function createRouter(options: RouterOptions): Promise; +// @public (undocumented) +const _feature: BackendFeature; +export default _feature; + // @public @deprecated export type RouterOptions = { database: DatabaseService; @@ -18,5 +23,9 @@ export type RouterOptions = { signals?: SignalsService; }; +// Warnings were encountered during analysis: +// +// src/index.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/user-settings-backend/src/index.ts b/plugins/user-settings-backend/src/index.ts index 395a8570bf..3728c573ed 100644 --- a/plugins/user-settings-backend/src/index.ts +++ b/plugins/user-settings-backend/src/index.ts @@ -14,5 +14,11 @@ * limitations under the License. */ +import { default as feature } from './alpha'; + +/** @public */ +const _feature = feature; +export default _feature; + export * from './deprecated'; export * from './database';