feat: Add torrentPeers endpoint (#118)

fixes #117

.gitignore

@@ -35,3 +35,4 @@ build
 docs
 dist
 yarn.lock
+.DS_Store

src/qbittorrent.ts

@@ -32,6 +32,7 @@ import type {
   TorrentFile,
   TorrentFilePriority,
   TorrentFilters,
+  TorrentPeersResponse,
   TorrentPieceState,
   TorrentProperties,
   TorrentTrackers,
@@ -754,6 +755,21 @@ export class QBittorrent implements TorrentClient {
     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: string, rid?: number): Promise<TorrentPeersResponse> {
+    const params: { hash: string; rid?: number } = { hash };
+    if (rid) {
+      params.rid = rid;
+    }
+
+    const res = await this.request<TorrentPeersResponse>('/sync/torrentPeers', 'GET', params);
+    return res.body;
+  }
+
   /**
    * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#login}
    */

src/types.ts

@@ -1259,3 +1259,30 @@ 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;
+}

test/index.spec.ts

@@ -129,6 +129,13 @@ it('should get torrent properties', async () => {
   const res = await client.torrentProperties(torrentId);
   expect(res.save_path).toEqual(expect.stringMatching(/downloads/i));
 });
+it('should get torrent peers', async () => {
+  const client = new QBittorrent({ baseUrl, username, password });
+  const torrentId = await setupTorrent(client);
+  const res = await client.torrentPeers(torrentId);
+  expect(res.full_update).toBe(true);
+  expect(res.peers).toBeDefined();
+});
 it('should get torrent trackers', async () => {
   const client = new QBittorrent({ baseUrl, username, password });
   const torrentId = await setupTorrent(client);