ryanlink 1.0.1

package/src/config/defaults.ts

@@ -0,0 +1,223 @@
+/**
+ * Default configuration options for Ryanlink
+ */
+
+import { CLIENT_NAME, CLIENT_VERSION, CLIENT_REPOSITORY } from "../metadata";
+import type { NodeOptions, PlayerOptions, RESTOptions } from "../types";
+
+/**
+ * Default REST client options
+ */
+export const DefaultRestOptions = Object.seal({
+    /**
+     * Lavalink API version
+     */
+    version: 4,
+
+    /**
+     * User agent string sent with requests
+     */
+    userAgent: `${CLIENT_NAME}/${CLIENT_VERSION} (${CLIENT_REPOSITORY})`,
+
+    /**
+     * Whether to include stack traces in error responses
+     */
+    stackTrace: false,
+
+    /**
+     * Request timeout in milliseconds
+     */
+    requestTimeout: 10_000,
+} as const satisfies Partial<RESTOptions>);
+
+/**
+ * Default Node connection options
+ */
+export const DefaultNodeOptions = Object.seal({
+    /**
+     * Interval for stats updates in milliseconds
+     */
+    statsInterval: 60_000,
+
+    /**
+     * Highest acceptable latency in milliseconds
+     */
+    highestLatency: 2_000,
+
+    /**
+     * Delay before reconnection attempts in milliseconds
+     */
+    reconnectDelay: 10_000,
+
+    /**
+     * Maximum number of reconnection attempts (-1 = infinite)
+     */
+    reconnectLimit: 3,
+
+    /**
+     * WebSocket handshake timeout in milliseconds
+     */
+    handshakeTimeout: 5_000,
+} as const satisfies Partial<Omit<NodeOptions, keyof RESTOptions>>);
+
+/**
+ * Default Player options
+ */
+export const DefaultPlayerOptions = Object.seal({
+    /**
+     * Automatically initialize player on construction
+     */
+    autoInit: true,
+
+    /**
+     * Automatically sync queue state with Lavalink
+     */
+    autoSync: true,
+
+    /**
+     * Default search prefix (ytsearch, ytmsearch, scsearch, etc.)
+     */
+    queryPrefix: "ytsearch",
+
+    /**
+     * Automatically relocate queues when nodes disconnect
+     */
+    relocateQueues: true,
+
+    /**
+     * Default function to fetch related tracks for autoplay
+     * Returns empty array by default (no autoplay)
+     */
+    async fetchRelatedTracks() {
+        return await Promise.resolve([]);
+    },
+} as const satisfies Partial<PlayerOptions>);
+
+/**
+ * Default queue options
+ */
+export const DefaultQueueOptions = Object.seal({
+    /**
+     * Default volume (0-1000)
+     */
+    volume: 100,
+
+    /**
+     * Default repeat mode
+     */
+    repeatMode: "none" as const,
+
+    /**
+     * Default autoplay state
+     */
+    autoplay: false,
+
+    /**
+     * Default paused state
+     */
+    paused: false,
+} as const);
+
+/**
+ * Default filter values
+ */
+export const DefaultFilterOptions = Object.seal({
+    /**
+     * Volume multiplier (0.0 - 5.0)
+     */
+    volume: 1.0,
+
+    /**
+     * Equalizer bands (15 bands, -0.25 to 1.0 each)
+     */
+    equalizer: [] as Array<{ band: number; gain: number }>,
+
+    /**
+     * Karaoke filter
+     */
+    karaoke: null as { level?: number; monoLevel?: number; filterBand?: number; filterWidth?: number } | null,
+
+    /**
+     * Timescale filter (speed, pitch, rate)
+     */
+    timescale: null as { speed?: number; pitch?: number; rate?: number } | null,
+
+    /**
+     * Tremolo filter (frequency, depth)
+     */
+    tremolo: null as { frequency?: number; depth?: number } | null,
+
+    /**
+     * Vibrato filter (frequency, depth)
+     */
+    vibrato: null as { frequency?: number; depth?: number } | null,
+
+    /**
+     * Rotation filter (rotationHz)
+     */
+    rotation: null as { rotationHz?: number } | null,
+
+    /**
+     * Distortion filter
+     */
+    distortion: null as {
+        sinOffset?: number;
+        sinScale?: number;
+        cosOffset?: number;
+        cosScale?: number;
+        tanOffset?: number;
+        tanScale?: number;
+        offset?: number;
+        scale?: number;
+    } | null,
+
+    /**
+     * Channel mix filter
+     */
+    channelMix: null as {
+        leftToLeft?: number;
+        leftToRight?: number;
+        rightToLeft?: number;
+        rightToRight?: number;
+    } | null,
+
+    /**
+     * Low pass filter
+     */
+    lowPass: null as { smoothing?: number } | null,
+} as const);
+
+/**
+ * Common HTTP status codes
+ */
+export const HttpStatusCodes = Object.freeze({
+    OK: 200,
+    CREATED: 201,
+    NO_CONTENT: 204,
+    BAD_REQUEST: 400,
+    UNAUTHORIZED: 401,
+    FORBIDDEN: 403,
+    NOT_FOUND: 404,
+    METHOD_NOT_ALLOWED: 405,
+    TOO_MANY_REQUESTS: 429,
+    INTERNAL_SERVER_ERROR: 500,
+    BAD_GATEWAY: 502,
+    SERVICE_UNAVAILABLE: 503,
+    GATEWAY_TIMEOUT: 504,
+} as const);
+
+/**
+ * WebSocket close codes
+ */
+export const WebSocketCloseCodes = Object.freeze({
+    NORMAL: 1000,
+    GOING_AWAY: 1001,
+    PROTOCOL_ERROR: 1002,
+    UNSUPPORTED_DATA: 1003,
+    NO_STATUS_RECEIVED: 1005,
+    ABNORMAL_CLOSURE: 1006,
+    INVALID_FRAME_PAYLOAD_DATA: 1007,
+    POLICY_VIOLATION: 1008,
+    MESSAGE_TOO_BIG: 1009,
+    INTERNAL_ERROR: 1011,
+} as const);

package/src/config/endpoints.ts

@@ -0,0 +1,99 @@
+/**
+ * Lavalink REST API route constructors
+ */
+
+/**
+ * An object holding methods that construct API routes based on params
+ */
+export const Routes = {
+    /**
+     * WebSocket endpoint
+     * @returns `/websocket`
+     */
+    websocket(): "/websocket" {
+        return "/websocket" as const;
+    },
+
+    /**
+     * Track loading endpoint
+     * @returns `/loadtracks`
+     */
+    trackLoading(): "/loadtracks" {
+        return "/loadtracks" as const;
+    },
+
+    /**
+     * Track decoding endpoint
+     * @param multiple Whether to decode multiple tracks
+     * @returns `/decodetrack` or `/decodetracks`
+     */
+    trackDecoding(multiple?: boolean): "/decodetrack" | "/decodetracks" {
+        if (multiple) {
+            return "/decodetracks" as const;
+        }
+        return "/decodetrack" as const;
+    },
+
+    /**
+     * Player endpoint
+     * @param sessionId Lavalink session ID
+     * @param guildId Optional guild ID for specific player
+     * @returns `/sessions/{sessionId}/players` or `/sessions/{sessionId}/players/{guildId}`
+     */
+    player(sessionId: string, guildId?: string): string {
+        if (guildId) {
+            return `/sessions/${sessionId}/players/${guildId}` as const;
+        }
+        return `/sessions/${sessionId}/players` as const;
+    },
+
+    /**
+     * Session endpoint
+     * @param sessionId Lavalink session ID
+     * @returns `/sessions/{sessionId}`
+     */
+    session(sessionId: string): string {
+        return `/sessions/${sessionId}` as const;
+    },
+
+    /**
+     * Info endpoint
+     * @returns `/info`
+     */
+    info(): "/info" {
+        return "/info" as const;
+    },
+
+    /**
+     * Stats endpoint
+     * @returns `/stats`
+     */
+    stats(): "/stats" {
+        return "/stats" as const;
+    },
+
+    /**
+     * Route planner endpoint
+     * @param free Optional action: `address` or `all`
+     * @returns `/routeplanner/status` or `/routeplanner/free/{action}`
+     */
+    routePlanner(free?: "address" | "all"): string {
+        if (free) {
+            return `/routeplanner/free/${free}` as const;
+        }
+        return "/routeplanner/status" as const;
+    },
+
+    /**
+     * Version endpoint
+     * @returns `/version`
+     */
+    version(): "/version" {
+        return "/version" as const;
+    },
+} as const;
+
+/**
+ * Type helper to extract route return types
+ */
+export type RouteReturnType<T extends keyof typeof Routes> = ReturnType<(typeof Routes)[T]>;

package/src/config/index.ts

@@ -0,0 +1,9 @@
+/**
+ * Configuration exports
+ */
+
+export * from "./defaults";
+export * from "./presets";
+export * from "./patterns";
+export * from "./endpoints";
+export * from "./symbols";

package/src/config/patterns.ts

@@ -0,0 +1,55 @@
+export const SnowflakeRegex = /^\d{17,20}$/;
+
+export const VoiceRegionIdRegex = /^([-a-z]{2,20})(?=[-a-z\d]*\.discord\.media:\d+$)/;
+
+export const UrlRegex = /^https?:\/\/.+/i;
+
+export const YoutubeRegex = /^(https?:\/\/)?(www\.)?(youtube\.com|youtu\.be)\/.+/i;
+
+export const SpotifyRegex = /^https?:\/\/open\.spotify\.com\/(track|album|playlist|artist)\/.+/i;
+
+export const SoundCloudRegex = /^https?:\/\/(www\.)?soundcloud\.com\/.+/i;
+
+export const BandcampRegex = /^https?:\/\/.+\.bandcamp\.com\/(track|album)\/.+/i;
+
+export const TwitchRegex = /^https?:\/\/(www\.)?twitch\.tv\/.+/i;
+
+export const AppleMusicRegex = /^https?:\/\/music\.apple\.com\/.+/i;
+
+export const DeezerRegex = /^https?:\/\/(www\.)?deezer\.com\/(track|album|playlist)\/.+/i;
+
+export const AudioFileRegex = /^https?:\/\/.+\.(mp3|wav|ogg|flac|m4a|aac|opus|webm)(\?.*)?$/i;
+
+export const TidalRegex =
+    /^https?:\/\/(?:(?:listen|www)\.)?tidal\.com\/(?:browse\/)?(?:album|track|playlist|mix)\/[a-zA-Z0-9-]+(?:\/.*)?(?:\?.*)?$/i;
+
+export const YandexMusicRegex =
+    /^(?:https?:\/\/)?music\.yandex\.(?:ru|com|kz|by)\/(?:artist|album|track|users\/[0-9A-Za-z@.-]+\/playlists|playlists)\/[0-9A-Za-z-.]+(?:\/track\/[0-9]+)?(?:\/)?$/i;
+
+export const AmazonMusicRegex =
+    /^https?:\/\/music\.amazon\.[^/]+\/(?:albums|tracks|artists|playlists|user-playlists|community-playlists)\/[A-Za-z0-9]+(?:\/[^/?#]+)?(?:[/?].*)?$/i;
+
+export const JioSaavnRegex =
+    /^(?:https?:\/\/)?(?:www\.)?jiosaavn\.com\/(?:song|album|featured|artist|s\/playlist)\/[a-zA-Z0-9_-]+(?:\/[a-zA-Z0-9_-]+)?$/i;
+
+export const PandoraRegex =
+    /^@?(?:https?:\/\/)?(?:www\.)?pandora\.com\/(?:playlist\/PL:[\d:]+|artist\/[\w-]+(?:\/[\w-]+)*\/(?:TR|AL|AR)[A-Za-z0-9]+)(?:[?#].*)?$/i;
+
+export const QobuzRegex =
+    /^https?:\/\/(?:www\.|play\.|open\.)?qobuz\.com\/(?:(?:[a-z]{2}-[a-z]{2}\/)?(?:album|playlist|track|artist)\/(?:.+?\/)?[a-zA-Z0-9]+|playlist\/\d+)$/i;
+
+export const AudiomackRegex =
+    /^https?:\/\/audiomack\.com\/(?:(?:[^/]+\/(?:song|album|playlist)|(?:song|album|playlist))\/[^/?#]+)$/i;
+
+export const MixcloudRegex =
+    /^https?:\/\/(?:(?:www|beta|m)\.)?mixcloud\.com\/[^/]+\/(?:playlists\/[^/]+|(?!stream|uploads|favorites|listens|playlists)[^/]+|(?:uploads|favorites|listens|stream))(?:\/)?$/i;
+
+export const AnghamiRegex = /^https?:\/\/(?:play\.)?anghami\.com\/(?:song|album|playlist|artist)\/[0-9]+$/i;
+
+export const AudiusRegex = /^https?:\/\/(?:www\.)?audius\.co\/[^/]+\/[^/]+$/i;
+
+export const GaanaRegex = /^https?:\/\/(?:www\.)?gaana\.com\/(?:song|album|playlist)\/[^/]+$/i;
+
+export const InstagramRegex = /^https?:\/\/(?:www\.)?instagram\.com\/(?:p|reel|tv)\/[A-Za-z0-9_-]+(?:\/)?$/i;
+
+export const ShazamRegex = /^https?:\/\/(?:www\.)?shazam\.com\/track\/[0-9]+$/i;