@cripty2001/utils 0.0.231 → 0.0.233

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { Whispr } from "@cripty2001/whispr";
-import type { TSchema } from "@sinclair/typebox";
+import type { Static, TSchema } from "@sinclair/typebox";
 export type JSONEncodable = number | string | boolean | JSONEncodable[] | null | {
     [key: string]: JSONEncodable;
 };
@@ -85,6 +85,9 @@ export declare function parseQuery(query: string | Record<string, any> | URLSear
  * @throws If `max - min + 1` is greater than 2^32
  */
 export declare function randBetween(min: number, max: number): number;
+export declare class GetenvHandledError extends Error {
+    constructor(message: string);
+}
 /**
  * Get an environment variable, convert it using the given converter function.
  * If the environment variable is not defined, the default value is used.
@@ -92,7 +95,7 @@ export declare function randBetween(min: number, max: number): number;
  *
  * @param key The environment variable key
  * @param defaultValue The default value to use if the environment variable is not defined
- * @param converter The function to use to convert the environment variable value to the desired type
+ * @param converter The function to use to convert the environment variable value to the desired type. If the converter throws a GetenvHandledError, that message is surfaced to the user. Otherwise, a generic error message is thrown.
  *
  * @returns The converted environment variable value, or the default value if provided
  *
@@ -100,18 +103,31 @@ export declare function randBetween(min: number, max: number): number;
  * @throws If the conversion throws an error
  */
 export declare function getEnv<R>(key: string, defaultValue?: R, converter?: (string: string) => R): R;
+/**
+ * @see getEnv, returning a string.
+ *
+ * @param allowEmpty Whether to allow empty strings
+ */
+export declare function getEnvString(key: string, allowEmpty?: boolean, defaultValue?: string): string;
 /**
  * @see getEnv, with the additional constraint that the environment variable must be a valid integer.
+ *
+ * @param constraints The constraints (min and max) to apply to the environment variable value
+ *
  * Note: the default value is not used instead of an invalid integer. An invalid integer therefore throws an error.
  */
-export declare function getEnvInt(key: string, defaultValue?: number): number;
+export declare function getEnvInt(key: string, constraints?: {
+    min?: number;
+    max?: number;
+}, defaultValue?: number): number;
 /**
- * @see getEnv, with the additional constraint that the environment variable must be a valid JSON object.
- * Note: the default value is not used instead of an invalid JSON object. An invalid JSON object therefore throws an error.
+ * @see getEnv, with the additional constraint that the environment variable must be valid JSON.
+ * Note: the default value is not used instead of invalid JSON or a schema mismatch. Those therefore throw.
  *
- * @param schema The schema to use to validate the environment variable value
+ * @param schema Optional TypeBox schema.
  */
-export declare function getEnvJson<T>(key: string, defaultValue?: T, schema?: TSchema): T;
+export declare function getEnvJson<T>(key: string, defaultValue?: T): T;
+export declare function getEnvJson<S extends TSchema>(key: string, defaultValue: Static<S> | undefined, schema: S): Static<S>;
 export declare const CURRENT_TS_MS: () => Whispr<number>;
 export declare function getClock(rate: number): Whispr<number>;
 export declare function timediff2HumanReadable(diffMs: number): string;

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CURRENT_TS_MS = void 0;
+exports.CURRENT_TS_MS = exports.GetenvHandledError = void 0;
 exports.randomBelow = randomBelow;
 exports.getRandom = getRandom;
 exports.getRandomId = getRandomId;
@@ -16,6 +16,7 @@ exports.stableLog = stableLog;
 exports.parseQuery = parseQuery;
 exports.randBetween = randBetween;
 exports.getEnv = getEnv;
+exports.getEnvString = getEnvString;
 exports.getEnvInt = getEnvInt;
 exports.getEnvJson = getEnvJson;
 exports.getClock = getClock;
@@ -23,6 +24,7 @@ exports.timediff2HumanReadable = timediff2HumanReadable;
 exports.fn2promise = fn2promise;
 exports.safeApply = safeApply;
 const whispr_1 = require("@cripty2001/whispr");
+const value_1 = require("@sinclair/typebox/value");
 const lodash_1 = require("lodash");
 const U32_LIMIT = 0x1_0000_0000;
 function randomU32() {
@@ -224,6 +226,12 @@ function randBetween(min, max) {
         return min;
     return min + randomBelow(span);
 }
+class GetenvHandledError extends Error {
+    constructor(message) {
+        super(message);
+    }
+}
+exports.GetenvHandledError = GetenvHandledError;
 /**
  * Get an environment variable, convert it using the given converter function.
  * If the environment variable is not defined, the default value is used.
@@ -231,7 +239,7 @@ function randBetween(min, max) {
  *
  * @param key The environment variable key
  * @param defaultValue The default value to use if the environment variable is not defined
- * @param converter The function to use to convert the environment variable value to the desired type
+ * @param converter The function to use to convert the environment variable value to the desired type. If the converter throws a GetenvHandledError, that message is surfaced to the user. Otherwise, a generic error message is thrown.
  *
  * @returns The converted environment variable value, or the default value if provided
  *
@@ -251,26 +259,61 @@ function getEnv(key, defaultValue, converter = (s) => s) {
             return converter(value);
         }
         catch (e) {
-            throw new Error(`Environment variable ${key} cannot be converted to the desired type.`);
+            const message = e instanceof GetenvHandledError ? `(${e.message})` : "";
+            throw new Error(`Environment variable ${key} cannot be converted to the desired type.${message}`);
         }
     })();
     return converted;
 }
 /**
- * @see getEnv, with the additional constraint that the environment variable must be a valid integer.
- * Note: the default value is not used instead of an invalid integer. An invalid integer therefore throws an error.
+ * @see getEnv, returning a string.
+ *
+ * @param allowEmpty Whether to allow empty strings
  */
-function getEnvInt(key, defaultValue) {
-    return getEnv(key, defaultValue, (s) => parseInt(s));
+function getEnvString(key, allowEmpty = false, defaultValue) {
+    return getEnv(key, defaultValue, (s) => {
+        if (s === "" && !allowEmpty)
+            throw new GetenvHandledError(`Empty string.`);
+        return s;
+    });
 }
 /**
- * @see getEnv, with the additional constraint that the environment variable must be a valid JSON object.
- * Note: the default value is not used instead of an invalid JSON object. An invalid JSON object therefore throws an error.
+ * @see getEnv, with the additional constraint that the environment variable must be a valid integer.
  *
- * @param schema The schema to use to validate the environment variable value
+ * @param constraints The constraints (min and max) to apply to the environment variable value
+ *
+ * Note: the default value is not used instead of an invalid integer. An invalid integer therefore throws an error.
  */
+function getEnvInt(key, constraints = {}, defaultValue) {
+    return getEnv(key, defaultValue, (s) => {
+        if (!/^[+-]?\d+$/.test(s))
+            throw new GetenvHandledError(`Invalid integer.`);
+        const parsed = Number(s);
+        if (!Number.isInteger(parsed))
+            throw new GetenvHandledError(`Invalid integer.`);
+        const MIN = constraints.min ?? Number.MIN_SAFE_INTEGER;
+        if (parsed < MIN)
+            throw new GetenvHandledError(`Less than minimum: ${MIN}.`);
+        const MAX = constraints.max ?? Number.MAX_SAFE_INTEGER;
+        if (parsed > MAX)
+            throw new GetenvHandledError(`Greater than maximum: ${MAX}.`);
+        return parsed;
+    });
+}
 function getEnvJson(key, defaultValue, schema) {
-    return getEnv(key, defaultValue, (s) => JSON.parse(s));
+    return getEnv(key, defaultValue, (s) => {
+        const parsed = (() => {
+            try {
+                return JSON.parse(s);
+            }
+            catch {
+                throw new GetenvHandledError(`Invalid JSON.`);
+            }
+        })();
+        if (schema === undefined)
+            return parsed;
+        return value_1.Value.Parse(schema, parsed);
+    });
 }
 const [currentTsMs, setCurrentTsMs] = whispr_1.Whispr.create(Date.now());
 let currentTsMsInterval = null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cripty2001/utils",
-  "version": "0.0.231",
+  "version": "0.0.233",
   "description": "Internal Set of utils. If you need them use them, otherwise go to the next package ;)",
   "homepage": "https://github.com/cripty2001/utils#readme",
   "bugs": {