amule-ec-client 0.4.3 → 0.5.0

package/dist/index.d.ts

@@ -4,17 +4,17 @@ interface AmuleFile {
     filePath?: string;
     sizeFull?: number;
     fileEd2kLink?: string;
-    upPrio: number;
-    getRequests: number;
-    getAllRequests: number;
-    getAccepts: number;
-    getAllAccepts: number;
-    getXferred: number;
-    getAllXferred: number;
-    getCompleteSourcesLow: number;
-    getCompleteSourcesHigh: number;
-    getCompleteSources: number;
-    getOnQueue: number;
+    upPrio?: number;
+    getRequests?: number;
+    getAllRequests?: number;
+    getAccepts?: number;
+    getAllAccepts?: number;
+    getXferred?: number;
+    getAllXferred?: number;
+    getCompleteSourcesLow?: number;
+    getCompleteSourcesHigh?: number;
+    getCompleteSources?: number;
+    getOnQueue?: number;
     getComment?: string;
     getRating?: number;
 }
@@ -22,48 +22,48 @@ interface AmuleTransferringFile extends AmuleFile {
     partMetID?: number;
     sizeXfer?: number;
     sizeDone?: number;
-    fileStatus: FileStatus;
-    stopped: boolean;
-    sourceCount: number;
-    sourceNotCurrCount: number;
-    sourceXferCount: number;
-    sourceCountA4AF: number;
+    fileStatus?: FileStatus;
+    stopped?: boolean;
+    sourceCount?: number;
+    sourceNotCurrCount?: number;
+    sourceXferCount?: number;
+    sourceCountA4AF?: number;
     speed?: number;
-    downPrio: number;
-    fileCat: number;
-    lastSeenComplete: number;
-    lastDateChanged: number;
-    downloadActiveTime: number;
-    availablePartCount: number;
-    a4AFAuto: boolean;
-    hashingProgress: boolean;
-    getLostDueToCorruption: number;
-    getGainDueToCompression: number;
-    totalPacketsSavedDueToICH: number;
-    a4afSources: number[];
+    downPrio?: number;
+    fileCat?: number;
+    lastSeenComplete?: number;
+    lastDateChanged?: number;
+    downloadActiveTime?: number;
+    availablePartCount?: number;
+    a4AFAuto?: boolean;
+    hashingProgress?: boolean;
+    getLostDueToCorruption?: number;
+    getGainDueToCompression?: number;
+    totalPacketsSavedDueToICH?: number;
+    a4afSources?: number[];
 }
 interface AmuleCategory {
-    id: number;
-    name: string;
-    path: string;
-    comment: string;
-    color: number;
-    priority: number;
+    id?: number;
+    name?: string;
+    path?: string;
+    comment?: string;
+    color?: number;
+    priority?: number;
 }
 interface AmuleServer {
     name?: string;
     description?: string;
     address?: string;
-    ip: string;
-    port: number;
+    ip?: string;
+    port?: number;
     ping?: number;
     users?: number;
     maxUsers?: number;
     files?: number;
-    priority: number;
+    priority?: number;
     version?: string;
-    isStatic: boolean;
-    failedCount: number;
+    isStatic?: boolean;
+    failedCount?: number;
 }
 interface AmuleUpDownClient {
     clientName?: string;
@@ -98,7 +98,7 @@ interface AmuleUpDownClient {
     uploadFilename?: string;
     requestFileId?: bigint | number;
     remoteFilename?: string;
-    disableViewShared: boolean;
+    disableViewShared?: boolean;
     version?: number;
     modVersion?: string;
     osInfo?: string;
@@ -108,6 +108,15 @@ interface AmuleUpDownClient {
     lastDownloadingPart?: number;
     uploadPartStatus?: string;
 }
+interface AmuleFriend {
+    name?: string;
+    userHashHexString?: string;
+    ip?: string;
+    port?: number;
+    friendSlot?: boolean;
+    shared?: boolean;
+    client?: AmuleUpDownClient;
+}
 declare enum FileStatus {
     READY = 0,
     EMPTY = 1,
@@ -176,161 +185,6 @@ declare enum SearchFileDownloadStatus {
     QUEUEDCANCELED = 4
 }
 
-/**
- * Main aMule EC Client
- */
-
-interface AmuleClientOptions {
-    host: string;
-    port: number;
-    password: string;
-    timeout?: number;
-}
-interface StatsResponse {
-    id: number;
-    ed2kId: number;
-    kadId?: string;
-    connectedServer?: {
-        name?: string;
-        description?: string;
-        ip: string;
-        port: number;
-    };
-    connectionState?: any;
-    uploadOverhead: number;
-    downloadOverhead: number;
-    bannedCount: number;
-    loggerMessage: string[];
-    totalSentBytes: number;
-    totalReceivedBytes: number;
-    sharedFileCount: number;
-    uploadSpeed: number;
-    downloadSpeed: number;
-    uploadSpeedLimit: number;
-    downloadSpeedLimit: number;
-    uploadQueueLength: number;
-    totalSourceCount: number;
-    ed2kUsers: number;
-    kadUsers: number;
-    ed2kFiles: number;
-    kadFiles: number;
-    kadNodes: number;
-}
-interface SearchResultsResponse {
-    files: {
-        fileName: string;
-        hash: Buffer;
-        sizeFull: number;
-        downloadStatus: number;
-        completeSourceCount: number;
-        sourceCount: number;
-    }[];
-}
-declare class AmuleClient {
-    private connection;
-    constructor(options: AmuleClientOptions);
-    /**
-     * Reconnect to the server
-     */
-    reconnect(): Promise<void>;
-    /**
-     * Get server statistics
-     */
-    getStats(): Promise<StatsResponse>;
-    /**
-     * Start an asynchronous search
-     */
-    searchAsync(query: string, searchType?: SearchType, filters?: SearchFilters): Promise<string>;
-    /**
-     * Get search status (0-1)
-     */
-    searchStatus(): Promise<number>;
-    /**
-     * Get search results
-     */
-    searchResults(): Promise<SearchResultsResponse>;
-    /**
-     * Perform a synchronous search (waits for results)
-     */
-    searchSync(query: string, searchType?: SearchType, filters?: SearchFilters, timeout?: number): Promise<SearchResultsResponse>;
-    /**
-     * Stop current search
-     */
-    searchStop(): Promise<void>;
-    /**
-     * Download a file from search results
-     */
-    downloadSearchResult(hash: Buffer): Promise<void>;
-    /**
-     * Download from an ed2k link
-     */
-    downloadEd2kLink(link: string): Promise<void>;
-    /**
-     * Get download queue
-     */
-    getDownloadQueue(): Promise<AmuleTransferringFile[]>;
-    /**
-     * Get shared files
-     */
-    getSharedFiles(): Promise<AmuleFile[]>;
-    /**
-     * Get client upload/download queue (clients we are uploading to/downloading from)
-     */
-    getClientQueue(): Promise<AmuleUpDownClient[]>;
-    /**
-     * Get the list of servers
-     */
-    getServerList(): Promise<AmuleServer[]>;
-    /**
-     * Connect to a specific server
-     */
-    connectToServer(ip: string, port: number): Promise<void>;
-    /**
-     * Disconnect from the current server
-     */
-    disconnectFromServer(): Promise<void>;
-    /**
-     * Create a category
-     */
-    createCategory(category: AmuleCategory): Promise<void>;
-    /**
-     * Update a category
-     */
-    updateCategory(id: number, category: AmuleCategory): Promise<void>;
-    /**
-     * Delete a category
-     */
-    deleteCategory(id: number): Promise<void>;
-    /**
-     * Get all categories
-     */
-    getCategories(): Promise<AmuleCategory[]>;
-    /**
-     * Set file category
-     */
-    setFileCategory(hash: Buffer, categoryId: number): Promise<void>;
-    /**
-     * Send a download command (PAUSE, RESUME, STOP, DELETE, etc.)
-     */
-    sendDownloadCommand(hash: Buffer, command: DownloadCommand): Promise<void>;
-    /**
-     * Pause a download
-     */
-    pauseDownload(hash: Buffer): Promise<void>;
-    /**
-     * Resume a download
-     */
-    resumeDownload(hash: Buffer): Promise<void>;
-    /**
-     * Stop a download
-     */
-    stopDownload(hash: Buffer): Promise<void>;
-    /**
-     * Delete a download
-     */
-    deleteDownload(hash: Buffer): Promise<void>;
-}
-
 declare enum ProtocolVersion {
     EC_CURRENT_PROTOCOL_VERSION = 516
 }
@@ -745,6 +599,172 @@ declare enum ECTagType {
     EC_TAGTYPE_UINT128 = 10
 }
 
+/**
+ * Main aMule EC Client
+ */
+
+interface AmuleClientOptions {
+    host: string;
+    port: number;
+    password: string;
+    timeout?: number;
+}
+interface StatsResponse {
+    id: number;
+    ed2kId: number;
+    kadId?: string;
+    connectedServer?: {
+        name?: string;
+        description?: string;
+        ip: string;
+        port: number;
+    };
+    connectionState?: any;
+    uploadOverhead: number;
+    downloadOverhead: number;
+    bannedCount: number;
+    loggerMessage: string[];
+    totalSentBytes: number;
+    totalReceivedBytes: number;
+    sharedFileCount: number;
+    uploadSpeed: number;
+    downloadSpeed: number;
+    uploadSpeedLimit: number;
+    downloadSpeedLimit: number;
+    uploadQueueLength: number;
+    totalSourceCount: number;
+    ed2kUsers: number;
+    kadUsers: number;
+    ed2kFiles: number;
+    kadFiles: number;
+    kadNodes: number;
+}
+interface SearchResultsResponse {
+    files: {
+        fileName: string;
+        hash: Buffer;
+        sizeFull: number;
+        downloadStatus: number;
+        completeSourceCount: number;
+        sourceCount: number;
+    }[];
+}
+interface UpdateResponse {
+    sharedFiles: AmuleFile[];
+    downloadQueue: AmuleTransferringFile[];
+    clients: AmuleUpDownClient[];
+    servers: AmuleServer[];
+    friends: AmuleFriend[];
+}
+declare class AmuleClient {
+    private connection;
+    constructor(options: AmuleClientOptions);
+    /**
+     * Reconnect to the server
+     */
+    reconnect(): Promise<void>;
+    /**
+     * Get server statistics
+     */
+    getStats(): Promise<StatsResponse>;
+    /**
+     * Get incremental updates for files, clients, servers, and friends
+     */
+    getUpdate(detailLevel?: ECDetailLevel): Promise<UpdateResponse>;
+    /**
+     * Start an asynchronous search
+     */
+    searchAsync(query: string, searchType?: SearchType, filters?: SearchFilters): Promise<string>;
+    /**
+     * Get search status (0-1)
+     */
+    searchStatus(): Promise<number>;
+    /**
+     * Get search results
+     */
+    searchResults(): Promise<SearchResultsResponse>;
+    /**
+     * Perform a synchronous search (waits for results)
+     */
+    searchSync(query: string, searchType?: SearchType, filters?: SearchFilters, timeout?: number): Promise<SearchResultsResponse>;
+    /**
+     * Stop current search
+     */
+    searchStop(): Promise<void>;
+    /**
+     * Download a file from search results
+     */
+    downloadSearchResult(hash: Buffer): Promise<void>;
+    /**
+     * Download from an ed2k link
+     */
+    downloadEd2kLink(link: string): Promise<void>;
+    /**
+     * Get download queue
+     */
+    getDownloadQueue(): Promise<AmuleTransferringFile[]>;
+    /**
+     * Get shared files
+     */
+    getSharedFiles(): Promise<AmuleFile[]>;
+    /**
+     * Get client upload/download queue (clients we are uploading to/downloading from)
+     */
+    getClientQueue(): Promise<AmuleUpDownClient[]>;
+    /**
+     * Get the list of servers
+     */
+    getServerList(): Promise<AmuleServer[]>;
+    /**
+     * Connect to a specific server
+     */
+    connectToServer(ip: string, port: number): Promise<void>;
+    /**
+     * Disconnect from the current server
+     */
+    disconnectFromServer(): Promise<void>;
+    /**
+     * Create a category
+     */
+    createCategory(category: AmuleCategory): Promise<void>;
+    /**
+     * Update a category
+     */
+    updateCategory(id: number, category: AmuleCategory): Promise<void>;
+    /**
+     * Delete a category
+     */
+    deleteCategory(id: number): Promise<void>;
+    /**
+     * Get all categories
+     */
+    getCategories(): Promise<AmuleCategory[]>;
+    /**
+     * Set file category
+     */
+    setFileCategory(hash: Buffer, categoryId: number): Promise<void>;
+    /**
+     * Send a download command (PAUSE, RESUME, STOP, DELETE, etc.)
+     */
+    sendDownloadCommand(hash: Buffer, command: DownloadCommand): Promise<void>;
+    /**
+     * Pause a download
+     */
+    pauseDownload(hash: Buffer): Promise<void>;
+    /**
+     * Resume a download
+     */
+    resumeDownload(hash: Buffer): Promise<void>;
+    /**
+     * Stop a download
+     */
+    stopDownload(hash: Buffer): Promise<void>;
+    /**
+     * Delete a download
+     */
+    deleteDownload(hash: Buffer): Promise<void>;
+}
+
 declare class AmuleException extends Error {
     cause?: Error | undefined;
     constructor(message: string, cause?: Error | undefined);
@@ -993,4 +1013,4 @@ declare class PacketParser {
     static hasCompletePacket(buffer: Buffer): boolean;
 }
 
-export { type AmuleCategory, AmuleClient, type AmuleClientOptions, AmuleException, type AmuleFile, type AmuleServer, type AmuleTransferringFile, type AmuleUpDownClient, CommunicationException, type ConnectionState, CustomTag, DoubleTag, DownloadCommand, ECDetailLevel, ECOpCode, ECSearchType, ECTagName, EcPrefs, FileStatus, Flags, Hash16Tag, InvalidECException, Ipv4Tag, Packet, PacketParser, PacketWriter, ProtocolVersion, SearchFileDownloadStatus, type SearchFilters, type SearchResultsResponse, SearchType, ServerException, type StatsResponse, StringTag, Tag, UByteTag, UInt128Tag, UIntTag, ULongTag, UShortTag };
+export { type AmuleCategory, AmuleClient, type AmuleClientOptions, AmuleException, type AmuleFile, type AmuleFriend, type AmuleServer, type AmuleTransferringFile, type AmuleUpDownClient, CommunicationException, type ConnectionState, CustomTag, DoubleTag, DownloadCommand, ECDetailLevel, ECOpCode, ECSearchType, ECTagName, EcPrefs, FileStatus, Flags, Hash16Tag, InvalidECException, Ipv4Tag, Packet, PacketParser, PacketWriter, ProtocolVersion, SearchFileDownloadStatus, type SearchFilters, type SearchResultsResponse, SearchType, ServerException, type StatsResponse, StringTag, Tag, UByteTag, UInt128Tag, UIntTag, ULongTag, UShortTag, type UpdateResponse };