@persona/layout-editor-remote-module 0.6.0 → 0.8.0

package/README.md

@@ -115,6 +115,11 @@ cannot derive itself:
 - `isReadOnly` — the host object is locked for edits
 - `isInEditor` — the module is rendered inside the layout editor rather than on a live record
 - `isUsingStubData` — the host is feeding placeholder/stub data instead of a real record
+- `dynamicHeight` — whether the host sizes the iframe to the height the bridge reports
+  (`RemoteModuleFrame`'s `dynamicHeight`). A module that fills a fixed-height iframe with viewport
+  units (`100vh`) should size to its content when it's set, or the reported height just follows the
+  iframe. `RemoteModuleFrame` sets it from its `dynamicHeight` prop, overriding any value in the
+  `context` prop.
 
 `context` is sent with `init` and pushed again whenever it changes, just like `data`; inside the
 iframe it arrives through `ready()`, `getContext()`, and the `context` render prop (all

package/dist/bridge-frame.d.mts

@@ -1,4 +1,4 @@
-import { n as Json, t as RemoteModuleContext } from "./protocol-BljV-Zhi.mjs";
+import { n as Json, t as RemoteModuleContext } from "./protocol-Dqnl8JTs.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-BQsn3N3N.mjs";
+import { c as resolveAllowedHostOrigins, n as SOURCE, o as candidateParentOrigin, r as parseHostToModuleMessage, s as personaDashboardHostOrigins, t as PROTOCOL_VERSION } from "./protocol-D_pdVZjs.mjs";
 import { Component, useEffect, useRef, useState } from "react";
 import { jsx } from "react/jsx-runtime";
 

package/dist/bridge-host.d.mts

@@ -1,4 +1,4 @@
-import { n as Json, t as RemoteModuleContext } from "./protocol-BljV-Zhi.mjs";
+import { n as Json, t as RemoteModuleContext } from "./protocol-Dqnl8JTs.mjs";
 import { CSSProperties, ReactNode } 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-BQsn3N3N.mjs";
+import { a as assertNotSelfOrigin, i as parseModuleToHostMessage, n as SOURCE, t as PROTOCOL_VERSION } from "./protocol-D_pdVZjs.mjs";
 import { useEffect, useMemo, useRef, useState } from "react";
 import { jsx } from "react/jsx-runtime";
 
@@ -139,16 +139,23 @@ function createHostBridge({ iframe, moduleOrigin, getData, getContext, resolveDa
 
 //#endregion
 //#region src/bridge/host/RemoteModuleFrame.tsx
+function withDynamicHeight(context, dynamicHeight) {
+	return {
+		...context,
+		dynamicHeight
+	};
+}
 function RemoteModuleFrame({ documentUrl, moduleOrigin, accessToken, environmentId, locale, extraParams, title, sandbox, referrerPolicy = "no-referrer", initRetryMs, initRetryTimeoutMs, dynamicHeight = false, heightOffset = 0, minHeight, className, style, data, context, resolveDataPath, onRenderError }) {
 	const iframeRef = useRef(null);
 	const dataRef = useRef(data);
-	const contextRef = useRef(context);
+	const contextRef = useRef(withDynamicHeight(context, dynamicHeight));
 	const onRenderErrorRef = useRef(onRenderError);
 	const resolveDataPathRef = useRef(resolveDataPath);
 	const bridgeRef = useRef(void 0);
 	const [height, setHeight] = useState();
+	const hostContext = useMemo(() => withDynamicHeight(context, dynamicHeight), [context, dynamicHeight]);
 	dataRef.current = data;
-	contextRef.current = context;
+	contextRef.current = hostContext;
 	onRenderErrorRef.current = onRenderError;
 	resolveDataPathRef.current = resolveDataPath;
 	const src = useMemo(() => buildModuleSrc(documentUrl, {
@@ -194,8 +201,8 @@ function RemoteModuleFrame({ documentUrl, moduleOrigin, accessToken, environment
 		bridgeRef.current?.pushData(data);
 	}, [data]);
 	useEffect(() => {
-		bridgeRef.current?.pushContext(context);
-	}, [context]);
+		bridgeRef.current?.pushContext(hostContext);
+	}, [hostContext]);
 	const computedHeight = dynamicHeight && height !== void 0 ? `${Math.max(height + heightOffset, minHeight ?? 0)}px` : minHeight === void 0 ? "100%" : `${minHeight}px`;
 	return /* @__PURE__ */ jsx("iframe", {
 		ref: iframeRef,

package/dist/{define-CUJkJjCk.d.mts → define-Bxk_kfEr.d.mts}

@@ -39,6 +39,7 @@ declare const remoteModuleRegistrationManifestV1Schema: z.ZodObject<{
     management: "management";
     related_records: "related_records";
   }>>;
+  categoryCustom: z.ZodOptional<z.ZodString>;
   configSchema: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
   defaultSize: z.ZodRecord<z.ZodEnum<{
     account: "account";
@@ -118,6 +119,8 @@ interface LayoutModuleDefinitionInput {
   allowDynamicHeight?: boolean;
   badge?: ModuleBadge;
   category?: ModuleCategory;
+  /** Free-form module-library category label; takes precedence over `category` when both are set. */
+  categoryCustom?: string;
   /** Authored as zod; converted to JSON Schema by the plugin. */
   configSchema?: z.ZodType;
   defaultSize: Partial<Record<LayoutType, {

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { a as JsonSchemaObject, c as ModuleCategory, d as RemoteModuleRegistrationManifestV1Schema, f as remoteModuleRegistrationManifestV1Schema, i as Json, l as RemoteModuleDelivery, n as LayoutModuleEntry, o as LayoutType, r as defineLayoutModule, s as ModuleBadge, t as LayoutModuleDefinitionInput, u as RemoteModuleRegistrationManifestV1 } from "./define-CUJkJjCk.mjs";
+import { a as JsonSchemaObject, c as ModuleCategory, d as RemoteModuleRegistrationManifestV1Schema, f as remoteModuleRegistrationManifestV1Schema, i as Json, l as RemoteModuleDelivery, n as LayoutModuleEntry, o as LayoutType, r as defineLayoutModule, s as ModuleBadge, t as LayoutModuleDefinitionInput, u as RemoteModuleRegistrationManifestV1 } from "./define-Bxk_kfEr.mjs";
 import { z } from "zod";
 
 //#region src/manifest-path.d.ts
@@ -44,6 +44,7 @@ declare const remoteModuleManifestDocumentSchema: z.ZodObject<{
       management: "management";
       related_records: "related_records";
     }>>;
+    categoryCustom: z.ZodOptional<z.ZodString>;
     configSchema: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     defaultSize: z.ZodRecord<z.ZodEnum<{
       account: "account";

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { n as DEFAULT_MANIFEST_PATH, r as defineLayoutModule, t as remoteModuleRegistrationManifestV1Schema } from "./schema-DoUyVRjU.mjs";
+import { n as DEFAULT_MANIFEST_PATH, r as defineLayoutModule, t as remoteModuleRegistrationManifestV1Schema } from "./schema-DU2LTDDC.mjs";
 import { z } from "zod";
 
 //#region src/parse.ts

package/dist/{protocol-BQsn3N3N.mjs → protocol-D_pdVZjs.mjs}

@@ -80,6 +80,7 @@ const remoteModuleRegistrationManifestV1Schema = z.object({
 	allowDynamicHeight: z.boolean().optional(),
 	badge: moduleBadgeSchema.optional(),
 	category: moduleCategorySchema.optional(),
+	categoryCustom: z.string().trim().min(1).max(80).optional(),
 	configSchema: looseObjectSchema.optional(),
 	defaultSize: z.partialRecord(layoutTypeSchema, gridSizeSchema),
 	descriptionShort: z.string().min(1),
@@ -155,7 +156,8 @@ const remoteModuleContextSchema = z.object({
 	layoutObjectId: z.string().nullable(),
 	isReadOnly: z.boolean(),
 	isInEditor: z.boolean(),
-	isUsingStubData: z.boolean()
+	isUsingStubData: z.boolean(),
+	dynamicHeight: z.boolean().optional()
 });
 const moduleToHostMessageSchema = z.discriminatedUnion("type", [
 	readySchema,

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

@@ -20,6 +20,7 @@ declare const remoteModuleContextSchema: z.ZodObject<{
   isReadOnly: z.ZodBoolean;
   isInEditor: z.ZodBoolean;
   isUsingStubData: z.ZodBoolean;
+  dynamicHeight: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
 type RemoteModuleContext = z.infer<typeof remoteModuleContextSchema>;
 //#endregion

package/dist/{schema-DoUyVRjU.mjs → schema-DU2LTDDC.mjs}

@@ -78,6 +78,7 @@ const remoteModuleRegistrationManifestV1Schema = z.object({
 	allowDynamicHeight: z.boolean().optional(),
 	badge: moduleBadgeSchema.optional(),
 	category: moduleCategorySchema.optional(),
+	categoryCustom: z.string().trim().min(1).max(80).optional(),
 	configSchema: looseObjectSchema.optional(),
 	defaultSize: z.partialRecord(layoutTypeSchema, gridSizeSchema),
 	descriptionShort: z.string().min(1),

package/dist/vite-plugin.d.mts

@@ -1,4 +1,4 @@
-import { n as LayoutModuleEntry, r as defineLayoutModule, t as LayoutModuleDefinitionInput } from "./define-CUJkJjCk.mjs";
+import { n as LayoutModuleEntry, r as defineLayoutModule, t as LayoutModuleDefinitionInput } from "./define-Bxk_kfEr.mjs";
 import { Plugin } from "vite";
 
 //#region src/vite-plugin.d.ts

package/dist/vite-plugin.mjs

@@ -1,4 +1,4 @@
-import { n as DEFAULT_MANIFEST_PATH, r as defineLayoutModule, t as remoteModuleRegistrationManifestV1Schema } from "./schema-DoUyVRjU.mjs";
+import { n as DEFAULT_MANIFEST_PATH, r as defineLayoutModule, t as remoteModuleRegistrationManifestV1Schema } from "./schema-DU2LTDDC.mjs";
 import { z } from "zod";
 import { existsSync } from "node:fs";
 import { mkdir, writeFile } from "node:fs/promises";
@@ -113,6 +113,7 @@ function buildManifestBase(definition) {
 		allowDynamicHeight: input.allowDynamicHeight,
 		badge: input.badge,
 		category: input.category,
+		categoryCustom: input.categoryCustom,
 		configSchema: input.configSchema ? z.toJSONSchema(input.configSchema) : void 0,
 		defaultSize: input.defaultSize,
 		descriptionShort: input.descriptionShort,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@persona/layout-editor-remote-module",
-  "version": "0.6.0",
+  "version": "0.8.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",

package/skills/getting-started/SKILL.md

@@ -68,7 +68,12 @@ specific layouts, `defaultSize` must provide an entry for each one.
 Optional fields: `allowDynamicHeight` (expose the dynamic-height option in the module's
 configuration), `badge` (`'beta' | 'deprecated' | 'improved' | 'new'`), `category`
 (`'build_your_own' | 'components' | 'management' | 'related_records'`; the host defaults to
-`build_your_own`), `icon` (an image path relative to the module's origin, such as
+`build_your_own`), `categoryCustom` (a free-form module-library category label, up to 80 characters;
+the host renders it verbatim — it is not translated — and groups modules that share the same
+trimmed, case-sensitive string, even across different module sources. When both are set,
+`categoryCustom` overrides `category`, and a label equal to one of the host's built-in category
+labels lands in "Other"; keep setting `category` as a fallback for hosts that predate
+`categoryCustom`), `icon` (an image path relative to the module's origin, such as
 `/assets/icon.svg`; the library shows a generic icon when it's omitted, fails to load, or is
 rejected as a cross-origin or non-http(s) URL), `internalUsersOnly` (a hint the host may use to
 narrow visibility, never widen it), and `configSchema` / `uiConfigSchema` (below).