@persona/layout-editor-remote-module 0.10.0 → 0.11.0

package/README.md

@@ -180,3 +180,24 @@ const { modules } = parseRemoteModuleManifest(await response.json());
 It throws `RemoteModuleManifestParseError` (with `.issues` and a prettified `.message`) on a
 malformed document; `safeParseRemoteModuleManifest` returns `{ success, data | error }` instead of
 throwing.
+
+### Rendering a config panel
+
+A host stores a placed module's config under a `config` property, so its RJSF form edits
+`{ config }`. The `./config-form` entry adapts a manifest to that shape, with no React or RJSF
+dependency:
+
+```ts
+import {
+  nestRemoteConfigSchema,
+  nestRemoteUiConfigSchema,
+  remoteConfigDefaults,
+} from '@persona/layout-editor-remote-module/config-form';
+
+const schema = nestRemoteConfigSchema(module.configSchema); // `$ref`s rewritten to match
+const uiSchema = nestRemoteUiConfigSchema(module.uiConfigSchema);
+const initialConfig = remoteConfigDefaults(module.configSchema); // top-level `default`s
+```
+
+Render the form with `schema`, `uiSchema` and `formData: { config }`, and read the edited config
+back from `formData.config`.

package/dist/bridge-frame.d.mts

@@ -1,4 +1,5 @@
-import { n as Json, t as RemoteModuleContext } from "./protocol-Dqnl8JTs.mjs";
+import { t as Json } from "./types-CBSiNsDJ.mjs";
+import { t as RemoteModuleContext } from "./protocol-ClWDYwW2.mjs";
 import { ReactNode } from "react";
 
 //#region src/bridge/origin.d.ts

package/dist/bridge-frame.mjs

@@ -1,4 +1,4 @@
-import { c as resolveAllowedHostOrigins, n as SOURCE, o as candidateParentOrigin, r as parseHostToModuleMessage, s as personaDashboardHostOrigins, t as PROTOCOL_VERSION } from "./protocol-Br3C6FM7.mjs";
+import { c as resolveAllowedHostOrigins, n as SOURCE, o as candidateParentOrigin, r as parseHostToModuleMessage, s as personaDashboardHostOrigins, t as PROTOCOL_VERSION } from "./protocol-BfjTaW1S.mjs";
 import { Component, useEffect, useRef, useState } from "react";
 import { jsx } from "react/jsx-runtime";
 

package/dist/bridge-host.d.mts

@@ -1,4 +1,5 @@
-import { n as Json, t as RemoteModuleContext } from "./protocol-Dqnl8JTs.mjs";
+import { t as Json } from "./types-CBSiNsDJ.mjs";
+import { t as RemoteModuleContext } from "./protocol-ClWDYwW2.mjs";
 import { CSSProperties, ReactNode, Ref } from "react";
 
 //#region src/bridge/host/buildModuleSrc.d.ts

package/dist/bridge-host.mjs

@@ -1,4 +1,4 @@
-import { a as assertNotSelfOrigin, i as parseModuleToHostMessage, n as SOURCE, t as PROTOCOL_VERSION } from "./protocol-Br3C6FM7.mjs";
+import { a as assertNotSelfOrigin, i as parseModuleToHostMessage, n as SOURCE, t as PROTOCOL_VERSION } from "./protocol-BfjTaW1S.mjs";
 import { useCallback, useEffect, useMemo, useRef, useState } from "react";
 import { jsx, jsxs } from "react/jsx-runtime";
 

package/dist/config-form.d.mts

@@ -0,0 +1,23 @@
+import { n as JsonSchemaObject, t as Json } from "./types-CBSiNsDJ.mjs";
+
+//#region src/config-form.d.ts
+
+/** JSON pointer, in the nested schema, of the module's own config schema. */
+declare const REMOTE_CONFIG_POINTER_PREFIX = "#/properties/config";
+/**
+ * Nest a manifest `configSchema` under a top-level `config` property, rewriting `$ref`s so they
+ * still resolve. Drops `$schema` and `$id`; keeps `$defs` / `definitions` at the root.
+ */
+declare function nestRemoteConfigSchema(configSchema: JsonSchemaObject): JsonSchemaObject;
+/**
+ * Nest a manifest `uiConfigSchema` to match {@link nestRemoteConfigSchema}, hiding the wrapper
+ * object's title so the module's fields render as if top level.
+ */
+declare function nestRemoteUiConfigSchema(uiConfigSchema: JsonSchemaObject | undefined): JsonSchemaObject;
+/**
+ * A config holding each top-level `configSchema` property's `default`. Properties without one are
+ * left unset; defaults are cloned so the result can be mutated freely.
+ */
+declare function remoteConfigDefaults(configSchema: JsonSchemaObject | undefined): Record<string, Json>;
+//#endregion
+export { REMOTE_CONFIG_POINTER_PREFIX, nestRemoteConfigSchema, nestRemoteUiConfigSchema, remoteConfigDefaults };

package/dist/config-form.mjs

@@ -0,0 +1,79 @@
+//#region src/config-form.ts
+/** JSON pointer, in the nested schema, of the module's own config schema. */
+const REMOTE_CONFIG_POINTER_PREFIX = "#/properties/config";
+/** Keywords whose values are instance data, never schemas, so a `$ref` key inside them is data. */
+const LITERAL_KEYWORDS = new Set([
+	"const",
+	"default",
+	"enum",
+	"examples"
+]);
+/** Keywords whose values map arbitrary names to schemas, so a name like `default` is a schema. */
+const SCHEMA_MAP_KEYWORDS = new Set([
+	"$defs",
+	"definitions",
+	"dependentSchemas",
+	"patternProperties",
+	"properties"
+]);
+function rewriteSchemaMap(value, schemaId) {
+	if (value == null || typeof value !== "object" || Array.isArray(value)) return value;
+	return Object.fromEntries(Object.entries(value).map(([name, schema]) => [name, rewriteReferences(schema, schemaId)]));
+}
+function rewriteReferences(value, schemaId) {
+	if (Array.isArray(value)) return value.map((item) => rewriteReferences(item, schemaId));
+	if (value == null || typeof value !== "object") return value;
+	return Object.fromEntries(Object.entries(value).map(([key, child]) => {
+		if (key === "$ref" && typeof child === "string") return [key, rewriteReference(child, schemaId)];
+		if (LITERAL_KEYWORDS.has(key)) return [key, child];
+		if (SCHEMA_MAP_KEYWORDS.has(key)) return [key, rewriteSchemaMap(child, schemaId)];
+		return [key, rewriteReferences(child, schemaId)];
+	}));
+}
+function rewriteReference(reference, schemaId) {
+	if (schemaId != null) {
+		if (reference === schemaId) return REMOTE_CONFIG_POINTER_PREFIX;
+		if (reference.startsWith(`${schemaId}#`)) return rewriteReference(reference.slice(schemaId.length));
+	}
+	if (reference === "#") return REMOTE_CONFIG_POINTER_PREFIX;
+	if (reference.startsWith("#/$defs/") || reference.startsWith("#/definitions/")) return reference;
+	if (reference.startsWith("#/")) return `${REMOTE_CONFIG_POINTER_PREFIX}${reference.slice(1)}`;
+	return reference;
+}
+/**
+* Nest a manifest `configSchema` under a top-level `config` property, rewriting `$ref`s so they
+* still resolve. Drops `$schema` and `$id`; keeps `$defs` / `definitions` at the root.
+*/
+function nestRemoteConfigSchema(configSchema) {
+	const { $defs, definitions, $id, ...rest } = configSchema;
+	const body = Object.fromEntries(Object.entries(rest).filter(([key]) => key !== "$schema"));
+	const schemaId = typeof $id === "string" ? $id : void 0;
+	return {
+		type: "object",
+		properties: { config: rewriteReferences(body, schemaId) },
+		...$defs != null && { $defs: rewriteSchemaMap($defs, schemaId) },
+		...definitions != null && { definitions: rewriteSchemaMap(definitions, schemaId) }
+	};
+}
+/**
+* Nest a manifest `uiConfigSchema` to match {@link nestRemoteConfigSchema}, hiding the wrapper
+* object's title so the module's fields render as if top level.
+*/
+function nestRemoteUiConfigSchema(uiConfigSchema) {
+	return { config: {
+		...uiConfigSchema,
+		"ui:title": ""
+	} };
+}
+/**
+* A config holding each top-level `configSchema` property's `default`. Properties without one are
+* left unset; defaults are cloned so the result can be mutated freely.
+*/
+function remoteConfigDefaults(configSchema) {
+	const properties = configSchema?.properties;
+	if (properties == null || typeof properties !== "object" || Array.isArray(properties)) return {};
+	return Object.fromEntries(Object.entries(properties).filter(([, propertySchema]) => typeof propertySchema === "object" && propertySchema != null && !Array.isArray(propertySchema) && "default" in propertySchema).map(([key, propertySchema]) => [key, structuredClone(propertySchema.default)]));
+}
+
+//#endregion
+export { REMOTE_CONFIG_POINTER_PREFIX, nestRemoteConfigSchema, nestRemoteUiConfigSchema, remoteConfigDefaults };

package/dist/{protocol-Dqnl8JTs.d.mts → protocol-ClWDYwW2.d.mts}

@@ -1,14 +1,7 @@
 import { z } from "zod";
 
-//#region src/types.d.ts
-
-type Json = boolean | JsonObject | JsonValue[] | null | number | string;
-type JsonObject = {
-  [key: string]: Json;
-};
-type JsonValue = Json;
-//#endregion
 //#region src/bridge/protocol.d.ts
+
 /**
  * Runtime facts about where the module is rendered, owned by the host and not
  * derivable by the module itself. Distinct from `data`, which is the module's
@@ -24,4 +17,4 @@ declare const remoteModuleContextSchema: z.ZodObject<{
 }, z.core.$strip>;
 type RemoteModuleContext = z.infer<typeof remoteModuleContextSchema>;
 //#endregion
-export { Json as n, RemoteModuleContext as t };
+export { RemoteModuleContext as t };

package/dist/types-CBSiNsDJ.d.mts

@@ -0,0 +1,17 @@
+import { z } from "zod";
+
+//#region src/types.d.ts
+
+type Json = boolean | JsonObject | JsonValue[] | null | number | string;
+/**
+ * Loose JSON Schema object. Deliberately not a full JSON Schema type system —
+ * this package only needs to carry what `z.toJSONSchema()` emits for consumers
+ * to validate or render.
+ */
+type JsonSchemaObject = Record<string, unknown>;
+type JsonObject = {
+  [key: string]: Json;
+};
+type JsonValue = Json;
+//#endregion
+export { JsonSchemaObject as n, Json as t };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@persona/layout-editor-remote-module",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "Shared manifest format, Vite plugin, and host/iframe bridge for remotely-defined dashboard layout modules in Persona dashboard apps.",
   "license": "SEE LICENSE",
   "type": "module",
@@ -15,6 +15,9 @@
       ],
       "bridge-frame": [
         "dist/bridge-frame.d.mts"
+      ],
+      "config-form": [
+        "dist/config-form.d.mts"
       ]
     }
   },
@@ -111,6 +114,10 @@
       "types": "./dist/bridge-host.d.mts",
       "import": "./dist/bridge-host.mjs"
     },
+    "./config-form": {
+      "types": "./dist/config-form.d.mts",
+      "import": "./dist/config-form.mjs"
+    },
     "./bridge-frame": {
       "types": "./dist/bridge-frame.d.mts",
       "import": "./dist/bridge-frame.mjs"