@clipboard-health/config 0.2.1 → 0.4.0

package/README.md

@@ -25,10 +25,10 @@ The TypeDoc comment for the `createConfig` function:
 ```ts
 // ./src/lib/createConfig.ts
 
+import { deepFreeze } from "@clipboard-health/util-typescript";
 import dotenv from "dotenv";
 import { fromZodError } from "zod-validation-error";
 
-import { deepFreeze } from "./internal/deepFreeze";
 import { resolve } from "./internal/resolver";
 import { type ConfigParams } from "./types";
 
@@ -58,9 +58,7 @@ dotenv.config();
  * **IMPORTANT**: To avoid runtime errors:
  * 1. Environment variables are strings, so use `z.coerce` Zod types for those you plan to override.
  *    Note that `z.coerce.boolean()` coerces any truthy value to `true`. To restrict to `"true" |
- *    "false"`, use the
- *    {@link https://github.com/ClipboardHealth/core-utils/blob/main/packages/contract-core/src/lib/schemas/booleanString.ts
- *    `booleanString` schema} from `@clipboard-health/contract-core`.
+ *    "false"`, use the `booleanString` schema from `@clipboard-health/contract-core`.
  * 2. The resulting configuration is deeply frozen and will throw a runtime error if you attempt to
  *    modify it. The actual return type is `ReadonlyDeep<SchemaT>`, but the library returns a
  *    `Readonly<SchemaT>` because the former prevents clients from passing configuration values to

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@clipboard-health/config",
   "description": "Type-safe static configuration management: a pure function to resolve, validate against a Zod schema, and freeze configuration values.",
-  "version": "0.2.1",
+  "version": "0.4.0",
   "dependencies": {
+    "@clipboard-health/util-typescript": "0.3.0",
     "decamelize": "5.0.1",
     "dotenv": "16.4.5",
     "tslib": "2.8.0",

package/src/lib/createConfig.d.ts

@@ -23,9 +23,7 @@ import { type ConfigParams } from "./types";
  * **IMPORTANT**: To avoid runtime errors:
  * 1. Environment variables are strings, so use `z.coerce` Zod types for those you plan to override.
  *    Note that `z.coerce.boolean()` coerces any truthy value to `true`. To restrict to `"true" |
- *    "false"`, use the
- *    {@link https://github.com/ClipboardHealth/core-utils/blob/main/packages/contract-core/src/lib/schemas/booleanString.ts
- *    `booleanString` schema} from `@clipboard-health/contract-core`.
+ *    "false"`, use the `booleanString` schema from `@clipboard-health/contract-core`.
  * 2. The resulting configuration is deeply frozen and will throw a runtime error if you attempt to
  *    modify it. The actual return type is `ReadonlyDeep<SchemaT>`, but the library returns a
  *    `Readonly<SchemaT>` because the former prevents clients from passing configuration values to

package/src/lib/createConfig.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createConfig = createConfig;
 const tslib_1 = require("tslib");
+const util_typescript_1 = require("@clipboard-health/util-typescript");
 const dotenv_1 = tslib_1.__importDefault(require("dotenv"));
 const zod_validation_error_1 = require("zod-validation-error");
-const deepFreeze_1 = require("./internal/deepFreeze");
 const resolver_1 = require("./internal/resolver");
 dotenv_1.default.config();
 /**
@@ -31,9 +31,7 @@ dotenv_1.default.config();
  * **IMPORTANT**: To avoid runtime errors:
  * 1. Environment variables are strings, so use `z.coerce` Zod types for those you plan to override.
  *    Note that `z.coerce.boolean()` coerces any truthy value to `true`. To restrict to `"true" |
- *    "false"`, use the
- *    {@link https://github.com/ClipboardHealth/core-utils/blob/main/packages/contract-core/src/lib/schemas/booleanString.ts
- *    `booleanString` schema} from `@clipboard-health/contract-core`.
+ *    "false"`, use the `booleanString` schema from `@clipboard-health/contract-core`.
  * 2. The resulting configuration is deeply frozen and will throw a runtime error if you attempt to
  *    modify it. The actual return type is `ReadonlyDeep<SchemaT>`, but the library returns a
  *    `Readonly<SchemaT>` because the former prevents clients from passing configuration values to
@@ -54,6 +52,6 @@ function createConfig(params) {
             cause: result.error,
         });
     }
-    return (0, deepFreeze_1.deepFreeze)(result.data);
+    return (0, util_typescript_1.deepFreeze)(result.data);
 }
 //# sourceMappingURL=createConfig.js.map

package/src/lib/createConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"createConfig.js","sourceRoot":"","sources":["../../../../../packages/config/src/lib/createConfig.ts"],"names":[],"mappings":";;AA+CA,oCAeC;;AA9DD,4DAA4B;AAC5B,+DAAoD;AAEpD,sDAAmD;AACnD,kDAA8C;AAG9C,gBAAM,CAAC,MAAM,EAAE,CAAC;AAEhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,SAAgB,YAAY,CAG1B,MAAqD;IACrD,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAC/C,MAAM,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC;IAEhC,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,IAAA,kBAAO,EAAC,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC7F,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,oCAAoC,IAAA,mCAAY,EAAC,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE;YAC3F,KAAK,EAAE,MAAM,CAAC,KAAK;SACpB,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAA,uBAAU,EAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AACjC,CAAC"}
+{"version":3,"file":"createConfig.js","sourceRoot":"","sources":["../../../../../packages/config/src/lib/createConfig.ts"],"names":[],"mappings":";;AA6CA,oCAeC;;AA5DD,uEAA+D;AAC/D,4DAA4B;AAC5B,+DAAoD;AAEpD,kDAA8C;AAG9C,gBAAM,CAAC,MAAM,EAAE,CAAC;AAEhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,SAAgB,YAAY,CAG1B,MAAqD;IACrD,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAC/C,MAAM,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC;IAEhC,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,IAAA,kBAAO,EAAC,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC7F,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,oCAAoC,IAAA,mCAAY,EAAC,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE;YAC3F,KAAK,EAAE,MAAM,CAAC,KAAK;SACpB,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAA,4BAAU,EAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AACjC,CAAC"}

package/src/lib/internal/resolver.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolve = resolve;
 const tslib_1 = require("tslib");
+const util_typescript_1 = require("@clipboard-health/util-typescript");
 const decamelize_1 = tslib_1.__importDefault(require("decamelize"));
 const zod_1 = require("zod");
-const isDefined_1 = require("./isDefined");
 function resolve(params) {
     const { config, path, ...rest } = params;
     return Object.fromEntries(Object.entries(config).map(([key, value]) => [
@@ -16,18 +16,18 @@ function resolve(params) {
 }
 function isConfigValue(value) {
     return (typeof value === "object" &&
-        (0, isDefined_1.isDefined)(value) &&
+        (0, util_typescript_1.isDefined)(value) &&
         "description" in value &&
         "defaultValue" in value);
 }
 function resolveConfigValue(params) {
     const { environment, path, schema, value } = params;
     const variable = process.env[(0, decamelize_1.default)(path.join("_")).toUpperCase()];
-    if ((0, isDefined_1.isDefined)(variable)) {
+    if ((0, util_typescript_1.isDefined)(variable)) {
         return parseEnvironmentVariable(variable, getSchema(path, schema));
     }
     const override = value.overrides?.[environment];
-    if ((0, isDefined_1.isDefined)(override)) {
+    if ((0, util_typescript_1.isDefined)(override)) {
         return override;
     }
     return value.defaultValue;

package/src/lib/internal/resolver.js.map

@@ -1 +1 @@
-{"version":3,"file":"resolver.js","sourceRoot":"","sources":["../../../../../../packages/config/src/lib/internal/resolver.ts"],"names":[],"mappings":";;AAiBA,0BAeC;;AAhCD,oEAAoC;AACpC,6BAAwB;AAGxB,2CAAwC;AAaxC,SAAgB,OAAO,CACrB,MAAwC;IAExC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IAEzC,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CACxB,CAAC,CAAC,GAAG,EAAE,KAAK,CAAuD,EAAE,EAAE,CAAC;QACtE,GAAG;QACH,aAAa,CAAC,KAAK,CAAC;YAClB,CAAC,CAAC,kBAAkB,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC;YAC9D,CAAC,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;KAC9D,CACF,CACF,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACnC,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,IAAA,qBAAS,EAAC,KAAK,CAAC;QAChB,aAAa,IAAI,KAAK;QACtB,cAAc,IAAI,KAAK,CACxB,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CAAC,MAAgC;IAC1D,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;IAEpD,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,IAAA,oBAAU,EAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IACvE,IAAI,IAAA,qBAAS,EAAC,QAAQ,CAAC,EAAE,CAAC;QACxB,OAAO,wBAAwB,CAAC,QAAQ,EAAE,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,QAAQ,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC,WAAW,CAAC,CAAC;IAChD,IAAI,IAAA,qBAAS,EAAC,QAAQ,CAAC,EAAE,CAAC;QACxB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,KAAK,CAAC,YAAY,CAAC;AAC5B,CAAC;AAED,SAAS,wBAAwB,CAAC,KAAc,EAAE,MAA0B;IAC1E,IAAI,MAAM,YAAY,OAAC,CAAC,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9D,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,SAAS,CAAC,IAAuB,EAAE,MAA0B;IACpE,OAAO,IAAI,CAAC,MAAM,CAChB,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;IACd,+DAA+D;IAC/D,MAAM,YAAY,OAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,0BAA0B,CAAC,MAAM,EACvF,MAAM,CACP,CAAC;AACJ,CAAC"}
+{"version":3,"file":"resolver.js","sourceRoot":"","sources":["../../../../../../packages/config/src/lib/internal/resolver.ts"],"names":[],"mappings":";;AAiBA,0BAeC;;AAhCD,uEAA8D;AAC9D,oEAAoC;AACpC,6BAAwB;AAexB,SAAgB,OAAO,CACrB,MAAwC;IAExC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IAEzC,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CACxB,CAAC,CAAC,GAAG,EAAE,KAAK,CAAuD,EAAE,EAAE,CAAC;QACtE,GAAG;QACH,aAAa,CAAC,KAAK,CAAC;YAClB,CAAC,CAAC,kBAAkB,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC;YAC9D,CAAC,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;KAC9D,CACF,CACF,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACnC,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,IAAA,2BAAS,EAAC,KAAK,CAAC;QAChB,aAAa,IAAI,KAAK;QACtB,cAAc,IAAI,KAAK,CACxB,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CAAC,MAAgC;IAC1D,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;IAEpD,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,IAAA,oBAAU,EAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IACvE,IAAI,IAAA,2BAAS,EAAC,QAAQ,CAAC,EAAE,CAAC;QACxB,OAAO,wBAAwB,CAAC,QAAQ,EAAE,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,QAAQ,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC,WAAW,CAAC,CAAC;IAChD,IAAI,IAAA,2BAAS,EAAC,QAAQ,CAAC,EAAE,CAAC;QACxB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,KAAK,CAAC,YAAY,CAAC;AAC5B,CAAC;AAED,SAAS,wBAAwB,CAAC,KAAc,EAAE,MAA0B;IAC1E,IAAI,MAAM,YAAY,OAAC,CAAC,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9D,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,SAAS,CAAC,IAAuB,EAAE,MAA0B;IACpE,OAAO,IAAI,CAAC,MAAM,CAChB,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;IACd,+DAA+D;IAC/D,MAAM,YAAY,OAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,0BAA0B,CAAC,MAAM,EACvF,MAAM,CACP,CAAC;AACJ,CAAC"}

package/src/lib/internal/deepFreeze.d.ts

@@ -1,9 +0,0 @@
-/**
- * Recursively freezes an object and all its nested properties.
- *
- * @template T - Type of the object to freeze
- * @param value - The object to freeze
- * @param seen - Internal parameter to track circular references
- * @returns A deeply frozen version of the input object.
- */
-export declare function deepFreeze<T extends object>(value: T, seen?: WeakSet<WeakKey>): Readonly<T>;

package/src/lib/internal/deepFreeze.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.deepFreeze = deepFreeze;
-/**
- * Recursively freezes an object and all its nested properties.
- *
- * @template T - Type of the object to freeze
- * @param value - The object to freeze
- * @param seen - Internal parameter to track circular references
- * @returns A deeply frozen version of the input object.
- */
-// eslint-disable-next-line @typescript-eslint/ban-types
-function deepFreeze(value, seen = new WeakSet()) {
-    if (!value || typeof value !== "object" || seen.has(value)) {
-        return value;
-    }
-    seen.add(value);
-    Reflect.ownKeys(value).forEach((key) => {
-        const property = value[key];
-        if (property && typeof property === "object" && !Object.isFrozen(property)) {
-            // eslint-disable-next-line @typescript-eslint/ban-types
-            deepFreeze(property, seen);
-        }
-    });
-    return Object.freeze(value);
-}
-//# sourceMappingURL=deepFreeze.js.map

package/src/lib/internal/deepFreeze.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"deepFreeze.js","sourceRoot":"","sources":["../../../../../../packages/config/src/lib/internal/deepFreeze.ts"],"names":[],"mappings":";;AASA,gCAeC;AAxBD;;;;;;;GAOG;AACH,wDAAwD;AACxD,SAAgB,UAAU,CAAmB,KAAQ,EAAE,IAAI,GAAG,IAAI,OAAO,EAAE;IACzE,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3D,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACf,OAAO,CAAC,OAAO,CAAC,KAAK,CAAoB,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QACzD,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3E,wDAAwD;YACxD,UAAU,CAA2B,QAAQ,EAAE,IAAI,CAAC,CAAC;QACvD,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC"}

package/src/lib/internal/isDefined.d.ts

@@ -1,4 +0,0 @@
-/**
- * Type guard that checks if a value is neither null nor undefined.
- */
-export declare function isDefined<T>(value: T): value is NonNullable<T>;

package/src/lib/internal/isDefined.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isDefined = isDefined;
-/**
- * Type guard that checks if a value is neither null nor undefined.
- */
-function isDefined(value) {
-    return value !== null && value !== undefined;
-}
-//# sourceMappingURL=isDefined.js.map

package/src/lib/internal/isDefined.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"isDefined.js","sourceRoot":"","sources":["../../../../../../packages/config/src/lib/internal/isDefined.ts"],"names":[],"mappings":";;AAGA,8BAEC;AALD;;GAEG;AACH,SAAgB,SAAS,CAAI,KAAQ;IACnC,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC;AAC/C,CAAC"}