zcb 0.3.3 → 0.3.5

package/src/utils/transformWriteConfig.test.ts

@@ -0,0 +1,111 @@
+import { jest } from '@jest/globals';
+import configBuilder from '../__testUtils__/configBuilder.ts';
+
+jest.unstable_mockModule('fs-extra/esm', () => ({
+  outputFileSync: jest.fn(),
+}));
+
+jest.unstable_mockModule('shelljs', () => ({
+  default: {
+    echo: jest.fn(),
+    exec: jest.fn(),
+    exit: jest.fn(),
+  },
+}));
+
+const { outputFileSync } = jest.mocked(await import('fs-extra/esm'));
+const { transformWriteConfig } = await import('./transformWriteConfig.ts');
+
+describe('transformWriteConfig', () => {
+  it('should call outputFileSync with the expected file content', async () => {
+    await transformWriteConfig(configBuilder.$values(), {
+      outputFile: 'config.ts',
+    });
+
+    expect(outputFileSync.mock.calls[0]?.[1]).toMatchInlineSnapshot(`
+      "/* eslint-disable import-x/no-default-export, unicorn/numeric-separators-style, unicorn/no-null */
+      /* This file is autogenerated, do not edit directly, your changes will not perist. */
+
+      export default {
+        countryCode: "GB",
+        countryName: null,
+        distanceUnit: "km",
+        enabled: true,
+        languageCodes: [
+          "en"
+        ],
+        locales: [
+          "en_GB"
+        ],
+        name: undefined,
+        pages: {
+          contactDetails: {
+            path: undefined,
+            queryParams: undefined,
+            sections: [
+              {
+                sections: undefined,
+                name: "header"
+              },
+              {
+                name: "body",
+                sections: [
+                  {
+                    sections: undefined,
+                    name: "main"
+                  },
+                  {
+                    name: "sidebar"
+                  }
+                ]
+              },
+              {
+                name: "footer"
+              }
+            ],
+            name: "contactDetails"
+          },
+          personalDetails: {
+            name: "personalDetails",
+            sections: [
+              {
+                name: "header"
+              },
+              {
+                name: "body",
+                sections: [
+                  {
+                    name: "main"
+                  },
+                  {
+                    name: "sidebar"
+                  }
+                ]
+              },
+              {
+                name: "footer"
+              }
+            ]
+          }
+        },
+        routes: [
+          {
+            aliases: undefined,
+            routes: undefined,
+            page: "personalDetails",
+            path: "personal-details"
+          },
+          {
+            page: "contactDetails",
+            path: "contact-details"
+          }
+        ],
+        timeouts: {
+          apollo: 10000
+        },
+        timezone: "Europe/London"
+      } as const;
+      "
+    `);
+  });
+});

package/src/utils/transformWriteConfig.ts

@@ -1,7 +1,7 @@
 import { outputFileSync } from 'fs-extra/esm';
 import Handlebars from 'handlebars';
 import { readFileSync } from 'node:fs';
-import { dirname, resolve } from 'node:path';
+import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 import shelljs from 'shelljs';
 import { removeDisabledSlices } from '../transformers/removeDisabledSlices.ts';
@@ -12,23 +12,30 @@ import { transformConfig } from './transformConfig.ts';
 export const transformWriteConfig = async <Config extends object>(
   config: Config,
   { experimentsCallback, outputFile }: WriteConfigOptions,
-) => {
+): Promise<void> => {
   const handlers: TransformConfigHandler[] = [removeDisabledSlices];
 
   if (experimentsCallback) {
     handlers.push(setupExperiments(experimentsCallback));
   }
 
+  const dirname = path.dirname(fileURLToPath(import.meta.url));
+
   const template = Handlebars.compile(
-    readFileSync(resolve(dirname(fileURLToPath(import.meta.url)), './templates/config.ts.hbs'), { encoding: 'utf8' }),
+    readFileSync(path.resolve(dirname, '../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:',
-  );
+  const output = template({
+    config: JSON.stringify(
+      await transformConfig(config, handlers),
+      (_k, v: unknown) => (v === undefined ? 'undefined' : v),
+      2,
+    ),
+  })
+    .replaceAll(/"([A-Za-z][\dA-Za-z]+)":/g, '$1:')
+    .replaceAll('"undefined"', 'undefined');
 
   shelljs.echo(`zcd watch => writing to file: ${outputFile}`);
   shelljs.echo(`zcd watch => content to write:\n${output}\n`);
-  outputFileSync(resolve(process.cwd(), outputFile), output);
+  outputFileSync(path.resolve(process.cwd(), outputFile), output);
 };

package/dist/types/cjs/utils/jsonStringifyReplacer.d.cts

@@ -1,109 +0,0 @@
-import { type Jsonifiable } from 'type-fest';
-export declare const jsonStringifyReplacer: (_key: string, value: Jsonifiable) => string | number | boolean | {
-    [x: string]: Jsonifiable | undefined;
-} | {
-    toJSON: () => Jsonifiable;
-} | import("type-fest/source/jsonifiable.js").JsonifiableArray | ({
-    anyOf: import("zod-to-json-schema").JsonSchema7DateType[];
-} & {
-    title?: string;
-    default?: any;
-    description?: string;
-    markdownDescription?: string;
-} & {
-    $schema?: string | undefined;
-    definitions?: {
-        [key: string]: import("zod-to-json-schema").JsonSchema7Type;
-    } | undefined;
-}) | ({
-    type: "object" | "array";
-} & {
-    title?: string;
-    default?: any;
-    description?: string;
-    markdownDescription?: string;
-} & {
-    $schema?: string | undefined;
-    definitions?: {
-        [key: string]: import("zod-to-json-schema").JsonSchema7Type;
-    } | undefined;
-}) | ({
-    type: ("string" | "number" | "boolean" | "integer" | "null") | ("string" | "number" | "boolean" | "integer" | "null")[];
-} & {
-    title?: string;
-    default?: any;
-    description?: string;
-    markdownDescription?: string;
-} & {
-    $schema?: string | undefined;
-    definitions?: {
-        [key: string]: import("zod-to-json-schema").JsonSchema7Type;
-    } | undefined;
-}) | ({
-    anyOf: import("zod-to-json-schema").JsonSchema7Type[];
-} & {
-    title?: string;
-    default?: any;
-    description?: string;
-    markdownDescription?: string;
-} & {
-    $schema?: string | undefined;
-    definitions?: {
-        [key: string]: import("zod-to-json-schema").JsonSchema7Type;
-    } | undefined;
-}) | (import("zod-to-json-schema").JsonSchema7UndefinedType & {
-    title?: string;
-    default?: any;
-    description?: string;
-    markdownDescription?: string;
-} & {
-    $schema?: string | undefined;
-    definitions?: {
-        [key: string]: import("zod-to-json-schema").JsonSchema7Type;
-    } | undefined;
-}) | (import("zod-to-json-schema").JsonSchema7AnyType & {
-    title?: string;
-    default?: any;
-    description?: string;
-    markdownDescription?: string;
-} & {
-    $schema?: string | undefined;
-    definitions?: {
-        [key: string]: import("zod-to-json-schema").JsonSchema7Type;
-    } | undefined;
-}) | ({
-    anyOf: [import("zod-to-json-schema").JsonSchema7Type, import("zod-to-json-schema").JsonSchema7NullType];
-} & {
-    title?: string;
-    default?: any;
-    description?: string;
-    markdownDescription?: string;
-} & {
-    $schema?: string | undefined;
-    definitions?: {
-        [key: string]: import("zod-to-json-schema").JsonSchema7Type;
-    } | undefined;
-}) | ({
-    type: [string, "null"];
-} & {
-    title?: string;
-    default?: any;
-    description?: string;
-    markdownDescription?: string;
-} & {
-    $schema?: string | undefined;
-    definitions?: {
-        [key: string]: import("zod-to-json-schema").JsonSchema7Type;
-    } | undefined;
-}) | (import("zod-to-json-schema").JsonSchema7AllOfType & {
-    title?: string;
-    default?: any;
-    description?: string;
-    markdownDescription?: string;
-} & {
-    $schema?: string | undefined;
-    definitions?: {
-        [key: string]: import("zod-to-json-schema").JsonSchema7Type;
-    } | undefined;
-}) | null;
-//# sourceMappingURL=jsonStringifyReplacer.d.cts.map

package/dist/types/cjs/utils/jsonStringifyReplacer.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"jsonStringifyReplacer.d.cts","sourceRoot":"","sources":["../../../../src/utils/jsonStringifyReplacer.cts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AAI7C,eAAO,MAAM,qBAAqB,GAAI,MAAM,MAAM,EAAE,OAAO,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SACc,CAAC"}

package/dist/types/esm/utils/jsonStringifyReplacer.d.ts

@@ -1,109 +0,0 @@
-import { type Jsonifiable } from 'type-fest';
-export declare const jsonStringifyReplacer: (_key: string, value: Jsonifiable) => string | number | boolean | {
-    [x: string]: Jsonifiable | undefined;
-} | {
-    toJSON: () => Jsonifiable;
-} | import("type-fest/source/jsonifiable.js").JsonifiableArray | ({
-    anyOf: import("zod-to-json-schema").JsonSchema7DateType[];
-} & {
-    title?: string;
-    default?: any;
-    description?: string;
-    markdownDescription?: string;
-} & {
-    $schema?: string | undefined;
-    definitions?: {
-        [key: string]: import("zod-to-json-schema").JsonSchema7Type;
-    } | undefined;
-}) | ({
-    type: "object" | "array";
-} & {
-    title?: string;
-    default?: any;
-    description?: string;
-    markdownDescription?: string;
-} & {
-    $schema?: string | undefined;
-    definitions?: {
-        [key: string]: import("zod-to-json-schema").JsonSchema7Type;
-    } | undefined;
-}) | ({
-    type: ("string" | "number" | "boolean" | "integer" | "null") | ("string" | "number" | "boolean" | "integer" | "null")[];
-} & {
-    title?: string;
-    default?: any;
-    description?: string;
-    markdownDescription?: string;
-} & {
-    $schema?: string | undefined;
-    definitions?: {
-        [key: string]: import("zod-to-json-schema").JsonSchema7Type;
-    } | undefined;
-}) | ({
-    anyOf: import("zod-to-json-schema").JsonSchema7Type[];
-} & {
-    title?: string;
-    default?: any;
-    description?: string;
-    markdownDescription?: string;
-} & {
-    $schema?: string | undefined;
-    definitions?: {
-        [key: string]: import("zod-to-json-schema").JsonSchema7Type;
-    } | undefined;
-}) | (import("zod-to-json-schema").JsonSchema7UndefinedType & {
-    title?: string;
-    default?: any;
-    description?: string;
-    markdownDescription?: string;
-} & {
-    $schema?: string | undefined;
-    definitions?: {
-        [key: string]: import("zod-to-json-schema").JsonSchema7Type;
-    } | undefined;
-}) | (import("zod-to-json-schema").JsonSchema7AnyType & {
-    title?: string;
-    default?: any;
-    description?: string;
-    markdownDescription?: string;
-} & {
-    $schema?: string | undefined;
-    definitions?: {
-        [key: string]: import("zod-to-json-schema").JsonSchema7Type;
-    } | undefined;
-}) | ({
-    anyOf: [import("zod-to-json-schema").JsonSchema7Type, import("zod-to-json-schema").JsonSchema7NullType];
-} & {
-    title?: string;
-    default?: any;
-    description?: string;
-    markdownDescription?: string;
-} & {
-    $schema?: string | undefined;
-    definitions?: {
-        [key: string]: import("zod-to-json-schema").JsonSchema7Type;
-    } | undefined;
-}) | ({
-    type: [string, "null"];
-} & {
-    title?: string;
-    default?: any;
-    description?: string;
-    markdownDescription?: string;
-} & {
-    $schema?: string | undefined;
-    definitions?: {
-        [key: string]: import("zod-to-json-schema").JsonSchema7Type;
-    } | undefined;
-}) | (import("zod-to-json-schema").JsonSchema7AllOfType & {
-    title?: string;
-    default?: any;
-    description?: string;
-    markdownDescription?: string;
-} & {
-    $schema?: string | undefined;
-    definitions?: {
-        [key: string]: import("zod-to-json-schema").JsonSchema7Type;
-    } | undefined;
-}) | null;
-//# sourceMappingURL=jsonStringifyReplacer.d.ts.map

package/dist/types/esm/utils/jsonStringifyReplacer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"jsonStringifyReplacer.d.ts","sourceRoot":"","sources":["../../../../src/utils/jsonStringifyReplacer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AAI7C,eAAO,MAAM,qBAAqB,GAAI,MAAM,MAAM,EAAE,OAAO,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SACc,CAAC"}

package/src/__snapshots__/createConfigBuilder.test.ts.snap

@@ -1,30 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`createConfigBuilder when a user stringifies the config when a config value is a zod schema should stringify the value to JSON schema correctly 1`] = `
-"{
-  "schema": {
-    "anyOf": [
-      {
-        "not": {}
-      },
-      {
-        "type": "object",
-        "properties": {
-          "alpha": {
-            "type": "string"
-          },
-          "bravo": {
-            "type": "boolean"
-          }
-        },
-        "required": [
-          "alpha",
-          "bravo"
-        ],
-        "additionalProperties": false
-      }
-    ],
-    "$schema": "http://json-schema.org/draft-07/schema#"
-  }
-}"
-`;

package/src/utils/jsonStringifyReplacer.ts

@@ -1,6 +0,0 @@
-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;