zcb 0.2.10 → 0.3.1

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "zcb",
   "description": "Build configs with type safety from zod schema.",
-  "version": "0.2.10",
-  "author": "Dylan Aubrey",
+  "version": "0.3.1",
+  "author": "miami-man",
   "license": "MIT",
   "homepage": "https://github.com/badbatch/zod-config-builder",
   "repository": "badbatch/zod-config-builder",
@@ -31,56 +31,56 @@
     "@types/fs-extra": "^11.0.4",
     "@types/json-schema": "^7.0.15",
     "@types/lodash-es": "^4.17.12",
-    "@types/shelljs": "^0.8.15",
+    "@types/shelljs": "^0.8.16",
     "@types/uuid": "^10.0.0",
     "@types/yargs": "^17.0.33",
-    "core-js": "^3.39.0",
-    "fs-extra": "^11.2.0",
+    "core-js": "^3.43.0",
+    "fs-extra": "^11.3.0",
     "handlebars": "^4.7.8",
     "json-schema": "^0.4.0",
     "lodash-es": "^4.17.21",
-    "shelljs": "^0.8.5",
+    "shelljs": "^0.10.0",
     "ts-node": "^10.9.2",
     "ts-toolbelt": "^9.6.0",
-    "type-fest": "^4.26.1",
-    "uuid": "^11.0.2",
-    "yargs": "^17.7.2",
-    "zod": "^3.23.8",
-    "zod-to-json-schema": "^3.23.5"
+    "type-fest": "^4.41.0",
+    "uuid": "^11.1.0",
+    "yargs": "^18.0.0",
+    "zod": "^3.25.63",
+    "zod-to-json-schema": "^3.24.5"
   },
   "devDependencies": {
-    "@commitlint/cli": "^19.5.0",
+    "@commitlint/cli": "^19.8.1",
     "@jest/globals": "^29.7.0",
-    "@repodog/cli": "^1.6.36",
+    "@repodog/cli": "^1.6.43",
     "@repodog/commitlint-config": "^19.0.3",
-    "@repodog/eslint-config": "^9.0.7",
-    "@repodog/eslint-config-jest": "^9.0.3",
-    "@repodog/jest-config": "^29.0.3",
+    "@repodog/eslint-config": "^9.0.15",
+    "@repodog/eslint-config-jest": "^9.0.4",
+    "@repodog/jest-config": "^29.0.4",
     "@repodog/markdownlint-config": "^1.2.4",
     "@repodog/prettier-config": "^3.0.2",
-    "@repodog/rollup-config": "^4.0.3",
-    "@repodog/swc-config": "^1.0.3",
-    "@repodog/syncpack-config": "^13.0.2",
+    "@repodog/rollup-config": "^4.0.9",
+    "@repodog/swc-config": "^1.0.10",
+    "@repodog/syncpack-config": "^13.0.3",
     "@repodog/ts-config": "^5.0.4",
     "@rollup/plugin-swc": "^0.3.0",
-    "@swc/core": "^1.7.26",
-    "@swc/jest": "^0.2.36",
+    "@swc/core": "^1.12.0",
+    "@swc/jest": "^0.2.38",
     "@types/jest": "^29.5.13",
-    "@types/node": "^22.5.5",
-    "cts-types": "^0.0.7",
+    "@types/node": "^24.0.1",
+    "cts-types": "^0.0.9",
     "del-cli": "^6.0.0",
-    "eslint": "^9.11.0",
+    "eslint": "^9.28.0",
     "generate-changelog": "^1.8.0",
-    "husky": "^9.1.6",
+    "husky": "^9.1.7",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "jest-environment-node": "^29.7.0",
-    "markdownlint-cli2": "^0.14.0",
-    "prettier": "^3.3.3",
-    "rollup": "^4.22.4",
+    "markdownlint-cli2": "^0.18.1",
+    "prettier": "^3.5.3",
+    "rollup": "^4.43.0",
     "suppress-experimental-warnings": "^2.0.0",
-    "syncpack": "^13.0.0",
-    "typescript": "^5.6.2"
+    "syncpack": "^13.0.4",
+    "typescript": "^5.8.3"
   },
   "keywords": [
     "config",
@@ -93,8 +93,8 @@
     "clean:dist": "del-cli ./dist",
     "commit": "commit",
     "compile": "pnpm run /^compile:.*/",
-    "compile:cjs": "MODULE_SYSTEM=cjs rollup -c ./rollup.config.cjs",
-    "compile:esm": "rollup -c ./rollup.config.cjs",
+    "compile:cjs": "MODULE_SYSTEM=cjs rollup -c ./rollup.config.mjs",
+    "compile:esm": "rollup -c ./rollup.config.mjs",
     "compile:types": "tsc --project ./tsconfig.build.json && cts-types build dist/types/esm dist/types/cjs",
     "cut:changelog": "changelog",
     "installActivateMise": "sh shellScripts/installActivateMise.sh",

package/src/__testUtils__/builtConfig.ts

@@ -1,4 +1,4 @@
-/* eslint-disable prettier/prettier, unicorn/numeric-separators-style */
+/* eslint-disable prettier/prettier, import-x/no-default-export, unicorn/numeric-separators-style */
 /* This file is autogenerated, do not edit directly, your changes will not perist. */
 
 export default {

package/src/__testUtils__/configBuilder.ts

@@ -54,4 +54,6 @@ configBuilder
   .timeouts({ apollo: 10_000 })
   .timezone('Europe/London');
 
+// convention is to default export.
+// eslint-disable-next-line import-x/no-default-export
 export default configBuilder;

package/src/createConfigReader.test.ts

@@ -28,7 +28,7 @@ describe('createConfigReader', () => {
         const reader = createReader();
 
         // @ts-expect-error path does not resovle to a string
-        expect(() => reader.read('pages.contactDetails', { vars })).toThrow(
+        expect(() => reader.read('pages.contactDetails', vars)).toThrow(
           new Error(
             'config reader received variables to use in string template, but the path did not resolve to a string.',
           ),
@@ -39,7 +39,7 @@ describe('createConfigReader', () => {
     describe('when a user accesses a property that is a string', () => {
       it('should return the correct string value with template placeholders populated', () => {
         const reader = createReader();
-        const value = reader.read('templateString', { vars });
+        const value = reader.read('templateString', vars);
         expect(value).toBe('Simple Simon met a pieman going to the fair');
       });
     });

package/src/createConfigReader.ts

@@ -2,12 +2,8 @@ import { get, isString } from 'lodash-es';
 import { type Get } from 'type-fest';
 import { type Path, type Scope } from './types.ts';
 
-export type ReadOptions = {
-  vars?: Record<string, string | number>;
-};
-
 export interface ConfigReader<Config extends object> {
-  read: <P extends Path<Config>>(path: P, options?: ReadOptions) => Get<Config, P>;
+  read: <P extends Path<Config>>(path: P, variables?: Record<string, string | number>) => Get<Config, P>;
   scope: <S extends Scope<Config>>(scope: S) => ConfigReader<Get<Config, S>>;
 }
 
@@ -15,8 +11,8 @@ export const createConfigReader = <Config extends object>(config: Config): Confi
   // Aimed at reducing the amount of work for typescript to resolve type.
   // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
   const configReader = {
-    read: <P extends Path<Config>>(path: P, { vars }: ReadOptions = {}) => {
-      if (!vars) {
+    read: <P extends Path<Config>>(path: P, variables?: Record<string, string | number>) => {
+      if (!variables) {
         return get(config, path);
       }
 
@@ -28,8 +24,8 @@ export const createConfigReader = <Config extends object>(config: Config): Confi
         );
       }
 
-      return Object.keys(vars).reduce<string>((acc, key) => {
-        return acc.replace(new RegExp(`{{${key}}}`), String(vars[key]));
+      return Object.keys(variables).reduce<string>((acc, key) => {
+        return acc.replace(new RegExp(`{{${key}}}`), String(variables[key]));
       }, output);
     },
     // Aimed at reducing the amount of work for typescript to resolve type.

package/src/transformers/cloneNonEnumerableValues.ts

@@ -14,7 +14,6 @@ export const cloneNonEnumerableValues: TransformConfigHandlerSync = <
       Object.defineProperty(clone, nonEnumerableKey, {
         configurable: false,
         enumerable: false,
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         value: config[nonEnumerableKey],
       });
     }