feat(server): migrate rest api handler (#337)

* feat(server): migrate rest api handler

* addressing PR comments

* update lock file

* fix pg string json handling

* update

Author: ymc9

BREAKINGCHANGES.md

@@ -1,3 +1,4 @@
 1. `update` and `delete` policy rejection throws `NotFoundError`
 1. `check()` ORM api has been removed
 1. non-optional to-one relation doesn't automatically filter parent read when evaluating access policies
+1. `@omit` and `@password` attributes have been removed

packages/orm/src/utils/clone.ts renamed to packages/common-helpers/src/clone.ts

@@ -1,4 +1,4 @@
-import { isPlainObject } from '@zenstackhq/common-helpers';
+import { isPlainObject } from './is-plain-object';
 
 /**
  * Clones the given object. Only arrays and plain objects are cloned. Other values are returned as is.

packages/orm/src/utils/enumerate.ts renamed to packages/common-helpers/src/enumerable.ts

@@ -1,3 +1,5 @@
+export * from './clone';
+export * from './enumerable';
 export * from './is-plain-object';
 export * from './lower-case-first';
 export * from './param-case';

packages/common-helpers/src/index.ts

@@ -1,9 +1,8 @@
-import { invariant, isPlainObject } from '@zenstackhq/common-helpers';
+import { enumerate, invariant, isPlainObject } from '@zenstackhq/common-helpers';
 import type { Expression, ExpressionBuilder, ExpressionWrapper, SqlBool, ValueNode } from 'kysely';
 import { expressionBuilder, sql, type SelectQueryBuilder } from 'kysely';
 import { match, P } from 'ts-pattern';
 import type { BuiltinType, DataSourceProviderType, FieldDef, GetModels, ModelDef, SchemaDef } from '../../../schema';
-import { enumerate } from '../../../utils/enumerate';
 import type { OrArray } from '../../../utils/type-utils';
 import { AGGREGATE_OPERATORS, DELEGATE_JOINED_FIELD_PREFIX, LOGICAL_COMBINATORS } from '../../constants';
 import type {
@@ -755,7 +754,7 @@ export abstract class BaseCrudDialect<Schema extends SchemaDef> {
                 : this.fieldRef(model, field, modelAlias);
         };
 
-        enumerate(orderBy).forEach((orderBy) => {
+        enumerate(orderBy).forEach((orderBy, index) => {
             for (const [field, value] of Object.entries<any>(orderBy)) {
                 if (!value) {
                     continue;
@@ -841,15 +840,16 @@ export abstract class BaseCrudDialect<Schema extends SchemaDef> {
                         }
                     } else {
                         // order by to-one relation
-                        result = result.leftJoin(relationModel, (join) => {
-                            const joinPairs = buildJoinPairs(this.schema, model, modelAlias, field, relationModel);
+                        const joinAlias = `${modelAlias}$orderBy$${index}`;
+                        result = result.leftJoin(`${relationModel} as ${joinAlias}`, (join) => {
+                            const joinPairs = buildJoinPairs(this.schema, model, modelAlias, field, joinAlias);
                             return join.on((eb) =>
                                 this.and(
                                     ...joinPairs.map(([left, right]) => eb(this.eb.ref(left), '=', this.eb.ref(right))),
                                 ),
                             );
                         });
-                        result = this.buildOrderBy(result, fieldDef.type, relationModel, value, negated);
+                        result = this.buildOrderBy(result, relationModel, joinAlias, value, negated);
                     }
                 }
             }

packages/orm/src/client/crud/dialects/base-dialect.ts

@@ -58,6 +58,14 @@ export class PostgresCrudDialect<Schema extends SchemaDef> extends BaseCrudDiale
                           : value,
                 )
                 .with('Decimal', () => (value !== null ? value.toString() : value))
+                .with('Json', () => {
+                    if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
+                        // postgres requires simple JSON values to be stringified
+                        return JSON.stringify(value);
+                    } else {
+                        return value;
+                    }
+                })
                 .otherwise(() => value);
         }
     }

packages/orm/src/client/crud/dialects/postgresql.ts

@@ -1,5 +1,5 @@
 import { createId } from '@paralleldrive/cuid2';
-import { invariant, isPlainObject } from '@zenstackhq/common-helpers';
+import { clone, enumerate, invariant, isPlainObject } from '@zenstackhq/common-helpers';
 import {
     DeleteResult,
     expressionBuilder,
@@ -17,8 +17,6 @@ import * as uuid from 'uuid';
 import type { ClientContract } from '../..';
 import type { BuiltinType, Expression, FieldDef } from '../../../schema';
 import { ExpressionUtils, type GetModels, type ModelDef, type SchemaDef } from '../../../schema';
-import { clone } from '../../../utils/clone';
-import { enumerate } from '../../../utils/enumerate';
 import { extractFields, fieldsToSelectObject } from '../../../utils/object-utils';
 import { NUMERIC_FIELD_TYPES } from '../../constants';
 import { TransactionIsolationLevel, type CRUD } from '../../contract';

packages/orm/src/client/crud/operations/base.ts

@@ -1,4 +1,4 @@
-import { invariant } from '@zenstackhq/common-helpers';
+import { enumerate, invariant } from '@zenstackhq/common-helpers';
 import Decimal from 'decimal.js';
 import stableStringify from 'json-stable-stringify';
 import { match, P } from 'ts-pattern';
@@ -12,7 +12,6 @@ import {
     type ModelDef,
     type SchemaDef,
 } from '../../../schema';
-import { enumerate } from '../../../utils/enumerate';
 import { extractFields } from '../../../utils/object-utils';
 import { formatError } from '../../../utils/zod-utils';
 import { AGGREGATE_OPERATORS, LOGICAL_COMBINATORS, NUMERIC_FIELD_TYPES } from '../../constants';

packages/orm/src/client/crud/validator/index.ts

@@ -55,7 +55,10 @@
         "@zenstackhq/orm": "workspace:*",
         "decimal.js": "catalog:",
         "superjson": "^2.2.3",
-        "ts-pattern": "catalog:"
+        "ts-japi": "^1.12.0",
+        "ts-pattern": "catalog:",
+        "url-pattern": "^1.0.3",
+        "zod-validation-error": "catalog:"
     },
     "devDependencies": {
         "@types/body-parser": "^1.19.6",
@@ -66,13 +69,15 @@
         "@zenstackhq/typescript-config": "workspace:*",
         "@zenstackhq/vitest-config": "workspace:*",
         "body-parser": "^2.2.0",
-        "supertest": "^7.1.4",
         "express": "^5.0.0",
-        "next": "^15.0.0"
+        "next": "^15.0.0",
+        "supertest": "^7.1.4",
+        "zod": "~3.25.0"
     },
     "peerDependencies": {
         "express": "^5.0.0",
-        "next": "^15.0.0"
+        "next": "^15.0.0",
+        "zod": "catalog:"
     },
     "peerDependenciesMeta": {
         "express": {

packages/server/package.json

@@ -1 +1,2 @@
-export { RPCApiHandler } from './rpc';
+export { RestApiHandler, type RestApiHandlerOptions } from './rest';
+export { RPCApiHandler, type RPCApiHandlerOptions } from './rpc';