Project types

export interface StoryboardDocument {
    components: DrawingComponent[];
    schemaVersion: 5;
    studio: StudioContent;
    version: number;
    id: Id;
    title: string;
    author?: string;
    createdAt: string;
    updatedAt: string;
    canvas: {
        width: number;
        height: number;
        background: string;
    };
    seed: number;
    frameRate: number;
    idCounter: number;
    scenes: Scene[];
    sequences: Sequence[];
    shots: Shot[];
    panels: Panel[];
    brushes: BrushPreset[];
    assets: Asset[];
    audioTracks: AudioTrack[];
    comments: ReviewComment[];
    locks: ProjectLock[];
    changes: ChangeEntry[];
    metadata: Record<string, string>;
}

export interface ProjectOptions {
    id?: Id;
    title: string;
    author?: string;
    width?: number;
    height?: number;
    background?: string;
    seed?: number;
    frameRate?: number;
}

export interface ProjectChanges {
    title?: string;
    author?: string | null;
    seed?: number;
    frameRate?: {
        value: number;
        timing: "preserve-frames" | "preserve-seconds";
    };
    canvas?: {
        width?: number;
        height?: number;
        background?: string;
        /** Existing artwork coordinates stay unchanged in either mode. */
        applyTo?: "new-panels" | "all-panels";
    };
}

export interface ProjectMigrationReport {
    format: "codeboard-project-migration/1";
    source: string;
    target: string;
    sourceContainerVersion: number;
    targetSchemaVersion: number;
    version: number;
    documentHash: string;
    snapshotHash: string;
    preserved: {
        projectId: string;
        boardTiming: true;
        artworkIds: true;
        embeddedAssets: number;
    };
    warnings: string[];
}

export interface PanelCaptureResult {
    animationId: string;
    source: {
        projectId: string;
        version: number;
        panelId: string;
        panelRevision: number;
        startFrame: number;
        durationFrames: number;
        captureStartFrame: number;
        captureDurationFrames: number;
    };
    identities: {
        sourceId: string;
        capturedId: string;
    }[];
}

export interface PanelCaptureOptions {
    id: string;
    name?: string;
    preRollFrames?: number;
    postRollFrames?: number;
}

export interface CoordinateSpace extends ArtworkCoordinateSpace {
    panelId: string;
}

export interface MutationOptions {
    expectedVersion?: number;
}

export interface ShotDuplicateOptions {
    id: string;
    shotId: string;
    name?: string;
}

export interface ShotDuplicateResult {
    animationId: string;
    sourceAnimationId: string;
    identities: {
        sourceId: string;
        copyId: string;
    }[];
}