@langchain/langgraph-sdk 0.0.13 → 0.0.14-rc.0

package/dist/client.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Client = exports.RunsClient = exports.ThreadsClient = exports.AssistantsClient = exports.CronsClient = void 0;
+exports.Client = exports.StoreClient = exports.RunsClient = exports.ThreadsClient = exports.AssistantsClient = exports.CronsClient = void 0;
 const async_caller_js_1 = require("./utils/async_caller.cjs");
 const index_js_1 = require("./utils/eventsource-parser/index.cjs");
 const stream_js_1 = require("./utils/stream.cjs");
@@ -165,6 +165,7 @@ class AssistantsClient extends BaseClient {
     /**
      * Get the JSON representation of the graph assigned to a runnable
      * @param assistantId The ID of the assistant.
+     * @param options.xray Whether to include subgraphs in the serialized graph representation. If an integer value is provided, only subgraphs with a depth less than or equal to the value will be included.
      * @returns Serialized graph
      */
     async getGraph(assistantId, options) {
@@ -690,6 +691,124 @@ class RunsClient extends BaseClient {
     }
 }
 exports.RunsClient = RunsClient;
+class StoreClient extends BaseClient {
+    /**
+     * Store or update an item.
+     *
+     * @param namespace A list of strings representing the namespace path.
+     * @param key The unique identifier for the item within the namespace.
+     * @param value A dictionary containing the item's data.
+     * @returns Promise<void>
+     */
+    async putItem(namespace, key, value) {
+        namespace.forEach((label) => {
+            if (label.includes(".")) {
+                throw new Error(`Invalid namespace label '${label}'. Namespace labels cannot contain periods ('.')`);
+            }
+        });
+        const payload = {
+            namespace,
+            key,
+            value,
+        };
+        return this.fetch("/store/items", {
+            method: "PUT",
+            json: payload,
+        });
+    }
+    /**
+     * Retrieve a single item.
+     *
+     * @param namespace A list of strings representing the namespace path.
+     * @param key The unique identifier for the item.
+     * @returns Promise<Item>
+     */
+    async getItem(namespace, key) {
+        namespace.forEach((label) => {
+            if (label.includes(".")) {
+                throw new Error(`Invalid namespace label '${label}'. Namespace labels cannot contain periods ('.')`);
+            }
+        });
+        const response = await this.fetch("/store/items", {
+            params: { namespace: namespace.join("."), key },
+        });
+        return {
+            ...response,
+            createdAt: response.created_at,
+            updatedAt: response.updated_at,
+        };
+    }
+    /**
+     * Delete an item.
+     *
+     * @param namespace A list of strings representing the namespace path.
+     * @param key The unique identifier for the item.
+     * @returns Promise<void>
+     */
+    async deleteItem(namespace, key) {
+        namespace.forEach((label) => {
+            if (label.includes(".")) {
+                throw new Error(`Invalid namespace label '${label}'. Namespace labels cannot contain periods ('.')`);
+            }
+        });
+        return this.fetch("/store/items", {
+            method: "DELETE",
+            json: { namespace, key },
+        });
+    }
+    /**
+     * Search for items within a namespace prefix.
+     *
+     * @param namespacePrefix List of strings representing the namespace prefix.
+     * @param options.filter Optional dictionary of key-value pairs to filter results.
+     * @param options.limit Maximum number of items to return (default is 10).
+     * @param options.offset Number of items to skip before returning results (default is 0).
+     * @returns Promise<SearchItemsResponse>
+     */
+    async searchItems(namespacePrefix, options) {
+        const payload = {
+            namespace_prefix: namespacePrefix,
+            filter: options?.filter,
+            limit: options?.limit ?? 10,
+            offset: options?.offset ?? 0,
+        };
+        const response = await this.fetch("/store/items/search", {
+            method: "POST",
+            json: payload,
+        });
+        return {
+            items: response.items.map((item) => ({
+                ...item,
+                createdAt: item.created_at,
+                updatedAt: item.updated_at,
+            })),
+        };
+    }
+    /**
+     * List namespaces with optional match conditions.
+     *
+     * @param options.prefix Optional list of strings representing the prefix to filter namespaces.
+     * @param options.suffix Optional list of strings representing the suffix to filter namespaces.
+     * @param options.maxDepth Optional integer specifying the maximum depth of namespaces to return.
+     * @param options.limit Maximum number of namespaces to return (default is 100).
+     * @param options.offset Number of namespaces to skip before returning results (default is 0).
+     * @returns Promise<ListNamespaceResponse>
+     */
+    async listNamespaces(options) {
+        const payload = {
+            prefix: options?.prefix,
+            suffix: options?.suffix,
+            max_depth: options?.maxDepth,
+            limit: options?.limit ?? 100,
+            offset: options?.offset ?? 0,
+        };
+        return this.fetch("/store/namespaces", {
+            method: "POST",
+            json: payload,
+        });
+    }
+}
+exports.StoreClient = StoreClient;
 class Client {
     constructor(config) {
         /**
@@ -728,10 +847,20 @@ class Client {
             writable: true,
             value: void 0
         });
+        /**
+         * The client for interacting with the KV store.
+         */
+        Object.defineProperty(this, "store", {
+            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);
+        this.store = new StoreClient(config);
     }
 }
 exports.Client = Client;

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import { Assistant, AssistantGraph, Config, DefaultValues, GraphSchema, Metadata, Run, Thread, ThreadState, Cron, AssistantVersion, Subgraphs, Checkpoint } from "./schema.js";
+import { Assistant, AssistantGraph, Config, DefaultValues, GraphSchema, Metadata, Run, Thread, ThreadState, Cron, AssistantVersion, Subgraphs, Checkpoint, SearchItemsResponse, ListNamespaceResponse, Item } from "./schema.js";
 import { AsyncCaller, AsyncCallerParams } from "./utils/async_caller.js";
 import { RunsCreatePayload, RunsStreamPayload, RunsWaitPayload, StreamEvent, CronsCreatePayload, OnConflictBehavior } from "./types.js";
 interface ClientConfig {
@@ -67,10 +67,11 @@ export declare class AssistantsClient extends BaseClient {
     /**
      * Get the JSON representation of the graph assigned to a runnable
      * @param assistantId The ID of the assistant.
+     * @param options.xray Whether to include subgraphs in the serialized graph representation. If an integer value is provided, only subgraphs with a depth less than or equal to the value will be included.
      * @returns Serialized graph
      */
     getGraph(assistantId: string, options?: {
-        xray?: boolean;
+        xray?: boolean | number;
     }): Promise<AssistantGraph>;
     /**
      * Get the state and config schema of the graph assigned to a runnable
@@ -356,6 +357,64 @@ export declare class RunsClient extends BaseClient {
      */
     delete(threadId: string, runId: string): Promise<void>;
 }
+export declare class StoreClient extends BaseClient {
+    /**
+     * Store or update an item.
+     *
+     * @param namespace A list of strings representing the namespace path.
+     * @param key The unique identifier for the item within the namespace.
+     * @param value A dictionary containing the item's data.
+     * @returns Promise<void>
+     */
+    putItem(namespace: string[], key: string, value: Record<string, any>): Promise<void>;
+    /**
+     * Retrieve a single item.
+     *
+     * @param namespace A list of strings representing the namespace path.
+     * @param key The unique identifier for the item.
+     * @returns Promise<Item>
+     */
+    getItem(namespace: string[], key: string): Promise<Item | null>;
+    /**
+     * Delete an item.
+     *
+     * @param namespace A list of strings representing the namespace path.
+     * @param key The unique identifier for the item.
+     * @returns Promise<void>
+     */
+    deleteItem(namespace: string[], key: string): Promise<void>;
+    /**
+     * Search for items within a namespace prefix.
+     *
+     * @param namespacePrefix List of strings representing the namespace prefix.
+     * @param options.filter Optional dictionary of key-value pairs to filter results.
+     * @param options.limit Maximum number of items to return (default is 10).
+     * @param options.offset Number of items to skip before returning results (default is 0).
+     * @returns Promise<SearchItemsResponse>
+     */
+    searchItems(namespacePrefix: string[], options?: {
+        filter?: Record<string, any>;
+        limit?: number;
+        offset?: number;
+    }): Promise<SearchItemsResponse>;
+    /**
+     * List namespaces with optional match conditions.
+     *
+     * @param options.prefix Optional list of strings representing the prefix to filter namespaces.
+     * @param options.suffix Optional list of strings representing the suffix to filter namespaces.
+     * @param options.maxDepth Optional integer specifying the maximum depth of namespaces to return.
+     * @param options.limit Maximum number of namespaces to return (default is 100).
+     * @param options.offset Number of namespaces to skip before returning results (default is 0).
+     * @returns Promise<ListNamespaceResponse>
+     */
+    listNamespaces(options?: {
+        prefix?: string[];
+        suffix?: string[];
+        maxDepth?: number;
+        limit?: number;
+        offset?: number;
+    }): Promise<ListNamespaceResponse>;
+}
 export declare class Client {
     /**
      * The client for interacting with assistants.
@@ -373,6 +432,10 @@ export declare class Client {
      * The client for interacting with cron runs.
      */
     crons: CronsClient;
+    /**
+     * The client for interacting with the KV store.
+     */
+    store: StoreClient;
     constructor(config?: ClientConfig);
 }
 export {};

package/dist/client.js

@@ -161,6 +161,7 @@ export class AssistantsClient extends BaseClient {
     /**
      * Get the JSON representation of the graph assigned to a runnable
      * @param assistantId The ID of the assistant.
+     * @param options.xray Whether to include subgraphs in the serialized graph representation. If an integer value is provided, only subgraphs with a depth less than or equal to the value will be included.
      * @returns Serialized graph
      */
     async getGraph(assistantId, options) {
@@ -683,6 +684,123 @@ export class RunsClient extends BaseClient {
         });
     }
 }
+export class StoreClient extends BaseClient {
+    /**
+     * Store or update an item.
+     *
+     * @param namespace A list of strings representing the namespace path.
+     * @param key The unique identifier for the item within the namespace.
+     * @param value A dictionary containing the item's data.
+     * @returns Promise<void>
+     */
+    async putItem(namespace, key, value) {
+        namespace.forEach((label) => {
+            if (label.includes(".")) {
+                throw new Error(`Invalid namespace label '${label}'. Namespace labels cannot contain periods ('.')`);
+            }
+        });
+        const payload = {
+            namespace,
+            key,
+            value,
+        };
+        return this.fetch("/store/items", {
+            method: "PUT",
+            json: payload,
+        });
+    }
+    /**
+     * Retrieve a single item.
+     *
+     * @param namespace A list of strings representing the namespace path.
+     * @param key The unique identifier for the item.
+     * @returns Promise<Item>
+     */
+    async getItem(namespace, key) {
+        namespace.forEach((label) => {
+            if (label.includes(".")) {
+                throw new Error(`Invalid namespace label '${label}'. Namespace labels cannot contain periods ('.')`);
+            }
+        });
+        const response = await this.fetch("/store/items", {
+            params: { namespace: namespace.join("."), key },
+        });
+        return {
+            ...response,
+            createdAt: response.created_at,
+            updatedAt: response.updated_at,
+        };
+    }
+    /**
+     * Delete an item.
+     *
+     * @param namespace A list of strings representing the namespace path.
+     * @param key The unique identifier for the item.
+     * @returns Promise<void>
+     */
+    async deleteItem(namespace, key) {
+        namespace.forEach((label) => {
+            if (label.includes(".")) {
+                throw new Error(`Invalid namespace label '${label}'. Namespace labels cannot contain periods ('.')`);
+            }
+        });
+        return this.fetch("/store/items", {
+            method: "DELETE",
+            json: { namespace, key },
+        });
+    }
+    /**
+     * Search for items within a namespace prefix.
+     *
+     * @param namespacePrefix List of strings representing the namespace prefix.
+     * @param options.filter Optional dictionary of key-value pairs to filter results.
+     * @param options.limit Maximum number of items to return (default is 10).
+     * @param options.offset Number of items to skip before returning results (default is 0).
+     * @returns Promise<SearchItemsResponse>
+     */
+    async searchItems(namespacePrefix, options) {
+        const payload = {
+            namespace_prefix: namespacePrefix,
+            filter: options?.filter,
+            limit: options?.limit ?? 10,
+            offset: options?.offset ?? 0,
+        };
+        const response = await this.fetch("/store/items/search", {
+            method: "POST",
+            json: payload,
+        });
+        return {
+            items: response.items.map((item) => ({
+                ...item,
+                createdAt: item.created_at,
+                updatedAt: item.updated_at,
+            })),
+        };
+    }
+    /**
+     * List namespaces with optional match conditions.
+     *
+     * @param options.prefix Optional list of strings representing the prefix to filter namespaces.
+     * @param options.suffix Optional list of strings representing the suffix to filter namespaces.
+     * @param options.maxDepth Optional integer specifying the maximum depth of namespaces to return.
+     * @param options.limit Maximum number of namespaces to return (default is 100).
+     * @param options.offset Number of namespaces to skip before returning results (default is 0).
+     * @returns Promise<ListNamespaceResponse>
+     */
+    async listNamespaces(options) {
+        const payload = {
+            prefix: options?.prefix,
+            suffix: options?.suffix,
+            max_depth: options?.maxDepth,
+            limit: options?.limit ?? 100,
+            offset: options?.offset ?? 0,
+        };
+        return this.fetch("/store/namespaces", {
+            method: "POST",
+            json: payload,
+        });
+    }
+}
 export class Client {
     constructor(config) {
         /**
@@ -721,9 +839,19 @@ export class Client {
             writable: true,
             value: void 0
         });
+        /**
+         * The client for interacting with the KV store.
+         */
+        Object.defineProperty(this, "store", {
+            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);
+        this.store = new StoreClient(config);
     }
 }

package/dist/schema.d.ts

@@ -159,4 +159,17 @@ export interface Checkpoint {
     checkpoint_id: Optional<string>;
     checkpoint_map: Optional<Record<string, unknown>>;
 }
+export interface ListNamespaceResponse {
+    namespaces: string[][];
+}
+export interface SearchItemsResponse {
+    items: Item[];
+}
+export interface Item {
+    namespace: string[];
+    key: string;
+    value: Record<string, any>;
+    createdAt: string;
+    updatedAt: string;
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/langgraph-sdk",
-  "version": "0.0.13",
+  "version": "0.0.14-rc.0",
   "description": "Client library for interacting with the LangGraph API",
   "type": "module",
   "packageManager": "yarn@1.22.19",