@arox/framework 0.1.1 → 0.1.2-beta.1

package/dist/structures/builder/Builder.d.ts

@@ -0,0 +1,19 @@
+import { SlashCommandBuilder, RESTPostAPIChatInputApplicationCommandsJSONBody } from "discord.js";
+import { Client } from "../core";
+export interface ApplicationJSONBody extends RESTPostAPIChatInputApplicationCommandsJSONBody {
+    prefix_support: boolean;
+    slash_support: boolean;
+    aliases: string[];
+}
+export declare class ApplicationCommandBuilder extends SlashCommandBuilder {
+    constructor();
+    protected prefix_support: boolean;
+    protected slash_support: boolean;
+    protected aliases: string[];
+    setAliases(...alias: string[]): this;
+    addAliases(...alias: string[]): this;
+    setPrefixSupport(support: boolean): this;
+    setSlashSupport(support: boolean): this;
+    toJSON(): ApplicationJSONBody;
+    toClientJSON(_client: Client): ReturnType<ApplicationCommandBuilder["toJSON"]>;
+}

package/dist/structures/builder/Command.d.ts

@@ -1,32 +1,20 @@
-import { ApplicationCommandOptionData, ChatInputCommandInteraction, Message } from "discord.js";
-import { Context, Client } from "#structures";
-import { Argument } from "./Argument";
+import { ChatInputCommandInteraction, Message } from "discord.js";
+import { Context, Client } from "../index";
 import { MaybePromise } from "#types/extra.js";
-import { Logger } from "#utils";
+import { Logger } from "../../utils/index";
+import { ApplicationCommandBuilder } from "./Builder";
 type MessageContext = NonNullable<ReturnType<Context<Message>["toJSON"]>>;
 type InteractionContext = NonNullable<ReturnType<Context<ChatInputCommandInteraction>["toJSON"]>>;
-export interface CommandOptions {
-    name: string;
-    description: string;
-    aliases?: string[];
-    options?: (ApplicationCommandOptionData | Argument)[];
-    slash?: boolean;
-    prefix?: boolean;
-}
 export declare class CommandBuilder {
+    #private;
+    readonly data: ApplicationCommandBuilder;
     readonly client: Client;
     readonly logger: Logger;
-    readonly name: string;
-    readonly description: string;
-    readonly aliases: string[];
-    readonly options: ApplicationCommandOptionData[];
-    private _supportsSlash;
-    private _supportsPrefix;
     _onMessage?: (ctx: MessageContext) => MaybePromise<void>;
     _onInteraction?: (ctx: InteractionContext) => MaybePromise<void>;
     get supportsSlash(): false | ((ctx: InteractionContext) => MaybePromise<void>) | undefined;
     get supportsPrefix(): false | ((ctx: MessageContext) => MaybePromise<void>) | undefined;
-    constructor(options: CommandOptions);
+    constructor(data: ApplicationCommandBuilder);
     onMessage(func: (ctx: MessageContext) => MaybePromise<void>): this;
     onInteraction(func: (ctx: InteractionContext) => MaybePromise<void>): this;
 }

package/dist/structures/builder/Context.d.ts

@@ -1,5 +1,6 @@
 import { Message, User, ChatInputCommandInteraction, Locale } from "discord.js";
-import { Client } from "#structures";
+import { Client } from "../index";
+import { TOptions } from "i18next";
 type ContextPayload<T extends ChatInputCommandInteraction | Message> = T extends ChatInputCommandInteraction ? {
     interaction: T;
     args?: string[];
@@ -16,7 +17,9 @@ export declare class Context<T extends ChatInputCommandInteraction | Message> {
     isInteraction(): this is Context<ChatInputCommandInteraction>;
     isMessage(): this is Context<Message>;
     get author(): User | null;
-    t(key: string, args?: Record<string, any>): string;
+    t(key: string, options?: TOptions & {
+        defaultValue?: string;
+    }): string;
     toJSON(): {
         kind: "interaction";
         interaction: T;

package/dist/structures/builder/Event.d.ts

@@ -1,19 +1,16 @@
 import { ClientEvents } from "discord.js";
 import { MaybePromise } from "#types/extra.js";
-import { Client } from "#structures";
-import { Logger } from "#utils";
+import { Client } from "../index";
+import { Logger } from "../../utils/index";
 type EventArgs<K extends keyof ClientEvents> = ClientEvents[K];
 type EventHandler<K extends keyof ClientEvents> = (context: EventBuilder<K>, ...args: EventArgs<K>) => MaybePromise<void>;
 export declare class EventBuilder<K extends keyof ClientEvents> {
+    #private;
     readonly name: K;
     readonly once: boolean;
     readonly client: Client;
     readonly logger: Logger;
-    private handler?;
-    private bound;
-    private readonly listener;
     constructor(name: K, once?: boolean, _handler?: EventHandler<K>);
-    private register;
     onExecute(func: EventHandler<K>): this;
 }
 export {};

package/dist/structures/builder/index.d.ts

@@ -1,4 +1,4 @@
-export * from "./Argument";
 export * from "./Command";
 export * from "./Context";
 export * from "./Event";
+export * from "./Builder";

package/dist/structures/core/Client.d.ts

@@ -1,9 +1,10 @@
 import { Client as DiscordClient, Collection, IntentsBitField } from "discord.js";
-import { CommandBuilder } from "#structures";
-import { Logger } from "#utils";
+import { CommandBuilder } from "../index";
+import { Logger } from "../../utils";
 import { FrameworkOptions } from "#types/client.js";
 import { i18n } from "i18next";
 export declare class Client<Ready extends boolean = boolean> extends DiscordClient<Ready> {
+    #private;
     readonly logger: Logger;
     commands: Collection<string, CommandBuilder>;
     aliases: Collection<string, Set<string>>;
@@ -14,7 +15,5 @@ export declare class Client<Ready extends boolean = boolean> extends DiscordClie
     };
     constructor(opts: FrameworkOptions);
     login(token?: string): Promise<string>;
-    loadDir(dir: string): Promise<void>;
-    loadFile(file: string): Promise<void>;
     registerCommands(): Promise<void>;
 }

package/dist/utils/logger/Logger.d.ts

@@ -4,6 +4,7 @@ import { Timestamp } from "@sapphire/timestamp";
 import type { ILogger } from "./ILogger";
 import { LogLevel } from "./ILogger";
 import { LoggerModule } from "i18next";
+export { LogLevel } from "./ILogger";
 export declare class Logger implements ILogger {
     level: LogLevel;
     readonly formats: Map<LogLevel, LoggerLevel>;

package/dist/utils/normalizeArray.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Normalizes data that is a rest parameter or an array into an array with a depth of 1.
+ *
+ * @typeParam ItemType - The data that must satisfy {@link RestOrArray}.
+ * @param arr - The (possibly variadic) data to normalize
+ */
+export declare function normalizeArray<ItemType>(arr: RestOrArray<ItemType>): ItemType[];
+/**
+ * Represents data that may be an array or came from a rest parameter.
+ *
+ * @remarks
+ * This type is used throughout builders to ensure both an array and variadic arguments
+ * may be used. It is normalized with {@link normalizeArray}.
+ */
+export type RestOrArray<Type> = Type[] | [Type[]];

package/package.json

@@ -1,62 +1 @@
-{
-  "name": "@arox/framework",
-  "version": "0.1.1",
-  "description": "",
-  "keywords": [
-    "discord.js",
-    "framework"
-  ],
-  "homepage": "https://github.com/AroxBot/framework#readme",
-  "bugs": {
-    "url": "https://github.com/AroxBot/framework/issues"
-  },
-  "license": "Apache-2.0",
-  "author": "vrdons",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/AroxBot/framework.git"
-  },
-  "type": "commonjs",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "imports": {
-    "#types/*": "./types/*",
-    "#utils": "./src/utils/index.ts",
-    "#structures": "./src/structures/index.ts",
-    "#ctx": "./src/context.ts"
-  },
-  "scripts": {
-    "prepare": "node scripts/prepareHusky.js",
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "check": "oxfmt --check && oxlint --type-aware --type-check",
-    "format": "oxfmt",
-    "build:js": "swc src -d dist --strip-leading-paths --copy-files",
-    "build:dts": "tsc --emitDeclarationOnly",
-    "build": "npm run build:js && node ./scripts/actions/patch.js && npm run build:dts",
-    "release:git": "node scripts/actions/github.js",
-    "release:npm": "node scripts/actions/npm.js"
-  },
-  "dependencies": {
-    "@sapphire/timestamp": "^1.0.5",
-    "@swc/helpers": "^0.5.18",
-    "colorette": "^2.0.20",
-    "fast-glob": "^3.3.3",
-    "i18next": "^25.8.0",
-    "i18next-fs-backend": "^2.6.1",
-    "lodash": "^4.17.21"
-  },
-  "devDependencies": {
-    "@swc/cli": "^0.7.10",
-    "@types/lodash": "^4.17.23",
-    "@types/node": "^25.0.9",
-    "husky": "^9.1.7",
-    "libnpmpack": "^9.0.12",
-    "oxfmt": "^0.26.0",
-    "oxlint": "^1.39.0",
-    "oxlint-tsgolint": "^0.11.0",
-    "typescript": "^5.9.3"
-  },
-  "peerDependencies": {
-    "discord.js": ">=14.25.1"
-  }
-}
+{"name":"@arox/framework","version":"0.1.2-beta.1","description":"","keywords":["arox","discord.js","framework"],"homepage":"https://github.com/AroxBot/framework#readme","bugs":{"url":"https://github.com/AroxBot/framework/issues"},"license":"Apache-2.0","author":"vrdons","contributors":["fhyrox"],"repository":{"type":"git","url":"git+https://github.com/AroxBot/framework.git"},"type":"commonjs","main":"dist/index.js","types":"dist/index.d.ts","imports":{"#types/*":"./types/*"},"dependencies":{"@sapphire/timestamp":"^1.0.5","colorette":"^2.0.20","fast-glob":"^3.3.3","i18next":"^25.8.0"},"peerDependencies":{"discord.js":">=14.25.1"}}

package/cliff.toml

@@ -1,48 +0,0 @@
-[changelog]
-header = """
-# Changelog\n
-All notable changes to this project will be documented in this file.\n
-"""
-body = """
-{% if version %}
-## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}\
-{% else %}\
-## Unreleased\
-{% endif %}
-
-{% for group, commits in commits | group_by(attribute="group") %}\
-### {{ group | upper_first }}
-{% for commit in commits %}
-- {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }} {% if commit.author.username %}by [@{{ commit.author.username }}](https://github.com/{{ commit.author.username }}){% else %}by {{ commit.author.name }}{% endif %} {% if commit.url %}([{{ commit.id | truncate(length=7, end="") }}]({{ commit.url }})){% else %}({{ commit.id | truncate(length=7, end="") }}){% endif %}\
-{% endfor %}\n
-{% endfor %}
-"""
-trim = true
-footer = """
-<!-- generated by git-cliff -->
-"""
-
-[git]
-conventional_commits = true
-filter_unconventional = true
-split_commits = false
-commit_preprocessors = [
-	{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/vrdons/zKitap2Pdf/pull/${2}))" },
-]
-commit_parsers = [
-	{ message = "^feat", group = "Features" },
-	{ message = "^fix", group = "Bug Fixes" },
-	{ message = "^doc", group = "Documentation" },
-	{ message = "^perf", group = "Performance" },
-	{ message = "^refactor", group = "Refactor" },
-	{ message = "^style", group = "Styling" },
-	{ message = "^test", group = "Testing" },
-	{ message = "^chore\\(release\\): prepare for", skip = true },
-	{ message = "^chore", group = "Miscellaneous Tasks" },
-	{ body = ".*security", group = "Security" },
-
-	{ message = "^deps|^build", group = "Dependencies" },
-	{ message = "^Merge pull request", group = "Pull Requests" },
-	{ message = "^Merge branch", group = "Merges" },
-	{ message = "^Revert", group = "Reverts" },
-]

package/dist/context.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: Object.getOwnPropertyDescriptor(all, name).get
-    });
-}
-_export(exports, {
-    get clearClient () {
-        return clearClient;
-    },
-    get currentClient () {
-        return currentClient;
-    },
-    get setClient () {
-        return setClient;
-    }
-});
-let currentClient = null;
-function setClient(client) {
-    currentClient = client;
-}
-function clearClient() {
-    currentClient = null;
-}

package/dist/events/interaction.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-const _discord = require("discord.js");
-const _structures = require("#structures");
-new _structures.EventBuilder(_discord.Events.InteractionCreate, false).onExecute(async function(context, interaction) {
-    if (!interaction.isChatInputCommand()) return;
-    const command = context.client.commands.get(interaction.commandName);
-    if (!command || !command.supportsSlash) {
-        await interaction.reply({
-            content: "Command not found or disabled.",
-            flags: _discord.MessageFlags.Ephemeral
-        });
-        return;
-    }
-    try {
-        const ctx = new _structures.Context(context.client, {
-            interaction
-        });
-        ctx.locale = interaction.locale;
-        context.logger.debug(`${ctx.author?.tag ?? "Unknown"} used ${command.name}(interaction)`);
-        if (command._onInteraction) await command._onInteraction(ctx.toJSON());
-    } catch (error) {
-        context.client.logger.error(`Error executing command ${command.name}:`, error);
-        if (interaction.replied || interaction.deferred) {
-            await interaction.followUp({
-                content: "There was an error while executing this command!",
-                flags: _discord.MessageFlags.Ephemeral
-            });
-        } else {
-            await interaction.reply({
-                content: "There was an error while executing this command!",
-                flags: _discord.MessageFlags.Ephemeral
-            });
-        }
-    }
-});

package/dist/events/message.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-const _discord = require("discord.js");
-const _structures = require("#structures");
-const _utils = require("#utils");
-new _structures.EventBuilder(_discord.Events.MessageCreate, false, async function(context, message) {
-    if (message.author.bot) return;
-    const prefix = context.client.prefix;
-    if (typeof prefix !== "string" || prefix.length === 0 || !message.content.startsWith(prefix)) return;
-    const args = message.content.slice(prefix.length).trim().split(/ +/);
-    const commandName = args.shift()?.toLowerCase();
-    if (!commandName) return;
-    const commandAlias = context.client.aliases.findKey((cmd)=>cmd.has(commandName));
-    let command = context.client.commands.get(commandAlias ?? commandName);
-    if (!command || !command.supportsPrefix) {
-        await message.reply({
-            content: "Command not found or disabled.",
-            allowedMentions: {
-                repliedUser: false
-            }
-        }).then(_utils.deleteMessageAfterSent);
-        return;
-    }
-    try {
-        const ctx = new _structures.Context(context.client, {
-            message,
-            args
-        });
-        context.logger.debug(`${ctx.author?.tag ?? "Unknown"} used ${command.name}(message)`);
-        if (command._onMessage) await command._onMessage(ctx.toJSON());
-    } catch (error) {
-        context.client.logger.error(`Error executing command ${command.name}:`, error);
-    }
-});

package/dist/events/ready.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-const _discord = require("discord.js");
-const _structures = require("#structures");
-new _structures.EventBuilder(_discord.Events.ClientReady).onExecute(async function(context) {
-    if (context.client.options.autoRegisterCommands) {
-        await context.client.registerCommands();
-    }
-});

package/dist/structures/builder/Argument.d.ts

@@ -1,22 +0,0 @@
-import { ApplicationCommandOptionData, ApplicationCommandOptionType } from "discord.js";
-export declare class Argument {
-    readonly name: string;
-    readonly description: string;
-    readonly type: ApplicationCommandOptionType;
-    readonly required: boolean;
-    readonly choices?: {
-        name: string;
-        value: string | number;
-    }[];
-    constructor(data: {
-        name: string;
-        description: string;
-        type: ApplicationCommandOptionType;
-        required?: boolean;
-        choices?: {
-            name: string;
-            value: string | number;
-        }[];
-    });
-    toJSON(): ApplicationCommandOptionData;
-}

package/dist/structures/builder/Argument.js

@@ -1,42 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "Argument", {
-    enumerable: true,
-    get: function() {
-        return Argument;
-    }
-});
-const _discord = require("discord.js");
-class Argument {
-    name;
-    description;
-    type;
-    required;
-    choices;
-    constructor(data){
-        this.name = data.name;
-        this.description = data.description;
-        this.type = data.type;
-        this.required = data.required ?? false;
-        this.choices = data.choices;
-    }
-    toJSON() {
-        const choicesAllowedTypes = [
-            _discord.ApplicationCommandOptionType.String,
-            _discord.ApplicationCommandOptionType.Integer,
-            _discord.ApplicationCommandOptionType.Number
-        ];
-        if (this.choices && !choicesAllowedTypes.includes(this.type)) {
-            throw new Error(`Choices are not allowed for option type ${_discord.ApplicationCommandOptionType[this.type]} (${this.type})`);
-        }
-        return {
-            name: this.name,
-            description: this.description,
-            type: this.type,
-            required: this.required,
-            choices: this.choices
-        };
-    }
-}

package/dist/structures/builder/Command.js

@@ -1,74 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "CommandBuilder", {
-    enumerable: true,
-    get: function() {
-        return CommandBuilder;
-    }
-});
-const _Argument = require("./Argument");
-const _ctx = require("#ctx");
-class CommandBuilder {
-    client;
-    logger;
-    name;
-    description;
-    aliases;
-    options;
-    _supportsSlash;
-    _supportsPrefix;
-    _onMessage;
-    _onInteraction;
-    get supportsSlash() {
-        return this._supportsSlash && this._onInteraction;
-    }
-    get supportsPrefix() {
-        return this._supportsPrefix && this._onMessage;
-    }
-    constructor(options){
-        const client = _ctx.currentClient;
-        if (!client) throw new Error("Client is not defined");
-        this.client = client;
-        this.logger = client.logger;
-        this.name = options.name;
-        this.description = options.description;
-        this.aliases = options.aliases ?? [];
-        this.options = (options.options ?? []).map((opt)=>{
-            return opt instanceof _Argument.Argument ? opt.toJSON() : opt;
-        });
-        this._supportsPrefix = options.prefix ?? false;
-        this._supportsSlash = options.slash ?? false;
-        if (!this._supportsPrefix && !this._supportsSlash) {
-            throw new Error(`Command ${this.name} must support either slash or prefix commands.`);
-        }
-        if (this.client.commands.has(this.name)) throw new Error(`Command name "${this.name}" is already registered.`);
-        const existingAliasOwner = this.client.aliases.findKey((aliases)=>aliases.has(this.name));
-        if (existingAliasOwner) {
-            throw new Error(`Command name "${this.name}" is already registered as an alias for command "${existingAliasOwner}".`);
-        }
-        for (const alias of this.aliases){
-            if (this.client.commands.has(alias)) {
-                throw new Error(`Alias "${alias}" is already registered as a command name.`);
-            }
-            const conflictingCommand = this.client.aliases.findKey((aliases)=>aliases.has(alias));
-            if (conflictingCommand) {
-                throw new Error(`Alias "${alias}" is already registered as an alias for command "${conflictingCommand}".`);
-            }
-        }
-        this.client.commands.set(this.name, this);
-        if (this.aliases.length > 0) {
-            this.client.aliases.set(this.name, new Set(this.aliases));
-        }
-        this.logger.debug(`Loaded Command ${this.name}`);
-    }
-    onMessage(func) {
-        this._onMessage = func;
-        return this;
-    }
-    onInteraction(func) {
-        this._onInteraction = func;
-        return this;
-    }
-}

package/dist/structures/builder/Context.js

@@ -1,67 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "Context", {
-    enumerable: true,
-    get: function() {
-        return Context;
-    }
-});
-const _discord = require("discord.js");
-class Context {
-    client;
-    args;
-    data;
-    locale;
-    constructor(client, payload){
-        this.client = client;
-        this.args = payload.args ?? [];
-        if ("interaction" in payload) {
-            this.data = payload.interaction;
-        } else {
-            this.data = payload.message;
-        }
-    }
-    isInteraction() {
-        return this.data instanceof _discord.ChatInputCommandInteraction;
-    }
-    isMessage() {
-        return this.data instanceof _discord.Message;
-    }
-    get author() {
-        if (this.isInteraction()) {
-            return this.data.user;
-        }
-        if (this.isMessage()) {
-            return this.data.author;
-        }
-        return null;
-    }
-    t(key, args) {
-        if (!this.client.i18n) {
-            throw new Error("i18n is not initialized");
-        }
-        let locale = this.locale ?? (Array.isArray(this.client.i18n.options.fallbackLng) ? this.client.i18n.options.fallbackLng[0] : this.client.i18n.options.fallbackLng) ?? "en";
-        const t = this.client.i18n.getFixedT(locale);
-        return t(key, args);
-    }
-    toJSON() {
-        const { data, args, author } = this;
-        if (this.isInteraction()) {
-            return {
-                kind: "interaction",
-                interaction: data,
-                author,
-                t: this.t.bind(this)
-            };
-        }
-        return {
-            kind: "message",
-            message: data,
-            args,
-            author,
-            t: this.t.bind(this)
-        };
-    }
-}

package/dist/structures/builder/Event.js

@@ -1,53 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "EventBuilder", {
-    enumerable: true,
-    get: function() {
-        return EventBuilder;
-    }
-});
-const _ctx = require("#ctx");
-class EventBuilder {
-    name;
-    once;
-    client;
-    logger;
-    handler;
-    bound = false;
-    listener = async (...args)=>{
-        if (!this.handler) return;
-        try {
-            await this.handler(this, ...args);
-        } catch (error) {
-            this.client.logger.error(`Error executing event ${this.name} (${this.constructor.name}):`, error);
-        }
-    };
-    constructor(name, once = false, _handler){
-        this.name = name;
-        this.once = once;
-        if (!_ctx.currentClient) throw new Error("Client is not defined");
-        this.client = _ctx.currentClient;
-        this.logger = _ctx.currentClient.logger;
-        if (_handler) {
-            this.handler = _handler;
-            this.register();
-        }
-    }
-    register() {
-        if (this.bound || !this.handler) return;
-        if (this.once) {
-            this.client.once(this.name, this.listener);
-        } else {
-            this.client.on(this.name, this.listener);
-        }
-        this.bound = true;
-        this.logger.debug(`Loaded Event ${String(this.name)}`);
-    }
-    onExecute(func) {
-        this.handler = func;
-        this.register();
-        return this;
-    }
-}

package/dist/structures/builder/index.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-const _export_star = require("@swc/helpers/_/_export_star");
-_export_star._(require("./Argument"), exports);
-_export_star._(require("./Command"), exports);
-_export_star._(require("./Context"), exports);
-_export_star._(require("./Event"), exports);