@backstage/plugin-catalog-node 1.12.7-next.2 → 1.13.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @backstage/plugin-catalog-node
 
+## 1.13.0
+
+### Minor Changes
+
+- bd35cdb: The `analyze-location` endpoint is now protected by the `catalog.location.analyze` permission.
+  The `validate-entity` endpoint is now protected by the `catalog.entity.validate` permission.
+- 29e57c7: Add catalog service mocks under the `/testUtils` subpath export.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.0.0
+  - @backstage/catalog-model@1.7.0
+  - @backstage/catalog-client@1.7.0
+  - @backstage/plugin-permission-node@0.8.3
+  - @backstage/plugin-catalog-common@1.1.0
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+  - @backstage/plugin-permission-common@0.8.1
+
 ## 1.12.7-next.2
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-node__alpha",
-  "version": "1.12.7-next.2",
+  "version": "1.13.0",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/index.d.ts

@@ -2,6 +2,7 @@
 import { CompoundEntityRef, Entity, LocationEntityV1alpha1 } from '@backstage/catalog-model';
 import { JsonValue } from '@backstage/types';
 import { LocationSpec as LocationSpec$1, AnalyzeLocationRequest, AnalyzeLocationResponse, AnalyzeLocationExistingEntity } from '@backstage/plugin-catalog-common';
+import { BackstageCredentials } from '@backstage/backend-plugin-api';
 
 /**
  * Holds the entity location information.
@@ -270,7 +271,7 @@ type LocationAnalyzer = {
      *
      * @param location - Git repository to analyze and generate config for.
      */
-    analyzeLocation(location: AnalyzeLocationRequest): Promise<AnalyzeLocationResponse>;
+    analyzeLocation(location: AnalyzeLocationRequest, credentials: BackstageCredentials): Promise<AnalyzeLocationResponse>;
 };
 /** @public */
 type AnalyzeOptions = {

package/dist/testUtils.cjs.js

@@ -0,0 +1,56 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var testUtils = require('@backstage/catalog-client/testUtils');
+var alpha = require('@backstage/plugin-catalog-node/alpha');
+
+function simpleMock(ref, mockFactory) {
+  return (partialImpl) => {
+    const mock = mockFactory();
+    if (partialImpl) {
+      for (const [key, impl] of Object.entries(partialImpl)) {
+        if (typeof impl === "function") {
+          mock[key].mockImplementation(impl);
+        } else {
+          mock[key] = impl;
+        }
+      }
+    }
+    return Object.assign(mock, {
+      factory: backendPluginApi.createServiceFactory({
+        service: ref,
+        deps: {},
+        factory: () => mock
+      })
+    });
+  };
+}
+function catalogServiceMock(options) {
+  return new testUtils.InMemoryCatalogClient(options);
+}
+((catalogServiceMock2) => {
+  catalogServiceMock2.factory = (options) => backendPluginApi.createServiceFactory({
+    service: alpha.catalogServiceRef,
+    deps: {},
+    factory: () => new testUtils.InMemoryCatalogClient(options)
+  });
+  catalogServiceMock2.mock = simpleMock(alpha.catalogServiceRef, () => ({
+    getEntities: jest.fn(),
+    getEntitiesByRefs: jest.fn(),
+    queryEntities: jest.fn(),
+    getEntityAncestors: jest.fn(),
+    getEntityByRef: jest.fn(),
+    removeEntityByUid: jest.fn(),
+    refreshEntity: jest.fn(),
+    getEntityFacets: jest.fn(),
+    getLocationById: jest.fn(),
+    getLocationByRef: jest.fn(),
+    addLocation: jest.fn(),
+    removeLocationById: jest.fn(),
+    getLocationByEntity: jest.fn(),
+    validateEntity: jest.fn()
+  }));
+})(catalogServiceMock || (catalogServiceMock = {}));
+
+exports.catalogServiceMock = catalogServiceMock;
+//# sourceMappingURL=testUtils.cjs.js.map

package/dist/testUtils.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testUtils.cjs.js","sources":["../src/testUtils/catalogServiceMock.ts"],"sourcesContent":["/*\n * Copyright 2024 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  ServiceRef,\n  createServiceFactory,\n} from '@backstage/backend-plugin-api';\nimport { InMemoryCatalogClient } from '@backstage/catalog-client/testUtils';\nimport { Entity } from '@backstage/catalog-model';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';\n// eslint-disable-next-line @backstage/no-undeclared-imports\nimport { ServiceMock } from '@backstage/backend-test-utils';\nimport { CatalogApi } from '@backstage/catalog-client';\n\n/** @internal */\nfunction simpleMock<TService>(\n  ref: ServiceRef<TService, any>,\n  mockFactory: () => jest.Mocked<TService>,\n): (partialImpl?: Partial<TService>) => ServiceMock<TService> {\n  return partialImpl => {\n    const mock = mockFactory();\n    if (partialImpl) {\n      for (const [key, impl] of Object.entries(partialImpl)) {\n        if (typeof impl === 'function') {\n          (mock as any)[key].mockImplementation(impl);\n        } else {\n          (mock as any)[key] = impl;\n        }\n      }\n    }\n    return Object.assign(mock, {\n      factory: createServiceFactory({\n        service: ref,\n        deps: {},\n        factory: () => mock,\n      }),\n    }) as ServiceMock<TService>;\n  };\n}\n\n/**\n * Creates a fake catalog client that handles entities in memory storage. Note\n * that this client may be severely limited in functionality, and advanced\n * functions may not be available at all.\n *\n * @public\n */\nexport function catalogServiceMock(options?: {\n  entities?: Entity[];\n}): CatalogApi {\n  return new InMemoryCatalogClient(options);\n}\n\n/**\n * A collection of mock functionality for the catalog service.\n *\n * @public\n */\nexport namespace catalogServiceMock {\n  /**\n   * Creates a fake catalog client that handles entities in memory storage. Note\n   * that this client may be severely limited in functionality, and advanced\n   * functions may not be available at all.\n   */\n  export const factory = (options?: { entities?: Entity[] }) =>\n    createServiceFactory({\n      service: catalogServiceRef,\n      deps: {},\n      factory: () => new InMemoryCatalogClient(options),\n    });\n  /**\n   * Creates a catalog client whose methods are mock functions, possibly with\n   * some of them overloaded by the caller.\n   */\n  export const mock = simpleMock(catalogServiceRef, () => ({\n    getEntities: jest.fn(),\n    getEntitiesByRefs: jest.fn(),\n    queryEntities: jest.fn(),\n    getEntityAncestors: jest.fn(),\n    getEntityByRef: jest.fn(),\n    removeEntityByUid: jest.fn(),\n    refreshEntity: jest.fn(),\n    getEntityFacets: jest.fn(),\n    getLocationById: jest.fn(),\n    getLocationByRef: jest.fn(),\n    addLocation: jest.fn(),\n    removeLocationById: jest.fn(),\n    getLocationByEntity: jest.fn(),\n    validateEntity: jest.fn(),\n  }));\n}\n"],"names":["createServiceFactory","InMemoryCatalogClient","catalogServiceMock","catalogServiceRef"],"mappings":";;;;;;AA4BA,SAAS,UAAA,CACP,KACA,WAC4D,EAAA;AAC5D,EAAA,OAAO,CAAe,WAAA,KAAA;AACpB,IAAA,MAAM,OAAO,WAAY,EAAA,CAAA;AACzB,IAAA,IAAI,WAAa,EAAA;AACf,MAAA,KAAA,MAAW,CAAC,GAAK,EAAA,IAAI,KAAK,MAAO,CAAA,OAAA,CAAQ,WAAW,CAAG,EAAA;AACrD,QAAI,IAAA,OAAO,SAAS,UAAY,EAAA;AAC9B,UAAC,IAAa,CAAA,GAAG,CAAE,CAAA,kBAAA,CAAmB,IAAI,CAAA,CAAA;AAAA,SACrC,MAAA;AACL,UAAC,IAAA,CAAa,GAAG,CAAI,GAAA,IAAA,CAAA;AAAA,SACvB;AAAA,OACF;AAAA,KACF;AACA,IAAO,OAAA,MAAA,CAAO,OAAO,IAAM,EAAA;AAAA,MACzB,SAASA,qCAAqB,CAAA;AAAA,QAC5B,OAAS,EAAA,GAAA;AAAA,QACT,MAAM,EAAC;AAAA,QACP,SAAS,MAAM,IAAA;AAAA,OAChB,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH,CAAA;AACF,CAAA;AASO,SAAS,mBAAmB,OAEpB,EAAA;AACb,EAAO,OAAA,IAAIC,gCAAsB,OAAO,CAAA,CAAA;AAC1C,CAAA;AAAA,CAOO,CAAUC,mBAAV,KAAA;AAME,EAAMA,mBAAA,CAAA,OAAA,GAAU,CAAC,OAAA,KACtBF,qCAAqB,CAAA;AAAA,IACnB,OAAS,EAAAG,uBAAA;AAAA,IACT,MAAM,EAAC;AAAA,IACP,OAAS,EAAA,MAAM,IAAIF,+BAAA,CAAsB,OAAO,CAAA;AAAA,GACjD,CAAA,CAAA;AAKI,EAAMC,mBAAA,CAAA,IAAA,GAAO,UAAW,CAAAC,uBAAA,EAAmB,OAAO;AAAA,IACvD,WAAA,EAAa,KAAK,EAAG,EAAA;AAAA,IACrB,iBAAA,EAAmB,KAAK,EAAG,EAAA;AAAA,IAC3B,aAAA,EAAe,KAAK,EAAG,EAAA;AAAA,IACvB,kBAAA,EAAoB,KAAK,EAAG,EAAA;AAAA,IAC5B,cAAA,EAAgB,KAAK,EAAG,EAAA;AAAA,IACxB,iBAAA,EAAmB,KAAK,EAAG,EAAA;AAAA,IAC3B,aAAA,EAAe,KAAK,EAAG,EAAA;AAAA,IACvB,eAAA,EAAiB,KAAK,EAAG,EAAA;AAAA,IACzB,eAAA,EAAiB,KAAK,EAAG,EAAA;AAAA,IACzB,gBAAA,EAAkB,KAAK,EAAG,EAAA;AAAA,IAC1B,WAAA,EAAa,KAAK,EAAG,EAAA;AAAA,IACrB,kBAAA,EAAoB,KAAK,EAAG,EAAA;AAAA,IAC5B,mBAAA,EAAqB,KAAK,EAAG,EAAA;AAAA,IAC7B,cAAA,EAAgB,KAAK,EAAG,EAAA;AAAA,GACxB,CAAA,CAAA,CAAA;AAAA,CA/Ba,EAAA,kBAAA,KAAA,kBAAA,GAAA,EAAA,CAAA,CAAA;;;;"}

package/dist/testUtils.d.ts

@@ -0,0 +1,37 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { Entity } from '@backstage/catalog-model';
+import { ServiceMock } from '@backstage/backend-test-utils';
+import { CatalogApi } from '@backstage/catalog-client';
+
+/**
+ * Creates a fake catalog client that handles entities in memory storage. Note
+ * that this client may be severely limited in functionality, and advanced
+ * functions may not be available at all.
+ *
+ * @public
+ */
+declare function catalogServiceMock(options?: {
+    entities?: Entity[];
+}): CatalogApi;
+/**
+ * A collection of mock functionality for the catalog service.
+ *
+ * @public
+ */
+declare namespace catalogServiceMock {
+    /**
+     * Creates a fake catalog client that handles entities in memory storage. Note
+     * that this client may be severely limited in functionality, and advanced
+     * functions may not be available at all.
+     */
+    const factory: (options?: {
+        entities?: Entity[];
+    }) => _backstage_backend_plugin_api.ServiceFactory<CatalogApi, "plugin", "singleton">;
+    /**
+     * Creates a catalog client whose methods are mock functions, possibly with
+     * some of them overloaded by the caller.
+     */
+    const mock: (partialImpl?: Partial<CatalogApi> | undefined) => ServiceMock<CatalogApi>;
+}
+
+export { catalogServiceMock };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-node",
-  "version": "1.12.7-next.2",
+  "version": "1.13.0",
   "description": "The plugin-catalog-node module for @backstage/plugin-catalog-backend",
   "backstage": {
     "role": "node-library",
@@ -34,13 +34,19 @@
       "types": "./dist/alpha.d.ts",
       "default": "./dist/alpha.cjs.js"
     },
+    "./testUtils": {
+      "require": "./dist/testUtils.cjs.js",
+      "types": "./dist/testUtils.d.ts",
+      "default": "./dist/testUtils.cjs.js"
+    },
     "./package.json": "./package.json"
   },
   "main": "./dist/index.cjs.js",
   "types": "./dist/index.d.ts",
   "files": [
     "dist",
-    "alpha"
+    "alpha",
+    "testUtils"
   ],
   "scripts": {
     "build": "backstage-cli package build",
@@ -52,17 +58,17 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "^1.0.0-next.2",
-    "@backstage/catalog-client": "^1.7.0-next.1",
-    "@backstage/catalog-model": "^1.6.0",
+    "@backstage/backend-plugin-api": "^1.0.0",
+    "@backstage/catalog-client": "^1.7.0",
+    "@backstage/catalog-model": "^1.7.0",
     "@backstage/errors": "^1.2.4",
-    "@backstage/plugin-catalog-common": "^1.0.26",
+    "@backstage/plugin-catalog-common": "^1.1.0",
     "@backstage/plugin-permission-common": "^0.8.1",
-    "@backstage/plugin-permission-node": "^0.8.3-next.2",
+    "@backstage/plugin-permission-node": "^0.8.3",
     "@backstage/types": "^1.1.1"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^1.0.0-next.2",
-    "@backstage/cli": "^0.27.1-next.2"
+    "@backstage/backend-test-utils": "^1.0.0",
+    "@backstage/cli": "^0.27.1"
   }
 }

package/testUtils/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@backstage/plugin-catalog-node__testutils",
+  "version": "1.13.0",
+  "main": "../dist/testUtils.cjs.js",
+  "types": "../dist/testUtils.d.ts"
+}