chore(orm): export JSON types (#476)

Author: ymc9

packages/orm/src/client/crud-types.ts

@@ -1,4 +1,5 @@
 import type { ExpressionBuilder, OperandExpression, SqlBool } from 'kysely';
+import type { DbNull, JsonNull, JsonNullValues, JsonValue } from '../common-types';
 import type {
     BuiltinType,
     FieldDef,
@@ -32,8 +33,6 @@ import type {
 } from '../schema';
 import type {
     AtLeast,
-    JsonNullValues,
-    JsonValue,
     MapBaseType,
     NonEmptyArray,
     NullableIf,
@@ -45,7 +44,6 @@ import type {
     WrapType,
     XOR,
 } from '../utils/type-utils';
-import type { DbNull, JsonNull } from './null-values';
 import type { ClientOptions } from './options';
 import type { ToKyselySchema } from './query-builder';
 

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

@@ -2,6 +2,7 @@ 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 { AnyNullClass, DbNullClass, JsonNullClass } from '../../../common-types';
 import type { BuiltinType, DataSourceProviderType, FieldDef, GetModels, ModelDef, SchemaDef } from '../../../schema';
 import type { OrArray } from '../../../utils/type-utils';
 import { AGGREGATE_OPERATORS, DELEGATE_JOINED_FIELD_PREFIX, LOGICAL_COMBINATORS } from '../../constants';
@@ -15,7 +16,6 @@ import type {
     StringFilter,
 } from '../../crud-types';
 import { createConfigError, createInvalidInputError, createNotSupportedError } from '../../errors';
-import { AnyNullClass, DbNullClass, JsonNullClass } from '../../null-values';
 import type { ClientOptions } from '../../options';
 import {
     aggregate,

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

@@ -11,11 +11,11 @@ import {
 } from 'kysely';
 import { match } from 'ts-pattern';
 import z from 'zod';
+import { AnyNullClass, DbNullClass, JsonNullClass } from '../../../common-types';
 import type { BuiltinType, FieldDef, GetModels, SchemaDef } from '../../../schema';
 import { DELEGATE_JOINED_FIELD_PREFIX } from '../../constants';
 import type { FindArgs } from '../../crud-types';
 import { createInternalError } from '../../errors';
-import { AnyNullClass, DbNullClass, JsonNullClass } from '../../null-values';
 import type { ClientOptions } from '../../options';
 import {
     buildJoinPairs,

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

@@ -10,11 +10,11 @@ import {
     type SqlBool,
 } from 'kysely';
 import { match } from 'ts-pattern';
+import { AnyNullClass, DbNullClass, JsonNullClass } from '../../../common-types';
 import type { BuiltinType, FieldDef, GetModels, SchemaDef } from '../../../schema';
 import { DELEGATE_JOINED_FIELD_PREFIX } from '../../constants';
 import type { FindArgs } from '../../crud-types';
 import { createInternalError } from '../../errors';
-import { AnyNullClass, DbNullClass, JsonNullClass } from '../../null-values';
 import {
     getDelegateDescendantModels,
     getManyToManyRelation,

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

@@ -3,6 +3,7 @@ import Decimal from 'decimal.js';
 import stableStringify from 'json-stable-stringify';
 import { match, P } from 'ts-pattern';
 import { z, ZodType } from 'zod';
+import { AnyNullClass, DbNullClass, JsonNullClass } from '../../../common-types';
 import {
     type AttributeApplication,
     type BuiltinType,
@@ -32,7 +33,6 @@ import {
     type UpsertArgs,
 } from '../../crud-types';
 import { createInternalError, createInvalidInputError } from '../../errors';
-import { AnyNullClass, DbNullClass, JsonNullClass } from '../../null-values';
 import {
     fieldHasDefaultValue,
     getDiscriminatorField,

packages/orm/src/client/index.ts

@@ -4,7 +4,6 @@ export type * from './crud-types';
 export { getCrudDialect } from './crud/dialects';
 export { BaseCrudDialect } from './crud/dialects/base-dialect';
 export { ORMError, ORMErrorReason, RejectedByPolicyReason } from './errors';
-export { AnyNull, DbNull, JsonNull } from './null-values';
 export * from './options';
 export * from './plugin';
 export type { ZenStackPromise } from './promise';

packages/orm/src/client/null-values.ts

@@ -0,0 +1,25 @@
+export type JsonValue = string | number | boolean | JsonObject | JsonArray;
+export type JsonObject = { [key: string]: JsonValue | null };
+export type JsonArray = ReadonlyArray<JsonValue | null>;
+export type JsonNullValues = DbNull | JsonNull | AnyNull;
+
+export class DbNullClass {
+    // @ts-ignore
+    private __brand = 'DbNull' as const;
+}
+export const DbNull = new DbNullClass();
+export type DbNull = typeof DbNull;
+
+export class JsonNullClass {
+    // @ts-ignore
+    private __brand = 'JsonNull' as const;
+}
+export const JsonNull = new JsonNullClass();
+export type JsonNull = typeof JsonNull;
+
+export class AnyNullClass {
+    // @ts-ignore
+    private __brand = 'AnyNull' as const;
+}
+export const AnyNull = new AnyNullClass();
+export type AnyNull = typeof AnyNull;

packages/orm/src/common-types.ts

@@ -1,4 +1,4 @@
 export * from './client';
+export * from './common-types';
 export * as KyselyUtils from './utils/kysely-utils';
 export * as SchemaUtils from './utils/schema-utils';
-export type { JsonArray, JsonObject, JsonValue } from './utils/type-utils';

packages/orm/src/index.ts

@@ -1,5 +1,5 @@
 import type Decimal from 'decimal.js';
-import type { AnyNull, DbNull, JsonNull } from '../client/null-values';
+import type { JsonObject, JsonValue } from '../common-types';
 
 export type Optional<T extends object, K extends keyof T = keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 
@@ -45,13 +45,6 @@ type TypeMap = {
 
 export type MapBaseType<T extends string> = T extends keyof TypeMap ? TypeMap[T] : unknown;
 
-export type JsonValue = string | number | boolean | JsonObject | JsonArray;
-
-export type JsonObject = { [key: string]: JsonValue | null };
-export type JsonArray = ReadonlyArray<JsonValue | null>;
-
-export type JsonNullValues = DbNull | JsonNull | AnyNull;
-
 export function call(code: string) {
     return { code };
 }