diff --git a/.changeset/catalog-node-extension-points-to-stable.md b/.changeset/catalog-node-extension-points-to-stable.md index b901007053..7e8e22dfc5 100644 --- a/.changeset/catalog-node-extension-points-to-stable.md +++ b/.changeset/catalog-node-extension-points-to-stable.md @@ -7,8 +7,7 @@ Promoted stable catalog extension points from alpha to main export. The followin - `catalogLocationsExtensionPoint` and `CatalogLocationsExtensionPoint` - `catalogProcessingExtensionPoint` and `CatalogProcessingExtensionPoint` - `catalogAnalysisExtensionPoint` and `CatalogAnalysisExtensionPoint` -- `catalogModelExtensionPoint` and `CatalogModelExtensionPoint` The old alpha exports for these extension points are now deprecated with `@deprecated` markers pointing to the new stable exports. Please update your imports from `@backstage/plugin-catalog-node/alpha` to `@backstage/plugin-catalog-node`. -Note: The `catalogPermissionExtensionPoint`, `CatalogPermissionExtensionPoint`, and `CatalogPermissionRuleInput` remain in alpha as they are deprecated in favor of `coreServices.permissionsRegistry`. +Note: The `catalogModelExtensionPoint`, `catalogPermissionExtensionPoint`, and related types remain in alpha. diff --git a/docs/features/software-catalog/extending-the-model--old.md b/docs/features/software-catalog/extending-the-model--old.md index c5f301c694..c39561d11b 100644 --- a/docs/features/software-catalog/extending-the-model--old.md +++ b/docs/features/software-catalog/extending-the-model--old.md @@ -166,7 +166,7 @@ This is an example of relaxing the format rules of the `metadata.name` field: ```ts import { createBackend } from '@backstage/backend-defaults'; import { createBackendModule } from '@backstage/backend-plugin-api'; -import { catalogModelExtensionPoint } from '@backstage/plugin-catalog-node'; +import { catalogModelExtensionPoint } from '@backstage/plugin-catalog-node/alpha'; const myCatalogCustomizations = createBackendModule({ pluginId: 'catalog', diff --git a/docs/features/software-catalog/extending-the-model.md b/docs/features/software-catalog/extending-the-model.md index 1737d42d5a..b0161c97ff 100644 --- a/docs/features/software-catalog/extending-the-model.md +++ b/docs/features/software-catalog/extending-the-model.md @@ -166,7 +166,7 @@ This is an example of relaxing the format rules of the `metadata.name` field: ```ts import { createBackend } from '@backstage/backend-defaults'; import { createBackendModule } from '@backstage/backend-plugin-api'; -import { catalogModelExtensionPoint } from '@backstage/plugin-catalog-node'; +import { catalogModelExtensionPoint } from '@backstage/plugin-catalog-node/alpha'; const myCatalogCustomizations = createBackendModule({ pluginId: 'catalog', diff --git a/docs/features/software-catalog/external-integrations.md b/docs/features/software-catalog/external-integrations.md index 68ca746e4f..a042c4fc4d 100644 --- a/docs/features/software-catalog/external-integrations.md +++ b/docs/features/software-catalog/external-integrations.md @@ -998,7 +998,7 @@ import { coreServices, createBackendModule, } from '@backstage/backend-plugin-api'; -import { catalogModelExtensionPoint } from '@backstage/plugin-catalog-node'; +import { catalogModelExtensionPoint } from '@backstage/plugin-catalog-node/alpha'; import { customEntityDataParser } from '../lib/customEntityDataParser'; export const catalogModuleCustomDataParser = createBackendModule({ diff --git a/plugins/catalog-backend/src/service/CatalogPlugin.ts b/plugins/catalog-backend/src/service/CatalogPlugin.ts index 54b87470ef..a774d79457 100644 --- a/plugins/catalog-backend/src/service/CatalogPlugin.ts +++ b/plugins/catalog-backend/src/service/CatalogPlugin.ts @@ -31,11 +31,11 @@ import { catalogAnalysisExtensionPoint, CatalogLocationsExtensionPoint, catalogLocationsExtensionPoint, - CatalogModelExtensionPoint, - catalogModelExtensionPoint, catalogProcessingExtensionPoint, } from '@backstage/plugin-catalog-node'; import { + CatalogModelExtensionPoint, + catalogModelExtensionPoint, CatalogPermissionExtensionPoint, catalogPermissionExtensionPoint, CatalogPermissionRuleInput, diff --git a/plugins/catalog-node/report-alpha.api.md b/plugins/catalog-node/report-alpha.api.md index 6027204fe5..c8ba44717b 100644 --- a/plugins/catalog-node/report-alpha.api.md +++ b/plugins/catalog-node/report-alpha.api.md @@ -6,8 +6,8 @@ import { CatalogAnalysisExtensionPoint as CatalogAnalysisExtensionPoint_2 } from '@backstage/plugin-catalog-node'; import { CatalogApi } from '@backstage/catalog-client'; import { CatalogLocationsExtensionPoint as CatalogLocationsExtensionPoint_2 } from '@backstage/plugin-catalog-node'; -import { CatalogModelExtensionPoint as CatalogModelExtensionPoint_2 } from '@backstage/plugin-catalog-node'; import { CatalogProcessingExtensionPoint as CatalogProcessingExtensionPoint_2 } from '@backstage/plugin-catalog-node'; +import { CatalogProcessorParser } from '@backstage/plugin-catalog-node'; import { EntitiesSearchFilter } from '@backstage/plugin-catalog-node'; import { Entity } from '@backstage/catalog-model'; import { ExtensionPoint } from '@backstage/backend-plugin-api'; @@ -16,6 +16,7 @@ import { PermissionResourceRef } from '@backstage/plugin-permission-node'; import { PermissionRule } from '@backstage/plugin-permission-node'; import { PermissionRuleParams } from '@backstage/plugin-permission-common'; import { ServiceRef } from '@backstage/backend-plugin-api'; +import { Validators } from '@backstage/catalog-model'; // @alpha @deprecated (undocumented) export type CatalogAnalysisExtensionPoint = CatalogAnalysisExtensionPoint_2; @@ -37,11 +38,14 @@ export type CatalogLocationsExtensionPoint = CatalogLocationsExtensionPoint_2; // @alpha @deprecated (undocumented) export const catalogLocationsExtensionPoint: ExtensionPoint; -// @alpha @deprecated (undocumented) -export type CatalogModelExtensionPoint = CatalogModelExtensionPoint_2; +// @alpha (undocumented) +export interface CatalogModelExtensionPoint { + setEntityDataParser(parser: CatalogProcessorParser): void; + setFieldValidators(validators: Partial): void; +} -// @alpha @deprecated (undocumented) -export const catalogModelExtensionPoint: ExtensionPoint; +// @alpha (undocumented) +export const catalogModelExtensionPoint: ExtensionPoint; // @alpha @deprecated (undocumented) export interface CatalogPermissionExtensionPoint { diff --git a/plugins/catalog-node/report.api.md b/plugins/catalog-node/report.api.md index 68040c2e61..2db2f883af 100644 --- a/plugins/catalog-node/report.api.md +++ b/plugins/catalog-node/report.api.md @@ -10,7 +10,6 @@ import { AnalyzeLocationRequest } from '@backstage/plugin-catalog-common'; import { AnalyzeLocationResponse } from '@backstage/plugin-catalog-common'; import { BackstageCredentials } from '@backstage/backend-plugin-api'; import { CatalogProcessor as CatalogProcessor_2 } from '@backstage/plugin-catalog-node'; -import { CatalogProcessorParser as CatalogProcessorParser_2 } from '@backstage/plugin-catalog-node'; import { CompoundEntityRef } from '@backstage/catalog-model'; import { Entity } from '@backstage/catalog-model'; import { EntityProvider as EntityProvider_2 } from '@backstage/plugin-catalog-node'; @@ -36,7 +35,6 @@ import { ScmLocationAnalyzer as ScmLocationAnalyzer_2 } from '@backstage/plugin- import { ServiceRef } from '@backstage/backend-plugin-api'; import { StreamEntitiesRequest } from '@backstage/catalog-client'; import { ValidateEntityResponse } from '@backstage/catalog-client'; -import { Validators } from '@backstage/catalog-model'; // @public (undocumented) export type AnalyzeOptions = { @@ -69,15 +67,6 @@ export interface CatalogLocationsExtensionPoint { // @public (undocumented) export const catalogLocationsExtensionPoint: ExtensionPoint; -// @public (undocumented) -export interface CatalogModelExtensionPoint { - setEntityDataParser(parser: CatalogProcessorParser_2): void; - setFieldValidators(validators: Partial): void; -} - -// @public (undocumented) -export const catalogModelExtensionPoint: ExtensionPoint; - // @public (undocumented) export interface CatalogProcessingExtensionPoint { addEntityProvider( diff --git a/plugins/catalog-node/src/alpha.ts b/plugins/catalog-node/src/alpha.ts index 5041d74fdb..8b42be5a95 100644 --- a/plugins/catalog-node/src/alpha.ts +++ b/plugins/catalog-node/src/alpha.ts @@ -57,11 +57,9 @@ import { CatalogLocationsExtensionPoint as _CatalogLocationsExtensionPoint, CatalogProcessingExtensionPoint as _CatalogProcessingExtensionPoint, CatalogAnalysisExtensionPoint as _CatalogAnalysisExtensionPoint, - CatalogModelExtensionPoint as _CatalogModelExtensionPoint, catalogLocationsExtensionPoint as _catalogLocationsExtensionPoint, catalogProcessingExtensionPoint as _catalogProcessingExtensionPoint, catalogAnalysisExtensionPoint as _catalogAnalysisExtensionPoint, - catalogModelExtensionPoint as _catalogModelExtensionPoint, } from '@backstage/plugin-catalog-node'; /** @@ -100,18 +98,8 @@ export type CatalogAnalysisExtensionPoint = _CatalogAnalysisExtensionPoint; */ export const catalogAnalysisExtensionPoint = _catalogAnalysisExtensionPoint; -/** - * @alpha - * @deprecated Use {@link @backstage/plugin-catalog-node#CatalogModelExtensionPoint} instead - */ -export type CatalogModelExtensionPoint = _CatalogModelExtensionPoint; - -/** - * @alpha - * @deprecated Use {@link @backstage/plugin-catalog-node#catalogModelExtensionPoint} instead - */ -export const catalogModelExtensionPoint = _catalogModelExtensionPoint; - +export type { CatalogModelExtensionPoint } from './extensions'; +export { catalogModelExtensionPoint } from './extensions'; export type { CatalogPermissionRuleInput } from './extensions'; export type { CatalogPermissionExtensionPoint } from './extensions'; export { catalogPermissionExtensionPoint } from './extensions'; diff --git a/plugins/catalog-node/src/extensions.ts b/plugins/catalog-node/src/extensions.ts index 9d5002ccd1..4fe4bfd679 100644 --- a/plugins/catalog-node/src/extensions.ts +++ b/plugins/catalog-node/src/extensions.ts @@ -97,7 +97,7 @@ export interface CatalogProcessingExtensionPoint { ): void; } -/** @public */ +/** @alpha */ export interface CatalogModelExtensionPoint { /** * Sets the validator function to use for one or more special fields of an @@ -158,7 +158,7 @@ export const catalogAnalysisExtensionPoint = id: 'catalog.analysis', }); -/** @public */ +/** @alpha */ export const catalogModelExtensionPoint = createExtensionPoint({ id: 'catalog.model', diff --git a/plugins/catalog-node/src/index.ts b/plugins/catalog-node/src/index.ts index 33464607d2..d0c947e23a 100644 --- a/plugins/catalog-node/src/index.ts +++ b/plugins/catalog-node/src/index.ts @@ -32,11 +32,9 @@ export type { CatalogLocationsExtensionPoint, CatalogProcessingExtensionPoint, CatalogAnalysisExtensionPoint, - CatalogModelExtensionPoint, } from './extensions'; export { catalogLocationsExtensionPoint, catalogProcessingExtensionPoint, catalogAnalysisExtensionPoint, - catalogModelExtensionPoint, } from './extensions';