@jeniex/utils 1.0.20 → 1.0.22

package/browser/index.cjs

@@ -78,6 +78,53 @@ async function sleep(milliSeconds) {
     });
 }
 
+/**
+ * Adds leading zeros to a number.
+ *
+ * @category String
+ */
+function padZeros(number, length) {
+    if (Math.abs(number).toString().length > length) {
+        throw new Error('Provided length can not be less than the digits of the number.');
+    }
+    if (number < 0) {
+        throw new Error('Provided number must be greater than zero.');
+    }
+    const padded = '0'.repeat(length - 1) + number;
+    if (number < 10) {
+        return padded;
+    }
+    return padded.slice(-length);
+}
+
+const lowercaseWords = new Set([
+    'a', 'an', 'the',
+    'and', 'but', 'for', 'nor', 'or', 'so', 'yet',
+    'about', 'across', 'after', 'along', 'among', 'around', 'as', 'at', 'before', 'between', 'by', 'during', 'in', 'into', 'of', 'on', 'over', 'since', 'through', 'throughout', 'to', 'under', 'with', 'within',
+    'away', 'back', 'down', 'far', 'off', 'on', 'out', 'up',
+    'he', 'her', 'him', 'his', 'it', 'its', 'me', 'my', 'our', 'she', 'their', 'them', 'they', 'us', 'we', 'you', 'your',
+]);
+function capitalizeWord(word) {
+    return word[0].toUpperCase() + word.slice(1).toLowerCase();
+}
+/**
+ * capitalizes a word or a sentence.
+ *
+ * @category String
+ */
+function capitalize(sentence) {
+    if (sentence.includes(' ')) {
+        return sentence.split(' ').map((word, index) => {
+            const lowercaseWord = word.toLowerCase();
+            if (index > 0 && lowercaseWords.has(lowercaseWord)) {
+                return lowercaseWord;
+            }
+            return capitalizeWord(word);
+        }).join(' ');
+    }
+    return capitalizeWord(sentence);
+}
+
 let infoObject;
 if (typeof GM !== 'undefined') {
     infoObject = GM.info;
@@ -197,14 +244,14 @@ const fishX = {
 function $(selectors, parent) {
     const element = (parent ?? document).querySelector(join(selectors));
     if (element === null) {
-        throw new Error(`Couldn't find the element with the selector ${selectors}`);
+        throw new Error(`Could not find the element with the selector ${selectors}`);
     }
     return element;
 }
 function $$(selectors, parent) {
     const elements = (parent ?? document).querySelectorAll(join(selectors));
     if (elements.length === 0) {
-        throw new Error(`Couldn't find any element with the selector ${selectors}`);
+        throw new Error(`Could not find any element with the selector ${selectors}`);
     }
     return elements;
 }
@@ -239,6 +286,26 @@ function setSearchParam(key, value, fullURL) {
     }
     return updatedURL.join('');
 }
+/**
+ * @param keys The names of the param in the search query.
+ * @param fullURL If provided, it will be our target, otherwise it is the current location.
+ */
+function removeSearchParams(keys, fullURL) {
+    const updatedURL = [];
+    const { origin, pathname, search, hash } = new URL(fullURL ?? window.location.href);
+    const searchParams = new URLSearchParams(search);
+    for (const key of keys) {
+        searchParams.delete(key);
+    }
+    updatedURL.push(origin, pathname);
+    if (searchParams.toString() !== '') {
+        updatedURL.push('?', searchParams.toString());
+    }
+    if (hash !== '') {
+        updatedURL.push(hash);
+    }
+    return updatedURL.join('');
+}
 
 function addStyle(css, parent = document.documentElement) {
     const style = document.createElement('style');
@@ -374,6 +441,7 @@ exports.$$ = $$;
 exports.addStyle = addStyle;
 exports.alert = alert;
 exports.asserted = asserted;
+exports.capitalize = capitalize;
 exports.confirm = confirm;
 exports.fish = fish;
 exports.fishResponse = fishResponse;
@@ -394,9 +462,11 @@ exports.isTruthy = isTruthy;
 exports.join = join;
 exports.logId = logId;
 exports.noop = noop;
+exports.padZeros = padZeros;
 exports.pageLoad = pageLoad;
 exports.prompt = prompt;
 exports.remove = remove;
+exports.removeSearchParams = removeSearchParams;
 exports.scriptName = scriptName;
 exports.setSearchParam = setSearchParam;
 exports.sleep = sleep;

package/browser/index.d.ts

@@ -35,6 +35,20 @@ declare function isFunction<T extends Function>(object: unknown): object is T;
  */
 declare function sleep(milliSeconds: number): Promise<void>;
 
+/**
+ * Adds leading zeros to a number.
+ *
+ * @category String
+ */
+declare function padZeros(number: number, length: number): string;
+
+/**
+ * capitalizes a word or a sentence.
+ *
+ * @category String
+ */
+declare function capitalize(sentence: string): string;
+
 type Nullable<T> = T | null | undefined;
 type Fn<T = void, U = any> = (param?: U) => T;
 type Prettify<T> = {
@@ -86,6 +100,11 @@ declare function getSearchParam(key: string, fullURL?: string): string | undefin
  * @param fullURL If provided, it will be our target, otherwise it is the current location.
  */
 declare function setSearchParam(key: string, value: string, fullURL?: string): string;
+/**
+ * @param keys The names of the param in the search query.
+ * @param fullURL If provided, it will be our target, otherwise it is the current location.
+ */
+declare function removeSearchParams(keys: string[], fullURL?: string): string;
 
 declare const scriptName: string;
 /** The identifier of the script to be used in logging. */
@@ -132,4 +151,4 @@ type Options = Record<string, FlagValue>;
 
 declare function getOptions(flags: Flag[]): Promise<Options>;
 
-export { $, $$, Flag, Fn, Nullable, Prettify, addStyle, alert, asserted, confirm, fish, fishResponse, fishX, fishXResponse, getOptions, getSearchParam, imageLoad, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, logId, noop, pageLoad, prompt, remove, scriptName, setSearchParam, sleep, tabURL, toString };
+export { $, $$, Flag, Fn, Nullable, Prettify, addStyle, alert, asserted, capitalize, confirm, fish, fishResponse, fishX, fishXResponse, getOptions, getSearchParam, imageLoad, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, logId, noop, padZeros, pageLoad, prompt, remove, removeSearchParams, scriptName, setSearchParam, sleep, tabURL, toString };

package/browser/index.js

@@ -76,6 +76,53 @@ async function sleep(milliSeconds) {
     });
 }
 
+/**
+ * Adds leading zeros to a number.
+ *
+ * @category String
+ */
+function padZeros(number, length) {
+    if (Math.abs(number).toString().length > length) {
+        throw new Error('Provided length can not be less than the digits of the number.');
+    }
+    if (number < 0) {
+        throw new Error('Provided number must be greater than zero.');
+    }
+    const padded = '0'.repeat(length - 1) + number;
+    if (number < 10) {
+        return padded;
+    }
+    return padded.slice(-length);
+}
+
+const lowercaseWords = new Set([
+    'a', 'an', 'the',
+    'and', 'but', 'for', 'nor', 'or', 'so', 'yet',
+    'about', 'across', 'after', 'along', 'among', 'around', 'as', 'at', 'before', 'between', 'by', 'during', 'in', 'into', 'of', 'on', 'over', 'since', 'through', 'throughout', 'to', 'under', 'with', 'within',
+    'away', 'back', 'down', 'far', 'off', 'on', 'out', 'up',
+    'he', 'her', 'him', 'his', 'it', 'its', 'me', 'my', 'our', 'she', 'their', 'them', 'they', 'us', 'we', 'you', 'your',
+]);
+function capitalizeWord(word) {
+    return word[0].toUpperCase() + word.slice(1).toLowerCase();
+}
+/**
+ * capitalizes a word or a sentence.
+ *
+ * @category String
+ */
+function capitalize(sentence) {
+    if (sentence.includes(' ')) {
+        return sentence.split(' ').map((word, index) => {
+            const lowercaseWord = word.toLowerCase();
+            if (index > 0 && lowercaseWords.has(lowercaseWord)) {
+                return lowercaseWord;
+            }
+            return capitalizeWord(word);
+        }).join(' ');
+    }
+    return capitalizeWord(sentence);
+}
+
 let infoObject;
 if (typeof GM !== 'undefined') {
     infoObject = GM.info;
@@ -195,14 +242,14 @@ const fishX = {
 function $(selectors, parent) {
     const element = (parent ?? document).querySelector(join(selectors));
     if (element === null) {
-        throw new Error(`Couldn't find the element with the selector ${selectors}`);
+        throw new Error(`Could not find the element with the selector ${selectors}`);
     }
     return element;
 }
 function $$(selectors, parent) {
     const elements = (parent ?? document).querySelectorAll(join(selectors));
     if (elements.length === 0) {
-        throw new Error(`Couldn't find any element with the selector ${selectors}`);
+        throw new Error(`Could not find any element with the selector ${selectors}`);
     }
     return elements;
 }
@@ -237,6 +284,26 @@ function setSearchParam(key, value, fullURL) {
     }
     return updatedURL.join('');
 }
+/**
+ * @param keys The names of the param in the search query.
+ * @param fullURL If provided, it will be our target, otherwise it is the current location.
+ */
+function removeSearchParams(keys, fullURL) {
+    const updatedURL = [];
+    const { origin, pathname, search, hash } = new URL(fullURL ?? window.location.href);
+    const searchParams = new URLSearchParams(search);
+    for (const key of keys) {
+        searchParams.delete(key);
+    }
+    updatedURL.push(origin, pathname);
+    if (searchParams.toString() !== '') {
+        updatedURL.push('?', searchParams.toString());
+    }
+    if (hash !== '') {
+        updatedURL.push(hash);
+    }
+    return updatedURL.join('');
+}
 
 function addStyle(css, parent = document.documentElement) {
     const style = document.createElement('style');
@@ -367,4 +434,4 @@ async function getOptions(flags) {
     return options;
 }
 
-export { $, $$, addStyle, alert, asserted, confirm, fish, fishResponse, fishX, fishXResponse, getOptions, getSearchParam, imageLoad, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, logId, noop, pageLoad, prompt, remove, scriptName, setSearchParam, sleep, tabURL, toString };
+export { $, $$, addStyle, alert, asserted, capitalize, confirm, fish, fishResponse, fishX, fishXResponse, getOptions, getSearchParam, imageLoad, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, logId, noop, padZeros, pageLoad, prompt, remove, removeSearchParams, scriptName, setSearchParam, sleep, tabURL, toString };

package/node/index.cjs

@@ -82,6 +82,53 @@ async function sleep(milliSeconds) {
     });
 }
 
+/**
+ * Adds leading zeros to a number.
+ *
+ * @category String
+ */
+function padZeros(number, length) {
+    if (Math.abs(number).toString().length > length) {
+        throw new Error('Provided length can not be less than the digits of the number.');
+    }
+    if (number < 0) {
+        throw new Error('Provided number must be greater than zero.');
+    }
+    const padded = '0'.repeat(length - 1) + number;
+    if (number < 10) {
+        return padded;
+    }
+    return padded.slice(-length);
+}
+
+const lowercaseWords = new Set([
+    'a', 'an', 'the',
+    'and', 'but', 'for', 'nor', 'or', 'so', 'yet',
+    'about', 'across', 'after', 'along', 'among', 'around', 'as', 'at', 'before', 'between', 'by', 'during', 'in', 'into', 'of', 'on', 'over', 'since', 'through', 'throughout', 'to', 'under', 'with', 'within',
+    'away', 'back', 'down', 'far', 'off', 'on', 'out', 'up',
+    'he', 'her', 'him', 'his', 'it', 'its', 'me', 'my', 'our', 'she', 'their', 'them', 'they', 'us', 'we', 'you', 'your',
+]);
+function capitalizeWord(word) {
+    return word[0].toUpperCase() + word.slice(1).toLowerCase();
+}
+/**
+ * capitalizes a word or a sentence.
+ *
+ * @category String
+ */
+function capitalize(sentence) {
+    if (sentence.includes(' ')) {
+        return sentence.split(' ').map((word, index) => {
+            const lowercaseWord = word.toLowerCase();
+            if (index > 0 && lowercaseWords.has(lowercaseWord)) {
+                return lowercaseWord;
+            }
+            return capitalizeWord(word);
+        }).join(' ');
+    }
+    return capitalizeWord(sentence);
+}
+
 /**
  * Lists the files that are present in the provided folder path.
  * @throws an error if the provided folder path does not exist.
@@ -193,6 +240,7 @@ async function readJSON(filePath, withComments = false) {
 }
 
 exports.asserted = asserted;
+exports.capitalize = capitalize;
 exports.isBoolean = isBoolean;
 exports.isFalsy = isFalsy;
 exports.isFunction = isFunction;
@@ -207,6 +255,7 @@ exports.listFiles = listFiles;
 exports.listFolders = listFolders;
 exports.listFoldersSync = listFoldersSync;
 exports.noop = noop;
+exports.padZeros = padZeros;
 exports.readJSON = readJSON;
 exports.remove = remove;
 exports.removeFiles = removeFiles;

package/node/index.d.ts

@@ -35,6 +35,20 @@ declare function isFunction<T extends Function>(object: unknown): object is T;
  */
 declare function sleep(milliSeconds: number): Promise<void>;
 
+/**
+ * Adds leading zeros to a number.
+ *
+ * @category String
+ */
+declare function padZeros(number: number, length: number): string;
+
+/**
+ * capitalizes a word or a sentence.
+ *
+ * @category String
+ */
+declare function capitalize(sentence: string): string;
+
 type Nullable<T> = T | null | undefined;
 type Fn<T = void, U = any> = (param?: U) => T;
 type Prettify<T> = {
@@ -95,4 +109,4 @@ declare function removeFiles({ folderPath, filter }: RemoveFilesOpt): Promise<vo
 
 declare function readJSON<T = object>(filePath: string, withComments?: boolean): Promise<T>;
 
-export { Fn, Nullable, Prettify, asserted, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, listFiles, listFolders, listFoldersSync, noop, readJSON, remove, removeFiles, sleep, toString };
+export { Fn, Nullable, Prettify, asserted, capitalize, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, listFiles, listFolders, listFoldersSync, noop, padZeros, readJSON, remove, removeFiles, sleep, toString };

package/node/index.js

@@ -80,6 +80,53 @@ async function sleep(milliSeconds) {
     });
 }
 
+/**
+ * Adds leading zeros to a number.
+ *
+ * @category String
+ */
+function padZeros(number, length) {
+    if (Math.abs(number).toString().length > length) {
+        throw new Error('Provided length can not be less than the digits of the number.');
+    }
+    if (number < 0) {
+        throw new Error('Provided number must be greater than zero.');
+    }
+    const padded = '0'.repeat(length - 1) + number;
+    if (number < 10) {
+        return padded;
+    }
+    return padded.slice(-length);
+}
+
+const lowercaseWords = new Set([
+    'a', 'an', 'the',
+    'and', 'but', 'for', 'nor', 'or', 'so', 'yet',
+    'about', 'across', 'after', 'along', 'among', 'around', 'as', 'at', 'before', 'between', 'by', 'during', 'in', 'into', 'of', 'on', 'over', 'since', 'through', 'throughout', 'to', 'under', 'with', 'within',
+    'away', 'back', 'down', 'far', 'off', 'on', 'out', 'up',
+    'he', 'her', 'him', 'his', 'it', 'its', 'me', 'my', 'our', 'she', 'their', 'them', 'they', 'us', 'we', 'you', 'your',
+]);
+function capitalizeWord(word) {
+    return word[0].toUpperCase() + word.slice(1).toLowerCase();
+}
+/**
+ * capitalizes a word or a sentence.
+ *
+ * @category String
+ */
+function capitalize(sentence) {
+    if (sentence.includes(' ')) {
+        return sentence.split(' ').map((word, index) => {
+            const lowercaseWord = word.toLowerCase();
+            if (index > 0 && lowercaseWords.has(lowercaseWord)) {
+                return lowercaseWord;
+            }
+            return capitalizeWord(word);
+        }).join(' ');
+    }
+    return capitalizeWord(sentence);
+}
+
 /**
  * Lists the files that are present in the provided folder path.
  * @throws an error if the provided folder path does not exist.
@@ -190,4 +237,4 @@ async function readJSON(filePath, withComments = false) {
     return JSON.parse(stringJSON);
 }
 
-export { asserted, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, listFiles, listFolders, listFoldersSync, noop, readJSON, remove, removeFiles, sleep, toString };
+export { asserted, capitalize, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, listFiles, listFolders, listFoldersSync, noop, padZeros, readJSON, remove, removeFiles, sleep, toString };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jeniex/utils",
-  "version": "1.0.20",
+  "version": "1.0.22",
   "author": "JenieX",
   "homepage": "https://github.com/JenieX/utils",
   "type": "module",