@trigger.dev/react-hooks 0.0.0-bun-runtimes-20260909131057

package/dist/esm/hooks/useRun.d.ts

@@ -0,0 +1,22 @@
+import type { AnyTask, RetrieveRunResult } from "@trigger.dev/core/v3";
+import type { CommonTriggerHookOptions } from "../utils/trigger-swr.js";
+/**
+ * Custom hook to retrieve and manage the state of a run by its ID.
+ *
+ * @template TTask - The type of the task associated with the run.
+ * @param {string} runId - The unique identifier of the run to retrieve.
+ * @param {CommonTriggerHookOptions} [options] - Optional configuration for the hook's behavior.
+ * @returns {Object} An object containing the run data, error, loading state, validation state, and error state.
+ * @returns {RetrieveRunResult<TTask> | undefined} run - The retrieved run data.
+ * @returns {Error | undefined} error - The error object if an error occurred.
+ * @returns {boolean} isLoading - Indicates if the run data is currently being loaded.
+ * @returns {boolean} isValidating - Indicates if the run data is currently being validated.
+ * @returns {boolean} isError - Indicates if an error occurred during the retrieval of the run data.
+ */
+export declare function useRun<TTask extends AnyTask>(runId: string, options?: CommonTriggerHookOptions): {
+    run: RetrieveRunResult<TTask> | undefined;
+    error: Error | undefined;
+    isLoading: boolean;
+    isValidating: boolean;
+    isError: boolean;
+};

package/dist/esm/hooks/useRun.js

@@ -0,0 +1,37 @@
+"use client";
+import { useSWR } from "../utils/trigger-swr.js";
+import { useApiClient } from "./useApiClient.js";
+/**
+ * Custom hook to retrieve and manage the state of a run by its ID.
+ *
+ * @template TTask - The type of the task associated with the run.
+ * @param {string} runId - The unique identifier of the run to retrieve.
+ * @param {CommonTriggerHookOptions} [options] - Optional configuration for the hook's behavior.
+ * @returns {Object} An object containing the run data, error, loading state, validation state, and error state.
+ * @returns {RetrieveRunResult<TTask> | undefined} run - The retrieved run data.
+ * @returns {Error | undefined} error - The error object if an error occurred.
+ * @returns {boolean} isLoading - Indicates if the run data is currently being loaded.
+ * @returns {boolean} isValidating - Indicates if the run data is currently being validated.
+ * @returns {boolean} isError - Indicates if an error occurred during the retrieval of the run data.
+ */
+export function useRun(runId, options) {
+    const apiClient = useApiClient(options);
+    const { data: run, error, isLoading, isValidating, } = useSWR(runId, () => {
+        if (!apiClient) {
+            throw new Error("Could not call useRun: Missing access token");
+        }
+        return apiClient.retrieveRun(runId);
+    }, {
+        revalidateOnReconnect: options?.revalidateOnReconnect,
+        refreshInterval: (run) => {
+            if (!run)
+                return options?.refreshInterval ?? 0;
+            if (run.isCompleted)
+                return 0;
+            return options?.refreshInterval ?? 0;
+        },
+        revalidateOnFocus: options?.revalidateOnFocus,
+    });
+    return { run, error, isLoading, isValidating, isError: !!error };
+}
+//# sourceMappingURL=useRun.js.map

package/dist/esm/hooks/useRun.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useRun.js","sourceRoot":"","sources":["../../../src/hooks/useRun.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAIb,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,MAAM,CACpB,KAAa,EACb,OAAkC;IAQlC,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IACxC,MAAM,EACJ,IAAI,EAAE,GAAG,EACT,KAAK,EACL,SAAS,EACT,YAAY,GACb,GAAG,MAAM,CACR,KAAK,EACL,GAAG,EAAE;QACH,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACjE,CAAC;QAED,OAAO,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC,EACD;QACE,qBAAqB,EAAE,OAAO,EAAE,qBAAqB;QACrD,eAAe,EAAE,CAAC,GAAG,EAAE,EAAE;YACvB,IAAI,CAAC,GAAG;gBAAE,OAAO,OAAO,EAAE,eAAe,IAAI,CAAC,CAAC;YAE/C,IAAI,GAAG,CAAC,WAAW;gBAAE,OAAO,CAAC,CAAC;YAE9B,OAAO,OAAO,EAAE,eAAe,IAAI,CAAC,CAAC;QACvC,CAAC;QACD,iBAAiB,EAAE,OAAO,EAAE,iBAAiB;KAC9C,CACF,CAAC;IAEF,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC;AACnE,CAAC"}

package/dist/esm/hooks/useSessionStream.d.ts

@@ -0,0 +1,131 @@
+import type { ControlEvent, SSEStreamPart } from "@trigger.dev/core/v3";
+import type { UseApiClientOptions } from "./useApiClient.js";
+export type UseSessionStreamInstance<TRecord> = {
+    /**
+     * The records received so far on the channel, in arrival order. Control records are
+     * never included here, they are delivered to `onControl` instead.
+     */
+    records: Array<TRecord>;
+    /**
+     * The cursor of the last record seen. Persist this and pass it back as the `lastEventId`
+     * option to resume the channel where you left off.
+     */
+    lastEventId: string | undefined;
+    /**
+     * The last control record seen on the channel (e.g. `turn-complete`).
+     */
+    lastControl: ControlEvent | undefined;
+    error: Error | undefined;
+    /**
+     * Abort the current request immediately, keep the records received so far.
+     */
+    stop: () => void;
+};
+export type UseSessionStreamOptions<TRecord> = UseApiClientOptions & {
+    id?: string;
+    enabled?: boolean;
+    /**
+     * Which channel of the session to read.
+     *
+     * @default "out"
+     */
+    io?: "out" | "in";
+    /**
+     * The number of milliseconds to throttle the record updates.
+     *
+     * @default 16
+     */
+    throttleInMs?: number;
+    /**
+     * The number of seconds to wait for new data to be available,
+     * If no data arrives within the timeout, the stream will be closed.
+     *
+     * @default 60 seconds
+     */
+    timeoutInSeconds?: number;
+    /**
+     * The cursor to resume from. If not provided, the channel is read from the beginning.
+     */
+    lastEventId?: string | number;
+    /**
+     * Where a fresh subscription (no `lastEventId`) starts reading.
+     *
+     * - `"beginning"` (default): replay the full channel history, then live-tail.
+     * - `"latest"`: start at the current tail (the latest record, then live
+     *   updates) instead of replaying history, for a last-value / live view.
+     *
+     * Ignored when `lastEventId` is set.
+     */
+    from?: "beginning" | "latest";
+    /**
+     * Cap the number of records kept in the accumulated `records` array. When more
+     * than `maxRecords` have been received, only the most recent `maxRecords` are
+     * retained. Use `maxRecords: 1` with `from: "latest"` for a last-value view
+     * with bounded memory. When unset, `records` accumulates without bound.
+     */
+    maxRecords?: number;
+    /**
+     * Callback invoked once per throttled flush with the batch of records in that
+     * flush, each carrying its event `id`, `chunk` and `timestamp`. Fires at the
+     * `throttleInMs` cadence (not per record) and includes control records, so it
+     * can track the resume cursor for everything on the channel.
+     */
+    onRecords?: (records: Array<SSEStreamPart<TRecord>>) => void;
+    /**
+     * Callback this is called when a control record is received (e.g. `turn-complete`).
+     */
+    onControl?: (event: ControlEvent) => void;
+};
+/**
+ * Hook to read one channel of a Session's realtime stream.
+ *
+ * This hook subscribes to one of the session's channels (`out` by default, or `in`) and
+ * updates the `records` array as new records arrive. It is read-only: use `useSession` for
+ * two-way (read and write) communication. The subscription is automatically managed: it
+ * starts when the component mounts (or when `enabled` becomes `true`) and stops when the
+ * component unmounts or when `stop()` is called.
+ *
+ * Requires a Public Access Token with the `read:sessions:{id}` scope.
+ *
+ * @template TRecord - The type of each record on the channel
+ * @param sessionIdOrExternalId - The id or external id of the session to subscribe to
+ * @param options - Optional configuration for the subscription
+ * @returns An object containing:
+ *   - `records`: An array of all the records received so far (accumulates over time)
+ *   - `lastEventId`: The cursor of the last record seen, for resuming later
+ *   - `lastControl`: The last control record seen
+ *   - `error`: Any error that occurred during subscription
+ *   - `stop`: A function to manually stop the subscription
+ *
+ * @example
+ * ```tsx
+ * "use client";
+ * import { useSessionStream } from "@trigger.dev/react-hooks";
+ *
+ * function SessionViewer({ sessionId }: { sessionId: string }) {
+ *   const { records, error } = useSessionStream<string>(sessionId, {
+ *     accessToken: publicAccessToken,
+ *   });
+ *
+ *   if (error) return <div>Error: {error.message}</div>;
+ *
+ *   return <div>{records.join("")}</div>;
+ * }
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // Read the input channel, resuming from a persisted cursor
+ * const { records, lastEventId, stop } = useSessionStream<MyRecord>(sessionId, {
+ *   accessToken: publicAccessToken,
+ *   io: "in",
+ *   lastEventId: persistedCursor,
+ *   onControl: (event) => {
+ *     if (event.subtype === "turn-complete") {
+ *       console.log("The turn is complete");
+ *     }
+ *   },
+ * });
+ * ```
+ */
+export declare function useSessionStream<TRecord = unknown>(sessionIdOrExternalId?: string, options?: UseSessionStreamOptions<TRecord>): UseSessionStreamInstance<TRecord>;

package/dist/esm/hooks/useSessionStream.js

@@ -0,0 +1,233 @@
+"use client";
+import { useCallback, useEffect, useId, useRef, useState } from "react";
+import { createThrottledQueue } from "../utils/throttle.js";
+import { useSWR } from "../utils/trigger-swr.js";
+import { useStableRequestCallback } from "../utils/useStableRequestCallback.js";
+import { useApiClient } from "./useApiClient.js";
+/**
+ * Hook to read one channel of a Session's realtime stream.
+ *
+ * This hook subscribes to one of the session's channels (`out` by default, or `in`) and
+ * updates the `records` array as new records arrive. It is read-only: use `useSession` for
+ * two-way (read and write) communication. The subscription is automatically managed: it
+ * starts when the component mounts (or when `enabled` becomes `true`) and stops when the
+ * component unmounts or when `stop()` is called.
+ *
+ * Requires a Public Access Token with the `read:sessions:{id}` scope.
+ *
+ * @template TRecord - The type of each record on the channel
+ * @param sessionIdOrExternalId - The id or external id of the session to subscribe to
+ * @param options - Optional configuration for the subscription
+ * @returns An object containing:
+ *   - `records`: An array of all the records received so far (accumulates over time)
+ *   - `lastEventId`: The cursor of the last record seen, for resuming later
+ *   - `lastControl`: The last control record seen
+ *   - `error`: Any error that occurred during subscription
+ *   - `stop`: A function to manually stop the subscription
+ *
+ * @example
+ * ```tsx
+ * "use client";
+ * import { useSessionStream } from "@trigger.dev/react-hooks";
+ *
+ * function SessionViewer({ sessionId }: { sessionId: string }) {
+ *   const { records, error } = useSessionStream<string>(sessionId, {
+ *     accessToken: publicAccessToken,
+ *   });
+ *
+ *   if (error) return <div>Error: {error.message}</div>;
+ *
+ *   return <div>{records.join("")}</div>;
+ * }
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // Read the input channel, resuming from a persisted cursor
+ * const { records, lastEventId, stop } = useSessionStream<MyRecord>(sessionId, {
+ *   accessToken: publicAccessToken,
+ *   io: "in",
+ *   lastEventId: persistedCursor,
+ *   onControl: (event) => {
+ *     if (event.subtype === "turn-complete") {
+ *       console.log("The turn is complete");
+ *     }
+ *   },
+ * });
+ * ```
+ */
+export function useSessionStream(sessionIdOrExternalId, options) {
+    const hookId = useId();
+    const idKey = options?.id ?? hookId;
+    const io = options?.io ?? "out";
+    const [initialRecordsFallback] = useState([]);
+    const { data: records, mutate: mutateRecords } = useSWR([idKey, sessionIdOrExternalId, io, "records"], null, {
+        fallbackData: initialRecordsFallback,
+    });
+    const recordsRef = useRef(records ?? []);
+    useEffect(() => {
+        recordsRef.current = records || [];
+    }, [records]);
+    const { data: lastEventId = undefined, mutate: setLastEventId } = useSWR([idKey, sessionIdOrExternalId, io, "lastEventId"], null);
+    const lastEventIdRef = useRef(lastEventId);
+    const channelIdentityRef = useRef(`${idKey}:${sessionIdOrExternalId}:${io}`);
+    useEffect(() => {
+        const identity = `${idKey}:${sessionIdOrExternalId}:${io}`;
+        if (channelIdentityRef.current !== identity) {
+            channelIdentityRef.current = identity;
+            lastEventIdRef.current = lastEventId;
+        }
+    }, [idKey, sessionIdOrExternalId, io, lastEventId]);
+    const { data: lastControl = undefined, mutate: setLastControl } = useSWR([idKey, sessionIdOrExternalId, io, "lastControl"], null);
+    const { data: _isComplete = false, mutate: setIsComplete } = useSWR([idKey, sessionIdOrExternalId, io, "complete"], null);
+    const { data: error = undefined, mutate: setError } = useSWR([idKey, sessionIdOrExternalId, io, "error"], null);
+    const abortControllerRef = useRef(null);
+    const stop = useCallback(() => {
+        if (abortControllerRef.current) {
+            abortControllerRef.current.abort();
+            abortControllerRef.current = null;
+        }
+    }, []);
+    const onRecordsCallback = options?.onRecords;
+    const onRecords = useCallback((recordsBatch) => {
+        if (onRecordsCallback) {
+            onRecordsCallback(recordsBatch);
+        }
+    }, [onRecordsCallback]);
+    const onControlCallback = options?.onControl;
+    const onControl = useCallback((event) => {
+        if (onControlCallback) {
+            onControlCallback(event);
+        }
+    }, [onControlCallback]);
+    const apiClient = useApiClient(options);
+    const timeoutInSeconds = options?.timeoutInSeconds;
+    const startEventId = options?.lastEventId;
+    const throttleInMs = options?.throttleInMs;
+    const from = options?.from;
+    const maxRecords = options?.maxRecords;
+    useEffect(() => {
+        if (maxRecords != null && maxRecords >= 0) {
+            const current = recordsRef.current;
+            if (current.length > maxRecords) {
+                mutateRecords(current.slice(current.length - maxRecords));
+            }
+        }
+    }, [maxRecords, mutateRecords]);
+    const triggerRequest = useCallback(async () => {
+        try {
+            if (!sessionIdOrExternalId || !apiClient) {
+                return;
+            }
+            const abortController = new AbortController();
+            abortControllerRef.current = abortController;
+            await processSessionStream(sessionIdOrExternalId, io, apiClient, mutateRecords, recordsRef, setLastEventId, setLastControl, setError, onRecords, onControl, abortControllerRef, timeoutInSeconds, startEventId !== undefined ? String(startEventId) : lastEventIdRef.current, throttleInMs ?? 16, from, maxRecords);
+        }
+        catch (err) {
+            if (err.name === "AbortError") {
+                abortControllerRef.current = null;
+                return;
+            }
+            setError(err);
+        }
+        finally {
+            if (abortControllerRef.current) {
+                abortControllerRef.current = null;
+            }
+            setIsComplete(true);
+        }
+    }, [
+        sessionIdOrExternalId,
+        io,
+        apiClient,
+        mutateRecords,
+        setLastEventId,
+        setLastControl,
+        setError,
+        setIsComplete,
+        onRecords,
+        onControl,
+        timeoutInSeconds,
+        startEventId,
+        throttleInMs,
+        from,
+        maxRecords,
+    ]);
+    const requestSubscription = useStableRequestCallback(triggerRequest);
+    useEffect(() => {
+        if (typeof options?.enabled === "boolean" && !options.enabled) {
+            return;
+        }
+        if (!sessionIdOrExternalId) {
+            return;
+        }
+        requestSubscription().finally(() => { });
+        return () => {
+            stop();
+        };
+    }, [sessionIdOrExternalId, io, stop, options?.enabled, requestSubscription]);
+    return { records: records ?? initialRecordsFallback, lastEventId, lastControl, error, stop };
+}
+async function processSessionStream(sessionIdOrExternalId, io, apiClient, mutateRecordsData, existingRecordsRef, setLastEventId, setLastControl, onError, onRecords, onControl, abortControllerRef, timeoutInSeconds, lastEventId, throttleInMs, from, maxRecords) {
+    let lastSeenEventId;
+    let publishedEventId;
+    let partsBatch = [];
+    const publishLastEventId = () => {
+        if (lastSeenEventId !== publishedEventId) {
+            publishedEventId = lastSeenEventId;
+            setLastEventId(lastSeenEventId);
+        }
+    };
+    const flushParts = () => {
+        if (partsBatch.length === 0)
+            return;
+        const batch = partsBatch;
+        partsBatch = [];
+        onRecords(batch);
+    };
+    try {
+        const stream = await apiClient.subscribeToSessionStream(sessionIdOrExternalId, io, {
+            signal: abortControllerRef.current?.signal,
+            timeoutInSeconds,
+            lastEventId,
+            from,
+            onPart: (part) => {
+                lastSeenEventId = part.id;
+                partsBatch.push(part);
+            },
+            onControl: (event) => {
+                setLastControl(event);
+                onControl(event);
+            },
+        });
+        const recordsQueue = createThrottledQueue(async (newRecords) => {
+            const combined = [...existingRecordsRef.current, ...newRecords];
+            const bounded = maxRecords != null && maxRecords >= 0 && combined.length > maxRecords
+                ? combined.slice(combined.length - maxRecords)
+                : combined;
+            existingRecordsRef.current = bounded;
+            mutateRecordsData(bounded);
+            publishLastEventId();
+            flushParts();
+        }, throttleInMs);
+        for await (const record of stream) {
+            recordsQueue.add(record);
+        }
+        await recordsQueue.flush();
+        publishLastEventId();
+        flushParts();
+    }
+    catch (err) {
+        if (err.name === "AbortError") {
+            return;
+        }
+        if (err instanceof Error) {
+            onError(err);
+        }
+        else {
+            onError(new Error(String(err)));
+        }
+        throw err;
+    }
+}
+//# sourceMappingURL=useSessionStream.js.map

package/dist/esm/hooks/useSessionStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSessionStream.js","sourceRoot":"","sources":["../../../src/hooks/useSessionStream.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAGb,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACxE,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAE5D,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACjD,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAEhF,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAoFjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,MAAM,UAAU,gBAAgB,CAC9B,qBAA8B,EAC9B,OAA0C;IAE1C,MAAM,MAAM,GAAG,KAAK,EAAE,CAAC;IACvB,MAAM,KAAK,GAAG,OAAO,EAAE,EAAE,IAAI,MAAM,CAAC;IACpC,MAAM,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,KAAK,CAAC;IAEhC,MAAM,CAAC,sBAAsB,CAAC,GAAG,QAAQ,CAAC,EAAoB,CAAC,CAAC;IAEhE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CACrD,CAAC,KAAK,EAAE,qBAAqB,EAAE,EAAE,EAAE,SAAS,CAAC,EAC7C,IAAI,EACJ;QACE,YAAY,EAAE,sBAAsB;KACrC,CACF,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAiB,OAAO,IAAK,EAAqB,CAAC,CAAC;IAC7E,SAAS,CAAC,GAAG,EAAE;QACb,UAAU,CAAC,OAAO,GAAG,OAAO,IAAK,EAAqB,CAAC;IACzD,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAEd,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,CACtE,CAAC,KAAK,EAAE,qBAAqB,EAAE,EAAE,EAAE,aAAa,CAAC,EACjD,IAAI,CACL,CAAC;IACF,MAAM,cAAc,GAAG,MAAM,CAAqB,WAAW,CAAC,CAAC;IAC/D,MAAM,kBAAkB,GAAG,MAAM,CAAC,GAAG,KAAK,IAAI,qBAAqB,IAAI,EAAE,EAAE,CAAC,CAAC;IAC7E,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,QAAQ,GAAG,GAAG,KAAK,IAAI,qBAAqB,IAAI,EAAE,EAAE,CAAC;QAC3D,IAAI,kBAAkB,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;YAC5C,kBAAkB,CAAC,OAAO,GAAG,QAAQ,CAAC;YACtC,cAAc,CAAC,OAAO,GAAG,WAAW,CAAC;QACvC,CAAC;IACH,CAAC,EAAE,CAAC,KAAK,EAAE,qBAAqB,EAAE,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC;IAEpD,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,CAEtE,CAAC,KAAK,EAAE,qBAAqB,EAAE,EAAE,EAAE,aAAa,CAAC,EAAE,IAAI,CAAC,CAAC;IAE3D,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CACjE,CAAC,KAAK,EAAE,qBAAqB,EAAE,EAAE,EAAE,UAAU,CAAC,EAC9C,IAAI,CACL,CAAC;IAEF,MAAM,EAAE,IAAI,EAAE,KAAK,GAAG,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAC1D,CAAC,KAAK,EAAE,qBAAqB,EAAE,EAAE,EAAE,OAAO,CAAC,EAC3C,IAAI,CACL,CAAC;IAEF,MAAM,kBAAkB,GAAG,MAAM,CAAyB,IAAI,CAAC,CAAC;IAEhE,MAAM,IAAI,GAAG,WAAW,CAAC,GAAG,EAAE;QAC5B,IAAI,kBAAkB,CAAC,OAAO,EAAE,CAAC;YAC/B,kBAAkB,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACnC,kBAAkB,CAAC,OAAO,GAAG,IAAI,CAAC;QACpC,CAAC;IACH,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,iBAAiB,GAAG,OAAO,EAAE,SAAS,CAAC;IAC7C,MAAM,SAAS,GAAG,WAAW,CAC3B,CAAC,YAA2C,EAAE,EAAE;QAC9C,IAAI,iBAAiB,EAAE,CAAC;YACtB,iBAAiB,CAAC,YAAY,CAAC,CAAC;QAClC,CAAC;IACH,CAAC,EACD,CAAC,iBAAiB,CAAC,CACpB,CAAC;IAEF,MAAM,iBAAiB,GAAG,OAAO,EAAE,SAAS,CAAC;IAC7C,MAAM,SAAS,GAAG,WAAW,CAC3B,CAAC,KAAmB,EAAE,EAAE;QACtB,IAAI,iBAAiB,EAAE,CAAC;YACtB,iBAAiB,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC,EACD,CAAC,iBAAiB,CAAC,CACpB,CAAC;IAEF,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IACxC,MAAM,gBAAgB,GAAG,OAAO,EAAE,gBAAgB,CAAC;IACnD,MAAM,YAAY,GAAG,OAAO,EAAE,WAAW,CAAC;IAC1C,MAAM,YAAY,GAAG,OAAO,EAAE,YAAY,CAAC;IAC3C,MAAM,IAAI,GAAG,OAAO,EAAE,IAAI,CAAC;IAC3B,MAAM,UAAU,GAAG,OAAO,EAAE,UAAU,CAAC;IAEvC,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,UAAU,IAAI,IAAI,IAAI,UAAU,IAAI,CAAC,EAAE,CAAC;YAC1C,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;YACnC,IAAI,OAAO,CAAC,MAAM,GAAG,UAAU,EAAE,CAAC;gBAChC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC;IACH,CAAC,EAAE,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC;IAEhC,MAAM,cAAc,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE;QAC5C,IAAI,CAAC;YACH,IAAI,CAAC,qBAAqB,IAAI,CAAC,SAAS,EAAE,CAAC;gBACzC,OAAO;YACT,CAAC;YAED,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;YAC9C,kBAAkB,CAAC,OAAO,GAAG,eAAe,CAAC;YAE7C,MAAM,oBAAoB,CACxB,qBAAqB,EACrB,EAAE,EACF,SAAS,EACT,aAAa,EACb,UAAU,EACV,cAAc,EACd,cAAc,EACd,QAAQ,EACR,SAAS,EACT,SAAS,EACT,kBAAkB,EAClB,gBAAgB,EAChB,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,EAC1E,YAAY,IAAI,EAAE,EAClB,IAAI,EACJ,UAAU,CACX,CAAC;QACJ,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAK,GAAW,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gBACvC,kBAAkB,CAAC,OAAO,GAAG,IAAI,CAAC;gBAClC,OAAO;YACT,CAAC;YAED,QAAQ,CAAC,GAAY,CAAC,CAAC;QACzB,CAAC;gBAAS,CAAC;YACT,IAAI,kBAAkB,CAAC,OAAO,EAAE,CAAC;gBAC/B,kBAAkB,CAAC,OAAO,GAAG,IAAI,CAAC;YACpC,CAAC;YAED,aAAa,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;IACH,CAAC,EAAE;QACD,qBAAqB;QACrB,EAAE;QACF,SAAS;QACT,aAAa;QACb,cAAc;QACd,cAAc;QACd,QAAQ;QACR,aAAa;QACb,SAAS;QACT,SAAS;QACT,gBAAgB;QAChB,YAAY;QACZ,YAAY;QACZ,IAAI;QACJ,UAAU;KACX,CAAC,CAAC;IACH,MAAM,mBAAmB,GAAG,wBAAwB,CAAC,cAAc,CAAC,CAAC;IAErE,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,OAAO,OAAO,EAAE,OAAO,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YAC9D,OAAO;QACT,CAAC;QAED,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAC3B,OAAO;QACT,CAAC;QAED,mBAAmB,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAExC,OAAO,GAAG,EAAE;YACV,IAAI,EAAE,CAAC;QACT,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,qBAAqB,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAE7E,OAAO,EAAE,OAAO,EAAE,OAAO,IAAI,sBAAsB,EAAE,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AAC/F,CAAC;AAED,KAAK,UAAU,oBAAoB,CACjC,qBAA6B,EAC7B,EAAgB,EAChB,SAAoB,EACpB,iBAA+C,EAC/C,kBAA0D,EAC1D,cAAgD,EAChD,cAAsD,EACtD,OAA2B,EAC3B,SAA2D,EAC3D,SAAwC,EACxC,kBAAkE,EAClE,gBAAyB,EACzB,WAAoB,EACpB,YAAqB,EACrB,IAA6B,EAC7B,UAAmB;IAEnB,IAAI,eAAmC,CAAC;IACxC,IAAI,gBAAoC,CAAC;IACzC,IAAI,UAAU,GAAkC,EAAE,CAAC;IAEnD,MAAM,kBAAkB,GAAG,GAAG,EAAE;QAC9B,IAAI,eAAe,KAAK,gBAAgB,EAAE,CAAC;YACzC,gBAAgB,GAAG,eAAe,CAAC;YACnC,cAAc,CAAC,eAAe,CAAC,CAAC;QAClC,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,UAAU,GAAG,GAAG,EAAE;QACtB,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QACpC,MAAM,KAAK,GAAG,UAAU,CAAC;QACzB,UAAU,GAAG,EAAE,CAAC;QAChB,SAAS,CAAC,KAAK,CAAC,CAAC;IACnB,CAAC,CAAC;IAEF,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,wBAAwB,CAAU,qBAAqB,EAAE,EAAE,EAAE;YAC1F,MAAM,EAAE,kBAAkB,CAAC,OAAO,EAAE,MAAM;YAC1C,gBAAgB;YAChB,WAAW;YACX,IAAI;YACJ,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;gBACf,eAAe,GAAG,IAAI,CAAC,EAAE,CAAC;gBAC1B,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxB,CAAC;YACD,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;gBACnB,cAAc,CAAC,KAAK,CAAC,CAAC;gBACtB,SAAS,CAAC,KAAK,CAAC,CAAC;YACnB,CAAC;SACF,CAAC,CAAC;QAEH,MAAM,YAAY,GAAG,oBAAoB,CAAU,KAAK,EAAE,UAAU,EAAE,EAAE;YACtE,MAAM,QAAQ,GAAG,CAAC,GAAG,kBAAkB,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;YAChE,MAAM,OAAO,GACX,UAAU,IAAI,IAAI,IAAI,UAAU,IAAI,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,UAAU;gBACnE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,UAAU,CAAC;gBAC9C,CAAC,CAAC,QAAQ,CAAC;YACf,kBAAkB,CAAC,OAAO,GAAG,OAAO,CAAC;YACrC,iBAAiB,CAAC,OAAO,CAAC,CAAC;YAC3B,kBAAkB,EAAE,CAAC;YACrB,UAAU,EAAE,CAAC;QACf,CAAC,EAAE,YAAY,CAAC,CAAC;QAEjB,IAAI,KAAK,EAAE,MAAM,MAAM,IAAI,MAAM,EAAE,CAAC;YAClC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC3B,CAAC;QAED,MAAM,YAAY,CAAC,KAAK,EAAE,CAAC;QAC3B,kBAAkB,EAAE,CAAC;QACrB,UAAU,EAAE,CAAC;IACf,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAK,GAAW,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;YACvC,OAAO;QACT,CAAC;QAED,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;YACzB,OAAO,CAAC,GAAG,CAAC,CAAC;QACf,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAClC,CAAC;QAED,MAAM,GAAG,CAAC;IACZ,CAAC;AACH,CAAC"}

package/dist/esm/hooks/useSessionStreamChannel.d.ts

@@ -0,0 +1,86 @@
+import type { AnySessionChannel, ControlEvent, SessionChannelIn, SessionChannelName, SessionChannelOut, SSEStreamPart } from "@trigger.dev/core/v3";
+import type { UseApiClientOptions } from "./useApiClient.js";
+type ChannelRecord<TChannel extends AnySessionChannel, S extends "in" | "out"> = S extends "out" ? SessionChannelOut<TChannel> : SessionChannelIn<TChannel>;
+export type UseSessionStreamChannelInstance<TRecord> = {
+    /** The records received so far on the channel, in arrival order. */
+    records: Array<TRecord>;
+    /** The cursor of the last record seen; pass back as `lastEventId` to resume. */
+    lastEventId: string | undefined;
+    /** The last control record seen on the channel. */
+    lastControl: ControlEvent | undefined;
+    error: Error | undefined;
+    /** Abort the current request immediately, keep the records received so far. */
+    stop: () => void;
+};
+export type UseSessionStreamChannelOptions<TChannel extends AnySessionChannel, S extends "in" | "out"> = UseApiClientOptions & {
+    /**
+     * The id or external id of the session that owns the channel. May be
+     * undefined while it resolves; the subscription starts once it is set.
+     */
+    sessionId?: string;
+    id?: string;
+    enabled?: boolean;
+    /**
+     * Which side of the channel to read.
+     *
+     * @default "out"
+     */
+    io?: S;
+    /**
+     * The number of milliseconds to throttle the record updates.
+     *
+     * @default 16
+     */
+    throttleInMs?: number;
+    /**
+     * The number of seconds to wait for new data before the stream closes.
+     *
+     * @default 60 seconds
+     */
+    timeoutInSeconds?: number;
+    /** The cursor to resume from. If not provided, reads per `from`. */
+    lastEventId?: string | number;
+    /**
+     * Where a fresh subscription (no `lastEventId`) starts reading.
+     *
+     * - `"beginning"` (default): replay the full channel history, then live-tail.
+     * - `"latest"`: start at the current tail, for a last-value / live view.
+     *
+     * Ignored when `lastEventId` is set.
+     */
+    from?: "beginning" | "latest";
+    /**
+     * Cap the number of records kept in `records`. Use `maxRecords: 1` with
+     * `from: "latest"` for a bounded last-value view.
+     */
+    maxRecords?: number;
+    /** Invoked once per throttled flush with the batch of records (control records included). */
+    onRecords?: (records: Array<SSEStreamPart<ChannelRecord<TChannel, S>>>) => void;
+    /** Called when a control record is received on the channel. */
+    onControl?: (event: ControlEvent) => void;
+};
+/**
+ * Read one side of a named Session side channel, with record types inferred
+ * from a `defineSessionChannel` declaration passed as the type argument.
+ *
+ * The channel name is typesafe (`SessionChannelName<TChannel>`) and `records`
+ * is typed from the channel's `.out` / `.in` record type. Called without the
+ * type argument, the channel name is any string and `records` is `unknown`.
+ *
+ * Requires a Public Access Token scoped to the session (or to the channel).
+ *
+ * @example
+ * ```tsx
+ * import type { screenshotsChannel } from "./shared/channels";
+ *
+ * const { records } = useSessionStreamChannel<typeof screenshotsChannel>("screenshots", {
+ *   sessionId,
+ *   accessToken,
+ *   io: "out",
+ *   from: "latest",
+ *   maxRecords: 1,
+ * });
+ * ```
+ */
+export declare function useSessionStreamChannel<TChannel extends AnySessionChannel = AnySessionChannel, S extends "in" | "out" = "out">(channel: SessionChannelName<TChannel>, options: UseSessionStreamChannelOptions<TChannel, S>): UseSessionStreamChannelInstance<ChannelRecord<TChannel, S>>;
+export {};