npm - @backstage/plugin-catalog-node - Versions diffs - 1.2.2-next.0 → 1.3.0-next.2 - Mend

@backstage/plugin-catalog-node 1.2.2-next.0 → 1.3.0-next.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,34 @@
 # @backstage/plugin-catalog-node
+## 1.3.0-next.2
+### Minor Changes
+- eacc8e2b55: Make it possible for entity providers to supply only entity refs, instead of full entities, in `delta` mutation deletions.
+### Patch Changes
+- 884d749b14: Refactored to use `coreServices` from `@backstage/backend-plugin-api`.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.2.0-next.2
+  - @backstage/catalog-client@1.2.0-next.1
+  - @backstage/catalog-model@1.1.4-next.1
+  - @backstage/errors@1.1.4-next.1
+  - @backstage/types@1.0.2-next.1
+  - @backstage/plugin-catalog-common@1.0.9-next.2
+## 1.2.2-next.1
+### Patch Changes
+- Updated dependencies
+  - @backstage/types@1.0.2-next.1
+  - @backstage/backend-plugin-api@0.1.5-next.1
+  - @backstage/catalog-client@1.2.0-next.1
+  - @backstage/catalog-model@1.1.4-next.1
+  - @backstage/errors@1.1.4-next.1
+  - @backstage/plugin-catalog-common@1.0.9-next.1
 ## 1.2.2-next.0
 ### Patch Changes

package/alpha/package.json CHANGED Viewed

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

package/dist/index.alpha.d.ts CHANGED Viewed

@@ -181,38 +181,47 @@ export declare type DeferredEntity = {
 };
 /**
- * An EntityProvider is able to provide entities to the catalog.
+ * 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 {
-    /** Unique provider name used internally for caching. */
+    /**
+     * 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;
-    /** Connect is called upon initialization by the catalog engine. */
+    /**
+     * Called upon initialization by the catalog engine.
+     */
     connect(connection: EntityProviderConnection): Promise<void>;
 }
 /**
- * The EntityProviderConnection is the connection between the catalog and the entity provider.
- * The EntityProvider use this connection to add and remove entities from the catalog.
+ * 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 delta update to the catalog engine.
+     * 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 has a matching refresh key associated with the provided keys.
+     * Schedules a refresh on all of the entities that have a matching refresh key associated with the provided keys.
      */
     refresh(options: EntityProviderRefreshOptions): Promise<void>;
 }
 /**
- * @public
  * 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';
@@ -220,10 +229,15 @@ export declare type EntityProviderMutation = {
 } | {
     type: 'delta';
     added: DeferredEntity[];
-    removed: DeferredEntity[];
+    removed: (DeferredEntity | {
+        entityRef: string;
+        locationKey?: string;
+    })[];
 };
 /**
+ * The options given to an entity refresh operation.
+ *
  * @public
  */
 export declare type EntityProviderRefreshOptions = {

package/dist/index.beta.d.ts CHANGED Viewed

@@ -168,38 +168,47 @@ export declare type DeferredEntity = {
 };
 /**
- * An EntityProvider is able to provide entities to the catalog.
+ * 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 {
-    /** Unique provider name used internally for caching. */
+    /**
+     * 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;
-    /** Connect is called upon initialization by the catalog engine. */
+    /**
+     * Called upon initialization by the catalog engine.
+     */
     connect(connection: EntityProviderConnection): Promise<void>;
 }
 /**
- * The EntityProviderConnection is the connection between the catalog and the entity provider.
- * The EntityProvider use this connection to add and remove entities from the catalog.
+ * 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 delta update to the catalog engine.
+     * 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 has a matching refresh key associated with the provided keys.
+     * Schedules a refresh on all of the entities that have a matching refresh key associated with the provided keys.
      */
     refresh(options: EntityProviderRefreshOptions): Promise<void>;
 }
 /**
- * @public
  * 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';
@@ -207,10 +216,15 @@ export declare type EntityProviderMutation = {
 } | {
     type: 'delta';
     added: DeferredEntity[];
-    removed: DeferredEntity[];
+    removed: (DeferredEntity | {
+        entityRef: string;
+        locationKey?: string;
+    })[];
 };
 /**
+ * The options given to an entity refresh operation.
+ *
  * @public
  */
 export declare type EntityProviderRefreshOptions = {

package/dist/index.cjs.js CHANGED Viewed

@@ -15,7 +15,7 @@ const catalogServiceRef = backendPluginApi.createServiceRef({
   defaultFactory: async (service) => backendPluginApi.createServiceFactory({
     service,
     deps: {
-      discoveryApi: backendPluginApi.discoveryServiceRef
+      discoveryApi: backendPluginApi.coreServices.discovery
     },
     async factory() {
       return async ({ discoveryApi }) => {

package/dist/index.cjs.js.map CHANGED Viewed

	@@ -1 +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 ~~discoveryServiceRef~~,\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: ~~discoveryServiceRef~~,\n },\n async factory() {\n return async ({ discoveryApi }) => {\n return new CatalogClient({ discoveryApi });\n };\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","~~discoveryServiceRef~~","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,~~YAAc~~,~~EAAAC~~,~~oCAAA~~;AAAA,~~KAChB~~;AAAA,IACA,MAAM,OAAU,GAAA;AACd,MAAO,OAAA,OAAO,EAAE,YAAA,EAAmB,KAAA;AACjC,QAAA,OAAO,IAAIC,2BAAA,CAAc,EAAE,YAAA,EAAc,CAAA,CAAA;AAAA,OAC3C,CAAA;AAAA,KACF;AAAA,GACD,CAAA;AACL,CAAC;;ACdY,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;;;;;;"}
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() {\n return async ({ discoveryApi }) => {\n return new CatalogClient({ discoveryApi });\n };\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,OAAU,GAAA;AACd,MAAO,OAAA,OAAO,EAAE,YAAA,EAAmB,KAAA;AACjC,QAAA,OAAO,IAAIC,2BAAA,CAAc,EAAE,YAAA,EAAc,CAAA,CAAA;AAAA,OAC3C,CAAA;AAAA,KACF;AAAA,GACD,CAAA;AACL,CAAC;;ACdY,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;;;;;;"}

package/dist/index.d.ts CHANGED Viewed

@@ -168,38 +168,47 @@ export declare type DeferredEntity = {
 };
 /**
- * An EntityProvider is able to provide entities to the catalog.
+ * 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 {
-    /** Unique provider name used internally for caching. */
+    /**
+     * 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;
-    /** Connect is called upon initialization by the catalog engine. */
+    /**
+     * Called upon initialization by the catalog engine.
+     */
     connect(connection: EntityProviderConnection): Promise<void>;
 }
 /**
- * The EntityProviderConnection is the connection between the catalog and the entity provider.
- * The EntityProvider use this connection to add and remove entities from the catalog.
+ * 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 delta update to the catalog engine.
+     * 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 has a matching refresh key associated with the provided keys.
+     * Schedules a refresh on all of the entities that have a matching refresh key associated with the provided keys.
      */
     refresh(options: EntityProviderRefreshOptions): Promise<void>;
 }
 /**
- * @public
  * 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';
@@ -207,10 +216,15 @@ export declare type EntityProviderMutation = {
 } | {
     type: 'delta';
     added: DeferredEntity[];
-    removed: DeferredEntity[];
+    removed: (DeferredEntity | {
+        entityRef: string;
+        locationKey?: string;
+    })[];
 };
 /**
+ * The options given to an entity refresh operation.
+ *
  * @public
  */
 export declare type EntityProviderRefreshOptions = {

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-catalog-node",
   "description": "The plugin-catalog-node module for @backstage/plugin-catalog-backend",
-  "version": "1.2.2-next.0",
+  "version": "1.3.0-next.2",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -24,17 +24,17 @@
     "postpack": "backstage-cli package postpack"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "^0.1.5-next.0",
-    "@backstage/catalog-client": "^1.2.0-next.0",
-    "@backstage/catalog-model": "^1.1.4-next.0",
-    "@backstage/errors": "^1.1.4-next.0",
-    "@backstage/plugin-catalog-common": "^1.0.9-next.0",
-    "@backstage/types": "^1.0.2-next.0"
+    "@backstage/backend-plugin-api": "^0.2.0-next.2",
+    "@backstage/catalog-client": "^1.2.0-next.1",
+    "@backstage/catalog-model": "^1.1.4-next.1",
+    "@backstage/errors": "^1.1.4-next.1",
+    "@backstage/plugin-catalog-common": "^1.0.9-next.2",
+    "@backstage/types": "^1.0.2-next.1"
   },
   "devDependencies": {
-    "@backstage/backend-common": "^0.16.1-next.0",
-    "@backstage/backend-test-utils": "^0.1.31-next.0",
-    "@backstage/cli": "^0.21.2-next.0"
+    "@backstage/backend-common": "^0.17.0-next.2",
+    "@backstage/backend-test-utils": "^0.1.31-next.2",
+    "@backstage/cli": "^0.21.2-next.2"
   },
   "files": [
     "dist",