bingo-stratum-testers 0.5.7 → 0.5.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (16) hide show
  1. package/lib/index.d.ts +1 -0
  2. package/lib/index.d.ts.map +1 -1
  3. package/lib/index.js +1 -0
  4. package/lib/index.js.map +1 -1
  5. package/lib/testBlock.d.ts +15 -0
  6. package/lib/testBlock.d.ts.map +1 -1
  7. package/lib/testBlock.js.map +1 -1
  8. package/lib/testIntake.d.ts +14 -0
  9. package/lib/testIntake.d.ts.map +1 -0
  10. package/lib/testIntake.js +8 -0
  11. package/lib/testIntake.js.map +1 -0
  12. package/lib/testIntake.test.d.ts +2 -0
  13. package/lib/testIntake.test.d.ts.map +1 -0
  14. package/lib/testIntake.test.js +46 -0
  15. package/lib/testIntake.test.js.map +1 -0
  16. package/package.json +5 -5
package/lib/index.d.ts CHANGED
@@ -1,2 +1,3 @@
1
1
  export { testBlock } from "./testBlock.js";
2
+ export { testIntake } from "./testIntake.js";
2
3
  //# sourceMappingURL=index.d.ts.map
package/lib/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC"}
1
+ {"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 CHANGED
@@ -1,2 +1,3 @@
1
1
  export { testBlock } from "./testBlock.js";
2
+ export { testIntake } from "./testIntake.js";
2
3
  //# sourceMappingURL=index.js.map
package/lib/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC"}
1
+ {"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 CHANGED
@@ -6,10 +6,25 @@ export interface BlockContextSettingsWithOptionalAddons<Addons extends object, O
6
6
  addons?: Partial<Addons>;
7
7
  }
8
8
  export interface BlockContextSettingsWithoutAddons<Options extends object> {
9
+ /**
10
+ * Which repository mode Bingo to simulate being run in.
11
+ * @see {@link https://create.bingo/build/concepts/modes}
12
+ */
9
13
  mode?: ProductionMode;
14
+ /**
15
+ * Whether to simulate being run in an "offline" mode.
16
+ * @see {@link http://create.bingo/build/details/contexts#options-offline}
17
+ */
10
18
  offline?: boolean;
19
+ /**
20
+ * Any options values as described by the Block's Base's options schema, as well as preset.
21
+ */
11
22
  options?: Options & StratumTemplateOptions;
12
23
  }
24
+ /**
25
+ * Simulates running a Block in-memory for tests.
26
+ * @see {@link https://www.create.bingo/engines/stratum/packages/bingo-stratum-testers/#testblock}
27
+ */
13
28
  export declare function testBlock<Addons extends object, Options extends object>(block: BlockWithAddons<Addons, Options>, settings: BlockContextSettingsWithOptionalAddons<Addons, Options>): Partial<BlockCreation<Options>>;
14
29
  export declare function testBlock<Options extends object>(block: BlockWithoutAddons<Options>, settings?: BlockContextSettingsWithoutAddons<Options>): Partial<BlockCreation<Options>>;
15
30
  //# sourceMappingURL=testBlock.d.ts.map
package/lib/testBlock.d.ts.map CHANGED
@@ -1 +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"}
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;;;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.map CHANGED
@@ -1 +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"}
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;AAwCjD,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"}
package/lib/testIntake.d.ts ADDED
@@ -0,0 +1,14 @@
1
+ import { IntakeDirectory } from "bingo-fs";
2
+ import { BlockWithAddons } from "bingo-stratum";
3
+ export interface TestIntakeSettings {
4
+ /**
5
+ * Existing file creations, if available.
6
+ */
7
+ files: IntakeDirectory;
8
+ }
9
+ /**
10
+ * Simulates running a Block's intake in-memory for tests.
11
+ * @see {@link https://www.create.bingo/engines/stratum/packages/bingo-stratum-testers/#testintake}
12
+ */
13
+ export declare function testIntake<Addons extends object, Options extends object>(block: BlockWithAddons<Addons, Options>, settings: TestIntakeSettings): Partial<Addons> | undefined;
14
+ //# sourceMappingURL=testIntake.d.ts.map
package/lib/testIntake.d.ts.map ADDED
@@ -0,0 +1 @@
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;AAEhD,MAAM,WAAW,kBAAkB;IAClC;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC;CACvB;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,GAC1B,OAAO,CAAC,MAAM,CAAC,GAAG,SAAS,CAE7B"}
package/lib/testIntake.js ADDED
@@ -0,0 +1,8 @@
1
+ /**
2
+ * Simulates running a Block's intake in-memory for tests.
3
+ * @see {@link https://www.create.bingo/engines/stratum/packages/bingo-stratum-testers/#testintake}
4
+ */
5
+ export function testIntake(block, settings) {
6
+ return block.intake?.(settings);
7
+ }
8
+ //# sourceMappingURL=testIntake.js.map
package/lib/testIntake.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"testIntake.js","sourceRoot":"","sources":["../src/testIntake.ts"],"names":[],"mappings":"AAUA;;;GAGG;AACH,MAAM,UAAU,UAAU,CACzB,KAAuC,EACvC,QAA4B;IAE5B,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,CAAC;AACjC,CAAC"}
package/lib/testIntake.test.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=testIntake.test.d.ts.map
package/lib/testIntake.test.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"testIntake.test.d.ts","sourceRoot":"","sources":["../src/testIntake.test.ts"],"names":[],"mappings":""}
package/lib/testIntake.test.js ADDED
@@ -0,0 +1,46 @@
1
+ import { createBase } from "bingo-stratum";
2
+ import { describe, expect, it } from "vitest";
3
+ import { z } from "zod";
4
+ import { testIntake } from "./testIntake.js";
5
+ const base = createBase({
6
+ options: {
7
+ value: z.string(),
8
+ },
9
+ });
10
+ describe("testIntake", () => {
11
+ it("returns undefined when the Block doesn't define an intake", () => {
12
+ const block = base.createBlock({
13
+ addons: {
14
+ value: z.string().optional(),
15
+ },
16
+ produce() {
17
+ return {};
18
+ },
19
+ });
20
+ const actual = testIntake(block, { files: {} });
21
+ expect(actual).toBeUndefined();
22
+ });
23
+ it("returns the intake result when the Block defines an intake", () => {
24
+ const block = base.createBlock({
25
+ addons: {
26
+ value: z.string().optional(),
27
+ },
28
+ intake({ files }) {
29
+ return {
30
+ value: files["value.txt"][0],
31
+ };
32
+ },
33
+ produce() {
34
+ return {};
35
+ },
36
+ });
37
+ const value = "abc";
38
+ const actual = testIntake(block, {
39
+ files: {
40
+ "value.txt": [value],
41
+ },
42
+ });
43
+ expect(actual).toEqual({ value });
44
+ });
45
+ });
46
+ //# sourceMappingURL=testIntake.test.js.map
package/lib/testIntake.test.js.map ADDED
@@ -0,0 +1 @@
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;AACJ,CAAC,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bingo-stratum-testers",
3
- "version": "0.5.7",
3
+ "version": "0.5.8",
4
4
  "description": "Test utilities for Stratum Blocks and Presets. 🧑‍🔧",
5
5
  "homepage": "https://www.create.bingo/engines/stratum/packages/bingo-stratum-testers",
6
6
  "repository": {
@@ -25,11 +25,11 @@
25
25
  "zod": "3.24.2"
26
26
  },
27
27
  "peerDependencies": {
28
- "bingo": "^0.5.10",
29
- "bingo-stratum": "^0.5.7",
30
28
  "bingo-fs": "^0.5.4",
31
- "bingo-testers": "^0.5.7",
32
- "bingo-systems": "^0.5.4"
29
+ "bingo-stratum": "^0.5.8",
30
+ "bingo": "^0.5.11",
31
+ "bingo-systems": "^0.5.4",
32
+ "bingo-testers": "^0.5.7"
33
33
  },
34
34
  "engines": {
35
35
  "node": ">=18"