@langchain/langgraph-sdk 0.0.1-rc.12 → 0.0.1-rc.14

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/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.12",
+  "version": "0.0.1-rc.14",
   "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": {