@scenario-labs/sdk 0.2.0 → 1.0.0

package/src/core/pagination.ts

@@ -0,0 +1,497 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { ScenarioError } from './error';
+import { FinalRequestOptions } from '../internal/request-options';
+import { defaultParseResponse } from '../internal/parse';
+import { type Scenario } from '../client';
+import { APIPromise } from './api-promise';
+import { type APIResponseProps } from '../internal/parse';
+import { maybeObj } from '../internal/utils/values';
+
+export type PageRequestOptions = Pick<FinalRequestOptions, 'query' | 'headers' | 'body' | 'path' | 'method'>;
+
+export abstract class AbstractPage<Item> implements AsyncIterable<Item> {
+  #client: Scenario;
+  protected options: FinalRequestOptions;
+
+  protected response: Response;
+  protected body: unknown;
+
+  constructor(client: Scenario, response: Response, body: unknown, options: FinalRequestOptions) {
+    this.#client = client;
+    this.options = options;
+    this.response = response;
+    this.body = body;
+  }
+
+  abstract nextPageRequestOptions(): PageRequestOptions | null;
+
+  abstract getPaginatedItems(): Item[];
+
+  hasNextPage(): boolean {
+    const items = this.getPaginatedItems();
+    if (!items.length) return false;
+    return this.nextPageRequestOptions() != null;
+  }
+
+  async getNextPage(): Promise<this> {
+    const nextOptions = this.nextPageRequestOptions();
+    if (!nextOptions) {
+      throw new ScenarioError(
+        'No next page expected; please check `.hasNextPage()` before calling `.getNextPage()`.',
+      );
+    }
+
+    return await this.#client.requestAPIList(this.constructor as any, nextOptions);
+  }
+
+  async *iterPages(): AsyncGenerator<this> {
+    let page: this = this;
+    yield page;
+    while (page.hasNextPage()) {
+      page = await page.getNextPage();
+      yield page;
+    }
+  }
+
+  async *[Symbol.asyncIterator](): AsyncGenerator<Item> {
+    for await (const page of this.iterPages()) {
+      for (const item of page.getPaginatedItems()) {
+        yield item;
+      }
+    }
+  }
+}
+
+/**
+ * This subclass of Promise will resolve to an instantiated Page once the request completes.
+ *
+ * It also implements AsyncIterable to allow auto-paginating iteration on an unawaited list call, eg:
+ *
+ *    for await (const item of client.items.list()) {
+ *      console.log(item)
+ *    }
+ */
+export class PagePromise<
+    PageClass extends AbstractPage<Item>,
+    Item = ReturnType<PageClass['getPaginatedItems']>[number],
+  >
+  extends APIPromise<PageClass>
+  implements AsyncIterable<Item>
+{
+  constructor(
+    client: Scenario,
+    request: Promise<APIResponseProps>,
+    Page: new (...args: ConstructorParameters<typeof AbstractPage>) => PageClass,
+  ) {
+    super(
+      client,
+      request,
+      async (client, props) =>
+        new Page(client, props.response, await defaultParseResponse(client, props), props.options),
+    );
+  }
+
+  /**
+   * Allow auto-paginating iteration on an unawaited list call, eg:
+   *
+   *    for await (const item of client.items.list()) {
+   *      console.log(item)
+   *    }
+   */
+  async *[Symbol.asyncIterator](): AsyncGenerator<Item> {
+    const page = await this;
+    for await (const item of page) {
+      yield item;
+    }
+  }
+}
+
+export interface AssetsCursorResponse<Item> {
+  assets: Array<Item>;
+
+  nextPaginationToken: string;
+}
+
+export interface AssetsCursorParams {
+  paginationToken?: string;
+}
+
+export class AssetsCursor<Item> extends AbstractPage<Item> implements AssetsCursorResponse<Item> {
+  assets: Array<Item>;
+
+  nextPaginationToken: string;
+
+  constructor(
+    client: Scenario,
+    response: Response,
+    body: AssetsCursorResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.assets = body.assets || [];
+    this.nextPaginationToken = body.nextPaginationToken || '';
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.assets ?? [];
+  }
+
+  nextPageRequestOptions(): PageRequestOptions | null {
+    const cursor = this.nextPaginationToken;
+    if (!cursor) {
+      return null;
+    }
+
+    return {
+      ...this.options,
+      query: {
+        ...maybeObj(this.options.query),
+        paginationToken: cursor,
+      },
+    };
+  }
+}
+
+export interface SnapshotsCursorResponse<Item> {
+  snapshots: Array<Item>;
+
+  nextPaginationToken: string;
+}
+
+export interface SnapshotsCursorParams {
+  paginationToken?: string;
+}
+
+export class SnapshotsCursor<Item> extends AbstractPage<Item> implements SnapshotsCursorResponse<Item> {
+  snapshots: Array<Item>;
+
+  nextPaginationToken: string;
+
+  constructor(
+    client: Scenario,
+    response: Response,
+    body: SnapshotsCursorResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.snapshots = body.snapshots || [];
+    this.nextPaginationToken = body.nextPaginationToken || '';
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.snapshots ?? [];
+  }
+
+  nextPageRequestOptions(): PageRequestOptions | null {
+    const cursor = this.nextPaginationToken;
+    if (!cursor) {
+      return null;
+    }
+
+    return {
+      ...this.options,
+      query: {
+        ...maybeObj(this.options.query),
+        paginationToken: cursor,
+      },
+    };
+  }
+}
+
+export interface CollectionsCursorResponse<Item> {
+  collections: Array<Item>;
+
+  nextPaginationToken: string;
+}
+
+export interface CollectionsCursorParams {
+  paginationToken?: string;
+}
+
+export class CollectionsCursor<Item> extends AbstractPage<Item> implements CollectionsCursorResponse<Item> {
+  collections: Array<Item>;
+
+  nextPaginationToken: string;
+
+  constructor(
+    client: Scenario,
+    response: Response,
+    body: CollectionsCursorResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.collections = body.collections || [];
+    this.nextPaginationToken = body.nextPaginationToken || '';
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.collections ?? [];
+  }
+
+  nextPageRequestOptions(): PageRequestOptions | null {
+    const cursor = this.nextPaginationToken;
+    if (!cursor) {
+      return null;
+    }
+
+    return {
+      ...this.options,
+      query: {
+        ...maybeObj(this.options.query),
+        paginationToken: cursor,
+      },
+    };
+  }
+}
+
+export interface JobsCursorResponse<Item> {
+  jobs: Array<Item>;
+
+  nextPaginationToken: string;
+}
+
+export interface JobsCursorParams {
+  paginationToken?: string;
+}
+
+export class JobsCursor<Item> extends AbstractPage<Item> implements JobsCursorResponse<Item> {
+  jobs: Array<Item>;
+
+  nextPaginationToken: string;
+
+  constructor(
+    client: Scenario,
+    response: Response,
+    body: JobsCursorResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.jobs = body.jobs || [];
+    this.nextPaginationToken = body.nextPaginationToken || '';
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.jobs ?? [];
+  }
+
+  nextPageRequestOptions(): PageRequestOptions | null {
+    const cursor = this.nextPaginationToken;
+    if (!cursor) {
+      return null;
+    }
+
+    return {
+      ...this.options,
+      query: {
+        ...maybeObj(this.options.query),
+        paginationToken: cursor,
+      },
+    };
+  }
+}
+
+export interface ModelsCursorResponse<Item> {
+  models: Array<Item>;
+
+  nextPaginationToken: string;
+}
+
+export interface ModelsCursorParams {
+  paginationToken?: string;
+}
+
+export class ModelsCursor<Item> extends AbstractPage<Item> implements ModelsCursorResponse<Item> {
+  models: Array<Item>;
+
+  nextPaginationToken: string;
+
+  constructor(
+    client: Scenario,
+    response: Response,
+    body: ModelsCursorResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.models = body.models || [];
+    this.nextPaginationToken = body.nextPaginationToken || '';
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.models ?? [];
+  }
+
+  nextPageRequestOptions(): PageRequestOptions | null {
+    const cursor = this.nextPaginationToken;
+    if (!cursor) {
+      return null;
+    }
+
+    return {
+      ...this.options,
+      query: {
+        ...maybeObj(this.options.query),
+        paginationToken: cursor,
+      },
+    };
+  }
+}
+
+export interface TagsCursorResponse<Item> {
+  tags: Array<Item>;
+
+  nextPaginationToken: string;
+}
+
+export interface TagsCursorParams {
+  paginationToken?: string;
+}
+
+export class TagsCursor<Item> extends AbstractPage<Item> implements TagsCursorResponse<Item> {
+  tags: Array<Item>;
+
+  nextPaginationToken: string;
+
+  constructor(
+    client: Scenario,
+    response: Response,
+    body: TagsCursorResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.tags = body.tags || [];
+    this.nextPaginationToken = body.nextPaginationToken || '';
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.tags ?? [];
+  }
+
+  nextPageRequestOptions(): PageRequestOptions | null {
+    const cursor = this.nextPaginationToken;
+    if (!cursor) {
+      return null;
+    }
+
+    return {
+      ...this.options,
+      query: {
+        ...maybeObj(this.options.query),
+        paginationToken: cursor,
+      },
+    };
+  }
+}
+
+export interface WorkflowsCursorResponse<Item> {
+  workflows: Array<Item>;
+
+  nextPaginationToken: string;
+}
+
+export interface WorkflowsCursorParams {
+  paginationToken?: string;
+}
+
+export class WorkflowsCursor<Item> extends AbstractPage<Item> implements WorkflowsCursorResponse<Item> {
+  workflows: Array<Item>;
+
+  nextPaginationToken: string;
+
+  constructor(
+    client: Scenario,
+    response: Response,
+    body: WorkflowsCursorResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.workflows = body.workflows || [];
+    this.nextPaginationToken = body.nextPaginationToken || '';
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.workflows ?? [];
+  }
+
+  nextPageRequestOptions(): PageRequestOptions | null {
+    const cursor = this.nextPaginationToken;
+    if (!cursor) {
+      return null;
+    }
+
+    return {
+      ...this.options,
+      query: {
+        ...maybeObj(this.options.query),
+        paginationToken: cursor,
+      },
+    };
+  }
+}
+
+export interface SearchHitsOffsetResponse<Item> {
+  hits: Array<Item>;
+
+  estimatedTotalHits: number;
+
+  offset: number;
+}
+
+export interface SearchHitsOffsetParams {
+  offset?: number;
+}
+
+export class SearchHitsOffset<Item> extends AbstractPage<Item> implements SearchHitsOffsetResponse<Item> {
+  hits: Array<Item>;
+
+  estimatedTotalHits: number;
+
+  offset: number;
+
+  constructor(
+    client: Scenario,
+    response: Response,
+    body: SearchHitsOffsetResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.hits = body.hits || [];
+    this.estimatedTotalHits = body.estimatedTotalHits || 0;
+    this.offset = body.offset || 0;
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.hits ?? [];
+  }
+
+  nextPageRequestOptions(): PageRequestOptions | null {
+    const offset = this.offset ?? 0;
+    const length = this.getPaginatedItems().length;
+    const currentCount = offset + length;
+
+    const totalCount = this.estimatedTotalHits;
+    if (!totalCount) {
+      return null;
+    }
+
+    if (currentCount < totalCount) {
+      return {
+        ...this.options,
+        body: {
+          ...maybeObj(this.options.body),
+          offset: currentCount,
+        },
+      };
+    }
+
+    return null;
+  }
+}

package/src/index.ts

@@ -6,6 +6,7 @@ export { type Uploadable, toFile } from './core/uploads';
 export { APIPromise } from './core/api-promise';
 export { Scenario } from './lib/scenario';
 export { type ClientOptions } from './client';
+export { PagePromise } from './core/pagination';
 export {
   ScenarioError,
   APIError,
@@ -23,5 +24,13 @@ export {
 } from './core/error';
 export { Job, type WaitOptions, type WithJob } from './lib/job';
 export { EnhancedWorkflows, WorkflowEntity } from './lib/workflow';
+export { validateWorkflowFlow } from './lib/workflow_validator';
+export {
+  validateEditorInfo,
+  WorkflowImportError,
+  VALID_EDITOR_NODE_TYPES,
+  type WorkflowExportData,
+  type WorkflowEditorNodeType,
+} from './lib/workflow_import_validator';
 export { EnhancedGenerate } from './lib/generate';
 export { EnhancedModels, EnhancedTrain } from './lib/models';

package/src/internal/request-options.ts

@@ -75,7 +75,7 @@ export type RequestOptions = {
    */
   defaultBaseURL?: string | undefined;
 
-  __security?: { scBearerAuth?: boolean; scBasicAuth?: boolean };
+  __security?: { scBasicAuth?: boolean; scBearerAuth?: boolean };
 
   __binaryResponse?: boolean | undefined;
 };

package/src/lib/models.ts

@@ -1,8 +1,55 @@
 import type { APIPromise } from '../core/api-promise';
 import type { RequestOptions } from '../internal/request-options';
-import { Models } from '../resources/models/models';
+import type { GenerateRunModelParams, GenerateRunModelResponse } from '../resources/generate';
+import { Models, type ModelRetrieveParams, type ModelRetrieveResponse } from '../resources/models/models';
 import { Train, type TrainTriggerParams, type TrainTriggerResponse } from '../resources/models/train';
 import { type WithJob, enhanceJob } from './job';
+// Type-only import to break the circular `scenario.ts` ↔ `models.ts` graph at runtime.
+import type { Scenario } from './scenario';
+
+/**
+ * Enhanced Model entity with helper methods.
+ * Has all original model fields plus `.run()`.
+ *
+ * @example
+ * ```ts
+ * const { model } = await client.models.retrieve(modelId);
+ * const gen = await model.run({ body: { prompt: 'a red car' } });
+ * const completed = await gen.job.wait();
+ * ```
+ */
+export class ModelEntity {
+  /** @internal */ declare readonly _client: Scenario;
+
+  /**
+   * Generate with this model. Shortcut for
+   * `client.generate.runModel(this.id, params)`.
+   *
+   * Returns an enhanced response where `response.job` has `.wait()`.
+   */
+  run(
+    this: ModelEntity & ModelRetrieveResponse.Model,
+    params: GenerateRunModelParams,
+    options?: RequestOptions,
+  ): APIPromise<WithJob<GenerateRunModelResponse>> {
+    return this._client.generate.runModel(this.id, params, options);
+  }
+
+  /** @internal Create a ModelEntity wrapping raw model data. */
+  static from(
+    client: Scenario,
+    data: ModelRetrieveResponse.Model,
+  ): ModelRetrieveResponse.Model & ModelEntity {
+    const entity = Object.assign(Object.create(ModelEntity.prototype), data);
+    Object.defineProperty(entity, '_client', { value: client, enumerable: false });
+    return entity;
+  }
+}
+
+/** Enhanced retrieve response where `model` has `.run()` on top of its original fields. */
+export type EnhancedModelRetrieveResponse = Omit<ModelRetrieveResponse, 'model'> & {
+  model: ModelRetrieveResponse.Model & ModelEntity;
+};
 
 /**
  * Enhanced Train resource.
@@ -20,8 +67,21 @@ export class EnhancedTrain extends Train {
 
 /**
  * Enhanced Models resource.
- * All original methods inherited. `train` is an {@link EnhancedTrain}.
+ * All original methods inherited.
+ * - `train` is an {@link EnhancedTrain}
+ * - `retrieve()` returns a response where `model` has `.run()`
  */
 export class EnhancedModels extends Models {
   override train: EnhancedTrain = new EnhancedTrain(this._client);
+
+  override retrieve(
+    modelID: string,
+    query: ModelRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<EnhancedModelRetrieveResponse> {
+    return super.retrieve(modelID, query, options)._thenUnwrap((data) => ({
+      ...data,
+      model: ModelEntity.from(this._client as Scenario, data.model),
+    }));
+  }
 }

package/src/lib/scenario.ts

@@ -1,6 +1,7 @@
 import { Scenario as BaseScenario } from '../client';
 import { EnhancedGenerate } from './generate';
 import { EnhancedModels } from './models';
+import { EnhancedUploads } from './upload';
 import { EnhancedWorkflows } from './workflow';
 
 /**
@@ -36,4 +37,5 @@ export class Scenario extends BaseScenario {
   override workflows: EnhancedWorkflows = new EnhancedWorkflows(this);
   override generate: EnhancedGenerate = new EnhancedGenerate(this);
   override models: EnhancedModels = new EnhancedModels(this);
+  override uploads: EnhancedUploads = new EnhancedUploads(this);
 }