@blazingagents/sdk 0.2.1 → 0.3.0

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";
@@ -99,19 +99,19 @@ interface ExistingSessionInput {
 }
 type ChatSessionInput = NewSessionInput | ExistingSessionInput;
 interface ChatMessageContentInput extends AttributionInput, CorrelatedRequestInput {
+    abortSignal?: AbortSignal;
     agentId: string;
     message: UIMessage;
     messageId?: string;
     promptId?: never;
-    signal?: AbortSignal;
     variables?: never;
 }
 interface ChatPromptContentInput extends AttributionInput, CorrelatedRequestInput {
+    abortSignal?: AbortSignal;
     agentId: string;
     message?: never;
     messageId?: string;
     promptId: string;
-    signal?: AbortSignal;
     variables?: Record<string, string>;
 }
 export type ChatMessageInput = ChatMessageContentInput & ChatSessionInput;
@@ -127,28 +127,32 @@ 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;
 }
 export interface CompletionPromptInput extends StatelessGenerationInput {
+    abortSignal?: AbortSignal;
     agentId: string;
     prompt: string;
     promptId?: never;
     schema?: never;
-    signal?: AbortSignal;
     variables?: never;
 }
 export interface CompletionPromptIdInput extends StatelessGenerationInput {
+    abortSignal?: AbortSignal;
     agentId: string;
     prompt?: never;
     promptId: string;
     schema?: never;
-    signal?: AbortSignal;
     variables?: Record<string, string>;
 }
 export type CompletionInput = CompletionPromptInput | CompletionPromptIdInput;
@@ -159,19 +163,19 @@ export interface CompletionResult {
     toResponse: () => Response;
 }
 export interface ObjectPromptInput extends StatelessGenerationInput {
+    abortSignal?: AbortSignal;
     agentId: string;
     prompt: string;
     promptId?: never;
     schema: Record<string, unknown>;
-    signal?: AbortSignal;
     variables?: never;
 }
 export interface ObjectPromptIdInput extends StatelessGenerationInput {
+    abortSignal?: AbortSignal;
     agentId: string;
     prompt?: never;
     promptId: string;
     schema: Record<string, unknown>;
-    signal?: AbortSignal;
     variables?: Record<string, string>;
 }
 export type ObjectInput = ObjectPromptInput | ObjectPromptIdInput;
@@ -181,128 +185,224 @@ export interface ObjectResult {
     requestId?: string;
     toResponse: () => Response;
 }
+export interface ResourceRequestOptions {
+    abortSignal?: AbortSignal;
+}
 export interface AgentsResource {
     /** Omitting `workspaceId` attaches a default Workspace with a lazy runtime. */
-    create(body: CreateAgentBody): Promise<Agent>;
+    create(input: CreateAgentBody & ResourceRequestOptions): Promise<Agent>;
     /** Deletes the Agent while preserving its attached Workspace. */
-    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>;
-    list(options?: AgentsListOptions): Promise<AgentsResponse>;
-    listMcpAttachments(agentId: string): Promise<McpAttachmentsResponse>;
-    listVersions(agentId: string, options?: AgentVersionsListOptions): Promise<AgentVersionsResponse>;
-    removeAvatar(agentId: string): Promise<Agent>;
-    /**
-     * Copies an immutable Version's configuration into the Agent through the
-     * ordinary update path, creating a new latest Version without rewriting history.
-     */
-    restoreVersion(agentId: string, version: number): Promise<Agent>;
+    delete(input: {
+        agentId: string;
+        includeArtifacts: boolean;
+    } & ResourceRequestOptions): Promise<void>;
+    disable(input: {
+        agentId: string;
+    } & ResourceRequestOptions): Promise<Agent>;
+    enable(input: {
+        agentId: string;
+    } & ResourceRequestOptions): Promise<Agent>;
+    get(input: {
+        agentId: string;
+    } & ResourceRequestOptions): Promise<Agent>;
+    getVersion(input: {
+        agentId: string;
+        version: number;
+    } & ResourceRequestOptions): Promise<AgentVersion>;
+    list(input?: AgentsListOptions): Promise<AgentsResponse>;
+    listMcpAttachments(input: {
+        agentId: string;
+    } & ResourceRequestOptions): Promise<McpAttachmentsResponse>;
+    listVersions(input: {
+        agentId: string;
+    } & AgentVersionsListOptions): Promise<AgentVersionsResponse>;
+    removeAvatar(input: {
+        agentId: string;
+    } & ResourceRequestOptions): Promise<Agent>;
+    /** Copies an immutable Version into the Agent, creating a new latest Version. */
+    restoreVersion(input: {
+        agentId: string;
+        version: number;
+    } & ResourceRequestOptions): Promise<Agent>;
     /** A concrete `workspaceId` switches the Agent; detachment is unsupported. */
-    update(agentId: string, body: UpdateAgentBody): Promise<Agent>;
-    updateMcpAttachment(agentId: string, mcpConnectionId: string, body: UpdateMcpAttachmentBody): Promise<McpAttachmentResponse>;
-    uploadAvatar(agentId: string, file: File): Promise<Agent>;
+    update(input: UpdateAgentBody & {
+        agentId: string;
+    } & ResourceRequestOptions): Promise<Agent>;
+    updateMcpAttachment(input: UpdateMcpAttachmentBody & {
+        agentId: string;
+        mcpConnectionId: string;
+    } & ResourceRequestOptions): Promise<McpAttachmentResponse>;
+    uploadAvatar(input: {
+        agentId: string;
+        file: File;
+    } & ResourceRequestOptions): Promise<Agent>;
 }
 export interface AgentClient {
     readonly skills: AgentSkillsResource;
 }
-export interface AgentsListOptions {
+export interface AgentsListOptions extends ResourceRequestOptions {
     userId?: string;
     workspaceId?: string;
 }
 export interface WorkspacesResource {
-    create(body?: CreateWorkspaceBody): Promise<Workspace>;
+    create(input?: CreateWorkspaceBody & ResourceRequestOptions): Promise<Workspace>;
     delete(input: {
         workspaceId: string;
-    }): Promise<"completed" | "pending">;
+    } & ResourceRequestOptions): Promise<"completed" | "pending">;
     get(input: {
         workspaceId: string;
-    }): Promise<Workspace>;
-    list(options?: WorkspacesListOptions): Promise<WorkspacesListResponse>;
+    } & ResourceRequestOptions): Promise<Workspace>;
+    list(input?: WorkspacesListOptions): Promise<WorkspacesListResponse>;
     update(input: UpdateWorkspaceBody & {
         workspaceId: string;
-    }): Promise<Workspace>;
+    } & ResourceRequestOptions): Promise<Workspace>;
 }
-export interface WorkspacesListOptions {
+export interface WorkspacesListOptions extends ResourceRequestOptions {
     cursor?: string;
     limit?: number;
     userId?: string;
 }
-export interface AgentVersionsListOptions {
+export interface AgentVersionsListOptions extends ResourceRequestOptions {
     cursor?: string;
     limit?: number;
 }
-export interface ArtifactsListOptions {
+export interface ArtifactsListOptions extends ResourceRequestOptions {
     agentId?: string;
     cursor?: string;
     sessionId?: string;
 }
 export interface ArtifactsResource {
-    createDownloadUrl(artifactId: string): Promise<ArtifactDownloadUrlResponse>;
-    delete(artifactId: string): Promise<void>;
-    get(artifactId: string): Promise<ArtifactListItem>;
-    list(options?: ArtifactsListOptions): Promise<ArtifactsListResponse>;
+    createDownloadUrl(input: {
+        artifactId: string;
+    } & ResourceRequestOptions): Promise<ArtifactDownloadUrlResponse>;
+    delete(input: {
+        artifactId: string;
+    } & ResourceRequestOptions): Promise<void>;
+    get(input: {
+        artifactId: string;
+    } & ResourceRequestOptions): Promise<ArtifactListItem>;
+    list(input?: 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>;
-    list(agentId: string, options?: MemoriesListOptions): Promise<MemoriesListResponse>;
-    update(agentId: string, memoryId: string, body: UpdateMemoryBody): Promise<MemoryResponse>;
-}
-export interface MemoriesListOptions {
+    create(input: CreateMemoryBody & {
+        agentId: string;
+    } & ResourceRequestOptions): Promise<MemoryResponse>;
+    delete(input: {
+        agentId: string;
+        memoryId: string;
+    } & ResourceRequestOptions): Promise<void>;
+    get(input: {
+        agentId: string;
+        memoryId: string;
+    } & ResourceRequestOptions): Promise<MemoryResponse>;
+    list(input: {
+        agentId: string;
+    } & MemoriesListOptions): Promise<MemoriesListResponse>;
+    update(input: UpdateMemoryBody & {
+        agentId: string;
+        memoryId: string;
+    } & ResourceRequestOptions): Promise<MemoryResponse>;
+}
+export interface MemoriesListOptions extends ResourceRequestOptions {
     cursor?: string;
     limit?: number;
     search?: string;
     userId?: string;
 }
 export interface PromptsResource {
-    create(body: CreatePromptBody): Promise<PromptResponse>;
-    delete(promptId: string): Promise<void>;
-    get(promptId: string): Promise<PromptResponse>;
-    list(userId?: string): Promise<PromptsResponse>;
-    update(promptId: string, body: UpdatePromptBody): Promise<PromptResponse>;
+    create(input: CreatePromptBody & ResourceRequestOptions): Promise<PromptResponse>;
+    delete(input: {
+        promptId: string;
+    } & ResourceRequestOptions): Promise<void>;
+    get(input: {
+        promptId: string;
+    } & ResourceRequestOptions): Promise<PromptResponse>;
+    list(input?: {
+        userId?: string;
+    } & ResourceRequestOptions): Promise<PromptsResponse>;
+    update(input: UpdatePromptBody & {
+        promptId: string;
+    } & ResourceRequestOptions): 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>;
-    update(id: string, body: UpdateProviderBody): Promise<ProviderResponse>;
+    create(input: CreateProviderBody & ResourceRequestOptions): Promise<ProviderResponse>;
+    delete(input: DeleteProviderOptions & {
+        providerId: string;
+    } & ResourceRequestOptions): Promise<void>;
+    get(input: {
+        providerId: string;
+    } & ResourceRequestOptions): Promise<ProviderResponse>;
+    getThinkingLevels(input: {
+        providerId: string;
+        model: string;
+    } & ResourceRequestOptions): Promise<ThinkingLevelsResponse>;
+    list(input?: ResourceRequestOptions): Promise<ProvidersResponse>;
+    listModels(input: {
+        providerId: string;
+    } & ResourceRequestOptions): Promise<ProviderModelsResponse>;
+    update(input: UpdateProviderBody & {
+        providerId: string;
+    } & ResourceRequestOptions): 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>;
-    reconnect(id: string, body: ReconnectMcpConnectionBody): Promise<McpConnectionReconnectResult>;
-    test(id: string): Promise<McpConnectionTestResponse>;
-    update(id: string, body: UpdateMcpConnectionBody): Promise<McpConnectionResponse>;
-}
-export interface SessionsListOptions {
+    connect(input: {
+        mcpConnectionId: string;
+    } & ResourceRequestOptions): Promise<McpConnectionOauthConnectResponse>;
+    create(input: CreateMcpConnectionBody & ResourceRequestOptions): Promise<McpConnectionResponse>;
+    delete(input: {
+        mcpConnectionId: string;
+    } & ResourceRequestOptions): Promise<void>;
+    get(input: {
+        mcpConnectionId: string;
+    } & ResourceRequestOptions): Promise<McpConnectionResponse>;
+    list(input?: ResourceRequestOptions): Promise<McpConnectionsResponse>;
+    reconnect(input: ReconnectMcpConnectionBody & {
+        mcpConnectionId: string;
+    } & ResourceRequestOptions): Promise<McpConnectionReconnectResult>;
+    test(input: {
+        mcpConnectionId: string;
+    } & ResourceRequestOptions): Promise<McpConnectionTestResponse>;
+    update(input: UpdateMcpConnectionBody & {
+        mcpConnectionId: string;
+    } & ResourceRequestOptions): Promise<McpConnectionResponse>;
+}
+export interface SessionsListOptions extends ResourceRequestOptions {
     cursor?: string;
     limit?: number;
     userId?: string;
 }
-export interface SessionMessagesOptions {
+export interface SessionMessagesOptions extends ResourceRequestOptions {
     after?: string;
     cursor?: string;
     limit?: number;
 }
 export interface SessionsResource {
-    decideToolApproval(agentId: string, sessionId: string, approvalId: string, decision: DecideToolApprovalBody, options?: {
-        signal?: AbortSignal;
-    }): Promise<ToolApprovalDecisionResponse>;
-    delete(agentId: string, sessionId: string, deleteArtifacts: boolean): Promise<void>;
-    joinToolApprovalContinuation(agentId: string, sessionId: string, continuationId: string, options?: {
-        signal?: AbortSignal;
-    }): 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>;
+    decideToolApproval(input: DecideToolApprovalBody & {
+        agentId: string;
+        sessionId: string;
+        approvalId: string;
+    } & ResourceRequestOptions): Promise<ToolApprovalDecisionResponse>;
+    delete(input: {
+        agentId: string;
+        sessionId: string;
+        deleteArtifacts: boolean;
+    } & ResourceRequestOptions): Promise<void>;
+    joinToolApprovalContinuation(input: {
+        agentId: string;
+        sessionId: string;
+        continuationId: string;
+    } & ResourceRequestOptions): Promise<TerminalStreamResult>;
+    list(input: {
+        agentId: string;
+    } & SessionsListOptions): Promise<SessionsListResponse>;
+    messages(input: {
+        agentId: string;
+        sessionId: string;
+    } & SessionMessagesOptions): Promise<SessionMessagesResponse>;
+    toolApprovals(input: {
+        agentId: string;
+        sessionId: string;
+    } & ResourceRequestOptions): Promise<ToolApprovalsResponse>;
 }
 export interface AgentSkillsResource {
     copy(input: {
@@ -310,72 +410,93 @@ export interface AgentSkillsResource {
         to: {
             agentIds: string[];
         };
-    }): Promise<SkillCopyResults>;
-    create(input: CreateSkillBody): Promise<SkillDetail>;
+    } & ResourceRequestOptions): Promise<SkillCopyResults>;
+    create(input: CreateSkillBody & ResourceRequestOptions): Promise<SkillDetail>;
     delete(input: {
         skillId: string;
-    }): Promise<void>;
+    } & ResourceRequestOptions): Promise<void>;
     deleteFile(input: {
         path: string;
         skillId: string;
-    }): Promise<SkillDetail>;
+    } & ResourceRequestOptions): Promise<SkillDetail>;
     get(input: {
         skillId: string;
-    }): Promise<SkillDetail>;
+    } & ResourceRequestOptions): Promise<SkillDetail>;
     getFile(input: {
         path: string;
         skillId: string;
-    }): Promise<Uint8Array>;
-    list(options?: SkillsListOptions): Promise<SkillsListResponse>;
+    } & ResourceRequestOptions): Promise<Uint8Array>;
+    list(input?: SkillsListOptions): Promise<SkillsListResponse>;
     putFile(input: {
         content: Blob | string | Uint8Array;
         path: string;
         skillId: string;
-    }): Promise<SkillDetail>;
+    } & ResourceRequestOptions): Promise<SkillDetail>;
     upload(input: {
         source: {
             file: Blob | Uint8Array;
             type: SkillArchiveType;
         };
-    }): Promise<SkillDetail>;
+    } & ResourceRequestOptions): Promise<SkillDetail>;
 }
-export interface SkillsListOptions {
+export interface SkillsListOptions extends ResourceRequestOptions {
     cursor?: string;
     limit?: number;
 }
-export interface TasksListOptions {
+export interface TasksListOptions extends ResourceRequestOptions {
     agentId?: string;
     cursor?: string;
     limit?: number;
     userId?: string;
 }
-export interface TaskRunsListOptions {
+export interface TaskRunsListOptions extends ResourceRequestOptions {
     cursor?: string;
     limit?: number;
 }
-export interface TaskRunMessagesOptions {
+export interface TaskRunMessagesOptions extends ResourceRequestOptions {
     after?: string;
     cursor?: string;
     limit?: number;
 }
 export interface TasksResource {
-    cancelRun(taskId: string, runId: string): Promise<void>;
-    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>;
-    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>;
+    cancelRun(input: {
+        taskId: string;
+        runId: string;
+    } & ResourceRequestOptions): Promise<void>;
+    create(input: CreateTaskBody & ResourceRequestOptions): Promise<CreateTaskResponse>;
+    createRun(input: CreateTaskRunBody & {
+        taskId: string;
+    } & ResourceRequestOptions): Promise<CreateTaskRunResponse>;
+    delete(input: {
+        taskId: string;
+    } & ResourceRequestOptions): Promise<void>;
+    get(input: {
+        taskId: string;
+    } & ResourceRequestOptions): Promise<TaskResponse>;
+    getRun(input: {
+        taskId: string;
+        runId: string;
+    } & ResourceRequestOptions): Promise<TaskRunResponse>;
+    list(input?: TasksListOptions): Promise<TasksListResponse>;
+    listRuns(input: {
+        taskId: string;
+    } & TaskRunsListOptions): Promise<TaskRunsListResponse>;
+    runMessages(input: {
+        taskId: string;
+        runId: string;
+    } & TaskRunMessagesOptions): Promise<TaskRunMessagesResponse>;
+    update(input: UpdateTaskBody & {
+        taskId: string;
+    } & ResourceRequestOptions): Promise<TaskResponse>;
 }
 export interface TenantResource {
-    get(): Promise<TenantSettingsResponse>;
-    patch(body: UpdateTenantSettingsBody): Promise<TenantSettingsResponse>;
+    get(input?: ResourceRequestOptions): Promise<TenantSettingsResponse>;
+    patch(input: UpdateTenantSettingsBody & ResourceRequestOptions): Promise<TenantSettingsResponse>;
 }
 export interface UsageResource {
-    get(query?: Partial<UsageQuery>): Promise<UsageResponse>;
-    getForAgent(agentId: string, query?: Partial<UsageQuery>): Promise<UsageResponse>;
+    get(input?: Partial<UsageQuery> & ResourceRequestOptions): Promise<UsageResponse>;
+    getForAgent(input: Partial<UsageQuery> & {
+        agentId: string;
+    } & ResourceRequestOptions): Promise<UsageResponse>;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blazingagents/sdk",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "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": {