@purr-react-core/utils.helpers 0.0.14

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Dinh Thien Phuc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs

@@ -0,0 +1 @@
+'use strict';var g=async n=>{try{return {error:null,result:await n}}catch(o){return {error:o,result:null}}},s=n=>{try{return n==="undefined"?null:JSON.parse(n??"")}catch{return null}},f=()=>{},c=n=>n.charAt(0).toUpperCase()+n.slice(1).toLowerCase(),p=(n,o=/-/)=>n.split(o).map(c).join(""),w=(n,o)=>(e,t)=>{let a=n.every(r=>o(r,e,t)??true),u=Object.keys(e).every(r=>n.includes(r)?true:e[r]===t[r]);return a&&u},d=n=>n;var m=()=>{window.location.reload();},k=(n,o="localStorage")=>s(window[o].getItem(n)),S=(n,o,e="localStorage")=>{window[e].setItem(n,JSON.stringify(o));},h=(n,o="localStorage")=>{window[o].removeItem(n);},T=(n="localStorage")=>{window[n].clear();};var i=n=>{if(Array.isArray(n))return  true;if(n&&typeof n=="object"&&"length"in n&&typeof n.length=="number")try{for(let o=0;o<n.length;o++)if(!(o in n))return !1;return !0}catch{return  false}return  false},b=n=>i(n)&&n.length>0,l=n=>typeof n=="object"&&n!==null&&!i(n)&&!(n instanceof Date)&&!(n instanceof RegExp)&&!(n instanceof Error)&&!(n instanceof Function),v=(n,o)=>!l(n)||o.length===0?false:o.some(e=>Object.prototype.hasOwnProperty.call(n,e)),O=n=>typeof n=="string"||n instanceof String,P=n=>typeof n=="number"&&!isNaN(n)||n instanceof Number&&!isNaN(n.valueOf()),R=n=>typeof n=="boolean"||n instanceof Boolean,A=n=>typeof n=="function"&&!/^class\s/.test(Function.prototype.toString.call(n)),E=n=>n instanceof Date&&!isNaN(n.getTime()),j=n=>n===void 0,D=n=>n===null,F=n=>n==null,B=n=>typeof n=="object"&&n!==null&&typeof n.then=="function"&&typeof n.catch=="function";exports.arePropsShallowEqual=w;exports.capitalize=c;exports.cast=d;exports.clearStorage=T;exports.doNothing=f;exports.getFromStorage=k;exports.hasProperties=v;exports.isArray=i;exports.isBoolean=R;exports.isDate=E;exports.isFunction=A;exports.isNil=F;exports.isNonEmptyArray=b;exports.isNull=D;exports.isNumber=P;exports.isObject=l;exports.isPromise=B;exports.isString=O;exports.isUndefined=j;exports.parseJSON=s;exports.reload=m;exports.removeFromStorage=h;exports.setToStorage=S;exports.toCamelCase=p;exports.tryDo=g;

package/dist/index.d.cts

@@ -0,0 +1,200 @@
+import { TAsyncBoundary } from '@purr-react-core/utils.definitions';
+
+/**
+ * Attempts to resolve the given promise and returns an object containing either the result or an error.
+ *
+ * @template T - The type of the resolved value of the promise.
+ * @param {Promise<T>} promise - The promise to be resolved.
+ * @returns {Promise<TAsyncBoundary<T>>} A promise that resolves to an object containing either the result or an error.
+ */
+declare const tryDo: <T>(promise: Promise<T>) => Promise<TAsyncBoundary<T>>;
+/**
+ * Parses a JSON string and returns the corresponding object.
+ *
+ * @template T - The type of the object to be returned.
+ * @param {string | null} jsonString - The JSON string to parse. If the string is "undefined" or null, the function returns null.
+ * @returns {T | null} - The parsed object, or null if the input is "undefined", null, or if parsing fails.
+ */
+declare const parseJSON: <T>(jsonString: string | null) => T | null;
+/**
+ * A no-operation (noop) function that does nothing.
+ *
+ * This function can be used as a placeholder or default callback
+ * where a function is required but no action is needed.
+ *
+ * @example
+ * ```typescript
+ * doNothing(); // This will perform no action
+ * ```
+ */
+declare const doNothing: () => void;
+/**
+ * Capitalizes the first character of the given string and converts the rest to lowercase.
+ *
+ * @param str - The string to be capitalized.
+ * @returns The capitalized string.
+ */
+declare const capitalize: (str: string) => string;
+/**
+ * Converts a string to camel case format.
+ *
+ * @param str - The string to be converted.
+ * @param divider - A regular expression used to split the string into words. Defaults to a hyphen (`-`).
+ * @returns The camel case formatted string.
+ */
+declare const toCamelCase: (str: string, divider?: RegExp) => string;
+/**
+ * Compares the shallow equality of specific properties and other properties between two objects.
+ *
+ * @param keys - An array of strings representing the keys of the properties to compare.
+ * @param callback - A function that takes a key, previous properties, and next properties, and returns a boolean or undefined.
+ *                   If the callback returns `undefined`, the comparison for that key defaults to `true`.
+ * @returns A function that takes two objects (`prevProps` and `nextProps`) and returns `true` if the specified properties and other properties are shallowly equal, otherwise `false`.
+ */
+declare const arePropsShallowEqual: (keys: string[], callback: (key: string, prevProps: Record<string, unknown>, nextProps: Record<string, unknown>) => boolean | undefined) => (prevProps: Record<string, unknown>, nextProps: Record<string, unknown>) => boolean;
+/**
+ * Casts a value to a specified type.
+ * Use it wisely, as it can lead to type errors if not used correctly.
+ *
+ * @template T - The type to cast the value to.
+ * @param {unknown} value - The value to cast.
+ * @returns {T} The cast value.
+ */
+declare const cast: <T>(value: unknown) => T;
+
+/**
+ * Reloads the current page.
+ *
+ * This function triggers a full page reload by calling `window.location.reload()`.
+ */
+declare const reload: () => void;
+/**
+ * Retrieves a value from the specified web storage (localStorage or sessionStorage).
+ *
+ * @template T - The expected type of the retrieved value.
+ * @param {string} key - The key of the item to retrieve from storage.
+ * @param {string} [storage="localStorage"] - The type of web storage to use ("localStorage" or "sessionStorage").
+ * @returns {T | null} - The parsed value from storage, or null if the key does not exist.
+ */
+declare const getFromStorage: <T>(key: string, storage?: "localStorage" | "sessionStorage") => T | null;
+/**
+ * Sets a value to the specified web storage (localStorage or sessionStorage).
+ *
+ * @template T - The type of the value to set.
+ * @param {string} key - The key of the item to set in storage.
+ * @param {T} value - The value to set in storage.
+ * @param {string} [storage="localStorage"] - The type of web storage to use ("localStorage" or "sessionStorage").
+ * @returns {void}
+ */
+declare const setToStorage: <T>(key: string, value: T, storage?: "localStorage" | "sessionStorage") => void;
+/**
+ * Removes an item from the specified web storage (localStorage or sessionStorage).
+ *
+ * @param {string} key - The key of the item to remove from storage.
+ * @param {string} [storage="localStorage"] - The type of web storage to use ("localStorage" or "sessionStorage").
+ * @returns {void}
+ */
+declare const removeFromStorage: (key: string, storage?: "localStorage" | "sessionStorage") => void;
+/**
+ * Clears all items from the specified web storage (localStorage or sessionStorage).
+ *
+ * @param {string} [storage="localStorage"] - The type of web storage to use ("localStorage" or "sessionStorage").
+ * @returns {void}
+ */
+declare const clearStorage: (storage?: "localStorage" | "sessionStorage") => void;
+
+/**
+ * Checks if the input is an array.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is an array, false otherwise.
+ */
+declare const isArray: (input: unknown) => input is unknown[];
+/**
+ * Checks if the input is a non-empty array.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is a non-empty array, false otherwise.
+ */
+declare const isNonEmptyArray: (input: unknown) => input is unknown[];
+/**
+ * Checks if the input is an object.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is an object, false otherwise.
+ */
+declare const isObject: (input: unknown) => input is Record<string, unknown>;
+/**
+ * Checks if the input object has the specified properties.
+ *
+ * @param {unknown} obj - The object to check.
+ * @param {string[]} properties - The properties to check.
+ * @returns {boolean} True if the input object has the specified properties, false otherwise.
+ */
+declare const hasProperties: (obj: unknown, properties: string[]) => obj is Record<string, unknown>;
+/**
+ * Checks if the input is a string.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is a string, false otherwise.
+ */
+declare const isString: (input: unknown) => input is string;
+/**
+ * Checks if the input is a number.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is a number, false otherwise.
+ */
+declare const isNumber: (input: unknown) => input is number;
+/**
+ * Checks if the input is a boolean.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is a boolean, false otherwise.
+ */
+declare const isBoolean: (input: unknown) => input is boolean;
+/**
+ * Checks if the input is a function.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is a function, false otherwise.
+ */
+declare const isFunction: (input: unknown) => input is (...args: unknown[]) => unknown;
+/**
+ * Checks if the input is a date.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is a date, false otherwise.
+ */
+declare const isDate: (input: unknown) => input is Date;
+/**
+ * Checks if the input is undefined.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is undefined, false otherwise.
+ */
+declare const isUndefined: (input: unknown) => input is undefined;
+/**
+ * Checks if the input is null.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is null, false otherwise.
+ */
+declare const isNull: (input: unknown) => input is null;
+/**
+ * Checks if the input is null or undefined.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is null or undefined, false otherwise.
+ */
+declare const isNil: (input: unknown) => input is null | undefined;
+/**
+ * Checks if the input is a promise.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is a promise, false otherwise.
+ * @template T - The type of the promise.
+ */
+declare const isPromise: <T = unknown>(input: unknown) => input is Promise<T>;
+
+export { arePropsShallowEqual, capitalize, cast, clearStorage, doNothing, getFromStorage, hasProperties, isArray, isBoolean, isDate, isFunction, isNil, isNonEmptyArray, isNull, isNumber, isObject, isPromise, isString, isUndefined, parseJSON, reload, removeFromStorage, setToStorage, toCamelCase, tryDo };

package/dist/index.d.ts

@@ -0,0 +1,200 @@
+import { TAsyncBoundary } from '@purr-react-core/utils.definitions';
+
+/**
+ * Attempts to resolve the given promise and returns an object containing either the result or an error.
+ *
+ * @template T - The type of the resolved value of the promise.
+ * @param {Promise<T>} promise - The promise to be resolved.
+ * @returns {Promise<TAsyncBoundary<T>>} A promise that resolves to an object containing either the result or an error.
+ */
+declare const tryDo: <T>(promise: Promise<T>) => Promise<TAsyncBoundary<T>>;
+/**
+ * Parses a JSON string and returns the corresponding object.
+ *
+ * @template T - The type of the object to be returned.
+ * @param {string | null} jsonString - The JSON string to parse. If the string is "undefined" or null, the function returns null.
+ * @returns {T | null} - The parsed object, or null if the input is "undefined", null, or if parsing fails.
+ */
+declare const parseJSON: <T>(jsonString: string | null) => T | null;
+/**
+ * A no-operation (noop) function that does nothing.
+ *
+ * This function can be used as a placeholder or default callback
+ * where a function is required but no action is needed.
+ *
+ * @example
+ * ```typescript
+ * doNothing(); // This will perform no action
+ * ```
+ */
+declare const doNothing: () => void;
+/**
+ * Capitalizes the first character of the given string and converts the rest to lowercase.
+ *
+ * @param str - The string to be capitalized.
+ * @returns The capitalized string.
+ */
+declare const capitalize: (str: string) => string;
+/**
+ * Converts a string to camel case format.
+ *
+ * @param str - The string to be converted.
+ * @param divider - A regular expression used to split the string into words. Defaults to a hyphen (`-`).
+ * @returns The camel case formatted string.
+ */
+declare const toCamelCase: (str: string, divider?: RegExp) => string;
+/**
+ * Compares the shallow equality of specific properties and other properties between two objects.
+ *
+ * @param keys - An array of strings representing the keys of the properties to compare.
+ * @param callback - A function that takes a key, previous properties, and next properties, and returns a boolean or undefined.
+ *                   If the callback returns `undefined`, the comparison for that key defaults to `true`.
+ * @returns A function that takes two objects (`prevProps` and `nextProps`) and returns `true` if the specified properties and other properties are shallowly equal, otherwise `false`.
+ */
+declare const arePropsShallowEqual: (keys: string[], callback: (key: string, prevProps: Record<string, unknown>, nextProps: Record<string, unknown>) => boolean | undefined) => (prevProps: Record<string, unknown>, nextProps: Record<string, unknown>) => boolean;
+/**
+ * Casts a value to a specified type.
+ * Use it wisely, as it can lead to type errors if not used correctly.
+ *
+ * @template T - The type to cast the value to.
+ * @param {unknown} value - The value to cast.
+ * @returns {T} The cast value.
+ */
+declare const cast: <T>(value: unknown) => T;
+
+/**
+ * Reloads the current page.
+ *
+ * This function triggers a full page reload by calling `window.location.reload()`.
+ */
+declare const reload: () => void;
+/**
+ * Retrieves a value from the specified web storage (localStorage or sessionStorage).
+ *
+ * @template T - The expected type of the retrieved value.
+ * @param {string} key - The key of the item to retrieve from storage.
+ * @param {string} [storage="localStorage"] - The type of web storage to use ("localStorage" or "sessionStorage").
+ * @returns {T | null} - The parsed value from storage, or null if the key does not exist.
+ */
+declare const getFromStorage: <T>(key: string, storage?: "localStorage" | "sessionStorage") => T | null;
+/**
+ * Sets a value to the specified web storage (localStorage or sessionStorage).
+ *
+ * @template T - The type of the value to set.
+ * @param {string} key - The key of the item to set in storage.
+ * @param {T} value - The value to set in storage.
+ * @param {string} [storage="localStorage"] - The type of web storage to use ("localStorage" or "sessionStorage").
+ * @returns {void}
+ */
+declare const setToStorage: <T>(key: string, value: T, storage?: "localStorage" | "sessionStorage") => void;
+/**
+ * Removes an item from the specified web storage (localStorage or sessionStorage).
+ *
+ * @param {string} key - The key of the item to remove from storage.
+ * @param {string} [storage="localStorage"] - The type of web storage to use ("localStorage" or "sessionStorage").
+ * @returns {void}
+ */
+declare const removeFromStorage: (key: string, storage?: "localStorage" | "sessionStorage") => void;
+/**
+ * Clears all items from the specified web storage (localStorage or sessionStorage).
+ *
+ * @param {string} [storage="localStorage"] - The type of web storage to use ("localStorage" or "sessionStorage").
+ * @returns {void}
+ */
+declare const clearStorage: (storage?: "localStorage" | "sessionStorage") => void;
+
+/**
+ * Checks if the input is an array.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is an array, false otherwise.
+ */
+declare const isArray: (input: unknown) => input is unknown[];
+/**
+ * Checks if the input is a non-empty array.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is a non-empty array, false otherwise.
+ */
+declare const isNonEmptyArray: (input: unknown) => input is unknown[];
+/**
+ * Checks if the input is an object.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is an object, false otherwise.
+ */
+declare const isObject: (input: unknown) => input is Record<string, unknown>;
+/**
+ * Checks if the input object has the specified properties.
+ *
+ * @param {unknown} obj - The object to check.
+ * @param {string[]} properties - The properties to check.
+ * @returns {boolean} True if the input object has the specified properties, false otherwise.
+ */
+declare const hasProperties: (obj: unknown, properties: string[]) => obj is Record<string, unknown>;
+/**
+ * Checks if the input is a string.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is a string, false otherwise.
+ */
+declare const isString: (input: unknown) => input is string;
+/**
+ * Checks if the input is a number.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is a number, false otherwise.
+ */
+declare const isNumber: (input: unknown) => input is number;
+/**
+ * Checks if the input is a boolean.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is a boolean, false otherwise.
+ */
+declare const isBoolean: (input: unknown) => input is boolean;
+/**
+ * Checks if the input is a function.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is a function, false otherwise.
+ */
+declare const isFunction: (input: unknown) => input is (...args: unknown[]) => unknown;
+/**
+ * Checks if the input is a date.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is a date, false otherwise.
+ */
+declare const isDate: (input: unknown) => input is Date;
+/**
+ * Checks if the input is undefined.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is undefined, false otherwise.
+ */
+declare const isUndefined: (input: unknown) => input is undefined;
+/**
+ * Checks if the input is null.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is null, false otherwise.
+ */
+declare const isNull: (input: unknown) => input is null;
+/**
+ * Checks if the input is null or undefined.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is null or undefined, false otherwise.
+ */
+declare const isNil: (input: unknown) => input is null | undefined;
+/**
+ * Checks if the input is a promise.
+ *
+ * @param {unknown} input - The input to check.
+ * @returns {boolean} True if the input is a promise, false otherwise.
+ * @template T - The type of the promise.
+ */
+declare const isPromise: <T = unknown>(input: unknown) => input is Promise<T>;
+
+export { arePropsShallowEqual, capitalize, cast, clearStorage, doNothing, getFromStorage, hasProperties, isArray, isBoolean, isDate, isFunction, isNil, isNonEmptyArray, isNull, isNumber, isObject, isPromise, isString, isUndefined, parseJSON, reload, removeFromStorage, setToStorage, toCamelCase, tryDo };

package/dist/index.js

@@ -0,0 +1 @@
+var g=async n=>{try{return {error:null,result:await n}}catch(o){return {error:o,result:null}}},s=n=>{try{return n==="undefined"?null:JSON.parse(n??"")}catch{return null}},f=()=>{},c=n=>n.charAt(0).toUpperCase()+n.slice(1).toLowerCase(),p=(n,o=/-/)=>n.split(o).map(c).join(""),w=(n,o)=>(e,t)=>{let a=n.every(r=>o(r,e,t)??true),u=Object.keys(e).every(r=>n.includes(r)?true:e[r]===t[r]);return a&&u},d=n=>n;var m=()=>{window.location.reload();},k=(n,o="localStorage")=>s(window[o].getItem(n)),S=(n,o,e="localStorage")=>{window[e].setItem(n,JSON.stringify(o));},h=(n,o="localStorage")=>{window[o].removeItem(n);},T=(n="localStorage")=>{window[n].clear();};var i=n=>{if(Array.isArray(n))return  true;if(n&&typeof n=="object"&&"length"in n&&typeof n.length=="number")try{for(let o=0;o<n.length;o++)if(!(o in n))return !1;return !0}catch{return  false}return  false},b=n=>i(n)&&n.length>0,l=n=>typeof n=="object"&&n!==null&&!i(n)&&!(n instanceof Date)&&!(n instanceof RegExp)&&!(n instanceof Error)&&!(n instanceof Function),v=(n,o)=>!l(n)||o.length===0?false:o.some(e=>Object.prototype.hasOwnProperty.call(n,e)),O=n=>typeof n=="string"||n instanceof String,P=n=>typeof n=="number"&&!isNaN(n)||n instanceof Number&&!isNaN(n.valueOf()),R=n=>typeof n=="boolean"||n instanceof Boolean,A=n=>typeof n=="function"&&!/^class\s/.test(Function.prototype.toString.call(n)),E=n=>n instanceof Date&&!isNaN(n.getTime()),j=n=>n===void 0,D=n=>n===null,F=n=>n==null,B=n=>typeof n=="object"&&n!==null&&typeof n.then=="function"&&typeof n.catch=="function";export{w as arePropsShallowEqual,c as capitalize,d as cast,T as clearStorage,f as doNothing,k as getFromStorage,v as hasProperties,i as isArray,R as isBoolean,E as isDate,A as isFunction,F as isNil,b as isNonEmptyArray,D as isNull,P as isNumber,l as isObject,B as isPromise,O as isString,j as isUndefined,s as parseJSON,m as reload,h as removeFromStorage,S as setToStorage,p as toCamelCase,g as tryDo};

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@purr-react-core/utils.helpers",
+  "version": "0.0.14",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "author": "@DinhThienPhuc",
+  "license": "ISC",
+  "description": "",
+  "sideEffects": false,
+  "dependencies": {
+    "@purr-react-core/utils.definitions": "0.0.14"
+  },
+  "scripts": {
+    "dev": "vite build --watch",
+    "build": "tsc && vite build",
+    "build:vite": "tsc && vite build",
+    "build:tsup": "tsup",
+    "lint": "eslint . --ext ts,tsx --max-warnings 0"
+  }
+}