zcb 0.0.10 → 0.0.13

package/dist/types/createConfigBuilder.d.ts

@@ -1,23 +1,16 @@
 import { type ZodError, type z } from 'zod';
-export declare const createConfigBuilder: <ZodTypes>(zodSchema: z.ZodSchema, derivedValueCallbacks?: Partial<Record<keyof ZodTypes, (c: { [Key in keyof ZodTypes]: ZodTypes[Key]; }) => ZodTypes[keyof ZodTypes]>>, initialValues?: Partial<{ [Key_1 in keyof ZodTypes]: ZodTypes[Key_1]; }>) => (Required<{ [Key_3 in keyof ZodTypes]: ZodTypes[Key_3]; }> extends infer T ? { [Key_2 in keyof T]: (value: { [Key_3 in keyof ZodTypes]: ZodTypes[Key_3]; }[Key_2] | ((c: { [Key_3 in keyof ZodTypes]: ZodTypes[Key_3]; }) => { [Key_3 in keyof ZodTypes]: ZodTypes[Key_3]; }[Key_2]), override?: boolean) => any & {
-    disable: () => any & any;
+export type ConfigBuilder<ZodTypes> = {
+    [Key in keyof Required<ZodTypes>]: (value: ZodTypes[Key] | ((c: ZodTypes) => ZodTypes[Key]), override?: boolean) => ConfigBuilder<ZodTypes>;
+} & {
+    disable: () => ConfigBuilder<ZodTypes>;
     errors: () => ZodError['errors'];
-    experiment: (key: string) => any & any;
-    extend: (configBuilder: any & any) => any & any;
-    flush: () => { [Key_3 in keyof ZodTypes]: ZodTypes[Key_3]; };
-    fork: () => any & any;
+    experiment: (key: string) => ConfigBuilder<ZodTypes>;
+    extend: (configBuilder: ConfigBuilder<ZodTypes>) => ConfigBuilder<ZodTypes>;
+    flush: () => ZodTypes;
+    fork: () => ConfigBuilder<ZodTypes>;
     toJson: () => string;
     validate: () => boolean;
-    values: () => { [Key_3 in keyof ZodTypes]: ZodTypes[Key_3]; };
-}; } : never) & {
-    disable: () => any & any;
-    errors: () => ZodError['errors'];
-    experiment: (key: string) => any & any;
-    extend: (configBuilder: any & any) => any & any;
-    flush: () => { [Key_3 in keyof ZodTypes]: ZodTypes[Key_3]; };
-    fork: () => any & any;
-    toJson: () => string;
-    validate: () => boolean;
-    values: () => { [Key_3 in keyof ZodTypes]: ZodTypes[Key_3]; };
+    values: () => ZodTypes;
 };
+export declare const createConfigBuilder: <ZodTypes>(zodSchema: z.ZodSchema, derivedValueCallbacks?: Partial<Record<keyof ZodTypes, (c: { [Key in keyof ZodTypes]: ZodTypes[Key]; }) => ZodTypes[keyof ZodTypes]>>, initialValues?: Partial<{ [Key_1 in keyof ZodTypes]: ZodTypes[Key_1]; }>) => ConfigBuilder<ZodTypes>;
 //# sourceMappingURL=createConfigBuilder.d.ts.map

package/dist/types/createConfigBuilder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createConfigBuilder.d.ts","sourceRoot":"","sources":["../../src/createConfigBuilder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,CAAC;AAe5C,eAAO,MAAM,mBAAmB,wBACnB,EAAE,SAAS,ufAuBP,OAAO;;YAIZ,MAAM,QAAQ,CAAC,QAAQ,CAAC;sBACd,MAAM;;;;YAIhB,MAAM,MAAM;cACV,MAAM,OAAO;;;;YANf,MAAM,QAAQ,CAAC,QAAQ,CAAC;sBACd,MAAM;;;;YAIhB,MAAM,MAAM;cACV,MAAM,OAAO;;CA4K1B,CAAC"}
+{"version":3,"file":"createConfigBuilder.d.ts","sourceRoot":"","sources":["../../src/createConfigBuilder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,CAAC;AAe5C,MAAM,MAAM,aAAa,CAAC,QAAQ,IAAI;KACnC,GAAG,IAAI,MAAM,QAAQ,CAAC,QAAQ,CAAC,GAAG,CACjC,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,QAAQ,KAAK,QAAQ,CAAC,GAAG,CAAC,CAAC,EACvD,QAAQ,CAAC,EAAE,OAAO,KACf,aAAa,CAAC,QAAQ,CAAC;CAC7B,GAAG;IACF,OAAO,EAAE,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAC;IACvC,MAAM,EAAE,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACjC,UAAU,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,aAAa,CAAC,QAAQ,CAAC,CAAC;IACrD,MAAM,EAAE,CAAC,aAAa,EAAE,aAAa,CAAC,QAAQ,CAAC,KAAK,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC5E,KAAK,EAAE,MAAM,QAAQ,CAAC;IACtB,IAAI,EAAE,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAC;IACpC,MAAM,EAAE,MAAM,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,OAAO,CAAC;IACxB,MAAM,EAAE,MAAM,QAAQ,CAAC;CACxB,CAAC;AAEF,eAAO,MAAM,mBAAmB,wBACnB,EAAE,SAAS,6OA0LvB,CAAC"}

package/dist/types/utils/importValidateTransformWriteConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"importValidateTransformWriteConfig.d.ts","sourceRoot":"","sources":["../../../src/utils/importValidateTransformWriteConfig.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAI1C,eAAO,MAAM,kCAAkC,cAClC,MAAM,cACL,MAAM,WACT,QAAQ,2BACQ,MAAM,SAiDhC,CAAC"}
+{"version":3,"file":"importValidateTransformWriteConfig.d.ts","sourceRoot":"","sources":["../../../src/utils/importValidateTransformWriteConfig.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAK1C,eAAO,MAAM,kCAAkC,cAClC,MAAM,cACL,MAAM,WACT,QAAQ,2BACQ,MAAM,SA2ChC,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zcb",
   "description": "Build configs with type safety from zod schema.",
-  "version": "0.0.10",
+  "version": "0.0.13",
   "author": "Dylan Aubrey",
   "license": "MIT",
   "homepage": "https://github.com/badbatch/zod-config-builder",
@@ -21,7 +21,6 @@
     "handlebars": "^4.7.7",
     "json-schema": "^0.4.0",
     "shelljs": "^0.8.4",
-    "ts-node": "^10.9.1",
     "yargs": "^15.1.0",
     "zod": "^3.21.4",
     "zod-to-json-schema": "^3.21.0"
@@ -29,7 +28,8 @@
   "peerDependencies": {
     "@babel/runtime": "<8",
     "core-js": "<4",
-    "lodash": "<5"
+    "lodash": "<5",
+    "ts-node": "<11"
   },
   "devDependencies": {
     "@babel/cli": "^7.21.5",
@@ -104,6 +104,7 @@
     "rollup-plugin-sourcemaps": "^0.6.3",
     "suppress-experimental-warnings": "^1.1.17",
     "syncpack": "^9.8.6",
+    "ts-node": "^10.9.1",
     "ts-toolbelt": "^9.6.0",
     "type-fest": "^3.10.0",
     "typescript": "^5.0.3"

package/src/createConfigBuilder.test.ts

@@ -483,7 +483,7 @@ describe('createConfigBuilder', () => {
           .languageCodes(['en'])
           .locales(({ countryCode, languageCodes }) =>
             // eslint-disable-next-line jest/no-conditional-in-test
-            languageCodes?.length && countryCode ? languageCodes.map(code => `${code}_${countryCode}`) : []
+            languageCodes?.length && countryCode ? languageCodes.map(code => `${code}_${countryCode}` as const) : []
           );
 
         expect(config.values()).toEqual({ countryCode: 'GB', languageCodes: ['en'], locales: ['en_GB'] });
@@ -498,7 +498,7 @@ describe('createConfigBuilder', () => {
           .languageCodes(['en'])
           .locales(({ countryCode, languageCodes }) =>
             // eslint-disable-next-line jest/no-conditional-in-test
-            languageCodes?.length && countryCode ? languageCodes.map(code => `${code}_${countryCode}`) : []
+            languageCodes?.length && countryCode ? languageCodes.map(code => `${code}_${countryCode}` as const) : []
           )
           .languageCodes(['fr'], true);
 

package/src/createConfigBuilder.ts

@@ -14,6 +14,23 @@ import { objectHasInvalidDefaults } from './utils/objectHasInvalidDefaults.ts';
 import { recordHasInvalidDefaults } from './utils/recordHasInvalidDefaults.ts';
 import { transformConfigSync } from './utils/transformConfig.ts';
 
+export type ConfigBuilder<ZodTypes> = {
+  [Key in keyof Required<ZodTypes>]: (
+    value: ZodTypes[Key] | ((c: ZodTypes) => ZodTypes[Key]),
+    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;
+};
+
 export const createConfigBuilder = <ZodTypes>(
   zodSchema: z.ZodSchema,
   derivedValueCallbacks: Partial<
@@ -27,31 +44,12 @@ export const createConfigBuilder = <ZodTypes>(
   initialValues: Partial<{
     [Key in keyof ZodTypes]: ZodTypes[Key];
   }> = {}
-) => {
+): ConfigBuilder<ZodTypes> => {
   type Config = {
     [Key in keyof ZodTypes]: ZodTypes[Key];
   };
 
-  type RequiredConfig = Required<Config>;
   type DerivedValueCallback<K extends keyof Config = keyof Config> = (c: Config) => Config[K];
-
-  type ConfigBuilder = {
-    [Key in keyof RequiredConfig]: (
-      value: Config[Key] | DerivedValueCallback<Key>,
-      override?: boolean
-    ) => ConfigBuilder;
-  } & {
-    disable: () => ConfigBuilder;
-    errors: () => ZodError['errors'];
-    experiment: (key: string) => ConfigBuilder;
-    extend: (configBuilder: ConfigBuilder) => ConfigBuilder;
-    flush: () => Config;
-    fork: () => ConfigBuilder;
-    toJson: () => string;
-    validate: () => boolean;
-    values: () => Config;
-  };
-
   let config = initialValues as Config;
 
   Object.defineProperty(config, NonEmumeralProperties.ZCB, {
@@ -89,7 +87,7 @@ export const createConfigBuilder = <ZodTypes>(
 
       return configBuilder;
     },
-    extend: (configBuilder: ConfigBuilder) => {
+    extend: (configBuilder: ConfigBuilder<Config>) => {
       config = transformConfigSync<Config>(configBuilder.values(), [cloneNonEnumerableValues]);
       // @ts-expect-error private property
       callbacks = { ...configBuilder.__callbacks } as Partial<Record<keyof Config, DerivedValueCallback>>;
@@ -128,7 +126,7 @@ export const createConfigBuilder = <ZodTypes>(
 
       return config;
     },
-  } as unknown as ConfigBuilder;
+  } as unknown as ConfigBuilder<ZodTypes>;
 
   Object.defineProperty(configBuilder, NonEmumeralProperties.CALLBACKS, {
     configurable: false,
@@ -216,7 +214,7 @@ export const createConfigBuilder = <ZodTypes>(
 
       config[castProperty] = propertyValue;
       return configBuilder;
-    }) as ConfigBuilder[keyof Config];
+    }) as ConfigBuilder<Config>[keyof Config];
   }
 
   return configBuilder;

package/src/utils/importValidateTransformWriteConfig.ts

@@ -1,6 +1,7 @@
 import { resolve } from 'node:path';
 import shelljs from 'shelljs';
 import type { Commands } from '../cli.ts';
+import type { ConfigBuilder } from '../createConfigBuilder.ts';
 import type { SetupExperimentsCallback } from '../types.ts';
 import { transformWriteConfig } from './transformWriteConfig.ts';
 
@@ -11,43 +12,37 @@ export const importValidateTransformWriteConfig = (
   experimentCallbackFile?: string
 ) => {
   import(resolve(process.cwd(), inputFile))
-    .then(
-      ({
-        default: configBuilder,
-      }: {
-        default: ReturnType<typeof import('../createConfigBuilder.ts')['createConfigBuilder']>;
-      }) => {
-        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.exit(1);
-        }
-
-        shelljs.echo('zcd ${command} => valid config');
+    .then(({ default: configBuilder }: { default: ConfigBuilder<object> }) => {
+      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.exit(1);
+      }
 
-        if (experimentCallbackFile) {
-          import(resolve(process.cwd(), experimentCallbackFile))
-            .then(({ default: experimentsCallback }: { default: SetupExperimentsCallback }) => {
-              void transformWriteConfig(configBuilder.values(), { experimentsCallback, outputFile });
-            })
-            .catch((error: unknown) => {
-              if (error instanceof Error) {
-                shelljs.echo(`zcd ${command} => error message: ${error.message}`);
+      shelljs.echo('zcd ${command} => valid config');
+      shelljs.echo(`zcd ${command} => config values:\n${configBuilder.toJson()}\n`);
 
-                if (error.stack) {
-                  shelljs.echo(`zcd ${command} => error stack:\n${error.stack}\n`);
-                }
-              }
-            });
+      if (experimentCallbackFile) {
+        import(resolve(process.cwd(), experimentCallbackFile))
+          .then(({ default: experimentsCallback }: { default: SetupExperimentsCallback }) => {
+            void transformWriteConfig(configBuilder.values(), { experimentsCallback, outputFile });
+          })
+          .catch((error: unknown) => {
+            if (error instanceof Error) {
+              shelljs.echo(`zcd ${command} => error message: ${error.message}`);
 
-          return;
-        }
+              if (error.stack) {
+                shelljs.echo(`zcd ${command} => error stack:\n${error.stack}\n`);
+              }
+            }
+          });
 
-        void transformWriteConfig(configBuilder.values(), { outputFile });
+        return;
       }
-    )
+
+      void transformWriteConfig(configBuilder.values(), { outputFile });
+    })
     .catch((error: unknown) => {
       if (error instanceof Error) {
         shelljs.echo(`zcd ${command} => error message: ${error.message}`);