vest 4.4.3-dev-c786f7 → 4.5.0-dev-9b46fb

package/types/vest.d.ts

@@ -1,4 +1,24 @@
 import { enforce } from 'n4s';
+type SuiteSummary = {
+    groups: Groups;
+    tests: Tests;
+    valid: boolean;
+} & SummaryBase;
+type GroupTestSummary = SingleTestSummary;
+type Groups = Record<string, Group>;
+type Group = Record<string, GroupTestSummary>;
+type Tests = Record<string, SingleTestSummary>;
+type SingleTestSummary = SummaryBase & {
+    errors: string[];
+    warnings: string[];
+    valid: boolean;
+};
+type SummaryBase = {
+    errorCount: number;
+    warnCount: number;
+    testCount: number;
+};
+type FailureMessages = Record<string, string[]>;
 declare enum TestSeverity {
     Error = "error",
     Warning = "warning"
@@ -48,61 +68,27 @@ 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(): SuiteSummary;
-type SuiteSummary = {
-    groups: Groups;
-    tests: Tests;
-    valid: boolean;
-} & SummaryBase;
-type GroupTestSummary = SingleTestSummary;
-type Groups = Record<string, Group>;
-type Group = Record<string, GroupTestSummary>;
-type Tests = Record<string, SingleTestSummary>;
-type SingleTestSummary = SummaryBase & {
-    errors: string[];
-    warnings: string[];
-    valid: boolean;
-};
-type SummaryBase = {
-    errorCount: number;
-    warnCount: number;
-    testCount: number;
-};
-type FailureMessages = Record<string, string[]>;
-declare function getErrors(): FailureMessages;
-declare function getErrors(fieldName?: string): string[];
-declare function getWarnings(): FailureMessages;
-declare function getWarnings(fieldName?: string): string[];
-declare function getErrorsByGroup(groupName: string): FailureMessages;
-declare function getErrorsByGroup(groupName: string, fieldName: 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;
-declare function hasErrorsByGroup(groupName: string, fieldName?: string): boolean;
-declare function hasWarningsByGroup(groupName: string, fieldName?: string): boolean;
-declare function isValid(fieldName?: string): boolean;
-declare function isValidByGroup(groupName: string, fieldName?: string): boolean;
-type SuiteResult = ReturnType<typeof genTestsSummary> & {
-    /**
-     * Returns whether the suite as a whole is valid.
-     * Determined if there are no errors, and if no
-     * required fields are skipped.
-     */
-    isValid: typeof isValid;
-    isValidByGroup: typeof isValidByGroup;
-    hasErrors: typeof hasErrors;
-    hasWarnings: typeof hasWarnings;
-    getErrors: typeof getErrors;
-    getWarnings: typeof getWarnings;
-    hasErrorsByGroup: typeof hasErrorsByGroup;
-    hasWarningsByGroup: typeof hasWarningsByGroup;
-    getErrorsByGroup: typeof getErrorsByGroup;
-    getWarningsByGroup: typeof getWarningsByGroup;
+type CB = (...args: any[]) => any;
+// eslint-disable-next-line max-lines-per-function, max-statements
+declare function suiteSelectors(summary: SuiteSummary): SuiteSelectors;
+interface SuiteSelectors {
+    getErrors(fieldName: string): string[];
+    getErrors(): FailureMessages;
+    getWarnings(): FailureMessages;
+    getWarnings(fieldName: string): string[];
+    getErrorsByGroup(groupName: string, fieldName: string): string[];
+    getErrorsByGroup(groupName: string): FailureMessages;
+    getWarningsByGroup(groupName: string): FailureMessages;
+    getWarningsByGroup(groupName: string, fieldName: string): string[];
+    hasErrors(fieldName?: string): boolean;
+    hasWarnings(fieldName?: string): boolean;
+    hasErrorsByGroup(groupName: string, fieldName?: string): boolean;
+    hasWarningsByGroup(groupName: string, fieldName?: string): boolean;
+    isValid(fieldName?: string): boolean;
+    isValidByGroup(groupName: string, fieldName?: string): boolean;
+}
+type SuiteResult = SuiteSummary & SuiteSelectors & {
+    suiteName: SuiteName;
 };
 type SuiteRunResult = SuiteResult & {
     done: Done;
@@ -136,8 +122,9 @@ type Suite<T extends CB> = {
  *  });
  * });
  */
-declare function create<T extends CB>(suiteName: string, suiteCallback: T): Suite<T>;
+declare function create<T extends CB>(suiteName: SuiteName, suiteCallback: T): Suite<T>;
 declare function create<T extends CB>(suiteCallback: T): Suite<T>;
+type SuiteName = string | void;
 type IsolateCursor = {
     current: () => number;
     next: () => void;
@@ -182,7 +169,6 @@ type OptionalFields = Record<string, [
     rule: (() => boolean) | boolean,
     isApplied: boolean
 ]>;
-type SuiteName = string | void;
 type TestCallbacks = {
     fieldCallbacks: Record<string, Array<(res: SuiteResult) => void>>;
     doneCallbacks: Array<(res: SuiteResult) => void>;
@@ -219,7 +205,6 @@ type CTXType = {
         };
         emit: (event: string, ...args: any[]) => void;
     };
-    summary?: SuiteSummary;
 };
 declare const context: typeof _default;
 /**
@@ -349,6 +334,6 @@ declare const test: typeof testBase & {
  * Sets a running test to warn only mode.
  */
 declare function warn(): void;
-declare const VERSION = "4.4.3-dev-c786f7";
-export { test, create, each, only, skip, warn, group, optional, skipWhen, omitWhen, enforce, VERSION, context, include, eager };
+declare const VERSION = "4.5.0-dev-9b46fb";
+export { suiteSelectors, test, create, each, only, skip, warn, group, optional, skipWhen, omitWhen, enforce, VERSION, context, include, eager };
 export type { SuiteResult, SuiteRunResult, SuiteSummary, VestTest, Suite };