zcb 0.0.6

package/src/createConfigBuilder.ts

@@ -0,0 +1,234 @@
+import { type JSONSchema7 } from 'json-schema';
+import { type ZodError, type z } from 'zod';
+import { zodToJsonSchema } from 'zod-to-json-schema';
+import { cloneNonEnumerableValues } from './transformers/cloneNonEnumerableValues.ts';
+import { arrayHasInvalidDefaults } from './utils/arrayHasInvalidDefaults.ts';
+import { isDerivedValueCallback } from './utils/isDerivedValueCallback.ts';
+import { isInvalidPropertyOverride } from './utils/isInvalidPropertyOverride.ts';
+import { 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 { recordHasInvalidDefaults } from './utils/recordHasInvalidDefaults.ts';
+import { transformConfigSync } from './utils/transformConfig.ts';
+
+export const RESERVED_KEYWORDS = new Set([
+  'disable',
+  'errors',
+  'experiment',
+  'extend',
+  'flush',
+  'fork',
+  'toJson',
+  'validate',
+  'values',
+]);
+
+export const createConfigBuilder = <ZodTypes>(
+  zodSchema: z.ZodSchema,
+  derivedValueCallbacks: Partial<
+    Record<
+      keyof ZodTypes,
+      (c: {
+        [Key in keyof ZodTypes]: ZodTypes[Key];
+      }) => ZodTypes[keyof ZodTypes]
+    >
+  > = {},
+  initialValues: Partial<{
+    [Key in keyof ZodTypes]: ZodTypes[Key];
+  }> = {}
+) => {
+  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, '__zcb', {
+    configurable: false,
+    enumerable: false,
+    value: true,
+  });
+
+  let callbacks: Partial<Record<keyof Config, DerivedValueCallback>> = { ...derivedValueCallbacks };
+
+  const configBuilder = {
+    disable: () => {
+      Object.defineProperty(config, '__disabled', {
+        configurable: false,
+        enumerable: false,
+        value: true,
+      });
+
+      return configBuilder;
+    },
+    errors: () => {
+      try {
+        zodSchema.parse(configBuilder.values());
+        return [];
+      } catch (error: unknown) {
+        return (error as ZodError).errors;
+      }
+    },
+    experiment: (key: string) => {
+      Object.defineProperty(config, '__experiment', {
+        configurable: false,
+        enumerable: false,
+        value: key,
+      });
+
+      return configBuilder;
+    },
+    extend: (configBuilder: ConfigBuilder) => {
+      config = transformConfigSync<Config>(configBuilder.values(), [cloneNonEnumerableValues]);
+      // @ts-expect-error private property
+      callbacks = { ...configBuilder.__callbacks } as Partial<Record<keyof Config, DerivedValueCallback>>;
+    },
+    flush: () => {
+      const values = configBuilder.values();
+      config = {} as Config;
+
+      Object.defineProperty(config, '__zcb', {
+        configurable: false,
+        enumerable: false,
+        value: true,
+      });
+
+      return values;
+    },
+    fork: () => createConfigBuilder<Config>(zodSchema, derivedValueCallbacks),
+    toJson: () => JSON.stringify(configBuilder.values(), undefined, 2),
+    validate: () => {
+      try {
+        zodSchema.parse(configBuilder.values());
+        return true;
+      } catch (error: unknown) {
+        console.error(error);
+        return false;
+      }
+    },
+    values: () => {
+      for (const property in callbacks) {
+        const callback = callbacks[property];
+
+        if (callback) {
+          config[property as keyof Config] = callback(config);
+        }
+      }
+
+      return config;
+    },
+  } as unknown as ConfigBuilder;
+
+  Object.defineProperty(configBuilder, '__callbacks', {
+    configurable: false,
+    enumerable: false,
+    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(
+        `"${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 castProperty = propertyName as keyof Config;
+    const propertyDefinition = jsonSchema.properties[propertyName];
+
+    if (isValidPropertyDefinition(propertyDefinition)) {
+      if (propertyDefinition.default) {
+        config[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 (objectHasInvalidDefaults(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.`
+          );
+        }
+
+        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.`
+          );
+        }
+      }
+    }
+
+    configBuilder[castProperty] = ((value: Config[keyof Config] | DerivedValueCallback, override?: boolean) => {
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+      if (isInvalidPropertyOverride(config[castProperty], override)) {
+        throw new Error(
+          `A value already exists for "${String(
+            castProperty
+          )}". 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.`
+        );
+      }
+
+      let propertyValue: Config[keyof Config];
+      const MAX_DEPTH = 1;
+
+      if (!isValidValue(value)) {
+        throw new Error(
+          `"${String(
+            castProperty
+          )}" 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;
+        propertyValue = value(config);
+      } else {
+        propertyValue = value;
+      }
+
+      config[castProperty] = propertyValue;
+      return configBuilder;
+    }) as ConfigBuilder[keyof Config];
+  }
+
+  return configBuilder;
+};

package/src/createConfigReader.test.ts

@@ -0,0 +1,45 @@
+import { config } from './__testUtils__/config.ts';
+
+describe('createConfigReader', () => {
+  describe('when a user accesses a known property', () => {
+    it('should return the correct value', async () => {
+      const { createConfigReader } = await import('./createConfigReader.ts');
+      const reader = createConfigReader(config);
+      const value = reader('countryCode');
+      expect(value).toBe('GB');
+    });
+  });
+
+  describe('when a user accesses a known nested property', () => {
+    it('should return the correct value', async () => {
+      const { createConfigReader } = await import('./createConfigReader.ts');
+      const reader = createConfigReader(config);
+      const value = reader('pages.contactDetails.name');
+      expect(value).toBe('contactDetails');
+    });
+  });
+
+  describe('when the reader is scoped', () => {
+    describe('when a user accesses a known property', () => {
+      it('should return the correct value', async () => {
+        const { createConfigReader } = await import('./createConfigReader.ts');
+        const reader = createConfigReader(config);
+        const scopedReader = reader.scope('pages.contactDetails');
+        const value = scopedReader('name');
+        expect(value).toBe('contactDetails');
+      });
+    });
+  });
+
+  describe('when the reader is scoped multiple times', () => {
+    describe('when a user accesses a known property', () => {
+      it('should return the correct value', async () => {
+        const { createConfigReader } = await import('./createConfigReader.ts');
+        const reader = createConfigReader(config);
+        const scopedReader = reader.scope('pages.contactDetails').scope('sections.1.sections').scope('0');
+        const value = scopedReader('name');
+        expect(value).toBe('main');
+      });
+    });
+  });
+});

package/src/createConfigReader.ts

@@ -0,0 +1,12 @@
+import get from 'lodash/get.js';
+import type { Get, Join } from 'type-fest';
+import type { Leaves, Paths } from './types.ts';
+
+export const createConfigReader = <Config extends object>(config: Config) => {
+  const configReader = <Path extends Join<Leaves<Config>, '.'>>(path: Path) => get(config, path);
+
+  configReader.scope = <Scope extends Join<Paths<Config>, '.'>>(scope: Scope) =>
+    createConfigReader(get(config, scope) as Get<Config, Scope>);
+
+  return configReader;
+};

package/src/data/countryCodes.ts

@@ -0,0 +1,247 @@
+export const countryCodes = [
+  'AF',
+  'AX',
+  'AL',
+  'DZ',
+  'AS',
+  'AD',
+  'AO',
+  'AI',
+  'AQ',
+  'AG',
+  'AR',
+  'AM',
+  'AW',
+  'AU',
+  'AT',
+  'AZ',
+  'BS',
+  'BH',
+  'BD',
+  'BB',
+  'BY',
+  'BE',
+  'BZ',
+  'BJ',
+  'BM',
+  'BT',
+  'BO',
+  'BA',
+  'BW',
+  'BV',
+  'BR',
+  'IO',
+  'BN',
+  'BG',
+  'BF',
+  'BI',
+  'KH',
+  'CM',
+  'CA',
+  'CV',
+  'KY',
+  'CF',
+  'TD',
+  'CL',
+  'CN',
+  'CX',
+  'CC',
+  'CO',
+  'KM',
+  'CG',
+  'CD',
+  'CK',
+  'CR',
+  'CI',
+  'HR',
+  'CU',
+  'CY',
+  'CZ',
+  'DK',
+  'DJ',
+  'DM',
+  'DO',
+  'EC',
+  'EG',
+  'SV',
+  'GQ',
+  'ER',
+  'EE',
+  'ET',
+  'FK',
+  'FO',
+  'FJ',
+  'FI',
+  'FR',
+  'GF',
+  'PF',
+  'TF',
+  'GA',
+  'GM',
+  'GE',
+  'DE',
+  'GH',
+  'GI',
+  'GR',
+  'GL',
+  'GD',
+  'GP',
+  'GU',
+  'GT',
+  'GG',
+  'GN',
+  'GW',
+  'GY',
+  'HT',
+  'HM',
+  'VA',
+  'HN',
+  'HK',
+  'HU',
+  'IS',
+  'IN',
+  'ID',
+  'IR',
+  'IQ',
+  'IE',
+  'IM',
+  'IL',
+  'IT',
+  'JM',
+  'JP',
+  'JE',
+  'JO',
+  'KZ',
+  'KE',
+  'KI',
+  'KR',
+  'KW',
+  'KG',
+  'LA',
+  'LV',
+  'LB',
+  'LS',
+  'LR',
+  'LY',
+  'LI',
+  'LT',
+  'LU',
+  'MO',
+  'MK',
+  'MG',
+  'MW',
+  'MY',
+  'MV',
+  'ML',
+  'MT',
+  'MH',
+  'MQ',
+  'MR',
+  'MU',
+  'YT',
+  'MX',
+  'FM',
+  'MD',
+  'MC',
+  'MN',
+  'ME',
+  'MS',
+  'MA',
+  'MZ',
+  'MM',
+  'NA',
+  'NR',
+  'NP',
+  'NL',
+  'AN',
+  'NC',
+  'NZ',
+  'NI',
+  'NE',
+  'NG',
+  'NU',
+  'NF',
+  'MP',
+  'NO',
+  'OM',
+  'PK',
+  'PW',
+  'PS',
+  'PA',
+  'PG',
+  'PY',
+  'PE',
+  'PH',
+  'PN',
+  'PL',
+  'PT',
+  'PR',
+  'QA',
+  'RE',
+  'RO',
+  'RU',
+  'RW',
+  'BL',
+  'SH',
+  'KN',
+  'LC',
+  'MF',
+  'PM',
+  'VC',
+  'WS',
+  'SM',
+  'ST',
+  'SA',
+  'SN',
+  'RS',
+  'SC',
+  'SL',
+  'SG',
+  'SK',
+  'SI',
+  'SB',
+  'SO',
+  'ZA',
+  'GS',
+  'ES',
+  'LK',
+  'SD',
+  'SR',
+  'SJ',
+  'SZ',
+  'SE',
+  'CH',
+  'SY',
+  'TW',
+  'TJ',
+  'TZ',
+  'TH',
+  'TL',
+  'TG',
+  'TK',
+  'TO',
+  'TT',
+  'TN',
+  'TR',
+  'TM',
+  'TC',
+  'TV',
+  'UG',
+  'UA',
+  'AE',
+  'GB',
+  'US',
+  'UM',
+  'UY',
+  'UZ',
+  'VU',
+  'VE',
+  'VN',
+  'VG',
+  'VI',
+  'WF',
+  'EH',
+  'YE',
+  'ZM',
+  'ZW',
+] as const;