@backstage/plugin-catalog-node 1.0.2-next.0 → 1.1.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @backstage/plugin-catalog-node
 
+## 1.1.0-next.2
+
+### Minor Changes
+
+- 9743bc788c: Added refresh function to the `EntityProviderConnection` to be able to schedule refreshes from entity providers.
+
+### Patch Changes
+
+- 409ed984e8: Updated usage of experimental backend service APIs.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.1.2-next.2
+  - @backstage/catalog-client@1.1.0-next.2
+  - @backstage/catalog-model@1.1.1-next.0
+  - @backstage/errors@1.1.1-next.0
+
+## 1.0.2-next.1
+
+### Patch Changes
+
+- 7d7d947352: Adds experimental `catalogServiceRef` for obtaining a `CatalogClient` in the new backend system.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.1.2-next.1
+  - @backstage/catalog-client@1.0.5-next.1
+
 ## 1.0.2-next.0
 
 ### Patch Changes

package/alpha/package.json

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

package/dist/index.alpha.d.ts

@@ -6,10 +6,12 @@
 
 /// <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 { ServiceRef } from '@backstage/backend-plugin-api';
 
 /**
  * @alpha
@@ -162,6 +164,12 @@ export declare type CatalogProcessorRelationResult = {
 /** @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
@@ -193,6 +201,10 @@ export declare interface EntityProviderConnection {
      * Applies either a full or 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.
+     */
+    refresh(options: EntityProviderRefreshOptions): Promise<void>;
 }
 
 /**
@@ -210,6 +222,13 @@ export declare type EntityProviderMutation = {
     removed: DeferredEntity[];
 };
 
+/**
+ * @public
+ */
+export declare type EntityProviderRefreshOptions = {
+    keys: string[];
+};
+
 /**
  * Holds the relation data for entities.
  *

package/dist/index.beta.d.ts

@@ -6,10 +6,12 @@
 
 /// <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 { ServiceRef } from '@backstage/backend-plugin-api';
 
 /* Excluded from this release type: CatalogProcessingExtensionPoint */
 
@@ -153,6 +155,8 @@ export declare type CatalogProcessorRelationResult = {
 /** @public */
 export declare type CatalogProcessorResult = CatalogProcessorLocationResult | CatalogProcessorEntityResult | CatalogProcessorRelationResult | CatalogProcessorErrorResult | CatalogProcessorRefreshKeysResult;
 
+/* Excluded from this release type: catalogServiceRef */
+
 /**
  * Entities that are not yet processed.
  * @public
@@ -184,6 +188,10 @@ export declare interface EntityProviderConnection {
      * Applies either a full or 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.
+     */
+    refresh(options: EntityProviderRefreshOptions): Promise<void>;
 }
 
 /**
@@ -201,6 +209,13 @@ export declare type EntityProviderMutation = {
     removed: DeferredEntity[];
 };
 
+/**
+ * @public
+ */
+export declare type EntityProviderRefreshOptions = {
+    keys: string[];
+};
+
 /**
  * Holds the relation data for entities.
  *

package/dist/index.cjs.js

@@ -3,12 +3,28 @@
 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.discoveryServiceRef
+    },
+    async factory() {
+      return async ({ discoveryApi }) => {
+        return new catalogClient.CatalogClient({ discoveryApi });
+      };
+    }
+  })
+});
+
 const processingResult = Object.freeze({
   notFoundError(atLocation, message) {
     return {
@@ -42,5 +58,6 @@ 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/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 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, LocationSpec } from './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","NotFoundError","InputError"],"mappings":";;;;;;;AACY,MAAC,+BAA+B,GAAGA,qCAAoB,CAAC;AACpE,EAAE,EAAE,EAAE,oBAAoB;AAC1B,CAAC;;ACFW,MAAC,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC;AAC9C,EAAE,aAAa,CAAC,UAAU,EAAE,OAAO,EAAE;AACrC,IAAI,OAAO;AACX,MAAM,IAAI,EAAE,OAAO;AACnB,MAAM,QAAQ,EAAE,UAAU;AAC1B,MAAM,KAAK,EAAE,IAAIC,oBAAa,CAAC,OAAO,CAAC;AACvC,KAAK,CAAC;AACN,GAAG;AACH,EAAE,UAAU,CAAC,UAAU,EAAE,OAAO,EAAE;AAClC,IAAI,OAAO;AACX,MAAM,IAAI,EAAE,OAAO;AACnB,MAAM,QAAQ,EAAE,UAAU;AAC1B,MAAM,KAAK,EAAE,IAAIC,iBAAU,CAAC,OAAO,CAAC;AACpC,KAAK,CAAC;AACN,GAAG;AACH,EAAE,YAAY,CAAC,UAAU,EAAE,OAAO,EAAE;AACpC,IAAI,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;AAC9E,GAAG;AACH,EAAE,QAAQ,CAAC,WAAW,EAAE;AACxB,IAAI,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AACvD,GAAG;AACH,EAAE,MAAM,CAAC,UAAU,EAAE,SAAS,EAAE;AAChC,IAAI,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AACvE,GAAG;AACH,EAAE,QAAQ,CAAC,IAAI,EAAE;AACjB,IAAI,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;AAChD,GAAG;AACH,EAAE,OAAO,CAAC,GAAG,EAAE;AACf,IAAI,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC;AACpC,GAAG;AACH,CAAC;;;;;"}
+{"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, LocationSpec } from './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;;ACfY,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

@@ -6,10 +6,12 @@
 
 /// <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 { ServiceRef } from '@backstage/backend-plugin-api';
 
 /* Excluded from this release type: CatalogProcessingExtensionPoint */
 
@@ -153,6 +155,8 @@ export declare type CatalogProcessorRelationResult = {
 /** @public */
 export declare type CatalogProcessorResult = CatalogProcessorLocationResult | CatalogProcessorEntityResult | CatalogProcessorRelationResult | CatalogProcessorErrorResult | CatalogProcessorRefreshKeysResult;
 
+/* Excluded from this release type: catalogServiceRef */
+
 /**
  * Entities that are not yet processed.
  * @public
@@ -184,6 +188,10 @@ export declare interface EntityProviderConnection {
      * Applies either a full or 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.
+     */
+    refresh(options: EntityProviderRefreshOptions): Promise<void>;
 }
 
 /**
@@ -201,6 +209,13 @@ export declare type EntityProviderMutation = {
     removed: DeferredEntity[];
 };
 
+/**
+ * @public
+ */
+export declare type EntityProviderRefreshOptions = {
+    keys: string[];
+};
+
 /**
  * Holds the relation data for entities.
  *

package/package.json

@@ -1,11 +1,10 @@
 {
   "name": "@backstage/plugin-catalog-node",
   "description": "The plugin-catalog-node module for @backstage/plugin-catalog-backend",
-  "version": "1.0.2-next.0",
+  "version": "1.1.0-next.2",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
-  "private": false,
   "publishConfig": {
     "access": "public",
     "main": "dist/index.cjs.js",
@@ -25,18 +24,20 @@
     "postpack": "backstage-cli package postpack"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "^0.1.2-next.0",
-    "@backstage/catalog-model": "^1.1.0",
-    "@backstage/errors": "1.1.0",
+    "@backstage/backend-plugin-api": "^0.1.2-next.2",
+    "@backstage/catalog-client": "^1.1.0-next.2",
+    "@backstage/catalog-model": "^1.1.1-next.0",
+    "@backstage/errors": "1.1.1-next.0",
     "@backstage/types": "^1.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-common": "^0.15.1-next.0",
-    "@backstage/cli": "^0.18.2-next.0"
+    "@backstage/backend-common": "^0.15.1-next.3",
+    "@backstage/backend-test-utils": "^0.1.28-next.3",
+    "@backstage/cli": "^0.19.0-next.3"
   },
   "files": [
     "dist",
     "alpha"
   ],
-  "gitHead": "c6c0b1978a7ab4d29d813996c56beb7e6b48a268"
+  "gitHead": "2f458448f850dc68a711e2f31d14a91f96cf175d"
 }