zcb 0.2.10 → 0.3.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zcb",
   "description": "Build configs with type safety from zod schema.",
-  "version": "0.2.10",
+  "version": "0.3.0",
   "author": "Dylan Aubrey",
   "license": "MIT",
   "homepage": "https://github.com/badbatch/zod-config-builder",

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.