@shotstack/shotstack-studio 2.17.0 → 2.19.0

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { components } from '@shotstack/schemas';
+import { operations } from '@shotstack/schemas';
 
 /** Passed to the host handler for one generation. */
 export declare interface AssetGenerationRequest {
@@ -18,6 +19,11 @@ export declare type AssetGeneratorHandler = (request: AssetGenerationRequest) =>
     url: string;
 }>;
 
+export declare interface AssetGeneratorOptions {
+    /** Model catalogue with each entry's option schema included. Entries without one are ignored. */
+    catalogue?: GenerationModelCatalogueResponse;
+}
+
 /**
  * Payload passed to button click handlers.
  */
@@ -231,7 +237,17 @@ export declare class Edit {
      * URL back to the clip; the host owns how generation happens and what a failure
      * message says. Without a handler, no generate affordance is shown.
      */
-    registerAssetGenerator(handler: AssetGeneratorHandler): void;
+    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.
@@ -491,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";
@@ -547,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;
@@ -601,6 +630,8 @@ declare type EditEventMap = {
 
 declare type EventPayloadMap<TPayload = any> = Record<string, TPayload>;
 
+declare type GenerationModelCatalogueResponse = operations["getModels"]["responses"][200]["content"]["application/json"];
+
 declare type Listener<TPayload = any> = (payload: TPayload) => void;
 
 /**

package/dist/internal.d.ts

@@ -1,4 +1,5 @@
 import { components } from '@shotstack/schemas';
+import { operations } from '@shotstack/schemas';
 
 /** Passed to the host handler for one generation. */
 declare interface AssetGenerationRequest {
@@ -18,6 +19,11 @@ declare type AssetGeneratorHandler = (request: AssetGenerationRequest) => Promis
     url: string;
 }>;
 
+declare interface AssetGeneratorOptions {
+    /** Model catalogue with each entry's option schema included. Entries without one are ignored. */
+    catalogue?: GenerationModelCatalogueResponse;
+}
+
 declare type Clip = components["schemas"]["Clip"];
 
 declare type ClipLocation = {
@@ -120,7 +126,17 @@ export declare class Edit {
      * URL back to the clip; the host owns how generation happens and what a failure
      * message says. Without a handler, no generate affordance is shown.
      */
-    registerAssetGenerator(handler: AssetGeneratorHandler): void;
+    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.
@@ -377,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";
@@ -433,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;
@@ -495,6 +524,8 @@ declare class EventEmitter<TEventPayloadMap extends EventPayloadMap = EventPaylo
 
 declare type EventPayloadMap<TPayload = any> = Record<string, TPayload>;
 
+declare type GenerationModelCatalogueResponse = operations["getModels"]["responses"][200]["content"]["application/json"];
+
 /**
  * Thrown by mutation methods (addClip, addTrack, addFont, setFonts) when a
  * referenced asset/font URL fails preflight.