@dropsh/plugin-schemata 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-schemata
+
+Authoritative JSON Schema source for [dropsh](https://github.com/pen-drop/dropsh),
+the entity-agnostic CLI for Drupal 11 JSON:API.
+
+By default dropsh derives a shallow schema from sample records (field names only,
+no required fields or constraints). With this plugin installed, `dropsh schema`
+instead returns the **authoritative** schema from Drupal's `schemata` module —
+with required fields and constraints — so client-side validation in `create` /
+`update` is meaningful.
+
+## Install
+
+```bash
+pnpm add @dropsh/plugin-schemata
+```
+
+`dropsh` is a peer dependency.
+
+## Usage
+
+```js
+import { schemataPlugin } from "@dropsh/plugin-schemata";
+
+export default {
+  site: { base_url: "https://my-drupal.example.com", jsonapi_prefix: "/jsonapi" },
+  plugins: [schemataPlugin()],
+};
+```
+
+```bash
+dropsh schema node/article --for=create
+```
+
+The output carries `x-dropsh-source: "schemata"` when the authoritative schema was
+used (vs `"heuristic"` / `"heuristic-empty"` for the sample-derived fallback). If
+the modules are missing or the endpoint is unreachable, the plugin transparently
+falls back to the base schema.
+
+## Required Drupal modules
+
+- [`schemata`](https://www.drupal.org/project/schemata)
+- `jsonapi_schema` (provided by the schemata project)
+
+## License
+
+MIT OR GPL-2.0-or-later

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

@@ -0,0 +1,28 @@
+import { HttpError } from "dropsh/plugin";
+import { fetchSchemata, SCHEMATA_MISS } from "./schemata.js";
+export function schemataPlugin() {
+    return {
+        id: "schemata",
+        requiredModules: ["schemata", "jsonapi_schema"],
+        async extendSchema(entityType, bundle, baseSchema, ctx) {
+            let result;
+            try {
+                result = await fetchSchemata({
+                    http: ctx.http,
+                    auth: ctx.auth,
+                    baseUrl: ctx.baseUrl,
+                    entity: entityType,
+                    bundle,
+                });
+            }
+            catch (err) {
+                if (err instanceof HttpError)
+                    return baseSchema;
+                throw err;
+            }
+            if (result === SCHEMATA_MISS)
+                return baseSchema;
+            return result;
+        },
+    };
+}

package/dist/plugins/schemata/src/schemata.js

@@ -0,0 +1,21 @@
+import { HttpError } from "dropsh/plugin";
+export const SCHEMATA_MISS = Symbol("SCHEMATA_MISS");
+export async function fetchSchemata(deps) {
+    const base = deps.baseUrl.replace(/\/+$/, "");
+    const url = `${base}/schemata/${deps.entity}/${deps.bundle}?_format=schema_json&_describes=api_json`;
+    const req = await deps.auth.apply({
+        method: "GET",
+        url,
+        headers: { Accept: "application/json" },
+    });
+    let res;
+    try {
+        res = await deps.http.send(req);
+    }
+    catch (err) {
+        if (err instanceof HttpError && err.status === 404)
+            return SCHEMATA_MISS;
+        throw err;
+    }
+    return JSON.parse(res.body);
+}

package/package.json

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