@to11ai/sdk 3.0.0-rc.7 → 3.0.0-rc.9

package/src/generated/zod.gen.ts

@@ -562,6 +562,13 @@ export const zApiKeysGetApiKeyOpenIdConfigResponse = z.object({
     subject_types_supported: z.array(z.string())
 });
 
+/**
+ * Success
+ */
+export const zDiscoveryGetDiscoveryResponse = z.object({
+    dashboardUrl: z.string().nullish()
+});
+
 /**
  * Success
  */
@@ -996,14 +1003,8 @@ export const zCostRateAdminResyncProjectScopeMapResponse = z.object({
 
 export const zApiKeysListApiKeysQuery = z.object({
     orgId: z.string().nullish(),
-    workspaceIds: z.union([
-        z.array(z.string()),
-        z.string()
-    ]).nullish(),
-    projectIds: z.union([
-        z.array(z.string()),
-        z.string()
-    ]).nullish(),
+    workspaceIds: z.array(z.string()).nullish(),
+    projectIds: z.array(z.string()).nullish(),
     scope: z.enum([
         'platform',
         'org',
@@ -1020,7 +1021,7 @@ export const zApiKeysListApiKeysQuery = z.object({
     expiry: z.string().nullish(),
     q: z.string().nullish(),
     cursor: z.string().nullish(),
-    limit: z.string(),
+    limit: z.int().nullish(),
     includeRevoked: z.enum(['true', 'false']),
     includeCounts: z.enum(['true', 'false'])
 });
@@ -1037,7 +1038,7 @@ export const zApiKeysListApiKeysResponse = z.object({
             revoked: z.number(),
             rotating: z.number()
         }),
-        keys: z.array(z.object({
+        items: z.array(z.object({
             calls7d: z.number(),
             createdAt: z.string(),
             createdBy: z.object({
@@ -1083,7 +1084,10 @@ export const zApiKeysListApiKeysResponse = z.object({
             ]),
             workspaceId: z.string().nullable()
         })),
-        nextCursor: z.string().nullable(),
+        pagination: z.object({
+            limit: z.int().gte(1).lte(100),
+            nextCursor: z.string().nullable()
+        }),
         viewerScopeAccess: z.enum([
             'none',
             'scoped',
@@ -2403,8 +2407,8 @@ export const zOrgAuditListOrgAuditEventsQuery = z.object({
     workspace_id: z.string().nullish(),
     since: z.string().nullish(),
     until: z.string().nullish(),
-    limit: z.string().nullish(),
-    cursor: z.string().nullish()
+    cursor: z.string().nullish(),
+    limit: z.int().nullish()
 });
 
 /**
@@ -2440,6 +2444,7 @@ export const zOrgAuditListOrgAuditEventsResponse = z.object({
             workspaceId: z.string().nullable()
         })),
         pagination: z.object({
+            limit: z.int().gte(1).lte(100),
             nextCursor: z.string().nullable()
         })
     }).nullable(),
@@ -3443,17 +3448,10 @@ export const zProjectsListProjectsByOrgPath = z.object({
 });
 
 export const zProjectsListProjectsByOrgQuery = z.object({
-    page: z.int().nullish(),
+    cursor: z.string().nullish(),
     limit: z.int().nullish(),
     search: z.string().nullish(),
-    sortDir: z.enum(['asc', 'desc']).nullish(),
     status: z.string().nullish(),
-    sortBy: z.enum([
-        'createdAt',
-        'updatedAt',
-        'name',
-        'slug'
-    ]).nullish(),
     workspaceSlug: z.string().nullish(),
     slug: z.string().nullish()
 });
@@ -3463,27 +3461,33 @@ export const zProjectsListProjectsByOrgQuery = z.object({
  */
 export const zProjectsListProjectsByOrgResponse = z.object({
     code: z.number(),
-    data: z.array(z.object({
-        createdAt: z.iso.datetime(),
-        id: z.string(),
-        name: z.string().min(1).max(120),
-        organizationId: z.string(),
-        slug: z.string().min(1).max(120),
-        status: z.enum([
-            'active',
-            'archived',
-            'deleted'
-        ]),
-        updatedAt: z.iso.datetime(),
-        workspaceId: z.string(),
-        workspaceName: z.string().min(1).max(120),
-        workspaceSlug: z.string().min(1).max(120),
-        workspaceStatus: z.enum([
-            'active',
-            'archived',
-            'deleted'
-        ])
-    })).nullable(),
+    data: z.object({
+        items: z.array(z.object({
+            createdAt: z.iso.datetime(),
+            id: z.string(),
+            name: z.string().min(1).max(120),
+            organizationId: z.string(),
+            slug: z.string().min(1).max(120),
+            status: z.enum([
+                'active',
+                'archived',
+                'deleted'
+            ]),
+            updatedAt: z.iso.datetime(),
+            workspaceId: z.string(),
+            workspaceName: z.string().min(1).max(120),
+            workspaceSlug: z.string().min(1).max(120),
+            workspaceStatus: z.enum([
+                'active',
+                'archived',
+                'deleted'
+            ])
+        })),
+        pagination: z.object({
+            limit: z.int().gte(1).lte(100),
+            nextCursor: z.string().nullable()
+        })
+    }).nullable(),
     error: z.object({
         code: z.string(),
         details: z.unknown().nullish(),
@@ -11956,24 +11960,15 @@ export const zTracesListTracesQuery = z.object({
     ]).nullish(),
     provider: z.union([
         z.string(),
-        z.union([
-            z.array(z.string()),
-            z.string()
-        ])
+        z.array(z.string())
     ]).nullish(),
     model: z.union([
         z.string(),
-        z.union([
-            z.array(z.string()),
-            z.string()
-        ])
+        z.array(z.string())
     ]).nullish(),
     promptRef: z.union([
         z.string(),
-        z.union([
-            z.array(z.string()),
-            z.string()
-        ])
+        z.array(z.string())
     ]).nullish(),
     sessionId: z.string().min(1).max(256).nullish(),
     minTokens: z.string().nullish(),
@@ -12171,24 +12166,15 @@ export const zTracesListTracePromptFacetsQuery = z.object({
     ]).nullish(),
     provider: z.union([
         z.string(),
-        z.union([
-            z.array(z.string()),
-            z.string()
-        ])
+        z.array(z.string())
     ]).nullish(),
     model: z.union([
         z.string(),
-        z.union([
-            z.array(z.string()),
-            z.string()
-        ])
+        z.array(z.string())
     ]).nullish(),
     promptRef: z.union([
         z.string(),
-        z.union([
-            z.array(z.string()),
-            z.string()
-        ])
+        z.array(z.string())
     ]).nullish(),
     sessionId: z.string().min(1).max(256).nullish(),
     minTokens: z.string().nullish(),

package/src/pagination.ts

@@ -0,0 +1,64 @@
+import { To11aiError } from "./errors";
+
+/**
+ * Keyset paging, as every cursor list in the API answers it. `nextCursor` is
+ * the opaque cursor of the next page and `null` on the last one; `limit` is
+ * the page size the server applied (its default when the call passed none,
+ * clamped to its max).
+ */
+export interface CursorPaginationInfo {
+	nextCursor: string | null;
+	limit: number;
+}
+
+/** One page of a cursor list: `{ items, pagination: { nextCursor, limit } }`. */
+export interface CursorPaginatedResult<T> {
+	items: T[];
+	pagination: CursorPaginationInfo;
+}
+
+/**
+ * Fetches one page. `cursor` is `undefined` for the first page and the
+ * previous page's `pagination.nextCursor` after that.
+ */
+export type FetchCursorPage<T> = (
+	cursor: string | undefined,
+) => Promise<CursorPaginatedResult<T>>;
+
+/**
+ * Walks a cursor list page by page, yielding each page as the server returned
+ * it. Stops after the page whose `nextCursor` is `null` or empty. Throws a
+ * `To11aiError` when the server hands back a cursor it already returned, so a
+ * misbehaving endpoint cannot loop the caller forever.
+ */
+export async function* iterateCursorPages<T>(
+	fetchPage: FetchCursorPage<T>,
+): AsyncGenerator<CursorPaginatedResult<T>, void, undefined> {
+	const seen = new Set<string>();
+	let cursor: string | undefined;
+	for (;;) {
+		const page = await fetchPage(cursor);
+		yield page;
+		const next = page.pagination.nextCursor;
+		if (next === null || next === undefined || next === "") return;
+		if (seen.has(next)) {
+			throw new To11aiError(
+				`Cursor pagination returned a cursor it already returned ("${next}"); stopping to avoid an endless loop.`,
+			);
+		}
+		seen.add(next);
+		cursor = next;
+	}
+}
+
+/**
+ * Walks a cursor list and yields its items one by one, across every page.
+ * Same stop rules as `iterateCursorPages`.
+ */
+export async function* iterateCursorItems<T>(
+	fetchPage: FetchCursorPage<T>,
+): AsyncGenerator<T, void, undefined> {
+	for await (const page of iterateCursorPages(fetchPage)) {
+		yield* page.items;
+	}
+}

package/src/prompts/resource.ts

@@ -1,5 +1,6 @@
 import { To11aiApiError, To11aiNetworkError } from "../errors";
 import { zResolvedPrompt } from "../generated/zod.gen";
+import { iterateCursorItems } from "../pagination";
 import type { ApiEnvelope, Transport } from "../transport";
 import type {
 	AnthropicRenderedPrompt,
@@ -18,6 +19,7 @@ import type {
 	GetPromptResult,
 	GetPromptVersionInput,
 	GetPromptVersionResult,
+	IterateVersionsInput,
 	ListPromptLabelsInput,
 	ListPromptLabelsResult,
 	ListPromptsInput,
@@ -25,6 +27,7 @@ import type {
 	ListPromptVersionsInput,
 	ListPromptVersionsResult,
 	PaginatedResult,
+	PromptVersionSummary,
 	RenderedChatMessage,
 	RenderedPrompt,
 	RenderFormat,
@@ -53,6 +56,7 @@ export type {
 	GetPromptResult,
 	GetPromptVersionInput,
 	GetPromptVersionResult,
+	IterateVersionsInput,
 	ListPromptLabelsInput,
 	ListPromptLabelsResult,
 	ListPromptsInput,
@@ -374,6 +378,26 @@ export class PromptResource<F extends RenderFormat | undefined = undefined> {
 		return unwrap(envelope);
 	}
 
+	/**
+	 * Every version of a prompt, newest first, as summaries: walks
+	 * `listVersions()` page by page until `pagination.nextCursor` is `null` and
+	 * yields one `PromptVersionSummary` at a time. `limit` sets the page size of
+	 * each request. Throws a `To11aiError` if the server repeats a cursor.
+	 *
+	 * ```ts
+	 * for await (const version of to11.prompts.iterateVersions({ promptId })) {
+	 *   console.log(version.version);
+	 * }
+	 * ```
+	 */
+	iterateVersions(
+		input: IterateVersionsInput,
+	): AsyncGenerator<PromptVersionSummary, void, undefined> {
+		return iterateCursorItems((cursor) =>
+			this.listVersions({ ...input, cursor }),
+		);
+	}
+
 	// ─── Get Version ──────────────────────────────────────────────────────────
 
 	async getVersion(

package/src/prompts/types.ts

@@ -8,6 +8,7 @@ import type {
 	ResolvedToolCall as GenResolvedToolCall,
 	ResolvedToolDefinition as GenResolvedToolDefinition,
 } from "../generated/types.gen";
+import type { CursorPaginatedResult } from "../pagination";
 
 export interface RowError {
 	path: ReadonlyArray<string | number>;
@@ -88,20 +89,12 @@ export interface PaginatedResult<T> {
 	pagination: PaginationInfo;
 }
 
-/**
- * Keyset paging, as the audit feeds use it. `nextCursor` is the opaque cursor
- * of the next page and `null` on the last one; `limit` is the page size the
- * server applied (its default when the call passed none, clamped to its max).
- */
-export interface CursorPaginationInfo {
-	nextCursor: string | null;
-	limit: number;
-}
-
-export interface CursorPaginatedResult<T> {
-	items: T[];
-	pagination: CursorPaginationInfo;
-}
+// The cursor page shapes are shared by every cursor list; they live in
+// `../pagination` and stay re-exported here for existing imports.
+export type {
+	CursorPaginatedResult,
+	CursorPaginationInfo,
+} from "../pagination";
 
 export interface CreatePromptInput {
 	projectId?: string;
@@ -169,6 +162,12 @@ export interface ListPromptVersionsInput {
 	limit?: number;
 }
 
+/**
+ * Input of `iterateVersions()`: `listVersions()` without `cursor`, which the
+ * iterator manages. `limit` is the page size of each request.
+ */
+export type IterateVersionsInput = Omit<ListPromptVersionsInput, "cursor">;
+
 /**
  * One page of a prompt's versions, newest first, as summaries. Read a
  * version's content with `getVersion()`.