@ctrl/qbittorrent 6.0.0 → 6.1.0

package/dist/src/qbittorrent.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" resolution-mode="require"/>
 import type { Options as GotOptions, Response } from 'got';
 import type { AddTorrentOptions as NormalizedAddTorrentOptions, AllClientData, NormalizedTorrent, TorrentClient, TorrentSettings } from '@ctrl/shared-torrent';
-import type { AddMagnetOptions, AddTorrentOptions, BuildInfo, Preferences, Torrent, TorrentCategories, TorrentFile, TorrentFilePriority, TorrentFilters, TorrentPieceState, TorrentProperties, TorrentTrackers, WebSeed } from './types.js';
+import type { AddMagnetOptions, AddTorrentOptions, BuildInfo, Preferences, Torrent, TorrentCategories, TorrentFile, TorrentFilePriority, TorrentFilters, TorrentPeersResponse, TorrentPieceState, TorrentProperties, TorrentTrackers, WebSeed } from './types.js';
 export declare class QBittorrent implements TorrentClient {
     config: TorrentSettings;
     /**
@@ -197,6 +197,12 @@ export declare class QBittorrent implements TorrentClient {
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#minimal-torrent-priority}
      */
     bottomPriority(hashes: string | string[] | 'all'): Promise<boolean>;
+    /**
+     * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-peers-data}
+     * @param rid - Response ID. If not provided, rid=0 will be assumed. If the given rid is
+     *  different from the one of last server reply, full_update will be true (see the server reply details for more info)
+     */
+    torrentPeers(hash: string, rid?: number): Promise<TorrentPeersResponse>;
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#login}
      */

package/dist/src/qbittorrent.js

@@ -550,6 +550,19 @@ export class QBittorrent {
         await this.request('/torrents/bottomPrio', 'POST', undefined, undefined, params);
         return true;
     }
+    /**
+     * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-peers-data}
+     * @param rid - Response ID. If not provided, rid=0 will be assumed. If the given rid is
+     *  different from the one of last server reply, full_update will be true (see the server reply details for more info)
+     */
+    async torrentPeers(hash, rid) {
+        const params = { hash };
+        if (rid) {
+            params.rid = rid;
+        }
+        const res = await this.request('/sync/torrentPeers', 'GET', params);
+        return res.body;
+    }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#login}
      */

package/dist/src/types.d.ts

@@ -1234,4 +1234,28 @@ export interface Preferences {
      */
     utp_tcp_mixed_mode: number;
 }
+export interface TorrentPeersResponse {
+    full_update: boolean;
+    peers: Peers;
+    rid: number;
+    show_flags: boolean;
+}
+type Peers = Record<string, TorrentPeer>;
+export interface TorrentPeer {
+    client?: string;
+    connection?: string;
+    country?: string;
+    country_code?: string;
+    dl_speed?: number;
+    downloaded?: number;
+    files?: string;
+    flags?: string;
+    flags_desc?: string;
+    ip?: string;
+    port?: number;
+    progress?: number;
+    relevance?: number;
+    up_speed?: number;
+    uploaded?: number;
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/qbittorrent",
-  "version": "6.0.0",
+  "version": "6.1.0",
   "description": "TypeScript api wrapper for qbittorrent using got",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",