refactor!: remove global context, update command/event attachment (#59)

* refactor!: remove global context, update command/event attachment

BREAKING CHANGE: The global context module has been removed. Commands
and events must now access the client and logger via instance properties
after being attached. The `prefix` option is now a function. Update your
usage accordingly.

* refactor(core): limit export factory recursion depth

Add MAX_EXPORT_FACTORY_DEPTH constant and enforce it in registerExport
to prevent infinite recursion when registering export factories. Rename
messages.ts to lang.ts and update imports. Remove unused prefix log and
package.json imports field.

* chore(utils): simplify getDefaultLang return logic

Author: vrdons

.npmignore

@@ -13,5 +13,6 @@ src
 scripts
 tsconfig.json
 .oxfmtrc.json
+.prettierrc
 package-lock.json
-.swcrc
+.swcrc

examples/basic_client/commands/ping.cjs

@@ -0,0 +1,23 @@
+const {
+	Command,
+	ApplicationCommandBuilder,
+} = require("../../../dist/index.cjs");
+
+module.exports = new Command({
+	data: new ApplicationCommandBuilder()
+		.setName("ping")
+		.setDescription("Replies with pong")
+		.setAliases("p")
+		.setPrefixSupport(true)
+		.setSlashSupport(true),
+	onMessage: (ctx) =>
+		ctx.message.reply(
+			ctx.t("test:hello", {
+				user: ctx.message.author.username,
+			})
+		),
+	onInteraction: (ctx) =>
+		ctx.interaction.reply(
+			ctx.t("test:hello", { user: ctx.interaction.user.username })
+		),
+});

examples/basic_client/events/ready.cjs

@@ -0,0 +1,6 @@
+const { EventBuilder } = require("../../../dist/index.cjs");
+
+module.exports = new EventBuilder("clientReady", false, (context) => {
+	context.logger.log("Client connected!");
+	context.logger.warn(`Current user: ${context.client.user.username}`);
+});

examples/basic_client/events/ready.js

@@ -9,7 +9,7 @@ const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
 const myinstance = i18next.createInstance({
-	supportedLngs: ["en-US", "tr"],
+	supportedLngs: ["en-US", "tr"], // Required to be `${Locale}` (LocaleString)
 	fallbackLng: "en-US",
 	defaultNS: "translation",
 	ns: ["translation", "test", "error"],
@@ -28,37 +28,18 @@ const client = new arox.Client({
 		IntentsBitField.Flags.GuildMessages,
 		IntentsBitField.Flags.MessageContent,
 	],
-	prefix: { enabled: true, prefix: "a!" },
+	prefix: () => "a!",
+	includePaths: [
+		path.join(__dirname, "events"),
+		path.join(__dirname, "commands"),
+	],
 	logger: {
 		level: arox.LogLevel.Debug,
 	},
 	autoRegisterCommands: false,
 	i18n: myinstance,
 });
 
-arox.setClient(client);
-const command = new arox.CommandBuilder(
-	new arox.ApplicationCommandBuilder()
-		.setName("arox")
-		.setDescription("Arox Test Command")
-		.addAliases("a")
-);
-arox.clearClient();
-
-command
-	.onMessage(function (ctx) {
-		const { message, t, author } = ctx;
-		void message.reply(
-			t("test:hello", { user: author?.username ?? "Unknown" })
-		);
-	})
-	.onInteraction(function (ctx) {
-		const { interaction, t, author } = ctx;
-		void interaction.reply(
-			t("test:hello", { user: author?.username ?? "Unknown" })
-		);
-	});
-
 async function init() {
 	const token = process.env.DISCORD_TOKEN ?? process.env.BOT_TOKEN;
 	await client.login(token);

examples/basic_client/index.js

@@ -1,4 +1,6 @@
 {
-	"command.notfound": "Command not found or disabled1",
-	"command.disabled": "Command not found or disabled2"
+	"command": {
+		"notfound": "Command not found or disabled1",
+		"disabled": "Command not found or disabled2"
+	}
 }