@convex-dev/persistent-text-streaming 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,188 @@
+# Convex Component: Persistent Text Streaming
+
+[![npm version](https://badge.fury.io/js/@convex-dev%2Fpersistent-text-streaming.svg)](https://badge.fury.io/js/@convex-dev%2Fpersistent-text-streaming)
+
+<!-- START: Include on https://convex.dev/components -->
+
+This Convex component enables persistent text streaming. It provides a React hook
+for streaming text from HTTP actions while simultaneously storing the data in the
+database. This persistence allows the text to be accessed after the stream ends
+or by other users.
+
+The most common use case is for AI chat applications. The example app (found in the
+`example` directory) is a just such a simple chat app that demonstrates use of the
+component.
+
+Here's what you'll end up with! The left browser window is streaming the chat body to the client,
+and the right browser window is subscribed to the chat body via a database query. The
+message is only updated in the database on sentence boundaries, whereas the HTTP
+stream sends tokens as they come:
+
+![example-animation](./anim.gif)
+
+## Pre-requisite: Convex
+
+You'll need an existing Convex project to use the component.
+Convex is a hosted backend platform, including a database, serverless functions,
+and a ton more you can learn about [here](https://docs.convex.dev/get-started).
+
+Run `npm create convex` or follow any of the [quickstarts](https://docs.convex.dev/home) to set one up.
+
+## Installation
+
+See [`example/`](./example/convex/) for a working demo.
+
+1. Install the Persistent Text Streaming component:
+
+```bash
+npm install @convex-dev/persistent-text-streaming
+```
+
+2. Create a [`convex.config.ts`](./example/convex/convex.config.ts) file in your
+   app's `convex/` folder and install the component by calling `use`:
+
+```ts
+// convex/convex.config.ts
+import { defineApp } from "convex/server";
+import persistentTextStreaming from "@convex-dev/persistent-text-streaming/convex.config";
+
+const app = defineApp();
+app.use(persistentTextStreaming);
+export default app;
+```
+
+## Usage
+
+Here's a simple example of how to use the component:
+
+In `convex/chat.ts`:
+
+```ts
+const persistentTextStreaming = new PersistentTextStreaming(
+  components.persistentTextStreaming
+);
+
+// Create a stream using the component and store the id in the database with
+// our chat message.
+export const createChat = mutation({
+  args: {
+    prompt: v.string(),
+  },
+  handler: async (ctx, args) => {
+    const streamId = await persistentTextStreaming.createStream(ctx);
+    const chatId = await ctx.db.insert("chats", {
+      title: "...",
+      prompt: args.prompt,
+      stream: streamId,
+    });
+    return chatId;
+  },
+});
+
+// Create a query that returns the chat body.
+export const getChatBody = query({
+  args: {
+    streamId: StreamIdValidator,
+  },
+  handler: async (ctx, args) => {
+    return await persistentTextStreaming.getStreamBody(
+      ctx,
+      args.streamId as StreamId
+    );
+  },
+});
+
+// Create an HTTP action that generates chunks of the chat body
+// and uses the component to stream them to the client and save them to the database.
+export const streamChat = httpAction(async (ctx, request) => {
+  const generateChat = async (ctx, request, streamId, chunkAppender) => {
+    await chunkAppender("Hi there!");
+    await chunkAppender("How are you?");
+    await chunkAppender("Pretend I'm an AI or something!");
+  };
+
+  const response = await persistentTextStreaming.stream(
+    ctx,
+    request,
+    body.streamId as StreamId,
+    generateChat
+  );
+
+  // Set CORS headers appropriately.
+  response.headers.set("Access-Control-Allow-Origin", "*");
+  response.headers.set("Vary", "Origin");
+  return response;
+});
+```
+
+You need to expose this HTTP endpoint in your app, `http.ts`:
+
+```ts
+http.route({
+  path: "/chat-stream",
+  method: "POST",
+  handler: streamChat,
+});
+```
+
+Finally, in your app, you can now create chats and them subscribe to them
+via stream and/or database query as optimal:
+
+```ts
+// chat-input.tsx, maybe?
+const createChat = useMutation(api.chat.createChat);
+const formSubmit = async (e: React.FormEvent) => {
+  e.preventDefault();
+  const chatId = await createChat({
+    prompt: inputValue,
+  });
+};
+
+// chat-message.tsx, maybe?
+import { useStream } from "@convex-dev/persistent-text-streaming/react";
+
+// ...
+
+// In our component:
+const { text, status } = useStream(
+  api.chat.getChatBody, // The query to call for the full stream body
+  new URL(`${convexSiteUrl}/chat-stream`), // The HTTP endpoint for streaming
+  driven, // True if this browser session created this chat and should generate the stream
+  chat.streamId as StreamId // The streamId from the chat database record
+);
+```
+
+## Design Philosophy
+
+This component balances HTTP streaming with database persistence to try to
+maximize the benefits of both. To understand why this balance is beneficial,
+let's examine each approach in isolation.
+
+- **HTTP streaming only**: If your app _only_ uses HTTP streaming, then the
+  original browser that made the request will have a great, high-performance
+  streaming experience. But if that HTTP connection is lost, if the browser
+  window is reloaded, if other users want to view the same chat, or this
+  users wants to revisit the conversation later, it won't be possible. The
+  conversation is only ephemeral because it was never stored on the server.
+
+- **Database Persistence Only**: If your app _only_ uses database persistence,
+  it's true that the conversation will be available for as long as you want.
+  Additionally, Convex's subscriptions will ensure the chat message is updated
+  as new text chunks are generated. However, there are a few downsides: one,
+  the entire chat body needs to be resent every time it is changed, which is a
+  lot redundant bandwidth to push into the database and over the websockets to
+  all connected clients. Two, you'll need to make a difficult tradeoff between
+  interactivity and efficiency. If you write every single small chunk to the
+  database, this will get quite slow and expensive. But if you batch up the chunks
+  into, say, paragraphs, then the user experience will feel laggy.
+
+This component combines the best of both worlds. The original browser that
+makes the request will still have a great, high-performance streaming experience.
+But the chat body is also stored in the database, so it can be accessed by the
+client even after the stream has finished, or by other users, etc.
+
+## Background
+
+This component is largely based on the Stack post [AI Chat with HTTP Streaming](https://stack.convex.dev/ai-chat-with-http-streaming).
+
+<!-- END: Include on https://convex.dev/components -->

package/dist/commonjs/client/index.d.ts

@@ -0,0 +1,89 @@
+import { Expand, FunctionReference, GenericActionCtx, GenericDataModel, GenericMutationCtx, GenericQueryCtx } from "convex/server";
+import { GenericId } from "convex/values";
+import { api } from "../component/_generated/api";
+import { StreamStatus } from "../component/schema";
+export type StreamId = string & {
+    __isStreamId: true;
+};
+export declare const StreamIdValidator: import("convex/values").VString<string, "required">;
+export type StreamBody = {
+    text: string;
+    status: StreamStatus;
+};
+export type ChunkAppender = (text: string) => Promise<void>;
+export type StreamWriter<A extends GenericActionCtx<GenericDataModel>> = (ctx: A, request: Request, streamId: StreamId, chunkAppender: ChunkAppender) => Promise<void>;
+export declare class PersistentTextStreaming {
+    component: UseApi<typeof api>;
+    options?: object | undefined;
+    constructor(component: UseApi<typeof api>, options?: object | undefined);
+    /**
+     * Create a new stream. This will return a stream ID that can be used
+     * in an HTTP action to stream data back out to the client while also
+     * permanently persisting the final stream in the database.
+     *
+     * @param ctx - A convex context capable of running mutations.
+     * @returns The ID of the new stream.
+     * @example
+     * ```ts
+     * const streaming = new PersistentTextStreaming(api);
+     * const streamId = await streaming.createStream(ctx);
+     * await streaming.stream(ctx, request, streamId, async (ctx, req, id, append) => {
+     *   await append("Hello ");
+     *   await append("World!");
+     * });
+     * ```
+     */
+    createStream(ctx: RunMutationCtx): Promise<StreamId>;
+    /**
+     * Get the body of a stream. This will return the full text of the stream
+     * and the status of the stream.
+     *
+     * @param ctx - A convex context capable of running queries.
+     * @param streamId - The ID of the stream to get the body of.
+     * @returns The body of the stream and the status of the stream.
+     * @example
+     * ```ts
+     * const streaming = new PersistentTextStreaming(api);
+     * const { text, status } = await streaming.getStreamBody(ctx, streamId);
+     * ```
+     */
+    getStreamBody(ctx: RunQueryCtx, streamId: StreamId): Promise<StreamBody>;
+    /**
+     * Inside an HTTP action, this will stream data back to the client while
+     * also persisting the final stream in the database.
+     *
+     * @param ctx - A convex context capable of running actions.
+     * @param request - The HTTP request object.
+     * @param streamId - The ID of the stream.
+     * @param streamWriter - A function that generates chunks and writes them
+     * to the stream with the given `StreamWriter`.
+     * @returns A promise that resolves to an HTTP response. You may need to adjust
+     * the headers of this response for CORS, etc.
+     * @example
+     * ```ts
+     * const streaming = new PersistentTextStreaming(api);
+     * const streamId = await streaming.createStream(ctx);
+     * const response = await streaming.stream(ctx, request, streamId, async (ctx, req, id, append) => {
+     *   await append("Hello ");
+     *   await append("World!");
+     * });
+     * ```
+     */
+    stream<A extends GenericActionCtx<GenericDataModel>>(ctx: A, request: Request, streamId: StreamId, streamWriter: StreamWriter<A>): Promise<Response>;
+    private addChunk;
+    private setStreamStatus;
+}
+type RunQueryCtx = {
+    runQuery: GenericQueryCtx<GenericDataModel>["runQuery"];
+};
+type RunMutationCtx = {
+    runMutation: GenericMutationCtx<GenericDataModel>["runMutation"];
+};
+export type OpaqueIds<T> = T extends GenericId<infer _T> | string ? string : T extends (infer U)[] ? OpaqueIds<U>[] : T extends ArrayBuffer ? ArrayBuffer : T extends object ? {
+    [K in keyof T]: OpaqueIds<T[K]>;
+} : T;
+export type UseApi<API> = Expand<{
+    [mod in keyof API]: API[mod] extends FunctionReference<infer FType, "public", infer FArgs, infer FReturnType, infer FComponentPath> ? FunctionReference<FType, "internal", OpaqueIds<FArgs>, OpaqueIds<FReturnType>, FComponentPath> : UseApi<API[mod]>;
+}>;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/commonjs/client/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EACN,iBAAiB,EACjB,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EAChB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,SAAS,EAAK,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,GAAG,EAAE,MAAM,6BAA6B,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG;IAAE,YAAY,EAAE,IAAI,CAAA;CAAE,CAAC;AACvD,eAAO,MAAM,iBAAiB,qDAAa,CAAC;AAC5C,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,YAAY,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAC5D,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,CACvE,GAAG,EAAE,CAAC,EACN,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,aAAa,KACzB,OAAO,CAAC,IAAI,CAAC,CAAC;AAQnB,qBAAa,uBAAuB;IAEzB,SAAS,EAAE,MAAM,CAAC,OAAO,GAAG,CAAC;IAC7B,OAAO,CAAC;gBADR,SAAS,EAAE,MAAM,CAAC,OAAO,GAAG,CAAC,EAC7B,OAAO,CAAC,oBAAQ;IAGzB;;;;;;;;;;;;;;;;OAgBG;IAEG,YAAY,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAK1D;;;;;;;;;;;;OAYG;IACG,aAAa,CACjB,GAAG,EAAE,WAAW,EAChB,QAAQ,EAAE,QAAQ,GACjB,OAAO,CAAC,UAAU,CAAC;IAQtB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,MAAM,CAAC,CAAC,SAAS,gBAAgB,CAAC,gBAAgB,CAAC,EACvD,GAAG,EAAE,CAAC,EACN,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,QAAQ,EAClB,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC;YAkDjB,QAAQ;YAcR,eAAe;CAU9B;AAID,KAAK,WAAW,GAAG;IACjB,QAAQ,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC,UAAU,CAAC,CAAC;CACzD,CAAC;AACF,KAAK,cAAc,GAAG;IACpB,WAAW,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,CAAC,aAAa,CAAC,CAAC;CAClE,CAAC;AAEF,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM,GAC7D,MAAM,GACN,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GACnB,SAAS,CAAC,CAAC,CAAC,EAAE,GACd,CAAC,SAAS,WAAW,GACnB,WAAW,GACX,CAAC,SAAS,MAAM,GACd;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GACnC,CAAC,CAAC;AAEZ,MAAM,MAAM,MAAM,CAAC,GAAG,IAAI,MAAM,CAAC;KAC9B,GAAG,IAAI,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,SAAS,iBAAiB,CACpD,MAAM,KAAK,EACX,QAAQ,EACR,MAAM,KAAK,EACX,MAAM,WAAW,EACjB,MAAM,cAAc,CACrB,GACG,iBAAiB,CACf,KAAK,EACL,UAAU,EACV,SAAS,CAAC,KAAK,CAAC,EAChB,SAAS,CAAC,WAAW,CAAC,EACtB,cAAc,CACf,GACD,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CACrB,CAAC,CAAC"}

package/dist/commonjs/client/index.js

@@ -0,0 +1,133 @@
+import { v } from "convex/values";
+export const StreamIdValidator = v.string();
+// TODO -- make more flexible. # of bytes, etc?
+const hasDelimeter = (text) => {
+    return text.includes(".") || text.includes("!") || text.includes("?");
+};
+// TODO -- some sort of wrapper with easy ergonomics for working with LLMs?
+export class PersistentTextStreaming {
+    component;
+    options;
+    constructor(component, options) {
+        this.component = component;
+        this.options = options;
+    }
+    /**
+     * Create a new stream. This will return a stream ID that can be used
+     * in an HTTP action to stream data back out to the client while also
+     * permanently persisting the final stream in the database.
+     *
+     * @param ctx - A convex context capable of running mutations.
+     * @returns The ID of the new stream.
+     * @example
+     * ```ts
+     * const streaming = new PersistentTextStreaming(api);
+     * const streamId = await streaming.createStream(ctx);
+     * await streaming.stream(ctx, request, streamId, async (ctx, req, id, append) => {
+     *   await append("Hello ");
+     *   await append("World!");
+     * });
+     * ```
+     */
+    async createStream(ctx) {
+        const id = await ctx.runMutation(this.component.lib.createStream);
+        return id;
+    }
+    /**
+     * Get the body of a stream. This will return the full text of the stream
+     * and the status of the stream.
+     *
+     * @param ctx - A convex context capable of running queries.
+     * @param streamId - The ID of the stream to get the body of.
+     * @returns The body of the stream and the status of the stream.
+     * @example
+     * ```ts
+     * const streaming = new PersistentTextStreaming(api);
+     * const { text, status } = await streaming.getStreamBody(ctx, streamId);
+     * ```
+     */
+    async getStreamBody(ctx, streamId) {
+        const { text, status } = await ctx.runQuery(this.component.lib.getStreamText, { streamId });
+        return { text, status: status };
+    }
+    /**
+     * Inside an HTTP action, this will stream data back to the client while
+     * also persisting the final stream in the database.
+     *
+     * @param ctx - A convex context capable of running actions.
+     * @param request - The HTTP request object.
+     * @param streamId - The ID of the stream.
+     * @param streamWriter - A function that generates chunks and writes them
+     * to the stream with the given `StreamWriter`.
+     * @returns A promise that resolves to an HTTP response. You may need to adjust
+     * the headers of this response for CORS, etc.
+     * @example
+     * ```ts
+     * const streaming = new PersistentTextStreaming(api);
+     * const streamId = await streaming.createStream(ctx);
+     * const response = await streaming.stream(ctx, request, streamId, async (ctx, req, id, append) => {
+     *   await append("Hello ");
+     *   await append("World!");
+     * });
+     * ```
+     */
+    async stream(ctx, request, streamId, streamWriter) {
+        const streamState = await ctx.runQuery(this.component.lib.getStreamStatus, {
+            streamId,
+        });
+        if (streamState !== "pending") {
+            console.log("Stream was already started");
+            return new Response("", {
+                status: 205,
+            });
+        }
+        // Create a TransformStream to handle streaming data
+        const { readable, writable } = new TransformStream();
+        const writer = writable.getWriter();
+        const textEncoder = new TextEncoder();
+        let pending = "";
+        const doStream = async () => {
+            const chunkAppender = async (text) => {
+                // write to this handler's response stream on every update
+                await writer.write(textEncoder.encode(text));
+                pending += text;
+                // write to the database periodically, like at the end of sentences
+                if (hasDelimeter(text)) {
+                    await this.addChunk(ctx, streamId, pending, false);
+                    pending = "";
+                }
+            };
+            try {
+                await streamWriter(ctx, request, streamId, chunkAppender);
+            }
+            catch (e) {
+                await this.setStreamStatus(ctx, streamId, "error");
+                await writer.close();
+                throw e;
+            }
+            // Success? Flush any last updates
+            await this.addChunk(ctx, streamId, pending, true);
+            await writer.close();
+        };
+        // Kick off the streaming, but don't await it.
+        void doStream();
+        // Send the readable back to the browser
+        return new Response(readable);
+    }
+    // Internal helper -- add a chunk to the stream.
+    async addChunk(ctx, streamId, text, final) {
+        await ctx.runMutation(this.component.lib.addChunk, {
+            streamId,
+            text,
+            final,
+        });
+    }
+    // Internal helper -- set the status of a stream.
+    async setStreamStatus(ctx, streamId, status) {
+        await ctx.runMutation(this.component.lib.setStreamStatus, {
+            streamId,
+            status,
+        });
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/commonjs/client/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAQA,OAAO,EAAa,CAAC,EAAE,MAAM,eAAe,CAAC;AAK7C,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;AAc5C,+CAA+C;AAC/C,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,EAAE;IACpC,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AACxE,CAAC,CAAC;AAEF,2EAA2E;AAC3E,MAAM,OAAO,uBAAuB;IAEzB;IACA;IAFT,YACS,SAA6B,EAC7B,OAAgB;QADhB,cAAS,GAAT,SAAS,CAAoB;QAC7B,YAAO,GAAP,OAAO,CAAS;IACtB,CAAC;IAEJ;;;;;;;;;;;;;;;;OAgBG;IAEH,KAAK,CAAC,YAAY,CAAC,GAAmB;QACpC,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAClE,OAAO,EAAc,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,aAAa,CACjB,GAAgB,EAChB,QAAkB;QAElB,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,QAAQ,CACzC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,EAChC,EAAE,QAAQ,EAAE,CACb,CAAC;QACF,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAsB,EAAE,CAAC;IAClD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,MAAM,CACV,GAAM,EACN,OAAgB,EAChB,QAAkB,EAClB,YAA6B;QAE7B,MAAM,WAAW,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,eAAe,EAAE;YACzE,QAAQ;SACT,CAAC,CAAC;QACH,IAAI,WAAW,KAAK,SAAS,EAAE;YAC7B,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;YAC1C,OAAO,IAAI,QAAQ,CAAC,EAAE,EAAE;gBACtB,MAAM,EAAE,GAAG;aACZ,CAAC,CAAC;SACJ;QACD,oDAAoD;QACpD,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,IAAI,eAAe,EAAE,CAAC;QACrD,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,EAAE,CAAC;QACpC,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;QACtC,IAAI,OAAO,GAAG,EAAE,CAAC;QAEjB,MAAM,QAAQ,GAAG,KAAK,IAAI,EAAE;YAC1B,MAAM,aAAa,GAAkB,KAAK,EAAE,IAAI,EAAE,EAAE;gBAClD,0DAA0D;gBAC1D,MAAM,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC7C,OAAO,IAAI,IAAI,CAAC;gBAChB,mEAAmE;gBACnE,IAAI,YAAY,CAAC,IAAI,CAAC,EAAE;oBACtB,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;oBACnD,OAAO,GAAG,EAAE,CAAC;iBACd;YACH,CAAC,CAAC;YACF,IAAI;gBACF,MAAM,YAAY,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC;aAC3D;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;gBACnD,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;gBACrB,MAAM,CAAC,CAAC;aACT;YAED,kCAAkC;YAClC,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;YAElD,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QACvB,CAAC,CAAC;QAEF,8CAA8C;QAC9C,KAAK,QAAQ,EAAE,CAAC;QAEhB,wCAAwC;QACxC,OAAO,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAChC,CAAC;IAED,gDAAgD;IACxC,KAAK,CAAC,QAAQ,CACpB,GAAmB,EACnB,QAAkB,EAClB,IAAY,EACZ,KAAc;QAEd,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE;YACjD,QAAQ;YACR,IAAI;YACJ,KAAK;SACN,CAAC,CAAC;IACL,CAAC;IAED,iDAAiD;IACzC,KAAK,CAAC,eAAe,CAC3B,GAAmB,EACnB,QAAkB,EAClB,MAAoB;QAEpB,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,eAAe,EAAE;YACxD,QAAQ;YACR,MAAM;SACP,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/commonjs/component/_generated/api.d.ts

@@ -0,0 +1,14 @@
+/**
+ * A utility for referencing Convex functions in your app's API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = api.myModule.myFunction;
+ * ```
+ */
+export const api: import("convex/server").AnyApi;
+export const internal: import("convex/server").AnyApi;
+export const components: {
+    [x: string]: import("../../../node_modules/convex/dist/esm-types/server/components").AnyComponentReference;
+};
+//# sourceMappingURL=api.d.ts.map

package/dist/commonjs/component/_generated/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../../src/component/_generated/api.js"],"names":[],"mappings":"AAYA;;;;;;;GAOG;AACH,iDAA0B;AAC1B,sDAA+B;AAC/B;;EAA8C"}

package/dist/commonjs/component/_generated/api.js

@@ -0,0 +1,22 @@
+/* eslint-disable */
+/**
+ * Generated `api` utility.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+import { anyApi, componentsGeneric } from "convex/server";
+/**
+ * A utility for referencing Convex functions in your app's API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = api.myModule.myFunction;
+ * ```
+ */
+export const api = anyApi;
+export const internal = anyApi;
+export const components = componentsGeneric();
+//# sourceMappingURL=api.js.map

package/dist/commonjs/component/_generated/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../../../src/component/_generated/api.js"],"names":[],"mappings":"AAAA,oBAAoB;AACpB;;;;;;;GAOG;AAEH,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAE1D;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,MAAM,CAAC;AAC1B,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC/B,MAAM,CAAC,MAAM,UAAU,GAAG,iBAAiB,EAAE,CAAC"}