@drawcall/design 0.5.8 → 0.5.11

package/README.md

@@ -32,4 +32,34 @@ npx @drawcall/design -p r6z2n9k4x8m1qc frame create oak-chair \
   --type market --asset oak-chair@1.2.3
 ```
 
+Design credentials are managed by `@drawcall/auth` and shared with other Drawcall CLIs. Existing
+credentials in `drawcall-design/config.json` migrate automatically.
+
+The Commander implementation is available for aggregate CLIs:
+
+```ts
+import { createDesignCommand } from "@drawcall/design";
+
+program.addCommand(createDesignCommand({ includeAuthCommands: false }));
+```
+
+The MCP tools can be mounted into a server owned by another package:
+
+```ts
+import {
+  createDesignMcpOperations,
+  registerDesignTools,
+  v1,
+} from "@drawcall/design";
+import { McpServer } from "@modelcontextprotocol/server";
+
+const client = v1.createClient({ authToken: process.env.DRAWCALL_AUTH_TOKEN });
+const server = new McpServer({ name: "mcp.drawcall.ai", version: "1.0.0" });
+
+registerDesignTools(server, createDesignMcpOperations(client));
+```
+
+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_skill`) before creating or changing a GLTS asset.

package/dist/browser.d.ts

@@ -0,0 +1,9 @@
+export * as v1 from "./v1/index.js";
+export { createDesignMcpOperations, registerDesignTools, type DesignMcpOperationRunner, type DesignMcpOperations, type DesignMcpServer, type DesignMcpScreenshot, 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 { 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, 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 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";

package/dist/browser.js

@@ -0,0 +1,8 @@
+export * as v1 from "./v1/index.js";
+export { createDesignMcpOperations, 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 { 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, projectSyncUrl, sourceFileChangeSchema, sourceFileMessageTypes, sourceFileReloadResultSchema, sourceFilesChangedMessageSchema, } from "./protocol.js";

package/dist/cli-client.js

@@ -1,3 +1,4 @@
+import { getAuthToken } from "@drawcall/auth";
 import { loadConfig } from "./config.js";
 import { createClient, DEFAULT_BASE_URL, } from "./v1/client.js";
 export class NotLoggedInError extends Error {
@@ -7,8 +8,8 @@ export class NotLoggedInError extends Error {
     }
 }
 export async function getCliClient(baseUrlOverride) {
+    const authToken = await getAuthToken();
     const config = await loadConfig();
-    const authToken = process.env.DRAWCALL_AUTH_TOKEN ?? config?.authToken;
     if (!authToken)
         throw new NotLoggedInError();
     const baseUrl = baseUrlOverride ??

package/dist/cli.js

@@ -1,224 +1,6 @@
 #!/usr/bin/env node
-import { createRequire } from "node:module";
-import { Command, Option } from "commander";
-import { clearConfig, getConfigPath, saveConfig } from "./config.js";
-import { getCliClient } from "./cli-client.js";
-import { readImageInput } from "./image.js";
-import { cliDesignSkill } from "./skill.generated.js";
-import { parseFrameSize } from "./target.js";
-import { createClient, DEFAULT_BASE_URL } from "./v1/client.js";
-import { designIdSchema, marketAssetSchema } from "./v1/schemas.js";
-const AUTH_ISSUER_URL = "https://auth.drawcall.ai/api/auth";
-const DEVICE_CLIENT_ID = "drawcall-cli";
-const program = new Command()
-    .name("design")
-    .description("Design 3D assets on Drawcall Design")
-    .version(readPackageVersion())
-    .addOption(new Option("--api <url>", "Design API URL").default(process.env.DESIGN_API_URL, "from DESIGN_API_URL / config / default"))
-    .addOption(new Option("-p, --project <id>", "Project ID"));
-program
-    .command("skill")
-    .description("Print the Drawcall Design skill")
-    .action(() => {
-    process.stdout.write(cliDesignSkill);
-});
-program
-    .command("login")
-    .description("Sign in with your Drawcall account")
-    .action(async (_options, command) => {
-    const baseUrlOverride = apiOption(command);
-    const baseUrl = baseUrlOverride ?? DEFAULT_BASE_URL;
-    const token = await runDeviceLogin();
-    const client = createClient({ baseUrl, authToken: token });
-    const user = await client.user.me();
-    await saveConfig(baseUrlOverride ? { authToken: token, baseUrl } : { authToken: token });
-    console.log(`Signed in as ${user.email}. Credentials saved to ${getConfigPath()}.`);
-});
-program
-    .command("logout")
-    .description("Sign out")
-    .action(async () => {
-    console.log((await clearConfig()) ? "Signed out." : "Already signed out.");
-});
-const project = program.command("project").description("Manage projects");
-project
-    .command("list")
-    .description("List projects")
-    .action(async (_options, command) => {
-    const client = await clientFor(command);
-    const projects = await client.project.list();
-    if (projects.length === 0) {
-        console.log("No projects.");
-        return;
-    }
-    for (const item of projects)
-        console.log(`${item.id}\t${item.name}`);
-});
-project
-    .command("create")
-    .description("Create a project")
-    .argument("<name>", "Project name")
-    .action(async (name, _options, command) => {
-    const client = await clientFor(command);
-    const created = await client.project.create({ name });
-    console.log(`Created ${created.id}\t${created.name}`);
-});
-project
-    .command("delete")
-    .description("Delete a project")
-    .argument("<project-id>", "Project ID")
-    .option("-y, --yes", "Confirm deletion", false)
-    .action(async (projectId, options, command) => {
-    requireConfirmation(options.yes);
-    const id = designIdSchema.parse(projectId);
-    const client = await clientFor(command);
-    await client.project.delete({ project: id });
-    console.log(`Deleted ${id}.`);
-});
-const frame = program.command("frame").description("Manage frames");
-frame
-    .command("list")
-    .description("List frames in the selected project")
-    .action(async (_options, command) => {
-    const client = await clientFor(command);
-    const frames = await client.frame.list({ project: projectId(command) });
-    if (frames.length === 0) {
-        console.log("No frames.");
-        return;
-    }
-    for (const item of frames) {
-        console.log(`${item.id}\t${item.name}\t${item.type}\t${item.width}x${item.height}`);
-    }
-});
-frame
-    .command("create")
-    .description("Create a GLTS, image, or pinned Market frame")
-    .argument("<name>", "Frame name")
-    .requiredOption("-t, --type <type>", "glts, image, or market")
-    .option("-s, --size <width>x<height>", "GLTS viewport size")
-    .option("--image <url-or-path>", "Image URL or local PNG, JPEG, or WebP")
-    .option("--asset <name@version>", "Exact public Market asset version")
-    .action(async (name, options, command) => {
-    const project = projectId(command);
-    const input = await createFrameInput(project, name, options);
-    const client = await clientFor(command);
-    const created = await client.frame.create(input);
-    console.log(`Created ${created.id}\t${created.name}\t${created.type}`);
-    console.log(`Path /${created.id}/`);
-});
-frame
-    .command("rename")
-    .description("Rename a frame")
-    .argument("<frame-id>", "Frame ID")
-    .argument("<name>", "New frame name")
-    .action(async (frameId, name, _options, command) => {
-    const id = designIdSchema.parse(frameId);
-    const client = await clientFor(command);
-    const renamed = await client.frame.rename({
-        project: projectId(command),
-        frame: id,
-        name,
-    });
-    console.log(`Renamed ${renamed.id}\t${renamed.name}.`);
-});
-frame
-    .command("delete")
-    .description("Delete frames")
-    .argument("<frame-id...>", "Frame IDs")
-    .option("-y, --yes", "Confirm deletion", false)
-    .action(async (frameIds, options, command) => {
-    requireConfirmation(options.yes);
-    const project = projectId(command);
-    const client = await clientFor(command);
-    for (const frameId of frameIds) {
-        const id = designIdSchema.parse(frameId);
-        await client.frame.delete({ project, frame: id });
-        console.log(`Deleted ${id}.`);
-    }
-});
-frame
-    .command("screenshot")
-    .description("Render frames and print their screenshot URLs")
-    .argument("<frame-id...>", "Frame IDs")
-    .action(async (frameIds, _options, command) => {
-    const project = projectId(command);
-    const client = await clientFor(command);
-    for (const frameId of frameIds) {
-        const id = designIdSchema.parse(frameId);
-        const result = await client.frame.screenshot({ project, frame: id });
-        console.log(`${id}\t${result.url}`);
-    }
-});
-program
-    .command("ls")
-    .description("List paths in the selected project filesystem")
-    .argument("[path]", "Absolute directory path", "/")
-    .action(async (path, _options, command) => {
-    const client = await clientFor(command);
-    const result = await client.filesystem.list({
-        project: projectId(command),
-        path,
-    });
-    for (const item of result.paths)
-        console.log(item);
-});
-program
-    .command("read")
-    .description("Read a project file")
-    .argument("<path>", "Absolute project path")
-    .action(async (path, _options, command) => {
-    const client = await clientFor(command);
-    const file = await client.filesystem.read({
-        project: projectId(command),
-        path,
-    });
-    if (file.type === "text") {
-        process.stdout.write(file.text);
-        return;
-    }
-    console.log(file.url);
-});
-program
-    .command("write")
-    .description("Create or overwrite a text project file")
-    .argument("<path>", "Absolute project path")
-    .argument("[text]", "Inline text; omit or use - to read stdin")
-    .action(async (path, text, _options, command) => {
-    const client = await clientFor(command);
-    await client.filesystem.write({
-        project: projectId(command),
-        path,
-        text: text === undefined || text === "-" ? await readStdin() : text,
-    });
-    console.log(`Wrote ${path}.`);
-});
-program
-    .command("edit")
-    .description("Replace text that occurs exactly once in a project file")
-    .argument("<path>", "Absolute project path")
-    .argument("<old-text>", "Text that must occur exactly once")
-    .argument("<new-text>", "Replacement text")
-    .action(async (path, oldText, newText, _options, command) => {
-    const client = await clientFor(command);
-    await client.filesystem.edit({
-        project: projectId(command),
-        path,
-        oldText,
-        newText,
-    });
-    console.log(`Edited ${path}.`);
-});
-program
-    .command("delete")
-    .description("Delete a project file")
-    .argument("<path>", "Absolute project path")
-    .option("-y, --yes", "Confirm deletion", false)
-    .action(async (path, options, command) => {
-    requireConfirmation(options.yes);
-    const client = await clientFor(command);
-    await client.filesystem.delete({ project: projectId(command), path });
-    console.log(`Deleted ${path}.`);
-});
+import { createDesignCommand } from "./command.js";
+const program = createDesignCommand();
 if (process.argv.length <= 2) {
     program.outputHelp();
 }
@@ -228,106 +10,3 @@ else {
         process.exitCode = 1;
     });
 }
-async function createFrameInput(project, name, options) {
-    if (options.type === "glts") {
-        if (options.image !== undefined || options.asset !== undefined) {
-            throw new Error("GLTS frames do not accept --image or --asset");
-        }
-        if (options.size === undefined) {
-            throw new Error("GLTS frames require --size <width>x<height>");
-        }
-        return {
-            project,
-            name,
-            type: "glts",
-            ...parseFrameSize(options.size),
-        };
-    }
-    if (options.type === "image") {
-        if (options.size !== undefined || options.asset !== undefined) {
-            throw new Error("Image frames do not accept --size or --asset");
-        }
-        if (options.image === undefined)
-            throw new Error("Image frames require --image");
-        return {
-            project,
-            name,
-            type: "image",
-            image: await readImageInput(options.image),
-        };
-    }
-    if (options.type === "market") {
-        if (options.size !== undefined || options.image !== undefined) {
-            throw new Error("Market frames do not accept --size or --image");
-        }
-        if (options.asset === undefined)
-            throw new Error("Market frames require --asset");
-        return {
-            project,
-            name,
-            type: "market",
-            asset: marketAssetSchema.parse(options.asset),
-        };
-    }
-    throw new Error("--type must be glts, image, or market");
-}
-async function clientFor(command) {
-    return getCliClient(apiOption(command));
-}
-function apiOption(command) {
-    const value = command.optsWithGlobals().api;
-    return typeof value === "string" ? value : undefined;
-}
-function projectId(command) {
-    const value = command.optsWithGlobals().project;
-    if (typeof value !== "string") {
-        throw new Error("Select a project with -p, --project <project-id>.");
-    }
-    return designIdSchema.parse(value);
-}
-function requireConfirmation(confirmed) {
-    if (!confirmed)
-        throw new Error("Destructive commands require --yes.");
-}
-async function readStdin() {
-    const chunks = [];
-    for await (const chunk of process.stdin) {
-        chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
-    }
-    return Buffer.concat(chunks).toString("utf8");
-}
-function readPackageVersion() {
-    const manifest = createRequire(import.meta.url)("../package.json");
-    if (!manifest ||
-        typeof manifest !== "object" ||
-        Array.isArray(manifest) ||
-        !("version" in manifest) ||
-        typeof manifest.version !== "string") {
-        throw new Error("@drawcall/design package.json is missing a valid version");
-    }
-    return manifest.version;
-}
-async function runDeviceLogin() {
-    const [{ default: open }, oauth] = await Promise.all([
-        import("open"),
-        import("openid-client"),
-    ]);
-    const configuration = await oauth.discovery(new URL(AUTH_ISSUER_URL), DEVICE_CLIENT_ID, undefined, oauth.None());
-    const authorization = await oauth.initiateDeviceAuthorization(configuration, {
-        scope: "design",
-    });
-    const verificationUrl = authorization.verification_uri_complete ?? authorization.verification_uri;
-    console.log(`Open ${verificationUrl}`);
-    console.log(`Code: ${authorization.user_code}`);
-    try {
-        await open(verificationUrl);
-    }
-    catch (error) {
-        const message = error instanceof Error ? error.message : String(error);
-        console.error(`Could not open a browser automatically: ${message}`);
-    }
-    const tokens = await oauth.pollDeviceAuthorizationGrant(configuration, authorization);
-    if (!tokens.access_token)
-        throw new Error("Device login completed without an access token.");
-    return tokens.access_token;
-}

package/dist/command.d.ts

@@ -0,0 +1,7 @@
+import { Command } from "commander";
+export interface DesignCommandOptions {
+    name?: string;
+    version?: string;
+    includeAuthCommands?: boolean;
+}
+export declare function createDesignCommand(options?: DesignCommandOptions): Command;