@forklaunch/validator 0.3.1 → 0.3.3

package/lib/src/zod/zodSchemaValidator.d.ts

@@ -0,0 +1,98 @@
+/**
+ * This module provides a Zod-based schema definition.
+ * It includes various types, schema creation, validation, and OpenAPI integration.
+ *
+ * @module ZodSchemaValidator
+ */
+import { SchemaObject } from 'openapi3-ts/oas31';
+import { ZodArray, ZodLiteral, ZodObject, ZodOptional, ZodRawShape, ZodType, ZodUnion, z } from 'zod';
+import { LiteralSchema, ParseResult, SchemaValidator as SV } from '../shared/types/schema.types';
+import { UnionZodResolve, ZodCatchall, ZodIdiomaticSchema, ZodResolve, ZodUnionContainer } from './types/schema.types';
+/**
+ * Class representing a Zod schema definition.
+ * @implements {StaticSchemaValidator}
+ */
+export declare class ZodSchemaValidator implements SV<(<T extends ZodObject<ZodRawShape>>(schema: T) => ZodResolve<T>), <T extends ZodIdiomaticSchema>(schema: T) => ZodResolve<T>, <T extends ZodIdiomaticSchema>(schema: T) => ZodOptional<ZodResolve<T>>, <T extends ZodIdiomaticSchema>(schema: T) => ZodArray<ZodResolve<T>>, <T extends ZodUnionContainer>(schemas: T) => ZodUnion<UnionZodResolve<T>>, <T extends LiteralSchema>(value: T) => ZodLiteral<ZodResolve<T>>, <T extends ZodCatchall>(schema: T, value: unknown) => boolean, <T extends ZodCatchall>(schema: T, value: unknown) => ParseResult<ZodResolve<T>>, <T extends ZodIdiomaticSchema>(schema: T) => SchemaObject> {
+    _Type: 'Zod';
+    _SchemaCatchall: ZodType;
+    _ValidSchemaObject: ZodObject<ZodRawShape> | ZodArray<ZodObject<ZodRawShape>>;
+    string: z.ZodString;
+    uuid: z.ZodString;
+    email: z.ZodString;
+    uri: z.ZodString;
+    number: z.ZodNumber;
+    bigint: z.ZodBigInt;
+    boolean: z.ZodEffects<z.ZodBoolean, boolean, unknown>;
+    date: z.ZodDate;
+    symbol: z.ZodSymbol;
+    nullish: ZodUnion<[z.ZodVoid, z.ZodNull, z.ZodUndefined]>;
+    any: z.ZodAny;
+    unknown: z.ZodUnknown;
+    never: z.ZodNever;
+    /**
+     * Pretty print Zod errors.
+     *
+     * @param {ZodError} error - The Zod error to pretty print.
+     * @returns
+     */
+    private prettyPrintZodErrors;
+    /**
+     * Compiles schema if this exists, for optimal performance.
+     *
+     * @param {ZodObject<ZodRawShape>} schema - The schema to compile.
+     * @returns {ZodResolve<T>} - The compiled schema.
+     */
+    compile<T extends ZodObject<ZodRawShape>>(schema: T): ZodResolve<T>;
+    /**
+     * Convert a schema to a Zod schema.
+     * @param {ZodIdiomaticSchema} schema - The schema to convert.
+     * @returns {ZodResolve<T>} The resolved schema.
+     */
+    schemify<T extends ZodIdiomaticSchema>(schema: T): ZodResolve<T>;
+    /**
+     * Make a schema optional.
+     * @param {ZodIdiomaticSchema} schema - The schema to make optional.
+     * @returns {ZodOptional<ZodResolve<T>>} The optional schema.
+     */
+    optional<T extends ZodIdiomaticSchema>(schema: T): ZodOptional<ZodResolve<T>>;
+    /**
+     * Create an array schema.
+     * @param {ZodIdiomaticSchema} schema - The schema to use for array items.
+     * @returns {ZodArray<ZodResolve<T>>} The array schema.
+     */
+    array<T extends ZodIdiomaticSchema>(schema: T): ZodArray<ZodResolve<T>>;
+    /**
+     * Create a union schema.
+     * @param {ZodUnionContainer} schemas - The schemas to union.
+     * @returns {ZodUnion<UnionZodResolve<T>>} The union schema.
+     */
+    union<T extends ZodUnionContainer>(schemas: T): ZodUnion<UnionZodResolve<T>>;
+    /**
+     * Create a literal schema.
+     * @param {LiteralSchema} value - The literal value.
+     * @returns {ZodLiteral<ZodResolve<T>>} The literal schema.
+     */
+    literal<T extends LiteralSchema>(value: T): ZodLiteral<ZodResolve<T>>;
+    /**
+     * Validate a value against a schema.
+     * @param {ZodCatchall} schema - The schema to validate against.
+     * @param {unknown} value - The value to validate.
+     * @returns {boolean} True if valid, otherwise false.
+     */
+    validate<T extends ZodCatchall>(schema: T, value: unknown): boolean;
+    /**
+     * Parses a value to a schema validation.
+     *
+     * @param {ZodCatchall} schema - The schema to validate against.
+     * @param {unknown} value - The value to validate.
+     * @returns {ParseResult} - The discrimintated parsed value if successful, the error if unsuccessful.
+     */
+    parse<T extends ZodCatchall>(schema: T, value: unknown): ParseResult<ZodResolve<T>>;
+    /**
+     * Convert a schema to an OpenAPI schema object.
+     * @param {ZodIdiomaticSchema} schema - The schema to convert.
+     * @returns {SchemaObject} The OpenAPI schema object.
+     */
+    openapi<T extends ZodIdiomaticSchema>(schema: T): SchemaObject;
+}
+//# sourceMappingURL=zodSchemaValidator.d.ts.map

package/lib/src/zod/zodSchemaValidator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zodSchemaValidator.d.ts","sourceRoot":"","sources":["../../../src/zod/zodSchemaValidator.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EACL,QAAQ,EAER,UAAU,EACV,SAAS,EACT,WAAW,EACX,WAAW,EACX,OAAO,EACP,QAAQ,EACR,CAAC,EACF,MAAM,KAAK,CAAC;AACb,OAAO,EACL,aAAa,EACb,WAAW,EACX,eAAe,IAAI,EAAE,EACtB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,eAAe,EACf,WAAW,EACX,kBAAkB,EAClB,UAAU,EACV,iBAAiB,EAClB,MAAM,sBAAsB,CAAC;AAE9B;;;GAGG;AACH,qBAAa,kBACX,YACE,EAAE,EACA,CAAC,CAAC,SAAS,SAAS,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,GAC9D,CAAC,CAAC,SAAS,kBAAkB,EAAE,MAAM,EAAE,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,EAC1D,CAAC,CAAC,SAAS,kBAAkB,EAAE,MAAM,EAAE,CAAC,KAAK,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EACvE,CAAC,CAAC,SAAS,kBAAkB,EAAE,MAAM,EAAE,CAAC,KAAK,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EACpE,CAAC,CAAC,SAAS,iBAAiB,EAAE,OAAO,EAAE,CAAC,KAAK,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EACzE,CAAC,CAAC,SAAS,aAAa,EAAE,KAAK,EAAE,CAAC,KAAK,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAChE,CAAC,CAAC,SAAS,WAAW,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,KAAK,OAAO,EAC7D,CAAC,CAAC,SAAS,WAAW,EACpB,MAAM,EAAE,CAAC,EACT,KAAK,EAAE,OAAO,KACX,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAC/B,CAAC,CAAC,SAAS,kBAAkB,EAAE,MAAM,EAAE,CAAC,KAAK,YAAY,CAC1D;IAEH,KAAK,EAAG,KAAK,CAAC;IACd,eAAe,EAAG,OAAO,CAAC;IAC1B,kBAAkB,EACd,SAAS,CAAC,WAAW,CAAC,GACtB,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;IAErC,MAAM,cAAc;IACpB,IAAI,cAA4B;IAChC,KAAK,cAA6B;IAClC,GAAG,cAA2B;IAC9B,MAAM,cAAqB;IAC3B,MAAM,cAAqB;IAC3B,OAAO,+CAMS;IAChB,IAAI,YAAmB;IACvB,MAAM,cAAc;IACpB,OAAO,mDAAgD;IACvD,GAAG,WAAW;IACd,OAAO,eAAe;IACtB,KAAK,aAAa;IAElB;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB;IAU5B;;;;;OAKG;IACH,OAAO,CAAC,CAAC,SAAS,SAAS,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;IAInE;;;;OAIG;IACH,QAAQ,CAAC,CAAC,SAAS,kBAAkB,EAAE,MAAM,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;IAyBhE;;;;OAIG;IACH,QAAQ,CAAC,CAAC,SAAS,kBAAkB,EACnC,MAAM,EAAE,CAAC,GACR,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAQ7B;;;;OAIG;IACH,KAAK,CAAC,CAAC,SAAS,kBAAkB,EAAE,MAAM,EAAE,CAAC,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAQvE;;;;OAIG;IACH,KAAK,CAAC,CAAC,SAAS,iBAAiB,EAAE,OAAO,EAAE,CAAC,GAAG,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAiB5E;;;;OAIG;IACH,OAAO,CAAC,CAAC,SAAS,aAAa,EAAE,KAAK,EAAE,CAAC,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAIrE;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,SAAS,WAAW,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO;IAInE;;;;;;OAMG;IACH,KAAK,CAAC,CAAC,SAAS,WAAW,EACzB,MAAM,EAAE,CAAC,EACT,KAAK,EAAE,OAAO,GACb,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAiB7B;;;;OAIG;IACH,OAAO,CAAC,CAAC,SAAS,kBAAkB,EAAE,MAAM,EAAE,CAAC,GAAG,YAAY;CAG/D"}

package/lib/src/zod/zodSchemaValidator.js

@@ -0,0 +1,179 @@
+/**
+ * This module provides a Zod-based schema definition.
+ * It includes various types, schema creation, validation, and OpenAPI integration.
+ *
+ * @module ZodSchemaValidator
+ */
+import { generateSchema } from '@anatine/zod-openapi';
+import { ZodType, z } from 'zod';
+/**
+ * Class representing a Zod schema definition.
+ * @implements {StaticSchemaValidator}
+ */
+export class ZodSchemaValidator {
+    _Type;
+    _SchemaCatchall;
+    _ValidSchemaObject;
+    string = z.string();
+    uuid = z.coerce.string().uuid();
+    email = z.coerce.string().email();
+    uri = z.coerce.string().url();
+    number = z.coerce.number();
+    bigint = z.coerce.bigint();
+    boolean = z.preprocess((val) => {
+        if (typeof val === 'string') {
+            if (val.toLowerCase() === 'true')
+                return true;
+            if (val.toLowerCase() === 'false')
+                return false;
+        }
+        return val;
+    }, z.boolean());
+    date = z.coerce.date();
+    symbol = z.symbol();
+    nullish = z.union([z.void(), z.null(), z.undefined()]);
+    any = z.any();
+    unknown = z.unknown();
+    never = z.never();
+    /**
+     * Pretty print Zod errors.
+     *
+     * @param {ZodError} error - The Zod error to pretty print.
+     * @returns
+     */
+    prettyPrintZodErrors(error) {
+        if (!error)
+            return;
+        const errorMessages = error.errors.map((err, index) => {
+            const path = err.path.length > 0 ? err.path.join(' > ') : 'root';
+            return `${index + 1}. Path: ${path}\n   Message: ${err.message}`;
+        });
+        return `Validation failed with the following errors:\n${errorMessages.join('\n\n')}`;
+    }
+    /**
+     * Compiles schema if this exists, for optimal performance.
+     *
+     * @param {ZodObject<ZodRawShape>} schema - The schema to compile.
+     * @returns {ZodResolve<T>} - The compiled schema.
+     */
+    compile(schema) {
+        return schema;
+    }
+    /**
+     * Convert a schema to a Zod schema.
+     * @param {ZodIdiomaticSchema} schema - The schema to convert.
+     * @returns {ZodResolve<T>} The resolved schema.
+     */
+    schemify(schema) {
+        if (typeof schema === 'string' ||
+            typeof schema === 'number' ||
+            typeof schema === 'boolean') {
+            return z.literal(schema);
+        }
+        if (schema instanceof ZodType) {
+            return schema;
+        }
+        const newSchema = {};
+        Object.getOwnPropertyNames(schema).forEach((key) => {
+            if (schema[key] instanceof ZodType) {
+                newSchema[key] = schema[key];
+            }
+            else {
+                newSchema[key] = this.schemify(schema[key]);
+            }
+        });
+        return z.object(newSchema);
+    }
+    /**
+     * Make a schema optional.
+     * @param {ZodIdiomaticSchema} schema - The schema to make optional.
+     * @returns {ZodOptional<ZodResolve<T>>} The optional schema.
+     */
+    optional(schema) {
+        if (schema instanceof ZodType) {
+            return schema.optional();
+        }
+        else {
+            return this.schemify(schema).optional();
+        }
+    }
+    /**
+     * Create an array schema.
+     * @param {ZodIdiomaticSchema} schema - The schema to use for array items.
+     * @returns {ZodArray<ZodResolve<T>>} The array schema.
+     */
+    array(schema) {
+        if (schema instanceof ZodType) {
+            return schema.array();
+        }
+        else {
+            return this.schemify(schema).array();
+        }
+    }
+    /**
+     * Create a union schema.
+     * @param {ZodUnionContainer} schemas - The schemas to union.
+     * @returns {ZodUnion<UnionZodResolve<T>>} The union schema.
+     */
+    union(schemas) {
+        if (schemas.length < 2) {
+            throw new Error('Union must have at least two schemas');
+        }
+        const unionTypes = schemas.map((schema) => {
+            if (schema instanceof ZodType) {
+                return schema;
+            }
+            return this.schemify(schema);
+        });
+        return z.union(unionTypes);
+    }
+    /**
+     * Create a literal schema.
+     * @param {LiteralSchema} value - The literal value.
+     * @returns {ZodLiteral<ZodResolve<T>>} The literal schema.
+     */
+    literal(value) {
+        return z.literal(value);
+    }
+    /**
+     * Validate a value against a schema.
+     * @param {ZodCatchall} schema - The schema to validate against.
+     * @param {unknown} value - The value to validate.
+     * @returns {boolean} True if valid, otherwise false.
+     */
+    validate(schema, value) {
+        return schema.safeParse(value).success;
+    }
+    /**
+     * Parses a value to a schema validation.
+     *
+     * @param {ZodCatchall} schema - The schema to validate against.
+     * @param {unknown} value - The value to validate.
+     * @returns {ParseResult} - The discrimintated parsed value if successful, the error if unsuccessful.
+     */
+    parse(schema, value) {
+        try {
+            const result = schema.safeParse(value);
+            return result.success
+                ? { ok: true, value: result.data }
+                : {
+                    ok: false,
+                    error: this.prettyPrintZodErrors(result.error)
+                };
+        }
+        catch (error) {
+            return {
+                ok: false,
+                error: `Unexpected zod safeParse error: ${error.message}`
+            };
+        }
+    }
+    /**
+     * Convert a schema to an OpenAPI schema object.
+     * @param {ZodIdiomaticSchema} schema - The schema to convert.
+     * @returns {SchemaObject} The OpenAPI schema object.
+     */
+    openapi(schema) {
+        return generateSchema(this.schemify(schema));
+    }
+}

package/lib/tests/typebox/advancedParse.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=advancedParse.test.d.ts.map

package/lib/tests/typebox/advancedParse.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"advancedParse.test.d.ts","sourceRoot":"","sources":["../../../tests/typebox/advancedParse.test.ts"],"names":[],"mappings":""}