@convex-dev/persistent-text-streaming 0.2.4 → 0.3.1

package/dist/esm/react/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/react/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAEjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAElD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,SAAS,CACvB,iBAAiB,EAAE,iBAAiB,CAClC,OAAO,EACP,QAAQ,EACR;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,EACpB,UAAU,CACX,EACD,SAAS,EAAE,GAAG,EACd,MAAM,EAAE,OAAO,EACf,QAAQ,EAAE,QAAQ,GAAG,SAAS,EAC9B,IAAI,CAAC,EAAE;IAEL,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC,cA0EF"}

package/dist/esm/react/index.js

@@ -1,133 +0,0 @@
-"use client";
-import { useQuery } from "convex/react";
-import { useEffect, useMemo, useRef, useState } from "react";
-/**
- * React hook for persistent text streaming.
- *
- * @param getPersistentBody - A query function reference that returns the body
- * of a stream using the component's `getStreamBody` method.
- * @param streamUrl - The URL of the http action that will kick off the stream
- * generation and stream the result back to the client using the component's
- * `stream` method.
- * @param driven - Whether this particular session is driving the stream. Set this
- * to true if this is the client session that first created the stream using the
- * component's `createStream` method. If you're simply reloading an existing
- * stream, set this to false.
- * @param streamId - The ID of the stream. If this is not provided, the return
- * value will be an empty string for the stream body and the status will be
- * `pending`.
- * @returns The body and status of the stream.
- */
-export function useStream(getPersistentBody, streamUrl, driven, streamId, opts) {
-    const [streamEnded, setStreamEnded] = useState(null);
-    // Used to prevent strict mode from causing multiple streams to be started.
-    const streamStarted = useRef(false);
-    const usePersistence = useMemo(() => {
-        // Something is wrong with the stream, so we need to use the database value.
-        if (streamEnded === false) {
-            return true;
-        }
-        // If we're not driving the stream, we must use the database value.
-        if (!driven) {
-            return true;
-        }
-        // Otherwise, we'll try to drive the stream and use the HTTP response.
-        return false;
-    }, [driven, streamId, streamEnded]);
-    //  console.log("usePersistence", usePersistence);
-    const persistentBody = useQuery(getPersistentBody, usePersistence && streamId ? { streamId } : "skip");
-    const [streamBody, setStreamBody] = useState("");
-    useEffect(() => {
-        if (driven && streamId && !streamStarted.current) {
-            // Kick off HTTP action.
-            void (async () => {
-                const success = await startStreaming(streamUrl, streamId, (text) => {
-                    setStreamBody((prev) => prev + text);
-                }, {
-                    ...opts?.headers,
-                    ...(opts?.authToken
-                        ? { Authorization: `Bearer ${opts.authToken}` }
-                        : {}),
-                });
-                setStreamEnded(success);
-            })();
-            // If we get remounted, we don't want to start a new stream.
-            return () => {
-                streamStarted.current = true;
-            };
-        }
-    }, [driven, streamId, setStreamEnded, streamStarted]);
-    const body = useMemo(() => {
-        // console.log(
-        //   "body info p vs. s",
-        //   persistentBody?.text?.length ?? 0,
-        //   streamBody.length
-        //);
-        if (persistentBody) {
-            return persistentBody;
-        }
-        let status;
-        if (streamEnded === null) {
-            status = streamBody.length > 0 ? "streaming" : "pending";
-        }
-        else {
-            status = streamEnded ? "done" : "error";
-        }
-        return {
-            text: streamBody,
-            status: status,
-        };
-    }, [persistentBody, streamBody, streamEnded]);
-    return body;
-}
-/**
- * Internal helper for starting a stream.
- *
- * @param url - The URL of the http action that will kick off the stream
- * generation and stream the result back to the client using the component's
- * `stream` method.
- * @param streamId - The ID of the stream.
- * @param onUpdate - A function that updates the stream body.
- * @returns A promise that resolves to a boolean indicating whether the stream
- * was started successfully. It can fail if the http action is not found, or
- * CORS fails, or an exception is raised, or the stream is already running
- * or finished, etc.
- */
-async function startStreaming(url, streamId, onUpdate, headers) {
-    const response = await fetch(url, {
-        method: "POST",
-        body: JSON.stringify({
-            streamId: streamId,
-        }),
-        headers: { "Content-Type": "application/json", ...headers },
-    });
-    // Adapted from https://developer.mozilla.org/en-US/docs/Web/API/Streams_API/Using_readable_streams
-    if (response.status === 205) {
-        console.error("Stream already finished", response);
-        return false;
-    }
-    if (!response.ok) {
-        console.error("Failed to reach streaming endpoint", response);
-        return false;
-    }
-    if (!response.body) {
-        console.error("No body in response", response);
-        return false;
-    }
-    const reader = response.body.getReader();
-    while (true) {
-        try {
-            const { done, value } = await reader.read();
-            if (done) {
-                onUpdate(new TextDecoder().decode(value));
-                return true;
-            }
-            onUpdate(new TextDecoder().decode(value));
-        }
-        catch (e) {
-            console.error("Error reading stream", e);
-            return false;
-        }
-    }
-}
-//# sourceMappingURL=index.js.map

package/dist/esm/react/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/react/index.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAIb,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAExC,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAG7D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,SAAS,CACvB,iBAKC,EACD,SAAc,EACd,MAAe,EACf,QAA8B,EAC9B,IAKC;IAED,MAAM,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,QAAQ,CAAC,IAAsB,CAAC,CAAC;IAEvE,2EAA2E;IAC3E,MAAM,aAAa,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAEpC,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,EAAE;QAClC,4EAA4E;QAC5E,IAAI,WAAW,KAAK,KAAK,EAAE;YACzB,OAAO,IAAI,CAAC;SACb;QACD,mEAAmE;QACnE,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,IAAI,CAAC;SACb;QACD,sEAAsE;QACtE,OAAO,KAAK,CAAC;IACf,CAAC,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC;IACpC,kDAAkD;IAClD,MAAM,cAAc,GAAG,QAAQ,CAC7B,iBAAiB,EACjB,cAAc,IAAI,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,CACnD,CAAC;IACF,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,QAAQ,CAAS,EAAE,CAAC,CAAC;IAEzD,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,MAAM,IAAI,QAAQ,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE;YAChD,wBAAwB;YACxB,KAAK,CAAC,KAAK,IAAI,EAAE;gBACf,MAAM,OAAO,GAAG,MAAM,cAAc,CAClC,SAAS,EACT,QAAQ,EACR,CAAC,IAAI,EAAE,EAAE;oBACP,aAAa,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;gBACvC,CAAC,EACD;oBACE,GAAG,IAAI,EAAE,OAAO;oBAChB,GAAG,CAAC,IAAI,EAAE,SAAS;wBACjB,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,IAAI,CAAC,SAAS,EAAE,EAAE;wBAC/C,CAAC,CAAC,EAAE,CAAC;iBACR,CACF,CAAC;gBACF,cAAc,CAAC,OAAO,CAAC,CAAC;YAC1B,CAAC,CAAC,EAAE,CAAC;YACL,4DAA4D;YAC5D,OAAO,GAAG,EAAE;gBACV,aAAa,CAAC,OAAO,GAAG,IAAI,CAAC;YAC/B,CAAC,CAAC;SACH;IACH,CAAC,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,aAAa,CAAC,CAAC,CAAC;IAEtD,MAAM,IAAI,GAAG,OAAO,CAAa,GAAG,EAAE;QACpC,eAAe;QACf,yBAAyB;QACzB,uCAAuC;QACvC,sBAAsB;QACtB,IAAI;QACJ,IAAI,cAAc,EAAE;YAClB,OAAO,cAAc,CAAC;SACvB;QACD,IAAI,MAAoB,CAAC;QACzB,IAAI,WAAW,KAAK,IAAI,EAAE;YACxB,MAAM,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;SAC1D;aAAM;YACL,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;SACzC;QACD,OAAO;YACL,IAAI,EAAE,UAAU;YAChB,MAAM,EAAE,MAAsB;SAC/B,CAAC;IACJ,CAAC,EAAE,CAAC,cAAc,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;IAE9C,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,cAAc,CAC3B,GAAQ,EACR,QAAkB,EAClB,QAAgC,EAChC,OAA+B;IAE/B,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;QAChC,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;YACnB,QAAQ,EAAE,QAAQ;SACnB,CAAC;QACF,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE;KAC5D,CAAC,CAAC;IACH,mGAAmG;IACnG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;QAC3B,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,QAAQ,CAAC,CAAC;QACnD,OAAO,KAAK,CAAC;KACd;IACD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;QAChB,OAAO,CAAC,KAAK,CAAC,oCAAoC,EAAE,QAAQ,CAAC,CAAC;QAC9D,OAAO,KAAK,CAAC;KACd;IACD,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE;QAClB,OAAO,CAAC,KAAK,CAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAC;QAC/C,OAAO,KAAK,CAAC;KACd;IACD,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;IACzC,OAAO,IAAI,EAAE;QACX,IAAI;YACF,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;YAC5C,IAAI,IAAI,EAAE;gBACR,QAAQ,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC1C,OAAO,IAAI,CAAC;aACb;YACD,QAAQ,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;SAC3C;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,CAAC,KAAK,CAAC,sBAAsB,EAAE,CAAC,CAAC,CAAC;YACzC,OAAO,KAAK,CAAC;SACd;KACF;AACH,CAAC"}

package/react/package.json

@@ -1,5 +0,0 @@
-{
-  "main": "../dist/commonjs/./react/index.js",
-  "module": "../dist/esm/./react/index.js",
-  "types": "../dist/commonjs/./react/index.d.ts"
-}

package/src/component/_generated/api.d.ts

@@ -1,81 +0,0 @@
-/* eslint-disable */
-/**
- * Generated `api` utility.
- *
- * THIS CODE IS AUTOMATICALLY GENERATED.
- *
- * To regenerate, run `npx convex dev`.
- * @module
- */
-
-import type * as crons from "../crons.js";
-import type * as lib from "../lib.js";
-
-import type {
-  ApiFromModules,
-  FilterApi,
-  FunctionReference,
-} from "convex/server";
-
-/**
- * A utility for referencing Convex functions in your app's API.
- *
- * Usage:
- * ```js
- * const myFunctionReference = api.myModule.myFunction;
- * ```
- */
-declare const fullApi: ApiFromModules<{
-  crons: typeof crons;
-  lib: typeof lib;
-}>;
-export type Mounts = {
-  lib: {
-    addChunk: FunctionReference<
-      "mutation",
-      "public",
-      { final: boolean; streamId: string; text: string },
-      any
-    >;
-    createStream: FunctionReference<"mutation", "public", {}, any>;
-    getStreamStatus: FunctionReference<
-      "query",
-      "public",
-      { streamId: string },
-      "pending" | "streaming" | "done" | "error" | "timeout"
-    >;
-    getStreamText: FunctionReference<
-      "query",
-      "public",
-      { streamId: string },
-      {
-        status: "pending" | "streaming" | "done" | "error" | "timeout";
-        text: string;
-      }
-    >;
-    setStreamStatus: FunctionReference<
-      "mutation",
-      "public",
-      {
-        status: "pending" | "streaming" | "done" | "error" | "timeout";
-        streamId: string;
-      },
-      any
-    >;
-  };
-};
-// For now fullApiWithMounts is only fullApi which provides
-// jump-to-definition in component client code.
-// Use Mounts for the same type without the inference.
-declare const fullApiWithMounts: typeof fullApi;
-
-export declare const api: FilterApi<
-  typeof fullApiWithMounts,
-  FunctionReference<any, "public">
->;
-export declare const internal: FilterApi<
-  typeof fullApiWithMounts,
-  FunctionReference<any, "internal">
->;
-
-export declare const components: {};

package/src/component/_generated/server.js

@@ -1,90 +0,0 @@
-/* eslint-disable */
-/**
- * Generated utilities for implementing server-side Convex query and mutation functions.
- *
- * THIS CODE IS AUTOMATICALLY GENERATED.
- *
- * To regenerate, run `npx convex dev`.
- * @module
- */
-
-import {
-  actionGeneric,
-  httpActionGeneric,
-  queryGeneric,
-  mutationGeneric,
-  internalActionGeneric,
-  internalMutationGeneric,
-  internalQueryGeneric,
-  componentsGeneric,
-} from "convex/server";
-
-/**
- * Define a query in this Convex app's public API.
- *
- * This function will be allowed to read your Convex database and will be accessible from the client.
- *
- * @param func - The query function. It receives a {@link QueryCtx} as its first argument.
- * @returns The wrapped query. Include this as an `export` to name it and make it accessible.
- */
-export const query = queryGeneric;
-
-/**
- * Define a query that is only accessible from other Convex functions (but not from the client).
- *
- * This function will be allowed to read from your Convex database. It will not be accessible from the client.
- *
- * @param func - The query function. It receives a {@link QueryCtx} as its first argument.
- * @returns The wrapped query. Include this as an `export` to name it and make it accessible.
- */
-export const internalQuery = internalQueryGeneric;
-
-/**
- * Define a mutation in this Convex app's public API.
- *
- * This function will be allowed to modify your Convex database and will be accessible from the client.
- *
- * @param func - The mutation function. It receives a {@link MutationCtx} as its first argument.
- * @returns The wrapped mutation. Include this as an `export` to name it and make it accessible.
- */
-export const mutation = mutationGeneric;
-
-/**
- * Define a mutation that is only accessible from other Convex functions (but not from the client).
- *
- * This function will be allowed to modify your Convex database. It will not be accessible from the client.
- *
- * @param func - The mutation function. It receives a {@link MutationCtx} as its first argument.
- * @returns The wrapped mutation. Include this as an `export` to name it and make it accessible.
- */
-export const internalMutation = internalMutationGeneric;
-
-/**
- * Define an action in this Convex app's public API.
- *
- * An action is a function which can execute any JavaScript code, including non-deterministic
- * code and code with side-effects, like calling third-party services.
- * They can be run in Convex's JavaScript environment or in Node.js using the "use node" directive.
- * They can interact with the database indirectly by calling queries and mutations using the {@link ActionCtx}.
- *
- * @param func - The action. It receives an {@link ActionCtx} as its first argument.
- * @returns The wrapped action. Include this as an `export` to name it and make it accessible.
- */
-export const action = actionGeneric;
-
-/**
- * Define an action that is only accessible from other Convex functions (but not from the client).
- *
- * @param func - The function. It receives an {@link ActionCtx} as its first argument.
- * @returns The wrapped function. Include this as an `export` to name it and make it accessible.
- */
-export const internalAction = internalActionGeneric;
-
-/**
- * Define a Convex HTTP action.
- *
- * @param func - The function. It receives an {@link ActionCtx} as its first argument, and a `Request` object
- * as its second.
- * @returns The wrapped endpoint function. Route a URL path to this function in `convex/http.js`.
- */
-export const httpAction = httpActionGeneric;