extract policy plugin to its own package

ymc9 · ymc9 · commit 41cd47862f37 · 2025-10-03T20:41:42.000-07:00
diff --git a/packages/plugins/policy/package.json b/packages/plugins/policy/package.json
@@ -0,0 +1,50 @@
+{
+    "name": "@zenstackhq/plugin-policy",
+    "version": "3.0.0-beta.8",
+    "description": "ZenStack Policy Plugin",
+    "type": "module",
+    "scripts": {
+        "build": "tsc --noEmit && 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"
+            }
+        },
+        "./package.json": {
+            "import": "./package.json",
+            "require": "./package.json"
+        }
+    },
+    "dependencies": {
+        "@zenstackhq/common-helpers": "workspace:*",
+        "@zenstackhq/sdk": "workspace:*",
+        "@zenstackhq/runtime": "workspace:*",
+        "ts-pattern": "catalog:"
+    },
+    "peerDependencies": {
+        "kysely": "catalog:"
+    },
+    "devDependencies": {
+        "@types/better-sqlite3": "^7.6.13",
+        "@types/pg": "^8.0.0",
+        "@zenstackhq/eslint-config": "workspace:*",
+        "@zenstackhq/typescript-config": "workspace:*",
+        "@zenstackhq/vitest-config": "workspace:*"
+    }
+}
diff --git a/packages/plugins/policy/src/column-collector.ts b/packages/plugins/policy/src/column-collector.ts
@@ -1,5 +1,5 @@
 import type { ColumnNode, OperationNode } from 'kysely';
-import { DefaultOperationNodeVisitor } from '../../utils/default-operation-node-visitor';
+import { DefaultOperationNodeVisitor } from '@zenstackhq/sdk';
 
 /**
  * Collects all column names from a query.
diff --git a/packages/plugins/policy/src/expression-evaluator.ts b/packages/plugins/policy/src/expression-evaluator.ts
@@ -10,7 +10,7 @@ import {
     type LiteralExpression,
     type MemberExpression,
     type UnaryExpression,
-} from '../../schema';
+} from '@zenstackhq/runtime/schema';
 
 type ExpressionEvaluatorContext = {
     auth?: any;
diff --git a/packages/plugins/policy/src/expression-transformer.ts b/packages/plugins/policy/src/expression-transformer.ts
@@ -1,4 +1,31 @@
 import { invariant } from '@zenstackhq/common-helpers';
+import {
+    getCrudDialect,
+    InternalError,
+    QueryError,
+    QueryUtils,
+    type BaseCrudDialect,
+    type ClientContract,
+    type CRUD_EXT,
+} from '@zenstackhq/runtime';
+import type {
+    BinaryExpression,
+    BinaryOperator,
+    BuiltinType,
+    FieldDef,
+    GetModels,
+    LiteralExpression,
+    MemberExpression,
+    UnaryExpression,
+} from '@zenstackhq/runtime/schema';
+import {
+    ExpressionUtils,
+    type ArrayExpression,
+    type CallExpression,
+    type Expression,
+    type FieldExpression,
+    type SchemaDef,
+} from '@zenstackhq/runtime/schema';
 import {
     AliasNode,
     BinaryOperationNode,
@@ -20,29 +47,6 @@ import {
     type OperationNode,
 } from 'kysely';
 import { match } from 'ts-pattern';
-import { QueryUtils } from '../../client';
-import type { ClientContract, CRUD_EXT } from '../../client/contract';
-import { getCrudDialect } from '../../client/crud/dialects';
-import type { BaseCrudDialect } from '../../client/crud/dialects/base-dialect';
-import { InternalError, QueryError } from '../../client/errors';
-import type {
-    BinaryExpression,
-    BinaryOperator,
-    BuiltinType,
-    FieldDef,
-    GetModels,
-    LiteralExpression,
-    MemberExpression,
-    UnaryExpression,
-} from '../../schema';
-import {
-    ExpressionUtils,
-    type ArrayExpression,
-    type CallExpression,
-    type Expression,
-    type FieldExpression,
-    type SchemaDef,
-} from '../../schema';
 import { ExpressionEvaluator } from './expression-evaluator';
 import { conjunction, disjunction, falseNode, isBeforeInvocation, logicalNot, trueNode } from './utils';
 
diff --git a/packages/plugins/policy/src/functions.ts b/packages/plugins/policy/src/functions.ts
@@ -1,8 +1,7 @@
 import { invariant } from '@zenstackhq/common-helpers';
+import type { ZModelFunction, ZModelFunctionContext } from '@zenstackhq/runtime';
+import { CRUD, QueryUtils } from '@zenstackhq/runtime';
 import { ExpressionWrapper, ValueNode, type Expression, type ExpressionBuilder } from 'kysely';
-import { QueryUtils } from '../../client';
-import { CRUD } from '../../client/contract';
-import type { ZModelFunction, ZModelFunctionContext } from '../../client/options';
 import { PolicyHandler } from './policy-handler';
 
 /**
diff --git a/packages/plugins/policy/src/index.ts b/packages/plugins/policy/src/index.ts
diff --git a/packages/plugins/policy/src/plugin.ts b/packages/plugins/policy/src/plugin.ts
@@ -1,5 +1,5 @@
-import { type OnKyselyQueryArgs, type RuntimePlugin } from '../../client/plugin';
-import type { SchemaDef } from '../../schema';
+import { type OnKyselyQueryArgs, type RuntimePlugin } from '@zenstackhq/runtime';
+import type { SchemaDef } from '@zenstackhq/runtime/schema';
 import { check } from './functions';
 import { PolicyHandler } from './policy-handler';
 
diff --git a/packages/plugins/policy/src/policy-handler.ts b/packages/plugins/policy/src/policy-handler.ts
@@ -1,4 +1,23 @@
 import { invariant } from '@zenstackhq/common-helpers';
+import type { BaseCrudDialect, ClientContract, ProceedKyselyQueryFunction } from '@zenstackhq/runtime';
+import {
+    getCrudDialect,
+    InternalError,
+    QueryError,
+    QueryUtils,
+    RejectedByPolicyError,
+    RejectedByPolicyReason,
+    type CRUD_EXT,
+} from '@zenstackhq/runtime';
+import {
+    ExpressionUtils,
+    type BuiltinType,
+    type Expression,
+    type GetModels,
+    type MemberExpression,
+    type SchemaDef,
+} from '@zenstackhq/runtime/schema';
+import { ExpressionVisitor } from '@zenstackhq/sdk';
 import {
     AliasNode,
     BinaryOperationNode,
@@ -33,22 +52,6 @@ import {
     type RootOperationNode,
 } from 'kysely';
 import { match } from 'ts-pattern';
-import type { ClientContract } from '../../client';
-import { QueryUtils } from '../../client';
-import { type CRUD_EXT } from '../../client/contract';
-import { getCrudDialect } from '../../client/crud/dialects';
-import type { BaseCrudDialect } from '../../client/crud/dialects/base-dialect';
-import { InternalError, QueryError, RejectedByPolicyError, RejectedByPolicyReason } from '../../client/errors';
-import type { ProceedKyselyQueryFunction } from '../../client/plugin';
-import {
-    ExpressionUtils,
-    type BuiltinType,
-    type Expression,
-    type GetModels,
-    type MemberExpression,
-    type SchemaDef,
-} from '../../schema';
-import { ExpressionVisitor } from '../../utils/expression-utils';
 import { ColumnCollector } from './column-collector';
 import { ExpressionTransformer } from './expression-transformer';
 import type { Policy, PolicyOperation } from './types';
diff --git a/packages/plugins/policy/src/types.ts b/packages/plugins/policy/src/types.ts
@@ -1,5 +1,5 @@
-import type { CRUD_EXT } from '../../client/contract';
-import type { Expression } from '../../schema';
+import type { CRUD_EXT } from '@zenstackhq/runtime';
+import type { Expression } from '@zenstackhq/runtime/schema';
 
 /**
  * Access policy kind.
diff --git a/packages/plugins/policy/src/utils.ts b/packages/plugins/policy/src/utils.ts
@@ -1,3 +1,5 @@
+import type { BaseCrudDialect } from '@zenstackhq/runtime';
+import { ExpressionUtils, type Expression, type SchemaDef } from '@zenstackhq/runtime/schema';
 import type { OperationNode } from 'kysely';
 import {
     AliasNode,
@@ -12,8 +14,6 @@ import {
     UnaryOperationNode,
     ValueNode,
 } from 'kysely';
-import type { BaseCrudDialect } from '../../client/crud/dialects/base-dialect';
-import { ExpressionUtils, type Expression, type SchemaDef } from '../../schema';
 
 /**
  * Creates a `true` value node.
diff --git a/packages/plugins/policy/tsconfig.json b/packages/plugins/policy/tsconfig.json
@@ -0,0 +1,4 @@
+{
+    "extends": "@zenstackhq/typescript-config/base.json",
+    "include": ["src/**/*"]
+}
diff --git a/packages/plugins/policy/tsup.config.ts b/packages/plugins/policy/tsup.config.ts
@@ -0,0 +1,12 @@
+import { defineConfig } from 'tsup';
+
+export default defineConfig({
+    entry: {
+        index: 'src/index.ts',
+    },
+    outDir: 'dist',
+    splitting: false,
+    sourcemap: true,
+    dts: true,
+    format: ['cjs', 'esm'],
+});
diff --git a/packages/plugins/policy/vitest.config.ts b/packages/plugins/policy/vitest.config.ts
@@ -0,0 +1,4 @@
+import base from '@zenstackhq/vitest-config/base';
+import { defineConfig, mergeConfig } from 'vitest/config';
+
+export default mergeConfig(base, defineConfig({}));
diff --git a/packages/runtime/src/client/index.ts b/packages/runtime/src/client/index.ts
@@ -1,11 +1,11 @@
-export { sql } from 'kysely';
 export { ZenStackClient } from './client-impl';
-export { CRUD, type ClientConstructor, type ClientContract } from './contract';
+export * from './contract';
 export type * from './crud-types';
 export { getCrudDialect } from './crud/dialects';
+export { BaseCrudDialect } from './crud/dialects/base-dialect';
 export * from './errors';
-export type { ClientOptions } from './options';
-export { definePlugin } from './plugin';
+export * from './options';
+export * from './plugin';
 export type { ZenStackPromise } from './promise';
 export type { ToKysely } from './query-builder';
 export * as QueryUtils from './query-utils';
diff --git a/packages/runtime/src/schema/index.ts b/packages/runtime/src/schema/index.ts
@@ -1,3 +1,4 @@
 export type * from '@zenstackhq/sdk/schema';
 export type { OperandExpression } from 'kysely';
+export * from './auth';
 export * from './expression';
diff --git a/packages/runtime/tsup.config.ts b/packages/runtime/tsup.config.ts
@@ -1,42 +1,15 @@
 import { defineConfig } from 'tsup';
 
-export default defineConfig([
-    {
-        entry: {
-            index: 'src/index.ts',
-            schema: 'src/schema/index.ts',
-            helpers: 'src/helpers.ts',
-        },
-        outDir: 'dist',
-        splitting: false,
-        sourcemap: true,
-        clean: true,
-        dts: true,
-        format: ['cjs', 'esm'],
+export default defineConfig({
+    entry: {
+        index: 'src/index.ts',
+        schema: 'src/schema/index.ts',
+        helpers: 'src/helpers.ts',
     },
-    {
-        // TODO: this approach externalizes JS imports but still duplicates type declarations
-        entry: {
-            'plugins/policy/index': 'src/plugins/policy/index.ts',
-        },
-        outDir: 'dist',
-        splitting: false,
-        sourcemap: true,
-        esbuildPlugins: [
-            {
-                name: 'external-relative',
-                setup(build) {
-                    // "../../client/*" is resolved to "../../" after bundling
-                    build.onResolve({ filter: /^\.\.\/\.\.\/client.*/ }, () => ({ path: '../../', external: true }));
-                    // "../../schema/*" is resolved to "../../schema" after bundling
-                    build.onResolve({ filter: /^\.\.\/\.\.\/schema.*/ }, () => ({
-                        path: '../../schema',
-                        external: true,
-                    }));
-                },
-            },
-        ],
-        dts: true,
-        format: ['cjs', 'esm'],
-    },
-]);
+    outDir: 'dist',
+    splitting: false,
+    sourcemap: true,
+    clean: true,
+    dts: true,
+    format: ['cjs', 'esm'],
+});
diff --git a/packages/runtime/vitest.config.ts b/packages/runtime/vitest.config.ts
@@ -1,12 +1,4 @@
 import base from '@zenstackhq/vitest-config/base';
-import path from 'node:path';
 import { defineConfig, mergeConfig } from 'vitest/config';
 
-export default mergeConfig(
-    base,
-    defineConfig({
-        test: {
-            setupFiles: [path.resolve(__dirname, './test/vitest-ext.ts')],
-        },
-    }),
-);
+export default mergeConfig(base, defineConfig({}));
diff --git a/packages/sdk/src/default-operation-node-visitor.ts b/packages/sdk/src/default-operation-node-visitor.ts
diff --git a/packages/sdk/src/expression-utils.ts b/packages/sdk/src/expression-utils.ts
@@ -10,7 +10,7 @@ import type {
     NullExpression,
     ThisExpression,
     UnaryExpression,
-} from '../schema';
+} from './schema';
 
 export class ExpressionVisitor {
     visit(expr: Expression): void {
diff --git a/packages/sdk/src/index.ts b/packages/sdk/src/index.ts
@@ -1,5 +1,7 @@
 import * as ModelUtils from './model-utils';
 export * from './cli-plugin';
+export * from './expression-utils';
+export * from './default-operation-node-visitor';
 export { PrismaSchemaGenerator } from './prisma/prisma-schema-generator';
 export * from './ts-schema-generator';
 export * from './zmodel-code-generator';
diff --git a/packages/testtools/package.json b/packages/testtools/package.json
@@ -35,6 +35,7 @@
         "@zenstackhq/language": "workspace:*",
         "@zenstackhq/runtime": "workspace:*",
         "@zenstackhq/sdk": "workspace:*",
+        "@zenstackhq/plugin-policy": "workspace:*",
         "glob": "^11.0.2",
         "kysely": "catalog:",
         "prisma": "catalog:",
diff --git a/packages/testtools/src/client.ts b/packages/testtools/src/client.ts
@@ -1,8 +1,8 @@
 import { invariant } from '@zenstackhq/common-helpers';
 import { loadDocument } from '@zenstackhq/language';
 import type { Model } from '@zenstackhq/language/ast';
+import { PolicyPlugin } from '@zenstackhq/plugin-policy';
 import { ZenStackClient, type ClientContract, type ClientOptions } from '@zenstackhq/runtime';
-import { PolicyPlugin } from '@zenstackhq/runtime/plugins/policy';
 import type { SchemaDef } from '@zenstackhq/runtime/schema';
 import { PrismaSchemaGenerator } from '@zenstackhq/sdk';
 import SQLite from 'better-sqlite3';
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/tests/e2e/orm/policy/basic-schema-read.test.ts b/tests/e2e/orm/policy/basic-schema-read.test.ts
diff --git a/tests/e2e/orm/policy/utils.ts b/tests/e2e/orm/policy/utils.ts
diff --git a/tests/e2e/package.json b/tests/e2e/package.json
