@mastra/client-js 0.0.0-vector-sources-20250516175436 → 0.0.0-vector-extension-schema-20250922130418

package/dist/resources/network-memory-thread.d.ts

@@ -0,0 +1,47 @@
+import type { StorageThreadType } from '@mastra/core/memory';
+import type { GetMemoryThreadMessagesResponse, ClientOptions, UpdateMemoryThreadParams, GetMemoryThreadMessagesParams } from '../types.js';
+import { BaseResource } from './base.js';
+export declare class NetworkMemoryThread extends BaseResource {
+    private threadId;
+    private networkId;
+    constructor(options: ClientOptions, threadId: string, networkId: string);
+    /**
+     * Retrieves the memory thread details
+     * @returns Promise containing thread details including title and metadata
+     */
+    get(): Promise<StorageThreadType>;
+    /**
+     * Updates the memory thread properties
+     * @param params - Update parameters including title and metadata
+     * @returns Promise containing updated thread details
+     */
+    update(params: UpdateMemoryThreadParams): Promise<StorageThreadType>;
+    /**
+     * Deletes the memory thread
+     * @returns Promise containing deletion result
+     */
+    delete(): Promise<{
+        result: string;
+    }>;
+    /**
+     * Retrieves messages associated with the thread
+     * @param params - Optional parameters including limit for number of messages to retrieve
+     * @returns Promise containing thread messages and UI messages
+     */
+    getMessages(params?: GetMemoryThreadMessagesParams): Promise<GetMemoryThreadMessagesResponse>;
+    /**
+     * Deletes one or more messages from the thread
+     * @param messageIds - Can be a single message ID (string), array of message IDs,
+     *                     message object with id property, or array of message objects
+     * @returns Promise containing deletion result
+     */
+    deleteMessages(messageIds: string | string[] | {
+        id: string;
+    } | {
+        id: string;
+    }[]): Promise<{
+        success: boolean;
+        message: string;
+    }>;
+}
+//# sourceMappingURL=network-memory-thread.d.ts.map

package/dist/resources/network-memory-thread.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"network-memory-thread.d.ts","sourceRoot":"","sources":["../../src/resources/network-memory-thread.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,OAAO,KAAK,EACV,+BAA+B,EAC/B,aAAa,EACb,wBAAwB,EACxB,6BAA6B,EAC9B,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,qBAAa,mBAAoB,SAAQ,YAAY;IAGjD,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,SAAS;gBAFjB,OAAO,EAAE,aAAa,EACd,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM;IAK3B;;;OAGG;IACH,GAAG,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAIjC;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAOpE;;;OAGG;IACH,MAAM,IAAI,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAMrC;;;;OAIG;IACH,WAAW,CAAC,MAAM,CAAC,EAAE,6BAA6B,GAAG,OAAO,CAAC,+BAA+B,CAAC;IAQ7F;;;;;OAKG;IACH,cAAc,CACZ,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,GAChE,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CASlD"}

package/dist/resources/observability.d.ts

@@ -0,0 +1,19 @@
+import type { AITraceRecord, AITracesPaginatedArg } from '@mastra/core/storage';
+import type { ClientOptions, GetAITracesResponse } from '../types.js';
+import { BaseResource } from './base.js';
+export declare class Observability extends BaseResource {
+    constructor(options: ClientOptions);
+    /**
+     * Retrieves a specific AI trace by ID
+     * @param traceId - ID of the trace to retrieve
+     * @returns Promise containing the AI trace with all its spans
+     */
+    getTrace(traceId: string): Promise<AITraceRecord>;
+    /**
+     * Retrieves paginated list of AI traces with optional filtering
+     * @param params - Parameters for pagination and filtering
+     * @returns Promise containing paginated traces and pagination info
+     */
+    getTraces(params: AITracesPaginatedArg): Promise<GetAITracesResponse>;
+}
+//# sourceMappingURL=observability.d.ts.map

package/dist/resources/observability.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"observability.d.ts","sourceRoot":"","sources":["../../src/resources/observability.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAChF,OAAO,KAAK,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,qBAAa,aAAc,SAAQ,YAAY;gBACjC,OAAO,EAAE,aAAa;IAIlC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAIjD;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAkCtE"}

package/dist/resources/tool.d.ts

@@ -0,0 +1,24 @@
+import type { RuntimeContext } from '@mastra/core/runtime-context';
+import type { GetToolResponse, ClientOptions } from '../types.js';
+import { BaseResource } from './base.js';
+export declare class Tool extends BaseResource {
+    private toolId;
+    constructor(options: ClientOptions, toolId: string);
+    /**
+     * Retrieves details about the tool
+     * @param runtimeContext - Optional runtime context to pass as query parameter
+     * @returns Promise containing tool details including description and schemas
+     */
+    details(runtimeContext?: RuntimeContext | Record<string, any>): Promise<GetToolResponse>;
+    /**
+     * Executes the tool with the provided parameters
+     * @param params - Parameters required for tool execution
+     * @returns Promise containing the tool execution results
+     */
+    execute(params: {
+        data: any;
+        runId?: string;
+        runtimeContext?: RuntimeContext | Record<string, any>;
+    }): Promise<any>;
+}
+//# sourceMappingURL=tool.d.ts.map

package/dist/resources/tool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tool.d.ts","sourceRoot":"","sources":["../../src/resources/tool.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAG/D,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,qBAAa,IAAK,SAAQ,YAAY;IAGlC,OAAO,CAAC,MAAM;gBADd,OAAO,EAAE,aAAa,EACd,MAAM,EAAE,MAAM;IAKxB;;;;OAIG;IACH,OAAO,CAAC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC;IAIxF;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,GAAG,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;CAiBpH"}

package/dist/resources/vNextNetwork.d.ts

@@ -0,0 +1,43 @@
+import type { RuntimeContext } from '@mastra/core/runtime-context';
+import type { WatchEvent } from '@mastra/core/workflows';
+import type { ClientOptions, GetVNextNetworkResponse, GenerateVNextNetworkResponse, LoopVNextNetworkResponse, GenerateOrStreamVNextNetworkParams, LoopStreamVNextNetworkParams } from '../types.js';
+import { BaseResource } from './base.js';
+export declare class VNextNetwork extends BaseResource {
+    private networkId;
+    constructor(options: ClientOptions, networkId: string);
+    /**
+     * Retrieves details about the network
+     * @param runtimeContext - Optional runtime context to pass as query parameter
+     * @returns Promise containing vNext network details
+     */
+    details(runtimeContext?: RuntimeContext | Record<string, any>): Promise<GetVNextNetworkResponse>;
+    /**
+     * Generates a response from the v-next network
+     * @param params - Generation parameters including message
+     * @returns Promise containing the generated response
+     */
+    generate(params: GenerateOrStreamVNextNetworkParams): Promise<GenerateVNextNetworkResponse>;
+    /**
+     * Generates a response from the v-next network using multiple primitives
+     * @param params - Generation parameters including message
+     * @returns Promise containing the generated response
+     */
+    loop(params: {
+        message: string;
+        runtimeContext?: RuntimeContext | Record<string, any>;
+    }): Promise<LoopVNextNetworkResponse>;
+    private streamProcessor;
+    /**
+     * Streams a response from the v-next network
+     * @param params - Stream parameters including message
+     * @returns Promise containing the results
+     */
+    stream(params: GenerateOrStreamVNextNetworkParams, onRecord: (record: WatchEvent) => void): Promise<void>;
+    /**
+     * Streams a response from the v-next network loop
+     * @param params - Stream parameters including message
+     * @returns Promise containing the results
+     */
+    loopStream(params: LoopStreamVNextNetworkParams, onRecord: (record: WatchEvent) => void): Promise<void>;
+}
+//# sourceMappingURL=vNextNetwork.d.ts.map

package/dist/resources/vNextNetwork.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vNextNetwork.d.ts","sourceRoot":"","sources":["../../src/resources/vNextNetwork.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEzD,OAAO,KAAK,EACV,aAAa,EACb,uBAAuB,EACvB,4BAA4B,EAC5B,wBAAwB,EACxB,kCAAkC,EAClC,4BAA4B,EAC7B,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAItC,qBAAa,YAAa,SAAQ,YAAY;IAG1C,OAAO,CAAC,SAAS;gBADjB,OAAO,EAAE,aAAa,EACd,SAAS,EAAE,MAAM;IAK3B;;;;OAIG;IACH,OAAO,CAAC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAIhG;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,kCAAkC,GAAG,OAAO,CAAC,4BAA4B,CAAC;IAU3F;;;;OAIG;IACH,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,EAAE,MAAM,CAAC;QAChB,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KACvD,GAAG,OAAO,CAAC,wBAAwB,CAAC;YAUtB,eAAe;IAgE9B;;;;OAIG;IACG,MAAM,CAAC,MAAM,EAAE,kCAAkC,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI;IA2B/F;;;;OAIG;IACG,UAAU,CAAC,MAAM,EAAE,4BAA4B,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI;CA0B9F"}

package/dist/resources/vector.d.ts

@@ -0,0 +1,51 @@
+import type { RuntimeContext } from '@mastra/core/runtime-context';
+import type { CreateIndexParams, GetVectorIndexResponse, QueryVectorParams, QueryVectorResponse, ClientOptions, UpsertVectorParams } from '../types.js';
+import { BaseResource } from './base.js';
+export declare class Vector extends BaseResource {
+    private vectorName;
+    constructor(options: ClientOptions, vectorName: string);
+    /**
+     * Retrieves details about a specific vector index
+     * @param indexName - Name of the index to get details for
+     * @param runtimeContext - Optional runtime context to pass as query parameter
+     * @returns Promise containing vector index details
+     */
+    details(indexName: string, runtimeContext?: RuntimeContext | Record<string, any>): Promise<GetVectorIndexResponse>;
+    /**
+     * Deletes a vector index
+     * @param indexName - Name of the index to delete
+     * @returns Promise indicating deletion success
+     */
+    delete(indexName: string): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Retrieves a list of all available indexes
+     * @param runtimeContext - Optional runtime context to pass as query parameter
+     * @returns Promise containing array of index names
+     */
+    getIndexes(runtimeContext?: RuntimeContext | Record<string, any>): Promise<{
+        indexes: string[];
+    }>;
+    /**
+     * Creates a new vector index
+     * @param params - Parameters for index creation including dimension and metric
+     * @returns Promise indicating creation success
+     */
+    createIndex(params: CreateIndexParams): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Upserts vectors into an index
+     * @param params - Parameters containing vectors, metadata, and optional IDs
+     * @returns Promise containing array of vector IDs
+     */
+    upsert(params: UpsertVectorParams): Promise<string[]>;
+    /**
+     * Queries vectors in an index
+     * @param params - Query parameters including query vector and search options
+     * @returns Promise containing query results
+     */
+    query(params: QueryVectorParams): Promise<QueryVectorResponse>;
+}
+//# sourceMappingURL=vector.d.ts.map

package/dist/resources/vector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vector.d.ts","sourceRoot":"","sources":["../../src/resources/vector.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,KAAK,EACV,iBAAiB,EACjB,sBAAsB,EACtB,iBAAiB,EACjB,mBAAmB,EACnB,aAAa,EACb,kBAAkB,EACnB,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,qBAAa,MAAO,SAAQ,YAAY;IAGpC,OAAO,CAAC,UAAU;gBADlB,OAAO,EAAE,aAAa,EACd,UAAU,EAAE,MAAM;IAK5B;;;;;OAKG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAMlH;;;;OAIG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IAMxD;;;;OAIG;IACH,UAAU,CAAC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IAIjG;;;;OAIG;IACH,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IAOrE;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAOrD;;;;OAIG;IACH,KAAK,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAM/D"}

package/dist/resources/workflow.d.ts

@@ -0,0 +1,254 @@
+import type { RuntimeContext } from '@mastra/core/runtime-context';
+import type { ClientOptions, GetWorkflowResponse, GetWorkflowRunsResponse, GetWorkflowRunsParams, WorkflowRunResult, WorkflowWatchResult, GetWorkflowRunByIdResponse, GetWorkflowRunExecutionResultResponse } from '../types.js';
+import { BaseResource } from './base.js';
+export declare class Workflow extends BaseResource {
+    private workflowId;
+    constructor(options: ClientOptions, workflowId: string);
+    /**
+     * Creates an async generator that processes a readable stream and yields workflow records
+     * separated by the Record Separator character (\x1E)
+     *
+     * @param stream - The readable stream to process
+     * @returns An async generator that yields parsed records
+     */
+    private streamProcessor;
+    /**
+     * Retrieves details about the workflow
+     * @param runtimeContext - Optional runtime context to pass as query parameter
+     * @returns Promise containing workflow details including steps and graphs
+     */
+    details(runtimeContext?: RuntimeContext | Record<string, any>): Promise<GetWorkflowResponse>;
+    /**
+     * Retrieves all runs for a workflow
+     * @param params - Parameters for filtering runs
+     * @param runtimeContext - Optional runtime context to pass as query parameter
+     * @returns Promise containing workflow runs array
+     */
+    runs(params?: GetWorkflowRunsParams, runtimeContext?: RuntimeContext | Record<string, any>): Promise<GetWorkflowRunsResponse>;
+    /**
+     * Retrieves a specific workflow run by its ID
+     * @param runId - The ID of the workflow run to retrieve
+     * @param runtimeContext - Optional runtime context to pass as query parameter
+     * @returns Promise containing the workflow run details
+     */
+    runById(runId: string, runtimeContext?: RuntimeContext | Record<string, any>): Promise<GetWorkflowRunByIdResponse>;
+    /**
+     * Retrieves the execution result for a specific workflow run by its ID
+     * @param runId - The ID of the workflow run to retrieve the execution result for
+     * @param runtimeContext - Optional runtime context to pass as query parameter
+     * @returns Promise containing the workflow run execution result
+     */
+    runExecutionResult(runId: string, runtimeContext?: RuntimeContext | Record<string, any>): Promise<GetWorkflowRunExecutionResultResponse>;
+    /**
+     * Cancels a specific workflow run by its ID
+     * @param runId - The ID of the workflow run to cancel
+     * @returns Promise containing a success message
+     */
+    cancelRun(runId: string): Promise<{
+        message: string;
+    }>;
+    /**
+     * Sends an event to a specific workflow run by its ID
+     * @param params - Object containing the runId, event and data
+     * @returns Promise containing a success message
+     */
+    sendRunEvent(params: {
+        runId: string;
+        event: string;
+        data: unknown;
+    }): Promise<{
+        message: string;
+    }>;
+    /**
+     * @deprecated Use createRunAsync() instead.
+     * @throws {Error} Always throws an error directing users to use createRunAsync()
+     */
+    createRun(_params?: {
+        runId?: string;
+    }): Promise<{
+        runId: string;
+        start: (params: {
+            inputData: Record<string, any>;
+            runtimeContext?: RuntimeContext | Record<string, any>;
+        }) => Promise<{
+            message: string;
+        }>;
+        watch: (onRecord: (record: WorkflowWatchResult) => void) => Promise<void>;
+        resume: (params: {
+            step: string | string[];
+            resumeData?: Record<string, any>;
+            runtimeContext?: RuntimeContext | Record<string, any>;
+        }) => Promise<{
+            message: string;
+        }>;
+        stream: (params: {
+            inputData: Record<string, any>;
+            runtimeContext?: RuntimeContext | Record<string, any>;
+        }) => Promise<ReadableStream>;
+        startAsync: (params: {
+            inputData: Record<string, any>;
+            runtimeContext?: RuntimeContext | Record<string, any>;
+        }) => Promise<WorkflowRunResult>;
+        resumeAsync: (params: {
+            step: string | string[];
+            resumeData?: Record<string, any>;
+            runtimeContext?: RuntimeContext | Record<string, any>;
+        }) => Promise<WorkflowRunResult>;
+    }>;
+    /**
+     * Creates a new workflow run
+     * @param params - Optional object containing the optional runId
+     * @returns Promise containing the runId of the created run with methods to control execution
+     */
+    createRunAsync(params?: {
+        runId?: string;
+    }): Promise<{
+        runId: string;
+        start: (params: {
+            inputData: Record<string, any>;
+            runtimeContext?: RuntimeContext | Record<string, any>;
+        }) => Promise<{
+            message: string;
+        }>;
+        watch: (onRecord: (record: WorkflowWatchResult) => void) => Promise<void>;
+        resume: (params: {
+            step: string | string[];
+            resumeData?: Record<string, any>;
+            runtimeContext?: RuntimeContext | Record<string, any>;
+        }) => Promise<{
+            message: string;
+        }>;
+        stream: (params: {
+            inputData: Record<string, any>;
+            runtimeContext?: RuntimeContext | Record<string, any>;
+        }) => Promise<ReadableStream>;
+        startAsync: (params: {
+            inputData: Record<string, any>;
+            runtimeContext?: RuntimeContext | Record<string, any>;
+        }) => Promise<WorkflowRunResult>;
+        resumeAsync: (params: {
+            step: string | string[];
+            resumeData?: Record<string, any>;
+            runtimeContext?: RuntimeContext | Record<string, any>;
+        }) => Promise<WorkflowRunResult>;
+        resumeStreamVNext: (params: {
+            step: string | string[];
+            resumeData?: Record<string, any>;
+            runtimeContext?: RuntimeContext | Record<string, any>;
+        }) => Promise<ReadableStream>;
+    }>;
+    /**
+     * Starts a workflow run synchronously without waiting for the workflow to complete
+     * @param params - Object containing the runId, inputData and runtimeContext
+     * @returns Promise containing success message
+     */
+    start(params: {
+        runId: string;
+        inputData: Record<string, any>;
+        runtimeContext?: RuntimeContext | Record<string, any>;
+    }): Promise<{
+        message: string;
+    }>;
+    /**
+     * Resumes a suspended workflow step synchronously without waiting for the workflow to complete
+     * @param params - Object containing the runId, step, resumeData and runtimeContext
+     * @returns Promise containing success message
+     */
+    resume({ step, runId, resumeData, ...rest }: {
+        step: string | string[];
+        runId: string;
+        resumeData?: Record<string, any>;
+        runtimeContext?: RuntimeContext | Record<string, any>;
+    }): Promise<{
+        message: string;
+    }>;
+    /**
+     * Starts a workflow run asynchronously and returns a promise that resolves when the workflow is complete
+     * @param params - Object containing the optional runId, inputData and runtimeContext
+     * @returns Promise containing the workflow execution results
+     */
+    startAsync(params: {
+        runId?: string;
+        inputData: Record<string, any>;
+        runtimeContext?: RuntimeContext | Record<string, any>;
+    }): Promise<WorkflowRunResult>;
+    /**
+     * Starts a workflow run and returns a stream
+     * @param params - Object containing the optional runId, inputData and runtimeContext
+     * @returns Promise containing the workflow execution results
+     */
+    stream(params: {
+        runId?: string;
+        inputData: Record<string, any>;
+        runtimeContext?: RuntimeContext | Record<string, any>;
+    }): Promise<import("stream/web").ReadableStream<{
+        type: string;
+        payload: any;
+    }>>;
+    /**
+     * Observes workflow stream for a workflow run
+     * @param params - Object containing the runId
+     * @returns Promise containing the workflow execution results
+     */
+    observeStream(params: {
+        runId: string;
+    }): Promise<import("stream/web").ReadableStream<{
+        type: string;
+        payload: any;
+    }>>;
+    /**
+     * Starts a workflow run and returns a stream
+     * @param params - Object containing the optional runId, inputData and runtimeContext
+     * @returns Promise containing the workflow execution results
+     */
+    streamVNext(params: {
+        runId?: string;
+        inputData: Record<string, any>;
+        runtimeContext?: RuntimeContext;
+        closeOnSuspend?: boolean;
+    }): Promise<import("stream/web").ReadableStream<{
+        type: string;
+        payload: any;
+        runId: string;
+        from: "AGENT" | "WORKFLOW";
+    }>>;
+    /**
+     * Resumes a suspended workflow step asynchronously and returns a promise that resolves when the workflow is complete
+     * @param params - Object containing the runId, step, resumeData and runtimeContext
+     * @returns Promise containing the workflow resume results
+     */
+    resumeAsync(params: {
+        runId: string;
+        step: string | string[];
+        resumeData?: Record<string, any>;
+        runtimeContext?: RuntimeContext | Record<string, any>;
+    }): Promise<WorkflowRunResult>;
+    /**
+     * Resumes a suspended workflow step that uses streamVNext asynchronously and returns a promise that resolves when the workflow is complete
+     * @param params - Object containing the runId, step, resumeData and runtimeContext
+     * @returns Promise containing the workflow resume results
+     */
+    resumeStreamVNext(params: {
+        runId: string;
+        step: string | string[];
+        resumeData?: Record<string, any>;
+        runtimeContext?: RuntimeContext | Record<string, any>;
+    }): Promise<ReadableStream>;
+    /**
+     * Watches workflow transitions in real-time
+     * @param runId - Optional run ID to filter the watch stream
+     * @returns AsyncGenerator that yields parsed records from the workflow watch stream
+     */
+    watch({ runId }: {
+        runId?: string;
+    }, onRecord: (record: WorkflowWatchResult) => void): Promise<void>;
+    /**
+     * Creates a new ReadableStream from an iterable or async iterable of objects,
+     * serializing each as JSON and separating them with the record separator (\x1E).
+     *
+     * @param records - An iterable or async iterable of objects to stream
+     * @returns A ReadableStream emitting the records as JSON strings separated by the record separator
+     */
+    static createRecordStream(records: Iterable<any> | AsyncIterable<any>): ReadableStream;
+}
+//# sourceMappingURL=workflow.d.ts.map

package/dist/resources/workflow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow.d.ts","sourceRoot":"","sources":["../../src/resources/workflow.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,KAAK,EACV,aAAa,EACb,mBAAmB,EACnB,uBAAuB,EACvB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,0BAA0B,EAC1B,qCAAqC,EACtC,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAItC,qBAAa,QAAS,SAAQ,YAAY;IAGtC,OAAO,CAAC,UAAU;gBADlB,OAAO,EAAE,aAAa,EACd,UAAU,EAAE,MAAM;IAK5B;;;;;;OAMG;YACY,eAAe;IAgE9B;;;;OAIG;IACH,OAAO,CAAC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAI5F;;;;;OAKG;IACH,IAAI,CACF,MAAM,CAAC,EAAE,qBAAqB,EAC9B,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACpD,OAAO,CAAC,uBAAuB,CAAC;IA8BnC;;;;;OAKG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAIlH;;;;;OAKG;IACH,kBAAkB,CAChB,KAAK,EAAE,MAAM,EACb,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACpD,OAAO,CAAC,qCAAqC,CAAC;IAMjD;;;;OAIG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAMtD;;;;OAIG;IACH,YAAY,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAOnG;;;OAGG;IACG,SAAS,CAAC,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC;QACrD,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,CAAC,MAAM,EAAE;YACd,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YAC/B,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SACvD,KAAK,OAAO,CAAC;YAAE,OAAO,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QACnC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1E,MAAM,EAAE,CAAC,MAAM,EAAE;YACf,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;YACxB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YACjC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SACvD,KAAK,OAAO,CAAC;YAAE,OAAO,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QACnC,MAAM,EAAE,CAAC,MAAM,EAAE;YACf,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YAC/B,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SACvD,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;QAC9B,UAAU,EAAE,CAAC,MAAM,EAAE;YACnB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YAC/B,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SACvD,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACjC,WAAW,EAAE,CAAC,MAAM,EAAE;YACpB,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;YACxB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YACjC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SACvD,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;KAClC,CAAC;IAWF;;;;OAIG;IACG,cAAc,CAAC,MAAM,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC;QACzD,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,CAAC,MAAM,EAAE;YACd,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YAC/B,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SACvD,KAAK,OAAO,CAAC;YAAE,OAAO,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QACnC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1E,MAAM,EAAE,CAAC,MAAM,EAAE;YACf,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;YACxB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YACjC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SACvD,KAAK,OAAO,CAAC;YAAE,OAAO,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QACnC,MAAM,EAAE,CAAC,MAAM,EAAE;YACf,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YAC/B,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SACvD,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;QAC9B,UAAU,EAAE,CAAC,MAAM,EAAE;YACnB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YAC/B,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SACvD,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACjC,WAAW,EAAE,CAAC,MAAM,EAAE;YACpB,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;YACxB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YACjC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SACvD,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACjC,iBAAiB,EAAE,CAAC,MAAM,EAAE;YAC1B,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;YACxB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YACjC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SACvD,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;KAC/B,CAAC;IA8DF;;;;OAIG;IACH,KAAK,CAAC,MAAM,EAAE;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC/B,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KACvD,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAQhC;;;;OAIG;IACH,MAAM,CAAC,EACL,IAAI,EACJ,KAAK,EACL,UAAU,EACV,GAAG,IAAI,EACR,EAAE;QACD,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACxB,KAAK,EAAE,MAAM,CAAC;QACd,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KACvD,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAYhC;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC/B,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KACvD,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAe9B;;;;OAIG;IACG,MAAM,CAAC,MAAM,EAAE;QACnB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC/B,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KACvD;cA6BkE,MAAM;iBAAW,GAAG;;IAiCvF;;;;OAIG;IACG,aAAa,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE;cAuBsB,MAAM;iBAAW,GAAG;;IAiCvF;;;;OAIG;IACG,WAAW,CAAC,MAAM,EAAE;QACxB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC/B,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,cAAc,CAAC,EAAE,OAAO,CAAC;KAC1B;cA+BW,MAAM;iBAAW,GAAG;eAAS,MAAM;cAAQ,OAAO,GAAG,UAAU;;IAkC3E;;;;OAIG;IACH,WAAW,CAAC,MAAM,EAAE;QAClB,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACxB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KACvD,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAY9B;;;;OAIG;IACH,iBAAiB,CAAC,MAAM,EAAE;QACxB,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACxB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KACvD,GAAG,OAAO,CAAC,cAAc,CAAC;IAW3B;;;;OAIG;IACG,KAAK,CAAC,EAAE,KAAK,EAAE,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI;IAsB1F;;;;;;OAMG;IACH,MAAM,CAAC,kBAAkB,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,GAAG,cAAc;CAgBvF"}

package/dist/tools.d.ts

@@ -0,0 +1,22 @@
+import type { ToolExecutionOptions } from 'ai';
+import type { z } from 'zod';
+export interface ClientToolExecutionContext<TSchemaIn extends z.ZodSchema | undefined = undefined> {
+    context: TSchemaIn extends z.ZodSchema ? z.infer<TSchemaIn> : unknown;
+}
+export interface ClientToolAction<TSchemaIn extends z.ZodSchema | undefined = undefined, TSchemaOut extends z.ZodSchema | undefined = undefined> {
+    id: string;
+    description: string;
+    inputSchema?: TSchemaIn;
+    outputSchema?: TSchemaOut;
+    execute?: (context: ClientToolExecutionContext<TSchemaIn>, options?: ToolExecutionOptions) => Promise<TSchemaOut extends z.ZodSchema ? z.infer<TSchemaOut> : unknown>;
+}
+export declare class ClientTool<TSchemaIn extends z.ZodSchema | undefined = undefined, TSchemaOut extends z.ZodSchema | undefined = undefined> implements ClientToolAction<TSchemaIn, TSchemaOut> {
+    id: string;
+    description: string;
+    inputSchema?: TSchemaIn;
+    outputSchema?: TSchemaOut;
+    execute?: ClientToolAction<TSchemaIn, TSchemaOut>['execute'];
+    constructor(opts: ClientToolAction<TSchemaIn, TSchemaOut>);
+}
+export declare function createTool<TSchemaIn extends z.ZodSchema | undefined = undefined, TSchemaOut extends z.ZodSchema | undefined = undefined>(opts: ClientToolAction<TSchemaIn, TSchemaOut>): ClientTool<TSchemaIn, TSchemaOut>;
+//# sourceMappingURL=tools.d.ts.map

package/dist/tools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools.d.ts","sourceRoot":"","sources":["../src/tools.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,IAAI,CAAC;AAC/C,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAG7B,MAAM,WAAW,0BAA0B,CAAC,SAAS,SAAS,CAAC,CAAC,SAAS,GAAG,SAAS,GAAG,SAAS;IAC/F,OAAO,EAAE,SAAS,SAAS,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC;CACvE;AAGD,MAAM,WAAW,gBAAgB,CAC/B,SAAS,SAAS,CAAC,CAAC,SAAS,GAAG,SAAS,GAAG,SAAS,EACrD,UAAU,SAAS,CAAC,CAAC,SAAS,GAAG,SAAS,GAAG,SAAS;IAEtD,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,YAAY,CAAC,EAAE,UAAU,CAAC;IAC1B,OAAO,CAAC,EAAE,CACR,OAAO,EAAE,0BAA0B,CAAC,SAAS,CAAC,EAC9C,OAAO,CAAC,EAAE,oBAAoB,KAC3B,OAAO,CAAC,UAAU,SAAS,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,CAAC;CAC9E;AAGD,qBAAa,UAAU,CACrB,SAAS,SAAS,CAAC,CAAC,SAAS,GAAG,SAAS,GAAG,SAAS,EACrD,UAAU,SAAS,CAAC,CAAC,SAAS,GAAG,SAAS,GAAG,SAAS,CACtD,YAAW,gBAAgB,CAAC,SAAS,EAAE,UAAU,CAAC;IAElD,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,YAAY,CAAC,EAAE,UAAU,CAAC;IAC1B,OAAO,CAAC,EAAE,gBAAgB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,SAAS,CAAC,CAAC;gBAEjD,IAAI,EAAE,gBAAgB,CAAC,SAAS,EAAE,UAAU,CAAC;CAO1D;AAGD,wBAAgB,UAAU,CACxB,SAAS,SAAS,CAAC,CAAC,SAAS,GAAG,SAAS,GAAG,SAAS,EACrD,UAAU,SAAS,CAAC,CAAC,SAAS,GAAG,SAAS,GAAG,SAAS,EACtD,IAAI,EAAE,gBAAgB,CAAC,SAAS,EAAE,UAAU,CAAC,GAAG,UAAU,CAAC,SAAS,EAAE,UAAU,CAAC,CAElF"}