@bouko/ts 0.2.0 → 0.2.2

package/dist/index.d.ts

@@ -1,10 +1,10 @@
-import type { JsonMap, JsonValue } from "./types/generic";
-export * from "./types/generic";
-export * from "./types/work";
-export * from "./utils/checkers";
-export * from "./utils/formatters";
-export * from "./utils/parsers";
-export declare const safely: <T>(action: () => T) => T | undefined;
-export declare const safelyThru: <T>(arr: T[], action: (item: T) => void) => void;
-export declare const isJsonMap: (value: unknown) => value is JsonMap;
-export declare const isJsonValue: (value: unknown) => value is JsonValue;
+import type { JsonMap, JsonValue } from "./types/generic";
+export * from "./types/generic";
+export * from "./types/work";
+export * from "./utils/checkers";
+export * from "./utils/formatters";
+export * from "./utils/parsers";
+export declare const safely: <T>(action: () => T) => T | undefined;
+export declare const safelyThru: <T>(arr: T[], action: (item: T) => void) => void;
+export declare const isJsonMap: (value: unknown) => value is JsonMap;
+export declare const isJsonValue: (value: unknown) => value is JsonValue;

package/dist/index.js

@@ -1,36 +1,36 @@
-export * from "./types/generic";
-export * from "./types/work";
-export * from "./utils/checkers";
-export * from "./utils/formatters";
-export * from "./utils/parsers";
-export const safely = (action) => {
-    try {
-        return action();
-    }
-    catch (err) {
-        return undefined;
-    }
-};
-export const safelyThru = (arr, action) => {
-    try {
-        arr.forEach(action);
-    }
-    catch {
-    }
-};
-export const isJsonMap = (value) => {
-    if (typeof value !== "object" ||
-        value === null ||
-        Array.isArray(value))
-        return false;
-    return Object.entries(value)
-        .every(([_, v]) => isJsonValue(v) ||
-        (Array.isArray(v) &&
-            v.every(isJsonValue)));
-};
-export const isJsonValue = (value) => (typeof value === "string" ||
-    typeof value === "number" ||
-    typeof value === "boolean" ||
-    value === null ||
-    value === undefined ||
-    isJsonMap(value));
+export * from "./types/generic";
+export * from "./types/work";
+export * from "./utils/checkers";
+export * from "./utils/formatters";
+export * from "./utils/parsers";
+export const safely = (action) => {
+    try {
+        return action();
+    }
+    catch (err) {
+        return undefined;
+    }
+};
+export const safelyThru = (arr, action) => {
+    try {
+        arr.forEach(action);
+    }
+    catch {
+    }
+};
+export const isJsonMap = (value) => {
+    if (typeof value !== "object" ||
+        value === null ||
+        Array.isArray(value))
+        return false;
+    return Object.entries(value)
+        .every(([_, v]) => isJsonValue(v) ||
+        (Array.isArray(v) &&
+            v.every(isJsonValue)));
+};
+export const isJsonValue = (value) => (typeof value === "string" ||
+    typeof value === "number" ||
+    typeof value === "boolean" ||
+    value === null ||
+    value === undefined ||
+    isJsonMap(value));

package/dist/types/generic.d.ts

@@ -1,15 +1,15 @@
-/**
- * Type definitions for common data structures.
- *
- * - `StringMap`: Map of string keys to string values.
- * - `JsonMap`: Object of primitives, arrays, or nested maps.
- * - `JsonValue`: Union type representing a valid JSON value.
- *
- * They are intended to facilitate type-safe handling
- * of generic objects (ex. forms)
-**/
-export type StringMap = Record<string, string>;
-export type JsonMap = {
-    [key: string]: JsonValue | JsonValue[];
-};
-export type JsonValue = string | string[] | number | number[] | boolean | boolean[] | null | null[] | undefined | undefined[] | JsonMap | JsonMap[];
+/**
+ * Type definitions for common data structures.
+ *
+ * - `StringMap`: Map of string keys to string values.
+ * - `JsonMap`: Object of primitives, arrays, or nested maps.
+ * - `JsonValue`: Union type representing a valid JSON value.
+ *
+ * They are intended to facilitate type-safe handling
+ * of generic objects (ex. forms).
+**/
+export declare type StringMap = Record<string, string>;
+export declare type JsonMap = {
+    [key: string]: JsonValue | JsonValue[];
+};
+export declare type JsonValue = string | string[] | number | number[] | boolean | boolean[] | null | null[] | undefined | undefined[] | JsonMap | JsonMap[];

package/dist/types/generic.js

@@ -1,12 +1,12 @@
-/**
- * Type definitions for common data structures.
- *
- * - `StringMap`: Map of string keys to string values.
- * - `JsonMap`: Object of primitives, arrays, or nested maps.
- * - `JsonValue`: Union type representing a valid JSON value.
- *
- * They are intended to facilitate type-safe handling
- * of generic objects (ex. forms)
-**/
-export {};
-// clean
+/**
+ * Type definitions for common data structures.
+ *
+ * - `StringMap`: Map of string keys to string values.
+ * - `JsonMap`: Object of primitives, arrays, or nested maps.
+ * - `JsonValue`: Union type representing a valid JSON value.
+ *
+ * They are intended to facilitate type-safe handling
+ * of generic objects (ex. forms).
+**/
+export {};
+// clean

package/dist/types/work.d.ts

@@ -1,3 +1,3 @@
-export type Job = {
-    job_id: string;
-};
+export declare type Job = {
+    job_id: string;
+};

package/dist/types/work.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/utils/checkers.d.ts

@@ -1,2 +1,2 @@
-export declare const isNum: (x: string) => boolean;
-export declare const isBool: (x: string) => boolean;
+export declare const isNum: (x: string) => boolean;
+export declare const isBool: (x: string) => boolean;

package/dist/utils/checkers.js

@@ -1,5 +1,5 @@
-export const isNum = (x) => !isNaN(Number(x));
-export const isBool = (x) => {
-    const lower = x.trim().toLowerCase();
-    return lower === "true" || lower === "false";
-};
+export const isNum = (x) => !isNaN(Number(x));
+export const isBool = (x) => {
+    const lower = x.trim().toLowerCase();
+    return lower === "true" || lower === "false";
+};

package/dist/utils/env.d.ts

@@ -0,0 +1,5 @@
+export declare function getEnv(key: string): string;
+export declare function getEnv(key: string, fallback: string): string;
+export declare function getEnv(key: string, fallback: number): number;
+export declare function getEnv(key: string, fallback: boolean): boolean;
+export declare function getEnv<T>(key: string): T;

package/dist/utils/env.js

@@ -0,0 +1,23 @@
+import { parseStr } from "./parsers";
+/**
+ * Retrieves and parses an environment variable.
+ *
+ * @param key - The variable name
+ * @param fallback - Backup if no value is found (optional)
+ *
+ * @returns {JsonValue} The value parsed based on whichever
+ * primitive type the string matches.
+ *
+ * @throws {Error} If the variable is not found in the
+ * environment and there is no fallback set.
+**/
+export function getEnv(key, fallback) {
+    const raw = process.env[key];
+    if (!raw || raw === "") {
+        if (fallback !== undefined)
+            return fallback;
+        throw new Error(`ENV Missing: '${key}'`);
+    }
+    return parseStr(raw);
+}
+// clean

package/dist/utils/formatters.d.ts

@@ -1 +1 @@
-export declare const shortenStr: (str: string) => string;
+export declare const shortenStr: (str: string) => string;

package/dist/utils/formatters.js

@@ -1,5 +1,5 @@
-export const shortenStr = (str) => {
-    if (str.length <= 6)
-        return str;
-    return `${str.slice(0, 3)}...${str.slice(-3)}`;
-};
+export const shortenStr = (str) => {
+    if (str.length <= 6)
+        return str;
+    return `${str.slice(0, 3)}...${str.slice(-3)}`;
+};

package/dist/utils/parsers.d.ts

@@ -1,4 +1,11 @@
-import { JsonValue } from "../types/generic";
-export declare const parseStr: <T extends JsonValue>(input: string) => T;
-export declare const parseNum: (input: string) => number | undefined;
-export declare const parseBool: (input: string) => boolean;
+import { JsonValue } from "../types/generic";
+/**
+ * Parses a string value into it's appropriate
+ * type, or at least cleans up the string.
+ *
+ * @param {string} input - The text to parse.
+ *
+ * @returns {JsonValue} The value parsed based on whichever
+ * primitive type the string matches.
+**/
+export declare const parseStr: (input: string) => JsonValue;

package/dist/utils/parsers.js

@@ -1,26 +1,23 @@
-import { isNum, isBool } from "./checkers";
-export const parseStr = (input) => {
-    if (isNum(input))
-        return parseNum(input);
-    else if (isBool(input))
-        return parseBool(input);
-    try {
-        return JSON.parse(input);
-    }
-    catch { }
-    return input.trim();
-};
-export const parseNum = (input) => {
-    const num = Number(input.trim());
-    if (!isNaN(num))
-        return num;
-};
-export const parseBool = (input) => {
-    const lower = input.trim().toLowerCase();
-    if (lower === "true")
-        return true;
-    if (lower === "false")
-        return false;
-    else
-        throw new Error(`Invalid boolean: ${input}`);
-};
+/**
+ * Parses a string value into it's appropriate
+ * type, or at least cleans up the string.
+ *
+ * @param {string} input - The text to parse.
+ *
+ * @returns {JsonValue} The value parsed based on whichever
+ * primitive type the string matches.
+**/
+export const parseStr = (input) => {
+    const trimmed = input.trim();
+    if (/^-?\d+(\.\d+)?$/.test(trimmed) && !isNaN(Number(trimmed)))
+        return Number(trimmed);
+    if (/^(true|false)$/i.test(trimmed))
+        return trimmed.toLowerCase() === "true";
+    try {
+        return JSON.parse(trimmed);
+    }
+    catch {
+        return trimmed;
+    }
+};
+// clean

package/package.json

@@ -1,7 +1,7 @@
 {
 
   "name": "@bouko/ts",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "license": "MIT",