@arox/framework 0.1.2-beta.1 → 0.1.2-beta.2

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

@@ -1,12 +1,11 @@
 import { SlashCommandBuilder, RESTPostAPIChatInputApplicationCommandsJSONBody } from "discord.js";
-import { Client } from "../core";
+import { Client } from "../core/index.js";
 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[];

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

@@ -1,21 +1,32 @@
-import { ChatInputCommandInteraction, Message } from "discord.js";
-import { Context, Client } from "../index";
-import { MaybePromise } from "#types/extra.js";
-import { Logger } from "../../utils/index";
-import { ApplicationCommandBuilder } from "./Builder";
-type MessageContext = NonNullable<ReturnType<Context<Message>["toJSON"]>>;
-type InteractionContext = NonNullable<ReturnType<Context<ChatInputCommandInteraction>["toJSON"]>>;
+import { Client } from "../index.js";
+import { Logger } from "../../utils/index.js";
+import type { MaybePromise } from "#types/extra.js";
+import { ApplicationCommandBuilder } from "../builder/Builder.js";
+import type { InteractionContextJSON, MessageContextJSON } from "../builder/Context.js";
+type MessageContext = MessageContextJSON;
+type InteractionContext = InteractionContextJSON;
+type CommandContext = MessageContext | InteractionContext;
 export declare class CommandBuilder {
     #private;
     readonly data: ApplicationCommandBuilder;
-    readonly client: Client;
-    readonly logger: Logger;
     _onMessage?: (ctx: MessageContext) => MaybePromise<void>;
     _onInteraction?: (ctx: InteractionContext) => MaybePromise<void>;
+    get client(): Client;
+    get logger(): Logger;
     get supportsSlash(): false | ((ctx: InteractionContext) => MaybePromise<void>) | undefined;
     get supportsPrefix(): false | ((ctx: MessageContext) => MaybePromise<void>) | undefined;
     constructor(data: ApplicationCommandBuilder);
+    attach(client: Client): this;
     onMessage(func: (ctx: MessageContext) => MaybePromise<void>): this;
     onInteraction(func: (ctx: InteractionContext) => MaybePromise<void>): this;
 }
+export interface CommandOptions {
+    data: ApplicationCommandBuilder;
+    execute?: (ctx: CommandContext) => MaybePromise<void>;
+    onMessage?: (ctx: MessageContext) => MaybePromise<void>;
+    onInteraction?: (ctx: InteractionContext) => MaybePromise<void>;
+}
+export declare class Command extends CommandBuilder {
+    constructor(options: CommandOptions);
+}
 export {};

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

@@ -1,6 +1,6 @@
-import { Message, User, ChatInputCommandInteraction, Locale } from "discord.js";
-import { Client } from "../index";
-import { TOptions } from "i18next";
+import { ChatInputCommandInteraction, Locale, Message, User } from "discord.js";
+import type { TOptions } from "i18next";
+import type { Client } from "../index.js";
 type ContextPayload<T extends ChatInputCommandInteraction | Message> = T extends ChatInputCommandInteraction ? {
     interaction: T;
     args?: string[];
@@ -8,6 +8,22 @@ type ContextPayload<T extends ChatInputCommandInteraction | Message> = T extends
     message: T;
     args?: string[];
 };
+type TranslateFn = (key: string, options?: TOptions & {
+    defaultValue?: string;
+}) => string;
+export interface InteractionContextJSON {
+    kind: "interaction";
+    interaction: ChatInputCommandInteraction;
+    author: User | null;
+    t: TranslateFn;
+}
+export interface MessageContextJSON {
+    kind: "message";
+    message: Message;
+    args: string[];
+    author: User | null;
+    t: TranslateFn;
+}
 export declare class Context<T extends ChatInputCommandInteraction | Message> {
     readonly client: Client;
     readonly args: string[];
@@ -20,20 +36,7 @@ export declare class Context<T extends ChatInputCommandInteraction | Message> {
     t(key: string, options?: TOptions & {
         defaultValue?: string;
     }): string;
-    toJSON(): {
-        kind: "interaction";
-        interaction: T;
-        author: User | null;
-        t: any;
-        message?: undefined;
-        args?: undefined;
-    } | {
-        kind: "message";
-        message: Message;
-        args: string[];
-        author: User | null;
-        t: any;
-        interaction?: undefined;
-    };
+    toJSON(this: Context<ChatInputCommandInteraction>): InteractionContextJSON;
+    toJSON(this: Context<Message>): MessageContextJSON;
 }
 export {};

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

@@ -1,16 +1,17 @@
 import { ClientEvents } from "discord.js";
-import { MaybePromise } from "#types/extra.js";
-import { Client } from "../index";
-import { Logger } from "../../utils/index";
+import type { MaybePromise } from "#types/extra.js";
+import { Client } from "../index.js";
+import { Logger } from "../../utils/index.js";
 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;
+    get client(): Client;
+    get logger(): Logger;
     constructor(name: K, once?: boolean, _handler?: EventHandler<K>);
+    attach(client: Client): this;
     onExecute(func: EventHandler<K>): this;
 }
 export {};

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

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

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

@@ -1,14 +1,14 @@
 import { Client as DiscordClient, Collection, IntentsBitField } from "discord.js";
-import { CommandBuilder } from "../index";
-import { Logger } from "../../utils";
-import { FrameworkOptions } from "#types/client.js";
-import { i18n } from "i18next";
+import type { i18n } from "i18next";
+import type { FrameworkOptions, PrefixFn } from "#types/client.js";
+import { Logger } from "../../utils/index.js";
+import { CommandBuilder } from "../index.js";
 export declare class Client<Ready extends boolean = boolean> extends DiscordClient<Ready> {
     #private;
     readonly logger: Logger;
     commands: Collection<string, CommandBuilder>;
     aliases: Collection<string, Set<string>>;
-    readonly prefix: string | false;
+    readonly prefix: PrefixFn;
     i18n: i18n | undefined;
     options: Omit<FrameworkOptions, "intents"> & {
         intents: IntentsBitField;

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

@@ -1 +1 @@
-export * from "./Client";
+export * from "./Client.js";

package/dist/structures/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./core";
-export * from "./builder";
+export * from "./core/index.js";
+export * from "./builder/index.js";

package/dist/utils/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./util";
-export * from "./Files";
-export * from "./logger/Logger";
+export * from "./util.js";
+export * from "./Files.js";
+export * from "./logger/Logger.js";

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

@@ -31,46 +31,4 @@ export declare enum LogLevel {
      */
     None = 100
 }
-export interface ILogger {
-    /**
-     * Checks whether a level is supported.
-     * @param level The level to check.
-     */
-    has(level: LogLevel): boolean;
-    /**
-     * Alias of {@link ILogger.write} with {@link LogLevel.Trace} as level.
-     * @param values The values to log.
-     */
-    trace(...values: readonly unknown[]): void;
-    /**
-     * Alias of {@link ILogger.write} with {@link LogLevel.Debug} as level.
-     * @param values The values to log.
-     */
-    debug(...values: readonly unknown[]): void;
-    /**
-     * Alias of {@link ILogger.write} with {@link LogLevel.Info} as level.
-     * @param values The values to log.
-     */
-    info(...values: readonly unknown[]): void;
-    /**
-     * Alias of {@link ILogger.write} with {@link LogLevel.Warn} as level.
-     * @param values The values to log.
-     */
-    warn(...values: readonly unknown[]): void;
-    /**
-     * Alias of {@link ILogger.write} with {@link LogLevel.Error} as level.
-     * @param values The values to log.
-     */
-    error(...values: readonly unknown[]): void;
-    /**
-     * Alias of {@link ILogger.write} with {@link LogLevel.Fatal} as level.
-     * @param values The values to log.
-     */
-    fatal(...values: readonly unknown[]): void;
-    /**
-     * Writes the log message given a level and the value(s).
-     * @param level The log level.
-     * @param values The values to log.
-     */
-    write(level: LogLevel, ...values: readonly unknown[]): void;
-}
+export type { ILogger } from "#types/logger.js";

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

@@ -1,10 +1,12 @@
 import { Console } from "console";
 import type { Color } from "colorette";
 import { Timestamp } from "@sapphire/timestamp";
-import type { ILogger } from "./ILogger";
-import { LogLevel } from "./ILogger";
-import { LoggerModule } from "i18next";
-export { LogLevel } from "./ILogger";
+import type { ILogger } from "./ILogger.js";
+import { LogLevel } from "./ILogger.js";
+import type { LoggerLevelOptions, LoggerOptions, LoggerStyleResolvable, LoggerTimestampFormatter, LoggerTimestampOptions } from "#types/logger.js";
+import type { LoggerModule } from "i18next";
+export { LogLevel } from "./ILogger.js";
+export type { LoggerFormatOptions, LoggerLevelOptions, LoggerOptions, LoggerStyleOptions, LoggerStyleResolvable, LoggerTimestampFormatter, LoggerTimestampOptions, } from "#types/logger.js";
 export declare class Logger implements ILogger {
     level: LogLevel;
     readonly formats: Map<LogLevel, LoggerLevel>;
@@ -57,44 +59,6 @@ export declare class LoggerLevel {
 }
 declare const _default: Logger;
 export default _default;
-export interface LoggerOptions {
-    stdout?: NodeJS.WritableStream;
-    stderr?: NodeJS.WritableStream;
-    defaultFormat?: LoggerLevelOptions;
-    format?: LoggerFormatOptions;
-    level?: LogLevel;
-    join?: string;
-    depth?: number;
-}
-export interface LoggerFormatOptions {
-    trace?: LoggerLevelOptions;
-    debug?: LoggerLevelOptions;
-    info?: LoggerLevelOptions;
-    warn?: LoggerLevelOptions;
-    error?: LoggerLevelOptions;
-    fatal?: LoggerLevelOptions;
-    none?: LoggerLevelOptions;
-}
-export interface LoggerLevelOptions {
-    timestamp?: LoggerTimestampOptions | null;
-    infix?: string;
-    message?: LoggerStyleResolvable | null;
-}
-export interface LoggerTimestampOptions {
-    pattern?: string;
-    utc?: boolean;
-    color?: LoggerStyleResolvable | null;
-    formatter?: LoggerTimestampFormatter;
-}
-export interface LoggerTimestampFormatter {
-    (timestamp: string): string;
-}
-export interface LoggerStyleOptions {
-    effects?: LoggerStyleEffect[];
-    text?: LoggerStyleText;
-    background?: LoggerStyleBackground;
-}
-export type LoggerStyleResolvable = Color | LoggerStyleOptions;
 export declare enum LoggerStyleEffect {
     Reset = "reset",
     Bold = "bold",

package/dist/utils/util.d.ts

@@ -1,4 +1,6 @@
-import { PrefixOptions } from "#types/client.js";
-import { InteractionResponse, Message } from "discord.js";
+import { ChatInputCommandInteraction, InteractionResponse, Locale, Message } from "discord.js";
+import type { Context } from "../structures/index.js";
+export declare const allowedLocales: readonly ["id", "en-US", "en-GB", "bg", "zh-CN", "zh-TW", "hr", "cs", "da", "nl", "fi", "fr", "de", "el", "hi", "hu", "it", "ja", "ko", "lt", "no", "pl", "pt-BR", "ro", "ru", "es-ES", "es-419", "sv-SE", "th", "tr", "uk", "vi"];
 export declare function deleteMessageAfterSent(message: Message | InteractionResponse, time?: number): Promise<void>;
-export declare function getPrefix(opts: PrefixOptions): string | false;
+export declare function toAllowedLocale(locale: string | null | undefined): `${Locale}` | undefined;
+export declare function getDefaultLang(ctx: Context<ChatInputCommandInteraction | Message>): `${Locale}`;

package/package.json

@@ -1 +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"}}
+{"name":"@arox/framework","version":"0.1.2-beta.2","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":"module","main":"dist/index.cjs","module":"dist/index.js","types":"dist/index.d.ts","imports":{"#types/*":"./types/*.d.ts"},"exports":{".":{"types":"./dist/index.d.ts","require":{"types":"./dist/index.d.cts","default":"./dist/index.cjs"},"import":{"types":"./dist/index.d.ts","default":"./dist/index.js"},"default":"./dist/index.js"}},"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/types/client.d.ts

@@ -1,21 +1,22 @@
-import { ClientOptions } from "discord.js";
-import { LoggerOptions } from "../src/utils/logger/Logger";
+import {
+	ChatInputCommandInteraction,
+	ClientOptions,
+	Locale,
+	Message,
+} from "discord.js";
+import type { LoggerOptions } from "./logger.js";
 import { i18n } from "i18next";
+import type { Context } from "../src/structures/builder/Context.js";
 
-export interface FrameworkPaths {
-	events?: string;
-	commands?: string;
-	locales?: string;
-}
-
-export type PrefixOptions =
-	| { enabled: true; prefix: string }
-	| { enabled: false }
-	| string;
+export type PrefixFn = (ctx: Context<Message>) => string | false;
+export type GetDefaultLangFn = (
+	ctx: Context<ChatInputCommandInteraction | Message>
+) => `${Locale}` | undefined;
 
 export interface FrameworkOptions extends ClientOptions {
 	logger?: LoggerOptions;
-	prefix?: PrefixOptions;
+	prefix?: PrefixFn;
+	getDefaultLang?: GetDefaultLangFn;
 	autoRegisterCommands?: boolean;
 	includePaths: string[];
 	i18n?: i18n;

package/types/logger.d.ts

@@ -0,0 +1,63 @@
+import type { Color } from "colorette";
+import type { LogLevel } from "../src/utils/logger/ILogger.js";
+import type {
+	LoggerStyleBackground,
+	LoggerStyleEffect,
+	LoggerStyleText,
+} from "../src/utils/logger/Logger.js";
+
+export interface ILogger {
+	has(level: LogLevel): boolean;
+	trace(...values: readonly unknown[]): void;
+	debug(...values: readonly unknown[]): void;
+	info(...values: readonly unknown[]): void;
+	warn(...values: readonly unknown[]): void;
+	error(...values: readonly unknown[]): void;
+	fatal(...values: readonly unknown[]): void;
+	write(level: LogLevel, ...values: readonly unknown[]): void;
+}
+
+export interface LoggerOptions {
+	stdout?: NodeJS.WritableStream;
+	stderr?: NodeJS.WritableStream;
+	defaultFormat?: LoggerLevelOptions;
+	format?: LoggerFormatOptions;
+	level?: LogLevel;
+	join?: string;
+	depth?: number;
+}
+
+export interface LoggerFormatOptions {
+	trace?: LoggerLevelOptions;
+	debug?: LoggerLevelOptions;
+	info?: LoggerLevelOptions;
+	warn?: LoggerLevelOptions;
+	error?: LoggerLevelOptions;
+	fatal?: LoggerLevelOptions;
+	none?: LoggerLevelOptions;
+}
+
+export interface LoggerLevelOptions {
+	timestamp?: LoggerTimestampOptions | null;
+	infix?: string;
+	message?: LoggerStyleResolvable | null;
+}
+
+export interface LoggerTimestampOptions {
+	pattern?: string;
+	utc?: boolean;
+	color?: LoggerStyleResolvable | null;
+	formatter?: LoggerTimestampFormatter;
+}
+
+export interface LoggerTimestampFormatter {
+	(timestamp: string): string;
+}
+
+export interface LoggerStyleOptions {
+	effects?: LoggerStyleEffect[];
+	text?: LoggerStyleText;
+	background?: LoggerStyleBackground;
+}
+
+export type LoggerStyleResolvable = Color | LoggerStyleOptions;

package/dist/context.d.ts

@@ -1,4 +0,0 @@
-import { Client } from "./structures";
-export declare let currentClient: Client | null;
-export declare function setClient(client: Client): void;
-export declare function clearClient(): void;