@erinjs/core 1.0.0 → 1.2.4

package/core/packages/fluxer-core/src/structures/User.test.ts

@@ -1,110 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import { Client, User } from '../';
-
-function createMockClient() {
-  return {} as Client;
-}
-
-function createUser(
-  overrides: Partial<{
-    id: string;
-    username: string;
-    avatar: string | null;
-    banner: string | null;
-  }> = {},
-) {
-  return new User(createMockClient(), {
-    id: overrides.id ?? '123456789012345678',
-    username: overrides.username ?? 'TestUser',
-    discriminator: '0',
-    avatar: overrides.avatar ?? null,
-    banner: overrides.banner ?? null,
-  });
-}
-
-describe('User', () => {
-  describe('toString()', () => {
-    it('returns user mention format', () => {
-      const user = createUser({ id: '987654321098765432' });
-      expect(user.toString()).toBe('<@987654321098765432>');
-    });
-  });
-
-  describe('avatarURL()', () => {
-    it('returns null when avatar is null', () => {
-      const user = createUser({ avatar: null });
-      expect(user.avatarURL()).toBeNull();
-    });
-
-    it('builds avatar URL with default png extension', () => {
-      const user = createUser({ avatar: 'abc123hash' });
-      const url = user.avatarURL();
-      expect(url).toContain('fluxerusercontent.com/avatars/123456789012345678/abc123hash.png');
-    });
-
-    it('uses gif for animated avatar (a_ prefix)', () => {
-      const user = createUser({ avatar: 'a_animatedhash' });
-      const url = user.avatarURL();
-      expect(url).toContain('.gif');
-    });
-
-    it('appends size when provided', () => {
-      const user = createUser({ avatar: 'hash' });
-      const url = user.avatarURL({ size: 256 });
-      expect(url).toContain('?size=256');
-    });
-  });
-
-  describe('displayAvatarURL()', () => {
-    it('returns default avatar URL when no custom avatar', () => {
-      const user = createUser({ avatar: null });
-      const url = user.displayAvatarURL();
-      expect(url).toContain('fluxerstatic.com/avatars/');
-    });
-
-    it('returns custom avatar URL when avatar is set', () => {
-      const user = createUser({ avatar: 'custom' });
-      const url = user.displayAvatarURL();
-      expect(url).toContain('fluxerusercontent.com/avatars/');
-    });
-  });
-
-  describe('bannerURL()', () => {
-    it('returns null when banner is null', () => {
-      const user = createUser({ banner: null });
-      expect(user.bannerURL()).toBeNull();
-    });
-
-    it('builds banner URL when banner is set', () => {
-      const user = createUser({ banner: 'bannerhash' });
-      const url = user.bannerURL();
-      expect(url).toContain('fluxerusercontent.com/banners/123456789012345678/bannerhash.png');
-    });
-  });
-
-  describe('constructor', () => {
-    it('parses API user data', () => {
-      const user = createUser({
-        id: '111',
-        username: 'Alice',
-        avatar: 'av',
-        banner: 'bn',
-      });
-      expect(user.id).toBe('111');
-      expect(user.username).toBe('Alice');
-      expect(user.avatar).toBe('av');
-      expect(user.banner).toBe('bn');
-    });
-
-    it('handles optional fields', () => {
-      const user = new User(createMockClient(), {
-        id: '1',
-        username: 'Bot',
-        discriminator: '0',
-      });
-      expect(user.globalName).toBeNull();
-      expect(user.avatar).toBeNull();
-      expect(user.bot).toBe(false);
-    });
-  });
-});

package/core/packages/fluxer-core/src/structures/User.ts

@@ -1,109 +0,0 @@
-import { Client } from '../client/Client.js';
-import { Base } from './Base.js';
-import { MessageSendOptions } from '../util/messageUtils.js';
-import { APIChannelPartial, APIUserPartial } from '@erinjs/types';
-import { Routes } from '@erinjs/types';
-import { CDN_URL } from '../util/Constants.js';
-import { cdnDefaultAvatarURL } from '../util/cdn.js';
-import { DMChannel } from './Channel.js';
-import { Message } from './Message';
-
-/** Represents a user (or bot) on Fluxer. */
-export class User extends Base {
-  readonly client: Client;
-  readonly id: string;
-  username: string;
-  discriminator: string;
-  globalName: string | null;
-  avatar: string | null;
-  readonly bot: boolean;
-  /** RGB avatar color (e.g. 7577782). Null if not set. */
-  avatarColor: number | null;
-  /** Public flags bitfield. Null if not set. */
-  flags: number | null;
-  /** Whether this is an official system user. */
-  readonly system: boolean;
-  /** Banner hash (from profile, member, or invite context). Null when not available. */
-  banner: string | null;
-
-  /** @param data - API user from message author, GET /users/{id}, or GET /users/@me */
-  constructor(client: Client, data: APIUserPartial) {
-    super();
-    this.client = client;
-    this.id = data.id;
-    this.username = data.username;
-    this.discriminator = data.discriminator;
-    this.globalName = data.global_name ?? null;
-    this.avatar = data.avatar ?? null;
-    this.bot = !!data.bot;
-    this.avatarColor = data.avatar_color ?? null;
-    this.flags = data.flags ?? data.public_flags ?? null;
-    this.system = !!data.system;
-    this.banner = data.banner ?? null;
-  }
-
-  /** Update mutable fields from fresh API data. Used by getOrCreateUser cache. */
-  _patch(data: APIUserPartial): void {
-    this.username = data.username;
-    this.discriminator = data.discriminator;
-    this.globalName = data.global_name ?? null;
-    this.avatar = data.avatar ?? null;
-    if (data.avatar_color !== undefined) this.avatarColor = data.avatar_color;
-    if (data.flags !== undefined) this.flags = data.flags;
-    if (data.banner !== undefined) this.banner = data.banner;
-  }
-
-  /**
-   * Get the URL for this user's avatar.
-   * Auto-detects animated avatars (hash starting with `a_`) and uses gif extension.
-   * @param options - Optional `size` and `extension` (default: png, or gif for animated)
-   */
-  avatarURL(options?: { size?: number; extension?: string }): string | null {
-    if (!this.avatar) return null;
-    const ext = this.avatar.startsWith('a_') ? 'gif' : (options?.extension ?? 'png');
-    const size = options?.size ? `?size=${options.size}` : '';
-    return `${CDN_URL}/avatars/${this.id}/${this.avatar}.${ext}${size}`;
-  }
-
-  /** Get the avatar URL, or the default avatar if none set (Fluxer: fluxerstatic.com). */
-  displayAvatarURL(options?: { size?: number; extension?: string }): string {
-    return this.avatarURL(options) ?? cdnDefaultAvatarURL(this.id);
-  }
-
-  /**
-   * Get the URL for this user's banner.
-   * Returns null if the user has no banner (only available when fetched from profile/member context).
-   */
-  bannerURL(options?: { size?: number; extension?: string }): string | null {
-    if (!this.banner) return null;
-    const ext = this.banner.startsWith('a_') ? 'gif' : (options?.extension ?? 'png');
-    const size = options?.size ? `?size=${options.size}` : '';
-    return `${CDN_URL}/banners/${this.id}/${this.banner}.${ext}${size}`;
-  }
-
-  /** Returns a mention string (e.g. `<@123456>`). */
-  toString(): string {
-    return `<@${this.id}>`;
-  }
-
-  /**
-   * Create or get a DM channel with this user.
-   * Returns the DM channel; use {@link DMChannel.send} to send messages.
-   */
-  async createDM(): Promise<DMChannel> {
-    const data = await this.client.rest.post(Routes.userMeChannels(), {
-      body: { recipient_id: this.id },
-      auth: true,
-    });
-    return new DMChannel(this.client, data as APIChannelPartial);
-  }
-
-  /**
-   * Send a DM to this user.
-   * Convenience method that creates the DM channel and sends the message.
-   */
-  async send(options: MessageSendOptions): Promise<Message> {
-    const dm = await this.createDM();
-    return dm.send(options);
-  }
-}

package/core/packages/fluxer-core/src/structures/Webhook.test.ts

@@ -1,109 +0,0 @@
-import { describe, it, expect, vi } from 'vitest';
-import { Client, Webhook } from '../';
-import { Routes } from '@erinjs/types';
-
-function createMockClient() {
-  const get = vi.fn();
-  const del = vi.fn();
-
-  const client = {
-    rest: {
-      get,
-      delete: del,
-      post: vi.fn(),
-      patch: vi.fn(),
-      put: vi.fn(),
-    },
-    getOrCreateUser: (data: { id: string; username?: string; discriminator?: string }) => ({
-      id: data.id,
-      username: data.username ?? 'user',
-      discriminator: data.discriminator ?? '0',
-    }),
-  } as unknown as Client;
-
-  return { client, get, del };
-}
-
-function createWebhook(client: Client, token: string | null = 'token123') {
-  const data = {
-    id: 'webhook1',
-    guild_id: 'guild1',
-    channel_id: 'channel1',
-    name: 'Test Webhook',
-    avatar: null,
-    user: {
-      id: 'user1',
-      username: 'WebhookUser',
-      discriminator: '0',
-    },
-  };
-
-  return new Webhook(client, {
-    ...data,
-    ...(token ? { token } : {}),
-  });
-}
-
-const mockMessagePayload = {
-  id: 'message1',
-  channel_id: 'channel1',
-  author: {
-    id: 'user1',
-    username: 'WebhookUser',
-    discriminator: '0',
-  },
-  type: 0,
-  flags: 0,
-  content: 'hello',
-  timestamp: new Date().toISOString(),
-  edited_timestamp: null,
-  pinned: false,
-};
-
-describe('Webhook', () => {
-  describe('fetchMessage()', () => {
-    it('fetches a webhook message using token auth route', async () => {
-      const { client, get } = createMockClient();
-      get.mockResolvedValue(mockMessagePayload);
-      const webhook = createWebhook(client);
-
-      const message = await webhook.fetchMessage('message1');
-
-      expect(get).toHaveBeenCalledWith(Routes.webhookMessage('webhook1', 'token123', 'message1'), {
-        auth: false,
-      });
-      expect(message.id).toBe('message1');
-    });
-
-    it('throws when token is unavailable', async () => {
-      const { client } = createMockClient();
-      const webhook = createWebhook(client, null);
-
-      await expect(webhook.fetchMessage('message1')).rejects.toThrow(
-        'Webhook token is required to fetch messages',
-      );
-    });
-  });
-
-  describe('deleteMessage()', () => {
-    it('deletes a webhook message using token auth route', async () => {
-      const { client, del } = createMockClient();
-      const webhook = createWebhook(client);
-
-      await webhook.deleteMessage('message1');
-
-      expect(del).toHaveBeenCalledWith(Routes.webhookMessage('webhook1', 'token123', 'message1'), {
-        auth: false,
-      });
-    });
-
-    it('throws when token is unavailable', async () => {
-      const { client } = createMockClient();
-      const webhook = createWebhook(client, null);
-
-      await expect(webhook.deleteMessage('message1')).rejects.toThrow(
-        'Webhook token is required to delete messages',
-      );
-    });
-  });
-});

package/core/packages/fluxer-core/src/structures/Webhook.ts

@@ -1,258 +0,0 @@
-import { Client } from '../client/Client.js';
-import { Base } from './Base.js';
-import { APIEmbed, APIMessage } from '@erinjs/types';
-import {
-  APIWebhook,
-  APIWebhookUpdateRequest,
-  APIWebhookTokenUpdateRequest,
-  APIWebhookEditMessageRequest,
-} from '@erinjs/types';
-import { Routes } from '@erinjs/types';
-import { EmbedBuilder } from '@erinjs/builders';
-import { buildSendBody, resolveMessageFiles, type MessageFileData } from '../util/messageUtils.js';
-import { Message } from './Message.js';
-import { User } from './User.js';
-import { cdnAvatarURL } from '../util/cdn.js';
-
-/** File data for webhook attachment uploads. Use `data` for buffers or `url` to fetch from a URL. */
-export type WebhookFileData = MessageFileData;
-
-/** Attachment metadata for webhook file uploads (id matches FormData index). */
-export interface WebhookAttachmentMeta {
-  id: number;
-  filename: string;
-  title?: string | null;
-  description?: string | null;
-  /** MessageAttachmentFlags: IS_SPOILER (8), CONTAINS_EXPLICIT_MEDIA (16), IS_ANIMATED (32) */
-  flags?: number;
-}
-
-/** Options for sending a message via webhook. Aligns with WebhookMessageRequest in the API. */
-export interface WebhookSendOptions {
-  /** Message text content (up to 2000 characters) */
-  content?: string;
-  /** Embed objects. Use EmbedBuilder or APIEmbed; EmbedBuilder is serialized automatically. */
-  embeds?: (APIEmbed | EmbedBuilder)[];
-  /** Override the webhook's default username for this message */
-  username?: string;
-  /** Override the webhook's default avatar URL for this message */
-  avatar_url?: string;
-  /** Text-to-speech */
-  tts?: boolean;
-  /** File attachments. When present, uses multipart/form-data (same as channel.send). */
-  files?: WebhookFileData[];
-  /** Attachment metadata for files (id = index). Use when files are provided. */
-  attachments?: WebhookAttachmentMeta[];
-}
-
-/**
- * Represents a Discord/Fluxer webhook. Supports creating, fetching, sending, and deleting.
- * The token is only available when the webhook was created; fetched webhooks cannot send messages.
- */
-export class Webhook extends Base {
-  readonly client: Client;
-  readonly id: string;
-  readonly guildId: string;
-  channelId: string;
-  name: string;
-  avatar: string | null;
-  /** Present only when webhook was created via createWebhook(); not returned when fetching. */
-  readonly token: string | null;
-  /** User who created the webhook. */
-  readonly user: User;
-
-  /** @param data - API webhook from POST /channels/{id}/webhooks (has token) or GET /webhooks/{id} (no token) */
-  constructor(client: Client, data: APIWebhook & { token?: string | null }) {
-    super();
-    this.client = client;
-    this.id = data.id;
-    this.guildId = data.guild_id;
-    this.channelId = data.channel_id;
-    this.name = data.name ?? 'Unknown';
-    this.avatar = data.avatar ?? null;
-    this.token = data.token ?? null;
-    this.user = client.getOrCreateUser(data.user);
-  }
-
-  /**
-   * Get the URL for this webhook's avatar.
-   * Returns null if the webhook has no custom avatar.
-   */
-  avatarURL(options?: { size?: number; extension?: string }): string | null {
-    return cdnAvatarURL(this.id, this.avatar, options);
-  }
-
-  /** Delete this webhook. Requires bot token with Manage Webhooks permission. */
-  async delete(): Promise<void> {
-    await this.client.rest.delete(Routes.webhook(this.id), { auth: true });
-  }
-
-  /**
-   * Edit this webhook. With token: name and avatar only. Without token (bot auth): name, avatar, and channel_id.
-   * @param options - Fields to update (name, avatar, channel_id when using bot auth)
-   * @returns This webhook instance with updated fields
-   */
-  async edit(options: APIWebhookUpdateRequest | APIWebhookTokenUpdateRequest): Promise<Webhook> {
-    const body: Record<string, unknown> = {};
-    if (options.name !== undefined) body.name = options.name;
-    if (options.avatar !== undefined) body.avatar = options.avatar;
-    if ('channel_id' in options && options.channel_id !== undefined && !this.token) {
-      body.channel_id = options.channel_id;
-    }
-
-    if (this.token) {
-      const data = await this.client.rest.patch(Routes.webhookExecute(this.id, this.token), {
-        body,
-        auth: false,
-      });
-      const w = data as APIWebhook;
-      this.name = w.name ?? this.name;
-      this.avatar = w.avatar ?? null;
-      return this;
-    }
-
-    const data = await this.client.rest.patch(Routes.webhook(this.id), {
-      body,
-      auth: true,
-    });
-    const w = data as APIWebhook;
-    this.name = w.name ?? this.name;
-    this.avatar = w.avatar ?? null;
-    this.channelId = w.channel_id ?? this.channelId;
-    return this;
-  }
-
-  /**
-   * Send a message via this webhook. Requires the webhook token (only present when created, not when fetched).
-   * @param options - Text content or object with content, embeds, username, avatar_url, tts, files, attachments
-   * @param wait - If true, waits for the API and returns the created Message; otherwise returns void (204)
-   * @throws Error if token is not available
-   * @example
-   * await webhook.send('Hello!');
-   * await webhook.send({ embeds: [embed] });
-   * await webhook.send({ content: 'File attached', files: [{ name: 'data.txt', data: buffer }] });
-   * const msg = await webhook.send({ content: 'Hi' }, true);
-   */
-  async send(options: string | WebhookSendOptions, wait?: boolean): Promise<Message | undefined> {
-    if (!this.token) {
-      throw new Error(
-        'Webhook token is required to send. The token is only returned when creating a webhook; fetched webhooks cannot send.',
-      );
-    }
-    const opts = typeof options === 'string' ? { content: options } : options;
-
-    // Use same body-building flow as ChannelManager.send / message send
-    const body = buildSendBody(opts) as Record<string, unknown>;
-    if (opts.username !== undefined) body.username = opts.username;
-    if (opts.avatar_url !== undefined) body.avatar_url = opts.avatar_url;
-    if (opts.tts !== undefined) body.tts = opts.tts;
-
-    const route = Routes.webhookExecute(this.id, this.token) + (wait ? '?wait=true' : '');
-
-    // Same pattern as ChannelManager: { body, files } when files present (URLs resolved automatically)
-    const files = opts.files?.length ? await resolveMessageFiles(opts.files) : undefined;
-    const postOptions = files?.length
-      ? { body, files, auth: false as const }
-      : { body, auth: false as const };
-
-    const data = await this.client.rest.post<APIMessage | undefined>(route, postOptions);
-
-    if (wait && data) {
-      return new Message(this.client, data);
-    }
-    return undefined;
-  }
-
-  /**
-   * Edit a message previously sent by this webhook.
-   * Requires the webhook token.
-   * @param messageId - The ID of the message to edit
-   * @param options - Fields to update (content, embeds, attachments)
-   * @returns The updated Message
-   * @throws Error if token is not available
-   */
-  async editMessage(messageId: string, options: APIWebhookEditMessageRequest): Promise<Message> {
-    if (!this.token) {
-      throw new Error(
-        'Webhook token is required to edit messages. The token is only returned when creating a webhook; fetched webhooks cannot edit messages.',
-      );
-    }
-    const data = await this.client.rest.patch<APIMessage>(
-      Routes.webhookMessage(this.id, this.token, messageId),
-      { body: options as Record<string, unknown>, auth: false },
-    );
-    return new Message(this.client, data);
-  }
-
-  /**
-   * Fetch a message sent by this webhook.
-   * Requires the webhook token.
-   * @param messageId - The ID of the message to fetch
-   * @returns The message
-   * @throws Error if token is not available
-   */
-  async fetchMessage(messageId: string): Promise<Message> {
-    if (!this.token) {
-      throw new Error(
-        'Webhook token is required to fetch messages. The token is only returned when creating a webhook; fetched webhooks cannot fetch messages.',
-      );
-    }
-    const data = await this.client.rest.get<APIMessage>(
-      Routes.webhookMessage(this.id, this.token, messageId),
-      { auth: false },
-    );
-    return new Message(this.client, data);
-  }
-
-  /**
-   * Delete a message sent by this webhook.
-   * Requires the webhook token.
-   * @param messageId - The ID of the message to delete
-   * @throws Error if token is not available
-   */
-  async deleteMessage(messageId: string): Promise<void> {
-    if (!this.token) {
-      throw new Error(
-        'Webhook token is required to delete messages. The token is only returned when creating a webhook; fetched webhooks cannot delete messages.',
-      );
-    }
-    await this.client.rest.delete(Routes.webhookMessage(this.id, this.token, messageId), {
-      auth: false,
-    });
-  }
-
-  /**
-   * Fetch a webhook by ID using bot auth.
-   * @param client - The client instance
-   * @param webhookId - The webhook ID
-   * @returns Webhook without token (cannot send)
-   */
-  static async fetch(client: Client, webhookId: string): Promise<Webhook> {
-    const data = await client.rest.get(Routes.webhook(webhookId));
-    return new Webhook(client, data as APIWebhook);
-  }
-
-  /**
-   * Create a Webhook instance from an ID and token (e.g. from a stored webhook URL).
-   * @param client - The client instance
-   * @param webhookId - The webhook ID
-   * @param token - The webhook token (from createWebhook or stored)
-   * @param options - Optional channelId, guildId, name for display
-   */
-  static fromToken(
-    client: Client,
-    webhookId: string,
-    token: string,
-    options?: { channelId?: string; guildId?: string; name?: string },
-  ): Webhook {
-    return new Webhook(client, {
-      id: webhookId,
-      guild_id: options?.guildId ?? '',
-      channel_id: options?.channelId ?? '',
-      name: options?.name ?? 'Webhook',
-      avatar: null,
-      token,
-      user: { id: '', username: 'webhook', discriminator: '0' },
-    });
-  }
-}

package/core/packages/fluxer-core/src/util/Constants.test.ts

@@ -1,16 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import { CDN_URL, STATIC_CDN_URL, DEFAULT_USER_AGENT } from './Constants.js';
-
-describe('Constants', () => {
-  it('CDN_URL points to fluxerusercontent', () => {
-    expect(CDN_URL).toBe('https://fluxerusercontent.com');
-  });
-
-  it('STATIC_CDN_URL points to fluxerstatic', () => {
-    expect(STATIC_CDN_URL).toBe('https://fluxerstatic.com');
-  });
-
-  it('DEFAULT_USER_AGENT is erin.js', () => {
-    expect(DEFAULT_USER_AGENT).toBe('erin.js');
-  });
-});

package/core/packages/fluxer-core/src/util/Constants.ts

@@ -1,7 +0,0 @@
-/** User Content CDN (avatars, icons, banners, emojis, attachments). */
-export const CDN_URL = 'https://fluxerusercontent.com';
-
-/** Static Assets CDN (default avatars). Use fluxerstatic.com for default avatars per Fluxer API. */
-export const STATIC_CDN_URL = 'https://fluxerstatic.com';
-
-export const DEFAULT_USER_AGENT = 'erin.js';

package/core/packages/fluxer-core/src/util/Events.ts

@@ -1,46 +0,0 @@
-/** Event name constants for client.on(Events.X, handler). Use with ClientEvents for typed callbacks. */
-export const Events = {
-  Ready: 'ready',
-  MessageCreate: 'messageCreate',
-  MessageUpdate: 'messageUpdate',
-  MessageDelete: 'messageDelete',
-  MessageDeleteBulk: 'messageDeleteBulk',
-  MessageReactionAdd: 'messageReactionAdd',
-  MessageReactionRemove: 'messageReactionRemove',
-  MessageReactionRemoveAll: 'messageReactionRemoveAll',
-  MessageReactionRemoveEmoji: 'messageReactionRemoveEmoji',
-  InteractionCreate: 'interactionCreate',
-  GuildCreate: 'guildCreate',
-  GuildUpdate: 'guildUpdate',
-  GuildDelete: 'guildDelete',
-  GuildBanAdd: 'guildBanAdd',
-  GuildBanRemove: 'guildBanRemove',
-  GuildEmojisUpdate: 'guildEmojisUpdate',
-  GuildStickersUpdate: 'guildStickersUpdate',
-  GuildIntegrationsUpdate: 'guildIntegrationsUpdate',
-  GuildMemberAdd: 'guildMemberAdd',
-  GuildMemberUpdate: 'guildMemberUpdate',
-  GuildMemberRemove: 'guildMemberRemove',
-  GuildRoleCreate: 'guildRoleCreate',
-  GuildRoleUpdate: 'guildRoleUpdate',
-  GuildRoleDelete: 'guildRoleDelete',
-  GuildScheduledEventCreate: 'guildScheduledEventCreate',
-  GuildScheduledEventUpdate: 'guildScheduledEventUpdate',
-  GuildScheduledEventDelete: 'guildScheduledEventDelete',
-  ChannelCreate: 'channelCreate',
-  ChannelUpdate: 'channelUpdate',
-  ChannelDelete: 'channelDelete',
-  ChannelPinsUpdate: 'channelPinsUpdate',
-  InviteCreate: 'inviteCreate',
-  InviteDelete: 'inviteDelete',
-  TypingStart: 'typingStart',
-  UserUpdate: 'userUpdate',
-  PresenceUpdate: 'presenceUpdate',
-  VoiceStateUpdate: 'voiceStateUpdate',
-  VoiceServerUpdate: 'voiceServerUpdate',
-  VoiceStatesSync: 'voiceStatesSync',
-  WebhooksUpdate: 'webhooksUpdate',
-  Resumed: 'resumed',
-  Error: 'error',
-  Debug: 'debug',
-} as const;