@wolfstar/create-http-framework 2.1.4 → 2.2.0-next-20260831123711

package/template/features/subcommands-i18n/src/commands/math.ts.hbs

@@ -0,0 +1,43 @@
+import { Command, RegisterCommand, RegisterSubcommand } from '@wolfstar/http-framework';
+import { applyLocalizedBuilder, getSupportedUserLanguageT } from '@wolfstar/plugin-i18next';
+import { ApplicationIntegrationType, InteractionContextType } from 'discord-api-types/v10';
+
+@RegisterCommand((builder) =>
+	applyLocalizedBuilder(builder, 'commands/math:name', 'commands/math:description') //
+		.setIntegrationTypes(ApplicationIntegrationType.GuildInstall, ApplicationIntegrationType.UserInstall)
+		.setContexts(InteractionContextType.Guild, InteractionContextType.BotDM, InteractionContextType.PrivateChannel)
+)
+export class MathCommand extends Command {
+	@RegisterSubcommand((builder) =>
+		applyLocalizedBuilder(builder, 'commands/math:addName', 'commands/math:addDescription') //
+			.addIntegerOption((option) =>
+				applyLocalizedBuilder(option, 'commands/math:optionsLeftName', 'commands/math:optionsLeftDescription').setRequired(true)
+			)
+			.addIntegerOption((option) =>
+				applyLocalizedBuilder(option, 'commands/math:optionsRightName', 'commands/math:optionsRightDescription').setRequired(true)
+			)
+	)
+	public add(interaction: Command.ChatInputInteraction, { left, right }: MathOptions) {
+		const t = getSupportedUserLanguageT(interaction);
+		return interaction.reply({ content: t('commands/math:addResult', { left, right, result: left + right }) });
+	}
+
+	@RegisterSubcommand((builder) =>
+		applyLocalizedBuilder(builder, 'commands/math:subtractName', 'commands/math:subtractDescription') //
+			.addIntegerOption((option) =>
+				applyLocalizedBuilder(option, 'commands/math:optionsLeftName', 'commands/math:optionsLeftDescription').setRequired(true)
+			)
+			.addIntegerOption((option) =>
+				applyLocalizedBuilder(option, 'commands/math:optionsRightName', 'commands/math:optionsRightDescription').setRequired(true)
+			)
+	)
+	public subtract(interaction: Command.ChatInputInteraction, { left, right }: MathOptions) {
+		const t = getSupportedUserLanguageT(interaction);
+		return interaction.reply({ content: t('commands/math:subtractResult', { left, right, result: left - right }) });
+	}
+}
+
+interface MathOptions {
+	left: number;
+	right: number;
+}

package/template/features/subcommands-i18n/src/locales/en-US/commands/math.json

@@ -0,0 +1,14 @@
+{
+	"name": "math",
+	"description": "Perform basic arithmetic",
+	"addName": "add",
+	"addDescription": "Add two numbers",
+	"subtractName": "subtract",
+	"subtractDescription": "Subtract two numbers",
+	"optionsLeftName": "left",
+	"optionsLeftDescription": "The left operand",
+	"optionsRightName": "right",
+	"optionsRightDescription": "The right operand",
+	"addResult": "{{left}} + {{right}} = {{result}}",
+	"subtractResult": "{{left}} - {{right}} = {{result}}"
+}

package/template/features/testing/tests/ping.test.js.hbs

@@ -0,0 +1,33 @@
+import { container } from '@wolfstar/http-framework';
+import { ChatInputApplicationCommandInteractionData, createTestHarness } from '@wolfstar/http-framework-test-utils';
+import { MessageFlags } from 'discord-api-types/v10';
+import { describe, expect, it } from 'vitest';
+import { PingCommand } from '../src/commands/ping.js';
+
+describe('ping command', () => {
+	it('replies with Pong', async () => {
+		const { client, runner } = createTestHarness();
+
+		await container.stores.loadPiece({ name: 'ping', piece: PingCommand, store: 'commands' });
+		await client.load({ baseUserDirectory: null });
+
+		const result = await runner.run({
+			...ChatInputApplicationCommandInteractionData,
+			data: {
+				id: '0',
+				name: 'ping',
+				type: 1,
+				options: []
+			}
+		});
+
+		expect(result).toHaveStatus(200);
+		expect(result.json()).toMatchObject({
+			type: 4,
+			data: {
+				content: 'Pong!',
+				flags: MessageFlags.Ephemeral
+			}
+		});
+	});
+});

package/template/features/testing/tests/ping.test.ts.hbs

@@ -0,0 +1,33 @@
+import { container } from '@wolfstar/http-framework';
+import { ChatInputApplicationCommandInteractionData, createTestHarness } from '@wolfstar/http-framework-test-utils';
+import { MessageFlags } from 'discord-api-types/v10';
+import { describe, expect, it } from 'vitest';
+import { PingCommand } from '../src/commands/ping.js';
+
+describe('ping command', () => {
+	it('replies with Pong', async () => {
+		const { client, runner } = createTestHarness();
+
+		await container.stores.loadPiece({ name: 'ping', piece: PingCommand, store: 'commands' });
+		await client.load({ baseUserDirectory: null });
+
+		const result = await runner.run({
+			...ChatInputApplicationCommandInteractionData,
+			data: {
+				id: '0',
+				name: 'ping',
+				type: 1,
+				options: []
+			}
+		});
+
+		expect(result).toHaveStatus(200);
+		expect(result.json()).toMatchObject({
+			type: 4,
+			data: {
+				content: 'Pong!',
+				flags: MessageFlags.Ephemeral
+			}
+		});
+	});
+});

package/template/features/testing/vitest.config.js.hbs

@@ -0,0 +1,9 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+	test: {
+		globals: true,
+		environment: 'node',
+		setupFiles: ['./vitest.setup.js']
+	}
+});

package/template/features/testing/vitest.config.ts.hbs

@@ -0,0 +1,9 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+	test: {
+		globals: true,
+		environment: 'node',
+		setupFiles: ['./vitest.setup.ts']
+	}
+});

package/template/features/testing/vitest.setup.js.hbs

@@ -0,0 +1,4 @@
+import { httpFrameworkMatchers } from '@wolfstar/http-framework-test-utils/vitest';
+import { expect } from 'vitest';
+
+expect.extend(httpFrameworkMatchers);

package/template/features/testing/vitest.setup.ts.hbs

@@ -0,0 +1,4 @@
+import { httpFrameworkMatchers } from '@wolfstar/http-framework-test-utils/vitest';
+import { expect } from 'vitest';
+
+expect.extend(httpFrameworkMatchers);

package/template/features/testing-i18n/tests/ping.test.js.hbs

@@ -0,0 +1,42 @@
+import '@wolfstar/plugin-i18next/register';
+import { container } from '@wolfstar/http-framework';
+import { ChatInputApplicationCommandInteractionData, createTestHarness } from '@wolfstar/http-framework-test-utils';
+import { MessageFlags } from 'discord-api-types/v10';
+import { describe, expect, it } from 'vitest';
+import { PingCommand } from '../src/commands/ping.js';
+
+describe('ping command', () => {
+	it('replies with Pong', async () => {
+		// The i18n plugin resolves `container.i18n` from `Client`'s `i18n` option, so the harness needs
+		// the same options passed to `new Client()` in `src/main.js` — pointing at the locale files
+		// under `src/locales/`, one directory up from this test file.
+		const { client, runner } = createTestHarness({
+			i18n: {
+				defaultLanguageDirectory: new URL('../src/locales', import.meta.url).pathname,
+				defaultName: 'en-US'
+			}
+		});
+
+		await container.stores.loadPiece({ name: 'ping', piece: PingCommand, store: 'commands' });
+		await client.load({ baseUserDirectory: null });
+
+		const result = await runner.run({
+			...ChatInputApplicationCommandInteractionData,
+			data: {
+				id: '0',
+				name: 'ping',
+				type: 1,
+				options: []
+			}
+		});
+
+		expect(result).toHaveStatus(200);
+		expect(result.json()).toMatchObject({
+			type: 4,
+			data: {
+				content: 'Pong!',
+				flags: MessageFlags.Ephemeral
+			}
+		});
+	});
+});

package/template/features/testing-i18n/tests/ping.test.ts.hbs

@@ -0,0 +1,42 @@
+import '@wolfstar/plugin-i18next/register';
+import { container } from '@wolfstar/http-framework';
+import { ChatInputApplicationCommandInteractionData, createTestHarness } from '@wolfstar/http-framework-test-utils';
+import { MessageFlags } from 'discord-api-types/v10';
+import { describe, expect, it } from 'vitest';
+import { PingCommand } from '../src/commands/ping.js';
+
+describe('ping command', () => {
+	it('replies with Pong', async () => {
+		// The i18n plugin resolves `container.i18n` from `Client`'s `i18n` option, so the harness needs
+		// the same options passed to `new Client()` in `src/main.ts` — pointing at the locale files
+		// under `src/locales/`, one directory up from this test file.
+		const { client, runner } = createTestHarness({
+			i18n: {
+				defaultLanguageDirectory: new URL('../src/locales', import.meta.url).pathname,
+				defaultName: 'en-US'
+			}
+		});
+
+		await container.stores.loadPiece({ name: 'ping', piece: PingCommand, store: 'commands' });
+		await client.load({ baseUserDirectory: null });
+
+		const result = await runner.run({
+			...ChatInputApplicationCommandInteractionData,
+			data: {
+				id: '0',
+				name: 'ping',
+				type: 1,
+				options: []
+			}
+		});
+
+		expect(result).toHaveStatus(200);
+		expect(result.json()).toMatchObject({
+			type: 4,
+			data: {
+				content: 'Pong!',
+				flags: MessageFlags.Ephemeral
+			}
+		});
+	});
+});

package/template/src/commands/ping.js.hbs

@@ -1,12 +0,0 @@
-import { Command } from '@wolfstar/http-framework';
-import { MessageFlags } from 'discord-api-types/v10';
-
-export class PingCommand extends Command {
-	chatInputRun(interaction) {
-		return interaction.reply({ content: 'Pong!', flags: MessageFlags.Ephemeral });
-	}
-
-	static builder = (builder) => builder
-		.setName('ping')
-		.setDescription('Replies with pong!')
-}

package/template/src/index.js.hbs

@@ -1,8 +0,0 @@
-import { Client } from '@wolfstar/http-framework';
-
-const client = new Client();
-
-await client.load();
-await client.listen({ port: {{port}} });
-
-console.log('Bot is running on port {{port}}');

package/template/src/index.ts.hbs

@@ -1,8 +0,0 @@
-import { Client } from '@wolfstar/http-framework';
-
-const client = new Client();
-
-await client.load();
-await client.listen({ port: {{port}} });
-
-console.log('Bot is running on port {{port}}');