@instantdb/resumable-stream 0.0.0

package/dist/commonjs/index.d.ts

@@ -0,0 +1,63 @@
+export interface CreateResumableStreamContextOptions {
+    /**
+     * A function that takes a promise and ensures that the current program stays alive
+     * until the promise is resolved.
+     *
+     * If you are deploying to a server environment, where you don't have to worry about
+     * the function getting suspended, pass in null.
+     */
+    waitUntil: ((promise: Promise<unknown>) => void) | null;
+    /**
+     * The appId for your InstantDB app. It may also be provided with the INSTANT_APP_ID environment variable.
+     */
+    appId?: string;
+    /**
+     * The appId for your InstantDB app. It may also be provided with the INSTANT_ADMIN_TOKEN environment variable.
+     */
+    adminToken?: string;
+    /**
+     * Optional apiURI for the instantdb server.
+     */
+    apiURI?: string;
+}
+export interface ResumableStreamContext {
+    /**
+     * Creates or resumes a resumable stream.
+     *
+     * Does not throw if the underlying stream is already done. The output can always be read from the
+     * stream and does not have to be saved to a separate table after streaming is completed.
+     *
+     * By default returns the entire buffered stream. Use `skipCharacters` to resume from a specific point.
+     *
+     * @param streamId - The ID of the stream. Must be unique for each stream.
+     * @param makeStream - A function that returns a stream of strings. It's only executed if the stream it not yet in progress.
+     * @param skipCharacters - Number of characters to skip
+     * @returns A readable stream of strings. Returns the stream even if it is fully done (streams are persisted until deleted)
+     */
+    resumableStream: (streamId: string, makeStream: () => ReadableStream<string>, skipCharacters?: number) => Promise<ReadableStream<string> | null>;
+    /**
+     * Resumes a stream that was previously created by `createNewResumableStream`.
+     *
+     * @param streamId - The ID of the stream. Must be unique for each stream.
+     * @param skipCharacters - Number of characters to skip
+     * @returns A readable stream of strings. Returns the stream even if it is fully done (streams are persisted until deleted)
+     */
+    resumeExistingStream: (streamId: string, skipCharacters?: number) => Promise<ReadableStream<string> | null | undefined>;
+    /**
+     * Creates a new resumable stream.
+     *
+     * @param streamId - The ID of the stream. Must be unique for each stream.
+     * @param makeStream - A function that returns a stream of strings.
+     * @param skipCharacters - Number of characters to skip
+     * @returns A readable stream of strings. Returns the stream even if it is fully done (streams are persisted until deleted)
+     */
+    createNewResumableStream: (streamId: string, makeStream: () => ReadableStream<string>, skipCharacters?: number) => Promise<ReadableStream<string> | null>;
+    /**
+     * Checks if a stream with the given streamId exists.
+     * @param streamId - The ID of the stream.
+     * @returns null if there is no stream with the given streamId. True if a stream with the given streamId exists. "DONE" if the stream is fully done.
+     */
+    hasExistingStream: (streamId: string) => Promise<null | true | 'DONE'>;
+}
+export declare function createResumableStreamContext(options: CreateResumableStreamContextOptions): ResumableStreamContext;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,mCAAmC;IAClD;;;;;;OAMG;IACH,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC;IACxD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC;;;;;;;;;;;;OAYG;IACH,eAAe,EAAE,CACf,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,cAAc,CAAC,MAAM,CAAC,EACxC,cAAc,CAAC,EAAE,MAAM,KACpB,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAC5C;;;;;;OAMG;IACH,oBAAoB,EAAE,CACpB,QAAQ,EAAE,MAAM,EAChB,cAAc,CAAC,EAAE,MAAM,KACpB,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;IACxD;;;;;;;OAOG;IACH,wBAAwB,EAAE,CACxB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,cAAc,CAAC,MAAM,CAAC,EACxC,cAAc,CAAC,EAAE,MAAM,KACpB,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAE5C;;;;OAIG;IACH,iBAAiB,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,GAAG,IAAI,GAAG,MAAM,CAAC,CAAC;CACxE;AAqBD,wBAAgB,4BAA4B,CAC1C,OAAO,EAAE,mCAAmC,GAC3C,sBAAsB,CA4GxB"}

package/dist/commonjs/index.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createResumableStreamContext = createResumableStreamContext;
+const admin_1 = require("@instantdb/admin");
+function skipCharactersTransformer(skipCharacters) {
+    let skipLeft = skipCharacters;
+    return new TransformStream({
+        transform(chunk, controller) {
+            if (!skipLeft) {
+                controller.enqueue(chunk);
+                return;
+            }
+            if (skipLeft > chunk.length) {
+                skipLeft += chunk.length;
+                return;
+            }
+            const remaining = chunk.slice(skipLeft);
+            skipLeft = 0;
+            controller.enqueue(remaining);
+        },
+    });
+}
+function createResumableStreamContext(options) {
+    const appId = options.appId || process.env.INSTANT_APP_ID;
+    if (!appId) {
+        throw new Error('Missing appId. Pass it as an argument to createResumableStreamContext or set the INSTANT_APP_ID environment variable.');
+    }
+    const adminToken = options.adminToken || process.env.INSTANT_APP_ADMIN_TOKEN;
+    if (!appId) {
+        throw new Error('Missing adminToken. Pass it as an argument to createResumableStreamContext or set the INSTANT_APP_ADMIN_TOKEN environment variable.');
+    }
+    const apiURI = options.apiURI || process.env.INSTANT_API_URI;
+    const db = (0, admin_1.init)({
+        appId,
+        adminToken,
+        apiURI,
+    });
+    async function resumableStream(streamId, makeStream, skipCharacters) {
+        const writeStream = db.streams.createWriteStream({
+            clientId: streamId,
+            waitUntil: options.waitUntil ?? undefined,
+        });
+        try {
+            const s = await writeStream.streamId();
+            const inputStream = makeStream();
+            inputStream.pipeTo(writeStream);
+            const readStream = db.streams.createReadStream({ streamId: s });
+            if (skipCharacters) {
+                return readStream.pipeThrough(skipCharactersTransformer(skipCharacters));
+            }
+            return readStream;
+        }
+        catch (e) {
+            const readStream = db.streams.createReadStream({ clientId: streamId });
+            if (skipCharacters) {
+                return readStream.pipeThrough(skipCharactersTransformer(skipCharacters));
+            }
+            return readStream;
+        }
+    }
+    async function resumeExistingStream(streamId, skipCharacters) {
+        const readStream = db.streams.createReadStream({ clientId: streamId });
+        if (skipCharacters) {
+            return readStream.pipeThrough(skipCharactersTransformer(skipCharacters));
+        }
+        return readStream;
+    }
+    async function createNewResumableStream(streamId, makeStream, skipCharacters) {
+        const inputStream = makeStream();
+        const writeStream = db.streams.createWriteStream({
+            clientId: streamId,
+            waitUntil: options.waitUntil ?? undefined,
+        });
+        // Wait for stream to be acknowledged by the server
+        await writeStream.streamId();
+        inputStream.pipeTo(writeStream);
+        const readStream = db.streams.createReadStream({ clientId: streamId });
+        if (skipCharacters) {
+            return readStream.pipeThrough(skipCharactersTransformer(skipCharacters));
+        }
+        return readStream;
+    }
+    async function hasExistingStream(streamId) {
+        const data = await db.query({
+            $streams: { $: { where: { clientId: streamId } } },
+        });
+        const stream = data?.$streams?.[0];
+        if (stream?.done) {
+            return 'DONE';
+        }
+        if (stream) {
+            return true;
+        }
+        return null;
+    }
+    return {
+        resumableStream,
+        resumeExistingStream,
+        createNewResumableStream,
+        hasExistingStream,
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/commonjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;AAgGA,oEA8GC;AA9MD,4CAAwC;AA6ExC,SAAS,yBAAyB,CAAC,cAAsB;IACvD,IAAI,QAAQ,GAAG,cAAc,CAAC;IAC9B,OAAO,IAAI,eAAe,CAAS;QACjC,SAAS,CAAC,KAAK,EAAE,UAAU;YACzB,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC1B,OAAO;YACT,CAAC;YACD,IAAI,QAAQ,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;gBAC5B,QAAQ,IAAI,KAAK,CAAC,MAAM,CAAC;gBACzB,OAAO;YACT,CAAC;YACD,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACxC,QAAQ,GAAG,CAAC,CAAC;YACb,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAChC,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,4BAA4B,CAC1C,OAA4C;IAE5C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;IAC1D,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CACb,uHAAuH,CACxH,CAAC;IACJ,CAAC;IACD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC;IAC7E,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CACb,qIAAqI,CACtI,CAAC;IACJ,CAAC;IACD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;IAE7D,MAAM,EAAE,GAAG,IAAA,YAAI,EAAC;QACd,KAAK;QACL,UAAU;QACV,MAAM;KACP,CAAC,CAAC;IAEH,KAAK,UAAU,eAAe,CAC5B,QAAgB,EAChB,UAAwC,EACxC,cAAuB;QAEvB,MAAM,WAAW,GAAG,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC;YAC/C,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,SAAS;SAC1C,CAAC,CAAC;QACH,IAAI,CAAC;YACH,MAAM,CAAC,GAAG,MAAM,WAAW,CAAC,QAAQ,EAAE,CAAC;YACvC,MAAM,WAAW,GAAG,UAAU,EAAE,CAAC;YACjC,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAChC,MAAM,UAAU,GAAG,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC;YAChE,IAAI,cAAc,EAAE,CAAC;gBACnB,OAAO,UAAU,CAAC,WAAW,CAC3B,yBAAyB,CAAC,cAAc,CAAC,CAC1C,CAAC;YACJ,CAAC;YACD,OAAO,UAAU,CAAC;QACpB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,UAAU,GAAG,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;YACvE,IAAI,cAAc,EAAE,CAAC;gBACnB,OAAO,UAAU,CAAC,WAAW,CAC3B,yBAAyB,CAAC,cAAc,CAAC,CAC1C,CAAC;YACJ,CAAC;YACD,OAAO,UAAU,CAAC;QACpB,CAAC;IACH,CAAC;IAED,KAAK,UAAU,oBAAoB,CACjC,QAAgB,EAChB,cAAuB;QAEvB,MAAM,UAAU,GAAG,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;QACvE,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,UAAU,CAAC,WAAW,CAAC,yBAAyB,CAAC,cAAc,CAAC,CAAC,CAAC;QAC3E,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,KAAK,UAAU,wBAAwB,CACrC,QAAgB,EAChB,UAAwC,EACxC,cAAuB;QAEvB,MAAM,WAAW,GAAG,UAAU,EAAE,CAAC;QACjC,MAAM,WAAW,GAAG,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC;YAC/C,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,SAAS;SAC1C,CAAC,CAAC;QAEH,mDAAmD;QACnD,MAAM,WAAW,CAAC,QAAQ,EAAE,CAAC;QAE7B,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAChC,MAAM,UAAU,GAAG,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;QACvE,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,UAAU,CAAC,WAAW,CAAC,yBAAyB,CAAC,cAAc,CAAC,CAAC,CAAC;QAC3E,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,KAAK,UAAU,iBAAiB,CAC9B,QAAgB;QAEhB,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,KAAK,CAAC;YAC1B,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE;SACnD,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC;QACnC,IAAI,MAAM,EAAE,IAAI,EAAE,CAAC;YACjB,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO;QACL,eAAe;QACf,oBAAoB;QACpB,wBAAwB;QACxB,iBAAiB;KAClB,CAAC;AACJ,CAAC","sourcesContent":["import { init } from '@instantdb/admin';\n\nexport interface CreateResumableStreamContextOptions {\n  /**\n   * A function that takes a promise and ensures that the current program stays alive\n   * until the promise is resolved.\n   *\n   * If you are deploying to a server environment, where you don't have to worry about\n   * the function getting suspended, pass in null.\n   */\n  waitUntil: ((promise: Promise<unknown>) => void) | null;\n  /**\n   * The appId for your InstantDB app. It may also be provided with the INSTANT_APP_ID environment variable.\n   */\n  appId?: string;\n  /**\n   * The appId for your InstantDB app. It may also be provided with the INSTANT_ADMIN_TOKEN environment variable.\n   */\n  adminToken?: string;\n  /**\n   * Optional apiURI for the instantdb server.\n   */\n  apiURI?: string;\n}\n\nexport interface ResumableStreamContext {\n  /**\n   * Creates or resumes a resumable stream.\n   *\n   * Does not throw if the underlying stream is already done. The output can always be read from the\n   * stream and does not have to be saved to a separate table after streaming is completed.\n   *\n   * By default returns the entire buffered stream. Use `skipCharacters` to resume from a specific point.\n   *\n   * @param streamId - The ID of the stream. Must be unique for each stream.\n   * @param makeStream - A function that returns a stream of strings. It's only executed if the stream it not yet in progress.\n   * @param skipCharacters - Number of characters to skip\n   * @returns A readable stream of strings. Returns the stream even if it is fully done (streams are persisted until deleted)\n   */\n  resumableStream: (\n    streamId: string,\n    makeStream: () => ReadableStream<string>,\n    skipCharacters?: number,\n  ) => Promise<ReadableStream<string> | null>;\n  /**\n   * Resumes a stream that was previously created by `createNewResumableStream`.\n   *\n   * @param streamId - The ID of the stream. Must be unique for each stream.\n   * @param skipCharacters - Number of characters to skip\n   * @returns A readable stream of strings. Returns the stream even if it is fully done (streams are persisted until deleted)\n   */\n  resumeExistingStream: (\n    streamId: string,\n    skipCharacters?: number,\n  ) => Promise<ReadableStream<string> | null | undefined>;\n  /**\n   * Creates a new resumable stream.\n   *\n   * @param streamId - The ID of the stream. Must be unique for each stream.\n   * @param makeStream - A function that returns a stream of strings.\n   * @param skipCharacters - Number of characters to skip\n   * @returns A readable stream of strings. Returns the stream even if it is fully done (streams are persisted until deleted)\n   */\n  createNewResumableStream: (\n    streamId: string,\n    makeStream: () => ReadableStream<string>,\n    skipCharacters?: number,\n  ) => Promise<ReadableStream<string> | null>;\n\n  /**\n   * Checks if a stream with the given streamId exists.\n   * @param streamId - The ID of the stream.\n   * @returns null if there is no stream with the given streamId. True if a stream with the given streamId exists. \"DONE\" if the stream is fully done.\n   */\n  hasExistingStream: (streamId: string) => Promise<null | true | 'DONE'>;\n}\n\nfunction skipCharactersTransformer(skipCharacters: number) {\n  let skipLeft = skipCharacters;\n  return new TransformStream<string>({\n    transform(chunk, controller) {\n      if (!skipLeft) {\n        controller.enqueue(chunk);\n        return;\n      }\n      if (skipLeft > chunk.length) {\n        skipLeft += chunk.length;\n        return;\n      }\n      const remaining = chunk.slice(skipLeft);\n      skipLeft = 0;\n      controller.enqueue(remaining);\n    },\n  });\n}\n\nexport function createResumableStreamContext(\n  options: CreateResumableStreamContextOptions,\n): ResumableStreamContext {\n  const appId = options.appId || process.env.INSTANT_APP_ID;\n  if (!appId) {\n    throw new Error(\n      'Missing appId. Pass it as an argument to createResumableStreamContext or set the INSTANT_APP_ID environment variable.',\n    );\n  }\n  const adminToken = options.adminToken || process.env.INSTANT_APP_ADMIN_TOKEN;\n  if (!appId) {\n    throw new Error(\n      'Missing adminToken. Pass it as an argument to createResumableStreamContext or set the INSTANT_APP_ADMIN_TOKEN environment variable.',\n    );\n  }\n  const apiURI = options.apiURI || process.env.INSTANT_API_URI;\n\n  const db = init({\n    appId,\n    adminToken,\n    apiURI,\n  });\n\n  async function resumableStream(\n    streamId: string,\n    makeStream: () => ReadableStream<string>,\n    skipCharacters?: number,\n  ): Promise<ReadableStream<string> | null> {\n    const writeStream = db.streams.createWriteStream({\n      clientId: streamId,\n      waitUntil: options.waitUntil ?? undefined,\n    });\n    try {\n      const s = await writeStream.streamId();\n      const inputStream = makeStream();\n      inputStream.pipeTo(writeStream);\n      const readStream = db.streams.createReadStream({ streamId: s });\n      if (skipCharacters) {\n        return readStream.pipeThrough(\n          skipCharactersTransformer(skipCharacters),\n        );\n      }\n      return readStream;\n    } catch (e) {\n      const readStream = db.streams.createReadStream({ clientId: streamId });\n      if (skipCharacters) {\n        return readStream.pipeThrough(\n          skipCharactersTransformer(skipCharacters),\n        );\n      }\n      return readStream;\n    }\n  }\n\n  async function resumeExistingStream(\n    streamId: string,\n    skipCharacters?: number,\n  ): Promise<ReadableStream<string> | null | undefined> {\n    const readStream = db.streams.createReadStream({ clientId: streamId });\n    if (skipCharacters) {\n      return readStream.pipeThrough(skipCharactersTransformer(skipCharacters));\n    }\n    return readStream;\n  }\n\n  async function createNewResumableStream(\n    streamId: string,\n    makeStream: () => ReadableStream<string>,\n    skipCharacters?: number,\n  ): Promise<ReadableStream<string> | null> {\n    const inputStream = makeStream();\n    const writeStream = db.streams.createWriteStream({\n      clientId: streamId,\n      waitUntil: options.waitUntil ?? undefined,\n    });\n\n    // Wait for stream to be acknowledged by the server\n    await writeStream.streamId();\n\n    inputStream.pipeTo(writeStream);\n    const readStream = db.streams.createReadStream({ clientId: streamId });\n    if (skipCharacters) {\n      return readStream.pipeThrough(skipCharactersTransformer(skipCharacters));\n    }\n    return readStream;\n  }\n\n  async function hasExistingStream(\n    streamId: string,\n  ): Promise<null | true | 'DONE'> {\n    const data = await db.query({\n      $streams: { $: { where: { clientId: streamId } } },\n    });\n\n    const stream = data?.$streams?.[0];\n    if (stream?.done) {\n      return 'DONE';\n    }\n    if (stream) {\n      return true;\n    }\n    return null;\n  }\n\n  return {\n    resumableStream,\n    resumeExistingStream,\n    createNewResumableStream,\n    hasExistingStream,\n  };\n}\n"]}

package/dist/commonjs/package.json

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

package/dist/esm/index.d.ts

@@ -0,0 +1,63 @@
+export interface CreateResumableStreamContextOptions {
+    /**
+     * A function that takes a promise and ensures that the current program stays alive
+     * until the promise is resolved.
+     *
+     * If you are deploying to a server environment, where you don't have to worry about
+     * the function getting suspended, pass in null.
+     */
+    waitUntil: ((promise: Promise<unknown>) => void) | null;
+    /**
+     * The appId for your InstantDB app. It may also be provided with the INSTANT_APP_ID environment variable.
+     */
+    appId?: string;
+    /**
+     * The appId for your InstantDB app. It may also be provided with the INSTANT_ADMIN_TOKEN environment variable.
+     */
+    adminToken?: string;
+    /**
+     * Optional apiURI for the instantdb server.
+     */
+    apiURI?: string;
+}
+export interface ResumableStreamContext {
+    /**
+     * Creates or resumes a resumable stream.
+     *
+     * Does not throw if the underlying stream is already done. The output can always be read from the
+     * stream and does not have to be saved to a separate table after streaming is completed.
+     *
+     * By default returns the entire buffered stream. Use `skipCharacters` to resume from a specific point.
+     *
+     * @param streamId - The ID of the stream. Must be unique for each stream.
+     * @param makeStream - A function that returns a stream of strings. It's only executed if the stream it not yet in progress.
+     * @param skipCharacters - Number of characters to skip
+     * @returns A readable stream of strings. Returns the stream even if it is fully done (streams are persisted until deleted)
+     */
+    resumableStream: (streamId: string, makeStream: () => ReadableStream<string>, skipCharacters?: number) => Promise<ReadableStream<string> | null>;
+    /**
+     * Resumes a stream that was previously created by `createNewResumableStream`.
+     *
+     * @param streamId - The ID of the stream. Must be unique for each stream.
+     * @param skipCharacters - Number of characters to skip
+     * @returns A readable stream of strings. Returns the stream even if it is fully done (streams are persisted until deleted)
+     */
+    resumeExistingStream: (streamId: string, skipCharacters?: number) => Promise<ReadableStream<string> | null | undefined>;
+    /**
+     * Creates a new resumable stream.
+     *
+     * @param streamId - The ID of the stream. Must be unique for each stream.
+     * @param makeStream - A function that returns a stream of strings.
+     * @param skipCharacters - Number of characters to skip
+     * @returns A readable stream of strings. Returns the stream even if it is fully done (streams are persisted until deleted)
+     */
+    createNewResumableStream: (streamId: string, makeStream: () => ReadableStream<string>, skipCharacters?: number) => Promise<ReadableStream<string> | null>;
+    /**
+     * Checks if a stream with the given streamId exists.
+     * @param streamId - The ID of the stream.
+     * @returns null if there is no stream with the given streamId. True if a stream with the given streamId exists. "DONE" if the stream is fully done.
+     */
+    hasExistingStream: (streamId: string) => Promise<null | true | 'DONE'>;
+}
+export declare function createResumableStreamContext(options: CreateResumableStreamContextOptions): ResumableStreamContext;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,mCAAmC;IAClD;;;;;;OAMG;IACH,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC;IACxD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC;;;;;;;;;;;;OAYG;IACH,eAAe,EAAE,CACf,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,cAAc,CAAC,MAAM,CAAC,EACxC,cAAc,CAAC,EAAE,MAAM,KACpB,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAC5C;;;;;;OAMG;IACH,oBAAoB,EAAE,CACpB,QAAQ,EAAE,MAAM,EAChB,cAAc,CAAC,EAAE,MAAM,KACpB,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;IACxD;;;;;;;OAOG;IACH,wBAAwB,EAAE,CACxB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,cAAc,CAAC,MAAM,CAAC,EACxC,cAAc,CAAC,EAAE,MAAM,KACpB,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAE5C;;;;OAIG;IACH,iBAAiB,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,GAAG,IAAI,GAAG,MAAM,CAAC,CAAC;CACxE;AAqBD,wBAAgB,4BAA4B,CAC1C,OAAO,EAAE,mCAAmC,GAC3C,sBAAsB,CA4GxB"}

package/dist/esm/index.js

@@ -0,0 +1,100 @@
+import { init } from '@instantdb/admin';
+function skipCharactersTransformer(skipCharacters) {
+    let skipLeft = skipCharacters;
+    return new TransformStream({
+        transform(chunk, controller) {
+            if (!skipLeft) {
+                controller.enqueue(chunk);
+                return;
+            }
+            if (skipLeft > chunk.length) {
+                skipLeft += chunk.length;
+                return;
+            }
+            const remaining = chunk.slice(skipLeft);
+            skipLeft = 0;
+            controller.enqueue(remaining);
+        },
+    });
+}
+export function createResumableStreamContext(options) {
+    const appId = options.appId || process.env.INSTANT_APP_ID;
+    if (!appId) {
+        throw new Error('Missing appId. Pass it as an argument to createResumableStreamContext or set the INSTANT_APP_ID environment variable.');
+    }
+    const adminToken = options.adminToken || process.env.INSTANT_APP_ADMIN_TOKEN;
+    if (!appId) {
+        throw new Error('Missing adminToken. Pass it as an argument to createResumableStreamContext or set the INSTANT_APP_ADMIN_TOKEN environment variable.');
+    }
+    const apiURI = options.apiURI || process.env.INSTANT_API_URI;
+    const db = init({
+        appId,
+        adminToken,
+        apiURI,
+    });
+    async function resumableStream(streamId, makeStream, skipCharacters) {
+        const writeStream = db.streams.createWriteStream({
+            clientId: streamId,
+            waitUntil: options.waitUntil ?? undefined,
+        });
+        try {
+            const s = await writeStream.streamId();
+            const inputStream = makeStream();
+            inputStream.pipeTo(writeStream);
+            const readStream = db.streams.createReadStream({ streamId: s });
+            if (skipCharacters) {
+                return readStream.pipeThrough(skipCharactersTransformer(skipCharacters));
+            }
+            return readStream;
+        }
+        catch (e) {
+            const readStream = db.streams.createReadStream({ clientId: streamId });
+            if (skipCharacters) {
+                return readStream.pipeThrough(skipCharactersTransformer(skipCharacters));
+            }
+            return readStream;
+        }
+    }
+    async function resumeExistingStream(streamId, skipCharacters) {
+        const readStream = db.streams.createReadStream({ clientId: streamId });
+        if (skipCharacters) {
+            return readStream.pipeThrough(skipCharactersTransformer(skipCharacters));
+        }
+        return readStream;
+    }
+    async function createNewResumableStream(streamId, makeStream, skipCharacters) {
+        const inputStream = makeStream();
+        const writeStream = db.streams.createWriteStream({
+            clientId: streamId,
+            waitUntil: options.waitUntil ?? undefined,
+        });
+        // Wait for stream to be acknowledged by the server
+        await writeStream.streamId();
+        inputStream.pipeTo(writeStream);
+        const readStream = db.streams.createReadStream({ clientId: streamId });
+        if (skipCharacters) {
+            return readStream.pipeThrough(skipCharactersTransformer(skipCharacters));
+        }
+        return readStream;
+    }
+    async function hasExistingStream(streamId) {
+        const data = await db.query({
+            $streams: { $: { where: { clientId: streamId } } },
+        });
+        const stream = data?.$streams?.[0];
+        if (stream?.done) {
+            return 'DONE';
+        }
+        if (stream) {
+            return true;
+        }
+        return null;
+    }
+    return {
+        resumableStream,
+        resumeExistingStream,
+        createNewResumableStream,
+        hasExistingStream,
+    };
+}
+//# 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,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AA6ExC,SAAS,yBAAyB,CAAC,cAAsB;IACvD,IAAI,QAAQ,GAAG,cAAc,CAAC;IAC9B,OAAO,IAAI,eAAe,CAAS;QACjC,SAAS,CAAC,KAAK,EAAE,UAAU;YACzB,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC1B,OAAO;YACT,CAAC;YACD,IAAI,QAAQ,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;gBAC5B,QAAQ,IAAI,KAAK,CAAC,MAAM,CAAC;gBACzB,OAAO;YACT,CAAC;YACD,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACxC,QAAQ,GAAG,CAAC,CAAC;YACb,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAChC,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,4BAA4B,CAC1C,OAA4C;IAE5C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;IAC1D,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CACb,uHAAuH,CACxH,CAAC;IACJ,CAAC;IACD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC;IAC7E,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CACb,qIAAqI,CACtI,CAAC;IACJ,CAAC;IACD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;IAE7D,MAAM,EAAE,GAAG,IAAI,CAAC;QACd,KAAK;QACL,UAAU;QACV,MAAM;KACP,CAAC,CAAC;IAEH,KAAK,UAAU,eAAe,CAC5B,QAAgB,EAChB,UAAwC,EACxC,cAAuB;QAEvB,MAAM,WAAW,GAAG,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC;YAC/C,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,SAAS;SAC1C,CAAC,CAAC;QACH,IAAI,CAAC;YACH,MAAM,CAAC,GAAG,MAAM,WAAW,CAAC,QAAQ,EAAE,CAAC;YACvC,MAAM,WAAW,GAAG,UAAU,EAAE,CAAC;YACjC,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAChC,MAAM,UAAU,GAAG,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC;YAChE,IAAI,cAAc,EAAE,CAAC;gBACnB,OAAO,UAAU,CAAC,WAAW,CAC3B,yBAAyB,CAAC,cAAc,CAAC,CAC1C,CAAC;YACJ,CAAC;YACD,OAAO,UAAU,CAAC;QACpB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,UAAU,GAAG,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;YACvE,IAAI,cAAc,EAAE,CAAC;gBACnB,OAAO,UAAU,CAAC,WAAW,CAC3B,yBAAyB,CAAC,cAAc,CAAC,CAC1C,CAAC;YACJ,CAAC;YACD,OAAO,UAAU,CAAC;QACpB,CAAC;IACH,CAAC;IAED,KAAK,UAAU,oBAAoB,CACjC,QAAgB,EAChB,cAAuB;QAEvB,MAAM,UAAU,GAAG,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;QACvE,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,UAAU,CAAC,WAAW,CAAC,yBAAyB,CAAC,cAAc,CAAC,CAAC,CAAC;QAC3E,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,KAAK,UAAU,wBAAwB,CACrC,QAAgB,EAChB,UAAwC,EACxC,cAAuB;QAEvB,MAAM,WAAW,GAAG,UAAU,EAAE,CAAC;QACjC,MAAM,WAAW,GAAG,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC;YAC/C,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,SAAS;SAC1C,CAAC,CAAC;QAEH,mDAAmD;QACnD,MAAM,WAAW,CAAC,QAAQ,EAAE,CAAC;QAE7B,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAChC,MAAM,UAAU,GAAG,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;QACvE,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,UAAU,CAAC,WAAW,CAAC,yBAAyB,CAAC,cAAc,CAAC,CAAC,CAAC;QAC3E,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,KAAK,UAAU,iBAAiB,CAC9B,QAAgB;QAEhB,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,KAAK,CAAC;YAC1B,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE;SACnD,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC;QACnC,IAAI,MAAM,EAAE,IAAI,EAAE,CAAC;YACjB,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO;QACL,eAAe;QACf,oBAAoB;QACpB,wBAAwB;QACxB,iBAAiB;KAClB,CAAC;AACJ,CAAC","sourcesContent":["import { init } from '@instantdb/admin';\n\nexport interface CreateResumableStreamContextOptions {\n  /**\n   * A function that takes a promise and ensures that the current program stays alive\n   * until the promise is resolved.\n   *\n   * If you are deploying to a server environment, where you don't have to worry about\n   * the function getting suspended, pass in null.\n   */\n  waitUntil: ((promise: Promise<unknown>) => void) | null;\n  /**\n   * The appId for your InstantDB app. It may also be provided with the INSTANT_APP_ID environment variable.\n   */\n  appId?: string;\n  /**\n   * The appId for your InstantDB app. It may also be provided with the INSTANT_ADMIN_TOKEN environment variable.\n   */\n  adminToken?: string;\n  /**\n   * Optional apiURI for the instantdb server.\n   */\n  apiURI?: string;\n}\n\nexport interface ResumableStreamContext {\n  /**\n   * Creates or resumes a resumable stream.\n   *\n   * Does not throw if the underlying stream is already done. The output can always be read from the\n   * stream and does not have to be saved to a separate table after streaming is completed.\n   *\n   * By default returns the entire buffered stream. Use `skipCharacters` to resume from a specific point.\n   *\n   * @param streamId - The ID of the stream. Must be unique for each stream.\n   * @param makeStream - A function that returns a stream of strings. It's only executed if the stream it not yet in progress.\n   * @param skipCharacters - Number of characters to skip\n   * @returns A readable stream of strings. Returns the stream even if it is fully done (streams are persisted until deleted)\n   */\n  resumableStream: (\n    streamId: string,\n    makeStream: () => ReadableStream<string>,\n    skipCharacters?: number,\n  ) => Promise<ReadableStream<string> | null>;\n  /**\n   * Resumes a stream that was previously created by `createNewResumableStream`.\n   *\n   * @param streamId - The ID of the stream. Must be unique for each stream.\n   * @param skipCharacters - Number of characters to skip\n   * @returns A readable stream of strings. Returns the stream even if it is fully done (streams are persisted until deleted)\n   */\n  resumeExistingStream: (\n    streamId: string,\n    skipCharacters?: number,\n  ) => Promise<ReadableStream<string> | null | undefined>;\n  /**\n   * Creates a new resumable stream.\n   *\n   * @param streamId - The ID of the stream. Must be unique for each stream.\n   * @param makeStream - A function that returns a stream of strings.\n   * @param skipCharacters - Number of characters to skip\n   * @returns A readable stream of strings. Returns the stream even if it is fully done (streams are persisted until deleted)\n   */\n  createNewResumableStream: (\n    streamId: string,\n    makeStream: () => ReadableStream<string>,\n    skipCharacters?: number,\n  ) => Promise<ReadableStream<string> | null>;\n\n  /**\n   * Checks if a stream with the given streamId exists.\n   * @param streamId - The ID of the stream.\n   * @returns null if there is no stream with the given streamId. True if a stream with the given streamId exists. \"DONE\" if the stream is fully done.\n   */\n  hasExistingStream: (streamId: string) => Promise<null | true | 'DONE'>;\n}\n\nfunction skipCharactersTransformer(skipCharacters: number) {\n  let skipLeft = skipCharacters;\n  return new TransformStream<string>({\n    transform(chunk, controller) {\n      if (!skipLeft) {\n        controller.enqueue(chunk);\n        return;\n      }\n      if (skipLeft > chunk.length) {\n        skipLeft += chunk.length;\n        return;\n      }\n      const remaining = chunk.slice(skipLeft);\n      skipLeft = 0;\n      controller.enqueue(remaining);\n    },\n  });\n}\n\nexport function createResumableStreamContext(\n  options: CreateResumableStreamContextOptions,\n): ResumableStreamContext {\n  const appId = options.appId || process.env.INSTANT_APP_ID;\n  if (!appId) {\n    throw new Error(\n      'Missing appId. Pass it as an argument to createResumableStreamContext or set the INSTANT_APP_ID environment variable.',\n    );\n  }\n  const adminToken = options.adminToken || process.env.INSTANT_APP_ADMIN_TOKEN;\n  if (!appId) {\n    throw new Error(\n      'Missing adminToken. Pass it as an argument to createResumableStreamContext or set the INSTANT_APP_ADMIN_TOKEN environment variable.',\n    );\n  }\n  const apiURI = options.apiURI || process.env.INSTANT_API_URI;\n\n  const db = init({\n    appId,\n    adminToken,\n    apiURI,\n  });\n\n  async function resumableStream(\n    streamId: string,\n    makeStream: () => ReadableStream<string>,\n    skipCharacters?: number,\n  ): Promise<ReadableStream<string> | null> {\n    const writeStream = db.streams.createWriteStream({\n      clientId: streamId,\n      waitUntil: options.waitUntil ?? undefined,\n    });\n    try {\n      const s = await writeStream.streamId();\n      const inputStream = makeStream();\n      inputStream.pipeTo(writeStream);\n      const readStream = db.streams.createReadStream({ streamId: s });\n      if (skipCharacters) {\n        return readStream.pipeThrough(\n          skipCharactersTransformer(skipCharacters),\n        );\n      }\n      return readStream;\n    } catch (e) {\n      const readStream = db.streams.createReadStream({ clientId: streamId });\n      if (skipCharacters) {\n        return readStream.pipeThrough(\n          skipCharactersTransformer(skipCharacters),\n        );\n      }\n      return readStream;\n    }\n  }\n\n  async function resumeExistingStream(\n    streamId: string,\n    skipCharacters?: number,\n  ): Promise<ReadableStream<string> | null | undefined> {\n    const readStream = db.streams.createReadStream({ clientId: streamId });\n    if (skipCharacters) {\n      return readStream.pipeThrough(skipCharactersTransformer(skipCharacters));\n    }\n    return readStream;\n  }\n\n  async function createNewResumableStream(\n    streamId: string,\n    makeStream: () => ReadableStream<string>,\n    skipCharacters?: number,\n  ): Promise<ReadableStream<string> | null> {\n    const inputStream = makeStream();\n    const writeStream = db.streams.createWriteStream({\n      clientId: streamId,\n      waitUntil: options.waitUntil ?? undefined,\n    });\n\n    // Wait for stream to be acknowledged by the server\n    await writeStream.streamId();\n\n    inputStream.pipeTo(writeStream);\n    const readStream = db.streams.createReadStream({ clientId: streamId });\n    if (skipCharacters) {\n      return readStream.pipeThrough(skipCharactersTransformer(skipCharacters));\n    }\n    return readStream;\n  }\n\n  async function hasExistingStream(\n    streamId: string,\n  ): Promise<null | true | 'DONE'> {\n    const data = await db.query({\n      $streams: { $: { where: { clientId: streamId } } },\n    });\n\n    const stream = data?.$streams?.[0];\n    if (stream?.done) {\n      return 'DONE';\n    }\n    if (stream) {\n      return true;\n    }\n    return null;\n  }\n\n  return {\n    resumableStream,\n    resumeExistingStream,\n    createNewResumableStream,\n    hasExistingStream,\n  };\n}\n"]}

package/dist/esm/package.json

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