Spraxium

https://spraxium.com/docs
Admin
Spraxium is a TypeScript framework for building Discord bots with enterprise-grade architecture,...
Tokens:2,880
Snippets:47
Trust Score:2.3
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install @spraxium/i18n

Source: https://spraxium.com

Install the @spraxium/i18n package using pnpm. This package simplifies multi-language bot development.

```bash
pnpm add @spraxium/i18n
```

--------------------------------

### Install @spraxium/http

Source: https://spraxium.com

Install the @spraxium/http package using pnpm. This package provides a full HTTP server for your bot.

```bash
pnpm add @spraxium/http
```

--------------------------------

### Install @spraxium/webhook

Source: https://spraxium.com

Install the @spraxium/webhook package using pnpm. This package offers a first-class Discord webhook implementation.

```bash
pnpm add @spraxium/webhook
```

--------------------------------

### Install @spraxium/env

Source: https://spraxium.com

Install the @spraxium/env package using pnpm. This package allows you to declare your environment as a typed schema.

```bash
pnpm add @spraxium/env
```

--------------------------------

### Initialize Spraxium Application and Load Module

Source: https://spraxium.com

This TypeScript code snippet demonstrates the main entry point for a Spraxium application. It initializes the Spraxium factory, loads the application module, sets up environment variables, configures intents, and starts the application listener.

```typescript
import { IntentPreset, SpraxiumFactory } from '@spraxium/core';
import { EnvValidator } from '@spraxium/env';
import { Logger } from '@spraxium/logger';
import { AppEnv } from './app.env';
import { AppModule } from './app.module';

async function main() {
  const logger = new Logger('Main');
  const environment = EnvValidator.validate(AppEnv);

  const app = await SpraxiumFactory.create({ token: environment.token });
  app.useModule(AppModule);
  app.provide(AppEnv, environment);
  app.intents(IntentPreset.Standard);

  logger.info('Starting application...');
  await app.listen();
}

main();
```

--------------------------------

### Install @spraxium/signal-client

Source: https://spraxium.com

Install the @spraxium/signal-client package using pnpm. This package is the emitter side of Signal for delivering signed event envelopes.

```bash
pnpm add @spraxium/signal-client
```

--------------------------------

### Install @spraxium/signal

Source: https://spraxium.com

Install the @spraxium/signal package using pnpm. This package turns Discord webhooks into a typed, HMAC-signed event bus.

```bash
pnpm add @spraxium/signal
```

--------------------------------

### Install @spraxium/logger

Source: https://spraxium.com

Install the @spraxium/logger package using pnpm. This package provides structured logging with ANSI-native output.

```bash
pnpm add @spraxium/logger
```

--------------------------------

### Install @spraxium/schedule

Source: https://spraxium.com

Install the @spraxium/schedule package using pnpm. This package enables running cron and interval jobs with full lifecycle awareness.

```bash
pnpm add @spraxium/schedule
```

--------------------------------

### Register and Handle Discord Slash Command with discord.js

Source: https://spraxium.com

This example shows how to register a slash command ('ban') with Discord using discord.js and then handle the interaction at runtime. It includes permission checks, user option retrieval, and member banning. Note that registration and runtime handling are decoupled, and permission logic is repeated.

```javascript
// 1. Register the slash command with Discord
const { REST, Routes, SlashCommandBuilder } = require('discord.js');

const command = new SlashCommandBuilder()
  .setName('ban')
  .setDescription('Ban a member from the server.')
  .addUserOption(opt =>
    opt.setName('user').setDescription('Target').setRequired(true))
  .addStringOption(opt =>
    opt.setName('reason').setDescription('Reason'));

const rest = new REST().setToken(process.env.DISCORD_TOKEN);
await rest.put(Routes.applicationCommands(CLIENT_ID), {
  body: [command.toJSON()],
});

// 2. Handle the interaction at runtime
client.on('interactionCreate', async (interaction) => {
  if (!interaction.isChatInputCommand()) return;
  if (interaction.commandName !== 'ban') return;

  if (!interaction.memberPermissions?.has('BanMembers')) {
    return interaction.reply({ content: 'No permission.', flags: 'Ephemeral' });
  }

  const target = interaction.options.getUser('user', true);
  const reason = interaction.options.getString('reason') ?? 'No reason';
  const member = interaction.guild?.members.cache.get(target.id);

  if (!member) {
    return interaction.reply({ content: 'User not found.', flags: 'Ephemeral' });
  }

  await member.ban({ reason });
  await interaction.reply(`Banned ${target.tag}.`);
});
```

--------------------------------

### Declare BanConfirmButton

Source: https://spraxium.com

Example of declaring a Discord button component using the @Button decorator. This button has a danger style and a confirmation label.

```typescript
import { Button, LinkButton } from '@spraxium/components';

@Button({
 customId: 'mod:ban-confirm',
 label: 'Confirm Ban',
 style: 'danger',
 emoji: '🔨',
})
export class BanConfirmButton {}

@Button({
 customId: 'mod:ban-cancel',
 label: 'Cancel',
 style: 'secondary',
})
export class BanCancelButton {}

@LinkButton({
 label: 'View User',
 url: 'https://discord.com/users/...',
 emoji: '🔗',
})
export class ViewUserButton {}
```

--------------------------------

### Create a New Spraxium Bot Project

Source: https://spraxium.com

Use this command to initialize a new Discord bot project with the Spraxium framework. It sets up the basic project structure and configuration.

```bash
$npx @spraxium/cli new my-bot
```

--------------------------------

### Spraxium CLI for Prisma Integration

Source: https://spraxium.com

Use the Spraxium CLI to scaffold Prisma integration. This command generates a fully typed Prisma client, wires the module provider, and scaffolds migrations.

```bash
$spraxium database prisma
```

--------------------------------

### Spraxium CLI for MongoDB Integration

Source: https://spraxium.com

Use the Spraxium CLI to scaffold MongoDB integration. This command bootstraps schemas, models, and a Mongoose connection module.

```bash
$spraxium database mongodb
```

--------------------------------

### Spraxium CLI for TypeORM Integration

Source: https://spraxium.com

Use the Spraxium CLI to scaffold TypeORM integration. This command scaffolds entities, repositories, and a DataSource provider configured from your environment variables.

```bash
$spraxium database typeorm
```

--------------------------------

### Define Ban Command with Options

Source: https://spraxium.com

Defines a slash command for banning members, specifying user and reason options with their descriptions and required status. Permissions are set at the command level.

```typescript
import { SlashCommand, SlashOption } from '@spraxium/common';
import { PermissionFlagsBits } from 'discord.js';

@SlashCommand({
 name: 'ban',
 description: 'Ban a member from the server.',
 defaultMemberPermissions: PermissionFlagsBits.BanMembers,
})
export class BanCommand {
 @SlashOption.User('target', {
 description: 'The member to ban',
 required: true,
 })
 @SlashOption.String('reason', {
 description: 'Reason for the ban',
 required: false,
 })
 build() {}
}
```

--------------------------------

### Spraxium CLI for Drizzle ORM Integration

Source: https://spraxium.com

Use the Spraxium CLI to scaffold Drizzle ORM integration. This command generates a strongly typed Drizzle schema, database adapter, and module provider.

```bash
$spraxium database drizzle
```

--------------------------------

### Define Modal Fields with Decorators

Source: https://spraxium.com

Define modal fields using class property decorators. Validators run before the handler is called. Use @ModalCache to keep responses alive across interactions.

```typescript
import {
 ModalCache,
 ModalComponent,
 ModalInput,
 ModalValidate,
 minWords,
 minLength,
} from '@spraxium/components';

@ModalCache({ ttl: 300 })
@ModalComponent({ id: 'report', title: 'Report an issue' })
export class ReportModal {
 @ModalValidate([minWords(5)])
 @ModalInput({
 label: 'What happened?',
 style: 'paragraph',
 required: true,
 maxLength: 1000,
 })
 description!: string;

 @ModalValidate([minLength(3)])
 @ModalInput({
 label: 'Evidence link',
 placeholder: 'https://…',
 })
 evidence!: string;
}
```
Tokens:
Raw