vest 4.3.2 → 4.4.0-dev-08ec91

package/types/vest.d.ts

@@ -58,16 +58,14 @@ type SuiteSummary = {
     tests: Tests;
     valid: boolean;
 } & SummaryBase;
-type GroupTestSummary = BaseTestSummary;
+type GroupTestSummary = SingleTestSummary;
 type Groups = Record<string, Group>;
 type Group = Record<string, GroupTestSummary>;
 type Tests = Record<string, SingleTestSummary>;
-type SingleTestSummary = BaseTestSummary & {
-    valid: boolean;
-};
-type BaseTestSummary = SummaryBase & {
+type SingleTestSummary = SummaryBase & {
     errors: string[];
     warnings: string[];
+    valid: boolean;
 };
 type SummaryBase = {
     errorCount: number;
@@ -87,13 +85,16 @@ 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: (fieldName?: string) => boolean;
+    isValid: typeof isValid;
+    isValidByGroup: typeof isValidByGroup;
     hasErrors: typeof hasErrors;
     hasWarnings: typeof hasWarnings;
     getErrors: typeof getErrors;
@@ -137,7 +138,7 @@ type Suite<T extends CB> = {
  */
 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(): {
+type Cursor = {
     addLevel: () => void;
     cursorAt: () => number;
     getCursor: () => number[];
@@ -162,36 +163,32 @@ declare enum Modes {
     EAGER = 1
 }
 type NestedArray<T> = Array<NestedArray<T> | T>;
-// eslint-disable-next-line max-lines-per-function
-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: SetStateInput<S>) => void
 ];
-type CreateStateReturn = {
-    reset: () => void;
-    registerStateKey: <S>(initialState?: StateInput<S> | undefined, onUpdate?: (() => void) | undefined) => () => StateHandlerReturn<S>;
+type UseState<S> = () => StateHandlerReturn<S>;
+type StateRef = {
+    optionalFields: UseState<OptionalFields>;
+    suiteId: UseState<string>;
+    suiteName: UseState<SuiteName>;
+    testCallbacks: UseState<TestCallbacks>;
+    testObjects: UseState<TestObjects>;
+};
+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>;
 };
-declare function createStateRef(state: State, { suiteId, suiteName }: {
-    suiteId: string;
-    suiteName?: void | string;
-}): {
-    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: () => StateHandlerReturn<{
-        prev: NestedArray<VestTest>;
-        current: NestedArray<VestTest>;
-    }>;
+type TestObjects = {
+    prev: NestedArray<VestTest>;
+    current: NestedArray<VestTest>;
 };
-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;
@@ -203,7 +200,7 @@ type CTXType = {
         type: IsolateTypes;
         keys: IsolateKeys;
     };
-    testCursor: ReturnType<typeof createCursor>;
+    testCursor: Cursor;
     stateRef?: StateRef;
     exclusion: {
         tests: Record<string, boolean>;
@@ -353,6 +350,6 @@ declare const test: typeof testBase & {
  * Sets a running test to warn only mode.
  */
 declare function warn(): void;
-declare const VERSION = "4.3.2";
+declare const VERSION = "4.4.0-dev-08ec91";
 export { test, create, each, only, skip, warn, group, optional, skipWhen, omitWhen, enforce, VERSION, context, include, eager };
 export type { SuiteResult, SuiteRunResult, SuiteSummary, VestTest, Suite };