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

package/dist/esm/hooks/useSessionStreamChannel.js

@@ -0,0 +1,206 @@
+"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";
+/**
+ * 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 function useSessionStreamChannel(channel, options) {
+    const hookId = useId();
+    const idKey = options.id ?? hookId;
+    const io = (options.io ?? "out");
+    const sessionId = options.sessionId;
+    const channelName = channel;
+    const [initialRecordsFallback] = useState([]);
+    const { data: records, mutate: mutateRecords } = useSWR([idKey, sessionId, channelName, io, "records"], null, { fallbackData: initialRecordsFallback });
+    const recordsRef = useRef(records ?? []);
+    useEffect(() => {
+        recordsRef.current = records || [];
+    }, [records]);
+    const { data: lastEventId = undefined, mutate: setLastEventId } = useSWR([idKey, sessionId, channelName, io, "lastEventId"], null);
+    const lastEventIdRef = useRef(lastEventId);
+    const channelIdentityRef = useRef(`${idKey}:${sessionId}:${channelName}:${io}`);
+    useEffect(() => {
+        const identity = `${idKey}:${sessionId}:${channelName}:${io}`;
+        if (channelIdentityRef.current !== identity) {
+            channelIdentityRef.current = identity;
+            lastEventIdRef.current = lastEventId;
+        }
+    }, [idKey, sessionId, channelName, io, lastEventId]);
+    const { data: lastControl = undefined, mutate: setLastControl } = useSWR([idKey, sessionId, channelName, io, "lastControl"], null);
+    const { data: _isComplete = false, mutate: setIsComplete } = useSWR([idKey, sessionId, channelName, io, "complete"], null);
+    const { data: error = undefined, mutate: setError } = useSWR([idKey, sessionId, channelName, 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 () => {
+        let abortController = null;
+        try {
+            if (!sessionId || !apiClient) {
+                return;
+            }
+            abortController = new AbortController();
+            abortControllerRef.current = abortController;
+            await processSessionChannelStream(sessionId, io, channelName, 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") {
+                return;
+            }
+            setError(err);
+        }
+        finally {
+            if (abortControllerRef.current === abortController) {
+                abortControllerRef.current = null;
+            }
+            setIsComplete(true);
+        }
+    }, [
+        sessionId,
+        io,
+        channelName,
+        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 (!sessionId) {
+            return;
+        }
+        requestSubscription().finally(() => { });
+        return () => {
+            stop();
+        };
+    }, [sessionId, channelName, io, stop, options.enabled, requestSubscription]);
+    return { records: records ?? initialRecordsFallback, lastEventId, lastControl, error, stop };
+}
+async function processSessionChannelStream(sessionIdOrExternalId, io, channel, 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,
+            channel,
+            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=useSessionStreamChannel.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useSessionStreamChannel.js","sourceRoot":"","sources":["../../../src/hooks/useSessionStreamChannel.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAWb,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;AAqEjD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,uBAAuB,CAIrC,OAAqC,EACrC,OAAoD;IAIpD,MAAM,MAAM,GAAG,KAAK,EAAE,CAAC;IACvB,MAAM,KAAK,GAAG,OAAO,CAAC,EAAE,IAAI,MAAM,CAAC;IACnC,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,EAAE,IAAI,KAAK,CAAiB,CAAC;IACjD,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IACpC,MAAM,WAAW,GAAG,OAAiB,CAAC;IAEtC,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,SAAS,EAAE,WAAW,EAAE,EAAE,EAAE,SAAS,CAAC,EAC9C,IAAI,EACJ,EAAE,YAAY,EAAE,sBAAsB,EAAE,CACzC,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,SAAS,EAAE,WAAW,EAAE,EAAE,EAAE,aAAa,CAAC,EAClD,IAAI,CACL,CAAC;IACF,MAAM,cAAc,GAAG,MAAM,CAAqB,WAAW,CAAC,CAAC;IAC/D,MAAM,kBAAkB,GAAG,MAAM,CAAC,GAAG,KAAK,IAAI,SAAS,IAAI,WAAW,IAAI,EAAE,EAAE,CAAC,CAAC;IAChF,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,QAAQ,GAAG,GAAG,KAAK,IAAI,SAAS,IAAI,WAAW,IAAI,EAAE,EAAE,CAAC;QAC9D,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,SAAS,EAAE,WAAW,EAAE,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC;IAErD,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,CAEtE,CAAC,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE,EAAE,aAAa,CAAC,EAAE,IAAI,CAAC,CAAC;IAE5D,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CACjE,CAAC,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE,EAAE,UAAU,CAAC,EAC/C,IAAI,CACL,CAAC;IAEF,MAAM,EAAE,IAAI,EAAE,KAAK,GAAG,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAC1D,CAAC,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE,EAAE,OAAO,CAAC,EAC5C,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,CAAC,SAAS,CAAC;IAC5C,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,CAAC,SAAS,CAAC;IAC5C,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,CAAC,gBAAgB,CAAC;IAClD,MAAM,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;IACzC,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IAC1C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAC1B,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IAEtC,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,eAAe,GAA2B,IAAI,CAAC;QACnD,IAAI,CAAC;YACH,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,EAAE,CAAC;gBAC7B,OAAO;YACT,CAAC;YAED,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;YACxC,kBAAkB,CAAC,OAAO,GAAG,eAAe,CAAC;YAE7C,MAAM,2BAA2B,CAC/B,SAAS,EACT,EAAE,EACF,WAAW,EACX,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,OAAO;YACT,CAAC;YAED,QAAQ,CAAC,GAAY,CAAC,CAAC;QACzB,CAAC;gBAAS,CAAC;YACT,IAAI,kBAAkB,CAAC,OAAO,KAAK,eAAe,EAAE,CAAC;gBACnD,kBAAkB,CAAC,OAAO,GAAG,IAAI,CAAC;YACpC,CAAC;YAED,aAAa,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;IACH,CAAC,EAAE;QACD,SAAS;QACT,EAAE;QACF,WAAW;QACX,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,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YAC7D,OAAO;QACT,CAAC;QAED,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,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,SAAS,EAAE,WAAW,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,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,2BAA2B,CACxC,qBAA6B,EAC7B,EAAgB,EAChB,OAAe,EACf,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,OAAO;YACP,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/useTaskTrigger.d.ts

@@ -0,0 +1,107 @@
+import { type InferRunTypes, type RunHandleFromTypes, type AnyTask, type TaskIdentifier, type TaskPayload, type TriggerOptions, type RealtimeRunSkipColumns } from "@trigger.dev/core/v3";
+import { type UseApiClientOptions } from "./useApiClient.js";
+import { type UseRealtimeRunInstance, type UseRealtimeRunWithStreamsInstance } from "./useRealtime.js";
+/**
+ * Base interface for task trigger instances.
+ *
+ * @template TTask - The type of the task
+ */
+export interface TriggerInstance<TTask extends AnyTask> {
+    /** Function to submit the task with a payload */
+    submit: (payload: TaskPayload<TTask>, options?: TriggerOptions) => void;
+    /** Whether the task is currently being submitted */
+    isLoading: boolean;
+    /** The handle returned after successful task submission */
+    handle?: RunHandleFromTypes<InferRunTypes<TTask>>;
+    /** Any error that occurred during submission */
+    error?: Error;
+}
+export type UseTaskTriggerOptions = UseApiClientOptions;
+/**
+ * Hook to trigger a task and manage its initial execution state.
+ *
+ * @template TTask - The type of the task
+ * @param {TaskIdentifier<TTask>} id - The identifier of the task to trigger
+ * @param {UseTaskTriggerOptions} [options] - Configuration options for the task trigger
+ * @returns {TriggerInstance<TTask>} An object containing the submit function, loading state, handle, and any errors
+ *
+ * @example
+ * ```ts
+ * import type { myTask } from './path/to/task';
+ * const { submit, isLoading, handle, error } = useTaskTrigger<typeof myTask>('my-task-id');
+ *
+ * // Submit the task with payload
+ * submit({ foo: 'bar' });
+ * ```
+ */
+export declare function useTaskTrigger<TTask extends AnyTask>(id: TaskIdentifier<TTask>, options?: UseTaskTriggerOptions): TriggerInstance<TTask>;
+/**
+ * Configuration options for task triggers with realtime updates.
+ */
+export type UseRealtimeTaskTriggerOptions = UseTaskTriggerOptions & {
+    /** Whether the realtime subscription is enabled */
+    enabled?: boolean;
+    /** Optional throttle time in milliseconds for stream updates */
+    experimental_throttleInMs?: number;
+    /**
+     * Skip columns from the subscription.
+     *
+     * @default []
+     */
+    skipColumns?: RealtimeRunSkipColumns;
+};
+export type RealtimeTriggerInstanceWithStreams<TTask extends AnyTask, TStreams extends Record<string, any> = Record<string, any>> = UseRealtimeRunWithStreamsInstance<TTask, TStreams> & {
+    submit: (payload: TaskPayload<TTask>, options?: TriggerOptions) => void;
+    isLoading: boolean;
+    handle?: RunHandleFromTypes<InferRunTypes<TTask>>;
+};
+/**
+ * Hook to trigger a task and subscribe to its realtime updates including stream data.
+ *
+ * @template TTask - The type of the task
+ * @template TStreams - The type of the streams data
+ * @param {TaskIdentifier<TTask>} id - The identifier of the task to trigger
+ * @param {UseRealtimeTaskTriggerOptions} [options] - Configuration options for the task trigger and realtime updates
+ * @returns {RealtimeTriggerInstanceWithStreams<TTask, TStreams>} An object containing the submit function, loading state,
+ *          handle, run state, streams data, and error handling
+ *
+ * @example
+ * ```ts
+ * import type { myTask } from './path/to/task';
+ * const { submit, run, streams, error } = useRealtimeTaskTriggerWithStreams<
+ *   typeof myTask,
+ *   { output: string }
+ * >('my-task-id');
+ *
+ * // Submit and monitor the task with streams
+ * submit({ foo: 'bar' });
+ * ```
+ */
+export declare function useRealtimeTaskTriggerWithStreams<TTask extends AnyTask, TStreams extends Record<string, any> = Record<string, any>>(id: TaskIdentifier<TTask>, options?: UseRealtimeTaskTriggerOptions): RealtimeTriggerInstanceWithStreams<TTask, TStreams>;
+export type RealtimeTriggerInstance<TTask extends AnyTask> = UseRealtimeRunInstance<TTask> & {
+    submit: (payload: TaskPayload<TTask>, options?: TriggerOptions) => void;
+    isLoading: boolean;
+    handle?: RunHandleFromTypes<InferRunTypes<TTask>>;
+};
+/**
+ * Hook to trigger a task and subscribe to its realtime updates.
+ *
+ * @template TTask - The type of the task
+ * @param {TaskIdentifier<TTask>} id - The identifier of the task to trigger
+ * @param {UseRealtimeTaskTriggerOptions} [options] - Configuration options for the task trigger and realtime updates
+ * @returns {RealtimeTriggerInstance<TTask>} An object containing the submit function, loading state,
+ *          handle, run state, and error handling
+ *
+ * @example
+ * ```ts
+ * import type { myTask } from './path/to/task';
+ * const { submit, run, error, stop } = useRealtimeTaskTrigger<typeof myTask>('my-task-id');
+ *
+ * // Submit and monitor the task
+ * submit({ foo: 'bar' });
+ *
+ * // Stop monitoring when needed
+ * stop();
+ * ```
+ */
+export declare function useRealtimeTaskTrigger<TTask extends AnyTask>(id: TaskIdentifier<TTask>, options?: UseRealtimeTaskTriggerOptions): RealtimeTriggerInstance<TTask>;

package/dist/esm/hooks/useTaskTrigger.js

@@ -0,0 +1,131 @@
+"use client";
+import { makeIdempotencyKey, stringifyIO, } from "@trigger.dev/core/v3";
+import useSWRMutation from "swr/mutation";
+import { useApiClient } from "./useApiClient.js";
+import { useRealtimeRun, useRealtimeRunWithStreams, } from "./useRealtime.js";
+/**
+ * Hook to trigger a task and manage its initial execution state.
+ *
+ * @template TTask - The type of the task
+ * @param {TaskIdentifier<TTask>} id - The identifier of the task to trigger
+ * @param {UseTaskTriggerOptions} [options] - Configuration options for the task trigger
+ * @returns {TriggerInstance<TTask>} An object containing the submit function, loading state, handle, and any errors
+ *
+ * @example
+ * ```ts
+ * import type { myTask } from './path/to/task';
+ * const { submit, isLoading, handle, error } = useTaskTrigger<typeof myTask>('my-task-id');
+ *
+ * // Submit the task with payload
+ * submit({ foo: 'bar' });
+ * ```
+ */
+export function useTaskTrigger(id, options) {
+    const apiClient = useApiClient(options);
+    async function triggerTask(id, { arg: { payload, options }, }) {
+        if (!apiClient) {
+            throw new Error("Could not trigger task in useTaskTrigger: Missing access token");
+        }
+        const payloadPacket = await stringifyIO(payload);
+        const handle = await apiClient.triggerTask(id, {
+            payload: payloadPacket.data,
+            options: {
+                queue: options?.queue ? { name: options.queue } : undefined,
+                concurrencyKey: options?.concurrencyKey,
+                payloadType: payloadPacket.dataType,
+                idempotencyKey: await makeIdempotencyKey(options?.idempotencyKey),
+                delay: options?.delay,
+                ttl: options?.ttl,
+                tags: options?.tags,
+                maxAttempts: options?.maxAttempts,
+                metadata: options?.metadata,
+                maxDuration: options?.maxDuration,
+                lockToVersion: options?.version,
+                debounce: options?.debounce,
+            },
+        });
+        return { ...handle, taskIdentifier: id };
+    }
+    const mutation = useSWRMutation(id, triggerTask);
+    return {
+        submit: (payload, options) => {
+            // trigger the task with the given payload
+            mutation.trigger({ payload, options });
+        },
+        isLoading: mutation.isMutating,
+        handle: mutation.data,
+        error: mutation.error,
+    };
+}
+/**
+ * Hook to trigger a task and subscribe to its realtime updates including stream data.
+ *
+ * @template TTask - The type of the task
+ * @template TStreams - The type of the streams data
+ * @param {TaskIdentifier<TTask>} id - The identifier of the task to trigger
+ * @param {UseRealtimeTaskTriggerOptions} [options] - Configuration options for the task trigger and realtime updates
+ * @returns {RealtimeTriggerInstanceWithStreams<TTask, TStreams>} An object containing the submit function, loading state,
+ *          handle, run state, streams data, and error handling
+ *
+ * @example
+ * ```ts
+ * import type { myTask } from './path/to/task';
+ * const { submit, run, streams, error } = useRealtimeTaskTriggerWithStreams<
+ *   typeof myTask,
+ *   { output: string }
+ * >('my-task-id');
+ *
+ * // Submit and monitor the task with streams
+ * submit({ foo: 'bar' });
+ * ```
+ */
+export function useRealtimeTaskTriggerWithStreams(id, options) {
+    const triggerInstance = useTaskTrigger(id, options);
+    const realtimeInstance = useRealtimeRunWithStreams(triggerInstance.handle?.id, {
+        ...options,
+        id: triggerInstance.handle?.id,
+        accessToken: triggerInstance.handle?.publicAccessToken ?? options?.accessToken,
+    });
+    return {
+        ...realtimeInstance,
+        ...triggerInstance,
+    };
+}
+/**
+ * Hook to trigger a task and subscribe to its realtime updates.
+ *
+ * @template TTask - The type of the task
+ * @param {TaskIdentifier<TTask>} id - The identifier of the task to trigger
+ * @param {UseRealtimeTaskTriggerOptions} [options] - Configuration options for the task trigger and realtime updates
+ * @returns {RealtimeTriggerInstance<TTask>} An object containing the submit function, loading state,
+ *          handle, run state, and error handling
+ *
+ * @example
+ * ```ts
+ * import type { myTask } from './path/to/task';
+ * const { submit, run, error, stop } = useRealtimeTaskTrigger<typeof myTask>('my-task-id');
+ *
+ * // Submit and monitor the task
+ * submit({ foo: 'bar' });
+ *
+ * // Stop monitoring when needed
+ * stop();
+ * ```
+ */
+export function useRealtimeTaskTrigger(id, options) {
+    const triggerInstance = useTaskTrigger(id, options);
+    const realtimeInstance = useRealtimeRun(triggerInstance.handle?.id, {
+        ...options,
+        id: triggerInstance.handle?.id,
+        accessToken: triggerInstance.handle?.publicAccessToken ?? options?.accessToken,
+    });
+    return {
+        submit: triggerInstance.submit,
+        isLoading: triggerInstance.isLoading,
+        handle: triggerInstance.handle,
+        run: realtimeInstance.run,
+        error: realtimeInstance.error ?? triggerInstance.error,
+        stop: realtimeInstance.stop,
+    };
+}
+//# sourceMappingURL=useTaskTrigger.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useTaskTrigger.js","sourceRoot":"","sources":["../../../src/hooks/useTaskTrigger.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAML,kBAAkB,EAClB,WAAW,GAGZ,MAAM,sBAAsB,CAAC;AAC9B,OAAO,cAAc,MAAM,cAAc,CAAC;AAC1C,OAAO,EAA4B,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAC3E,OAAO,EAGL,cAAc,EACd,yBAAyB,GAC1B,MAAM,kBAAkB,CAAC;AAoB1B;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,cAAc,CAC5B,EAAyB,EACzB,OAA+B;IAE/B,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAExC,KAAK,UAAU,WAAW,CACxB,EAAU,EACV,EACE,GAAG,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,GAC0C;QAErE,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;QACpF,CAAC;QAED,MAAM,aAAa,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,CAAC;QAEjD,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,WAAW,CAAC,EAAE,EAAE;YAC7C,OAAO,EAAE,aAAa,CAAC,IAAI;YAC3B,OAAO,EAAE;gBACP,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS;gBAC3D,cAAc,EAAE,OAAO,EAAE,cAAc;gBACvC,WAAW,EAAE,aAAa,CAAC,QAAQ;gBACnC,cAAc,EAAE,MAAM,kBAAkB,CAAC,OAAO,EAAE,cAAc,CAAC;gBACjE,KAAK,EAAE,OAAO,EAAE,KAAK;gBACrB,GAAG,EAAE,OAAO,EAAE,GAAG;gBACjB,IAAI,EAAE,OAAO,EAAE,IAAI;gBACnB,WAAW,EAAE,OAAO,EAAE,WAAW;gBACjC,QAAQ,EAAE,OAAO,EAAE,QAAQ;gBAC3B,WAAW,EAAE,OAAO,EAAE,WAAW;gBACjC,aAAa,EAAE,OAAO,EAAE,OAAO;gBAC/B,QAAQ,EAAE,OAAO,EAAE,QAAQ;aAC5B;SACF,CAAC,CAAC;QAEH,OAAO,EAAE,GAAG,MAAM,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC;IAC3C,CAAC;IAED,MAAM,QAAQ,GAAG,cAAc,CAAC,EAAY,EAAE,WAAW,CAAC,CAAC;IAE3D,OAAO;QACL,MAAM,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;YAC3B,0CAA0C;YAC1C,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QACzC,CAAC;QACD,SAAS,EAAE,QAAQ,CAAC,UAAU;QAC9B,MAAM,EAAE,QAAQ,CAAC,IAAgD;QACjE,KAAK,EAAE,QAAQ,CAAC,KAAK;KACtB,CAAC;AACJ,CAAC;AA4BD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,iCAAiC,CAI/C,EAAyB,EACzB,OAAuC;IAEvC,MAAM,eAAe,GAAG,cAAc,CAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,MAAM,gBAAgB,GAAG,yBAAyB,CAAkB,eAAe,CAAC,MAAM,EAAE,EAAE,EAAE;QAC9F,GAAG,OAAO;QACV,EAAE,EAAE,eAAe,CAAC,MAAM,EAAE,EAAE;QAC9B,WAAW,EAAE,eAAe,CAAC,MAAM,EAAE,iBAAiB,IAAI,OAAO,EAAE,WAAW;KAC/E,CAAC,CAAC;IAEH,OAAO;QACL,GAAG,gBAAgB;QACnB,GAAG,eAAe;KACnB,CAAC;AACJ,CAAC;AAQD;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,MAAM,UAAU,sBAAsB,CACpC,EAAyB,EACzB,OAAuC;IAEvC,MAAM,eAAe,GAAG,cAAc,CAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,MAAM,gBAAgB,GAAG,cAAc,CAAQ,eAAe,CAAC,MAAM,EAAE,EAAE,EAAE;QACzE,GAAG,OAAO;QACV,EAAE,EAAE,eAAe,CAAC,MAAM,EAAE,EAAE;QAC9B,WAAW,EAAE,eAAe,CAAC,MAAM,EAAE,iBAAiB,IAAI,OAAO,EAAE,WAAW;KAC/E,CAAC,CAAC;IAEH,OAAO;QACL,MAAM,EAAE,eAAe,CAAC,MAAM;QAC9B,SAAS,EAAE,eAAe,CAAC,SAAS;QACpC,MAAM,EAAE,eAAe,CAAC,MAAM;QAC9B,GAAG,EAAE,gBAAgB,CAAC,GAAG;QACzB,KAAK,EAAE,gBAAgB,CAAC,KAAK,IAAI,eAAe,CAAC,KAAK;QACtD,IAAI,EAAE,gBAAgB,CAAC,IAAI;KAC5B,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,35 @@
+import type { UseApiClientOptions } from "./useApiClient.js";
+/**
+ * Base interface for task trigger instances.
+ *
+ * @template TOutput - The type of the output
+ */
+export interface WaitTokenInstance<TOutput> {
+    /** Function to complete the waitpoint with an output */
+    complete: (output: TOutput) => void;
+    /** Whether the waitpoint is currently being completed */
+    isLoading: boolean;
+    /** Whether the waitpoint has been completed */
+    isCompleted: boolean;
+    /** Any error that occurred during completion */
+    error?: Error;
+    /** Whether the waitpoint is ready to be completed */
+    isReady: boolean;
+}
+/**
+ * Hook to complete a waitpoint and manage its completion state.
+ *
+ * @template TOutput - The type of the output
+ * @param {string} waitpointId - The identifier of the waitpoint to complete
+ * @returns {WaitTokenInstance<TOutput>} An object containing the complete function, loading state, isCompleted, and any errors
+ *
+ * @example
+ * ```ts
+ * import type { myTask } from './path/to/task';
+ * const { complete, isLoading, isCompleted, error } = useWaitToken('waitpoint-id');
+ *
+ * // Complete the waitpoint with an output
+ * complete({ foo: 'bar' });
+ * ```
+ */
+export declare function useWaitToken<TOutput>(waitpointId?: string, options?: UseApiClientOptions): WaitTokenInstance<TOutput>;

package/dist/esm/hooks/useWaitToken.js

@@ -0,0 +1,46 @@
+"use client";
+import useSWRMutation from "swr/mutation";
+import { useApiClient } from "./useApiClient.js";
+/**
+ * Hook to complete a waitpoint and manage its completion state.
+ *
+ * @template TOutput - The type of the output
+ * @param {string} waitpointId - The identifier of the waitpoint to complete
+ * @returns {WaitTokenInstance<TOutput>} An object containing the complete function, loading state, isCompleted, and any errors
+ *
+ * @example
+ * ```ts
+ * import type { myTask } from './path/to/task';
+ * const { complete, isLoading, isCompleted, error } = useWaitToken('waitpoint-id');
+ *
+ * // Complete the waitpoint with an output
+ * complete({ foo: 'bar' });
+ * ```
+ */
+export function useWaitToken(waitpointId, options) {
+    const apiClient = useApiClient(options);
+    async function completeWaitpoint(id, { arg: { output } }) {
+        if (!apiClient) {
+            throw new Error("Could not complete waitpoint in useWaitToken: Missing access token");
+        }
+        if (!waitpointId) {
+            throw new Error("Could not complete waitpoint in useWaitToken: Missing waitpoint ID");
+        }
+        const result = await apiClient.completeWaitpointToken(waitpointId, {
+            data: output,
+        });
+        return result;
+    }
+    const mutation = useSWRMutation(waitpointId, completeWaitpoint);
+    return {
+        complete: (output) => {
+            // trigger the task with the given payload
+            mutation.trigger({ output });
+        },
+        isLoading: mutation.isMutating,
+        isCompleted: !!mutation.data?.success,
+        isReady: !!waitpointId,
+        error: mutation.error,
+    };
+}
+//# sourceMappingURL=useWaitToken.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useWaitToken.js","sourceRoot":"","sources":["../../../src/hooks/useWaitToken.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,cAAc,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAoBjD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,YAAY,CAC1B,WAAoB,EACpB,OAA6B;IAE7B,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAExC,KAAK,UAAU,iBAAiB,CAAC,EAAU,EAAE,EAAE,GAAG,EAAE,EAAE,MAAM,EAAE,EAAgC;QAC5F,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;QACxF,CAAC;QAED,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;QACxF,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,sBAAsB,CAAC,WAAW,EAAE;YACjE,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,QAAQ,GAAG,cAAc,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC;IAEhE,OAAO;QACL,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE;YACnB,0CAA0C;YAC1C,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QAC/B,CAAC;QACD,SAAS,EAAE,QAAQ,CAAC,UAAU;QAC9B,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO;QACrC,OAAO,EAAE,CAAC,CAAC,WAAW;QACtB,KAAK,EAAE,QAAQ,CAAC,KAAK;KACtB,CAAC;AACJ,CAAC"}

package/dist/esm/index.d.ts

@@ -0,0 +1,9 @@
+export * from "./contexts.js";
+export * from "./hooks/useApiClient.js";
+export * from "./hooks/useRun.js";
+export * from "./hooks/useRealtime.js";
+export * from "./hooks/useTaskTrigger.js";
+export * from "./hooks/useWaitToken.js";
+export * from "./hooks/useInputStreamSend.js";
+export * from "./hooks/useSessionStream.js";
+export * from "./hooks/useSessionStreamChannel.js";

package/dist/esm/index.js

@@ -0,0 +1,10 @@
+export * from "./contexts.js";
+export * from "./hooks/useApiClient.js";
+export * from "./hooks/useRun.js";
+export * from "./hooks/useRealtime.js";
+export * from "./hooks/useTaskTrigger.js";
+export * from "./hooks/useWaitToken.js";
+export * from "./hooks/useInputStreamSend.js";
+export * from "./hooks/useSessionStream.js";
+export * from "./hooks/useSessionStreamChannel.js";
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC"}

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/dist/esm/utils/createContextAndHook.d.ts

@@ -0,0 +1,14 @@
+import React from "react";
+type Options = {
+    assertCtxFn?: (v: unknown, msg: string) => void;
+};
+type ContextOf<T> = React.Context<T | undefined>;
+type UseCtxFn<T> = () => T;
+/**
+ * Creates and returns a Context and two hooks that return the context value.
+ * The Context type is derived from the type passed in by the user.
+ * The first hook returned guarantees that the context exists so the returned value is always CtxValue
+ * The second hook makes no guarantees, so the returned value can be CtxValue | undefined
+ */
+export declare const createContextAndHook: <CtxVal>(displayName: string, options?: Options) => [ContextOf<CtxVal>, UseCtxFn<CtxVal>, UseCtxFn<CtxVal | Partial<CtxVal>>];
+export {};

package/dist/esm/utils/createContextAndHook.js

@@ -0,0 +1,31 @@
+"use client";
+import React from "react";
+function assertContextExists(contextVal, msgOrCtx) {
+    if (!contextVal) {
+        throw typeof msgOrCtx === "string"
+            ? new Error(msgOrCtx)
+            : new Error(`${msgOrCtx.displayName} not found`);
+    }
+}
+/**
+ * Creates and returns a Context and two hooks that return the context value.
+ * The Context type is derived from the type passed in by the user.
+ * The first hook returned guarantees that the context exists so the returned value is always CtxValue
+ * The second hook makes no guarantees, so the returned value can be CtxValue | undefined
+ */
+export const createContextAndHook = (displayName, options) => {
+    const { assertCtxFn = assertContextExists } = options || {};
+    const Ctx = React.createContext(undefined);
+    Ctx.displayName = displayName;
+    const useCtx = () => {
+        const ctx = React.useContext(Ctx);
+        assertCtxFn(ctx, `${displayName} not found`);
+        return ctx;
+    };
+    const useCtxWithoutGuarantee = () => {
+        const ctx = React.useContext(Ctx);
+        return ctx ? ctx : {};
+    };
+    return [Ctx, useCtx, useCtxWithoutGuarantee];
+};
+//# sourceMappingURL=createContextAndHook.js.map

package/dist/esm/utils/createContextAndHook.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createContextAndHook.js","sourceRoot":"","sources":["../../../src/utils/createContextAndHook.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AACb,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,SAAS,mBAAmB,CAC1B,UAAmB,EACnB,QAAqC;IAErC,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,OAAO,QAAQ,KAAK,QAAQ;YAChC,CAAC,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC;YACrB,CAAC,CAAC,IAAI,KAAK,CAAC,GAAG,QAAQ,CAAC,WAAW,YAAY,CAAC,CAAC;IACrD,CAAC;AACH,CAAC;AAMD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,WAAmB,EACnB,OAAiB,EAC0D,EAAE;IAC7E,MAAM,EAAE,WAAW,GAAG,mBAAmB,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAC5D,MAAM,GAAG,GAAG,KAAK,CAAC,aAAa,CAAqB,SAAS,CAAC,CAAC;IAC/D,GAAG,CAAC,WAAW,GAAG,WAAW,CAAC;IAE9B,MAAM,MAAM,GAAG,GAAG,EAAE;QAClB,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAClC,WAAW,CAAC,GAAG,EAAE,GAAG,WAAW,YAAY,CAAC,CAAC;QAC7C,OAAO,GAAa,CAAC;IACvB,CAAC,CAAC;IAEF,MAAM,sBAAsB,GAAG,GAAG,EAAE;QAClC,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAClC,OAAO,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACxB,CAAC,CAAC;IAEF,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,sBAAsB,CAAC,CAAC;AAC/C,CAAC,CAAC"}

package/dist/esm/utils/throttle.d.ts

@@ -0,0 +1,6 @@
+export type ThrottledQueue<T> = {
+    add: (item: T) => void;
+    flush: () => Promise<void>;
+    isEmpty: () => boolean;
+};
+export declare function createThrottledQueue<T>(onFlush: (items: T[]) => Promise<void>, throttleInMs?: number): ThrottledQueue<T>;