SDK overview

The Democraft authoring SDK lives in @democraft/core. It is deliberately small: three builders and four locator factories. Everything else (capture, resolution, render) is driven from what these produce.

What's in @democraft/core

import {
  // demo + config builders
  defineDemo,
  defineConfig,
  // target builders
  defineTarget,
  defineTargets,
  // locator factories
  byRole,
  byLabel,
  byTestId,
  byText,
} from "@democraft/core";

The shape of a demo

A DemoDefinition is a plain object — defineDemo is an identity function that exists for type inference and editor jump-to-definition:

{
  id: string,
  title: string,
  source: { baseUrl: string, initialPath?: string },
  targets: Record<string, TargetDefinition>,
  run: ({ demo: DemoCapture }) => Promise<void> | void,
}

The shape of a scene

Inside run, demo.scene(id, run) gives you a DemoScene with fifteen async methods. Each appends one step to the scene. The compiler flattens all scenes into a single ordered step list (the IR), which capture and render consume.

See:

• defineDemo for the full definition reference.
• locators for the four factories and fallback chains.
• scenes for the builder method reference.

A single API, two audiences

This is why the API stays small and predictable: every concept has exactly one place to live, and the fifteen step kinds cover the demo vocabulary without extension points that would fragment the surface.