@red-hat-developer-hub/backstage-plugin-catalog-backend-module-ai-resource-extensions 0.4.0

package/CHANGELOG.md

@@ -0,0 +1,39 @@
+# @red-hat-developer-hub/backstage-plugin-catalog-backend-module-ai-resource-extensions
+
+## 0.4.0
+
+### Minor Changes
+
+- 238650c: Rename package from the accidentally doubled
+  `catalog-backend-module-catalog-backend-module-ai-resource-extensions` path/name
+  to `catalog-backend-module-ai-resource-extensions`.
+
+## 0.3.0
+
+### Minor Changes
+
+- 55088f9: Aggregate multiple AIResource extension errors into a single response.
+  Extract OCI validation into a shared `collectOciErrors` function called by
+  `AIResourceExtensionsProcessor` so that scope and OCI constraint violations
+  are reported together instead of stopping at the first failure.
+- 8317e6e: Consolidate OCI location validation into `AIResourceExtensionsProcessor`.
+  The standalone `AIResourceOciProcessor` class and its public export have been
+  removed; OCI format checks now run via the internal `collectOciErrors` helper
+  called by `AIResourceExtensionsProcessor`.
+- 93847ae: Migrate OCI asset location validation from `spec.location` to the standard
+  `backstage.io/source-location` annotation using the Backstage location-ref
+  form `url:oci://...`. The annotation is parsed with upstream `parseLocationRef`
+  for correct whitespace handling. Bare `oci://...` annotations (without the
+  `url:` prefix) are rejected with an actionable error.
+
+### Patch Changes
+
+- e168046: Add AIResource example YAML files and extend README with schema field
+  reference, registration guidance, and OCI validation-only documentation.
+
+## 0.2.0
+
+### Minor Changes
+
+- 6af0114: Add AIResource extension validation via AIResourceExtensionsProcessor, starting with spec.scope
+- 67be6ce: Scaffold new AIResource catalog extension and add upstream module to workspace

package/README.md

@@ -0,0 +1,128 @@
+# @red-hat-developer-hub/backstage-plugin-catalog-backend-module-ai-resource-extensions
+
+A Backstage catalog backend module that validates RHDH-specific extension
+fields on AIResource entities.
+
+## Validation
+
+The module registers a single catalog processor —
+`AIResourceExtensionsProcessor` — for `AIResource` entities.
+Non-AIResource entities pass through unchanged.
+
+### `AIResourceExtensionsProcessor`
+
+Validates RHDH extension fields on `AIResource` entities. All constraint
+violations are collected and reported in a single error rather than
+stopping at the first failure.
+
+#### `spec.scope`
+
+When present, `spec.scope` must be one of:
+
+- `organization`
+- `product`
+- `team`
+
+Omitting `spec.scope` is valid. Invalid values produce an actionable error
+naming the field, the received value, and the accepted values.
+
+#### `backstage.io/source-location` (OCI)
+
+When `backstage.io/source-location` uses the location-ref form
+`url:oci://…`, validates that the OCI target is a well-formed
+`oci://registry/repository[:tag|@digest]` URI. Validation is format-only —
+the processor makes no outbound registry or HTTP calls.
+
+Bare `oci://…` annotations (without the `url:` prefix) are rejected with
+an actionable error explaining the required `url:oci://…` format. The
+`url:` prefix is required because bare `oci://…` parses as location type
+`oci` with a non-URL target, which would break future UrlReader integration.
+
+Non-OCI source-locations (e.g. `url:https://…`) are not subject to OCI
+format rules and pass through without validation.
+
+## Schema Fields
+
+An `AIResource` entity uses `apiVersion: backstage.io/v1beta1` and
+`kind: AIResource`. The following fields are relevant:
+
+| Field                          | Enforced by this module | Description                                                                                      |
+| ------------------------------ | ----------------------- | ------------------------------------------------------------------------------------------------ |
+| `spec.type`                    | no¹                     | The type of AI asset (e.g. `model`)                                                              |
+| `spec.lifecycle`               | no¹                     | Lifecycle stage (e.g. `experimental`, `production`)                                              |
+| `spec.owner`                   | no¹                     | Owning entity reference (e.g. `team-data-science`)                                               |
+| `spec.scope`                   | optional, validated     | RHDH extension. Accepted values: `organization`, `product`, `team`. Omitting the field is valid. |
+| `backstage.io/source-location` | when target is `oci://` | Standard Backstage annotation. For OCI assets use `url:oci://…` (see below).                     |
+
+¹ These fields are typical for Backstage entities but are **not** validated or
+required by the processors in this module. Entities missing these fields will
+pass through without error.
+
+### `spec.scope` Values
+
+| Value          | Description                                           |
+| -------------- | ----------------------------------------------------- |
+| `organization` | The AI asset is shared across the entire organization |
+| `product`      | The AI asset is scoped to a specific product          |
+| `team`         | The AI asset is scoped to a specific team             |
+
+## Registering an AIResource Entity
+
+AIResource entities are registered through the standard RHDH catalog
+interfaces — no AIResource-specific registration flow is required.
+
+### Git-backed entities
+
+1. Create a `catalog-info.yaml` with `kind: AIResource`.
+2. Set `backstage.io/source-location` to the repository URL using the
+   standard location-ref form (e.g. `url:https://github.com/my-org/my-repo`)
+   so consumers can locate the source repository.
+3. Register the entity YAML via the RHDH catalog URL registration UI or
+   include it in a catalog location for auto-discovery.
+
+See [`examples/ai-resource-git.yaml`](../../examples/ai-resource-git.yaml)
+for a complete example.
+
+### OCI-backed entities
+
+1. Create a `catalog-info.yaml` with `kind: AIResource`.
+2. Set `backstage.io/source-location` to an OCI reference using the
+   location-ref form `url:oci://…`
+   (e.g. `url:oci://quay.io/my-org/my-model:latest`).
+
+   **Important:** use the `url:oci://…` form — not bare `oci://…`. The
+   `url:` prefix is required by the Backstage location-ref convention.
+
+3. Register the file via the RHDH catalog URL registration UI or include
+   it in a catalog location for auto-discovery.
+
+See [`examples/ai-resource-oci.yaml`](../../examples/ai-resource-oci.yaml)
+for a complete example.
+
+## OCI Validation-Only Behavior
+
+The `AIResourceExtensionsProcessor` validates the `backstage.io/source-location`
+annotation when the location-ref target uses the `oci://` scheme. It checks:
+
+- The annotation uses the `url:oci://…` location-ref form (not bare `oci://…`).
+- The OCI target is a non-empty string with no leading or trailing whitespace.
+- The URI contains at least a registry and a repository path
+  (e.g. `oci://quay.io/org/model:tag`).
+
+**The processor makes zero outbound network calls.** It does not contact
+OCI registries, pull manifests, or verify that the referenced artifact
+exists. The catalog indexes the OCI reference as metadata only.
+
+This design is intentional for air-gap safety: RHDH deployments in
+disconnected environments can register OCI-backed AI assets without
+requiring network access to the artifact registry at ingestion time.
+The OCI URI serves as a stable reference that downstream tooling can
+resolve when registry access is available.
+
+## Public API
+
+| Export                          | Description                                             |
+| ------------------------------- | ------------------------------------------------------- |
+| `AIResourceExtensionsProcessor` | `CatalogProcessor` for RHDH AIResource extension fields |
+| `VALID_AI_RESOURCE_SCOPES`      | Readonly tuple of accepted scope values                 |
+| `AIResourceScope`               | Type union of accepted scope values                     |

package/dist/AIResourceExtensionsProcessor.cjs.js

@@ -0,0 +1,39 @@
+'use strict';
+
+var collectOciErrors = require('./collectOciErrors.cjs.js');
+
+const VALID_AI_RESOURCE_SCOPES = [
+  "organization",
+  "product",
+  "team"
+];
+class AIResourceExtensionsProcessor {
+  getProcessorName() {
+    return "AIResourceExtensionsProcessor";
+  }
+  async preProcessEntity(entity, _location, _emit) {
+    if (entity.kind !== "AIResource") {
+      return entity;
+    }
+    const errors = [];
+    const scope = entity.spec?.scope;
+    if (scope !== void 0 && !VALID_AI_RESOURCE_SCOPES.includes(scope)) {
+      const accepted = VALID_AI_RESOURCE_SCOPES.map((v) => `'${v}'`).join(", ");
+      const sanitized = Array.from(String(scope)).filter((c) => c.charCodeAt(0) > 31).join("").slice(0, 200);
+      errors.push(
+        `spec.scope has invalid value '${sanitized}'; accepted values are ${accepted}`
+      );
+    }
+    errors.push(...collectOciErrors.collectOciErrors(entity));
+    if (errors.length > 0) {
+      throw new Error(
+        `Validation failed for AIResource entity: ${errors.join("; ")}`
+      );
+    }
+    return entity;
+  }
+}
+
+exports.AIResourceExtensionsProcessor = AIResourceExtensionsProcessor;
+exports.VALID_AI_RESOURCE_SCOPES = VALID_AI_RESOURCE_SCOPES;
+//# sourceMappingURL=AIResourceExtensionsProcessor.cjs.js.map

package/dist/AIResourceExtensionsProcessor.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AIResourceExtensionsProcessor.cjs.js","sources":["../src/AIResourceExtensionsProcessor.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\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  CatalogProcessor,\n  CatalogProcessorEmit,\n} from '@backstage/plugin-catalog-node';\nimport { Entity } from '@backstage/catalog-model';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport { collectOciErrors } from './collectOciErrors';\n\n/**\n * Valid values for spec.scope on AIResource entities.\n *\n * @public\n */\nexport const VALID_AI_RESOURCE_SCOPES = [\n  'organization',\n  'product',\n  'team',\n] as const;\n\n/**\n * Type for valid AIResource scope values.\n *\n * @public\n */\nexport type AIResourceScope = (typeof VALID_AI_RESOURCE_SCOPES)[number];\n\n/**\n * A CatalogProcessor that validates RHDH-specific extension\n * fields on AIResource entities.\n *\n * Validates:\n * - `spec.scope`: optional field restricted to 'organization',\n *   'product', or 'team'\n * - `backstage.io/source-location`: OCI URI format when the\n *   location-ref target uses the `oci://` scheme\n *\n * All constraint violations are collected and reported in a single\n * error rather than stopping at the first failure.\n *\n * @public\n */\nexport class AIResourceExtensionsProcessor implements CatalogProcessor {\n  getProcessorName(): string {\n    return 'AIResourceExtensionsProcessor';\n  }\n\n  async preProcessEntity(\n    entity: Entity,\n    _location: LocationSpec,\n    _emit: CatalogProcessorEmit,\n  ): Promise<Entity> {\n    if (entity.kind !== 'AIResource') {\n      return entity;\n    }\n\n    const errors: string[] = [];\n\n    const scope = entity.spec?.scope;\n    if (\n      scope !== undefined &&\n      !VALID_AI_RESOURCE_SCOPES.includes(scope as AIResourceScope)\n    ) {\n      const accepted = VALID_AI_RESOURCE_SCOPES.map(v => `'${v}'`).join(', ');\n      const sanitized = Array.from(String(scope))\n        .filter(c => c.charCodeAt(0) > 0x1f)\n        .join('')\n        .slice(0, 200);\n      errors.push(\n        `spec.scope has invalid value '${sanitized}'; accepted values are ${accepted}`,\n      );\n    }\n\n    errors.push(...collectOciErrors(entity));\n\n    if (errors.length > 0) {\n      throw new Error(\n        `Validation failed for AIResource entity: ${errors.join('; ')}`,\n      );\n    }\n\n    return entity;\n  }\n}\n"],"names":["collectOciErrors"],"mappings":";;;;AA6BO,MAAM,wBAAA,GAA2B;AAAA,EACtC,cAAA;AAAA,EACA,SAAA;AAAA,EACA;AACF;AAwBO,MAAM,6BAAA,CAA0D;AAAA,EACrE,gBAAA,GAA2B;AACzB,IAAA,OAAO,+BAAA;AAAA,EACT;AAAA,EAEA,MAAM,gBAAA,CACJ,MAAA,EACA,SAAA,EACA,KAAA,EACiB;AACjB,IAAA,IAAI,MAAA,CAAO,SAAS,YAAA,EAAc;AAChC,MAAA,OAAO,MAAA;AAAA,IACT;AAEA,IAAA,MAAM,SAAmB,EAAC;AAE1B,IAAA,MAAM,KAAA,GAAQ,OAAO,IAAA,EAAM,KAAA;AAC3B,IAAA,IACE,UAAU,MAAA,IACV,CAAC,wBAAA,CAAyB,QAAA,CAAS,KAAwB,CAAA,EAC3D;AACA,MAAA,MAAM,QAAA,GAAW,yBAAyB,GAAA,CAAI,CAAA,CAAA,KAAK,IAAI,CAAC,CAAA,CAAA,CAAG,CAAA,CAAE,IAAA,CAAK,IAAI,CAAA;AACtE,MAAA,MAAM,SAAA,GAAY,MAAM,IAAA,CAAK,MAAA,CAAO,KAAK,CAAC,CAAA,CACvC,OAAO,CAAA,CAAA,KAAK,CAAA,CAAE,WAAW,CAAC,CAAA,GAAI,EAAI,CAAA,CAClC,IAAA,CAAK,EAAE,CAAA,CACP,KAAA,CAAM,GAAG,GAAG,CAAA;AACf,MAAA,MAAA,CAAO,IAAA;AAAA,QACL,CAAA,8BAAA,EAAiC,SAAS,CAAA,uBAAA,EAA0B,QAAQ,CAAA;AAAA,OAC9E;AAAA,IACF;AAEA,IAAA,MAAA,CAAO,IAAA,CAAK,GAAGA,iCAAA,CAAiB,MAAM,CAAC,CAAA;AAEvC,IAAA,IAAI,MAAA,CAAO,SAAS,CAAA,EAAG;AACrB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,yCAAA,EAA4C,MAAA,CAAO,IAAA,CAAK,IAAI,CAAC,CAAA;AAAA,OAC/D;AAAA,IACF;AAEA,IAAA,OAAO,MAAA;AAAA,EACT;AACF;;;;;"}

package/dist/collectOciErrors.cjs.js

@@ -0,0 +1,43 @@
+'use strict';
+
+var catalogModel = require('@backstage/catalog-model');
+
+function collectOciErrors(entity) {
+  const annotation = entity.metadata?.annotations?.[catalogModel.ANNOTATION_SOURCE_LOCATION];
+  if (annotation === void 0 || annotation === null) {
+    return [];
+  }
+  let type;
+  let target;
+  try {
+    ({ type, target } = catalogModel.parseLocationRef(annotation));
+  } catch {
+    return [];
+  }
+  if (type === "oci") {
+    const sanitized = Array.from(annotation.trim()).filter((c) => c.charCodeAt(0) > 31).join("").slice(0, 200);
+    return [
+      `${catalogModel.ANNOTATION_SOURCE_LOCATION} '${sanitized}' uses a bare oci:// URI; the Backstage location-ref form url:oci://\u2026 is required (e.g. url:oci://quay.io/org/model:tag)`
+    ];
+  }
+  if (type !== "url" || !target.startsWith("oci://")) {
+    return [];
+  }
+  const ociPath = target.slice("oci://".length);
+  if (ociPath === "") {
+    return [
+      `${catalogModel.ANNOTATION_SOURCE_LOCATION} target 'oci://' is not a valid OCI reference; expected format url:oci://registry/repository[:tag|@digest]`
+    ];
+  }
+  const parts = ociPath.split("/");
+  if (parts.length < 2 || parts.some((part) => part === "" || /\s/.test(part))) {
+    const sanitized = Array.from(target).filter((c) => c.charCodeAt(0) > 31).join("").slice(0, 200);
+    return [
+      `${catalogModel.ANNOTATION_SOURCE_LOCATION} target '${sanitized}' is not a valid OCI reference; expected format url:oci://registry/repository[:tag|@digest]`
+    ];
+  }
+  return [];
+}
+
+exports.collectOciErrors = collectOciErrors;
+//# sourceMappingURL=collectOciErrors.cjs.js.map

package/dist/collectOciErrors.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collectOciErrors.cjs.js","sources":["../src/collectOciErrors.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\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  ANNOTATION_SOURCE_LOCATION,\n  Entity,\n  parseLocationRef,\n} from '@backstage/catalog-model';\n\n/**\n * Collects OCI-related validation errors for an AIResource entity\n * without throwing. Returns an array of error messages (empty if valid).\n *\n * Validates the `backstage.io/source-location` annotation when its\n * location-ref target uses the `oci://` scheme. The annotation must\n * use the Backstage location-ref form `url:oci://…`.\n *\n * Uses upstream `parseLocationRef` for parsing, which normalizes\n * leading/trailing whitespace around type and target.\n *\n * @internal\n */\nexport function collectOciErrors(entity: Entity): string[] {\n  const annotation = entity.metadata?.annotations?.[ANNOTATION_SOURCE_LOCATION];\n\n  if (annotation === undefined || annotation === null) {\n    return [];\n  }\n\n  let type: string;\n  let target: string;\n  try {\n    ({ type, target } = parseLocationRef(annotation));\n  } catch {\n    // Not a valid location-ref (no colon, empty type/target, etc.)\n    // Leave it for other processors to handle.\n    return [];\n  }\n\n  // Detect bare `oci://…` without the required `url:` prefix.\n  // parseLocationRef parses `oci://host/path` as type `oci` with a\n  // non-URL target, which breaks future UrlReader integration.\n  if (type === 'oci') {\n    const sanitized = Array.from(annotation.trim())\n      .filter(c => c.charCodeAt(0) > 0x1f)\n      .join('')\n      .slice(0, 200);\n    return [\n      `${ANNOTATION_SOURCE_LOCATION} '${sanitized}' uses a bare oci:// URI; ` +\n        `the Backstage location-ref form url:oci://… is required ` +\n        `(e.g. url:oci://quay.io/org/model:tag)`,\n    ];\n  }\n\n  // Only apply OCI validation when the location-ref type is `url` and\n  // the target starts with `oci://`.\n  if (type !== 'url' || !target.startsWith('oci://')) {\n    return [];\n  }\n\n  const ociPath = target.slice('oci://'.length);\n\n  if (ociPath === '') {\n    return [\n      `${ANNOTATION_SOURCE_LOCATION} target 'oci://' is not a valid OCI ` +\n        `reference; expected format url:oci://registry/repository[:tag|@digest]`,\n    ];\n  }\n\n  const parts = ociPath.split('/');\n\n  // Reject missing registry/repo, empty segments (e.g. trailing slash),\n  // and whitespace inside path segments (e.g. oci:// quay.io/...).\n  if (parts.length < 2 || parts.some(part => part === '' || /\\s/.test(part))) {\n    const sanitized = Array.from(target)\n      .filter(c => c.charCodeAt(0) > 0x1f)\n      .join('')\n      .slice(0, 200);\n    return [\n      `${ANNOTATION_SOURCE_LOCATION} target '${sanitized}' is not a valid ` +\n        `OCI reference; expected format ` +\n        `url:oci://registry/repository[:tag|@digest]`,\n    ];\n  }\n\n  return [];\n}\n"],"names":["ANNOTATION_SOURCE_LOCATION","parseLocationRef"],"mappings":";;;;AAmCO,SAAS,iBAAiB,MAAA,EAA0B;AACzD,EAAA,MAAM,UAAA,GAAa,MAAA,CAAO,QAAA,EAAU,WAAA,GAAcA,uCAA0B,CAAA;AAE5E,EAAA,IAAI,UAAA,KAAe,MAAA,IAAa,UAAA,KAAe,IAAA,EAAM;AACnD,IAAA,OAAO,EAAC;AAAA,EACV;AAEA,EAAA,IAAI,IAAA;AACJ,EAAA,IAAI,MAAA;AACJ,EAAA,IAAI;AACF,IAAA,CAAC,EAAE,IAAA,EAAM,MAAA,EAAO,GAAIC,8BAAiB,UAAU,CAAA;AAAA,EACjD,CAAA,CAAA,MAAQ;AAGN,IAAA,OAAO,EAAC;AAAA,EACV;AAKA,EAAA,IAAI,SAAS,KAAA,EAAO;AAClB,IAAA,MAAM,SAAA,GAAY,MAAM,IAAA,CAAK,UAAA,CAAW,MAAM,CAAA,CAC3C,OAAO,CAAA,CAAA,KAAK,CAAA,CAAE,WAAW,CAAC,CAAA,GAAI,EAAI,CAAA,CAClC,IAAA,CAAK,EAAE,CAAA,CACP,KAAA,CAAM,GAAG,GAAG,CAAA;AACf,IAAA,OAAO;AAAA,MACL,CAAA,EAAGD,uCAA0B,CAAA,EAAA,EAAK,SAAS,CAAA,6HAAA;AAAA,KAG7C;AAAA,EACF;AAIA,EAAA,IAAI,SAAS,KAAA,IAAS,CAAC,MAAA,CAAO,UAAA,CAAW,QAAQ,CAAA,EAAG;AAClD,IAAA,OAAO,EAAC;AAAA,EACV;AAEA,EAAA,MAAM,OAAA,GAAU,MAAA,CAAO,KAAA,CAAM,QAAA,CAAS,MAAM,CAAA;AAE5C,EAAA,IAAI,YAAY,EAAA,EAAI;AAClB,IAAA,OAAO;AAAA,MACL,GAAGA,uCAA0B,CAAA,0GAAA;AAAA,KAE/B;AAAA,EACF;AAEA,EAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,KAAA,CAAM,GAAG,CAAA;AAI/B,EAAA,IAAI,KAAA,CAAM,MAAA,GAAS,CAAA,IAAK,KAAA,CAAM,IAAA,CAAK,CAAA,IAAA,KAAQ,IAAA,KAAS,EAAA,IAAM,IAAA,CAAK,IAAA,CAAK,IAAI,CAAC,CAAA,EAAG;AAC1E,IAAA,MAAM,YAAY,KAAA,CAAM,IAAA,CAAK,MAAM,CAAA,CAChC,MAAA,CAAO,OAAK,CAAA,CAAE,UAAA,CAAW,CAAC,CAAA,GAAI,EAAI,CAAA,CAClC,IAAA,CAAK,EAAE,CAAA,CACP,KAAA,CAAM,GAAG,GAAG,CAAA;AACf,IAAA,OAAO;AAAA,MACL,CAAA,EAAGA,uCAA0B,CAAA,SAAA,EAAY,SAAS,CAAA,2FAAA;AAAA,KAGpD;AAAA,EACF;AAEA,EAAA,OAAO,EAAC;AACV;;;;"}

package/dist/index.cjs.js

@@ -0,0 +1,13 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var module$1 = require('./module.cjs.js');
+var AIResourceExtensionsProcessor = require('./AIResourceExtensionsProcessor.cjs.js');
+
+
+
+exports.default = module$1.catalogModuleCatalogBackendModuleAiResourceExtensions;
+exports.AIResourceExtensionsProcessor = AIResourceExtensionsProcessor.AIResourceExtensionsProcessor;
+exports.VALID_AI_RESOURCE_SCOPES = AIResourceExtensionsProcessor.VALID_AI_RESOURCE_SCOPES;
+//# 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,57 @@
+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';
+
+/**
+ * catalogModuleCatalogBackendModuleAiResourceExtensions is the catalog-backend-module-ai-resource-extensions backend module for the catalog plugin.
+ *
+ * Registers {@link AIResourceExtensionsProcessor}, which validates all
+ * RHDH extension constraints (spec.scope and OCI source-location) and
+ * aggregates errors into a single response.
+ *
+ * @public
+ */
+declare const catalogModuleCatalogBackendModuleAiResourceExtensions: _backstage_backend_plugin_api.BackendFeature;
+
+/**
+ * Valid values for spec.scope on AIResource entities.
+ *
+ * @public
+ */
+declare const VALID_AI_RESOURCE_SCOPES: readonly ["organization", "product", "team"];
+/**
+ * Type for valid AIResource scope values.
+ *
+ * @public
+ */
+type AIResourceScope = (typeof VALID_AI_RESOURCE_SCOPES)[number];
+/**
+ * A CatalogProcessor that validates RHDH-specific extension
+ * fields on AIResource entities.
+ *
+ * Validates:
+ * - `spec.scope`: optional field restricted to 'organization',
+ *   'product', or 'team'
+ * - `backstage.io/source-location`: OCI URI format when the
+ *   location-ref target uses the `oci://` scheme
+ *
+ * All constraint violations are collected and reported in a single
+ * error rather than stopping at the first failure.
+ *
+ * @public
+ */
+declare class AIResourceExtensionsProcessor implements CatalogProcessor {
+    getProcessorName(): string;
+    preProcessEntity(entity: Entity, _location: LocationSpec, _emit: CatalogProcessorEmit): Promise<Entity>;
+}
+
+/**
+ * The catalog-backend-module-ai-resource-extensions backend module for the catalog plugin.
+ *
+ * @packageDocumentation
+ */
+
+
+export { AIResourceExtensionsProcessor, VALID_AI_RESOURCE_SCOPES, catalogModuleCatalogBackendModuleAiResourceExtensions as default };
+export type { AIResourceScope };

package/dist/module.cjs.js

@@ -0,0 +1,23 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var pluginCatalogNode = require('@backstage/plugin-catalog-node');
+var AIResourceExtensionsProcessor = require('./AIResourceExtensionsProcessor.cjs.js');
+
+const catalogModuleCatalogBackendModuleAiResourceExtensions = backendPluginApi.createBackendModule({
+  pluginId: "catalog",
+  moduleId: "catalog-backend-module-ai-resource-extensions",
+  register(reg) {
+    reg.registerInit({
+      deps: {
+        catalog: pluginCatalogNode.catalogProcessingExtensionPoint
+      },
+      async init({ catalog }) {
+        catalog.addProcessor(new AIResourceExtensionsProcessor.AIResourceExtensionsProcessor());
+      }
+    });
+  }
+});
+
+exports.catalogModuleCatalogBackendModuleAiResourceExtensions = catalogModuleCatalogBackendModuleAiResourceExtensions;
+//# 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":["/*\n * Copyright Red Hat, Inc.\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 { createBackendModule } from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node';\n\nimport { AIResourceExtensionsProcessor } from './AIResourceExtensionsProcessor';\n\n/**\n * catalogModuleCatalogBackendModuleAiResourceExtensions is the catalog-backend-module-ai-resource-extensions backend module for the catalog plugin.\n *\n * Registers {@link AIResourceExtensionsProcessor}, which validates all\n * RHDH extension constraints (spec.scope and OCI source-location) and\n * aggregates errors into a single response.\n *\n * @public\n */\nexport const catalogModuleCatalogBackendModuleAiResourceExtensions =\n  createBackendModule({\n    pluginId: 'catalog',\n    moduleId: 'catalog-backend-module-ai-resource-extensions',\n    register(reg) {\n      reg.registerInit({\n        deps: {\n          catalog: catalogProcessingExtensionPoint,\n        },\n        async init({ catalog }) {\n          catalog.addProcessor(new AIResourceExtensionsProcessor());\n        },\n      });\n    },\n  });\n"],"names":["createBackendModule","catalogProcessingExtensionPoint","AIResourceExtensionsProcessor"],"mappings":";;;;;;AA6BO,MAAM,wDACXA,oCAAA,CAAoB;AAAA,EAClB,QAAA,EAAU,SAAA;AAAA,EACV,QAAA,EAAU,+CAAA;AAAA,EACV,SAAS,GAAA,EAAK;AACZ,IAAA,GAAA,CAAI,YAAA,CAAa;AAAA,MACf,IAAA,EAAM;AAAA,QACJ,OAAA,EAASC;AAAA,OACX;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,OAAA,EAAQ,EAAG;AACtB,QAAA,OAAA,CAAQ,YAAA,CAAa,IAAIC,2DAAA,EAA+B,CAAA;AAAA,MAC1D;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;;;;"}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@red-hat-developer-hub/backstage-plugin-catalog-backend-module-ai-resource-extensions",
+  "version": "0.4.0",
+  "license": "Apache-2.0",
+  "description": "The catalog-backend-module-ai-resource-extensions backend module for the catalog plugin.",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/redhat-developer/rhdh-plugins",
+    "directory": "workspaces/ai-integrations/plugins/catalog-backend-module-ai-resource-extensions"
+  },
+  "backstage": {
+    "role": "backend-plugin-module",
+    "pluginId": "catalog",
+    "pluginPackage": "@backstage/plugin-catalog-backend",
+    "features": {
+      ".": "@backstage/BackendFeature"
+    }
+  },
+  "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.9.2",
+    "@backstage/catalog-model": "^1.9.0",
+    "@backstage/plugin-catalog-common": "^1.1.10",
+    "@backstage/plugin-catalog-node": "^2.2.2"
+  },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "^1.11.4",
+    "@backstage/cli": "^0.36.3"
+  },
+  "files": [
+    "dist"
+  ],
+  "typesVersions": {
+    "*": {
+      "package.json": [
+        "package.json"
+      ]
+    }
+  }
+}