@kyvrixon/utils 0.0.2 → 0.0.4

package/package.json

@@ -1,27 +1,28 @@
 {
-	"name": "@kyvrixon/utils",
-	"main": "./dist/index.js",
-	"version": "0.0.2",
-	"type": "module",
-	"private": false,
-	"files": [
-		"dist"
-	],
-	"packageManager": "bun@1.3.6",
-	"types": "./dist/types/index.d.ts",
-	"devDependencies": {
-		"@types/bun": "1.3.6"
-	},
-	"peerDependencies": {
-		"typescript": "^5.9.3"
-	},
-	"dependencies": {
-		"chalk": "^5.6.2"
-	},
-	"exports": {
-		".": {
-			"types": "./dist/types/index.d.ts",
-			"import": "./dist/index.js"
-		}
-	}
+  "name": "@kyvrixon/utils",
+  "main": "./src/index.ts",
+  "version": "0.0.4",
+  "type": "module",
+  "private": false,
+  "license": "MIT",
+  "files": [
+    "src"
+  ],
+  "packageManager": "bun@1.3.6",
+  "types": "./src/index.ts",
+  "devDependencies": {
+    "@types/bun": "1.3.6"
+  },
+  "peerDependencies": {
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "chalk": "^5.6.2"
+  },
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "import": "./src/index.ts"
+    }
+  }
 }

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./lib/logger";
+export * from "./lib/formatSeconds";

package/src/lib/formatSeconds.ts

@@ -0,0 +1,135 @@
+type TimeUnitTypes = "y" | "mo" | "w" | "d" | "h" | "m" | "s" | "ms";
+
+const UNITS: Record<
+	TimeUnitTypes,
+	{ label: string; short: string; ms: number }
+> = {
+	y: { label: "year", short: "y", ms: 0 },
+	mo: { label: "month", short: "mo", ms: 0 },
+	w: { label: "week", short: "w", ms: 7 * 24 * 3600 * 1000 },
+	d: { label: "day", short: "d", ms: 24 * 3600 * 1000 },
+	h: { label: "hour", short: "h", ms: 3600 * 1000 },
+	m: { label: "minute", short: "m", ms: 60 * 1000 },
+	s: { label: "second", short: "s", ms: 1000 },
+	ms: { label: "millisecond", short: "ms", ms: 1 },
+};
+
+const ALL_UNITS_ORDER: Array<TimeUnitTypes> = [
+	"y",
+	"mo",
+	"w",
+	"d",
+	"h",
+	"m",
+	"s",
+	"ms",
+];
+
+export const formatSeconds = (
+	seconds: number,
+	options: {
+		includeZeroUnits?: boolean;
+		onlyUnits?: Array<TimeUnitTypes>;
+		format?: "long" | "short";
+		customFormatter?: (
+			unit: TimeUnitTypes,
+			value: number,
+			label: string,
+		) => string;
+	} = {},
+): string => {
+	const includeZeroUnits = options.includeZeroUnits ?? false;
+	const onlyUnits = options.onlyUnits ?? [];
+	const format = options.format ?? "long";
+	const customFormatter = options.customFormatter;
+
+	const totalMs = Math.max(0, Number(seconds) * 1000);
+	const unitsToDisplay = ALL_UNITS_ORDER.filter((u) =>
+		onlyUnits.length ? onlyUnits.includes(u) : true,
+	);
+
+	if (totalMs === 0) {
+		const zeroParts: Array<string> = [];
+		for (const u of unitsToDisplay) {
+			if (format === "short") {
+				zeroParts.push(`0${UNITS[u].short}`);
+			} else {
+				zeroParts.push(`0 ${UNITS[u].label}`);
+			}
+		}
+		return zeroParts.join(format === "short" ? " " : ", ");
+	}
+
+	const now = new Date();
+	const end = new Date(now.getTime() + totalMs);
+
+	let years = 0;
+	if (unitsToDisplay.includes("y") || unitsToDisplay.includes("mo")) {
+		years = end.getFullYear() - now.getFullYear();
+	}
+
+	let months = 0;
+	if (unitsToDisplay.includes("mo")) {
+		months = end.getMonth() - now.getMonth();
+		if (years < 0) months += 12;
+	}
+
+	const remainingMs =
+		end.getTime() -
+		new Date(
+			now.getFullYear() + years,
+			now.getMonth() + months,
+			now.getDate(),
+			now.getHours(),
+			now.getMinutes(),
+			now.getSeconds(),
+			now.getMilliseconds(),
+		).getTime();
+
+	const diff: Record<TimeUnitTypes, number> = {
+		y: years,
+		mo: months,
+		w: Math.floor(remainingMs / UNITS.w.ms),
+		d: Math.floor((remainingMs % UNITS.w.ms) / UNITS.d.ms),
+		h: Math.floor((remainingMs % UNITS.d.ms) / UNITS.h.ms),
+		m: Math.floor((remainingMs % UNITS.h.ms) / UNITS.m.ms),
+		s: Math.floor((remainingMs % UNITS.m.ms) / UNITS.s.ms),
+		ms: remainingMs % 1000,
+	};
+
+	const showZeros = includeZeroUnits || onlyUnits.length > 0;
+
+	const parts: Array<string> = [];
+	for (const unit of unitsToDisplay) {
+		const value = diff[unit] ?? 0;
+		if (value || showZeros) {
+			let label = "";
+			if (format === "short") {
+				label = UNITS[unit].short;
+			} else {
+				if (value === 1) {
+					label = UNITS[unit].label;
+				} else {
+					label = `${UNITS[unit].label}s`;
+				}
+			}
+
+			if (customFormatter) {
+				parts.push(customFormatter(unit, value, label));
+			} else {
+				if (format === "short") {
+					parts.push(`${value}${label}`);
+				} else {
+					parts.push(`${value} ${label}`);
+				}
+			}
+		}
+	}
+
+	if (format === "long" && parts.length > 1) {
+		const last = parts.pop();
+		return `${parts.join(", ")} and ${last}`;
+	}
+
+	return parts.join(format === "short" ? " " : ",");
+};

package/src/lib/logger.ts

@@ -0,0 +1,124 @@
+import { env } from "bun";
+import chalk from "chalk";
+
+type LogLevel = "notif" | "alert" | "error" | "debug";
+const { cyan, yellow, red, magenta, dim, gray, bold } = chalk;
+const formatter = new Intl.DateTimeFormat("en-AU", {
+	weekday: "short",
+	hour: "2-digit",
+	minute: "2-digit",
+	second: "2-digit",
+	hour12: false,
+});
+
+/**
+ * To enable debuging make the env variable `__DEBUG_MODE` equal to "1"
+ */
+export class Logger {
+	private readonly colors: Record<LogLevel, typeof chalk> = {
+		notif: cyan,
+		alert: yellow,
+		error: red,
+		debug: magenta,
+	};
+
+	private readonly logMethods: Record<
+		LogLevel,
+		"log" | "warn" | "error" | "debug"
+	> = {
+		notif: "log",
+		alert: "warn",
+		error: "error",
+		debug: "debug",
+	};
+
+	private getTimestamp(): string {
+		const now = new Date();
+		const ms = now.getMilliseconds().toString().padStart(3, "0");
+		const base = formatter.format(now).replace(",", " @");
+		return `${base}.${ms}`;
+	}
+
+	private formatMessage(level: LogLevel, message: string | Error): string {
+		const timestamp = gray(`[${this.getTimestamp()}]`);
+		const levelLabel = bold(this.colors[level](level.toUpperCase().padEnd(5)));
+
+		const content =
+			message instanceof Error
+				? `${red(message.message)}\n${dim(this.sanitizeStack(message.stack || ""))}`
+				: message;
+
+		return `${timestamp} ${levelLabel} ${dim("»")} ${content}`;
+	}
+
+	private sanitizeStack(stack: string): string {
+		return stack
+			.split("\n")
+			.filter((line) => !line.includes("(native") && line.includes(":"))
+			.map((line, index) => {
+				if (index === 0) return false;
+				return (
+					line
+						.trim()
+						// .replace(/\\/g, "/")
+						// .replace(
+						// 	/(.*):(\d+):(\d+)/,
+						// 	(_, f, l, c) => `${dim(f)} ${bold(`(L${l} C${c})`)}`,
+						// )
+						.replace(/at\s+/, "  └─ ")
+				);
+			})
+			.filter(Boolean)
+			.join("\n");
+	}
+
+	private log(level: LogLevel, message: unknown, forceError?: boolean): void {
+		if (forceError) return void console.error(message);
+		void console[this.logMethods[level]](
+			this.formatMessage(level, message as string | Error),
+		);
+	}
+
+	/**
+	 * Pring a regular (info) message
+	 *
+	 * @param m Message to display
+	 */
+	public notif(m: unknown) {
+		this.log("notif", m);
+	}
+
+	/**
+	 * Print an alert (warning)
+	 *
+	 * @param m Message to display
+	 */
+	public alert(m: unknown) {
+		this.log("alert", m);
+	}
+
+	/**
+	 * Print an error
+	 *
+	 * @param m Message to display
+	 * @param e Error (optional)
+	 * @param f Force error - directly calls `console.error()`
+	 */
+	public error(m: unknown, e?: Error, f?: boolean) {
+		this.log("error", e ?? m, f);
+	}
+
+	/**
+	 * Print a debug message
+	 *
+	 * @param m Message to display
+	 */
+	public debug(m: unknown) {
+		if ("__DEBUG_MODE" in env && env.__DEBUG_MODE === "1") this.log("debug", m);
+	}
+
+	public divider(text: string): void {
+		const line = dim("─".repeat(Math.max(0, (50 - text.length - 2) / 2)));
+		console.log(`\n${line} ${bold(text.trim())} ${line}`);
+	}
+}

package/dist/index.js

@@ -1 +0,0 @@
-export * from "./lib/Logger";

package/dist/lib/Logger.js

@@ -1,104 +0,0 @@
-import { env } from "bun";
-import chalk from "chalk";
-const { cyan, yellow, red, magenta, dim, gray, bold } = chalk;
-const formatter = new Intl.DateTimeFormat("en-AU", {
-    weekday: "short",
-    hour: "2-digit",
-    minute: "2-digit",
-    second: "2-digit",
-    hour12: false,
-});
-/**
- * To enable debuging make the env variable `__DEBUG_MODE` equal to "1"
- */
-export class Logger {
-    colors = {
-        notif: cyan,
-        alert: yellow,
-        error: red,
-        debug: magenta,
-    };
-    logMethods = {
-        notif: "log",
-        alert: "warn",
-        error: "error",
-        debug: "debug",
-    };
-    getTimestamp() {
-        const now = new Date();
-        const ms = now.getMilliseconds().toString().padStart(3, "0");
-        const base = formatter.format(now).replace(",", " @");
-        return `${base}:${ms}`;
-    }
-    formatMessage(level, message) {
-        const timestamp = gray(`[${this.getTimestamp()}]`);
-        const levelLabel = bold(this.colors[level](level.toUpperCase().padEnd(5)));
-        const content = message instanceof Error
-            ? `${red(message.message)}\n${dim(this.sanitizeStack(message.stack || ""))}`
-            : message;
-        return `${timestamp} ${levelLabel} ${dim("»")} ${content}`;
-    }
-    sanitizeStack(stack) {
-        return stack
-            .split("\n")
-            .filter((line) => !line.includes("(native") && line.includes(":"))
-            .map((line, index) => {
-            if (index === 0)
-                return false;
-            return (line
-                .trim()
-                // .replace(/\\/g, "/")
-                // .replace(
-                // 	/(.*):(\d+):(\d+)/,
-                // 	(_, f, l, c) => `${dim(f)} ${bold(`(L${l} C${c})`)}`,
-                // )
-                .replace(/at\s+/, "  └─ "));
-        })
-            .filter(Boolean)
-            .join("\n");
-    }
-    log(level, message, forceError) {
-        if (forceError)
-            return void console.error(message);
-        void console[this.logMethods[level]](this.formatMessage(level, message));
-    }
-    /**
-     * Pring a regular (info) message
-     *
-     * @param m Message to display
-     */
-    notif(m) {
-        this.log("notif", m);
-    }
-    /**
-     * Print an alert (warning)
-     *
-     * @param m Message to display
-     */
-    alert(m) {
-        this.log("alert", m);
-    }
-    /**
-     * Print an error
-     *
-     * @param m Message to display
-     * @param e Error (optional)
-     * @param f Force error - directly calls `console.error()`
-     */
-    error(m, e, f) {
-        this.log("error", e ?? m, f);
-    }
-    /**
-     * Print a debug message
-     *
-     * @param m Message to display
-     */
-    debug(m) {
-        if ("__DEBUG_MODE" in env && env.__DEBUG_MODE === "1")
-            this.log("debug", m);
-    }
-    divider(text) {
-        const line = dim("─".repeat(Math.max(0, (50 - text.length - 2) / 2)));
-        console.log(`\n${line} ${bold(text.trim())} ${line}`);
-    }
-}

package/dist/types/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./lib/Logger";
-//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}

package/dist/types/lib/Logger.d.ts

@@ -1,39 +0,0 @@
-/**
- * To enable debuging make the env variable `__DEBUG_MODE` equal to "1"
- */
-export declare class Logger {
-    private readonly colors;
-    private readonly logMethods;
-    private getTimestamp;
-    private formatMessage;
-    private sanitizeStack;
-    private log;
-    /**
-     * Pring a regular (info) message
-     *
-     * @param m Message to display
-     */
-    notif(m: unknown): void;
-    /**
-     * Print an alert (warning)
-     *
-     * @param m Message to display
-     */
-    alert(m: unknown): void;
-    /**
-     * Print an error
-     *
-     * @param m Message to display
-     * @param e Error (optional)
-     * @param f Force error - directly calls `console.error()`
-     */
-    error(m: unknown, e?: Error, f?: boolean): void;
-    /**
-     * Print a debug message
-     *
-     * @param m Message to display
-     */
-    debug(m: unknown): void;
-    divider(text: string): void;
-}
-//# sourceMappingURL=Logger.d.ts.map

package/dist/types/lib/Logger.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Logger.d.ts","sourceRoot":"","sources":["../../../lib/Logger.ts"],"names":[],"mappings":"AAaA;;GAEG;AACH,qBAAa,MAAM;IAClB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAKrB;IAEF,OAAO,CAAC,QAAQ,CAAC,UAAU,CAQzB;IAEF,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,aAAa;IAqBrB,OAAO,CAAC,GAAG;IAOX;;;;OAIG;IACI,KAAK,CAAC,CAAC,EAAE,OAAO;IAIvB;;;;OAIG;IACI,KAAK,CAAC,CAAC,EAAE,OAAO;IAIvB;;;;;;OAMG;IACI,KAAK,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,EAAE,OAAO;IAI/C;;;;OAIG;IACI,KAAK,CAAC,CAAC,EAAE,OAAO;IAIhB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;CAIlC"}