zcb 0.0.27 → 0.1.1

package/src/createConfigBuilder.ts

@@ -4,13 +4,14 @@ 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';
 import { isSchemaValid } from './utils/isSchemaValid.ts';
 import { isValidPropertyDefinition } from './utils/isValidPropertyDefinition.ts';
 import { isValidValue } from './utils/isValidValue.ts';
-import { objectHasInvalidDefaults } from './utils/objectHasInvalidDefaults.ts';
+import { jsonStringifyReplacer } from './utils/jsonStringifyReplacer.ts';
 import { recordHasInvalidDefaults } from './utils/recordHasInvalidDefaults.ts';
 import { transformConfigSync } from './utils/transformConfig.ts';
 
@@ -20,15 +21,15 @@ export type ConfigBuilder<ZodTypes> = {
     override?: boolean
   ) => ConfigBuilder<ZodTypes>;
 } & {
-  disable: () => ConfigBuilder<ZodTypes>;
-  errors: () => ZodError['errors'];
-  experiment: (key: string) => ConfigBuilder<ZodTypes>;
-  extend: (configBuilder: ConfigBuilder<ZodTypes>) => ConfigBuilder<ZodTypes>;
-  flush: () => ZodTypes;
-  fork: () => ConfigBuilder<ZodTypes>;
-  toJson: () => string;
-  validate: () => boolean;
-  values: () => ZodTypes;
+  $disable: () => ConfigBuilder<ZodTypes>;
+  $errors: () => ZodError['errors'];
+  $experiment: (key: string) => ConfigBuilder<ZodTypes>;
+  $extend: (configBuilder: ConfigBuilder<ZodTypes>) => ConfigBuilder<ZodTypes>;
+  $flush: () => ZodTypes;
+  $fork: () => ConfigBuilder<ZodTypes>;
+  $toJson: () => string;
+  $validate: () => boolean;
+  $values: () => ZodTypes;
 };
 
 export const createConfigBuilder = <ZodTypes>(
@@ -61,7 +62,7 @@ export const createConfigBuilder = <ZodTypes>(
   let callbacks: Partial<Record<keyof Config, DerivedValueCallback>> = { ...derivedValueCallbacks };
 
   const configBuilder = {
-    disable: () => {
+    $disable: () => {
       Object.defineProperty(config, NonEmumeralProperties.DISABLED, {
         configurable: false,
         enumerable: false,
@@ -70,15 +71,15 @@ export const createConfigBuilder = <ZodTypes>(
 
       return configBuilder;
     },
-    errors: () => {
+    $errors: () => {
       try {
-        zodSchema.parse(configBuilder.values());
+        zodSchema.parse(configBuilder.$values());
         return [];
       } catch (error: unknown) {
         return (error as ZodError).errors;
       }
     },
-    experiment: (key: string) => {
+    $experiment: (key: string) => {
       Object.defineProperty(config, NonEmumeralProperties.EXPERIMENT, {
         configurable: false,
         enumerable: false,
@@ -87,13 +88,13 @@ export const createConfigBuilder = <ZodTypes>(
 
       return configBuilder;
     },
-    extend: (builder: ConfigBuilder<Config>) => {
-      config = transformConfigSync<Config>(builder.values(), [cloneNonEnumerableValues]);
+    $extend: (builder: ConfigBuilder<Config>) => {
+      config = transformConfigSync<Config>(builder.$values(), [cloneNonEnumerableValues]);
       // @ts-expect-error private property
       callbacks = { ...builder.__callbacks } as Partial<Record<keyof Config, DerivedValueCallback>>;
     },
-    flush: () => {
-      const values = configBuilder.values();
+    $flush: () => {
+      const values = configBuilder.$values();
       config = {} as Config;
 
       Object.defineProperty(config, NonEmumeralProperties.ZCB, {
@@ -104,18 +105,18 @@ export const createConfigBuilder = <ZodTypes>(
 
       return values;
     },
-    fork: () => createConfigBuilder<Config>(zodSchema, derivedValueCallbacks),
-    toJson: () => JSON.stringify(configBuilder.values(), undefined, 2),
-    validate: () => {
+    $fork: () => createConfigBuilder<Config>(zodSchema, derivedValueCallbacks),
+    $toJson: () => JSON.stringify(configBuilder.$values(), jsonStringifyReplacer, 2),
+    $validate: () => {
       try {
-        zodSchema.parse(configBuilder.values());
+        zodSchema.parse(configBuilder.$values());
         return true;
       } catch (error: unknown) {
         console.error(error);
         return false;
       }
     },
-    values: () => {
+    $values: () => {
       for (const property in callbacks) {
         const callback = callbacks[property];
 
@@ -166,20 +167,18 @@ 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) {
+          config[castProperty] = propertyDefaults as Config[keyof Config];
         }
       }
     }

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/importValidateTransformWriteConfig.ts

@@ -13,20 +13,20 @@ export const importValidateTransformWriteConfig = (
 ) => {
   import(resolve(process.cwd(), inputFile))
     .then(({ default: configBuilder }: { default: ConfigBuilder<object> }) => {
-      if (!configBuilder.validate()) {
+      if (!configBuilder.$validate()) {
         shelljs.echo(`zcd ${command} => invalid config`);
-        shelljs.echo(`zcd ${command} => config values:\n${configBuilder.toJson()}\n`);
-        shelljs.echo(`zcd ${command} => errors:\n${JSON.stringify(configBuilder.errors(), undefined, 2)}\n`);
+        shelljs.echo(`zcd ${command} => config values:\n${configBuilder.$toJson()}\n`);
+        shelljs.echo(`zcd ${command} => errors:\n${JSON.stringify(configBuilder.$errors(), undefined, 2)}\n`);
         shelljs.exit(1);
       }
 
       shelljs.echo('zcd ${command} => valid config');
-      shelljs.echo(`zcd ${command} => config values:\n${configBuilder.toJson()}\n`);
+      shelljs.echo(`zcd ${command} => config values:\n${configBuilder.$toJson()}\n`);
 
       if (experimentCallbackFile) {
         import(resolve(process.cwd(), experimentCallbackFile))
           .then(({ default: experimentsCallback }: { default: SetupExperimentsCallback }) => {
-            void transformWriteConfig(configBuilder.values(), { experimentsCallback, outputFile });
+            void transformWriteConfig(configBuilder.$values(), { experimentsCallback, outputFile });
           })
           .catch((error: unknown) => {
             if (error instanceof Error) {
@@ -41,7 +41,7 @@ export const importValidateTransformWriteConfig = (
         return;
       }
 
-      void transformWriteConfig(configBuilder.values(), { outputFile });
+      void transformWriteConfig(configBuilder.$values(), { outputFile });
     })
     .catch((error: unknown) => {
       if (error instanceof Error) {

package/src/utils/isPropertyReservedWord.ts

@@ -1,13 +1,13 @@
 export const RESERVED_KEYWORDS = new Set([
-  'disable',
-  'errors',
-  'experiment',
-  'extend',
-  'flush',
-  'fork',
-  'toJson',
-  'validate',
-  'values',
+  '$disable',
+  '$errors',
+  '$experiment',
+  '$extend',
+  '$flush',
+  '$fork',
+  '$toJson',
+  '$validate',
+  '$values',
 ]);
 
 export const isPropertyReservedWord = (propertyName: string) => RESERVED_KEYWORDS.has(propertyName);

package/src/utils/jsonStringifyReplacer.ts

@@ -0,0 +1,6 @@
+import type { Jsonifiable } from 'type-fest';
+import { ZodType } from 'zod';
+import { zodToJsonSchema } from 'zod-to-json-schema';
+
+export const jsonStringifyReplacer = (_key: string, value: Jsonifiable) =>
+  value instanceof ZodType ? zodToJsonSchema(value, { errorMessages: true }) : value;

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/src/utils/transformConfig.test.ts

@@ -4,7 +4,7 @@ describe('transformConfig', () => {
   describe('when no handlers are passed in', () => {
     it('should return the correct config', async () => {
       const { transformConfig } = await import('./transformConfig.ts');
-      await expect(transformConfig(configBuilder.values())).resolves.toMatchSnapshot();
+      await expect(transformConfig(configBuilder.$values())).resolves.toMatchSnapshot();
     });
   });
 });
@@ -13,7 +13,7 @@ describe('transformConfigSync', () => {
   describe('when no handlers are passed in', () => {
     it('should return the correct config', async () => {
       const { transformConfigSync } = await import('./transformConfig.ts');
-      expect(transformConfigSync(configBuilder.values())).toMatchSnapshot();
+      expect(transformConfigSync(configBuilder.$values())).toMatchSnapshot();
     });
   });
 });

package/tsconfig.build.json

@@ -1,12 +1,9 @@
 {
-  "extends": "@repodog/ts-config/build.json",
+  "extends": ["./tsconfig.json", "@repodog/ts-config/build.json"],
   "compilerOptions": {
     "rootDir": "src",
     "outDir": "dist/types/esm"
   },
-  "include": [
-    "src/**/*"
-  ],
   "exclude": [
     "**/*.test.*",
     "**/__testUtils__/**"

package/tsconfig.json

@@ -1,8 +1,5 @@
 {
   "extends": "@repodog/ts-config/index.json",
-  "compilerOptions": {
-    "rootDir": "src"
-  },
   "include": [
     "src/**/*"
   ]

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"}