Scripting Interface

scripting-interface_en.html

This document expands the scripting model into a deterministic interface description suitable for future automation, CLI design, and AI-driven integration.

Model

The interface follows a command → state → composition → render → output flow. Commands mutate or query documented state. Rendering then derives from the same canonical composition model used by the user interface.

COMMAND → STATE → COMPOSITION MODEL → RENDER → OUTPUT

Execution guarantees

• Commands should be side-effect explicit.
• The same command sequence with the same inputs should produce materially equivalent results.
• Readiness-dependent commands should expose readiness rather than guessing timing.
• Command docs must distinguish state mutation, pure inspection, and irreversible output operations.

Argument design rules

• Prefer semantically descriptive enum values over vague booleans where behavior matters.
• Where a boolean is unavoidable, document the default explicitly.
• Arguments affecting output fidelity, QR behavior, localization, or clipping must be called out as high-impact.
• Path names, filenames, and document references should use canonical lowercase forms.

Example end-to-end flow

setDocument({ text: "https://define.com/_MyAnythingList.txt" })
setThumbnail({ mode: "url-art", source: null, fitMode: "contain" })
setQr({ enabled: true, content: "https://8k.art/?myanythinglist=https://define.com/_MyAnythingList.txt", layerPolicy: "dedicated" })
render({ target: "export", resolution: { width: 8192, height: 4320 }, language: "en" })
exportImage({ format: "png", qualityMode: "master", requireQrParity: true })