zod-typeorm 1.0.0 → 1.1.1

package/README.md

@@ -0,0 +1,166 @@
+# zod-typeorm
+
+[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.
+
+## Brief description
+
+- Works with class inheritance (no base class pollution)
+- Currently **no property name conflict resolution**
+- Currently no integration with *@Column* decorator from TypeORM
+- Supports schema variants (no predefined schema)
+
+## Quick start
+
+Define schema for each property with *@ZodProperty*.
+
+- Argument can be schema diretly like `@ZodProperty(z.number().min(0))`
+- Or it can be options with *schema* property `@ZodProperty({ schema: z.number().min(0) })`
+
+```ts
+@Entity()
+export class TestEntity {
+  @PrimaryGeneratedColumn({ unsigned: true })
+  @ZodProperty(z.number().min(0))
+  id: number;
+
+  @Column()
+  @ZodProperty(z.string().min(1).max(255))
+  name: string;
+}
+
+// Create schema from entity
+const entitySchema = createZodSchemaFromEntity(TestEntity);
+// included schema properties: id, name
+```
+
+## Installation
+
+```bash
+npm install zod-typeorm
+```
+
+## Inheritance support
+
+Library supports object inheritance with limition that property names should **not be duplicated** between classes.
+
+```ts
+export class EntityBase {
+  @Column()
+  @ZodProperty({ schema: z.string().min(1).max(255) })
+  baseProperty: string;
+}
+
+@Entity()
+export class TestEntity extends EntityBase {
+  @PrimaryGeneratedColumn({ unsigned: true })
+  @ZodProperty({ schema: z.number().min(0) })
+  id: number;
+
+  @Column()
+  @ZodProperty({ schema: z.string().min(1).max(255) })
+  name: string;
+}
+
+// Create schema from entity
+const entitySchema = createZodSchemaFromEntity(TestEntity);
+// included schema properties: baseProperty, id, name
+```
+
+## Schema variants
+
+To create different schema from the same Entity based on your use case, there is support for schema variants.
+
+- Variants can have arbitrary name (except *default* is reserved), variant names don't need to be defined anywhere, just use logic below
+- Using *includeForVariants* in *@ZodProperty* you can select variants for which property should be included
+- Using *optionalForVariants* in *@ZodProperty* you can make property optional for variants
+- Using *skipForVariants* in *@ZodProperty* you can exclude property from variants
+- Using *transformForVariants* in *@ZodProperty* you can transform schema additionaly for variants
+
+```ts
+@Entity()
+export class TestEntity {
+  @PrimaryGeneratedColumn({ unsigned: true })
+  @ZodProperty({ schema: z.number().min(0) })
+  id: number;
+
+  @Column()
+  @ZodProperty({ schema: z.string().min(1).max(255) })
+  name: string;
+
+  @Column({ unsigned: true })
+  @ZodProperty({ schema: z.number().min(0), includeForVariants: ['variant1'] })
+  iProperty: number;
+
+  @Column({ unsigned: true })
+  @ZodProperty({ schema: z.number().min(0), includeForVariants: ['variant2'] })
+  sProperty: number;
+
+  @Column({ unsigned: true })
+  @ZodProperty({ schema: z.number().min(0), skipForVariants: ['variant2'], optionalForVariants: ['variant3'] })
+  pProperty: number;
+}
+
+// Create schemas from entity
+const schemas = createZodSchemasFromEntity(TestEntity, ['variant1', 'variant2', 'variant3']);
+schemas.variant1 // variant1: includes properties id, name, iProperty, pProperty
+schemas.variant2 // variant2: includes properties id, name, sProperty
+schemas.variant3 // variant3: includes properties id, name, pProperty?
+```
+
+
+## Schema generation options
+
+While creating schemas additional options can be specified.
+
+```ts
+const schemas = createZodSchemasFromEntity(TestEntity, ['variant1', 'variant2', 'variant3'], {
+  strict: true, // Make schema strict (see Zod doc)
+  optionalFields: [], // Make fields optional for all variants
+  skipFields: [], // Skip fields for all variants,
+  transformFields: {
+    variant1: (schema: z.ZodType) => schema, // Transform certain fields
+  },
+  transformSchema: (schema: z.ZodObject<z.ZodRawShape>) => schema, // Additionaly transform generated schema
+  transformSchemaForVariants: {
+    variant1: (schema: z.ZodObject<z.ZodRawShape>) => schema, // Transform schema for variant
+  },
+});
+```
+
+## Type Inference
+
+```ts
+type Variant1 = z.infer<typeof schemas.variant1>;
+type Variant2 = z.infer<typeof schemas.variant2>;
+type Variant3 = z.infer<typeof schemas.variant3>;
+```
+
+## API reference
+
+Decorators:
+
+- `@ZodProperty(schema)`
+- `@ZodProperty({ schema, includeForVariants?, optionalForVariants?, skipForVariants?, transformForVariants? })`
+
+Schema creation:
+
+- `createZodSchemaFromEntity(entityClass, variantName, options)`
+- `createZodSchemasFromEntity(entityClass, [variantNames], options)`
+
+
+## Requirements
+
+- TypeORM >= 1.1.1
+- Zod >= 4.0.0
+- TypeScript
+- *reflect-metadata* package
+
+## Contribution
+
+Contributions are welcome, before commiting changes please run:
+
+```bash
+npm run typecheck
+npm run test
+npm run check-format
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zod-typeorm",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "TypeORM Zod utililities",
   "keywords": ["database", "orm", "schema", "typeorm", "validation", "zod"],
   "author": "Martin Dagarin",

package/dist/decorators/index.d.ts

@@ -1,2 +0,0 @@
-export { ZOD_SCHEMA_PROPERTY, ZodProperty, type ZodPropertyOptions, type ZodPropertyMetadata, } from './zod-property.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/decorators/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/decorators/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,WAAW,EACX,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,GACzB,MAAM,mBAAmB,CAAC"}

package/dist/decorators/index.js

@@ -1,2 +0,0 @@
-export { ZOD_SCHEMA_PROPERTY, ZodProperty, } from './zod-property.js';
-//# sourceMappingURL=index.js.map

package/dist/decorators/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/decorators/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,WAAW,GAGZ,MAAM,mBAAmB,CAAC"}

package/dist/decorators/zod-property.d.ts

@@ -1,27 +0,0 @@
-import 'reflect-metadata';
-import { z } from 'zod';
-export declare const ZOD_SCHEMA_PROPERTY: unique symbol;
-export interface ZodPropertyOptions {
-    schema: z.ZodType | (() => z.ZodType);
-    /**
-     * Make property optional when generating schema for certain variants
-     */
-    optionalForVariants?: string[];
-    /**
-     * Skip property when generating schema for certain variants (blacklist)
-     */
-    skipForVariants?: string[];
-    /**
-     * Include property only when generating schema for specified variants (whitelist)
-     */
-    includeForVariants?: string[];
-}
-export interface ZodPropertyMetadata {
-    propertyKey: string | symbol;
-    schema: z.ZodType | (() => z.ZodType);
-    optionalForVariants: string[];
-    skipForVariants: string[];
-    includeForVariants: string[];
-}
-export declare function ZodProperty(options: ZodPropertyOptions | z.ZodType | (() => z.ZodType)): PropertyDecorator;
-//# sourceMappingURL=zod-property.d.ts.map

package/dist/decorators/zod-property.d.ts.map

@@ -1 +0,0 @@
-{"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;CAC/B;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;CAC9B;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,CAAC,CAAC,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,iBAAiB,CAyC1G"}

package/dist/decorators/zod-property.js

@@ -1,41 +0,0 @@
-import 'reflect-metadata';
-import { z } from 'zod';
-export const ZOD_SCHEMA_PROPERTY = Symbol('zod:schema:property');
-export function ZodProperty(options) {
-    return (target, propertyKey) => {
-        const ctor = target.constructor;
-        let existingMetadata = Reflect.getOwnMetadata(ZOD_SCHEMA_PROPERTY, ctor) ?? [];
-        // First time copy metadata from base class if anything exists
-        if (!existingMetadata || existingMetadata.length < 1) {
-            existingMetadata = [...(Reflect.getMetadata(ZOD_SCHEMA_PROPERTY, ctor) ?? [])];
-        }
-        // Prevent duplicate metadata registration
-        const index = existingMetadata.findIndex(m => m.propertyKey === propertyKey);
-        // Prepare new record
-        const metadata = {
-            propertyKey: propertyKey,
-            ...((options instanceof z.ZodType || typeof options === 'function')
-                ? {
-                    schema: options,
-                    optionalForVariants: [],
-                    skipForVariants: [],
-                    includeForVariants: [],
-                }
-                : {
-                    schema: options.schema,
-                    optionalForVariants: options.optionalForVariants ?? [],
-                    skipForVariants: options.skipForVariants ?? [],
-                    includeForVariants: options.includeForVariants ?? [],
-                }),
-        };
-        if (index === -1) { // No existing metadata found => add new record
-            existingMetadata.push(metadata);
-        }
-        else { // Found existing metadata => overwrite
-            existingMetadata[index] = metadata;
-        }
-        // Set updated metadata
-        Reflect.defineMetadata(ZOD_SCHEMA_PROPERTY, existingMetadata, ctor);
-    };
-}
-//# sourceMappingURL=zod-property.js.map

package/dist/decorators/zod-property.js.map

@@ -1 +0,0 @@
-{"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;AA+BjE,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,CAAC,CAAC,CAAC,WAAW,KAAK,WAAW,CAAC,CAAC;QAE7E,qBAAqB;QACrB,MAAM,QAAQ,GAAwB;YACpC,WAAW,EAAE,WAAW;YACxB,GAAG,CAAC,CAAC,OAAO,YAAY,CAAC,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,UAAU,CAAC;gBACjE,CAAC,CAAC;oBACA,MAAM,EAAE,OAAO;oBACf,mBAAmB,EAAE,EAAE;oBACvB,eAAe,EAAE,EAAE;oBACnB,kBAAkB,EAAE,EAAE;iBACvB;gBACD,CAAC,CAAC;oBACA,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;iBACrD,CAAC;SACL,CAAC;QAEF,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,+CAA+C;YACjE,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClC,CAAC;aAAM,CAAC,CAAC,uCAAuC;YAC9C,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/decorators/zod-schema.d.ts

@@ -1,14 +0,0 @@
-import 'reflect-metadata';
-export declare const ZOD_SCHEMA: unique symbol;
-export interface ZodSchemaOptions {
-    /**
-     * Reject unknown properties
-     * @default false
-     */
-    strict?: boolean;
-}
-export interface ZodSchemaMetadata {
-    strict: boolean;
-}
-export declare function ZodSchema(options?: ZodSchemaOptions): ClassDecorator;
-//# sourceMappingURL=zod-schema.d.ts.map

package/dist/decorators/zod-schema.d.ts.map

@@ -1 +0,0 @@
-{"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"}

package/dist/decorators/zod-schema.js

@@ -1,13 +0,0 @@
-import 'reflect-metadata';
-import { z } from 'zod';
-export const ZOD_SCHEMA = Symbol('zod:schema');
-export function ZodSchema(options = {}) {
-    return (target) => {
-        // Prepare new record
-        const metadata = {
-            strict: options.strict ?? false,
-        };
-        Reflect.defineMetadata(ZOD_SCHEMA, metadata, target);
-    };
-}
-//# sourceMappingURL=zod-schema.js.map

package/dist/decorators/zod-schema.js.map

@@ -1 +0,0 @@
-{"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"}

package/dist/index.d.ts

@@ -1,6 +0,0 @@
-/**
- * zod-typeorm library
- */
-export * from './decorators/index.js';
-export { createZodSchemaFromEntityForVariant, createZodSchemaFromEntity, createZodSchemasFromEntity, type CreateZodSchemaOptions, } from './schema.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,uBAAuB,CAAC;AAEtC,OAAO,EACL,mCAAmC,EACnC,yBAAyB,EACzB,0BAA0B,EAC1B,KAAK,sBAAsB,GAC5B,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -1,6 +0,0 @@
-/**
- * zod-typeorm library
- */
-export * from './decorators/index.js';
-export { createZodSchemaFromEntityForVariant, createZodSchemaFromEntity, createZodSchemasFromEntity, } from './schema.js';
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,uBAAuB,CAAC;AAEtC,OAAO,EACL,mCAAmC,EACnC,yBAAyB,EACzB,0BAA0B,GAE3B,MAAM,aAAa,CAAC"}

package/dist/schema.d.ts

@@ -1,52 +0,0 @@
-import 'reflect-metadata';
-import { z } from 'zod';
-export interface CreateZodSchemaOptions {
-    /**
-     * Create strict schema
-     */
-    strict?: boolean;
-    /**
-     * Make fields optional
-     */
-    optionalFields?: (string | Symbol)[];
-    /**
-     * Skip additional fields
-     */
-    skipFields?: (string | Symbol)[];
-    /**
-     * Add additional field transformation
-     */
-    transformFields?: Record<string | symbol, (schema: z.ZodType) => z.ZodType>;
-    /**
-     * Additional schema transformation
-     */
-    transformSchema?: (schema: z.ZodObject<z.ZodRawShape>) => z.ZodObject<z.ZodRawShape>;
-    /**
-     * Add additional schema transformation for certain schemas
-     */
-    transformSchemaForVariants?: Record<string, (schema: z.ZodObject<z.ZodRawShape>) => z.ZodObject<z.ZodRawShape>>;
-}
-/**
- * Generate schema from decorated class for variant
- * @param entityClass Entity class
- * @param variantName Variant name
- * @param options Options
- * @returns z.ZodObject
- */
-export declare function createZodSchemaFromEntityForVariant<T>(entityClass: new () => T, variantName: string, options?: CreateZodSchemaOptions): z.ZodObject<z.ZodRawShape>;
-/**
- * Generate schema from decorated class for 'default' variant
- * @param entityClass Entity class
- * @param options Options
- * @returns z.ZodObject
- */
-export declare function createZodSchemaFromEntity<T>(entityClass: new () => T, options?: CreateZodSchemaOptions): z.ZodObject<z.ZodRawShape>;
-/**
- * Generate schema from decorated class for list of variants
- * @param entityClass Entity class
- * @param variantNames Variant names
- * @param options Options
- * @returns Record<string, z.ZodObject>
- */
-export declare function createZodSchemasFromEntity<T>(entityClass: new () => T, variantNames: string[], options?: CreateZodSchemaOptions): Record<string, z.ZodObject<z.ZodRawShape>>;
-//# sourceMappingURL=schema.d.ts.map

package/dist/schema.d.ts.map

@@ -1 +0,0 @@
-{"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,mCAAmC,CAAC,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,GAAE,sBAA2B,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAiCtK;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,OAAO,GAAE,sBAA2B,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAEvI;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE,sBAA2B,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAKhL"}

package/dist/schema.js

@@ -1,63 +0,0 @@
-import 'reflect-metadata';
-import { z } from 'zod';
-import { ZOD_SCHEMA_PROPERTY } from './decorators/zod-property.js';
-/**
- * Generate schema from decorated class for variant
- * @param entityClass Entity class
- * @param variantName Variant name
- * @param options Options
- * @returns z.ZodObject
- */
-export function createZodSchemaFromEntityForVariant(entityClass, variantName, options = {}) {
-    // Get metadata for properties
-    const propertyMetadata = Reflect.getMetadata(ZOD_SCHEMA_PROPERTY, entityClass) ?? [];
-    if (propertyMetadata.length <= 0)
-        throw new Error(`No Zod metadata found on Entity ${entityClass.name} (Use @ZodProperty)`);
-    // Build set of properties for zod schema
-    const shape = {};
-    for (const item of propertyMetadata) { // Go over each property decorator metadata
-        // Check if field needs to be skipped (schema skip, skip field because of variant) or if not in include list
-        if (options.skipFields?.includes(item.propertyKey) || item.skipForVariants.includes(variantName) || (item.includeForVariants.length > 0 && !item.includeForVariants.includes(variantName)))
-            continue;
-        const propertyKey = String(item.propertyKey);
-        shape[propertyKey] =
-            typeof item.schema === 'function'
-                ? item.schema()
-                : item.schema;
-        if (item.propertyKey && options.transformFields && item.propertyKey in options.transformFields && options.transformFields[item.propertyKey]) // Transform field
-            shape[propertyKey] = options.transformFields[item.propertyKey](shape[propertyKey]);
-        if (options.optionalFields?.includes(item.propertyKey) || item.optionalForVariants.includes(variantName)) // Make field optional
-            shape[propertyKey] = shape[propertyKey].optional();
-    }
-    let schema = z.object(shape);
-    if (options.transformSchemaForVariants && variantName in options.transformSchemaForVariants && options.transformSchemaForVariants[variantName]) // Per-variant transformation
-        schema = options.transformSchemaForVariants[variantName](schema);
-    if (options.transformSchema) // Single (everytime) transformation
-        schema = options.transformSchema(schema);
-    if (options.strict)
-        schema = schema.strict();
-    return schema;
-}
-/**
- * Generate schema from decorated class for 'default' variant
- * @param entityClass Entity class
- * @param options Options
- * @returns z.ZodObject
- */
-export function createZodSchemaFromEntity(entityClass, options = {}) {
-    return createZodSchemaFromEntityForVariant(entityClass, 'default', options);
-}
-/**
- * Generate schema from decorated class for list of variants
- * @param entityClass Entity class
- * @param variantNames Variant names
- * @param options Options
- * @returns Record<string, z.ZodObject>
- */
-export function createZodSchemasFromEntity(entityClass, variantNames, options = {}) {
-    const schemaVariants = {};
-    for (let name of variantNames)
-        schemaVariants[name] = createZodSchemaFromEntityForVariant(entityClass, name, options);
-    return schemaVariants;
-}
-//# sourceMappingURL=schema.js.map

package/dist/schema.js.map

@@ -1 +0,0 @@
-{"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,mCAAmC,CAAI,WAAwB,EAAE,WAAmB,EAAE,OAAO,GAA2B,EAAE;IACxI,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,CAAC,2CAA2C;QAChF,4GAA4G;QAC5G,IAAI,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;YACxL,SAAS;QAEX,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC7C,KAAK,CAAC,WAAW,CAAC;YAChB,OAAO,IAAI,CAAC,MAAM,KAAK,UAAU;gBAC/B,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE;gBACf,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QAClB,IAAI,IAAI,CAAC,WAAW,IAAI,OAAO,CAAC,eAAe,IAAI,IAAI,CAAC,WAAW,IAAI,OAAO,CAAC,eAAe,IAAI,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,kBAAkB;YAC7J,KAAK,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;QACtF,IAAI,OAAO,CAAC,cAAc,EAAE,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,sBAAsB;YAC9H,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,IAAI,OAAO,CAAC,0BAA0B,IAAI,WAAW,IAAI,OAAO,CAAC,0BAA0B,IAAI,OAAO,CAAC,0BAA0B,CAAC,WAAW,CAAC,EAAE,6BAA6B;QAC3K,MAAM,GAAG,OAAO,CAAC,0BAA0B,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC;IACnE,IAAI,OAAO,CAAC,eAAe,EAAE,oCAAoC;QAC/D,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IAC3C,IAAI,OAAO,CAAC,MAAM;QAChB,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;IAC3B,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CAAI,WAAwB,EAAE,OAAO,GAA2B,EAAE;IACzG,OAAO,mCAAmC,CAAC,WAAW,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;AAC9E,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CAAI,WAAwB,EAAE,YAAsB,EAAE,OAAO,GAA2B,EAAE;IAClI,MAAM,cAAc,GAA+C,EAAE,CAAC;IACtE,KAAK,IAAI,IAAI,IAAI,YAAY;QAC3B,cAAc,CAAC,IAAI,CAAC,GAAG,mCAAmC,CAAC,WAAW,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACzF,OAAO,cAAc,CAAC;AACxB,CAAC"}