zcb 0.1.2 → 0.2.0

package/package.json

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

package/src/__testUtils__/configBuilder.ts

@@ -12,7 +12,7 @@ import {
 } from './schema.ts';
 
 const configBuilder = createConfigBuilder<ConfigType>(configSchema);
-const routeBuilder = createConfigBuilder<RouteType>(routeSchema, { path: ({ page }) => kebabCase(page) });
+const routeBuilder = createConfigBuilder<RouteType>(routeSchema, undefined, { path: ({ page }) => kebabCase(page) });
 const pageBuilder = createConfigBuilder<PageType>(pageSchema);
 const sectionBuilder = createConfigBuilder<SectionType>(sectionSchema);
 const subsectionBuilder = sectionBuilder.$fork();

package/src/createConfigBuilder.test.ts

@@ -62,7 +62,7 @@ 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, { path: ({ page }) => kebabCase(page) });
+      const route = createConfigBuilder<RouteType>(routeSchema, undefined, { path: ({ page }) => kebabCase(page) });
       const page = createConfigBuilder<PageType>(pageSchema);
 
       config
@@ -85,7 +85,7 @@ 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, { path: ({ page }) => kebabCase(page) });
+      const route = createConfigBuilder<RouteType>(routeSchema, undefined, { path: ({ page }) => kebabCase(page) });
       const page = createConfigBuilder<PageType>(pageSchema);
 
       config
@@ -121,7 +121,7 @@ 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, { path: ({ page }) => kebabCase(page) });
+      const route = createConfigBuilder<RouteType>(routeSchema, undefined, { path: ({ page }) => kebabCase(page) });
       const page = createConfigBuilder<PageType>(pageSchema);
 
       config
@@ -156,7 +156,7 @@ 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, { 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);
@@ -401,7 +401,7 @@ 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, { path: ({ page }) => kebabCase(page) });
+          const route = createConfigBuilder<RouteType>(routeSchema, undefined, { path: ({ page }) => kebabCase(page) });
           const subRoute = route.$fork();
 
           config.routes([
@@ -430,7 +430,7 @@ 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, { path: ({ page }) => kebabCase(page) });
+          const route = createConfigBuilder<RouteType>(routeSchema, undefined, { path: ({ page }) => kebabCase(page) });
 
           config.routes([
             route.page('personalDetails').$flush(),

package/src/createConfigBuilder.ts

@@ -4,16 +4,13 @@ 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 { collateDefaultValues } from './utils/collateDefaultValues.ts';
 import { isDerivedValueCallback } from './utils/isDerivedValueCallback.ts';
 import { isInvalidPropertyOverride } from './utils/isInvalidPropertyOverride.ts';
 import { RESERVED_KEYWORDS, isPropertyReservedWord } from './utils/isPropertyReservedWord.ts';
 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 { recordHasInvalidDefaults } from './utils/recordHasInvalidDefaults.ts';
 import { transformConfigSync } from './utils/transformConfig.ts';
 
 export type ConfigBuilder<ZodTypes> = {
@@ -33,8 +30,13 @@ export type ConfigBuilder<ZodTypes> = {
   $values: () => ZodTypes;
 };
 
+export type CreateConfigBuilderOptions = {
+  type?: string;
+};
+
 export const createConfigBuilder = <ZodTypes>(
   zodSchema: z.ZodSchema,
+  options: CreateConfigBuilderOptions = {},
   derivedValueCallbacks: Partial<
     Record<
       keyof ZodTypes,
@@ -52,15 +54,36 @@ export const createConfigBuilder = <ZodTypes>(
   };
 
   type DerivedValueCallback<K extends keyof Config = keyof Config> = (c: Config) => Config[K];
-  let config = cloneDeep(initialValues) as Config;
-  const defaultValues = {} as Partial<Config>;
 
-  Object.defineProperty(config, NonEmumeralProperties.ZCB, {
-    configurable: false,
-    enumerable: false,
-    value: true,
-  });
+  const jsonSchema = zodToJsonSchema(zodSchema) as JSONSchema7;
 
+  if (isSchemaValid(jsonSchema)) {
+    throw new Error(`The root type of a config schema must be "object", but received "${String(jsonSchema.type)}"`);
+  }
+
+  const addNonEnumeralBaseProperties = (conf: Config) => {
+    Object.defineProperty(conf, NonEmumeralProperties.ZCB, {
+      configurable: false,
+      enumerable: false,
+      value: true,
+    });
+
+    if (options.type) {
+      Object.defineProperty(conf, NonEmumeralProperties.TYPE, {
+        configurable: false,
+        enumerable: false,
+        value: options.type,
+      });
+    }
+  };
+
+  const createInitialConfig = () => {
+    const config = merge(cloneDeep(initialValues), collateDefaultValues(jsonSchema)) as Config;
+    addNonEnumeralBaseProperties(config);
+    return config;
+  };
+
+  let config = createInitialConfig();
   let callbacks: Partial<Record<keyof Config, DerivedValueCallback>> = { ...derivedValueCallbacks };
 
   const configBuilder = {
@@ -97,17 +120,10 @@ export const createConfigBuilder = <ZodTypes>(
     },
     $flush: () => {
       const values = configBuilder.$values();
-      config = cloneDeep(defaultValues) as Config;
-
-      Object.defineProperty(config, NonEmumeralProperties.ZCB, {
-        configurable: false,
-        enumerable: false,
-        value: true,
-      });
-
+      config = createInitialConfig();
       return values;
     },
-    $fork: () => createConfigBuilder<Config>(zodSchema, derivedValueCallbacks),
+    $fork: () => createConfigBuilder<Config>(zodSchema, options, derivedValueCallbacks, initialValues),
     $toJson: () => JSON.stringify(configBuilder.$values(), jsonStringifyReplacer, 2),
     $validate: () => {
       try {
@@ -137,12 +153,6 @@ export const createConfigBuilder = <ZodTypes>(
     value: callbacks,
   });
 
-  const jsonSchema = zodToJsonSchema(zodSchema) as JSONSchema7;
-
-  if (isSchemaValid(jsonSchema)) {
-    throw new Error(`The root type of a config schema must be "object", but received "${String(jsonSchema.type)}"`);
-  }
-
   for (const propertyName in jsonSchema.properties) {
     if (isPropertyReservedWord(propertyName)) {
       throw new Error(
@@ -152,47 +162,13 @@ export const createConfigBuilder = <ZodTypes>(
       );
     }
 
-    const castProperty = propertyName as keyof Config;
-    const propertyDefinition = jsonSchema.properties[propertyName];
-
-    if (isValidPropertyDefinition(propertyDefinition)) {
-      if (propertyDefinition.default) {
-        defaultValues[castProperty] = propertyDefinition.default as Config[keyof Config];
-      }
-
-      if (propertyDefinition.type === 'array' && arrayHasInvalidDefaults(propertyDefinition)) {
-        throw new Error(
-          `When setting schema array defaults for the array assigned to "${String(
-            castProperty
-          )}", set them on the array and not the item.`
-        );
-      }
-
-      if (propertyDefinition.type === 'object') {
-        if (recordHasInvalidDefaults(propertyDefinition)) {
-          throw new Error(
-            `When setting schema property defaults for the value of the record assigned to "${String(
-              castProperty
-            )}", set them on the record and not the value.`
-          );
-        }
-
-        const propertyDefaults = collateObjectPropertyDefaults(propertyDefinition);
-
-        if (propertyDefaults) {
-          defaultValues[castProperty] = propertyDefaults as Config[keyof Config];
-        }
-      }
-
-      merge(config, cloneDeep(defaultValues));
-    }
+    const castPropertyName = propertyName as keyof Config;
 
-    configBuilder[castProperty] = ((value: Config[keyof Config] | DerivedValueCallback, override?: boolean) => {
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-      if (isInvalidPropertyOverride(config[castProperty], override)) {
+    configBuilder[castPropertyName] = ((value: Config[keyof Config] | DerivedValueCallback, override?: boolean) => {
+      if (isInvalidPropertyOverride(config[castPropertyName], override)) {
         throw new Error(
           `A value already exists for "${String(
-            castProperty
+            castPropertyName
           )}". You may be trying to add a new values before flushing the old one. If you intended to override the existing value, pass in true as the second argument.`
         );
       }
@@ -203,19 +179,19 @@ export const createConfigBuilder = <ZodTypes>(
       if (!isValidValue(value)) {
         throw new Error(
           `"${String(
-            castProperty
+            castPropertyName
           )}" value has a depth greater than ${MAX_DEPTH}. To pass in objects with a depth greater than ${MAX_DEPTH}, create a builder for that config slice.`
         );
       }
 
       if (isDerivedValueCallback<DerivedValueCallback>(value)) {
-        callbacks[castProperty] = value;
+        callbacks[castPropertyName] = value;
         propertyValue = value(config);
       } else {
         propertyValue = value;
       }
 
-      config[castProperty] = propertyValue;
+      config[castPropertyName] = propertyValue;
       return configBuilder;
     }) as ConfigBuilder<Config>[keyof Config];
   }

package/src/types.ts

@@ -19,6 +19,7 @@ export enum NonEmumeralProperties {
   CALLBACKS = '__callbacks',
   DISABLED = '__disabled',
   EXPERIMENT = '__experiment',
+  TYPE = '__type',
   ZCB = '__zcb',
 }
 

package/src/utils/collateDefaultValues.ts

@@ -0,0 +1,55 @@
+import { type JSONSchema7 } from 'json-schema';
+import { arrayHasInvalidDefaults } from './arrayHasInvalidDefaults.ts';
+import { collateObjectPropertyDefaults } from './collateObjectPropertyDefaults.ts';
+import { RESERVED_KEYWORDS, isPropertyReservedWord } from './isPropertyReservedWord.ts';
+import { isValidPropertyDefinition } from './isValidPropertyDefinition.ts';
+import { recordHasInvalidDefaults } from './recordHasInvalidDefaults.ts';
+
+export const collateDefaultValues = <Config>(jsonSchema: JSONSchema7) => {
+  const defaultValues = {} as Partial<Config>;
+
+  for (const propertyName in jsonSchema.properties) {
+    if (isPropertyReservedWord(propertyName)) {
+      throw new Error(
+        `"${propertyName}" is a reserved keyword within the config builder. Please use a different property name. The full list of reserved keywords is: ${[
+          ...RESERVED_KEYWORDS,
+        ].join(', ')}`
+      );
+    }
+
+    const castPropertyName = propertyName as keyof Config;
+    const propertyDefinition = jsonSchema.properties[propertyName];
+
+    if (isValidPropertyDefinition(propertyDefinition)) {
+      if (propertyDefinition.default) {
+        defaultValues[castPropertyName] = propertyDefinition.default as Config[keyof Config];
+      }
+
+      if (propertyDefinition.type === 'array' && arrayHasInvalidDefaults(propertyDefinition)) {
+        throw new Error(
+          `When setting schema array defaults for the array assigned to "${String(
+            castPropertyName
+          )}", set them on the array and not the item.`
+        );
+      }
+
+      if (propertyDefinition.type === 'object') {
+        if (recordHasInvalidDefaults(propertyDefinition)) {
+          throw new Error(
+            `When setting schema property defaults for the value of the record assigned to "${String(
+              castPropertyName
+            )}", set them on the record and not the value.`
+          );
+        }
+
+        const propertyDefaults = collateObjectPropertyDefaults(propertyDefinition);
+
+        if (propertyDefaults) {
+          defaultValues[castPropertyName] = propertyDefaults as Config[keyof Config];
+        }
+      }
+    }
+  }
+
+  return defaultValues;
+};