@dropsh/plugin-display-builder 0.1.0

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,24 @@
+# Display Builder DropSH Plugin
+
+Extends JSON:API operation schemas for entity view displays managed by Display Builder.
+
+## Drupal Requirements
+
+Enable these Drupal modules on the target site:
+
+- `display_builder`
+- `display_builder_entity_view`
+- `jsonapi_sdc`
+
+## Metadata Sources
+
+The plugin reads Display Builder metadata from standard JSON:API config resources:
+
+```http
+GET /jsonapi/entity_view_display/entity_view_display?filter[drupal_internal__id]={entity_type}.{bundle}.{view_mode}
+GET /jsonapi/display_builder_profile/display_builder_profile?filter[drupal_internal__id]={profile_id}
+```
+
+The factory requests the `default` view mode while building operation schemas. Component metadata
+comes from `jsonapi_sdc`; Display Builder profile `component_library` settings are emitted as
+schema metadata so clients can derive the configured component selection without a patched endpoint.

package/dist/plugins/display-builder/src/index.js

@@ -0,0 +1,30 @@
+import { fetchSdcComponents } from "@dropsh/sdc-client";
+import { HttpError } from "dropsh/plugin";
+import { fetchDisplayBuilderMetadata } from "./metadata-client.js";
+import { extendDisplayBuilderSchema } from "./schema.js";
+export function displayBuilderPlugin() {
+    return {
+        id: "display-builder",
+        requiredModules: ["display_builder", "display_builder_entity_view", "jsonapi_sdc"],
+        async extendSchema(_entityType, _bundle, schema) {
+            return schema;
+        },
+        async extendOperationSchema(entityType, bundle, _operation, schema, ctx) {
+            const metadata = await fetchDisplayBuilderMetadata(ctx, entityType, bundle, "default");
+            if (!metadata.enabled || !metadata.overrideField) {
+                return schema;
+            }
+            let components;
+            try {
+                components = await fetchSdcComponents(ctx);
+            }
+            catch (err) {
+                if (err instanceof HttpError && err.status === 404) {
+                    throw new HttpError(404, "Display Builder plugin requires Drupal module jsonapi_sdc to build component schemas.", err.body);
+                }
+                throw err;
+            }
+            return extendDisplayBuilderSchema(schema, metadata, components);
+        },
+    };
+}

package/dist/plugins/display-builder/src/metadata-client.js

@@ -0,0 +1,98 @@
+import { HttpError } from "dropsh/plugin";
+const invalidJsonMessage = "Display Builder JSON:API config response did not return valid JSON.";
+const invalidMetadataObjectMessage = "Display Builder JSON:API config response did not return a valid object.";
+function asObject(value) {
+    if (typeof value !== "object" || value === null || Array.isArray(value)) {
+        return {};
+    }
+    return value;
+}
+function isObject(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function asString(value, fallback = "") {
+    return typeof value === "string" ? value : fallback;
+}
+async function fetchJson(ctx, url) {
+    const request = await ctx.auth.apply({
+        method: "GET",
+        url,
+        headers: { Accept: "application/vnd.api+json" },
+    });
+    const response = await ctx.http.send(request);
+    let body;
+    try {
+        body = JSON.parse(response.body);
+    }
+    catch {
+        throw new HttpError(502, invalidJsonMessage, response.body);
+    }
+    if (!isObject(body)) {
+        throw new HttpError(502, invalidMetadataObjectMessage, body);
+    }
+    return body;
+}
+function singleResource(body) {
+    if (!Array.isArray(body.data) || body.data.length === 0) {
+        return null;
+    }
+    return asObject(body.data[0]);
+}
+async function fetchJsonApiConfigResource(ctx, resourceType, internalId) {
+    const baseUrl = ctx.baseUrl.replace(/\/+$/, "");
+    const body = await fetchJson(ctx, `${baseUrl}/jsonapi/${resourceType}/${resourceType}?filter%5Bdrupal_internal__id%5D=${encodeURIComponent(internalId)}`);
+    const resource = singleResource(body);
+    return resource ? asObject(resource.attributes) : null;
+}
+function configLabel(config, fallback) {
+    return asString(config.label, fallback);
+}
+function profileSummary(id, config) {
+    return {
+        id,
+        label: configLabel(config ?? {}, id),
+    };
+}
+/**
+ * Fetches Display Builder schema metadata from standard JSON:API config
+ * resources: entity_view_display and display_builder_profile.
+ */
+export async function fetchDisplayBuilderMetadata(ctx, entityType, bundle, viewMode = "default") {
+    const display = await fetchJsonApiConfigResource(ctx, "entity_view_display", `${entityType}.${bundle}.${viewMode}`);
+    if (!display) {
+        return { enabled: false };
+    }
+    const displayBuilderSettings = asObject(asObject(display.third_party_settings).display_builder);
+    const profileId = asString(displayBuilderSettings.profile);
+    if (!profileId) {
+        return { enabled: false };
+    }
+    const profile = await fetchJsonApiConfigResource(ctx, "display_builder_profile", profileId);
+    if (!profile) {
+        return { enabled: false };
+    }
+    const overrideProfileId = asString(displayBuilderSettings.override_profile, profileId);
+    const overrideProfile = overrideProfileId && overrideProfileId !== profileId
+        ? await fetchJsonApiConfigResource(ctx, "display_builder_profile", overrideProfileId)
+        : profile;
+    const componentLibrary = asObject(asObject(profile.islands).component_library);
+    return {
+        enabled: true,
+        entityType: asString(display.targetEntityType, entityType),
+        bundle: asString(display.bundle, bundle),
+        viewMode: asString(display.mode, viewMode),
+        profile: profileSummary(profileId, profile),
+        profileConfig: profile,
+        overrideField: asString(displayBuilderSettings.override_field),
+        ...(overrideProfileId
+            ? {
+                overrideProfile: profileSummary(overrideProfileId, overrideProfile),
+                overrideProfileConfig: overrideProfile,
+            }
+            : {}),
+        ...(displayBuilderSettings.sources !== undefined
+            ? { sourceTree: displayBuilderSettings.sources }
+            : {}),
+        componentLibrary,
+    };
+}

package/dist/plugins/display-builder/src/schema.js

@@ -0,0 +1,77 @@
+function cloneValue(value) {
+    if (value === undefined) {
+        return value;
+    }
+    return JSON.parse(JSON.stringify(value));
+}
+function cloneSchema(schema) {
+    return cloneValue(schema);
+}
+function ensureObjectProperty(parent, key) {
+    parent.properties ??= {};
+    const properties = parent.properties;
+    properties[key] ??= { type: "object" };
+    const child = properties[key];
+    child.type ??= "object";
+    child.properties ??= {};
+    return child;
+}
+function idValue(value) {
+    if (typeof value === "string") {
+        return value;
+    }
+    if (typeof value === "object" && value !== null && !Array.isArray(value)) {
+        const id = value.id;
+        return typeof id === "string" ? id : undefined;
+    }
+    return undefined;
+}
+function sourceTreeSchema() {
+    return {
+        type: "array",
+        description: "Display Builder source tree for the configured entity-view override field.",
+        items: {
+            type: "object",
+            additionalProperties: true,
+        },
+    };
+}
+function componentMetadata(component) {
+    return {
+        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 extendDisplayBuilderSchema(baseSchema, metadata, components) {
+    if (!metadata.enabled || !metadata.overrideField) {
+        return baseSchema;
+    }
+    const schema = cloneSchema(baseSchema);
+    const data = ensureObjectProperty(schema, "data");
+    const attributes = ensureObjectProperty(data, "attributes");
+    const activeMetadata = metadata;
+    const attributeProperties = attributes.properties;
+    const sortedComponents = [...components].sort((a, b) => a.id.localeCompare(b.id));
+    attributeProperties[activeMetadata.overrideField] = sourceTreeSchema();
+    schema["x-dropsh-builder"] = "display-builder";
+    schema["x-dropsh-display-builder"] = {
+        entity_type: activeMetadata.entityType,
+        bundle: activeMetadata.bundle,
+        view_mode: activeMetadata.viewMode,
+        profile: idValue(activeMetadata.profile),
+        profile_config: cloneValue(activeMetadata.profileConfig),
+        override_field: activeMetadata.overrideField,
+        override_profile: idValue(activeMetadata.overrideProfile),
+        override_profile_config: cloneValue(activeMetadata.overrideProfileConfig),
+        source_tree: cloneValue(activeMetadata.sourceTree),
+        component_library: cloneValue(activeMetadata.componentLibrary),
+    };
+    schema["x-dropsh-components"] = sortedComponents.map(componentMetadata);
+    return schema;
+}

package/package.json

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