drizzle-typebox 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.cts +45 -0
  2. package/index.d.mts +45 -0
  3. package/package.json +13 -5
package/index.d.cts ADDED
@@ -0,0 +1,45 @@
1
+ import type { TAny, TArray, TBigInt, TBoolean, TDate, TLiteral, TNull, TNumber, TObject, TOptional, TSchema, TString, TUnion } from '@sinclair/typebox';
2
+ import { type Assume, type DrizzleTypeError, type Equal, type Simplify, type Table, type Column } from 'drizzle-orm';
3
+ type TUnionLiterals<T extends string[]> = T extends readonly [
4
+ infer U extends string,
5
+ ...infer Rest extends string[]
6
+ ] ? [TLiteral<U>, ...TUnionLiterals<Rest>] : [];
7
+ type Json = typeof jsonSchema;
8
+ export declare const jsonSchema: TUnion<[TUnion<[TString, TNumber, TBoolean, TNull]>, TArray<TAny>, import("@sinclair/typebox").TRecord<TString, TAny>]>;
9
+ type TNullable<TType extends TSchema> = TUnion<[TType, TNull]>;
10
+ type MapInsertColumnToTypebox<TColumn extends Column, TType extends TSchema> = TColumn['_']['notNull'] extends false ? TOptional<TNullable<TType>> : TColumn['_']['hasDefault'] extends true ? TOptional<TType> : TType;
11
+ type MapSelectColumnToTypebox<TColumn extends Column, TType extends TSchema> = TColumn['_']['notNull'] extends false ? TNullable<TType> : TType;
12
+ type MapColumnToTypebox<TColumn extends Column, TType extends TSchema, TMode extends 'insert' | 'select'> = TMode extends 'insert' ? MapInsertColumnToTypebox<TColumn, TType> : MapSelectColumnToTypebox<TColumn, TType>;
13
+ type MaybeOptional<TColumn extends Column, TType extends TSchema, TMode extends 'insert' | 'select', TNoOptional extends boolean> = TNoOptional extends true ? TType : MapColumnToTypebox<TColumn, TType, TMode>;
14
+ type GetTypeboxType<TColumn extends Column> = TColumn['_']['dataType'] extends infer TDataType ? TDataType extends 'custom' ? TAny : TDataType extends 'json' ? Json : TColumn extends {
15
+ enumValues: [string, ...string[]];
16
+ } ? Equal<TColumn['enumValues'], [string, ...string[]]> extends true ? TString : TUnion<TUnionLiterals<TColumn['enumValues']>> : TDataType extends 'array' ? TArray<GetTypeboxType<Assume<TColumn['_'], {
17
+ baseColumn: Column;
18
+ }>['baseColumn']>> : TDataType extends 'bigint' ? TBigInt : TDataType extends 'number' ? TNumber : TDataType extends 'string' ? TString : TDataType extends 'boolean' ? TBoolean : TDataType extends 'date' ? TDate : TAny : never;
19
+ type ValueOrUpdater<T, TUpdaterArg> = T | ((arg: TUpdaterArg) => T);
20
+ type UnwrapValueOrUpdater<T> = T extends ValueOrUpdater<infer U, any> ? U : never;
21
+ export type Refine<TTable extends Table, TMode extends 'select' | 'insert'> = {
22
+ [K in keyof TTable['_']['columns']]?: ValueOrUpdater<TSchema, TMode extends 'select' ? BuildSelectSchema<TTable, {}, true> : BuildInsertSchema<TTable, {}, true>>;
23
+ };
24
+ export type BuildInsertSchema<TTable extends Table, TRefine extends Refine<TTable, 'insert'> | {}, TNoOptional extends boolean = false> = TTable['_']['columns'] extends infer TColumns extends Record<string, Column<any>> ? {
25
+ [K in keyof TColumns & string]: MaybeOptional<TColumns[K], K extends keyof TRefine ? Assume<UnwrapValueOrUpdater<TRefine[K]>, TSchema> : GetTypeboxType<TColumns[K]>, 'insert', TNoOptional>;
26
+ } : never;
27
+ export type BuildSelectSchema<TTable extends Table, TRefine extends Refine<TTable, 'select'>, TNoOptional extends boolean = false> = Simplify<{
28
+ [K in keyof TTable['_']['columns']]: MaybeOptional<TTable['_']['columns'][K], K extends keyof TRefine ? Assume<UnwrapValueOrUpdater<TRefine[K]>, TSchema> : GetTypeboxType<TTable['_']['columns'][K]>, 'select', TNoOptional>;
29
+ }>;
30
+ export declare const Nullable: <T extends TSchema>(schema: T) => TUnion<[T, TNull]>;
31
+ export declare function createInsertSchema<TTable extends Table, TRefine extends Refine<TTable, 'insert'> = Refine<TTable, 'insert'>>(table: TTable,
32
+ /**
33
+ * @param refine Refine schema fields
34
+ */
35
+ refine?: {
36
+ [K in keyof TRefine]: K extends keyof TTable['_']['columns'] ? TRefine[K] : DrizzleTypeError<`Column '${K & string}' does not exist in table '${TTable['_']['name']}'`>;
37
+ }): TObject<BuildInsertSchema<TTable, Equal<TRefine, Refine<TTable, 'insert'>> extends true ? {} : TRefine>>;
38
+ export declare function createSelectSchema<TTable extends Table, TRefine extends Refine<TTable, 'select'> = Refine<TTable, 'select'>>(table: TTable,
39
+ /**
40
+ * @param refine Refine schema fields
41
+ */
42
+ refine?: {
43
+ [K in keyof TRefine]: K extends keyof TTable['_']['columns'] ? TRefine[K] : DrizzleTypeError<`Column '${K & string}' does not exist in table '${TTable['_']['name']}'`>;
44
+ }): TObject<BuildSelectSchema<TTable, Equal<TRefine, Refine<TTable, 'select'>> extends true ? {} : TRefine>>;
45
+ export {};
package/index.d.mts ADDED
@@ -0,0 +1,45 @@
1
+ import type { TAny, TArray, TBigInt, TBoolean, TDate, TLiteral, TNull, TNumber, TObject, TOptional, TSchema, TString, TUnion } from '@sinclair/typebox';
2
+ import { type Assume, type DrizzleTypeError, type Equal, type Simplify, type Table, type Column } from 'drizzle-orm';
3
+ type TUnionLiterals<T extends string[]> = T extends readonly [
4
+ infer U extends string,
5
+ ...infer Rest extends string[]
6
+ ] ? [TLiteral<U>, ...TUnionLiterals<Rest>] : [];
7
+ type Json = typeof jsonSchema;
8
+ export declare const jsonSchema: TUnion<[TUnion<[TString, TNumber, TBoolean, TNull]>, TArray<TAny>, import("@sinclair/typebox").TRecord<TString, TAny>]>;
9
+ type TNullable<TType extends TSchema> = TUnion<[TType, TNull]>;
10
+ type MapInsertColumnToTypebox<TColumn extends Column, TType extends TSchema> = TColumn['_']['notNull'] extends false ? TOptional<TNullable<TType>> : TColumn['_']['hasDefault'] extends true ? TOptional<TType> : TType;
11
+ type MapSelectColumnToTypebox<TColumn extends Column, TType extends TSchema> = TColumn['_']['notNull'] extends false ? TNullable<TType> : TType;
12
+ type MapColumnToTypebox<TColumn extends Column, TType extends TSchema, TMode extends 'insert' | 'select'> = TMode extends 'insert' ? MapInsertColumnToTypebox<TColumn, TType> : MapSelectColumnToTypebox<TColumn, TType>;
13
+ type MaybeOptional<TColumn extends Column, TType extends TSchema, TMode extends 'insert' | 'select', TNoOptional extends boolean> = TNoOptional extends true ? TType : MapColumnToTypebox<TColumn, TType, TMode>;
14
+ type GetTypeboxType<TColumn extends Column> = TColumn['_']['dataType'] extends infer TDataType ? TDataType extends 'custom' ? TAny : TDataType extends 'json' ? Json : TColumn extends {
15
+ enumValues: [string, ...string[]];
16
+ } ? Equal<TColumn['enumValues'], [string, ...string[]]> extends true ? TString : TUnion<TUnionLiterals<TColumn['enumValues']>> : TDataType extends 'array' ? TArray<GetTypeboxType<Assume<TColumn['_'], {
17
+ baseColumn: Column;
18
+ }>['baseColumn']>> : TDataType extends 'bigint' ? TBigInt : TDataType extends 'number' ? TNumber : TDataType extends 'string' ? TString : TDataType extends 'boolean' ? TBoolean : TDataType extends 'date' ? TDate : TAny : never;
19
+ type ValueOrUpdater<T, TUpdaterArg> = T | ((arg: TUpdaterArg) => T);
20
+ type UnwrapValueOrUpdater<T> = T extends ValueOrUpdater<infer U, any> ? U : never;
21
+ export type Refine<TTable extends Table, TMode extends 'select' | 'insert'> = {
22
+ [K in keyof TTable['_']['columns']]?: ValueOrUpdater<TSchema, TMode extends 'select' ? BuildSelectSchema<TTable, {}, true> : BuildInsertSchema<TTable, {}, true>>;
23
+ };
24
+ export type BuildInsertSchema<TTable extends Table, TRefine extends Refine<TTable, 'insert'> | {}, TNoOptional extends boolean = false> = TTable['_']['columns'] extends infer TColumns extends Record<string, Column<any>> ? {
25
+ [K in keyof TColumns & string]: MaybeOptional<TColumns[K], K extends keyof TRefine ? Assume<UnwrapValueOrUpdater<TRefine[K]>, TSchema> : GetTypeboxType<TColumns[K]>, 'insert', TNoOptional>;
26
+ } : never;
27
+ export type BuildSelectSchema<TTable extends Table, TRefine extends Refine<TTable, 'select'>, TNoOptional extends boolean = false> = Simplify<{
28
+ [K in keyof TTable['_']['columns']]: MaybeOptional<TTable['_']['columns'][K], K extends keyof TRefine ? Assume<UnwrapValueOrUpdater<TRefine[K]>, TSchema> : GetTypeboxType<TTable['_']['columns'][K]>, 'select', TNoOptional>;
29
+ }>;
30
+ export declare const Nullable: <T extends TSchema>(schema: T) => TUnion<[T, TNull]>;
31
+ export declare function createInsertSchema<TTable extends Table, TRefine extends Refine<TTable, 'insert'> = Refine<TTable, 'insert'>>(table: TTable,
32
+ /**
33
+ * @param refine Refine schema fields
34
+ */
35
+ refine?: {
36
+ [K in keyof TRefine]: K extends keyof TTable['_']['columns'] ? TRefine[K] : DrizzleTypeError<`Column '${K & string}' does not exist in table '${TTable['_']['name']}'`>;
37
+ }): TObject<BuildInsertSchema<TTable, Equal<TRefine, Refine<TTable, 'insert'>> extends true ? {} : TRefine>>;
38
+ export declare function createSelectSchema<TTable extends Table, TRefine extends Refine<TTable, 'select'> = Refine<TTable, 'select'>>(table: TTable,
39
+ /**
40
+ * @param refine Refine schema fields
41
+ */
42
+ refine?: {
43
+ [K in keyof TRefine]: K extends keyof TTable['_']['columns'] ? TRefine[K] : DrizzleTypeError<`Column '${K & string}' does not exist in table '${TTable['_']['name']}'`>;
44
+ }): TObject<BuildSelectSchema<TTable, Equal<TRefine, Refine<TTable, 'select'>> extends true ? {} : TRefine>>;
45
+ export {};
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "drizzle-typebox",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Generate Typebox schemas from Drizzle ORM schemas",
5
5
  "type": "module",
6
6
  "scripts": {
7
- "build": "rimraf dist && rollup --config rollup.config.ts --configPlugin typescript && resolve-tspaths && cp README.md package.json dist/",
7
+ "build": "tsx scripts/build.ts",
8
8
  "b": "pnpm build",
9
9
  "test:types": "cd tests && tsc",
10
10
  "pack": "(cd dist && npm pack --pack-destination ..) && rm -f package.tgz && mv *.tgz package.tgz",
@@ -13,9 +13,15 @@
13
13
  },
14
14
  "exports": {
15
15
  ".": {
16
+ "import": {
17
+ "types": "./index.d.mts",
18
+ "default": "./index.mjs"
19
+ },
20
+ "require": {
21
+ "types": "./index.d.cjs",
22
+ "default": "./index.cjs"
23
+ },
16
24
  "types": "./index.d.ts",
17
- "import": "./index.mjs",
18
- "require": "./index.cjs",
19
25
  "default": "./index.mjs"
20
26
  }
21
27
  },
@@ -70,9 +76,11 @@
70
76
  "@sinclair/typebox": "^0.29.6",
71
77
  "@types/node": "^18.15.10",
72
78
  "ava": "^5.1.0",
79
+ "cpy": "^10.1.0",
73
80
  "drizzle-orm": "link:../drizzle-orm/dist",
74
81
  "rimraf": "^5.0.0",
75
82
  "rollup": "^3.20.7",
76
- "tsx": "^3.12.2"
83
+ "tsx": "^3.12.2",
84
+ "zx": "^7.2.2"
77
85
  }
78
86
  }