@backstage/plugin-catalog-node 1.3.3 → 1.3.4-next.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @backstage/plugin-catalog-node
 
+## 1.3.4-next.0
+
+### Patch Changes
+
+- 928a12a9b3: Internal refactor of `/alpha` exports.
+- Updated dependencies
+  - @backstage/catalog-client@1.4.0-next.0
+  - @backstage/backend-plugin-api@0.4.1-next.0
+  - @backstage/catalog-model@1.2.1-next.0
+  - @backstage/plugin-catalog-common@1.0.12-next.0
+  - @backstage/errors@1.1.4
+  - @backstage/types@1.0.2
+
 ## 1.3.3
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-node",
-  "version": "1.3.3",
-  "main": "../dist/index.cjs.js",
-  "types": "../dist/index.alpha.d.ts"
+  "version": "1.3.4-next.0",
+  "main": "../dist/alpha.cjs.js",
+  "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.cjs.js

@@ -0,0 +1,27 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var catalogClient = require('@backstage/catalog-client');
+
+const catalogServiceRef = backendPluginApi.createServiceRef({
+  id: "catalog-client",
+  defaultFactory: async (service) => backendPluginApi.createServiceFactory({
+    service,
+    deps: {
+      discoveryApi: backendPluginApi.coreServices.discovery
+    },
+    async factory({ discoveryApi }) {
+      return new catalogClient.CatalogClient({ discoveryApi });
+    }
+  })
+});
+
+const catalogProcessingExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "catalog.processing"
+});
+
+exports.catalogProcessingExtensionPoint = catalogProcessingExtensionPoint;
+exports.catalogServiceRef = catalogServiceRef;
+//# sourceMappingURL=alpha.cjs.js.map

package/dist/alpha.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alpha.cjs.js","sources":["../src/catalogService.ts","../src/extensions.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  createServiceFactory,\n  createServiceRef,\n  coreServices,\n} from '@backstage/backend-plugin-api';\nimport { CatalogApi, CatalogClient } from '@backstage/catalog-client';\n\n/**\n * The catalogService provides the catalog API.\n * @alpha\n */\nexport const catalogServiceRef = createServiceRef<CatalogApi>({\n  id: 'catalog-client',\n  defaultFactory: async service =>\n    createServiceFactory({\n      service,\n      deps: {\n        discoveryApi: coreServices.discovery,\n      },\n      async factory({ discoveryApi }) {\n        return new CatalogClient({ discoveryApi });\n      },\n    }),\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport {\n  EntityProvider,\n  CatalogProcessor,\n} from '@backstage/plugin-catalog-node';\n\n/**\n * @alpha\n */\nexport interface CatalogProcessingExtensionPoint {\n  addProcessor(\n    ...processors: Array<CatalogProcessor | Array<CatalogProcessor>>\n  ): void;\n  addEntityProvider(\n    ...providers: Array<EntityProvider | Array<EntityProvider>>\n  ): void;\n}\n\n/**\n * @alpha\n */\nexport const catalogProcessingExtensionPoint =\n  createExtensionPoint<CatalogProcessingExtensionPoint>({\n    id: 'catalog.processing',\n  });\n"],"names":["createServiceRef","createServiceFactory","coreServices","CatalogClient","createExtensionPoint"],"mappings":";;;;;;;AA2BO,MAAM,oBAAoBA,iCAA6B,CAAA;AAAA,EAC5D,EAAI,EAAA,gBAAA;AAAA,EACJ,cAAA,EAAgB,OAAM,OAAA,KACpBC,qCAAqB,CAAA;AAAA,IACnB,OAAA;AAAA,IACA,IAAM,EAAA;AAAA,MACJ,cAAcC,6BAAa,CAAA,SAAA;AAAA,KAC7B;AAAA,IACA,MAAM,OAAA,CAAQ,EAAE,YAAA,EAAgB,EAAA;AAC9B,MAAA,OAAO,IAAIC,2BAAA,CAAc,EAAE,YAAA,EAAc,CAAA,CAAA;AAAA,KAC3C;AAAA,GACD,CAAA;AACL,CAAC;;ACHM,MAAM,kCACXC,qCAAsD,CAAA;AAAA,EACpD,EAAI,EAAA,oBAAA;AACN,CAAC;;;;;"}

package/dist/alpha.d.ts

@@ -0,0 +1,23 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { CatalogApi } from '@backstage/catalog-client';
+import { CatalogProcessor, EntityProvider } from '@backstage/plugin-catalog-node';
+
+/**
+ * The catalogService provides the catalog API.
+ * @alpha
+ */
+declare const catalogServiceRef: _backstage_backend_plugin_api.ServiceRef<CatalogApi, "plugin">;
+
+/**
+ * @alpha
+ */
+interface CatalogProcessingExtensionPoint {
+    addProcessor(...processors: Array<CatalogProcessor | Array<CatalogProcessor>>): void;
+    addEntityProvider(...providers: Array<EntityProvider | Array<EntityProvider>>): void;
+}
+/**
+ * @alpha
+ */
+declare const catalogProcessingExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<CatalogProcessingExtensionPoint>;
+
+export { CatalogProcessingExtensionPoint, catalogProcessingExtensionPoint, catalogServiceRef };

package/dist/index.cjs.js

@@ -2,27 +2,8 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var backendPluginApi = require('@backstage/backend-plugin-api');
-var catalogClient = require('@backstage/catalog-client');
 var errors = require('@backstage/errors');
 
-const catalogProcessingExtensionPoint = backendPluginApi.createExtensionPoint({
-  id: "catalog.processing"
-});
-
-const catalogServiceRef = backendPluginApi.createServiceRef({
-  id: "catalog-client",
-  defaultFactory: async (service) => backendPluginApi.createServiceFactory({
-    service,
-    deps: {
-      discoveryApi: backendPluginApi.coreServices.discovery
-    },
-    async factory({ discoveryApi }) {
-      return new catalogClient.CatalogClient({ discoveryApi });
-    }
-  })
-});
-
 const processingResult = Object.freeze({
   notFoundError(atLocation, message) {
     return {
@@ -55,7 +36,5 @@ const processingResult = Object.freeze({
   }
 });
 
-exports.catalogProcessingExtensionPoint = catalogProcessingExtensionPoint;
-exports.catalogServiceRef = catalogServiceRef;
 exports.processingResult = processingResult;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/extensions.ts","../src/catalogService.ts","../src/api/processingResult.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport { EntityProvider } from './api';\nimport { CatalogProcessor } from './api/processor';\n\n/**\n * @alpha\n */\nexport interface CatalogProcessingExtensionPoint {\n  addProcessor(\n    ...processors: Array<CatalogProcessor | Array<CatalogProcessor>>\n  ): void;\n  addEntityProvider(\n    ...providers: Array<EntityProvider | Array<EntityProvider>>\n  ): void;\n}\n\n/**\n * @alpha\n */\nexport const catalogProcessingExtensionPoint =\n  createExtensionPoint<CatalogProcessingExtensionPoint>({\n    id: 'catalog.processing',\n  });\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  createServiceFactory,\n  createServiceRef,\n  coreServices,\n} from '@backstage/backend-plugin-api';\nimport { CatalogApi, CatalogClient } from '@backstage/catalog-client';\n\n/**\n * The catalogService provides the catalog API.\n * @alpha\n */\nexport const catalogServiceRef = createServiceRef<CatalogApi>({\n  id: 'catalog-client',\n  defaultFactory: async service =>\n    createServiceFactory({\n      service,\n      deps: {\n        discoveryApi: coreServices.discovery,\n      },\n      async factory({ discoveryApi }) {\n        return new CatalogClient({ discoveryApi });\n      },\n    }),\n});\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { InputError, NotFoundError } from '@backstage/errors';\nimport { Entity } from '@backstage/catalog-model';\nimport { CatalogProcessorResult } from './processor';\nimport { EntityRelationSpec } from './common';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\n\n/**\n * Factory functions for the standard processing result types.\n *\n * @public\n */\nexport const processingResult = Object.freeze({\n  notFoundError(\n    atLocation: LocationSpec,\n    message: string,\n  ): CatalogProcessorResult {\n    return {\n      type: 'error',\n      location: atLocation,\n      error: new NotFoundError(message),\n    };\n  },\n\n  inputError(\n    atLocation: LocationSpec,\n    message: string,\n  ): CatalogProcessorResult {\n    return {\n      type: 'error',\n      location: atLocation,\n      error: new InputError(message),\n    };\n  },\n\n  generalError(\n    atLocation: LocationSpec,\n    message: string,\n  ): CatalogProcessorResult {\n    return { type: 'error', location: atLocation, error: new Error(message) };\n  },\n\n  location(newLocation: LocationSpec): CatalogProcessorResult {\n    return { type: 'location', location: newLocation };\n  },\n\n  entity(atLocation: LocationSpec, newEntity: Entity): CatalogProcessorResult {\n    return { type: 'entity', location: atLocation, entity: newEntity };\n  },\n\n  relation(spec: EntityRelationSpec): CatalogProcessorResult {\n    return { type: 'relation', relation: spec };\n  },\n\n  refresh(key: string): CatalogProcessorResult {\n    return { type: 'refresh', key };\n  },\n} as const);\n"],"names":["createExtensionPoint","createServiceRef","createServiceFactory","coreServices","CatalogClient","NotFoundError","InputError"],"mappings":";;;;;;;;AAkCO,MAAM,kCACXA,qCAAsD,CAAA;AAAA,EACpD,EAAI,EAAA,oBAAA;AACN,CAAC;;ACVI,MAAM,oBAAoBC,iCAA6B,CAAA;AAAA,EAC5D,EAAI,EAAA,gBAAA;AAAA,EACJ,cAAA,EAAgB,OAAM,OAAA,KACpBC,qCAAqB,CAAA;AAAA,IACnB,OAAA;AAAA,IACA,IAAM,EAAA;AAAA,MACJ,cAAcC,6BAAa,CAAA,SAAA;AAAA,KAC7B;AAAA,IACA,MAAM,OAAA,CAAQ,EAAE,YAAA,EAAgB,EAAA;AAC9B,MAAA,OAAO,IAAIC,2BAAA,CAAc,EAAE,YAAA,EAAc,CAAA,CAAA;AAAA,KAC3C;AAAA,GACD,CAAA;AACL,CAAC;;ACZY,MAAA,gBAAA,GAAmB,OAAO,MAAO,CAAA;AAAA,EAC5C,aAAA,CACE,YACA,OACwB,EAAA;AACxB,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,OAAA;AAAA,MACN,QAAU,EAAA,UAAA;AAAA,MACV,KAAA,EAAO,IAAIC,oBAAA,CAAc,OAAO,CAAA;AAAA,KAClC,CAAA;AAAA,GACF;AAAA,EAEA,UAAA,CACE,YACA,OACwB,EAAA;AACxB,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,OAAA;AAAA,MACN,QAAU,EAAA,UAAA;AAAA,MACV,KAAA,EAAO,IAAIC,iBAAA,CAAW,OAAO,CAAA;AAAA,KAC/B,CAAA;AAAA,GACF;AAAA,EAEA,YAAA,CACE,YACA,OACwB,EAAA;AACxB,IAAO,OAAA,EAAE,MAAM,OAAS,EAAA,QAAA,EAAU,YAAY,KAAO,EAAA,IAAI,KAAM,CAAA,OAAO,CAAE,EAAA,CAAA;AAAA,GAC1E;AAAA,EAEA,SAAS,WAAmD,EAAA;AAC1D,IAAA,OAAO,EAAE,IAAA,EAAM,UAAY,EAAA,QAAA,EAAU,WAAY,EAAA,CAAA;AAAA,GACnD;AAAA,EAEA,MAAA,CAAO,YAA0B,SAA2C,EAAA;AAC1E,IAAA,OAAO,EAAE,IAAM,EAAA,QAAA,EAAU,QAAU,EAAA,UAAA,EAAY,QAAQ,SAAU,EAAA,CAAA;AAAA,GACnE;AAAA,EAEA,SAAS,IAAkD,EAAA;AACzD,IAAA,OAAO,EAAE,IAAA,EAAM,UAAY,EAAA,QAAA,EAAU,IAAK,EAAA,CAAA;AAAA,GAC5C;AAAA,EAEA,QAAQ,GAAqC,EAAA;AAC3C,IAAO,OAAA,EAAE,IAAM,EAAA,SAAA,EAAW,GAAI,EAAA,CAAA;AAAA,GAChC;AACF,CAAU;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/api/processingResult.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { InputError, NotFoundError } from '@backstage/errors';\nimport { Entity } from '@backstage/catalog-model';\nimport { CatalogProcessorResult } from './processor';\nimport { EntityRelationSpec } from './common';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\n\n/**\n * Factory functions for the standard processing result types.\n *\n * @public\n */\nexport const processingResult = Object.freeze({\n  notFoundError(\n    atLocation: LocationSpec,\n    message: string,\n  ): CatalogProcessorResult {\n    return {\n      type: 'error',\n      location: atLocation,\n      error: new NotFoundError(message),\n    };\n  },\n\n  inputError(\n    atLocation: LocationSpec,\n    message: string,\n  ): CatalogProcessorResult {\n    return {\n      type: 'error',\n      location: atLocation,\n      error: new InputError(message),\n    };\n  },\n\n  generalError(\n    atLocation: LocationSpec,\n    message: string,\n  ): CatalogProcessorResult {\n    return { type: 'error', location: atLocation, error: new Error(message) };\n  },\n\n  location(newLocation: LocationSpec): CatalogProcessorResult {\n    return { type: 'location', location: newLocation };\n  },\n\n  entity(atLocation: LocationSpec, newEntity: Entity): CatalogProcessorResult {\n    return { type: 'entity', location: atLocation, entity: newEntity };\n  },\n\n  relation(spec: EntityRelationSpec): CatalogProcessorResult {\n    return { type: 'relation', relation: spec };\n  },\n\n  refresh(key: string): CatalogProcessorResult {\n    return { type: 'refresh', key };\n  },\n} as const);\n"],"names":["NotFoundError","InputError"],"mappings":";;;;;;AA2Ba,MAAA,gBAAA,GAAmB,OAAO,MAAO,CAAA;AAAA,EAC5C,aAAA,CACE,YACA,OACwB,EAAA;AACxB,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,OAAA;AAAA,MACN,QAAU,EAAA,UAAA;AAAA,MACV,KAAA,EAAO,IAAIA,oBAAA,CAAc,OAAO,CAAA;AAAA,KAClC,CAAA;AAAA,GACF;AAAA,EAEA,UAAA,CACE,YACA,OACwB,EAAA;AACxB,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,OAAA;AAAA,MACN,QAAU,EAAA,UAAA;AAAA,MACV,KAAA,EAAO,IAAIC,iBAAA,CAAW,OAAO,CAAA;AAAA,KAC/B,CAAA;AAAA,GACF;AAAA,EAEA,YAAA,CACE,YACA,OACwB,EAAA;AACxB,IAAO,OAAA,EAAE,MAAM,OAAS,EAAA,QAAA,EAAU,YAAY,KAAO,EAAA,IAAI,KAAM,CAAA,OAAO,CAAE,EAAA,CAAA;AAAA,GAC1E;AAAA,EAEA,SAAS,WAAmD,EAAA;AAC1D,IAAA,OAAO,EAAE,IAAA,EAAM,UAAY,EAAA,QAAA,EAAU,WAAY,EAAA,CAAA;AAAA,GACnD;AAAA,EAEA,MAAA,CAAO,YAA0B,SAA2C,EAAA;AAC1E,IAAA,OAAO,EAAE,IAAM,EAAA,QAAA,EAAU,QAAU,EAAA,UAAA,EAAY,QAAQ,SAAU,EAAA,CAAA;AAAA,GACnE;AAAA,EAEA,SAAS,IAAkD,EAAA;AACzD,IAAA,OAAO,EAAE,IAAA,EAAM,UAAY,EAAA,QAAA,EAAU,IAAK,EAAA,CAAA;AAAA,GAC5C;AAAA,EAEA,QAAQ,GAAqC,EAAA;AAC3C,IAAO,OAAA,EAAE,IAAM,EAAA,SAAA,EAAW,GAAI,EAAA,CAAA;AAAA,GAChC;AACF,CAAU;;;;"}

package/dist/index.d.ts

@@ -1,27 +1,45 @@
-/**
- * The catalog-backend-node module for `@backstage/plugin-catalog-backend`.
- *
- * @packageDocumentation
- */
-
 /// <reference types="node" />
-
-import { CatalogApi } from '@backstage/catalog-client';
-import { CompoundEntityRef } from '@backstage/catalog-model';
-import { Entity } from '@backstage/catalog-model';
-import { ExtensionPoint } from '@backstage/backend-plugin-api';
+import { CompoundEntityRef, Entity } from '@backstage/catalog-model';
 import { JsonValue } from '@backstage/types';
-import { LocationSpec as LocationSpec_2 } from '@backstage/plugin-catalog-common';
-import { ServiceRef } from '@backstage/backend-plugin-api';
-
-/* Excluded from this release type: CatalogProcessingExtensionPoint */
+import { LocationSpec as LocationSpec$1 } from '@backstage/plugin-catalog-common';
 
-/* Excluded from this release type: catalogProcessingExtensionPoint */
+/**
+ * Holds the entity location information.
+ *
+ * @remarks
+ *
+ *  `presence` flag: when using repo importer plugin, location is being created before the component yaml file is merged to the main branch.
+ *  This flag is then set to indicate that the file can be not present.
+ *  default value: 'required'.
+ *
+ * @public
+ * @deprecated use the same type from `@backstage/plugin-catalog-common` instead
+ */
+declare type LocationSpec = LocationSpec$1;
+/**
+ * Holds the relation data for entities.
+ *
+ * @public
+ */
+declare type EntityRelationSpec = {
+    /**
+     * The source entity of this relation.
+     */
+    source: CompoundEntityRef;
+    /**
+     * The type of the relation.
+     */
+    type: string;
+    /**
+     * The target entity of this relation.
+     */
+    target: CompoundEntityRef;
+};
 
 /**
  * @public
  */
-export declare type CatalogProcessor = {
+declare type CatalogProcessor = {
     /**
      * A unique identifier for the Catalog Processor.
      */
@@ -37,7 +55,7 @@ export declare type CatalogProcessor = {
      * @param cache - A cache for storing values local to this processor and the current entity.
      * @returns True if handled by this processor, false otherwise
      */
-    readLocation?(location: LocationSpec_2, optional: boolean, emit: CatalogProcessorEmit, parser: CatalogProcessorParser, cache: CatalogProcessorCache): Promise<boolean>;
+    readLocation?(location: LocationSpec$1, optional: boolean, emit: CatalogProcessorEmit, parser: CatalogProcessorParser, cache: CatalogProcessorCache): Promise<boolean>;
     /**
      * Pre-processes an emitted entity, after it has been emitted but before it
      * has been validated.
@@ -55,7 +73,7 @@ export declare type CatalogProcessor = {
      * @param cache - A cache for storing values local to this processor and the current entity.
      * @returns The same entity or a modified version of it
      */
-    preProcessEntity?(entity: Entity, location: LocationSpec_2, emit: CatalogProcessorEmit, originLocation: LocationSpec_2, cache: CatalogProcessorCache): Promise<Entity>;
+    preProcessEntity?(entity: Entity, location: LocationSpec$1, emit: CatalogProcessorEmit, originLocation: LocationSpec$1, cache: CatalogProcessorCache): Promise<Entity>;
     /**
      * Validates the entity as a known entity kind, after it has been pre-
      * processed and has passed through basic overall validation.
@@ -77,9 +95,18 @@ export declare type CatalogProcessor = {
      * @param cache - A cache for storing values local to this processor and the current entity.
      * @returns The same entity or a modified version of it
      */
-    postProcessEntity?(entity: Entity, location: LocationSpec_2, emit: CatalogProcessorEmit, cache: CatalogProcessorCache): Promise<Entity>;
+    postProcessEntity?(entity: Entity, location: LocationSpec$1, emit: CatalogProcessorEmit, cache: CatalogProcessorCache): Promise<Entity>;
 };
-
+/**
+ * A parser, that is able to take the raw catalog descriptor data and turn it
+ * into the actual result pieces. The default implementation performs a YAML
+ * document parsing.
+ * @public
+ */
+declare type CatalogProcessorParser = (options: {
+    data: Buffer;
+    location: LocationSpec$1;
+}) => AsyncIterable<CatalogProcessorResult>;
 /**
  * A cache for storing data during processing.
  *
@@ -96,7 +123,7 @@ export declare type CatalogProcessor = {
  *
  * @public
  */
-export declare interface CatalogProcessorCache {
+interface CatalogProcessorCache {
     /**
      * Retrieve a value from the cache.
      */
@@ -106,102 +133,61 @@ export declare interface CatalogProcessorCache {
      */
     set<ItemType extends JsonValue>(key: string, value: ItemType): Promise<void>;
 }
-
 /** @public */
-export declare type CatalogProcessorEmit = (generated: CatalogProcessorResult) => void;
-
+declare type CatalogProcessorEmit = (generated: CatalogProcessorResult) => void;
 /** @public */
-export declare type CatalogProcessorEntityResult = {
+declare type CatalogProcessorLocationResult = {
+    type: 'location';
+    location: LocationSpec$1;
+};
+/** @public */
+declare type CatalogProcessorEntityResult = {
     type: 'entity';
     entity: Entity;
-    location: LocationSpec_2;
+    location: LocationSpec$1;
 };
-
 /** @public */
-export declare type CatalogProcessorErrorResult = {
-    type: 'error';
-    error: Error;
-    location: LocationSpec_2;
+declare type CatalogProcessorRelationResult = {
+    type: 'relation';
+    relation: EntityRelationSpec;
 };
-
 /** @public */
-export declare type CatalogProcessorLocationResult = {
-    type: 'location';
-    location: LocationSpec_2;
+declare type CatalogProcessorErrorResult = {
+    type: 'error';
+    error: Error;
+    location: LocationSpec$1;
 };
-
-/**
- * A parser, that is able to take the raw catalog descriptor data and turn it
- * into the actual result pieces. The default implementation performs a YAML
- * document parsing.
- * @public
- */
-export declare type CatalogProcessorParser = (options: {
-    data: Buffer;
-    location: LocationSpec_2;
-}) => AsyncIterable<CatalogProcessorResult>;
-
 /** @public */
-export declare type CatalogProcessorRefreshKeysResult = {
+declare type CatalogProcessorRefreshKeysResult = {
     type: 'refresh';
     key: string;
 };
-
 /** @public */
-export declare type CatalogProcessorRelationResult = {
-    type: 'relation';
-    relation: EntityRelationSpec;
-};
-
-/** @public */
-export declare type CatalogProcessorResult = CatalogProcessorLocationResult | CatalogProcessorEntityResult | CatalogProcessorRelationResult | CatalogProcessorErrorResult | CatalogProcessorRefreshKeysResult;
-
-/* Excluded from this release type: catalogServiceRef */
-
-/**
- * Entities that are not yet processed.
- * @public
- */
-export declare type DeferredEntity = {
-    entity: Entity;
-    locationKey?: string;
-};
+declare type CatalogProcessorResult = CatalogProcessorLocationResult | CatalogProcessorEntityResult | CatalogProcessorRelationResult | CatalogProcessorErrorResult | CatalogProcessorRefreshKeysResult;
 
 /**
- * An entity provider is able to provide entities to the catalog.
- * See https://backstage.io/docs/features/software-catalog/life-of-an-entity for more details.
+ * Factory functions for the standard processing result types.
  *
  * @public
  */
-export declare interface EntityProvider {
-    /**
-     * The name of the provider, which must be unique for all providers that are
-     * active in a catalog, and stable over time since emitted entities are
-     * related to the provider by this name.
-     */
-    getProviderName(): string;
-    /**
-     * Called upon initialization by the catalog engine.
-     */
-    connect(connection: EntityProviderConnection): Promise<void>;
-}
+declare const processingResult: Readonly<{
+    readonly notFoundError: (atLocation: LocationSpec$1, message: string) => CatalogProcessorResult;
+    readonly inputError: (atLocation: LocationSpec$1, message: string) => CatalogProcessorResult;
+    readonly generalError: (atLocation: LocationSpec$1, message: string) => CatalogProcessorResult;
+    readonly location: (newLocation: LocationSpec$1) => CatalogProcessorResult;
+    readonly entity: (atLocation: LocationSpec$1, newEntity: Entity) => CatalogProcessorResult;
+    readonly relation: (spec: EntityRelationSpec) => CatalogProcessorResult;
+    readonly refresh: (key: string) => CatalogProcessorResult;
+}>;
 
 /**
- * The connection between the catalog and the entity provider.
- * Entity providers use this connection to add and remove entities from the catalog.
- *
+ * Entities that are not yet processed.
  * @public
  */
-export declare interface EntityProviderConnection {
-    /**
-     * Applies either a full or a delta update to the catalog engine.
-     */
-    applyMutation(mutation: EntityProviderMutation): Promise<void>;
-    /**
-     * Schedules a refresh on all of the entities that have a matching refresh key associated with the provided keys.
-     */
-    refresh(options: EntityProviderRefreshOptions): Promise<void>;
-}
+declare type DeferredEntity = {
+    entity: Entity;
+    locationKey?: string;
+};
 
 /**
  * A 'full' mutation replaces all existing entities created by this entity provider with new ones.
@@ -210,7 +196,7 @@ export declare interface EntityProviderConnection {
  *
  * @public
  */
-export declare type EntityProviderMutation = {
+declare type EntityProviderMutation = {
     type: 'full';
     entities: DeferredEntity[];
 } | {
@@ -221,63 +207,47 @@ export declare type EntityProviderMutation = {
         locationKey?: string;
     })[];
 };
-
 /**
  * The options given to an entity refresh operation.
  *
  * @public
  */
-export declare type EntityProviderRefreshOptions = {
+declare type EntityProviderRefreshOptions = {
     keys: string[];
 };
-
 /**
- * Holds the relation data for entities.
+ * The connection between the catalog and the entity provider.
+ * Entity providers use this connection to add and remove entities from the catalog.
  *
  * @public
  */
-export declare type EntityRelationSpec = {
-    /**
-     * The source entity of this relation.
-     */
-    source: CompoundEntityRef;
+interface EntityProviderConnection {
     /**
-     * The type of the relation.
+     * Applies either a full or a delta update to the catalog engine.
      */
-    type: string;
+    applyMutation(mutation: EntityProviderMutation): Promise<void>;
     /**
-     * The target entity of this relation.
+     * Schedules a refresh on all of the entities that have a matching refresh key associated with the provided keys.
      */
-    target: CompoundEntityRef;
-};
-
-/**
- * Holds the entity location information.
- *
- * @remarks
- *
- *  `presence` flag: when using repo importer plugin, location is being created before the component yaml file is merged to the main branch.
- *  This flag is then set to indicate that the file can be not present.
- *  default value: 'required'.
- *
- * @public
- * @deprecated use the same type from `@backstage/plugin-catalog-common` instead
- */
-export declare type LocationSpec = LocationSpec_2;
-
+    refresh(options: EntityProviderRefreshOptions): Promise<void>;
+}
 /**
- * Factory functions for the standard processing result types.
+ * An entity provider is able to provide entities to the catalog.
+ * See https://backstage.io/docs/features/software-catalog/life-of-an-entity for more details.
  *
  * @public
  */
-export declare const processingResult: Readonly<{
-    readonly notFoundError: (atLocation: LocationSpec_2, message: string) => CatalogProcessorResult;
-    readonly inputError: (atLocation: LocationSpec_2, message: string) => CatalogProcessorResult;
-    readonly generalError: (atLocation: LocationSpec_2, message: string) => CatalogProcessorResult;
-    readonly location: (newLocation: LocationSpec_2) => CatalogProcessorResult;
-    readonly entity: (atLocation: LocationSpec_2, newEntity: Entity) => CatalogProcessorResult;
-    readonly relation: (spec: EntityRelationSpec) => CatalogProcessorResult;
-    readonly refresh: (key: string) => CatalogProcessorResult;
-}>;
+interface EntityProvider {
+    /**
+     * The name of the provider, which must be unique for all providers that are
+     * active in a catalog, and stable over time since emitted entities are
+     * related to the provider by this name.
+     */
+    getProviderName(): string;
+    /**
+     * Called upon initialization by the catalog engine.
+     */
+    connect(connection: EntityProviderConnection): Promise<void>;
+}
 
-export { }
+export { CatalogProcessor, CatalogProcessorCache, CatalogProcessorEmit, CatalogProcessorEntityResult, CatalogProcessorErrorResult, CatalogProcessorLocationResult, CatalogProcessorParser, CatalogProcessorRefreshKeysResult, CatalogProcessorRelationResult, CatalogProcessorResult, DeferredEntity, EntityProvider, EntityProviderConnection, EntityProviderMutation, EntityProviderRefreshOptions, EntityRelationSpec, LocationSpec, processingResult };

package/package.json

@@ -1,22 +1,32 @@
 {
   "name": "@backstage/plugin-catalog-node",
   "description": "The plugin-catalog-node module for @backstage/plugin-catalog-backend",
-  "version": "1.3.3",
-  "main": "dist/index.cjs.js",
-  "types": "dist/index.d.ts",
+  "version": "1.3.4-next.0",
+  "main": "./dist/index.cjs.js",
+  "types": "./dist/index.d.ts",
   "license": "Apache-2.0",
   "publishConfig": {
-    "access": "public",
-    "main": "dist/index.cjs.js",
-    "types": "dist/index.d.ts",
-    "alphaTypes": "dist/index.alpha.d.ts"
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.cjs.js"
+    },
+    "./alpha": {
+      "require": "./dist/alpha.cjs.js",
+      "types": "./dist/alpha.d.ts",
+      "default": "./dist/alpha.cjs.js"
+    },
+    "./package.json": "./package.json"
   },
   "backstage": {
     "role": "node-library"
   },
   "scripts": {
     "start": "backstage-cli package start",
-    "build": "backstage-cli package build --experimental-type-build",
+    "build": "backstage-cli package build",
     "lint": "backstage-cli package lint",
     "test": "backstage-cli package test",
     "clean": "backstage-cli package clean",
@@ -24,17 +34,17 @@
     "postpack": "backstage-cli package postpack"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "^0.4.0",
-    "@backstage/catalog-client": "^1.3.1",
-    "@backstage/catalog-model": "^1.2.0",
+    "@backstage/backend-plugin-api": "^0.4.1-next.0",
+    "@backstage/catalog-client": "^1.4.0-next.0",
+    "@backstage/catalog-model": "^1.2.1-next.0",
     "@backstage/errors": "^1.1.4",
-    "@backstage/plugin-catalog-common": "^1.0.11",
+    "@backstage/plugin-catalog-common": "^1.0.12-next.0",
     "@backstage/types": "^1.0.2"
   },
   "devDependencies": {
-    "@backstage/backend-common": "^0.18.2",
-    "@backstage/backend-test-utils": "^0.1.34",
-    "@backstage/cli": "^0.22.2"
+    "@backstage/backend-common": "^0.18.3-next.0",
+    "@backstage/backend-test-utils": "^0.1.35-next.0",
+    "@backstage/cli": "^0.22.4-next.0"
   },
   "files": [
     "dist",

package/dist/index.alpha.d.ts

@@ -1,296 +0,0 @@
-/**
- * The catalog-backend-node module for `@backstage/plugin-catalog-backend`.
- *
- * @packageDocumentation
- */
-
-/// <reference types="node" />
-
-import { CatalogApi } from '@backstage/catalog-client';
-import { CompoundEntityRef } from '@backstage/catalog-model';
-import { Entity } from '@backstage/catalog-model';
-import { ExtensionPoint } from '@backstage/backend-plugin-api';
-import { JsonValue } from '@backstage/types';
-import { LocationSpec as LocationSpec_2 } from '@backstage/plugin-catalog-common';
-import { ServiceRef } from '@backstage/backend-plugin-api';
-
-/**
- * @alpha
- */
-export declare interface CatalogProcessingExtensionPoint {
-    addProcessor(...processors: Array<CatalogProcessor | Array<CatalogProcessor>>): void;
-    addEntityProvider(...providers: Array<EntityProvider | Array<EntityProvider>>): void;
-}
-
-/**
- * @alpha
- */
-export declare const catalogProcessingExtensionPoint: ExtensionPoint<CatalogProcessingExtensionPoint>;
-
-/**
- * @public
- */
-export declare type CatalogProcessor = {
-    /**
-     * A unique identifier for the Catalog Processor.
-     */
-    getProcessorName(): string;
-    /**
-     * Reads the contents of a location.
-     *
-     * @param location - The location to read
-     * @param optional - Whether a missing target should trigger an error
-     * @param emit - A sink for items resulting from the read
-     * @param parser - A parser, that is able to take the raw catalog descriptor
-     *               data and turn it into the actual result pieces.
-     * @param cache - A cache for storing values local to this processor and the current entity.
-     * @returns True if handled by this processor, false otherwise
-     */
-    readLocation?(location: LocationSpec_2, optional: boolean, emit: CatalogProcessorEmit, parser: CatalogProcessorParser, cache: CatalogProcessorCache): Promise<boolean>;
-    /**
-     * Pre-processes an emitted entity, after it has been emitted but before it
-     * has been validated.
-     *
-     * This type of processing usually involves enriching the entity with
-     * additional data, and the input entity may actually still be incomplete
-     * when the processor is invoked.
-     *
-     * @param entity - The (possibly partial) entity to process
-     * @param location - The location that the entity came from
-     * @param emit - A sink for auxiliary items resulting from the processing
-     * @param originLocation - The location that the entity originally came from.
-     *   While location resolves to the direct parent location, originLocation
-     *   tells which location was used to start the ingestion loop.
-     * @param cache - A cache for storing values local to this processor and the current entity.
-     * @returns The same entity or a modified version of it
-     */
-    preProcessEntity?(entity: Entity, location: LocationSpec_2, emit: CatalogProcessorEmit, originLocation: LocationSpec_2, cache: CatalogProcessorCache): Promise<Entity>;
-    /**
-     * Validates the entity as a known entity kind, after it has been pre-
-     * processed and has passed through basic overall validation.
-     *
-     * @param entity - The entity to validate
-     * @returns Resolves to true, if the entity was of a kind that was known and
-     *   handled by this processor, and was found to be valid. Resolves to false,
-     *   if the entity was not of a kind that was known by this processor.
-     *   Rejects to an Error describing the problem, if the entity was of a kind
-     *   that was known by this processor and was not valid.
-     */
-    validateEntityKind?(entity: Entity): Promise<boolean>;
-    /**
-     * Post-processes an emitted entity, after it has been validated.
-     *
-     * @param entity - The entity to process
-     * @param location - The location that the entity came from
-     * @param emit - A sink for auxiliary items resulting from the processing
-     * @param cache - A cache for storing values local to this processor and the current entity.
-     * @returns The same entity or a modified version of it
-     */
-    postProcessEntity?(entity: Entity, location: LocationSpec_2, emit: CatalogProcessorEmit, cache: CatalogProcessorCache): Promise<Entity>;
-};
-
-/**
- * A cache for storing data during processing.
- *
- * The values stored in the cache are always local to each processor, meaning
- * no processor can see cache values from other processors.
- *
- * The cache instance provided to the CatalogProcessor is also scoped to the
- * entity being processed, meaning that each processor run can't see cache
- * values from processing runs for other entities.
- *
- * Values that are set during a processing run will only be visible in the directly
- * following run. The cache will be overwritten every run unless no new cache items
- * are written, in which case the existing values remain in the cache.
- *
- * @public
- */
-export declare interface CatalogProcessorCache {
-    /**
-     * Retrieve a value from the cache.
-     */
-    get<ItemType extends JsonValue>(key: string): Promise<ItemType | undefined>;
-    /**
-     * Store a value in the cache.
-     */
-    set<ItemType extends JsonValue>(key: string, value: ItemType): Promise<void>;
-}
-
-/** @public */
-export declare type CatalogProcessorEmit = (generated: CatalogProcessorResult) => void;
-
-/** @public */
-export declare type CatalogProcessorEntityResult = {
-    type: 'entity';
-    entity: Entity;
-    location: LocationSpec_2;
-};
-
-/** @public */
-export declare type CatalogProcessorErrorResult = {
-    type: 'error';
-    error: Error;
-    location: LocationSpec_2;
-};
-
-/** @public */
-export declare type CatalogProcessorLocationResult = {
-    type: 'location';
-    location: LocationSpec_2;
-};
-
-/**
- * A parser, that is able to take the raw catalog descriptor data and turn it
- * into the actual result pieces. The default implementation performs a YAML
- * document parsing.
- * @public
- */
-export declare type CatalogProcessorParser = (options: {
-    data: Buffer;
-    location: LocationSpec_2;
-}) => AsyncIterable<CatalogProcessorResult>;
-
-/** @public */
-export declare type CatalogProcessorRefreshKeysResult = {
-    type: 'refresh';
-    key: string;
-};
-
-/** @public */
-export declare type CatalogProcessorRelationResult = {
-    type: 'relation';
-    relation: EntityRelationSpec;
-};
-
-/** @public */
-export declare type CatalogProcessorResult = CatalogProcessorLocationResult | CatalogProcessorEntityResult | CatalogProcessorRelationResult | CatalogProcessorErrorResult | CatalogProcessorRefreshKeysResult;
-
-/**
- * The catalogService provides the catalog API.
- * @alpha
- */
-export declare const catalogServiceRef: ServiceRef<CatalogApi, "plugin">;
-
-/**
- * Entities that are not yet processed.
- * @public
- */
-export declare type DeferredEntity = {
-    entity: Entity;
-    locationKey?: string;
-};
-
-/**
- * An entity provider is able to provide entities to the catalog.
- * See https://backstage.io/docs/features/software-catalog/life-of-an-entity for more details.
- *
- * @public
- */
-export declare interface EntityProvider {
-    /**
-     * The name of the provider, which must be unique for all providers that are
-     * active in a catalog, and stable over time since emitted entities are
-     * related to the provider by this name.
-     */
-    getProviderName(): string;
-    /**
-     * Called upon initialization by the catalog engine.
-     */
-    connect(connection: EntityProviderConnection): Promise<void>;
-}
-
-/**
- * The connection between the catalog and the entity provider.
- * Entity providers use this connection to add and remove entities from the catalog.
- *
- * @public
- */
-export declare interface EntityProviderConnection {
-    /**
-     * Applies either a full or a delta update to the catalog engine.
-     */
-    applyMutation(mutation: EntityProviderMutation): Promise<void>;
-    /**
-     * Schedules a refresh on all of the entities that have a matching refresh key associated with the provided keys.
-     */
-    refresh(options: EntityProviderRefreshOptions): Promise<void>;
-}
-
-/**
- * A 'full' mutation replaces all existing entities created by this entity provider with new ones.
- * A 'delta' mutation can both add and remove entities provided by this provider. Previously provided
- * entities from a 'full' mutation are not removed.
- *
- * @public
- */
-export declare type EntityProviderMutation = {
-    type: 'full';
-    entities: DeferredEntity[];
-} | {
-    type: 'delta';
-    added: DeferredEntity[];
-    removed: (DeferredEntity | {
-        entityRef: string;
-        locationKey?: string;
-    })[];
-};
-
-/**
- * The options given to an entity refresh operation.
- *
- * @public
- */
-export declare type EntityProviderRefreshOptions = {
-    keys: string[];
-};
-
-/**
- * Holds the relation data for entities.
- *
- * @public
- */
-export declare type EntityRelationSpec = {
-    /**
-     * The source entity of this relation.
-     */
-    source: CompoundEntityRef;
-    /**
-     * The type of the relation.
-     */
-    type: string;
-    /**
-     * The target entity of this relation.
-     */
-    target: CompoundEntityRef;
-};
-
-/**
- * Holds the entity location information.
- *
- * @remarks
- *
- *  `presence` flag: when using repo importer plugin, location is being created before the component yaml file is merged to the main branch.
- *  This flag is then set to indicate that the file can be not present.
- *  default value: 'required'.
- *
- * @public
- * @deprecated use the same type from `@backstage/plugin-catalog-common` instead
- */
-export declare type LocationSpec = LocationSpec_2;
-
-/**
- * Factory functions for the standard processing result types.
- *
- * @public
- */
-export declare const processingResult: Readonly<{
-    readonly notFoundError: (atLocation: LocationSpec_2, message: string) => CatalogProcessorResult;
-    readonly inputError: (atLocation: LocationSpec_2, message: string) => CatalogProcessorResult;
-    readonly generalError: (atLocation: LocationSpec_2, message: string) => CatalogProcessorResult;
-    readonly location: (newLocation: LocationSpec_2) => CatalogProcessorResult;
-    readonly entity: (atLocation: LocationSpec_2, newEntity: Entity) => CatalogProcessorResult;
-    readonly relation: (spec: EntityRelationSpec) => CatalogProcessorResult;
-    readonly refresh: (key: string) => CatalogProcessorResult;
-}>;
-
-export { }

package/dist/index.beta.d.ts

@@ -1,283 +0,0 @@
-/**
- * The catalog-backend-node module for `@backstage/plugin-catalog-backend`.
- *
- * @packageDocumentation
- */
-
-/// <reference types="node" />
-
-import { CatalogApi } from '@backstage/catalog-client';
-import { CompoundEntityRef } from '@backstage/catalog-model';
-import { Entity } from '@backstage/catalog-model';
-import { ExtensionPoint } from '@backstage/backend-plugin-api';
-import { JsonValue } from '@backstage/types';
-import { LocationSpec as LocationSpec_2 } from '@backstage/plugin-catalog-common';
-import { ServiceRef } from '@backstage/backend-plugin-api';
-
-/* Excluded from this release type: CatalogProcessingExtensionPoint */
-
-/* Excluded from this release type: catalogProcessingExtensionPoint */
-
-/**
- * @public
- */
-export declare type CatalogProcessor = {
-    /**
-     * A unique identifier for the Catalog Processor.
-     */
-    getProcessorName(): string;
-    /**
-     * Reads the contents of a location.
-     *
-     * @param location - The location to read
-     * @param optional - Whether a missing target should trigger an error
-     * @param emit - A sink for items resulting from the read
-     * @param parser - A parser, that is able to take the raw catalog descriptor
-     *               data and turn it into the actual result pieces.
-     * @param cache - A cache for storing values local to this processor and the current entity.
-     * @returns True if handled by this processor, false otherwise
-     */
-    readLocation?(location: LocationSpec_2, optional: boolean, emit: CatalogProcessorEmit, parser: CatalogProcessorParser, cache: CatalogProcessorCache): Promise<boolean>;
-    /**
-     * Pre-processes an emitted entity, after it has been emitted but before it
-     * has been validated.
-     *
-     * This type of processing usually involves enriching the entity with
-     * additional data, and the input entity may actually still be incomplete
-     * when the processor is invoked.
-     *
-     * @param entity - The (possibly partial) entity to process
-     * @param location - The location that the entity came from
-     * @param emit - A sink for auxiliary items resulting from the processing
-     * @param originLocation - The location that the entity originally came from.
-     *   While location resolves to the direct parent location, originLocation
-     *   tells which location was used to start the ingestion loop.
-     * @param cache - A cache for storing values local to this processor and the current entity.
-     * @returns The same entity or a modified version of it
-     */
-    preProcessEntity?(entity: Entity, location: LocationSpec_2, emit: CatalogProcessorEmit, originLocation: LocationSpec_2, cache: CatalogProcessorCache): Promise<Entity>;
-    /**
-     * Validates the entity as a known entity kind, after it has been pre-
-     * processed and has passed through basic overall validation.
-     *
-     * @param entity - The entity to validate
-     * @returns Resolves to true, if the entity was of a kind that was known and
-     *   handled by this processor, and was found to be valid. Resolves to false,
-     *   if the entity was not of a kind that was known by this processor.
-     *   Rejects to an Error describing the problem, if the entity was of a kind
-     *   that was known by this processor and was not valid.
-     */
-    validateEntityKind?(entity: Entity): Promise<boolean>;
-    /**
-     * Post-processes an emitted entity, after it has been validated.
-     *
-     * @param entity - The entity to process
-     * @param location - The location that the entity came from
-     * @param emit - A sink for auxiliary items resulting from the processing
-     * @param cache - A cache for storing values local to this processor and the current entity.
-     * @returns The same entity or a modified version of it
-     */
-    postProcessEntity?(entity: Entity, location: LocationSpec_2, emit: CatalogProcessorEmit, cache: CatalogProcessorCache): Promise<Entity>;
-};
-
-/**
- * A cache for storing data during processing.
- *
- * The values stored in the cache are always local to each processor, meaning
- * no processor can see cache values from other processors.
- *
- * The cache instance provided to the CatalogProcessor is also scoped to the
- * entity being processed, meaning that each processor run can't see cache
- * values from processing runs for other entities.
- *
- * Values that are set during a processing run will only be visible in the directly
- * following run. The cache will be overwritten every run unless no new cache items
- * are written, in which case the existing values remain in the cache.
- *
- * @public
- */
-export declare interface CatalogProcessorCache {
-    /**
-     * Retrieve a value from the cache.
-     */
-    get<ItemType extends JsonValue>(key: string): Promise<ItemType | undefined>;
-    /**
-     * Store a value in the cache.
-     */
-    set<ItemType extends JsonValue>(key: string, value: ItemType): Promise<void>;
-}
-
-/** @public */
-export declare type CatalogProcessorEmit = (generated: CatalogProcessorResult) => void;
-
-/** @public */
-export declare type CatalogProcessorEntityResult = {
-    type: 'entity';
-    entity: Entity;
-    location: LocationSpec_2;
-};
-
-/** @public */
-export declare type CatalogProcessorErrorResult = {
-    type: 'error';
-    error: Error;
-    location: LocationSpec_2;
-};
-
-/** @public */
-export declare type CatalogProcessorLocationResult = {
-    type: 'location';
-    location: LocationSpec_2;
-};
-
-/**
- * A parser, that is able to take the raw catalog descriptor data and turn it
- * into the actual result pieces. The default implementation performs a YAML
- * document parsing.
- * @public
- */
-export declare type CatalogProcessorParser = (options: {
-    data: Buffer;
-    location: LocationSpec_2;
-}) => AsyncIterable<CatalogProcessorResult>;
-
-/** @public */
-export declare type CatalogProcessorRefreshKeysResult = {
-    type: 'refresh';
-    key: string;
-};
-
-/** @public */
-export declare type CatalogProcessorRelationResult = {
-    type: 'relation';
-    relation: EntityRelationSpec;
-};
-
-/** @public */
-export declare type CatalogProcessorResult = CatalogProcessorLocationResult | CatalogProcessorEntityResult | CatalogProcessorRelationResult | CatalogProcessorErrorResult | CatalogProcessorRefreshKeysResult;
-
-/* Excluded from this release type: catalogServiceRef */
-
-/**
- * Entities that are not yet processed.
- * @public
- */
-export declare type DeferredEntity = {
-    entity: Entity;
-    locationKey?: string;
-};
-
-/**
- * An entity provider is able to provide entities to the catalog.
- * See https://backstage.io/docs/features/software-catalog/life-of-an-entity for more details.
- *
- * @public
- */
-export declare interface EntityProvider {
-    /**
-     * The name of the provider, which must be unique for all providers that are
-     * active in a catalog, and stable over time since emitted entities are
-     * related to the provider by this name.
-     */
-    getProviderName(): string;
-    /**
-     * Called upon initialization by the catalog engine.
-     */
-    connect(connection: EntityProviderConnection): Promise<void>;
-}
-
-/**
- * The connection between the catalog and the entity provider.
- * Entity providers use this connection to add and remove entities from the catalog.
- *
- * @public
- */
-export declare interface EntityProviderConnection {
-    /**
-     * Applies either a full or a delta update to the catalog engine.
-     */
-    applyMutation(mutation: EntityProviderMutation): Promise<void>;
-    /**
-     * Schedules a refresh on all of the entities that have a matching refresh key associated with the provided keys.
-     */
-    refresh(options: EntityProviderRefreshOptions): Promise<void>;
-}
-
-/**
- * A 'full' mutation replaces all existing entities created by this entity provider with new ones.
- * A 'delta' mutation can both add and remove entities provided by this provider. Previously provided
- * entities from a 'full' mutation are not removed.
- *
- * @public
- */
-export declare type EntityProviderMutation = {
-    type: 'full';
-    entities: DeferredEntity[];
-} | {
-    type: 'delta';
-    added: DeferredEntity[];
-    removed: (DeferredEntity | {
-        entityRef: string;
-        locationKey?: string;
-    })[];
-};
-
-/**
- * The options given to an entity refresh operation.
- *
- * @public
- */
-export declare type EntityProviderRefreshOptions = {
-    keys: string[];
-};
-
-/**
- * Holds the relation data for entities.
- *
- * @public
- */
-export declare type EntityRelationSpec = {
-    /**
-     * The source entity of this relation.
-     */
-    source: CompoundEntityRef;
-    /**
-     * The type of the relation.
-     */
-    type: string;
-    /**
-     * The target entity of this relation.
-     */
-    target: CompoundEntityRef;
-};
-
-/**
- * Holds the entity location information.
- *
- * @remarks
- *
- *  `presence` flag: when using repo importer plugin, location is being created before the component yaml file is merged to the main branch.
- *  This flag is then set to indicate that the file can be not present.
- *  default value: 'required'.
- *
- * @public
- * @deprecated use the same type from `@backstage/plugin-catalog-common` instead
- */
-export declare type LocationSpec = LocationSpec_2;
-
-/**
- * Factory functions for the standard processing result types.
- *
- * @public
- */
-export declare const processingResult: Readonly<{
-    readonly notFoundError: (atLocation: LocationSpec_2, message: string) => CatalogProcessorResult;
-    readonly inputError: (atLocation: LocationSpec_2, message: string) => CatalogProcessorResult;
-    readonly generalError: (atLocation: LocationSpec_2, message: string) => CatalogProcessorResult;
-    readonly location: (newLocation: LocationSpec_2) => CatalogProcessorResult;
-    readonly entity: (atLocation: LocationSpec_2, newEntity: Entity) => CatalogProcessorResult;
-    readonly relation: (spec: EntityRelationSpec) => CatalogProcessorResult;
-    readonly refresh: (key: string) => CatalogProcessorResult;
-}>;
-
-export { }