openplanr 3.1.1 → 3.3.0

package/lib/host-packages/openai/openplanr/runtime/design/scripts/design-handoff.mjs

@@ -25,7 +25,7 @@ import {
 } from "./design-shared-artifact-support-protocol-contracts-ea2cd15e.mjs";
 import {
   validateJson
-} from "./design-shared-protocol-contracts-31a760fc.mjs";
+} from "./design-shared-protocol-contracts-b5f28f94.mjs";
 import {
   assertPlainData,
   canonicalizeJson,
@@ -654,7 +654,7 @@ function compileDesignHandoffReadiness(input) {
   if (input === null || input === void 0) return designHandoffReadinessAbsence();
   const source = plainClone(input);
   const document = source.document;
-  if (!document || document.kind !== "openplanr-design-document" || document.schemaVersion !== "1.0.0" || typeof document.id !== "string" || !document.id)
+  if (!document || document.kind !== "openplanr-design-document" || !["1.0.0", "1.1.0"].includes(document.schemaVersion) || typeof document.id !== "string" || !document.id)
     throw new TypeError("Readiness requires one supported design document.");
   const revision = source.sourceRevision === null || source.sourceRevision === void 0 ? null : normalizeDigest(source.sourceRevision, "design revision");
   const direction = selectedDirection(document, source.studioState);

package/lib/host-packages/openai/openplanr/runtime/design/scripts/design-resource-pack.mjs

@@ -7,7 +7,7 @@ import {
   LARGE_OBJECT_LIMITS,
   RESOURCE_HTML_SEGMENT_ENCODING,
   assertLargeObjectContract
-} from "./design-shared-protocol-contracts-31a760fc.mjs";
+} from "./design-shared-protocol-contracts-b5f28f94.mjs";
 import {
   canonicalizeJson
 } from "./design-shared-protocol-contracts-75a938cc.mjs";

package/lib/host-packages/openai/openplanr/runtime/design/scripts/design-review.mjs

@@ -19,6 +19,8 @@ import {
   readRuntimeAsset,
   renderArtifactParentRuntime,
   renderDesignStudio,
+  saveDesignLayout,
+  saveDesignViewContext,
   standaloneDesignHtml,
   timingSafeTokenEqual
 } from "./design-document.mjs";
@@ -282,7 +284,7 @@ function reviewExportTools() {
           frame: {
             id: refs.frame,
             label: field(frame?.label),
-            ...dimensions(frame) ?? { width: null, height: null }
+            ...frame?.height === "auto" && Number.isInteger(frame.width) && frame.width > 0 && frame.width <= 16384 ? { width: frame.width, height: "auto" } : dimensions(frame) ?? { width: null, height: null }
           },
           threads: []
         });
@@ -327,7 +329,7 @@ function reviewExportTools() {
       overallNotes
     };
   }
-  const inline = (value) => String(value ?? "Unavailable").replaceAll("\\", "\\\\").replace(/[\r\n]/gu, " ").replace(/[\[\]<>`*#|]/gu, (char) => "\\" + char);
+  const inline = (value) => String(value ?? "Unavailable").replaceAll("\\", "\\\\").replace(/[\r\n]/gu, " ").replace(/[[\]<>`*#|]/gu, (char) => "\\" + char);
   const quoted = (value) => {
     const runs = value.match(/`+/gu) ?? [];
     const fence = "`".repeat(Math.max(3, ...runs.map((run) => run.length + 1)));
@@ -2470,6 +2472,23 @@ function studioRuntimeIdentity(current) {
     )
   };
 }
+function studioContentIdentity(current) {
+  const document = { ...current.document };
+  delete document.layout;
+  return hash(
+    JSON.stringify({
+      document,
+      layoutGuidance: {
+        titles: Object.entries(current.document.layout?.boards ?? {}).filter(([, board]) => board.title !== void 0).map(([key, board]) => [key, board.title]).sort(([left], [right]) => left.localeCompare(right)),
+        sections: current.document.layout?.sections ?? []
+      },
+      artifactDigest: digestArtifactEnvelope(current.envelope),
+      fingerprints: current.fingerprints,
+      contextDigest: current.contextDigest,
+      specification: readFileSync4(join5(current.directory, "design-spec.md"), "utf8")
+    })
+  );
+}
 function exportDesignReview(file, { scope = "all", env = process.env } = {}) {
   if (!["all", "current"].includes(scope))
     throw new Error("Review export scope must be current or all.");
@@ -2894,7 +2913,13 @@ async function startDesignReviewUnlocked(file, {
       }).state;
       const stalePins = readDesignFeedback(file, env).pins.filter((pin) => pin.stale);
       return renderDesignStudio(
-        { ...current, envelope: model.envelope, state, stalePins },
+        {
+          ...current,
+          envelope: model.envelope,
+          state,
+          stalePins,
+          contentIdentity: studioContentIdentity(current)
+        },
         { stageRuntimeUrl: `${base}runtime.js` }
       ).replace(
         "</head>",
@@ -2908,6 +2933,8 @@ async function startDesignReviewUnlocked(file, {
           launchContext: base.startsWith("/studio/") ? "local Studio" : "private review"
         },
         stateUrl: `${base}api/design-state`,
+        viewContextUrl: `${base}api/design-view-context`,
+        layoutUrl: `${base}api/design-layout`,
         statusUrl: `${base}api/design-status`,
         readyUrl: `${base}api/design-ready`,
         shareUrl: `${base}api/design-share`,
@@ -3169,7 +3196,9 @@ ${renderArtifactParentRuntime({ ...options, adapterRuntimeUrl: `${base}api/desig
             revision: current.revision,
             status: ready?.revision === current.revision ? ready.status : "loading",
             verification: current.verification.status,
-            runtimeIdentity: studioRuntimeIdentity(current)
+            runtimeIdentity: studioRuntimeIdentity(current),
+            contentIdentity: studioContentIdentity(current),
+            layout: current.document.layout
           });
         } else if (route === "design-state" && req.method === "GET") {
           respond(res, 200, {
@@ -3181,6 +3210,18 @@ ${renderArtifactParentRuntime({ ...options, adapterRuntimeUrl: `${base}api/desig
           });
         } else if (route === "design-state" && req.method === "PUT") {
           respond(res, 200, await saveDesignState(file, await readBody(req)));
+        } else if (route === "design-view-context" && req.method === "PUT") {
+          if (req.headers["x-openplanr-design"] !== "1" || !String(req.headers["content-type"] ?? "").startsWith("application/json") || req.headers.origin && req.headers.origin !== `http://127.0.0.1:${server.port}`)
+            throw Object.assign(new Error("View context requires a same-origin studio request."), {
+              statusCode: 403
+            });
+          respond(res, 200, saveDesignViewContext(file, await readBody(req), clock));
+        } else if (route === "design-layout" && req.method === "PUT") {
+          if (req.headers["x-openplanr-design"] !== "1" || !String(req.headers["content-type"] ?? "").startsWith("application/json") || req.headers.origin && req.headers.origin !== `http://127.0.0.1:${server.port}`)
+            throw Object.assign(new Error("Layout saves require a same-origin studio request."), {
+              statusCode: 403
+            });
+          respond(res, 200, await saveDesignLayout(file, await readBody(req)));
         } else if (route === "design-ready" && req.method === "POST") {
           const value = await readBody(req);
           const loadedArtifacts = new Set(Array.isArray(value?.artifacts) ? value.artifacts : []);

package/lib/host-packages/{claude/openplanr/runtime/design/scripts/design-runtime-support-e34c388a8e59.mjs → openai/openplanr/runtime/design/scripts/design-runtime-support-25485dbf1cb2.mjs}

@@ -12,7 +12,7 @@ import "./design-compression.mjs";
 import "./design-owner-custody.mjs";
 import "./design-runtime-home.mjs";
 import "./design-loopback-server.mjs";
-import "./design-shared-protocol-contracts-31a760fc.mjs";
+import "./design-shared-protocol-contracts-b5f28f94.mjs";
 import "./design-shared-protocol-contracts-75a938cc.mjs";
 export {
   copyUploadSpool,

package/lib/host-packages/openai/openplanr/runtime/design/scripts/design-share.mjs

@@ -50,7 +50,7 @@ import {
   DESIGN_WORKSPACE_SCHEMA,
   DESIGN_WORKSPACE_VERSION,
   assertWorkspaceContract
-} from "./design-shared-protocol-contracts-31a760fc.mjs";
+} from "./design-shared-protocol-contracts-b5f28f94.mjs";
 import {
   canonicalizeJson,
   deepFreeze,
@@ -97,13 +97,13 @@ ${current.document.id}`);
   const legacyPath = !options.custodyRoot && !configuredPlanrHome(env) ? join(realpathSync(env.HOME || homedir()), ".openplanr", "design-shares", `${key}.json`) : null;
   return { root, path, current, legacyPath };
 }
-function presentationFingerprint(current) {
+function presentationFingerprint(current, { legacy = false } = {}) {
   const state = readJson(join(current.root, ".design/studio-state.json"), { state: {} }).state;
   return hash(
     JSON.stringify({
       revision: current.revision,
       selectedVariant: state.selectedVariant ?? current.document.selectedVariant,
-      positions: state.positions ?? {},
+      ...legacy ? { positions: state.positions ?? {} } : {},
       verification: current.verification.status
     })
   );
@@ -119,7 +119,10 @@ var safeStatus = (record, current) => ({
     url: workspaceReviewUrl(record.custody),
     revision: record.custody.currentRevision ?? record.publishedRevision ?? null,
     publishedRevision: record.publishedRevision ?? null,
-    hasUpdate: record.publishedRevision !== current.revision || record.publishedPresentation !== presentationFingerprint(current),
+    hasUpdate: record.publishedRevision !== current.revision || ![
+      presentationFingerprint(current),
+      presentationFingerprint(current, { legacy: true })
+    ].includes(record.publishedPresentation),
     epoch: record.custody.epoch,
     commentsPaused: Boolean(record.custody.commentsPaused ?? record.commentsPaused),
     revoked: Boolean(record.revoked),
@@ -1804,7 +1807,7 @@ async function importDesignShareRecovery(file, { input, ...options } = {}) {
       const pending = custody.pendingCreate ?? custody.pendingMutation.body;
       const destination = join3(root, "uploads", custody.id, pending.operationId);
       if (existsSync4(destination)) {
-        const { spoolChunkReader: spoolChunkReader2 } = await import("./design-runtime-support-e34c388a8e59.mjs");
+        const { spoolChunkReader: spoolChunkReader2 } = await import("./design-runtime-support-25485dbf1cb2.mjs");
         const reader = spoolChunkReader2(destination, pending);
         for (const part of pending.manifest.chunks) await reader(part.index);
       } else await copyUploadSpool(custody, destination);

package/lib/host-packages/openai/openplanr/runtime/design/scripts/design-shared-artifact-support-dependencies-design-support-protocol-contracts-3d9b1a86.mjs

@@ -14,9 +14,12 @@ import {
   MAX_ARTIFACT_HTML_BYTES
 } from "./design-shared-artifact-support-protocol-contracts-ea2cd15e.mjs";
 import {
+  DESIGN_DOCUMENT_SCHEMA,
+  DESIGN_DOCUMENT_V120_SCHEMA,
   DESIGN_REVIEW_BUNDLE_SCHEMA,
+  validateDesignProps,
   validateJson
-} from "./design-shared-protocol-contracts-31a760fc.mjs";
+} from "./design-shared-protocol-contracts-b5f28f94.mjs";
 import {
   canonicalizeJson,
   sha256Hex
@@ -25,6 +28,7 @@ import {
 // packages/design/lib/design/document-state.mjs
 import { createHash, randomUUID } from "node:crypto";
 import {
+  chmodSync,
   closeSync,
   lstatSync,
   mkdirSync,
@@ -47,14 +51,15 @@ function readJson(path, fallback = void 0) {
     throw error;
   }
 }
-function atomicJson(path, value) {
-  atomicBytes(path, json(value));
+function atomicJson(path, value, { mode } = {}) {
+  atomicBytes(path, json(value), mode);
 }
-function atomicBytes(path, bytes) {
+function atomicBytes(path, bytes, mode) {
   mkdirSync(dirname(path), { recursive: true });
   const temporary = `${path}.${randomUUID()}.tmp`;
   try {
     writeFileSync(temporary, bytes, { mode: 384, flag: "wx" });
+    if (mode !== void 0) chmodSync(temporary, mode);
     renameSync(temporary, path);
   } finally {
     rmSync(temporary, { force: true });
@@ -320,6 +325,7 @@ var MIME = {
 };
 var children = (node) => [...node.childNodes ?? [], ...node.content?.childNodes ?? []];
 var attr = (node, name) => node.attrs?.find((item2) => item2.name === name);
+var isPropToken = (value) => typeof value === "string" && value.length <= 128 && /^[a-z][a-z0-9-]*(?![\s\S])/u.test(value);
 var text = (node) => children(node).map((item2) => item2.value ?? "").join("");
 function setText(node, value) {
   node.childNodes = [{ nodeName: "#text", value, parentNode: node }];
@@ -329,6 +335,23 @@ function element(name, value) {
   setText(node, value);
   return node;
 }
+function parseBodySource(html) {
+  const roots = [];
+  const parser = new Parser({ sourceCodeLocationInfo: true });
+  const onStartTag = parser.onStartTag.bind(parser);
+  parser.onStartTag = (token) => {
+    if (token.tagName === "body") roots.push(token);
+    onStartTag(token);
+  };
+  parser.tokenizer.write(html, true);
+  const body = parser.document.childNodes.find((node) => node.tagName === "html")?.childNodes.find((node) => node.tagName === "body");
+  const root = roots.length === 1 && body?.sourceCodeLocation?.startTag?.startOffset === roots[0].location?.startOffset ? roots[0] : null;
+  return { document: parser.document, roots, root };
+}
+function inspectLocalDocumentBody(html) {
+  const { root } = parseBodySource(html);
+  return root ? { attrs: root.attrs, location: root.location } : null;
+}
 function resolveLocalDocumentFile(root, path, from = root) {
   if (typeof path !== "string" || !path || /^(?:[a-z][a-z\d+.-]*:|\/|\\)/iu.test(path))
     throw new Error(`Expected a local relative asset: ${path}`);
@@ -350,7 +373,8 @@ function bundleLocalDocument({
   screenId,
   maxBytes = MAX_ARTIFACT_HTML_BYTES,
   readSource,
-  passive = false
+  passive = false,
+  screenProps
 }) {
   const root = realpathSync2(inputRoot);
   const files = /* @__PURE__ */ new Map();
@@ -480,7 +504,16 @@ function bundleLocalDocument({
     return value.replace(/<\/script/giu, "<\\/script");
   }
   const input = read(source.html);
-  const document = parse(input.value.toString("utf8"));
+  const propEntries = Object.entries(screenProps ?? {});
+  let document;
+  if (propEntries.length) {
+    const parsed = parseBodySource(input.value.toString("utf8"));
+    if (!parsed.root)
+      throw new Error(
+        `Screen ${screenId} source ${source.html} requires a single authored <body> root for props; found ${parsed.roots.length}.`
+      );
+    document = parsed.document;
+  } else document = parse(input.value.toString("utf8"));
   let head, body;
   const deferredScripts = [];
   const queue = [...children(document)];
@@ -572,6 +605,22 @@ function bundleLocalDocument({
     body.childNodes.push(node);
   }
   body.attrs.push({ name: "data-planr-screen", value: screenId });
+  if (propEntries.length) {
+    const classes = (attr(body, "class")?.value ?? "").split(/\s+/u).filter(Boolean).filter((item2) => !propEntries.some(([name]) => item2.startsWith(`prop-${name}-`)));
+    for (const [name, value] of propEntries) {
+      if (!isPropToken(name) || !(typeof value === "boolean" || isPropToken(value)))
+        throw new TypeError(
+          `Screen ${screenId} source ${source.html} has invalid prop ${name}: ${JSON.stringify(value)}.`
+        );
+      const attribute = `data-prop-${name}`;
+      body.attrs = body.attrs.filter((item2) => item2.name !== attribute);
+      body.attrs.push({ name: attribute, value: String(value) });
+      const prefix = `prop-${name}-`;
+      classes.push(`${prefix}${value}`);
+    }
+    body.attrs = body.attrs.filter((item2) => item2.name !== "class");
+    body.attrs.push({ name: "class", value: classes.join(" ") });
+  }
   const html = serialize(document);
   if (Buffer.byteLength(html) > maxBytes)
     throw new Error("Bundled design exceeds the output budget.");
@@ -683,6 +732,61 @@ Object.assign(bundleV12.properties, {
   fingerprints: list(DESIGN_FINGERPRINT_SCHEMA, 4096)
 });
 var DESIGN_REVIEW_BUNDLE_V12_SCHEMA = bundleV12;
+var bundleCurrent = (
+  /** @type {MutableSchema} */
+  structuredClone(bundleV12)
+);
+bundleCurrent.$id = "https://openplanr.dev/schemas/v1.20.0/design-review-bundle.schema.json";
+bundleCurrent["x-openplanr-contract"] = { id: "design-review-bundle", version: "1.20.0" };
+bundleCurrent.properties.schemaVersion = { enum: ["1.1.0", "1.2.0"] };
+bundleCurrent.properties.envelope = bundleV11.properties.envelope;
+bundleCurrent.allOf = [
+  {
+    if: { properties: { schemaVersion: { const: "1.2.0" } } },
+    then: { properties: { envelope: bundleV12.properties.envelope } }
+  }
+];
+var currentDesign2 = (
+  /** @type {MutableSchema} */
+  bundleCurrent.properties.design
+);
+for (const key of ["frames", "layout"])
+  currentDesign2.properties[key] = /** @type {Record<string, unknown>} */
+  DESIGN_DOCUMENT_V120_SCHEMA.properties[key];
+bundleCurrent.$defs = structuredClone(DESIGN_DOCUMENT_V120_SCHEMA.$defs);
+var currentEntries = (
+  /** @type {{ items: { properties: Record<string, unknown> } }} */
+  bundleCurrent.properties.entries
+);
+currentEntries.items.properties.height = { const: "auto" };
+var bundleProps = (
+  /** @type {MutableSchema} */
+  structuredClone(bundleCurrent)
+);
+bundleProps.$id = "https://openplanr.dev/schemas/v1.22.0/design-review-bundle.schema.json";
+bundleProps["x-openplanr-contract"] = { id: "design-review-bundle", version: "1.22.0" };
+var propsDesign = (
+  /** @type {MutableSchema} */
+  bundleProps.properties.design
+);
+var authoredProperties = (
+  /** @type {Record<string, unknown>} */
+  DESIGN_DOCUMENT_SCHEMA.properties
+);
+propsDesign.properties.schemaVersion = authoredProperties.schemaVersion;
+for (const key of ["screens", "variants"]) {
+  const projected = (
+    /** @type {{ items: { properties: Record<string, unknown> } }} */
+    propsDesign.properties[key]
+  );
+  const authored = (
+    /** @type {{ items: { properties: Record<string, unknown> } }} */
+    authoredProperties[key]
+  );
+  projected.items.properties.props = authored.items.properties.props;
+}
+propsDesign.allOf = structuredClone(DESIGN_DOCUMENT_SCHEMA.allOf);
+var DESIGN_REVIEW_BUNDLE_CURRENT_SCHEMA = bundleProps;
 var item = closed(
   {
     pinId: id,
@@ -799,10 +903,19 @@ function assertDesignReviewMetadata(value) {
   );
 }
 function assertDesignReviewBundle(value) {
+  if (value?.design?.schemaVersion !== "1.1.0" && ["screens", "variants"].some(
+    (field) => Array.isArray(value?.design?.[field]) && value.design[field].some((item2) => item2 && Object.hasOwn(item2, "props"))
+  ))
+    throw new TypeError('Invalid design props: props require design.schemaVersion "1.1.0"');
   assertReviewExperience(
     value,
-    value?.schemaVersion === "1.2.0" ? DESIGN_REVIEW_BUNDLE_V12_SCHEMA : value?.schemaVersion === "1.1.0" ? DESIGN_REVIEW_BUNDLE_V11_SCHEMA : DESIGN_REVIEW_BUNDLE_SCHEMA
+    value?.design?.schemaVersion !== void 0 || ["screens", "variants"].some(
+      (field) => Array.isArray(value?.design?.[field]) && value.design[field].some((item2) => item2 && Object.hasOwn(item2, "props"))
+    ) || value?.design?.layout !== void 0 || Array.isArray(value?.design?.frames) && value.design.frames.some(({ height }) => height === "auto") ? DESIGN_REVIEW_BUNDLE_CURRENT_SCHEMA : value?.schemaVersion === "1.2.0" ? DESIGN_REVIEW_BUNDLE_V12_SCHEMA : value?.schemaVersion === "1.1.0" ? DESIGN_REVIEW_BUNDLE_V11_SCHEMA : DESIGN_REVIEW_BUNDLE_SCHEMA
   );
+  const propErrors = validateDesignProps(value.design);
+  if (propErrors.length) throw new TypeError(`Invalid design props:
+${propErrors.join("\n")}`);
   if (["1.1.0", "1.2.0"].includes(value.schemaVersion)) {
     if (value.reviewContext.designId !== value.design.id || value.contextDigest !== sha256Hex(canonicalizeJson(value.reviewContext)))
       throw new TypeError("Review context identity or digest does not match its published design.");
@@ -871,6 +984,7 @@ function reviewFingerprints({ document, context, screen, variant, frame, sourceD
   const components = context.implementation.components.filter(
     (component) => !component.screenIds?.length || component.screenIds.includes(screen.id)
   );
+  const values = Object.hasOwn(variant.props ?? {}, screen.id) ? variant.props[screen.id] : {};
   return {
     screenId: screen.id,
     variantId: variant.id,
@@ -878,7 +992,15 @@ function reviewFingerprints({ document, context, screen, variant, frame, sourceD
     contentDigest: reviewDigest({
       files: Object.entries(sourceDigests).sort(([a], [b]) => a < b ? -1 : a > b ? 1 : 0),
       width: frame.width,
-      height: frame.height
+      height: frame.height,
+      ...screen.props === void 0 ? {} : {
+        props: Object.fromEntries(
+          Object.entries(screen.props).map(([name, declaration]) => [
+            name,
+            Object.hasOwn(values, name) ? values[name] : declaration.default
+          ])
+        )
+      }
     }),
     guidanceDigest: reviewDigest({
       title: screen.title,
@@ -903,6 +1025,7 @@ function bundleDesignRevision(current, state = {}) {
     kind: "openplanr-design-review-bundle",
     schemaVersion: current.envelope.schemaVersion === "1.1.0" ? "1.2.0" : "1.1.0",
     design: {
+      ...document.screens.some((screen) => screen.props !== void 0) || document.variants.some((variant) => variant.props !== void 0) ? { schemaVersion: document.schemaVersion } : {},
       ...pick(document, [
         "id",
         "title",
@@ -910,19 +1033,20 @@ function bundleDesignRevision(current, state = {}) {
         "selectedVariant",
         "screenOrder",
         "frames",
-        "flows"
+        "flows",
+        "layout"
       ]),
       screens: document.screens.map(
-        (screen) => pick(screen, ["id", "title", "description", "anchors"])
+        (screen) => pick(screen, ["id", "title", "description", "anchors", "props"])
       ),
       selectedVariant: document.variants.some(
         (variant) => variant.id === state.selectedVariant && variant.status === "ready"
       ) ? state.selectedVariant : document.selectedVariant,
-      variants: document.variants.filter((variant) => variant.status === "ready").map((variant) => pick(variant, ["id", "label", "status"]))
+      variants: document.variants.filter((variant) => variant.status === "ready").map((variant) => pick(variant, ["id", "label", "status", "props"]))
     },
     envelope: structuredClone(current.envelope),
     entries: structuredClone(current.entries),
-    state: pick(state, ["positions"]),
+    state: {},
     revision: current.revision,
     verification: pick(current.verification ?? {}, ["status"]),
     reviewContext: context,
@@ -963,6 +1087,7 @@ export {
   serialize,
   parse,
   parseFragment,
+  inspectLocalDocumentBody,
   resolveLocalDocumentFile,
   bundleLocalDocument,
   DESIGN_HANDOFF_CONTENT_SCHEMA,
@@ -981,6 +1106,7 @@ export {
   json,
   readJson,
   atomicJson,
+  atomicBytes,
   recoverDesignPublication,
   designSpecPath,
   currentDesign

package/lib/host-packages/openai/openplanr/runtime/design/scripts/design-shared-artifact-support-protocol-contracts-ea2cd15e.mjs

@@ -1,7 +1,7 @@
 import {
   LARGE_OBJECT_LIMITS,
   validateJson
-} from "./design-shared-protocol-contracts-31a760fc.mjs";
+} from "./design-shared-protocol-contracts-b5f28f94.mjs";
 
 // packages/protocol/src/errors.mjs
 var ARTIFACT_ERROR_CODES = Object.freeze({