vest 4.0.0-dev-31f012 → 4.0.0-dev-e266d9

package/types/enforce/schema.d.ts

@@ -0,0 +1,151 @@
+type DropFirst<T extends unknown[]> = T extends [
+    unknown,
+    ...infer U
+] ? U : never;
+type TStringable = string | ((...args: any[]) => string);
+type TRuleReturn = boolean | {
+    pass: boolean;
+    message?: TStringable;
+};
+type TRuleDetailedResult = {
+    pass: boolean;
+    message?: string;
+};
+type TArgs = any[];
+type TBaseRules = typeof baseRules;
+type KBaseRules = keyof TBaseRules;
+declare function condition(value: any, callback: (value: any) => TRuleReturn): TRuleReturn;
+declare function endsWith(value: string, arg1: string): boolean;
+declare function equals(value: unknown, arg1: unknown): boolean;
+declare function greaterThan(value: number | string, gt: number | string): boolean;
+declare function greaterThanOrEquals(value: string | number, gte: string | number): boolean;
+declare function inside(value: unknown, arg1: string | unknown[]): boolean;
+// The module is named "isArrayValue" since it
+// is conflicting with a nested npm dependency.
+// We may need to revisit this in the future.
+declare function isArray(value: unknown): value is Array<unknown>;
+declare function isBetween(value: number | string, min: number | string, max: number | string): boolean;
+declare function isBlank(value: unknown): boolean;
+declare function isBoolean(value: unknown): value is boolean;
+declare function isEmpty(value: unknown): boolean;
+declare function isNaN(value: unknown): boolean;
+declare function isNegative(value: number | string): boolean;
+declare function isNull(value: unknown): value is null;
+declare function isNullish(value: any): value is null | undefined;
+declare function isNumber(value: unknown): value is number;
+declare function isNumeric(value: string | number): boolean;
+declare function isStringValue(v: unknown): v is string;
+declare function isTruthy(value: unknown): boolean;
+declare function isUndefined(value?: unknown): boolean;
+declare function lengthEquals(value: string | unknown[], arg1: string | number): boolean;
+declare function lessThan(value: string | number, lt: string | number): boolean;
+declare function lessThanOrEquals(value: string | number, lte: string | number): boolean;
+declare function longerThan(value: string | unknown[], arg1: string | number): boolean;
+declare function longerThanOrEquals(value: string | unknown[], arg1: string | number): boolean;
+declare function matches(value: string, regex: RegExp | string): boolean;
+declare function numberEquals(value: string | number, eq: string | number): boolean;
+declare function shorterThan(value: string | unknown[], arg1: string | number): boolean;
+declare function shorterThanOrEquals(value: string | unknown[], arg1: string | number): boolean;
+declare function startsWith(value: string, arg1: string): boolean;
+declare const baseRules: {
+    condition: typeof condition;
+    doesNotEndWith: (value: string, arg1: string) => boolean;
+    doesNotStartWith: (value: string, arg1: string) => boolean;
+    endsWith: typeof endsWith;
+    equals: typeof equals;
+    greaterThan: typeof greaterThan;
+    greaterThanOrEquals: typeof greaterThanOrEquals;
+    gt: typeof greaterThan;
+    gte: typeof greaterThanOrEquals;
+    inside: typeof inside;
+    isArray: typeof isArray;
+    isBetween: typeof isBetween;
+    isBlank: typeof isBlank;
+    isBoolean: typeof isBoolean;
+    isEmpty: typeof isEmpty;
+    isEven: (value: any) => boolean;
+    isFalsy: (value: unknown) => boolean;
+    isNaN: typeof isNaN;
+    isNegative: typeof isNegative;
+    isNotArray: (value: unknown) => boolean;
+    isNotBetween: (value: string | number, min: string | number, max: string | number) => boolean;
+    isNotBlank: (value: unknown) => boolean;
+    isNotBoolean: (value: unknown) => boolean;
+    isNotEmpty: (value: unknown) => boolean;
+    isNotNaN: (value: unknown) => boolean;
+    isNotNull: (value: unknown) => boolean;
+    isNotNullish: (value: any) => boolean;
+    isNotNumber: (value: unknown) => boolean;
+    isNotNumeric: (value: string | number) => boolean;
+    isNotString: (v: unknown) => boolean;
+    isNotUndefined: (value?: unknown) => boolean;
+    isNull: typeof isNull;
+    isNullish: typeof isNullish;
+    isNumber: typeof isNumber;
+    isNumeric: typeof isNumeric;
+    isOdd: (value: any) => boolean;
+    isPositive: (value: string | number) => boolean;
+    isString: typeof isStringValue;
+    isTruthy: typeof isTruthy;
+    isUndefined: typeof isUndefined;
+    lengthEquals: typeof lengthEquals;
+    lengthNotEquals: (value: string | unknown[], arg1: string | number) => boolean;
+    lessThan: typeof lessThan;
+    lessThanOrEquals: typeof lessThanOrEquals;
+    longerThan: typeof longerThan;
+    longerThanOrEquals: typeof longerThanOrEquals;
+    lt: typeof lessThan;
+    lte: typeof lessThanOrEquals;
+    matches: typeof matches;
+    notEquals: (value: unknown, arg1: unknown) => boolean;
+    notInside: (value: unknown, arg1: string | unknown[]) => boolean;
+    notMatches: (value: string, regex: string | RegExp) => boolean;
+    numberEquals: typeof numberEquals;
+    numberNotEquals: (value: string | number, eq: string | number) => boolean;
+    shorterThan: typeof shorterThan;
+    shorterThanOrEquals: typeof shorterThanOrEquals;
+    startsWith: typeof startsWith;
+};
+type TRules<E = Record<string, unknown>> = n4s.EnforceCustomMatchers<TRules<E> & E> & Record<string, (...args: TArgs) => TRules<E> & E> & {
+    [P in KBaseRules]: (...args: DropFirst<Parameters<TBaseRules[P]>> | TArgs) => TRules<E> & E;
+};
+/* eslint-disable @typescript-eslint/no-namespace, @typescript-eslint/no-empty-interface */
+declare global {
+    namespace n4s {
+        interface IRules<E> extends TRules<E> {
+        }
+    }
+}
+type TLazyRules = n4s.IRules<TLazyRuleMethods>;
+type TLazy = TLazyRules & TLazyRuleMethods & 
+// This is a "catch all" hack to make TS happy while not
+// losing type hints
+Record<string, (...args: any[]) => any>;
+interface IShapeObject extends Record<string, any>, Record<string, TLazyRuleRunners> {
+}
+type TLazyRuleMethods = TLazyRuleRunners & {
+    message: (message: TLazyMessage) => TLazy;
+};
+type TLazyRuleRunners = {
+    test: (value: unknown) => boolean;
+    run: (value: unknown) => TRuleDetailedResult;
+};
+type TLazyMessage = string | ((value: unknown, originalMessage?: TStringable) => string);
+declare function isArrayOf(inputArray: any[], currentRule: TLazy): TRuleDetailedResult;
+declare function loose(inputObject: Record<string, any>, shapeObject: IShapeObject): TRuleDetailedResult;
+declare function optional(value: any, ruleChain: TLazy): TRuleDetailedResult;
+declare function shape(inputObject: Record<string, any>, shapeObject: IShapeObject): TRuleDetailedResult;
+// Help needed improving the typings of this file.
+// Ideally, we'd be able to extend IShapeObject, but that's not possible.
+declare function partial<T extends Record<any, any>>(shapeObject: T): T;
+declare global {
+    namespace n4s {
+        interface EnforceCustomMatchers<R> {
+            isArrayOf: (...args: DropFirst<Parameters<typeof isArrayOf>>) => R;
+            loose: (...args: DropFirst<Parameters<typeof loose>>) => R;
+            shape: (...args: DropFirst<Parameters<typeof shape>>) => R;
+            optional: (...args: DropFirst<Parameters<typeof optional>>) => R;
+        }
+    }
+}
+export { partial };

package/types/vest.d.ts

@@ -1,181 +1,4 @@
-type TEnforceContext = null | {
-    meta: Record<string, any>;
-    value: any;
-    parent: () => TEnforceContext;
-};
-type DropFirst<T extends unknown[]> = T extends [
-    unknown,
-    ...infer U
-] ? U : never;
-type TStringable = string | ((...args: any[]) => string);
-type TRuleReturn = boolean | {
-    pass: boolean;
-    message?: TStringable;
-};
-type TRuleDetailedResult = {
-    pass: boolean;
-    message?: string;
-};
-type TLazyRules = TRules<TLazyRuleMethods>;
-type TLazy = TLazyRules & TLazyRuleMethods;
-type TShapeObject = Record<any, TLazy>;
-type TLazyRuleMethods = TLazyRuleRunners & {
-    message: (message: TLazyMessage) => TLazy;
-};
-type TLazyRuleRunners = {
-    test: (value: unknown) => boolean;
-    run: (value: unknown) => TRuleDetailedResult;
-};
-type TLazyMessage = string | ((value: unknown, originalMessage?: TStringable) => string);
-declare function allOf(value: unknown, ...rules: TLazy[]): TRuleDetailedResult;
-declare function anyOf(value: unknown, ...rules: TLazy[]): TRuleDetailedResult;
-declare function noneOf(value: unknown, ...rules: TLazy[]): TRuleDetailedResult;
-declare function oneOf(value: unknown, ...rules: TLazy[]): TRuleDetailedResult;
-declare function optional(value: any, ruleChain: TLazy): TRuleDetailedResult;
-declare function compounds(): {
-    allOf: typeof allOf;
-    anyOf: typeof anyOf;
-    noneOf: typeof noneOf;
-    oneOf: typeof oneOf;
-    optional: typeof optional;
-};
-type TCompounds = ReturnType<typeof compounds>;
-type KCompounds = keyof TCompounds;
-type TArgs = any[];
-type TRuleValue = any;
-type TRuleBase = (value: TRuleValue, ...args: TArgs) => TRuleReturn;
-type TRule = Record<string, TRuleBase>;
-type TBaseRules = typeof baseRules;
-type KBaseRules = keyof TBaseRules;
-declare function condition(value: any, callback: (value: any) => TRuleReturn): TRuleReturn;
-declare function endsWith(value: string, arg1: string): boolean;
-declare function equals(value: unknown, arg1: unknown): boolean;
-declare function greaterThan(value: number | string, gt: number | string): boolean;
-declare function greaterThanOrEquals(value: string | number, gte: string | number): boolean;
-declare function inside(value: unknown, arg1: string | unknown[]): boolean;
-// The module is named "isArrayValue" since it
-// is conflicting with a nested npm dependency.
-// We may need to revisit this in the future.
-declare function isArray(value: unknown): value is Array<unknown>;
-declare function isBetween(value: number | string, min: number | string, max: number | string): boolean;
-declare function isBlank(value: unknown): boolean;
-declare function isBoolean(value: unknown): value is boolean;
-declare function isEmpty(value: unknown): boolean;
-declare function isNaN(value: unknown): boolean;
-declare function isNegative(value: number | string): boolean;
-declare function isNull(value: unknown): value is null;
-declare function isNumber(value: unknown): value is number;
-declare function isNumeric(value: string | number): boolean;
-declare function isStringValue(v: unknown): v is string;
-declare function isTruthy(value: unknown): boolean;
-declare function isUndefined(value?: unknown): boolean;
-declare function lengthEquals(value: string | unknown[], arg1: string | number): boolean;
-declare function lessThan(value: string | number, lt: string | number): boolean;
-declare function lessThanOrEquals(value: string | number, lte: string | number): boolean;
-declare function longerThan(value: string | unknown[], arg1: string | number): boolean;
-declare function longerThanOrEquals(value: string | unknown[], arg1: string | number): boolean;
-declare function matches(value: string, regex: RegExp | string): boolean;
-declare function numberEquals(value: string | number, eq: string | number): boolean;
-declare function shorterThan(value: string | unknown[], arg1: string | number): boolean;
-declare function shorterThanOrEquals(value: string | unknown[], arg1: string | number): boolean;
-declare function startsWith(value: string, arg1: string): boolean;
-declare function shape(inputObject: Record<string, any>, shapeObject: TShapeObject): TRuleDetailedResult;
-declare function loose(inputObject: Record<string, any>, shapeObject: TShapeObject): TRuleDetailedResult;
-declare function isArrayOf(inputArray: any[], currentRule: TLazy): TRuleDetailedResult;
-declare const baseRules: {
-    condition: typeof condition;
-    doesNotEndWith: (value: string, arg1: string) => boolean;
-    doesNotStartWith: (value: string, arg1: string) => boolean;
-    endsWith: typeof endsWith;
-    equals: typeof equals;
-    greaterThan: typeof greaterThan;
-    greaterThanOrEquals: typeof greaterThanOrEquals;
-    gt: typeof greaterThan;
-    gte: typeof greaterThanOrEquals;
-    inside: typeof inside;
-    isArray: typeof isArray;
-    isBetween: typeof isBetween;
-    isBlank: typeof isBlank;
-    isBoolean: typeof isBoolean;
-    isEmpty: typeof isEmpty;
-    isEven: (value: any) => boolean;
-    isFalsy: (value: unknown) => boolean;
-    isNaN: typeof isNaN;
-    isNegative: typeof isNegative;
-    isNotArray: (value: unknown) => boolean;
-    isNotBetween: (value: string | number, min: string | number, max: string | number) => boolean;
-    isNotBlank: (value: unknown) => boolean;
-    isNotBoolean: (value: unknown) => boolean;
-    isNotEmpty: (value: unknown) => boolean;
-    isNotNaN: (value: unknown) => boolean;
-    isNotNull: (value: unknown) => boolean;
-    isNotNumber: (value: unknown) => boolean;
-    isNotNumeric: (value: string | number) => boolean;
-    isNotString: (v: unknown) => boolean;
-    isNotUndefined: (value?: unknown) => boolean;
-    isNull: typeof isNull;
-    isNumber: typeof isNumber;
-    isNumeric: typeof isNumeric;
-    isOdd: (value: any) => boolean;
-    isPositive: (value: string | number) => boolean;
-    isString: typeof isStringValue;
-    isTruthy: typeof isTruthy;
-    isUndefined: typeof isUndefined;
-    lengthEquals: typeof lengthEquals;
-    lengthNotEquals: (value: string | unknown[], arg1: string | number) => boolean;
-    lessThan: typeof lessThan;
-    lessThanOrEquals: typeof lessThanOrEquals;
-    longerThan: typeof longerThan;
-    longerThanOrEquals: typeof longerThanOrEquals;
-    lt: typeof lessThan;
-    lte: typeof lessThanOrEquals;
-    matches: typeof matches;
-    notEquals: (value: unknown, arg1: unknown) => boolean;
-    notInside: (value: unknown, arg1: string | unknown[]) => boolean;
-    notMatches: (value: string, regex: string | RegExp) => boolean;
-    numberEquals: typeof numberEquals;
-    numberNotEquals: (value: string | number, eq: string | number) => boolean;
-    shorterThan: typeof shorterThan;
-    shorterThanOrEquals: typeof shorterThanOrEquals;
-    startsWith: typeof startsWith;
-} & {
-    allOf: typeof allOf;
-    anyOf: typeof anyOf;
-    noneOf: typeof noneOf;
-    oneOf: typeof oneOf;
-    optional: typeof optional;
-} & {
-    shape: typeof shape;
-    loose: typeof loose;
-    isArrayOf: typeof isArrayOf;
-};
-/* eslint-disable @typescript-eslint/no-namespace, @typescript-eslint/no-empty-interface */
-declare global {
-    namespace n4s {
-        interface EnforceCustomMatchers<R> {
-        }
-    }
-}
-type TRules<E = Record<string, unknown>> = n4s.EnforceCustomMatchers<TRules & E> & Record<string, (...args: TArgs) => TRules & E> & {
-    [P in KCompounds]: (...args: DropFirst<Parameters<TCompounds[P]>> | TArgs) => TRules & E;
-} & {
-    [P in KBaseRules]: (...args: DropFirst<Parameters<TBaseRules[P]>> | TArgs) => TRules & E;
-};
-declare function enforceEager(value: TRuleValue): TRules;
-type TEnforceEager = typeof enforceEager;
-// Help needed improving the typings of this file.
-// Ideally, we'd be able to extend TShapeObject, but that's not possible.
-declare function partial<T extends Record<any, any>>(shapeObject: T): T;
-declare function modifiers(): {
-    partial: typeof partial;
-};
-type TModifiers = ReturnType<typeof modifiers>;
-declare const enforce: TEnforce;
-type TEnforce = TEnforceEager & TLazyRules & TEnforceMethods;
-type TEnforceMethods = TModifiers & {
-    context: () => TEnforceContext;
-    extend: (customRules: TRule) => void;
-};
+import { enforce } from 'n4s';
 /**
  * Reads the testObjects list and gets full validation result from it.
  */
@@ -234,34 +57,46 @@ interface IDone {
         cb: (res: TDraftResult) => void
     ]): IVestResult;
 }
-// eslint-disable-next-line max-lines-per-function
-declare function create<T extends (...args: any[]) => void>(suiteCallback: T): {
-    (...args: Parameters<T>): IVestResult;
+type CreateProperties = {
     get: () => TDraftResult;
     reset: () => void;
     remove: (fieldName: string) => void;
 };
+type CB = (...args: any[]) => void;
+type SuiteReturnType<T extends CB> = {
+    (...args: Parameters<T>): IVestResult;
+} & CreateProperties;
+declare function create<T extends CB>(suiteName: string, suiteCallback: T): SuiteReturnType<T>;
+declare function create<T extends CB>(suiteCallback: T): SuiteReturnType<T>;
+declare function each<T>(list: T[], callback: (arg: T, index: number) => void): void;
+declare enum TestSeverity {
+    Error = "error",
+    Warning = "warning"
+}
 declare class VestTest {
     fieldName: string;
     testFn: TTestFn;
     asyncTest?: TAsyncTest;
     groupName?: string;
     message?: string;
+    key?: null | string;
     id: string;
-    warns: boolean;
+    severity: TestSeverity;
     status: KStatus;
-    constructor(fieldName: string, testFn: TTestFn, { message, groupName }?: {
+    constructor(fieldName: string, testFn: TTestFn, { message, groupName, key }?: {
         message?: string;
         groupName?: string;
+        key?: string;
     });
     run(): TTestResult;
     setStatus(status: KStatus): void;
+    warns(): boolean;
     setPending(): void;
     fail(): void;
     done(): void;
     warn(): void;
     isFinalStatus(): boolean;
-    skip(): void;
+    skip(force?: boolean): void;
     cancel(): void;
     omit(): void;
     valueOf(): boolean;
@@ -295,35 +130,28 @@ declare function skip(item: TExclusionItem): void;
 declare namespace skip {
     var group: (item: TExclusionItem) => void;
 }
-declare function skipWhen(conditional: boolean | ((...args: any[]) => boolean), callback: (...args: any[]) => void): void;
-/**
- * Sets a running test to warn only mode.
- */
-declare function warn(): void;
 /**
  * Runs a group callback.
  */
 declare function group(groupName: string, tests: () => void): void;
-declare function optional$0(optionals: TOptionalsInput): void;
+declare function optional(optionals: TOptionalsInput): void;
 type TOptionalsInput = string | string[] | TOptionalsObject;
 type TOptionalsObject = Record<string, () => boolean>;
-declare function testBase(fieldName: string, ...args: [
-    message: string,
-    cb: TTestFn
-]): VestTest;
-declare function testBase(fieldName: string, ...args: [
-    cb: TTestFn
-]): VestTest;
+declare function skipWhen(conditional: boolean | ((draft: TDraftResult) => boolean), callback: (...args: any[]) => void): void;
+declare function testBase(fieldName: string, message: string, cb: TTestFn): VestTest;
+declare function testBase(fieldName: string, cb: TTestFn): VestTest;
+declare function testBase(fieldName: string, message: string, cb: TTestFn, key: string): VestTest;
+declare function testBase(fieldName: string, cb: TTestFn, key: string): VestTest;
 declare const _default: typeof testBase & {
-    each: (table: any[]) => {
-        (fieldName: TStringable, message: TStringable, cb: (...args: any[]) => TTestResult): VestTest[];
-        (fieldName: TStringable, cb: (...args: any[]) => TTestResult): VestTest[];
-    };
     memo: {
         (fieldName: string, test: TTestFn, deps: unknown[]): VestTest;
         (fieldName: string, message: string, test: TTestFn, deps: unknown[]): VestTest;
     };
 };
 declare const test: typeof _default;
-declare const VERSION = "4.0.0-dev-31f012";
-export { test, create, only, skip, warn, group, optional$0 as optional, skipWhen, enforce, VERSION };
+/**
+ * Sets a running test to warn only mode.
+ */
+declare function warn(): void;
+declare const VERSION = "4.0.0-dev-e266d9";
+export { test, create, each, only, skip, warn, group, optional, skipWhen, enforce, VERSION };