feat: make plugins compatible with prisma client extensions

.vscode/tasks.json

@@ -18,7 +18,7 @@
         },
         {
             "label": "Build all - watch",
-            "command": "pnpm watch",
+            "command": "turbo watch build",
             "type": "shell",
             "group": {
                 "kind": "build"
@@ -28,6 +28,16 @@
                 "id": "server-process"
             }
         },
+        {
+            "label": "Lint all",
+            "command": "pnpm lint",
+            "type": "shell",
+            "icon": {
+                "color": "terminal.ansiYellow",
+                "id": "server-process"
+            },
+            "problemMatcher": []
+        },
         {
             "label": "Test all",
             "command": "pnpm test",

README.md

@@ -280,16 +280,20 @@ You can use a plugin to achieve the following goals:
 
 #### 1. ORM query interception
 
-ORM query interception allows you to intercept the high-level ORM API calls.
+ORM query interception allows you to intercept the high-level ORM API calls. The interceptor's configuration is compatible with Prisma's [query client extension](https://www.prisma.io/docs/orm/prisma-client/client-extensions/query).
 
 ```ts
 client.$use({
     id: 'cost-logger',
-    async onQuery({ model, operation, proceed, queryArgs }) {
-        const start = Date.now();
-        const result = await proceed(queryArgs);
-        console.log(`[cost] ${model} ${operation} took ${Date.now() - start}ms`);
-        return result;
+    onQuery: {
+        $allModels: {
+            $allOperations: async ({ model, operation, args, query }) => {
+                const start = Date.now();
+                const result = await query(args);
+                console.log(`[cost] ${model} ${operation} took ${Date.now() - start}ms`);
+                return result;
+            },
+        },
     },
 });
 ```

TODO.md

@@ -51,10 +51,11 @@
         - [x] Count
         - [x] Aggregate
         - [x] Group by
+    - [ ] Raw queries
     - [ ] Extensions
         - [x] Query builder API
         - [x] Computed fields
-        - [ ] Prisma client extension
+        - [x] Prisma client extension
     - [ ] Misc
         - [x] JSDoc for CRUD methods
         - [x] Cache validation schemas
@@ -66,7 +67,8 @@
         - [ ] Error system
         - [x] Custom table name
         - [x] Custom field name
-        - [ ] Implement changesets
+        - [ ] Strict undefined checks
+    - [ ] Benchmark
 - [ ] Polymorphism
 - [ ] Validation
 - [ ] Access Policy

package.json

@@ -1,6 +1,6 @@
 {
     "name": "zenstack-v3",
-    "version": "3.0.0-alpha.4",
+    "version": "3.0.0-alpha.5",
     "description": "ZenStack",
     "packageManager": "pnpm@10.12.1",
     "scripts": {

packages/cli/package.json

@@ -3,7 +3,7 @@
     "publisher": "zenstack",
     "displayName": "ZenStack CLI",
     "description": "FullStack database toolkit with built-in access control and automatic API generation.",
-    "version": "3.0.0-alpha.4",
+    "version": "3.0.0-alpha.5",
     "type": "module",
     "author": {
         "name": "ZenStack Team"
@@ -22,20 +22,21 @@
     },
     "scripts": {
         "build": "tsup-node",
+        "watch": "tsup-node --watch",
         "lint": "eslint src --ext ts",
         "test": "vitest run",
         "pack": "pnpm pack"
     },
     "dependencies": {
         "@zenstackhq/language": "workspace:*",
         "@zenstackhq/sdk": "workspace:*",
+        "@zenstackhq/common-helpers": "workspace:*",
         "async-exit-hook": "^2.0.1",
         "colors": "1.4.0",
         "commander": "^8.3.0",
         "langium": "catalog:",
         "ora": "^5.4.1",
         "package-manager-detector": "^1.3.0",
-        "tiny-invariant": "^1.3.3",
         "ts-pattern": "catalog:"
     },
     "peerDependencies": {

packages/cli/src/actions/generate.ts

@@ -1,10 +1,9 @@
+import { invariant } from '@zenstackhq/common-helpers';
 import { isPlugin, LiteralExpr, type Model } from '@zenstackhq/language/ast';
-import type { CliGenerator } from '@zenstackhq/runtime/client';
-import { PrismaSchemaGenerator, TsSchemaGenerator } from '@zenstackhq/sdk';
+import { PrismaSchemaGenerator, TsSchemaGenerator, type CliGenerator } from '@zenstackhq/sdk';
 import colors from 'colors';
 import fs from 'node:fs';
 import path from 'node:path';
-import invariant from 'tiny-invariant';
 import { getSchemaFile, loadSchemaDocument } from './action-utils';
 
 type Options = {

packages/common-helpers/eslint.config.js

@@ -0,0 +1,4 @@
+import config from '@zenstackhq/eslint-config/base.js';
+
+/** @type {import("eslint").Linter.Config} */
+export default config;

packages/common-helpers/package.json

@@ -0,0 +1,34 @@
+{
+    "name": "@zenstackhq/common-helpers",
+    "version": "3.0.0-alpha.5",
+    "description": "ZenStack Common Helpers",
+    "type": "module",
+    "scripts": {
+        "build": "tsup-node",
+        "watch": "tsup-node --watch",
+        "lint": "eslint src --ext ts",
+        "pack": "pnpm pack"
+    },
+    "keywords": [],
+    "author": "ZenStack Team",
+    "license": "MIT",
+    "files": [
+        "dist"
+    ],
+    "exports": {
+        ".": {
+            "import": {
+                "types": "./dist/index.d.ts",
+                "default": "./dist/index.js"
+            },
+            "require": {
+                "types": "./dist/index.d.cts",
+                "default": "./dist/index.cjs"
+            }
+        }
+    },
+    "devDependencies": {
+        "@zenstackhq/typescript-config": "workspace:*",
+        "@zenstackhq/eslint-config": "workspace:*"
+    }
+}

packages/common-helpers/src/index.ts

@@ -0,0 +1,6 @@
+export * from './is-plain-object';
+export * from './lower-case-first';
+export * from './param-case';
+export * from './sleep';
+export * from './tiny-invariant';
+export * from './upper-case-first';

packages/common-helpers/src/is-plain-object.ts

@@ -0,0 +1,23 @@
+function isObject(o: unknown) {
+    return Object.prototype.toString.call(o) === '[object Object]';
+}
+
+export function isPlainObject(o: unknown) {
+    if (isObject(o) === false) return false;
+
+    // If has modified constructor
+    const ctor = (o as { constructor: unknown }).constructor;
+    if (ctor === undefined) return true;
+
+    // If has modified prototype
+    const prot = (ctor as { prototype: unknown }).prototype;
+    if (isObject(prot) === false) return false;
+
+    // If constructor does not have an Object-specific method
+    if (Object.prototype.hasOwnProperty.call(prot, 'isPrototypeOf') === false) {
+        return false;
+    }
+
+    // Most likely a plain Object
+    return true;
+}

packages/common-helpers/src/lower-case-first.ts

@@ -0,0 +1,3 @@
+export function lowerCaseFirst(input: string) {
+    return input.charAt(0).toLowerCase() + input.slice(1);
+}

packages/common-helpers/src/param-case.ts

@@ -0,0 +1,18 @@
+const DEFAULT_SPLIT_REGEXP_1 = /([a-z0-9])([A-Z])/g;
+const DEFAULT_SPLIT_REGEXP_2 = /([A-Z])([A-Z][a-z])/g;
+const DEFAULT_STRIP_REGEXP = /[^A-Z0-9]+/gi;
+
+export function paramCase(input: string) {
+    const result = input
+        .replace(DEFAULT_SPLIT_REGEXP_1, "$1\0$2")
+        .replace(DEFAULT_SPLIT_REGEXP_2, "$1\0$2")
+        .replace(DEFAULT_STRIP_REGEXP, "\0");
+
+    let start = 0;
+    let end = result.length;
+
+    while (result.charAt(start) === "\0") start++;
+    while (result.charAt(end - 1) === "\0") end--;
+
+    return result.slice(start, end).split("\0").map((str) => str.toLowerCase()).join("-");
+}

packages/common-helpers/src/sleep.ts

@@ -0,0 +1,5 @@
+export function sleep(timeout: number) {
+    return new Promise<void>((resolve) => {
+        setTimeout(() => resolve(), timeout);
+    });
+}

packages/common-helpers/src/tiny-invariant.ts

@@ -0,0 +1,14 @@
+const isProduction = process.env['NODE_ENV'] === 'production';
+const prefix = 'Invariant failed';
+
+export function invariant(condition: unknown, message?: string): asserts condition {
+    if (condition) {
+        return;
+    }
+
+    if (isProduction) {
+        throw new Error(prefix);
+    }
+
+    throw new Error(message ? `${prefix}: ${message}` : prefix);
+}

packages/common-helpers/src/upper-case-first.ts

@@ -0,0 +1,3 @@
+export function upperCaseFirst(input: string) {
+    return input.charAt(0).toUpperCase() + input.slice(1);
+}

packages/common-helpers/tsconfig.json

@@ -0,0 +1,7 @@
+{
+    "extends": "@zenstackhq/typescript-config/base.json",
+    "compilerOptions": {
+        "outDir": "dist"
+    },
+    "include": ["src/**/*.ts"]
+}

packages/common-helpers/tsup.config.ts

@@ -0,0 +1,13 @@
+import { defineConfig } from 'tsup';
+
+export default defineConfig({
+    entry: {
+        index: 'src/index.ts',
+    },
+    outDir: 'dist',
+    splitting: false,
+    sourcemap: true,
+    clean: true,
+    dts: true,
+    format: ['cjs', 'esm'],
+});

packages/create-zenstack/package.json

@@ -1,6 +1,6 @@
 {
     "name": "create-zenstack",
-    "version": "3.0.0-alpha.4",
+    "version": "3.0.0-alpha.5",
     "description": "Create a new ZenStack project",
     "type": "module",
     "scripts": {

packages/eslint-config/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/eslint-config",
-    "version": "3.0.0-alpha.4",
+    "version": "3.0.0-alpha.5",
     "type": "module",
     "private": true,
     "license": "MIT"

packages/language/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/language",
     "description": "ZenStack ZModel language specification",
-    "version": "3.0.0-alpha.4",
+    "version": "3.0.0-alpha.5",
     "license": "MIT",
     "author": "ZenStack Team",
     "files": [

packages/runtime/package.json

@@ -1,10 +1,11 @@
 {
     "name": "@zenstackhq/runtime",
-    "version": "3.0.0-alpha.4",
+    "version": "3.0.0-alpha.5",
     "description": "ZenStack Runtime",
     "type": "module",
     "scripts": {
         "build": "tsup-node",
+        "watch": "tsup-node --watch",
         "lint": "eslint src --ext ts",
         "test": "vitest run && pnpm test:generate && pnpm test:typecheck",
         "test:generate": "tsx test/typing/generate.ts",
@@ -64,13 +65,12 @@
         }
     },
     "dependencies": {
+        "@zenstackhq/common-helpers": "workspace:*",
         "@paralleldrive/cuid2": "^2.2.2",
         "decimal.js": "^10.4.3",
-        "is-plain-object": "^5.0.0",
         "json-stable-stringify": "^1.3.0",
         "kysely": "catalog:",
         "nanoid": "^5.0.9",
-        "tiny-invariant": "^1.3.3",
         "ts-pattern": "catalog:",
         "ulid": "^3.0.0",
         "utility-types": "^3.11.0",