@jeniex/utils 1.0.1 → 1.0.3

package/browser/index.cjs

@@ -1,5 +1,3 @@
-// @ts-nocheck
-
 'use strict';
 
 function isString(object) {
@@ -40,6 +38,27 @@ async function sleep(milliSeconds) {
     });
 }
 
+const scriptInfo = typeof GM === 'undefined' ? GM_info : GM.info;
+const SCRIPT_NAME = scriptInfo.script.name;
+/** The identifier of the script to be used in logging */
+const LOG_ID = `[${SCRIPT_NAME}]:`;
+/** The initial tab URL on the script run */
+const TAB_URL = window.location.href;
+
+function alert(message) {
+    if (message === undefined) {
+        window.alert(`[ ${SCRIPT_NAME} ]`);
+        return;
+    }
+    window.alert(`[ ${SCRIPT_NAME} ]\n\n${message}`);
+}
+function confirm(message) {
+    return window.confirm(`[ ${SCRIPT_NAME} ]\n\n${message}`);
+}
+function prompt(message, _default) {
+    return window.prompt(`[ ${SCRIPT_NAME} ]\n\n${message}`, _default);
+}
+
 function $(selectors, parent) {
     const element = (parent ?? document).querySelector(ensureJoin(selectors));
     if (element === null) {
@@ -55,14 +74,95 @@ function $$(selectors, parent) {
     return elements;
 }
 
+function createFlagMessage(flag) {
+    const { message: messageHeader, values, type } = flag;
+    let message = messageHeader;
+    if (values !== undefined) {
+        message += `\n\n${values.join(' | ')}`;
+    }
+    if (type === 'number' && flag.range !== undefined) {
+        const [min, max] = flag.range;
+        if (min !== undefined) {
+            message += `\nMinimum: ${min}`;
+        }
+        if (max !== undefined) {
+            message += `\nMaximum: ${max}`;
+        }
+    }
+    return message;
+}
+
+function validateFlagValue(flag, promptValue) {
+    const { type, name, values } = flag;
+    if (promptValue === null || promptValue === '') {
+        throw new Error(`You did not provide a value for "${name}" option.`);
+    }
+    switch (type) {
+        case 'boolean': {
+            if (promptValue !== 'yes' && promptValue !== 'no') {
+                throw new Error(`Invalid value for "${name}" option!`);
+            }
+            return promptValue === 'yes';
+        }
+        case 'string': {
+            if (values !== undefined && !values.includes(promptValue)) {
+                throw new Error(`Provided value for "${name}" option is not in the list.`);
+            }
+            return promptValue;
+        }
+        case 'number': {
+            const promptValueAsNumber = Number(promptValue);
+            if (Number.isNaN(promptValueAsNumber)) {
+                throw new TypeError(`You need to provide a number for "${name}" option!`);
+            }
+            if (values !== undefined && !values.includes(promptValueAsNumber)) {
+                throw new Error(`Provided value for "${name}" option is not in the list.`);
+            }
+            const [min, max] = flag.range ?? [];
+            if (min !== undefined && promptValueAsNumber < min) {
+                throw new Error(`Provided value for "${name}" option is less than the minimum.`);
+            }
+            if (max !== undefined && promptValueAsNumber > max) {
+                throw new Error(`Provided value for "${name}" option is greater than the maximum.`);
+            }
+            return promptValueAsNumber;
+        }
+        default: {
+            throw new Error(`Unsupported flag type for "${name}" option.`);
+        }
+    }
+}
+
+function processFlag(flag) {
+    const message = createFlagMessage(flag);
+    const promptValue = prompt(message, flag.default?.toString());
+    return [flag.name, validateFlagValue(flag, promptValue)];
+}
+async function getOptions(flags) {
+    const options = {};
+    for (const flag of flags) {
+        const [name, value] = processFlag(flag);
+        options[name] = value;
+        await sleep(300);
+    }
+    return options;
+}
+
 exports.$ = $;
 exports.$$ = $$;
+exports.LOG_ID = LOG_ID;
+exports.SCRIPT_NAME = SCRIPT_NAME;
+exports.TAB_URL = TAB_URL;
+exports.alert = alert;
 exports.asserted = asserted;
+exports.confirm = confirm;
 exports.ensureJoin = ensureJoin;
+exports.getOptions = getOptions;
 exports.isFalsy = isFalsy;
 exports.isNotNullish = isNotNullish;
 exports.isNullish = isNullish;
 exports.isString = isString;
 exports.isTruthy = isTruthy;
 exports.noop = noop;
+exports.prompt = prompt;
 exports.sleep = sleep;

package/browser/index.d.ts

@@ -15,9 +15,45 @@ declare function sleep(milliSeconds: number): Promise<void>;
 type Nullable<T> = T | null | undefined;
 type Fn<T = any, U = void> = (param: T) => U;
 
+declare const SCRIPT_NAME: string;
+/** The identifier of the script to be used in logging */
+declare const LOG_ID: string;
+/** The initial tab URL on the script run */
+declare const TAB_URL: string;
+
+declare function alert(message?: string): void;
+declare function confirm(message: string): boolean;
+declare function prompt(message: string, _default?: string): string | null;
+
 type Parent = Document | HTMLElement;
 type Selectors = string[] | string;
 declare function $<T = HTMLElement>(selectors: Selectors, parent?: Parent): T;
 declare function $$<T extends Element = HTMLElement>(selectors: Selectors, parent?: Parent): NodeListOf<T>;
 
-export { $, $$, Fn, Nullable, asserted, ensureJoin, isFalsy, isNotNullish, isNullish, isString, isTruthy, noop, sleep };
+interface FlagBase {
+    name: string;
+    message: string;
+}
+interface FlagBoolean extends FlagBase {
+    type: 'boolean';
+    values?: ['no', 'yes'] | ['yes', 'no'];
+    default: 'no' | 'yes';
+}
+interface FlagString extends FlagBase {
+    type: 'string';
+    values?: string[];
+    default: string;
+}
+interface FlagNumber extends FlagBase {
+    type: 'number';
+    values?: number[];
+    range?: [number, number] | [number, undefined] | [undefined, number];
+    default: number;
+}
+type Flag = FlagBoolean | FlagNumber | FlagString;
+type FlagValue = boolean | number | string;
+type Options = Record<string, FlagValue>;
+
+declare function getOptions(flags: Flag[]): Promise<Options>;
+
+export { $, $$, Flag, Fn, LOG_ID, Nullable, SCRIPT_NAME, TAB_URL, alert, asserted, confirm, ensureJoin, getOptions, isFalsy, isNotNullish, isNullish, isString, isTruthy, noop, prompt, sleep };

package/browser/index.mjs

@@ -1,5 +1,3 @@
-// @ts-nocheck
-
 function isString(object) {
     return typeof object === 'string';
 }
@@ -38,6 +36,27 @@ async function sleep(milliSeconds) {
     });
 }
 
+const scriptInfo = typeof GM === 'undefined' ? GM_info : GM.info;
+const SCRIPT_NAME = scriptInfo.script.name;
+/** The identifier of the script to be used in logging */
+const LOG_ID = `[${SCRIPT_NAME}]:`;
+/** The initial tab URL on the script run */
+const TAB_URL = window.location.href;
+
+function alert(message) {
+    if (message === undefined) {
+        window.alert(`[ ${SCRIPT_NAME} ]`);
+        return;
+    }
+    window.alert(`[ ${SCRIPT_NAME} ]\n\n${message}`);
+}
+function confirm(message) {
+    return window.confirm(`[ ${SCRIPT_NAME} ]\n\n${message}`);
+}
+function prompt(message, _default) {
+    return window.prompt(`[ ${SCRIPT_NAME} ]\n\n${message}`, _default);
+}
+
 function $(selectors, parent) {
     const element = (parent ?? document).querySelector(ensureJoin(selectors));
     if (element === null) {
@@ -53,4 +72,78 @@ function $$(selectors, parent) {
     return elements;
 }
 
-export { $, $$, asserted, ensureJoin, isFalsy, isNotNullish, isNullish, isString, isTruthy, noop, sleep };
+function createFlagMessage(flag) {
+    const { message: messageHeader, values, type } = flag;
+    let message = messageHeader;
+    if (values !== undefined) {
+        message += `\n\n${values.join(' | ')}`;
+    }
+    if (type === 'number' && flag.range !== undefined) {
+        const [min, max] = flag.range;
+        if (min !== undefined) {
+            message += `\nMinimum: ${min}`;
+        }
+        if (max !== undefined) {
+            message += `\nMaximum: ${max}`;
+        }
+    }
+    return message;
+}
+
+function validateFlagValue(flag, promptValue) {
+    const { type, name, values } = flag;
+    if (promptValue === null || promptValue === '') {
+        throw new Error(`You did not provide a value for "${name}" option.`);
+    }
+    switch (type) {
+        case 'boolean': {
+            if (promptValue !== 'yes' && promptValue !== 'no') {
+                throw new Error(`Invalid value for "${name}" option!`);
+            }
+            return promptValue === 'yes';
+        }
+        case 'string': {
+            if (values !== undefined && !values.includes(promptValue)) {
+                throw new Error(`Provided value for "${name}" option is not in the list.`);
+            }
+            return promptValue;
+        }
+        case 'number': {
+            const promptValueAsNumber = Number(promptValue);
+            if (Number.isNaN(promptValueAsNumber)) {
+                throw new TypeError(`You need to provide a number for "${name}" option!`);
+            }
+            if (values !== undefined && !values.includes(promptValueAsNumber)) {
+                throw new Error(`Provided value for "${name}" option is not in the list.`);
+            }
+            const [min, max] = flag.range ?? [];
+            if (min !== undefined && promptValueAsNumber < min) {
+                throw new Error(`Provided value for "${name}" option is less than the minimum.`);
+            }
+            if (max !== undefined && promptValueAsNumber > max) {
+                throw new Error(`Provided value for "${name}" option is greater than the maximum.`);
+            }
+            return promptValueAsNumber;
+        }
+        default: {
+            throw new Error(`Unsupported flag type for "${name}" option.`);
+        }
+    }
+}
+
+function processFlag(flag) {
+    const message = createFlagMessage(flag);
+    const promptValue = prompt(message, flag.default?.toString());
+    return [flag.name, validateFlagValue(flag, promptValue)];
+}
+async function getOptions(flags) {
+    const options = {};
+    for (const flag of flags) {
+        const [name, value] = processFlag(flag);
+        options[name] = value;
+        await sleep(300);
+    }
+    return options;
+}
+
+export { $, $$, LOG_ID, SCRIPT_NAME, TAB_URL, alert, asserted, confirm, ensureJoin, getOptions, isFalsy, isNotNullish, isNullish, isString, isTruthy, noop, prompt, sleep };

package/node/index.cjs

@@ -1,5 +1,3 @@
-// @ts-nocheck
-
 'use strict';
 
 var fs = require('node:fs');

package/node/index.mjs

@@ -1,5 +1,3 @@
-// @ts-nocheck
-
 import fs from 'node:fs';
 import fsp from 'node:fs/promises';
 import path from 'node:path';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jeniex/utils",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "author": "JenieX",
   "homepage": "https://github.com/JenieX/utils",
   "type": "module",
@@ -31,6 +31,7 @@
     "@jeniex/eslint-config": "^0.0.3",
     "@rollup/plugin-typescript": "^11.1.3",
     "@types/node": "^20.5.7",
+    "@violentmonkey/types": "^0.1.5",
     "rollup": "^3.28.0",
     "rollup-plugin-dts": "^5.3.1",
     "tslib": "^2.6.2"