@anvpx/motion-schema 0.0.0-stage → 0.1.0

package/dist/template.d.ts

@@ -0,0 +1,478 @@
+import { z } from "zod";
+import { type Result } from "./errors.ts";
+/** Manifest format version; a breaking change bumps it. */
+export declare const TEMPLATE_VERSION = 1;
+/**
+ * Blueprint scene-prop transforms (`{"$slot": name, "as": ...}`), closed set. `flow-nodes`: labels to
+ * `{id,label}`; `flow-edges`: "A>B" or "A>B|label" to `{from,to,label}`; `flow-chain`: labels to a
+ * consecutive-edge chain.
+ */
+export declare const SLOT_TRANSFORMS: readonly ["flow-nodes", "flow-edges", "flow-chain"];
+/** Length classes of a pacing document. */
+export declare const LENGTH_CLASSES: readonly ["short", "standard", "long"];
+/** Template level `discover`; lengths are derived from its blueprints, never stored. */
+export declare const ManifestDiscoverSchema: z.ZodObject<{
+    useCases: z.ZodArray<z.ZodString>;
+    audience: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    goodFor: z.ZodString;
+    notFor: z.ZodOptional<z.ZodString>;
+    tags: z.ZodArray<z.ZodString>;
+    tone: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    aspects: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strict>;
+/** Blueprint level `discover`; `lengths` are seconds. */
+export declare const BlueprintDiscoverSchema: z.ZodObject<{
+    useCases: z.ZodArray<z.ZodString>;
+    audience: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    goodFor: z.ZodString;
+    notFor: z.ZodOptional<z.ZodString>;
+    tags: z.ZodArray<z.ZodString>;
+    tone: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    aspects: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    lengths: z.ZodOptional<z.ZodObject<{
+        min: z.ZodNumber;
+        max: z.ZodNumber;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export declare const SlotSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    required: z.ZodOptional<z.ZodBoolean>;
+    optional: z.ZodOptional<z.ZodBoolean>;
+    type: z.ZodLiteral<"text">;
+    min: z.ZodOptional<z.ZodNumber>;
+    max: z.ZodOptional<z.ZodNumber>;
+    default: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+    required: z.ZodOptional<z.ZodBoolean>;
+    optional: z.ZodOptional<z.ZodBoolean>;
+    type: z.ZodLiteral<"text[]">;
+    min: z.ZodOptional<z.ZodNumber>;
+    max: z.ZodOptional<z.ZodNumber>;
+    itemMax: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>, z.ZodObject<{
+    required: z.ZodOptional<z.ZodBoolean>;
+    optional: z.ZodOptional<z.ZodBoolean>;
+    type: z.ZodLiteral<"number">;
+    min: z.ZodOptional<z.ZodNumber>;
+    max: z.ZodOptional<z.ZodNumber>;
+    int: z.ZodOptional<z.ZodBoolean>;
+    default: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"enum">;
+    values: z.ZodArray<z.ZodString>;
+    default: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+    required: z.ZodOptional<z.ZodBoolean>;
+    optional: z.ZodOptional<z.ZodBoolean>;
+    type: z.ZodLiteral<"object">;
+    fields: z.ZodRecord<z.ZodString, z.ZodEnum<{
+        number: "number";
+        text: "text";
+    }>>;
+    list: z.ZodOptional<z.ZodBoolean>;
+    min: z.ZodOptional<z.ZodNumber>;
+    max: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>], "type">;
+/** A blueprint scene: a storyboard scene whose props may hold `$slot`/`$spread`/`$item` constructs. */
+export declare const BlueprintSceneSchema: z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodString;
+    duration: z.ZodOptional<z.ZodNumber>;
+    narration: z.ZodOptional<z.ZodString>;
+    words: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        w: z.ZodString;
+        start: z.ZodNumber;
+        end: z.ZodNumber;
+        confidence: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>>;
+    props: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    shot: z.ZodOptional<z.ZodEnum<{
+        close: "close";
+        medium: "medium";
+        overhead: "overhead";
+        wide: "wide";
+    }>>;
+    move: z.ZodOptional<z.ZodEnum<{
+        orbit: "orbit";
+        "pan-l": "pan-l";
+        "pan-r": "pan-r";
+        "pull-out": "pull-out";
+        "push-in": "push-in";
+        reveal: "reveal";
+        static: "static";
+        tilt: "tilt";
+    }>>;
+    ease: z.ZodOptional<z.ZodEnum<{
+        in: "in";
+        "in-out": "in-out";
+        linear: "linear";
+        out: "out";
+        "spring-snappy": "spring-snappy";
+        "spring-soft": "spring-soft";
+    }>>;
+    transition: z.ZodOptional<z.ZodEnum<{
+        crossfade: "crossfade";
+        cut: "cut";
+        push: "push";
+        wipe: "wipe";
+        "zoom-through": "zoom-through";
+    }>>;
+    focus: z.ZodOptional<z.ZodString>;
+    layer: z.ZodOptional<z.ZodEnum<{
+        base: "base";
+        overlay: "overlay";
+    }>>;
+    over: z.ZodOptional<z.ZodString>;
+    offset: z.ZodOptional<z.ZodNumber>;
+    when: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/** One scene per item of a list slot; `$item` inside refers to the current item, ids get `-<n>`. */
+export declare const BlueprintRepeatSchema: z.ZodObject<{
+    $repeat: z.ZodString;
+    when: z.ZodOptional<z.ZodString>;
+    scene: z.ZodObject<{
+        id: z.ZodString;
+        type: z.ZodString;
+        duration: z.ZodOptional<z.ZodNumber>;
+        narration: z.ZodOptional<z.ZodString>;
+        words: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            w: z.ZodString;
+            start: z.ZodNumber;
+            end: z.ZodNumber;
+            confidence: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strict>>>;
+        props: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        shot: z.ZodOptional<z.ZodEnum<{
+            close: "close";
+            medium: "medium";
+            overhead: "overhead";
+            wide: "wide";
+        }>>;
+        move: z.ZodOptional<z.ZodEnum<{
+            orbit: "orbit";
+            "pan-l": "pan-l";
+            "pan-r": "pan-r";
+            "pull-out": "pull-out";
+            "push-in": "push-in";
+            reveal: "reveal";
+            static: "static";
+            tilt: "tilt";
+        }>>;
+        ease: z.ZodOptional<z.ZodEnum<{
+            in: "in";
+            "in-out": "in-out";
+            linear: "linear";
+            out: "out";
+            "spring-snappy": "spring-snappy";
+            "spring-soft": "spring-soft";
+        }>>;
+        transition: z.ZodOptional<z.ZodEnum<{
+            crossfade: "crossfade";
+            cut: "cut";
+            push: "push";
+            wipe: "wipe";
+            "zoom-through": "zoom-through";
+        }>>;
+        focus: z.ZodOptional<z.ZodString>;
+        layer: z.ZodOptional<z.ZodEnum<{
+            base: "base";
+            overlay: "overlay";
+        }>>;
+        over: z.ZodOptional<z.ZodString>;
+        offset: z.ZodOptional<z.ZodNumber>;
+        when: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+export declare const BlueprintDocSchema: z.ZodObject<{
+    id: z.ZodString;
+    purpose: z.ZodString;
+    discover: z.ZodOptional<z.ZodObject<{
+        useCases: z.ZodArray<z.ZodString>;
+        audience: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        goodFor: z.ZodString;
+        notFor: z.ZodOptional<z.ZodString>;
+        tags: z.ZodArray<z.ZodString>;
+        tone: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        aspects: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        lengths: z.ZodOptional<z.ZodObject<{
+            min: z.ZodNumber;
+            max: z.ZodNumber;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    slots: z.ZodRecord<z.ZodString, z.ZodDiscriminatedUnion<[z.ZodObject<{
+        required: z.ZodOptional<z.ZodBoolean>;
+        optional: z.ZodOptional<z.ZodBoolean>;
+        type: z.ZodLiteral<"text">;
+        min: z.ZodOptional<z.ZodNumber>;
+        max: z.ZodOptional<z.ZodNumber>;
+        default: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>, z.ZodObject<{
+        required: z.ZodOptional<z.ZodBoolean>;
+        optional: z.ZodOptional<z.ZodBoolean>;
+        type: z.ZodLiteral<"text[]">;
+        min: z.ZodOptional<z.ZodNumber>;
+        max: z.ZodOptional<z.ZodNumber>;
+        itemMax: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>, z.ZodObject<{
+        required: z.ZodOptional<z.ZodBoolean>;
+        optional: z.ZodOptional<z.ZodBoolean>;
+        type: z.ZodLiteral<"number">;
+        min: z.ZodOptional<z.ZodNumber>;
+        max: z.ZodOptional<z.ZodNumber>;
+        int: z.ZodOptional<z.ZodBoolean>;
+        default: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>, z.ZodObject<{
+        type: z.ZodLiteral<"enum">;
+        values: z.ZodArray<z.ZodString>;
+        default: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>, z.ZodObject<{
+        required: z.ZodOptional<z.ZodBoolean>;
+        optional: z.ZodOptional<z.ZodBoolean>;
+        type: z.ZodLiteral<"object">;
+        fields: z.ZodRecord<z.ZodString, z.ZodEnum<{
+            number: "number";
+            text: "text";
+        }>>;
+        list: z.ZodOptional<z.ZodBoolean>;
+        min: z.ZodOptional<z.ZodNumber>;
+        max: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>], "type">>;
+    example: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    meta: z.ZodOptional<z.ZodObject<{
+        title: z.ZodOptional<z.ZodUnknown>;
+        lang: z.ZodOptional<z.ZodString>;
+        approval: z.ZodOptional<z.ZodEnum<{
+            auto: "auto";
+            confirm: "confirm";
+        }>>;
+    }, z.core.$strict>>;
+    scenes: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+        $repeat: z.ZodString;
+        when: z.ZodOptional<z.ZodString>;
+        scene: z.ZodObject<{
+            id: z.ZodString;
+            type: z.ZodString;
+            duration: z.ZodOptional<z.ZodNumber>;
+            narration: z.ZodOptional<z.ZodString>;
+            words: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                w: z.ZodString;
+                start: z.ZodNumber;
+                end: z.ZodNumber;
+                confidence: z.ZodOptional<z.ZodNumber>;
+            }, z.core.$strict>>>;
+            props: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+            shot: z.ZodOptional<z.ZodEnum<{
+                close: "close";
+                medium: "medium";
+                overhead: "overhead";
+                wide: "wide";
+            }>>;
+            move: z.ZodOptional<z.ZodEnum<{
+                orbit: "orbit";
+                "pan-l": "pan-l";
+                "pan-r": "pan-r";
+                "pull-out": "pull-out";
+                "push-in": "push-in";
+                reveal: "reveal";
+                static: "static";
+                tilt: "tilt";
+            }>>;
+            ease: z.ZodOptional<z.ZodEnum<{
+                in: "in";
+                "in-out": "in-out";
+                linear: "linear";
+                out: "out";
+                "spring-snappy": "spring-snappy";
+                "spring-soft": "spring-soft";
+            }>>;
+            transition: z.ZodOptional<z.ZodEnum<{
+                crossfade: "crossfade";
+                cut: "cut";
+                push: "push";
+                wipe: "wipe";
+                "zoom-through": "zoom-through";
+            }>>;
+            focus: z.ZodOptional<z.ZodString>;
+            layer: z.ZodOptional<z.ZodEnum<{
+                base: "base";
+                overlay: "overlay";
+            }>>;
+            over: z.ZodOptional<z.ZodString>;
+            offset: z.ZodOptional<z.ZodNumber>;
+            when: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        id: z.ZodString;
+        type: z.ZodString;
+        duration: z.ZodOptional<z.ZodNumber>;
+        narration: z.ZodOptional<z.ZodString>;
+        words: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            w: z.ZodString;
+            start: z.ZodNumber;
+            end: z.ZodNumber;
+            confidence: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strict>>>;
+        props: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        shot: z.ZodOptional<z.ZodEnum<{
+            close: "close";
+            medium: "medium";
+            overhead: "overhead";
+            wide: "wide";
+        }>>;
+        move: z.ZodOptional<z.ZodEnum<{
+            orbit: "orbit";
+            "pan-l": "pan-l";
+            "pan-r": "pan-r";
+            "pull-out": "pull-out";
+            "push-in": "push-in";
+            reveal: "reveal";
+            static: "static";
+            tilt: "tilt";
+        }>>;
+        ease: z.ZodOptional<z.ZodEnum<{
+            in: "in";
+            "in-out": "in-out";
+            linear: "linear";
+            out: "out";
+            "spring-snappy": "spring-snappy";
+            "spring-soft": "spring-soft";
+        }>>;
+        transition: z.ZodOptional<z.ZodEnum<{
+            crossfade: "crossfade";
+            cut: "cut";
+            push: "push";
+            wipe: "wipe";
+            "zoom-through": "zoom-through";
+        }>>;
+        focus: z.ZodOptional<z.ZodString>;
+        layer: z.ZodOptional<z.ZodEnum<{
+            base: "base";
+            overlay: "overlay";
+        }>>;
+        over: z.ZodOptional<z.ZodString>;
+        offset: z.ZodOptional<z.ZodNumber>;
+        when: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>]>>;
+}, z.core.$strict>;
+export declare const TemplateManifestSchema: z.ZodObject<{
+    templateVersion: z.ZodLiteral<1>;
+    id: z.ZodString;
+    version: z.ZodString;
+    title: z.ZodString;
+    summary: z.ZodString;
+    domains: z.ZodArray<z.ZodString>;
+    discover: z.ZodOptional<z.ZodObject<{
+        useCases: z.ZodArray<z.ZodString>;
+        audience: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        goodFor: z.ZodString;
+        notFor: z.ZodOptional<z.ZodString>;
+        tags: z.ZodArray<z.ZodString>;
+        tone: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        aspects: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>>;
+    requires: z.ZodObject<{
+        storyboard: z.ZodNumber;
+        scenes: z.ZodArray<z.ZodString>;
+    }, z.core.$strict>;
+    themes: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        file: z.ZodString;
+        mode: z.ZodEnum<{
+            dark: "dark";
+            light: "light";
+        }>;
+        pair: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    styles: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        file: z.ZodString;
+    }, z.core.$strict>>;
+    blueprints: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        file: z.ZodString;
+    }, z.core.$strict>>;
+    pacing: z.ZodString;
+    copy: z.ZodString;
+    license: z.ZodString;
+}, z.core.$strict>;
+export declare const StylePresetSchema: z.ZodObject<{
+    id: z.ZodString;
+    theme: z.ZodString;
+    frame: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        fps: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        platform: z.ZodString;
+    }, z.core.$strict>]>>;
+    direction: z.ZodOptional<z.ZodObject<{
+        shot: z.ZodOptional<z.ZodEnum<{
+            close: "close";
+            medium: "medium";
+            overhead: "overhead";
+            wide: "wide";
+        }>>;
+        move: z.ZodOptional<z.ZodEnum<{
+            orbit: "orbit";
+            "pan-l": "pan-l";
+            "pan-r": "pan-r";
+            "pull-out": "pull-out";
+            "push-in": "push-in";
+            reveal: "reveal";
+            static: "static";
+            tilt: "tilt";
+        }>>;
+        ease: z.ZodOptional<z.ZodEnum<{
+            in: "in";
+            "in-out": "in-out";
+            linear: "linear";
+            out: "out";
+            "spring-snappy": "spring-snappy";
+            "spring-soft": "spring-soft";
+        }>>;
+        transition: z.ZodOptional<z.ZodEnum<{
+            crossfade: "crossfade";
+            cut: "cut";
+            push: "push";
+            wipe: "wipe";
+            "zoom-through": "zoom-through";
+        }>>;
+    }, z.core.$strict>>;
+    props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+}, z.core.$strict>;
+export declare const PacingDocSchema: z.ZodObject<{
+    wordsPerSecond: z.ZodNumber;
+    sceneSeconds: z.ZodRecord<z.ZodString, z.ZodObject<{
+        short: z.ZodNumber;
+        standard: z.ZodNumber;
+        long: z.ZodNumber;
+    }, z.core.$strict>>;
+    lengths: z.ZodObject<{
+        short: z.ZodObject<{
+            scenes: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
+            totalSec: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
+        }, z.core.$strict>;
+        standard: z.ZodObject<{
+            scenes: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
+            totalSec: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
+        }, z.core.$strict>;
+        long: z.ZodObject<{
+            scenes: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
+            totalSec: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
+        }, z.core.$strict>;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+export type SlotDef = z.infer<typeof SlotSchema>;
+export type BlueprintScene = z.infer<typeof BlueprintSceneSchema>;
+export type BlueprintRepeat = z.infer<typeof BlueprintRepeatSchema>;
+export type ManifestDiscover = z.infer<typeof ManifestDiscoverSchema>;
+export type BlueprintDiscover = z.infer<typeof BlueprintDiscoverSchema>;
+export type BlueprintDoc = z.infer<typeof BlueprintDocSchema>;
+export type TemplateManifest = z.infer<typeof TemplateManifestSchema>;
+export type StylePreset = z.infer<typeof StylePresetSchema>;
+export type PacingDoc = z.infer<typeof PacingDocSchema>;
+export declare const parseTemplateManifest: (input: unknown) => Result<TemplateManifest>;
+export declare const parseBlueprintDoc: (input: unknown) => Result<BlueprintDoc>;
+export declare const parseStylePreset: (input: unknown) => Result<StylePreset>;
+export declare const parsePacingDoc: (input: unknown) => Result<PacingDoc>;
+/** JSON Schemas of the template documents, for editors and constrained decoding. */
+export declare const templateJsonSchemas: () => Record<string, unknown>;