plugins/catalog-backend-module-*: flip around alpha exports to stable

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2024-10-13 10:54:10 +02:00
parent bc71718834
commit 881507f9d5
45 changed files with 230 additions and 201 deletions
@@ -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)
```
@@ -105,6 +105,10 @@ export class AwsS3EntityProvider implements EntityProvider {
refresh(logger: LoggerService): Promise<void>;
}
// @public
const catalogModuleAwsS3EntityProvider: BackendFeature;
export default catalogModuleAwsS3EntityProvider;
// @public
export const defaultEksClusterEntityTransformer: EksClusterEntityTransformer;
@@ -114,14 +118,8 @@ export type EksClusterEntityTransformer = (
accountId: string,
) => Promise<Entity>;
// @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)
```
@@ -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;
@@ -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';
@@ -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',
@@ -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)
```
@@ -55,19 +55,15 @@ export class AzureDevOpsEntityProvider implements EntityProvider {
refresh(logger: LoggerService): Promise<void>;
}
// @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)
```
@@ -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;
@@ -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';
@@ -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',
@@ -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)
```
@@ -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)
```
@@ -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;
@@ -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';
@@ -26,7 +26,7 @@ import { eventsServiceRef } from '@backstage/plugin-events-node';
import { BitbucketCloudEntityProvider } from '../providers/BitbucketCloudEntityProvider';
/**
* @alpha
* @public
*/
export const catalogModuleBitbucketCloudEntityProvider = createBackendModule({
pluginId: 'catalog',
@@ -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)
```
@@ -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)
```
@@ -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;
@@ -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,
@@ -22,7 +22,7 @@ import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/
import { BitbucketServerEntityProvider } from '../providers';
/**
* @alpha
* @public
*/
export const catalogModuleBitbucketServerEntityProvider = createBackendModule({
pluginId: 'catalog',
@@ -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)
```
@@ -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".
@@ -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;
@@ -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';
@@ -22,7 +22,7 @@ import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/
import { GerritEntityProvider } from '../providers/GerritEntityProvider';
/**
* @alpha
* @public
*/
export const catalogModuleGerritEntityProvider = createBackendModule({
pluginId: 'catalog',
@@ -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)
```
@@ -38,9 +38,9 @@ export const defaultUserTransformer: (
_ctx: TransformerContext,
) => Promise<UserEntity | undefined>;
// @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)
```
@@ -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;
@@ -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';
@@ -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',
@@ -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)
```
@@ -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)
```
@@ -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;
@@ -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,
@@ -25,7 +25,7 @@ import { GitlabDiscoveryEntityProvider } from '../providers';
/**
* Registers the GitlabDiscoveryEntityProvider with the catalog processing extension point.
*
* @alpha
* @public
*/
export const catalogModuleGitlabDiscoveryEntityProvider = createBackendModule({
@@ -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<TCursor, TContext>(config: {
options: IncrementalEntityProviderOptions;
provider: IncrementalEntityProvider<TCursor, TContext>;
}): 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<IncrementalIngestionProviderExtensionPoint>;
// @alpha (undocumented)
export const incrementalIngestionProvidersExtensionPoint: ExtensionPoint<IncrementalIngestionProviderExtensionPoint_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 "IncrementalIngestionProviderExtensionPoint".
// src/alpha.d.ts:8:22 - (ae-undocumented) Missing documentation for "incrementalIngestionProvidersExtensionPoint".
// (No @packageDocumentation comment for this package)
```
@@ -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<T> =
| {
@@ -32,10 +39,6 @@ export type EntityIteratorResult<T> =
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<TCursor, TContext>(config: {
options: IncrementalEntityProviderOptions_2;
provider: IncrementalEntityProvider_2<TCursor, TContext>;
}): void;
}
// @public
export const incrementalIngestionProvidersExtensionPoint: ExtensionPoint<IncrementalIngestionProviderExtensionPoint>;
// @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)
```
@@ -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;
@@ -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,
@@ -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({
@@ -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<MicrosoftGraphOrgEntityProviderTransformsExtensionPoint>;
// 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<MicrosoftGraphOrgEntityProviderTransformsExtensionPoint_2>;
// @alpha
export interface MicrosoftGraphOrgEntityProviderTransformsExtensionPoint {
setGroupTransformer(
transformer: GroupTransformer | Record<string, GroupTransformer>,
): void;
setOrganizationTransformer(
transformer:
| OrganizationTransformer
| Record<string, OrganizationTransformer>,
): void;
setProviderConfigTransformer(
transformer:
| ProviderConfigTransformer
| Record<string, ProviderConfigTransformer>,
): void;
setUserTransformer(
transformer: UserTransformer | Record<string, UserTransformer>,
): 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)
```
@@ -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<UserEntity | undefined>;
// @public (undocumented)
const _feature: BackendFeature;
export default _feature;
// @public
export type GroupMember =
| (MicrosoftGraph.Group & {
@@ -172,6 +177,29 @@ export type MicrosoftGraphOrgEntityProviderOptions =
| Record<string, ProviderConfigTransformer>;
};
// @public
export const microsoftGraphOrgEntityProviderTransformExtensionPoint: ExtensionPoint<MicrosoftGraphOrgEntityProviderTransformsExtensionPoint>;
// @public
export interface MicrosoftGraphOrgEntityProviderTransformsExtensionPoint {
setGroupTransformer(
transformer: GroupTransformer_2 | Record<string, GroupTransformer_2>,
): void;
setOrganizationTransformer(
transformer:
| OrganizationTransformer_2
| Record<string, OrganizationTransformer_2>,
): void;
setProviderConfigTransformer(
transformer:
| ProviderConfigTransformer_2
| Record<string, ProviderConfigTransformer_2>,
): void;
setUserTransformer(
transformer: UserTransformer_2 | Record<string, UserTransformer_2>,
): 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)
```
@@ -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;
@@ -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';
@@ -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<MicrosoftGraphOrgEntityProviderTransformsExtensionPoint>(
@@ -88,7 +88,7 @@ export const microsoftGraphOrgEntityProviderTransformExtensionPoint =
/**
* Registers the MicrosoftGraphOrgEntityProvider with the catalog processing extension point.
*
* @alpha
* @public
*/
export const catalogModuleMicrosoftGraphOrgEntityProvider = createBackendModule(
{