@dropsh/sdc-client 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,40 @@
+# @dropsh/sdc-client
+
+Single Directory Components (SDC) client for [dropsh](https://github.com/pen-drop/dropsh),
+the entity-agnostic CLI for Drupal 11 JSON:API.
+
+A small library that fetches and types a Drupal site's SDC component definitions
+via the `jsonapi_sdc` module. It is the building block used by
+[`@dropsh/plugin-canvas`](https://www.npmjs.com/package/@dropsh/plugin-canvas) to
+build Canvas component schemas; you normally depend on it transitively rather than
+directly.
+
+## Install
+
+```bash
+pnpm add @dropsh/sdc-client
+```
+
+`dropsh` is a peer dependency.
+
+## Usage
+
+```ts
+import { fetchSdcComponents, type SdcComponent } from "@dropsh/sdc-client";
+import type { PluginContext } from "dropsh/plugin";
+
+async function listComponents(ctx: PluginContext): Promise<SdcComponent[]> {
+  return fetchSdcComponents(ctx); // uses ctx.http / ctx.auth / ctx.baseUrl
+}
+```
+
+`fetchSdcComponents` throws an `HttpError` (status 404) when `jsonapi_sdc` is not
+installed or reachable.
+
+## Required Drupal module
+
+- `jsonapi_sdc`
+
+## License
+
+MIT OR GPL-2.0-or-later

package/dist/packages/sdc-client/src/index.d.ts

@@ -0,0 +1,24 @@
+import { type PluginContext } from "dropsh/plugin";
+export interface SdcComponent {
+    id: string;
+    jsonapiId: string;
+    name: string;
+    description: string;
+    status: string;
+    provider: string;
+    props: Record<string, unknown>;
+    slots: Record<string, unknown>;
+    variants: Record<string, unknown>;
+}
+/**
+ * Normalises a Drupal SDC id (e.g. "olivero:teaser") into the dotted form
+ * used by dropsh schemas: "sdc.<provider>.<name>".
+ */
+export declare function toSdcComponentId(sdcId: string): string;
+/**
+ * Fetches all SDC components from the Drupal jsonapi_sdc endpoint and
+ * returns them as a normalised list. Throws a `404 HttpError` with a clear
+ * message if jsonapi_sdc is not installed, and `502`/`422` HttpErrors for
+ * malformed or empty responses.
+ */
+export declare function fetchSdcComponents(ctx: PluginContext): Promise<SdcComponent[]>;

package/dist/packages/sdc-client/src/index.js

@@ -0,0 +1,83 @@
+import { HttpError } from "dropsh/plugin";
+const invalidJsonApiMessage = "jsonapi_sdc did not return a valid JSON:API document.";
+function asObject(value) {
+    if (typeof value !== "object" || value === null || Array.isArray(value)) {
+        return {};
+    }
+    return value;
+}
+function asString(value, fallback) {
+    return typeof value === "string" && value.length > 0 ? value : fallback;
+}
+/**
+ * Normalises a Drupal SDC id (e.g. "olivero:teaser") into the dotted form
+ * used by dropsh schemas: "sdc.<provider>.<name>".
+ */
+export function toSdcComponentId(sdcId) {
+    const [provider, name] = sdcId.split(":", 2);
+    if (!provider || !name) {
+        return `sdc.${sdcId.replace(/:/g, ".")}`;
+    }
+    return `sdc.${provider}.${name}`;
+}
+function normalizeResource(resource) {
+    const attributes = resource.attributes ?? {};
+    const id = asString(attributes.drupal_internal__id, "");
+    if (!id.includes(":")) {
+        return null;
+    }
+    const provider = asString(attributes.provider, id.split(":", 1)[0] ?? "");
+    return {
+        id,
+        jsonapiId: asString(resource.id, id.replace(/:/g, "--")),
+        name: asString(attributes.name, id),
+        description: asString(attributes.description, ""),
+        status: asString(attributes.status, "stable"),
+        provider,
+        props: asObject(attributes.props),
+        slots: asObject(attributes.slots),
+        variants: asObject(attributes.variants),
+    };
+}
+/**
+ * Fetches all SDC components from the Drupal jsonapi_sdc endpoint and
+ * returns them as a normalised list. Throws a `404 HttpError` with a clear
+ * message if jsonapi_sdc is not installed, and `502`/`422` HttpErrors for
+ * malformed or empty responses.
+ */
+export async function fetchSdcComponents(ctx) {
+    const request = await ctx.auth.apply({
+        method: "GET",
+        url: `${ctx.baseUrl.replace(/\/+$/, "")}/jsonapi/sdc_component`,
+        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 jsonapi_sdc is required to fetch SDC components.", error.body);
+        }
+        throw error;
+    }
+    let body;
+    try {
+        body = JSON.parse(response.body);
+    }
+    catch {
+        throw new HttpError(502, invalidJsonApiMessage, response.body);
+    }
+    if (typeof body !== "object" || body === null || Array.isArray(body)) {
+        throw new HttpError(502, invalidJsonApiMessage, body);
+    }
+    const jsonApiBody = body;
+    const resources = Array.isArray(jsonApiBody.data) ? jsonApiBody.data : [];
+    const components = resources
+        .map((resource) => normalizeResource(asObject(resource)))
+        .filter((component) => component !== null);
+    if (components.length === 0) {
+        throw new HttpError(422, "jsonapi_sdc returned no SDC components.", jsonApiBody);
+    }
+    return components;
+}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@dropsh/sdc-client",
+  "version": "0.0.2",
+  "type": "module",
+  "main": "./dist/packages/sdc-client/src/index.js",
+  "types": "./dist/packages/sdc-client/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/packages/sdc-client/src/index.d.ts",
+      "default": "./dist/packages/sdc-client/src/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/packages/sdc-client/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"
+  }
+}