zcb 0.3.1 → 0.3.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zcb",
   "description": "Build configs with type safety from zod schema.",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "author": "miami-man",
   "license": "MIT",
   "homepage": "https://github.com/badbatch/zod-config-builder",
@@ -22,6 +22,14 @@
       },
       "import": "./dist/esm/index.mjs",
       "require": "./dist/cjs/index.cjs"
+    },
+    "./cli": {
+      "types": {
+        "import": "./dist/types/esm/cli.d.ts",
+        "require": "./dist/types/cjs/cli.d.cts"
+      },
+      "import": "./dist/esm/cli.mjs",
+      "require": "./dist/cjs/cli.cjs"
     }
   },
   "publishConfig": {
@@ -31,11 +39,11 @@
     "@types/fs-extra": "^11.0.4",
     "@types/json-schema": "^7.0.15",
     "@types/lodash-es": "^4.17.12",
-    "@types/shelljs": "^0.8.16",
+    "@types/shelljs": "^0.8.17",
     "@types/uuid": "^10.0.0",
     "@types/yargs": "^17.0.33",
-    "core-js": "^3.43.0",
-    "fs-extra": "^11.3.0",
+    "core-js": "^3.45.0",
+    "fs-extra": "^11.3.1",
     "handlebars": "^4.7.8",
     "json-schema": "^0.4.0",
     "lodash-es": "^4.17.21",
@@ -45,42 +53,42 @@
     "type-fest": "^4.41.0",
     "uuid": "^11.1.0",
     "yargs": "^18.0.0",
-    "zod": "^3.25.63",
-    "zod-to-json-schema": "^3.24.5"
+    "zod": "^3.25.76",
+    "zod-to-json-schema": "^3.24.6"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.8.1",
     "@jest/globals": "^29.7.0",
-    "@repodog/cli": "^1.6.43",
-    "@repodog/commitlint-config": "^19.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.9",
-    "@repodog/swc-config": "^1.0.10",
-    "@repodog/syncpack-config": "^13.0.3",
-    "@repodog/ts-config": "^5.0.4",
+    "@repodog/cli": "^1.6.45",
+    "@repodog/commitlint-config": "^19.0.5",
+    "@repodog/eslint-config": "^9.0.18",
+    "@repodog/eslint-config-jest": "^9.0.6",
+    "@repodog/jest-config": "^29.0.5",
+    "@repodog/markdownlint-config": "^1.2.5",
+    "@repodog/prettier-config": "^3.0.3",
+    "@repodog/rollup-config": "^4.0.11",
+    "@repodog/swc-config": "^1.0.12",
+    "@repodog/syncpack-config": "^13.0.4",
+    "@repodog/ts-config": "^5.0.5",
     "@rollup/plugin-swc": "^0.3.0",
-    "@swc/core": "^1.12.0",
-    "@swc/jest": "^0.2.38",
+    "@swc/core": "^1.13.3",
+    "@swc/jest": "^0.2.39",
     "@types/jest": "^29.5.13",
-    "@types/node": "^24.0.1",
-    "cts-types": "^0.0.9",
+    "@types/node": "^24.2.1",
+    "cts-types": "^0.0.10",
     "del-cli": "^6.0.0",
-    "eslint": "^9.28.0",
+    "eslint": "^9.33.0",
     "generate-changelog": "^1.8.0",
     "husky": "^9.1.7",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "jest-environment-node": "^29.7.0",
     "markdownlint-cli2": "^0.18.1",
-    "prettier": "^3.5.3",
-    "rollup": "^4.43.0",
+    "prettier": "^3.6.2",
+    "rollup": "^4.46.2",
     "suppress-experimental-warnings": "^2.0.0",
     "syncpack": "^13.0.4",
-    "typescript": "^5.8.3"
+    "typescript": "^5.9.2"
   },
   "keywords": [
     "config",
@@ -106,7 +114,7 @@
     "test": "COMPILER=swc node --require=suppress-experimental-warnings --experimental-vm-modules node_modules/jest/bin/jest.js",
     "type-check": "tsc --noEmit",
     "validate": "pnpm run syncpack && pnpm run build && pnpm run lint && pnpm run type-check && pnpm run test",
-    "zcb:build": "NODE_OPTIONS=\"--loader ts-node/esm\" node ./bin/zcb.mjs build ./src/__testUtils__/configBuilder.ts ./src/__testUtils__/builtConfig.ts",
-    "zcb:watch": "NODE_OPTIONS=\"--loader ts-node/esm\" node ./bin/zcb.mjs watch ./src/__testUtils__/configBuilder.ts ./src/__testUtils__/builtConfig.ts"
+    "zcb:build": "NODE_OPTIONS=\"--experimental-strip-types\" node ./bin/zcb.js build ./src/__testUtils__/configBuilder.ts ./src/__testUtils__/builtConfig.ts",
+    "zcb:watch": "NODE_OPTIONS=\"--experimental-strip-types\" node ./bin/zcb.js watch ./src/__testUtils__/configBuilder.ts ./src/__testUtils__/builtConfig.ts"
   }
 }

package/src/__testUtils__/builtConfig.ts

@@ -1,17 +1,18 @@
-/* eslint-disable prettier/prettier, import-x/no-default-export, unicorn/numeric-separators-style */
+/* eslint-disable prettier/prettier, 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: "United Kingdom",
+  countryName: null,
   distanceUnit: "km",
+  enabled: true,
   languageCodes: [
     "en"
   ],
   locales: [
     "en_GB"
   ],
-  name: "alpha",
+  name: undefined,
   pages: {
     contactDetails: {
       name: "contactDetails",

package/src/__testUtils__/configBuilder.ts

@@ -19,13 +19,15 @@ const subsectionBuilder = sectionBuilder.$fork();
 
 configBuilder
   .countryCode('GB')
-  .countryName('United Kingdom')
+  // Want to test using null value
+  // eslint-disable-next-line unicorn/no-null
+  .countryName(null)
   .distanceUnit('km')
+  .enabled(true)
   .languageCodes(['en'])
   .locales(({ countryCode, languageCodes }) =>
     languageCodes?.length && countryCode ? languageCodes.map(code => `${code}_${countryCode}`) : [],
   )
-  .name('alpha')
   .pages({
     contactDetails: pageBuilder
       .name('contactDetails')

package/src/__testUtils__/schema.ts

@@ -42,8 +42,9 @@ export const routeSchema: z.ZodType<RouteType> = baseRouteSchema.extend({
 
 export const configSchema = z.object({
   countryCode: z.enum(countryCodes).optional(),
-  countryName: z.enum(countryNames).optional(),
+  countryName: z.enum(countryNames).optional().nullable(),
   distanceUnit: z.enum(distanceUnits).optional(),
+  enabled: z.boolean().optional(),
   languageCodes: z.array(z.enum(languageCodes)).optional(),
   locales: z.array(z.string().regex(/[a-z]{2}_[A-Z]{2}/)).optional(),
   name: z.string().optional(),

package/src/cli.ts

@@ -5,10 +5,7 @@ import yargs, { type Argv } from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import { importValidateTransformWriteConfig } from './utils/importValidateTransformWriteConfig.ts';
 
-export enum Commands {
-  BUILD = 'build',
-  WATCH = 'watch',
-}
+export type Commands = 'build' | 'watch';
 
 const generateArguments = (cmdYargs: Argv) =>
   cmdYargs
@@ -50,7 +47,7 @@ export const cli = () => {
           importValidateTransformWriteConfig(
             cmdYargs['input-file'],
             cmdYargs['output-file'],
-            Commands.WATCH,
+            'watch',
             cmdYargs['experiments-callback-file'],
           );
         });
@@ -66,7 +63,7 @@ export const cli = () => {
         importValidateTransformWriteConfig(
           cmdYargs['input-file'],
           cmdYargs['output-file'],
-          Commands.BUILD,
+          'build',
           cmdYargs['experiments-callback-file'],
         );
       },

package/src/createConfigBuilder.ts

@@ -4,7 +4,6 @@ import { v4 as uuidV4 } from 'uuid';
 import { type ZodError, type z } from 'zod';
 import { zodToJsonSchema } from 'zod-to-json-schema';
 import { cloneNonEnumerableValues } from './transformers/cloneNonEnumerableValues.ts';
-import { NonEmumeralProperties } from './types.ts';
 import { collateDefaultValues } from './utils/collateDefaultValues.ts';
 import { isDerivedValueCallback } from './utils/isDerivedValueCallback.ts';
 import { isInvalidPropertyOverride } from './utils/isInvalidPropertyOverride.ts';
@@ -70,20 +69,20 @@ export const createConfigBuilder = <ZodTypes>(
   const uuid = options.overrides?.uuid ?? uuidV4;
 
   const addNonEnumeralBaseProperties = (conf: Config) => {
-    Object.defineProperty(conf, NonEmumeralProperties.ZCB, {
+    Object.defineProperty(conf, '__zcb', {
       configurable: false,
       enumerable: false,
       value: true,
     });
 
-    Object.defineProperty(conf, NonEmumeralProperties.ID, {
+    Object.defineProperty(conf, '__id', {
       configurable: false,
       enumerable: false,
       value: uuid(),
     });
 
     if (options.type) {
-      Object.defineProperty(conf, NonEmumeralProperties.TYPE, {
+      Object.defineProperty(conf, '__type', {
         configurable: false,
         enumerable: false,
         value: options.type,
@@ -107,7 +106,7 @@ export const createConfigBuilder = <ZodTypes>(
   // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
   const configBuilder = {
     $disable: () => {
-      Object.defineProperty(config, NonEmumeralProperties.DISABLED, {
+      Object.defineProperty(config, '__disabled', {
         configurable: false,
         enumerable: false,
         value: true,
@@ -126,7 +125,7 @@ export const createConfigBuilder = <ZodTypes>(
       }
     },
     $experiment: (key: string) => {
-      Object.defineProperty(config, NonEmumeralProperties.EXPERIMENT, {
+      Object.defineProperty(config, '__experiment', {
         configurable: false,
         enumerable: false,
         value: key,
@@ -172,7 +171,7 @@ export const createConfigBuilder = <ZodTypes>(
     },
   } as unknown as ConfigBuilder<ZodTypes>;
 
-  Object.defineProperty(configBuilder, NonEmumeralProperties.CALLBACKS, {
+  Object.defineProperty(configBuilder, '__callbacks', {
     configurable: false,
     enumerable: false,
     value: callbacks,

package/src/createConfigReader.test.ts

@@ -1,7 +1,7 @@
 import { createReader } from './__testUtils__/configReader.ts';
 
 describe('createConfigReader', () => {
-  describe('when a user accesses a known property', () => {
+  describe('when that value is a string', () => {
     it('should return the correct value', () => {
       const reader = createReader();
       const value = reader.read('countryCode');
@@ -9,11 +9,69 @@ describe('createConfigReader', () => {
     });
   });
 
-  describe('when a user accesses a known nested property', () => {
+  describe('when that value is a number', () => {
     it('should return the correct value', () => {
       const reader = createReader();
-      const value = reader.read('pages.contactDetails.name');
-      expect(value).toBe('contactDetails');
+      const value = reader.read('timeouts.apollo');
+      expect(value).toBe(10_000);
+    });
+  });
+
+  describe('when that value is a boolean', () => {
+    it('should return the correct value', () => {
+      const reader = createReader();
+      const value = reader.read('enabled');
+      expect(value).toBe(true);
+    });
+  });
+
+  describe('when that value is null', () => {
+    it('should return the correct value', () => {
+      const reader = createReader();
+      const value = reader.read('countryName');
+      expect(value).toBeNull();
+    });
+  });
+
+  describe('when that value is undefined', () => {
+    it('should return the correct value', () => {
+      const reader = createReader();
+      // Required for testing
+      // eslint-disable-next-line @typescript-eslint/no-confusing-void-expression
+      const value = reader.read('name');
+      expect(value).toBeUndefined();
+    });
+  });
+
+  describe('when that value is an array', () => {
+    describe('when the array is of primitives', () => {
+      it('should return the correct value', () => {
+        const reader = createReader();
+        const value = reader.read('languageCodes');
+        expect(value).toEqual(['en']);
+      });
+    });
+
+    describe('when the array is of objects', () => {
+      it('should throw the expected error', () => {
+        const reader = createReader();
+
+        // @ts-expect-error Required to test error
+        expect(() => reader.read('pages.contactDetails.sections')).toThrow(
+          'Path resolved to an object or an array of objects, but `read` can only resolve to a primitive value or an array of primitives. Use the `scope` method instead',
+        );
+      });
+    });
+  });
+
+  describe('when that value is an object', () => {
+    it('should throw the expected error', () => {
+      const reader = createReader();
+
+      // @ts-expect-error Required to test error
+      expect(() => reader.read('timeouts')).toThrow(
+        'Path resolved to an object or an array of objects, but `read` can only resolve to a primitive value or an array of primitives. Use the `scope` method instead.',
+      );
     });
   });
 
@@ -24,14 +82,11 @@ describe('createConfigReader', () => {
     };
 
     describe('when a user accesses a property that is not a string', () => {
-      it('should throw the correct error', () => {
+      it('should throw the expected error', () => {
         const reader = createReader();
 
-        // @ts-expect-error path does not resovle to a string
-        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.',
-          ),
+        expect(() => reader.read('timeouts.apollo', vars)).toThrow(
+          'Config reader received variables to use in string template, but the path did not resolve to a string.',
         );
       });
     });
@@ -46,7 +101,7 @@ describe('createConfigReader', () => {
   });
 
   describe('when the reader is scoped', () => {
-    describe('when a user accesses a known property', () => {
+    describe('when the value is an object', () => {
       it('should return the correct value', () => {
         const reader = createReader();
         const scopedReader = reader.scope('pages.contactDetails');
@@ -54,15 +109,35 @@ describe('createConfigReader', () => {
         expect(value).toBe('contactDetails');
       });
     });
-  });
 
-  describe('when the reader is scoped multiple times', () => {
-    describe('when a user accesses a known property', () => {
+    describe('when the value is an array of objects', () => {
       it('should return the correct value', () => {
         const reader = createReader();
-        const scopedReader = reader.scope('pages.contactDetails').scope('sections.1.sections').scope('0');
-        const value = scopedReader.read('name');
-        expect(value).toBe('main');
+        const scopedReader = reader.scope('pages.contactDetails.sections');
+        const subScopedReader = scopedReader.scope('0');
+        const value = subScopedReader.read('name');
+        expect(value).toBe('header');
+      });
+    });
+
+    describe('when the value is an array of primitives', () => {
+      it('should throw the expected error', () => {
+        const reader = createReader();
+
+        expect(() => reader.scope('languageCodes')).toThrow(
+          'Path resolved to a primitive or an array of primitive, but `scope` can only resolve to an object or an array of object. Use the `read` method instead.',
+        );
+      });
+    });
+
+    describe('when the value is a primitive', () => {
+      it('should throw the expected error', () => {
+        const reader = createReader();
+
+        // @ts-expect-error Required to test error
+        expect(() => reader.scope('timeouts.apollo')).toThrow(
+          'Path resolved to a primitive or an array of primitive, but `scope` can only resolve to an object or an array of object. Use the `read` method instead.',
+        );
       });
     });
   });

package/src/createConfigReader.ts

@@ -1,6 +1,7 @@
-import { get, isString } from 'lodash-es';
+import { isPlainObject, isString } from 'lodash-es';
 import { type Get } from 'type-fest';
 import { type Path, type Scope } from './types.ts';
+import { get } from './utils/typedGet.ts';
 
 export interface ConfigReader<Config extends object> {
   read: <P extends Path<Config>>(path: P, variables?: Record<string, string | number>) => Get<Config, P>;
@@ -10,17 +11,23 @@ export interface ConfigReader<Config extends object> {
 export const createConfigReader = <Config extends object>(config: Config): ConfigReader<Config> => {
   // Aimed at reducing the amount of work for typescript to resolve type.
   // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-  const configReader = {
+  return {
     read: <P extends Path<Config>>(path: P, variables?: Record<string, string | number>) => {
-      if (!variables) {
-        return get(config, path);
+      const output = get(config, path);
+
+      if (isPlainObject(output) || (Array.isArray(output) && output.some(entry => isPlainObject(entry)))) {
+        throw new Error(
+          'Path resolved to an object or an array of objects, but `read` can only resolve to a primitive value or an array of primitives. Use the `scope` method instead.',
+        );
       }
 
-      const output = get(config, path);
+      if (!variables) {
+        return output;
+      }
 
       if (!isString(output)) {
         throw new Error(
-          'config reader received variables to use in string template, but the path did not resolve to a string.',
+          'Config reader received variables to use in string template, but the path did not resolve to a string.',
         );
       }
 
@@ -28,10 +35,16 @@ export const createConfigReader = <Config extends object>(config: Config): Confi
         return acc.replace(new RegExp(`{{${key}}}`), String(variables[key]));
       }, output);
     },
-    // Aimed at reducing the amount of work for typescript to resolve type.
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    scope: <S extends Scope<Config>>(scope: S) => createConfigReader(get(config, scope) as Get<Config, S>),
-  } as ConfigReader<Config>;
+    scope: <S extends Scope<Config>>(scope: S) => {
+      const output = get(config, scope);
 
-  return configReader;
+      if (!isPlainObject(output) && !(Array.isArray(output) && output.some(entry => isPlainObject(entry)))) {
+        throw new Error(
+          'Path resolved to a primitive or an array of primitive, but `scope` can only resolve to an object or an array of object. Use the `read` method instead.',
+        );
+      }
+
+      return createConfigReader(output);
+    },
+  } as ConfigReader<Config>;
 };

package/src/templates/config.ts.hbs

@@ -1,4 +1,4 @@
-/* eslint-disable prettier/prettier, import-x/no-default-export, unicorn/numeric-separators-style */
+/* eslint-disable prettier/prettier, 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 {{{ config }}} as const;

package/src/transformers/cloneNonEnumerableValues.ts

@@ -1,6 +1,6 @@
-import { type AnyRecord, NonEmumeralProperties, type TransformConfigHandlerSync } from '../types.ts';
+import { type AnyRecord, type TransformConfigHandlerSync } from '../types.ts';
 
-const NON_ENUMERABLE_KEYS = new Set(Object.values(NonEmumeralProperties));
+const NON_ENUMERABLE_KEYS = ['__callbacks', '__disabled', '__experiment', '__id', '__type', '__zcb'];
 
 export const cloneNonEnumerableValues: TransformConfigHandlerSync = <
   Config1 extends AnyRecord,

package/src/transformers/removeDisabledSlices.ts

@@ -1,17 +1,12 @@
-import {
-  type AnyRecord,
-  NonEmumeralProperties,
-  TransformConfigHandlerAction,
-  type TransformConfigHandlerSync,
-} from '../types.ts';
+import { type AnyRecord, type TransformConfigHandlerSync } from '../types.ts';
 
 export const removeDisabledSlices: TransformConfigHandlerSync = <Config extends AnyRecord>(
   clone: Config,
   config: Config,
 ) => {
-  if (NonEmumeralProperties.DISABLED in config) {
+  if ('__disabled' in config) {
     return {
-      action: TransformConfigHandlerAction.DELETE_NODE,
+      action: 'DELETE_NODE',
     };
   }
 

package/src/transformers/runExperiments.ts

@@ -1,15 +1,9 @@
-import {
-  type AnyRecord,
-  type Buckets,
-  NonEmumeralProperties,
-  type RunExperimentsCallback,
-  type TransformConfigHandler,
-} from '../types.ts';
+import { type AnyRecord, type Buckets, type RunExperimentsCallback, type TransformConfigHandler } from '../types.ts';
 
 export const runExperiments =
   (callback: RunExperimentsCallback): TransformConfigHandler =>
   async <Config extends AnyRecord>(clone: Config, config: Config) => {
-    if (NonEmumeralProperties.EXPERIMENT in config && typeof config.__experiment === 'object') {
+    if ('__experiment' in config && typeof config.__experiment === 'object') {
       // As __experiment is private property, Typescript doesn't know what type is.
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
       const { buckets, id } = config.__experiment as { buckets: Buckets<Config>; id: string };

package/src/transformers/setupExperiments.ts

@@ -1,14 +1,9 @@
-import {
-  type AnyRecord,
-  NonEmumeralProperties,
-  type SetupExperimentsCallback,
-  type TransformConfigHandler,
-} from '../types.ts';
+import { type AnyRecord, type SetupExperimentsCallback, type TransformConfigHandler } from '../types.ts';
 
 export const setupExperiments =
   (callback: SetupExperimentsCallback): TransformConfigHandler =>
   async <Config extends AnyRecord>(clone: Config, config: Config) => {
-    if (NonEmumeralProperties.EXPERIMENT in config && typeof config.__experiment === 'string') {
+    if ('__experiment' in config && typeof config.__experiment === 'string') {
       const buckets = await callback(config.__experiment, clone, config);
 
       // @ts-expect-error private property

package/src/types.ts

@@ -15,14 +15,7 @@ export interface Experiment<Config extends AnyRecord> {
   value?: Config;
 }
 
-export enum NonEmumeralProperties {
-  CALLBACKS = '__callbacks',
-  DISABLED = '__disabled',
-  EXPERIMENT = '__experiment',
-  ID = '__id',
-  TYPE = '__type',
-  ZCB = '__zcb',
-}
+export type NonEmumeralProperties = '__callbacks' | '__disabled' | '__experiment' | '__id' | '__type' | '__zcb';
 
 export type Path<Config extends object> = Join<Leaves<Config>, '.'>;
 
@@ -46,10 +39,7 @@ export type TransformConfigHandlerSync = <Config extends AnyRecord>(
   config: Config,
 ) => TransformConfigHandlerReturnType<Config>;
 
-export enum TransformConfigHandlerAction {
-  DELETE_NODE = 'deleteNode',
-  SKIP_NODE = 'skipNode',
-}
+export type TransformConfigHandlerAction = 'DELETE_NODE' | 'SKIP_NODE';
 
 export interface TransformConfigHandlerReturnType<Config extends AnyRecord> {
   action?: TransformConfigHandlerAction;
@@ -61,22 +51,43 @@ export interface WriteConfigOptions {
   outputFile: string;
 }
 
-export type Leaves<T, LeafPath extends string[] = [], Depth extends number = 0> = T extends string
-  ? LeafPath
-  : Depth extends 15
-    ? LeafPath
-    : {
-        [K in keyof T & string]: Leaves<T[K], [...LeafPath, K], LeafPath['length']>;
-      }[keyof T & string];
+export type Primitive = string | number | boolean | bigint | symbol | null | undefined;
 
-export type Paths<T, LeafPath extends string[] = [], Depth extends number = 0> = T extends string
-  ? LeafPath
-  : Depth extends 15
-    ? LeafPath
-    : {
-        [K in keyof T & string]: T[K] extends object ? Paths<T[K], [...LeafPath, K], LeafPath['length']> : LeafPath;
-      }[keyof T & string];
+export type Prev = [never, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, ...0[]];
 
+export type IsArrayOfPrimitives<T> = T extends readonly (infer U)[]
+  ? Exclude<U, Primitive> extends never
+    ? true
+    : false
+  : false;
+
+export type OwnKeys<T> = Exclude<
+  {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    [K in Extract<keyof T, string>]: T[K] extends (...args: any[]) => any ? never : K;
+  }[Extract<keyof T, string>],
+  `${string}[Symbol.${string}`
+>;
+
+export type Leaves<T, LeafPath extends string[] = [], Depth extends number = 10> = Depth extends never
+  ? never
+  : T extends Primitive
+    ? LeafPath
+    : IsArrayOfPrimitives<T> extends true
+      ? LeafPath
+      : {
+          [K in OwnKeys<T>]: Leaves<T[K], [...LeafPath, K], Prev[Depth]>;
+        }[OwnKeys<T>];
+
+export type Paths<T, ScopePath extends string[] = [], Depth extends number = 10> = Depth extends never
+  ? never
+  : T extends Primitive
+    ? never
+    : ScopePath extends []
+      ? { [K in OwnKeys<T>]: Paths<T[K], [K], Prev[Depth]> }[OwnKeys<T>]
+      : ScopePath | { [K in OwnKeys<T>]: Paths<T[K], [...ScopePath, K], Prev[Depth]> }[OwnKeys<T>];
+
+// This type is not used, but is left here for reference
 export type LeavesScopeDiffs<T1 extends readonly string[][], T2 extends string[]> = {
   [K1 in keyof T1]: List.Length<List.Intersect<T1[K1], T2, '<-contains'>> extends 1
     ? List.Length<T1[K1]> extends 1