zcb 0.0.6

package/src/utils/__snapshots__/transformConfig.test.ts.snap

@@ -0,0 +1,151 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`transformConfig when no handlers are passed in should return the correct config 1`] = `
+{
+  "countryCode": "GB",
+  "countryName": "United Kingdom",
+  "distanceUnit": "km",
+  "languageCodes": [
+    "en",
+  ],
+  "locales": [
+    "en_GB",
+  ],
+  "name": "alpha",
+  "pages": {
+    "contactDetails": {
+      "name": "contactDetails",
+      "sections": [
+        {
+          "name": "header",
+        },
+        {
+          "name": "body",
+          "sections": [
+            {
+              "name": "main",
+            },
+            {
+              "name": "sidebar",
+            },
+          ],
+        },
+        {
+          "name": "footer",
+        },
+      ],
+    },
+    "personalDetails": {
+      "name": "personalDetails",
+      "sections": [
+        {
+          "name": "header",
+        },
+        {
+          "name": "body",
+          "sections": [
+            {
+              "name": "main",
+            },
+            {
+              "name": "sidebar",
+            },
+          ],
+        },
+        {
+          "name": "footer",
+        },
+      ],
+    },
+  },
+  "routes": [
+    {
+      "page": "personalDetails",
+      "path": "personal-details",
+    },
+    {
+      "page": "contactDetails",
+      "path": "contact-details",
+    },
+  ],
+  "timeouts": {
+    "apollo": 10000,
+  },
+  "timezone": "Europe/London",
+}
+`;
+
+exports[`transformConfigSync when no handlers are passed in should return the correct config 1`] = `
+{
+  "countryCode": "GB",
+  "countryName": "United Kingdom",
+  "distanceUnit": "km",
+  "languageCodes": [
+    "en",
+  ],
+  "locales": [
+    "en_GB",
+  ],
+  "name": "alpha",
+  "pages": {
+    "contactDetails": {
+      "name": "contactDetails",
+      "sections": [
+        {
+          "name": "header",
+        },
+        {
+          "name": "body",
+          "sections": [
+            {
+              "name": "main",
+            },
+            {
+              "name": "sidebar",
+            },
+          ],
+        },
+        {
+          "name": "footer",
+        },
+      ],
+    },
+    "personalDetails": {
+      "name": "personalDetails",
+      "sections": [
+        {
+          "name": "header",
+        },
+        {
+          "name": "body",
+          "sections": [
+            {
+              "name": "main",
+            },
+            {
+              "name": "sidebar",
+            },
+          ],
+        },
+        {
+          "name": "footer",
+        },
+      ],
+    },
+  },
+  "routes": [
+    {
+      "page": "personalDetails",
+      "path": "personal-details",
+    },
+    {
+      "page": "contactDetails",
+      "path": "contact-details",
+    },
+  ],
+  "timeouts": {
+    "apollo": 10000,
+  },
+  "timezone": "Europe/London",
+}
+`;

package/src/utils/arrayHasInvalidDefaults.ts

@@ -0,0 +1,6 @@
+import type { JSONSchema7 } from 'json-schema';
+
+export const arrayHasInvalidDefaults = (propertyDefinition: JSONSchema7) => {
+  const { items } = propertyDefinition;
+  return items && typeof items === 'object' && 'default' in items;
+};

package/src/utils/isDerivedValueCallback.ts

@@ -0,0 +1,3 @@
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const isDerivedValueCallback = <T extends (c: any) => any>(value: any): value is T =>
+  typeof value === 'function';

package/src/utils/isInvalidPropertyOverride.ts

@@ -0,0 +1,3 @@
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const isInvalidPropertyOverride = (propertyValue: any, override = false) =>
+  !override && propertyValue !== undefined;

package/src/utils/isPropertyReservedWord.ts

@@ -0,0 +1,3 @@
+import { RESERVED_KEYWORDS } from '../createConfigBuilder.ts';
+
+export const isPropertyReservedWord = (propertyName: string) => RESERVED_KEYWORDS.has(propertyName);

package/src/utils/isSchemaValid.ts

@@ -0,0 +1,3 @@
+import type { JSONSchema7 } from 'json-schema';
+
+export const isSchemaValid = (schema: JSONSchema7) => schema.type !== 'object';

package/src/utils/isValidPropertyDefinition.ts

@@ -0,0 +1,5 @@
+import type { JSONSchema7, JSONSchema7Definition } from 'json-schema';
+
+export const isValidPropertyDefinition = (
+  propertyDefinition: JSONSchema7Definition | undefined
+): propertyDefinition is JSONSchema7 => typeof propertyDefinition === 'object';

package/src/utils/isValidValue.ts

@@ -0,0 +1,27 @@
+import isPlainObject from 'lodash/isPlainObject.js';
+
+export const isValidValue = (value: unknown, depth = 0): boolean => {
+  if (isPlainObject(value)) {
+    const object = value as Record<string, unknown>;
+
+    if (object.__zcb === true) {
+      return true;
+    }
+
+    if (depth < 1 && Object.values(object).every(v => isValidValue(v, depth + 1))) {
+      return true;
+    }
+
+    return false;
+  }
+
+  if (Array.isArray(value)) {
+    if (value.every(v => isValidValue(v, depth + 1))) {
+      return true;
+    }
+
+    return false;
+  }
+
+  return true;
+};

package/src/utils/objectHasInvalidDefaults.ts

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

package/src/utils/recordHasInvalidDefaults.ts

@@ -0,0 +1,6 @@
+import type { JSONSchema7 } from 'json-schema';
+
+export const recordHasInvalidDefaults = (propertyDefinition: JSONSchema7) =>
+  propertyDefinition.additionalProperties &&
+  typeof propertyDefinition.additionalProperties === 'object' &&
+  'default' in propertyDefinition.additionalProperties;

package/src/utils/transformConfig.test.ts

@@ -0,0 +1,19 @@
+import configBuilder from '../__testUtils__/configBuilder.ts';
+
+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();
+    });
+  });
+});
+
+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();
+    });
+  });
+});

package/src/utils/transformConfig.ts

@@ -0,0 +1,119 @@
+import castArray from 'lodash/castArray.js';
+import isPlainObject from 'lodash/isPlainObject.js';
+import {
+  type AnyRecord,
+  type TransformConfigHandler,
+  TransformConfigHandlerAction,
+  type TransformConfigHandlerSync,
+} from '../types.ts';
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const transformArray = (list: any[], handler: TransformConfigHandler | TransformConfigHandler[]): Promise<any[]> =>
+  Promise.all(
+    list.map(entry => {
+      if (isPlainObject(entry)) {
+        return transformConfig(entry, handler);
+      }
+
+      if (Array.isArray(entry)) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+        return transformArray(entry, handler);
+      }
+
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+      return entry;
+    })
+  );
+
+export const transformConfig = async <Config extends AnyRecord>(
+  config: Config,
+  handler: TransformConfigHandler | TransformConfigHandler[] = []
+): Promise<Config> => {
+  let transform = {} as Config;
+  const handlers = castArray(handler);
+
+  for (const callback of handlers) {
+    const result = await Promise.resolve(callback(transform, config));
+
+    if (result.action === TransformConfigHandlerAction.DELETE_NODE) {
+      return {} as Config;
+    }
+
+    if (result.value) {
+      transform = result.value;
+    }
+
+    if (result.action === TransformConfigHandlerAction.SKIP_NODE) {
+      return transform;
+    }
+  }
+
+  for (const key in config) {
+    const value = config[key];
+
+    if (isPlainObject(value)) {
+      transform[key] = await transformConfig(value, handler);
+    } else if (Array.isArray(value)) {
+      transform[key] = (await transformArray(value, handler)) as Config[Extract<keyof Config, string>];
+    } else {
+      transform[key] = value;
+    }
+  }
+
+  return transform;
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const transformArraySync = (list: any[], handler: TransformConfigHandlerSync | TransformConfigHandlerSync[]): any[] =>
+  list.map(entry => {
+    if (isPlainObject(entry)) {
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+      return transformConfigSync(entry, handler);
+    }
+
+    if (Array.isArray(entry)) {
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+      return transformArraySync(entry, handler);
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+    return entry;
+  });
+
+export const transformConfigSync = <Config extends AnyRecord>(
+  config: Config,
+  handler: TransformConfigHandlerSync | TransformConfigHandlerSync[] = []
+): Config => {
+  let transform = {} as Config;
+  const handlers = castArray(handler);
+
+  for (const callback of handlers) {
+    const result = callback(transform, config);
+
+    if (result.action === TransformConfigHandlerAction.DELETE_NODE) {
+      return {} as Config;
+    }
+
+    if (result.value) {
+      transform = result.value;
+    }
+
+    if (result.action === TransformConfigHandlerAction.SKIP_NODE) {
+      return transform;
+    }
+  }
+
+  for (const key in config) {
+    const value = config[key];
+
+    if (isPlainObject(value)) {
+      transform[key] = transformConfigSync(value, handler);
+    } else if (Array.isArray(value)) {
+      transform[key] = transformArraySync(value, handler) as Config[Extract<keyof Config, string>];
+    } else {
+      transform[key] = value;
+    }
+  }
+
+  return transform;
+};

package/src/utils/writeConfig.ts

@@ -0,0 +1,34 @@
+import { outputFileSync } from 'fs-extra/esm';
+import Handlebars from 'handlebars';
+import { readFileSync } from 'node:fs';
+import { dirname, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import shelljs from 'shelljs';
+import { removeDisabledSlices } from '../transformers/removeDisabledSlices.ts';
+import { setupExperiments } from '../transformers/setupExperiments.ts';
+import type { TransformConfigHandler, WriteConfigOptions } from '../types.ts';
+import { transformConfig } from './transformConfig.ts';
+
+export const writeConfig = async <Config extends object>(
+  config: Config,
+  { experimentsCallback, outputFile }: WriteConfigOptions
+) => {
+  const handlers: TransformConfigHandler[] = [removeDisabledSlices];
+
+  if (experimentsCallback) {
+    handlers.push(setupExperiments(experimentsCallback));
+  }
+
+  const template = Handlebars.compile(
+    readFileSync(resolve(dirname(fileURLToPath(import.meta.url)), './templates/config.ts.hbs'), { encoding: 'utf8' })
+  );
+
+  const output = template({ config: JSON.stringify(await transformConfig(config, handlers), undefined, 2) }).replaceAll(
+    /"([A-Za-z][\dA-Za-z]+)":/g,
+    '$1:'
+  );
+
+  shelljs.echo(`zcd watch => writing to file: ${outputFile}`);
+  shelljs.echo(`zcd watch => content to write:\n${output}\n`);
+  outputFileSync(outputFile, output);
+};

package/tsconfig.build.json

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

package/tsconfig.json

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