@shotstack/shotstack-studio 2.17.0 → 2.18.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,7 @@ 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;
     private applyGeneratedSrc;
     /**
      * Look up the (trackIndex, clipIndex) position of a clip by its stable ID.
@@ -601,6 +607,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,7 @@ 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;
     private applyGeneratedSrc;
     /**
      * Look up the (trackIndex, clipIndex) position of a clip by its stable ID.
@@ -495,6 +501,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.