@shotstack/shotstack-studio 2.18.0 → 2.19.0

package/dist/index.d.ts

@@ -238,6 +238,16 @@ export declare class Edit {
      * message says. Without a handler, no generate affordance is shown.
      */
     registerAssetGenerator(handler: AssetGeneratorHandler, options?: AssetGeneratorOptions): void;
+    /**
+     * Generate the asset for a prompt-bearing clip and write the result to it.
+     *
+     * Rejects only when no generator is registered or the clip has nothing to generate from.
+     * A generation failure resolves and surfaces as a `clip:generationFailed` event. Removing
+     * the clip, reloading the edit or disposing it resolves writing nothing, and no completed
+     * or failed event follows the `clip:generationStarted` already emitted. A second call while
+     * one is in flight for the same clip is ignored.
+     */
+    generateClip(clipId: string): Promise<void>;
     private applyGeneratedSrc;
     /**
      * Look up the (trackIndex, clipIndex) position of a clip by its stable ID.
@@ -497,6 +507,9 @@ declare const EditEvent: {
     readonly ClipCaptureStarted: "clip:captureStarted";
     readonly ClipCaptureCompleted: "clip:captureCompleted";
     readonly ClipCaptureFailed: "clip:captureFailed";
+    readonly ClipGenerationStarted: "clip:generationStarted";
+    readonly ClipGenerationCompleted: "clip:generationCompleted";
+    readonly ClipGenerationFailed: "clip:generationFailed";
     readonly ClipUnresolved: "clip:unresolved";
     readonly SelectionCleared: "selection:cleared";
     readonly EditChanged: "edit:changed";
@@ -553,6 +566,16 @@ declare type EditEventMap = {
         error: string;
         fallback: string;
     };
+    [EditEvent.ClipGenerationStarted]: {
+        clipId: string;
+    };
+    [EditEvent.ClipGenerationCompleted]: {
+        clipId: string;
+    };
+    [EditEvent.ClipGenerationFailed]: {
+        clipId: string;
+        error: string;
+    };
     [EditEvent.ClipUnresolved]: ClipLocation & {
         assetType: string;
         clipId: string;

package/dist/internal.d.ts

@@ -127,6 +127,16 @@ export declare class Edit {
      * message says. Without a handler, no generate affordance is shown.
      */
     registerAssetGenerator(handler: AssetGeneratorHandler, options?: AssetGeneratorOptions): void;
+    /**
+     * Generate the asset for a prompt-bearing clip and write the result to it.
+     *
+     * Rejects only when no generator is registered or the clip has nothing to generate from.
+     * A generation failure resolves and surfaces as a `clip:generationFailed` event. Removing
+     * the clip, reloading the edit or disposing it resolves writing nothing, and no completed
+     * or failed event follows the `clip:generationStarted` already emitted. A second call while
+     * one is in flight for the same clip is ignored.
+     */
+    generateClip(clipId: string): Promise<void>;
     private applyGeneratedSrc;
     /**
      * Look up the (trackIndex, clipIndex) position of a clip by its stable ID.
@@ -383,6 +393,9 @@ declare const EditEvent: {
     readonly ClipCaptureStarted: "clip:captureStarted";
     readonly ClipCaptureCompleted: "clip:captureCompleted";
     readonly ClipCaptureFailed: "clip:captureFailed";
+    readonly ClipGenerationStarted: "clip:generationStarted";
+    readonly ClipGenerationCompleted: "clip:generationCompleted";
+    readonly ClipGenerationFailed: "clip:generationFailed";
     readonly ClipUnresolved: "clip:unresolved";
     readonly SelectionCleared: "selection:cleared";
     readonly EditChanged: "edit:changed";
@@ -439,6 +452,16 @@ declare type EditEventMap = {
         error: string;
         fallback: string;
     };
+    [EditEvent.ClipGenerationStarted]: {
+        clipId: string;
+    };
+    [EditEvent.ClipGenerationCompleted]: {
+        clipId: string;
+    };
+    [EditEvent.ClipGenerationFailed]: {
+        clipId: string;
+        error: string;
+    };
     [EditEvent.ClipUnresolved]: ClipLocation & {
         assetType: string;
         clipId: string;