@koine/utils 1.0.26 → 1.0.29

package/cookie.js

@@ -1,228 +1,10 @@
 /**
  * @file
  *
- * Inspired and adapted from
+ * @category cookie
  *
+ * All cookie related code is inspired and adapted from:
  * - [js-cookie](https://github.com/js-cookie/js-cookie)
- * @see https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/js-cookie/index.d.ts
  * - [cookie](https://github.com/jshttp/cookie)
- *
- */
-import { __assign, __rest } from "tslib";
-import { isNumber } from "./is";
-/**
- * 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]+$/;
-/**
- * Parse a cookie header.
- *
- * Parse the given cookie header string into an object
- * The object has the various cookies as keys(names) => values
- */
-export function parseCookie(str, attributes) {
-    if (attributes === void 0) { attributes = {}; }
-    if (typeof str !== "string") {
-        throw new TypeError("argument str must be a string");
-    }
-    var obj = {};
-    var pairs = str.split(";");
-    var _a = attributes.decode, decode = _a === void 0 ? decodeURIComponent : _a;
-    for (var i = 0; i < pairs.length; i++) {
-        var pair = pairs[i];
-        var index = pair.indexOf("=");
-        // skip things that don't look like key=value
-        if (index < 0) {
-            continue;
-        }
-        var key = pair.substring(0, index).trim();
-        // only assign once
-        if (undefined == obj[key]) {
-            var val = pair.substring(index + 1, pair.length).trim();
-            // quoted values
-            if (val[0] === '"') {
-                val = val.slice(1, -1);
-            }
-            obj[key] = tryDecode(val, decode);
-        }
-    }
-    return obj;
-}
-/**
- * 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"
- */
-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;
-}
-/**
- * Try decoding a string using a decoding function.
  */
-function tryDecode(str, decode) {
-    try {
-        return decode(str);
-    }
-    catch (e) {
-        return str;
-    }
-}
-function converterRead(value) {
-    if (value[0] === '"') {
-        value = value.slice(1, -1);
-    }
-    return value.replace(/(%[\dA-F]{2})+/gi, decodeURIComponent);
-}
-function converterWrite(value) {
-    return encodeURIComponent(value).replace(/%(2[346BF]|3[AC-F]|40|5[BDE]|60|7[BCD])/g, decodeURIComponent);
-}
-export function readCookie(name) {
-    if (typeof document === "undefined") {
-        if (process.env["NODE_ENV"] !== "production") {
-            console.warn("@koine/utils:cookie readCookie, document is undefined");
-        }
-        return name ? "" : {};
-    }
-    var cookies = document.cookie ? document.cookie.split("; ") : [];
-    var all = {};
-    for (var i = 0; i < cookies.length; i++) {
-        var parts = cookies[i].split("=");
-        var value = parts.slice(1).join("=");
-        try {
-            var found = decodeURIComponent(parts[0]);
-            all[found] = converterRead(value);
-            if (name === found) {
-                break;
-            }
-        }
-        catch (e) {
-            if (process.env["NODE_ENV"] !== "production") {
-                console.warn("@koine/utils:cookie readCookie, failed to decode", value);
-            }
-        }
-    }
-    return name ? all[name] : all;
-}
-var defaultAttributesClient = { path: "/" };
-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 function removeCookie(name, attributes) {
-    if (attributes === void 0) { attributes = {}; }
-    setCookie(name, "", __assign(__assign(__assign({}, defaultAttributesClient), attributes), { expires: -1 }));
-}
+export var defaultAttributesClient = { path: "/" };

package/decode.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @category security
+ * @see https://stackoverflow.com/a/22405578/9122820
+ */
+export declare function decode(str: string): string;
+export default decode;

package/decode.js

@@ -0,0 +1,10 @@
+/**
+ * @category security
+ * @see https://stackoverflow.com/a/22405578/9122820
+ */
+export function decode(str) {
+    return str.replace(/.{3}/g, function (c) {
+        return String.fromCharCode(parseInt(c, 10));
+    });
+}
+export default decode;

package/encode.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @category security
+ * @see https://stackoverflow.com/a/22405578/9122820
+ */
+export declare function encode(str: string): string;
+export default encode;

package/encode.js

@@ -0,0 +1,10 @@
+/**
+ * @category security
+ * @see https://stackoverflow.com/a/22405578/9122820
+ */
+export function encode(str) {
+    return str.replace(/./g, function (c) {
+        return ("00" + c.charCodeAt(0)).slice(-3);
+    });
+}
+export default encode;

package/{cast.d.ts → ensureInt.d.ts}

@@ -1,5 +1,7 @@
-export declare function toNumber(input?: string | number, fallback?: number): number;
 /**
  * Ensure input to be an integer
+ *
+ * @category cast
  */
 export declare const ensureInt: (input: string | number) => number;
+export default ensureInt;

package/{cast.js → ensureInt.js}

@@ -1,10 +1,9 @@
-import { isNumber } from "./is";
-export function toNumber(input, fallback) {
-    return isNumber(input) ? input : input ? parseFloat(input) : fallback || 0;
-}
 /**
  * Ensure input to be an integer
+ *
+ * @category cast
  */
 export var ensureInt = function (input) {
     return typeof input === "string" ? parseInt(input, 10) : Math.round(input);
 };
+export default ensureInt;

package/findDuplicatedIndexes.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @category array
+ */
+export declare function findDuplicatedIndexes(arr: any[]): Record<number, true>;
+export default findDuplicatedIndexes;

package/findDuplicatedIndexes.js

@@ -0,0 +1,14 @@
+/**
+ * @category array
+ */
+export function findDuplicatedIndexes(arr) {
+    var indexes = {};
+    for (var i = 0; i < arr.length; i++) {
+        var idxInArray = arr.indexOf(arr[i]);
+        if (idxInArray !== i && idxInArray !== -1) {
+            indexes[i] = true;
+        }
+    }
+    return indexes;
+}
+export default findDuplicatedIndexes;

package/getKeys.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Type safe replacement for `Object.keys(myObject)` to iterate over a record
+ * without loosing the key's types in simple `string`s.
+ *
+ * @category objects
+ * @see https://stackoverflow.com/a/59459000/1938970
+ */
+export declare const getKeys: <T extends object>(obj: T) => (keyof T)[];
+export default getKeys;

package/getKeys.js

@@ -0,0 +1,9 @@
+/**
+ * Type safe replacement for `Object.keys(myObject)` to iterate over a record
+ * without loosing the key's types in simple `string`s.
+ *
+ * @category objects
+ * @see https://stackoverflow.com/a/59459000/1938970
+ */
+export var getKeys = Object.keys;
+export default getKeys;

package/getNonce.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @category security
+ * @see https://github.com/styled-components/styled-components/blob/main/packages/styled-components/src/utils/nonce.ts
+ */
+export declare function getNonce(): string | null;
+export default getNonce;

package/getNonce.js

@@ -0,0 +1,9 @@
+import { isUndefined } from "./isUndefined";
+/**
+ * @category security
+ * @see https://github.com/styled-components/styled-components/blob/main/packages/styled-components/src/utils/nonce.ts
+ */
+export function getNonce() {
+    return isUndefined(__webpack_nonce__) ? null : __webpack_nonce__;
+}
+export default getNonce;

package/getType.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @file
+ *
+ * Same as [is-what](https://github.com/mesqueeb/is-what) plus:
+ *
+ * - `isFormData`
+ * - `isInt`
+ * - `isFloat`
+ */
+export declare type AnyFunction = (...args: any[]) => any;
+export declare type AnyAsyncFunction = (...args: any[]) => Promise<any>;
+export declare type AnyClass = new (...args: any[]) => any;
+export declare type PlainObject = Record<string | number | symbol, any>;
+export declare type TypeGuard<A, B extends A> = (payload: A) => payload is B;
+/**
+ * Returns the object type of the given payload
+ *
+ * @param {*} payload
+ * @returns {string}
+ */
+export declare function getType(payload: any): string;
+export default getType;

package/getType.js

@@ -0,0 +1,19 @@
+/**
+ * @file
+ *
+ * Same as [is-what](https://github.com/mesqueeb/is-what) plus:
+ *
+ * - `isFormData`
+ * - `isInt`
+ * - `isFloat`
+ */
+/**
+ * Returns the object type of the given payload
+ *
+ * @param {*} payload
+ * @returns {string}
+ */
+export function getType(payload) {
+    return Object.prototype.toString.call(payload).slice(8, -1);
+}
+export default getType;

package/getUrlHashParams.d.ts

@@ -0,0 +1,9 @@
+import { type AnyQueryParams } from "./location";
+/**
+ * It returns the "query params" as an object extracting it from the given `hash`
+ *string or, if not provided, failling back reading the `location.hash`
+
+ * @category location
+ */
+export declare function getUrlHashParams<T extends NonNullable<AnyQueryParams>>(hash?: string): T;
+export default getUrlHashParams;

package/getUrlHashParams.js

@@ -0,0 +1,16 @@
+/**
+ * It returns the "query params" as an object extracting it from the given `hash`
+ *string or, if not provided, failling back reading the `location.hash`
+
+ * @category location
+ */
+export function getUrlHashParams(hash) {
+    if (hash === void 0) { hash = ""; }
+    hash = hash || location.hash;
+    var hashParts = hash.split("?");
+    if (hashParts.length >= 1) {
+        return Object.fromEntries(new URLSearchParams(hashParts[1]));
+    }
+    return {};
+}
+export default getUrlHashParams;

package/getUrlHashPathname.d.ts

@@ -0,0 +1,9 @@
+/**
+ * It returns the "pathname" cleaned up from the `#` and the initial slashes
+ *  extracting it from the given `hash` string or, if not provided, failling
+ * back reading the `location.hash`
+ *
+ * @category location
+ */
+export declare function getUrlHashPathname(hash?: string): string;
+export default getUrlHashPathname;

package/getUrlHashPathname.js

@@ -0,0 +1,13 @@
+/**
+ * It returns the "pathname" cleaned up from the `#` and the initial slashes
+ *  extracting it from the given `hash` string or, if not provided, failling
+ * back reading the `location.hash`
+ *
+ * @category location
+ */
+export function getUrlHashPathname(hash) {
+    if (hash === void 0) { hash = ""; }
+    hash = hash || location.hash;
+    return hash.split("?")[0].replace(/^#\//, "");
+}
+export default getUrlHashPathname;

package/getUrlPathnameParts.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Get pathname parts
+ *
+ * First clean the pathname from the first slash if any then split the pathname
+ * in parts,
+ * Given a pathname like: `"/en/{prefix}/{collection}/{slug}"` we obtain
+ * `[locale, prefix, collection, slug]`
+ *
+ * @category location
+ */
+export declare function getUrlPathnameParts(pathname?: string): string[];
+export default getUrlPathnameParts;

package/getUrlPathnameParts.js

@@ -0,0 +1,20 @@
+import isBrowser from "./isBrowser";
+/**
+ * Get pathname parts
+ *
+ * First clean the pathname from the first slash if any then split the pathname
+ * in parts,
+ * Given a pathname like: `"/en/{prefix}/{collection}/{slug}"` we obtain
+ * `[locale, prefix, collection, slug]`
+ *
+ * @category location
+ */
+export function getUrlPathnameParts(pathname) {
+    if (pathname === void 0) { pathname = ""; }
+    pathname = pathname || isBrowser ? location.pathname : "";
+    return pathname
+        .replace(/^\//, "")
+        .split("/")
+        .filter(function (part) { return part; });
+}
+export default getUrlPathnameParts;

package/getUrlQueryParams.d.ts

@@ -0,0 +1,14 @@
+import { type AnyQueryParams } from "./location";
+/**
+ * Get parsed query parameters as object dictionary (from URL or given query string)
+ *
+ * @category location
+ * @param url A URL which contains a  `?`, e.g. `?myparam=x` or `https://a.com?myparams=x`.
+ *                    If not provided it defaults reading the current URL query string with
+ *                    `location.search`. Through this argument you can use this
+ *                    same function to parse, for instance, the query params of
+ *                    the `href` of a `<a href="...">` HTML tag.
+ *
+ */
+export declare function getUrlQueryParams<T extends NonNullable<AnyQueryParams>>(url?: string): T;
+export default getUrlQueryParams;

package/getUrlQueryParams.js

@@ -0,0 +1,38 @@
+import isBrowser from "./isBrowser";
+/**
+ * Get parsed query parameters as object dictionary (from URL or given query string)
+ *
+ * @category location
+ * @param url A URL which contains a  `?`, e.g. `?myparam=x` or `https://a.com?myparams=x`.
+ *                    If not provided it defaults reading the current URL query string with
+ *                    `location.search`. Through this argument you can use this
+ *                    same function to parse, for instance, the query params of
+ *                    the `href` of a `<a href="...">` HTML tag.
+ *
+ */
+export function getUrlQueryParams(url) {
+    var _a;
+    var params = {};
+    var search = url
+        ? (_a = url.split("?")) === null || _a === void 0 ? void 0 : _a[1]
+        : isBrowser
+            ? location.search.substring(1)
+            : "";
+    if (!search) {
+        return {};
+    }
+    try {
+        // @see https://stackoverflow.com/a/8649003/1938970
+        var paramsAsObj = "{\"".concat(search
+            .replace(/&/g, '","')
+            .replace(/=/g, '":"'), "\"}");
+        params = JSON.parse(paramsAsObj, function (key, value) {
+            return key === "" ? value : decodeURIComponent(value);
+        });
+    }
+    catch (e) {
+        // do nothing or warn on process.env["NODE_ENV"] !== "production"
+    }
+    return params;
+}
+export default getUrlQueryParams;