fix up the exports to keep the DEPRECATION

Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2022-03-03 14:00:23 +01:00
parent 2255bfd1c4
commit 48997f9bcf
4 changed files with 12 additions and 11 deletions
+1 -1
View File
@@ -3,7 +3,7 @@
'@backstage/plugin-catalog-common': patch
---
Moved the `CatalogEntityDocument` to `@backstage/plugin-catalog-common` and deprecated the export from `@backstage/plugin-catalog-backend`.
**DEPRECATION**: Moved the `CatalogEntityDocument` to `@backstage/plugin-catalog-common` and deprecated the export from `@backstage/plugin-catalog-backend`.
A new `type` field has also been added to `CatalogEntityDocument` as a replacement for `componentType`, which is now deprecated. Both fields are still present and should be set to the same value in order to avoid issues with indexing.
+4 -3
View File
@@ -7,7 +7,7 @@
import { BitbucketIntegration } from '@backstage/integration';
import { CatalogApi } from '@backstage/catalog-client';
import { CatalogEntityDocument } from '@backstage/plugin-catalog-common';
import { CatalogEntityDocument as CatalogEntityDocument_2 } from '@backstage/plugin-catalog-common';
import { CompoundEntityRef } from '@backstage/catalog-model';
import { ConditionalPolicyDecision } from '@backstage/plugin-permission-node';
import { Conditions } from '@backstage/plugin-permission-node';
@@ -248,7 +248,8 @@ export const catalogConditions: Conditions<{
>;
}>;
export { CatalogEntityDocument };
// @public @deprecated (undocumented)
export type CatalogEntityDocument = CatalogEntityDocument_2;
// @public (undocumented)
export type CatalogEnvironment = {
@@ -423,7 +424,7 @@ export class DefaultCatalogCollator {
// (undocumented)
protected discovery: PluginEndpointDiscovery;
// (undocumented)
execute(): Promise<CatalogEntityDocument[]>;
execute(): Promise<CatalogEntityDocument_2[]>;
// (undocumented)
protected filter?: GetEntitiesRequest['filter'];
// (undocumented)
@@ -36,11 +36,6 @@ import {
} from '@backstage/plugin-catalog-common';
import { Readable } from 'stream';
/**
* @deprecated import from `@backstage/plugin-catalog-common` instead
*/
export type { CatalogEntityDocument };
/** @public */
export type DefaultCatalogCollatorFactoryOptions = {
discovery: PluginEndpointDiscovery;
+7 -2
View File
@@ -17,8 +17,13 @@
export { DefaultCatalogCollatorFactory } from './DefaultCatalogCollatorFactory';
export type { DefaultCatalogCollatorFactoryOptions } from './DefaultCatalogCollatorFactory';
/** @public @deprecated use the export from `plugin-catalog-common` instead */
export type { CatalogEntityDocument } from '@backstage/plugin-catalog-common';
import { CatalogEntityDocument as CatalogEntityDocumentType } from '@backstage/plugin-catalog-common';
/**
* @deprecated import from `@backstage/plugin-catalog-common` instead
* @public
*/
export type CatalogEntityDocument = CatalogEntityDocumentType;
/**
* todo(backstage/techdocs-core): stop exporting this in a future release.