@dropsh/plugin-canvas 0.0.2

package/LICENSE

@@ -0,0 +1,51 @@
+drupal-cli is dual-licensed. You may use this software under the terms of
+either the MIT License or the GNU General Public License version 2 or any
+later version, at your option.
+
+SPDX-License-Identifier: (MIT OR GPL-2.0-or-later)
+
+================================================================================
+MIT License
+================================================================================
+
+Copyright (c) 2026 Christian Wiedemann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+================================================================================
+GNU General Public License, version 2 or later
+================================================================================
+
+The full text of the GNU GPL v2 is available at:
+  https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
+
+The full text of any later GPL version is available at:
+  https://www.gnu.org/licenses/
+
+Copyright (C) 2026 Christian Wiedemann
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation; either version 2 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+details.

package/README.md

@@ -0,0 +1,47 @@
+# @dropsh/plugin-canvas
+
+Canvas component schemas for [dropsh](https://github.com/pen-drop/dropsh), the
+entity-agnostic CLI for Drupal 11 JSON:API.
+
+Extends the `dropsh schema` output for Canvas pages with a typed
+`attributes.components` array built from the site's Single Directory Components
+(SDC), so `create` / `update` payloads for `canvas_page` can be validated against
+the real component set.
+
+## Install
+
+```bash
+pnpm add @dropsh/plugin-canvas
+```
+
+`dropsh` is a peer dependency. The plugin depends on `@dropsh/sdc-client`
+(installed automatically).
+
+## Usage
+
+```js
+import { canvasPlugin } from "@dropsh/plugin-canvas";
+
+export default {
+  site: { base_url: "https://my-drupal.example.com", jsonapi_prefix: "/jsonapi" },
+  plugins: [canvasPlugin()],
+};
+```
+
+```bash
+dropsh schema canvas_page/canvas_page --for=create
+```
+
+The returned JSON Schema includes `x-dropsh-builder: "canvas"`,
+`x-dropsh-components`, and a typed `attributes.components` array. If `jsonapi_sdc`
+is missing or inaccessible, the Canvas schema **fails** (rather than returning
+incomplete component information) so you never validate against a partial set.
+
+## Required Drupal modules
+
+- `canvas`
+- `jsonapi_sdc`
+
+## License
+
+MIT OR GPL-2.0-or-later

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

@@ -0,0 +1,87 @@
+import { toSdcComponentId } from "@dropsh/sdc-client";
+function cloneValue(value) {
+    return JSON.parse(JSON.stringify(value));
+}
+function cloneSchema(schema) {
+    return cloneValue(schema);
+}
+function ensureObjectProperty(parent, key) {
+    parent.properties ??= {};
+    parent.properties[key] ??= { type: "object" };
+    const child = parent.properties[key];
+    child.type ??= "object";
+    child.properties ??= {};
+    return child;
+}
+function slotNames(components) {
+    return [...new Set(components.flatMap((component) => Object.keys(component.slots)))].sort();
+}
+function inputSchema(component) {
+    const props = Object.keys(component.props).length > 0
+        ? cloneValue(component.props)
+        : { properties: {}, additionalProperties: true };
+    return {
+        ...props,
+        type: "object",
+        description: `Inputs for ${toSdcComponentId(component.id)} (${component.name})`,
+    };
+}
+function slotSchema(knownSlots) {
+    return {
+        type: ["string", "null"],
+        enum: knownSlots.length > 0 ? [null, ...knownSlots] : [null],
+        description: knownSlots.length > 0
+            ? `Known SDC slot names: ${knownSlots.join(", ")}. Use null for root components.`
+            : "No SDC slots were reported by jsonapi_sdc. Use null for root components.",
+    };
+}
+function componentItemVariant(component, knownSlots) {
+    return {
+        type: "object",
+        additionalProperties: false,
+        properties: {
+            uuid: { type: "string", format: "uuid" },
+            component_id: { type: "string", const: toSdcComponentId(component.id) },
+            parent_uuid: { type: ["string", "null"], format: "uuid" },
+            slot: slotSchema(knownSlots),
+            inputs: inputSchema(component),
+            label: { type: ["string", "null"] },
+        },
+        required: ["uuid", "component_id", "inputs"],
+    };
+}
+function componentMetadata(component) {
+    return {
+        id: toSdcComponentId(component.id),
+        source_id: component.id,
+        name: component.name,
+        description: component.description,
+        provider: component.provider,
+        status: component.status,
+        props: cloneValue(component.props),
+        slots: cloneValue(component.slots),
+        variants: cloneValue(component.variants),
+    };
+}
+export function extendCanvasSchema(baseSchema, operation, components) {
+    const schema = cloneSchema(baseSchema);
+    const data = ensureObjectProperty(schema, "data");
+    if (operation === "update") {
+        data.required = ["type", "id"];
+    }
+    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));
+    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.",
+        items: {
+            oneOf: componentItemVariants,
+        },
+    };
+    schema["x-dropsh-builder"] = "canvas";
+    schema["x-dropsh-components"] = components.map(componentMetadata);
+    return schema;
+}

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

@@ -0,0 +1,28 @@
+import { fetchSdcComponents } from "@dropsh/sdc-client";
+import { HttpError } from "dropsh/plugin";
+import { extendCanvasSchema } from "./canvas-schema.js";
+export function canvasPlugin() {
+    return {
+        id: "canvas",
+        requiredModules: ["canvas", "jsonapi_sdc"],
+        async extendSchema(_entityType, _bundle, schema) {
+            return schema;
+        },
+        async extendOperationSchema(entityType, bundle, operation, schema, ctx) {
+            if (entityType !== "canvas_page" || bundle !== "canvas_page") {
+                return schema;
+            }
+            let components;
+            try {
+                components = await fetchSdcComponents(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 err;
+            }
+            return extendCanvasSchema(schema, operation, components);
+        },
+    };
+}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@dropsh/plugin-canvas",
+  "version": "0.0.2",
+  "type": "module",
+  "main": "./dist/plugins/canvas/src/index.js",
+  "exports": {
+    ".": "./dist/plugins/canvas/src/index.js"
+  },
+  "files": [
+    "dist/plugins/canvas/src",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "dropsh": "*"
+  },
+  "dependencies": {
+    "@dropsh/sdc-client": "0.0.2"
+  },
+  "devDependencies": {
+    "typescript": "^5.6.0",
+    "vitest": "^4.1.8",
+    "dropsh": "0.0.2"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run --passWithNoTests",
+    "typecheck": "tsc --noEmit"
+  }
+}