vest 4.2.2 → 4.3.1

package/types/promisify.d.ts

@@ -1,28 +1,32 @@
 /**
  * Reads the testObjects list and gets full validation result from it.
  */
-declare function genTestsSummary(): TTestSummary;
-type TTestSummary = {
-    groups: Record<string, TTestGroup>;
-    tests: TTestGroup;
-} & TTestSummaryBase;
-type TTestGroup = Record<string, TSingleTestSummary>;
-type TSingleTestSummary = {
+declare function genTestsSummary(): SuiteSummary;
+type Groups = Record<string, TestGroup>;
+type SuiteSummary = {
+    groups: Groups;
+    tests: TestGroup;
+    valid: boolean;
+} & SummaryBase;
+type TestGroup = Record<string, SingleTestSummary>;
+type SingleTestSummary = SummaryBase & {
     errors: string[];
     warnings: string[];
-} & TTestSummaryBase;
-type TTestSummaryBase = {
+    valid: boolean;
+};
+type SummaryBase = {
     errorCount: number;
     warnCount: number;
     testCount: number;
 };
-declare function getErrors(): Record<string, string[]>;
+type FailureMessages = Record<string, string[]>;
+declare function getErrors(): FailureMessages;
 declare function getErrors(fieldName?: string): string[];
-declare function getWarnings(): Record<string, string[]>;
+declare function getWarnings(): FailureMessages;
 declare function getWarnings(fieldName?: string): string[];
-declare function getErrorsByGroup(groupName: string): Record<string, string[]>;
+declare function getErrorsByGroup(groupName: string): FailureMessages;
 declare function getErrorsByGroup(groupName: string, fieldName: string): string[];
-declare function getWarningsByGroup(groupName: string): Record<string, string[]>;
+declare function getWarningsByGroup(groupName: string): FailureMessages;
 declare function getWarningsByGroup(groupName: string, fieldName: string): string[];
 declare function hasErrors(fieldName?: string): boolean;
 declare function hasWarnings(fieldName?: string): boolean;
@@ -45,9 +49,9 @@ type SuiteResult = ReturnType<typeof genTestsSummary> & {
     getWarningsByGroup: typeof getWarningsByGroup;
 };
 type SuiteRunResult = SuiteResult & {
-    done: IDone;
+    done: Done;
 };
-interface IDone {
+interface Done {
     (...args: [
         cb: (res: SuiteResult) => void
     ]): SuiteRunResult;

package/types/vest.d.ts

@@ -5,20 +5,20 @@ declare enum TestSeverity {
 }
 declare class VestTest {
     fieldName: string;
-    testFn: TTestFn;
-    asyncTest?: TAsyncTest;
+    testFn: TestFn;
+    asyncTest?: AsyncTest;
     groupName?: string;
     message?: string;
     key?: null | string;
     id: string;
     severity: TestSeverity;
     status: KStatus;
-    constructor(fieldName: string, testFn: TTestFn, { message, groupName, key }?: {
+    constructor(fieldName: string, testFn: TestFn, { message, groupName, key }?: {
         message?: string;
         groupName?: string;
         key?: string;
     });
-    run(): TTestResult;
+    run(): TestResult;
     setStatus(status: KStatus): void;
     warns(): boolean;
     setPending(): void;
@@ -44,35 +44,40 @@ declare class VestTest {
     isWarning(): boolean;
     statusEquals(status: KStatus): boolean;
 }
-type TAsyncTest = Promise<string | void>;
-type TTestResult = TAsyncTest | boolean | void;
-type TTestFn = () => TTestResult;
+type AsyncTest = Promise<string | void>;
+type TestResult = AsyncTest | boolean | void;
+type TestFn = () => TestResult;
 type KStatus = "UNTESTED" | "SKIPPED" | "FAILED" | "WARNING" | "PASSING" | "PENDING" | "CANCELED" | "OMITTED";
+type CB = (...args: any[]) => void;
 /**
  * Reads the testObjects list and gets full validation result from it.
  */
-declare function genTestsSummary(): TTestSummary;
-type TTestSummary = {
-    groups: Record<string, TTestGroup>;
-    tests: TTestGroup;
-} & TTestSummaryBase;
-type TTestGroup = Record<string, TSingleTestSummary>;
-type TSingleTestSummary = {
+declare function genTestsSummary(): SuiteSummary;
+type Groups = Record<string, TestGroup>;
+type SuiteSummary = {
+    groups: Groups;
+    tests: TestGroup;
+    valid: boolean;
+} & SummaryBase;
+type TestGroup = Record<string, SingleTestSummary>;
+type SingleTestSummary = SummaryBase & {
     errors: string[];
     warnings: string[];
-} & TTestSummaryBase;
-type TTestSummaryBase = {
+    valid: boolean;
+};
+type SummaryBase = {
     errorCount: number;
     warnCount: number;
     testCount: number;
 };
-declare function getErrors(): Record<string, string[]>;
+type FailureMessages = Record<string, string[]>;
+declare function getErrors(): FailureMessages;
 declare function getErrors(fieldName?: string): string[];
-declare function getWarnings(): Record<string, string[]>;
+declare function getWarnings(): FailureMessages;
 declare function getWarnings(fieldName?: string): string[];
-declare function getErrorsByGroup(groupName: string): Record<string, string[]>;
+declare function getErrorsByGroup(groupName: string): FailureMessages;
 declare function getErrorsByGroup(groupName: string, fieldName: string): string[];
-declare function getWarningsByGroup(groupName: string): Record<string, string[]>;
+declare function getWarningsByGroup(groupName: string): FailureMessages;
 declare function getWarningsByGroup(groupName: string, fieldName: string): string[];
 declare function hasErrors(fieldName?: string): boolean;
 declare function hasWarnings(fieldName?: string): boolean;
@@ -95,9 +100,9 @@ type SuiteResult = ReturnType<typeof genTestsSummary> & {
     getWarningsByGroup: typeof getWarningsByGroup;
 };
 type SuiteRunResult = SuiteResult & {
-    done: IDone;
+    done: Done;
 };
-interface IDone {
+interface Done {
     (...args: [
         cb: (res: SuiteResult) => void
     ]): SuiteRunResult;
@@ -112,8 +117,7 @@ type CreateProperties = {
     resetField: (fieldName: string) => void;
     remove: (fieldName: string) => void;
 };
-type CB = (...args: any[]) => void;
-type SuiteReturnType<T extends CB> = {
+type Suite<T extends CB> = {
     (...args: Parameters<T>): SuiteRunResult;
 } & CreateProperties;
 /**
@@ -127,8 +131,8 @@ type SuiteReturnType<T extends CB> = {
  *  });
  * });
  */
-declare function create<T extends CB>(suiteName: string, suiteCallback: T): SuiteReturnType<T>;
-declare function create<T extends CB>(suiteCallback: T): SuiteReturnType<T>;
+declare function create<T extends CB>(suiteName: string, suiteCallback: T): Suite<T>;
+declare function create<T extends CB>(suiteCallback: T): Suite<T>;
 declare function createCursor(): {
     addLevel: () => void;
     cursorAt: () => number;
@@ -155,35 +159,35 @@ declare enum Modes {
 }
 type NestedArray<T> = Array<NestedArray<T> | T>;
 // eslint-disable-next-line max-lines-per-function
-declare function createState(onStateChange?: (...args: unknown[]) => unknown): TCreateStateReturn;
-type TStateInput<S> = S | ((prevState?: S) => S);
-type TSetStateInput<S> = S | ((prevState: S) => S);
-type TState = ReturnType<typeof createState>;
-type TStateHandlerReturn<S> = [
+declare function createState(onStateChange?: (...args: unknown[]) => unknown): CreateStateReturn;
+type StateInput<S> = S | ((prevState?: S) => S);
+type SetStateInput<S> = S | ((prevState: S) => S);
+type State = ReturnType<typeof createState>;
+type StateHandlerReturn<S> = [
     S,
-    (nextState: TSetStateInput<S>) => void
+    (nextState: SetStateInput<S>) => void
 ];
-type TCreateStateReturn = {
+type CreateStateReturn = {
     reset: () => void;
-    registerStateKey: <S>(initialState?: TStateInput<S> | undefined, onUpdate?: (() => void) | undefined) => () => TStateHandlerReturn<S>;
+    registerStateKey: <S>(initialState?: StateInput<S> | undefined, onUpdate?: (() => void) | undefined) => () => StateHandlerReturn<S>;
 };
-declare function createStateRef(state: TState, { suiteId, suiteName }: {
+declare function createStateRef(state: State, { suiteId, suiteName }: {
     suiteId: string;
     suiteName?: void | string;
 }): {
-    optionalFields: () => TStateHandlerReturn<Record<string, boolean | (() => boolean)>>;
-    suiteId: () => TStateHandlerReturn<string>;
-    suiteName: () => TStateHandlerReturn<string | void>;
-    testCallbacks: () => TStateHandlerReturn<{
+    optionalFields: () => StateHandlerReturn<Record<string, boolean | (() => boolean)>>;
+    suiteId: () => StateHandlerReturn<string>;
+    suiteName: () => StateHandlerReturn<string | void>;
+    testCallbacks: () => StateHandlerReturn<{
         fieldCallbacks: Record<string, ((res: SuiteResult) => void)[]>;
         doneCallbacks: ((res: SuiteResult) => void)[];
     }>;
-    testObjects: () => TStateHandlerReturn<{
+    testObjects: () => StateHandlerReturn<{
         prev: NestedArray<VestTest>;
         current: NestedArray<VestTest>;
     }>;
 };
-type TStateRef = ReturnType<typeof createStateRef>;
+type StateRef = ReturnType<typeof createStateRef>;
 declare const _default: {
     run: <R>(ctxRef: Partial<CTXType>, fn: (context: CTXType) => R) => R;
     bind: <Fn extends (...args: any[]) => any>(ctxRef: Partial<CTXType>, fn: Fn) => Fn;
@@ -196,7 +200,7 @@ type CTXType = {
         keys: IsolateKeys;
     };
     testCursor: ReturnType<typeof createCursor>;
-    stateRef?: TStateRef;
+    stateRef?: StateRef;
     exclusion: {
         tests: Record<string, boolean>;
         groups: Record<string, boolean>;
@@ -210,11 +214,12 @@ type CTXType = {
         Modes
     ];
     bus?: {
-        on: (event: string, handler: (...args: any[]) => void) => {
+        on: (event: string, handler: CB) => {
             off: () => void;
         };
         emit: (event: string, ...args: any[]) => void;
     };
+    summary?: SuiteSummary;
 };
 declare const context: typeof _default;
 /**
@@ -231,7 +236,7 @@ declare const context: typeof _default;
  * })
  */
 declare function each<T>(list: T[], callback: (arg: T, index: number) => void): void;
-type TExclusionItem = string | string[] | undefined;
+type ExclusionItem = string | string[] | undefined;
 /**
  * Adds a field or a list of fields into the inclusion list
  *
@@ -239,9 +244,9 @@ type TExclusionItem = string | string[] | undefined;
  *
  * only('username');
  */
-declare function only(item: TExclusionItem): void;
+declare function only(item: ExclusionItem): void;
 declare namespace only {
-    var group: (item: TExclusionItem) => void;
+    var group: (item: ExclusionItem) => void;
 }
 /**
  * Adds a field or a list of fields into the exclusion list
@@ -250,9 +255,9 @@ declare namespace only {
  *
  * skip('username');
  */
-declare function skip(item: TExclusionItem): void;
+declare function skip(item: ExclusionItem): void;
 declare namespace skip {
-    var group: (item: TExclusionItem) => void;
+    var group: (item: ExclusionItem) => void;
 }
 /**
  * Runs tests within a group so that they can be controlled or queried separately.
@@ -296,7 +301,7 @@ declare function eager(): void;
  *  test('username', 'User already taken', async () => await doesUserExist(username)
  * });
  */
-declare function omitWhen(conditional: boolean | ((draft: SuiteResult) => boolean), callback: (...args: any[]) => void): void;
+declare function omitWhen(conditional: boolean | ((draft: SuiteResult) => boolean), callback: CB): void;
 /**
  * Marks a field as optional, either just by name, or by a given condition.
  *
@@ -308,9 +313,9 @@ declare function omitWhen(conditional: boolean | ((draft: SuiteResult) => boolea
  *  username: () => allowUsernameEmpty,
  * });
  */
-declare function optional(optionals: TOptionalsInput): void;
-type TOptionalsInput = string | string[] | TOptionalsObject;
-type TOptionalsObject = Record<string, () => boolean>;
+declare function optional(optionals: OptionalsInput): void;
+type OptionalsInput = string | string[] | OptionalsObject;
+type OptionalsObject = Record<string, () => boolean>;
 /**
  * Conditionally skips running tests within the callback.
  *
@@ -320,11 +325,11 @@ type TOptionalsObject = Record<string, () => boolean>;
  *  test('username', 'User already taken', async () => await doesUserExist(username)
  * });
  */
-declare function skipWhen(conditional: boolean | ((draft: SuiteResult) => 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 function skipWhen(conditional: boolean | ((draft: SuiteResult) => boolean), callback: CB): void;
+declare function testBase(fieldName: string, message: string, cb: TestFn): VestTest;
+declare function testBase(fieldName: string, cb: TestFn): VestTest;
+declare function testBase(fieldName: string, message: string, cb: TestFn, key: string): VestTest;
+declare function testBase(fieldName: string, cb: TestFn, key: string): VestTest;
 /**
  * Represents a single case in a validation suite.
  *
@@ -336,14 +341,14 @@ declare function testBase(fieldName: string, cb: TTestFn, key: string): VestTest
  */
 declare const test: typeof testBase & {
     memo: {
-        (fieldName: string, test: TTestFn, deps: unknown[]): VestTest;
-        (fieldName: string, message: string, test: TTestFn, deps: unknown[]): VestTest;
+        (fieldName: string, test: TestFn, deps: unknown[]): VestTest;
+        (fieldName: string, message: string, test: TestFn, deps: unknown[]): VestTest;
     };
 };
 /**
  * Sets a running test to warn only mode.
  */
 declare function warn(): void;
-declare const VERSION = "4.2.2";
+declare const VERSION = "4.3.1";
 export { test, create, each, only, skip, warn, group, optional, skipWhen, omitWhen, enforce, VERSION, context, include, eager };
-export type { SuiteResult, SuiteRunResult, VestTest };
+export type { SuiteResult, SuiteRunResult, SuiteSummary, VestTest, Suite };