@clipwright/core 0.26.1 → 0.27.0

package/dist/edit-shots.d.ts

@@ -0,0 +1,548 @@
+import { z } from "zod";
+/** The tariff a paid edit is priced by; the prices join it later, so further keys pass through. */
+export declare const editPricing: z.ZodObject<{
+    tariff_id: z.ZodString;
+}, z.core.$loose>;
+export declare const viewShot: z.ZodObject<{
+    id: z.ZodString;
+    index: z.ZodNumber;
+    track: z.ZodEnum<{
+        presenter: "presenter";
+        visual: "visual";
+    }>;
+    kind: z.ZodEnum<{
+        clip: "clip";
+        picture: "picture";
+        presenter: "presenter";
+    }>;
+    start_frame: z.ZodNumber;
+    end_frame: z.ZodNumber;
+    first_word: z.ZodNullable<z.ZodNumber>;
+    end_word: z.ZodNullable<z.ZodNumber>;
+    description: z.ZodNullable<z.ZodString>;
+    preview_url: z.ZodNullable<z.ZodString>;
+    source: z.ZodEnum<{
+        candidate: "candidate";
+        customer: "customer";
+        generated: "generated";
+        unknown: "unknown";
+        upload: "upload";
+    }>;
+    media_frames: z.ZodNullable<z.ZodNumber>;
+    media_offset_frames: z.ZodNullable<z.ZodNumber>;
+    operations: z.ZodArray<z.ZodEnum<{
+        animate: "animate";
+        cover: "cover";
+        delete: "delete";
+        edit_picture: "edit_picture";
+        new_picture: "new_picture";
+        retake: "retake";
+        retime: "retime";
+        upload: "upload";
+    }>>;
+}, z.core.$strip>;
+export type ViewShot = z.infer<typeof viewShot>;
+/** A run whose plan is recorded: its timeline, its words and the rules an edit of it must keep. */
+export declare const plannedRunShots: z.ZodObject<{
+    planned: z.ZodLiteral<true>;
+    run_id: z.ZodString;
+    line: z.ZodEnum<{
+        faceless: "faceless";
+        long_form: "long_form";
+        ugc: "ugc";
+    }>;
+    frame: z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        aspect_ratio: z.ZodEnum<{
+            "16:9": "16:9";
+            "1:1": "1:1";
+            "9:16": "9:16";
+        }>;
+    }, z.core.$strip>;
+    timebase: z.ZodObject<{
+        fps: z.ZodNumber;
+    }, z.core.$strip>;
+    duration_frames: z.ZodNumber;
+    captions: z.ZodNullable<z.ZodBoolean>;
+    narration: z.ZodObject<{
+        offset_frames: z.ZodNumber;
+        words: z.ZodArray<z.ZodObject<{
+            index: z.ZodNumber;
+            text: z.ZodString;
+            start_ms: z.ZodNumber;
+            end_ms: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    tracks: z.ZodArray<z.ZodObject<{
+        id: z.ZodEnum<{
+            presenter: "presenter";
+            visual: "visual";
+        }>;
+        shots: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            index: z.ZodNumber;
+            track: z.ZodEnum<{
+                presenter: "presenter";
+                visual: "visual";
+            }>;
+            kind: z.ZodEnum<{
+                clip: "clip";
+                picture: "picture";
+                presenter: "presenter";
+            }>;
+            start_frame: z.ZodNumber;
+            end_frame: z.ZodNumber;
+            first_word: z.ZodNullable<z.ZodNumber>;
+            end_word: z.ZodNullable<z.ZodNumber>;
+            description: z.ZodNullable<z.ZodString>;
+            preview_url: z.ZodNullable<z.ZodString>;
+            source: z.ZodEnum<{
+                candidate: "candidate";
+                customer: "customer";
+                generated: "generated";
+                unknown: "unknown";
+                upload: "upload";
+            }>;
+            media_frames: z.ZodNullable<z.ZodNumber>;
+            media_offset_frames: z.ZodNullable<z.ZodNumber>;
+            operations: z.ZodArray<z.ZodEnum<{
+                animate: "animate";
+                cover: "cover";
+                delete: "delete";
+                edit_picture: "edit_picture";
+                new_picture: "new_picture";
+                retake: "retake";
+                retime: "retime";
+                upload: "upload";
+            }>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    rules: z.ZodObject<{
+        kinds: z.ZodRecord<z.ZodEnum<{
+            clip: "clip";
+            picture: "picture";
+            presenter: "presenter";
+        }> & z.core.$partial, z.ZodObject<{
+            min_frames: z.ZodNumber;
+            max_frames: z.ZodNumber;
+            movable: z.ZodBoolean;
+            resizable: z.ZodBoolean;
+        }, z.core.$strict>>;
+        output_coverage: z.ZodEnum<{
+            union: "union";
+            visual: "visual";
+        }>;
+        first_visual_kind: z.ZodNullable<z.ZodEnum<{
+            clip: "clip";
+            picture: "picture";
+            presenter: "presenter";
+        }>>;
+        picture_assets_unique: z.ZodBoolean;
+        visual_covers_presenter: z.ZodBoolean;
+        add_visual: z.ZodEnum<{
+            never: "never";
+            over_presenter: "over_presenter";
+        }>;
+        reuse_source_asset: z.ZodBoolean;
+        upload_aspect: z.ZodNullable<z.ZodObject<{
+            max_distance: z.ZodNumber;
+        }, z.core.$strict>>;
+        max_generated_per_revision: z.ZodNumber;
+    }, z.core.$strict>;
+    editable: z.ZodObject<{
+        state: z.ZodEnum<{
+            editable: "editable";
+            expired: "expired";
+            not_recorded: "not_recorded";
+        }>;
+        media_available_until: z.ZodNullable<z.ZodString>;
+        reason: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    lineage: z.ZodObject<{
+        source_run_id: z.ZodNullable<z.ZodString>;
+        root_run_id: z.ZodString;
+        revisions: z.ZodArray<z.ZodObject<{
+            run_id: z.ZodString;
+            state: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    withheld: z.ZodArray<z.ZodEnum<{
+        description: "description";
+        source_media: "source_media";
+    }>>;
+    pricing: z.ZodNullable<z.ZodObject<{
+        tariff_id: z.ZodString;
+    }, z.core.$loose>>;
+    paid_edits: z.ZodObject<{
+        enabled: z.ZodBoolean;
+        reason: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    contract_version: z.ZodString;
+}, z.core.$strip>;
+/** A run with no plan to show: it carries no frame, duration, words or rules, and none are invented. */
+export declare const unplannedRunShots: z.ZodObject<{
+    planned: z.ZodLiteral<false>;
+    run_id: z.ZodString;
+    line: z.ZodEnum<{
+        faceless: "faceless";
+        long_form: "long_form";
+        ugc: "ugc";
+    }>;
+    editable: z.ZodObject<{
+        state: z.ZodEnum<{
+            not_recorded: "not_recorded";
+            not_succeeded: "not_succeeded";
+            unsupported_line: "unsupported_line";
+        }>;
+        media_available_until: z.ZodNullable<z.ZodString>;
+        reason: z.ZodString;
+    }, z.core.$strip>;
+    lineage: z.ZodObject<{
+        source_run_id: z.ZodNullable<z.ZodString>;
+        root_run_id: z.ZodString;
+        revisions: z.ZodArray<z.ZodObject<{
+            run_id: z.ZodString;
+            state: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    contract_version: z.ZodString;
+}, z.core.$strip>;
+export declare const runShots: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    planned: z.ZodLiteral<true>;
+    run_id: z.ZodString;
+    line: z.ZodEnum<{
+        faceless: "faceless";
+        long_form: "long_form";
+        ugc: "ugc";
+    }>;
+    frame: z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        aspect_ratio: z.ZodEnum<{
+            "16:9": "16:9";
+            "1:1": "1:1";
+            "9:16": "9:16";
+        }>;
+    }, z.core.$strip>;
+    timebase: z.ZodObject<{
+        fps: z.ZodNumber;
+    }, z.core.$strip>;
+    duration_frames: z.ZodNumber;
+    captions: z.ZodNullable<z.ZodBoolean>;
+    narration: z.ZodObject<{
+        offset_frames: z.ZodNumber;
+        words: z.ZodArray<z.ZodObject<{
+            index: z.ZodNumber;
+            text: z.ZodString;
+            start_ms: z.ZodNumber;
+            end_ms: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    tracks: z.ZodArray<z.ZodObject<{
+        id: z.ZodEnum<{
+            presenter: "presenter";
+            visual: "visual";
+        }>;
+        shots: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            index: z.ZodNumber;
+            track: z.ZodEnum<{
+                presenter: "presenter";
+                visual: "visual";
+            }>;
+            kind: z.ZodEnum<{
+                clip: "clip";
+                picture: "picture";
+                presenter: "presenter";
+            }>;
+            start_frame: z.ZodNumber;
+            end_frame: z.ZodNumber;
+            first_word: z.ZodNullable<z.ZodNumber>;
+            end_word: z.ZodNullable<z.ZodNumber>;
+            description: z.ZodNullable<z.ZodString>;
+            preview_url: z.ZodNullable<z.ZodString>;
+            source: z.ZodEnum<{
+                candidate: "candidate";
+                customer: "customer";
+                generated: "generated";
+                unknown: "unknown";
+                upload: "upload";
+            }>;
+            media_frames: z.ZodNullable<z.ZodNumber>;
+            media_offset_frames: z.ZodNullable<z.ZodNumber>;
+            operations: z.ZodArray<z.ZodEnum<{
+                animate: "animate";
+                cover: "cover";
+                delete: "delete";
+                edit_picture: "edit_picture";
+                new_picture: "new_picture";
+                retake: "retake";
+                retime: "retime";
+                upload: "upload";
+            }>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    rules: z.ZodObject<{
+        kinds: z.ZodRecord<z.ZodEnum<{
+            clip: "clip";
+            picture: "picture";
+            presenter: "presenter";
+        }> & z.core.$partial, z.ZodObject<{
+            min_frames: z.ZodNumber;
+            max_frames: z.ZodNumber;
+            movable: z.ZodBoolean;
+            resizable: z.ZodBoolean;
+        }, z.core.$strict>>;
+        output_coverage: z.ZodEnum<{
+            union: "union";
+            visual: "visual";
+        }>;
+        first_visual_kind: z.ZodNullable<z.ZodEnum<{
+            clip: "clip";
+            picture: "picture";
+            presenter: "presenter";
+        }>>;
+        picture_assets_unique: z.ZodBoolean;
+        visual_covers_presenter: z.ZodBoolean;
+        add_visual: z.ZodEnum<{
+            never: "never";
+            over_presenter: "over_presenter";
+        }>;
+        reuse_source_asset: z.ZodBoolean;
+        upload_aspect: z.ZodNullable<z.ZodObject<{
+            max_distance: z.ZodNumber;
+        }, z.core.$strict>>;
+        max_generated_per_revision: z.ZodNumber;
+    }, z.core.$strict>;
+    editable: z.ZodObject<{
+        state: z.ZodEnum<{
+            editable: "editable";
+            expired: "expired";
+            not_recorded: "not_recorded";
+        }>;
+        media_available_until: z.ZodNullable<z.ZodString>;
+        reason: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    lineage: z.ZodObject<{
+        source_run_id: z.ZodNullable<z.ZodString>;
+        root_run_id: z.ZodString;
+        revisions: z.ZodArray<z.ZodObject<{
+            run_id: z.ZodString;
+            state: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    withheld: z.ZodArray<z.ZodEnum<{
+        description: "description";
+        source_media: "source_media";
+    }>>;
+    pricing: z.ZodNullable<z.ZodObject<{
+        tariff_id: z.ZodString;
+    }, z.core.$loose>>;
+    paid_edits: z.ZodObject<{
+        enabled: z.ZodBoolean;
+        reason: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    contract_version: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    planned: z.ZodLiteral<false>;
+    run_id: z.ZodString;
+    line: z.ZodEnum<{
+        faceless: "faceless";
+        long_form: "long_form";
+        ugc: "ugc";
+    }>;
+    editable: z.ZodObject<{
+        state: z.ZodEnum<{
+            not_recorded: "not_recorded";
+            not_succeeded: "not_succeeded";
+            unsupported_line: "unsupported_line";
+        }>;
+        media_available_until: z.ZodNullable<z.ZodString>;
+        reason: z.ZodString;
+    }, z.core.$strip>;
+    lineage: z.ZodObject<{
+        source_run_id: z.ZodNullable<z.ZodString>;
+        root_run_id: z.ZodString;
+        revisions: z.ZodArray<z.ZodObject<{
+            run_id: z.ZodString;
+            state: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    contract_version: z.ZodString;
+}, z.core.$strip>], "planned">;
+export type PlannedRunShots = z.infer<typeof plannedRunShots>;
+export type UnplannedRunShots = z.infer<typeof unplannedRunShots>;
+export type RunShots = z.infer<typeof runShots>;
+export declare const plannedRunShotsRead: z.ZodObject<{
+    planned: z.ZodLiteral<true>;
+    run_id: z.ZodString;
+    timebase: z.ZodObject<{
+        fps: z.ZodNumber;
+    }, z.core.$strip>;
+    duration_frames: z.ZodNumber;
+    captions: z.ZodNullable<z.ZodBoolean>;
+    narration: z.ZodObject<{
+        offset_frames: z.ZodNumber;
+        words: z.ZodArray<z.ZodObject<{
+            index: z.ZodNumber;
+            text: z.ZodString;
+            start_ms: z.ZodNumber;
+            end_ms: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    lineage: z.ZodObject<{
+        source_run_id: z.ZodNullable<z.ZodString>;
+        root_run_id: z.ZodString;
+        revisions: z.ZodArray<z.ZodObject<{
+            run_id: z.ZodString;
+            state: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    pricing: z.ZodNullable<z.ZodObject<{
+        tariff_id: z.ZodString;
+    }, z.core.$loose>>;
+    paid_edits: z.ZodObject<{
+        enabled: z.ZodBoolean;
+        reason: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    contract_version: z.ZodString;
+    line: z.ZodString;
+    frame: z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        aspect_ratio: z.ZodString;
+    }, z.core.$strip>;
+    tracks: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        shots: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            index: z.ZodNumber;
+            start_frame: z.ZodNumber;
+            end_frame: z.ZodNumber;
+            first_word: z.ZodNullable<z.ZodNumber>;
+            end_word: z.ZodNullable<z.ZodNumber>;
+            description: z.ZodNullable<z.ZodString>;
+            preview_url: z.ZodNullable<z.ZodString>;
+            media_frames: z.ZodNullable<z.ZodNumber>;
+            media_offset_frames: z.ZodNullable<z.ZodNumber>;
+            track: z.ZodString;
+            kind: z.ZodString;
+            source: z.ZodString;
+            operations: z.ZodArray<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    rules: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    editable: z.ZodObject<{
+        state: z.ZodString;
+        media_available_until: z.ZodNullable<z.ZodString>;
+        reason: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    withheld: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export declare const unplannedRunShotsRead: z.ZodObject<{
+    planned: z.ZodLiteral<false>;
+    run_id: z.ZodString;
+    lineage: z.ZodObject<{
+        source_run_id: z.ZodNullable<z.ZodString>;
+        root_run_id: z.ZodString;
+        revisions: z.ZodArray<z.ZodObject<{
+            run_id: z.ZodString;
+            state: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    contract_version: z.ZodString;
+    line: z.ZodString;
+    editable: z.ZodObject<{
+        state: z.ZodString;
+        media_available_until: z.ZodNullable<z.ZodString>;
+        reason: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const runShotsRead: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    planned: z.ZodLiteral<true>;
+    run_id: z.ZodString;
+    timebase: z.ZodObject<{
+        fps: z.ZodNumber;
+    }, z.core.$strip>;
+    duration_frames: z.ZodNumber;
+    captions: z.ZodNullable<z.ZodBoolean>;
+    narration: z.ZodObject<{
+        offset_frames: z.ZodNumber;
+        words: z.ZodArray<z.ZodObject<{
+            index: z.ZodNumber;
+            text: z.ZodString;
+            start_ms: z.ZodNumber;
+            end_ms: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    lineage: z.ZodObject<{
+        source_run_id: z.ZodNullable<z.ZodString>;
+        root_run_id: z.ZodString;
+        revisions: z.ZodArray<z.ZodObject<{
+            run_id: z.ZodString;
+            state: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    pricing: z.ZodNullable<z.ZodObject<{
+        tariff_id: z.ZodString;
+    }, z.core.$loose>>;
+    paid_edits: z.ZodObject<{
+        enabled: z.ZodBoolean;
+        reason: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    contract_version: z.ZodString;
+    line: z.ZodString;
+    frame: z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        aspect_ratio: z.ZodString;
+    }, z.core.$strip>;
+    tracks: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        shots: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            index: z.ZodNumber;
+            start_frame: z.ZodNumber;
+            end_frame: z.ZodNumber;
+            first_word: z.ZodNullable<z.ZodNumber>;
+            end_word: z.ZodNullable<z.ZodNumber>;
+            description: z.ZodNullable<z.ZodString>;
+            preview_url: z.ZodNullable<z.ZodString>;
+            media_frames: z.ZodNullable<z.ZodNumber>;
+            media_offset_frames: z.ZodNullable<z.ZodNumber>;
+            track: z.ZodString;
+            kind: z.ZodString;
+            source: z.ZodString;
+            operations: z.ZodArray<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    rules: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    editable: z.ZodObject<{
+        state: z.ZodString;
+        media_available_until: z.ZodNullable<z.ZodString>;
+        reason: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    withheld: z.ZodArray<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    planned: z.ZodLiteral<false>;
+    run_id: z.ZodString;
+    lineage: z.ZodObject<{
+        source_run_id: z.ZodNullable<z.ZodString>;
+        root_run_id: z.ZodString;
+        revisions: z.ZodArray<z.ZodObject<{
+            run_id: z.ZodString;
+            state: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    contract_version: z.ZodString;
+    line: z.ZodString;
+    editable: z.ZodObject<{
+        state: z.ZodString;
+        media_available_until: z.ZodNullable<z.ZodString>;
+        reason: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>], "planned">;
+export type RunShotsRead = z.infer<typeof runShotsRead>;
+/** The path of a run's shots. The id is encoded, since it comes from the caller. */
+export declare const runShotsPath: (id: string) => string;

package/dist/edit-shots.js

@@ -0,0 +1,61 @@
+import { z } from "zod";
+import { frame, frameCount, shotId } from "./edit-primitives.js";
+import { EDIT_LINES, SHOT_ACTIONS, SHOT_KINDS, SHOT_SOURCES, SHOT_TRACKS, editRules } from "./edit-rules.js";
+import { runId } from "./runs.js";
+import { ASPECT_RATIOS } from "./skills.js";
+/** The tariff a paid edit is priced by; the prices join it later, so further keys pass through. */
+export const editPricing = z.object({ tariff_id: z.string().min(1) }).passthrough();
+const word = z.object({ index: frame, text: z.string().min(1), start_ms: frame, end_ms: frame.positive() });
+export const viewShot = z.object({
+    id: shotId, index: frame, track: z.enum(SHOT_TRACKS), kind: z.enum(SHOT_KINDS),
+    start_frame: frame, end_frame: frame.positive(),
+    first_word: frame.nullable(), end_word: frame.nullable(),
+    description: z.string().nullable(), preview_url: z.string().url().nullable(),
+    source: z.enum(SHOT_SOURCES),
+    media_frames: frameCount.nullable(), media_offset_frames: frame.nullable(),
+    operations: z.array(z.enum(SHOT_ACTIONS)),
+});
+const lineage = z.object({ source_run_id: runId.nullable(), root_run_id: runId, revisions: z.array(z.object({ run_id: runId, state: z.string() })) });
+const until = z.string().datetime().nullable();
+/** A run whose plan is recorded: its timeline, its words and the rules an edit of it must keep. */
+export const plannedRunShots = z.object({
+    planned: z.literal(true),
+    run_id: runId, line: z.enum(EDIT_LINES),
+    frame: z.object({ width: frameCount, height: frameCount, aspect_ratio: z.enum(ASPECT_RATIOS) }),
+    timebase: z.object({ fps: z.number().int().positive() }),
+    duration_frames: frameCount, captions: z.boolean().nullable(),
+    narration: z.object({ offset_frames: frame, words: z.array(word) }),
+    tracks: z.array(z.object({ id: z.enum(SHOT_TRACKS), shots: z.array(viewShot) })),
+    rules: editRules,
+    editable: z.object({ state: z.enum(["editable", "expired", "not_recorded"]), media_available_until: until, reason: z.string().nullable() }),
+    lineage,
+    withheld: z.array(z.enum(["description", "source_media"])),
+    pricing: editPricing.nullable(),
+    paid_edits: z.object({ enabled: z.boolean(), reason: z.string().nullable() }),
+    contract_version: z.string().min(1),
+});
+/** A run with no plan to show: it carries no frame, duration, words or rules, and none are invented. */
+export const unplannedRunShots = z.object({
+    planned: z.literal(false),
+    run_id: runId, line: z.enum(EDIT_LINES),
+    editable: z.object({ state: z.enum(["not_succeeded", "unsupported_line", "not_recorded"]), media_available_until: until, reason: z.string().min(1) }),
+    lineage,
+    contract_version: z.string().min(1),
+});
+export const runShots = z.discriminatedUnion("planned", [plannedRunShots, unplannedRunShots]);
+// What installed clients parse: every closed vocabulary is an open string, and `rules` is opaque.
+const editableRead = z.object({ state: z.string(), media_available_until: until, reason: z.string().nullable() });
+const viewShotRead = viewShot.extend({ track: z.string(), kind: z.string(), source: z.string(), operations: z.array(z.string()) });
+export const plannedRunShotsRead = plannedRunShots.extend({
+    line: z.string(),
+    frame: z.object({ width: frameCount, height: frameCount, aspect_ratio: z.string() }),
+    tracks: z.array(z.object({ id: z.string(), shots: z.array(viewShotRead) })),
+    rules: z.record(z.string(), z.unknown()),
+    editable: editableRead,
+    withheld: z.array(z.string()),
+});
+export const unplannedRunShotsRead = unplannedRunShots.extend({ line: z.string(), editable: editableRead });
+export const runShotsRead = z.discriminatedUnion("planned", [plannedRunShotsRead, unplannedRunShotsRead]);
+/** The path of a run's shots. The id is encoded, since it comes from the caller. */
+export const runShotsPath = (id) => `/v1/runs/${encodeURIComponent(id)}/shots`;
+//# sourceMappingURL=edit-shots.js.map

package/dist/edit-shots.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"edit-shots.js","sourceRoot":"","sources":["../src/edit-shots.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC7G,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,mGAAmG;AACnG,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;AAEpF,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAE5G,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;IAC9E,WAAW,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,CAAC,QAAQ,EAAE;IAC/C,UAAU,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE;IACxD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC5E,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;IAC5B,YAAY,EAAE,UAAU,CAAC,QAAQ,EAAE,EAAE,mBAAmB,EAAE,KAAK,CAAC,QAAQ,EAAE;IAC1E,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;CAC1C,CAAC,CAAC;AAGH,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,aAAa,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AACtJ,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;AAE/C,mGAAmG;AACnG,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IACxB,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;IACvC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;IAC/F,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC;IACxD,eAAe,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC7D,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;IACnE,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAChF,KAAK,EAAE,SAAS;IAChB,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC,EAAE,qBAAqB,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC;IAC3I,OAAO;IACP,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC,CAAC;IAC1D,OAAO,EAAE,WAAW,CAAC,QAAQ,EAAE;IAC/B,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC;IAC7E,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CACpC,CAAC,CAAC;AAEH,wGAAwG;AACxG,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IACzB,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;IACvC,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,kBAAkB,EAAE,cAAc,CAAC,CAAC,EAAE,qBAAqB,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACrJ,OAAO;IACP,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CACpC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAC,kBAAkB,CAAC,SAAS,EAAE,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC,CAAC;AAK9F,kGAAkG;AAClG,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,qBAAqB,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAClH,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;AACnI,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAAC,MAAM,CAAC;IACxD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;IACpF,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;IAC3E,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;IACxC,QAAQ,EAAE,YAAY;IACtB,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CAC9B,CAAC,CAAC;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,iBAAiB,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;AAC5G,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,kBAAkB,CAAC,SAAS,EAAE,CAAC,mBAAmB,EAAE,qBAAqB,CAAC,CAAC,CAAC;AAG1G,oFAAoF;AACpF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,EAAU,EAAU,EAAE,CAAC,YAAY,kBAAkB,CAAC,EAAE,CAAC,QAAQ,CAAC"}

package/dist/edit-validate.d.ts

@@ -0,0 +1,57 @@
+import type { EditDocument } from "./edit-document.js";
+import { type ShotOperationMode } from "./edit-operations.js";
+import type { ShotKind } from "./edit-rules.js";
+import type { PlannedRunShots } from "./edit-shots.js";
+/** In the order issues are reported. */
+export declare const EDIT_ISSUE_CODES: readonly ["source_mismatch", "timebase_mismatch", "duration_mismatch", "duplicate_shot_id", "span_out_of_range", "kind_changed", "shot_added_not_allowed", "too_short", "too_long", "action_not_allowed", "not_movable", "not_resizable", "overlap", "tracks_overlap", "uncovered", "first_shot_fixed", "foreign_source_asset", "kind_asset_mismatch", "candidate_for_other_shot", "unknown_asset", "upload_shape_refused", "duplicate_picture_asset", "too_many_generated", "footage_exceeded", "presenter_out_of_sync", "presenter_outside_recording"];
+export type EditIssueCode = (typeof EDIT_ISSUE_CODES)[number];
+/** What the caller measured about the assets a document names: kept candidates by run id, uploads by upload id. */
+export type EditFacts = {
+    candidates: Record<string, {
+        shot_id: string;
+        kind: "picture" | "clip";
+        media_frames: number | null;
+    }>;
+    uploads: Record<string, {
+        width: number;
+        height: number;
+    }>;
+};
+export type EditIssue = {
+    code: EditIssueCode;
+    shot_id?: string;
+    from_frame?: number;
+    to_frame?: number;
+    message: string;
+};
+export type EditSummary = {
+    /** Source shots whose start_frame, end_frame or media_offset_frames changed. */
+    retimed: string[];
+    /** Source shot ids absent from the document. */
+    deleted: string[];
+    /** Document shot ids that are not source shot ids. */
+    added: string[];
+    replaced: {
+        shot_id: string;
+        from: "candidate" | "upload";
+    }[];
+    /** Facts only: pricing decides what each entry costs. */
+    generated: {
+        shot_id: string;
+        kind: ShotKind;
+        mode: ShotOperationMode;
+    }[];
+    /** Any list above is non-empty. */
+    changed: boolean;
+};
+/** Presenter frames no visual shot covers. */
+export declare function presenterVisibleFrames(shots: Pick<PlannedRunShots, "tracks">): number;
+export declare function diffEditDocument(document: EditDocument, shots: PlannedRunShots): EditSummary;
+/** Checks a document against the view it edits. Every issue is collected; the rules come from the view. */
+export declare function validateEditDocument(document: EditDocument, shots: PlannedRunShots, facts: EditFacts): {
+    ok: true;
+    summary: EditSummary;
+} | {
+    ok: false;
+    issues: EditIssue[];
+};