@zoodogood/utils 1.0.4 → 1.0.5-change.421

package/lib/discordjs/mod.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Create a message object for Discord.
+ *
+ * @param {Object} params = Parameters for creating the message.
+ * @param {string} [params.content] - The message content.
+ * @param {string} [params.title] - The title of the embed.
+ * @param {string} [params.url] - The URL of the embed.
+ * @param {Object} [params.author] - The author of the embed.
+ * @param {string} [params.thumbnail] - The thumbnail URL of the embed.
+ * @param {string} [params.description] - The description of the embed.
+ * @param {string} [params.color] - The color of the embed.
+ * @param {Object[]} [params.fields] - The fields of the embed.
+ * @param {string} [params.image] - The image URL of the embed.
+ * @param {string} [params.video] - The video URL of the embed.
+ * @param {Object} [params.footer] - The footer of the embed.
+ * @param {string} [params.timestamp] - The timestamp of the embed.
+ * @param {boolean} [params.ephemeral] - Whether the message should be ephemeral.
+ * @param {boolean} [params.fetchReply] - Whether to fetch the message reply.
+ * @param {Object[] | Object} [params.components] - The message components.
+ * @param {Object[] | Object[]} [params.files] - The message files.
+ * @param {string} [params.reference] - The message reference.
+ * @returns {Object} - The message object.
+ */
+export function CreateMessage({ content, title, url, author, thumbnail, description, color, fields, image, video, footer, timestamp, ephemeral, fetchReply, components, files, reference, }: {
+    content?: string | undefined;
+    title?: string | undefined;
+    url?: string | undefined;
+    author?: Object | undefined;
+    thumbnail?: string | undefined;
+    description?: string | undefined;
+    color?: string | undefined;
+    fields?: Object[] | undefined;
+    image?: string | undefined;
+    video?: string | undefined;
+    footer?: Object | undefined;
+    timestamp?: string | undefined;
+    ephemeral?: boolean | undefined;
+    fetchReply?: boolean | undefined;
+    components?: Object | Object[] | undefined;
+    files?: Object[] | undefined;
+    reference?: string | undefined;
+}): Object;
+export function CreateModal({ title, customId, components }: {
+    title: any;
+    customId: any;
+    components: any;
+}): import("discord.js").APIModalInteractionResponseCallbackData;
+export function SimplifyComponents(data: any): any;
+/**
+ *
+ * @param {*} embed
+ * @returns {boolean}
+ */
+export function isEmptyEmbed(embed: any): boolean;

package/lib/discordjs/mod.js

@@ -0,0 +1,116 @@
+import { EmbedBuilder, ModalBuilder, resolveColor, ActionRow, } from "discord.js";
+import { ComponentType } from "discord-api-types/v10";
+/**
+ *
+ * @param {*} embed
+ * @returns {boolean}
+ */
+function isEmptyEmbed(embed) {
+    const DEFAULT_PROPERTIES = {
+        title: undefined,
+        author: undefined,
+        thumbnail: undefined,
+        description: undefined,
+        fields: undefined,
+        image: undefined,
+        footer: undefined,
+        timestamp: undefined,
+        video: undefined,
+    };
+    // in isEmptyEmbed context is a good compare
+    const isEqualDefault = (key) => String(embed[key]) === String(DEFAULT_PROPERTIES[key]);
+    const isEveryPropertyDefault = Object.keys(DEFAULT_PROPERTIES).every(isEqualDefault);
+    return isEveryPropertyDefault;
+}
+/**
+ * Create a message object for Discord.
+ *
+ * @param {Object} params = Parameters for creating the message.
+ * @param {string} [params.content] - The message content.
+ * @param {string} [params.title] - The title of the embed.
+ * @param {string} [params.url] - The URL of the embed.
+ * @param {Object} [params.author] - The author of the embed.
+ * @param {string} [params.thumbnail] - The thumbnail URL of the embed.
+ * @param {string} [params.description] - The description of the embed.
+ * @param {string} [params.color] - The color of the embed.
+ * @param {Object[]} [params.fields] - The fields of the embed.
+ * @param {string} [params.image] - The image URL of the embed.
+ * @param {string} [params.video] - The video URL of the embed.
+ * @param {Object} [params.footer] - The footer of the embed.
+ * @param {string} [params.timestamp] - The timestamp of the embed.
+ * @param {boolean} [params.ephemeral] - Whether the message should be ephemeral.
+ * @param {boolean} [params.fetchReply] - Whether to fetch the message reply.
+ * @param {Object[] | Object} [params.components] - The message components.
+ * @param {Object[] | Object[]} [params.files] - The message files.
+ * @param {string} [params.reference] - The message reference.
+ * @returns {Object} - The message object.
+ */
+function CreateMessage({ content, title, url, author, thumbnail, description, color, fields, image, video, footer, timestamp, ephemeral, fetchReply, components, files, reference, }) {
+    const message = {};
+    thumbnail && (thumbnail = { url: thumbnail });
+    image && (image = { url: image });
+    video && (video = { url: video });
+    color = resolveColor(color !== null && color !== void 0 ? color : "Random");
+    const embed = new EmbedBuilder({
+        title,
+        url,
+        author,
+        thumbnail,
+        description,
+        color,
+        fields,
+        image,
+        video,
+        footer,
+        timestamp,
+    });
+    if (!isEmptyEmbed(embed.data)) {
+        message.embeds = [embed];
+    }
+    if (files) {
+        message.files = files;
+    }
+    if (reference)
+        message.reply = {
+            messageReference: reference,
+        };
+    message.components = components ? SimplifyComponents(components) : null;
+    message.content = content;
+    message.ephemeral = ephemeral;
+    message.fetchReply = fetchReply;
+    return message;
+}
+function CreateModal({ title, customId, components }) {
+    components = SimplifyComponents(components);
+    return new ModalBuilder({ title, customId, components }).toJSON();
+}
+function SimplifyComponents(data) {
+    if (data instanceof Array && data.length === 0)
+        return [];
+    const isComponent = (component) => "type" in component && component.type !== ComponentType.ActionRow;
+    const isActionRow = (component) => (component instanceof Array && isComponent(component.at(0))) ||
+        component instanceof ActionRow;
+    const isComponents = (component) => component instanceof Array && isActionRow(component.at(0));
+    const argumentType = [
+        isComponent(data),
+        isActionRow(data),
+        isComponents(data),
+    ].findIndex(Boolean);
+    if (argumentType === -1)
+        throw new TypeError("expected component");
+    const wrapToArray = (component) => [component];
+    const arrayToActionRow = (componentsArray) => {
+        const isActionRow = "type" in componentsArray &&
+            componentsArray.type === ComponentType.ActionRow;
+        if (isActionRow)
+            return componentsArray;
+        return { type: ComponentType.ActionRow, components: componentsArray };
+    };
+    if (argumentType <= 0)
+        data = wrapToArray(data);
+    if (argumentType <= 1)
+        data = wrapToArray(data);
+    data = data.map(arrayToActionRow);
+    return data;
+}
+export { CreateMessage, CreateModal, SimplifyComponents, isEmptyEmbed };

package/lib/nodejs/getChildProcessUtils.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
 import type { ChildProcessWithoutNullStreams } from "child_process";
 import EventsEmitter from "events";
 interface IContext {

package/lib/objectives/DotNotatedInterface.d.ts

@@ -0,0 +1,23 @@
+interface IMethodsOptions {
+    defaultValue?: any;
+    allowSetFunctions?: boolean;
+}
+export declare class DotNotatedInterface {
+    target: Record<string, unknown>;
+    constructor(target: DotNotatedInterface["target"]);
+    getItem<T>(key: string, options?: IMethodsOptions): T | null;
+    setItem<T>(key: string, value: CallableFunction, options?: IMethodsOptions): T;
+    hasItem(key: string, options?: IMethodsOptions): boolean;
+    removeItem(key: string, options?: IMethodsOptions): boolean;
+    getParentAndlastSegmentByNotatedKey(key: string, { needFillIfParentNotExists }: {
+        needFillIfParentNotExists?: boolean | undefined;
+    }): {
+        parent: object | null;
+        lastSegment: string;
+    };
+    fillIsNotExists({ parent, segment, }: {
+        parent: {};
+        segment: string;
+    }): string;
+}
+export {};

package/lib/objectives/DotNotatedInterface.js

@@ -0,0 +1,60 @@
+export class DotNotatedInterface {
+    constructor(target) {
+        this.target = target;
+    }
+    getItem(key, options = {}) {
+        var _a;
+        const { parent, lastSegment } = this.getParentAndlastSegmentByNotatedKey(key, { needFillIfParentNotExists: false });
+        if (!parent || lastSegment in parent === false) {
+            return (_a = options.defaultValue) !== null && _a !== void 0 ? _a : null;
+        }
+        // @ts-ignore
+        return parent[lastSegment];
+    }
+    setItem(key, value, options = {}) {
+        if (typeof value === "function" && !options.allowSetFunctions) {
+            value = value(this.getItem(key, options));
+        }
+        const { parent, lastSegment } = this.getParentAndlastSegmentByNotatedKey(key, { needFillIfParentNotExists: true });
+        // @ts-ignore
+        return (parent[lastSegment] = value);
+    }
+    hasItem(key, options = {}) {
+        const { parent, lastSegment } = this.getParentAndlastSegmentByNotatedKey(key, { needFillIfParentNotExists: false });
+        if (parent === null) {
+            return false;
+        }
+        return lastSegment in parent;
+    }
+    removeItem(key, options = {}) {
+        const { parent, lastSegment } = this.getParentAndlastSegmentByNotatedKey(key, { needFillIfParentNotExists: false });
+        if (!parent) {
+            return false;
+        }
+        // @ts-ignore
+        return delete parent[lastSegment];
+    }
+    getParentAndlastSegmentByNotatedKey(key, { needFillIfParentNotExists = false }) {
+        const pathSegments = key.split(".");
+        if (!pathSegments.length) {
+            throw new Error("Empty path to property");
+        }
+        let parent = this.target;
+        for (let segment of pathSegments.slice(0, -1)) {
+            needFillIfParentNotExists &&
+                (segment = this.fillIsNotExists({ parent, segment }));
+            if (parent[segment] === undefined) {
+                return { parent: null, lastSegment: segment };
+            }
+            parent = parent[segment];
+        }
+        return { parent, lastSegment: pathSegments.at(-1) };
+    }
+    fillIsNotExists({ parent, segment, }) {
+        if (segment in parent === false) {
+            // @ts-ignore
+            parent[segment] = {};
+        }
+        return segment;
+    }
+}

package/lib/objectives/GlitchText.js

@@ -1,4 +1,4 @@
-import { getRandomValue } from "./getRandomValue.js";
+import { getRandomNumberInRange } from "./getRandomNumberInRange.js";
 class GlitchText {
     constructor(from = "", to = "hello, world", { step = 15, random = false, maximum = 100 } = {}) {
         this.from = from;
@@ -18,7 +18,7 @@ class GlitchText {
                 word.pop();
             if (word.length < target.length)
                 word.push(String.fromCharCode(~~(Math.random() * 50)));
-            word.forEach((_, index, array) => array[index] = String.fromCharCode(getRandomValue({ min: MIN, max: MAX })));
+            word.forEach((_, index, array) => array[index] = String.fromCharCode(getRandomNumberInRange({ min: MIN, max: MAX })));
             yield word.join("");
         }
         if (this.maximum)

package/lib/objectives/getRandomElementFromArray.d.ts

@@ -0,0 +1,7 @@
+interface IParams {
+    needPop?: boolean;
+    associatedWeights?: number[];
+}
+export declare function getRandomElementIndexInWeights(weights: NonNullable<IParams["associatedWeights"]>): number | never;
+export declare function getRandomElementFromArray<T>(array: T[], { needPop, associatedWeights }?: IParams): T;
+export {};

package/lib/objectives/getRandomElementFromArray.js

@@ -0,0 +1,24 @@
+import { getRandomNumberInRange } from "./getRandomNumberInRange.js";
+export function getRandomElementIndexInWeights(weights) {
+    if (weights.length < 1) {
+        new Error("Invalid array length");
+    }
+    let previousLimit = 0;
+    const thresholds = weights.map((weight) => (previousLimit += weight));
+    const lotterySecretNumber = Math.random() * thresholds.at(-1);
+    return thresholds.findIndex((threshold) => threshold >= lotterySecretNumber);
+}
+export function getRandomElementFromArray(array, { needPop, associatedWeights } = {}) {
+    if (associatedWeights && associatedWeights.length !== array.length) {
+        throw new Error("Incorrectly passed argument associatedWeights: The length of the associatedWeights must exactly match the length of the weights array");
+    }
+    const index = associatedWeights
+        ? getRandomElementIndexInWeights(associatedWeights)
+        : getRandomNumberInRange({ max: array.length });
+    const input = array[index];
+    if (needPop) {
+        array.splice(index, 1);
+        associatedWeights === null || associatedWeights === void 0 ? void 0 : associatedWeights.splice(index, 1);
+    }
+    return input;
+}

package/lib/objectives/getRandomNumberInRange.d.ts

@@ -0,0 +1,7 @@
+interface IGetRandomValueOptions {
+    min?: number;
+    max: number;
+    needRound?: boolean;
+}
+declare function getRandomNumberInRange({ min, max, needRound }: IGetRandomValueOptions): number;
+export { getRandomNumberInRange };

package/lib/objectives/getRandomNumberInRange.js

@@ -0,0 +1,8 @@
+function getRandomNumberInRange({ min = 0, max, needRound = true }) {
+    let value = Math.random() * (max - min + Number(needRound)) + min;
+    if (needRound) {
+        value = Math.floor(value);
+    }
+    return value;
+}
+export { getRandomNumberInRange };

package/lib/objectives/mod.d.ts

@@ -1,8 +1,8 @@
 export * from './CustomCollector.js';
 export * from './GlitchText.js';
-export * from './getRandomValue.js';
+export * from './getRandomNumberInRange.js';
 export * from './rangeToArray.js';
-declare function omit(object: object, filter: CallableFunction): {
+declare function omit(object: Object, filter: CallableFunction): {
     [k: string]: any;
 };
 export { omit };

package/lib/objectives/mod.js

@@ -1,6 +1,6 @@
 export * from './CustomCollector.js';
 export * from './GlitchText.js';
-export * from './getRandomValue.js';
+export * from './getRandomNumberInRange.js';
 export * from './rangeToArray.js';
 function omit(object, filter) {
     const entries = Object.entries(object)

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@zoodogood/utils",
   "type": "module",
-  "version": "1.0.4",
+  "version": "1.0.5-change.421",
   "description": "",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "homepage": "https://zoodogood.github.io/utils",
   "scripts": {
-    "test": "node index",
+    "test": "vitest",
     "docs-build": "cd ./docs && retype build  --output ./public",
     "docs-watch": "cd ./docs && retype watch",
-    "prepack": "tsc"
+    "prepack": "tsc",
+    "build": "tsc"
   },
   "typings": "lib/index",
   "exports": {
@@ -31,7 +32,8 @@
     "@types/node": "^20.5.9",
     "discord.js": "^14.13.0",
     "retypeapp-linux-x64": "^3.3.0",
-    "typescript": "^5.2.2"
+    "typescript": "^5.2.2",
+    "vitest": "^0.34.5"
   },
   "peerDependencies": {
     "discord.js": "=>14.x.x"

package/readme.md

@@ -7,4 +7,7 @@ https://zoodogood.github.io/utils/public
 export { ending } from '@zoodogood/utils/primitives';
 ```
 
-[NPM](https://www.npmjs.com/package/@zoodogood/utils)
+[NPM](https://www.npmjs.com/package/@zoodogood/utils)
+
+#### From developer:
+(Wa) Use only documented functions that are not marked "Unstable". Thanks.