@dropsh/plugin-canvas 0.0.2 → 0.1.0

package/dist/plugins/canvas/src/canvas-schema.js

@@ -35,22 +35,27 @@ function slotSchema(knownSlots) {
             : "No SDC slots were reported by jsonapi_sdc. Use null for root components.",
     };
 }
-function componentItemVariant(component, knownSlots) {
+function componentItemVariant(component, knownSlots, version) {
     return {
         type: "object",
         additionalProperties: false,
         properties: {
             uuid: { type: "string", format: "uuid" },
             component_id: { type: "string", const: toSdcComponentId(component.id) },
+            component_version: {
+                type: "string",
+                const: version,
+                description: "Active version hash of the Canvas component config entity.",
+            },
             parent_uuid: { type: ["string", "null"], format: "uuid" },
             slot: slotSchema(knownSlots),
             inputs: inputSchema(component),
             label: { type: ["string", "null"] },
         },
-        required: ["uuid", "component_id", "inputs"],
+        required: ["uuid", "component_id", "component_version", "inputs"],
     };
 }
-function componentMetadata(component) {
+function componentMetadata(component, version) {
     return {
         id: toSdcComponentId(component.id),
         source_id: component.id,
@@ -58,12 +63,13 @@ function componentMetadata(component) {
         description: component.description,
         provider: component.provider,
         status: component.status,
+        version,
         props: cloneValue(component.props),
         slots: cloneValue(component.slots),
         variants: cloneValue(component.variants),
     };
 }
-export function extendCanvasSchema(baseSchema, operation, components) {
+export function extendCanvasSchema(baseSchema, operation, components, versions) {
     const schema = cloneSchema(baseSchema);
     const data = ensureObjectProperty(schema, "data");
     if (operation === "update") {
@@ -71,9 +77,13 @@ export function extendCanvasSchema(baseSchema, operation, components) {
     }
     const attributes = ensureObjectProperty(data, "attributes");
     const knownSlots = slotNames(components);
-    const componentItemVariants = [...components]
-        .sort((a, b) => toSdcComponentId(a.id).localeCompare(toSdcComponentId(b.id)))
-        .map((component) => componentItemVariant(component, knownSlots));
+    const sortedComponents = [...components].sort((a, b) => toSdcComponentId(a.id).localeCompare(toSdcComponentId(b.id)));
+    // Only components with a Canvas `Component` config entity can be placed:
+    // the server validates component_id against that config and requires its
+    // active version hash on every tree item.
+    const componentItemVariants = sortedComponents
+        .filter((component) => versions.has(toSdcComponentId(component.id)))
+        .map((component) => componentItemVariant(component, knownSlots, versions.get(toSdcComponentId(component.id))));
     attributes.properties.components = {
         type: "array",
         description: "Canvas component tree. Root components use parent_uuid=null and slot=null. Child components set parent_uuid to another component uuid and slot to one of the parent's slot names.",
@@ -82,6 +92,6 @@ export function extendCanvasSchema(baseSchema, operation, components) {
         },
     };
     schema["x-dropsh-builder"] = "canvas";
-    schema["x-dropsh-components"] = components.map(componentMetadata);
+    schema["x-dropsh-components"] = components.map((component) => componentMetadata(component, versions.get(toSdcComponentId(component.id)) ?? null));
     return schema;
 }

package/dist/plugins/canvas/src/component-versions.js

@@ -0,0 +1,44 @@
+import { HttpError } from "dropsh/plugin";
+/**
+ * Fetches the Canvas `Component` config entities and returns a map of
+ * component config id (e.g. "sdc.olivero.teaser") to its active version
+ * hash. The server validates `component_version` on every component tree
+ * item against this hash, so payloads cannot be built without it.
+ */
+export async function fetchComponentVersions(ctx) {
+    const versions = new Map();
+    let url = `${ctx.baseUrl.replace(/\/+$/, "")}/jsonapi/component/component`;
+    while (url) {
+        const request = await ctx.auth.apply({
+            method: "GET",
+            url,
+            headers: { Accept: "application/vnd.api+json" },
+        });
+        let response;
+        try {
+            response = await ctx.http.send(request);
+        }
+        catch (error) {
+            if (error instanceof HttpError && error.status === 404) {
+                throw new HttpError(error.status, "Drupal module canvas is required to fetch component versions.", error.body);
+            }
+            throw error;
+        }
+        let body;
+        try {
+            body = JSON.parse(response.body);
+        }
+        catch {
+            throw new HttpError(502, "Invalid JSON:API response from component endpoint.", response.body);
+        }
+        for (const resource of body.data ?? []) {
+            const id = resource.attributes?.drupal_internal__id;
+            const version = resource.attributes?.active_version;
+            if (typeof id === "string" && typeof version === "string" && version.length > 0) {
+                versions.set(id, version);
+            }
+        }
+        url = body.links?.next?.href ?? null;
+    }
+    return versions;
+}

package/dist/plugins/canvas/src/index.js

@@ -1,6 +1,7 @@
 import { fetchSdcComponents } from "@dropsh/sdc-client";
 import { HttpError } from "dropsh/plugin";
 import { extendCanvasSchema } from "./canvas-schema.js";
+import { fetchComponentVersions } from "./component-versions.js";
 export function canvasPlugin() {
     return {
         id: "canvas",
@@ -13,16 +14,20 @@ export function canvasPlugin() {
                 return schema;
             }
             let components;
+            let versions;
             try {
-                components = await fetchSdcComponents(ctx);
+                [components, versions] = await Promise.all([
+                    fetchSdcComponents(ctx),
+                    fetchComponentVersions(ctx),
+                ]);
             }
             catch (err) {
                 if (err instanceof HttpError && err.status === 404) {
-                    throw new HttpError(404, "Canvas plugin requires Drupal module jsonapi_sdc to build component schemas.", err.body);
+                    throw new HttpError(404, "Canvas plugin requires Drupal modules canvas and jsonapi_sdc to build component schemas.", err.body);
                 }
                 throw err;
             }
-            return extendCanvasSchema(schema, operation, components);
+            return extendCanvasSchema(schema, operation, components, versions);
         },
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dropsh/plugin-canvas",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "type": "module",
   "main": "./dist/plugins/canvas/src/index.js",
   "exports": {
@@ -17,12 +17,12 @@
     "dropsh": "*"
   },
   "dependencies": {
-    "@dropsh/sdc-client": "0.0.2"
+    "@dropsh/sdc-client": "0.1.0"
   },
   "devDependencies": {
     "typescript": "^5.6.0",
     "vitest": "^4.1.8",
-    "dropsh": "0.0.2"
+    "dropsh": "0.1.0"
   },
   "scripts": {
     "build": "tsc",