bingo-stratum-testers 0.5.7 → 0.5.9

package/lib/index.d.ts

@@ -1,2 +1,3 @@
 export { testBlock } from "./testBlock.js";
+export { testIntake } from "./testIntake.js";
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC"}

package/lib/index.js

@@ -1,2 +1,3 @@
 export { testBlock } from "./testBlock.js";
+export { testIntake } from "./testIntake.js";
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC"}

package/lib/testBlock.d.ts

@@ -6,10 +6,25 @@ export interface BlockContextSettingsWithOptionalAddons<Addons extends object, O
     addons?: Partial<Addons>;
 }
 export interface BlockContextSettingsWithoutAddons<Options extends object> {
+    /**
+     * Which repository mode Bingo to simulate being run in.
+     * @see {@link https://create.bingo/build/concepts/modes}
+     */
     mode?: ProductionMode;
+    /**
+     * Whether to simulate being run in an "offline" mode.
+     * @see {@link http://create.bingo/build/details/contexts#options-offline}
+     */
     offline?: boolean;
+    /**
+     * Any options values as described by the Block's Base's options schema, as well as preset.
+     */
     options?: Options & StratumTemplateOptions;
 }
+/**
+ * Simulates running a Block in-memory for tests.
+ * @see {@link https://www.create.bingo/engines/stratum/packages/bingo-stratum-testers/#testblock}
+ */
 export declare function testBlock<Addons extends object, Options extends object>(block: BlockWithAddons<Addons, Options>, settings: BlockContextSettingsWithOptionalAddons<Addons, Options>): Partial<BlockCreation<Options>>;
 export declare function testBlock<Options extends object>(block: BlockWithoutAddons<Options>, settings?: BlockContextSettingsWithoutAddons<Options>): Partial<BlockCreation<Options>>;
 //# sourceMappingURL=testBlock.d.ts.map

package/lib/testBlock.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"testBlock.d.ts","sourceRoot":"","sources":["../src/testBlock.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,EACN,eAAe,EACf,kBAAkB,EAGlB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAI9E,MAAM,WAAW,sCAAsC,CACtD,MAAM,SAAS,MAAM,EACrB,OAAO,SAAS,MAAM,CACrB,SAAQ,iCAAiC,CAAC,OAAO,CAAC;IACnD,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,iCAAiC,CAAC,OAAO,SAAS,MAAM;IACxE,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;CAC3C;AAED,wBAAgB,SAAS,CAAC,MAAM,SAAS,MAAM,EAAE,OAAO,SAAS,MAAM,EACtE,KAAK,EAAE,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,EACvC,QAAQ,EAAE,sCAAsC,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/D,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;AACnC,wBAAgB,SAAS,CAAC,OAAO,SAAS,MAAM,EAC/C,KAAK,EAAE,kBAAkB,CAAC,OAAO,CAAC,EAClC,QAAQ,CAAC,EAAE,iCAAiC,CAAC,OAAO,CAAC,GACnD,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC"}
+{"version":3,"file":"testBlock.d.ts","sourceRoot":"","sources":["../src/testBlock.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,EACN,eAAe,EACf,kBAAkB,EAGlB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAI9E,MAAM,WAAW,sCAAsC,CACtD,MAAM,SAAS,MAAM,EACrB,OAAO,SAAS,MAAM,CACrB,SAAQ,iCAAiC,CAAC,OAAO,CAAC;IACnD,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,iCAAiC,CAAC,OAAO,SAAS,MAAM;IACxE;;;OAGG;IACH,IAAI,CAAC,EAAE,cAAc,CAAC;IAEtB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;CAC3C;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,MAAM,SAAS,MAAM,EAAE,OAAO,SAAS,MAAM,EACtE,KAAK,EAAE,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,EACvC,QAAQ,EAAE,sCAAsC,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/D,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;AACnC,wBAAgB,SAAS,CAAC,OAAO,SAAS,MAAM,EAC/C,KAAK,EAAE,kBAAkB,CAAC,OAAO,CAAC,EAClC,QAAQ,CAAC,EAAE,iCAAiC,CAAC,OAAO,CAAC,GACnD,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC"}

package/lib/testBlock.js

@@ -2,9 +2,10 @@ import { produceBlock, } from "bingo-stratum";
 import { createFailingObject } from "./utils.js";
 export function testBlock(block, settings = {}) {
     return produceBlock(block, {
-        addons: {},
-        options: createFailingObject("options", "the Block"),
         ...settings,
+        addons: settings.addons ?? {},
+        options: settings.options ??
+            createFailingObject("options", "the Block"),
     });
 }
 //# sourceMappingURL=testBlock.js.map

package/lib/testBlock.js.map

@@ -1 +1 @@
-{"version":3,"file":"testBlock.js","sourceRoot":"","sources":["../src/testBlock.ts"],"names":[],"mappings":"AACA,OAAO,EAGN,YAAY,GAEZ,MAAM,eAAe,CAAC;AAIvB,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAuBjD,MAAM,UAAU,SAAS,CACxB,KAAqE,EACrE,WAAoE,EAAE;IAEtE,OAAO,YAAY,CAClB,KAAyC,EACzC;QACC,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAY;QAC/D,GAAG,QAAQ;KACwC,CACpD,CAAC;AACH,CAAC"}
+{"version":3,"file":"testBlock.js","sourceRoot":"","sources":["../src/testBlock.ts"],"names":[],"mappings":"AACA,OAAO,EAGN,YAAY,GAEZ,MAAM,eAAe,CAAC;AAIvB,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAwCjD,MAAM,UAAU,SAAS,CACxB,KAAqE,EACrE,WAAoE,EAAE;IAEtE,OAAO,YAAY,CAClB,KAAyC,EACzC;QACC,GAAG,QAAQ;QACX,MAAM,EAAE,QAAQ,CAAC,MAAM,IAAI,EAAE;QAC7B,OAAO,EACN,QAAQ,CAAC,OAAO;YACf,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAa;KACN,CACpD,CAAC;AACH,CAAC"}

package/lib/testIntake.d.ts

@@ -0,0 +1,19 @@
+import { IntakeDirectory } from "bingo-fs";
+import { BlockWithAddons } from "bingo-stratum";
+import { StratumTemplateOptions } from "bingo-stratum/lib/types/templates.js";
+export interface TestIntakeSettings<Options extends object> {
+    /**
+     * Existing file creations, if available.
+     */
+    files: IntakeDirectory;
+    /**
+     * Any options values as described by the Block's Base's options schema, as well as preset.
+     */
+    options?: Options & StratumTemplateOptions;
+}
+/**
+ * Simulates running a Block's intake in-memory for tests.
+ * @see {@link https://www.create.bingo/engines/stratum/packages/bingo-stratum-testers/#testintake}
+ */
+export declare function testIntake<Addons extends object, Options extends object>(block: BlockWithAddons<Addons, Options>, settings: TestIntakeSettings<Options>): Partial<Addons> | undefined;
+//# sourceMappingURL=testIntake.d.ts.map

package/lib/testIntake.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testIntake.d.ts","sourceRoot":"","sources":["../src/testIntake.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAI9E,MAAM,WAAW,kBAAkB,CAAC,OAAO,SAAS,MAAM;IACzD;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;CAC3C;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,MAAM,SAAS,MAAM,EAAE,OAAO,SAAS,MAAM,EACvE,KAAK,EAAE,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,EACvC,QAAQ,EAAE,kBAAkB,CAAC,OAAO,CAAC,GACnC,OAAO,CAAC,MAAM,CAAC,GAAG,SAAS,CAO7B"}

package/lib/testIntake.js

@@ -0,0 +1,13 @@
+import { createFailingObject } from "./utils.js";
+/**
+ * Simulates running a Block's intake in-memory for tests.
+ * @see {@link https://www.create.bingo/engines/stratum/packages/bingo-stratum-testers/#testintake}
+ */
+export function testIntake(block, settings) {
+    return block.intake?.({
+        ...settings,
+        options: settings.options ??
+            createFailingObject("options", "the Block"),
+    });
+}
+//# sourceMappingURL=testIntake.js.map

package/lib/testIntake.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testIntake.js","sourceRoot":"","sources":["../src/testIntake.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAcjD;;;GAGG;AACH,MAAM,UAAU,UAAU,CACzB,KAAuC,EACvC,QAAqC;IAErC,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;QACrB,GAAG,QAAQ;QACX,OAAO,EACN,QAAQ,CAAC,OAAO;YACf,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAa;KACzD,CAAC,CAAC;AACJ,CAAC"}

package/lib/testIntake.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=testIntake.test.d.ts.map

package/lib/testIntake.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testIntake.test.d.ts","sourceRoot":"","sources":["../src/testIntake.test.ts"],"names":[],"mappings":""}

package/lib/testIntake.test.js

@@ -0,0 +1,75 @@
+import { createBase } from "bingo-stratum";
+import { describe, expect, it } from "vitest";
+import { z } from "zod";
+import { testIntake } from "./testIntake.js";
+const base = createBase({
+    options: {
+        value: z.string(),
+    },
+});
+describe("testIntake", () => {
+    it("returns undefined when the Block doesn't define an intake", () => {
+        const block = base.createBlock({
+            addons: {
+                value: z.string().optional(),
+            },
+            produce() {
+                return {};
+            },
+        });
+        const actual = testIntake(block, { files: {} });
+        expect(actual).toBeUndefined();
+    });
+    it("returns the intake result when the Block defines an intake", () => {
+        const block = base.createBlock({
+            addons: {
+                value: z.string().optional(),
+            },
+            intake({ files }) {
+                return {
+                    value: files["value.txt"][0],
+                };
+            },
+            produce() {
+                return {};
+            },
+        });
+        const value = "abc";
+        const actual = testIntake(block, {
+            files: {
+                "value.txt": [value],
+            },
+        });
+        expect(actual).toEqual({ value });
+    });
+    describe("options", () => {
+        const blockUsingOptions = base.createBlock({
+            addons: {
+                extra: z.string().optional(),
+            },
+            intake({ options }) {
+                return {
+                    extra: options.value + "!",
+                };
+            },
+            produce() {
+                return {};
+            },
+        });
+        it("throws an error when options isn't provided and a block uses options", () => {
+            expect(() => testIntake(blockUsingOptions, {
+                files: {},
+            })).toThrowErrorMatchingInlineSnapshot(`[Error: Context property 'options' was used by the Block but not provided.]`);
+        });
+        it("passes options to the block when provided", () => {
+            const actual = testIntake(blockUsingOptions, {
+                files: {},
+                options: { preset: "test", value: "abc" },
+            });
+            expect(actual).toEqual({
+                extra: "abc!",
+            });
+        });
+    });
+});
+//# sourceMappingURL=testIntake.test.js.map

package/lib/testIntake.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testIntake.test.js","sourceRoot":"","sources":["../src/testIntake.test.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,MAAM,IAAI,GAAG,UAAU,CAAC;IACvB,OAAO,EAAE;QACR,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;KACjB;CACD,CAAC,CAAC;AAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC3B,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACpE,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC;YAC9B,MAAM,EAAE;gBACP,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;aAC5B;YACD,OAAO;gBACN,OAAO,EAAE,CAAC;YACX,CAAC;SACD,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;QAEhD,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAE,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACrE,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC;YAC9B,MAAM,EAAE;gBACP,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;aAC5B;YACD,MAAM,CAAC,EAAE,KAAK,EAAE;gBACf,OAAO;oBACN,KAAK,EAAG,KAAK,CAAC,WAAW,CAAqB,CAAC,CAAC,CAAC;iBACjD,CAAC;YACH,CAAC;YACD,OAAO;gBACN,OAAO,EAAE,CAAC;YACX,CAAC;SACD,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,KAAK,CAAC;QAEpB,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,EAAE;YAChC,KAAK,EAAE;gBACN,WAAW,EAAE,CAAC,KAAK,CAAC;aACpB;SACD,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;QACxB,MAAM,iBAAiB,GAAG,IAAI,CAAC,WAAW,CAAC;YAC1C,MAAM,EAAE;gBACP,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;aAC5B;YACD,MAAM,CAAC,EAAE,OAAO,EAAE;gBACjB,OAAO;oBACN,KAAK,EAAE,OAAO,CAAC,KAAK,GAAG,GAAG;iBAC1B,CAAC;YACH,CAAC;YACD,OAAO;gBACN,OAAO,EAAE,CAAC;YACX,CAAC;SACD,CAAC,CAAC;QAEH,EAAE,CAAC,sEAAsE,EAAE,GAAG,EAAE;YAC/E,MAAM,CAAC,GAAG,EAAE,CACX,UAAU,CAAC,iBAAiB,EAAE;gBAC7B,KAAK,EAAE,EAAE;aACT,CAAC,CACF,CAAC,kCAAkC,CACnC,6EAA6E,CAC7E,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACpD,MAAM,MAAM,GAAG,UAAU,CAAC,iBAAiB,EAAE;gBAC5C,KAAK,EAAE,EAAE;gBACT,OAAO,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE;aACzC,CAAC,CAAC;YAEH,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBACtB,KAAK,EAAE,MAAM;aACb,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bingo-stratum-testers",
-  "version": "0.5.7",
+  "version": "0.5.9",
   "description": "Test utilities for Stratum Blocks and Presets. 🧑‍🔧",
   "homepage": "https://www.create.bingo/engines/stratum/packages/bingo-stratum-testers",
   "repository": {
@@ -25,11 +25,11 @@
     "zod": "3.24.2"
   },
   "peerDependencies": {
-    "bingo": "^0.5.10",
-    "bingo-stratum": "^0.5.7",
-    "bingo-fs": "^0.5.4",
-    "bingo-testers": "^0.5.7",
-    "bingo-systems": "^0.5.4"
+    "bingo-fs": "^0.5.5",
+    "bingo-stratum": "^0.5.11",
+    "bingo": "^0.5.14",
+    "bingo-systems": "^0.5.4",
+    "bingo-testers": "^0.5.7"
   },
   "engines": {
     "node": ">=18"