@backstage/plugin-catalog-backend-module-scaffolder-entity-model 0.0.0-nightly-20230913021415

package/CHANGELOG.md

@@ -0,0 +1,33 @@
+# @backstage/plugin-catalog-backend-module-scaffolder-entity-model
+
+## 0.0.0-nightly-20230913021415
+
+### Minor Changes
+
+- d5313ede3529: Added a dedicated module to collect the `ScaffolderEntitiesProcessor` and `catalogModuleTemplateKind`.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/catalog-model@0.0.0-nightly-20230913021415
+  - @backstage/plugin-catalog-common@0.0.0-nightly-20230913021415
+  - @backstage/plugin-scaffolder-common@0.0.0-nightly-20230913021415
+  - @backstage/backend-common@0.0.0-nightly-20230913021415
+  - @backstage/backend-plugin-api@0.0.0-nightly-20230913021415
+  - @backstage/plugin-catalog-node@0.0.0-nightly-20230913021415
+
+## 0.1.0-next.0
+
+### Minor Changes
+
+- d5313ede3529: Added a dedicated module to collect the `ScaffolderEntitiesProcessor` and `catalogModuleTemplateKind`.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/catalog-model@1.4.2-next.2
+  - @backstage/plugin-catalog-common@1.0.16-next.2
+  - @backstage/plugin-scaffolder-common@1.4.1-next.2
+  - @backstage/backend-plugin-api@0.6.3-next.3
+  - @backstage/backend-common@0.19.5-next.3
+  - @backstage/plugin-catalog-node@1.4.4-next.3

package/README.md

@@ -0,0 +1,3 @@
+# @backstage/plugin-catalog-backend-module-scaffolder-entity-model
+
+Adds support for the scaffolder specific entity model (e.g. the Template kind) to the catalog backend plugin.

package/dist/index.cjs.js

@@ -0,0 +1,88 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var catalogModel = require('@backstage/catalog-model');
+var pluginCatalogNode = require('@backstage/plugin-catalog-node');
+var pluginScaffolderCommon = require('@backstage/plugin-scaffolder-common');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var alpha = require('@backstage/plugin-catalog-node/alpha');
+var pluginCatalogBackendModuleScaffolderEntityModel = require('@backstage/plugin-catalog-backend-module-scaffolder-entity-model');
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class ScaffolderEntitiesProcessor {
+  constructor() {
+    __publicField(this, "validators", [pluginScaffolderCommon.templateEntityV1beta3Validator]);
+  }
+  getProcessorName() {
+    return "ScaffolderEntitiesProcessor";
+  }
+  async validateEntityKind(entity) {
+    for (const validator of this.validators) {
+      if (await validator.check(entity)) {
+        return true;
+      }
+    }
+    return false;
+  }
+  async postProcessEntity(entity, _location, emit) {
+    const selfRef = catalogModel.getCompoundEntityRef(entity);
+    if (entity.apiVersion === "scaffolder.backstage.io/v1beta3" && entity.kind === "Template") {
+      const template = entity;
+      const target = template.spec.owner;
+      if (target) {
+        const targetRef = catalogModel.parseEntityRef(target, {
+          defaultKind: "Group",
+          defaultNamespace: selfRef.namespace
+        });
+        emit(
+          pluginCatalogNode.processingResult.relation({
+            source: selfRef,
+            type: catalogModel.RELATION_OWNED_BY,
+            target: {
+              kind: targetRef.kind,
+              namespace: targetRef.namespace,
+              name: targetRef.name
+            }
+          })
+        );
+        emit(
+          pluginCatalogNode.processingResult.relation({
+            source: {
+              kind: targetRef.kind,
+              namespace: targetRef.namespace,
+              name: targetRef.name
+            },
+            type: catalogModel.RELATION_OWNER_OF,
+            target: selfRef
+          })
+        );
+      }
+    }
+    return entity;
+  }
+}
+
+const catalogModuleScaffolderEntityModel = backendPluginApi.createBackendModule({
+  pluginId: "catalog",
+  moduleId: "scaffolderEntityModel",
+  register(env) {
+    env.registerInit({
+      deps: {
+        catalog: alpha.catalogProcessingExtensionPoint
+      },
+      async init({ catalog }) {
+        catalog.addProcessor(new pluginCatalogBackendModuleScaffolderEntityModel.ScaffolderEntitiesProcessor());
+      }
+    });
+  }
+});
+
+exports.ScaffolderEntitiesProcessor = ScaffolderEntitiesProcessor;
+exports["default"] = catalogModuleScaffolderEntityModel;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/processor/ScaffolderEntitiesProcessor.ts","../src/module.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 {\n  Entity,\n  getCompoundEntityRef,\n  parseEntityRef,\n  RELATION_OWNED_BY,\n  RELATION_OWNER_OF,\n} from '@backstage/catalog-model';\nimport {\n  CatalogProcessor,\n  CatalogProcessorEmit,\n  processingResult,\n} from '@backstage/plugin-catalog-node';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport {\n  TemplateEntityV1beta3,\n  templateEntityV1beta3Validator,\n} from '@backstage/plugin-scaffolder-common';\n\n/**\n * Adds support for scaffolder specific entity kinds to the catalog.\n *\n * @public\n */\nexport class ScaffolderEntitiesProcessor implements CatalogProcessor {\n  getProcessorName(): string {\n    return 'ScaffolderEntitiesProcessor';\n  }\n\n  private readonly validators = [templateEntityV1beta3Validator];\n\n  async validateEntityKind(entity: Entity): Promise<boolean> {\n    for (const validator of this.validators) {\n      if (await validator.check(entity)) {\n        return true;\n      }\n    }\n\n    return false;\n  }\n\n  async postProcessEntity(\n    entity: Entity,\n    _location: LocationSpec,\n    emit: CatalogProcessorEmit,\n  ): Promise<Entity> {\n    const selfRef = getCompoundEntityRef(entity);\n\n    if (\n      entity.apiVersion === 'scaffolder.backstage.io/v1beta3' &&\n      entity.kind === 'Template'\n    ) {\n      const template = entity as TemplateEntityV1beta3;\n\n      const target = template.spec.owner;\n      if (target) {\n        const targetRef = parseEntityRef(target, {\n          defaultKind: 'Group',\n          defaultNamespace: selfRef.namespace,\n        });\n        emit(\n          processingResult.relation({\n            source: selfRef,\n            type: RELATION_OWNED_BY,\n            target: {\n              kind: targetRef.kind,\n              namespace: targetRef.namespace,\n              name: targetRef.name,\n            },\n          }),\n        );\n        emit(\n          processingResult.relation({\n            source: {\n              kind: targetRef.kind,\n              namespace: targetRef.namespace,\n              name: targetRef.name,\n            },\n            type: RELATION_OWNER_OF,\n            target: selfRef,\n          }),\n        );\n      }\n    }\n\n    return entity;\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 */\n\nimport { createBackendModule } from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\nimport { ScaffolderEntitiesProcessor } from '@backstage/plugin-catalog-backend-module-scaffolder-entity-model';\n\n/**\n * Registers support for the scaffolder specific entity model (e.g. the Template\n * kind) to the catalog backend plugin.\n *\n * @public\n */\nexport const catalogModuleScaffolderEntityModel = createBackendModule({\n  pluginId: 'catalog',\n  moduleId: 'scaffolderEntityModel',\n  register(env) {\n    env.registerInit({\n      deps: {\n        catalog: catalogProcessingExtensionPoint,\n      },\n      async init({ catalog }) {\n        catalog.addProcessor(new ScaffolderEntitiesProcessor());\n      },\n    });\n  },\n});\n"],"names":["templateEntityV1beta3Validator","getCompoundEntityRef","parseEntityRef","processingResult","RELATION_OWNED_BY","RELATION_OWNER_OF","createBackendModule","catalogProcessingExtensionPoint","ScaffolderEntitiesProcessor"],"mappings":";;;;;;;;;;;;;;;;;AAuCO,MAAM,2BAAwD,CAAA;AAAA,EAA9D,WAAA,GAAA;AAKL,IAAiB,aAAA,CAAA,IAAA,EAAA,YAAA,EAAa,CAACA,qDAA8B,CAAA,CAAA,CAAA;AAAA,GAAA;AAAA,EAJ7D,gBAA2B,GAAA;AACzB,IAAO,OAAA,6BAAA,CAAA;AAAA,GACT;AAAA,EAIA,MAAM,mBAAmB,MAAkC,EAAA;AACzD,IAAW,KAAA,MAAA,SAAA,IAAa,KAAK,UAAY,EAAA;AACvC,MAAA,IAAI,MAAM,SAAA,CAAU,KAAM,CAAA,MAAM,CAAG,EAAA;AACjC,QAAO,OAAA,IAAA,CAAA;AAAA,OACT;AAAA,KACF;AAEA,IAAO,OAAA,KAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAM,iBAAA,CACJ,MACA,EAAA,SAAA,EACA,IACiB,EAAA;AACjB,IAAM,MAAA,OAAA,GAAUC,kCAAqB,MAAM,CAAA,CAAA;AAE3C,IAAA,IACE,MAAO,CAAA,UAAA,KAAe,iCACtB,IAAA,MAAA,CAAO,SAAS,UAChB,EAAA;AACA,MAAA,MAAM,QAAW,GAAA,MAAA,CAAA;AAEjB,MAAM,MAAA,MAAA,GAAS,SAAS,IAAK,CAAA,KAAA,CAAA;AAC7B,MAAA,IAAI,MAAQ,EAAA;AACV,QAAM,MAAA,SAAA,GAAYC,4BAAe,MAAQ,EAAA;AAAA,UACvC,WAAa,EAAA,OAAA;AAAA,UACb,kBAAkB,OAAQ,CAAA,SAAA;AAAA,SAC3B,CAAA,CAAA;AACD,QAAA,IAAA;AAAA,UACEC,mCAAiB,QAAS,CAAA;AAAA,YACxB,MAAQ,EAAA,OAAA;AAAA,YACR,IAAM,EAAAC,8BAAA;AAAA,YACN,MAAQ,EAAA;AAAA,cACN,MAAM,SAAU,CAAA,IAAA;AAAA,cAChB,WAAW,SAAU,CAAA,SAAA;AAAA,cACrB,MAAM,SAAU,CAAA,IAAA;AAAA,aAClB;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AACA,QAAA,IAAA;AAAA,UACED,mCAAiB,QAAS,CAAA;AAAA,YACxB,MAAQ,EAAA;AAAA,cACN,MAAM,SAAU,CAAA,IAAA;AAAA,cAChB,WAAW,SAAU,CAAA,SAAA;AAAA,cACrB,MAAM,SAAU,CAAA,IAAA;AAAA,aAClB;AAAA,YACA,IAAM,EAAAE,8BAAA;AAAA,YACN,MAAQ,EAAA,OAAA;AAAA,WACT,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACF;AAEA,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AACF;;AC5EO,MAAM,qCAAqCC,oCAAoB,CAAA;AAAA,EACpE,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,uBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,OAAS,EAAAC,qCAAA;AAAA,OACX;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,OAAA,EAAW,EAAA;AACtB,QAAQ,OAAA,CAAA,YAAA,CAAa,IAAIC,2EAAA,EAA6B,CAAA,CAAA;AAAA,OACxD;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+import { Entity } from '@backstage/catalog-model';
+import { CatalogProcessor, CatalogProcessorEmit } from '@backstage/plugin-catalog-node';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+
+/**
+ * Adds support for scaffolder specific entity kinds to the catalog.
+ *
+ * @public
+ */
+declare class ScaffolderEntitiesProcessor implements CatalogProcessor {
+    getProcessorName(): string;
+    private readonly validators;
+    validateEntityKind(entity: Entity): Promise<boolean>;
+    postProcessEntity(entity: Entity, _location: LocationSpec, emit: CatalogProcessorEmit): Promise<Entity>;
+}
+
+/**
+ * Registers support for the scaffolder specific entity model (e.g. the Template
+ * kind) to the catalog backend plugin.
+ *
+ * @public
+ */
+declare const catalogModuleScaffolderEntityModel: () => _backstage_backend_plugin_api.BackendFeature;
+
+export { ScaffolderEntitiesProcessor, catalogModuleScaffolderEntityModel as default };

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@backstage/plugin-catalog-backend-module-scaffolder-entity-model",
+  "description": "Adds support for the scaffolder specific entity model (e.g. the Template kind) to the catalog backend plugin.",
+  "version": "0.0.0-nightly-20230913021415",
+  "main": "./dist/index.cjs.js",
+  "types": "./dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.cjs.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "backstage": {
+    "role": "backend-plugin-module"
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@backstage/backend-common": "^0.0.0-nightly-20230913021415",
+    "@backstage/backend-plugin-api": "^0.0.0-nightly-20230913021415",
+    "@backstage/catalog-model": "^0.0.0-nightly-20230913021415",
+    "@backstage/plugin-catalog-common": "^0.0.0-nightly-20230913021415",
+    "@backstage/plugin-catalog-node": "^0.0.0-nightly-20230913021415",
+    "@backstage/plugin-scaffolder-common": "^0.0.0-nightly-20230913021415"
+  },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "^0.0.0-nightly-20230913021415",
+    "@backstage/cli": "^0.0.0-nightly-20230913021415"
+  },
+  "files": [
+    "dist"
+  ]
+}