zcb 0.1.0 → 0.1.2

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zcb",
   "description": "Build configs with type safety from zod schema.",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "author": "Dylan Aubrey",
   "license": "MIT",
   "homepage": "https://github.com/badbatch/zod-config-builder",

package/src/createConfigBuilder.test.ts

@@ -205,38 +205,37 @@ describe('createConfigBuilder', () => {
           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.'
           );
         });
       });

package/src/createConfigBuilder.ts

@@ -1,9 +1,11 @@
 import { type JSONSchema7 } from 'json-schema';
+import { cloneDeep, merge } from 'lodash-es';
 import { type ZodError, type z } from 'zod';
 import { zodToJsonSchema } from 'zod-to-json-schema';
 import { cloneNonEnumerableValues } from './transformers/cloneNonEnumerableValues.ts';
 import { NonEmumeralProperties } from './types.ts';
 import { arrayHasInvalidDefaults } from './utils/arrayHasInvalidDefaults.ts';
+import { collateObjectPropertyDefaults } from './utils/collateObjectPropertyDefaults.ts';
 import { isDerivedValueCallback } from './utils/isDerivedValueCallback.ts';
 import { isInvalidPropertyOverride } from './utils/isInvalidPropertyOverride.ts';
 import { RESERVED_KEYWORDS, isPropertyReservedWord } from './utils/isPropertyReservedWord.ts';
@@ -11,7 +13,6 @@ import { isSchemaValid } from './utils/isSchemaValid.ts';
 import { isValidPropertyDefinition } from './utils/isValidPropertyDefinition.ts';
 import { isValidValue } from './utils/isValidValue.ts';
 import { jsonStringifyReplacer } from './utils/jsonStringifyReplacer.ts';
-import { objectHasInvalidDefaults } from './utils/objectHasInvalidDefaults.ts';
 import { recordHasInvalidDefaults } from './utils/recordHasInvalidDefaults.ts';
 import { transformConfigSync } from './utils/transformConfig.ts';
 
@@ -51,7 +52,8 @@ export const createConfigBuilder = <ZodTypes>(
   };
 
   type DerivedValueCallback<K extends keyof Config = keyof Config> = (c: Config) => Config[K];
-  let config = initialValues as Config;
+  let config = cloneDeep(initialValues) as Config;
+  const defaultValues = {} as Partial<Config>;
 
   Object.defineProperty(config, NonEmumeralProperties.ZCB, {
     configurable: false,
@@ -95,7 +97,7 @@ export const createConfigBuilder = <ZodTypes>(
     },
     $flush: () => {
       const values = configBuilder.$values();
-      config = {} as Config;
+      config = cloneDeep(defaultValues) as Config;
 
       Object.defineProperty(config, NonEmumeralProperties.ZCB, {
         configurable: false,
@@ -155,7 +157,7 @@ export const createConfigBuilder = <ZodTypes>(
 
     if (isValidPropertyDefinition(propertyDefinition)) {
       if (propertyDefinition.default) {
-        config[castProperty] = propertyDefinition.default as Config[keyof Config];
+        defaultValues[castProperty] = propertyDefinition.default as Config[keyof Config];
       }
 
       if (propertyDefinition.type === 'array' && arrayHasInvalidDefaults(propertyDefinition)) {
@@ -167,22 +169,22 @@ export const createConfigBuilder = <ZodTypes>(
       }
 
       if (propertyDefinition.type === 'object') {
-        if (objectHasInvalidDefaults(propertyDefinition)) {
+        if (recordHasInvalidDefaults(propertyDefinition)) {
           throw new Error(
-            `When setting schema property defaults for the object assigned to "${String(
+            `When setting schema property defaults for the value of the record assigned to "${String(
               castProperty
-            )}", set them on the object and not the property.`
+            )}", set them on the record and not the value.`
           );
         }
 
-        if (recordHasInvalidDefaults(propertyDefinition)) {
-          throw new Error(
-            `When setting schema property defaults for the object assigned to "${String(
-              castProperty
-            )}", set them on the object and not the property.`
-          );
+        const propertyDefaults = collateObjectPropertyDefaults(propertyDefinition);
+
+        if (propertyDefaults) {
+          defaultValues[castProperty] = propertyDefaults as Config[keyof Config];
         }
       }
+
+      merge(config, cloneDeep(defaultValues));
     }
 
     configBuilder[castProperty] = ((value: Config[keyof Config] | DerivedValueCallback, override?: boolean) => {

package/src/utils/collateObjectPropertyDefaults.ts

@@ -0,0 +1,26 @@
+import type { JSONSchema7 } from 'json-schema';
+import { isBoolean, isUndefined } from 'lodash-es';
+import type { Jsonifiable } from 'type-fest';
+import { objectPropertyHasDefaults } from './objectPropertyHasDefaults.ts';
+
+export const collateObjectPropertyDefaults = (propertyDefinition: JSONSchema7) => {
+  const { properties } = propertyDefinition;
+
+  if (!properties || !objectPropertyHasDefaults(propertyDefinition)) {
+    return;
+  }
+
+  return Object.keys(properties).reduce<Record<string, Jsonifiable>>((acc, key) => {
+    const propertyDef = properties[key];
+
+    if (!propertyDef || isBoolean(propertyDef)) {
+      return acc;
+    }
+
+    if ('default' in propertyDef && !isUndefined(propertyDef.default)) {
+      acc[key] = propertyDef.default;
+    }
+
+    return acc;
+  }, {});
+};

package/src/utils/{objectHasInvalidDefaults.ts → objectPropertyHasDefaults.ts}

@@ -1,5 +1,5 @@
 import type { JSONSchema7 } from 'json-schema';
 
-export const objectHasInvalidDefaults = (propertyDefinition: JSONSchema7) =>
+export const objectPropertyHasDefaults = (propertyDefinition: JSONSchema7) =>
   propertyDefinition.properties &&
   Object.values(propertyDefinition.properties).some(value => typeof value === 'object' && 'default' in value);

package/dist/types/cjs/utils/objectHasInvalidDefaults.d.cts

@@ -1,3 +0,0 @@
-import type { JSONSchema7 } from 'json-schema';
-export declare const objectHasInvalidDefaults: (propertyDefinition: JSONSchema7) => boolean | undefined;
-//# sourceMappingURL=objectHasInvalidDefaults.d.cts.map

package/dist/types/cjs/utils/objectHasInvalidDefaults.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"objectHasInvalidDefaults.d.cts","sourceRoot":"","sources":["../../../../src/utils/objectHasInvalidDefaults.cts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C,eAAO,MAAM,wBAAwB,uBAAwB,WAAW,wBAEqC,CAAC"}

package/dist/types/esm/utils/objectHasInvalidDefaults.d.ts

@@ -1,3 +0,0 @@
-import type { JSONSchema7 } from 'json-schema';
-export declare const objectHasInvalidDefaults: (propertyDefinition: JSONSchema7) => boolean | undefined;
-//# sourceMappingURL=objectHasInvalidDefaults.d.ts.map

package/dist/types/esm/utils/objectHasInvalidDefaults.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"objectHasInvalidDefaults.d.ts","sourceRoot":"","sources":["../../../../src/utils/objectHasInvalidDefaults.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C,eAAO,MAAM,wBAAwB,uBAAwB,WAAW,wBAEqC,CAAC"}