zcb 0.3.3 → 0.3.5

package/package.json

@@ -1,19 +1,25 @@
 {
   "name": "zcb",
   "description": "Build configs with type safety from zod schema.",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "author": "miami-man",
   "license": "MIT",
   "homepage": "https://github.com/badbatch/zod-config-builder",
-  "repository": "badbatch/zod-config-builder",
+  "repository": {
+    "type": "git",
+    "url": "badbatch/zod-config-builder"
+  },
   "bugs": "https://github.com/badbatch/zod-config-builder/issues",
   "type": "module",
   "bin": {
     "zcb": "./bin/zcb.js"
   },
-  "main": "./dist/cjs/index.cjs",
+  "main": "./dist/cjs/index.mjs",
   "module": "./dist/esm/index.mjs",
-  "types": "./dist/types/cjs/index.d.cts",
+  "types": "./dist/types/cjs/index.d.ts",
+  "imports": {
+    "#*": "./src/*"
+  },
   "exports": {
     ".": {
       "types": {
@@ -39,56 +45,55 @@
     "@types/fs-extra": "^11.0.4",
     "@types/json-schema": "^7.0.15",
     "@types/lodash-es": "^4.17.12",
-    "@types/shelljs": "^0.8.17",
-    "@types/uuid": "^10.0.0",
-    "@types/yargs": "^17.0.33",
-    "core-js": "^3.45.0",
-    "fs-extra": "^11.3.1",
-    "handlebars": "^4.7.8",
+    "@types/shelljs": "^0.10.0",
+    "@types/uuid": "^11.0.0",
+    "@types/yargs": "^17.0.35",
+    "core-js": "^3.49.0",
+    "fs-extra": "^11.3.6",
+    "handlebars": "^4.7.9",
     "json-schema": "^0.4.0",
-    "lodash-es": "^4.17.21",
+    "lodash-es": "^4.18.1",
     "shelljs": "^0.10.0",
     "ts-node": "^10.9.2",
     "ts-toolbelt": "^9.6.0",
-    "type-fest": "^4.41.0",
-    "uuid": "^11.1.0",
+    "type-fest": "^5.8.0",
+    "uuid": "^14.0.1",
     "yargs": "^18.0.0",
-    "zod": "^3.25.76",
-    "zod-to-json-schema": "^3.24.6"
+    "zod": "^4.4.3",
+    "zod-to-json-schema": "^3.25.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "^19.8.1",
-    "@jest/globals": "^29.7.0",
-    "@repodog/cli": "^1.6.45",
-    "@repodog/commitlint-config": "^19.0.5",
-    "@repodog/eslint-config": "^9.0.18",
-    "@repodog/eslint-config-jest": "^9.0.6",
-    "@repodog/jest-config": "^29.0.5",
-    "@repodog/markdownlint-config": "^1.2.5",
-    "@repodog/prettier-config": "^3.0.3",
-    "@repodog/rollup-config": "^4.0.11",
-    "@repodog/swc-config": "^1.0.12",
-    "@repodog/syncpack-config": "^13.0.4",
-    "@repodog/ts-config": "^5.0.5",
-    "@rollup/plugin-swc": "^0.3.0",
-    "@swc/core": "^1.13.3",
+    "@commitlint/cli": "^21.2.1",
+    "@jest/globals": "^30.4.1",
+    "@repodog/cli": "^1.6.59",
+    "@repodog/commitlint-config": "^21.0.2",
+    "@repodog/eslint-config": "^9.0.29",
+    "@repodog/eslint-config-jest": "^9.0.9",
+    "@repodog/jest-config": "^30.0.4",
+    "@repodog/markdownlint-config": "^1.2.7",
+    "@repodog/prettier-config": "^3.0.5",
+    "@repodog/rollup-config": "^4.0.17",
+    "@repodog/swc-config": "^1.0.15",
+    "@repodog/syncpack-config": "^15.0.3",
+    "@repodog/ts-config": "^6.0.3",
+    "@rollup/plugin-swc": "^0.4.1",
+    "@swc/core": "^1.15.43",
     "@swc/jest": "^0.2.39",
-    "@types/jest": "^29.5.13",
+    "@types/jest": "^30.0.0",
     "@types/node": "^24.2.1",
-    "cts-types": "^0.0.10",
-    "del-cli": "^6.0.0",
-    "eslint": "^9.33.0",
+    "cts-types": "^0.0.11",
+    "del-cli": "^7.0.0",
+    "eslint": "^9.39.4",
     "generate-changelog": "^1.8.0",
     "husky": "^9.1.7",
-    "jest": "^29.7.0",
-    "jest-environment-jsdom": "^29.7.0",
-    "jest-environment-node": "^29.7.0",
-    "markdownlint-cli2": "^0.18.1",
-    "prettier": "^3.6.2",
-    "rollup": "^4.46.2",
+    "jest": "^30.4.2",
+    "jest-environment-node": "^30.4.1",
+    "markdownlint-cli2": "^0.23.0",
+    "prettier": "^3.9.5",
+    "rollup": "^4.62.2",
     "suppress-experimental-warnings": "^2.0.0",
-    "syncpack": "^13.0.4",
-    "typescript": "^5.9.2"
+    "syncpack": "^15.3.2",
+    "typescript": "^6.0.3"
   },
   "keywords": [
     "config",
@@ -110,7 +115,7 @@
     "lint:code": "eslint .",
     "lint:docs": "markdownlint-cli2 --config \".markdownlint.json\" \"**/*.md\" \"!**/node_modules/**\"",
     "repodog": "repodog",
-    "syncpack": "syncpack format && syncpack list-mismatches && syncpack lint-semver-ranges",
+    "syncpack": "syncpack format --check && syncpack lint",
     "test": "COMPILER=swc node --require=suppress-experimental-warnings --experimental-vm-modules node_modules/jest/bin/jest.js",
     "type-check": "tsc --noEmit",
     "validate": "pnpm run syncpack && pnpm run build && pnpm run lint && pnpm run type-check && pnpm run test",

package/pnpm-workspace.yaml

@@ -0,0 +1,4 @@
+allowBuilds:
+  '@swc/core': false
+  core-js: false
+  unrs-resolver: false

package/src/__testUtils__/builtConfig.ts

@@ -1,4 +1,4 @@
-/* eslint-disable prettier/prettier, import-x/no-default-export, unicorn/numeric-separators-style, unicorn/no-null */
+/* eslint-disable import-x/no-default-export, unicorn/numeric-separators-style, unicorn/no-null */
 /* This file is autogenerated, do not edit directly, your changes will not perist. */
 
 export default {

package/src/__testUtils__/configBuilder.ts

@@ -17,6 +17,32 @@ const pageBuilder = createConfigBuilder<PageType>(pageSchema);
 const sectionBuilder = createConfigBuilder<SectionType>(sectionSchema);
 const subsectionBuilder = sectionBuilder.$fork();
 
+const contactDetailsPage = pageBuilder
+  .name('contactDetails')
+  .sections([
+    sectionBuilder.name('header').$flush(),
+    sectionBuilder
+      .name('body')
+      .sections([subsectionBuilder.name('main').$flush(), subsectionBuilder.name('sidebar').$flush()])
+      .$flush(),
+    sectionBuilder.name('footer').$flush(),
+  ])
+  .$flush();
+
+const personalDetailPage = pageBuilder
+  .name('personalDetails')
+  .sections([
+    sectionBuilder.name('header').$flush(),
+    sectionBuilder
+      .name('body')
+      .sections([subsectionBuilder.name('main').$flush(), subsectionBuilder.name('sidebar').$flush()])
+      .$flush(),
+    sectionBuilder.name('footer').$flush(),
+  ])
+  .$flush();
+
+// Required for how builder is executed
+// eslint-disable-next-line unicorn/no-top-level-side-effects
 configBuilder
   .countryCode('GB')
   // Want to test using null value
@@ -29,28 +55,8 @@ configBuilder
     languageCodes?.length && countryCode ? languageCodes.map(code => `${code}_${countryCode}`) : [],
   )
   .pages({
-    contactDetails: pageBuilder
-      .name('contactDetails')
-      .sections([
-        sectionBuilder.name('header').$flush(),
-        sectionBuilder
-          .name('body')
-          .sections([subsectionBuilder.name('main').$flush(), subsectionBuilder.name('sidebar').$flush()])
-          .$flush(),
-        sectionBuilder.name('footer').$flush(),
-      ])
-      .$flush(),
-    personalDetails: pageBuilder
-      .name('personalDetails')
-      .sections([
-        sectionBuilder.name('header').$flush(),
-        sectionBuilder
-          .name('body')
-          .sections([subsectionBuilder.name('main').$flush(), subsectionBuilder.name('sidebar').$flush()])
-          .$flush(),
-        sectionBuilder.name('footer').$flush(),
-      ])
-      .$flush(),
+    contactDetails: contactDetailsPage,
+    personalDetails: personalDetailPage,
   })
   .routes([routeBuilder.page('personalDetails').$flush(), routeBuilder.page('contactDetails').$flush()])
   .timeouts({ apollo: 10_000 })

package/src/__testUtils__/schema.ts

@@ -48,9 +48,9 @@ export const configSchema = z.object({
   languageCodes: z.array(z.enum(languageCodes)).optional(),
   locales: z.array(z.string().regex(/[a-z]{2}_[A-Z]{2}/)).optional(),
   name: z.string().optional(),
-  pages: z.record(pageSchema).optional(),
+  pages: z.record(z.string(), pageSchema).optional(),
   routes: z.array(routeSchema).optional(),
-  timeouts: z.record(z.number()).optional(),
+  timeouts: z.record(z.string(), z.number()).optional(),
   timezone: z.enum(timezones).optional(),
 });
 

package/src/cli.ts

@@ -5,9 +5,15 @@ import yargs, { type Argv } from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import { importValidateTransformWriteConfig } from './utils/importValidateTransformWriteConfig.ts';
 
-export type Commands = 'build' | 'watch';
+export type CliCommands = 'build' | 'watch';
 
-const generateArguments = (cmdYargs: Argv) =>
+export type CliArguments = Argv<{
+  'experiments-callback-file'?: string;
+  'input-file': string;
+  'output-file': string;
+}>;
+
+const generateArguments = (cmdYargs: Argv): CliArguments =>
   cmdYargs
     .positional('input-file', {
       demandOption: true,
@@ -24,7 +30,7 @@ const generateArguments = (cmdYargs: Argv) =>
       type: 'string',
     });
 
-export const cli = () => {
+export const cli = (): void => {
   // yargs does not provide a way to pass generic to type args.
   // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
   const argv = yargs(hideBin(process.argv)) as Argv<{

package/src/createConfigBuilder.test.ts

@@ -1,5 +1,5 @@
 import { kebabCase } from 'lodash-es';
-import { ZodType, z } from 'zod';
+import { z } from 'zod';
 import {
   type ConfigType,
   type PageType,
@@ -62,7 +62,11 @@ describe('createConfigBuilder', () => {
     it('should copy over all values to the new config', async () => {
       const { createConfigBuilder } = await import('./createConfigBuilder.ts');
       const config = createConfigBuilder<ConfigType>(configSchema);
-      const route = createConfigBuilder<RouteType>(routeSchema, undefined, { path: ({ page }) => kebabCase(page) });
+
+      const route = createConfigBuilder<RouteType>(routeSchema, undefined, {
+        path: ({ page }) => kebabCase(page),
+      });
+
       const page = createConfigBuilder<PageType>(pageSchema);
 
       config
@@ -85,13 +89,19 @@ describe('createConfigBuilder', () => {
     it('should copy over all experiments to the new config', async () => {
       const { createConfigBuilder } = await import('./createConfigBuilder.ts');
       const config = createConfigBuilder<ConfigType>(configSchema);
-      const route = createConfigBuilder<RouteType>(routeSchema, undefined, { path: ({ page }) => kebabCase(page) });
+
+      const route = createConfigBuilder<RouteType>(routeSchema, undefined, {
+        path: ({ page }) => kebabCase(page),
+      });
+
       const page = createConfigBuilder<PageType>(pageSchema);
 
       config
         .$experiment('FEAT_ALPHA@0.0.1')
         .name('alpha')
-        .pages({ contactDetails: page.$experiment('FEAT_BRAVO@0.0.1').name('contactDetails').$flush() })
+        .pages({
+          contactDetails: page.$experiment('FEAT_BRAVO@0.0.1').name('contactDetails').$flush(),
+        })
         .routes([route.$experiment('FEAT_CHARLIE@0.0.1').page('contactDetails').$flush()]);
 
       const childConfig = createConfigBuilder<ConfigType>(configSchema);
@@ -102,13 +112,14 @@ describe('createConfigBuilder', () => {
           __experiment: 'FEAT_ALPHA@0.0.1',
           // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
           pages: expect.objectContaining({
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, unicorn/max-nested-calls
             contactDetails: expect.objectContaining({
               __experiment: 'FEAT_BRAVO@0.0.1',
             }),
           }),
           // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
           routes: expect.arrayContaining([
+            // eslint-disable-next-line unicorn/max-nested-calls
             expect.objectContaining({
               __experiment: 'FEAT_CHARLIE@0.0.1',
             }),
@@ -120,13 +131,19 @@ describe('createConfigBuilder', () => {
     it('should copy over all disabled flags to the new config', async () => {
       const { createConfigBuilder } = await import('./createConfigBuilder.ts');
       const config = createConfigBuilder<ConfigType>(configSchema);
-      const route = createConfigBuilder<RouteType>(routeSchema, undefined, { path: ({ page }) => kebabCase(page) });
+
+      const route = createConfigBuilder<RouteType>(routeSchema, undefined, {
+        path: ({ page }) => kebabCase(page),
+      });
+
       const page = createConfigBuilder<PageType>(pageSchema);
 
       config
         .$disable()
         .name('alpha')
-        .pages({ contactDetails: page.$disable().name('contactDetails').$flush() })
+        .pages({
+          contactDetails: page.$disable().name('contactDetails').$flush(),
+        })
         .routes([route.$disable().page('contactDetails').$flush()]);
 
       const childConfig = createConfigBuilder<ConfigType>(configSchema);
@@ -137,13 +154,14 @@ describe('createConfigBuilder', () => {
           __disabled: true,
           // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
           pages: expect.objectContaining({
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, unicorn/max-nested-calls
             contactDetails: expect.objectContaining({
               __disabled: true,
             }),
           }),
           // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
           routes: expect.arrayContaining([
+            // eslint-disable-next-line unicorn/max-nested-calls
             expect.objectContaining({
               __disabled: true,
             }),
@@ -154,12 +172,20 @@ describe('createConfigBuilder', () => {
 
     it('should copy over all derived value callbacks to the new config builder', async () => {
       const { createConfigBuilder } = await import('./createConfigBuilder.ts');
-      const route = createConfigBuilder<RouteType>(routeSchema, undefined, { path: ({ page }) => kebabCase(page) });
+
+      const route = createConfigBuilder<RouteType>(routeSchema, undefined, {
+        path: ({ page }) => kebabCase(page),
+      });
+
       route.page('personalDetails');
       const childRoute = createConfigBuilder<RouteType>(routeSchema);
       childRoute.$extend(route);
       childRoute.page('contactDetails', true);
-      expect(childRoute.$values()).toEqual({ page: 'contactDetails', path: 'contact-details' });
+
+      expect(childRoute.$values()).toEqual({
+        page: 'contactDetails',
+        path: 'contact-details',
+      });
     });
   });
 
@@ -174,7 +200,23 @@ describe('createConfigBuilder', () => {
           });
 
           const config = createConfigBuilder<z.infer<typeof extendedSchema>>(extendedSchema);
-          expect(config.$values()).toEqual({ description: 'This is the description.' });
+
+          expect(config.$values()).toMatchInlineSnapshot(`
+            {
+              "countryCode": undefined,
+              "countryName": undefined,
+              "description": "This is the description.",
+              "distanceUnit": undefined,
+              "enabled": undefined,
+              "languageCodes": undefined,
+              "locales": undefined,
+              "name": undefined,
+              "pages": undefined,
+              "routes": undefined,
+              "timeouts": undefined,
+              "timezone": undefined,
+            }
+          `);
         });
       });
 
@@ -183,11 +225,31 @@ describe('createConfigBuilder', () => {
           const { createConfigBuilder } = await import('./createConfigBuilder.ts');
 
           const extendedSchema = configSchema.extend({
-            flags: z.record(z.boolean()).optional().default({ alpha: true, bravo: false, charlie: false }),
+            flags: z.record(z.string(), z.boolean()).optional().default({ alpha: true, bravo: false, charlie: false }),
           });
 
           const config = createConfigBuilder<z.infer<typeof extendedSchema>>(extendedSchema);
-          expect(config.$values()).toEqual({ flags: { alpha: true, bravo: false, charlie: false } });
+
+          expect(config.$values()).toMatchInlineSnapshot(`
+            {
+              "countryCode": undefined,
+              "countryName": undefined,
+              "distanceUnit": undefined,
+              "enabled": undefined,
+              "flags": {
+                "alpha": true,
+                "bravo": false,
+                "charlie": false,
+              },
+              "languageCodes": undefined,
+              "locales": undefined,
+              "name": undefined,
+              "pages": undefined,
+              "routes": undefined,
+              "timeouts": undefined,
+              "timezone": undefined,
+            }
+          `);
         });
       });
 
@@ -200,7 +262,28 @@ describe('createConfigBuilder', () => {
           });
 
           const config = createConfigBuilder<z.infer<typeof extendedSchema>>(extendedSchema);
-          expect(config.$values()).toEqual({ colors: ['red', 'yellow', 'pink', 'green'] });
+
+          expect(config.$values()).toMatchInlineSnapshot(`
+            {
+              "colors": [
+                "red",
+                "yellow",
+                "pink",
+                "green",
+              ],
+              "countryCode": undefined,
+              "countryName": undefined,
+              "distanceUnit": undefined,
+              "enabled": undefined,
+              "languageCodes": undefined,
+              "locales": undefined,
+              "name": undefined,
+              "pages": undefined,
+              "routes": undefined,
+              "timeouts": undefined,
+              "timezone": undefined,
+            }
+          `);
         });
       });
 
@@ -218,7 +301,26 @@ describe('createConfigBuilder', () => {
           });
 
           const config = createConfigBuilder<z.infer<typeof extendedSchema>>(extendedSchema);
-          expect(config.$values()).toEqual({ flags: { alpha: true, bravo: true } });
+
+          expect(config.$values()).toMatchInlineSnapshot(`
+            {
+              "countryCode": undefined,
+              "countryName": undefined,
+              "distanceUnit": undefined,
+              "enabled": undefined,
+              "flags": {
+                "alpha": true,
+                "bravo": true,
+              },
+              "languageCodes": undefined,
+              "locales": undefined,
+              "name": undefined,
+              "pages": undefined,
+              "routes": undefined,
+              "timeouts": undefined,
+              "timezone": undefined,
+            }
+          `);
         });
       });
     });
@@ -229,7 +331,7 @@ describe('createConfigBuilder', () => {
           const { createConfigBuilder } = await import('./createConfigBuilder.ts');
 
           const extendedSchema = configSchema.extend({
-            flags: z.record(z.boolean().default(true)).optional(),
+            flags: z.record(z.string(), z.boolean().default(true)).optional(),
           });
 
           expect(() => createConfigBuilder<z.infer<typeof extendedSchema>>(extendedSchema)).toThrow(
@@ -399,7 +501,11 @@ describe('createConfigBuilder', () => {
         it('should add the value to the config', async () => {
           const { createConfigBuilder } = await import('./createConfigBuilder.ts');
           const config = createConfigBuilder<ConfigType>(configSchema);
-          const route = createConfigBuilder<RouteType>(routeSchema, undefined, { path: ({ page }) => kebabCase(page) });
+
+          const route = createConfigBuilder<RouteType>(routeSchema, undefined, {
+            path: ({ page }) => kebabCase(page),
+          });
+
           const subRoute = route.$fork();
 
           config.routes([
@@ -428,7 +534,10 @@ describe('createConfigBuilder', () => {
         it('should be a valid config', async () => {
           const { createConfigBuilder } = await import('./createConfigBuilder.ts');
           const config = createConfigBuilder<ConfigType>(configSchema);
-          const route = createConfigBuilder<RouteType>(routeSchema, undefined, { path: ({ page }) => kebabCase(page) });
+
+          const route = createConfigBuilder<RouteType>(routeSchema, undefined, {
+            path: ({ page }) => kebabCase(page),
+          });
 
           config.routes([
             route.page('personalDetails').$flush(),
@@ -483,7 +592,11 @@ describe('createConfigBuilder', () => {
             languageCodes?.length && countryCode ? languageCodes.map(code => `${code}_${countryCode}` as const) : [],
           );
 
-        expect(config.$values()).toEqual({ countryCode: 'GB', languageCodes: ['en'], locales: ['en_GB'] });
+        expect(config.$values()).toEqual({
+          countryCode: 'GB',
+          languageCodes: ['en'],
+          locales: ['en_GB'],
+        });
       });
 
       it('should update the value to the config automatically', async () => {
@@ -499,7 +612,11 @@ describe('createConfigBuilder', () => {
           )
           .languageCodes(['fr'], true);
 
-        expect(config.$values()).toEqual({ countryCode: 'GB', languageCodes: ['fr'], locales: ['fr_GB'] });
+        expect(config.$values()).toEqual({
+          countryCode: 'GB',
+          languageCodes: ['fr'],
+          locales: ['fr_GB'],
+        });
       });
 
       it('should be a valid config', async () => {
@@ -520,27 +637,29 @@ describe('createConfigBuilder', () => {
   });
 
   describe('when a user stringifies the config', () => {
-    describe('when a config value is a zod schema', () => {
-      it('should stringify the value to JSON schema correctly', async () => {
-        const { createConfigBuilder } = await import('./createConfigBuilder.ts');
-
-        const extendedSchema = configSchema.extend({
-          schema: z.instanceof(ZodType),
-        });
-
-        const config = createConfigBuilder<z.infer<typeof extendedSchema>>(extendedSchema);
+    it('should stringify the value to JSON correctly', async () => {
+      const { createConfigBuilder } = await import('./createConfigBuilder.ts');
+      const config = createConfigBuilder<ConfigType>(configSchema);
 
-        config.schema(
-          z
-            .object({
-              alpha: z.string(),
-              bravo: z.boolean(),
-            })
-            .optional(),
+      config
+        .countryCode('GB')
+        .languageCodes(['en'])
+        .locales(({ countryCode, languageCodes }) =>
+          // eslint-disable-next-line jest/no-conditional-in-test
+          languageCodes?.length && countryCode ? languageCodes.map(code => `${code}_${countryCode}`) : [],
         );
 
-        expect(config.$toJson()).toMatchSnapshot();
-      });
+      expect(config.$toJson()).toMatchInlineSnapshot(`
+       "{
+         "countryCode": "GB",
+         "languageCodes": [
+           "en"
+         ],
+         "locales": [
+           "en_GB"
+         ]
+       }"
+      `);
     });
   });
 });