From 881507f9d5aae262ec05a2f12a57eaf9b0cf9c77 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Sun, 13 Oct 2024 10:54:10 +0200 Subject: [PATCH] plugins/catalog-backend-module-*: flip around alpha exports to stable Signed-off-by: Patrik Oldsberg --- .../report-alpha.api.md | 10 +++-- .../catalog-backend-module-aws/report.api.md | 12 ++---- .../catalog-backend-module-aws/src/alpha.ts | 7 +++- .../catalog-backend-module-aws/src/index.ts | 7 +--- .../catalogModuleAwsS3EntityProvider.ts | 2 +- .../report-alpha.api.md | 10 +++-- .../report.api.md | 10 ++--- .../catalog-backend-module-azure/src/alpha.ts | 7 +++- .../catalog-backend-module-azure/src/index.ts | 7 +--- .../catalogModuleAzureDevOpsEntityProvider.ts | 2 +- .../report-alpha.api.md | 6 +-- .../report.api.md | 9 ++--- .../src/alpha.ts | 7 +++- .../src/index.ts | 7 +--- ...talogModuleBitbucketCloudEntityProvider.ts | 2 +- .../report-alpha.api.md | 6 +-- .../report.api.md | 9 ++--- .../src/alpha.ts | 7 +++- .../src/index.ts | 7 +--- ...alogModuleBitbucketServerEntityProvider.ts | 2 +- .../report-alpha.api.md | 6 +-- .../report.api.md | 6 +-- .../src/alpha.ts | 7 +++- .../src/index.ts | 7 +--- .../catalogModuleGerritEntityProvider.ts | 2 +- .../report-alpha.api.md | 10 +++-- .../report.api.md | 10 ++--- .../src/alpha.ts | 7 +++- .../src/index.ts | 7 +--- .../src/module/githubCatalogModule.ts | 2 +- .../report-alpha.api.md | 10 +++-- .../report.api.md | 10 ++--- .../src/alpha.ts | 6 ++- .../src/index.ts | 7 +--- ...alogModuleGitlabDiscoveryEntityProvider.ts | 2 +- .../report-alpha.api.md | 28 +++++++------ .../report.api.md | 26 ++++++++---- .../src/alpha.ts | 16 +++++++- .../src/index.ts | 8 +--- ...oduleIncrementalIngestionEntityProvider.ts | 6 +-- .../report-alpha.api.md | 40 ++++++++----------- .../report.api.md | 40 +++++++++++++++---- .../src/alpha.ts | 18 ++++++++- .../src/index.ts | 8 +--- ...ogModuleMicrosoftGraphOrgEntityProvider.ts | 6 +-- 45 files changed, 230 insertions(+), 201 deletions(-) diff --git a/plugins/catalog-backend-module-aws/report-alpha.api.md b/plugins/catalog-backend-module-aws/report-alpha.api.md index 495abb6b48..2d9ceaec2d 100644 --- a/plugins/catalog-backend-module-aws/report-alpha.api.md +++ b/plugins/catalog-backend-module-aws/report-alpha.api.md @@ -5,9 +5,13 @@ ```ts import { BackendFeature } from '@backstage/backend-plugin-api'; -// @alpha -const catalogModuleAwsS3EntityProvider: BackendFeature; -export default catalogModuleAwsS3EntityProvider; +// @alpha (undocumented) +const _feature: BackendFeature; +export default _feature; + +// Warnings were encountered during analysis: +// +// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-aws/report.api.md b/plugins/catalog-backend-module-aws/report.api.md index ed0eac9864..c0e5653190 100644 --- a/plugins/catalog-backend-module-aws/report.api.md +++ b/plugins/catalog-backend-module-aws/report.api.md @@ -105,6 +105,10 @@ export class AwsS3EntityProvider implements EntityProvider { refresh(logger: LoggerService): Promise; } +// @public +const catalogModuleAwsS3EntityProvider: BackendFeature; +export default catalogModuleAwsS3EntityProvider; + // @public export const defaultEksClusterEntityTransformer: EksClusterEntityTransformer; @@ -114,14 +118,8 @@ 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". @@ -132,6 +130,4 @@ export default _feature; // 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/alpha.ts b/plugins/catalog-backend-module-aws/src/alpha.ts index 01a9b25f7c..cba672ce49 100644 --- a/plugins/catalog-backend-module-aws/src/alpha.ts +++ b/plugins/catalog-backend-module-aws/src/alpha.ts @@ -14,5 +14,8 @@ * limitations under the License. */ -export * from './module'; -export { default } from './module'; +import { default as feature } from './module'; + +/** @alpha */ +const _feature = feature; +export default _feature; diff --git a/plugins/catalog-backend-module-aws/src/index.ts b/plugins/catalog-backend-module-aws/src/index.ts index 8fbc7e3b87..1170fba043 100644 --- a/plugins/catalog-backend-module-aws/src/index.ts +++ b/plugins/catalog-backend-module-aws/src/index.ts @@ -14,18 +14,13 @@ * 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 * * @packageDocumentation */ +export { default } from './module'; export * from './processors'; export * from './providers'; export * from './types'; diff --git a/plugins/catalog-backend-module-aws/src/module/catalogModuleAwsS3EntityProvider.ts b/plugins/catalog-backend-module-aws/src/module/catalogModuleAwsS3EntityProvider.ts index 5568b8b3d8..2c99f2a44a 100644 --- a/plugins/catalog-backend-module-aws/src/module/catalogModuleAwsS3EntityProvider.ts +++ b/plugins/catalog-backend-module-aws/src/module/catalogModuleAwsS3EntityProvider.ts @@ -24,7 +24,7 @@ import { AwsS3EntityProvider } from '../providers'; /** * Registers the AwsS3EntityProvider with the catalog processing extension point. * - * @alpha + * @public */ export const catalogModuleAwsS3EntityProvider = createBackendModule({ pluginId: 'catalog', diff --git a/plugins/catalog-backend-module-azure/report-alpha.api.md b/plugins/catalog-backend-module-azure/report-alpha.api.md index fc48df304a..1be3e1481f 100644 --- a/plugins/catalog-backend-module-azure/report-alpha.api.md +++ b/plugins/catalog-backend-module-azure/report-alpha.api.md @@ -5,9 +5,13 @@ ```ts import { BackendFeature } from '@backstage/backend-plugin-api'; -// @alpha -const catalogModuleAzureDevOpsEntityProvider: BackendFeature; -export default catalogModuleAzureDevOpsEntityProvider; +// @alpha (undocumented) +const _feature: BackendFeature; +export default _feature; + +// Warnings were encountered during analysis: +// +// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-azure/report.api.md b/plugins/catalog-backend-module-azure/report.api.md index 00a18ee604..b3b7b71158 100644 --- a/plugins/catalog-backend-module-azure/report.api.md +++ b/plugins/catalog-backend-module-azure/report.api.md @@ -55,19 +55,15 @@ export class AzureDevOpsEntityProvider implements EntityProvider { refresh(logger: LoggerService): Promise; } -// @public (undocumented) -const _feature: BackendFeature; -export default _feature; +// @public +const catalogModuleAzureDevOpsEntityProvider: BackendFeature; +export default catalogModuleAzureDevOpsEntityProvider; // 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/alpha.ts b/plugins/catalog-backend-module-azure/src/alpha.ts index 01a9b25f7c..cba672ce49 100644 --- a/plugins/catalog-backend-module-azure/src/alpha.ts +++ b/plugins/catalog-backend-module-azure/src/alpha.ts @@ -14,5 +14,8 @@ * limitations under the License. */ -export * from './module'; -export { default } from './module'; +import { default as feature } from './module'; + +/** @alpha */ +const _feature = feature; +export default _feature; diff --git a/plugins/catalog-backend-module-azure/src/index.ts b/plugins/catalog-backend-module-azure/src/index.ts index f844d9a7b6..dbbdff67ce 100644 --- a/plugins/catalog-backend-module-azure/src/index.ts +++ b/plugins/catalog-backend-module-azure/src/index.ts @@ -14,17 +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 * * @packageDocumentation */ +export { default } from './module'; export { AzureDevOpsDiscoveryProcessor } from './processors'; export { AzureDevOpsEntityProvider } from './providers'; diff --git a/plugins/catalog-backend-module-azure/src/module/catalogModuleAzureDevOpsEntityProvider.ts b/plugins/catalog-backend-module-azure/src/module/catalogModuleAzureDevOpsEntityProvider.ts index cb4d5a1bf8..3aaa1b5b08 100644 --- a/plugins/catalog-backend-module-azure/src/module/catalogModuleAzureDevOpsEntityProvider.ts +++ b/plugins/catalog-backend-module-azure/src/module/catalogModuleAzureDevOpsEntityProvider.ts @@ -24,7 +24,7 @@ import { AzureDevOpsEntityProvider } from '../providers'; /** * Registers the AzureDevOpsEntityProvider with the catalog processing extension point. * - * @alpha + * @public */ export const catalogModuleAzureDevOpsEntityProvider = createBackendModule({ pluginId: 'catalog', diff --git a/plugins/catalog-backend-module-bitbucket-cloud/report-alpha.api.md b/plugins/catalog-backend-module-bitbucket-cloud/report-alpha.api.md index 3f0a2d1514..418327eb07 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/report-alpha.api.md +++ b/plugins/catalog-backend-module-bitbucket-cloud/report-alpha.api.md @@ -6,12 +6,12 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha (undocumented) -const catalogModuleBitbucketCloudEntityProvider: BackendFeature; -export default catalogModuleBitbucketCloudEntityProvider; +const _feature: BackendFeature; +export default _feature; // Warnings were encountered during analysis: // -// src/module/catalogModuleBitbucketCloudEntityProvider.d.ts:4:22 - (ae-undocumented) Missing documentation for "catalogModuleBitbucketCloudEntityProvider". +// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-bitbucket-cloud/report.api.md b/plugins/catalog-backend-module-bitbucket-cloud/report.api.md index 2ddf5f5401..19e835913f 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/report.api.md +++ b/plugins/catalog-backend-module-bitbucket-cloud/report.api.md @@ -39,16 +39,13 @@ export class BitbucketCloudEntityProvider implements EntityProvider { } // @public (undocumented) -const _feature: BackendFeature; -export default _feature; +const catalogModuleBitbucketCloudEntityProvider: BackendFeature; +export default catalogModuleBitbucketCloudEntityProvider; // 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/module/catalogModuleBitbucketCloudEntityProvider.d.ts:4:22 - (ae-undocumented) Missing documentation for "catalogModuleBitbucketCloudEntityProvider". // 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/alpha.ts b/plugins/catalog-backend-module-bitbucket-cloud/src/alpha.ts index 01a9b25f7c..cba672ce49 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/src/alpha.ts +++ b/plugins/catalog-backend-module-bitbucket-cloud/src/alpha.ts @@ -14,5 +14,8 @@ * limitations under the License. */ -export * from './module'; -export { default } from './module'; +import { default as feature } from './module'; + +/** @alpha */ +const _feature = feature; +export default _feature; diff --git a/plugins/catalog-backend-module-bitbucket-cloud/src/index.ts b/plugins/catalog-backend-module-bitbucket-cloud/src/index.ts index ef693fedc3..b46ff31c51 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/src/index.ts +++ b/plugins/catalog-backend-module-bitbucket-cloud/src/index.ts @@ -14,16 +14,11 @@ * 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 * * @packageDocumentation */ +export { default } from './module'; export { BitbucketCloudEntityProvider } from './providers/BitbucketCloudEntityProvider'; diff --git a/plugins/catalog-backend-module-bitbucket-cloud/src/module/catalogModuleBitbucketCloudEntityProvider.ts b/plugins/catalog-backend-module-bitbucket-cloud/src/module/catalogModuleBitbucketCloudEntityProvider.ts index 8cc8f50d5b..91f20c157c 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/src/module/catalogModuleBitbucketCloudEntityProvider.ts +++ b/plugins/catalog-backend-module-bitbucket-cloud/src/module/catalogModuleBitbucketCloudEntityProvider.ts @@ -26,7 +26,7 @@ import { eventsServiceRef } from '@backstage/plugin-events-node'; import { BitbucketCloudEntityProvider } from '../providers/BitbucketCloudEntityProvider'; /** - * @alpha + * @public */ export const catalogModuleBitbucketCloudEntityProvider = createBackendModule({ pluginId: 'catalog', diff --git a/plugins/catalog-backend-module-bitbucket-server/report-alpha.api.md b/plugins/catalog-backend-module-bitbucket-server/report-alpha.api.md index 49648580f8..60f05fac26 100644 --- a/plugins/catalog-backend-module-bitbucket-server/report-alpha.api.md +++ b/plugins/catalog-backend-module-bitbucket-server/report-alpha.api.md @@ -6,12 +6,12 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha (undocumented) -const catalogModuleBitbucketServerEntityProvider: BackendFeature; -export default catalogModuleBitbucketServerEntityProvider; +const _feature: BackendFeature; +export default _feature; // Warnings were encountered during analysis: // -// src/module/catalogModuleBitbucketServerEntityProvider.d.ts:4:22 - (ae-undocumented) Missing documentation for "catalogModuleBitbucketServerEntityProvider". +// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-bitbucket-server/report.api.md b/plugins/catalog-backend-module-bitbucket-server/report.api.md index 33acd9a926..41b0d398ab 100644 --- a/plugins/catalog-backend-module-bitbucket-server/report.api.md +++ b/plugins/catalog-backend-module-bitbucket-server/report.api.md @@ -112,13 +112,11 @@ export type BitbucketServerRepository = { }; // @public (undocumented) -const _feature: BackendFeature; -export default _feature; +const catalogModuleBitbucketServerEntityProvider: BackendFeature; +export default catalogModuleBitbucketServerEntityProvider; // 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". @@ -129,8 +127,7 @@ export default _feature; // src/lib/BitbucketServerClient.d.ts:56:1 - (ae-undocumented) Missing documentation for "BitbucketServerPagedResponse". // src/lib/types.d.ts:2:1 - (ae-undocumented) Missing documentation for "BitbucketServerRepository". // src/lib/types.d.ts:14:1 - (ae-undocumented) Missing documentation for "BitbucketServerProject". +// src/module/catalogModuleBitbucketServerEntityProvider.d.ts:4:22 - (ae-undocumented) Missing documentation for "catalogModuleBitbucketServerEntityProvider". // 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/alpha.ts b/plugins/catalog-backend-module-bitbucket-server/src/alpha.ts index 01a9b25f7c..cba672ce49 100644 --- a/plugins/catalog-backend-module-bitbucket-server/src/alpha.ts +++ b/plugins/catalog-backend-module-bitbucket-server/src/alpha.ts @@ -14,5 +14,8 @@ * limitations under the License. */ -export * from './module'; -export { default } from './module'; +import { default as feature } from './module'; + +/** @alpha */ +const _feature = feature; +export default _feature; diff --git a/plugins/catalog-backend-module-bitbucket-server/src/index.ts b/plugins/catalog-backend-module-bitbucket-server/src/index.ts index 7bc1737803..f05c9ca0e9 100644 --- a/plugins/catalog-backend-module-bitbucket-server/src/index.ts +++ b/plugins/catalog-backend-module-bitbucket-server/src/index.ts @@ -14,18 +14,13 @@ * 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 * * @packageDocumentation */ +export { default } from './module'; export { BitbucketServerClient } from './lib'; export type { BitbucketServerProject, diff --git a/plugins/catalog-backend-module-bitbucket-server/src/module/catalogModuleBitbucketServerEntityProvider.ts b/plugins/catalog-backend-module-bitbucket-server/src/module/catalogModuleBitbucketServerEntityProvider.ts index 3b9a44f5a2..2c78d219d9 100644 --- a/plugins/catalog-backend-module-bitbucket-server/src/module/catalogModuleBitbucketServerEntityProvider.ts +++ b/plugins/catalog-backend-module-bitbucket-server/src/module/catalogModuleBitbucketServerEntityProvider.ts @@ -22,7 +22,7 @@ import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/ import { BitbucketServerEntityProvider } from '../providers'; /** - * @alpha + * @public */ export const catalogModuleBitbucketServerEntityProvider = createBackendModule({ pluginId: 'catalog', diff --git a/plugins/catalog-backend-module-gerrit/report-alpha.api.md b/plugins/catalog-backend-module-gerrit/report-alpha.api.md index 0774a27299..741c105577 100644 --- a/plugins/catalog-backend-module-gerrit/report-alpha.api.md +++ b/plugins/catalog-backend-module-gerrit/report-alpha.api.md @@ -6,12 +6,12 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha (undocumented) -const catalogModuleGerritEntityProvider: BackendFeature; -export default catalogModuleGerritEntityProvider; +const _feature: BackendFeature; +export default _feature; // Warnings were encountered during analysis: // -// src/module/catalogModuleGerritEntityProvider.d.ts:4:22 - (ae-undocumented) Missing documentation for "catalogModuleGerritEntityProvider". +// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-gerrit/report.api.md b/plugins/catalog-backend-module-gerrit/report.api.md index 5d78cba9aa..76866fe76a 100644 --- a/plugins/catalog-backend-module-gerrit/report.api.md +++ b/plugins/catalog-backend-module-gerrit/report.api.md @@ -12,8 +12,8 @@ import { SchedulerService } from '@backstage/backend-plugin-api'; import { SchedulerServiceTaskRunner } from '@backstage/backend-plugin-api'; // @public (undocumented) -const _feature: BackendFeature; -export default _feature; +const catalogModuleGerritEntityProvider: BackendFeature; +export default catalogModuleGerritEntityProvider; // @public (undocumented) export class GerritEntityProvider implements EntityProvider { @@ -36,7 +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/module/catalogModuleGerritEntityProvider.d.ts:4:22 - (ae-undocumented) Missing documentation for "catalogModuleGerritEntityProvider". // 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/alpha.ts b/plugins/catalog-backend-module-gerrit/src/alpha.ts index 01a9b25f7c..cba672ce49 100644 --- a/plugins/catalog-backend-module-gerrit/src/alpha.ts +++ b/plugins/catalog-backend-module-gerrit/src/alpha.ts @@ -14,5 +14,8 @@ * limitations under the License. */ -export * from './module'; -export { default } from './module'; +import { default as feature } from './module'; + +/** @alpha */ +const _feature = feature; +export default _feature; diff --git a/plugins/catalog-backend-module-gerrit/src/index.ts b/plugins/catalog-backend-module-gerrit/src/index.ts index 177932685e..81375b9ab2 100644 --- a/plugins/catalog-backend-module-gerrit/src/index.ts +++ b/plugins/catalog-backend-module-gerrit/src/index.ts @@ -14,10 +14,5 @@ * limitations under the License. */ -import { default as feature } from './alpha'; - -/** @public */ -const _feature = feature; -export default _feature; - +export { default } from './module'; export { GerritEntityProvider } from './providers/GerritEntityProvider'; diff --git a/plugins/catalog-backend-module-gerrit/src/module/catalogModuleGerritEntityProvider.ts b/plugins/catalog-backend-module-gerrit/src/module/catalogModuleGerritEntityProvider.ts index e0efbabefd..a1aaac7b5c 100644 --- a/plugins/catalog-backend-module-gerrit/src/module/catalogModuleGerritEntityProvider.ts +++ b/plugins/catalog-backend-module-gerrit/src/module/catalogModuleGerritEntityProvider.ts @@ -22,7 +22,7 @@ import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/ import { GerritEntityProvider } from '../providers/GerritEntityProvider'; /** - * @alpha + * @public */ export const catalogModuleGerritEntityProvider = createBackendModule({ pluginId: 'catalog', diff --git a/plugins/catalog-backend-module-github/report-alpha.api.md b/plugins/catalog-backend-module-github/report-alpha.api.md index faa5423d82..fbe98b714e 100644 --- a/plugins/catalog-backend-module-github/report-alpha.api.md +++ b/plugins/catalog-backend-module-github/report-alpha.api.md @@ -5,9 +5,13 @@ ```ts import { BackendFeature } from '@backstage/backend-plugin-api'; -// @alpha -const githubCatalogModule: BackendFeature; -export default githubCatalogModule; +// @alpha (undocumented) +const _feature: BackendFeature; +export default _feature; + +// Warnings were encountered during analysis: +// +// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-github/report.api.md b/plugins/catalog-backend-module-github/report.api.md index 52c061c8a5..e81d0a0e81 100644 --- a/plugins/catalog-backend-module-github/report.api.md +++ b/plugins/catalog-backend-module-github/report.api.md @@ -38,9 +38,9 @@ export const defaultUserTransformer: ( _ctx: TransformerContext, ) => Promise; -// @public (undocumented) -const _feature: BackendFeature; -export default _feature; +// @public +const githubCatalogModule: BackendFeature; +export default githubCatalogModule; // @public export class GithubDiscoveryProcessor implements CatalogProcessor { @@ -338,8 +338,6 @@ 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". @@ -362,6 +360,4 @@ 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/alpha.ts b/plugins/catalog-backend-module-github/src/alpha.ts index 01a9b25f7c..cba672ce49 100644 --- a/plugins/catalog-backend-module-github/src/alpha.ts +++ b/plugins/catalog-backend-module-github/src/alpha.ts @@ -14,5 +14,8 @@ * limitations under the License. */ -export * from './module'; -export { default } from './module'; +import { default as feature } from './module'; + +/** @alpha */ +const _feature = feature; +export default _feature; diff --git a/plugins/catalog-backend-module-github/src/index.ts b/plugins/catalog-backend-module-github/src/index.ts index e7a96d8a3f..539e4ae14f 100644 --- a/plugins/catalog-backend-module-github/src/index.ts +++ b/plugins/catalog-backend-module-github/src/index.ts @@ -14,18 +14,13 @@ * 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 * * @packageDocumentation */ +export { default } from './module'; export { GithubLocationAnalyzer } from './analyzers/GithubLocationAnalyzer'; export type { GithubLocationAnalyzerOptions } from './analyzers/GithubLocationAnalyzer'; export { GithubDiscoveryProcessor } from './processors/GithubDiscoveryProcessor'; diff --git a/plugins/catalog-backend-module-github/src/module/githubCatalogModule.ts b/plugins/catalog-backend-module-github/src/module/githubCatalogModule.ts index 15d36a3011..bc10b04802 100644 --- a/plugins/catalog-backend-module-github/src/module/githubCatalogModule.ts +++ b/plugins/catalog-backend-module-github/src/module/githubCatalogModule.ts @@ -30,7 +30,7 @@ import { GithubLocationAnalyzer } from '../analyzers/GithubLocationAnalyzer'; /** * Registers the `GithubEntityProvider` with the catalog processing extension point. * - * @alpha + * @public */ export const githubCatalogModule = createBackendModule({ pluginId: 'catalog', diff --git a/plugins/catalog-backend-module-gitlab/report-alpha.api.md b/plugins/catalog-backend-module-gitlab/report-alpha.api.md index 0b1c7df3cc..350411a6dc 100644 --- a/plugins/catalog-backend-module-gitlab/report-alpha.api.md +++ b/plugins/catalog-backend-module-gitlab/report-alpha.api.md @@ -5,9 +5,13 @@ ```ts import { BackendFeature } from '@backstage/backend-plugin-api'; -// @alpha -const catalogModuleGitlabDiscoveryEntityProvider: BackendFeature; -export default catalogModuleGitlabDiscoveryEntityProvider; +// @alpha (undocumented) +const _feature: BackendFeature; +export default _feature; + +// Warnings were encountered during analysis: +// +// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-gitlab/report.api.md b/plugins/catalog-backend-module-gitlab/report.api.md index ac7624986d..07612bca88 100644 --- a/plugins/catalog-backend-module-gitlab/report.api.md +++ b/plugins/catalog-backend-module-gitlab/report.api.md @@ -19,9 +19,9 @@ 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 +const catalogModuleGitlabDiscoveryEntityProvider: BackendFeature; +export default catalogModuleGitlabDiscoveryEntityProvider; // @public export class GitlabDiscoveryEntityProvider implements EntityProvider { @@ -182,8 +182,6 @@ 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". @@ -203,6 +201,4 @@ 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/alpha.ts b/plugins/catalog-backend-module-gitlab/src/alpha.ts index 65f5b05b49..4c49bb9de9 100644 --- a/plugins/catalog-backend-module-gitlab/src/alpha.ts +++ b/plugins/catalog-backend-module-gitlab/src/alpha.ts @@ -14,4 +14,8 @@ * limitations under the License. */ -export { catalogModuleGitlabDiscoveryEntityProvider as default } from './module/catalogModuleGitlabDiscoveryEntityProvider'; +import { catalogModuleGitlabDiscoveryEntityProvider } from './module/catalogModuleGitlabDiscoveryEntityProvider'; + +/** @alpha */ +const _feature = catalogModuleGitlabDiscoveryEntityProvider; +export default _feature; diff --git a/plugins/catalog-backend-module-gitlab/src/index.ts b/plugins/catalog-backend-module-gitlab/src/index.ts index fa2de998b7..4f64e76395 100644 --- a/plugins/catalog-backend-module-gitlab/src/index.ts +++ b/plugins/catalog-backend-module-gitlab/src/index.ts @@ -14,18 +14,13 @@ * 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 * * @packageDocumentation */ +export { catalogModuleGitlabDiscoveryEntityProvider as default } from './module/catalogModuleGitlabDiscoveryEntityProvider'; export { GitLabDiscoveryProcessor } from './GitLabDiscoveryProcessor'; export { GitlabDiscoveryEntityProvider, diff --git a/plugins/catalog-backend-module-gitlab/src/module/catalogModuleGitlabDiscoveryEntityProvider.ts b/plugins/catalog-backend-module-gitlab/src/module/catalogModuleGitlabDiscoveryEntityProvider.ts index bba8348a74..bbcbae0763 100644 --- a/plugins/catalog-backend-module-gitlab/src/module/catalogModuleGitlabDiscoveryEntityProvider.ts +++ b/plugins/catalog-backend-module-gitlab/src/module/catalogModuleGitlabDiscoveryEntityProvider.ts @@ -25,7 +25,7 @@ import { GitlabDiscoveryEntityProvider } from '../providers'; /** * Registers the GitlabDiscoveryEntityProvider with the catalog processing extension point. * - * @alpha + * @public */ export const catalogModuleGitlabDiscoveryEntityProvider = createBackendModule({ diff --git a/plugins/catalog-backend-module-incremental-ingestion/report-alpha.api.md b/plugins/catalog-backend-module-incremental-ingestion/report-alpha.api.md index cfc4bca6f2..8f3a5fa780 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/report-alpha.api.md +++ b/plugins/catalog-backend-module-incremental-ingestion/report-alpha.api.md @@ -8,20 +8,24 @@ import { ExtensionPoint } from '@backstage/backend-plugin-api'; import { IncrementalEntityProvider } from '@backstage/plugin-catalog-backend-module-incremental-ingestion'; import { IncrementalEntityProviderOptions } from '@backstage/plugin-catalog-backend-module-incremental-ingestion'; -// @alpha -const catalogModuleIncrementalIngestionEntityProvider: BackendFeature; -export default catalogModuleIncrementalIngestionEntityProvider; +// @alpha (undocumented) +const _feature: BackendFeature; +export default _feature; -// @alpha -export interface IncrementalIngestionProviderExtensionPoint { - addProvider(config: { - options: IncrementalEntityProviderOptions; - provider: IncrementalEntityProvider; - }): void; -} +// Warning: (ae-forgotten-export) The symbol "IncrementalIngestionProviderExtensionPoint_2" needs to be exported by the entry point alpha.d.ts +// +// @alpha (undocumented) +export type IncrementalIngestionProviderExtensionPoint = + IncrementalIngestionProviderExtensionPoint_2; -// @alpha -export const incrementalIngestionProvidersExtensionPoint: ExtensionPoint; +// @alpha (undocumented) +export const incrementalIngestionProvidersExtensionPoint: ExtensionPoint; + +// Warnings were encountered during analysis: +// +// src/alpha.d.ts:3:15 - (ae-undocumented) Missing documentation for "_feature". +// src/alpha.d.ts:6:1 - (ae-undocumented) Missing documentation for "IncrementalIngestionProviderExtensionPoint". +// src/alpha.d.ts:8:22 - (ae-undocumented) Missing documentation for "incrementalIngestionProvidersExtensionPoint". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-incremental-ingestion/report.api.md b/plugins/catalog-backend-module-incremental-ingestion/report.api.md index 70a96ade80..4b7e473b48 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/report.api.md +++ b/plugins/catalog-backend-module-incremental-ingestion/report.api.md @@ -12,6 +12,9 @@ import type { DeferredEntity } from '@backstage/plugin-catalog-node'; import type { DurationObjectUnits } from 'luxon'; import { EventParams } from '@backstage/plugin-events-node'; import { EventSubscriber } from '@backstage/plugin-events-node'; +import { ExtensionPoint } from '@backstage/backend-plugin-api'; +import { IncrementalEntityProvider as IncrementalEntityProvider_2 } from '@backstage/plugin-catalog-backend-module-incremental-ingestion'; +import { IncrementalEntityProviderOptions as IncrementalEntityProviderOptions_2 } from '@backstage/plugin-catalog-backend-module-incremental-ingestion'; import type { Logger } from 'winston'; import type { PermissionEvaluator } from '@backstage/plugin-permission-common'; import type { PluginDatabaseManager } from '@backstage/backend-common'; @@ -19,6 +22,10 @@ import { Router } from 'express'; import { SchedulerService } from '@backstage/backend-plugin-api'; import { UrlReaderService } from '@backstage/backend-plugin-api'; +// @public +const catalogModuleIncrementalIngestionEntityProvider: BackendFeature; +export default catalogModuleIncrementalIngestionEntityProvider; + // @public export type EntityIteratorResult = | { @@ -32,10 +39,6 @@ export type EntityIteratorResult = cursor?: T; }; -// @public (undocumented) -const _feature: BackendFeature; -export default _feature; - // @public (undocumented) export class IncrementalCatalogBuilder { // (undocumented) @@ -90,6 +93,17 @@ export interface IncrementalEntityProviderOptions { restLength: DurationObjectUnits; } +// @public +export interface IncrementalIngestionProviderExtensionPoint { + addProvider(config: { + options: IncrementalEntityProviderOptions_2; + provider: IncrementalEntityProvider_2; + }): void; +} + +// @public +export const incrementalIngestionProvidersExtensionPoint: ExtensionPoint; + // @public (undocumented) export type PluginEnvironment = { logger: Logger; @@ -102,13 +116,9 @@ 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/alpha.ts b/plugins/catalog-backend-module-incremental-ingestion/src/alpha.ts index 01a9b25f7c..ee9c7ff415 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/src/alpha.ts +++ b/plugins/catalog-backend-module-incremental-ingestion/src/alpha.ts @@ -14,5 +14,17 @@ * limitations under the License. */ -export * from './module'; -export { default } from './module'; +import { default as feature } from './module'; +import { + IncrementalIngestionProviderExtensionPoint as ExtensionPoint, + incrementalIngestionProvidersExtensionPoint as extensionPoint, +} from './module'; + +/** @alpha */ +const _feature = feature; +export default _feature; + +/** @alpha */ +export type IncrementalIngestionProviderExtensionPoint = ExtensionPoint; +/** @alpha */ +export const incrementalIngestionProvidersExtensionPoint = extensionPoint; diff --git a/plugins/catalog-backend-module-incremental-ingestion/src/index.ts b/plugins/catalog-backend-module-incremental-ingestion/src/index.ts index fcd7670245..73c0e33946 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/src/index.ts +++ b/plugins/catalog-backend-module-incremental-ingestion/src/index.ts @@ -14,18 +14,14 @@ * 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. * * @packageDocumentation */ +export { default } from './module'; +export * from './module'; export * from './service'; export { type EntityIteratorResult, diff --git a/plugins/catalog-backend-module-incremental-ingestion/src/module/catalogModuleIncrementalIngestionEntityProvider.ts b/plugins/catalog-backend-module-incremental-ingestion/src/module/catalogModuleIncrementalIngestionEntityProvider.ts index adb5ab6a04..8752bd3137 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/src/module/catalogModuleIncrementalIngestionEntityProvider.ts +++ b/plugins/catalog-backend-module-incremental-ingestion/src/module/catalogModuleIncrementalIngestionEntityProvider.ts @@ -27,7 +27,7 @@ import { import { WrapperProviders } from './WrapperProviders'; /** - * @alpha + * @public * Interface for {@link incrementalIngestionProvidersExtensionPoint}. */ export interface IncrementalIngestionProviderExtensionPoint { @@ -39,7 +39,7 @@ export interface IncrementalIngestionProviderExtensionPoint { } /** - * @alpha + * @public * * Extension point for registering incremental ingestion providers. * The `catalogModuleIncrementalIngestionEntityProvider` must be installed for these providers to work. @@ -80,7 +80,7 @@ export const incrementalIngestionProvidersExtensionPoint = /** * Registers the incremental entity provider with the catalog processing extension point. * - * @alpha + * @public */ export const catalogModuleIncrementalIngestionEntityProvider = createBackendModule({ diff --git a/plugins/catalog-backend-module-msgraph/report-alpha.api.md b/plugins/catalog-backend-module-msgraph/report-alpha.api.md index 8129aec50f..416c335bff 100644 --- a/plugins/catalog-backend-module-msgraph/report-alpha.api.md +++ b/plugins/catalog-backend-module-msgraph/report-alpha.api.md @@ -10,32 +10,24 @@ import { OrganizationTransformer } from '@backstage/plugin-catalog-backend-modul import { ProviderConfigTransformer } from '@backstage/plugin-catalog-backend-module-msgraph'; import { UserTransformer } from '@backstage/plugin-catalog-backend-module-msgraph'; -// @alpha -const catalogModuleMicrosoftGraphOrgEntityProvider: BackendFeature; -export default catalogModuleMicrosoftGraphOrgEntityProvider; +// @alpha (undocumented) +const _feature: BackendFeature; +export default _feature; -// @alpha -export const microsoftGraphOrgEntityProviderTransformExtensionPoint: ExtensionPoint; +// Warning: (ae-forgotten-export) The symbol "MicrosoftGraphOrgEntityProviderTransformsExtensionPoint_2" needs to be exported by the entry point alpha.d.ts +// +// @alpha (undocumented) +export const microsoftGraphOrgEntityProviderTransformExtensionPoint: ExtensionPoint; -// @alpha -export interface MicrosoftGraphOrgEntityProviderTransformsExtensionPoint { - setGroupTransformer( - transformer: GroupTransformer | Record, - ): void; - setOrganizationTransformer( - transformer: - | OrganizationTransformer - | Record, - ): void; - setProviderConfigTransformer( - transformer: - | ProviderConfigTransformer - | Record, - ): void; - setUserTransformer( - transformer: UserTransformer | Record, - ): void; -} +// @alpha (undocumented) +export type MicrosoftGraphOrgEntityProviderTransformsExtensionPoint = + MicrosoftGraphOrgEntityProviderTransformsExtensionPoint_2; + +// Warnings were encountered during analysis: +// +// src/alpha.d.ts:3:15 - (ae-undocumented) Missing documentation for "_feature". +// src/alpha.d.ts:6:1 - (ae-undocumented) Missing documentation for "MicrosoftGraphOrgEntityProviderTransformsExtensionPoint". +// src/alpha.d.ts:8:22 - (ae-undocumented) Missing documentation for "microsoftGraphOrgEntityProviderTransformExtensionPoint". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-msgraph/report.api.md b/plugins/catalog-backend-module-msgraph/report.api.md index 3e29ed76df..4d7c0966a5 100644 --- a/plugins/catalog-backend-module-msgraph/report.api.md +++ b/plugins/catalog-backend-module-msgraph/report.api.md @@ -9,16 +9,25 @@ import { CatalogProcessorEmit } from '@backstage/plugin-catalog-node'; import { Config } from '@backstage/config'; import { EntityProvider } from '@backstage/plugin-catalog-node'; import { EntityProviderConnection } from '@backstage/plugin-catalog-node'; +import { ExtensionPoint } from '@backstage/backend-plugin-api'; import { GroupEntity } from '@backstage/catalog-model'; +import { GroupTransformer as GroupTransformer_2 } from '@backstage/plugin-catalog-backend-module-msgraph'; import { LocationSpec } from '@backstage/plugin-catalog-common'; import { LoggerService } from '@backstage/backend-plugin-api'; import * as MicrosoftGraph from '@microsoft/microsoft-graph-types'; +import { OrganizationTransformer as OrganizationTransformer_2 } from '@backstage/plugin-catalog-backend-module-msgraph'; +import { ProviderConfigTransformer as ProviderConfigTransformer_2 } from '@backstage/plugin-catalog-backend-module-msgraph'; import { Response as Response_2 } from 'node-fetch'; import { SchedulerService } from '@backstage/backend-plugin-api'; import { SchedulerServiceTaskRunner } from '@backstage/backend-plugin-api'; import { SchedulerServiceTaskScheduleDefinition } from '@backstage/backend-plugin-api'; import { TokenCredential } from '@azure/identity'; import { UserEntity } from '@backstage/catalog-model'; +import { UserTransformer as UserTransformer_2 } from '@backstage/plugin-catalog-backend-module-msgraph'; + +// @public +const catalogModuleMicrosoftGraphOrgEntityProvider: BackendFeature; +export default catalogModuleMicrosoftGraphOrgEntityProvider; // @public export function defaultGroupTransformer( @@ -37,10 +46,6 @@ export function defaultUserTransformer( userPhoto?: string, ): Promise; -// @public (undocumented) -const _feature: BackendFeature; -export default _feature; - // @public export type GroupMember = | (MicrosoftGraph.Group & { @@ -172,6 +177,29 @@ export type MicrosoftGraphOrgEntityProviderOptions = | Record; }; +// @public +export const microsoftGraphOrgEntityProviderTransformExtensionPoint: ExtensionPoint; + +// @public +export interface MicrosoftGraphOrgEntityProviderTransformsExtensionPoint { + setGroupTransformer( + transformer: GroupTransformer_2 | Record, + ): void; + setOrganizationTransformer( + transformer: + | OrganizationTransformer_2 + | Record, + ): void; + setProviderConfigTransformer( + transformer: + | ProviderConfigTransformer_2 + | Record, + ): void; + setUserTransformer( + transformer: UserTransformer_2 | Record, + ): void; +} + // @public @deprecated export class MicrosoftGraphOrgReaderProcessor implements CatalogProcessor { constructor(options: { @@ -298,8 +326,6 @@ 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" @@ -307,6 +333,4 @@ 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/alpha.ts b/plugins/catalog-backend-module-msgraph/src/alpha.ts index 01a9b25f7c..2c0cfe2fb4 100644 --- a/plugins/catalog-backend-module-msgraph/src/alpha.ts +++ b/plugins/catalog-backend-module-msgraph/src/alpha.ts @@ -14,5 +14,19 @@ * limitations under the License. */ -export * from './module'; -export { default } from './module'; +import { default as feature } from './module'; +import { + MicrosoftGraphOrgEntityProviderTransformsExtensionPoint as ExtensionPoint, + microsoftGraphOrgEntityProviderTransformExtensionPoint as extensionPoint, +} from './module'; + +/** @alpha */ +const _feature = feature; +export default _feature; + +/** @alpha */ +export type MicrosoftGraphOrgEntityProviderTransformsExtensionPoint = + ExtensionPoint; +/** @alpha */ +export const microsoftGraphOrgEntityProviderTransformExtensionPoint = + extensionPoint; diff --git a/plugins/catalog-backend-module-msgraph/src/index.ts b/plugins/catalog-backend-module-msgraph/src/index.ts index 4dd70d32e8..bd7e72479b 100644 --- a/plugins/catalog-backend-module-msgraph/src/index.ts +++ b/plugins/catalog-backend-module-msgraph/src/index.ts @@ -14,17 +14,13 @@ * 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 * * @packageDocumentation */ +export { default } from './module'; +export * from './module'; export * from './microsoftGraph'; export * from './processors'; diff --git a/plugins/catalog-backend-module-msgraph/src/module/catalogModuleMicrosoftGraphOrgEntityProvider.ts b/plugins/catalog-backend-module-msgraph/src/module/catalogModuleMicrosoftGraphOrgEntityProvider.ts index e1a15a3468..262c56cf3f 100644 --- a/plugins/catalog-backend-module-msgraph/src/module/catalogModuleMicrosoftGraphOrgEntityProvider.ts +++ b/plugins/catalog-backend-module-msgraph/src/module/catalogModuleMicrosoftGraphOrgEntityProvider.ts @@ -31,7 +31,7 @@ import { MicrosoftGraphOrgEntityProvider } from '../processors'; /** * Interface for {@link microsoftGraphOrgEntityProviderTransformExtensionPoint}. * - * @alpha + * @public */ export interface MicrosoftGraphOrgEntityProviderTransformsExtensionPoint { /** @@ -76,7 +76,7 @@ export interface MicrosoftGraphOrgEntityProviderTransformsExtensionPoint { /** * Extension point used to customize the transforms used by the module. * - * @alpha + * @public */ export const microsoftGraphOrgEntityProviderTransformExtensionPoint = createExtensionPoint( @@ -88,7 +88,7 @@ export const microsoftGraphOrgEntityProviderTransformExtensionPoint = /** * Registers the MicrosoftGraphOrgEntityProvider with the catalog processing extension point. * - * @alpha + * @public */ export const catalogModuleMicrosoftGraphOrgEntityProvider = createBackendModule( {