fluxer.ts 0.1.0 → 0.2.0

package/README.md

@@ -2,10 +2,11 @@
 
 Lightweight, TypeScript-first SDK for building [Fluxer](https://fluxer.gg) bots.
 
-- **Small** — single package, one dependency (`ws`), ~22KB compiled
-- **TypeScript-first** — full type definitions, no `any`
+- **Small** — single package, one dependency (`ws`), ~60KB compiled
+- **TypeScript-first** — 870+ lines of type definitions generated from the Fluxer OpenAPI spec
 - **Simple API** — connect, listen, send — no unnecessary abstractions
 - **Built for Fluxer** — handles Fluxer-specific gateway behavior (guild `properties`, v1 gateway protocol)
+- **Complete** — 94 route builders, 40+ gateway events, 65 convenience methods
 
 ## Install
 
@@ -48,86 +49,261 @@ await client.sendMessage(channelId, 'Hello!');
 // Send with embeds
 await client.sendMessage(channelId, {
   content: 'Check this out',
-  embeds: [{ title: 'My Embed', description: 'Content here', color: 0x7c6fff }],
+  embeds: [{ type: 'rich', title: 'My Embed', description: 'Content here', color: 0x7c6fff }],
 });
 
 // Reply to a message
 await client.replyTo(message, 'Got it!');
 
-// Edit a message
+// Edit / delete
 await client.editMessage(channelId, messageId, 'Updated content');
-
-// Delete a message
 await client.deleteMessage(channelId, messageId);
 
-// React
-await client.react(channelId, messageId, '👍');
+// Bulk delete (2-100 messages)
+await client.bulkDelete(channelId, messageIds);
+
+// Fetch messages
+const messages = await client.fetchMessages(channelId, { limit: 50 });
+const single = await client.fetchMessage(channelId, messageId);
 
 // Typing indicator
 await client.sendTyping(channelId);
 ```
 
+### Reactions
+
+```typescript
+// Add / remove reactions
+await client.react(channelId, messageId, '👍');
+await client.unreact(channelId, messageId, '👍');
+
+// Remove another user's reaction
+await client.removeReaction(channelId, messageId, '👍', userId);
+
+// Remove all reactions
+await client.removeAllReactions(channelId, messageId);
+await client.removeAllReactionsForEmoji(channelId, messageId, '👍');
+
+// Fetch who reacted
+const users = await client.fetchReactions(channelId, messageId, '👍');
+```
+
+### Pins
+
+```typescript
+await client.pinMessage(channelId, messageId);
+await client.unpinMessage(channelId, messageId);
+const pins = await client.fetchPinnedMessages(channelId);
+```
+
 ### Guilds
 
 ```typescript
-// Access cached guilds (populated on connect)
+// Fetch guild info
+const guild = await client.fetchGuild(guildId);
+
+// Edit guild
+await client.editGuild(guildId, { name: 'New Name' });
+
+// Access cached guilds
 for (const [id, guild] of client.guilds) {
   console.log(guild.name);
 }
 
+// Audit log
+const log = await client.fetchAuditLog(guildId, { limit: 50 });
+
+// Vanity URL
+const vanity = await client.fetchVanityUrl(guildId);
+```
+
+### Members
+
+```typescript
 // Fetch members
-const members = await client.fetchMembers(guildId);
+const members = await client.fetchMembers(guildId, { limit: 100 });
+const member = await client.fetchMember(guildId, userId);
 
-// Fetch roles
-const roles = await client.fetchRoles(guildId);
+// Edit member
+await client.editMember(guildId, userId, { nick: 'Cool Name' });
+
+// Kick
+await client.kickMember(guildId, userId);
 
 // Set bot nickname
-await client.setNickname(guildId, 'Cool Bot');
+await client.setNickname(guildId, 'Bot Name');
 ```
 
-### Interactions (Slash Commands)
+### Roles
 
 ```typescript
-import { InteractionCallbackType } from 'fluxer.ts';
+const roles = await client.fetchRoles(guildId);
 
-// Register commands
-await client.registerCommands(applicationId, [
-  { name: 'ping', description: 'Pong!' },
-]);
+// Create / edit / delete
+const role = await client.createRole(guildId, { name: 'Moderator', color: 0x3498db });
+await client.editRole(guildId, roleId, { name: 'Admin' });
+await client.deleteRole(guildId, roleId);
 
-// Handle interactions
-client.on('interactionCreate', async (interaction) => {
-  if (interaction.data?.name === 'ping') {
-    await client.respondToInteraction(
-      interaction.id,
-      interaction.token,
-      InteractionCallbackType.ChannelMessageWithSource,
-      { content: 'Pong!' },
-    );
-  }
+// Add / remove from member
+await client.addRole(guildId, userId, roleId);
+await client.removeRole(guildId, userId, roleId);
+```
+
+### Bans
+
+```typescript
+await client.banMember(guildId, userId, { reason: 'Rule violation' });
+await client.unbanMember(guildId, userId);
+const bans = await client.fetchBans(guildId);
+```
+
+### Channels
+
+```typescript
+const channel = await client.fetchChannel(channelId);
+const guildChannels = await client.fetchGuildChannels(guildId);
+
+// Create / edit / delete
+const ch = await client.createChannel(guildId, { name: 'general', type: 0 });
+await client.editChannel(channelId, { topic: 'Updated topic' });
+await client.deleteChannel(channelId);
+
+// Permission overwrites
+await client.editPermission(channelId, roleId, { type: 0, allow: '1024', deny: '0' });
+await client.deletePermission(channelId, roleId);
+```
+
+### Emojis & Stickers
+
+```typescript
+const emojis = await client.fetchEmojis(guildId);
+const emoji = await client.createEmoji(guildId, { name: 'cool', image: 'data:image/png;base64,...' });
+await client.editEmoji(guildId, emojiId, { name: 'cooler' });
+await client.deleteEmoji(guildId, emojiId);
+
+const stickers = await client.fetchStickers(guildId);
+const sticker = await client.createSticker(guildId, {
+  name: 'cool', description: 'A cool sticker', tags: 'cool',
+  file: { name: 'sticker.png', data: stickerBuffer },
 });
+await client.editSticker(guildId, stickerId, { name: 'cooler' });
+await client.deleteSticker(guildId, stickerId);
+```
+
+### Invites
+
+```typescript
+const invite = await client.createInvite(channelId, { max_age: 86400 });
+const channelInvites = await client.fetchChannelInvites(channelId);
+const guildInvites = await client.fetchGuildInvites(guildId);
+const info = await client.fetchInvite('abc123');
+await client.deleteInvite('abc123');
+```
+
+### Webhooks
+
+```typescript
+const webhook = await client.createWebhook(channelId, { name: 'My Webhook' });
+await client.editWebhook(webhookId, { name: 'Updated' });
+await client.executeWebhook(webhookId, token, 'Hello from webhook!');
+await client.deleteWebhook(webhookId);
+
+const channelHooks = await client.fetchChannelWebhooks(channelId);
+const guildHooks = await client.fetchGuildWebhooks(guildId);
+```
+
+### Users
+
+```typescript
+const user = await client.fetchUser(userId);
+const dm = await client.createDM(userId);
+await client.sendMessage(dm.id, 'Hello!');
+```
+
+### Lifecycle
+
+```typescript
+// Connect
+await client.login('your-bot-token');
+
+// Leave a guild
+await client.leaveGuild(guildId);
+
+// Disconnect
+client.destroy();
 ```
 
 ### Events
 
 ```typescript
+// Session
 client.on('ready', (user, guilds) => { });
+
+// Messages
 client.on('messageCreate', (message) => { });
 client.on('messageUpdate', (message) => { });
 client.on('messageDelete', ({ id, channel_id }) => { });
-client.on('interactionCreate', (interaction) => { });
+client.on('messageDeleteBulk', ({ ids, channel_id }) => { });
+
+// Reactions
+client.on('messageReactionAdd', (data) => { });
+client.on('messageReactionRemove', (data) => { });
+client.on('messageReactionRemoveAll', (data) => { });
+client.on('messageReactionRemoveEmoji', (data) => { });
+
+// Guilds
 client.on('guildCreate', (guild) => { });
+client.on('guildUpdate', (guild) => { });
 client.on('guildDelete', ({ id }) => { });
+
+// Members
 client.on('guildMemberAdd', (member) => { });
+client.on('guildMemberUpdate', (member) => { });
 client.on('guildMemberRemove', ({ guild_id, user }) => { });
+
+// Roles
+client.on('guildRoleCreate', ({ guild_id, role }) => { });
+client.on('guildRoleUpdate', ({ guild_id, role }) => { });
+client.on('guildRoleDelete', ({ guild_id, role_id }) => { });
+client.on('guildRoleUpdateBulk', ({ guild_id, roles }) => { });
+
+// Bans
+client.on('guildBanAdd', ({ guild_id, user }) => { });
+client.on('guildBanRemove', ({ guild_id, user }) => { });
+
+// Emojis & Stickers
+client.on('guildEmojisUpdate', ({ guild_id, emojis }) => { });
+client.on('guildStickersUpdate', ({ guild_id, stickers }) => { });
+
+// Channels
 client.on('channelCreate', (channel) => { });
 client.on('channelUpdate', (channel) => { });
+client.on('channelUpdateBulk', (channels) => { });
 client.on('channelDelete', (channel) => { });
-client.on('messageReactionAdd', (data) => { });
-client.on('messageReactionRemove', (data) => { });
+client.on('channelPinsUpdate', (data) => { });
+
+// Invites
+client.on('inviteCreate', ({ code, channel_id }) => { });
+client.on('inviteDelete', ({ code, channel_id }) => { });
+
+// Webhooks
+client.on('webhooksUpdate', ({ guild_id, channel_id }) => { });
+
+// Voice
+client.on('voiceStateUpdate', (state) => { });
+client.on('voiceServerUpdate', (data) => { });
+
+// Typing & Presence
 client.on('typingStart', (data) => { });
+client.on('presenceUpdate', (data) => { });
+client.on('userUpdate', (user) => { });
+
+// System
 client.on('error', (error) => { });
 client.on('debug', (message) => { });
+
+// Raw — any unhandled gateway event
+client.on('raw', (event, data) => { });
 ```
 
 ### REST API (Direct)
@@ -154,15 +330,28 @@ const intents = GatewayIntents.Guilds | GatewayIntents.GuildMessages | GatewayIn
 const client = new Client({ intents: IntentsAll });
 ```
 
+## Type Generation
+
+Types are auto-generated from the Fluxer OpenAPI spec:
+
+```bash
+node tools/generate-types.mjs > src/types.generated.ts
+```
+
+The generator reads `reference/openapi.json` and outputs TypeScript interfaces and enums for all bot-relevant API objects. Modify `tools/generate-types.mjs` to add schemas or change mappings.
+
 ## How it differs from @fluxerjs/core
 
 | | fluxer.ts | @fluxerjs/core |
 |---|---|---|
-| Size | ~22KB | ~809KB |
+| Size | ~60KB | ~809KB |
 | Packages | 1 | 7 (monorepo) |
 | Dependencies | 1 (ws) | 6 |
 | TypeScript | Source + declarations | Declarations only |
 | Fluxer-specific | Yes (properties, v1 gateway) | Discord.js port |
+| API types | Generated from OpenAPI spec | Manual |
+| Events | 40+ | Unknown |
+| Client methods | 65 | Unknown |
 
 ## License