zcb 0.3.2 → 0.3.4

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zcb",
   "description": "Build configs with type safety from zod schema.",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "author": "miami-man",
   "license": "MIT",
   "homepage": "https://github.com/badbatch/zod-config-builder",
@@ -14,6 +14,9 @@
   "main": "./dist/cjs/index.cjs",
   "module": "./dist/esm/index.mjs",
   "types": "./dist/types/cjs/index.d.cts",
+  "imports": {
+    "#*": "./src/*"
+  },
   "exports": {
     ".": {
       "types": {

package/src/createConfigBuilder.test.ts

@@ -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);
@@ -120,13 +130,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);
@@ -154,12 +170,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 +198,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,
+            }
+          `);
         });
       });
 
@@ -187,7 +227,27 @@ describe('createConfigBuilder', () => {
           });
 
           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 +260,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 +299,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,
+            }
+          `);
         });
       });
     });
@@ -399,7 +499,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 +532,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 +590,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 +610,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 () => {

package/src/createConfigBuilder.ts

@@ -190,6 +190,11 @@ export const createConfigBuilder = <ZodTypes>(
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     const castPropertyName = propertyName as keyof Config;
 
+    if (!jsonSchema.required?.includes(propertyName) && !(propertyName in config)) {
+      // @ts-expect-error Optional properties we want to exist in the config with undefined initial values.
+      config[propertyName] = undefined;
+    }
+
     // Aimed at making it easier for Typescript to derive type.
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     configBuilder[castPropertyName] = ((value: Config[keyof Config] | DerivedValueCallback, override?: boolean) => {

package/src/createConfigReader.test.ts

@@ -56,6 +56,7 @@ describe('createConfigReader', () => {
       it('should throw the expected error', () => {
         const reader = createReader();
 
+        // @ts-expect-error Required to test error
         expect(() => reader.read('pages.contactDetails.sections')).toThrow(
           'Path resolved to an object or an array of objects, but `read` can only resolve to a primitive value or an array of primitives. Use the `scope` method instead',
         );

package/src/types.ts

@@ -55,16 +55,11 @@ export type Primitive = string | number | boolean | bigint | symbol | null | und
 
 export type Prev = [never, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, ...0[]];
 
-export type Leaves<T, LeafPath extends string[] = [], Depth extends number = 10> = Depth extends never
-  ? never
-  : T extends Primitive
-    ? LeafPath
-    : // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      T extends readonly any[]
-      ? LeafPath
-      : {
-          [K in keyof T & string]: Leaves<T[K], [...LeafPath, K], Prev[Depth]>;
-        }[keyof T & string];
+export type IsArrayOfPrimitives<T> = T extends readonly (infer U)[]
+  ? Exclude<U, Primitive> extends never
+    ? true
+    : false
+  : false;
 
 export type OwnKeys<T> = Exclude<
   {
@@ -74,6 +69,16 @@ export type OwnKeys<T> = Exclude<
   `${string}[Symbol.${string}`
 >;
 
+export type Leaves<T, LeafPath extends string[] = [], Depth extends number = 10> = Depth extends never
+  ? never
+  : T extends Primitive
+    ? LeafPath
+    : IsArrayOfPrimitives<T> extends true
+      ? LeafPath
+      : {
+          [K in OwnKeys<T>]: Leaves<T[K], [...LeafPath, K], Prev[Depth]>;
+        }[OwnKeys<T>];
+
 export type Paths<T, ScopePath extends string[] = [], Depth extends number = 10> = Depth extends never
   ? never
   : T extends Primitive

package/src/utils/transformConfig.test.ts

@@ -17,18 +17,23 @@ describe('transformConfig', () => {
           "locales": [
             "en_GB",
           ],
+          "name": undefined,
           "pages": {
             "contactDetails": {
               "name": "contactDetails",
+              "path": undefined,
+              "queryParams": undefined,
               "sections": [
                 {
                   "name": "header",
+                  "sections": undefined,
                 },
                 {
                   "name": "body",
                   "sections": [
                     {
                       "name": "main",
+                      "sections": undefined,
                     },
                     {
                       "name": "sidebar",
@@ -65,8 +70,10 @@ describe('transformConfig', () => {
           },
           "routes": [
             {
+              "aliases": undefined,
               "page": "personalDetails",
               "path": "personal-details",
+              "routes": undefined,
             },
             {
               "page": "contactDetails",
@@ -100,18 +107,23 @@ describe('transformConfigSync', () => {
           "locales": [
             "en_GB",
           ],
+          "name": undefined,
           "pages": {
             "contactDetails": {
               "name": "contactDetails",
+              "path": undefined,
+              "queryParams": undefined,
               "sections": [
                 {
                   "name": "header",
+                  "sections": undefined,
                 },
                 {
                   "name": "body",
                   "sections": [
                     {
                       "name": "main",
+                      "sections": undefined,
                     },
                     {
                       "name": "sidebar",
@@ -148,8 +160,10 @@ describe('transformConfigSync', () => {
           },
           "routes": [
             {
+              "aliases": undefined,
               "page": "personalDetails",
               "path": "personal-details",
+              "routes": undefined,
             },
             {
               "page": "contactDetails",

package/src/utils/transformWriteConfig.test.ts

@@ -0,0 +1,111 @@
+import { jest } from '@jest/globals';
+import configBuilder from '../__testUtils__/configBuilder.ts';
+
+jest.unstable_mockModule('fs-extra/esm', () => ({
+  outputFileSync: jest.fn(),
+}));
+
+jest.unstable_mockModule('shelljs', () => ({
+  default: {
+    echo: jest.fn(),
+    exec: jest.fn(),
+    exit: jest.fn(),
+  },
+}));
+
+const { outputFileSync } = jest.mocked(await import('fs-extra/esm'));
+const { transformWriteConfig } = await import('./transformWriteConfig.ts');
+
+describe('transformWriteConfig', () => {
+  it('should call outputFileSync with the expected file content', async () => {
+    await transformWriteConfig(configBuilder.$values(), {
+      outputFile: 'config.ts',
+    });
+
+    expect(outputFileSync.mock.calls[0]?.[1]).toMatchInlineSnapshot(`
+      "/* eslint-disable prettier/prettier, 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 {
+        countryCode: "GB",
+        countryName: null,
+        distanceUnit: "km",
+        enabled: true,
+        languageCodes: [
+          "en"
+        ],
+        locales: [
+          "en_GB"
+        ],
+        name: undefined,
+        pages: {
+          contactDetails: {
+            path: undefined,
+            queryParams: undefined,
+            sections: [
+              {
+                sections: undefined,
+                name: "header"
+              },
+              {
+                name: "body",
+                sections: [
+                  {
+                    sections: undefined,
+                    name: "main"
+                  },
+                  {
+                    name: "sidebar"
+                  }
+                ]
+              },
+              {
+                name: "footer"
+              }
+            ],
+            name: "contactDetails"
+          },
+          personalDetails: {
+            name: "personalDetails",
+            sections: [
+              {
+                name: "header"
+              },
+              {
+                name: "body",
+                sections: [
+                  {
+                    name: "main"
+                  },
+                  {
+                    name: "sidebar"
+                  }
+                ]
+              },
+              {
+                name: "footer"
+              }
+            ]
+          }
+        },
+        routes: [
+          {
+            aliases: undefined,
+            routes: undefined,
+            page: "personalDetails",
+            path: "personal-details"
+          },
+          {
+            page: "contactDetails",
+            path: "contact-details"
+          }
+        ],
+        timeouts: {
+          apollo: 10000
+        },
+        timezone: "Europe/London"
+      } as const;
+      "
+    `);
+  });
+});

package/src/utils/transformWriteConfig.ts

@@ -20,13 +20,18 @@ export const transformWriteConfig = async <Config extends object>(
   }
 
   const template = Handlebars.compile(
-    readFileSync(resolve(dirname(fileURLToPath(import.meta.url)), './templates/config.ts.hbs'), { encoding: 'utf8' }),
+    readFileSync(resolve(dirname(fileURLToPath(import.meta.url)), '../templates/config.ts.hbs'), { encoding: 'utf8' }),
   );
 
-  const output = template({ config: JSON.stringify(await transformConfig(config, handlers), undefined, 2) }).replaceAll(
-    /"([A-Za-z][\dA-Za-z]+)":/g,
-    '$1:',
-  );
+  const output = template({
+    config: JSON.stringify(
+      await transformConfig(config, handlers),
+      (_k, v: unknown) => (v === undefined ? 'undefined' : v),
+      2,
+    ),
+  })
+    .replaceAll(/"([A-Za-z][\dA-Za-z]+)":/g, '$1:')
+    .replaceAll('"undefined"', 'undefined');
 
   shelljs.echo(`zcd watch => writing to file: ${outputFile}`);
   shelljs.echo(`zcd watch => content to write:\n${output}\n`);