@koine/utils 1.0.72 → 1.0.75

package/capitalize.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Capitalize first letter of the given string.
+ *
+ * @category text
+ * @see https://stackoverflow.com/a/11409944/1938970
+ */
+export declare function capitalize<T extends string>(text?: null | T): "" | Capitalize<T>;
+export default capitalize;

package/capitalize.js

@@ -0,0 +1,12 @@
+/**
+ * Capitalize first letter of the given string.
+ *
+ * @category text
+ * @see https://stackoverflow.com/a/11409944/1938970
+ */
+export function capitalize(text) {
+    return text
+        ? (text.charAt(0).toUpperCase() + text.slice(1))
+        : "";
+}
+export default capitalize;

package/createStorage.d.ts

@@ -1,6 +1,3 @@
-declare type NullableRecord<T> = {
-    [K in keyof T]: T[K] | null;
-};
 export declare type CreateStorageConfig = Record<string, any>;
 /**
  * Utility to create a storage instance to interact with `localStorage` using
@@ -16,8 +13,10 @@ export declare const createStorage: <T extends CreateStorageConfig>(config: Part
     get<TKey extends keyof T>(key: TKey): T[TKey] | null;
     /**
      * Get all storage values (it uses `localStorage.get()`).
+     *
+     * `undefined` and `null` values are not returned.
      */
-    getAll(): NullableRecord<T>;
+    getAll(): T;
     /**
      * Set a storage value (it uses `localStorage.set()`).
      *

package/createStorage.js

@@ -2,7 +2,7 @@ import { __assign } from "tslib";
 import { decode } from "./decode";
 import { encode } from "./encode";
 import { isBrowser } from "./isBrowser";
-import { isUndefined } from "./isUndefined";
+import { isNullOrUndefined } from "./isNullOrUndefined";
 import { isString } from "./isString";
 /**
  * Utility to create a storage instance to interact with `localStorage` using
@@ -48,11 +48,16 @@ export var createStorage = function (config) {
         },
         /**
          * Get all storage values (it uses `localStorage.get()`).
+         *
+         * `undefined` and `null` values are not returned.
          */
         getAll: function () {
             var all = {};
             for (var key in keys) {
-                all[key] = this.get(key);
+                var value = this.get(key);
+                if (!isNullOrUndefined(value)) {
+                    all[key] = value;
+                }
             }
             return all;
         },
@@ -73,7 +78,7 @@ export var createStorage = function (config) {
         setMany: function (newValues) {
             for (var key in newValues) {
                 var value = newValues[key];
-                if (!isUndefined(value)) {
+                if (!isNullOrUndefined(value)) {
                     this.set(key, value);
                 }
                 else {

package/getEmptyArray.d.ts

@@ -0,0 +1,9 @@
+/**
+ *
+ * Returns an array of undefined values of the desired length, useful to build
+ * skeleton UIs.
+ *
+ * @category array
+ */
+export declare function getEmptyArray(length: number | string): undefined[];
+export default getEmptyArray;

package/getEmptyArray.js

@@ -0,0 +1,15 @@
+import isNumber from "./isNumber";
+/**
+ *
+ * Returns an array of undefined values of the desired length, useful to build
+ * skeleton UIs.
+ *
+ * @category array
+ */
+export function getEmptyArray /* <T extends undefined | null = undefined> */(length) {
+    if (!isNumber(length)) {
+        length = parseInt(length, 10);
+    }
+    return Array.from({ length: length });
+}
+export default getEmptyArray;

package/getParamAmong.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Get query parameter as `string` treating the `ParsedUrlQuery` result of
+ * [`querystring`](https://nodejs.org/api/querystring.html) (used in next.js
+ * router and elsewhere)
+ *
+ * @category location
+ *
+ * @param {string} [raw] - The _raw_ query parameter
+ * @param {string[]} [allowedValues=[]] - The list of values (as strings) that the parameter can have, if not one of them `null` is returned
+ */
+export declare function getParamAmong<T extends string[]>(raw?: string | string[], allowedValues?: T): T[number] | null;
+export default getParamAmong;

package/getParamAmong.js

@@ -0,0 +1,17 @@
+import getParamAsString from "./getParamAsString";
+/**
+ * Get query parameter as `string` treating the `ParsedUrlQuery` result of
+ * [`querystring`](https://nodejs.org/api/querystring.html) (used in next.js
+ * router and elsewhere)
+ *
+ * @category location
+ *
+ * @param {string} [raw] - The _raw_ query parameter
+ * @param {string[]} [allowedValues=[]] - The list of values (as strings) that the parameter can have, if not one of them `null` is returned
+ */
+export function getParamAmong(raw, allowedValues) {
+    if (allowedValues === void 0) { allowedValues = []; }
+    var string = getParamAsString(raw);
+    return allowedValues.includes(string) ? string : null;
+}
+export default getParamAmong;

package/getParamAsInt.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Get query parameter as `int`eger treating the `ParsedUrlQuery` result of
+ * [`querystring`](https://nodejs.org/api/querystring.html) (used in next.js
+ * router and elsewhere)
+ *
+ * @category location
+ *
+ * @param {string} [raw] - The _raw_ query parameter
+ * @param {number} [fallback] - Fallback number, we return `null` if not provided
+ */
+export declare function getParamAsInt(raw?: string | string[], fallback?: number): number | null;
+export default getParamAsInt;

package/getParamAsInt.js

@@ -0,0 +1,19 @@
+import getParamAsString from "./getParamAsString";
+import isUndefined from "./isUndefined";
+/**
+ * Get query parameter as `int`eger treating the `ParsedUrlQuery` result of
+ * [`querystring`](https://nodejs.org/api/querystring.html) (used in next.js
+ * router and elsewhere)
+ *
+ * @category location
+ *
+ * @param {string} [raw] - The _raw_ query parameter
+ * @param {number} [fallback] - Fallback number, we return `null` if not provided
+ */
+export function getParamAsInt(raw, fallback) {
+    var string = getParamAsString(raw);
+    if (string)
+        parseInt(string, 10);
+    return isUndefined(fallback) ? null : fallback;
+}
+export default getParamAsInt;

package/getParamAsString.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Get query parameter as `string` treating the `ParsedUrlQuery` result of
+ * [`querystring`](https://nodejs.org/api/querystring.html) (used in next.js
+ * router and elsewhere)
+ *
+ * @category location
+ *
+ * @param {string} [raw] - The _raw_ query parameter
+ */
+export declare function getParamAsString(raw?: string | string[]): string;
+export default getParamAsString;

package/getParamAsString.js

@@ -0,0 +1,14 @@
+import isArray from "./isArray";
+/**
+ * Get query parameter as `string` treating the `ParsedUrlQuery` result of
+ * [`querystring`](https://nodejs.org/api/querystring.html) (used in next.js
+ * router and elsewhere)
+ *
+ * @category location
+ *
+ * @param {string} [raw] - The _raw_ query parameter
+ */
+export function getParamAsString(raw) {
+    return (isArray(raw) ? raw[0] : raw) || "";
+}
+export default getParamAsString;

package/index.d.ts

@@ -2,6 +2,7 @@ export * from "./accentSets";
 export * from "./addOrReplaceAtIdx";
 export * from "./arrayToLookup";
 export * from "./buildUrlQueryString";
+export * from "./capitalize";
 export * from "./changeUrlPath";
 export * from "./chunkByChunks";
 export * from "./chunkBySize";
@@ -16,8 +17,12 @@ export * from "./Emitter";
 export * from "./encode";
 export * from "./ensureInt";
 export * from "./findDuplicatedIndexes";
+export * from "./getEmptyArray";
 export * from "./getKeys";
 export * from "./getNonce";
+export * from "./getParamAmong";
+export * from "./getParamAsInt";
+export * from "./getParamAsString";
 export * from "./getType";
 export * from "./getUrlHashParams";
 export * from "./getUrlHashPathname";

package/index.js

@@ -2,6 +2,7 @@ export * from "./accentSets";
 export * from "./addOrReplaceAtIdx";
 export * from "./arrayToLookup";
 export * from "./buildUrlQueryString";
+export * from "./capitalize";
 export * from "./changeUrlPath";
 export * from "./chunkByChunks";
 export * from "./chunkBySize";
@@ -17,8 +18,12 @@ export * from "./encode";
 export * from "./ensureInt";
 // export * from "./env"
 export * from "./findDuplicatedIndexes";
+export * from "./getEmptyArray";
 export * from "./getKeys";
 export * from "./getNonce";
+export * from "./getParamAmong";
+export * from "./getParamAsInt";
+export * from "./getParamAsString";
 export * from "./getType";
 export * from "./getUrlHashParams";
 export * from "./getUrlHashPathname";
@@ -92,6 +97,7 @@ export * from "./readCookie";
 export * from "./redirectTo";
 export * from "./removeAccents";
 export * from "./removeCookie";
+// export * from "./removeDuplicates";
 export * from "./removeDuplicatesByKey";
 export * from "./removeDuplicatesComparing";
 export * from "./removeIndexesFromArray";

package/node/capitalize.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.capitalize = void 0;
+/**
+ * Capitalize first letter of the given string.
+ *
+ * @category text
+ * @see https://stackoverflow.com/a/11409944/1938970
+ */
+function capitalize(text) {
+    return text
+        ? (text.charAt(0).toUpperCase() + text.slice(1))
+        : "";
+}
+exports.capitalize = capitalize;
+exports.default = capitalize;

package/node/createStorage.js

@@ -5,7 +5,7 @@ var tslib_1 = require("tslib");
 var decode_1 = require("./decode");
 var encode_1 = require("./encode");
 var isBrowser_1 = require("./isBrowser");
-var isUndefined_1 = require("./isUndefined");
+var isNullOrUndefined_1 = require("./isNullOrUndefined");
 var isString_1 = require("./isString");
 /**
  * Utility to create a storage instance to interact with `localStorage` using
@@ -51,11 +51,16 @@ var createStorage = function (config) {
         },
         /**
          * Get all storage values (it uses `localStorage.get()`).
+         *
+         * `undefined` and `null` values are not returned.
          */
         getAll: function () {
             var all = {};
             for (var key in keys) {
-                all[key] = this.get(key);
+                var value = this.get(key);
+                if (!(0, isNullOrUndefined_1.isNullOrUndefined)(value)) {
+                    all[key] = value;
+                }
             }
             return all;
         },
@@ -76,7 +81,7 @@ var createStorage = function (config) {
         setMany: function (newValues) {
             for (var key in newValues) {
                 var value = newValues[key];
-                if (!(0, isUndefined_1.isUndefined)(value)) {
+                if (!(0, isNullOrUndefined_1.isNullOrUndefined)(value)) {
                     this.set(key, value);
                 }
                 else {

package/node/getEmptyArray.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEmptyArray = void 0;
+var isNumber_1 = require("./isNumber");
+/**
+ *
+ * Returns an array of undefined values of the desired length, useful to build
+ * skeleton UIs.
+ *
+ * @category array
+ */
+function getEmptyArray /* <T extends undefined | null = undefined> */(length) {
+    if (!(0, isNumber_1.default)(length)) {
+        length = parseInt(length, 10);
+    }
+    return Array.from({ length: length });
+}
+exports.getEmptyArray = getEmptyArray;
+exports.default = getEmptyArray;

package/node/getParamAmong.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getParamAmong = void 0;
+var getParamAsString_1 = require("./getParamAsString");
+/**
+ * Get query parameter as `string` treating the `ParsedUrlQuery` result of
+ * [`querystring`](https://nodejs.org/api/querystring.html) (used in next.js
+ * router and elsewhere)
+ *
+ * @category location
+ *
+ * @param {string} [raw] - The _raw_ query parameter
+ * @param {string[]} [allowedValues=[]] - The list of values (as strings) that the parameter can have, if not one of them `null` is returned
+ */
+function getParamAmong(raw, allowedValues) {
+    if (allowedValues === void 0) { allowedValues = []; }
+    var string = (0, getParamAsString_1.default)(raw);
+    return allowedValues.includes(string) ? string : null;
+}
+exports.getParamAmong = getParamAmong;
+exports.default = getParamAmong;

package/node/getParamAsInt.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getParamAsInt = void 0;
+var getParamAsString_1 = require("./getParamAsString");
+var isUndefined_1 = require("./isUndefined");
+/**
+ * Get query parameter as `int`eger treating the `ParsedUrlQuery` result of
+ * [`querystring`](https://nodejs.org/api/querystring.html) (used in next.js
+ * router and elsewhere)
+ *
+ * @category location
+ *
+ * @param {string} [raw] - The _raw_ query parameter
+ * @param {number} [fallback] - Fallback number, we return `null` if not provided
+ */
+function getParamAsInt(raw, fallback) {
+    var string = (0, getParamAsString_1.default)(raw);
+    if (string)
+        parseInt(string, 10);
+    return (0, isUndefined_1.default)(fallback) ? null : fallback;
+}
+exports.getParamAsInt = getParamAsInt;
+exports.default = getParamAsInt;

package/node/getParamAsString.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getParamAsString = void 0;
+var isArray_1 = require("./isArray");
+/**
+ * Get query parameter as `string` treating the `ParsedUrlQuery` result of
+ * [`querystring`](https://nodejs.org/api/querystring.html) (used in next.js
+ * router and elsewhere)
+ *
+ * @category location
+ *
+ * @param {string} [raw] - The _raw_ query parameter
+ */
+function getParamAsString(raw) {
+    return ((0, isArray_1.default)(raw) ? raw[0] : raw) || "";
+}
+exports.getParamAsString = getParamAsString;
+exports.default = getParamAsString;

package/node/index.js

@@ -5,6 +5,7 @@ tslib_1.__exportStar(require("./accentSets"), exports);
 tslib_1.__exportStar(require("./addOrReplaceAtIdx"), exports);
 tslib_1.__exportStar(require("./arrayToLookup"), exports);
 tslib_1.__exportStar(require("./buildUrlQueryString"), exports);
+tslib_1.__exportStar(require("./capitalize"), exports);
 tslib_1.__exportStar(require("./changeUrlPath"), exports);
 tslib_1.__exportStar(require("./chunkByChunks"), exports);
 tslib_1.__exportStar(require("./chunkBySize"), exports);
@@ -20,8 +21,12 @@ tslib_1.__exportStar(require("./encode"), exports);
 tslib_1.__exportStar(require("./ensureInt"), exports);
 // export * from "./env"
 tslib_1.__exportStar(require("./findDuplicatedIndexes"), exports);
+tslib_1.__exportStar(require("./getEmptyArray"), exports);
 tslib_1.__exportStar(require("./getKeys"), exports);
 tslib_1.__exportStar(require("./getNonce"), exports);
+tslib_1.__exportStar(require("./getParamAmong"), exports);
+tslib_1.__exportStar(require("./getParamAsInt"), exports);
+tslib_1.__exportStar(require("./getParamAsString"), exports);
 tslib_1.__exportStar(require("./getType"), exports);
 tslib_1.__exportStar(require("./getUrlHashParams"), exports);
 tslib_1.__exportStar(require("./getUrlHashPathname"), exports);
@@ -95,6 +100,7 @@ tslib_1.__exportStar(require("./readCookie"), exports);
 tslib_1.__exportStar(require("./redirectTo"), exports);
 tslib_1.__exportStar(require("./removeAccents"), exports);
 tslib_1.__exportStar(require("./removeCookie"), exports);
+// export * from "./removeDuplicates";
 tslib_1.__exportStar(require("./removeDuplicatesByKey"), exports);
 tslib_1.__exportStar(require("./removeDuplicatesComparing"), exports);
 tslib_1.__exportStar(require("./removeIndexesFromArray"), exports);

package/node/removeDuplicates.js

@@ -0,0 +1,13 @@
+"use strict";
+// /**
+//  * FIXME: Type 'Set<any>' can only be iterated through when using the
+//  * '--downlevelIteration' flag or with a '--target' of 'es2015' or higher.
+//  * I am not sure I want to use those ts options here. Let's keep it commented
+//  * for now
+//  *
+//  * @category array
+//  */
+// export function removeDuplicates<T extends any[]>(arr: T) {
+//   return [...new Set(arr)];
+// }
+// export default removeDuplicates;

package/package.json

@@ -7,7 +7,7 @@
   "peerDependencies": {
     "tslib": "^2.4.0"
   },
-  "version": "1.0.72",
+  "version": "1.0.75",
   "module": "./index.js",
   "types": "./index.d.ts"
 }

package/removeDuplicates.js

@@ -0,0 +1,13 @@
+"use strict";
+// /**
+//  * FIXME: Type 'Set<any>' can only be iterated through when using the
+//  * '--downlevelIteration' flag or with a '--target' of 'es2015' or higher.
+//  * I am not sure I want to use those ts options here. Let's keep it commented
+//  * for now
+//  *
+//  * @category array
+//  */
+// export function removeDuplicates<T extends any[]>(arr: T) {
+//   return [...new Set(arr)];
+// }
+// export default removeDuplicates;

package/typings.d.ts

@@ -6,3 +6,7 @@
 
 // eslint-disable-next-line no-var,@typescript-eslint/no-explicit-any
 declare var gtag: (...args: any[]) => any;
+
+// declare type NullableRecord<T> = {
+//   [K in keyof T]: T[K] | null;
+// };