@langchain/langgraph-sdk 0.0.47 → 0.0.49

package/dist/client.cjs

@@ -726,9 +726,21 @@ class StoreClient extends BaseClient {
      * @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.
+     * @param options.index Controls search indexing - null (use defaults), false (disable), or list of field paths to index.
+     * @param options.ttl Optional time-to-live in minutes for the item, or null for no expiration.
      * @returns Promise<void>
-     */
-    async putItem(namespace, key, value) {
+     *
+     * @example
+     * ```typescript
+     * await client.store.putItem(
+     *   ["documents", "user123"],
+     *   "item456",
+     *   { title: "My Document", content: "Hello World" },
+     *   { ttl: 60 } // expires in 60 minutes
+     * );
+     * ```
+     */
+    async putItem(namespace, key, value, options) {
         namespace.forEach((label) => {
             if (label.includes(".")) {
                 throw new Error(`Invalid namespace label '${label}'. Namespace labels cannot contain periods ('.')`);
@@ -738,6 +750,8 @@ class StoreClient extends BaseClient {
             namespace,
             key,
             value,
+            index: options?.index,
+            ttl: options?.ttl,
         };
         return this.fetch("/store/items", {
             method: "PUT",
@@ -749,16 +763,41 @@ class StoreClient extends BaseClient {
      *
      * @param namespace A list of strings representing the namespace path.
      * @param key The unique identifier for the item.
+     * @param options.refreshTtl Whether to refresh the TTL on this read operation. If null, uses the store's default behavior.
      * @returns Promise<Item>
-     */
-    async getItem(namespace, key) {
+     *
+     * @example
+     * ```typescript
+     * const item = await client.store.getItem(
+     *   ["documents", "user123"],
+     *   "item456",
+     *   { refreshTtl: true }
+     * );
+     * console.log(item);
+     * // {
+     * //   namespace: ["documents", "user123"],
+     * //   key: "item456",
+     * //   value: { title: "My Document", content: "Hello World" },
+     * //   createdAt: "2024-07-30T12:00:00Z",
+     * //   updatedAt: "2024-07-30T12:00:00Z"
+     * // }
+     * ```
+     */
+    async getItem(namespace, key, options) {
         namespace.forEach((label) => {
             if (label.includes(".")) {
                 throw new Error(`Invalid namespace label '${label}'. Namespace labels cannot contain periods ('.')`);
             }
         });
+        const params = {
+            namespace: namespace.join("."),
+            key,
+        };
+        if (options?.refreshTtl !== undefined) {
+            params.refresh_ttl = options.refreshTtl;
+        }
         const response = await this.fetch("/store/items", {
-            params: { namespace: namespace.join("."), key },
+            params,
         });
         return response
             ? {
@@ -794,7 +833,33 @@ class StoreClient extends BaseClient {
      * @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).
      * @param options.query Optional search query.
+     * @param options.refreshTtl Whether to refresh the TTL on items returned by this search. If null, uses the store's default behavior.
      * @returns Promise<SearchItemsResponse>
+     *
+     * @example
+     * ```typescript
+     * const results = await client.store.searchItems(
+     *   ["documents"],
+     *   {
+     *     filter: { author: "John Doe" },
+     *     limit: 5,
+     *     refreshTtl: true
+     *   }
+     * );
+     * console.log(results);
+     * // {
+     * //   items: [
+     * //     {
+     * //       namespace: ["documents", "user123"],
+     * //       key: "item789",
+     * //       value: { title: "Another Document", author: "John Doe" },
+     * //       createdAt: "2024-07-30T12:00:00Z",
+     * //       updatedAt: "2024-07-30T12:00:00Z"
+     * //     },
+     * //     // ... additional items ...
+     * //   ]
+     * // }
+     * ```
      */
     async searchItems(namespacePrefix, options) {
         const payload = {
@@ -803,6 +868,7 @@ class StoreClient extends BaseClient {
             limit: options?.limit ?? 10,
             offset: options?.offset ?? 0,
             query: options?.query,
+            refresh_ttl: options?.refreshTtl,
         };
         const response = await this.fetch("/store/items/search", {
             method: "POST",

package/dist/client.d.ts

@@ -389,17 +389,52 @@ export declare class StoreClient extends BaseClient {
      * @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.
+     * @param options.index Controls search indexing - null (use defaults), false (disable), or list of field paths to index.
+     * @param options.ttl Optional time-to-live in minutes for the item, or null for no expiration.
      * @returns Promise<void>
-     */
-    putItem(namespace: string[], key: string, value: Record<string, any>): Promise<void>;
+     *
+     * @example
+     * ```typescript
+     * await client.store.putItem(
+     *   ["documents", "user123"],
+     *   "item456",
+     *   { title: "My Document", content: "Hello World" },
+     *   { ttl: 60 } // expires in 60 minutes
+     * );
+     * ```
+     */
+    putItem(namespace: string[], key: string, value: Record<string, any>, options?: {
+        index?: false | string[] | null;
+        ttl?: number | null;
+    }): Promise<void>;
     /**
      * Retrieve a single item.
      *
      * @param namespace A list of strings representing the namespace path.
      * @param key The unique identifier for the item.
+     * @param options.refreshTtl Whether to refresh the TTL on this read operation. If null, uses the store's default behavior.
      * @returns Promise<Item>
-     */
-    getItem(namespace: string[], key: string): Promise<Item | null>;
+     *
+     * @example
+     * ```typescript
+     * const item = await client.store.getItem(
+     *   ["documents", "user123"],
+     *   "item456",
+     *   { refreshTtl: true }
+     * );
+     * console.log(item);
+     * // {
+     * //   namespace: ["documents", "user123"],
+     * //   key: "item456",
+     * //   value: { title: "My Document", content: "Hello World" },
+     * //   createdAt: "2024-07-30T12:00:00Z",
+     * //   updatedAt: "2024-07-30T12:00:00Z"
+     * // }
+     * ```
+     */
+    getItem(namespace: string[], key: string, options?: {
+        refreshTtl?: boolean | null;
+    }): Promise<Item | null>;
     /**
      * Delete an item.
      *
@@ -416,13 +451,40 @@ export declare class StoreClient extends BaseClient {
      * @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).
      * @param options.query Optional search query.
+     * @param options.refreshTtl Whether to refresh the TTL on items returned by this search. If null, uses the store's default behavior.
      * @returns Promise<SearchItemsResponse>
+     *
+     * @example
+     * ```typescript
+     * const results = await client.store.searchItems(
+     *   ["documents"],
+     *   {
+     *     filter: { author: "John Doe" },
+     *     limit: 5,
+     *     refreshTtl: true
+     *   }
+     * );
+     * console.log(results);
+     * // {
+     * //   items: [
+     * //     {
+     * //       namespace: ["documents", "user123"],
+     * //       key: "item789",
+     * //       value: { title: "Another Document", author: "John Doe" },
+     * //       createdAt: "2024-07-30T12:00:00Z",
+     * //       updatedAt: "2024-07-30T12:00:00Z"
+     * //     },
+     * //     // ... additional items ...
+     * //   ]
+     * // }
+     * ```
      */
     searchItems(namespacePrefix: string[], options?: {
         filter?: Record<string, any>;
         limit?: number;
         offset?: number;
         query?: string;
+        refreshTtl?: boolean | null;
     }): Promise<SearchItemsResponse>;
     /**
      * List namespaces with optional match conditions.

package/dist/client.js

@@ -718,9 +718,21 @@ export class StoreClient extends BaseClient {
      * @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.
+     * @param options.index Controls search indexing - null (use defaults), false (disable), or list of field paths to index.
+     * @param options.ttl Optional time-to-live in minutes for the item, or null for no expiration.
      * @returns Promise<void>
-     */
-    async putItem(namespace, key, value) {
+     *
+     * @example
+     * ```typescript
+     * await client.store.putItem(
+     *   ["documents", "user123"],
+     *   "item456",
+     *   { title: "My Document", content: "Hello World" },
+     *   { ttl: 60 } // expires in 60 minutes
+     * );
+     * ```
+     */
+    async putItem(namespace, key, value, options) {
         namespace.forEach((label) => {
             if (label.includes(".")) {
                 throw new Error(`Invalid namespace label '${label}'. Namespace labels cannot contain periods ('.')`);
@@ -730,6 +742,8 @@ export class StoreClient extends BaseClient {
             namespace,
             key,
             value,
+            index: options?.index,
+            ttl: options?.ttl,
         };
         return this.fetch("/store/items", {
             method: "PUT",
@@ -741,16 +755,41 @@ export class StoreClient extends BaseClient {
      *
      * @param namespace A list of strings representing the namespace path.
      * @param key The unique identifier for the item.
+     * @param options.refreshTtl Whether to refresh the TTL on this read operation. If null, uses the store's default behavior.
      * @returns Promise<Item>
-     */
-    async getItem(namespace, key) {
+     *
+     * @example
+     * ```typescript
+     * const item = await client.store.getItem(
+     *   ["documents", "user123"],
+     *   "item456",
+     *   { refreshTtl: true }
+     * );
+     * console.log(item);
+     * // {
+     * //   namespace: ["documents", "user123"],
+     * //   key: "item456",
+     * //   value: { title: "My Document", content: "Hello World" },
+     * //   createdAt: "2024-07-30T12:00:00Z",
+     * //   updatedAt: "2024-07-30T12:00:00Z"
+     * // }
+     * ```
+     */
+    async getItem(namespace, key, options) {
         namespace.forEach((label) => {
             if (label.includes(".")) {
                 throw new Error(`Invalid namespace label '${label}'. Namespace labels cannot contain periods ('.')`);
             }
         });
+        const params = {
+            namespace: namespace.join("."),
+            key,
+        };
+        if (options?.refreshTtl !== undefined) {
+            params.refresh_ttl = options.refreshTtl;
+        }
         const response = await this.fetch("/store/items", {
-            params: { namespace: namespace.join("."), key },
+            params,
         });
         return response
             ? {
@@ -786,7 +825,33 @@ export class StoreClient extends BaseClient {
      * @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).
      * @param options.query Optional search query.
+     * @param options.refreshTtl Whether to refresh the TTL on items returned by this search. If null, uses the store's default behavior.
      * @returns Promise<SearchItemsResponse>
+     *
+     * @example
+     * ```typescript
+     * const results = await client.store.searchItems(
+     *   ["documents"],
+     *   {
+     *     filter: { author: "John Doe" },
+     *     limit: 5,
+     *     refreshTtl: true
+     *   }
+     * );
+     * console.log(results);
+     * // {
+     * //   items: [
+     * //     {
+     * //       namespace: ["documents", "user123"],
+     * //       key: "item789",
+     * //       value: { title: "Another Document", author: "John Doe" },
+     * //       createdAt: "2024-07-30T12:00:00Z",
+     * //       updatedAt: "2024-07-30T12:00:00Z"
+     * //     },
+     * //     // ... additional items ...
+     * //   ]
+     * // }
+     * ```
      */
     async searchItems(namespacePrefix, options) {
         const payload = {
@@ -795,6 +860,7 @@ export class StoreClient extends BaseClient {
             limit: options?.limit ?? 10,
             offset: options?.offset ?? 0,
             query: options?.query,
+            refresh_ttl: options?.refreshTtl,
         };
         const response = await this.fetch("/store/items/search", {
             method: "POST",

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { Client } from "./client.js";
-export type { Assistant, AssistantVersion, AssistantGraph, Config, DefaultValues, GraphSchema, Metadata, Run, Thread, ThreadTask, ThreadState, ThreadStatus, Cron, Checkpoint, Interrupt, ListNamespaceResponse, Item, SearchItem, SearchItemsResponse, CronCreateResponse, CronCreateForThreadResponse, } from "./schema.js";
+export type { AssistantBase, Assistant, AssistantVersion, AssistantGraph, Config, DefaultValues, GraphSchema, Metadata, Run, Thread, ThreadTask, ThreadState, ThreadStatus, Cron, Checkpoint, Interrupt, ListNamespaceResponse, Item, SearchItem, SearchItemsResponse, CronCreateResponse, CronCreateForThreadResponse, } from "./schema.js";
 export { overrideFetchImplementation } from "./singletons/fetch.js";
 export type { OnConflictBehavior, Command } from "./types.js";
 export type { StreamMode } from "./types.stream.js";

package/dist/schema.d.ts

@@ -77,14 +77,14 @@ export interface AssistantBase {
     metadata: Metadata;
     /** The version of the assistant. */
     version: number;
+    /** The name of the assistant */
+    name: string;
 }
 export interface AssistantVersion extends AssistantBase {
 }
 export interface Assistant extends AssistantBase {
     /** The last time the assistant was updated. */
     updated_at: string;
-    /** The name of the assistant */
-    name: string;
 }
 export interface AssistantGraph {
     nodes: Array<{

package/package.json

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