@lichen-ai/lichen-sdk 0.1.0

package/dist/tests/sse.test.mjs

@@ -0,0 +1,132 @@
+import { describe, test, expect } from 'vitest';
+import { Readable } from 'node:stream';
+import { IterableReadableStream } from "../utils/stream.mjs";
+import { BytesLineDecoder, SSEDecoder } from "../utils/sse.mjs";
+const gather = async (stream) => {
+    const results = [];
+    const iterator = IterableReadableStream.fromReadableStream(stream);
+    for await (const chunk of iterator)
+        results.push(chunk);
+    return results;
+};
+const textEncoder = new TextEncoder();
+const textDecoder = new TextDecoder();
+describe('BytesLineDecoder', () => {
+    const createStream = (chunks) => {
+        return Readable.toWeb(Readable.from(chunks));
+    };
+    test('handles single line with newline', async () => {
+        const input = createStream([textEncoder.encode('hello\n')]);
+        const decoded = input.pipeThrough(BytesLineDecoder());
+        const results = await gather(decoded);
+        expect(results.length).toBe(1);
+        expect(textDecoder.decode(results[0])).toBe('hello');
+    });
+    test('handles multiple lines', async () => {
+        const input = createStream([textEncoder.encode('line1\nline2\nline3\n')]);
+        const decoded = input.pipeThrough(BytesLineDecoder());
+        const results = await gather(decoded);
+        expect(results.length).toBe(3);
+        expect(textDecoder.decode(results[0])).toBe('line1');
+        expect(textDecoder.decode(results[1])).toBe('line2');
+        expect(textDecoder.decode(results[2])).toBe('line3');
+    });
+    test('handles split chunks', async () => {
+        const input = createStream([textEncoder.encode('li'), textEncoder.encode('ne1\nli'), textEncoder.encode('ne2\n')]);
+        const decoded = input.pipeThrough(BytesLineDecoder());
+        const results = await gather(decoded);
+        expect(results.length).toBe(2);
+        expect(textDecoder.decode(results[0])).toBe('line1');
+        expect(textDecoder.decode(results[1])).toBe('line2');
+    });
+    test('handles CR LF line endings', async () => {
+        const input = createStream([textEncoder.encode('line1\r\nline2\r\n')]);
+        const decoded = input.pipeThrough(BytesLineDecoder());
+        const results = await gather(decoded);
+        expect(results.length).toBe(2);
+        expect(textDecoder.decode(results[0])).toBe('line1');
+        expect(textDecoder.decode(results[1])).toBe('line2');
+    });
+    test('handles split CR LF', async () => {
+        const input = createStream([textEncoder.encode('line1\r'), textEncoder.encode('\nline2\r\n')]);
+        const decoded = input.pipeThrough(BytesLineDecoder());
+        const results = await gather(decoded);
+        expect(results.length).toBe(2);
+        expect(textDecoder.decode(results[0])).toBe('line1');
+        expect(textDecoder.decode(results[1])).toBe('line2');
+    });
+    test('handles stale line', async () => {
+        const input = createStream([textEncoder.encode('hello')]);
+        const decoded = input.pipeThrough(BytesLineDecoder());
+        const results = await gather(decoded);
+        expect(results.length).toBe(1);
+        expect(textDecoder.decode(results[0])).toBe('hello');
+    });
+});
+describe('SSEDecoder', () => {
+    const createStream = (lines) => {
+        return Readable.toWeb(Readable.from(lines.map((line) => textEncoder.encode(line))));
+    };
+    test('decodes simple event', async () => {
+        const input = createStream(['event: test\n', 'data: {"message": "hello"}\n', '\n']);
+        const decoded = input.pipeThrough(BytesLineDecoder()).pipeThrough(SSEDecoder());
+        const results = await gather(decoded);
+        expect(results.length).toBe(1);
+        expect(results[0]).toEqual({
+            event: 'test',
+            data: { message: 'hello' }
+        });
+    });
+    test('ignores comments', async () => {
+        const input = createStream([': this is a comment\n', 'event: test\n', 'data: {"message": "hello"}\n']);
+        const decoded = input.pipeThrough(BytesLineDecoder()).pipeThrough(SSEDecoder());
+        const results = await gather(decoded);
+        expect(results.length).toBe(1);
+        expect(results[0]).toEqual({
+            event: 'test',
+            data: { message: 'hello' }
+        });
+    });
+    test('handles multiple events', async () => {
+        const input = createStream([
+            'event: test1\n',
+            'data: {"message": "hello"}\n',
+            '\n',
+            'event: test2\n',
+            'data: {"message": "world"}\n',
+            '\n'
+        ]);
+        const decoded = input.pipeThrough(BytesLineDecoder()).pipeThrough(SSEDecoder());
+        const results = await gather(decoded);
+        expect(results.length).toBe(2);
+        expect(results[0]).toEqual({
+            event: 'test1',
+            data: { message: 'hello' }
+        });
+        expect(results[1]).toEqual({
+            event: 'test2',
+            data: { message: 'world' }
+        });
+    });
+    test('end event without data', async () => {
+        const input = createStream(['event: test\n']);
+        const decoded = input.pipeThrough(BytesLineDecoder()).pipeThrough(SSEDecoder());
+        const results = await gather(decoded);
+        expect(results.length).toBe(1);
+        expect(results[0]).toEqual({
+            event: 'test',
+            data: null
+        });
+    });
+    test('end event without newline', async () => {
+        const input = createStream(['event: end']);
+        const decoded = input.pipeThrough(BytesLineDecoder()).pipeThrough(SSEDecoder());
+        const results = await gather(decoded);
+        expect(results.length).toBe(1);
+        expect(results[0]).toEqual({
+            event: 'end',
+            data: null
+        });
+    });
+});
+//# sourceMappingURL=sse.test.mjs.map

package/dist/tests/sse.test.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sse.test.mjs","sourceRoot":"","sources":["../../src/tests/sse.test.ts"],"names":[],"mappings":"OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,QAAQ;OACxC,EAAE,QAAQ,EAAE,MAAM,aAAa;OAC/B,EAAE,sBAAsB,EAAE;OAC1B,EAAE,gBAAgB,EAAE,UAAU,EAAE;AAEvC,MAAM,MAAM,GAAG,KAAK,EAAK,MAAyB,EAAgB,EAAE;IAClE,MAAM,OAAO,GAAQ,EAAE,CAAA;IACvB,MAAM,QAAQ,GAAG,sBAAsB,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAA;IAClE,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,QAAQ;QAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACvD,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA;AAED,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAA;AACrC,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAA;AAErC,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,MAAM,YAAY,GAAG,CAAC,MAAoB,EAAE,EAAE;QAC5C,OAAO,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAA+B,CAAA;IAC5E,CAAC,CAAA;IAED,IAAI,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,KAAK,GAAG,YAAY,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QAC3D,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC,CAAA;QACrD,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAA;QAErC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAC9B,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACtD,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;QACxC,MAAM,KAAK,GAAG,YAAY,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAA;QACzE,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC,CAAA;QACrD,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAA;QAErC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAC9B,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACpD,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACpD,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACtD,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;QACtC,MAAM,KAAK,GAAG,YAAY,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;QAClH,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC,CAAA;QACrD,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAA;QAErC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAC9B,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACpD,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACtD,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;QAC5C,MAAM,KAAK,GAAG,YAAY,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAA;QACtE,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC,CAAA;QACrD,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAA;QAErC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAC9B,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACpD,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACtD,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,qBAAqB,EAAE,KAAK,IAAI,EAAE;QACrC,MAAM,KAAK,GAAG,YAAY,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;QAC9F,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC,CAAA;QACrD,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAA;QAErC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAC9B,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACpD,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACtD,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,oBAAoB,EAAE,KAAK,IAAI,EAAE;QACpC,MAAM,KAAK,GAAG,YAAY,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;QACzD,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC,CAAA;QACrD,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAA;QAErC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAC9B,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACtD,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA;AAEF,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,MAAM,YAAY,GAAG,CAAC,KAAe,EAAE,EAAE;QACvC,OAAO,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAA+B,CAAA;IACnH,CAAC,CAAA;IAED,IAAI,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;QACtC,MAAM,KAAK,GAAG,YAAY,CAAC,CAAC,eAAe,EAAE,8BAA8B,EAAE,IAAI,CAAC,CAAC,CAAA;QACnF,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,CAAA;QAE/E,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAA;QACrC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAC9B,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YACzB,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE;SAC3B,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,kBAAkB,EAAE,KAAK,IAAI,EAAE;QAClC,MAAM,KAAK,GAAG,YAAY,CAAC,CAAC,uBAAuB,EAAE,eAAe,EAAE,8BAA8B,CAAC,CAAC,CAAA;QACtG,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,CAAA;QAE/E,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAA;QACrC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAC9B,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YACzB,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE;SAC3B,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,yBAAyB,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,KAAK,GAAG,YAAY,CAAC;YACzB,gBAAgB;YAChB,8BAA8B;YAC9B,IAAI;YACJ,gBAAgB;YAChB,8BAA8B;YAC9B,IAAI;SACL,CAAC,CAAA;QACF,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,CAAA;QAE/E,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAA;QACrC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAC9B,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YACzB,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE;SAC3B,CAAC,CAAA;QACF,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YACzB,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE;SAC3B,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;QACxC,MAAM,KAAK,GAAG,YAAY,CAAC,CAAC,eAAe,CAAC,CAAC,CAAA;QAC7C,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,CAAA;QAE/E,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAA;QACrC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAC9B,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YACzB,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,IAAI;SACX,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QAC3C,MAAM,KAAK,GAAG,YAAY,CAAC,CAAC,YAAY,CAAC,CAAC,CAAA;QAC1C,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,CAAA;QAE/E,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAA;QACrC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAC9B,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YACzB,KAAK,EAAE,KAAK;YACZ,IAAI,EAAE,IAAI;SACX,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/types.d.ts

@@ -0,0 +1,178 @@
+import { Checkpoint, Config, Metadata, RunInput } from './schema.js';
+import { StreamMode } from './types.stream.js';
+export type MultitaskStrategy = 'reject' | 'interrupt' | 'rollback' | 'enqueue';
+export type OnConflictBehavior = 'raise' | 'do_nothing';
+export type OnCompletionBehavior = 'complete' | 'continue';
+export type DisconnectMode = 'cancel' | 'continue';
+export type Durability = 'exit' | 'async' | 'sync';
+export type StreamEvent = 'events' | 'metadata' | 'debug' | 'updates' | 'values' | 'messages/partial' | 'messages/metadata' | 'messages/complete' | 'messages' | (string & {});
+export interface Send {
+    node: string;
+    input: unknown | null;
+}
+export interface Command {
+    /**
+     * An object to update the thread state with.
+     */
+    update?: Record<string, unknown> | [string, unknown][] | null;
+    /**
+     * The value to return from an `interrupt` function call.
+     */
+    resume?: unknown;
+    /**
+     * Determine the next node to navigate to. Can be one of the following:
+     * - Name(s) of the node names to navigate to next.
+     * - `Send` command(s) to execute node(s) with provided input.
+     */
+    goto?: Send | Send[] | string | string[];
+}
+export interface RunsInvokePayload {
+    /**
+     * Input to the run. Must be a valid {@link ChatRequest} (send / resume / retry)
+     * or a {@link LegacyChatRequest}.
+     * Pass `null` to resume from the current state of the thread.
+     */
+    input?: RunInput | null;
+    /**
+     * Metadata for the run.
+     */
+    metadata?: Metadata;
+    /**
+     * Additional configuration for the run.
+     */
+    config?: Config;
+    /**
+     * Static context to add to the assistant.
+     * @remarks Added in LangGraph.js 0.4
+     */
+    context?: unknown;
+    /**
+     * Checkpoint ID for when creating a new run.
+     */
+    checkpointId?: string;
+    /**
+     * Checkpoint for when creating a new run.
+     */
+    checkpoint?: Omit<Checkpoint, 'thread_id'>;
+    /**
+     * Whether to checkpoint during the run (or only at the end/interruption).
+     * @deprecated Use `durability` instead.
+     */
+    checkpointDuring?: boolean;
+    /**
+     * Whether to checkpoint during the run (or only at the end/interruption).
+     * - `"async"`: Save checkpoint asynchronously while the next step executes (default).
+     * - `"sync"`: Save checkpoint synchronously before the next step starts.
+     * - `"exit"`: Save checkpoint only when the graph exits.
+     * @default "async"
+     */
+    durability?: Durability;
+    /**
+     * Interrupt execution before entering these nodes.
+     */
+    interruptBefore?: '*' | string[];
+    /**
+     * 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.
+     */
+    signal?: AbortController['signal'];
+    /**
+     * Behavior to handle run completion. Only relevant if
+     * there is a pending/inflight run on the same thread. One of:
+     * - "complete": Complete the run.
+     * - "continue": Continue the run.
+     */
+    onCompletion?: OnCompletionBehavior;
+    /**
+     * Webhook to call when the run is complete.
+     */
+    webhook?: string;
+    /**
+     * Behavior to handle disconnection. Only relevant if
+     * there is a pending/inflight run on the same thread. One of:
+     * - "cancel": Cancel the run.
+     * - "continue": Continue the run.
+     */
+    onDisconnect?: DisconnectMode;
+    /**
+     * The number of seconds to wait before starting the run.
+     * Use to schedule future runs.
+     */
+    afterSeconds?: number;
+    /**
+     * Behavior if the specified run doesn't exist. Defaults to "reject".
+     */
+    ifNotExists?: 'create' | 'reject';
+    /**
+     * One or more commands to invoke the graph with.
+     */
+    command?: Command;
+    /**
+     * Callback when a run is created.
+     */
+    onRunCreated?: (params: {
+        run_id: string;
+        thread_id?: string;
+    }) => void;
+}
+export interface RunsStreamPayload<TStreamMode extends StreamMode | StreamMode[] = [], TSubgraphs extends boolean = false> extends RunsInvokePayload {
+    /**
+     * One of `"values"`, `"messages"`, `"messages-tuple"`, `"updates"`, `"events"`, `"debug"`, `"custom"`.
+     */
+    streamMode?: TStreamMode;
+    /**
+     * Stream output from subgraphs. By default, streams only the top graph.
+     */
+    streamSubgraphs?: TSubgraphs;
+    /**
+     * Whether the stream is considered resumable.
+     * If true, the stream can be resumed and replayed in its entirety even after disconnection.
+     */
+    streamResumable?: boolean;
+    /**
+     * Pass one or more feedbackKeys if you want to request short-lived signed URLs
+     * for submitting feedback to LangSmith with this key for this run.
+     */
+    feedbackKeys?: string[];
+}
+export interface RunsCreatePayload extends RunsInvokePayload {
+    /**
+     * One of `"values"`, `"messages"`, `"messages-tuple"`, `"updates"`, `"events"`, `"debug"`, `"custom"`.
+     */
+    streamMode?: StreamMode | Array<StreamMode>;
+    /**
+     * Stream output from subgraphs. By default, streams only the top graph.
+     */
+    streamSubgraphs?: boolean;
+    /**
+     * Whether the stream is considered resumable.
+     * If true, the stream can be resumed and replayed in its entirety even after disconnection.
+     */
+    streamResumable?: boolean;
+}
+export interface CronsCreatePayload extends RunsCreatePayload {
+    /**
+     * Schedule for running the Cron Job
+     */
+    schedule: string;
+}
+export interface RunsWaitPayload extends RunsStreamPayload {
+    /**
+     * Raise errors returned by the run. Default is `true`.
+     */
+    raiseError?: boolean;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/dist/types.messages.d.ts

@@ -0,0 +1,86 @@
+type ImageDetail = 'auto' | 'low' | 'high';
+type MessageContentImageUrl = {
+    type: 'image_url';
+    image_url: string | {
+        url: string;
+        detail?: ImageDetail | undefined;
+    };
+};
+type MessageContentText = {
+    type: 'text';
+    text: string;
+};
+type MessageContentComplex = MessageContentText | MessageContentImageUrl;
+type MessageContent = string | MessageContentComplex[];
+/**
+ * Model-specific additional kwargs, which is passed back to the underlying LLM.
+ */
+type MessageAdditionalKwargs = Record<string, unknown>;
+type BaseMessage = {
+    additional_kwargs?: MessageAdditionalKwargs | undefined;
+    content: MessageContent;
+    id?: string | undefined;
+    name?: string | undefined;
+    response_metadata?: Record<string, unknown> | undefined;
+};
+export type HumanMessage = BaseMessage & {
+    type: 'human';
+    example?: boolean | undefined;
+};
+export type AIMessage = BaseMessage & {
+    type: 'ai';
+    example?: boolean | undefined;
+    tool_calls?: {
+        name: string;
+        args: {
+            [x: string]: any;
+        };
+        id?: string | undefined;
+        type?: 'tool_call' | undefined;
+    }[] | undefined;
+    invalid_tool_calls?: {
+        name?: string | undefined;
+        args?: string | undefined;
+        id?: string | undefined;
+        error?: string | undefined;
+        type?: 'invalid_tool_call' | undefined;
+    }[] | undefined;
+    usage_metadata?: {
+        input_tokens: number;
+        output_tokens: number;
+        total_tokens: number;
+        input_token_details?: {
+            audio?: number | undefined;
+            cache_read?: number | undefined;
+            cache_creation?: number | undefined;
+        } | undefined;
+        output_token_details?: {
+            audio?: number | undefined;
+            reasoning?: number | undefined;
+        } | undefined;
+    } | undefined;
+};
+export type ToolMessage = BaseMessage & {
+    type: 'tool';
+    status?: 'error' | 'success' | undefined;
+    tool_call_id: string;
+    /**
+     * Artifact of the Tool execution which is not meant to be sent to the model.
+     *
+     * Should only be specified if it is different from the message content, e.g. if only
+     * a subset of the full tool output is being passed as message content but the full
+     * output is needed in other parts of the code.
+     */
+    artifact?: any;
+};
+export type SystemMessage = BaseMessage & {
+    type: 'system';
+};
+export type FunctionMessage = BaseMessage & {
+    type: 'function';
+};
+export type RemoveMessage = BaseMessage & {
+    type: 'remove';
+};
+export type Message = HumanMessage | AIMessage | ToolMessage | SystemMessage | FunctionMessage | RemoveMessage;
+export {};

package/dist/types.messages.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.messages.js.map

package/dist/types.messages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.messages.js","sourceRoot":"","sources":["../src/types.messages.ts"],"names":[],"mappings":""}

package/dist/types.messages.mjs

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.messages.mjs.map

package/dist/types.messages.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.messages.mjs","sourceRoot":"","sources":["../src/types.messages.ts"],"names":[],"mappings":""}

package/dist/types.mjs

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.mjs.map

package/dist/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/dist/types.stream.d.ts

@@ -0,0 +1,212 @@
+import type { Message } from './types.messages.js';
+import type { Interrupt, Metadata, Config, ThreadTask } from './schema.js';
+/**
+import type { SubgraphCheckpointsStreamEvent } from "./types.stream.subgraph.js";
+ * Stream modes
+ * - "values": Stream only the state values.
+ * - "messages": Stream complete messages.
+ * - "messages-tuple": Stream (message chunk, metadata) tuples.
+ * - "updates": Stream updates to the state.
+ * - "events": Stream events occurring during execution.
+ * - "debug": Stream detailed debug information.
+ * - "custom": Stream custom events.
+ */
+export type StreamMode = 'values' | 'messages' | 'updates' | 'events' | 'debug' | 'tasks' | 'checkpoints' | 'custom' | 'messages-tuple';
+export type ThreadStreamMode = 'run_modes' | 'lifecycle' | 'state_update';
+type MessageTupleMetadata = {
+    tags: string[];
+    [key: string]: unknown;
+};
+type AsSubgraph<TEvent extends {
+    id?: string;
+    event: string;
+    data: unknown;
+}> = {
+    id?: TEvent['id'];
+    event: TEvent['event'] | `${TEvent['event']}|${string}`;
+    data: TEvent['data'];
+};
+/**
+ * Stream event with values after completion of each step.
+ */
+export type ValuesStreamEvent<StateType> = {
+    id?: string;
+    event: 'values';
+    data: StateType;
+};
+/**
+ * Stream event with message chunks coming from LLM invocations inside nodes.
+ */
+export type MessagesTupleStreamEvent = {
+    event: 'messages';
+    data: [message: Message, config: MessageTupleMetadata];
+};
+/**
+ * Metadata stream event with information about the run and thread
+ */
+export type MetadataStreamEvent = {
+    id?: string;
+    event: 'metadata';
+    data: {
+        run_id: string;
+        thread_id: string;
+    };
+};
+/**
+ * Stream event with error information.
+ */
+export type ErrorStreamEvent = {
+    id?: string;
+    event: 'error';
+    data: {
+        error: string;
+        message: string;
+    };
+};
+/**
+ * Stream event with updates to the state after each step.
+ * The streamed outputs include the name of the node that
+ * produced the update as well as the update.
+ */
+export type UpdatesStreamEvent<UpdateType> = {
+    id?: string;
+    event: 'updates';
+    data: {
+        [node: string]: UpdateType;
+    };
+};
+/**
+ * Streaming custom data from inside the nodes.
+ */
+export type CustomStreamEvent<T> = {
+    event: 'custom';
+    data: T;
+};
+type MessagesMetadataStreamEvent = {
+    id?: string;
+    event: 'messages/metadata';
+    data: {
+        [messageId: string]: {
+            metadata: unknown;
+        };
+    };
+};
+type MessagesCompleteStreamEvent = {
+    id?: string;
+    event: 'messages/complete';
+    data: Message[];
+};
+type MessagesPartialStreamEvent = {
+    id?: string;
+    event: 'messages/partial';
+    data: Message[];
+};
+type TasksStreamCreateEvent<StateType> = {
+    id?: string;
+    event: 'tasks';
+    data: {
+        id: string;
+        name: string;
+        interrupts: Interrupt[];
+        input: StateType;
+        triggers: string[];
+    };
+};
+type TasksStreamResultEvent<UpdateType> = {
+    id?: string;
+    event: 'tasks';
+    data: {
+        id: string;
+        name: string;
+        interrupts: Interrupt[];
+        result: [string, UpdateType][];
+    };
+};
+type TasksStreamErrorEvent = {
+    id?: string;
+    event: 'tasks';
+    data: {
+        id: string;
+        name: string;
+        interrupts: Interrupt[];
+        error: string;
+    };
+};
+export type TasksStreamEvent<StateType, UpdateType> = TasksStreamCreateEvent<StateType> | TasksStreamResultEvent<UpdateType> | TasksStreamErrorEvent;
+type SubgraphTasksStreamEvent<StateType, UpdateType> = AsSubgraph<TasksStreamCreateEvent<StateType>> | AsSubgraph<TasksStreamResultEvent<UpdateType>> | AsSubgraph<TasksStreamErrorEvent>;
+export type CheckpointsStreamEvent<StateType> = {
+    id?: string;
+    event: 'checkpoints';
+    data: {
+        values: StateType;
+        next: string[];
+        config: Config;
+        metadata: Metadata;
+        tasks: ThreadTask[];
+    };
+};
+type SubgraphCheckpointsStreamEvent<StateType> = AsSubgraph<CheckpointsStreamEvent<StateType>>;
+/**
+ * Message stream event specific to LangGraph Server.
+ * @deprecated Use `streamMode: "messages-tuple"` instead.
+ */
+export type MessagesStreamEvent = MessagesMetadataStreamEvent | MessagesCompleteStreamEvent | MessagesPartialStreamEvent;
+/**
+ * Stream event with detailed debug information.
+ */
+export type DebugStreamEvent = {
+    id?: string;
+    event: 'debug';
+    data: unknown;
+};
+/**
+ * Stream event with events occurring during execution.
+ */
+export type EventsStreamEvent = {
+    id?: string;
+    event: 'events';
+    data: {
+        event: `on_${'chat_model' | 'llm' | 'chain' | 'tool' | 'retriever' | 'prompt'}_${'start' | 'stream' | 'end'}` | (string & {});
+        name: string;
+        tags: string[];
+        run_id: string;
+        metadata: Record<string, unknown>;
+        parent_ids: string[];
+        data: unknown;
+    };
+};
+/**
+ * Stream event with a feedback key to signed URL map. Set `feedbackKeys` in
+ * the `RunsStreamPayload` to receive this event.
+ */
+export type FeedbackStreamEvent = {
+    id?: string;
+    event: 'feedback';
+    data: {
+        [feedbackKey: string]: string;
+    };
+};
+type GetStreamModeMap<TStreamMode extends StreamMode | StreamMode[], TStateType = unknown, TUpdateType = TStateType, TCustomType = unknown> = {
+    values: ValuesStreamEvent<TStateType>;
+    updates: UpdatesStreamEvent<TUpdateType>;
+    custom: CustomStreamEvent<TCustomType>;
+    debug: DebugStreamEvent;
+    messages: MessagesStreamEvent;
+    'messages-tuple': MessagesTupleStreamEvent;
+    tasks: TasksStreamEvent<TStateType, TUpdateType>;
+    checkpoints: CheckpointsStreamEvent<TStateType>;
+    events: EventsStreamEvent;
+}[TStreamMode extends StreamMode[] ? TStreamMode[number] : TStreamMode] | ErrorStreamEvent | MetadataStreamEvent | FeedbackStreamEvent;
+type GetSubgraphsStreamModeMap<TStreamMode extends StreamMode | StreamMode[], TStateType = unknown, TUpdateType = TStateType, TCustomType = unknown> = {
+    values: SubgraphValuesStreamEvent<TStateType>;
+    updates: SubgraphUpdatesStreamEvent<TUpdateType>;
+    custom: SubgraphCustomStreamEvent<TCustomType>;
+    debug: SubgraphDebugStreamEvent;
+    messages: SubgraphMessagesStreamEvent;
+    'messages-tuple': SubgraphMessagesTupleStreamEvent;
+    events: SubgraphEventsStreamEvent;
+    tasks: SubgraphTasksStreamEvent<TStateType, TUpdateType>;
+    checkpoints: SubgraphCheckpointsStreamEvent<TStateType>;
+}[TStreamMode extends StreamMode[] ? TStreamMode[number] : TStreamMode] | SubgraphErrorStreamEvent | MetadataStreamEvent | FeedbackStreamEvent;
+export type TypedAsyncGenerator<TStreamMode extends StreamMode | StreamMode[] = [], TSubgraphs extends boolean = false, TStateType = unknown, TUpdateType = TStateType, TCustomType = unknown> = AsyncGenerator<TSubgraphs extends true ? GetSubgraphsStreamModeMap<TStreamMode, TStateType, TUpdateType, TCustomType> : GetStreamModeMap<TStreamMode, TStateType, TUpdateType, TCustomType>>;
+export {};

package/dist/types.stream.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.stream.js.map

package/dist/types.stream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.stream.js","sourceRoot":"","sources":["../src/types.stream.ts"],"names":[],"mappings":""}

package/dist/types.stream.mjs

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.stream.mjs.map

package/dist/types.stream.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.stream.mjs","sourceRoot":"","sources":["../src/types.stream.ts"],"names":[],"mappings":""}