@erinjs/core 1.0.0 → 1.2.4

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

@@ -1,87 +0,0 @@
-import { EventEmitter } from 'events';
-import { Collection } from '@erinjs/collection';
-import { Client } from '../client/Client.js';
-import { Message } from '../structures/Message.js';
-import { Events } from './Events.js';
-
-export interface MessageCollectorOptions {
-  /** Filter function. Return true to collect the message. */
-  filter?: (message: Message) => boolean;
-  /** Max duration in ms. Collector stops when time expires. */
-  time?: number;
-  /** Max messages to collect. Collector stops when limit reached. */
-  max?: number;
-}
-
-export type MessageCollectorEndReason = 'time' | 'limit' | 'user';
-
-export interface MessageCollectorEvents {
-  collect: [message: Message];
-  end: [collected: Collection<string, Message>, reason: MessageCollectorEndReason];
-}
-
-/**
- * Collects messages in a channel. Use channel.createMessageCollector().
- * @example
- * const collector = channel.createMessageCollector({ filter: m => m.author.id === userId, time: 10000 });
- * collector.on('collect', m => console.log(m.content));
- * collector.on('end', (collected, reason) => console.log(`Stopped: ${reason}`));
- */
-export class MessageCollector extends EventEmitter {
-  readonly client: Client;
-  readonly channelId: string;
-  readonly options: Required<MessageCollectorOptions>;
-  readonly collected = new Collection<string, Message>();
-  private _timeout: ReturnType<typeof setTimeout> | null = null;
-  private _ended = false;
-  private _listener: (message: Message) => void;
-
-  constructor(client: Client, channelId: string, options: MessageCollectorOptions = {}) {
-    super();
-    this.client = client;
-    this.channelId = channelId;
-    this.options = {
-      filter: options.filter ?? (() => true),
-      time: options.time ?? 0,
-      max: options.max ?? 0,
-    };
-    this._listener = (message: Message) => {
-      if (this._ended || message.channelId !== this.channelId) return;
-      if (!this.options.filter(message)) return;
-      this.collected.set(message.id, message);
-      this.emit('collect', message);
-      if (this.options.max > 0 && this.collected.size >= this.options.max) {
-        this.stop('limit');
-      }
-    };
-    this.client.on(Events.MessageCreate, this._listener);
-    if (this.options.time > 0) {
-      this._timeout = setTimeout(() => this.stop('time'), this.options.time);
-    }
-  }
-
-  stop(reason: MessageCollectorEndReason = 'user'): void {
-    if (this._ended) return;
-    this._ended = true;
-    this.client.off(Events.MessageCreate, this._listener);
-    if (this._timeout) {
-      clearTimeout(this._timeout);
-      this._timeout = null;
-    }
-    this.emit('end', this.collected, reason);
-  }
-
-  override on<K extends keyof MessageCollectorEvents>(
-    event: K,
-    listener: (...args: MessageCollectorEvents[K]) => void,
-  ): this {
-    return super.on(event, listener as (...args: unknown[]) => void) as this;
-  }
-
-  override emit<K extends keyof MessageCollectorEvents>(
-    event: K,
-    ...args: MessageCollectorEvents[K]
-  ): boolean {
-    return super.emit(event, ...args);
-  }
-}

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

@@ -1,33 +0,0 @@
-import { REST } from '@erinjs/rest';
-import { GatewayPresenceUpdateData } from '@erinjs/types';
-
-/** Optional cache size limits. When exceeded, oldest entries are evicted (FIFO). Omit or use 0 for unbounded. */
-export interface CacheSizeLimits {
-  channels?: number;
-  guilds?: number;
-  users?: number;
-  /** Max messages per channel to cache. Enables channel.messages.get() and oldMessage in messageUpdate. 0 = disabled. */
-  messages?: number;
-}
-
-export interface ClientOptions {
-  rest?: Partial<ConstructorParameters<typeof REST>[0]>;
-  /** Gateway intents. Not yet supported by Fluxer—value is always sent as 0. Set suppressIntentWarning to silence the warning. */
-  intents?: number;
-  /** Suppress the warning when intents are set (Fluxer does not support intents yet). */
-  suppressIntentWarning?: boolean;
-  /** When true, delay the Ready event until all guilds from READY (including unavailable) have been received via GUILD_CREATE. Default: false. */
-  waitForGuilds?: boolean;
-  /** Cache size limits (channels, guilds, users). When exceeded, oldest entries are evicted. Omit or 0 = unbounded. */
-  cache?: CacheSizeLimits;
-  /** Initial presence (status, custom_status, etc.) sent on identify. Can also update via PresenceUpdate after connect. */
-  presence?: GatewayPresenceUpdateData;
-  /** Optional WebSocket constructor (e.g. `require('ws')` in Node for compatibility) */
-  WebSocket?: new (url: string) => {
-    send(data: string | ArrayBufferLike): void;
-    close(code?: number): void;
-    readyState: number;
-    addEventListener?(type: string, listener: (e: unknown) => void): void;
-    on?(event: string, cb: (data?: unknown) => void): void;
-  };
-}

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

@@ -1,116 +0,0 @@
-import { EventEmitter } from 'events';
-import { Collection } from '@erinjs/collection';
-import { Client } from '../client/Client.js';
-import { MessageReaction } from '../structures/MessageReaction.js';
-import { User } from '../structures/User.js';
-import { GatewayReactionEmoji } from '@erinjs/types';
-import { Events } from './Events.js';
-
-export interface ReactionCollectorOptions {
-  /** Filter function. Return true to collect the reaction. */
-  filter?: (reaction: MessageReaction, user: User) => boolean;
-  /** Max duration in ms. Collector stops when time expires. */
-  time?: number;
-  /** Max reactions to collect. Collector stops when limit reached. */
-  max?: number;
-}
-
-export type ReactionCollectorEndReason = 'time' | 'limit' | 'user';
-
-export interface CollectedReaction {
-  reaction: MessageReaction;
-  user: User;
-}
-
-export interface ReactionCollectorEvents {
-  collect: [reaction: MessageReaction, user: User];
-  end: [collected: Collection<string, CollectedReaction>, reason: ReactionCollectorEndReason];
-}
-
-/**
- * Collects reactions on a message. Use message.createReactionCollector().
- * @example
- * const collector = message.createReactionCollector({ filter: (r, u) => u.id === userId, time: 10000 });
- * collector.on('collect', (reaction, user) => console.log(user.username, 'reacted', reaction.emoji.name));
- * collector.on('end', (collected, reason) => console.log(`Stopped: ${reason}`));
- */
-export class ReactionCollector extends EventEmitter {
-  readonly client: Client;
-  readonly messageId: string;
-  readonly channelId: string;
-  readonly options: Required<ReactionCollectorOptions>;
-  readonly collected = new Collection<string, CollectedReaction>();
-  private _timeout: ReturnType<typeof setTimeout> | null = null;
-  private _ended = false;
-  private _listener: (
-    reaction: MessageReaction,
-    user: User,
-    _msgId: string,
-    channelId: string,
-    _emoji: GatewayReactionEmoji,
-    userId: string,
-  ) => void;
-
-  constructor(
-    client: Client,
-    messageId: string,
-    channelId: string,
-    options: ReactionCollectorOptions = {},
-  ) {
-    super();
-    this.client = client;
-    this.messageId = messageId;
-    this.channelId = channelId;
-    this.options = {
-      filter: options.filter ?? (() => true),
-      time: options.time ?? 0,
-      max: options.max ?? 0,
-    };
-    this._listener = (
-      reaction: MessageReaction,
-      user: User,
-      _msgId: string,
-      chId: string,
-      _emoji: GatewayReactionEmoji,
-      userId: string,
-    ) => {
-      if (this._ended || reaction.messageId !== this.messageId || chId !== this.channelId) return;
-      if (!this.options.filter(reaction, user)) return;
-      const key = `${userId}:${reaction.emoji.id ?? reaction.emoji.name}`;
-      this.collected.set(key, { reaction, user });
-      this.emit('collect', reaction, user);
-      if (this.options.max > 0 && this.collected.size >= this.options.max) {
-        this.stop('limit');
-      }
-    };
-    this.client.on(Events.MessageReactionAdd, this._listener);
-    if (this.options.time > 0) {
-      this._timeout = setTimeout(() => this.stop('time'), this.options.time);
-    }
-  }
-
-  stop(reason: ReactionCollectorEndReason = 'user'): void {
-    if (this._ended) return;
-    this._ended = true;
-    this.client.off(Events.MessageReactionAdd, this._listener);
-    if (this._timeout) {
-      clearTimeout(this._timeout);
-      this._timeout = null;
-    }
-    this.emit('end', this.collected, reason);
-  }
-
-  override on<K extends keyof ReactionCollectorEvents>(
-    event: K,
-    listener: (...args: ReactionCollectorEvents[K]) => void,
-  ): this {
-    return super.on(event, listener as (...args: unknown[]) => void) as this;
-  }
-
-  override emit<K extends keyof ReactionCollectorEvents>(
-    event: K,
-    ...args: ReactionCollectorEvents[K]
-  ): boolean {
-    return super.emit(event, ...args);
-  }
-}

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

@@ -1,108 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import {
-  cdnAvatarURL,
-  cdnDisplayAvatarURL,
-  cdnBannerURL,
-  cdnMemberAvatarURL,
-  cdnMemberBannerURL,
-  cdnDefaultAvatarURL,
-} from './cdn.js';
-
-describe('cdnAvatarURL', () => {
-  it('returns null for null hash', () => {
-    expect(cdnAvatarURL('123', null)).toBeNull();
-  });
-
-  it('builds avatar URL with default extension', () => {
-    const url = cdnAvatarURL('123456789012345678', 'abc123hash');
-    expect(url).toContain('fluxerusercontent.com/avatars/123456789012345678/abc123hash.png');
-  });
-
-  it('uses gif for a_ prefix (animated)', () => {
-    const url = cdnAvatarURL('123', 'a_animatedhash');
-    expect(url).toContain('.gif');
-  });
-
-  it('appends size when provided', () => {
-    const url = cdnAvatarURL('123', 'hash', { size: 256 });
-    expect(url).toContain('?size=256');
-  });
-
-  it('uses custom extension', () => {
-    const url = cdnAvatarURL('123', 'hash', { extension: 'webp' });
-    expect(url).toContain('.webp');
-  });
-});
-
-describe('cdnDisplayAvatarURL', () => {
-  it('returns default avatar when hash is null', () => {
-    const url = cdnDisplayAvatarURL('123', null);
-    expect(url).toContain('fluxerstatic.com/avatars/');
-    expect(url).toContain('.png');
-  });
-
-  it('returns custom avatar when hash present', () => {
-    const url = cdnDisplayAvatarURL('123', 'abc');
-    expect(url).toContain('fluxerusercontent.com/avatars/');
-  });
-});
-
-describe('cdnBannerURL', () => {
-  it('returns null for null hash', () => {
-    expect(cdnBannerURL('123', null)).toBeNull();
-  });
-
-  it('builds banner URL', () => {
-    const url = cdnBannerURL('123456789012345678', 'bannerhash');
-    expect(url).toContain('fluxerusercontent.com/banners/123456789012345678/bannerhash.png');
-  });
-
-  it('uses gif for a_ prefix', () => {
-    const url = cdnBannerURL('123', 'a_banner');
-    expect(url).toContain('.gif');
-  });
-});
-
-describe('cdnMemberAvatarURL', () => {
-  it('returns null for null hash', () => {
-    expect(cdnMemberAvatarURL('g1', 'u1', null)).toBeNull();
-  });
-
-  it('builds member avatar URL', () => {
-    const url = cdnMemberAvatarURL('guild123', 'user456', 'memberhash');
-    expect(url).toContain(
-      'fluxerusercontent.com/guilds/guild123/users/user456/avatars/memberhash.png',
-    );
-  });
-});
-
-describe('cdnMemberBannerURL', () => {
-  it('returns null for null hash', () => {
-    expect(cdnMemberBannerURL('g1', 'u1', null)).toBeNull();
-  });
-
-  it('builds member banner URL', () => {
-    const url = cdnMemberBannerURL('guild123', 'user456', 'bannerhash');
-    expect(url).toContain(
-      'fluxerusercontent.com/guilds/guild123/users/user456/banners/bannerhash.png',
-    );
-  });
-});
-
-describe('cdnDefaultAvatarURL', () => {
-  it('returns URL with index 0-5 from user ID', () => {
-    const url = cdnDefaultAvatarURL('0');
-    expect(url).toContain('fluxerstatic.com/avatars/');
-    expect(url).toContain('.png');
-  });
-
-  it('accepts numeric index', () => {
-    const url = cdnDefaultAvatarURL(3);
-    expect(url).toContain('/avatars/3.png');
-  });
-
-  it('handles negative index by taking abs and mod', () => {
-    const url = cdnDefaultAvatarURL(-1);
-    expect(url).toContain('/avatars/1.png');
-  });
-});

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

@@ -1,130 +0,0 @@
-import { CDN_URL, STATIC_CDN_URL } from './Constants.js';
-
-export interface CdnUrlOptions {
-  size?: number;
-  extension?: string;
-}
-
-function getExtension(hash: string | null, options?: CdnUrlOptions): string {
-  const ext = options?.extension ?? 'png';
-  // Animated avatars/banners have hash starting with a_
-  if (hash?.startsWith('a_')) return 'gif';
-  return ext;
-}
-
-function appendSize(options?: CdnUrlOptions): string {
-  return options?.size ? `?size=${options.size}` : '';
-}
-
-/**
- * Build a user avatar URL from raw API data.
- * @param userId - The user's snowflake ID
- * @param avatarHash - The avatar hash from the API, or null if no custom avatar
- * @param options - Optional size and extension (default: png; auto-detects gif for a_ hashes)
- * @returns The avatar URL, or null if no avatar hash
- * @example
- * const url = cdnAvatarURL(userData.id, userData.avatar, { size: 256 });
- */
-export function cdnAvatarURL(
-  userId: string,
-  avatarHash: string | null,
-  options?: CdnUrlOptions,
-): string | null {
-  if (!avatarHash) return null;
-  const ext = getExtension(avatarHash, options);
-  const size = appendSize(options);
-  return `${CDN_URL}/avatars/${userId}/${avatarHash}.${ext}${size}`;
-}
-
-/**
- * Build an avatar URL, or the default avatar when none set.
- * @param userId - The user's snowflake ID
- * @param avatarHash - The avatar hash from the API, or null
- * @param options - Optional size and extension
- * @returns The avatar URL (never null)
- * @example
- * const url = cdnDisplayAvatarURL(user.id, user.avatar, { size: 64 });
- */
-export function cdnDisplayAvatarURL(
-  userId: string,
-  avatarHash: string | null,
-  options?: CdnUrlOptions,
-): string {
-  return cdnAvatarURL(userId, avatarHash, options) ?? cdnDefaultAvatarURL(userId);
-}
-
-/**
- * Build a user or guild banner URL from raw API data.
- * @param resourceId - The user ID or guild ID
- * @param bannerHash - The banner hash from the API, or null
- * @param options - Optional size and extension (default: png; auto-detects gif for a_ hashes)
- * @returns The banner URL, or null if no banner
- * @example
- * const url = cdnBannerURL(userData.id, profile.banner, { size: 512 });
- */
-export function cdnBannerURL(
-  resourceId: string,
-  bannerHash: string | null,
-  options?: CdnUrlOptions,
-): string | null {
-  if (!bannerHash) return null;
-  const ext = getExtension(bannerHash, options);
-  const size = appendSize(options);
-  return `${CDN_URL}/banners/${resourceId}/${bannerHash}.${ext}${size}`;
-}
-
-/**
- * Build a guild member avatar URL (guild-specific avatar).
- * @param guildId - The guild ID
- * @param userId - The user ID
- * @param avatarHash - The member avatar hash, or null
- * @param options - Optional size and extension
- * @returns The member avatar URL, or null if no guild avatar
- * @example
- * const url = cdnMemberAvatarURL(member.guild.id, member.id, member.avatar);
- */
-export function cdnMemberAvatarURL(
-  guildId: string,
-  userId: string,
-  avatarHash: string | null,
-  options?: CdnUrlOptions,
-): string | null {
-  if (!avatarHash) return null;
-  const ext = getExtension(avatarHash, options);
-  const size = appendSize(options);
-  return `${CDN_URL}/guilds/${guildId}/users/${userId}/avatars/${avatarHash}.${ext}${size}`;
-}
-
-/**
- * Build a guild member banner URL (guild-specific banner).
- * @param guildId - The guild ID
- * @param userId - The user ID
- * @param bannerHash - The member banner hash, or null
- * @param options - Optional size and extension
- * @returns The member banner URL, or null if no guild banner
- */
-export function cdnMemberBannerURL(
-  guildId: string,
-  userId: string,
-  bannerHash: string | null,
-  options?: CdnUrlOptions,
-): string | null {
-  if (!bannerHash) return null;
-  const ext = getExtension(bannerHash, options);
-  const size = appendSize(options);
-  return `${CDN_URL}/guilds/${guildId}/users/${userId}/banners/${bannerHash}.${ext}${size}`;
-}
-
-/**
- * Get the default avatar URL (used when user has no custom avatar).
- * Fluxer uses fluxerstatic.com with index = userId % 6 (six default avatar variants).
- * @param userIdOrIndex - User ID (snowflake string) to derive index, or explicit index 0-5
- * @returns The default avatar URL
- */
-export function cdnDefaultAvatarURL(userIdOrIndex: string | number): string {
-  const index =
-    typeof userIdOrIndex === 'string'
-      ? Number(BigInt(userIdOrIndex) % 6n)
-      : Math.abs(Math.floor(userIdOrIndex) % 6);
-  return `${STATIC_CDN_URL}/avatars/${index}.png`;
-}

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

@@ -1,33 +0,0 @@
-import { APIGuild, APIRole } from '@erinjs/types';
-
-/** Guild payload shape from Fluxer gateway (GUILD_CREATE, GUILD_UPDATE, READY). */
-type GatewayGuildPayload =
-  | APIGuild
-  | {
-      id: string;
-      properties?: Record<string, unknown>;
-      roles?: APIRole[] | unknown;
-      [key: string]: unknown;
-    };
-
-/**
- * Normalize gateway guild payload to APIGuild shape.
- * Fluxer gateway may send { id, properties: { owner_id, ... }, roles } instead of flat APIGuild.
- * @param raw - Raw guild data from gateway (accepts unknown for gateway payloads)
- * @returns Normalized APIGuild with roles, or null if raw is null/undefined
- */
-export function normalizeGuildPayload(
-  raw: GatewayGuildPayload | null | undefined | unknown,
-): (APIGuild & { roles?: APIRole[] }) | null {
-  if (!raw || typeof raw !== 'object') {
-    return null;
-  }
-  if ('properties' in raw && raw.properties != null && typeof raw.properties === 'object') {
-    const r = raw as { properties: Record<string, unknown>; roles?: APIRole[] | unknown };
-    return {
-      ...r.properties,
-      roles: r.roles as APIRole[] | undefined,
-    } as APIGuild & { roles?: APIRole[] };
-  }
-  return raw as APIGuild & { roles?: APIRole[] };
-}

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

@@ -1,74 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import { Message } from '../';
-import { EmbedBuilder } from '@erinjs/builders';
-
-describe('Message._createMessageBody', () => {
-  it('converts string to content-only body', async () => {
-    const result = await Message._createMessageBody('Hello world');
-    expect(result.body).toEqual({ content: 'Hello world' });
-  });
-
-  it('passes through content from options', async () => {
-    const result = await Message._createMessageBody({ content: 'Test' });
-    expect(result.body.content).toBe('Test');
-  });
-
-  it('serializes EmbedBuilder to APIEmbed', async () => {
-    const embed = new EmbedBuilder().setTitle('Test').setDescription('Desc');
-    const result = await Message._createMessageBody({ embeds: [embed] });
-    expect(result.body.embeds).toHaveLength(1);
-    expect(result.body.embeds![0]).toEqual(embed.toJSON());
-  });
-
-  it('passes through raw APIEmbed', async () => {
-    const raw = { title: 'Raw', type: 'rich' as const };
-    const result = await Message._createMessageBody({ embeds: [raw] });
-    expect(result.body.embeds).toHaveLength(1);
-    expect(result.body.embeds![0]).toBe(raw);
-  });
-
-  it('builds attachments from files when no attachments metadata', async () => {
-    const result = await Message._createMessageBody({
-      files: [
-        { name: 'a.txt', data: new Uint8Array() },
-        { name: 'b.png', data: new Uint8Array(), filename: 'custom.png' },
-      ],
-    });
-    expect(result.body.attachments).toEqual([
-      { id: 0, filename: 'a.txt' },
-      { id: 1, filename: 'custom.png' },
-    ]);
-  });
-
-  it('uses attachments metadata when provided with files', async () => {
-    const result = await Message._createMessageBody({
-      files: [{ name: 'a.txt', data: new Uint8Array() }],
-      attachments: [{ id: 0, filename: 'a.txt', title: 'My File', description: 'A file' }],
-    });
-    expect(result.body.attachments).toEqual([
-      { id: 0, filename: 'a.txt', title: 'My File', description: 'A file' },
-    ]);
-  });
-
-  it('includes flags in attachment metadata', async () => {
-    const result = await Message._createMessageBody({
-      files: [{ name: 'a.txt', data: new Uint8Array() }],
-      attachments: [{ id: 0, filename: 'a.txt', flags: 8 }],
-    });
-    expect(result.body.attachments![0].flags).toBe(8);
-  });
-
-  it('returns empty result when no content, embeds, or files', async () => {
-    const result = await Message._createMessageBody({});
-    expect(result.body).toEqual({});
-  });
-
-  it('handles mixed EmbedBuilder and raw embed', async () => {
-    const raw = { title: 'Raw', type: 'rich' as const };
-    const built = new EmbedBuilder().setTitle('Built').setDescription('D');
-    const result = await Message._createMessageBody({ embeds: [raw, built] });
-    expect(result.body.embeds).toHaveLength(2);
-    expect(result.body.embeds![0]).toBe(raw);
-    expect(result.body.embeds![1]).toEqual(built.toJSON());
-  });
-});