@drawcall/design 0.9.1 → 0.10.0

package/README.md

@@ -10,7 +10,7 @@ const projects = await design.project.list();
 ```
 
 Projects and frames have immutable 14-character lowercase IDs. A project is a hosted filesystem at `https://<project-id>.design.drawcallcontent.com/`; every frame owns `/<frame-id>/` within it.
-The current rendered image for any GLTS, image, or Market frame is available at
+The current rendered image for any GLTS, Markdown, image, or Market frame is available at
 `https://<project-id>.design.drawcallcontent.com/<frame-id>.webp`.
 
 ```sh
@@ -28,6 +28,11 @@ npx drawcall design -p r6z2n9k4x8m1qc ls /
 npx drawcall design -p r6z2n9k4x8m1qc read /a4z8m2q7v9kcde/index.glts
 npx drawcall design -p r6z2n9k4x8m1qc frame screenshot a4z8m2q7v9kcde
 
+npx drawcall design -p r6z2n9k4x8m1qc frame create release-notes \
+  --type markdown --size 720x900
+npx drawcall design -p r6z2n9k4x8m1qc write /b4z8m2q7v9kcdf/index.md \
+  $'# Release notes\n\n![Racecar](/a4z8m2q7v9kcde.webp)'
+
 npx drawcall design -p r6z2n9k4x8m1qc frame create reference \
   --type image --image ./reference.png
 npx drawcall design -p r6z2n9k4x8m1qc frame create oak-chair \
@@ -66,9 +71,11 @@ registerDesignTools(server, client);
 ```
 
 Image generation accepts public HTTP(S) reference URLs. Use a frame's canonical
-WebP URL to reference a GLTS, image, or Market frame.
+WebP URL to reference a GLTS, Markdown, image, or Market frame.
 
 The host owns the server identity, authentication, and transport. The MCP SDK
 is an optional peer dependency and is required only when mounting these tools.
 
-GLTS frames accept only `.glts` files. An absent `index.glts` still renders an intentionally empty frame. For authored scenes, work top-down: write `index.glts`, reference planned child assets, then implement those children progressively. A missing imported `.glts` path renders a labeled glowing placeholder without creating a stored file; writing the real file replaces it on revalidation. Image and Market files are available through the same filesystem but are read-only. Read `npx drawcall design skill` (or MCP `get_design_instructions`) before creating or changing a GLTS asset.
+GLTS frames accept only `.glts` files. An absent `index.glts` still renders an intentionally empty frame. For authored scenes, work top-down: write `index.glts`, reference planned child assets, then implement those children progressively. A missing imported `.glts` path renders a labeled glowing placeholder without creating a stored file; writing the real file replaces it on revalidation.
+
+Markdown frames accept only `index.md`; an absent source renders an empty document. Embed an existing non-Markdown frame with standard image syntax such as `![Racecar](/a4z8m2q7v9kcde.webp)`. Raw HTML is disabled, Markdown frames cannot embed other Markdown frames, and each document is limited to 32 frame embeds. Image and Market files are available through the same filesystem but are read-only. Read `npx drawcall design skill` (or MCP `get_design_instructions`) before creating or changing a GLTS or Markdown frame.

package/dist/browser.d.ts

@@ -3,8 +3,8 @@ export { frameImageUrl } from "./frame-image.js";
 export { registerDesignTools, type DesignMcpOptions, type DesignMcpServer, type DesignMcpToolResult, } from "./mcp/index.js";
 export { cliDesignSkill, mcpDesignSkill } from "./skill.generated.js";
 export { frameCreationCapabilities, type FrameCreationCapability, type FrameCreationCapabilityId, type FrameCreationInput, } from "./v1/capabilities.js";
-export { cameraPoseSchema, IMAGE_GENERATION_MODEL, IMAGE_GENERATION_PROVIDER, } from "./v1/schemas.js";
+export { cameraPoseSchema, commentBodySchema, commentPositionInputSchema, commentPositionSchema, commentSchema, createCommentSchema, IMAGE_GENERATION_MODEL, IMAGE_GENERATION_PROVIDER, } from "./v1/schemas.js";
 export { parseFrameSize } from "./target.js";
-export { projectFrameLayoutSchema, projectFrameRecordSchema, projectGltsFrameRecordSchema, projectImageFrameRecordSchema, projectMarketFileSchema, projectMarketFrameRecordSchema, projectPresenceClientMessageSchema, projectPresenceServerMessageSchema, projectStateSchema, type ProjectFrameLayout, type ProjectFrameRecord, type ProjectGltsFrameRecord, type ProjectImageFrameRecord, type ProjectMarketFile, type ProjectMarketFrameRecord, type ProjectPresenceClientMessage, type ProjectPresenceServerMessage, type ProjectState, } from "./project-state.js";
-export { cameraCaptureCommandSchema, cameraCaptureResultSchema, cameraMessageTypes, cameraSetCommandSchema, gltsExportCancelCommandSchema, gltsExportCancelledResultSchema, gltsExportCommandSchema, gltsExportFrameMessageSchema, gltsExportMessageTypes, gltsExportParentMessageSchema, gltsExportResultSchema, gltsRuntimeExportFormatSchema, immersiveCommandSchema, immersiveFrameMessageSchema, immersiveMessageTypes, immersiveModeSchema, inspectionCommandSchema, inspectionFrameMessageSchema, inspectionMessageTypes, posterMessageTypes, posterPagePath, posterPageUrl, posterRenderCommandSchema, posterRenderResultSchema, projectSyncUrl, sourceFileChangeSchema, sourceFileMessageTypes, sourceFileReloadResultSchema, sourceFilesChangedMessageSchema, type GltsExportCancelCommand, type GltsExportCancelledResult, type GltsExportCommand, type GltsExportFrameMessage, type GltsExportParentMessage, type GltsExportResult, type GltsRuntimeExportFormat, type CameraCaptureCommand, type CameraSetCommand, type CameraCaptureFailure, type CameraCaptureResult, type InspectionAppliedMessage, type InspectionCommand, type InspectionFrameMessage, type PosterRenderCommand, type PosterRenderResult, type ImmersiveCommand, type ImmersiveFrameMessage, type ImmersiveMode, type SourceFileChange, type SourceFileReloadResult, type SourceFilesChangedMessage, } from "./protocol.js";
-export type { BinaryFile, CameraPose, CreateFrame, CreateProjectFromBrief, CreateGltsFrame, CreateImageFrame, CreateMarketFrame, GenerateImage, GenerateImageUrl, DesignFile, FileList, FileMutation, FrameExport, Frame, GltsFrame, GltsFrameExport, ImageFrame, ImageFrameExport, ImageGenerationOperation, ImageGenerationProvenance, ImageGenerationResult, ImageInput, ImageInputProvenance, MarketFrame, MarketFrameExport, Project, ProjectDerivationStatus, Screenshot, TextFile, User, } from "./v1/schemas.js";
+export { projectFrameLayoutSchema, projectCommentsChangedServerMessageSchema, projectFrameRecordSchema, projectGltsFrameRecordSchema, projectImageFrameRecordSchema, projectMarkdownFrameRecordSchema, projectMarketFileSchema, projectMarketFrameRecordSchema, projectPresenceClientMessageSchema, projectPresenceServerMessageSchema, projectStateSchema, type ProjectFrameLayout, type ProjectCommentsChangedServerMessage, type ProjectFrameRecord, type ProjectGltsFrameRecord, type ProjectImageFrameRecord, type ProjectMarkdownFrameRecord, type ProjectMarketFile, type ProjectMarketFrameRecord, type ProjectPresenceClientMessage, type ProjectPresenceServerMessage, type ProjectState, } from "./project-state.js";
+export { cameraCaptureCommandSchema, cameraCaptureResultSchema, cameraMessageTypes, cameraSetCommandSchema, commentActionMessageSchema, commentActionResultSchema, commentPickCommandSchema, commentPickResultSchema, commentRuntimeMessageTypes, commentSelectionMessageSchema, commentStateCommandSchema, frameRenderResultSchema, gltsExportCancelCommandSchema, gltsExportCancelledResultSchema, gltsExportCommandSchema, gltsExportFrameMessageSchema, gltsExportMessageTypes, gltsExportParentMessageSchema, gltsExportResultSchema, gltsRuntimeExportFormatSchema, immersiveCommandSchema, immersiveFrameMessageSchema, immersiveMessageTypes, immersiveModeSchema, inspectionCommandSchema, inspectionFrameMessageSchema, inspectionMessageTypes, posterMessageTypes, posterPagePath, posterPageUrl, posterRenderCommandSchema, posterRenderResultSchema, previewConfigureCommandSchema, previewLoadCommandSchema, previewLoadResultSchema, previewMessageTypes, previewPagePath, previewPageUrl, previewPixelRatioMax, previewSessionEventSchema, projectSyncUrl, sourceFileChangeSchema, sourceFileMessageTypes, sourceFileReloadResultSchema, sourceFilesChangedMessageSchema, type GltsExportCancelCommand, type GltsExportCancelledResult, type GltsExportCommand, type GltsExportFrameMessage, type GltsExportParentMessage, type GltsExportResult, type GltsRuntimeExportFormat, type CameraCaptureCommand, type CameraSetCommand, type CameraCaptureFailure, type CameraCaptureResult, type CommentActionMessage, type CommentActionResult, type CommentPickCommand, type CommentPickResult, type CommentSelectionMessage, type CommentStateCommand, type FrameRenderResult, type InspectionAppliedMessage, type InspectionCommand, type InspectionFrameMessage, type PosterRenderCommand, type PosterRenderResult, type PreviewLoadCommand, type PreviewLoadResult, type ImmersiveCommand, type ImmersiveFrameMessage, type ImmersiveMode, type SourceFileChange, type SourceFileReloadResult, type SourceFilesChangedMessage, } from "./protocol.js";
+export type { BinaryFile, CameraPose, Comment, CommentAuthor, CommentPosition, CommentPositionInput, CommentReply, CommentResolution, CreateComment, CreateFrame, CreateProjectFromBrief, CreateGltsFrame, CreateImageFrame, CreateMarkdownFrame, CreateMarketFrame, GenerateImage, GenerateImageUrl, DesignFile, FileList, FileMutation, FrameExport, Frame, GltsFrame, GltsFrameExport, ImageFrame, ImageFrameExport, ImageGenerationOperation, ImageGenerationProvenance, ImageGenerationResult, ImageInput, ImageInputProvenance, MarketFrame, MarketFrameExport, MarkdownFrame, MarkdownFrameExport, Project, ProjectDerivationStatus, Screenshot, TextFile, User, } from "./v1/schemas.js";

package/dist/browser.js

@@ -3,7 +3,7 @@ export { frameImageUrl } from "./frame-image.js";
 export { registerDesignTools, } from "./mcp/index.js";
 export { cliDesignSkill, mcpDesignSkill } from "./skill.generated.js";
 export { frameCreationCapabilities, } from "./v1/capabilities.js";
-export { cameraPoseSchema, IMAGE_GENERATION_MODEL, IMAGE_GENERATION_PROVIDER, } from "./v1/schemas.js";
+export { cameraPoseSchema, commentBodySchema, commentPositionInputSchema, commentPositionSchema, commentSchema, createCommentSchema, IMAGE_GENERATION_MODEL, IMAGE_GENERATION_PROVIDER, } from "./v1/schemas.js";
 export { parseFrameSize } from "./target.js";
-export { projectFrameLayoutSchema, projectFrameRecordSchema, projectGltsFrameRecordSchema, projectImageFrameRecordSchema, projectMarketFileSchema, projectMarketFrameRecordSchema, projectPresenceClientMessageSchema, projectPresenceServerMessageSchema, projectStateSchema, } from "./project-state.js";
-export { cameraCaptureCommandSchema, cameraCaptureResultSchema, cameraMessageTypes, cameraSetCommandSchema, gltsExportCancelCommandSchema, gltsExportCancelledResultSchema, gltsExportCommandSchema, gltsExportFrameMessageSchema, gltsExportMessageTypes, gltsExportParentMessageSchema, gltsExportResultSchema, gltsRuntimeExportFormatSchema, immersiveCommandSchema, immersiveFrameMessageSchema, immersiveMessageTypes, immersiveModeSchema, inspectionCommandSchema, inspectionFrameMessageSchema, inspectionMessageTypes, posterMessageTypes, posterPagePath, posterPageUrl, posterRenderCommandSchema, posterRenderResultSchema, projectSyncUrl, sourceFileChangeSchema, sourceFileMessageTypes, sourceFileReloadResultSchema, sourceFilesChangedMessageSchema, } from "./protocol.js";
+export { projectFrameLayoutSchema, projectCommentsChangedServerMessageSchema, projectFrameRecordSchema, projectGltsFrameRecordSchema, projectImageFrameRecordSchema, projectMarkdownFrameRecordSchema, projectMarketFileSchema, projectMarketFrameRecordSchema, projectPresenceClientMessageSchema, projectPresenceServerMessageSchema, projectStateSchema, } from "./project-state.js";
+export { cameraCaptureCommandSchema, cameraCaptureResultSchema, cameraMessageTypes, cameraSetCommandSchema, commentActionMessageSchema, commentActionResultSchema, commentPickCommandSchema, commentPickResultSchema, commentRuntimeMessageTypes, commentSelectionMessageSchema, commentStateCommandSchema, frameRenderResultSchema, gltsExportCancelCommandSchema, gltsExportCancelledResultSchema, gltsExportCommandSchema, gltsExportFrameMessageSchema, gltsExportMessageTypes, gltsExportParentMessageSchema, gltsExportResultSchema, gltsRuntimeExportFormatSchema, immersiveCommandSchema, immersiveFrameMessageSchema, immersiveMessageTypes, immersiveModeSchema, inspectionCommandSchema, inspectionFrameMessageSchema, inspectionMessageTypes, posterMessageTypes, posterPagePath, posterPageUrl, posterRenderCommandSchema, posterRenderResultSchema, previewConfigureCommandSchema, previewLoadCommandSchema, previewLoadResultSchema, previewMessageTypes, previewPagePath, previewPageUrl, previewPixelRatioMax, previewSessionEventSchema, projectSyncUrl, sourceFileChangeSchema, sourceFileMessageTypes, sourceFileReloadResultSchema, sourceFilesChangedMessageSchema, } from "./protocol.js";

package/dist/command/comment.d.ts

@@ -0,0 +1,2 @@
+import type { Command } from "commander";
+export declare function registerCommentCommands(program: Command): void;

package/dist/command/comment.js

@@ -0,0 +1,142 @@
+import { designIdSchema, } from "../v1/schemas.js";
+import { clientFor, projectId, requireConfirmation } from "./context.js";
+import { textArgument } from "./input.js";
+export function registerCommentCommands(program) {
+    const comment = program.command("comment").description("Manage comments");
+    comment
+        .command("list")
+        .description("List comments, optionally for one frame")
+        .argument("[frame-id]", "Frame ID")
+        .action(async (frameId, _options, command) => {
+        const client = await clientFor(command);
+        const comments = await client.comment.list({
+            project: projectId(command),
+            ...(frameId ? { frame: designIdSchema.parse(frameId) } : {}),
+        });
+        for (const item of comments)
+            console.log(commentLine(item));
+    });
+    comment
+        .command("show")
+        .description("Show a comment and its replies")
+        .argument("<comment-id>", "Comment ID")
+        .action(async (commentId, _options, command) => {
+        const client = await clientFor(command);
+        const result = await client.comment.get({
+            project: projectId(command),
+            comment: designIdSchema.parse(commentId),
+        });
+        console.log(JSON.stringify(result, null, 2));
+    });
+    comment
+        .command("create")
+        .description("Create a frame or positioned comment")
+        .argument("<frame-id>", "Frame ID")
+        .argument("[text]", "Inline text; omit or use - to read stdin")
+        .option("--position-2d <x,y>", "Normalized position in an image frame")
+        .option("--position-3d <x,y,z>", "World position in a GLTS frame")
+        .action(async (frameId, text, options, command) => {
+        const client = await clientFor(command);
+        const project = projectId(command);
+        const frame = designIdSchema.parse(frameId);
+        const position = commentPosition(options);
+        const body = await textArgument(text);
+        const created = await client.comment.create(position
+            ? {
+                project,
+                frame,
+                body,
+                position,
+                expectedContentRevision: await commentPositionRevision(client, project, frame, position.kind),
+            }
+            : { project, frame, body });
+        console.log(`Created ${created.id}.`);
+    });
+    comment
+        .command("reply")
+        .description("Reply to a comment")
+        .argument("<comment-id>", "Comment ID")
+        .argument("[text]", "Inline text; omit or use - to read stdin")
+        .action(async (commentId, text, _options, command) => {
+        const client = await clientFor(command);
+        const updated = await client.comment.reply({
+            project: projectId(command),
+            comment: designIdSchema.parse(commentId),
+            body: await textArgument(text),
+        });
+        console.log(`Replied to ${updated.id}.`);
+    });
+    registerResolutionCommand(comment, "resolve", true);
+    registerResolutionCommand(comment, "reopen", false);
+    comment
+        .command("delete")
+        .description("Delete a comment or reply")
+        .argument("<comment-id>", "Comment or reply ID")
+        .option("-y, --yes", "Confirm deletion", false)
+        .action(async (commentId, options, command) => {
+        requireConfirmation(options.yes);
+        const client = await clientFor(command);
+        const deleted = await client.comment.delete({
+            project: projectId(command),
+            comment: designIdSchema.parse(commentId),
+        });
+        console.log(`Deleted ${deleted.id}.`);
+    });
+}
+function registerResolutionCommand(comment, name, resolved) {
+    comment
+        .command(name)
+        .description(`${resolved ? "Resolve" : "Reopen"} a comment`)
+        .argument("<comment-id>", "Comment ID")
+        .action(async (commentId, _options, command) => {
+        const client = await clientFor(command);
+        const updated = await client.comment.setResolved({
+            project: projectId(command),
+            comment: designIdSchema.parse(commentId),
+            resolved,
+        });
+        console.log(`${resolved ? "Resolved" : "Reopened"} ${updated.id}.`);
+    });
+}
+function commentPosition(options) {
+    if (options.position2d && options.position3d) {
+        throw new Error("Choose at most one of --position-2d or --position-3d.");
+    }
+    if (options.position2d) {
+        const [x, y] = coordinates(options.position2d, 2);
+        return { kind: "2d", x, y };
+    }
+    if (options.position3d) {
+        const [x, y, z] = coordinates(options.position3d, 3);
+        return { kind: "3d", x, y, z };
+    }
+}
+function coordinates(value, count) {
+    const parts = value.split(",");
+    const coordinates = parts.map(Number);
+    if (coordinates.length !== count ||
+        parts.some((part) => part.trim() === "") ||
+        coordinates.some((coordinate) => !Number.isFinite(coordinate))) {
+        throw new Error(`Position must contain ${count} comma-separated numbers.`);
+    }
+    return coordinates;
+}
+async function commentPositionRevision(client, project, frame, position) {
+    const target = (await client.frame.list({ project })).find((candidate) => candidate.id === frame);
+    if (!target)
+        throw new Error(`Frame ${frame} does not exist.`);
+    if ((position === "2d" && target.type !== "image") ||
+        (position === "3d" && target.type !== "glts")) {
+        throw new Error(`${target.type} frames do not support ${position.toUpperCase()} comment positions.`);
+    }
+    if (target.contentRevision === undefined) {
+        throw new Error(`Frame ${frame} has no content revision.`);
+    }
+    return target.contentRevision;
+}
+function commentLine(comment) {
+    const status = comment.resolution ? "resolved" : "open";
+    const position = comment.position?.kind ?? "frame";
+    const body = comment.body.replace(/\s+/gu, " ");
+    return `${comment.id}\t${comment.frameId}\t${position}\t${status}\t${comment.author.name}\t${body}`;
+}