@valkyriestudios/utils 12.12.0 → 12.14.0

package/README.md

@@ -404,6 +404,10 @@ Available tokens for usage in spec:
 | `SSS` | Milliseconds as 3-digit | 000 001 ... 998 999 |
 | `A` | Uppercase AM/PM | AM ... PM |
 | `a` | Lowercase AM/PM | am ... pm |
+| `l` | Locale-specific short Date | 15/07/2024 |
+| `L` | Locale-Specific date | 15 jul 2024 |
+| `t` | Locale-specific short time | 10:28 AM |
+| `T` | Locale-specific time with seconds | 10:28:30 AM |
 
 ```typescript
 format(new Date('2023-01-10T14:30:00Z'), '[Today is] dddd, MMMM D, YYYY [at] h:mm A', 'en', 'Europe/Brussels');

package/array/join.js

@@ -3,27 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.join = join;
 exports.default = join;
 const round_1 = require("../number/round");
-const isInteger_1 = require("../number/isInteger");
+const isIntegerAboveOrEqual_1 = require("../number/isIntegerAboveOrEqual");
 function join(val, opts) {
     if (!Array.isArray(val) || !val.length)
         return '';
-    let DELIM = ' ';
-    let TRIM = true;
-    let VALTRIM = true;
-    let VALROUND = false;
-    let INNERTRIM = false;
-    if (opts && Object.prototype.toString.call(opts) === '[object Object]') {
-        if (typeof opts.delim === 'string')
-            DELIM = opts.delim;
-        if (opts.trim === false)
-            TRIM = opts.trim;
-        if (opts.valtrim === false)
-            VALTRIM = false;
-        if (opts.innertrim === true)
-            INNERTRIM = true;
-        if ((0, isInteger_1.isInteger)(opts.valround) && opts.valround >= 0)
-            VALROUND = opts.valround;
-    }
+    const DELIM = typeof opts?.delim === 'string' ? opts.delim : ' ';
+    const TRIM = opts?.trim ?? true;
+    const VALTRIM = opts?.valtrim ?? true;
+    const INNERTRIM = opts?.innertrim ?? false;
+    const VALROUND = (0, isIntegerAboveOrEqual_1.isIntegerAboveOrEqual)(opts?.valround, 0) ? opts.valround : false;
     let result = '';
     for (let i = 0; i < val.length; i++) {
         const el = val[i];

package/array/sort.d.ts

@@ -17,7 +17,14 @@ interface sortOptions {
 }
 type sortByFunction = (el: Record<string, any>) => string;
 /**
- * Sort an array of objects, uses an implementation of Tony Hoare's quicksort
+ * Sort an array of objects.
+ *
+ * The internals of this function swap between insertion and quicksort depending on the use-case.
+ * Insertion sort is used for smaller arrays and quicksort is used for larger arrays.
+ *
+ * The threshold for insertion sort is 10 elements.
+ *
+ * The quicksort implementation is based on Tony Hoare's quicksort
  * (https://cs.stanford.edu/people/eroberts/courses/soco/projects/2008-09/tony-hoare/quicksort.html)
  *
  * Example:
@@ -43,10 +50,10 @@ type sortByFunction = (el: Record<string, any>) => string;
  * Output:
  *  [{test: 'Pony'}, {test: 'Peter'}, {test: 'JOHn'}, {test: 'Joe'}]
  *
- * @param val - Array to sort
- * @param by - Either a string (key) or a function
- * @param dir - (default='asc') Direction to sort in (asc or desc)
- * @param opts - Sort options
+ * @param {Array} val - Array to sort
+ * @param {string|sortByFunction} by - Either a string (key) or a function
+ * @param {'desc'|'asc'} dir - (default='asc') Direction to sort in (asc or desc)
+ * @param {sortOptions} opts - Sort options
  *
  * @returns Sorted array
  * @throws {Error}

package/array/sort.js

@@ -3,50 +3,60 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.sort = sort;
 exports.default = sort;
 const isNotEmpty_1 = require("../object/isNotEmpty");
-function partition(arr, start_ix, end_ix) {
-    const pivot_val = arr[Math.floor((start_ix + end_ix) / 2)].t;
-    while (start_ix <= end_ix) {
-        while (arr[start_ix].t < pivot_val) {
-            start_ix++;
+const INSERTION_SORT_THRESHOLD = 10;
+function partition(arr, low, high) {
+    const pivot = arr[Math.floor((low + high) / 2)][0];
+    let i = low;
+    let j = high;
+    while (i <= j) {
+        while (arr[i][0] < pivot) {
+            i++;
         }
-        while (arr[end_ix].t > pivot_val) {
-            end_ix--;
+        while (arr[j][0] > pivot) {
+            j--;
         }
-        if (start_ix <= end_ix) {
-            const temp = arr[start_ix];
-            arr[start_ix] = arr[end_ix];
-            arr[end_ix] = temp;
-            start_ix++;
-            end_ix--;
+        if (i <= j) {
+            [arr[i], arr[j]] = [arr[j], arr[i]];
+            i++;
+            j--;
         }
     }
-    return start_ix;
+    return i;
 }
-function quickSort(arr, start_ix = 0, end_ix = arr.length - 1) {
-    if (start_ix < end_ix) {
-        const ix = partition(arr, start_ix, end_ix);
-        quickSort(arr, start_ix, ix - 1);
-        quickSort(arr, ix, end_ix);
+function quickSort(arr) {
+    const stack = [{ low: 0, high: arr.length - 1 }];
+    while (stack.length) {
+        const { low, high } = stack.pop();
+        if (high - low <= INSERTION_SORT_THRESHOLD) {
+            for (let i = low + 1; i <= high; i++) {
+                const key = arr[i];
+                let j = i - 1;
+                while (j >= low && arr[j][0] > key[0]) {
+                    arr[j + 1] = arr[j];
+                    j--;
+                }
+                arr[j + 1] = key;
+            }
+        }
+        else {
+            const p = partition(arr, low, high);
+            if (p - 1 > low)
+                stack.push({ low, high: p - 1 });
+            if (p < high)
+                stack.push({ low: p, high });
+        }
     }
     return arr;
 }
 function sort(arr, by, dir = 'asc', opts) {
     if (!Array.isArray(arr) || !arr.length)
         return [];
-    if (dir !== 'asc' && dir !== 'desc')
-        throw new Error('Direction should be either asc or desc');
-    let NOKEY_HIDE = false;
-    let NOKEY_AT_END = true;
+    const NOKEY_HIDE = opts?.nokey_hide === true;
+    const NOKEY_AT_END = opts?.nokey_atend !== false;
     let FILTER_FN = isNotEmpty_1.isNotEmptyObject;
-    if (opts && Object.prototype.toString.call(opts) === '[object Object]') {
-        if (opts.nokey_hide === true)
-            NOKEY_HIDE = true;
-        if (opts.nokey_atend === false)
-            NOKEY_AT_END = false;
-        if (typeof opts.filter_fn === 'function') {
-            const fn = opts.filter_fn;
-            FILTER_FN = (el => (0, isNotEmpty_1.isNotEmptyObject)(el) && fn(el));
-        }
+    if (typeof opts?.filter_fn === 'function') {
+        const fn = opts.filter_fn;
+        FILTER_FN = (el => (0, isNotEmpty_1.isNotEmptyObject)(el) && fn(el));
     }
     const prepared_arr = [];
     const nokey_arr = [];
@@ -54,30 +64,27 @@ function sort(arr, by, dir = 'asc', opts) {
         const by_s = by.trim();
         if (!by_s.length)
             throw new Error('Sort by as string should contain content');
-        for (let i = 0; i < arr.length; i++) {
-            const el = arr[i];
+        for (const el of arr) {
             if (!FILTER_FN(el))
                 continue;
             if (el?.[by_s] === undefined) {
                 nokey_arr.push(el);
             }
             else {
-                prepared_arr.push({ t: el[by_s], el });
+                prepared_arr.push([el[by_s], el]);
             }
         }
     }
     else if (typeof by === 'function') {
-        let key;
-        for (let i = 0; i < arr.length; i++) {
-            const el = arr[i];
+        for (const el of arr) {
             if (!FILTER_FN(el))
                 continue;
-            key = by(el);
+            const key = by(el);
             if (key === undefined) {
                 nokey_arr.push(el);
             }
             else {
-                prepared_arr.push({ t: key, el });
+                prepared_arr.push([key, el]);
             }
         }
     }
@@ -88,15 +95,11 @@ function sort(arr, by, dir = 'asc', opts) {
     if (dir === 'desc')
         prepared_arr.reverse();
     const rslt = [];
-    if (!NOKEY_HIDE && !NOKEY_AT_END) {
-        for (let i = 0; i < nokey_arr.length; i++)
-            rslt.push(nokey_arr[i]);
-    }
+    if (!NOKEY_HIDE && !NOKEY_AT_END)
+        rslt.push(...nokey_arr);
     for (let i = 0; i < prepared_arr.length; i++)
-        rslt.push(prepared_arr[i].el);
-    if (!NOKEY_HIDE && NOKEY_AT_END) {
-        for (let i = 0; i < nokey_arr.length; i++)
-            rslt.push(nokey_arr[i]);
-    }
+        rslt.push(prepared_arr[i][1]);
+    if (!NOKEY_HIDE && NOKEY_AT_END)
+        rslt.push(...nokey_arr);
     return rslt;
 }

package/date/format.js

@@ -36,7 +36,7 @@ function toZone(date, zone) {
         throw new Error(`format: Invalid zone passed - ${zone}`);
     const offset = zone_time - client_time;
     zone_offset_cache.set(ckey, offset);
-    return new Date(date.getTime() + offset);
+    return new Date(client_time + offset);
 }
 function runIntl(loc, token, props, val) {
     const hash = `${loc}:${token}`;
@@ -74,6 +74,10 @@ const Tokens = [
     ['SSS', d => `${d.getMilliseconds()}`.padStart(3, '0')],
     ['A', d => d.getHours() < 12 ? 'AM' : 'PM'],
     ['a', d => d.getHours() < 12 ? 'am' : 'pm'],
+    ['l', (d, loc) => runIntl(loc, 'l', { dateStyle: 'short' }, d)],
+    ['L', (d, loc) => runIntl(loc, 'L', { dateStyle: 'medium' }, d)],
+    ['t', (d, loc) => runIntl(loc, 't', { timeStyle: 'short' }, d)],
+    ['T', (d, loc) => runIntl(loc, 'T', { timeStyle: 'medium' }, d)],
 ]
     .sort((a, b) => a[0].length > b[0].length ? -1 : 1)
     .map((el) => [el[0], new RegExp(el[0], 'g'), el[1]]);

package/index.d.ts

@@ -26,9 +26,9 @@ declare module "number/round" {
     function round(val: number, precision?: number): number;
     export { round, round as default };
 }
-declare module "number/isInteger" {
-    function isInteger(val: unknown): val is number;
-    export { isInteger, isInteger as default };
+declare module "number/isIntegerAboveOrEqual" {
+    function isIntegerAboveOrEqual(val: unknown, ref: number): val is number;
+    export { isIntegerAboveOrEqual, isIntegerAboveOrEqual as default };
 }
 declare module "array/join" {
     interface joinOptions {
@@ -56,10 +56,6 @@ declare module "array/mapKey" {
     function mapKey<T extends Record<string, any>>(arr: T[], key: string, opts?: mapOptions): Record<string, T>;
     export { mapKey, mapKey as default };
 }
-declare module "number/isIntegerAboveOrEqual" {
-    function isIntegerAboveOrEqual(val: unknown, ref: number): val is number;
-    export { isIntegerAboveOrEqual, isIntegerAboveOrEqual as default };
-}
 declare module "array/mapPrimitive" {
     interface mapOptions {
         valtrim?: boolean;
@@ -322,6 +318,10 @@ declare module "number/isBetween" {
     function isNumberBetween(val: unknown, min: number, max: number): val is number;
     export { isNumberBetween, isNumberBetween as default };
 }
+declare module "number/isInteger" {
+    function isInteger(val: unknown): val is number;
+    export { isInteger, isInteger as default };
+}
 declare module "number/isIntegerAbove" {
     function isIntegerAbove(val: unknown, ref: number): val is number;
     export { isIntegerAbove, isIntegerAbove as default };

package/package.json

@@ -1 +1 @@
-{ "name": "@valkyriestudios/utils", "version": "12.12.0", "description": "A collection of single-function utilities for common tasks", "author": { "name": "Peter Vermeulen", "url": "https://www.linkedin.com/in/petervermeulen1/" }, "keywords": [ "utility", "library", "javascript", "js", "node", "bun" ], "license": "MIT", "repository": { "type": "git", "url": "git+https://github.com/ValkyrieStudios/utils.git" }, "bugs": { "url": "https://github.com/ValkyrieStudios/utils/issues" }, "homepage": "https://github.com/ValkyrieStudios/utils#readme", "types": "index.d.ts" }
+{ "name": "@valkyriestudios/utils", "version": "12.14.0", "description": "A collection of single-function utilities for common tasks", "author": { "name": "Peter Vermeulen", "url": "https://www.linkedin.com/in/petervermeulen1/" }, "keywords": [ "utility", "library", "javascript", "js", "node", "bun" ], "license": "MIT", "repository": { "type": "git", "url": "git+https://github.com/ValkyrieStudios/utils.git" }, "bugs": { "url": "https://github.com/ValkyrieStudios/utils/issues" }, "homepage": "https://github.com/ValkyrieStudios/utils#readme", "types": "index.d.ts" }

package/string/humanizeNumber.js

@@ -34,10 +34,13 @@ function humanizeNumber(val, options = {}) {
         }
     }
     const humanized = `${(0, round_1.round)(normalized, PRECISION)}`.split('.', 2);
-    humanized[0] = humanized[0].split('').reverse().map((char, ix, original) => {
-        if (ix > 0 && ix < original.length && ix % 3 === 0)
-            return char + DELIM;
-        return char;
-    }).reverse().join('');
-    return `${sign}${humanized.join(SEPARATOR)}${UNITS ? UNITS[unit_ix] : ''}`;
+    const integerPart = humanized[0];
+    let formattedIntegerPart = '';
+    for (let i = 0; i < integerPart.length; i++) {
+        if (i > 0 && (integerPart.length - i) % 3 === 0) {
+            formattedIntegerPart += DELIM;
+        }
+        formattedIntegerPart += integerPart[i];
+    }
+    return `${sign}${formattedIntegerPart}${humanized[1] ? SEPARATOR + humanized[1] : ''}${UNITS ? UNITS[unit_ix] : ''}`;
 }