@scenario-labs/sdk 0.2.0 → 0.3.0

package/src/lib/workflow_validator.ts

@@ -0,0 +1,167 @@
+const VALID_NODE_TYPES = new Set([
+  'custom-model',
+  'for-each',
+  'generate-prompt',
+  'list',
+  'logic',
+  'model',
+  'remove-background',
+  'transform',
+  'user-approval',
+  'workflow',
+]);
+
+type RawRef = {
+  node?: unknown;
+  conditional?: unknown;
+};
+
+type RawInput = {
+  name?: unknown;
+  ref?: RawRef;
+  items?: unknown[][];
+};
+
+type RawNode = {
+  id?: unknown;
+  type?: unknown;
+  modelId?: unknown;
+  workflowId?: unknown;
+  logicType?: unknown;
+  loopBodyNodeIds?: unknown;
+  count?: unknown;
+  dependsOn?: unknown;
+  inputs?: unknown;
+};
+
+/**
+ * Validates the structural integrity of a workflow flow (array of nodes).
+ *
+ * Throws an `Error` with a human-readable message on the first violation found.
+ *
+ * Checks performed:
+ *  1. Every node has a non-empty string `id`
+ *  2. Node IDs are unique within the flow
+ *  3. Every node `type` is a recognized workflow node type
+ *  4. Per-type required fields:
+ *       - custom-model → modelId
+ *       - workflow     → workflowId
+ *       - logic        → logicType
+ *       - for-each     → loopBodyNodeIds (non-empty) OR count (>0)
+ *  5. Cross-references all point to node IDs that exist in the flow:
+ *       - dependsOn entries
+ *       - input ref.node (excluding "workflow" which is a reserved keyword)
+ *       - input ref.conditional entries
+ *       - loopBodyNodeIds entries
+ */
+export function validateWorkflowFlow(flow: unknown[]): void {
+  const nodeIds = new Set<string>();
+  const firstSeenAt = new Map<string, number>();
+
+  // Pass 1 — per-node checks (ID, type, required fields)
+  for (let i = 0; i < flow.length; i++) {
+    const node = flow[i] as RawNode;
+
+    if (typeof node.id !== 'string' || !node.id) {
+      throw new Error(`Node at index ${i} is missing an "id" field`);
+    }
+    if (nodeIds.has(node.id)) {
+      throw new Error(
+        `Duplicate node id "${node.id}" at index ${i} (first seen at index ${firstSeenAt.get(node.id)})`,
+      );
+    }
+    nodeIds.add(node.id);
+    firstSeenAt.set(node.id, i);
+
+    const label = `"${node.id}"`;
+
+    if (typeof node.type !== 'string' || !VALID_NODE_TYPES.has(node.type)) {
+      throw new Error(
+        `Node ${label} has invalid type "${node.type}". Valid types are: ${[...VALID_NODE_TYPES].join(', ')}`,
+      );
+    }
+
+    const type = node.type;
+
+    if (type === 'custom-model' && !node.modelId) {
+      throw new Error(`Node ${label} (custom-model) is missing required field "modelId"`);
+    }
+    if (type === 'workflow' && !node.workflowId) {
+      throw new Error(`Node ${label} (workflow) is missing required field "workflowId"`);
+    }
+    if (type === 'logic' && !node.logicType) {
+      throw new Error(`Node ${label} (logic) is missing required field "logicType"`);
+    }
+    if (type === 'for-each') {
+      const hasLoopBody = Array.isArray(node.loopBodyNodeIds) && node.loopBodyNodeIds.length > 0;
+      const hasCount = typeof node.count === 'number' && node.count > 0;
+      if (!hasLoopBody && !hasCount) {
+        throw new Error(
+          `Node ${label} (for-each) requires either "loopBodyNodeIds" (non-empty array) or "count" (positive number)`,
+        );
+      }
+    }
+  }
+
+  // Pass 2 — cross-reference checks (all node IDs are now collected)
+  for (const rawNode of flow) {
+    const node = rawNode as RawNode;
+    const nodeId = node.id as string;
+
+    if (Array.isArray(node.dependsOn)) {
+      for (const depId of node.dependsOn) {
+        if (typeof depId === 'string' && !nodeIds.has(depId)) {
+          throw new Error(`Node "${nodeId}" dependsOn unknown node "${depId}"`);
+        }
+      }
+    }
+
+    if (Array.isArray(node.inputs)) {
+      for (const input of node.inputs) {
+        validateInputRefs(nodeId, input as RawInput, nodeIds);
+      }
+    }
+
+    if (Array.isArray(node.loopBodyNodeIds)) {
+      for (const bodyId of node.loopBodyNodeIds as unknown[]) {
+        if (typeof bodyId === 'string' && !nodeIds.has(bodyId)) {
+          throw new Error(`Node "${nodeId}" loopBodyNodeIds references unknown node "${bodyId}"`);
+        }
+      }
+    }
+  }
+}
+
+function validateInputRefs(nodeId: string, input: RawInput, nodeIds: Set<string>): void {
+  const inputName = typeof input.name === 'string' && input.name ? input.name : '(unnamed)';
+
+  if (input.ref) {
+    const { node: refNode, conditional } = input.ref;
+
+    // "workflow" is a reserved keyword meaning "take from the workflow's own inputs"
+    if (typeof refNode === 'string' && refNode !== 'workflow' && !nodeIds.has(refNode)) {
+      throw new Error(`Node "${nodeId}" input "${inputName}" references unknown node "${refNode}"`);
+    }
+
+    if (Array.isArray(conditional)) {
+      for (const condId of conditional) {
+        if (typeof condId === 'string' && !nodeIds.has(condId)) {
+          throw new Error(
+            `Node "${nodeId}" input "${inputName}" has a conditional ref pointing to unknown node "${condId}"`,
+          );
+        }
+      }
+    }
+  }
+
+  // Recurse into INPUTS_ARRAY sub-inputs
+  if (Array.isArray(input.items)) {
+    for (const item of input.items) {
+      if (Array.isArray(item)) {
+        for (const subInput of item) {
+          validateInputRefs(nodeId, subInput as RawInput, nodeIds);
+        }
+      }
+    }
+  }
+}

package/src/resources/assets/assets.ts

@@ -60,8 +60,8 @@ export class Assets extends APIResource {
   /**
    * Delete multiple assets
    */
-  deleteMultiple(options?: RequestOptions): APIPromise<unknown> {
-    return this._client.delete('/assets', options);
+  deleteMultiple(body: AssetDeleteMultipleParams, options?: RequestOptions): APIPromise<unknown> {
+    return this._client.delete('/assets', { body, ...options });
   }
 
   /**
@@ -10274,7 +10274,80 @@ export interface AssetListParams {
    * img2img, txt2video, uploaded, uploaded-video, uploaded-audio, uploaded-3d,
    * uploaded-avatar, upscale-video
    */
-  types?: string;
+  types?:
+    | 'inference-txt2img'
+    | 'inference-txt2img-ip-adapter'
+    | 'inference-txt2img-texture'
+    | 'inference-img2img'
+    | 'inference-img2img-ip-adapter'
+    | 'inference-img2img-texture'
+    | 'inference-inpaint'
+    | 'inference-inpaint-ip-adapter'
+    | 'inference-reference'
+    | 'inference-reference-texture'
+    | 'inference-controlnet'
+    | 'inference-controlnet-ip-adapter'
+    | 'inference-controlnet-img2img'
+    | 'inference-controlnet-reference'
+    | 'inference-controlnet-inpaint'
+    | 'inference-controlnet-inpaint-ip-adapter'
+    | 'inference-controlnet-texture'
+    | 'background-removal'
+    | 'canvas'
+    | 'canvas-export'
+    | 'canvas-drawing'
+    | 'detection'
+    | 'patch'
+    | 'pixelization'
+    | 'upscale'
+    | 'upscale-texture'
+    | 'upscale-skybox'
+    | 'vectorization'
+    | 'segment'
+    | 'segmentation-image'
+    | 'segmentation-mask'
+    | 'skybox-base-360'
+    | 'skybox-hdri'
+    | 'skybox-3d'
+    | 'restyle'
+    | 'reframe'
+    | 'generative-fill'
+    | 'texture'
+    | 'texture-height'
+    | 'texture-normal'
+    | 'texture-smoothness'
+    | 'texture-metallic'
+    | 'texture-edge'
+    | 'texture-ao'
+    | 'texture-albedo'
+    | 'image-prompt-editing'
+    | 'unknown'
+    | 'img23d'
+    | 'txt23d'
+    | 'video23d'
+    | '3d23d'
+    | '3d23d-texture'
+    | '3d-texture'
+    | '3d-texture-mtl'
+    | '3d-texture-albedo'
+    | '3d-texture-normal'
+    | '3d-texture-roughness'
+    | '3d-texture-metallic'
+    | 'img2video'
+    | 'txt2audio'
+    | 'audio2audio'
+    | 'voice-clone'
+    | 'video2video'
+    | 'video2img'
+    | 'txt2img'
+    | 'img2img'
+    | 'txt2video'
+    | 'uploaded'
+    | 'uploaded-video'
+    | 'uploaded-audio'
+    | 'uploaded-3d'
+    | 'uploaded-avatar'
+    | 'upscale-video';
 
   /**
    * Filter results to only return assets updated after the specified ISO string date
@@ -10289,6 +10362,13 @@ export interface AssetListParams {
   updatedBefore?: string;
 }
 
+export interface AssetDeleteMultipleParams {
+  /**
+   * The ids of the assets to delete. (Max 100 at once)
+   */
+  assetIds: Array<string>;
+}
+
 export interface AssetDuplicateParams {
   /**
    * Query param: If set to true, returns the original asset without transformation
@@ -10442,6 +10522,7 @@ export declare namespace Assets {
     type AssetRetrieveParams as AssetRetrieveParams,
     type AssetUpdateParams as AssetUpdateParams,
     type AssetListParams as AssetListParams,
+    type AssetDeleteMultipleParams as AssetDeleteMultipleParams,
     type AssetDuplicateParams as AssetDuplicateParams,
     type AssetGetBulkParams as AssetGetBulkParams,
     type AssetListSnapshotsParams as AssetListSnapshotsParams,

package/src/resources/assets/index.ts

@@ -16,6 +16,7 @@ export {
   type AssetRetrieveParams,
   type AssetUpdateParams,
   type AssetListParams,
+  type AssetDeleteMultipleParams,
   type AssetDuplicateParams,
   type AssetGetBulkParams,
   type AssetListSnapshotsParams,

package/src/resources/collections/assets.ts

@@ -16,8 +16,12 @@ export class Assets extends APIResource {
   /**
    * Remove assets from a specific collection
    */
-  remove(collectionID: string, options?: RequestOptions): APIPromise<AssetRemoveResponse> {
-    return this._client.delete(path`/collections/${collectionID}/assets`, options);
+  remove(
+    collectionID: string,
+    body: AssetRemoveParams,
+    options?: RequestOptions,
+  ): APIPromise<AssetRemoveResponse> {
+    return this._client.delete(path`/collections/${collectionID}/assets`, { body, ...options });
   }
 }
 
@@ -142,10 +146,18 @@ export interface AssetAddParams {
   assetIds: Array<string>;
 }
 
+export interface AssetRemoveParams {
+  /**
+   * The ids of the assets to remove from the collection. (Max 49 at once)
+   */
+  assetIds: Array<string>;
+}
+
 export declare namespace Assets {
   export {
     type AssetAddResponse as AssetAddResponse,
     type AssetRemoveResponse as AssetRemoveResponse,
     type AssetAddParams as AssetAddParams,
+    type AssetRemoveParams as AssetRemoveParams,
   };
 }

package/src/resources/collections/collections.ts

@@ -2,9 +2,9 @@
 
 import { APIResource } from '../../core/resource';
 import * as AssetsAPI from './assets';
-import { AssetAddParams, AssetAddResponse, AssetRemoveResponse, Assets } from './assets';
+import { AssetAddParams, AssetAddResponse, AssetRemoveParams, AssetRemoveResponse, Assets } from './assets';
 import * as ModelsAPI from './models';
-import { ModelAddParams, ModelAddResponse, ModelRemoveResponse, Models } from './models';
+import { ModelAddParams, ModelAddResponse, ModelRemoveParams, ModelRemoveResponse, Models } from './models';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -344,6 +344,7 @@ export declare namespace Collections {
     type AssetAddResponse as AssetAddResponse,
     type AssetRemoveResponse as AssetRemoveResponse,
     type AssetAddParams as AssetAddParams,
+    type AssetRemoveParams as AssetRemoveParams,
   };
 
   export {
@@ -351,5 +352,6 @@ export declare namespace Collections {
     type ModelAddResponse as ModelAddResponse,
     type ModelRemoveResponse as ModelRemoveResponse,
     type ModelAddParams as ModelAddParams,
+    type ModelRemoveParams as ModelRemoveParams,
   };
 }

package/src/resources/collections/index.ts

@@ -1,6 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Assets, type AssetAddResponse, type AssetRemoveResponse, type AssetAddParams } from './assets';
+export {
+  Assets,
+  type AssetAddResponse,
+  type AssetRemoveResponse,
+  type AssetAddParams,
+  type AssetRemoveParams,
+} from './assets';
 export {
   Collections,
   type CollectionCreateResponse,
@@ -12,4 +18,10 @@ export {
   type CollectionUpdateParams,
   type CollectionListParams,
 } from './collections';
-export { Models, type ModelAddResponse, type ModelRemoveResponse, type ModelAddParams } from './models';
+export {
+  Models,
+  type ModelAddResponse,
+  type ModelRemoveResponse,
+  type ModelAddParams,
+  type ModelRemoveParams,
+} from './models';

package/src/resources/collections/models.ts

@@ -16,8 +16,12 @@ export class Models extends APIResource {
   /**
    * Remove models from a specific collection
    */
-  remove(collectionID: string, options?: RequestOptions): APIPromise<ModelRemoveResponse> {
-    return this._client.delete(path`/collections/${collectionID}/models`, options);
+  remove(
+    collectionID: string,
+    body: ModelRemoveParams,
+    options?: RequestOptions,
+  ): APIPromise<ModelRemoveResponse> {
+    return this._client.delete(path`/collections/${collectionID}/models`, { body, ...options });
   }
 }
 
@@ -142,10 +146,18 @@ export interface ModelAddParams {
   modelIds: Array<string>;
 }
 
+export interface ModelRemoveParams {
+  /**
+   * The ids of the models to remove from the collection. (Max 49 at once)
+   */
+  modelIds: Array<string>;
+}
+
 export declare namespace Models {
   export {
     type ModelAddResponse as ModelAddResponse,
     type ModelRemoveResponse as ModelRemoveResponse,
     type ModelAddParams as ModelAddParams,
+    type ModelRemoveParams as ModelRemoveParams,
   };
 }

package/src/resources/index.ts

@@ -16,6 +16,7 @@ export {
   type AssetRetrieveParams,
   type AssetUpdateParams,
   type AssetListParams,
+  type AssetDeleteMultipleParams,
   type AssetDuplicateParams,
   type AssetGetBulkParams,
   type AssetListSnapshotsParams,