@dropsh/plugin-schemata 0.0.2 → 0.1.1

package/README.md

@@ -3,11 +3,14 @@
 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.
+dropsh works without this plugin. By default it derives a shallow schema from
+JSON:API sample records, which is enough to discover field names but does not
+know Drupal's required fields or constraints.
+
+With this plugin installed, `dropsh schema` reads the **authoritative** schema
+from Drupal's `schemata` module. The generated schema is more precise, so
+client-side validation in `create` / `update` can catch invalid payloads before
+they are sent to Drupal.
 
 ## Install
 
@@ -40,7 +43,23 @@ falls back to the base schema.
 ## Required Drupal modules
 
 - [`schemata`](https://www.drupal.org/project/schemata)
-- `jsonapi_schema` (provided by the schemata project)
+- `schemata_json_schema` (submodule of the schemata project)
+
+Install and enable both on the Drupal site:
+
+```bash
+composer require drupal/schemata
+drush en schemata schemata_json_schema
+```
+
+Grant the role used by dropsh access to the Schemata data model endpoint:
+
+```bash
+drush role:perm:add "content_editor" "access schemata data models"
+```
+
+For OAuth2, grant the permission to the user role or client credential access
+context used by the configured auth provider.
 
 ## License
 

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

@@ -3,7 +3,7 @@ import { fetchSchemata, SCHEMATA_MISS } from "./schemata.js";
 export function schemataPlugin() {
     return {
         id: "schemata",
-        requiredModules: ["schemata", "jsonapi_schema"],
+        requiredModules: ["schemata", "schemata_json_schema"],
         async extendSchema(entityType, bundle, baseSchema, ctx) {
             let result;
             try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dropsh/plugin-schemata",
-  "version": "0.0.2",
+  "version": "0.1.1",
   "type": "module",
   "main": "./dist/plugins/schemata/src/index.js",
   "exports": {
@@ -19,7 +19,7 @@
   "devDependencies": {
     "typescript": "^5.6.0",
     "vitest": "^4.1.8",
-    "dropsh": "0.0.2"
+    "dropsh": "0.1.1"
   },
   "scripts": {
     "build": "tsc",