@langgraph-js/pure-graph 1.0.0

package/src/queue/stream_queue.ts

@@ -0,0 +1,236 @@
+import { EventEmitter } from 'eventemitter3';
+import { JsonPlusSerializer } from './JsonPlusSerializer.js';
+import { EventMessage } from './event_message.js';
+
+/**
+ * 流队列事件接口
+ * Stream queue events interface
+ */
+interface StreamQueueEvents<T extends EventMessage> {
+    /** 数据事件：当有新数据时触发 / Data event: triggered when new data arrives */
+    data: (data: T) => void;
+    /** 其他事件 / Other events */
+    [key: string]: ((...args: any[]) => void) | undefined;
+}
+
+/**
+ * 基础流队列类
+ * Base stream queue class
+ */
+export class BaseStreamQueue extends EventEmitter<StreamQueueEvents<EventMessage>> {
+    /** 序列化器实例 / Serializer instance */
+    serializer = new JsonPlusSerializer();
+
+    /**
+     * 构造函数
+     * Constructor
+     * @param compressMessages 是否压缩消息 / Whether to compress messages
+     */
+    constructor(readonly compressMessages: boolean = true) {
+        super();
+    }
+
+    /**
+     * 编码数据为 Uint8Array
+     * Encode data to Uint8Array
+     * @param message 要编码的消息 / Message to encode
+     * @returns 编码后的 Uint8Array / Encoded Uint8Array
+     */
+    async encodeData(message: EventMessage): Promise<Uint8Array> {
+        const [_, serializedMessage] = await this.serializer.dumpsTyped(message);
+        return serializedMessage;
+    }
+
+    /**
+     * 解码数据为 EventMessage
+     * Decode data to EventMessage
+     * @param serializedMessage 要解码的消息 / Message to decode
+     * @returns 解码后的 EventMessage / Decoded EventMessage
+     */
+    async decodeData(serializedMessage: string | Uint8Array): Promise<EventMessage> {
+        const message = (await this.serializer.loadsTyped('json', serializedMessage)) as EventMessage;
+        return message;
+    }
+}
+
+/**
+ * 基础流队列接口
+ * Base stream queue interface
+ */
+export interface BaseStreamQueueInterface {
+    /** 是否压缩消息 / Whether to compress messages */
+    compressMessages: boolean;
+    /**
+     * 推送数据项到队列
+     * Push item to queue
+     * @param item 要推送的数据项 / Item to push
+     */
+    push(item: EventMessage): Promise<void>;
+    /** 获取所有数据 / Get all data */
+    getAll(): Promise<EventMessage[]>;
+    /** 清空队列 / Clear queue */
+    clear(): void;
+    /**
+     * 监听数据变化
+     * Listen for data changes
+     * @param listener 数据变化监听器 / Data change listener
+     * @returns 取消监听函数 / Unsubscribe function
+     */
+    onDataChange(listener: (data: EventMessage) => void): () => void;
+    /** 取消信号控制器 / Cancel signal controller */
+    cancelSignal: AbortController;
+    /** 取消操作 / Cancel operation */
+    cancel(): void;
+}
+
+/**
+ * StreamQueue 管理器，通过 id 管理多个队列实例
+ * StreamQueue manager, manages multiple queue instances by id
+ */
+export class StreamQueueManager<Q extends BaseStreamQueueInterface> {
+    /** 存储队列实例的 Map / Map storing queue instances */
+    private queues: Map<string, Q> = new Map();
+    /** 默认是否压缩消息 / Default compress messages setting */
+    private defaultCompressMessages: boolean;
+    /** 队列构造函数 / Queue constructor */
+    private queueConstructor: new (compressMessages: boolean) => Q;
+
+    /**
+     * 构造函数
+     * Constructor
+     * @param queueConstructor 队列构造函数 / Queue constructor
+     * @param options 配置选项 / Configuration options
+     */
+    constructor(
+        queueConstructor: new (compressMessages: boolean) => Q,
+        options: {
+            /** 默认是否压缩消息 / Default compress messages setting */
+            defaultCompressMessages?: boolean;
+        } = {},
+    ) {
+        this.defaultCompressMessages = options.defaultCompressMessages ?? true;
+        this.queueConstructor = queueConstructor;
+    }
+
+    /**
+     * 创建指定 id 的队列
+     * Create queue with specified id
+     * @param id 队列 ID / Queue ID
+     * @param compressMessages 是否压缩消息 / Whether to compress messages
+     * @returns 创建的队列实例 / Created queue instance
+     */
+    createQueue(id: string, compressMessages?: boolean): Q {
+        const compress = compressMessages ?? this.defaultCompressMessages;
+        this.queues.set(id, new this.queueConstructor(compress));
+        return this.queues.get(id)!;
+    }
+
+    /**
+     * 获取或创建指定 id 的队列
+     * Get or create queue with specified id
+     * @param id 队列 ID / Queue ID
+     * @param compressMessages 是否压缩消息，默认为构造函数中的默认值 / Whether to compress messages, defaults to constructor default
+     * @returns StreamQueue 实例 / StreamQueue instance
+     */
+    getQueue(id: string): Q {
+        const queue = this.queues.get(id);
+        if (!queue) {
+            throw new Error(`Queue with id '${id}' does not exist`);
+        }
+        return queue;
+    }
+
+    /**
+     * 取消指定 id 的队列
+     * Cancel queue with specified id
+     * @param id 队列 ID / Queue ID
+     */
+    cancelQueue(id: string): void {
+        const queue = this.queues.get(id);
+        if (queue) {
+            queue.cancel();
+            this.removeQueue(id);
+        }
+    }
+    /**
+     * 向指定 id 的队列推送数据
+     * Push data to queue with specified id
+     * @param id 队列 ID / Queue ID
+     * @param item 要推送的数据项 / Item to push
+     * @param compressMessages 是否压缩消息，默认为构造函数中的默认值 / Whether to compress messages, defaults to constructor default
+     */
+    async pushToQueue(id: string, item: EventMessage, compressMessages?: boolean): Promise<void> {
+        const queue = this.getQueue(id);
+        await queue.push(item);
+    }
+
+    /**
+     * 获取指定 id 队列中的所有数据
+     * Get all data from queue with specified id
+     * @param id 队列 ID / Queue ID
+     * @returns 队列中的所有数据 / All data in the queue
+     */
+    async getQueueData(id: string): Promise<EventMessage[]> {
+        const queue = this.queues.get(id);
+        if (!queue) {
+            throw new Error(`Queue with id '${id}' does not exist`);
+        }
+        return await queue.getAll();
+    }
+
+    /**
+     * 清空指定 id 的队列
+     * Clear queue with specified id
+     * @param id 队列 ID / Queue ID
+     */
+    clearQueue(id: string): void {
+        const queue = this.queues.get(id);
+        if (queue) {
+            queue.clear();
+        }
+    }
+
+    /**
+     * 删除指定 id 的队列
+     * Remove queue with specified id
+     * @param id 队列 ID / Queue ID
+     * @returns 是否成功删除 / Whether successfully deleted
+     */
+    removeQueue(id: string) {
+        setTimeout(() => {
+            return this.queues.delete(id);
+        }, 500);
+    }
+
+    /**
+     * 获取所有队列的 ID
+     * Get all queue IDs
+     * @returns 所有队列 ID 的数组 / Array of all queue IDs
+     */
+    getAllQueueIds(): string[] {
+        return Array.from(this.queues.keys());
+    }
+
+    /**
+     * 获取所有队列及其数据的快照
+     * Get snapshot of all queues and their data
+     * @returns 包含所有队列数据的结果对象 / Result object containing all queue data
+     */
+    async getAllQueuesData(): Promise<Record<string, EventMessage[]>> {
+        const result: Record<string, EventMessage[]> = {};
+        for (const [id, queue] of this.queues) {
+            result[id] = await queue.getAll();
+        }
+        return result;
+    }
+
+    /**
+     * 清空所有队列
+     * Clear all queues
+     */
+    clearAllQueues(): void {
+        for (const queue of this.queues.values()) {
+            queue.clear();
+        }
+    }
+}

package/src/storage/index.ts

@@ -0,0 +1,14 @@
+import { StreamQueueManager } from '../queue/stream_queue';
+import { MemorySaver } from './memory/checkpoint';
+import { MemoryStreamQueue } from './memory/queue';
+
+// 所有的适配实现，都请写到这里，通过环境变量进行判断使用哪种方式进行适配
+
+export const createCheckPointer = () => {
+    return new MemorySaver();
+};
+
+export const createMessageQueue = () => {
+    const q: new (compressMessages: boolean) => MemoryStreamQueue = MemoryStreamQueue;
+    return new StreamQueueManager(q);
+};

package/src/storage/memory/checkpoint.ts

@@ -0,0 +1,2 @@
+import { MemorySaver } from '@langchain/langgraph-checkpoint';
+export { MemorySaver };

package/src/storage/memory/queue.ts

@@ -0,0 +1,83 @@
+import { CancelEventMessage, EventMessage } from '../../queue/event_message.js';
+import { BaseStreamQueue } from '../../queue/stream_queue.js';
+import { BaseStreamQueueInterface } from '../../queue/stream_queue.js';
+/** 内存实现的消息队列，用于存储消息 */
+export class MemoryStreamQueue extends BaseStreamQueue implements BaseStreamQueueInterface {
+    private data: EventMessage[] = [];
+    async push(item: EventMessage): Promise<void> {
+        const data = this.compressMessages ? ((await this.encodeData(item)) as unknown as EventMessage) : item;
+        this.data.push(data);
+        this.emit('dataChange', data);
+    }
+
+    onDataChange(listener: (data: EventMessage) => void): () => void {
+        this.on('dataChange', async (item) => {
+            listener(this.compressMessages ? ((await this.decodeData(item)) as EventMessage) : item);
+        });
+        return () => this.off('dataChange', listener);
+    }
+
+    /**
+     * 异步生成器：支持 for await...of 方式消费队列数据
+     */
+    async *onDataReceive(): AsyncGenerator<EventMessage, void, unknown> {
+        const queue: EventMessage[] = [];
+        let pendingResolve: (() => void) | null = null;
+        let isStreamEnded = false;
+        const handleData = async (item: EventMessage) => {
+            const data = this.compressMessages ? ((await this.decodeData(item as any)) as EventMessage) : item;
+            queue.push(data);
+
+            // 检查是否为流结束或错误信号
+            if (
+                data.event === '__stream_end__' ||
+                data.event === '__stream_error__' ||
+                data.event === '__stream_cancel__'
+            ) {
+                isStreamEnded = true;
+                if (data.event === '__stream_cancel__') {
+                    this.cancel();
+                }
+            }
+
+            if (pendingResolve) {
+                pendingResolve();
+                pendingResolve = null;
+            }
+        };
+
+        this.on('dataChange', handleData as any);
+
+        try {
+            while (!isStreamEnded) {
+                if (queue.length > 0) {
+                    const item = queue.shift() as EventMessage;
+                    yield item;
+                } else {
+                    await new Promise((resolve) => {
+                        pendingResolve = resolve as () => void;
+                    });
+                }
+            }
+        } finally {
+            this.off('dataChange', handleData as any);
+        }
+    }
+
+    async getAll(): Promise<EventMessage[]> {
+        return this.compressMessages
+            ? ((await Promise.all(
+                  this.data.map((i) => this.decodeData(i as unknown as string | Uint8Array)),
+              )) as unknown as EventMessage[])
+            : this.data;
+    }
+
+    clear(): void {
+        this.data = [];
+    }
+    public cancelSignal = new AbortController();
+    cancel(): void {
+        this.push(new CancelEventMessage());
+        this.cancelSignal.abort('user cancel this run');
+    }
+}

package/src/storage/memory/threads.ts

@@ -0,0 +1,154 @@
+import { BaseThreadsManager } from '../../threads/index.js';
+import {
+    Command,
+    Metadata,
+    OnConflictBehavior,
+    Run,
+    RunStatus,
+    SortOrder,
+    Thread,
+    ThreadSortBy,
+    ThreadStatus,
+} from '@langgraph-js/sdk';
+
+export class MemoryThreadsManager<ValuesType = unknown> extends BaseThreadsManager {
+    private threads: Thread<ValuesType>[] = [];
+
+    async create(payload?: {
+        metadata?: Metadata;
+        threadId?: string;
+        ifExists?: OnConflictBehavior;
+        graphId?: string;
+        supersteps?: Array<{ updates: Array<{ values: unknown; command?: Command; asNode: string }> }>;
+    }): Promise<Thread<ValuesType>> {
+        const threadId = payload?.threadId || crypto.randomUUID();
+        if (payload?.ifExists === 'raise' && this.threads.some((t) => t.thread_id === threadId)) {
+            throw new Error(`Thread with ID ${threadId} already exists.`);
+        }
+
+        const thread: Thread<ValuesType> = {
+            thread_id: threadId,
+            created_at: new Date().toISOString(),
+            updated_at: new Date().toISOString(),
+            metadata: payload?.metadata || {},
+            status: 'idle',
+            values: null as unknown as ValuesType,
+            interrupts: {},
+        };
+        this.threads.push(thread);
+        return thread;
+    }
+
+    async search(query?: {
+        metadata?: Metadata;
+        limit?: number;
+        offset?: number;
+        status?: ThreadStatus;
+        sortBy?: ThreadSortBy;
+        sortOrder?: SortOrder;
+    }): Promise<Thread<ValuesType>[]> {
+        let filteredThreads = [...this.threads];
+        if (query?.status) {
+            filteredThreads = filteredThreads.filter((t) => t.status === query.status);
+        }
+
+        if (query?.metadata) {
+            for (const key in query.metadata) {
+                if (Object.prototype.hasOwnProperty.call(query.metadata, key)) {
+                    filteredThreads = filteredThreads.filter(
+                        (t) => t.metadata && t.metadata[key] === query.metadata?.[key],
+                    );
+                }
+            }
+        }
+
+        if (query?.sortBy) {
+            filteredThreads.sort((a, b) => {
+                let aValue: any;
+                let bValue: any;
+
+                switch (query.sortBy) {
+                    case 'created_at':
+                        aValue = new Date(a.created_at).getTime();
+                        bValue = new Date(b.created_at).getTime();
+                        break;
+                    case 'updated_at':
+                        aValue = new Date(a.updated_at).getTime();
+                        bValue = new Date(b.updated_at).getTime();
+                        break;
+                    default:
+                        return 0;
+                }
+
+                if (query.sortOrder === 'desc') {
+                    return bValue - aValue;
+                } else {
+                    return aValue - bValue;
+                }
+            });
+        }
+
+        const offset = query?.offset || 0;
+        const limit = query?.limit || filteredThreads.length;
+
+        return filteredThreads.slice(offset, offset + limit);
+    }
+
+    async get(threadId: string): Promise<Thread<ValuesType>> {
+        const thread = this.threads.find((t) => t.thread_id === threadId);
+        if (!thread) {
+            throw new Error(`Thread with ID ${threadId} not found.`);
+        }
+        return thread;
+    }
+    async set(threadId: string, thread: Partial<Thread<ValuesType>>): Promise<void> {
+        const index = this.threads.findIndex((t) => t.thread_id === threadId);
+        if (index === -1) {
+            throw new Error(`Thread with ID ${threadId} not found.`);
+        }
+        this.threads[index] = { ...this.threads[index], ...thread };
+    }
+    async delete(threadId: string): Promise<void> {
+        const initialLength = this.threads.length;
+        this.threads = this.threads.filter((t) => t.thread_id !== threadId);
+        if (this.threads.length === initialLength) {
+            throw new Error(`Thread with ID ${threadId} not found.`);
+        }
+    }
+    runs: Run[] = [];
+    async createRun(threadId: string, assistantId: string, payload?: { metadata?: Metadata }): Promise<Run> {
+        const runId = crypto.randomUUID();
+        const run: Run = {
+            run_id: runId,
+            thread_id: threadId,
+            assistant_id: assistantId,
+            created_at: new Date().toISOString(),
+            updated_at: new Date().toISOString(),
+            status: 'pending',
+            metadata: payload?.metadata ?? {},
+            multitask_strategy: 'reject',
+        };
+        this.runs.push(run);
+        return run;
+    }
+    async listRuns(
+        threadId: string,
+        options?: { limit?: number; offset?: number; status?: RunStatus },
+    ): Promise<Run[]> {
+        let filteredRuns = [...this.runs];
+        if (options?.status) {
+            filteredRuns = filteredRuns.filter((r) => r.status === options.status);
+        }
+        if (options?.limit) {
+            filteredRuns = filteredRuns.slice(options.offset || 0, (options.offset || 0) + options.limit);
+        }
+        return filteredRuns;
+    }
+    async updateRun(runId: string, run: Partial<Run>): Promise<void> {
+        const index = this.runs.findIndex((r) => r.run_id === runId);
+        if (index === -1) {
+            throw new Error(`Run with ID ${runId} not found.`);
+        }
+        this.runs[index] = { ...this.runs[index], ...run };
+    }
+}

package/src/threads/index.ts

@@ -0,0 +1,51 @@
+import {
+    Command,
+    Metadata,
+    OnConflictBehavior,
+    Run,
+    RunStatus,
+    SortOrder,
+    Thread,
+    ThreadSortBy,
+    ThreadStatus,
+} from '@langgraph-js/sdk';
+
+export class BaseThreadsManager<ValuesType = unknown> {
+    create(payload?: {
+        metadata?: Metadata;
+        threadId?: string;
+        ifExists?: OnConflictBehavior;
+        graphId?: string;
+        supersteps?: Array<{ updates: Array<{ values: unknown; command?: Command; asNode: string }> }>;
+    }): Promise<Thread<ValuesType>> {
+        throw new Error('Function not implemented.');
+    }
+    set(threadId: string, thread: Partial<Thread<ValuesType>>): Promise<void> {
+        throw new Error('Function not implemented.');
+    }
+    search(query?: {
+        metadata?: Metadata;
+        limit?: number;
+        offset?: number;
+        status?: ThreadStatus;
+        sortBy?: ThreadSortBy;
+        sortOrder?: SortOrder;
+    }): Promise<Thread<ValuesType>[]> {
+        throw new Error('Function not implemented.');
+    }
+    get(threadId: string): Promise<Thread<ValuesType>> {
+        throw new Error('Function not implemented.');
+    }
+    delete(threadId: string): Promise<void> {
+        throw new Error('Function not implemented.');
+    }
+    createRun(threadId: string, assistantId: string, payload?: { metadata?: Metadata }): Promise<Run> {
+        throw new Error('Function not implemented.');
+    }
+    listRuns(threadId: string, options?: { limit?: number; offset?: number; status?: RunStatus }): Promise<Run[]> {
+        throw new Error('Function not implemented.');
+    }
+    updateRun(runId: string, run: Partial<Run>): Promise<void> {
+        throw new Error('Function not implemented.');
+    }
+}

package/src/types.ts

@@ -0,0 +1,116 @@
+import {
+    Thread,
+    Assistant,
+    Run,
+    StreamMode,
+    Command,
+    Metadata,
+    AssistantGraph,
+    OnConflictBehavior,
+    ThreadStatus,
+    Checkpoint,
+} from '@langchain/langgraph-sdk';
+import { StreamEvent } from '@langchain/core/tracers/log_stream';
+import { EventMessage } from './queue/event_message';
+import { RunnableConfig } from '@langchain/core/runnables';
+
+// 基础类型定义
+export type AssistantSortBy = 'assistant_id' | 'graph_id' | 'name' | 'created_at' | 'updated_at';
+export type ThreadSortBy = 'thread_id' | 'status' | 'created_at' | 'updated_at';
+export type SortOrder = 'asc' | 'desc';
+export type RunStatus = 'pending' | 'running' | 'error' | 'success' | 'timeout' | 'interrupted';
+export type MultitaskStrategy = 'reject' | 'interrupt' | 'rollback' | 'enqueue';
+export type DisconnectMode = 'cancel' | 'continue';
+export type OnCompletionBehavior = 'complete' | 'continue';
+export type CancelAction = 'interrupt' | 'rollback';
+
+export type StreamInputData = {
+    input?: Record<string, unknown> | null;
+    metadata?: Metadata;
+    config?: RunnableConfig;
+    checkpointId?: string;
+    checkpoint?: Omit<Checkpoint, 'thread_id'>;
+    checkpoint_during?: boolean;
+    interrupt_before?: '*' | string[];
+    interrupt_after?: '*' | string[];
+    multitask_strategy?: MultitaskStrategy;
+    on_completion?: OnCompletionBehavior;
+    signal?: AbortController['signal'];
+    webhook?: string;
+    on_disconnect?: DisconnectMode;
+    after_seconds?: number;
+    if_not_exists?: 'create' | 'reject';
+    command?: Command;
+    onRunCreated?: (params: { run_id: string; thread_id?: string }) => void;
+    stream_mode?: StreamMode[];
+    stream_subgraphs?: boolean;
+    stream_resumable?: boolean;
+    feedback_keys?: string[];
+    temporary?: boolean;
+};
+/**
+ * 兼容 LangGraph SDK 的接口定义，方便进行无侵入式的扩展
+ */
+export interface ILangGraphClient<TStateType = unknown> {
+    assistants: {
+        search(query?: {
+            graphId?: string;
+            metadata?: Metadata;
+            limit?: number;
+            offset?: number;
+            sortBy?: AssistantSortBy;
+            sortOrder?: SortOrder;
+        }): Promise<Assistant[]>;
+        getGraph(assistantId: string, options?: { xray?: boolean | number }): Promise<AssistantGraph>;
+    };
+    threads: {
+        create(payload?: {
+            metadata?: Metadata;
+            thread_id?: string;
+            if_exists?: OnConflictBehavior;
+            graph_id?: string;
+            // supersteps?: Array<{
+            //     updates: Array<{
+            //         values: unknown;
+            //         command?: Command;
+            //         as_node: string;
+            //     }>;
+            // }>;
+        }): Promise<Thread<TStateType>>;
+        search(query?: {
+            metadata?: Metadata;
+            limit?: number;
+            offset?: number;
+            status?: ThreadStatus;
+            sortBy?: ThreadSortBy;
+            sortOrder?: SortOrder;
+        }): Promise<Thread<TStateType>[]>;
+        get(threadId: string): Promise<Thread<TStateType>>;
+        delete(threadId: string): Promise<void>;
+    };
+    runs: {
+        list(
+            threadId: string,
+            options?: {
+                limit?: number;
+                offset?: number;
+                status?: RunStatus;
+            },
+        ): Promise<Run[]>;
+
+        stream(threadId: string, assistantId: string, payload?: StreamInputData): AsyncGenerator<EventMessage>;
+        joinStream(
+            threadId: string,
+            runId: string,
+            options?:
+                | {
+                      signal?: AbortSignal;
+                      cancelOnDisconnect?: boolean;
+                      lastEventId?: string;
+                      streamMode?: StreamMode | StreamMode[];
+                  }
+                | AbortSignal,
+        ): AsyncGenerator<{ id?: string; event: StreamEvent; data: any }>;
+        cancel(threadId: string, runId: string, wait?: boolean, action?: CancelAction): Promise<void>;
+    };
+}