@shotstack/shotstack-studio 2.0.0-beta.19 → 2.0.0-beta.20

package/dist/index.d.ts

@@ -7,6 +7,7 @@ import { cropSchema as CropSchema } from '@shotstack/schemas/zod';
 import { editSchema as EditSchema } from '@shotstack/schemas/zod';
 import { htmlAssetSchema as HtmlAssetSchema } from '@shotstack/schemas/zod';
 import { imageAssetSchema as ImageAssetSchema } from '@shotstack/schemas/zod';
+import { imageToVideoAssetSchema as ImageToVideoAssetSchema } from '@shotstack/schemas/zod';
 import { lumaAssetSchema as LumaAssetSchema } from '@shotstack/schemas/zod';
 import { offsetSchema as OffsetSchema } from '@shotstack/schemas/zod';
 import { outputSchema as OutputSchema } from '@shotstack/schemas/zod';
@@ -14,6 +15,8 @@ import * as pixi from 'pixi.js';
 import { richTextAssetSchema as RichTextAssetSchema } from '@shotstack/schemas/zod';
 import { shapeAssetSchema as ShapeAssetSchema } from '@shotstack/schemas/zod';
 import { textAssetSchema as TextAssetSchema } from '@shotstack/schemas/zod';
+import { textToImageAssetSchema as TextToImageAssetSchema } from '@shotstack/schemas/zod';
+import { textToSpeechAssetSchema as TextToSpeechAssetSchema } from '@shotstack/schemas/zod';
 import { timelineSchema as TimelineSchema } from '@shotstack/schemas/zod';
 import { trackSchema as TrackSchema } from '@shotstack/schemas/zod';
 import { transformationSchema as TransformationSchema } from '@shotstack/schemas/zod';
@@ -138,6 +141,7 @@ export declare class Canvas {
     private background?;
     private timeline?;
     private uiController;
+    private alignmentGuides;
     private minZoom;
     private maxZoom;
     private currentZoom;
@@ -146,11 +150,6 @@ export declare class Canvas {
     private onWheelBound;
     private canvasRoot;
     constructor(edit: Edit);
-    /**
-     * Register a UIController to receive tick updates for canvas overlays.
-     * @deprecated Use `new UIController(edit, canvas)` instead - auto-registers.
-     */
-    registerUIController(controller: UIController): void;
     load(): Promise<void>;
     private setupTouchHandling;
     private onWheel;
@@ -310,8 +309,13 @@ export declare type ClipLocation = {
     clipIndex: number;
 };
 
+/**
+ * Reference to a clip from the document (source of truth).
+ * Contains original timing values like "auto", "end", and alias references.
+ * Used in public SDK events so consumers see the document state.
+ */
 export declare type ClipReference = ClipLocation & {
-    clip: ResolvedClip;
+    clip: Clip;
 };
 
 /** Custom clip renderer interface */
@@ -443,20 +447,17 @@ export declare class Edit {
     private static readonly MAX_HISTORY_SIZE;
     private document;
     private backgroundColor;
-    private edit;
     private tracks;
     playbackTime: Seconds;
     totalDuration: Seconds;
     isPlaying: boolean;
     private get clips();
-    private get endLengthClips();
-    private cachedTimelineEnd;
     private canvas;
+    private timingManager;
     private lumaMaskController;
     private playerReconciler;
     private outputSettings;
     private selectionManager;
-    private alignmentGuides;
     private commandHistory;
     private commandIndex;
     private commandQueue;
@@ -467,6 +468,7 @@ export declare class Edit {
     private isBatchingEvents;
     private syncCorrectionCount;
     private isExporting;
+    private lastResolved;
     /**
      * Create an Edit instance from a template configuration.
      */
@@ -499,7 +501,6 @@ export declare class Edit {
             message: string;
         }>;
     };
-    getResolvedEdit(): ResolvedEdit;
     addClip(trackIdx: number, clip: Clip): void | Promise<void>;
     getClip(trackIdx: number, clipIdx: number): Clip | null;
     /**
@@ -532,6 +533,12 @@ export declare class Edit {
     private detectBindingsInObject;
     /**
      * Checks if edit has structural changes requiring full reload.
+     *
+     * TODO: Expand granular path to handle more cases:
+     * - Clip add/remove: Use existing addClip()/deleteClip() commands
+     * - Soundtrack changes: Add/remove AudioPlayer via commands
+     * - Font changes: Load new fonts incrementally
+     * - Merge field changes: Re-resolve affected clips
      */
     private hasStructuralChanges;
     /**
@@ -540,6 +547,9 @@ export declare class Edit {
     private preserveClipIdsForGranularUpdate;
     /**
      * Applies granular changes without full reload.
+     * @param newEdit - The new edit configuration
+     * @param oldTracks - The old tracks (captured before document update)
+     * @param oldOutput - The old output settings (captured before document update)
      */
     private applyGranularChanges;
     private queueDisposeClip;
@@ -553,8 +563,6 @@ export declare class Edit {
     private extractFilenameFromUrl;
     private disposeClip;
     private unloadClipAssets;
-    private updateTotalDuration;
-    private resolveAllTiming;
     private movePlayerToTrackContainer;
     private addPlayer;
     setOutputSize(width: number, height: number): Promise<void>;
@@ -608,9 +616,6 @@ export declare class Edit {
 
 declare type Edit_2 = components["schemas"]["Edit"];
 
-/** Alias for Edit type to avoid conflicts with SDK's Edit class */
-export declare type EditConfig = Edit_2;
-
 export declare const EditEvent: {
     readonly PlaybackPlay: "playback:play";
     readonly PlaybackPause: "playback:pause";
@@ -624,6 +629,7 @@ export declare const EditEvent: {
     readonly ClipRestored: "clip:restored";
     readonly ClipCopied: "clip:copied";
     readonly ClipLoadFailed: "clip:loadFailed";
+    readonly ClipUnresolved: "clip:unresolved";
     readonly SelectionCleared: "selection:cleared";
     readonly EditChanged: "edit:changed";
     readonly EditUndo: "edit:undo";
@@ -652,8 +658,9 @@ export declare const EditEvent: {
 export declare type EditEventMap = {
     [EditEvent.PlaybackPlay]: void;
     [EditEvent.PlaybackPause]: void;
+    /** Contains the document (source of truth) with original timing values like "auto", "end" */
     [EditEvent.TimelineUpdated]: {
-        current: ResolvedEdit;
+        current: Edit_2;
     };
     [EditEvent.TimelineBackgroundChanged]: {
         color: string;
@@ -676,6 +683,10 @@ export declare type EditEventMap = {
         error: string;
         assetType: string;
     };
+    [EditEvent.ClipUnresolved]: ClipLocation & {
+        assetType: string;
+        clipId: string;
+    };
     [EditEvent.SelectionCleared]: void;
     [EditEvent.EditChanged]: {
         source: string;
@@ -702,19 +713,19 @@ export declare type EditEventMap = {
         height: number;
     };
     [EditEvent.OutputResolutionChanged]: {
-        resolution: string | undefined;
+        resolution: Output["resolution"];
     };
     [EditEvent.OutputAspectRatioChanged]: {
-        aspectRatio: string | undefined;
+        aspectRatio: Output["aspectRatio"];
     };
     [EditEvent.OutputFpsChanged]: {
         fps: number;
     };
     [EditEvent.OutputFormatChanged]: {
-        format: string;
+        format: Output["format"];
     };
     [EditEvent.OutputDestinationsChanged]: {
-        destinations: unknown[];
+        destinations: Destination[];
     };
     [EditEvent.MergeFieldRegistered]: {
         field: MergeField_2;
@@ -792,6 +803,10 @@ export declare type ImageAsset = components["schemas"]["ImageAsset"];
 
 export { ImageAssetSchema }
 
+export declare type ImageToVideoAsset = components["schemas"]["ImageToVideoAsset"];
+
+export { ImageToVideoAssetSchema }
+
 /**
  * Inspector displays performance stats as an HTML overlay.
  * Shows FPS, memory, playback health, and clip statistics.
@@ -1006,27 +1021,18 @@ export declare const OutputResolutionSchema: z.ZodOptional<z.ZodEnum<{
 export { OutputSchema }
 
 export declare const OutputSizeSchema: z.ZodObject<{
-    width: z.ZodOptional<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>>;
-    height: z.ZodOptional<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>>;
+    width: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>, z.ZodString]>>;
+    height: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>, z.ZodString]>>;
 }, z.core.$strip>;
 
 declare type ResolutionChangeCallback = (width: number, height: number) => void;
 
 declare type ResolvedClip = Omit<Clip, "start" | "length"> & {
+    id: string;
     start: Seconds;
     length: Seconds;
 };
 
-declare type ResolvedEdit = Omit<Edit_2, "timeline"> & {
-    timeline: Omit<Edit_2["timeline"], "tracks"> & {
-        tracks: ResolvedTrack[];
-    };
-};
-
-declare type ResolvedTrack = {
-    clips: ResolvedClip[];
-};
-
 export declare type RichTextAsset = components["schemas"]["RichTextAsset"];
 
 export { RichTextAssetSchema }
@@ -1240,6 +1246,10 @@ export declare type TextAsset = components["schemas"]["TextAsset"];
 
 export { TextAssetSchema }
 
+export declare type TextToImageAsset = components["schemas"]["TextToImageAsset"];
+
+export { TextToImageAssetSchema }
+
 export declare class TextToolbar extends BaseToolbar {
     private textEditBtn;
     private textEditPopup;
@@ -1310,6 +1320,10 @@ export declare class TextToolbar extends BaseToolbar {
     dispose(): void;
 }
 
+export declare type TextToSpeechAsset = components["schemas"]["TextToSpeechAsset"];
+
+export { TextToSpeechAssetSchema }
+
 export declare class Timeline {
     private readonly edit;
     readonly element: HTMLElement;
@@ -1543,7 +1557,6 @@ export declare class TranscriptionIndicator extends Entity {
     hide(): void;
     getIsVisible(): boolean;
     update(deltaTime: number, _elapsed: number): void;
-    draw(): void;
     private redraw;
     setPosition(x: number, y: number): void;
     getWidth(): number;
@@ -1813,6 +1826,9 @@ export declare interface UIRegistration {
     dispose(): void;
 }
 
+/** Alias for Edit type - represents an edit before timing values are resolved */
+export declare type UnresolvedEdit = Edit_2;
+
 export declare const VERSION: string;
 
 export declare type VideoAsset = components["schemas"]["VideoAsset"];