bingo-testers 0.5.4 → 0.5.5

package/lib/testOptions.d.ts

@@ -0,0 +1,3 @@
+import { AnyShape, HasOptionsAndMaybePrepare, InferredObject, OptionsContext } from "bingo";
+export declare function testOptions<OptionsShape extends AnyShape>(base: HasOptionsAndMaybePrepare<OptionsShape>, context?: Partial<OptionsContext<InferredObject<OptionsShape>>>): Promise<Partial<InferredObject<OptionsShape>> | import("bingo").AwaitedLazyProperties<import("bingo").LazyOptionalOptions<Partial<InferredObject<OptionsShape>>>> | undefined>;
+//# sourceMappingURL=testOptions.d.ts.map

package/lib/testOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testOptions.d.ts","sourceRoot":"","sources":["../src/testOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,QAAQ,EAER,yBAAyB,EACzB,cAAc,EACd,cAAc,EACd,MAAM,OAAO,CAAC;AAIf,wBAAsB,WAAW,CAAC,YAAY,SAAS,QAAQ,EAC9D,IAAI,EAAE,yBAAyB,CAAC,YAAY,CAAC,EAC7C,OAAO,GAAE,OAAO,CAAC,cAAc,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,CAAM,kLAenE"}

package/lib/testOptions.js

@@ -0,0 +1,17 @@
+import { awaitLazyProperties, } from "bingo";
+import { createFailingFunction } from "./utils.js";
+export async function testOptions(base, context = {}) {
+    if (!base.prepare) {
+        return context.options;
+    }
+    return await awaitLazyProperties({
+        ...base.prepare({
+            ...context,
+            log: context.log ?? createFailingFunction("log", "prepare()"),
+            options: context.options ?? {},
+            take: context.take ?? createFailingFunction("take", "prepare()"),
+        }),
+        ...context.options,
+    });
+}
+//# sourceMappingURL=testOptions.js.map

package/lib/testOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testOptions.js","sourceRoot":"","sources":["../src/testOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,mBAAmB,GAInB,MAAM,OAAO,CAAC;AAEf,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAEnD,MAAM,CAAC,KAAK,UAAU,WAAW,CAChC,IAA6C,EAC7C,UAAiE,EAAE;IAEnE,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QACnB,OAAO,OAAO,CAAC,OAAO,CAAC;IACxB,CAAC;IAED,OAAO,MAAM,mBAAmB,CAAC;QAChC,GAAG,IAAI,CAAC,OAAO,CAAC;YACf,GAAG,OAAO;YACV,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,qBAAqB,CAAC,KAAK,EAAE,WAAW,CAAC;YAC7D,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE;YAC9B,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,qBAAqB,CAAC,MAAM,EAAE,WAAW,CAAC;SAChE,CAAC;QACF,GAAG,OAAO,CAAC,OAAO;KAClB,CAAC,CAAC;AACJ,CAAC"}

package/lib/testOptions.test.d.ts

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

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

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

package/lib/testOptions.test.js

@@ -0,0 +1,96 @@
+import { describe, expect, it, vi } from "vitest";
+import { z } from "zod";
+import { testOptions } from "./testOptions.js";
+describe("testOptions", () => {
+    it("returns context.options directly when base.prepare is undefined", async () => {
+        const options = { value: "abc" };
+        const actual = await testOptions({
+            options: {
+                value: z.string(),
+            },
+        }, { options });
+        expect(actual).toBe(options);
+    });
+    it("uses an options value from context when prepare also creates a value for it", async () => {
+        const value = "provided";
+        const getValue = vi.fn().mockResolvedValueOnce("default");
+        const actual = await testOptions({
+            options: {
+                value: z.string(),
+            },
+            prepare() {
+                return {
+                    value: getValue,
+                };
+            },
+        }, {
+            options: { value },
+        });
+        expect(actual).toEqual({ value });
+        expect(getValue).not.toHaveBeenCalled();
+    });
+    it("passes options to prepare when provided in context", async () => {
+        const actual = await testOptions({
+            options: {
+                first: z.string(),
+                second: z.string(),
+            },
+            prepare({ options }) {
+                return {
+                    second: () => Promise.resolve(String(options.first) + "!"),
+                };
+            },
+        }, {
+            options: { first: "abc" },
+        });
+        expect(actual).toEqual({
+            first: "abc",
+            second: "abc!",
+        });
+    });
+    it("throws an error when prepare calls log and log is not provided", async () => {
+        const act = async () => await testOptions({
+            options: {},
+            prepare({ log }) {
+                log("message");
+                return {};
+            },
+        });
+        await expect(act).rejects.toEqual(new Error(`Context property 'log' was used by prepare() but not provided.`));
+    });
+    it("calls the provided log when prepare calls log and log is provided", async () => {
+        const data = "message";
+        const log = vi.fn();
+        await testOptions({
+            options: {},
+            prepare({ log }) {
+                log(data);
+                return {};
+            },
+        }, { log });
+        expect(log).toHaveBeenCalledWith(data);
+    });
+    it("throws an error when prepare calls take and take is not provided", async () => {
+        const act = async () => await testOptions({
+            options: {},
+            prepare({ take }) {
+                take(vi.fn());
+                return {};
+            },
+        });
+        await expect(act).rejects.toEqual(new Error(`Context property 'take' was used by prepare() but not provided.`));
+    });
+    it("calls the provided take when prepare calls take and take is provided", async () => {
+        const input = vi.fn();
+        const take = vi.fn();
+        await testOptions({
+            options: {},
+            prepare({ take }) {
+                take(input);
+                return {};
+            },
+        }, { take });
+        expect(take).toHaveBeenCalledWith(input);
+    });
+});
+//# sourceMappingURL=testOptions.test.js.map

package/lib/testOptions.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testOptions.test.js","sourceRoot":"","sources":["../src/testOptions.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAClD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC5B,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAChF,MAAM,OAAO,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;QAEjC,MAAM,MAAM,GAAG,MAAM,WAAW,CAC/B;YACC,OAAO,EAAE;gBACR,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;aACjB;SACD,EACD,EAAE,OAAO,EAAE,CACX,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6EAA6E,EAAE,KAAK,IAAI,EAAE;QAC5F,MAAM,KAAK,GAAG,UAAU,CAAC;QACzB,MAAM,QAAQ,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC;QAE1D,MAAM,MAAM,GAAG,MAAM,WAAW,CAC/B;YACC,OAAO,EAAE;gBACR,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;aACjB;YACD,OAAO;gBACN,OAAO;oBACN,KAAK,EAAE,QAAQ;iBACf,CAAC;YACH,CAAC;SACD,EACD;YACC,OAAO,EAAE,EAAE,KAAK,EAAE;SAClB,CACD,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QAClC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;QACnE,MAAM,MAAM,GAAG,MAAM,WAAW,CAC/B;YACC,OAAO,EAAE;gBACR,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;gBACjB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;aAClB;YACD,OAAO,CAAC,EAAE,OAAO,EAAE;gBAClB,OAAO;oBACN,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC;iBAC1D,CAAC;YACH,CAAC;SACD,EACD;YACC,OAAO,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE;SACzB,CACD,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACtB,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC/E,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE,CACtB,MAAM,WAAW,CAAC;YACjB,OAAO,EAAE,EAAE;YACX,OAAO,CAAC,EAAE,GAAG,EAAE;gBACd,GAAG,CAAC,SAAS,CAAC,CAAC;gBACf,OAAO,EAAE,CAAC;YACX,CAAC;SACD,CAAC,CAAC;QAEJ,MAAM,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,OAAO,CAChC,IAAI,KAAK,CACR,gEAAgE,CAChE,CACD,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mEAAmE,EAAE,KAAK,IAAI,EAAE;QAClF,MAAM,IAAI,GAAG,SAAS,CAAC;QACvB,MAAM,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAEpB,MAAM,WAAW,CAChB;YACC,OAAO,EAAE,EAAE;YACX,OAAO,CAAC,EAAE,GAAG,EAAE;gBACd,GAAG,CAAC,IAAI,CAAC,CAAC;gBACV,OAAO,EAAE,CAAC;YACX,CAAC;SACD,EACD,EAAE,GAAG,EAAE,CACP,CAAC;QAEF,MAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,KAAK,IAAI,EAAE;QACjF,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE,CACtB,MAAM,WAAW,CAAC;YACjB,OAAO,EAAE,EAAE;YACX,OAAO,CAAC,EAAE,IAAI,EAAE;gBACf,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;gBACd,OAAO,EAAE,CAAC;YACX,CAAC;SACD,CAAC,CAAC;QAEJ,MAAM,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,OAAO,CAChC,IAAI,KAAK,CACR,iEAAiE,CACjE,CACD,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;QACrF,MAAM,KAAK,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACtB,MAAM,IAAI,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAErB,MAAM,WAAW,CAChB;YACC,OAAO,EAAE,EAAE;YACX,OAAO,CAAC,EAAE,IAAI,EAAE;gBACf,IAAI,CAAC,KAAK,CAAC,CAAC;gBACZ,OAAO,EAAE,CAAC;YACX,CAAC;SACD,EACD,EAAE,IAAI,EAAE,CACR,CAAC;QAEF,MAAM,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "bingo-testers",
-  "version": "0.5.4",
+  "version": "0.5.5",
   "description": "Test utilities for composable, testable, type-safe templates. ⚗️",
+  "homepage": "https://www.create.bingo/build/packages/bingo-testers",
   "repository": {
     "type": "git",
     "url": "https://github.com/JoshuaKGoldberg/bingo",
@@ -30,7 +31,7 @@
     "zod": "3.24.2"
   },
   "peerDependencies": {
-    "bingo": "^0.5.4",
+    "bingo": "^0.5.6",
     "bingo-fs": "^0.5.4",
     "bingo-systems": "^0.5.4"
   },