@blazingagents/sdk 0.2.0 → 0.2.2

package/dist/types.d.ts

@@ -6,7 +6,7 @@ import type { BlazingAgentsChatMessageMetadata } from "./contracts/entities/chat
 import type { CreateMcpConnectionBody, McpAttachmentResponse, McpAttachmentsResponse, McpConnectionOauthConnectResponse, McpConnectionReconnectResult, McpConnectionResponse, McpConnectionsResponse, McpConnectionTestResponse, ReconnectMcpConnectionBody, UpdateMcpAttachmentBody, UpdateMcpConnectionBody } from "./contracts/entities/mcp-connections.ts";
 import type { CreateMemoryBody, MemoriesListResponse, MemoryResponse, UpdateMemoryBody } from "./contracts/entities/memories.ts";
 import type { CreatePromptBody, PromptResponse, PromptsResponse, UpdatePromptBody } from "./contracts/entities/prompts.ts";
-import type { CreateProviderBody, DeleteProviderOptions, ProviderModelsResponse, ProviderResponse, ProvidersResponse, UpdateProviderBody } from "./contracts/entities/providers.ts";
+import type { CreateProviderBody, DeleteProviderOptions, ProviderModelsResponse, ProviderResponse, ProvidersResponse, ThinkingLevelsResponse, UpdateProviderBody } from "./contracts/entities/providers.ts";
 import type { DecideToolApprovalBody, SessionMessagesResponse, SessionsListResponse, ToolApprovalDecisionResponse, ToolApprovalsResponse } from "./contracts/entities/sessions.ts";
 import type { CreateSkillBody, SkillArchiveType, SkillCopyResults, SkillDetail, SkillsListResponse } from "./contracts/entities/skills.ts";
 import type { CreateTaskBody, CreateTaskResponse, CreateTaskRunBody, CreateTaskRunResponse, TaskResponse, TaskRunMessagesResponse, TaskRunResponse, TaskRunsListResponse, TasksListResponse, UpdateTaskBody } from "./contracts/entities/tasks.ts";
@@ -127,10 +127,14 @@ export interface ChatResult {
      */
     sessionId: Promise<string>;
     toResponse: () => Response;
+    /** Claims the SSE bytes once, without constructing a Response. Shares ownership with toResponse(). */
+    toStream: () => ReadableStream<Uint8Array>;
 }
 export interface TerminalStreamResult {
     requestId?: string;
     toResponse: () => Response;
+    /** Claims the SSE bytes once, without constructing a Response. Shares ownership with toResponse(). */
+    toStream: () => ReadableStream<Uint8Array>;
 }
 interface StatelessGenerationInput extends AttributionInput, CorrelatedRequestInput {
     version?: number;
@@ -181,6 +185,7 @@ export interface ObjectResult {
     requestId?: string;
     toResponse: () => Response;
 }
+export type ResourceReadOptions = Pick<RequestOptions, "signal">;
 export interface AgentsResource {
     /** Omitting `workspaceId` attaches a default Workspace with a lazy runtime. */
     create(body: CreateAgentBody): Promise<Agent>;
@@ -188,10 +193,10 @@ export interface AgentsResource {
     delete(agentId: string, includeArtifacts: boolean): Promise<void>;
     disable(agentId: string): Promise<Agent>;
     enable(agentId: string): Promise<Agent>;
-    get(agentId: string): Promise<Agent>;
-    getVersion(agentId: string, version: number): Promise<AgentVersion>;
+    get(agentId: string, options?: ResourceReadOptions): Promise<Agent>;
+    getVersion(agentId: string, version: number, options?: ResourceReadOptions): Promise<AgentVersion>;
     list(options?: AgentsListOptions): Promise<AgentsResponse>;
-    listMcpAttachments(agentId: string): Promise<McpAttachmentsResponse>;
+    listMcpAttachments(agentId: string, options?: ResourceReadOptions): Promise<McpAttachmentsResponse>;
     listVersions(agentId: string, options?: AgentVersionsListOptions): Promise<AgentVersionsResponse>;
     removeAvatar(agentId: string): Promise<Agent>;
     /**
@@ -207,7 +212,7 @@ export interface AgentsResource {
 export interface AgentClient {
     readonly skills: AgentSkillsResource;
 }
-export interface AgentsListOptions {
+export interface AgentsListOptions extends ResourceReadOptions {
     userId?: string;
     workspaceId?: string;
 }
@@ -218,22 +223,22 @@ export interface WorkspacesResource {
     }): Promise<"completed" | "pending">;
     get(input: {
         workspaceId: string;
-    }): Promise<Workspace>;
+    }, options?: ResourceReadOptions): Promise<Workspace>;
     list(options?: WorkspacesListOptions): Promise<WorkspacesListResponse>;
     update(input: UpdateWorkspaceBody & {
         workspaceId: string;
     }): Promise<Workspace>;
 }
-export interface WorkspacesListOptions {
+export interface WorkspacesListOptions extends ResourceReadOptions {
     cursor?: string;
     limit?: number;
     userId?: string;
 }
-export interface AgentVersionsListOptions {
+export interface AgentVersionsListOptions extends ResourceReadOptions {
     cursor?: string;
     limit?: number;
 }
-export interface ArtifactsListOptions {
+export interface ArtifactsListOptions extends ResourceReadOptions {
     agentId?: string;
     cursor?: string;
     sessionId?: string;
@@ -241,17 +246,17 @@ export interface ArtifactsListOptions {
 export interface ArtifactsResource {
     createDownloadUrl(artifactId: string): Promise<ArtifactDownloadUrlResponse>;
     delete(artifactId: string): Promise<void>;
-    get(artifactId: string): Promise<ArtifactListItem>;
+    get(artifactId: string, options?: ResourceReadOptions): Promise<ArtifactListItem>;
     list(options?: ArtifactsListOptions): Promise<ArtifactsListResponse>;
 }
 export interface MemoriesResource {
     create(agentId: string, body: CreateMemoryBody): Promise<MemoryResponse>;
     delete(agentId: string, memoryId: string): Promise<void>;
-    get(agentId: string, memoryId: string): Promise<MemoryResponse>;
+    get(agentId: string, memoryId: string, options?: ResourceReadOptions): Promise<MemoryResponse>;
     list(agentId: string, options?: MemoriesListOptions): Promise<MemoriesListResponse>;
     update(agentId: string, memoryId: string, body: UpdateMemoryBody): Promise<MemoryResponse>;
 }
-export interface MemoriesListOptions {
+export interface MemoriesListOptions extends ResourceReadOptions {
     cursor?: string;
     limit?: number;
     search?: string;
@@ -260,34 +265,35 @@ export interface MemoriesListOptions {
 export interface PromptsResource {
     create(body: CreatePromptBody): Promise<PromptResponse>;
     delete(promptId: string): Promise<void>;
-    get(promptId: string): Promise<PromptResponse>;
-    list(userId?: string): Promise<PromptsResponse>;
+    get(promptId: string, options?: ResourceReadOptions): Promise<PromptResponse>;
+    list(userId?: string, options?: ResourceReadOptions): Promise<PromptsResponse>;
     update(promptId: string, body: UpdatePromptBody): Promise<PromptResponse>;
 }
 export interface ProvidersResource {
     create(body: CreateProviderBody): Promise<ProviderResponse>;
     delete(id: string, options?: DeleteProviderOptions): Promise<void>;
-    get(id: string): Promise<ProviderResponse>;
-    list(): Promise<ProvidersResponse>;
-    listModels(id: string): Promise<ProviderModelsResponse>;
+    get(id: string, options?: ResourceReadOptions): Promise<ProviderResponse>;
+    getThinkingLevels(id: string, model: string, options?: ResourceReadOptions): Promise<ThinkingLevelsResponse>;
+    list(options?: ResourceReadOptions): Promise<ProvidersResponse>;
+    listModels(id: string, options?: ResourceReadOptions): Promise<ProviderModelsResponse>;
     update(id: string, body: UpdateProviderBody): Promise<ProviderResponse>;
 }
 export interface McpConnectionsResource {
     connect(id: string): Promise<McpConnectionOauthConnectResponse>;
     create(body: CreateMcpConnectionBody): Promise<McpConnectionResponse>;
     delete(id: string): Promise<void>;
-    get(id: string): Promise<McpConnectionResponse>;
-    list(): Promise<McpConnectionsResponse>;
+    get(id: string, options?: ResourceReadOptions): Promise<McpConnectionResponse>;
+    list(options?: ResourceReadOptions): Promise<McpConnectionsResponse>;
     reconnect(id: string, body: ReconnectMcpConnectionBody): Promise<McpConnectionReconnectResult>;
     test(id: string): Promise<McpConnectionTestResponse>;
     update(id: string, body: UpdateMcpConnectionBody): Promise<McpConnectionResponse>;
 }
-export interface SessionsListOptions {
+export interface SessionsListOptions extends ResourceReadOptions {
     cursor?: string;
     limit?: number;
     userId?: string;
 }
-export interface SessionMessagesOptions {
+export interface SessionMessagesOptions extends ResourceReadOptions {
     after?: string;
     cursor?: string;
     limit?: number;
@@ -302,7 +308,7 @@ export interface SessionsResource {
     }): Promise<TerminalStreamResult>;
     list(agentId: string, options?: SessionsListOptions): Promise<SessionsListResponse>;
     messages(agentId: string, sessionId: string, options?: SessionMessagesOptions): Promise<SessionMessagesResponse>;
-    toolApprovals(agentId: string, sessionId: string): Promise<ToolApprovalsResponse>;
+    toolApprovals(agentId: string, sessionId: string, options?: ResourceReadOptions): Promise<ToolApprovalsResponse>;
 }
 export interface AgentSkillsResource {
     copy(input: {
@@ -321,11 +327,11 @@ export interface AgentSkillsResource {
     }): Promise<SkillDetail>;
     get(input: {
         skillId: string;
-    }): Promise<SkillDetail>;
+    }, options?: ResourceReadOptions): Promise<SkillDetail>;
     getFile(input: {
         path: string;
         skillId: string;
-    }): Promise<Uint8Array>;
+    }, options?: ResourceReadOptions): Promise<Uint8Array>;
     list(options?: SkillsListOptions): Promise<SkillsListResponse>;
     putFile(input: {
         content: Blob | string | Uint8Array;
@@ -339,21 +345,21 @@ export interface AgentSkillsResource {
         };
     }): Promise<SkillDetail>;
 }
-export interface SkillsListOptions {
+export interface SkillsListOptions extends ResourceReadOptions {
     cursor?: string;
     limit?: number;
 }
-export interface TasksListOptions {
+export interface TasksListOptions extends ResourceReadOptions {
     agentId?: string;
     cursor?: string;
     limit?: number;
     userId?: string;
 }
-export interface TaskRunsListOptions {
+export interface TaskRunsListOptions extends ResourceReadOptions {
     cursor?: string;
     limit?: number;
 }
-export interface TaskRunMessagesOptions {
+export interface TaskRunMessagesOptions extends ResourceReadOptions {
     after?: string;
     cursor?: string;
     limit?: number;
@@ -363,19 +369,19 @@ export interface TasksResource {
     create(body: CreateTaskBody): Promise<CreateTaskResponse>;
     createRun(taskId: string, body?: CreateTaskRunBody): Promise<CreateTaskRunResponse>;
     delete(taskId: string): Promise<void>;
-    get(taskId: string): Promise<TaskResponse>;
-    getRun(taskId: string, runId: string): Promise<TaskRunResponse>;
+    get(taskId: string, options?: ResourceReadOptions): Promise<TaskResponse>;
+    getRun(taskId: string, runId: string, options?: ResourceReadOptions): Promise<TaskRunResponse>;
     list(options?: TasksListOptions): Promise<TasksListResponse>;
     listRuns(taskId: string, options?: TaskRunsListOptions): Promise<TaskRunsListResponse>;
     runMessages(taskId: string, runId: string, options?: TaskRunMessagesOptions): Promise<TaskRunMessagesResponse>;
     update(taskId: string, body: UpdateTaskBody): Promise<TaskResponse>;
 }
 export interface TenantResource {
-    get(): Promise<TenantSettingsResponse>;
+    get(options?: ResourceReadOptions): Promise<TenantSettingsResponse>;
     patch(body: UpdateTenantSettingsBody): Promise<TenantSettingsResponse>;
 }
 export interface UsageResource {
-    get(query?: Partial<UsageQuery>): Promise<UsageResponse>;
-    getForAgent(agentId: string, query?: Partial<UsageQuery>): Promise<UsageResponse>;
+    get(query?: Partial<UsageQuery> & ResourceReadOptions): Promise<UsageResponse>;
+    getForAgent(agentId: string, query?: Partial<UsageQuery> & ResourceReadOptions): Promise<UsageResponse>;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blazingagents/sdk",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "TypeScript SDK for the Blazing Agents API",
   "homepage": "https://docs.blazingagents.com",
   "bugs": {
@@ -35,7 +35,7 @@
     "lint": "ultracite check",
     "prepack": "npm run build",
     "test": "vitest run --coverage",
-    "test:consumer": "npm run build && vitest run -c vitest.consumer.config.mts",
+    "test:consumer": "npm run build && tsc -p tsconfig.consumer.json && vitest run -c vitest.consumer.config.mts",
     "typecheck": "tsc --noEmit -p tsconfig.json && tsc --noEmit -p tsconfig.tests.json"
   },
   "dependencies": {