@koine/utils 1.0.26 → 1.0.29

package/serializeCookie.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @file
+ *
+ * @category cookie
+ *
+ * All cookie related code is inspired and adapted from:
+ * - [js-cookie](https://github.com/js-cookie/js-cookie)
+ * - [cookie](https://github.com/jshttp/cookie)
+ */
+import { type CookieAttributesServer } from "./cookie";
+/**
+ * Serialize data into a cookie header.
+ *
+ * Serialize the a name value pair into a cookie string suitable for
+ * http headers. An optional attributes object specified cookie parameters.
+ *
+ * serialize('foo', 'bar', { httpOnly: true })
+ *   => "foo=bar; httpOnly"
+ *
+ * @category cookie
+ *
+ * All cookie related code is inspired and adapted from:
+ * - [js-cookie](https://github.com/js-cookie/js-cookie)
+ * - [cookie](https://github.com/jshttp/cookie)
+ */
+export declare function serializeCookie(name: string, val: string, attributes?: CookieAttributesServer): string;
+export default serializeCookie;

package/serializeCookie.js

@@ -0,0 +1,104 @@
+/**
+ * @file
+ *
+ * @category cookie
+ *
+ * All cookie related code is inspired and adapted from:
+ * - [js-cookie](https://github.com/js-cookie/js-cookie)
+ * - [cookie](https://github.com/jshttp/cookie)
+ */
+import { isNumber } from "./isNumber";
+/**
+ * RegExp to match field-content in RFC 7230 sec 3.2
+ *
+ * field-content = field-vchar [ 1*( SP / HTAB ) field-vchar ]
+ * field-vchar   = VCHAR / obs-text
+ * obs-text      = %x80-FF
+ */
+// eslint-disable-next-line no-control-regex
+var fieldContentRegExp = /^[\u0009\u0020-\u007e\u0080-\u00ff]+$/;
+/**
+ * Serialize data into a cookie header.
+ *
+ * Serialize the a name value pair into a cookie string suitable for
+ * http headers. An optional attributes object specified cookie parameters.
+ *
+ * serialize('foo', 'bar', { httpOnly: true })
+ *   => "foo=bar; httpOnly"
+ *
+ * @category cookie
+ *
+ * All cookie related code is inspired and adapted from:
+ * - [js-cookie](https://github.com/js-cookie/js-cookie)
+ * - [cookie](https://github.com/jshttp/cookie)
+ */
+export function serializeCookie(name, val, attributes) {
+    if (attributes === void 0) { attributes = {}; }
+    var _a = attributes.encode, encode = _a === void 0 ? encodeURIComponent : _a, domain = attributes.domain, path = attributes.path, httpOnly = attributes.httpOnly, secure = attributes.secure, sameSite = attributes.sameSite;
+    var maxAge = attributes.maxAge, expires = attributes.expires;
+    var value = encode(val);
+    if (process.env["NODE_ENV"] !== "production") {
+        if (!fieldContentRegExp.test(name)) {
+            throw new TypeError("argument name is invalid");
+        }
+        if (typeof attributes.encode !== "function") {
+            throw new TypeError("option encode is invalid");
+        }
+        if (value && !fieldContentRegExp.test(value)) {
+            throw new TypeError("argument val is invalid");
+        }
+    }
+    var str = name + "=" + value;
+    if (null != maxAge) {
+        maxAge = maxAge - 0;
+        if (isNaN(maxAge) || !isFinite(maxAge)) {
+            throw new TypeError("option maxAge is invalid");
+        }
+        str += "; Max-Age=" + Math.floor(maxAge);
+    }
+    if (domain) {
+        if (process.env["NODE_ENV"] !== "production") {
+            if (!fieldContentRegExp.test(domain)) {
+                throw new TypeError("option domain is invalid");
+            }
+        }
+        str += "; Domain=" + domain;
+    }
+    if (path) {
+        if (process.env["NODE_ENV"] !== "production") {
+            if (!fieldContentRegExp.test(path)) {
+                throw new TypeError("option path is invalid");
+            }
+        }
+        str += "; Path=" + path;
+    }
+    if (expires) {
+        if (isNumber(expires)) {
+            expires = new Date(Date.now() + expires * 864e5);
+        }
+        str += "; Expires=" + expires.toUTCString();
+    }
+    if (httpOnly) {
+        str += "; HttpOnly";
+    }
+    if (secure) {
+        str += "; Secure";
+    }
+    if (sameSite) {
+        switch (sameSite.toLowerCase()) {
+            case "lax":
+                str += "; SameSite=Lax";
+                break;
+            case "strict":
+                str += "; SameSite=Strict";
+                break;
+            case "none":
+                str += "; SameSite=None";
+                break;
+            //  default:
+            //    throw new TypeError('option sameSite is invalid');
+        }
+    }
+    return str;
+}
+export default serializeCookie;

package/setCookie.d.ts

@@ -0,0 +1,10 @@
+import { type CookieAttributesClient } from "./cookie";
+/**
+ * @category cookie
+ *
+ * All cookie related code is inspired and adapted from:
+ * - [js-cookie](https://github.com/js-cookie/js-cookie)
+ * - [cookie](https://github.com/jshttp/cookie)
+ */
+export declare function setCookie<T extends string = string>(name: string, value: string | T, attributes?: CookieAttributesClient): string | undefined;
+export default setCookie;

package/setCookie.js

@@ -0,0 +1,57 @@
+import { __assign, __rest } from "tslib";
+import { defaultAttributesClient } from "./cookie";
+import isNumber from "./isNumber";
+function converterWrite(value) {
+    return encodeURIComponent(value).replace(/%(2[346BF]|3[AC-F]|40|5[BDE]|60|7[BCD])/g, decodeURIComponent);
+}
+/**
+ * @category cookie
+ *
+ * All cookie related code is inspired and adapted from:
+ * - [js-cookie](https://github.com/js-cookie/js-cookie)
+ * - [cookie](https://github.com/jshttp/cookie)
+ */
+export function setCookie(name, value, attributes) {
+    if (attributes === void 0) { attributes = {}; }
+    // eslint-disable-next-line prefer-const
+    var expires = attributes.expires, restAttrs = __rest(attributes, ["expires"]);
+    var cleanedAttrs = __assign(__assign({ expires: "" }, defaultAttributesClient), restAttrs);
+    if (typeof document === "undefined") {
+        if (process.env["NODE_ENV"] !== "production") {
+            console.warn("@koine/utils:cookie setCookie, document is undefined");
+        }
+        return;
+    }
+    if (isNumber(expires)) {
+        expires = new Date(Date.now() + expires * 864e5);
+    }
+    if (expires) {
+        cleanedAttrs.expires = expires.toUTCString();
+    }
+    name = encodeURIComponent(name)
+        .replace(/%(2[346B]|5E|60|7C)/g, decodeURIComponent)
+        .replace(/[()]/g, escape);
+    var stringifiedAttributes = "";
+    for (var name_1 in attributes) {
+        var attrName = name_1;
+        if (!attributes[attrName]) {
+            continue;
+        }
+        stringifiedAttributes += "; " + attrName;
+        if (attributes[attrName] === true) {
+            continue;
+        }
+        // Considers RFC 6265 section 5.2:
+        // ...
+        // 3.  If the remaining unparsed-attributes contains a %x3B (";")
+        //     character:
+        // Consume the characters of the unparsed-attributes up to,
+        // not including, the first %x3B (";") character.
+        // ...
+        stringifiedAttributes +=
+            "=" + String(attributes[attrName]).split(";")[0];
+    }
+    return (document.cookie =
+        name + "=" + converterWrite(value) + stringifiedAttributes);
+}
+export default setCookie;

package/shuffle.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Creates an array of shuffled values, using a version of the
+ * [Fisher-Yates shuffle](https://en.wikipedia.org/wiki/Fisher-Yates_shuffle).
+ *
+ * @see lodash.shuffle
+ * @since 0.1.0
+ * @category arrays
+ * @param {Array} array The array to shuffle.
+ * @returns {Array} Returns the new shuffled array.
+ * @example
+ *
+ * shuffle([1, 2, 3, 4])
+ * // => [4, 1, 3, 2]
+ */
+export declare function shuffle<T>(array: T[]): T[];
+export default shuffle;

package/shuffle.js

@@ -0,0 +1,32 @@
+import { __spreadArray } from "tslib";
+/**
+ * Creates an array of shuffled values, using a version of the
+ * [Fisher-Yates shuffle](https://en.wikipedia.org/wiki/Fisher-Yates_shuffle).
+ *
+ * @see lodash.shuffle
+ * @since 0.1.0
+ * @category arrays
+ * @param {Array} array The array to shuffle.
+ * @returns {Array} Returns the new shuffled array.
+ * @example
+ *
+ * shuffle([1, 2, 3, 4])
+ * // => [4, 1, 3, 2]
+ */
+export function shuffle(array) {
+    var length = array == null ? 0 : array.length;
+    if (!length) {
+        return [];
+    }
+    var index = -1;
+    var lastIndex = length - 1;
+    var result = __spreadArray([], array, true);
+    while (++index < length) {
+        var rand = index + Math.floor(Math.random() * (lastIndex - index + 1));
+        var value = result[rand];
+        result[rand] = result[index];
+        result[index] = value;
+    }
+    return result;
+}
+export default shuffle;

package/{text.d.ts → slugify.d.ts}

@@ -1,14 +1,11 @@
-/**
- * First value is the `to`, second is `from`, from *which* chars do we translates *to*
- */
-export declare type AccentsSet = [string, string];
-export declare function removeAccents(text?: string, sets?: AccentsSet[]): string;
 /**
  * Slugify a text
  *
  * - replaces the accented letters
  * - replaces the punctuation with dashes
  *
+ * @category text
  * @see https://gist.github.com/mathewbyrne/1280286#gistcomment-3498021
  */
 export declare function slugify(text: string, separator?: string): string;
+export default slugify;

package/slugify.js

@@ -0,0 +1,23 @@
+import { accentsSets } from "./accentSets";
+import { removeAccents } from "./removeAccents";
+/**
+ * Slugify a text
+ *
+ * - replaces the accented letters
+ * - replaces the punctuation with dashes
+ *
+ * @category text
+ * @see https://gist.github.com/mathewbyrne/1280286#gistcomment-3498021
+ */
+export function slugify(text, separator) {
+    if (separator === void 0) { separator = "-"; }
+    return removeAccents(text.toString().toLowerCase().trim(), accentsSets.concat([["-", "[·/_,:;']"]]))
+        .replace(/\s+/g, "-") // replace spaces with -
+        .replace(/&/g, "-and-") // replace & with 'and'
+        .replace(/[^\w-]+/g, "") // remove all non-word chars
+        .replace(/--+/g, "-") // replace multiple - with single -
+        .replace(/^-+/, "") // trim - from start of text
+        .replace(/-+$/, "") // trim - from end of text
+        .replace(/-/g, separator);
+}
+export default slugify;

package/swapMap.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Swap object map key/value
+ *
+ * @category objects
+ */
+export declare function swapMap<T extends Record<string, string | number | symbol> = Record<string, string | number | symbol>>(map?: T): Record<T[keyof T], keyof T>;
+export default swapMap;

package/swapMap.js

@@ -0,0 +1,14 @@
+/**
+ * Swap object map key/value
+ *
+ * @category objects
+ */
+export function swapMap(map) {
+    if (map === void 0) { map = {}; }
+    var output = {};
+    for (var key in map) {
+        output[map[key]] = key;
+    }
+    return output;
+}
+export default swapMap;

package/{typography.d.ts → titleCase.d.ts}

@@ -1,9 +1,7 @@
 /**
+ * @category typography
  * @see https://github.com/blakeembrey/change-case/blob/master/packages/title-case/src/index.ts
  * @author Blake Embrey (hello@blakeembrey.com)
  */
 export declare const titleCase: (input?: null | string) => string;
-/**
- * Truncate string
- */
-export declare const truncate: (input: undefined | null | string, length: number) => string;
+export default titleCase;

package/{typography.js → titleCase.js}

@@ -1,4 +1,5 @@
 /**
+ * @category typography
  * @see https://github.com/blakeembrey/change-case/blob/master/packages/title-case/src/index.ts
  * @author Blake Embrey (hello@blakeembrey.com)
  */
@@ -7,13 +8,4 @@ export var titleCase = function (input) {
         ? input.replace(/\w\S*/g, function (txt) { return txt.charAt(0).toUpperCase() + txt.substring(1).toLowerCase(); })
         : "";
 };
-/**
- * Truncate string
- */
-export var truncate = function (input, length) {
-    return input
-        ? input.length > length
-            ? input.substring(0, length) + "..."
-            : input
-        : "";
-};
+export default titleCase;

package/toNumber.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @category cast
+ */
+export declare function toNumber(input?: string | number, fallback?: number): number;
+export default toNumber;

package/toNumber.js

@@ -0,0 +1,8 @@
+import { isNumber } from "./isNumber";
+/**
+ * @category cast
+ */
+export function toNumber(input, fallback) {
+    return isNumber(input) ? input : input ? parseFloat(input) : fallback || 0;
+}
+export default toNumber;

package/{colors.d.ts → toRgba.d.ts}

@@ -1 +1,5 @@
+/**
+ * @category colors
+ */
 export declare function toRgba(hex: string, alpha?: number): string;
+export default toRgba;

package/{colors.js → toRgba.js}

@@ -2,6 +2,9 @@
 // export const toRgb = (hexColor: string) => hexRgb(hexColor, { format: "css" });
 // export const toRgba = (hexColor: string, alpha: number) =>
 //   hexRgb(hexColor, { format: "css", alpha });
+/**
+ * @category colors
+ */
 export function toRgba(hex, alpha) {
     if (alpha === void 0) { alpha = 1; }
     var r = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex);
@@ -10,3 +13,4 @@ export function toRgba(hex, alpha) {
     }
     return "";
 }
+export default toRgba;

package/transformToUrlPathname.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Transform string in a URL pathname (relative URL)
+ *
+ * - adds an initial slash
+ * - encode the string
+ * - replaces whitespaces with dashes
+ *
+ * @category location
+ */
+export declare function transformToUrlPathname(toPathname?: string): string;
+export default transformToUrlPathname;

package/transformToUrlPathname.js

@@ -0,0 +1,16 @@
+import isString from "./isString";
+/**
+ * Transform string in a URL pathname (relative URL)
+ *
+ * - adds an initial slash
+ * - encode the string
+ * - replaces whitespaces with dashes
+ *
+ * @category location
+ */
+export function transformToUrlPathname(toPathname) {
+    return isString(toPathname)
+        ? "/".concat(encodeURIComponent(toPathname.replace(/\s/g, "-").toLowerCase()))
+        : "";
+}
+export default transformToUrlPathname;

package/truncate.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Truncate string
+ *
+ * @category typography
+ */
+export declare const truncate: (input: undefined | null | string, length: number) => string;
+export default truncate;

package/truncate.js

@@ -0,0 +1,13 @@
+/**
+ * Truncate string
+ *
+ * @category typography
+ */
+export var truncate = function (input, length) {
+    return input
+        ? input.length > length
+            ? input.substring(0, length) + "..."
+            : input
+        : "";
+};
+export default truncate;

package/uid.d.ts

@@ -1,10 +1,7 @@
 /**
  * Super basic UID increment-based generator
- */
-export declare const uid: (prefix?: string) => string;
-/**
- * Uuid, tiny custom helper instead of node's uuid/v4
  *
- * @see https://stackoverflow.com/a/2117523/1938970
+ * @category uid
  */
-export declare const uuid: () => string;
+export declare const uid: (prefix?: string) => string;
+export default uid;

package/uid.js

@@ -1,20 +1,12 @@
 var lastId = 0;
 /**
  * Super basic UID increment-based generator
+ *
+ * @category uid
  */
 export var uid = function (prefix) {
     if (prefix === void 0) { prefix = "id"; }
     lastId++;
     return "".concat(prefix, "-").concat(lastId);
 };
-/**
- * Uuid, tiny custom helper instead of node's uuid/v4
- *
- * @see https://stackoverflow.com/a/2117523/1938970
- */
-export var uuid = function () {
-    return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, function (c) {
-        var r = (Math.random() * 16) | 0, v = c == "x" ? r : (r & 0x3) | 0x8;
-        return v.toString(16);
-    });
-};
+export default uid;

package/updateLinkParams.d.ts

@@ -0,0 +1,10 @@
+import { type AnyQueryParams } from "./location";
+/**
+ * Update link `<a href="">` merging the given new query parameters.
+ * it returns the newly created `href` URL value
+ *
+ * @category location
+ * @pure
+ */
+export declare function updateLinkParams($anchor: HTMLAnchorElement, newParams: NonNullable<AnyQueryParams>): string;
+export default updateLinkParams;

package/updateLinkParams.js

@@ -0,0 +1,14 @@
+import updateUrlQueryParams from "./updateUrlQueryParams";
+/**
+ * Update link `<a href="">` merging the given new query parameters.
+ * it returns the newly created `href` URL value
+ *
+ * @category location
+ * @pure
+ */
+export function updateLinkParams($anchor, newParams) {
+    var href = updateUrlQueryParams($anchor.href, newParams);
+    $anchor.href = href;
+    return href;
+}
+export default updateLinkParams;

package/updateUrlQueryParams.d.ts

@@ -0,0 +1,9 @@
+import { type AnyQueryParams } from "./location";
+/**
+ * Update a URL string query parameters merging the given new query parameters
+ *
+ * @category location
+ * @pure
+ */
+export declare function updateUrlQueryParams(url: string, newParams?: NonNullable<AnyQueryParams>): string;
+export default updateUrlQueryParams;

package/updateUrlQueryParams.js

@@ -0,0 +1,18 @@
+import buildUrlQueryString from "./buildUrlQueryString";
+import getUrlQueryParams from "./getUrlQueryParams";
+import mergeUrlQueryParams from "./mergeUrlQueryParams";
+/**
+ * Update a URL string query parameters merging the given new query parameters
+ *
+ * @category location
+ * @pure
+ */
+export function updateUrlQueryParams(url, newParams) {
+    if (newParams === void 0) { newParams = {}; }
+    var parts = url.split("?");
+    var allParams = parts[1]
+        ? mergeUrlQueryParams(getUrlQueryParams(url), newParams)
+        : newParams;
+    return parts[0] + buildUrlQueryString(allParams);
+}
+export default updateUrlQueryParams;

package/uuid.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Uuid, tiny custom helper instead of node's uuid/v4
+ *
+ * @category uid
+ * @see https://stackoverflow.com/a/2117523/1938970
+ */
+export declare const uuid: () => string;
+export default uuid;

package/uuid.js

@@ -0,0 +1,13 @@
+/**
+ * Uuid, tiny custom helper instead of node's uuid/v4
+ *
+ * @category uid
+ * @see https://stackoverflow.com/a/2117523/1938970
+ */
+export var uuid = function () {
+    return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, function (c) {
+        var r = (Math.random() * 16) | 0, v = c == "x" ? r : (r & 0x3) | 0x8;
+        return v.toString(16);
+    });
+};
+export default uuid;

package/wait.d.ts

@@ -0,0 +1,7 @@
+/**
+ * A promisified `setTimeout`
+ *
+ * @category async
+ */
+export declare const wait: (milliseconds: number) => Promise<unknown>;
+export default wait;

package/wait.js

@@ -0,0 +1,9 @@
+/**
+ * A promisified `setTimeout`
+ *
+ * @category async
+ */
+export var wait = function (milliseconds) {
+    return new Promise(function (resolve) { return setTimeout(resolve, milliseconds); });
+};
+export default wait;

package/whitelistObject.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Whitelist an object properties by selecting only the given keys, it returns a
+ * new object.
+ *
+ * @category objects
+ */
+export declare function whitelistObject<T extends object, Keys extends (keyof T)[]>(object: T, keys: Keys): Pick<T, Keys[number]>;
+export default whitelistObject;

package/whitelistObject.js

@@ -0,0 +1,15 @@
+/**
+ * Whitelist an object properties by selecting only the given keys, it returns a
+ * new object.
+ *
+ * @category objects
+ */
+export function whitelistObject(object, keys) {
+    var output = {};
+    var len = keys.length;
+    while (len--) {
+        output[keys[len]] = object[keys[len]];
+    }
+    return output;
+}
+export default whitelistObject;

package/arrays.d.ts

@@ -1,41 +0,0 @@
-/**
- * Creates an array of shuffled values, using a version of the
- * [Fisher-Yates shuffle](https://en.wikipedia.org/wiki/Fisher-Yates_shuffle).
- *
- * @see lodash.shuffle
- * @since 0.1.0
- * @category Array
- * @param {Array} array The array to shuffle.
- * @returns {Array} Returns the new shuffled array.
- * @example
- *
- * shuffle([1, 2, 3, 4])
- * // => [4, 1, 3, 2]
- */
-export declare function shuffle<T>(array: T[]): T[];
-/**
- * Maps an array of objects into a map keyed with the given key
- */
-export declare function mapListBy<T extends Record<string | number | symbol, any>>(array?: T[], key?: keyof T): Record<T[keyof T], T>;
-/**
- * Maps a simple flat array to a lookup dictionary object
- */
-export declare function arrayToLookup<T extends string | number | symbol>(array?: T[]): Record<T, 1>;
-/**
- * Remove duplicated array objects, equality is determined by a strict (`===`)
- * comparison of each object's given key
- */
-export declare function removeDuplicatesByKey<T extends Record<string | number | symbol, any>>(array?: T[], key?: keyof T): T[];
-export declare function addOrReplaceAtIdx<T>(list: T[], newItem: T, newIdx?: number): T[];
-/**
- * @see https://stackoverflow.com/a/40682136/1938970
- */
-export declare function chunkBySize<T>(arr: T[], size: number): T[][];
-/**
- * TODO: untested
- * @see https://stackoverflow.com/a/8189268/1938970
- */
-export declare function chunkByChunks<T>(arr: T[], nrOfChunks: number, balanced?: boolean): T[][];
-export declare function removeDuplicatesComparing<T>(from: any[], to: T[]): T[];
-export declare function findDuplicatedIndexes(arr: any[]): Record<number, true>;
-export declare function removeIndexesFromArray<T>(arr: T[], indexes: Record<number, true>): T[];