testeranto 0.37.2 → 0.38.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "testeranto",
   "description": "teeny tiny tightly-typed typescript tests",
-  "version": "0.37.2",
+  "version": "0.38.0",
   "type": "module",
   "types": "./src/index.d.mts",
   "main": "./src/index.mts",
@@ -9,8 +9,7 @@
     ".": "./src/index.mjs",
     "./src/Project": "./src/Project.js",
     "./src/Features": "./src/Features.js",
-    "./src/Report": "./src/Report.tsx",
-    "./src/kokomoFeatures": "./src/kokomoFeatures.ts"
+    "./src/Report": "./src/Report.tsx"
   },
   "repository": "git@github.com:adamwong246/testeranto.git",
   "homepage": "https://github.com/adamwong246/testeranto",
@@ -66,4 +65,4 @@
     "why-is-node-running": "^2.2.2",
     "why-is-node-still-running": "^1.0.0"
   }
-}
+}

package/src/index.mts

@@ -24,8 +24,8 @@ type IRunner = (x: ITTestResourceConfiguration, t: ITLog) => Promise<boolean>;
 export type IT = {
   toObj(): object;
   name: string;
-  givens: BaseGiven<unknown, unknown, unknown, unknown>[];
-  checks: BaseCheck<unknown, unknown, unknown, unknown, ITTestShape>[];
+  givens: BaseGiven<unknown, unknown, unknown, unknown, Record<string, BaseFeature>>[];
+  checks: BaseCheck<unknown, unknown, unknown, unknown, ITTestShape, unknown>[];
   testResourceConfiguration: ITTestResourceConfiguration
 };
 
@@ -47,21 +47,21 @@ export type ITTestShape = {
   checks;
 };
 
-export type ITestSpecification<ITestShape extends ITTestShape> = (
+export type ITestSpecification<ITestShape extends ITTestShape, IFeatureShape> = (
   Suite: {
     [K in keyof ITestShape["suites"]]: (
       name: string,
-      givens: BaseGiven<unknown, unknown, unknown, unknown>[],
-      checks: BaseCheck<unknown, unknown, unknown, unknown, ITestShape>[]
-    ) => BaseSuite<unknown, unknown, unknown, unknown, unknown, ITestShape>;
+      givens: BaseGiven<unknown, unknown, unknown, unknown, Record<string, BaseFeature>>[],
+      checks: BaseCheck<unknown, unknown, unknown, unknown, ITestShape, IFeatureShape>[]
+    ) => BaseSuite<unknown, unknown, unknown, unknown, unknown, ITestShape, IFeatureShape>;
   },
   Given: {
     [K in keyof ITestShape["givens"]]: (
-      features: string[],
+      features: (keyof IFeatureShape)[],
       whens: BaseWhen<unknown, unknown, unknown>[],
       thens: BaseThen<unknown, unknown, unknown>[],
       ...xtras: ITestShape["givens"][K]
-    ) => BaseGiven<unknown, unknown, unknown, unknown>;
+    ) => BaseGiven<unknown, unknown, unknown, unknown, unknown>;
   },
   When: {
     [K in keyof ITestShape["whens"]]: (
@@ -77,7 +77,7 @@ export type ITestSpecification<ITestShape extends ITTestShape> = (
     [K in keyof ITestShape["checks"]]: (
 
       name: string,
-      features: string[],
+      features: (keyof IFeatureShape)[],
       callbackA: (
         whens: {
           [K in keyof ITestShape["whens"]]: (...unknown) => BaseWhen<unknown, unknown, unknown>
@@ -88,7 +88,7 @@ export type ITestSpecification<ITestShape extends ITTestShape> = (
 
       ) => unknown,
       ...xtras: ITestShape["checks"][K]
-    ) => BaseCheck<unknown, unknown, unknown, unknown, ITestShape>;
+    ) => BaseCheck<unknown, unknown, unknown, unknown, ITestShape, IFeatureShape>;
   }
 ) => any[];
 
@@ -177,18 +177,19 @@ export abstract class BaseSuite<
   ISelection,
   IThenShape,
   ITestShape extends ITTestShape,
+  IFeatureShape,
 > {
   name: string;
-  givens: BaseGiven<ISubject, IStore, ISelection, IThenShape>[];
-  checks: BaseCheck<ISubject, IStore, ISelection, IThenShape, ITestShape>[];
+  givens: BaseGiven<ISubject, IStore, ISelection, IThenShape, IFeatureShape>[];
+  checks: BaseCheck<ISubject, IStore, ISelection, IThenShape, ITestShape, IFeatureShape>[];
   store: IStore;
-  fails: BaseGiven<ISubject, IStore, ISelection, IThenShape>[];
+  fails: BaseGiven<ISubject, IStore, ISelection, IThenShape, IFeatureShape>[];
   testResourceConfiguration: ITTestResourceConfiguration;
 
   constructor(
     name: string,
-    givens: BaseGiven<ISubject, IStore, ISelection, IThenShape>[] = [],
-    checks: BaseCheck<ISubject, IStore, ISelection, IThenShape, ITestShape>[] = []
+    givens: BaseGiven<ISubject, IStore, ISelection, IThenShape, IFeatureShape>[] = [],
+    checks: BaseCheck<ISubject, IStore, ISelection, IThenShape, ITestShape, IFeatureShape>[] = []
   ) {
     this.name = name;
     this.givens = givens;
@@ -222,7 +223,8 @@ export abstract class BaseSuite<
     IStore,
     ISelection,
     IThenShape,
-    ITestShape
+    ITestShape,
+    IFeatureShape
   >> {
 
     this.testResourceConfiguration = testResourceConfiguration;
@@ -269,9 +271,10 @@ export abstract class BaseGiven<
   IStore,
   ISelection,
   IThenShape,
+  IFeatureShape
 > {
   name: string;
-  features: string[];
+  features: (keyof IFeatureShape)[];
   whens: BaseWhen<IStore, ISelection, IThenShape>[];
   thens: BaseThen<ISelection, IStore, IThenShape>[];
   error: Error;
@@ -280,7 +283,7 @@ export abstract class BaseGiven<
 
   constructor(
     name: string,
-    features: string[],
+    features: (keyof IFeatureShape)[],
     whens: BaseWhen<IStore, ISelection, IThenShape>[],
     thens: BaseThen<ISelection, IStore, IThenShape>[],
   ) {
@@ -447,10 +450,11 @@ export abstract class BaseCheck<
   IStore,
   ISelection,
   IThenShape,
-  ITestShape extends ITTestShape
+  ITestShape extends ITTestShape,
+  IFeatureShape
 > {
   name: string;
-  features: string[];
+  features: (keyof IFeatureShape)[];
   checkCB: (whens, thens) => any;
   whens: {
     [K in keyof ITestShape["whens"]]: (p, tc) =>
@@ -463,7 +467,7 @@ export abstract class BaseCheck<
 
   constructor(
     name: string,
-    features: string[],
+    features: (keyof IFeatureShape)[],
     checkCB: (
       whens,
       thens
@@ -550,7 +554,8 @@ export abstract class TesterantoLevelZero<
   WhenExtensions,
   ThenExtensions,
   CheckExtensions,
-  IThenShape
+  IThenShape,
+  IFeatureShape,
 
 > {
   constructorator: IStore;
@@ -559,20 +564,20 @@ export abstract class TesterantoLevelZero<
     keyof SuiteExtensions,
     (
       name: string,
-      givens: BaseGiven<ISubject, IStore, ISelection, IThenShape>[],
-      checks: BaseCheck<ISubject, IStore, ISelection, IThenShape, ITTestShape>[]
-    ) => BaseSuite<IInput, ISubject, IStore, ISelection, IThenShape, ITTestShape>
+      givens: BaseGiven<ISubject, IStore, ISelection, IThenShape, IFeatureShape>[],
+      checks: BaseCheck<ISubject, IStore, ISelection, IThenShape, ITTestShape, IFeatureShape>[]
+    ) => BaseSuite<IInput, ISubject, IStore, ISelection, IThenShape, ITTestShape, IFeatureShape>
   >;
 
   givenOverides: Record<
     keyof GivenExtensions,
     (
       name: string,
-      features: string[],
+      features: (keyof IFeatureShape)[],
       whens: BaseWhen<IStore, ISelection, IThenShape>[],
       thens: BaseThen<ISelection, IStore, IThenShape>[],
       ...xtraArgs
-    ) => BaseGiven<ISubject, IStore, ISelection, IThenShape>
+    ) => BaseGiven<ISubject, IStore, ISelection, IThenShape, IFeatureShape>
   >;
 
   whenOverides: Record<
@@ -594,7 +599,7 @@ export abstract class TesterantoLevelZero<
       feature: string,
       callback: (whens, thens) => any,
       ...xtraArgs
-    ) => BaseCheck<ISubject, IStore, ISelection, IThenShape, ITTestShape>
+    ) => BaseCheck<ISubject, IStore, ISelection, IThenShape, ITTestShape, IFeatureShape>
   >;
 
   constructor(
@@ -603,20 +608,20 @@ export abstract class TesterantoLevelZero<
       keyof SuiteExtensions,
       (
         name: string,
-        givens: BaseGiven<ISubject, IStore, ISelection, IThenShape>[],
-        checks: BaseCheck<ISubject, IStore, ISelection, IThenShape, ITTestShape>[]
-      ) => BaseSuite<IInput, ISubject, IStore, ISelection, IThenShape, ITTestShape>
+        givens: BaseGiven<ISubject, IStore, ISelection, IThenShape, IFeatureShape>[],
+        checks: BaseCheck<ISubject, IStore, ISelection, IThenShape, ITTestShape, IFeatureShape>[]
+      ) => BaseSuite<IInput, ISubject, IStore, ISelection, IThenShape, ITTestShape, IFeatureShape>
     >,
 
     givenOverides: Record<
       keyof GivenExtensions,
       (
         name: string,
-        features: string[],
+        features: (keyof IFeatureShape)[],
         whens: BaseWhen<IStore, ISelection, IThenShape>[],
         thens: BaseThen<ISelection, IStore, IThenShape>[],
         ...xtraArgs
-      ) => BaseGiven<ISubject, IStore, ISelection, IThenShape>
+      ) => BaseGiven<ISubject, IStore, ISelection, IThenShape, IFeatureShape>
     >,
 
     whenOverides: Record<
@@ -638,7 +643,7 @@ export abstract class TesterantoLevelZero<
         feature: string,
         callback: (whens, thens) => any,
         ...xtraArgs
-      ) => BaseCheck<ISubject, IStore, ISelection, IThenShape, ITTestShape>
+      ) => BaseCheck<ISubject, IStore, ISelection, IThenShape, ITTestShape, IFeatureShape>
     >
   ) {
     this.constructorator = cc;
@@ -657,11 +662,11 @@ export abstract class TesterantoLevelZero<
     keyof GivenExtensions,
     (
       name: string,
-      features: string[],
+      features: (keyof IFeatureShape)[],
       whens: BaseWhen<IStore, ISelection, IThenShape>[],
       thens: BaseThen<ISelection, IStore, IThenShape>[],
       ...xtraArgs
-    ) => BaseGiven<ISubject, IStore, ISelection, IThenShape>
+    ) => BaseGiven<ISubject, IStore, ISelection, IThenShape, IFeatureShape>
   > {
     return this.givenOverides;
   }
@@ -690,7 +695,7 @@ export abstract class TesterantoLevelZero<
       callback: (whens, thens) => any,
       whens,
       thens
-    ) => BaseCheck<ISubject, IStore, ISelection, IThenShape, ITTestShape>
+    ) => BaseCheck<ISubject, IStore, ISelection, IThenShape, ITTestShape, IFeatureShape>
   > {
     return this.checkOverides;
   }
@@ -704,7 +709,8 @@ export abstract class TesterantoLevelOne<
   ISubject,
   IWhenShape,
   IThenShape,
-  IInput
+  IInput,
+  IFeatureShape extends Record<string, BaseFeature>
 > {
   constructor(
     testImplementation: ITestImplementation<
@@ -719,18 +725,18 @@ export abstract class TesterantoLevelOne<
       Suite: {
         [K in keyof ITestShape["suites"]]: (
           feature: string,
-          givens: BaseGiven<ISubject, IStore, ISelection, IThenShape>[],
-          checks: BaseCheck<ISubject, IStore, ISelection, IThenShape, ITestShape>[]
-        ) => BaseSuite<IInput, ISubject, IStore, ISelection, IThenShape, ITestShape>;
+          givens: BaseGiven<ISubject, IStore, ISelection, IThenShape, IFeatureShape>[],
+          checks: BaseCheck<ISubject, IStore, ISelection, IThenShape, ITestShape, IFeatureShape>[]
+        ) => BaseSuite<IInput, ISubject, IStore, ISelection, IThenShape, ITestShape, IFeatureShape>;
       },
       Given: {
         [K in keyof ITestShape["givens"]]: (
           name: string,
-          features: string[],
+          features: (keyof IFeatureShape)[],
           whens: BaseWhen<IStore, ISelection, IThenShape>[],
           thens: BaseThen<ISelection, IStore, IThenShape>[],
-          ...a: ITestShape["givens"]
-        ) => BaseGiven<ISubject, IStore, ISelection, IThenShape>;
+          ...a: ITestShape["givens"][K]
+        ) => BaseGiven<ISubject, IStore, ISelection, IThenShape, IFeatureShape>;
       },
       When: {
         [K in keyof ITestShape["whens"]]: (
@@ -745,28 +751,28 @@ export abstract class TesterantoLevelOne<
       Check: {
         [K in keyof ITestShape["checks"]]: (
           name: string,
-          features: string[],
+          features: (keyof IFeatureShape)[],
           cbz: (...any) => Promise<void>
         ) => any;
       }
-    ) => BaseSuite<IInput, ISubject, IStore, ISelection, IThenShape, ITestShape>[],
+    ) => BaseSuite<IInput, ISubject, IStore, ISelection, IThenShape, ITestShape, IFeatureShape>[],
 
     input: IInput,
 
     suiteKlasser: (
       name: string,
-      givens: BaseGiven<ISubject, IStore, ISelection, IThenShape>[],
-      checks: BaseCheck<ISubject, IStore, ISelection, IThenShape, ITestShape>[]
+      givens: BaseGiven<ISubject, IStore, ISelection, IThenShape, IFeatureShape>[],
+      checks: BaseCheck<ISubject, IStore, ISelection, IThenShape, ITestShape, IFeatureShape>[]
     ) =>
-      BaseSuite<IInput, ISubject, IStore, ISelection, IThenShape, ITestShape>,
+      BaseSuite<IInput, ISubject, IStore, ISelection, IThenShape, ITestShape, IFeatureShape>,
     givenKlasser: (n, f, w, t, z?) =>
-      BaseGiven<ISubject, IStore, ISelection, IThenShape>,
+      BaseGiven<ISubject, IStore, ISelection, IThenShape, IFeatureShape>,
     whenKlasser: (s, o) =>
       BaseWhen<IStore, ISelection, IThenShape>,
     thenKlasser: (s, o) =>
       BaseThen<IStore, ISelection, IThenShape>,
     checkKlasser: (n, f, cb, w, t) =>
-      BaseCheck<ISubject, IStore, ISelection, IThenShape, ITestShape>,
+      BaseCheck<ISubject, IStore, ISelection, IThenShape, ITestShape, IFeatureShape>,
 
     testResourceRequirement,
     nameKey: string
@@ -834,7 +840,8 @@ export abstract class TesterantoLevelOne<
       WhenExtensions,
       ThenExtensions,
       ICheckExtensions,
-      IThenShape
+      IThenShape,
+      IFeatureShape,
     > extends TesterantoLevelZero<
       IInput,
       ISubject,
@@ -845,7 +852,8 @@ export abstract class TesterantoLevelOne<
       WhenExtensions,
       ThenExtensions,
       ICheckExtensions,
-      IThenShape
+      IThenShape,
+      IFeatureShape
     > { })(
       input,
       classySuites,
@@ -868,7 +876,7 @@ export abstract class TesterantoLevelOne<
     const suiteRunner = (suite) => (
       testResourceConfiguration: ITTestResourceConfiguration,
       tLog: ITLog,
-    ): BaseSuite<IInput, ISubject, IStore, ISelection, IThenShape, ITestShape> => {
+    ): BaseSuite<IInput, ISubject, IStore, ISelection, IThenShape, ITestShape, IFeatureShape> => {
       return suite.run(
         input,
         testResourceConfiguration,
@@ -904,7 +912,7 @@ export abstract class TesterantoLevelOne<
             access.write(`${l.toString()}\n`);
           }
           const suiteDone: BaseSuite<
-            IInput, ISubject, IStore, ISelection, IThenShape, ITestShape
+            IInput, ISubject, IStore, ISelection, IThenShape, ITestShape, IFeatureShape
           > = await runner(testResourceConfiguration, tLog);
           const resultsFilePath = path.resolve(`${testResourceConfiguration.fs}/results.json`)
 
@@ -937,10 +945,12 @@ export default async <
   WhenShape,
   ThenShape,
   InitialStateShape,
+  IFeatureShape extends Record<string, BaseFeature>,
 >(
   input: Input,
   testSpecification: ITestSpecification<
-    TestShape
+    TestShape,
+    IFeatureShape
   >,
   testImplementation,
   testInterface: {
@@ -973,6 +983,8 @@ export default async <
   testResourceRequirement: ITTestResourceRequirement = defaultTestResourceRequirement
 
 ) => {
+
+
   const butThen = testInterface.butThen || (async (a) => a as any);
   const { andWhen } = testInterface;
   const actionHandler = testInterface.actionHandler || function (b: (...any: any[]) => any) {
@@ -994,7 +1006,8 @@ export default async <
     Subject,
     WhenShape,
     ThenShape,
-    Input
+    Input,
+    IFeatureShape
   > {
     constructor() {
       super(
@@ -1002,7 +1015,7 @@ export default async <
         /* @ts-ignore:next-line */
         testSpecification,
         input,
-        (class extends BaseSuite<Input, Subject, Store, Selection, ThenShape, TestShape> {
+        (class extends BaseSuite<Input, Subject, Store, Selection, ThenShape, TestShape, IFeatureShape> {
           async setup(s: Input, artifactory): Promise<Subject> {
             return beforeAll(s, artifactory);
           }
@@ -1015,12 +1028,13 @@ export default async <
           Subject,
           Store,
           Selection,
-          ThenShape
+          ThenShape,
+          IFeatureShape
         > {
           initialValues: any;
           constructor(
             name: string,
-            features: string[],
+            features: (keyof IFeatureShape)[],
             whens: BaseWhen<Store, Selection, ThenShape>[],
             thens: BaseThen<Selection, Store, ThenShape>[],
             initialValues: any
@@ -1068,12 +1082,12 @@ export default async <
           }
         },
 
-        class Check extends BaseCheck<Subject, Store, Selection, ThenShape, TestShape> {
+        class Check extends BaseCheck<Subject, Store, Selection, ThenShape, TestShape, IFeatureShape> {
           initialValues: any;
 
           constructor(
             name: string,
-            features: string[],
+            features: (keyof IFeatureShape)[],
             checkCallback: (a, b) => any,
             whens,
             thens,