@langchain/langgraph-sdk 0.0.1-rc.8 → 0.0.1

package/LICENSE

@@ -1,6 +1,6 @@
-The MIT License
+MIT License
 
-Copyright (c) 2024 LangChain
+Copyright (c) 2024 LangChain, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,64 @@
+# LangGraph JS/TS SDK
+
+This repository contains the JS/TS SDK for interacting with the LangGraph REST API.
+
+## Quick Start
+
+To get started with the JS/TS SDK, [install the package](https://www.npmjs.com/package/@langchain/langgraph-sdk)
+
+```bash
+yarn add @langchain/langgraph-sdk
+```
+
+You will need a running LangGraph API server. If you're running a server locally using `langgraph-cli`, SDK will automatically point at `http://localhost:8123`, otherwise
+you would need to specify the server URL when creating a client.
+
+```js
+import { Client } from "@langchain/langgraph-sdk";
+
+const client = new Client();
+
+// List all assistants
+const assistants = await client.assistants.search({
+  metadata: null,
+  offset: 0,
+  limit: 10,
+});
+
+// We auto-create an assistant for each graph you register in config.
+const agent = assistants[0];
+
+// Start a new thread
+const thread = await client.threads.create();
+
+// Start a streaming run
+const messages = [{ role: "human", content: "what's the weather in la" }];
+
+const streamResponse = client.runs.stream(
+  thread["thread_id"],
+  agent["assistant_id"],
+  {
+    input: { messages },
+  }
+);
+
+for await (const chunk of streamResponse) {
+  console.log(chunk);
+}
+```
+
+## Documentation
+
+To generate documentation, run the following commands:
+
+1. Generate docs.
+
+        yarn typedoc
+
+1. Consolidate doc files into one markdown file.
+
+        npx concat-md --decrease-title-levels --ignore=js_ts_sdk_ref.md --start-title-level-at 2 docs > docs/js_ts_sdk_ref.md
+
+1. Copy `js_ts_sdk_ref.md` to MkDocs directory.
+
+        cp docs/js_ts_sdk_ref.md ../../docs/docs/cloud/reference/sdk/js_ts_sdk_ref.md

package/dist/client.d.mts

@@ -1,15 +1,17 @@
-import { Assistant, AssistantGraph, Config, DefaultValues, GraphSchema, Metadata, Run, RunEvent, Thread, ThreadState } from "./schema.js";
+import { Assistant, AssistantGraph, Config, DefaultValues, GraphSchema, Metadata, Run, Thread, ThreadState, Cron } from "./schema.js";
 import { AsyncCaller, AsyncCallerParams } from "./utils/async_caller.mjs";
-import { RunsCreatePayload, RunsStreamPayload, RunsWaitPayload } from "./types.mjs";
+import { RunsCreatePayload, RunsStreamPayload, RunsWaitPayload, StreamEvent, CronsCreatePayload } from "./types.mjs";
 interface ClientConfig {
     apiUrl?: string;
     callerOptions?: AsyncCallerParams;
     timeoutMs?: number;
+    defaultHeaders?: Record<string, string | null | undefined>;
 }
 declare class BaseClient {
     protected asyncCaller: AsyncCaller;
     protected timeoutMs: number;
     protected apiUrl: string;
+    protected defaultHeaders: Record<string, string | null | undefined>;
     constructor(config?: ClientConfig);
     protected prepareFetchOptions(path: string, options?: RequestInit & {
         json?: unknown;
@@ -20,6 +22,39 @@ declare class BaseClient {
         params?: Record<string, unknown>;
     }): Promise<T>;
 }
+declare class CronsClient extends BaseClient {
+    /**
+     *
+     * @param threadId The ID of the thread.
+     * @param assistantId Assistant ID to use for this cron job.
+     * @param payload Payload for creating a cron job.
+     * @returns The created background run.
+     */
+    createForThread(threadId: string, assistantId: string, payload?: CronsCreatePayload): Promise<Run>;
+    /**
+     *
+     * @param assistantId Assistant ID to use for this cron job.
+     * @param payload Payload for creating a cron job.
+     * @returns
+     */
+    create(assistantId: string, payload?: CronsCreatePayload): Promise<Run>;
+    /**
+     *
+     * @param cronId Cron ID of Cron job to delete.
+     */
+    delete(cronId: string): Promise<void>;
+    /**
+     *
+     * @param query Query options.
+     * @returns List of crons.
+     */
+    search(query?: {
+        assistantId?: string;
+        threadId?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<Cron[]>;
+}
 declare class AssistantsClient extends BaseClient {
     /**
      * Get an assistant by ID.
@@ -61,12 +96,19 @@ declare class AssistantsClient extends BaseClient {
         config?: Config;
         metadata?: Metadata;
     }): Promise<Assistant>;
+    /**
+     * Delete an assistant.
+     *
+     * @param assistantId ID of the assistant.
+     */
+    delete(assistantId: string): Promise<void>;
     /**
      * List assistants.
      * @param query Query options.
      * @returns List of assistants.
      */
     search(query?: {
+        graphId?: string;
         metadata?: Metadata;
         limit?: number;
         offset?: number;
@@ -138,17 +180,16 @@ declare class ThreadsClient extends BaseClient {
      * @param threadId ID of the thread.
      * @returns Thread state.
      */
-    getState<ValuesType = DefaultValues>(threadId: string): Promise<ThreadState<ValuesType>>;
+    getState<ValuesType = DefaultValues>(threadId: string, checkpointId?: string): Promise<ThreadState<ValuesType>>;
     /**
      * Add state to a thread.
      *
-     * @param threadIdOrConfig Thread ID or config that identifies the state to start from.
-     * @param values The state update
-     * @param options Additional options.
+     * @param threadId The ID of the thread.
      * @returns
      */
-    updateState<ValuesType = DefaultValues>(threadIdOrConfig: string | Config, options: {
+    updateState<ValuesType = DefaultValues>(threadId: string, options: {
         values: ValuesType;
+        checkpointId?: string;
         asNode?: string;
     }): Promise<void>;
     /**
@@ -172,15 +213,12 @@ declare class ThreadsClient extends BaseClient {
     }): Promise<ThreadState<ValuesType>[]>;
 }
 declare class RunsClient extends BaseClient {
-    /**
-     * Create a run and stream the results.
-     *
-     * @param threadId The ID of the thread.
-     * @param assistantId Assistant ID to use for this run.
-     * @param payload Payload for creating a run.
-     */
+    stream(threadId: null, assistantId: string, payload?: Omit<RunsStreamPayload, "multitaskStrategy">): AsyncGenerator<{
+        event: StreamEvent;
+        data: any;
+    }>;
     stream(threadId: string, assistantId: string, payload?: RunsStreamPayload): AsyncGenerator<{
-        event: "events" | "metadata" | "debug" | "updates" | "values" | "messages/partial" | "messages/metadata" | "messages/complete" | (string & {});
+        event: StreamEvent;
         data: any;
     }>;
     /**
@@ -192,14 +230,7 @@ declare class RunsClient extends BaseClient {
      * @returns The created run.
      */
     create(threadId: string, assistantId: string, payload?: RunsCreatePayload): Promise<Run>;
-    /**
-     * Create a run and wait for it to complete.
-     *
-     * @param threadId The ID of the thread.
-     * @param assistantId Assistant ID to use for this run.
-     * @param payload Payload for creating a run.
-     * @returns The last values chunk of the thread.
-     */
+    wait(threadId: null, assistantId: string, payload?: Omit<RunsWaitPayload, "multitaskStrategy">): Promise<ThreadState["values"]>;
     wait(threadId: string, assistantId: string, payload?: RunsWaitPayload): Promise<ThreadState["values"]>;
     /**
      * List all runs for a thread.
@@ -229,25 +260,30 @@ declare class RunsClient extends BaseClient {
      */
     get(threadId: string, runId: string): Promise<Run>;
     /**
-     * List all events for a run.
+     * Cancel a run.
      *
      * @param threadId The ID of the thread.
      * @param runId The ID of the run.
-     * @param options Filtering and pagination options.
-     * @returns List of events.
+     * @param wait Whether to block when canceling
+     * @returns
      */
-    listEvents(threadId: string, runId: string, options?: {
-        /**
-         * Maximum number of events to return.
-         * Defaults to 10
-         */
-        limit?: number;
-        /**
-         * Offset to start from.
-         * Defaults to 0.
-         */
-        offset?: number;
-    }): Promise<RunEvent[]>;
+    cancel(threadId: string, runId: string, wait?: boolean): Promise<void>;
+    /**
+     * Block until a run is done.
+     *
+     * @param threadId The ID of the thread.
+     * @param runId The ID of the run.
+     * @returns
+     */
+    join(threadId: string, runId: string): Promise<void>;
+    /**
+     * Delete a run.
+     *
+     * @param threadId The ID of the thread.
+     * @param runId The ID of the run.
+     * @returns
+     */
+    delete(threadId: string, runId: string): Promise<void>;
 }
 export declare class Client {
     /**
@@ -262,6 +298,10 @@ export declare class Client {
      * The client for interacting with runs.
      */
     runs: RunsClient;
+    /**
+     * The client for interacting with cron runs.
+     */
+    crons: CronsClient;
     constructor(config?: ClientConfig);
 }
 export {};

package/dist/client.mjs

@@ -21,6 +21,12 @@ class BaseClient {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "defaultHeaders", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.asyncCaller = new AsyncCaller({
             maxRetries: 4,
             maxConcurrency: 4,
@@ -28,9 +34,13 @@ class BaseClient {
         });
         this.timeoutMs = config?.timeoutMs || 12_000;
         this.apiUrl = config?.apiUrl || "http://localhost:8123";
+        this.defaultHeaders = config?.defaultHeaders || {};
     }
     prepareFetchOptions(path, options) {
-        const mutatedOptions = { ...options };
+        const mutatedOptions = {
+            ...options,
+            headers: { ...this.defaultHeaders, ...options?.headers },
+        };
         if (mutatedOptions.json) {
             mutatedOptions.body = JSON.stringify(mutatedOptions.json);
             mutatedOptions.headers = {
@@ -55,9 +65,84 @@ class BaseClient {
     }
     async fetch(path, options) {
         const response = await this.asyncCaller.fetch(...this.prepareFetchOptions(path, options));
+        if (response.status === 202 || response.status === 204) {
+            return undefined;
+        }
         return response.json();
     }
 }
+class CronsClient extends BaseClient {
+    /**
+     *
+     * @param threadId The ID of the thread.
+     * @param assistantId Assistant ID to use for this cron job.
+     * @param payload Payload for creating a cron job.
+     * @returns The created background run.
+     */
+    async createForThread(threadId, assistantId, payload) {
+        const json = {
+            schedule: payload?.schedule,
+            input: payload?.input,
+            config: payload?.config,
+            metadata: payload?.metadata,
+            assistant_id: assistantId,
+            interrupt_before: payload?.interruptBefore,
+            interrupt_after: payload?.interruptAfter,
+            webhook: payload?.webhook,
+        };
+        return this.fetch(`/threads/${threadId}/runs/crons`, {
+            method: "POST",
+            json,
+        });
+    }
+    /**
+     *
+     * @param assistantId Assistant ID to use for this cron job.
+     * @param payload Payload for creating a cron job.
+     * @returns
+     */
+    async create(assistantId, payload) {
+        const json = {
+            schedule: payload?.schedule,
+            input: payload?.input,
+            config: payload?.config,
+            metadata: payload?.metadata,
+            assistant_id: assistantId,
+            interrupt_before: payload?.interruptBefore,
+            interrupt_after: payload?.interruptAfter,
+            webhook: payload?.webhook,
+        };
+        return this.fetch(`/runs/crons`, {
+            method: "POST",
+            json,
+        });
+    }
+    /**
+     *
+     * @param cronId Cron ID of Cron job to delete.
+     */
+    async delete(cronId) {
+        await this.fetch(`/runs/crons/${cronId}`, {
+            method: "DELETE",
+        });
+    }
+    /**
+     *
+     * @param query Query options.
+     * @returns List of crons.
+     */
+    async search(query) {
+        return this.fetch("/runs/crons/search", {
+            method: "POST",
+            json: {
+                assistant_id: query?.assistantId ?? undefined,
+                thread_id: query?.threadId ?? undefined,
+                limit: query?.limit ?? 10,
+                offset: query?.offset ?? 0,
+            },
+        });
+    }
+}
 class AssistantsClient extends BaseClient {
     /**
      * Get an assistant by ID.
@@ -115,6 +200,16 @@ class AssistantsClient extends BaseClient {
             },
         });
     }
+    /**
+     * Delete an assistant.
+     *
+     * @param assistantId ID of the assistant.
+     */
+    async delete(assistantId) {
+        return this.fetch(`/assistants/${assistantId}`, {
+            method: "DELETE",
+        });
+    }
     /**
      * List assistants.
      * @param query Query options.
@@ -124,6 +219,7 @@ class AssistantsClient extends BaseClient {
         return this.fetch("/assistants/search", {
             method: "POST",
             json: {
+                graph_id: query?.graphId ?? undefined,
                 metadata: query?.metadata ?? undefined,
                 limit: query?.limit ?? 10,
                 offset: query?.offset ?? 0,
@@ -198,34 +294,25 @@ class ThreadsClient extends BaseClient {
      * @param threadId ID of the thread.
      * @returns Thread state.
      */
-    async getState(threadId) {
-        return this.fetch(`/threads/${threadId}/state`);
+    async getState(threadId, checkpointId) {
+        return this.fetch(checkpointId != null
+            ? `/threads/${threadId}/state/${checkpointId}`
+            : `/threads/${threadId}/state`);
     }
     /**
      * Add state to a thread.
      *
-     * @param threadIdOrConfig Thread ID or config that identifies the state to start from.
-     * @param values The state update
-     * @param options Additional options.
+     * @param threadId The ID of the thread.
      * @returns
      */
-    async updateState(threadIdOrConfig, options) {
-        let config = undefined;
-        let threadId;
-        if (typeof threadIdOrConfig !== "string") {
-            config = threadIdOrConfig;
-            if (typeof config.configurable?.thread_id !== "string") {
-                throw new Error("Thread ID is required when updating state with a config.");
-            }
-            threadId = config.configurable.thread_id;
-        }
-        else {
-            config = undefined;
-            threadId = threadIdOrConfig;
-        }
+    async updateState(threadId, options) {
         return this.fetch(`/threads/${threadId}/state`, {
             method: "POST",
-            json: { values: options.values, config, as_node: options?.asNode },
+            json: {
+                values: options.values,
+                checkpoint_id: options.checkpointId,
+                as_node: options?.asNode,
+            },
         });
     }
     /**
@@ -277,18 +364,23 @@ class RunsClient extends BaseClient {
      * @param payload Payload for creating a run.
      */
     async *stream(threadId, assistantId, payload) {
-        const response = await this.asyncCaller.fetch(...this.prepareFetchOptions(`/threads/${threadId}/runs/stream`, {
+        const json = {
+            input: payload?.input,
+            config: payload?.config,
+            metadata: payload?.metadata,
+            stream_mode: payload?.streamMode,
+            feedback_keys: payload?.feedbackKeys,
+            assistant_id: assistantId,
+            interrupt_before: payload?.interruptBefore,
+            interrupt_after: payload?.interruptAfter,
+        };
+        if (payload?.multitaskStrategy != null) {
+            json["multitask_strategy"] = payload?.multitaskStrategy;
+        }
+        const endpoint = threadId == null ? `/runs/stream` : `/threads/${threadId}/runs/stream`;
+        const response = await this.asyncCaller.fetch(...this.prepareFetchOptions(endpoint, {
             method: "POST",
-            json: {
-                input: payload?.input,
-                config: payload?.config,
-                metadata: payload?.metadata,
-                stream_mode: payload?.streamMode,
-                feedback_keys: payload?.feedbackKeys,
-                assistant_id: assistantId,
-                interrupt_before: payload?.interruptBefore,
-                interrupt_after: payload?.interruptAfter,
-            },
+            json,
             signal: payload?.signal,
         }));
         let parser;
@@ -324,17 +416,21 @@ class RunsClient extends BaseClient {
      * @returns The created run.
      */
     async create(threadId, assistantId, payload) {
+        const json = {
+            input: payload?.input,
+            config: payload?.config,
+            metadata: payload?.metadata,
+            assistant_id: assistantId,
+            interrupt_before: payload?.interruptBefore,
+            interrupt_after: payload?.interruptAfter,
+            webhook: payload?.webhook,
+        };
+        if (payload?.multitaskStrategy != null) {
+            json["multitask_strategy"] = payload?.multitaskStrategy;
+        }
         return this.fetch(`/threads/${threadId}/runs`, {
             method: "POST",
-            json: {
-                input: payload?.input,
-                config: payload?.config,
-                metadata: payload?.metadata,
-                assistant_id: assistantId,
-                interrupt_before: payload?.interruptBefore,
-                interrupt_after: payload?.interruptAfter,
-                webhook: payload?.webhook,
-            },
+            json,
             signal: payload?.signal,
         });
     }
@@ -347,16 +443,21 @@ class RunsClient extends BaseClient {
      * @returns The last values chunk of the thread.
      */
     async wait(threadId, assistantId, payload) {
-        return this.fetch(`/threads/${threadId}/runs/wait`, {
+        const json = {
+            input: payload?.input,
+            config: payload?.config,
+            metadata: payload?.metadata,
+            assistant_id: assistantId,
+            interrupt_before: payload?.interruptBefore,
+            interrupt_after: payload?.interruptAfter,
+        };
+        if (payload?.multitaskStrategy != null) {
+            json["multitask_strategy"] = payload?.multitaskStrategy;
+        }
+        const endpoint = threadId == null ? `/runs/wait` : `/threads/${threadId}/runs/wait`;
+        return this.fetch(endpoint, {
             method: "POST",
-            json: {
-                input: payload?.input,
-                config: payload?.config,
-                metadata: payload?.metadata,
-                assistant_id: assistantId,
-                interrupt_before: payload?.interruptBefore,
-                interrupt_after: payload?.interruptAfter,
-            },
+            json,
             signal: payload?.signal,
         });
     }
@@ -386,21 +487,43 @@ class RunsClient extends BaseClient {
         return this.fetch(`/threads/${threadId}/runs/${runId}`);
     }
     /**
-     * List all events for a run.
+     * Cancel a run.
      *
      * @param threadId The ID of the thread.
      * @param runId The ID of the run.
-     * @param options Filtering and pagination options.
-     * @returns List of events.
+     * @param wait Whether to block when canceling
+     * @returns
      */
-    async listEvents(threadId, runId, options) {
-        return this.fetch(`/threads/${threadId}/runs/${runId}/events`, {
+    async cancel(threadId, runId, wait = false) {
+        return this.fetch(`/threads/${threadId}/runs/${runId}/cancel`, {
+            method: "POST",
             params: {
-                limit: options?.limit ?? 10,
-                offset: options?.offset ?? 0,
+                wait: wait ? "1" : "0",
             },
         });
     }
+    /**
+     * Block until a run is done.
+     *
+     * @param threadId The ID of the thread.
+     * @param runId The ID of the run.
+     * @returns
+     */
+    async join(threadId, runId) {
+        return this.fetch(`/threads/${threadId}/runs/${runId}/join`);
+    }
+    /**
+     * Delete a run.
+     *
+     * @param threadId The ID of the thread.
+     * @param runId The ID of the run.
+     * @returns
+     */
+    async delete(threadId, runId) {
+        return this.fetch(`/threads/${threadId}/runs/${runId}`, {
+            method: "DELETE",
+        });
+    }
 }
 export class Client {
     constructor(config) {
@@ -431,8 +554,18 @@ export class Client {
             writable: true,
             value: void 0
         });
+        /**
+         * The client for interacting with cron runs.
+         */
+        Object.defineProperty(this, "crons", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.assistants = new AssistantsClient(config);
         this.threads = new ThreadsClient(config);
         this.runs = new RunsClient(config);
+        this.crons = new CronsClient(config);
     }
 }

package/dist/index.d.mts

@@ -1,2 +1,2 @@
 export { Client } from "./client.mjs";
-export type { Assistant, AssistantGraph, Config, DefaultValues, GraphSchema, Metadata, Run, RunEvent, Thread, ThreadState, } from "./schema.js";
+export type { Assistant, AssistantGraph, Config, DefaultValues, GraphSchema, Metadata, Run, Thread, ThreadState, Cron, } from "./schema.js";

package/dist/schema.d.ts

@@ -56,14 +56,23 @@ export interface Thread {
     updated_at: string;
     metadata: Metadata;
 }
+export interface Cron {
+    cron_id: string;
+    thread_id: Optional<string>;
+    end_time: Optional<string>;
+    schedule: string;
+    created_at: string;
+    updated_at: string;
+    payload: Record<string, unknown>;
+}
 export type DefaultValues = Record<string, unknown>[] | Record<string, unknown>;
 export interface ThreadState<ValuesType = DefaultValues> {
     values: ValuesType;
     next: string[];
-    config: Config;
+    checkpoint_id: string;
     metadata: Metadata;
     created_at: Optional<string>;
-    parent_config: Optional<Config>;
+    parent_checkpoint_id: Optional<string>;
 }
 export interface Run {
     run_id: string;
@@ -74,15 +83,4 @@ export interface Run {
     status: "pending" | "running" | "error" | "success" | "timeout" | "interrupted";
     metadata: Metadata;
 }
-export interface RunEvent {
-    event_id: string;
-    run_id: string;
-    received_at: string;
-    span_id: string;
-    event: string;
-    name: string;
-    data: Record<string, unknown>;
-    metadata: Record<string, unknown>;
-    tags: string[];
-}
 export {};

package/dist/types.d.mts

@@ -1,5 +1,7 @@
 import { Config, Metadata } from "./schema.js";
 export type StreamMode = "values" | "messages" | "updates" | "events" | "debug";
+export type MultitaskStrategy = "reject" | "interrupt" | "rollback" | "enqueue";
+export type StreamEvent = "events" | "metadata" | "debug" | "updates" | "values" | "messages/partial" | "messages/metadata" | "messages/complete" | (string & {});
 interface RunsInvokePayload {
     /**
      * Input to the run. Pass `null` to resume from the current state of the thread.
@@ -21,6 +23,17 @@ interface RunsInvokePayload {
      * Interrupt execution after leaving these nodes.
      */
     interruptAfter?: string[];
+    /**
+     * Strategy to handle concurrent runs on the same thread. Only relevant if
+     * there is a pending/inflight run on the same thread. One of:
+     * - "reject": Reject the new run.
+     * - "interrupt": Interrupt the current run, keeping steps completed until now,
+         and start a new one.
+     * - "rollback": Cancel and delete the existing run, rolling back the thread to
+        the state before it had started, then start the new run.
+     * - "enqueue": Queue up the new run to start after the current run finishes.
+     */
+    multitaskStrategy?: MultitaskStrategy;
     /**
      * Abort controller signal to cancel the run.
      */
@@ -49,5 +62,11 @@ export interface RunsCreatePayload extends RunsInvokePayload {
      */
     webhook?: string;
 }
+export interface CronsCreatePayload extends RunsCreatePayload {
+    /**
+     * Schedule for running the Cron Job
+     */
+    schedule: string;
+}
 export type RunsWaitPayload = RunsStreamPayload;
 export {};

package/dist/utils/async_caller.d.mts

@@ -11,6 +11,12 @@ export interface AsyncCallerParams {
      */
     maxRetries?: number;
     onFailedResponseHook?: ResponseCallback;
+    /**
+     * Specify a custom fetch implementation.
+     *
+     * By default we expect the `fetch` is available in the global scope.
+     */
+    fetch?: typeof fetch;
 }
 export interface AsyncCallerCallOptions {
     signal?: AbortSignal;
@@ -33,6 +39,7 @@ export declare class AsyncCaller {
     protected maxRetries: AsyncCallerParams["maxRetries"];
     private queue;
     private onFailedResponseHook?;
+    private customFetch?;
     constructor(params: AsyncCallerParams);
     call<A extends any[], T extends (...args: A) => Promise<any>>(callable: T, ...args: Parameters<T>): Promise<Awaited<ReturnType<T>>>;
     callWithOptions<A extends any[], T extends (...args: A) => Promise<any>>(options: AsyncCallerCallOptions, callable: T, ...args: Parameters<T>): Promise<Awaited<ReturnType<T>>>;

package/dist/utils/async_caller.mjs

@@ -99,6 +99,12 @@ export class AsyncCaller {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "customFetch", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.maxConcurrency = params.maxConcurrency ?? Infinity;
         this.maxRetries = params.maxRetries ?? 4;
         if ("default" in PQueueMod) {
@@ -112,6 +118,7 @@ export class AsyncCaller {
             this.queue = new PQueueMod({ concurrency: this.maxConcurrency });
         }
         this.onFailedResponseHook = params?.onFailedResponseHook;
+        this.customFetch = params.fetch;
     }
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     call(callable, ...args) {
@@ -175,6 +182,7 @@ export class AsyncCaller {
         return this.call(callable, ...args);
     }
     fetch(...args) {
-        return this.call(() => fetch(...args).then((res) => (res.ok ? res : Promise.reject(res))));
+        const fetchFn = this.customFetch ?? fetch;
+        return this.call(() => fetchFn(...args).then((res) => (res.ok ? res : Promise.reject(res))));
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/langgraph-sdk",
-  "version": "0.0.1-rc.8",
+  "version": "0.0.1",
   "description": "Client library for interacting with the LangGraph API",
   "type": "module",
   "packageManager": "yarn@1.22.19",
@@ -26,7 +26,10 @@
     "@tsconfig/recommended": "^1.0.2",
     "@types/node": "^20.12.12",
     "@types/uuid": "^9.0.1",
+    "concat-md": "^0.5.1",
     "prettier": "^3.2.5",
+    "typedoc": "^0.26.1",
+    "typedoc-plugin-markdown": "^4.1.0",
     "typescript": "^5.4.5"
   },
   "exports": {