for-modules 1.1.5 → 1.1.6

package/package.json

@@ -1,24 +1,53 @@
-{
-  "name": "for-modules",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "version": "1.1.5",
-  "description": "For lavalink",
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org/",
-    "access": "public"
-  },
-  "bugs": {
-    "url": "https://github.com/kungkmg/For-modules/issues"
-  },
-  "homepage": "https://github.com/kungkmg/For-modules#readme",
-  "peerDependencies": {
-    "typescript": "^5.5.4"
-  },
-  "keywords": [
-    "lavalink",
-    "discord",
-    "TikTok",
-    "api"
-  ]
+{
+  "name": "for-modules",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "version": "1.1.6",
+  "description": "For lavalink",
+  "license": "MIT",
+  "author": "v",
+  "scripts": {
+    "start": "tsc -p . && bun dist/index.js",
+    "build:js": "npx babel src --out-dir dist --extensions \".ts,.tsx\" --source-maps inline",
+    "lint": "npx eslint src/**/*.ts",
+    "test:manager": "bun test/manager.ts",
+    "test:player": "bun test/player.ts"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.10.0",
+    "@types/bun": "latest",
+    "eslint": "^9.10.0",
+    "globals": "^15.9.0",
+    "typescript-eslint": "^8.4.0",
+    "@babel/cli": "^7.25.6",
+    "@babel/core": "^7.25.2",
+    "@babel/preset-env": "^7.25.4",
+    "@babel/preset-typescript": "^7.24.7"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "bugs": {
+    "url": "https://github.com/kungkmg/For-modules/issues"
+  },
+  "homepage": "https://github.com/kungkmg/For-modules#readme",
+  "peerDependencies": {
+    "typescript": "^5.5.4"
+  },
+  "dependencies": {
+    "@discordjs/collection": "^2.1.1",
+    "axios": "^1.7.7",
+    "discord.js": "^14.16.1",
+    "events": "^3.3.0",
+    "tiny-typed-emitter": "^2.1.0",
+    "ws": "^8.18.0",
+    "yt-dlp-wrap": "^2.3.12"
+  },
+  "keywords": [
+    "lavalink",
+    "discord",
+    "wrapper",
+    "api"
+  ]
 }

package/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended"
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "lib": ["ESNext", "DOM"],
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false,
+    "rootDir": "./src",
+    "outDir": "./dist",
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "isolatedModules": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules"]
+}

package/dist/Structures/Filters.d.ts

@@ -1,109 +0,0 @@
-import { Band } from "../Utils/FiltersEqualizers";
-import { Player } from "./Player";
-export declare class Filters {
-    distortion: DistortionOptions | null;
-    equalizer: Band[];
-    karaoke: KaraokeOptions | null;
-    player: Player;
-    rotation: RotationOptions | null;
-    timescale: TimescaleOptions | null;
-    vibrato: VibratoOptions | null;
-    volume: number;
-    private filterStatus;
-    constructor(player: Player);
-    private updateFilters;
-    private applyFilter;
-    private setFilterStatus;
-    /**
-     * Sets the equalizer bands and updates the filters.
-     * @param bands - The equalizer bands.
-     */
-    setEqualizer(bands?: Band[]): this;
-    /** Applies the eight dimension audio effect. */
-    eightD(): this;
-    /** Applies the bass boost effect. */
-    bassBoost(): this;
-    /** Applies the nightcore effect. */
-    nightcore(): this;
-    /** Applies the slow motion audio effect. */
-    slowmo(): this;
-    /** Applies the soft audio effect. */
-    soft(): this;
-    /** Applies the television audio effect. */
-    tv(): this;
-    /** Applies the treble bass effect. */
-    trebleBass(): this;
-    /** Applies the vaporwave effect. */
-    vaporwave(): this;
-    /** Applies the distortion audio effect. */
-    distort(): this;
-    /** Applies the karaoke options specified by the filter. */
-    setKaraoke(karaoke?: KaraokeOptions): this;
-    /** Applies the timescale options specified by the filter. */
-    setTimescale(timescale?: TimescaleOptions): this;
-    /** Applies the vibrato options specified by the filter. */
-    setVibrato(vibrato?: VibratoOptions): this;
-    /** Applies the rotation options specified by the filter. */
-    setRotation(rotation?: RotationOptions): this;
-    /** Applies the distortion options specified by the filter. */
-    setDistortion(distortion?: DistortionOptions): this;
-    /** Removes the audio effects and resets the filter status. */
-    clearFilters(): Promise<this>;
-    /** Returns the status of the specified filter . */
-    getFilterStatus(filter: keyof AvailableFilters): boolean;
-}
-/** Options for adjusting the timescale of audio. */
-interface TimescaleOptions {
-    /** The speed factor for the timescale. */
-    speed?: number;
-    /** The pitch factor for the timescale. */
-    pitch?: number;
-    /** The rate factor for the timescale. */
-    rate?: number;
-}
-/** Options for applying vibrato effect to audio. */
-interface VibratoOptions {
-    /** The frequency of the vibrato effect. */
-    frequency: number;
-    /** * The depth of the vibrato effect.*/
-    depth: number;
-}
-/** Options for applying rotation effect to audio. */
-interface RotationOptions {
-    /** The rotation speed in Hertz (Hz). */
-    rotationHz: number;
-}
-/** Options for applying karaoke effect to audio. */
-interface KaraokeOptions {
-    /** The level of karaoke effect. */
-    level?: number;
-    /** The mono level of karaoke effect. */
-    monoLevel?: number;
-    /** The filter band of karaoke effect. */
-    filterBand?: number;
-    /** The filter width of karaoke effect. */
-    filterWidth?: number;
-}
-interface DistortionOptions {
-    sinOffset?: number;
-    sinScale?: number;
-    cosOffset?: number;
-    cosScale?: number;
-    tanOffset?: number;
-    tanScale?: number;
-    offset?: number;
-    scale?: number;
-}
-interface AvailableFilters {
-    bassboost: boolean;
-    distort: boolean;
-    eightD: boolean;
-    karaoke: boolean;
-    nightcore: boolean;
-    slowmo: boolean;
-    soft: boolean;
-    trebleBass: boolean;
-    tv: boolean;
-    vaporwave: boolean;
-}
-export {};

package/dist/Structures/Manager.d.ts

@@ -1,192 +0,0 @@
-import { EventEmitter } from "events";
-import { LoadType, Plugin, TrackData, TrackEndEvent, TrackExceptionEvent, TrackStartEvent, TrackStuckEvent, VoicePacket, VoiceServer, WebSocketClosedEvent } from "./Utils";
-import { Collection } from "@discordjs/collection";
-import { Node, NodeOptions } from "./Node";
-import { Player, PlayerOptions, Track, UnresolvedTrack } from "./Player";
-import { VoiceState } from "..";
-import { ClientUser, User } from "discord.js";
-/**
- * The main hub for interacting with Lavalink and using Magmastream,
- */
-export declare class Manager extends EventEmitter {
-    static readonly DEFAULT_SOURCES: Record<SearchPlatform, string>;
-    /** The map of players. */
-    readonly players: Collection<string, Player>;
-    /** The map of nodes. */
-    readonly nodes: Collection<string, Node>;
-    /** The options that were set. */
-    readonly options: ManagerOptions;
-    private initiated;
-    caches: Collection<string, SearchResult>;
-    /** Returns the nodes that has the least load. */
-    get leastLoadNode(): Collection<string, Node>;
-    /** Returns the nodes that has the least amount of players. */
-    private get leastPlayersNode();
-    /** Returns a node based on priority. */
-    private get priorityNode();
-    /** Returns the node to use. */
-    get useableNodes(): Node;
-    /**
-     * Initiates the Manager class.
-     * @param options
-     */
-    constructor(options: ManagerOptions);
-    /**
-     * Initiates the Manager.
-     * @param clientId
-     */
-    init(clientId?: string): this;
-    /**
-     * Searches the enabled sources based off the URL or the `source` property.
-     * @param query
-     * @param requester
-     * @returns The search result.
-     */
-    search(query: string | SearchQuery, requester?: User | ClientUser): Promise<SearchResult>;
-    /**
-     * Decodes the base64 encoded tracks and returns a TrackData array.
-     * @param tracks
-     */
-    decodeTracks(tracks: string[]): Promise<TrackData[]>;
-    /**
-     * Decodes the base64 encoded track and returns a TrackData.
-     * @param track
-     */
-    decodeTrack(track: string): Promise<TrackData>;
-    /**
-     * Creates a player or returns one if it already exists.
-     * @param options
-     */
-    create(options: PlayerOptions): Player;
-    /**
-     * Returns a player or undefined if it does not exist.
-     * @param guild
-     */
-    get(guild: string): Player | undefined;
-    /**
-     * Destroys a player if it exists.
-     * @param guild
-     */
-    destroy(guild: string): void;
-    /**
-     * Creates a node or returns one if it already exists.
-     * @param options
-     */
-    createNode(options: NodeOptions): Node;
-    /**
-     * Destroys a node if it exists.
-     * @param identifier
-     */
-    destroyNode(identifier: string): void;
-    /**
-     * Sends voice data to the Lavalink server.
-     * @param data
-     */
-    updateVoiceState(data: VoicePacket | VoiceServer | VoiceState): Promise<void>;
-}
-export interface Payload {
-    /** The OP code */
-    op: number;
-    d: {
-        guild_id: string;
-        channel_id: string | null;
-        self_mute: boolean;
-        self_deaf: boolean;
-    };
-}
-export interface ManagerOptions {
-    /** Use priority mode over least amount of player or load? */
-    usePriority?: boolean;
-    /** Use the least amount of players or least load? */
-    useNode?: "leastLoad" | "leastPlayers";
-    /** The array of nodes to connect to. */
-    nodes?: NodeOptions[];
-    /** The client ID to use. */
-    clientId?: string;
-    /** Value to use for the `Client-Name` header. */
-    clientName?: string;
-    /** The shard count. */
-    shards?: number;
-    /** A array of plugins to use. */
-    plugins?: Plugin[];
-    /** Whether players should automatically play the next song. */
-    autoPlay?: boolean;
-    /** An array of track properties to keep. `track` will always be present. */
-    trackPartial?: string[];
-    /** The default search platform to use, can be "youtube", "youtube music", "soundcloud" or deezer. */
-    defaultSearchPlatform?: SearchPlatform;
-    /** Whether the YouTube video titles should be replaced if the Author does not exactly match. */
-    replaceYouTubeCredentials?: boolean;
-    caches: {
-        /** Whether to cache the search results. */
-        enabled: boolean;
-        /** The time to cache the search results. */
-        time: number;
-    };
-    /**
-     * Function to send data to the websocket.
-     * @param id
-     * @param payload
-     */
-    send(id: string, payload: Payload): void;
-}
-export type SearchPlatform = "deezer" | "soundcloud" | "youtube music" | "youtube" | "spotify" | "jiosaavn" | "tidal" | "applemusic" | "bandcamp" | "tiktok";
-export interface SearchQuery {
-    /** The source to search from. */
-    source?: SearchPlatform | string;
-    /** The query to search for. */
-    query: string;
-}
-export interface LavalinkResponse {
-    loadType: LoadType;
-    data: TrackData[] | PlaylistRawData;
-}
-export interface SearchResult {
-    /** The load type of the result. */
-    loadType: LoadType;
-    /** The array of tracks from the result. */
-    tracks: Track[];
-    /** The playlist info if the load type is 'playlist'. */
-    playlist?: PlaylistData;
-}
-export interface PlaylistRawData {
-    info: {
-        /** The playlist name. */
-        name: string;
-    };
-    /** Addition info provided by plugins. */
-    pluginInfo: object;
-    /** The tracks of the playlist */
-    tracks: TrackData[];
-}
-export interface PlaylistData {
-    /** The playlist name. */
-    name: string;
-    /** The length of the playlist. */
-    duration: number;
-    /** The songs of the playlist. */
-    tracks: Track[];
-}
-export interface ManagerEvents {
-    NodeCreate: (node: Node) => void;
-    NodeDestroy: (node: Node) => void;
-    NodeConnect: (node: Node) => void;
-    NodeReconnect: (node: Node) => void;
-    NodeDisconnect: (node: Node, reason: {
-        code?: number;
-        reason?: string;
-    }) => void;
-    NodeError: (node: Node, error: Error) => void;
-    NodeRaw: (payload: unknown) => void;
-    PlayerCreate: (player: Player) => void;
-    PlayerDestroy: (player: Player) => void;
-    PlayerStateUpdate: (oldPlayer: Player, newPlayer: Player) => void;
-    PlayerMove: (player: Player, initChannel: string, newChannel: string) => void;
-    PlayerDisconnect: (player: Player, oldChannel: string) => void;
-    QueueEnd: (player: Player, track: Track | UnresolvedTrack, payload: TrackEndEvent) => void;
-    SocketClosed: (player: Player, payload: WebSocketClosedEvent) => void;
-    TrackStart: (player: Player, track: Track, payload: TrackStartEvent) => void;
-    TrackEnd: (player: Player, track: Track, payload: TrackEndEvent) => void;
-    TrackStuck: (player: Player, track: Track, payload: TrackStuckEvent) => void;
-    TrackError: (player: Player, track: Track | UnresolvedTrack, payload: TrackExceptionEvent) => void;
-}

package/dist/Structures/Node.d.ts

@@ -1,140 +0,0 @@
-import { PlayerEvent, PlayerEvents, TrackEndEvent, TrackExceptionEvent, TrackStartEvent, TrackStuckEvent, WebSocketClosedEvent } from "./Utils";
-import { Manager } from "./Manager";
-import { Player, Track, UnresolvedTrack } from "./Player";
-import { Rest } from "./Rest";
-import WebSocket from "ws";
-export declare class Node {
-    options: NodeOptions;
-    /** The socket for the node. */
-    socket: WebSocket | null;
-    /** The stats for the node. */
-    stats: NodeStats;
-    manager: Manager;
-    /** The node's session ID. */
-    sessionId: string | null;
-    /** The REST instance. */
-    readonly rest: Rest;
-    private static _manager;
-    private reconnectTimeout?;
-    private reconnectAttempts;
-    /** Returns if connected to the Node. */
-    get connected(): boolean;
-    /** Returns the address for this node. */
-    get address(): string;
-    /** @hidden */
-    static init(manager: Manager): void;
-    /**
-     * Creates an instance of Node.
-     * @param options
-     */
-    constructor(options: NodeOptions);
-    /** Connects to the Node. */
-    connect(): void;
-    /** Destroys the Node and all players connected with it. */
-    destroy(): void;
-    private reconnect;
-    protected open(): void;
-    protected close(code: number, reason: string): void;
-    protected error(error: Error): void;
-    protected message(d: Buffer | string): void;
-    protected handleEvent(payload: PlayerEvent & PlayerEvents): Promise<void>;
-    protected trackStart(player: Player, track: Track, payload: TrackStartEvent): void;
-    protected trackEnd(player: Player, track: Track, payload: TrackEndEvent): Promise<void>;
-    extractSpotifyTrackID(url: string): string | null;
-    extractSpotifyArtistID(url: string): string | null;
-    private handleAutoplay;
-    private handleFailedTrack;
-    private handleRepeatedTrack;
-    private playNextTrack;
-    protected queueEnd(player: Player, track: Track, payload: TrackEndEvent): Promise<void>;
-    protected trackStuck(player: Player, track: Track, payload: TrackStuckEvent): void;
-    protected trackError(player: Player, track: Track | UnresolvedTrack, payload: TrackExceptionEvent): void;
-    protected socketClosed(player: Player, payload: WebSocketClosedEvent): void;
-}
-export interface NodeOptions {
-    /** The host for the node. */
-    host: string;
-    /** The port for the node. */
-    port?: number;
-    /** The password for the node. */
-    password?: string;
-    /** Whether the host uses SSL. */
-    secure?: boolean;
-    /** The identifier for the node. */
-    identifier?: string;
-    /** The retryAmount for the node. */
-    retryAmount?: number;
-    /** The retryDelay for the node. */
-    retryDelay?: number;
-    /** Whether to resume the previous session. */
-    resumeStatus?: boolean;
-    /** The time the manager will wait before trying to resume the previous session. */
-    resumeTimeout?: number;
-    /** The timeout used for api calls. */
-    requestTimeout?: number;
-    /** Priority of the node. */
-    priority?: number;
-}
-export interface NodeStats {
-    /** The amount of players on the node. */
-    players: number;
-    /** The amount of playing players on the node. */
-    playingPlayers: number;
-    /** The uptime for the node. */
-    uptime: number;
-    /** The memory stats for the node. */
-    memory: MemoryStats;
-    /** The cpu stats for the node. */
-    cpu: CPUStats;
-    /** The frame stats for the node. */
-    frameStats: FrameStats;
-}
-export interface MemoryStats {
-    /** The free memory of the allocated amount. */
-    free: number;
-    /** The used memory of the allocated amount. */
-    used: number;
-    /** The total allocated memory. */
-    allocated: number;
-    /** The reservable memory. */
-    reservable: number;
-}
-export interface CPUStats {
-    /** The core amount the host machine has. */
-    cores: number;
-    /** The system load. */
-    systemLoad: number;
-    /** The lavalink load. */
-    lavalinkLoad: number;
-}
-export interface FrameStats {
-    /** The amount of sent frames. */
-    sent?: number;
-    /** The amount of nulled frames. */
-    nulled?: number;
-    /** The amount of deficit frames. */
-    deficit?: number;
-}
-export interface LavalinkInfo {
-    version: {
-        semver: string;
-        major: number;
-        minor: number;
-        patch: number;
-        preRelease: string;
-    };
-    buildTime: number;
-    git: {
-        branch: string;
-        commit: string;
-        commitTime: number;
-    };
-    jvm: string;
-    lavaplayer: string;
-    sourceManagers: string[];
-    filters: string[];
-    plugins: {
-        name: string;
-        version: string;
-    }[];
-}