zcb 0.0.27 → 0.1.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zcb",
   "description": "Build configs with type safety from zod schema.",
-  "version": "0.0.27",
+  "version": "0.1.1",
   "author": "Dylan Aubrey",
   "license": "MIT",
   "homepage": "https://github.com/badbatch/zod-config-builder",
@@ -15,12 +15,14 @@
   "module": "./dist/esm/index.mjs",
   "types": "./dist/types/cjs/index.d.cts",
   "exports": {
-    "types": {
-      "import": "./dist/types/esm/index.d.ts",
-      "require": "./dist/types/cjs/index.d.cts"
-    },
-    "import": "./dist/esm/index.mjs",
-    "require": "./dist/cjs/index.cjs"
+    ".": {
+      "types": {
+        "import": "./dist/types/esm/index.d.ts",
+        "require": "./dist/types/cjs/index.d.cts"
+      },
+      "import": "./dist/esm/index.mjs",
+      "require": "./dist/cjs/index.cjs"
+    }
   },
   "publishConfig": {
     "access": "public"
@@ -65,7 +67,7 @@
     "@commitlint/prompt-cli": "^17.6.3",
     "@jest/globals": "^29.5.0",
     "@repodog/babel-config": "^1.1.11",
-    "@repodog/cli": "^1.3.3",
+    "@repodog/cli": "^1.4.1",
     "@repodog/commitlint-config": "^1.1.6",
     "@repodog/eslint-config": "^1.1.19",
     "@repodog/eslint-config-jest": "^1.1.10",
@@ -74,7 +76,7 @@
     "@repodog/prettier-config": "^1.1.5",
     "@repodog/rollup-config": "^1.1.8",
     "@repodog/syncpack-config": "^1.2.3",
-    "@repodog/ts-config": "^1.1.7",
+    "@repodog/ts-config": "^1.3.0",
     "@rollup/plugin-babel": "^6.0.3",
     "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-image": "^3.0.2",
@@ -83,15 +85,15 @@
     "@rollup/plugin-terser": "^0.4.1",
     "@types/jest": "^25.2.3",
     "@types/lodash-es": "^4.17.9",
-    "@types/node": "^18.16.7",
+    "@types/node": "^20.11.0",
     "@typescript-eslint/eslint-plugin": "^5.59.5",
     "@typescript-eslint/parser": "^5.59.5",
     "babel-jest": "^29.5.0",
     "babel-plugin-codegen": "^4.1.5",
     "babel-plugin-macros": "^3.1.0",
     "core-js": "^3.30.2",
-    "cts-types": "^0.0.4",
-    "del-cli": "^3.0.1",
+    "cts-types": "^0.0.6",
+    "del-cli": "^5.1.0",
     "eslint": "^8.40.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-import-resolver-typescript": "^3.5.5",
@@ -104,7 +106,6 @@
     "eslint-plugin-sort-keys-fix": "^1.1.2",
     "eslint-plugin-typescript-sort-keys": "^2.3.0",
     "eslint-plugin-unicorn": "^46.0.1",
-    "fast-check": "^3.14.0",
     "generate-changelog": "^1.8.0",
     "husky": "^8.0.3",
     "identity-obj-proxy": "^3.0.0",
@@ -119,7 +120,7 @@
     "rollup-plugin-copy": "^3.4.0",
     "rollup-plugin-sourcemaps": "^0.6.3",
     "suppress-experimental-warnings": "^1.1.17",
-    "syncpack": "^12.0.0-alpha.0",
+    "syncpack": "^12.3.0",
     "ts-node": "^10.9.1",
     "typescript": "^5.0.4"
   },

package/src/__snapshots__/createConfigBuilder.test.ts.snap

@@ -0,0 +1,30 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`createConfigBuilder when a user stringifies the config when a config value is a zod schema should stringify the value to JSON schema correctly 1`] = `
+"{
+  "schema": {
+    "anyOf": [
+      {
+        "not": {}
+      },
+      {
+        "type": "object",
+        "properties": {
+          "alpha": {
+            "type": "string"
+          },
+          "bravo": {
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "alpha",
+          "bravo"
+        ],
+        "additionalProperties": false
+      }
+    ],
+    "$schema": "http://json-schema.org/draft-07/schema#"
+  }
+}"
+`;

package/src/__testUtils__/configBuilder.ts

@@ -15,7 +15,7 @@ const configBuilder = createConfigBuilder<ConfigType>(configSchema);
 const routeBuilder = createConfigBuilder<RouteType>(routeSchema, { path: ({ page }) => kebabCase(page) });
 const pageBuilder = createConfigBuilder<PageType>(pageSchema);
 const sectionBuilder = createConfigBuilder<SectionType>(sectionSchema);
-const subsectionBuilder = sectionBuilder.fork();
+const subsectionBuilder = sectionBuilder.$fork();
 
 configBuilder
   .countryCode('GB')
@@ -30,27 +30,27 @@ configBuilder
     contactDetails: pageBuilder
       .name('contactDetails')
       .sections([
-        sectionBuilder.name('header').flush(),
+        sectionBuilder.name('header').$flush(),
         sectionBuilder
           .name('body')
-          .sections([subsectionBuilder.name('main').flush(), subsectionBuilder.name('sidebar').flush()])
-          .flush(),
-        sectionBuilder.name('footer').flush(),
+          .sections([subsectionBuilder.name('main').$flush(), subsectionBuilder.name('sidebar').$flush()])
+          .$flush(),
+        sectionBuilder.name('footer').$flush(),
       ])
-      .flush(),
+      .$flush(),
     personalDetails: pageBuilder
       .name('personalDetails')
       .sections([
-        sectionBuilder.name('header').flush(),
+        sectionBuilder.name('header').$flush(),
         sectionBuilder
           .name('body')
-          .sections([subsectionBuilder.name('main').flush(), subsectionBuilder.name('sidebar').flush()])
-          .flush(),
-        sectionBuilder.name('footer').flush(),
+          .sections([subsectionBuilder.name('main').$flush(), subsectionBuilder.name('sidebar').$flush()])
+          .$flush(),
+        sectionBuilder.name('footer').$flush(),
       ])
-      .flush(),
+      .$flush(),
   })
-  .routes([routeBuilder.page('personalDetails').flush(), routeBuilder.page('contactDetails').flush()])
+  .routes([routeBuilder.page('personalDetails').$flush(), routeBuilder.page('contactDetails').$flush()])
   .timeouts({ apollo: 10_000 })
   .timezone('Europe/London');
 

package/src/createConfigBuilder.test.ts

@@ -1,5 +1,5 @@
 import { kebabCase } from 'lodash-es';
-import { z } from 'zod';
+import { ZodType, z } from 'zod';
 import {
   type ConfigType,
   type PageType,
@@ -27,11 +27,11 @@ describe('createConfigBuilder', () => {
       const { createConfigBuilder } = await import('./createConfigBuilder.ts');
 
       const invalidSchema = z.object({
-        values: z.string(),
+        $values: z.string(),
       });
 
       expect(() => createConfigBuilder<z.infer<typeof invalidSchema>>(invalidSchema)).toThrow(
-        `"values" is a reserved keyword within the config builder. Please use a different property name. The full list of reserved keywords is: ${[
+        `"$values" is a reserved keyword within the config builder. Please use a different property name. The full list of reserved keywords is: ${[
           ...RESERVED_KEYWORDS,
         ].join(', ')}`
       );
@@ -42,9 +42,9 @@ describe('createConfigBuilder', () => {
     it('should add the disabled flag to the config', async () => {
       const { createConfigBuilder } = await import('./createConfigBuilder.ts');
       const config = createConfigBuilder<ConfigType>(configSchema);
-      config.disable().name('alpha');
+      config.$disable().name('alpha');
       // @ts-expect-error private property
-      expect(config.values().__disabled).toBe(true);
+      expect(config.$values().__disabled).toBe(true);
     });
   });
 
@@ -52,9 +52,9 @@ describe('createConfigBuilder', () => {
     it('should add the experiment to the config', async () => {
       const { createConfigBuilder } = await import('./createConfigBuilder.ts');
       const config = createConfigBuilder<ConfigType>(configSchema);
-      config.experiment('FEAT_ALPHA@0.0.1').name('alpha');
+      config.$experiment('FEAT_ALPHA@0.0.1').name('alpha');
       // @ts-expect-error private property
-      expect(config.values().__experiment).toBe('FEAT_ALPHA@0.0.1');
+      expect(config.$values().__experiment).toBe('FEAT_ALPHA@0.0.1');
     });
   });
 
@@ -67,13 +67,13 @@ describe('createConfigBuilder', () => {
 
       config
         .name('alpha')
-        .pages({ contactDetails: page.name('contactDetails').flush() })
-        .routes([route.page('contactDetails').flush()]);
+        .pages({ contactDetails: page.name('contactDetails').$flush() })
+        .routes([route.page('contactDetails').$flush()]);
 
       const childConfig = createConfigBuilder<ConfigType>(configSchema);
-      childConfig.extend(config);
+      childConfig.$extend(config);
 
-      expect(childConfig.values()).toEqual({
+      expect(childConfig.$values()).toEqual({
         name: 'alpha',
         pages: {
           contactDetails: { name: 'contactDetails' },
@@ -89,15 +89,15 @@ describe('createConfigBuilder', () => {
       const page = createConfigBuilder<PageType>(pageSchema);
 
       config
-        .experiment('FEAT_ALPHA@0.0.1')
+        .$experiment('FEAT_ALPHA@0.0.1')
         .name('alpha')
-        .pages({ contactDetails: page.experiment('FEAT_BRAVO@0.0.1').name('contactDetails').flush() })
-        .routes([route.experiment('FEAT_CHARLIE@0.0.1').page('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);
-      childConfig.extend(config);
+      childConfig.$extend(config);
 
-      expect(childConfig.values()).toEqual(
+      expect(childConfig.$values()).toEqual(
         expect.objectContaining({
           __experiment: 'FEAT_ALPHA@0.0.1',
           // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
@@ -125,15 +125,15 @@ describe('createConfigBuilder', () => {
       const page = createConfigBuilder<PageType>(pageSchema);
 
       config
-        .disable()
+        .$disable()
         .name('alpha')
-        .pages({ contactDetails: page.disable().name('contactDetails').flush() })
-        .routes([route.disable().page('contactDetails').flush()]);
+        .pages({ contactDetails: page.$disable().name('contactDetails').$flush() })
+        .routes([route.$disable().page('contactDetails').$flush()]);
 
       const childConfig = createConfigBuilder<ConfigType>(configSchema);
-      childConfig.extend(config);
+      childConfig.$extend(config);
 
-      expect(childConfig.values()).toEqual(
+      expect(childConfig.$values()).toEqual(
         expect.objectContaining({
           __disabled: true,
           // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
@@ -159,9 +159,9 @@ describe('createConfigBuilder', () => {
       const route = createConfigBuilder<RouteType>(routeSchema, { path: ({ page }) => kebabCase(page) });
       route.page('personalDetails');
       const childRoute = createConfigBuilder<RouteType>(routeSchema);
-      childRoute.extend(route);
+      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' });
     });
   });
 
@@ -176,7 +176,7 @@ describe('createConfigBuilder', () => {
           });
 
           const config = createConfigBuilder<z.infer<typeof extendedSchema>>(extendedSchema);
-          expect(config.values()).toEqual({ description: 'This is the description.' });
+          expect(config.$values()).toEqual({ description: 'This is the description.' });
         });
       });
 
@@ -189,7 +189,7 @@ describe('createConfigBuilder', () => {
           });
 
           const config = createConfigBuilder<z.infer<typeof extendedSchema>>(extendedSchema);
-          expect(config.values()).toEqual({ flags: { alpha: true, bravo: false, charlie: false } });
+          expect(config.$values()).toEqual({ flags: { alpha: true, bravo: false, charlie: false } });
         });
       });
 
@@ -202,41 +202,40 @@ describe('createConfigBuilder', () => {
           });
 
           const config = createConfigBuilder<z.infer<typeof extendedSchema>>(extendedSchema);
-          expect(config.values()).toEqual({ colors: ['red', 'yellow', 'pink', 'green'] });
+          expect(config.$values()).toEqual({ colors: ['red', 'yellow', 'pink', 'green'] });
         });
       });
-    });
 
-    describe('and a config has an invalid default value', () => {
-      describe('and that value is a record of booleans', () => {
+      describe('and that value is an object of key/value pairs', () => {
         it('should throw an error', async () => {
           const { createConfigBuilder } = await import('./createConfigBuilder.ts');
 
           const extendedSchema = configSchema.extend({
-            flags: z.record(z.boolean().default(true)).optional(),
+            flags: z
+              .object({
+                alpha: z.boolean().default(true),
+                bravo: z.boolean().default(true),
+              })
+              .optional(),
           });
 
-          expect(() => createConfigBuilder<z.infer<typeof extendedSchema>>(extendedSchema)).toThrow(
-            'When setting schema property defaults for the object assigned to "flags", set them on the object and not the property.'
-          );
+          const config = createConfigBuilder<z.infer<typeof extendedSchema>>(extendedSchema);
+          expect(config.$values()).toEqual({ flags: { alpha: true, bravo: true } });
         });
       });
+    });
 
-      describe('and that value is an object of key/value pairs', () => {
+    describe('and a config has an invalid default value', () => {
+      describe('and that value is a record of booleans', () => {
         it('should throw an error', async () => {
           const { createConfigBuilder } = await import('./createConfigBuilder.ts');
 
           const extendedSchema = configSchema.extend({
-            flags: z
-              .object({
-                alpha: z.boolean().default(true),
-                bravo: z.boolean().default(true),
-              })
-              .optional(),
+            flags: z.record(z.boolean().default(true)).optional(),
           });
 
           expect(() => createConfigBuilder<z.infer<typeof extendedSchema>>(extendedSchema)).toThrow(
-            'When setting schema property defaults for the object assigned to "flags", set them on the object and not the property.'
+            'When setting schema property defaults for the value of the record assigned to "flags", set them on the record and not the value.'
           );
         });
       });
@@ -275,14 +274,14 @@ describe('createConfigBuilder', () => {
         const { createConfigBuilder } = await import('./createConfigBuilder.ts');
         const config = createConfigBuilder<ConfigType>(configSchema);
         config.countryCode('GB');
-        expect(config.values()).toEqual({ countryCode: 'GB' });
+        expect(config.$values()).toEqual({ countryCode: 'GB' });
       });
 
       it('should be a valid config', async () => {
         const { createConfigBuilder } = await import('./createConfigBuilder.ts');
         const config = createConfigBuilder<ConfigType>(configSchema);
         config.countryCode('GB');
-        expect(config.validate()).toBe(true);
+        expect(config.$validate()).toBe(true);
       });
     });
 
@@ -291,14 +290,14 @@ describe('createConfigBuilder', () => {
         const { createConfigBuilder } = await import('./createConfigBuilder.ts');
         const config = createConfigBuilder<ConfigType>(configSchema);
         config.languageCodes(['en']);
-        expect(config.values()).toEqual({ languageCodes: ['en'] });
+        expect(config.$values()).toEqual({ languageCodes: ['en'] });
       });
 
       it('should be a valid config', async () => {
         const { createConfigBuilder } = await import('./createConfigBuilder.ts');
         const config = createConfigBuilder<ConfigType>(configSchema);
         config.languageCodes(['en']);
-        expect(config.validate()).toBe(true);
+        expect(config.$validate()).toBe(true);
       });
     });
 
@@ -307,14 +306,14 @@ describe('createConfigBuilder', () => {
         const { createConfigBuilder } = await import('./createConfigBuilder.ts');
         const config = createConfigBuilder<ConfigType>(configSchema);
         config.timeouts({ apollo: 120_000 });
-        expect(config.values()).toEqual({ timeouts: { apollo: 120_000 } });
+        expect(config.$values()).toEqual({ timeouts: { apollo: 120_000 } });
       });
 
       it('should be a valid config', async () => {
         const { createConfigBuilder } = await import('./createConfigBuilder.ts');
         const config = createConfigBuilder<ConfigType>(configSchema);
         config.timeouts({ apollo: 120_000 });
-        expect(config.validate()).toBe(true);
+        expect(config.$validate()).toBe(true);
       });
     });
 
@@ -326,11 +325,11 @@ describe('createConfigBuilder', () => {
           const page = createConfigBuilder<PageType>(pageSchema);
 
           config.pages({
-            contactDetails: page.name('contactDetails').flush(),
-            personalDetails: page.name('personalDetails').flush(),
+            contactDetails: page.name('contactDetails').$flush(),
+            personalDetails: page.name('personalDetails').$flush(),
           });
 
-          expect(config.values()).toEqual({
+          expect(config.$values()).toEqual({
             pages: {
               contactDetails: {
                 name: 'contactDetails',
@@ -348,11 +347,11 @@ describe('createConfigBuilder', () => {
           const page = createConfigBuilder<PageType>(pageSchema);
 
           config.pages({
-            contactDetails: page.name('contactDetails').flush(),
-            personalDetails: page.name('personalDetails').flush(),
+            contactDetails: page.name('contactDetails').$flush(),
+            personalDetails: page.name('personalDetails').$flush(),
           });
 
-          expect(config.validate()).toBe(true);
+          expect(config.$validate()).toBe(true);
         });
       });
 
@@ -392,7 +391,7 @@ describe('createConfigBuilder', () => {
             // no catch
           }
 
-          expect(config.values()).toEqual({});
+          expect(config.$values()).toEqual({});
         });
       });
     });
@@ -403,17 +402,17 @@ describe('createConfigBuilder', () => {
           const { createConfigBuilder } = await import('./createConfigBuilder.ts');
           const config = createConfigBuilder<ConfigType>(configSchema);
           const route = createConfigBuilder<RouteType>(routeSchema, { path: ({ page }) => kebabCase(page) });
-          const subRoute = route.fork();
+          const subRoute = route.$fork();
 
           config.routes([
-            route.page('personalDetails').flush(),
+            route.page('personalDetails').$flush(),
             route
               .page('contactDetails')
-              .routes([subRoute.page('deliveryAddress').flush(), subRoute.page('billingAddress').flush()])
-              .flush(),
+              .routes([subRoute.page('deliveryAddress').$flush(), subRoute.page('billingAddress').$flush()])
+              .$flush(),
           ]);
 
-          expect(config.values()).toEqual({
+          expect(config.$values()).toEqual({
             routes: [
               { page: 'personalDetails', path: 'personal-details' },
               {
@@ -434,17 +433,17 @@ describe('createConfigBuilder', () => {
           const route = createConfigBuilder<RouteType>(routeSchema, { path: ({ page }) => kebabCase(page) });
 
           config.routes([
-            route.page('personalDetails').flush(),
+            route.page('personalDetails').$flush(),
             route
               .page('contactDetails')
               .routes(() => {
-                const subRoute = route.fork();
-                return [subRoute.page('deliveryAddress').flush(), subRoute.page('billingAddress').flush()];
+                const subRoute = route.$fork();
+                return [subRoute.page('deliveryAddress').$flush(), subRoute.page('billingAddress').$flush()];
               })
-              .flush(),
+              .$flush(),
           ]);
 
-          expect(config.validate()).toBe(true);
+          expect(config.$validate()).toBe(true);
         });
       });
 
@@ -468,7 +467,7 @@ describe('createConfigBuilder', () => {
             // no catch
           }
 
-          expect(config.values()).toEqual({});
+          expect(config.$values()).toEqual({});
         });
       });
     });
@@ -486,7 +485,7 @@ 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 () => {
@@ -502,7 +501,7 @@ 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 () => {
@@ -517,7 +516,32 @@ describe('createConfigBuilder', () => {
             languageCodes?.length && countryCode ? languageCodes.map(code => `${code}_${countryCode}`) : []
           );
 
-        expect(config.validate()).toBe(true);
+        expect(config.$validate()).toBe(true);
+      });
+    });
+  });
+
+  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);
+
+        config.schema(
+          z
+            .object({
+              alpha: z.string(),
+              bravo: z.boolean(),
+            })
+            .optional()
+        );
+
+        expect(config.$toJson()).toMatchSnapshot();
       });
     });
   });