@kwiz/common 1.0.96 → 1.0.97

package/src/helpers/collections.ts

@@ -1,108 +1,108 @@
-import { IDictionary } from "../types/common.types";
-import { IMultiLevelGroup, IMultiLevelGroupItem } from "./collections.base";
-import { hasOwnProperty, objectsEqual } from "./objects";
-import { isFunction, isNotEmptyArray, isNullOrEmptyArray, isNullOrEmptyString, isNullOrUndefined, isNumber, isString } from "./typecheckers";
-
-/** check that every element in the arrays are the same value */
-export function arraysEqual(arr1: any[], arr2: any[]): boolean {
-    if (isNullOrEmptyArray(arr1) && isNullOrEmptyArray(arr2)) return true;
-    return Array.isArray(arr1) && Array.isArray(arr2) && arr1.length === arr2.length && arr1.every((v1: any, i: number) => {
-        var v2 = arr2[i];
-        if (isString(v1) || isNumber(v1)) {
-            return v1 === v2;
-        } else if (Array.isArray(v1) && Array.isArray(v2)) {
-            return arraysEqual(v1, v2);
-        } else {
-            return objectsEqual(v1, v2);
-        }
-    });
-}
-
-/** Takes an array and transforms it into a dictionary. this will assign all items of the same key as an array. */
-export function groupBy<T>(arr: T[], getKeys: (element: T) => string[], filter?: (element: T) => boolean): IDictionary<T[]> {
-    let dic: IDictionary<T[]> = {};
-
-    if (isNotEmptyArray(arr))
-        arr.forEach(i => {
-            if (!isFunction(filter) || filter(i)) {
-                let keys = getKeys(i);
-                keys.forEach(key => {
-                    if (isNullOrEmptyString(key)) key = "";
-                    if (!hasOwnProperty(dic, key)) dic[key] = [i];
-                    else dic[key].push(i);
-                });
-            }
-        });
-    return dic;
-}
-
-var groupByMultipleCacheKey = "$groupByMultipleCache";
-/** allows nested multi-level grouping */
-export function GroupByMultiple<ItemType>(arr: ItemType[], groupDefinitions: {
-    /** return all groups this item belongs to */
-    getGroupsForThisElement: ((element: ItemType) => string[]);
-    /** Optional, add a prefix to the group. For example: "Priority > " to fullTitle will be "Priority > High" */
-    groupPrefix?: string;
-}[], options?: {
-    filter?: (element: ItemType) => boolean;
-    /** if groups were calculated, they are returned from cache. send true to clear that cache. send true if you suspect getKeysCollection might change on your existing array. */
-    clearCache?: boolean;
-    parentGroup?: IMultiLevelGroup<ItemType>;
-}): IDictionary<IMultiLevelGroup<ItemType>> {
-    options = options || {};
-    if (options.clearCache || isNullOrUndefined(arr[groupByMultipleCacheKey])) {
-        let dic: IDictionary<IMultiLevelGroup<ItemType>> = {};
-
-        let groupDefinition = groupDefinitions[0];//get first
-        let getKeys = groupDefinition.getGroupsForThisElement;
-
-        if (isNotEmptyArray(arr)) {
-            let groupIndex = 0;
-            arr.forEach(i => {
-                if (!isFunction(options.filter) || options.filter(i)) {
-                    let keys = getKeys(i);
-                    keys.forEach(key => {
-                        if (isNullOrEmptyString(key)) key = "";
-                        if (!hasOwnProperty(dic, key)) {
-                            let groupKey = groupIndex.toString(10);
-                            let groupKeyParent = options.parentGroup;
-                            while (groupKeyParent) {
-                                groupKey = groupKeyParent.index + "_" + groupKey;
-                                groupKeyParent = groupKeyParent.parentGroup;
-                            }
-                            dic[key] = {
-                                groupItems: [],
-                                subGroups: {},
-                                depth: options.parentGroup ? options.parentGroup.depth + 1 : 0,
-                                parentGroup: options.parentGroup,
-                                key: groupKey,
-                                index: groupIndex,
-                                title: key,
-                                groupPrefix: groupDefinition.groupPrefix,
-                                fullTitle: `${isNullOrEmptyString(groupDefinition.groupPrefix) ? "" : groupDefinition.groupPrefix}${key}`
-                            };
-                            groupIndex++;
-                        }
-                        let itemWithGroup = i as (ItemType & IMultiLevelGroupItem<ItemType>);
-                        itemWithGroup.parentGroup = dic[key];
-                        dic[key].groupItems.push(itemWithGroup);
-                    });
-                }
-            });
-        }
-
-        if (isNotEmptyArray(groupDefinitions) && groupDefinitions.length > 1) {
-            //run for every group and call this again
-            Object.keys(dic).forEach(groupName => {
-                let currentGroup = dic[groupName];
-                currentGroup.subGroups = GroupByMultiple(currentGroup.groupItems, groupDefinitions.slice(1), {
-                    ...options,
-                    parentGroup: currentGroup
-                });
-            });
-        }
-
-        arr[groupByMultipleCacheKey] = dic;
-    }
-    return arr[groupByMultipleCacheKey];
+import { IDictionary } from "../types/common.types";
+import { IMultiLevelGroup, IMultiLevelGroupItem } from "./collections.base";
+import { hasOwnProperty, objectsEqual } from "./objects";
+import { isFunction, isNotEmptyArray, isNullOrEmptyArray, isNullOrEmptyString, isNullOrUndefined, isNumber, isString } from "./typecheckers";
+
+/** check that every element in the arrays are the same value */
+export function arraysEqual(arr1: any[], arr2: any[]): boolean {
+    if (isNullOrEmptyArray(arr1) && isNullOrEmptyArray(arr2)) return true;
+    return Array.isArray(arr1) && Array.isArray(arr2) && arr1.length === arr2.length && arr1.every((v1: any, i: number) => {
+        var v2 = arr2[i];
+        if (isString(v1) || isNumber(v1)) {
+            return v1 === v2;
+        } else if (Array.isArray(v1) && Array.isArray(v2)) {
+            return arraysEqual(v1, v2);
+        } else {
+            return objectsEqual(v1, v2);
+        }
+    });
+}
+
+/** Takes an array and transforms it into a dictionary. this will assign all items of the same key as an array. */
+export function groupBy<T>(arr: T[], getKeys: (element: T) => string[], filter?: (element: T) => boolean): IDictionary<T[]> {
+    let dic: IDictionary<T[]> = {};
+
+    if (isNotEmptyArray(arr))
+        arr.forEach(i => {
+            if (!isFunction(filter) || filter(i)) {
+                let keys = getKeys(i);
+                keys.forEach(key => {
+                    if (isNullOrEmptyString(key)) key = "";
+                    if (!hasOwnProperty(dic, key)) dic[key] = [i];
+                    else dic[key].push(i);
+                });
+            }
+        });
+    return dic;
+}
+
+var groupByMultipleCacheKey = "$groupByMultipleCache";
+/** allows nested multi-level grouping */
+export function GroupByMultiple<ItemType>(arr: ItemType[], groupDefinitions: {
+    /** return all groups this item belongs to */
+    getGroupsForThisElement: ((element: ItemType) => string[]);
+    /** Optional, add a prefix to the group. For example: "Priority > " to fullTitle will be "Priority > High" */
+    groupPrefix?: string;
+}[], options?: {
+    filter?: (element: ItemType) => boolean;
+    /** if groups were calculated, they are returned from cache. send true to clear that cache. send true if you suspect getKeysCollection might change on your existing array. */
+    clearCache?: boolean;
+    parentGroup?: IMultiLevelGroup<ItemType>;
+}): IDictionary<IMultiLevelGroup<ItemType>> {
+    options = options || {};
+    if (options.clearCache || isNullOrUndefined(arr[groupByMultipleCacheKey])) {
+        let dic: IDictionary<IMultiLevelGroup<ItemType>> = {};
+
+        let groupDefinition = groupDefinitions[0];//get first
+        let getKeys = groupDefinition.getGroupsForThisElement;
+
+        if (isNotEmptyArray(arr)) {
+            let groupIndex = 0;
+            arr.forEach(i => {
+                if (!isFunction(options.filter) || options.filter(i)) {
+                    let keys = getKeys(i);
+                    keys.forEach(key => {
+                        if (isNullOrEmptyString(key)) key = "";
+                        if (!hasOwnProperty(dic, key)) {
+                            let groupKey = groupIndex.toString(10);
+                            let groupKeyParent = options.parentGroup;
+                            while (groupKeyParent) {
+                                groupKey = groupKeyParent.index + "_" + groupKey;
+                                groupKeyParent = groupKeyParent.parentGroup;
+                            }
+                            dic[key] = {
+                                groupItems: [],
+                                subGroups: {},
+                                depth: options.parentGroup ? options.parentGroup.depth + 1 : 0,
+                                parentGroup: options.parentGroup,
+                                key: groupKey,
+                                index: groupIndex,
+                                title: key,
+                                groupPrefix: groupDefinition.groupPrefix,
+                                fullTitle: `${isNullOrEmptyString(groupDefinition.groupPrefix) ? "" : groupDefinition.groupPrefix}${key}`
+                            };
+                            groupIndex++;
+                        }
+                        let itemWithGroup = i as (ItemType & IMultiLevelGroupItem<ItemType>);
+                        itemWithGroup.parentGroup = dic[key];
+                        dic[key].groupItems.push(itemWithGroup);
+                    });
+                }
+            });
+        }
+
+        if (isNotEmptyArray(groupDefinitions) && groupDefinitions.length > 1) {
+            //run for every group and call this again
+            Object.keys(dic).forEach(groupName => {
+                let currentGroup = dic[groupName];
+                currentGroup.subGroups = GroupByMultiple(currentGroup.groupItems, groupDefinitions.slice(1), {
+                    ...options,
+                    parentGroup: currentGroup
+                });
+            });
+        }
+
+        arr[groupByMultipleCacheKey] = dic;
+    }
+    return arr[groupByMultipleCacheKey];
 }

package/src/helpers/color.ts

@@ -1,55 +1,55 @@
-import { isNullOrEmptyString } from "./typecheckers";
-
-/** get the oposite color of a color, or the best contrasting black or white. This is useful to know which color text to show on a dynamic background color */
-export function invertColor(color: string, blackOrWhite?: boolean, defaultIfEmpty?: string) {
-    if (isNullOrEmptyString(color) && !isNullOrEmptyString(defaultIfEmpty)) return defaultIfEmpty;
-    let rgba = colorToRGBA(color);
-
-    if (blackOrWhite) {
-        // http://stackoverflow.com/a/3943023/112731
-        return (rgba.r * 0.299 + rgba.g * 0.587 + rgba.b * 0.114) > 186
-            ? '#000000'
-            : '#FFFFFF';
-    }
-    // invert color components
-    let _r = (255 - rgba.r);
-    let _g = (255 - rgba.g);
-    let _b = (255 - rgba.b);
-    // pad each with zeros and return
-    return "#" + byteToHex(_r) + byteToHex(_g) + byteToHex(_b);
-}
-
-
-/** Returns the color as an array of [r, g, b, a] -- all range from 0 - 255 */
-export function colorToRGBA(color: string) {
-    // Returns the color as an array of [r, g, b, a] -- all range from 0 - 255
-    // color must be a valid canvas fillStyle. This will cover most anything
-    // you'd want to use.
-    // Examples:
-    // colorToRGBA('red')  # [255, 0, 0, 255]
-    // colorToRGBA('#f00') # [255, 0, 0, 255]
-    let cvs = document.createElement('canvas');
-    cvs.height = 1;
-    cvs.width = 1;
-    let ctx = cvs.getContext('2d');
-    ctx.fillStyle = color;
-    ctx.fillRect(0, 0, 1, 1);
-    let data = ctx.getImageData(0, 0, 1, 1).data;
-    return { r: data[0], g: data[1], b: data[2], a: data[3] };
-}
-
-function byteToHex(num: number) {
-    // Turns a number (0-255) into a 2-character hex number (00-ff)
-    return ('0' + num.toString(16)).slice(-2);
-}
-
-/** Convert any CSS color to a hex representation, returns #000000 */
-export function colorToHex(color: string) {
-    // 
-    // Examples:
-    // colorToHex('red')            # '#ff0000'
-    // colorToHex('rgb(255, 0, 0)') # '#ff0000'
-    let rgba = colorToRGBA(color);
-    let hex = byteToHex(rgba.r) + byteToHex(rgba.g) + byteToHex(rgba.b);
-    return "#" + hex;
+import { isNullOrEmptyString } from "./typecheckers";
+
+/** get the oposite color of a color, or the best contrasting black or white. This is useful to know which color text to show on a dynamic background color */
+export function invertColor(color: string, blackOrWhite?: boolean, defaultIfEmpty?: string) {
+    if (isNullOrEmptyString(color) && !isNullOrEmptyString(defaultIfEmpty)) return defaultIfEmpty;
+    let rgba = colorToRGBA(color);
+
+    if (blackOrWhite) {
+        // http://stackoverflow.com/a/3943023/112731
+        return (rgba.r * 0.299 + rgba.g * 0.587 + rgba.b * 0.114) > 186
+            ? '#000000'
+            : '#FFFFFF';
+    }
+    // invert color components
+    let _r = (255 - rgba.r);
+    let _g = (255 - rgba.g);
+    let _b = (255 - rgba.b);
+    // pad each with zeros and return
+    return "#" + byteToHex(_r) + byteToHex(_g) + byteToHex(_b);
+}
+
+
+/** Returns the color as an array of [r, g, b, a] -- all range from 0 - 255 */
+export function colorToRGBA(color: string) {
+    // Returns the color as an array of [r, g, b, a] -- all range from 0 - 255
+    // color must be a valid canvas fillStyle. This will cover most anything
+    // you'd want to use.
+    // Examples:
+    // colorToRGBA('red')  # [255, 0, 0, 255]
+    // colorToRGBA('#f00') # [255, 0, 0, 255]
+    let cvs = document.createElement('canvas');
+    cvs.height = 1;
+    cvs.width = 1;
+    let ctx = cvs.getContext('2d');
+    ctx.fillStyle = color;
+    ctx.fillRect(0, 0, 1, 1);
+    let data = ctx.getImageData(0, 0, 1, 1).data;
+    return { r: data[0], g: data[1], b: data[2], a: data[3] };
+}
+
+function byteToHex(num: number) {
+    // Turns a number (0-255) into a 2-character hex number (00-ff)
+    return ('0' + num.toString(16)).slice(-2);
+}
+
+/** Convert any CSS color to a hex representation, returns #000000 */
+export function colorToHex(color: string) {
+    // 
+    // Examples:
+    // colorToHex('red')            # '#ff0000'
+    // colorToHex('rgb(255, 0, 0)') # '#ff0000'
+    let rgba = colorToRGBA(color);
+    let hex = byteToHex(rgba.r) + byteToHex(rgba.g) + byteToHex(rgba.b);
+    return "#" + hex;
 }

package/src/helpers/cookies.ts

@@ -1,60 +1,60 @@
-import { trim } from "./strings";
-import { isNullOrEmptyString, isNumeric, isString } from "./typecheckers";
-
-var _zeroDay = new Date(0);
-var _today = new Date();
-
-export function deleteCookie(cookieName: string, path?: string) {
-    var days = (_zeroDay.getTime() - _today.getTime()) / (24 * 60 * 60 * 1000);
-    setCookie(cookieName, "", Math.round(days), path);
-}
-
-export function getAllCookies(prefix?: string): string[] {
-    let cookies = document.cookie.split(';');
-    let names: string[] = [];
-    for (var k = 0; k < cookies.length; k++) {
-        let cookieSplit = cookies[k].split('=');
-        let cookieName = trim(cookieSplit[0]);
-        if (isNullOrEmptyString(prefix) || cookieName.indexOf(prefix) === 0)
-            names.push(cookieName);
-    }
-    return names;
-}
-
-/** get a cookie's value by that name, or null */
-export function getCookie(cookieName: string) {
-    try {
-        let cookies = document.cookie.split(';');
-        for (var k = 0; k < cookies.length; k++) {
-            let cookieSplit = cookies[k].split('=');
-            if (trim(cookieSplit[0]) === cookieName) {
-                return decodeURIComponent(trim(cookieSplit[1]));
-            }
-        }
-    } catch (e) { }
-    return null;
-}
-/** set a cookie by that name and value. if you do not send expireDays, it will be a session cookie (in memory) */
-export function setCookie(name: string, value: string, expireDays?: number, path?: string) {
-    var cookie: string[] = [];
-
-    var cookieValue = `${name}=${isString(value) ? value : ""}`;
-    cookie.push(cookieValue);
-
-    if (isNumeric(expireDays)) {
-        var d = new Date();
-        d.setTime(d.getTime() + (expireDays * 24 * 60 * 60 * 1000));
-        var cookieExpires = "expires=" + d.toUTCString();
-        cookie.push(cookieExpires);
-    }
-
-    var cookiePath = `${isString(path) ? `path=` + path : "path=/"}`;
-    cookie.push(cookiePath);
-
-    document.cookie = cookie.join(";");
-}
-
-export function cookieEnabled() {
-    let enabled = "navigator" in globalThis && navigator.cookieEnabled === true;
-    return enabled;
+import { trim } from "./strings";
+import { isNullOrEmptyString, isNumeric, isString } from "./typecheckers";
+
+var _zeroDay = new Date(0);
+var _today = new Date();
+
+export function deleteCookie(cookieName: string, path?: string) {
+    var days = (_zeroDay.getTime() - _today.getTime()) / (24 * 60 * 60 * 1000);
+    setCookie(cookieName, "", Math.round(days), path);
+}
+
+export function getAllCookies(prefix?: string): string[] {
+    let cookies = document.cookie.split(';');
+    let names: string[] = [];
+    for (var k = 0; k < cookies.length; k++) {
+        let cookieSplit = cookies[k].split('=');
+        let cookieName = trim(cookieSplit[0]);
+        if (isNullOrEmptyString(prefix) || cookieName.indexOf(prefix) === 0)
+            names.push(cookieName);
+    }
+    return names;
+}
+
+/** get a cookie's value by that name, or null */
+export function getCookie(cookieName: string) {
+    try {
+        let cookies = document.cookie.split(';');
+        for (var k = 0; k < cookies.length; k++) {
+            let cookieSplit = cookies[k].split('=');
+            if (trim(cookieSplit[0]) === cookieName) {
+                return decodeURIComponent(trim(cookieSplit[1]));
+            }
+        }
+    } catch (e) { }
+    return null;
+}
+/** set a cookie by that name and value. if you do not send expireDays, it will be a session cookie (in memory) */
+export function setCookie(name: string, value: string, expireDays?: number, path?: string) {
+    var cookie: string[] = [];
+
+    var cookieValue = `${name}=${isString(value) ? value : ""}`;
+    cookie.push(cookieValue);
+
+    if (isNumeric(expireDays)) {
+        var d = new Date();
+        d.setTime(d.getTime() + (expireDays * 24 * 60 * 60 * 1000));
+        var cookieExpires = "expires=" + d.toUTCString();
+        cookie.push(cookieExpires);
+    }
+
+    var cookiePath = `${isString(path) ? `path=` + path : "path=/"}`;
+    cookie.push(cookiePath);
+
+    document.cookie = cookie.join(";");
+}
+
+export function cookieEnabled() {
+    let enabled = "navigator" in globalThis && navigator.cookieEnabled === true;
+    return enabled;
 }