@drawcall/design 0.8.1 → 0.9.1

package/README.md

@@ -1,6 +1,6 @@
 # @drawcall/design
 
-The typed Drawcall Design v1 contract, client, and remote CLI.
+Typed Drawcall Design contracts, clients, and remote CLI.
 
 ```ts
 import { v1 } from "@drawcall/design";
@@ -10,26 +10,35 @@ 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
+`https://<project-id>.design.drawcallcontent.com/<frame-id>.webp`.
 
 ```sh
-npx @drawcall/design login
-npx @drawcall/design project create showroom
+npx drawcall auth login
+npx drawcall design project create showroom
 # `project list` prints: <project-id> <name>
 
-npx @drawcall/design -p r6z2n9k4x8m1qc frame create racecar \
+npx drawcall design -p r6z2n9k4x8m1qc frame create racecar \
   --type glts --size 800x800
 # `frame create` prints its frame ID and /<frame-id>/ path.
 
-npx @drawcall/design -p r6z2n9k4x8m1qc write /a4z8m2q7v9kcde/index.glts \
+npx drawcall design -p r6z2n9k4x8m1qc write /a4z8m2q7v9kcde/index.glts \
   'export default class Racecar extends THREE.Group {}'
-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 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 reference \
+npx drawcall design -p r6z2n9k4x8m1qc frame create reference \
   --type image --image ./reference.png
-npx @drawcall/design -p r6z2n9k4x8m1qc frame create oak-chair \
+npx drawcall design -p r6z2n9k4x8m1qc frame create oak-chair \
   --type market --asset oak-chair@1.2.3
+
+npx drawcall design -p r6z2n9k4x8m1qc frame generate-image product-shot \
+  --prompt "A clean product photograph" \
+  --reference https://r6z2n9k4x8m1qc.design.drawcallcontent.com/a4z8m2q7v9kcde.webp
+npx drawcall design -p r6z2n9k4x8m1qc frame edit-image b4z8m2q7v9kcdf \
+  --prompt "Use warmer light" --replace \
+  --reference ./lighting.webp
 ```
 
 Design credentials are managed by `@drawcall/auth` and shared with other Drawcall CLIs. Existing
@@ -49,13 +58,17 @@ The MCP tools can be mounted into a server owned by another package:
 import { registerDesignTools, v1 } from "@drawcall/design";
 import { McpServer } from "@modelcontextprotocol/server";
 
-const client = v1.createClient({ authToken: process.env.DRAWCALL_AUTH_TOKEN });
+const options = { authToken: process.env.DRAWCALL_AUTH_TOKEN };
+const client = v1.createClient(options);
 const server = new McpServer({ name: "mcp.drawcall.ai", version: "1.0.0" });
 
 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.
+
 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. 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.

package/dist/browser.d.ts

@@ -1,4 +1,5 @@
 export * as v1 from "./v1/index.js";
+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";
@@ -6,4 +7,4 @@ export { cameraPoseSchema, IMAGE_GENERATION_MODEL, IMAGE_GENERATION_PROVIDER, }
 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, GenerateImageFrame, DesignFile, FileList, FileMutation, FrameExport, Frame, GltsFrame, GltsFrameExport, ImageFrame, ImageFrameExport, ImageGenerationOperation, ImageGenerationProvenance, ImageGenerationResult, MarketFrame, MarketFrameExport, Project, ProjectDerivationStatus, Screenshot, TextFile, User, } from "./v1/schemas.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";

package/dist/browser.js

@@ -1,4 +1,5 @@
 export * as v1 from "./v1/index.js";
+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";

package/dist/cli-client.js

@@ -3,11 +3,15 @@ import { loadConfig } from "./config.js";
 import { createClient, DEFAULT_BASE_URL, } from "./v1/client.js";
 export class NotLoggedInError extends Error {
     constructor() {
-        super("Not logged in. Run `npx @drawcall/design login` first.");
+        super("Not logged in. Run `npx drawcall auth login` first.");
         this.name = "NotLoggedInError";
     }
 }
 export async function getCliClient(baseUrlOverride) {
+    const options = await clientOptions(baseUrlOverride);
+    return createClient(options);
+}
+async function clientOptions(baseUrlOverride) {
     const authToken = await getAuthToken();
     const config = await loadConfig();
     if (!authToken)
@@ -16,5 +20,5 @@ export async function getCliClient(baseUrlOverride) {
         process.env.DESIGN_API_URL ??
         config?.baseUrl ??
         DEFAULT_BASE_URL;
-    return createClient({ baseUrl, authToken });
+    return { baseUrl, authToken };
 }