@kyvrixon/utils 0.0.1 → 0.0.3

package/README.md

@@ -1 +1,7 @@
-General utility files I use for alot of projects! Does not include any larger scale items, just the little things
+# Utils
+
+General utility files I use for alot of projects! Does not include any larger scale items, just the little things
+
+```bash
+bun install @kyvrixon/utils@latest
+```

package/dist/index.js

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

package/dist/lib/formatSeconds.js

@@ -0,0 +1,99 @@
+const UNITS = {
+    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 = [
+    "y",
+    "mo",
+    "w",
+    "d",
+    "h",
+    "m",
+    "s",
+    "ms",
+];
+export const formatSeconds = (seconds, options = {}) => {
+    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 = [];
+        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 = {
+        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 = [];
+    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/dist/types/index.d.ts

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

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

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

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

@@ -36,4 +36,4 @@ export declare class Logger {
     debug(m: unknown): void;
     divider(text: string): void;
 }
-//# sourceMappingURL=Logger.d.ts.map
+//# sourceMappingURL=logger.d.ts.map

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

@@ -1 +1 @@
-{"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"}
+{"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"}

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

@@ -0,0 +1,9 @@
+type TimeUnitTypes = "y" | "mo" | "w" | "d" | "h" | "m" | "s" | "ms";
+export declare const formatSeconds: (seconds: number, options?: {
+    includeZeroUnits?: boolean;
+    onlyUnits?: Array<TimeUnitTypes>;
+    format?: "long" | "short";
+    customFormatter?: (unit: TimeUnitTypes, value: number, label: string) => string;
+}) => string;
+export {};
+//# sourceMappingURL=formatSeconds.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"formatSeconds.d.ts","sourceRoot":"","sources":["../../../lib/formatSeconds.ts"],"names":[],"mappings":"AAAA,KAAK,aAAa,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,CAAC;AA2BrE,eAAO,MAAM,aAAa,GACzB,SAAS,MAAM,EACf,UAAS;IACR,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC1B,eAAe,CAAC,EAAE,CACjB,IAAI,EAAE,aAAa,EACnB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,KACT,MAAM,CAAC;CACP,KACJ,MA+FF,CAAC"}

package/package.json

@@ -1,13 +1,14 @@
 {
 	"name": "@kyvrixon/utils",
-	"module": "index.js",
-	"version": "0.0.1",
+	"main": "./dist/index.js",
+	"version": "0.0.3",
 	"type": "module",
 	"private": false,
 	"files": [
 		"dist"
 	],
 	"packageManager": "bun@1.3.6",
+	"types": "./dist/types/index.d.ts",
 	"devDependencies": {
 		"@types/bun": "1.3.6"
 	},
@@ -16,5 +17,11 @@
 	},
 	"dependencies": {
 		"chalk": "^5.6.2"
+	},
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/index.js"
+		}
 	}
 }