prisma-cursorstream 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Hasan Arous (EtaBits)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,72 @@
+# prisma-cursorstream
+
+Prisma Stream Client Extension (Cursor-based Implementation)
+
+## Features
+
+- Clean API (`for await`)
+- Fully typed <img src="https://www.typescriptlang.org/favicon-32x32.png" height="16" width="16" alt="" />
+- Minimal implementation. The [source](https://github.com/etabits/prisma-cursorstream/blob/main/src/index.ts) itself is well below 100 LOCs.
+
+## Installation & Activation
+
+```sh
+npm install prisma-cursorstream
+```
+
+Then, extend your prisma client like this:
+
+```js
+import { PrismaClient } from "@prisma/client";
+import cursorStream from "prisma-cursorstream";
+
+const db = new PrismaClient().$extends(cursorStream);
+```
+
+## Usage
+
+```js
+const stream = db.post.cursorStream({
+  // Your usual findMany args
+  select: {
+    id: true,
+    title: true,
+  },
+  where: {
+    published: true,
+  },
+});
+for await (const post of stream) {
+  console.log(post); // {id: 1, title: 'Hello!'}
+}
+```
+
+## Advanced API
+
+The following options provide additional controls over the streaming process.
+
+- **Batch size**: The `take` property of the findMany arg is repurposed to specify how many rows are fetched each batch. Defaults to `100`
+- **Pre-fill size**: Since the streaming happens asynchronously, it may be useful to fetch more rows well before current batch is completely consumed. Use the `skip` property of the findMany arg which is repurposed to specify the internal `highWaterMark` of the `Readable` stream. Defaults to double the batch size (usually `200`).
+- **Batch transformation**: Sometimes you may need to pre-process the resulting rows in batches before they are consumed. This is where the `batchTransformer` comes in. If provided, it receives an array of the last fetched batch of rows, can operate on them asynchronously, and then return an array of transformed rows to be consumed instead. Types are properly handled.
+
+```js
+const stream = db.post.cursorStream(
+  {
+    take: 42, // batches of 42 posts at a time
+    skip: 69, // prefetch up to 69 posts
+  },
+  {
+    async batchTransformer(posts) {
+      const translations = await translate(posts.map((p) => p.title));
+      return posts.map((p, i) => ({
+        ...p,
+        translatedTitle: translations[i],
+      }));
+    },
+  }
+);
+
+for await (const translatedPost of stream) {
+  console.log(translatedPost); // {..., translatedTitle: "مرحبا!"}
+}
+```

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import { Prisma, PrismaClientExtends } from "@prisma/client/extension";
+import { DefaultArgs } from "@prisma/client/runtime/library";
+declare const _default: (client: any) => PrismaClientExtends<import("@prisma/client/runtime/library").InternalArgs<{}, {
+    $allModels: {
+        cursorStream<T, A extends Prisma.Args<T, "findMany">, R extends Prisma.Result<T, A, "findMany">[number], C extends ((dataset: R[]) => Promise<unknown[]>) | undefined>(this: T, findManyArgs: A, { batchTransformer }?: {
+            batchTransformer?: C | undefined;
+        }): Iterable<C extends Function ? Awaited<ReturnType<C>>[number] extends object ? Awaited<ReturnType<C>>[number] : R : R>;
+    };
+}, {}, {}> & DefaultArgs>;
+export default _default;

package/dist/index.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const extension_1 = require("@prisma/client/extension");
+const node_stream_1 = require("node:stream");
+exports.default = extension_1.Prisma.defineExtension((client) => {
+    return client.$extends({
+        model: {
+            $allModels: {
+                cursorStream(findManyArgs, { batchTransformer } = {}) {
+                    const context = extension_1.Prisma.getExtensionContext(this);
+                    const take = findManyArgs.take || 100;
+                    const highWaterMark = findManyArgs.skip || take * 2;
+                    const cursorField = Object.keys(findManyArgs.cursor || {})[0] || "id";
+                    if (findManyArgs.select && !findManyArgs.select[cursorField]) {
+                        throw new Error(`Must select cursor field "${cursorField}"`);
+                    }
+                    let cursorValue;
+                    const readableStream = new node_stream_1.Readable({
+                        objectMode: true,
+                        highWaterMark,
+                        async read() {
+                            try {
+                                const results = await context.findMany({
+                                    ...findManyArgs,
+                                    take,
+                                    skip: cursorValue ? 1 : 0,
+                                    cursor: cursorValue
+                                        ? {
+                                            [cursorField]: cursorValue,
+                                        }
+                                        : undefined,
+                                });
+                                const transformedResults = batchTransformer
+                                    ? await batchTransformer(results)
+                                    : results;
+                                for (const result of transformedResults) {
+                                    this.push(result);
+                                }
+                                if (results.length < take) {
+                                    this.push(null);
+                                    return;
+                                }
+                                cursorValue = results[results.length - 1][cursorField];
+                            }
+                            catch (err) {
+                                this.destroy(err);
+                            }
+                        },
+                    });
+                    return readableStream;
+                },
+            },
+        },
+    });
+});

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "prisma-cursorstream",
+  "version": "0.1.0",
+  "description": "Prisma Stream Client Extension (Cursor-based Implementation)",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "keywords": [
+    "prisma-extension",
+    "prisma-client",
+    "prisma",
+    "streams"
+  ],
+  "author": "Hasan Arous <hasan.arous@gmail.com> (https://www.aularon.com/)",
+  "license": "MIT",
+  "devDependencies": {
+    "@prisma/client": "^5.1.1",
+    "@types/node": "^20.5.1",
+    "typescript": "^5.1.6"
+  },
+  "peerDependencies": {
+    "@prisma/client": "^5.1.1"
+  },
+  "scripts": {}
+}