@dropsh/plugin-jsonapi-schema 0.5.5 → 0.5.6

package/dist/plugins/jsonapi-schema/src/index.d.ts

@@ -0,0 +1,14 @@
+import type { DropSHPlugin } from "dropsh/plugin";
+/**
+ * Authoritative JSON:API write-schema source backed by the Drupal
+ * `jsonapi_schema` module (works on Drupal 10.1+/11 + PHP 8.4, unlike the
+ * dead `schemata_json_schema` endpoint which 500s there).
+ *
+ * Outcomes are distinguished instead of collapsed into one silent fallback:
+ * - 200 → the derived write schema replaces the heuristic base.
+ * - 404 → the module/route is absent; fall back to the heuristic base **and**
+ *   warn why (so the user knows the constraint-bearing schema is missing).
+ * - any other status / unparseable body → the endpoint is broken; fall back to
+ *   the heuristic base **and** warn visibly. Never swallowed silently.
+ */
+export declare function jsonapiSchemaPlugin(): DropSHPlugin;

package/dist/plugins/jsonapi-schema/src/jsonapi-schema.d.ts

@@ -0,0 +1,37 @@
+import type { AuthAdapter, HttpClient } from "dropsh/plugin";
+/** Sentinel returned when the jsonapi_schema route is absent (HTTP 404). */
+export declare const JSONAPI_SCHEMA_MISS: unique symbol;
+export interface FetchJsonapiSchemaDeps {
+    http: HttpClient;
+    auth: AuthAdapter;
+    baseUrl: string;
+    jsonapiPrefix: string;
+    entity: string;
+    bundle: string;
+}
+/**
+ * Fetch the resource-object schema for a bundle from the jsonapi_schema module.
+ *
+ * Route (dynamic, registered by jsonapi_schema): the resource-object schema
+ * lives at `{jsonapiPrefix}/{entity}/{bundle}/resource/schema`. It describes a
+ * single JSON:API resource object (type + attributes + relationships), which is
+ * exactly what a create/update payload's `data` member must satisfy.
+ *
+ * Returns the parsed schema on 200, {@link JSONAPI_SCHEMA_MISS} on 404 (module
+ * or route absent), and throws on any other HTTP status (a broken endpoint must
+ * be surfaced, never silently swallowed) or an unparseable body.
+ */
+export declare function fetchJsonapiSchema(deps: FetchJsonapiSchemaDeps): Promise<unknown | typeof JSONAPI_SCHEMA_MISS>;
+/**
+ * Transform a jsonapi_schema resource-object schema into a JSON Schema that
+ * validates a dropsh create/update payload — a JSON:API document envelope
+ * `{ data: { type, id, attributes, relationships } }`.
+ *
+ * The module emits `{ allOf: [ { properties: { type, attributes, relationships }
+ * (local $refs) }, { $ref: "https://jsonapi.org/schema#/definitions/resource" } ],
+ * definitions: {...} }`. We inline the local definitions, drop the external
+ * jsonapi.org `$ref` (Ajv cannot fetch it), and wrap the resource object as the
+ * `data` member. dropsh's `toOperationVariant` later tailors `required` per
+ * operation, so we only assert the resource `type` here.
+ */
+export declare function buildWriteSchema(resourceSchema: unknown): unknown;

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "@dropsh/plugin-jsonapi-schema",
-  "version": "0.5.5",
+  "version": "0.5.6",
   "type": "module",
   "main": "./dist/plugins/jsonapi-schema/src/index.js",
+  "types": "./dist/plugins/jsonapi-schema/src/index.d.ts",
   "exports": {
-    ".": "./dist/plugins/jsonapi-schema/src/index.js"
+    ".": {
+      "types": "./dist/plugins/jsonapi-schema/src/index.d.ts",
+      "default": "./dist/plugins/jsonapi-schema/src/index.js"
+    }
   },
   "files": [
     "dist/plugins/jsonapi-schema/src",
@@ -19,7 +23,7 @@
   "devDependencies": {
     "typescript": "^5.6.0",
     "vitest": "^4.1.8",
-    "dropsh": "0.5.5"
+    "dropsh": "0.5.6"
   },
   "scripts": {
     "build": "tsc",