@vivix-labs/project-studio 0.0.0-stage → 1.0.0-beta

package/dist/shared.d.ts

@@ -0,0 +1,510 @@
+import * as vivix_studio_sdk_shared from 'vivix-studio/sdk/shared';
+import { z } from 'vivix-studio/sdk/shared';
+import { V as VersionRef, C as CallContext, R as RecordValue, D as DataAPI, J as JSONValue, a as DataWorkspace, b as SqlInput, c as SqlRow, d as VersionValue, F as FileValue } from './shared-BUdviVVD.js';
+
+declare function taskCostLabel(task: any): string;
+
+declare const clipScript: z.ZodObject<{
+    title: z.ZodString;
+    visual: z.ZodDefault<z.ZodString>;
+    voiceover: z.ZodDefault<z.ZodString>;
+    onScreenText: z.ZodDefault<z.ZodString>;
+    cta: z.ZodDefault<z.ZodString>;
+    plannedDurationMs: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+}, z.core.$strict>;
+declare const adBrief: z.ZodObject<{
+    product: z.ZodDefault<z.ZodString>;
+    category: z.ZodDefault<z.ZodString>;
+    audience: z.ZodDefault<z.ZodString>;
+    sellingPoints: z.ZodDefault<z.ZodString>;
+    channel: z.ZodDefault<z.ZodString>;
+    aspectRatio: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    targetDurationMs: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+    body: z.ZodDefault<z.ZodString>;
+    productRefs: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        storeId: z.ZodUUID;
+        objectId: z.ZodUUID;
+        versionId: z.ZodUUID;
+    }, z.core.$strict>>>;
+    modelRefs: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        storeId: z.ZodUUID;
+        objectId: z.ZodUUID;
+        versionId: z.ZodUUID;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
+declare const adStoryboard: z.ZodObject<{
+    brief: z.ZodObject<{
+        product: z.ZodDefault<z.ZodString>;
+        category: z.ZodDefault<z.ZodString>;
+        audience: z.ZodDefault<z.ZodString>;
+        sellingPoints: z.ZodDefault<z.ZodString>;
+        channel: z.ZodDefault<z.ZodString>;
+        aspectRatio: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+        targetDurationMs: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+        body: z.ZodDefault<z.ZodString>;
+        productRefs: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            storeId: z.ZodUUID;
+            objectId: z.ZodUUID;
+            versionId: z.ZodUUID;
+        }, z.core.$strict>>>;
+        modelRefs: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            storeId: z.ZodUUID;
+            objectId: z.ZodUUID;
+            versionId: z.ZodUUID;
+        }, z.core.$strict>>>;
+    }, z.core.$strict>;
+    clips: z.ZodArray<z.ZodObject<{
+        assetId: z.ZodUUID;
+        script: z.ZodObject<{
+            title: z.ZodString;
+            visual: z.ZodDefault<z.ZodString>;
+            voiceover: z.ZodDefault<z.ZodString>;
+            onScreenText: z.ZodDefault<z.ZodString>;
+            cta: z.ZodDefault<z.ZodString>;
+            plannedDurationMs: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+        }, z.core.$strict>;
+        edits: z.ZodArray<z.ZodObject<{
+            sourceVersionId: z.ZodUUID;
+            editRef: z.ZodObject<{
+                storeId: z.ZodUUID;
+                objectId: z.ZodUUID;
+                versionId: z.ZodUUID;
+            }, z.core.$strict>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+declare const adTypeId = "studio.adStoryboard";
+type AdBrief = z.infer<typeof adBrief>;
+type ClipScript = z.infer<typeof clipScript>;
+type AdStoryboard = z.infer<typeof adStoryboard>;
+interface VideoFileRef$1 {
+    source: VersionRef;
+    fileId: string;
+}
+type AdVideoInput = {
+    kind: 'source';
+    file: VideoFileRef$1;
+} | {
+    kind: 'edit';
+    editRef: VersionRef;
+};
+interface AdRecipe {
+    trim: {
+        inMs: number;
+        outMs: number;
+    };
+    crop: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+}
+interface AdMediaResolver {
+    readonly capabilityVersion: 'media-tools/1';
+    readonly storeId: string;
+    readonly projectId: string;
+    resolve(input: AdVideoInput): Promise<{
+        file: VideoFileRef$1;
+        recipe: AdRecipe;
+        durationMs: number;
+        effectiveDurationMs: number;
+        previewUrl: string;
+        displayWidth?: number;
+        displayHeight?: number;
+    }>;
+}
+type AdSequenceEntry = {
+    assetId: string;
+    title: string;
+    assetRevision: number;
+    selectedVersionId: string | null;
+    candidates: Array<{
+        versionId: string;
+        versionNumber: number;
+        durationMs: number | null;
+        generation: unknown;
+    }>;
+} & ({
+    state: 'ready';
+    input: AdVideoInput;
+    file: VideoFileRef$1;
+    previewUrl: string;
+    durationMs: number;
+    recipe: AdRecipe;
+} | {
+    state: 'empty' | 'unavailable';
+    message: string;
+});
+interface AdSequence {
+    storyboardId: string;
+    storyboardRevision: number;
+    aspectRatio: string | null;
+    entries: AdSequenceEntry[];
+    actualDurationMs: number;
+    targetDurationMs: number | null;
+}
+interface AdService {
+    bindEdit(input: {
+        expectedRevision: number;
+        expectedAssetRevision: number;
+        assetId: string;
+        sourceVersionId: string;
+        editRef: VersionRef;
+    }, call: CallContext, media?: AdMediaResolver): Promise<RecordValue>;
+    resolveSequence(media?: AdMediaResolver): Promise<AdSequence>;
+}
+interface AdStudioProvider {
+    role: 'project';
+    data: DataAPI;
+    ads: AdService;
+}
+
+declare const videoFileRef: z.ZodObject<{
+    source: z.ZodObject<{
+        storeId: z.ZodUUID;
+        objectId: z.ZodUUID;
+        versionId: z.ZodUUID;
+    }, z.core.$strict>;
+    fileId: z.ZodUUID;
+}, z.core.$strict>;
+type VideoFileRef = z.infer<typeof videoFileRef>;
+
+interface VideoUse {
+    usageId: string;
+    revision: number;
+    file: VideoFileRef;
+    editRef: VersionRef | null;
+}
+
+declare const studioConfig: z.ZodObject<{
+    role: z.ZodDefault<z.ZodEnum<{
+        project: "project";
+        coordinator: "coordinator";
+    }>>;
+    dataInstance: z.ZodDefault<z.ZodString>;
+    apiInstance: z.ZodDefault<z.ZodString>;
+    libraryInstance: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+}, z.core.$strict>;
+declare const versionRef: z.ZodObject<{
+    storeId: z.ZodUUID;
+    objectId: z.ZodUUID;
+    versionId: z.ZodUUID;
+}, z.core.$strict>;
+declare const tags: z.ZodDefault<z.ZodPipe<z.ZodArray<z.ZodString>, z.ZodTransform<string[], string[]>>>;
+declare const kind: z.ZodEnum<{
+    file: "file";
+    text: "text";
+    image: "image";
+    video: "video";
+    audio: "audio";
+}>;
+declare const projectData: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodDefault<z.ZodString>;
+    status: z.ZodDefault<z.ZodEnum<{
+        draft: "draft";
+        active: "active";
+        archived: "archived";
+    }>>;
+    aspectRatio: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    coverRef: z.ZodDefault<z.ZodNullable<z.ZodObject<{
+        storeId: z.ZodUUID;
+        objectId: z.ZodUUID;
+        versionId: z.ZodUUID;
+    }, z.core.$strict>>>;
+    briefRef: z.ZodDefault<z.ZodNullable<z.ZodObject<{
+        storeId: z.ZodUUID;
+        objectId: z.ZodUUID;
+    }, z.core.$strict>>>;
+    tags: z.ZodDefault<z.ZodPipe<z.ZodArray<z.ZodString>, z.ZodTransform<string[], string[]>>>;
+}, z.core.$strict>;
+declare const assetData: z.ZodObject<{
+    projectId: z.ZodUUID;
+    name: z.ZodString;
+    kind: z.ZodEnum<{
+        file: "file";
+        text: "text";
+        image: "image";
+        video: "video";
+        audio: "audio";
+    }>;
+    purpose: z.ZodDefault<z.ZodEnum<{
+        reference: "reference";
+        script: "script";
+        shot: "shot";
+        music: "music";
+        voice: "voice";
+        subtitle: "subtitle";
+        final: "final";
+        other: "other";
+    }>>;
+    origin: z.ZodEnum<{
+        upload: "upload";
+        library: "library";
+        generated: "generated";
+        authored: "authored";
+    }>;
+    orderKey: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+    tags: z.ZodDefault<z.ZodPipe<z.ZodArray<z.ZodString>, z.ZodTransform<string[], string[]>>>;
+    lifecycle: z.ZodDefault<z.ZodEnum<{
+        ready: "ready";
+        draft: "draft";
+        archived: "archived";
+    }>>;
+    sourceRef: z.ZodDefault<z.ZodNullable<z.ZodObject<{
+        storeId: z.ZodUUID;
+        objectId: z.ZodUUID;
+        versionId: z.ZodUUID;
+    }, z.core.$strict>>>;
+    adoptedVersionId: z.ZodDefault<z.ZodNullable<z.ZodUUID>>;
+}, z.core.$strict>;
+declare const taskStates: readonly ["queued", "submitting", "submission_unknown", "running", "cancel_requested", "remote_succeeded", "saving", "save_failed", "partial", "succeeded", "failed", "canceled"];
+declare const anchor: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"whole">;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"timeRange">;
+    startMs: z.ZodNumber;
+    endMs: z.ZodNumber;
+}, z.core.$strict>], "kind">;
+declare const generationInput: z.ZodObject<{
+    targetAssetId: z.ZodOptional<z.ZodUUID>;
+    taskName: z.ZodOptional<z.ZodString>;
+    context: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    expectedRevision: z.ZodOptional<z.ZodNumber>;
+    newAsset: z.ZodOptional<z.ZodObject<{
+        name: z.ZodString;
+        kind: z.ZodEnum<{
+            image: "image";
+            video: "video";
+            audio: "audio";
+        }>;
+    }, z.core.$strict>>;
+    modelId: z.ZodString;
+    capabilityId: z.ZodString;
+    prompt: z.ZodString;
+    parameters: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    outputCount: z.ZodDefault<z.ZodNumber>;
+    inputs: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        ref: z.ZodObject<{
+            storeId: z.ZodUUID;
+            objectId: z.ZodUUID;
+            versionId: z.ZodUUID;
+        }, z.core.$strict>;
+        role: z.ZodString;
+        order: z.ZodNumber;
+        weight: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strict>>>;
+    baseVersionId: z.ZodOptional<z.ZodUUID>;
+    changeRequest: z.ZodOptional<z.ZodString>;
+    preserveRequest: z.ZodDefault<z.ZodString>;
+    anchor: z.ZodDefault<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"whole">;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"timeRange">;
+        startMs: z.ZodNumber;
+        endMs: z.ZodNumber;
+    }, z.core.$strict>], "kind">>;
+    retryOfTaskId: z.ZodOptional<z.ZodUUID>;
+    acknowledgeUnknown: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+declare const projectSettingsInput: z.ZodObject<{
+    projectId: z.ZodUUID;
+    expectedRevision: z.ZodNumber;
+    changes: z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        tags: z.ZodOptional<z.ZodPipe<z.ZodArray<z.ZodString>, z.ZodTransform<string[], string[]>>>;
+        aspectRatio: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        coverRef: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            storeId: z.ZodUUID;
+            objectId: z.ZodUUID;
+            versionId: z.ZodUUID;
+        }, z.core.$strict>>>;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+declare const generationSubmitOperation: vivix_studio_sdk_shared.Operation<{
+    modelId: string;
+    capabilityId: string;
+    prompt: string;
+    parameters: Record<string, unknown>;
+    outputCount: number;
+    inputs: {
+        ref: {
+            storeId: string;
+            objectId: string;
+            versionId: string;
+        };
+        role: string;
+        order: number;
+        weight: number | null;
+    }[];
+    preserveRequest: string;
+    anchor: {
+        kind: "whole";
+    } | {
+        kind: "timeRange";
+        startMs: number;
+        endMs: number;
+    };
+    targetAssetId?: string | undefined;
+    taskName?: string | undefined;
+    context?: Record<string, string> | undefined;
+    expectedRevision?: number | undefined;
+    newAsset?: {
+        name: string;
+        kind: "image" | "video" | "audio";
+    } | undefined;
+    baseVersionId?: string | undefined;
+    changeRequest?: string | undefined;
+    retryOfTaskId?: string | undefined;
+    acknowledgeUnknown?: boolean | undefined;
+}, any>;
+declare const studioOperations: {
+    generationSubmit: vivix_studio_sdk_shared.Operation<{
+        modelId: string;
+        capabilityId: string;
+        prompt: string;
+        parameters: Record<string, unknown>;
+        outputCount: number;
+        inputs: {
+            ref: {
+                storeId: string;
+                objectId: string;
+                versionId: string;
+            };
+            role: string;
+            order: number;
+            weight: number | null;
+        }[];
+        preserveRequest: string;
+        anchor: {
+            kind: "whole";
+        } | {
+            kind: "timeRange";
+            startMs: number;
+            endMs: number;
+        };
+        targetAssetId?: string | undefined;
+        taskName?: string | undefined;
+        context?: Record<string, string> | undefined;
+        expectedRevision?: number | undefined;
+        newAsset?: {
+            name: string;
+            kind: "image" | "video" | "audio";
+        } | undefined;
+        baseVersionId?: string | undefined;
+        changeRequest?: string | undefined;
+        retryOfTaskId?: string | undefined;
+        acknowledgeUnknown?: boolean | undefined;
+    }, any>;
+};
+type GenerationInput = z.infer<typeof generationInput>;
+type StudioConfig = z.infer<typeof studioConfig>;
+type StudioSource = 'projects' | 'assets' | 'tasks';
+interface StudioCatalogEntry {
+    id: string;
+    name: string;
+    available: boolean;
+}
+type StudioQueryInput = SqlInput & {
+    source: StudioSource;
+    catalog?: StudioCatalogEntry[];
+};
+interface StudioFavoriteResult {
+    favorite: RecordValue | null;
+    ref: VersionRef;
+    enabled: boolean;
+}
+interface StudioExportEntry {
+    ref: VersionRef;
+    fileId: string;
+    name: string;
+    sizeBytes: number;
+    open(signal: AbortSignal): Promise<ReadableStream<Uint8Array>>;
+}
+interface StudioGlobal {
+    query(input: StudioQueryInput): Promise<{
+        items: SqlRow[];
+        nextOffset: number | null;
+    }>;
+    asset(ref: VersionRef): Promise<{
+        item: SqlRow;
+        versions: VersionValue[];
+        files: FileValue[];
+    }>;
+    favorite(input: {
+        ref: VersionRef;
+        enabled: boolean;
+    }, call: CallContext): Promise<StudioFavoriteResult>;
+    exportEntries(refs: VersionRef[]): Promise<StudioExportEntry[]>;
+}
+declare const favoriteData: z.ZodObject<{
+    ref: z.ZodObject<{
+        storeId: z.ZodUUID;
+        objectId: z.ZodUUID;
+        versionId: z.ZodUUID;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+declare const globalQueryInput: z.ZodObject<{
+    sql: z.ZodString;
+    params: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNull]>>, z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNull]>>]>>;
+    timeoutMs: z.ZodOptional<z.ZodNumber>;
+    maxRows: z.ZodOptional<z.ZodNumber>;
+    limit: z.ZodOptional<z.ZodNumber>;
+    offset: z.ZodOptional<z.ZodNumber>;
+    source: z.ZodEnum<{
+        projects: "projects";
+        assets: "assets";
+        tasks: "tasks";
+    }>;
+    catalog: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        available: z.ZodBoolean;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
+declare const studioDefaultQueries: Record<StudioSource, string>;
+interface StudioAPI {
+    readonly role: 'project' | 'coordinator';
+    readonly data: DataAPI;
+    readonly global?: StudioGlobal;
+    readonly derivedVideos?: DerivedVideoPublisher;
+}
+declare function generationOperation(model: any, kind: string, referenceCount: number, action?: string): any;
+declare function generationParameters(model: any, operation: string, raw: string, kinds: string[]): string;
+
+interface DerivedVideoImport {
+    stagingFileId: string;
+    inputs: {
+        file: {
+            source: VersionRef;
+            fileId: string;
+        };
+        editRef: VersionRef | null;
+        recipe: JSONValue;
+    }[];
+    provenance: JSONValue;
+    outputName: string;
+    publicationKey: string;
+    completion: {
+        jobId: string;
+        expectedRevision: number;
+        executionToken: string;
+    };
+}
+interface DerivedVideoPublisher {
+    readonly capabilityVersion: 'derived-video/1';
+    readonly storeId: string;
+    readonly projectId: string;
+    assertSameWorkspace(provider: DataWorkspace, projectId: string): void;
+    importDerivedVideo(input: DerivedVideoImport, call: CallContext, complete: (result: {
+        source: VersionRef;
+        fileId: string;
+    }) => void): Promise<{
+        source: VersionRef;
+        fileId: string;
+    }>;
+}
+
+export { type AdBrief, type AdMediaResolver, type AdRecipe, type AdSequence, type AdSequenceEntry, type AdService, type AdStoryboard, type AdStudioProvider, type AdVideoInput, type ClipScript, type DerivedVideoImport, type DerivedVideoPublisher, type GenerationInput, SqlInput, SqlRow, type StudioAPI, type StudioCatalogEntry, type StudioConfig, type StudioExportEntry, type StudioFavoriteResult, type StudioGlobal, type StudioQueryInput, type StudioSource, VersionRef, type VideoFileRef$1 as VideoFileRef, type VideoUse, adBrief, adStoryboard, adTypeId, anchor, assetData, clipScript, favoriteData, generationInput, generationOperation, generationParameters, generationSubmitOperation, globalQueryInput, kind, projectData, projectSettingsInput, studioConfig, studioDefaultQueries, studioOperations, tags, taskCostLabel, taskStates, versionRef };