zod-typeorm 1.0.0 → 1.1.2
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.
- package/README.md +166 -0
- package/dist/decorators/index.d.ts +1 -1
- package/dist/decorators/index.d.ts.map +1 -1
- package/dist/decorators/zod-property.d.ts +5 -0
- package/dist/decorators/zod-property.d.ts.map +1 -1
- package/dist/decorators/zod-property.js +10 -4
- package/dist/decorators/zod-property.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/schema.d.ts +3 -10
- package/dist/schema.d.ts.map +1 -1
- package/dist/schema.js +27 -23
- package/dist/schema.js.map +1 -1
- package/package.json +1 -1
- package/dist/decorators/zod-schema.d.ts +0 -14
- package/dist/decorators/zod-schema.d.ts.map +0 -1
- package/dist/decorators/zod-schema.js +0 -13
- package/dist/decorators/zod-schema.js.map +0 -1
package/README.md
CHANGED
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
# zod-typeorm
|
|
2
|
+
|
|
3
|
+
[zod-typeorm](https://github.com/SloCompTech/zod-typeorm) aims to be simple helper library to help developers create Zod schemas from TypeORM entites without assumptions about development style.
|
|
4
|
+
|
|
5
|
+
## Brief description
|
|
6
|
+
|
|
7
|
+
- Works with class inheritance (no base class pollution)
|
|
8
|
+
- Currently **no property name conflict resolution**
|
|
9
|
+
- Currently no integration with *@Column* decorator from TypeORM
|
|
10
|
+
- Supports schema variants (no predefined schema)
|
|
11
|
+
|
|
12
|
+
## Quick start
|
|
13
|
+
|
|
14
|
+
Define schema for each property with *@ZodProperty*.
|
|
15
|
+
|
|
16
|
+
- Argument can be schema diretly like `@ZodProperty(z.number().min(0))`
|
|
17
|
+
- Or it can be options with *schema* property `@ZodProperty({ schema: z.number().min(0) })`
|
|
18
|
+
|
|
19
|
+
```ts
|
|
20
|
+
@Entity()
|
|
21
|
+
export class TestEntity {
|
|
22
|
+
@PrimaryGeneratedColumn({ unsigned: true })
|
|
23
|
+
@ZodProperty(z.number().min(0))
|
|
24
|
+
id: number;
|
|
25
|
+
|
|
26
|
+
@Column()
|
|
27
|
+
@ZodProperty(z.string().min(1).max(255))
|
|
28
|
+
name: string;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
// Create schema from entity
|
|
32
|
+
const entitySchema = createZodSchemaFromEntity(TestEntity);
|
|
33
|
+
// included schema properties: id, name
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Installation
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
npm install zod-typeorm
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Inheritance support
|
|
43
|
+
|
|
44
|
+
Library supports object inheritance with limition that property names should **not be duplicated** between classes.
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
export class EntityBase {
|
|
48
|
+
@Column()
|
|
49
|
+
@ZodProperty({ schema: z.string().min(1).max(255) })
|
|
50
|
+
baseProperty: string;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
@Entity()
|
|
54
|
+
export class TestEntity extends EntityBase {
|
|
55
|
+
@PrimaryGeneratedColumn({ unsigned: true })
|
|
56
|
+
@ZodProperty({ schema: z.number().min(0) })
|
|
57
|
+
id: number;
|
|
58
|
+
|
|
59
|
+
@Column()
|
|
60
|
+
@ZodProperty({ schema: z.string().min(1).max(255) })
|
|
61
|
+
name: string;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
// Create schema from entity
|
|
65
|
+
const entitySchema = createZodSchemaFromEntity(TestEntity);
|
|
66
|
+
// included schema properties: baseProperty, id, name
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Schema variants
|
|
70
|
+
|
|
71
|
+
To create different schema from the same Entity based on your use case, there is support for schema variants.
|
|
72
|
+
|
|
73
|
+
- Variants can have arbitrary name (except *default* is reserved), variant names don't need to be defined anywhere, just use logic below
|
|
74
|
+
- Using *includeForVariants* in *@ZodProperty* you can select variants for which property should be included
|
|
75
|
+
- Using *optionalForVariants* in *@ZodProperty* you can make property optional for variants
|
|
76
|
+
- Using *skipForVariants* in *@ZodProperty* you can exclude property from variants
|
|
77
|
+
- Using *transformForVariants* in *@ZodProperty* you can transform schema additionaly for variants
|
|
78
|
+
|
|
79
|
+
```ts
|
|
80
|
+
@Entity()
|
|
81
|
+
export class TestEntity {
|
|
82
|
+
@PrimaryGeneratedColumn({ unsigned: true })
|
|
83
|
+
@ZodProperty({ schema: z.number().min(0) })
|
|
84
|
+
id: number;
|
|
85
|
+
|
|
86
|
+
@Column()
|
|
87
|
+
@ZodProperty({ schema: z.string().min(1).max(255) })
|
|
88
|
+
name: string;
|
|
89
|
+
|
|
90
|
+
@Column({ unsigned: true })
|
|
91
|
+
@ZodProperty({ schema: z.number().min(0), includeForVariants: ['variant1'] })
|
|
92
|
+
iProperty: number;
|
|
93
|
+
|
|
94
|
+
@Column({ unsigned: true })
|
|
95
|
+
@ZodProperty({ schema: z.number().min(0), includeForVariants: ['variant2'] })
|
|
96
|
+
sProperty: number;
|
|
97
|
+
|
|
98
|
+
@Column({ unsigned: true })
|
|
99
|
+
@ZodProperty({ schema: z.number().min(0), skipForVariants: ['variant2'], optionalForVariants: ['variant3'] })
|
|
100
|
+
pProperty: number;
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
// Create schemas from entity
|
|
104
|
+
const schemas = createZodSchemasFromEntity(TestEntity, ['variant1', 'variant2', 'variant3']);
|
|
105
|
+
schemas.variant1 // variant1: includes properties id, name, iProperty, pProperty
|
|
106
|
+
schemas.variant2 // variant2: includes properties id, name, sProperty
|
|
107
|
+
schemas.variant3 // variant3: includes properties id, name, pProperty?
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
## Schema generation options
|
|
112
|
+
|
|
113
|
+
While creating schemas additional options can be specified.
|
|
114
|
+
|
|
115
|
+
```ts
|
|
116
|
+
const schemas = createZodSchemasFromEntity(TestEntity, ['variant1', 'variant2', 'variant3'], {
|
|
117
|
+
strict: true, // Make schema strict (see Zod doc)
|
|
118
|
+
optionalFields: [], // Make fields optional for all variants
|
|
119
|
+
skipFields: [], // Skip fields for all variants,
|
|
120
|
+
transformFields: {
|
|
121
|
+
variant1: (schema: z.ZodType) => schema, // Transform certain fields
|
|
122
|
+
},
|
|
123
|
+
transformSchema: (schema: z.ZodObject<z.ZodRawShape>) => schema, // Additionaly transform generated schema
|
|
124
|
+
transformSchemaForVariants: {
|
|
125
|
+
variant1: (schema: z.ZodObject<z.ZodRawShape>) => schema, // Transform schema for variant
|
|
126
|
+
},
|
|
127
|
+
});
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
## Type Inference
|
|
131
|
+
|
|
132
|
+
```ts
|
|
133
|
+
type Variant1 = z.infer<typeof schemas.variant1>;
|
|
134
|
+
type Variant2 = z.infer<typeof schemas.variant2>;
|
|
135
|
+
type Variant3 = z.infer<typeof schemas.variant3>;
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
## API reference
|
|
139
|
+
|
|
140
|
+
Decorators:
|
|
141
|
+
|
|
142
|
+
- `@ZodProperty(schema)`
|
|
143
|
+
- `@ZodProperty({ schema, includeForVariants?, optionalForVariants?, skipForVariants?, transformForVariants? })`
|
|
144
|
+
|
|
145
|
+
Schema creation:
|
|
146
|
+
|
|
147
|
+
- `createZodSchemaFromEntity(entityClass, variantName, options)`
|
|
148
|
+
- `createZodSchemasFromEntity(entityClass, [variantNames], options)`
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
## Requirements
|
|
152
|
+
|
|
153
|
+
- TypeORM >= 1.1.1
|
|
154
|
+
- Zod >= 4.0.0
|
|
155
|
+
- TypeScript
|
|
156
|
+
- *reflect-metadata* package
|
|
157
|
+
|
|
158
|
+
## Contribution
|
|
159
|
+
|
|
160
|
+
Contributions are welcome, before commiting changes please run:
|
|
161
|
+
|
|
162
|
+
```bash
|
|
163
|
+
npm run typecheck
|
|
164
|
+
npm run test
|
|
165
|
+
npm run check-format
|
|
166
|
+
```
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export { ZOD_SCHEMA_PROPERTY, ZodProperty, type
|
|
1
|
+
export { ZOD_SCHEMA_PROPERTY, ZodProperty, type ZodPropertyMetadata, type ZodPropertyOptions, } from './zod-property.js';
|
|
2
2
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/decorators/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,WAAW,EACX,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/decorators/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,WAAW,EACX,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,GACxB,MAAM,mBAAmB,CAAC"}
|
|
@@ -15,6 +15,10 @@ export interface ZodPropertyOptions {
|
|
|
15
15
|
* Include property only when generating schema for specified variants (whitelist)
|
|
16
16
|
*/
|
|
17
17
|
includeForVariants?: string[];
|
|
18
|
+
/**
|
|
19
|
+
* Transform property for certain variants
|
|
20
|
+
*/
|
|
21
|
+
transformForVariants?: Record<string, (schema: z.ZodType) => z.ZodType>;
|
|
18
22
|
}
|
|
19
23
|
export interface ZodPropertyMetadata {
|
|
20
24
|
propertyKey: string | symbol;
|
|
@@ -22,6 +26,7 @@ export interface ZodPropertyMetadata {
|
|
|
22
26
|
optionalForVariants: string[];
|
|
23
27
|
skipForVariants: string[];
|
|
24
28
|
includeForVariants: string[];
|
|
29
|
+
transformForVariants: Record<string, (schema: z.ZodType) => z.ZodType>;
|
|
25
30
|
}
|
|
26
31
|
export declare function ZodProperty(options: ZodPropertyOptions | z.ZodType | (() => z.ZodType)): PropertyDecorator;
|
|
27
32
|
//# sourceMappingURL=zod-property.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"zod-property.d.ts","sourceRoot":"","sources":["../../src/decorators/zod-property.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,mBAAmB,eAAgC,CAAC;AAGjE,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,CAAC,CAAC,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC;IAEtC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAE3B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"zod-property.d.ts","sourceRoot":"","sources":["../../src/decorators/zod-property.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,mBAAmB,eAAgC,CAAC;AAGjE,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,CAAC,CAAC,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC;IAEtC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAE3B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE9B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC;CACzE;AAGD,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7B,MAAM,EAAE,CAAC,CAAC,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC;IACtC,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC;CACxE;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,CAAC,CAAC,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,iBAAiB,CA+C1G"}
|
|
@@ -10,28 +10,34 @@ export function ZodProperty(options) {
|
|
|
10
10
|
existingMetadata = [...(Reflect.getMetadata(ZOD_SCHEMA_PROPERTY, ctor) ?? [])];
|
|
11
11
|
}
|
|
12
12
|
// Prevent duplicate metadata registration
|
|
13
|
-
const index = existingMetadata.findIndex(m => m.propertyKey === propertyKey);
|
|
13
|
+
const index = existingMetadata.findIndex((m) => m.propertyKey === propertyKey);
|
|
14
14
|
// Prepare new record
|
|
15
15
|
const metadata = {
|
|
16
16
|
propertyKey: propertyKey,
|
|
17
|
-
...(
|
|
17
|
+
...(options instanceof z.ZodType || typeof options === 'function'
|
|
18
18
|
? {
|
|
19
|
+
// Only ZodType is provided, on additional properties
|
|
19
20
|
schema: options,
|
|
20
21
|
optionalForVariants: [],
|
|
21
22
|
skipForVariants: [],
|
|
22
23
|
includeForVariants: [],
|
|
24
|
+
transformForVariants: {},
|
|
23
25
|
}
|
|
24
26
|
: {
|
|
27
|
+
// ZodType is provided with additional properties
|
|
25
28
|
schema: options.schema,
|
|
26
29
|
optionalForVariants: options.optionalForVariants ?? [],
|
|
27
30
|
skipForVariants: options.skipForVariants ?? [],
|
|
28
31
|
includeForVariants: options.includeForVariants ?? [],
|
|
32
|
+
transformForVariants: options.transformForVariants ?? {},
|
|
29
33
|
}),
|
|
30
34
|
};
|
|
31
|
-
if (index === -1) {
|
|
35
|
+
if (index === -1) {
|
|
36
|
+
// No existing metadata found => add new record
|
|
32
37
|
existingMetadata.push(metadata);
|
|
33
38
|
}
|
|
34
|
-
else {
|
|
39
|
+
else {
|
|
40
|
+
// Found existing metadata => overwrite
|
|
35
41
|
existingMetadata[index] = metadata;
|
|
36
42
|
}
|
|
37
43
|
// Set updated metadata
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"zod-property.js","sourceRoot":"","sources":["../../src/decorators/zod-property.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,mBAAmB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"zod-property.js","sourceRoot":"","sources":["../../src/decorators/zod-property.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,mBAAmB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAqCjE,MAAM,UAAU,WAAW,CAAC,OAA2D;IACrF,OAAO,CAAC,MAAc,EAAE,WAA4B,EAAE,EAAE;QACtD,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC;QAEhC,IAAI,gBAAgB,GAA0B,OAAO,CAAC,cAAc,CAAC,mBAAmB,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;QAEtG,8DAA8D;QAC9D,IAAI,CAAC,gBAAgB,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrD,gBAAgB,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,mBAAmB,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QACjF,CAAC;QAED,0CAA0C;QAC1C,MAAM,KAAK,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,KAAK,WAAW,CAAC,CAAC;QAE/E,qBAAqB;QACrB,MAAM,QAAQ,GAAwB;YACpC,WAAW,EAAE,WAAW;YACxB,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,UAAU;gBAC/D,CAAC,CAAC;oBACE,qDAAqD;oBACrD,MAAM,EAAE,OAAO;oBACf,mBAAmB,EAAE,EAAE;oBACvB,eAAe,EAAE,EAAE;oBACnB,kBAAkB,EAAE,EAAE;oBACtB,oBAAoB,EAAE,EAAE;iBACzB;gBACH,CAAC,CAAC;oBACE,iDAAiD;oBACjD,MAAM,EAAE,OAAO,CAAC,MAAM;oBACtB,mBAAmB,EAAE,OAAO,CAAC,mBAAmB,IAAI,EAAE;oBACtD,eAAe,EAAE,OAAO,CAAC,eAAe,IAAI,EAAE;oBAC9C,kBAAkB,EAAE,OAAO,CAAC,kBAAkB,IAAI,EAAE;oBACpD,oBAAoB,EAAE,OAAO,CAAC,oBAAoB,IAAI,EAAE;iBACzD,CAAC;SACP,CAAC;QAEF,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,+CAA+C;YAC/C,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClC,CAAC;aAAM,CAAC;YACN,uCAAuC;YACvC,gBAAgB,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC;QACrC,CAAC;QAED,uBAAuB;QACvB,OAAO,CAAC,cAAc,CAAC,mBAAmB,EAAE,gBAAgB,EAAE,IAAI,CAAC,CAAC;IACtE,CAAC,CAAC;AACJ,CAAC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -2,5 +2,5 @@
|
|
|
2
2
|
* zod-typeorm library
|
|
3
3
|
*/
|
|
4
4
|
export * from './decorators/index.js';
|
|
5
|
-
export {
|
|
5
|
+
export { type CreateZodSchemaOptions, createZodSchemaFromEntity, createZodSchemasFromEntity, } from './schema.js';
|
|
6
6
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,uBAAuB,CAAC;AAEtC,OAAO,EACL,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,uBAAuB,CAAC;AAEtC,OAAO,EACL,KAAK,sBAAsB,EAC3B,yBAAyB,EACzB,0BAA0B,GAC3B,MAAM,aAAa,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -2,5 +2,5 @@
|
|
|
2
2
|
* zod-typeorm library
|
|
3
3
|
*/
|
|
4
4
|
export * from './decorators/index.js';
|
|
5
|
-
export {
|
|
5
|
+
export { createZodSchemaFromEntity, createZodSchemasFromEntity, } from './schema.js';
|
|
6
6
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,uBAAuB,CAAC;AAEtC,OAAO,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,uBAAuB,CAAC;AAEtC,OAAO,EAEL,yBAAyB,EACzB,0BAA0B,GAC3B,MAAM,aAAa,CAAC"}
|
package/dist/schema.d.ts
CHANGED
|
@@ -8,11 +8,11 @@ export interface CreateZodSchemaOptions {
|
|
|
8
8
|
/**
|
|
9
9
|
* Make fields optional
|
|
10
10
|
*/
|
|
11
|
-
optionalFields?: (string |
|
|
11
|
+
optionalFields?: (string | symbol)[];
|
|
12
12
|
/**
|
|
13
13
|
* Skip additional fields
|
|
14
14
|
*/
|
|
15
|
-
skipFields?: (string |
|
|
15
|
+
skipFields?: (string | symbol)[];
|
|
16
16
|
/**
|
|
17
17
|
* Add additional field transformation
|
|
18
18
|
*/
|
|
@@ -33,14 +33,7 @@ export interface CreateZodSchemaOptions {
|
|
|
33
33
|
* @param options Options
|
|
34
34
|
* @returns z.ZodObject
|
|
35
35
|
*/
|
|
36
|
-
export declare function
|
|
37
|
-
/**
|
|
38
|
-
* Generate schema from decorated class for 'default' variant
|
|
39
|
-
* @param entityClass Entity class
|
|
40
|
-
* @param options Options
|
|
41
|
-
* @returns z.ZodObject
|
|
42
|
-
*/
|
|
43
|
-
export declare function createZodSchemaFromEntity<T>(entityClass: new () => T, options?: CreateZodSchemaOptions): z.ZodObject<z.ZodRawShape>;
|
|
36
|
+
export declare function createZodSchemaFromEntity<T>(entityClass: new () => T, variantName?: string, options?: CreateZodSchemaOptions): z.ZodObject<z.ZodRawShape>;
|
|
44
37
|
/**
|
|
45
38
|
* Generate schema from decorated class for list of variants
|
|
46
39
|
* @param entityClass Entity class
|
package/dist/schema.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAErC;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAEjC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC;IAE5E;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;IAErF;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;CACjH;AAED;;;;;;GAMG;AACH,wBAAgB,
|
|
1
|
+
{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAErC;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAEjC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC;IAE5E;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;IAErF;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;CACjH;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CAAC,CAAC,EACzC,WAAW,EAAE,UAAU,CAAC,EACxB,WAAW,GAAE,MAAkB,EAC/B,OAAO,GAAE,sBAA2B,GACnC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAiD5B;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,EAC1C,WAAW,EAAE,UAAU,CAAC,EACxB,YAAY,EAAE,MAAM,EAAE,EACtB,OAAO,GAAE,sBAA2B,GACnC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAI5C"}
|
package/dist/schema.js
CHANGED
|
@@ -8,45 +8,49 @@ import { ZOD_SCHEMA_PROPERTY } from './decorators/zod-property.js';
|
|
|
8
8
|
* @param options Options
|
|
9
9
|
* @returns z.ZodObject
|
|
10
10
|
*/
|
|
11
|
-
export function
|
|
11
|
+
export function createZodSchemaFromEntity(entityClass, variantName = 'default', options = {}) {
|
|
12
12
|
// Get metadata for properties
|
|
13
13
|
const propertyMetadata = Reflect.getMetadata(ZOD_SCHEMA_PROPERTY, entityClass) ?? [];
|
|
14
14
|
if (propertyMetadata.length <= 0)
|
|
15
15
|
throw new Error(`No Zod metadata found on Entity ${entityClass.name} (Use @ZodProperty)`);
|
|
16
16
|
// Build set of properties for zod schema
|
|
17
17
|
const shape = {};
|
|
18
|
-
for (const item of propertyMetadata) {
|
|
18
|
+
for (const item of propertyMetadata) {
|
|
19
|
+
if (!item.propertyKey)
|
|
20
|
+
continue;
|
|
21
|
+
// Go over each property decorator metadata
|
|
19
22
|
// Check if field needs to be skipped (schema skip, skip field because of variant) or if not in include list
|
|
20
|
-
if (options.skipFields?.includes(item.propertyKey) ||
|
|
23
|
+
if (options.skipFields?.includes(item.propertyKey) ||
|
|
24
|
+
item.skipForVariants.includes(variantName) ||
|
|
25
|
+
(item.includeForVariants.length > 0 && !item.includeForVariants.includes(variantName)))
|
|
21
26
|
continue;
|
|
22
27
|
const propertyKey = String(item.propertyKey);
|
|
23
|
-
shape[propertyKey] =
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
28
|
+
shape[propertyKey] = typeof item.schema === 'function' ? item.schema() : item.schema;
|
|
29
|
+
if (variantName in item.transformForVariants && item.transformForVariants[variantName])
|
|
30
|
+
shape[propertyKey] = item.transformForVariants[variantName](shape[propertyKey]);
|
|
31
|
+
if (item.propertyKey && options.transformFields && item.propertyKey in options.transformFields) {
|
|
32
|
+
const transformFn = options.transformFields[item.propertyKey];
|
|
33
|
+
if (transformFn)
|
|
34
|
+
// Transform field
|
|
35
|
+
shape[propertyKey] = transformFn(shape[propertyKey]);
|
|
36
|
+
}
|
|
37
|
+
if (options.optionalFields?.includes(item.propertyKey) || item.optionalForVariants.includes(variantName))
|
|
38
|
+
// Make field optional
|
|
30
39
|
shape[propertyKey] = shape[propertyKey].optional();
|
|
31
40
|
}
|
|
32
41
|
let schema = z.object(shape);
|
|
33
|
-
if (options.transformSchemaForVariants &&
|
|
42
|
+
if (options.transformSchemaForVariants &&
|
|
43
|
+
variantName in options.transformSchemaForVariants &&
|
|
44
|
+
options.transformSchemaForVariants[variantName])
|
|
45
|
+
// Per-variant transformation
|
|
34
46
|
schema = options.transformSchemaForVariants[variantName](schema);
|
|
35
|
-
if (options.transformSchema)
|
|
47
|
+
if (options.transformSchema)
|
|
48
|
+
// Single (everytime) transformation
|
|
36
49
|
schema = options.transformSchema(schema);
|
|
37
50
|
if (options.strict)
|
|
38
51
|
schema = schema.strict();
|
|
39
52
|
return schema;
|
|
40
53
|
}
|
|
41
|
-
/**
|
|
42
|
-
* Generate schema from decorated class for 'default' variant
|
|
43
|
-
* @param entityClass Entity class
|
|
44
|
-
* @param options Options
|
|
45
|
-
* @returns z.ZodObject
|
|
46
|
-
*/
|
|
47
|
-
export function createZodSchemaFromEntity(entityClass, options = {}) {
|
|
48
|
-
return createZodSchemaFromEntityForVariant(entityClass, 'default', options);
|
|
49
|
-
}
|
|
50
54
|
/**
|
|
51
55
|
* Generate schema from decorated class for list of variants
|
|
52
56
|
* @param entityClass Entity class
|
|
@@ -56,8 +60,8 @@ export function createZodSchemaFromEntity(entityClass, options = {}) {
|
|
|
56
60
|
*/
|
|
57
61
|
export function createZodSchemasFromEntity(entityClass, variantNames, options = {}) {
|
|
58
62
|
const schemaVariants = {};
|
|
59
|
-
for (
|
|
60
|
-
schemaVariants[name] =
|
|
63
|
+
for (const name of variantNames)
|
|
64
|
+
schemaVariants[name] = createZodSchemaFromEntity(entityClass, name, options);
|
|
61
65
|
return schemaVariants;
|
|
62
66
|
}
|
|
63
67
|
//# sourceMappingURL=schema.js.map
|
package/dist/schema.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,mBAAmB,EAA4B,MAAM,8BAA8B,CAAC;AAkC7F;;;;;;GAMG;AACH,MAAM,UAAU,
|
|
1
|
+
{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,mBAAmB,EAA4B,MAAM,8BAA8B,CAAC;AAkC7F;;;;;;GAMG;AACH,MAAM,UAAU,yBAAyB,CACvC,WAAwB,EACxB,WAAW,GAAW,SAAS,EAC/B,OAAO,GAA2B,EAAE;IAEpC,8BAA8B;IAC9B,MAAM,gBAAgB,GAA0B,OAAO,CAAC,WAAW,CAAC,mBAAmB,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC;IAC5G,IAAI,gBAAgB,CAAC,MAAM,IAAI,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,mCAAmC,WAAW,CAAC,IAAI,qBAAqB,CAAC,CAAC;IAE5F,yCAAyC;IACzC,MAAM,KAAK,GAA8B,EAAE,CAAC;IAE5C,KAAK,MAAM,IAAI,IAAI,gBAAgB,EAAE,CAAC;QACpC,IAAI,CAAC,IAAI,CAAC,WAAW;YAAE,SAAS;QAEhC,2CAA2C;QAC3C,4GAA4G;QAC5G,IACE,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC;YAC9C,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,WAAW,CAAC;YAC1C,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;YAEtF,SAAS;QAEX,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC7C,KAAK,CAAC,WAAW,CAAC,GAAG,OAAO,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QACrF,IAAI,WAAW,IAAI,IAAI,CAAC,oBAAoB,IAAI,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC;YACpF,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;QAClF,IAAI,IAAI,CAAC,WAAW,IAAI,OAAO,CAAC,eAAe,IAAI,IAAI,CAAC,WAAW,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;YAC/F,MAAM,WAAW,GAAG,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC9D,IAAI,WAAW;gBACb,kBAAkB;gBAClB,KAAK,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;QACzD,CAAC;QACD,IAAI,OAAO,CAAC,cAAc,EAAE,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,WAAW,CAAC;YACtG,sBAAsB;YACtB,KAAK,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE,CAAC;IACvD,CAAC;IAED,IAAI,MAAM,GAA+B,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACzD,IACE,OAAO,CAAC,0BAA0B;QAClC,WAAW,IAAI,OAAO,CAAC,0BAA0B;QACjD,OAAO,CAAC,0BAA0B,CAAC,WAAW,CAAC;QAE/C,6BAA6B;QAC7B,MAAM,GAAG,OAAO,CAAC,0BAA0B,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC;IACnE,IAAI,OAAO,CAAC,eAAe;QACzB,oCAAoC;QACpC,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IAC3C,IAAI,OAAO,CAAC,MAAM;QAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;IAC7C,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CACxC,WAAwB,EACxB,YAAsB,EACtB,OAAO,GAA2B,EAAE;IAEpC,MAAM,cAAc,GAA+C,EAAE,CAAC;IACtE,KAAK,MAAM,IAAI,IAAI,YAAY;QAAE,cAAc,CAAC,IAAI,CAAC,GAAG,yBAAyB,CAAC,WAAW,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC9G,OAAO,cAAc,CAAC;AACxB,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import 'reflect-metadata';
|
|
2
|
-
export declare const ZOD_SCHEMA: unique symbol;
|
|
3
|
-
export interface ZodSchemaOptions {
|
|
4
|
-
/**
|
|
5
|
-
* Reject unknown properties
|
|
6
|
-
* @default false
|
|
7
|
-
*/
|
|
8
|
-
strict?: boolean;
|
|
9
|
-
}
|
|
10
|
-
export interface ZodSchemaMetadata {
|
|
11
|
-
strict: boolean;
|
|
12
|
-
}
|
|
13
|
-
export declare function ZodSchema(options?: ZodSchemaOptions): ClassDecorator;
|
|
14
|
-
//# sourceMappingURL=zod-schema.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"zod-schema.d.ts","sourceRoot":"","sources":["../../src/decorators/zod-schema.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAI1B,eAAO,MAAM,UAAU,eAAuB,CAAC;AAG/C,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAGlB;AAGD,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,wBAAgB,SAAS,CAAC,OAAO,GAAE,gBAAqB,GAAG,cAAc,CASxE"}
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import 'reflect-metadata';
|
|
2
|
-
import { z } from 'zod';
|
|
3
|
-
export const ZOD_SCHEMA = Symbol('zod:schema');
|
|
4
|
-
export function ZodSchema(options = {}) {
|
|
5
|
-
return (target) => {
|
|
6
|
-
// Prepare new record
|
|
7
|
-
const metadata = {
|
|
8
|
-
strict: options.strict ?? false,
|
|
9
|
-
};
|
|
10
|
-
Reflect.defineMetadata(ZOD_SCHEMA, metadata, target);
|
|
11
|
-
};
|
|
12
|
-
}
|
|
13
|
-
//# sourceMappingURL=zod-schema.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"zod-schema.js","sourceRoot":"","sources":["../../src/decorators/zod-schema.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;AAkB/C,MAAM,UAAU,SAAS,CAAC,OAAO,GAAqB,EAAE;IACtD,OAAO,CAAC,MAAM,EAAE,EAAE;QAChB,qBAAqB;QACrB,MAAM,QAAQ,GAAsB;YAClC,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK;SAChC,CAAC;QAEF,OAAO,CAAC,cAAc,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC,CAAC;AACJ,CAAC"}
|