exisjs 0.9.1 → 0.9.2

package/dist/validator/engine.d.ts

@@ -1,8 +1,22 @@
 import { type ResolveSchema } from './tex-types';
+import { ValidatorError } from './error';
+import type { ValidationErrorDescriptor } from './types';
+/** Result of `safeParse()`: the data, or the errors instead of a throw. */
+export type SafeParseResult<T> = {
+    success: true;
+    data: T;
+    errors?: undefined;
+    error?: undefined;
+} | {
+    success: false;
+    data?: undefined;
+    errors: ValidationErrorDescriptor[];
+    error: ValidatorError;
+};
 /**
  * The rule string for one field of an object schema. Shared by `tex.object`,
- * `tex.array` and `extend` so a nested schema keeps its `optional()` /
- * `nullable()` modifiers on every path.
+ * `tex.array`, `tex.record`, `tex.union` and `extend` so a nested schema
+ * keeps its `optional()` / `nullable()` modifiers on every path.
  */
 export declare function fieldRule(key: string, value: unknown): string;
 export declare class TexEngine<T = any> {
@@ -10,29 +24,49 @@ export declare class TexEngine<T = any> {
     private rawSchema;
     private validator;
     private strict;
+    private _queryValidator?;
     readonly _type: T;
     _isOptional: boolean;
     _isNullable: boolean;
-    private _plan?;
+    private _objectRules;
+    /** @internal Read by the rule compiler when this schema is nested */
+    _objectCheck?: (v: any) => any;
     constructor(schema: Record<string, string>, rawSchema: Record<string, any>, strict?: boolean, isOptional?: boolean);
     private _fieldValidators?;
     /**
      * The compiled validator stops at the first problem, which keeps valid
-     * requests fast. Once a parse has failed, every other top-level field is
-     * checked on its own so the response lists all failing fields (capped).
+     * requests fast. Once a parse has failed, every field is checked on its
+     * own, descending into nested objects, array items and record values, so
+     * the response lists every failing value (capped).
      */
     private collectErrors;
-    /** Turns a validator exception into a structured error entry */
-    private describeError;
+    /** @internal Checks each field on its own; used after a failed parse */
+    _collectFields(data: Record<string, any>, query?: boolean): ValidationErrorDescriptor[];
     getCompiledSchema(): Record<string, string>;
     /** A copy with another shape that keeps strictness and modifiers */
     private derive;
+    /** A copy with the same shape, keeping refine() rules */
+    private copy;
     /** The field may be left out. */
     optional(): TexEngine<T | undefined> & {
         readonly __isOptional: true;
     };
     /** The field may be `null`. */
     nullable(): TexEngine<T | null>;
+    /**
+     * A check across fields, run once every field is valid. `path` names the
+     * field the error is reported on (default: the object itself).
+     *
+     * @example
+     * ```ts
+     * tex.object({ password: tex.string(), confirm: tex.string() })
+     *   .refine((d) => d.password === d.confirm, { message: 'Passwords must match', path: 'confirm' })
+     * ```
+     */
+    refine(fn: (data: T) => boolean, message?: string | ((data: T) => string) | {
+        message?: string | ((data: T) => string);
+        path?: string;
+    }): TexEngine<T>;
     /** The field may be left out or be `null`. */
     nullish(): TexEngine<T | null | undefined> & {
         readonly __isOptional: true;
@@ -43,8 +77,17 @@ export declare class TexEngine<T = any> {
     transform<Out>(fn: (val: T) => Out): TexTransformedEngine<T, Out>;
     pick<K extends keyof T>(keys: K[]): TexEngine<Pick<T, K>>;
     omit<K extends keyof T>(keys: K[]): TexEngine<Omit<T, K>>;
+    /**
+     * Validates `data` and returns a new object with the declared fields only.
+     * The input is never modified. Throws `ValidatorError` listing every
+     * failing field.
+     */
     parse(data: any): T;
+    /** Like `parse()`, but returns `{ success, data }` or `{ success, errors }`. */
+    safeParse(data: any): SafeParseResult<T>;
+    /** Runs `parse()`, then every `refineAsync()` rule, nested ones included. */
     parseAsync(data: any): Promise<T>;
+    safeParseAsync(data: any): Promise<SafeParseResult<T>>;
     toMongoSchema(): Record<string, any>;
     toOpenApi(): Record<string, any>;
 }
@@ -54,7 +97,9 @@ export declare class TexTransformedEngine<In, Out> {
     readonly _type: Out;
     constructor(inner: TexEngine<In>, transformFn: (val: In) => Out);
     parse(data: any): Out;
+    safeParse(data: any): SafeParseResult<Out>;
     parseAsync(data: any): Promise<Out>;
+    safeParseAsync(data: any): Promise<SafeParseResult<Out>>;
     toOpenApi(): Record<string, any>;
 }
 export declare class TexDiscriminatedUnionEngine<Discriminator extends string, Variants extends (TexEngine<any> | Record<string, any>)[]> {
@@ -62,9 +107,15 @@ export declare class TexDiscriminatedUnionEngine<Discriminator extends string, V
     readonly variants: Variants;
     readonly _type: Variants[number]['_type'];
     private engines;
+    private tags;
     constructor(discriminator: Discriminator, variants: Variants);
+    /** The variant whose discriminator matches `data`, if any */
+    variantFor(data: any): TexEngine<any> | undefined;
+    private noMatch;
     parse(data: any): Variants[number]['_type'];
+    safeParse(data: any): SafeParseResult<Variants[number]['_type']>;
     parseAsync(data: any): Promise<Variants[number]['_type']>;
+    safeParseAsync(data: any): Promise<SafeParseResult<Variants[number]['_type']>>;
     toOpenApi(): Record<string, any>;
 }
 //# sourceMappingURL=engine.d.ts.map

package/dist/validator/engine.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"engine.d.ts","sourceRoot":"","sources":["../../src/validator/engine.ts"],"names":[],"mappings":"AACA,OAAO,EAAW,KAAK,aAAa,EAAE,MAAM,aAAa,CAAA;AAWzD;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,MAAM,CAc7D;AAED,qBAAa,SAAS,CAAC,CAAC,GAAG,GAAG;IAC5B,OAAO,CAAC,MAAM,CAAwB;IACtC,OAAO,CAAC,SAAS,CAAqB;IACtC,OAAO,CAAC,SAAS,CAAoB;IACrC,OAAO,CAAC,MAAM,CAAS;IAEvB,SAAgB,KAAK,EAAG,CAAC,CAAA;IAClB,WAAW,UAAQ;IACnB,WAAW,UAAQ;IAG1B,OAAO,CAAC,KAAK,CAAC,CAAW;gBAGvB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC9B,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC9B,MAAM,UAAQ,EACd,UAAU,UAAQ;IAUpB,OAAO,CAAC,gBAAgB,CAAC,CAAiC;IAE1D;;;;OAIG;IACH,OAAO,CAAC,aAAa;IA0CrB,gEAAgE;IAChE,OAAO,CAAC,aAAa;IAgGrB,iBAAiB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAI3C,oEAAoE;IACpE,OAAO,CAAC,MAAM;IAcd,iCAAiC;IACjC,QAAQ,IAAI,SAAS,CAAC,CAAC,GAAG,SAAS,CAAC,GAAG;QAAE,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAA;KAAE;IAMtE,+BAA+B;IAC/B,QAAQ,IAAI,SAAS,CAAC,CAAC,GAAG,IAAI,CAAC;IAM/B,8CAA8C;IAC9C,OAAO,IAAI,SAAS,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,GAAG;QAC3C,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAA;KAC5B;IAID,OAAO,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAoBhC,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAClC,SAAS,EAAE,CAAC,GACX,SAAS,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;IAUlC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,CAAC,GAAG,KAAK,CAAC;IAM3D,SAAS,CAAC,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,GAAG,GAAG,oBAAoB,CAAC,CAAC,EAAE,GAAG,CAAC;IAIjE,IAAI,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAYzD,IAAI,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAYzD,KAAK,CAAC,IAAI,EAAE,GAAG,GAAG,CAAC;IAgFb,UAAU,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;IA0CvC,aAAa,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAgCpC,SAAS,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAoDjC;AAED,qBAAa,oBAAoB,CAAC,EAAE,EAAE,GAAG;aAIrB,KAAK,EAAE,SAAS,CAAC,EAAE,CAAC;aACpB,WAAW,EAAE,CAAC,GAAG,EAAE,EAAE,KAAK,GAAG;IAJ/C,SAAgB,KAAK,EAAG,GAAG,CAAA;gBAGT,KAAK,EAAE,SAAS,CAAC,EAAE,CAAC,EACpB,WAAW,EAAE,CAAC,GAAG,EAAE,EAAE,KAAK,GAAG;IAG/C,KAAK,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG;IAKf,UAAU,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAKzC,SAAS,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAGjC;AAED,qBAAa,2BAA2B,CACtC,aAAa,SAAS,MAAM,EAC5B,QAAQ,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE;aAMvC,aAAa,EAAE,aAAa;aAC5B,QAAQ,EAAE,QAAQ;IALpC,SAAgB,KAAK,EAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAA;IACjD,OAAO,CAAC,OAAO,CAAkB;gBAGf,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,QAAQ;IAiBpC,KAAK,CAAC,IAAI,EAAE,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;IAqErC,UAAU,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC;IAsC/D,SAAS,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CASjC"}
+{"version":3,"file":"engine.d.ts","sourceRoot":"","sources":["../../src/validator/engine.ts"],"names":[],"mappings":"AACA,OAAO,EAAW,KAAK,aAAa,EAAE,MAAM,aAAa,CAAA;AACzD,OAAO,EAAE,cAAc,EAAuC,MAAM,SAAS,CAAA;AAU7E,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,SAAS,CAAA;AAExD,2EAA2E;AAC3E,MAAM,MAAM,eAAe,CAAC,CAAC,IACzB;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,CAAC,CAAC;IAAC,MAAM,CAAC,EAAE,SAAS,CAAC;IAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAAE,GACjE;IACE,OAAO,EAAE,KAAK,CAAA;IACd,IAAI,CAAC,EAAE,SAAS,CAAA;IAChB,MAAM,EAAE,yBAAyB,EAAE,CAAA;IACnC,KAAK,EAAE,cAAc,CAAA;CACtB,CAAA;AAiCL;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,MAAM,CAkB7D;AAyJD,qBAAa,SAAS,CAAC,CAAC,GAAG,GAAG;IAC5B,OAAO,CAAC,MAAM,CAAwB;IACtC,OAAO,CAAC,SAAS,CAAqB;IACtC,OAAO,CAAC,SAAS,CAAoB;IACrC,OAAO,CAAC,MAAM,CAAS;IAEvB,OAAO,CAAC,eAAe,CAAC,CAAoB;IAE5C,SAAgB,KAAK,EAAG,CAAC,CAAA;IAClB,WAAW,UAAQ;IACnB,WAAW,UAAQ;IAE1B,OAAO,CAAC,YAAY,CAAmB;IACvC,qEAAqE;IACrE,YAAY,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,GAAG,CAAA;gBAG5B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC9B,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC9B,MAAM,UAAQ,EACd,UAAU,UAAQ;IAUpB,OAAO,CAAC,gBAAgB,CAAC,CAAiC;IAE1D;;;;;OAKG;IACH,OAAO,CAAC,aAAa;IAiBrB,wEAAwE;IACxE,cAAc,CACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACzB,KAAK,UAAQ,GACZ,yBAAyB,EAAE;IAyC9B,iBAAiB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAI3C,oEAAoE;IACpE,OAAO,CAAC,MAAM;IAcd,yDAAyD;IACzD,OAAO,CAAC,IAAI;IAOZ,iCAAiC;IACjC,QAAQ,IAAI,SAAS,CAAC,CAAC,GAAG,SAAS,CAAC,GAAG;QAAE,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAA;KAAE;IAMtE,+BAA+B;IAC/B,QAAQ,IAAI,SAAS,CAAC,CAAC,GAAG,IAAI,CAAC;IAM/B;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,EACxB,OAAO,CAAC,EACJ,MAAM,GACN,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC,GACrB;QAAE,OAAO,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAC9D,SAAS,CAAC,CAAC,CAAC;IAYf,8CAA8C;IAC9C,OAAO,IAAI,SAAS,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,GAAG;QAC3C,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAA;KAC5B;IAID,OAAO,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAkBhC,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAClC,SAAS,EAAE,CAAC,GACX,SAAS,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;IAUlC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,CAAC,GAAG,KAAK,CAAC;IAM3D,SAAS,CAAC,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,GAAG,GAAG,oBAAoB,CAAC,CAAC,EAAE,GAAG,CAAC;IAIjE,IAAI,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAYzD,IAAI,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAYzD;;;;OAIG;IACH,KAAK,CAAC,IAAI,EAAE,GAAG,GAAG,CAAC;IAuCnB,gFAAgF;IAChF,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,eAAe,CAAC,CAAC,CAAC;IAIxC,6EAA6E;IACvE,UAAU,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;IAOvC,cAAc,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAItD,aAAa,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAiCpC,SAAS,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CA0DjC;AAED,qBAAa,oBAAoB,CAAC,EAAE,EAAE,GAAG;aAIrB,KAAK,EAAE,SAAS,CAAC,EAAE,CAAC;aACpB,WAAW,EAAE,CAAC,GAAG,EAAE,EAAE,KAAK,GAAG;IAJ/C,SAAgB,KAAK,EAAG,GAAG,CAAA;gBAGT,KAAK,EAAE,SAAS,CAAC,EAAE,CAAC,EACpB,WAAW,EAAE,CAAC,GAAG,EAAE,EAAE,KAAK,GAAG;IAG/C,KAAK,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG;IAKrB,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,eAAe,CAAC,GAAG,CAAC;IAIpC,UAAU,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAKzC,cAAc,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;IAIxD,SAAS,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAGjC;AAED,qBAAa,2BAA2B,CACtC,aAAa,SAAS,MAAM,EAC5B,QAAQ,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE;aAQvC,aAAa,EAAE,aAAa;aAC5B,QAAQ,EAAE,QAAQ;IAPpC,SAAgB,KAAK,EAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAA;IACjD,OAAO,CAAC,OAAO,CAAkB;IAEjC,OAAO,CAAC,IAAI,CAAiC;gBAG3B,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,QAAQ;IAsBpC,6DAA6D;IAC7D,UAAU,CAAC,IAAI,EAAE,GAAG,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,SAAS;IAOjD,OAAO,CAAC,OAAO;IAmCf,KAAK,CAAC,IAAI,EAAE,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;IAM3C,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC;IAI1D,UAAU,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC;IAM/D,cAAc,CACZ,IAAI,EAAE,GAAG,GACR,OAAO,CAAC,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAItD,SAAS,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CASjC"}