@thecodingsheikh/backstage-plugin-catalog-backend-module-multi-owner-processor 1.0.2

package/README.md

@@ -0,0 +1,72 @@
+# @thecodingsheikh/backstage-plugin-catalog-backend-module-multi-owner-processor
+
+A backend module for the Backstage catalog that processes `spec.owners` on entities and emits proper `ownedBy` / `ownerOf` relations for each owner.
+
+![screenshow](https://github.com/TheCodingSheikh/backstage-plugins/blob/main/plugins/multi-owner/catalog-backend-module-multi-owner-processor/screenshot.png?raw=true)
+
+## Features
+
+- Reads `spec.owners` (an array of strings or `{ name, role }` objects) from any entity
+- Emits bidirectional `ownedBy` / `ownerOf` relations for each owner
+- Writes a normalized `multi-owner.io/owners` annotation (JSON) for the frontend to consume
+- Coexists with the built-in `spec.owner` field — both are merged automatically
+- Defaults unqualified references to `kind: Group`
+
+## Installation
+
+```bash
+yarn --cwd packages/backend @thecodingsheikh/backstage-plugin-catalog-backend-module-multi-owner-processor
+```
+
+### Backend Setup
+
+In your `packages/backend/src/index.ts`:
+
+```ts
+const backend = createBackend();
+
+// ... other plugins ...
+
+// Multi-owner processor
+backend.add(
+  import(
+    '@thecodingsheikh/backstage-plugin-catalog-backend-module-multi-owner-processor'
+  ),
+);
+
+backend.start();
+```
+
+## Entity Configuration
+
+Add `spec.owners` to any entity's `catalog-info.yaml`:
+
+```yaml
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: my-service
+spec:
+  type: service
+  lifecycle: production
+  owners:
+    - name: group:default/platform-team
+      role: maintainer
+    - name: group:default/sre-team
+      role: operations
+    - name: user:default/jane
+      role: tech-lead
+    - group:default/qa-team  # string shorthand, no role
+```
+
+## How It Works
+
+```mermaid
+graph LR
+    A[Entity YAML] -->|spec.owners| B[MultiOwnerEntitiesProcessor]
+    B -->|preProcess| C[Writes annotation]
+    B -->|postProcess| D[Emits ownedBy relations]
+    B -->|postProcess| E[Emits ownerOf relations]
+    C --> F[Frontend Card reads annotation]
+    D --> G[Backstage ownership features]
+```

package/dist/MultiOwnerEntitiesProcessor.cjs.js

@@ -0,0 +1,76 @@
+'use strict';
+
+var pluginCatalogNode = require('@backstage/plugin-catalog-node');
+var catalogModel = require('@backstage/catalog-model');
+var backstagePluginMultiOwnerCommon = require('@thecodingsheikh/backstage-plugin-multi-owner-common');
+
+class MultiOwnerEntitiesProcessor {
+  getProcessorName() {
+    return "MultiOwnerEntitiesProcessor";
+  }
+  async preProcessEntity(entity, _location) {
+    const spec = entity.spec;
+    if (!spec?.owners) {
+      return entity;
+    }
+    const owners = backstagePluginMultiOwnerCommon.parseOwners(spec.owners);
+    if (owners.length === 0) {
+      return entity;
+    }
+    return {
+      ...entity,
+      metadata: {
+        ...entity.metadata,
+        annotations: {
+          ...entity.metadata.annotations,
+          [backstagePluginMultiOwnerCommon.MULTI_OWNER_ANNOTATION]: JSON.stringify(owners)
+        }
+      }
+    };
+  }
+  async postProcessEntity(entity, _location, emit) {
+    const spec = entity.spec;
+    if (!spec?.owners) {
+      return entity;
+    }
+    const owners = backstagePluginMultiOwnerCommon.parseOwners(spec.owners);
+    for (const owner of owners) {
+      let ownerRef;
+      try {
+        const parsed = catalogModel.parseEntityRef(owner.name, {
+          defaultKind: "group",
+          defaultNamespace: entity.metadata.namespace || "default"
+        });
+        ownerRef = catalogModel.stringifyEntityRef(parsed);
+      } catch {
+        continue;
+      }
+      emit(
+        pluginCatalogNode.processingResult.relation({
+          type: catalogModel.RELATION_OWNED_BY,
+          source: {
+            kind: entity.kind,
+            namespace: entity.metadata.namespace || "default",
+            name: entity.metadata.name
+          },
+          target: catalogModel.parseEntityRef(ownerRef)
+        })
+      );
+      emit(
+        pluginCatalogNode.processingResult.relation({
+          type: catalogModel.RELATION_OWNER_OF,
+          source: catalogModel.parseEntityRef(ownerRef),
+          target: {
+            kind: entity.kind,
+            namespace: entity.metadata.namespace || "default",
+            name: entity.metadata.name
+          }
+        })
+      );
+    }
+    return entity;
+  }
+}
+
+exports.MultiOwnerEntitiesProcessor = MultiOwnerEntitiesProcessor;
+//# sourceMappingURL=MultiOwnerEntitiesProcessor.cjs.js.map

package/dist/MultiOwnerEntitiesProcessor.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MultiOwnerEntitiesProcessor.cjs.js","sources":["../src/MultiOwnerEntitiesProcessor.ts"],"sourcesContent":["import {\n    CatalogProcessor,\n    CatalogProcessorEmit,\n    processingResult,\n} from '@backstage/plugin-catalog-node';\nimport { Entity } from '@backstage/catalog-model';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport {\n    RELATION_OWNED_BY,\n    RELATION_OWNER_OF,\n    parseEntityRef,\n    stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport {\n    MULTI_OWNER_ANNOTATION,\n    parseOwners,\n} from '@thecodingsheikh/backstage-plugin-multi-owner-common';\n\n/**\n * A catalog processor that reads `spec.owners` from entities and emits\n * `ownedBy` / `ownerOf` relations for each owner listed.\n *\n * It also writes the normalized owner list as a JSON annotation\n * (`backstage.io/owners`) so the frontend can display them.\n *\n * @remarks\n * This processor runs *in addition to* the built-in processor that handles\n * `spec.owner`. If both fields are present, owners from both are emitted.\n * Duplicate relations are automatically deduplicated by the catalog engine.\n */\nexport class MultiOwnerEntitiesProcessor implements CatalogProcessor {\n    getProcessorName(): string {\n        return 'MultiOwnerEntitiesProcessor';\n    }\n\n    async preProcessEntity(\n        entity: Entity,\n        _location: LocationSpec,\n    ): Promise<Entity> {\n        const spec = entity.spec as Record<string, unknown> | undefined;\n        if (!spec?.owners) {\n            return entity;\n        }\n\n        const owners = parseOwners(spec.owners);\n        if (owners.length === 0) {\n            return entity;\n        }\n\n        // Write the normalized owner list as a JSON annotation so the\n        // frontend card can read it without re-parsing spec.\n        return {\n            ...entity,\n            metadata: {\n                ...entity.metadata,\n                annotations: {\n                    ...entity.metadata.annotations,\n                    [MULTI_OWNER_ANNOTATION]: JSON.stringify(owners),\n                },\n            },\n        };\n    }\n\n    async postProcessEntity(\n        entity: Entity,\n        _location: LocationSpec,\n        emit: CatalogProcessorEmit,\n    ): Promise<Entity> {\n        const spec = entity.spec as Record<string, unknown> | undefined;\n        if (!spec?.owners) {\n            return entity;\n        }\n\n        const owners = parseOwners(spec.owners);\n\n        for (const owner of owners) {\n            let ownerRef: string;\n            try {\n                // Validate and normalize the entity reference\n                const parsed = parseEntityRef(owner.name, {\n                    defaultKind: 'group',\n                    defaultNamespace: entity.metadata.namespace || 'default',\n                });\n                ownerRef = stringifyEntityRef(parsed);\n            } catch {\n                // Skip invalid references\n                continue;\n            }\n\n            // Emit the bidirectional ownership relations\n            emit(\n                processingResult.relation({\n                    type: RELATION_OWNED_BY,\n                    source: {\n                        kind: entity.kind,\n                        namespace: entity.metadata.namespace || 'default',\n                        name: entity.metadata.name,\n                    },\n                    target: parseEntityRef(ownerRef),\n                }),\n            );\n\n            emit(\n                processingResult.relation({\n                    type: RELATION_OWNER_OF,\n                    source: parseEntityRef(ownerRef),\n                    target: {\n                        kind: entity.kind,\n                        namespace: entity.metadata.namespace || 'default',\n                        name: entity.metadata.name,\n                    },\n                }),\n            );\n        }\n\n        return entity;\n    }\n}\n"],"names":["parseOwners","MULTI_OWNER_ANNOTATION","parseEntityRef","stringifyEntityRef","processingResult","RELATION_OWNED_BY","RELATION_OWNER_OF"],"mappings":";;;;;;AA8BO,MAAM,2BAAA,CAAwD;AAAA,EACjE,gBAAA,GAA2B;AACvB,IAAA,OAAO,6BAAA;AAAA,EACX;AAAA,EAEA,MAAM,gBAAA,CACF,MAAA,EACA,SAAA,EACe;AACf,IAAA,MAAM,OAAO,MAAA,CAAO,IAAA;AACpB,IAAA,IAAI,CAAC,MAAM,MAAA,EAAQ;AACf,MAAA,OAAO,MAAA;AAAA,IACX;AAEA,IAAA,MAAM,MAAA,GAASA,2CAAA,CAAY,IAAA,CAAK,MAAM,CAAA;AACtC,IAAA,IAAI,MAAA,CAAO,WAAW,CAAA,EAAG;AACrB,MAAA,OAAO,MAAA;AAAA,IACX;AAIA,IAAA,OAAO;AAAA,MACH,GAAG,MAAA;AAAA,MACH,QAAA,EAAU;AAAA,QACN,GAAG,MAAA,CAAO,QAAA;AAAA,QACV,WAAA,EAAa;AAAA,UACT,GAAG,OAAO,QAAA,CAAS,WAAA;AAAA,UACnB,CAACC,sDAAsB,GAAG,IAAA,CAAK,UAAU,MAAM;AAAA;AACnD;AACJ,KACJ;AAAA,EACJ;AAAA,EAEA,MAAM,iBAAA,CACF,MAAA,EACA,SAAA,EACA,IAAA,EACe;AACf,IAAA,MAAM,OAAO,MAAA,CAAO,IAAA;AACpB,IAAA,IAAI,CAAC,MAAM,MAAA,EAAQ;AACf,MAAA,OAAO,MAAA;AAAA,IACX;AAEA,IAAA,MAAM,MAAA,GAASD,2CAAA,CAAY,IAAA,CAAK,MAAM,CAAA;AAEtC,IAAA,KAAA,MAAW,SAAS,MAAA,EAAQ;AACxB,MAAA,IAAI,QAAA;AACJ,MAAA,IAAI;AAEA,QAAA,MAAM,MAAA,GAASE,2BAAA,CAAe,KAAA,CAAM,IAAA,EAAM;AAAA,UACtC,WAAA,EAAa,OAAA;AAAA,UACb,gBAAA,EAAkB,MAAA,CAAO,QAAA,CAAS,SAAA,IAAa;AAAA,SAClD,CAAA;AACD,QAAA,QAAA,GAAWC,gCAAmB,MAAM,CAAA;AAAA,MACxC,CAAA,CAAA,MAAQ;AAEJ,QAAA;AAAA,MACJ;AAGA,MAAA,IAAA;AAAA,QACIC,mCAAiB,QAAA,CAAS;AAAA,UACtB,IAAA,EAAMC,8BAAA;AAAA,UACN,MAAA,EAAQ;AAAA,YACJ,MAAM,MAAA,CAAO,IAAA;AAAA,YACb,SAAA,EAAW,MAAA,CAAO,QAAA,CAAS,SAAA,IAAa,SAAA;AAAA,YACxC,IAAA,EAAM,OAAO,QAAA,CAAS;AAAA,WAC1B;AAAA,UACA,MAAA,EAAQH,4BAAe,QAAQ;AAAA,SAClC;AAAA,OACL;AAEA,MAAA,IAAA;AAAA,QACIE,mCAAiB,QAAA,CAAS;AAAA,UACtB,IAAA,EAAME,8BAAA;AAAA,UACN,MAAA,EAAQJ,4BAAe,QAAQ,CAAA;AAAA,UAC/B,MAAA,EAAQ;AAAA,YACJ,MAAM,MAAA,CAAO,IAAA;AAAA,YACb,SAAA,EAAW,MAAA,CAAO,QAAA,CAAS,SAAA,IAAa,SAAA;AAAA,YACxC,IAAA,EAAM,OAAO,QAAA,CAAS;AAAA;AAC1B,SACH;AAAA,OACL;AAAA,IACJ;AAEA,IAAA,OAAO,MAAA;AAAA,EACX;AACJ;;;;"}

package/dist/index.cjs.js

@@ -0,0 +1,12 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var module$1 = require('./module.cjs.js');
+var MultiOwnerEntitiesProcessor = require('./MultiOwnerEntitiesProcessor.cjs.js');
+
+
+
+exports.default = module$1.default;
+exports.MultiOwnerEntitiesProcessor = MultiOwnerEntitiesProcessor.MultiOwnerEntitiesProcessor;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,36 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { CatalogProcessor, CatalogProcessorEmit } from '@backstage/plugin-catalog-node';
+import { Entity } from '@backstage/catalog-model';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
+
+/**
+ * Backend module that registers the {@link MultiOwnerEntitiesProcessor}
+ * with the catalog processing pipeline.
+ *
+ * @remarks
+ * Install this module in your backend by adding:
+ * ```ts
+ * backend.add(import('@thecodingsheikh/backstage-plugin-catalog-backend-module-multi-owner-processor'));
+ * ```
+ */
+declare const _default: _backstage_backend_plugin_api.BackendFeature;
+
+/**
+ * A catalog processor that reads `spec.owners` from entities and emits
+ * `ownedBy` / `ownerOf` relations for each owner listed.
+ *
+ * It also writes the normalized owner list as a JSON annotation
+ * (`backstage.io/owners`) so the frontend can display them.
+ *
+ * @remarks
+ * This processor runs *in addition to* the built-in processor that handles
+ * `spec.owner`. If both fields are present, owners from both are emitted.
+ * Duplicate relations are automatically deduplicated by the catalog engine.
+ */
+declare class MultiOwnerEntitiesProcessor implements CatalogProcessor {
+    getProcessorName(): string;
+    preProcessEntity(entity: Entity, _location: LocationSpec): Promise<Entity>;
+    postProcessEntity(entity: Entity, _location: LocationSpec, emit: CatalogProcessorEmit): Promise<Entity>;
+}
+
+export { MultiOwnerEntitiesProcessor, _default as default };

package/dist/module.cjs.js

@@ -0,0 +1,25 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var alpha = require('@backstage/plugin-catalog-node/alpha');
+var MultiOwnerEntitiesProcessor = require('./MultiOwnerEntitiesProcessor.cjs.js');
+
+var module$1 = backendPluginApi.createBackendModule({
+  pluginId: "catalog",
+  moduleId: "multi-owner-processor",
+  register(reg) {
+    reg.registerInit({
+      deps: {
+        catalog: alpha.catalogProcessingExtensionPoint
+      },
+      async init({ catalog }) {
+        catalog.addProcessor(new MultiOwnerEntitiesProcessor.MultiOwnerEntitiesProcessor());
+      }
+    });
+  }
+});
+
+exports.default = module$1;
+//# sourceMappingURL=module.cjs.js.map

package/dist/module.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.cjs.js","sources":["../src/module.ts"],"sourcesContent":["import { createBackendModule } from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\nimport { MultiOwnerEntitiesProcessor } from './MultiOwnerEntitiesProcessor';\n\n/**\n * Backend module that registers the {@link MultiOwnerEntitiesProcessor}\n * with the catalog processing pipeline.\n *\n * @remarks\n * Install this module in your backend by adding:\n * ```ts\n * backend.add(import('@thecodingsheikh/backstage-plugin-catalog-backend-module-multi-owner-processor'));\n * ```\n */\nexport default createBackendModule({\n    pluginId: 'catalog',\n    moduleId: 'multi-owner-processor',\n    register(reg) {\n        reg.registerInit({\n            deps: {\n                catalog: catalogProcessingExtensionPoint,\n            },\n            async init({ catalog }) {\n                catalog.addProcessor(new MultiOwnerEntitiesProcessor());\n            },\n        });\n    },\n});\n"],"names":["createBackendModule","catalogProcessingExtensionPoint","MultiOwnerEntitiesProcessor"],"mappings":";;;;;;;;AAcA,eAAeA,oCAAA,CAAoB;AAAA,EAC/B,QAAA,EAAU,SAAA;AAAA,EACV,QAAA,EAAU,uBAAA;AAAA,EACV,SAAS,GAAA,EAAK;AACV,IAAA,GAAA,CAAI,YAAA,CAAa;AAAA,MACb,IAAA,EAAM;AAAA,QACF,OAAA,EAASC;AAAA,OACb;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,OAAA,EAAQ,EAAG;AACpB,QAAA,OAAA,CAAQ,YAAA,CAAa,IAAIC,uDAAA,EAA6B,CAAA;AAAA,MAC1D;AAAA,KACH,CAAA;AAAA,EACL;AACJ,CAAC,CAAA;;;;"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@thecodingsheikh/backstage-plugin-catalog-backend-module-multi-owner-processor",
+  "version": "1.0.2",
+  "license": "Apache-2.0",
+  "main": "./dist/index.cjs.js",
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "backstage": {
+    "role": "backend-plugin-module",
+    "pluginId": "catalog",
+    "pluginPackage": "@backstage/plugin-catalog-backend",
+    "pluginPackages": [
+      "@thecodingsheikh/backstage-plugin-multi-owner-common",
+      "@thecodingsheikh/backstage-plugin-multi-owner",
+      "@thecodingsheikh/backstage-plugin-catalog-backend-module-multi-owner-processor"
+    ],
+    "features": {
+      ".": "@backstage/BackendFeature"
+    }
+  },
+  "sideEffects": false,
+  "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-plugin-api": "^1.1.1",
+    "@backstage/catalog-model": "^1.7.3",
+    "@backstage/plugin-catalog-common": "^1.1.2",
+    "@backstage/plugin-catalog-node": "^1.15.1",
+    "@thecodingsheikh/backstage-plugin-multi-owner-common": "^1.0.2"
+  },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "^1.2.1",
+    "@backstage/cli": "^0.34.5"
+  },
+  "files": [
+    "dist"
+  ],
+  "typesVersions": {
+    "*": {
+      "package.json": [
+        "package.json"
+      ]
+    }
+  }
+}