@introspection-sdk/introspection-node 0.5.0 → 0.5.1

package/src/runner-resources/files.ts

@@ -1,5 +1,6 @@
 import type {
   File as FileResource,
+  FileCreateOptions,
   FileCreateTextParams,
   FileListParams,
   FileType,
@@ -8,6 +9,7 @@ import type {
   Paginated,
 } from "@introspection-sdk/types";
 import { HttpClient } from "../http.js";
+import { Paginator, cursorPaginate } from "../pagination.js";
 
 export type FileUploadBody =
   | { file: Blob; name?: string; file_type?: FileType }
@@ -22,23 +24,20 @@ export class FileVersionsApi {
   constructor(private readonly http: HttpClient) {}
 
   /**
-   * Iterate versions of a file. Pages are fetched lazily as the
-   * iterator is consumed; stop early to stop fetching.
+   * List versions of a file. `await` the result for the first page, or
+   * `for await` it to stream every version across pages (fetched lazily;
+   * stop early to stop fetching).
    */
-  async *list(
-    fileId: string,
-    params?: ListParams,
-  ): AsyncIterable<FileResource> {
-    let next: string | undefined = params?.next;
-    do {
-      const page = await this.http.request<Paginated<FileResource>>({
-        method: "GET",
-        path: `/v1/files/${encodeURIComponent(fileId)}/versions`,
-        query: { ...params, next } as Record<string, unknown>,
-      });
-      for (const f of page.records) yield f;
-      next = page.next ?? undefined;
-    } while (next);
+  list(fileId: string, params?: ListParams): Paginator<FileResource> {
+    return cursorPaginate(
+      (next) =>
+        this.http.request<Paginated<FileResource>>({
+          method: "GET",
+          path: `/v1/files/${encodeURIComponent(fileId)}/versions`,
+          query: { ...params, next } as Record<string, unknown>,
+        }),
+      params?.next,
+    );
   }
 
   get(fileId: string, versionId: string): Promise<FileResource> {
@@ -48,8 +47,12 @@ export class FileVersionsApi {
     });
   }
 
-  create(fileId: string, body: FileUploadBody): Promise<FileResource> {
-    const form = toFormData(body);
+  create(
+    fileId: string,
+    body: FileUploadBody,
+    options?: FileCreateOptions,
+  ): Promise<FileResource> {
+    const form = toFormData(body, options);
     return this.http.request<FileResource>({
       method: "POST",
       path: `/v1/files/${encodeURIComponent(fileId)}/versions`,
@@ -66,25 +69,28 @@ export class FilesApi {
   }
 
   /**
-   * Iterate files matching `params`. Pages are fetched lazily as the
-   * iterator is consumed (`limit` sets the page size, `next` the
-   * starting cursor); stop early to stop fetching.
+   * List files matching `params`. `await` the result for the first page,
+   * or `for await` it to stream every file across pages (fetched lazily —
+   * `limit` sets the page size, `next` the starting cursor; stop early to
+   * stop fetching).
    */
-  async *list(params?: FileListParams): AsyncIterable<FileResource> {
-    let next: string | undefined = params?.next;
-    do {
-      const page = await this.http.request<Paginated<FileResource>>({
-        method: "GET",
-        path: "/v1/files",
-        query: { ...params, next } as Record<string, unknown>,
-      });
-      for (const f of page.records) yield f;
-      next = page.next ?? undefined;
-    } while (next);
+  list(params?: FileListParams): Paginator<FileResource> {
+    return cursorPaginate(
+      (next) =>
+        this.http.request<Paginated<FileResource>>({
+          method: "GET",
+          path: "/v1/files",
+          query: { ...params, next } as Record<string, unknown>,
+        }),
+      params?.next,
+    );
   }
 
-  upload(body: FileUploadBody): Promise<FileResource> {
-    const form = toFormData(body);
+  upload(
+    body: FileUploadBody,
+    options?: FileCreateOptions,
+  ): Promise<FileResource> {
+    const form = toFormData(body, options);
     return this.http.request<FileResource>({
       method: "POST",
       path: "/v1/files",
@@ -92,11 +98,16 @@ export class FilesApi {
     });
   }
 
-  createText(body: FileCreateTextParams): Promise<FileResource> {
+  createText(
+    body: FileCreateTextParams,
+    options?: FileCreateOptions,
+  ): Promise<FileResource> {
     return this.http.request<FileResource>({
       method: "POST",
       path: "/v1/files",
-      body,
+      body: options?.visibility
+        ? { ...body, visibility: options.visibility }
+        : body,
     });
   }
 
@@ -140,7 +151,10 @@ export class FilesApi {
   }
 }
 
-function toFormData(body: FileUploadBody): FormData {
+function toFormData(
+  body: FileUploadBody,
+  options?: FileCreateOptions,
+): FormData {
   const fd = new FormData();
   if ("file" in body && body.file instanceof Blob) {
     fd.append("file", body.file, body.name);
@@ -160,5 +174,6 @@ function toFormData(body: FileUploadBody): FormData {
   }
   if (body.name) fd.append("name", body.name);
   if (body.file_type) fd.append("file_type", body.file_type);
+  if (options?.visibility) fd.append("visibility", options.visibility);
   return fd;
 }

package/src/runner-resources/tasks.ts

@@ -12,6 +12,7 @@ import type {
   TaskUpdateParams,
 } from "@introspection-sdk/types";
 import { HttpClient } from "../http.js";
+import { Paginator, cursorPaginate } from "../pagination.js";
 import { parseSse } from "../streaming.js";
 
 export interface StartParams extends TaskCreateParams {
@@ -85,21 +86,21 @@ export class TasksApi {
   }
 
   /**
-   * Iterate tasks matching `params`. Pages are fetched lazily as the
-   * iterator is consumed (`limit` sets the page size, `next` the
-   * starting cursor); stop early to stop fetching.
+   * List tasks matching `params`. `await` the result for the first page,
+   * or `for await` it to stream every task across pages (fetched lazily —
+   * `limit` sets the page size, `next` the starting cursor; stop early to
+   * stop fetching).
    */
-  async *list(params?: TaskListParams): AsyncIterable<Task> {
-    let next: string | undefined = params?.next;
-    do {
-      const page = await this.http.request<Paginated<Task>>({
-        method: "GET",
-        path: "/v1/tasks",
-        query: { ...params, next } as Record<string, unknown>,
-      });
-      for (const t of page.records) yield t;
-      next = page.next ?? undefined;
-    } while (next);
+  list(params?: TaskListParams): Paginator<Task> {
+    return cursorPaginate(
+      (next) =>
+        this.http.request<Paginated<Task>>({
+          method: "GET",
+          path: "/v1/tasks",
+          query: { ...params, next } as Record<string, unknown>,
+        }),
+      params?.next,
+    );
   }
 
   create(body: TaskCreateParams): Promise<TaskCreateResponse> {