@elara-services/packages 5.3.1 → 6.0.1

package/CHANGELOG

@@ -1,62 +0,0 @@
-# v5.2.0
-- Added `textInput` for `Interactions`
-- Added typings for `textInput` helper function.
-
-# v5.1.0
-- Added `name_localizations` for `SlashBuilder.choice`
-- Added typings for `min_length` and `max_length` for `SlashBuilder.option` for STRING options.
-- Fixed typings for `Interactions.button` to have `label` and `title`
-- Fixed `Interactions.button` to allow for `title` and `label`
-
-
-# v5.0.0
-### BREAKING CHANGES
-- `locale` option for `SlashBuilder.context.user` and `SlashBuilder.context.message` was turned into `options` taking in more options (to support both permissions and locale)
-- `defaultPermission`/`default_permission` was removed, since it's deprecated. (if you want to use it then stay on v4.8.1)
-
-# v4.8.0/v4.8.1
-- Added: `dmPermission` (`dm_permission`) for SlashBuilder.create
-- Added: `defaultMemberPermissions` (`default_member_permissions`) for SlashBuilder.create
-- Deprecated `defaultPermission` (`default_permission`) for SlashBuilder.create
-- Updated: Typings for SlashBuilder.create
-
-# v4.7.0
-Added `locale` option for `<SlashBuilder>.create`, `<SlashBuilder>.option`, `<SlashBuilder.context.user/message>`
-
-
-# v4.0.3, v4.0.2
-Added 
-- fetch (useful with `@elara-services/fetch`)
-
-# v4.0.1
-Added 
-- Languages.find
-- Languages.langs 
-
-# v4.0.0
-__Breaking Change__
-The following functions & methods for `SlashBuilder` was moved to `static`
-> So you no longer need to do `new (require("@elara-services/packages").SlashBuilder)()`
-
-
-# v3.0.3
-Added 'types.context.user', 'types.context.message' and the typings for SlashBuilder
-
-
-# v3.0.1, v3.0.2
-
-Fixed the typings for modal and added the typings for "ButtonStyle" 
-
-
-# v3.0.0
-
-__Breaking Changes__
-Removed `UserFlags`, `Permissions` and `BitField`
-
-
-__Added__
-`Interactions`
--> button
--> select
--> modal
-And the typings.

package/index.d.ts

@@ -1,247 +0,0 @@
-declare module "@elara-services/packages" {
-    type array = string[];
-
-    export class AES {
-        public constructor(key: string);
-        private key: string;
-        private header: string;
-        public encrypt(input: string): string
-        public decrypt(encrypted: string): string;
-    }
-
-    export const Languages: {
-        find(name: string): string | null;
-        langs: object
-    }
-
-    export class Minesweeper {
-        public constructor(options?: {
-            rows?: number;
-            columns?: number;
-            mines?: number;
-            emote?: string
-        });
-
-        public rows: number;
-        public columns: number;
-        public mines: number;
-        public matrix: array;
-        public types: {
-            mine: string;
-            numbers: array
-        };
-
-        public generateEmptyMatrix(): void;
-        public plantMines(): void;
-        public getNumberOfMines(x: number, y: number): string;
-        public start(): string | array[] | null;
-    }
-
-    export class Interactions extends null {
-        public static button(options: ButtonOptions): Button;
-        public static select(options: SelectOptions): Select;
-        public static modal(options: ModalOptions): Modal;
-        public static textInput(options: TextInputOptions, row?: boolean): TextInput | { type: number, components: [ TextInput ] };
-    }
-
-    export type ChannelTypes = 'GUILD_TEXT' | 'DM' | 'GUILD_VOICE' | 'GROUP_DM' | 'GUILD_CATEGORY' | 'GUILD_NEWS' | 'GUILD_STORE' | 'GUILD_NEWS_THREAD' | 'GUILD_PUBLIC_THREAD' | 'GUILD_PRIVATE_THREAD' | 'GUILD_STAGE_VOICE';
-
-    export type TextInputOptions = {
-        id?: string;
-        type?: number;
-        title?: string;
-        style?: number;
-        min?: number;
-        max?: number;
-        holder?: string;
-    } & TextInput;
-
-    export type TextInput = {
-        custom_id?: string;
-        type?: number;
-        label?: string;
-        style?: number;
-        min_length?: number;
-        max_length?: number;
-        placeholder?: string;
-        value?: string;
-        required?: boolean;
-    }
-
-    export type SlashOptions = {
-        type: number;
-        name: string;
-        description: string;
-        required?: boolean;
-        channel_types?: ChannelTypes[];
-        autocomplete?: boolean;
-        min_value?: number;
-        max_value?: number;
-        min_length?: number;
-        max_length?: number;
-        choices?: { name: string, value: string }[];
-        options?: SlashOptions[];
-        locale?: {
-            names?: object;
-            descriptions?: object;
-        }
-    }
-
-    export type Slash = {
-        type?: number;
-
-        dmPermission?: boolean;
-        dm_permission?: boolean;
-
-        defaultMemberPermissions?: string;
-        default_member_permissions?: string;
-        
-        options?: SlashOptions[];
-        locale?: {
-            names?: object;
-            descriptions?: object;
-        }
-    }
-
-    export class SlashBuilder {
-
-        public static TEXT_BASED_CHANNELS: number[];
-
-        public static types: {
-            sub_command: number,
-            sub_group: number,
-            string: number,
-            integer: number,
-            boolean: number,
-            user: number,
-            channel: number,
-            role: number,
-            mentionable: number,
-            number: number,
-            context: {
-                user: number;
-                message: number;
-            }
-        };
-
-        public static context: {
-            user(name: string, options?: Omit<Slash, "options"|"type">): Slash;
-            message(name: string, options?: Omit<Slash, "options"|"type">): Slash;
-        };
-
-        public static choice(name: string, value: string|number, name_localizations?: object): { name: string, value: string|number, name_localizations: object };
-        public static option(data: SlashOptions): Slash;
-        public static create(name: string, description: string, options: Slash): Slash;
-    }
-
-    export type Button = {
-        custom_id?: string;
-        label?: string;
-        type?: number;
-        style?: number;
-        disabled?: boolean;
-        emoji?: { name?: string, id?: string, animated?: boolean };
-        url?: string
-    }
-
-    export type ButtonOptions = {
-        id?: Button['custom_id'];
-        title?: Button['label'];
-        label?: Button['label'];
-        custom_id?: Button['custom_id'];
-        type?: Button['type'];
-        style?: ButtonStyles | Button['style'];
-        disabled?: Button['disabled'];
-        emoji?: Button['emoji'];
-        url?: Button['url']
-    }
-
-    export type ButtonStyles = 'PRIMARY' | 'BLURPLE' | 'SECONDARY' | 'GREY' | 'SUCCESS' | 'GREEN' | 'DANGER' | 'RED' | 'LINK' | 'URL'
-
-    export type Select = {
-        custom_id: string;
-        placeholder: string;
-        min_values: number;
-        max_values: number;
-        type: number;
-        disabled: boolean;
-        options: {
-            label: string;
-            value: string;
-            description?: string;
-            emoji?: Button['emoji'],
-            default?: boolean;
-        }[]
-    }
-
-    export type SelectOptions = {
-        id?: Select['custom_id'];
-        custom_id?: Select['custom_id'];
-        holder?: Select['placeholder'];
-        min?: Select['min_values'];
-        max?: Select['max_values'];
-        type?: Select['type'];
-        options: Select['options'];
-        disabled?: Select['disabled'];
-    }
-
-    export type Modal = {
-        title: string;
-        custom_id: string;
-        components: {
-            type: number,
-            components: {
-                type: number;
-                custom_id: string;
-                label: string;
-                style: 1 | 2 | number;
-                min_length?: number;
-                max_length?: number;
-                required?: boolean;
-                value?: string;
-                placeholder?: string;
-            }[]
-        }[]
-    }
-
-    export type ModalOptions = {
-        id?: Modal['custom_id'];
-        custom_id?: Modal['custom_id'];
-        title?: Modal['title'];
-        label?: Modal['title'];
-        components: Modal['components']
-    }
-
-
-    export function randomWeight(objects: object[]): object
-    export function randomWords(options?: {
-        exactly?: boolean;
-        maxLength?: number;
-        min?: number;
-        max?: number;
-        wordsPerString?: number;
-        formatter(word: string): void;
-        separator: string;
-        join: string;
-    }): string | string[]
-
-    export async function fetch(url: string, key?: string, body?: any, postRequest?: boolean, returnRaw?: boolean): Promise<object|string|null>;
-
-
-    export class Duration extends null {
-        static get timeIds(): Set<string>;
-        static validate(value: string): boolean;
-        static parse(value: string): number | null;
-        static determineTimeType(str: string): number;
-    };
-
-    export class Tasks extends null {
-        static create(options: {
-            id: string;
-            time: string;
-            shouldCancel?: boolean
-        }, run: Function): void;
-        
-        static delete(id: string): void;
-    }
-}

package/index.js

@@ -1,11 +0,0 @@
-
-exports.AES = require("./packages/aes256");
-exports.Minesweeper = require("./packages/minesweeper");
-exports.randomWords = require("./packages/random/words");
-exports.randomWeight = require("./packages/random/weight");
-exports.Languages = require("./packages/languages");
-exports.SlashBuilder = require("./packages/SlashBuilder");
-exports.Interactions = require("./packages/Interactions");
-exports.fetch = require("./packages/fetch");
-exports.Duration = require("./packages/duration");
-exports.Tasks = require("./packages/Tasks");

package/packages/Interactions.js

@@ -1,76 +0,0 @@
-module.exports = class Interactions extends null {
-    static button(options = {}) {
-        if (typeof options.style === "string") {
-            let styles = { PRIMARY: 1, BLURPLE: 1, SECONDARY: 2, GREY: 2, SUCCESS: 3, GREEN: 3, DANGER: 4, RED: 4, LINK: 5, URL: 5 };
-            let style = styles[options.style?.toUpperCase()];
-            if (!style) options.style = 2;
-            else options.style = style; 
-        };
-        if (typeof options.url === "string" && options.url.match(/(https?|discord):\/\//gi)) {
-            options.style = 5;
-            options.id = "";
-        }
-        return {
-            custom_id: options?.id ?? options?.custom_id ?? "",
-            label: options?.title ?? options?.label ?? "",
-            type: options?.type ?? 2,
-            style: options?.style ? options.style : 2,
-            disabled: Boolean(options.disabled),
-            emoji: options?.emoji ?? undefined,
-            url: options?.url ?? undefined
-        };
-    }
-
-    static select(options = {}) {
-        if (!options.options || !Array.isArray(options.options)) throw new Error(`[Dropdown#options]: isn't an array.`);
-        return {
-            custom_id: options?.id ?? options?.custom_id ?? "",
-            placeholder: options?.holder ?? "",
-            min_values: options?.min ?? 1,
-            max_values: options?.max ?? 1,
-            options: options?.options,
-            type: options?.type ?? 3,
-            disabled: typeof options?.disabled === "boolean" ? options.disabled : false
-        }
-    }
-
-    static modal(options = {}) {
-        if (!options.components || !Array.isArray(options.components)) throw new Error(`[Modal#components]: isn't an array!`);
-        return {
-            custom_id: options?.id ?? options?.custom_id,
-            title: options?.title ?? options?.label,
-            components: options.components
-        };
-    };
-
-    static textInput(options = {}, row = false) {
-        let data = {};
-
-        if (options.type) data.type = options.type;
-        else data.type = 4;
-
-        if (options.id) data.custom_id = options.id;
-        else if (options.custom_id) data.custom_id = options.custom_id;
-
-        if (options.label) data.label = options.label;
-        else if (options.title) data.label = options.title;
-        
-        if (options.style) data.style = options.style;
-        else data.style = 1;
-
-        if (options.min) data.min_length = options.min;
-        else if (options.min_length) data.min_length = options.min_length;
-        
-        if (options.max) data.max_length = options.max;
-        else if (options.max_length) data.max_length = options.max_length;
-
-        if (options.holder) data.placeholder = options.holder;
-        else if (options.placeholder) data.placeholder = options.placeholder;
-
-        if (typeof options.required === "boolean") data.required = options.required;
-        if (options.value) data.value = options.value;
-
-        if (row) return data;
-        return { type: 1, components: [ data ] };
-    };
-};

package/packages/SlashBuilder.js

@@ -1,58 +0,0 @@
-module.exports = class SlashBuilder extends null {
-    static get TEXT_BASED_CHANNELS() {
-        return [ 0, 5, 11, 12 ]
-    }
-
-    static get types() {
-        return {
-            sub_command: 1,
-            sub_group: 2,
-            string: 3,
-            integer: 4,
-            boolean: 5,
-            user: 6,
-            channel: 7,
-            role: 8,
-            mentionable: 9,
-            number: 10,
-            context: {
-                user: 2,
-                message: 3
-            }
-        };
-    }
-
-    static get context() {
-        return {
-            user: (name, options) => this.create(name, "", { type: this.types.context.user, ...options }),
-            message: (name, options) => this.create(name, "", { type: this.types.context.message, ...options })
-        }
-    };
-    
-    static choice(name, value, name_localizations) {
-        return { name, value, name_localizations };
-    };
-
-    static option(data) {
-        let _data = { ...data };
-        if (_data.locale?.names) _data.name_localizations = _data.locale.names;
-        if (_data.locale?.descriptions) _data.description_localizations = _data.locale.descriptions;
-        if ("locale" in _data) delete _data["locale"];
-        return _data;
-    };
-
-    static create(name, description, options = { }) {
-        let obj = { name, description };
-        if (options?.locale?.names) obj.name_localizations = options.locale.names;
-        if (options?.locale?.descriptions) obj.description_localizations = options.locale.descriptions;
-        if (options?.options?.length) obj.options = options.options;
-        if (options?.type) obj.type = options.type;
-
-        if ("dmPermission" in options) obj.dm_permission = options.dmPermission;
-        else if ("dm_permission" in options) obj.dm_permission = options.dm_permission;
-        
-        if ("default_member_permissions" in options) obj.default_member_permissions = options.default_member_permissions;
-        else if ("defaultMemberPermissions" in options) obj.default_member_permissions = options.defaultMemberPermissions;
-        return obj;
-    };
-};

package/packages/Tasks.js

@@ -1,22 +0,0 @@
-let nodeSchedule;
-
-try {
-    nodeSchedule = require("node-schedule");
-} catch { };
-
-module.exports = class Tasks extends null {
-    static create({ id = "", time = "", shouldCancel = true } = {}, run) {
-        if (!nodeSchedule) return `[Tasks:Create:ERROR]: I was unable to locate the 'node-schedule' package!`;
-        if (!id || !time || !run) return `[Tasks:Create:ERROR]: You didn't provide a valid ID, Time or Run function`;
-        if (nodeSchedule.scheduledJobs[id]) return `[Tasks:Create:ERROR]: Found (${id}) already in the scheduledJobs object.`;
-        return nodeSchedule.scheduleJob(id, time, () => {
-            run();
-            if (shouldCancel) return nodeSchedule.cancelJob(id);
-        });
-    };
-
-    static delete(id) {
-        if (!nodeSchedule) return null;
-        return nodeSchedule.cancelJob(id);
-    };
-};

package/packages/aes256.js

@@ -1,62 +0,0 @@
-const crypto = require("node:crypto"),
-      CIPHER_ALGORITHM = 'aes-256-ctr';
-
-module.exports = class AES256 {
-    constructor(key) {
-        if (!key || typeof key !== "string") throw new Error(`${this.header} 'key' is invalid or not a string.`);
-        /** @private */
-        this.key = key;
-    };
-    /** @private */
-    get header() {
-        return `[SECURITY]:`;
-    };
-
-    encrypt(input) {
-        let isString = typeof input === 'string',
-            isBuffer = Buffer.isBuffer(input);
-        if (!(isString || isBuffer) || (isString && !input) || (isBuffer && !Buffer.byteLength(input))) {
-            throw new Error(`${this.header} Provided invalid 'input', must be a non-empty string or buffer.`);
-        };
-
-        let sha = crypto.createHash("sha256");
-        sha.update(this.key);
-
-        let iv = crypto.randomBytes(16),
-            cipher = crypto.createCipheriv(CIPHER_ALGORITHM, sha.digest(), iv),
-            buffer = input;
-        
-        if (isString) buffer = Buffer.from(input);
-        let text = cipher.update(buffer),
-            encrypted = Buffer.concat([ iv, text, cipher.final() ]);
-        
-        if (isString) encrypted = encrypted.toString('base64');
-        return encrypted;
-    };
-
-    decrypt(encrypted) {
-        let [ isString, isBuffer ] = [
-            typeof encrypted === 'string',
-            Buffer.isBuffer(encrypted)
-        ];
-        if (!(isString || isBuffer) || (isString && !encrypted) || (isBuffer && !Buffer.byteLength(encrypted))) throw new Error(`${this.header} Provided "encrypted" must be a non-empty string or buffer`);
-        let sha256 = crypto.createHash('sha256');
-        sha256.update(this.key);
-    
-        let input = encrypted;
-        if (isString) {
-          input = Buffer.from(encrypted, 'base64');
-          if (input.length < 17) throw new Error(`${this.header} Provided "encrypted" must decrypt to a non-empty string or buffer`);
-        } else {
-          if (Buffer.byteLength(encrypted) < 17) throw new Error(`${this.header} Provided "encrypted" must decrypt to a non-empty string or buffer`);
-        }
-    
-        let iv = input.slice(0, 16),
-            decipher = crypto.createDecipheriv(CIPHER_ALGORITHM, sha256.digest(), iv),
-            ciphertext = input.slice(16),
-            output;
-        if (isString) output = decipher.update(ciphertext) + decipher.final();
-        else output = Buffer.concat([decipher.update(ciphertext), decipher.final()]);
-        return output;
-    };
-};

package/packages/duration.js

@@ -1,74 +0,0 @@
-module.exports = class Duration extends null {
-    static parse(value) {
-        const MATCHES_ALL = value.match(/\d+\s*[A-Za-z]+/g);
-        if (MATCHES_ALL) {
-            let totalTime = 0;
-            for (const dur of MATCHES_ALL) {
-                const [ num, str ] = [
-                    parseInt(dur.match(/\d+/g)[0]),
-                    dur.match(/[A-Za-z]+/g)[0]
-                ];
-                if (isNaN(num)) totalTime = 0;
-                else totalTime += num * module.exports.determineTimeType(str);
-            }
-            if (totalTime) return totalTime;
-        }
-    
-        return null;
-    };
-
-    static determineTimeType(str) {
-        switch (str) {
-            case "ms": case "millisecond": case "milliseconds": return 1;
-            
-            case "s": case "second": case "seconds": return 1000;
-            
-            case "m": case "min": case "mins": case "minute": case "minutes": return 60 * 1000;
-            
-            case "h": case "hr": case "hour": case "hours": return 60 * 60 * 1000;
-            
-            case "d": case "day": case "days": return 24 * 60 * 60 * 1000;
-            
-            case "w": case "week": case "weeks": return 7 * 24 * 60 * 60 * 1000;
-            
-            case "mo": case "month": case "months": return 30 * 24 * 60 * 60 * 1000;
-            
-            case "y": case "year": case "years": return 365 * 24 * 60 * 60 * 1000;
-            
-            default: return 1;
-        }
-    };
-
-    static validate(value) {
-        const MATCHES_ALL = value.match(/\d+\s*[A-Za-z]+/g);
-        if (MATCHES_ALL) {
-            for (const match of MATCHES_ALL) {
-                let [ num, str ] = [
-                    match.match(/\d+/g),
-                    match.match(/[A-Za-z]+/g)
-                ]
-                if (!num || (num.length !== 1)) return false;
-                if (!str || (str.length !== 1)) return false;
-                if (!Number.isInteger(parseInt(num[0]))) return false;
-                if (!module.exports.timeIds.has(str[0])) return false;
-            }
-    
-            return true;
-        }
-    
-        return false;
-    }
-
-    static get timeIds() {
-        return new Set([
-            "ms", "millisecond", "milliseconds",
-            "s", "second", "seconds",
-            "m", "min", "mins", "minute", "minutes",
-            "h", "hr", "hrs", "hour", "hours",
-            "d", "day", "days",
-            "w", "week", "weeks",
-            "mo", "month", "months",
-            "y", "year", "years"
-        ])
-    }
-}

package/packages/fetch.js

@@ -1,30 +0,0 @@
-let fetch;
-
-try {
-    fetch = require("@elara-services/fetch");
-    if ("fetch" in fetch) {
-        fetch = fetch.fetch;
-    }
-} catch {
-
-}
-
-module.exports = async (url, key = "", body = undefined, postRequest = false, returnRaw = false) => {
-    if (!fetch) throw new Error(`Unable to find @elara-services/fetch package`);
-    try {
-        let headers = { 
-            "User-Agent": `Services v${Math.floor(Math.random() * 999999)}`
-        };
-        if (key !== "" && key) headers.Authorization = key;
-        let res = await fetch(url, postRequest ? "POST" : "GET")
-        .header(headers)
-        .body(body, "json")
-        .send()
-        .catch(() => ({ statusCode: 500 }));
-        if (res.statusCode !== 200) return null;
-        if (returnRaw) return res.body;
-        return res.json();
-    } catch {
-        return null;
-    }
-}