@ctrl/qbittorrent 6.0.0 → 7.0.0

package/README.md

@@ -1,4 +1,4 @@
-# qBittorrent [![npm](https://badgen.net/npm/v/@ctrl/qbittorrent)](https://www.npmjs.com/package/@ctrl/qbittorrent) [![CircleCI](https://badgen.net/circleci/github/scttcper/qbittorrent)](https://circleci.com/gh/scttcper/qbittorrent) [![coverage](https://badgen.net/codecov/c/github/scttcper/qbittorrent)](https://codecov.io/gh/scttcper/qbittorrent)
+# qBittorrent [![npm](https://badgen.net/npm/v/@ctrl/qbittorrent)](https://www.npmjs.com/package/@ctrl/qbittorrent) [![coverage](https://badgen.net/codecov/c/github/scttcper/qbittorrent)](https://codecov.io/gh/scttcper/qbittorrent)
 
 > TypeScript api wrapper for [qBittorrent](https://www.qbittorrent.org/) using [got](https://github.com/sindresorhus/got)
 

package/dist/src/normalizeTorrentData.d.ts

@@ -0,0 +1,3 @@
+import { NormalizedTorrent } from '@ctrl/shared-torrent';
+import { Torrent } from './types.js';
+export declare function normalizeTorrentData(torrent: Torrent): NormalizedTorrent;

package/dist/src/normalizeTorrentData.js

@@ -0,0 +1,91 @@
+import { TorrentState as NormalizedTorrentState } from '@ctrl/shared-torrent';
+import { TorrentState } from './types.js';
+export function normalizeTorrentData(torrent) {
+    let state = NormalizedTorrentState.unknown;
+    let stateMessage = '';
+    let { eta } = torrent;
+    /**
+     * Good references https://github.com/qbittorrent/qBittorrent/blob/master/src/webui/www/private/scripts/dynamicTable.js#L933
+     * https://github.com/Radarr/Radarr/blob/develop/src/NzbDrone.Core/Download/Clients/QBittorrent/QBittorrent.cs#L242
+     */
+    switch (torrent.state) {
+        case TorrentState.Error:
+            state = NormalizedTorrentState.warning;
+            stateMessage = 'qBittorrent is reporting an error';
+            break;
+        case TorrentState.PausedDL:
+            state = NormalizedTorrentState.paused;
+            break;
+        case TorrentState.QueuedDL: // queuing is enabled and torrent is queued for download
+        case TorrentState.CheckingDL: // same as checkingUP, but torrent has NOT finished downloading
+        case TorrentState.CheckingUP: // torrent has finished downloading and is being checked. Set when `recheck torrent on completion` is enabled. In the event the check fails we shouldn't treat it as completed.
+            state = NormalizedTorrentState.queued;
+            break;
+        case TorrentState.MetaDL: // Metadl could be an error if DHT is not enabled
+        case TorrentState.ForcedDL: // torrent is being downloaded, and was forced started
+        case TorrentState.ForcedMetaDL: // torrent metadata is being forcibly downloaded
+        case TorrentState.Downloading: // torrent is being downloaded and data is being transferred
+            state = NormalizedTorrentState.downloading;
+            break;
+        case TorrentState.Allocating:
+            // state = 'stalledDL';
+            state = NormalizedTorrentState.queued;
+            break;
+        case TorrentState.StalledDL:
+            state = NormalizedTorrentState.warning;
+            stateMessage = 'The download is stalled with no connection';
+            break;
+        case TorrentState.PausedUP: // torrent is paused and has finished downloading:
+        case TorrentState.Uploading: // torrent is being seeded and data is being transferred
+        case TorrentState.StalledUP: // torrent is being seeded, but no connection were made
+        case TorrentState.QueuedUP: // queuing is enabled and torrent is queued for upload
+        case TorrentState.ForcedUP: // torrent has finished downloading and is being forcibly seeded
+            // state = 'completed';
+            state = NormalizedTorrentState.seeding;
+            eta = 0; // qBittorrent sends eta=8640000 for completed torrents
+            break;
+        case TorrentState.Moving: // torrent is being moved from a folder
+        case TorrentState.QueuedForChecking:
+        case TorrentState.CheckingResumeData:
+            state = NormalizedTorrentState.checking;
+            break;
+        case TorrentState.Unknown:
+            state = NormalizedTorrentState.error;
+            break;
+        case TorrentState.MissingFiles:
+            state = NormalizedTorrentState.error;
+            stateMessage = 'The download is missing files';
+            break;
+        default:
+            break;
+    }
+    const isCompleted = torrent.progress === 1;
+    const result = {
+        id: torrent.hash,
+        name: torrent.name,
+        stateMessage,
+        state,
+        eta,
+        dateAdded: new Date(torrent.added_on * 1000).toISOString(),
+        isCompleted,
+        progress: torrent.progress,
+        label: torrent.category,
+        tags: torrent.tags.split(', '),
+        dateCompleted: new Date(torrent.completion_on * 1000).toISOString(),
+        savePath: torrent.save_path,
+        uploadSpeed: torrent.upspeed,
+        downloadSpeed: torrent.dlspeed,
+        queuePosition: torrent.priority,
+        connectedPeers: torrent.num_leechs,
+        connectedSeeds: torrent.num_seeds,
+        totalPeers: torrent.num_incomplete,
+        totalSeeds: torrent.num_complete,
+        totalSelected: torrent.size,
+        totalSize: torrent.total_size,
+        totalUploaded: torrent.uploaded,
+        totalDownloaded: torrent.downloaded,
+        ratio: torrent.ratio,
+        raw: torrent,
+    };
+    return result;
+}

package/dist/src/qbittorrent.d.ts

@@ -1,7 +1,6 @@
 /// <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,16 +196,16 @@ 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}
      */
     login(): Promise<boolean>;
     logout(): boolean;
-    request<T extends object | string>(path: string, method: GotOptions['method'], params?: any, body?: GotOptions['body'], form?: GotOptions['form'], headers?: any, json?: boolean): Promise<Response<T>>;
-    /**
-     * Normalizes hashes
-     * @returns hashes as string seperated by `|`
-     */
-    private _normalizeHashes;
-    private _normalizeTorrentData;
+    request<T>(path: string, method: 'GET' | 'POST', params?: Record<string, string | number>, body?: URLSearchParams | FormData, headers?: any, json?: boolean): Promise<T>;
 }

package/dist/src/qbittorrent.js

@@ -1,16 +1,10 @@
-/* eslint-disable @typescript-eslint/no-redundant-type-constituents */
-/* eslint-disable @typescript-eslint/ban-types */
-import { existsSync } from 'fs';
-import { URLSearchParams } from 'url';
-import { File, FormData } from 'formdata-node';
-import { fileFromPath } from 'formdata-node/file-from-path';
-import got from 'got';
+import { FormData } from 'node-fetch-native';
+import { ofetch } from 'ofetch';
 import { Cookie } from 'tough-cookie';
+import { joinURL } from 'ufo';
 import { magnetDecode } from '@ctrl/magnet-link';
-import { TorrentState as NormalizedTorrentState } from '@ctrl/shared-torrent';
 import { hash } from '@ctrl/torrent-file';
-import { urlJoin } from '@ctrl/url-join';
-import { TorrentState } from './types.js';
+import { normalizeTorrentData } from './normalizeTorrentData.js';
 const defaults = {
     baseUrl: 'http://localhost:9091/',
     path: '/api/v2',
@@ -19,31 +13,16 @@ const defaults = {
     timeout: 5000,
 };
 export class QBittorrent {
+    config;
+    /**
+     * auth cookie
+     */
+    _sid;
+    /**
+     * cookie expiration
+     */
+    _exp;
     constructor(options = {}) {
-        Object.defineProperty(this, "config", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * auth cookie
-         */
-        Object.defineProperty(this, "_sid", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * cookie expiration
-         */
-        Object.defineProperty(this, "_exp", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
         this.config = { ...defaults, ...options };
     }
     /**
@@ -57,19 +36,19 @@ export class QBittorrent {
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-application-version}
      */
     async getAppVersion() {
-        const res = await this.request('/app/version', 'GET', undefined, undefined, undefined, undefined, false);
-        return res.body;
+        const res = await this.request('/app/version', 'GET', undefined, undefined, undefined, false);
+        return res;
     }
     async getApiVersion() {
-        const res = await this.request('/app/webapiVersion', 'GET', undefined, undefined, undefined, undefined, false);
-        return res.body;
+        const res = await this.request('/app/webapiVersion', 'GET', undefined, undefined, undefined, false);
+        return res;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-build-info}
      */
     async getBuildInfo() {
         const res = await this.request('/app/buildInfo', 'GET');
-        return res.body;
+        return res;
     }
     async getTorrent(hash) {
         const torrentsResponse = await this.listTorrents({ hashes: hash });
@@ -77,22 +56,22 @@ export class QBittorrent {
         if (!torrentData) {
             throw new Error('Torrent not found');
         }
-        return this._normalizeTorrentData(torrentData);
+        return normalizeTorrentData(torrentData);
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-application-preferences}
      */
     async getPreferences() {
         const res = await this.request('/app/preferences', 'GET');
-        return res.body;
+        return res;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#set-application-preferences}
      */
     async setPreferences(preferences) {
-        await this.request('/app/setPreferences', 'POST', undefined, undefined, {
+        await this.request('/app/setPreferences', 'POST', undefined, objToUrlSearchParams({
             json: JSON.stringify(preferences),
-        });
+        }));
         return true;
     }
     /**
@@ -105,7 +84,7 @@ export class QBittorrent {
     async listTorrents({ hashes, filter, category, sort, offset, reverse, tag, } = {}) {
         const params = {};
         if (hashes) {
-            params.hashes = this._normalizeHashes(hashes);
+            params.hashes = normalizeHashes(hashes);
         }
         if (filter) {
             params.filter = filter;
@@ -126,7 +105,7 @@ export class QBittorrent {
             params.reverse = JSON.stringify(reverse);
         }
         const res = await this.request('/torrents/info', 'GET', params);
-        return res.body;
+        return res;
     }
     async getAllData() {
         const listTorrents = await this.listTorrents();
@@ -137,7 +116,7 @@ export class QBittorrent {
         };
         const labels = {};
         for (const torrent of listTorrents) {
-            const torrentData = this._normalizeTorrentData(torrent);
+            const torrentData = normalizeTorrentData(torrent);
             results.torrents.push(torrentData);
             // setup label
             if (torrentData.label) {
@@ -160,40 +139,40 @@ export class QBittorrent {
      */
     async torrentProperties(hash) {
         const res = await this.request('/torrents/properties', 'GET', { hash });
-        return res.body;
+        return res;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-trackers}
      */
     async torrentTrackers(hash) {
         const res = await this.request('/torrents/trackers', 'GET', { hash });
-        return res.body;
+        return res;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-web-seeds}
      */
     async torrentWebSeeds(hash) {
         const res = await this.request('/torrents/webseeds', 'GET', { hash });
-        return res.body;
+        return res;
     }
     async torrentFiles(hash) {
         const res = await this.request('/torrents/files', 'GET', { hash });
-        return res.body;
+        return res;
     }
     async setFilePriority(hash, fileIds, priority) {
         const res = await this.request('/torrents/filePrio', 'GET', {
             hash,
-            id: this._normalizeHashes(fileIds),
+            id: normalizeHashes(fileIds),
             priority,
         });
-        return res.body;
+        return res;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-pieces-states}
      */
     async torrentPieceStates(hash) {
         const res = await this.request('/torrents/pieceStates', 'GET', { hash });
-        return res.body;
+        return res;
     }
     /**
      * Torrents piece hashes
@@ -202,7 +181,7 @@ export class QBittorrent {
      */
     async torrentPieceHashes(hash) {
         const res = await this.request('/torrents/pieceHashes', 'GET', { hash });
-        return res.body;
+        return res;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#set-torrent-location}
@@ -210,7 +189,7 @@ export class QBittorrent {
     async setTorrentLocation(hashes, location) {
         await this.request('/torrents/setLocation', 'POST', undefined, undefined, {
             location,
-            hashes: this._normalizeHashes(hashes),
+            hashes: normalizeHashes(hashes),
         });
         return true;
     }
@@ -218,27 +197,24 @@ export class QBittorrent {
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#set-torrent-name}
      */
     async setTorrentName(hash, name) {
-        await this.request('/torrents/rename', 'POST', undefined, undefined, {
-            hash,
-            name,
-        });
+        const data = { hash, name };
+        await this.request('/torrents/rename', 'POST', undefined, objToUrlSearchParams(data));
         return true;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-all-tags}
      */
     async getTags() {
-        const res = await this.request('/torrents/tags', 'get');
-        return res.body;
+        const res = await this.request('/torrents/tags', 'GET');
+        return res;
     }
     /**
      * @param tags comma separated list
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#create-tags}
      */
     async createTags(tags) {
-        await this.request('/torrents/createTags', 'POST', undefined, undefined, {
-            tags,
-        }, undefined, false);
+        const data = { tags };
+        await this.request('/torrents/createTags', 'POST', undefined, objToUrlSearchParams(data), undefined, false);
         return true;
     }
     /**
@@ -246,53 +222,47 @@ export class QBittorrent {
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#delete-tags}
      */
     async deleteTags(tags) {
-        await this.request('/torrents/deleteTags', 'POST', undefined, undefined, { tags }, undefined, false);
+        const data = { tags };
+        await this.request('/torrents/deleteTags', 'POST', undefined, objToUrlSearchParams(data), undefined, false);
         return true;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-all-categories}
      */
     async getCategories() {
-        const res = await this.request('/torrents/categories', 'get');
-        return res.body;
+        const res = await this.request('/torrents/categories', 'GET');
+        return res;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#add-new-category}
      */
     async createCategory(category, savePath = '') {
-        await this.request('/torrents/createCategory', 'POST', undefined, undefined, {
-            category,
-            savePath,
-        }, undefined, false);
+        const data = { category, savePath };
+        await this.request('/torrents/createCategory', 'POST', undefined, objToUrlSearchParams(data), undefined, false);
         return true;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#edit-category}
      */
     async editCategory(category, savePath = '') {
-        await this.request('/torrents/editCategory', 'POST', undefined, undefined, {
-            category,
-            savePath,
-        }, undefined, false);
+        const data = { category, savePath };
+        await this.request('/torrents/editCategory', 'POST', undefined, objToUrlSearchParams(data), undefined, false);
         return true;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#remove-categories}
      */
     async removeCategory(categories) {
-        await this.request('/torrents/removeCategories', 'POST', undefined, undefined, {
-            categories,
-        }, undefined, false);
+        const data = { categories };
+        await this.request('/torrents/removeCategories', 'POST', undefined, objToUrlSearchParams(data), undefined, false);
         return true;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#add-torrent-tags}
      */
     async addTorrentTags(hashes, tags) {
-        await this.request('/torrents/addTags', 'POST', undefined, undefined, {
-            hashes: this._normalizeHashes(hashes),
-            tags,
-        }, undefined, false);
+        const data = { hashes: normalizeHashes(hashes), tags };
+        await this.request('/torrents/addTags', 'POST', undefined, objToUrlSearchParams(data), undefined, false);
         return true;
     }
     /**
@@ -300,11 +270,11 @@ export class QBittorrent {
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#remove-torrent-tags}
      */
     async removeTorrentTags(hashes, tags) {
-        const form = { hashes: this._normalizeHashes(hashes) };
+        const data = { hashes: normalizeHashes(hashes) };
         if (tags) {
-            form.tags = tags;
+            data.tags = tags;
         }
-        await this.request('/torrents/removeTags', 'POST', undefined, undefined, form, undefined, false);
+        await this.request('/torrents/removeTags', 'POST', undefined, objToUrlSearchParams(data), undefined, false);
         return true;
     }
     /**
@@ -317,61 +287,54 @@ export class QBittorrent {
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#set-torrent-category}
      */
     async setTorrentCategory(hashes, category = '') {
-        await this.request('/torrents/setCategory', 'POST', undefined, undefined, {
-            hashes: this._normalizeHashes(hashes),
+        const data = {
+            hashes: normalizeHashes(hashes),
             category,
-        });
+        };
+        await this.request('/torrents/setCategory', 'POST', undefined, objToUrlSearchParams(data));
         return true;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#pause-torrents}
      */
     async pauseTorrent(hashes) {
-        const params = {
-            hashes: this._normalizeHashes(hashes),
-        };
-        await this.request('/torrents/pause', 'POST', undefined, undefined, params);
+        const data = { hashes: normalizeHashes(hashes) };
+        await this.request('/torrents/pause', 'POST', undefined, objToUrlSearchParams(data));
         return true;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#resume-torrents}
      */
     async resumeTorrent(hashes) {
-        const params = {
-            hashes: this._normalizeHashes(hashes),
-        };
-        await this.request('/torrents/resume', 'POST', undefined, undefined, params);
+        const data = { hashes: normalizeHashes(hashes) };
+        await this.request('/torrents/resume', 'POST', undefined, objToUrlSearchParams(data));
         return true;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#delete-torrents}
      */
     async removeTorrent(hashes, deleteFiles = true) {
-        const params = {
-            hashes: this._normalizeHashes(hashes),
+        const data = {
+            hashes: normalizeHashes(hashes),
             deleteFiles,
         };
-        await this.request('/torrents/delete', 'POST', undefined, undefined, params);
+        await this.request('/torrents/delete', 'POST', undefined, objToUrlSearchParams(data));
         return true;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#recheck-torrents}
      */
     async recheckTorrent(hashes) {
-        const params = {
-            hashes: this._normalizeHashes(hashes),
-        };
-        await this.request('/torrents/recheck', 'POST', undefined, undefined, params);
+        const data = { hashes: normalizeHashes(hashes) };
+        await this.request('/torrents/recheck', 'POST', undefined, objToUrlSearchParams(data));
         return true;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#reannounce-torrents}
      */
     async reannounceTorrent(hashes) {
-        const params = {
-            hashes: this._normalizeHashes(hashes),
-        };
-        await this.request('/torrents/reannounce', 'POST', undefined, undefined, params);
+        const data = { hashes: normalizeHashes(hashes) };
+        await this.request('/torrents/reannounce', 'POST', undefined, objToUrlSearchParams(data));
         return true;
     }
     async addTorrent(torrent, options = {}) {
@@ -382,13 +345,7 @@ export class QBittorrent {
         }
         const type = { type: 'application/x-bittorrent' };
         if (typeof torrent === 'string') {
-            if (existsSync(torrent)) {
-                const file = await fileFromPath(torrent, options.filename ?? 'torrent', type);
-                form.set('file', file);
-            }
-            else {
-                form.set('file', new File([Buffer.from(torrent, 'base64')], 'file.torrent', type));
-            }
+            form.set('file', new File([Buffer.from(torrent, 'base64')], 'file.torrent', type));
         }
         else {
             const file = new File([torrent], options.filename ?? 'torrent', type);
@@ -403,11 +360,11 @@ export class QBittorrent {
                 options.useAutoTMM = 'false';
             }
             for (const [key, value] of Object.entries(options)) {
-                form.append(key, value);
+                form.append(key, `${value}`);
             }
         }
-        const res = await this.request('/torrents/add', 'POST', undefined, form, undefined, undefined, false);
-        if (res.body === 'Fails.') {
+        const res = await this.request('/torrents/add', 'POST', undefined, form, undefined, false);
+        if (res === 'Fails.') {
             throw new Error('Failed to add torrent');
         }
         return true;
@@ -445,9 +402,9 @@ export class QBittorrent {
     async renameFile(hash, id, name) {
         const form = new FormData();
         form.append('hash', hash);
-        form.append('id', id);
+        form.append('id', id.toString());
         form.append('name', name);
-        await this.request('/torrents/renameFile', 'POST', undefined, form, undefined, false);
+        await this.request('/torrents/renameFile', 'POST', undefined, undefined, form, false);
         return true;
     }
     /**
@@ -458,7 +415,7 @@ export class QBittorrent {
         form.append('hash', hash);
         form.append('oldPath', oldPath);
         form.append('newPath', newPath);
-        await this.request('/torrents/renameFolder', 'POST', undefined, form, undefined, false);
+        await this.request('/torrents/renameFolder', 'POST', undefined, undefined, form, false);
         return true;
     }
     /**
@@ -477,11 +434,11 @@ export class QBittorrent {
                 options.useAutoTMM = 'false';
             }
             for (const [key, value] of Object.entries(options)) {
-                form.append(key, value);
+                form.append(key, `${value}`);
             }
         }
-        const res = await this.request('/torrents/add', 'POST', undefined, form, undefined, undefined, false);
-        if (res.body === 'Fails.') {
+        const res = await this.request('/torrents/add', 'POST', undefined, form, undefined, false);
+        if (res === 'Fails.') {
             throw new Error('Failed to add torrent');
         }
         return true;
@@ -490,89 +447,94 @@ export class QBittorrent {
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#add-trackers-to-torrent}
      */
     async addTrackers(hash, urls) {
-        const params = { hash, urls };
-        await this.request('/torrents/addTrackers', 'POST', undefined, undefined, params);
+        const data = { hash, urls };
+        await this.request('/torrents/addTrackers', 'POST', undefined, objToUrlSearchParams(data));
         return true;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#edit-trackers}
      */
     async editTrackers(hash, origUrl, newUrl) {
-        const params = { hash, origUrl, newUrl };
-        await this.request('/torrents/editTrackers', 'POST', undefined, undefined, params);
+        const data = { hash, origUrl, newUrl };
+        await this.request('/torrents/editTrackers', 'POST', undefined, objToUrlSearchParams(data));
         return true;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#remove-trackers}
      */
     async removeTrackers(hash, urls) {
-        const params = { hash, urls };
-        await this.request('/torrents/removeTrackers', 'POST', undefined, undefined, params);
+        const data = { hash, urls };
+        await this.request('/torrents/removeTrackers', 'POST', undefined, objToUrlSearchParams(data));
         return true;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#increase-torrent-priority}
      */
     async queueUp(hashes) {
-        const params = {
-            hashes: this._normalizeHashes(hashes),
-        };
-        await this.request('/torrents/increasePrio', 'POST', undefined, undefined, params);
+        const data = { hashes: normalizeHashes(hashes) };
+        await this.request('/torrents/increasePrio', 'POST', undefined, objToUrlSearchParams(data));
         return true;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#decrease-torrent-priority}
      */
     async queueDown(hashes) {
-        const params = {
-            hashes: this._normalizeHashes(hashes),
-        };
-        await this.request('/torrents/decreasePrio', 'POST', undefined, undefined, params);
+        const data = { hashes: normalizeHashes(hashes) };
+        await this.request('/torrents/decreasePrio', 'POST', undefined, objToUrlSearchParams(data));
         return true;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#maximal-torrent-priority}
      */
     async topPriority(hashes) {
-        const params = {
-            hashes: this._normalizeHashes(hashes),
-        };
-        await this.request('/torrents/topPrio', 'POST', undefined, undefined, params);
+        const data = { hashes: normalizeHashes(hashes) };
+        await this.request('/torrents/topPrio', 'POST', undefined, objToUrlSearchParams(data));
         return true;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#minimal-torrent-priority}
      */
     async bottomPriority(hashes) {
-        const params = {
-            hashes: this._normalizeHashes(hashes),
-        };
-        await this.request('/torrents/bottomPrio', 'POST', undefined, undefined, params);
+        const data = { hashes: normalizeHashes(hashes) };
+        await this.request('/torrents/bottomPrio', 'POST', undefined, objToUrlSearchParams(data));
         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;
+    }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#login}
      */
     async login() {
-        const url = urlJoin(this.config.baseUrl, this.config.path, '/auth/login');
-        const res = await got({
-            url,
+        const url = joinURL(this.config.baseUrl, this.config.path, '/auth/login');
+        const res = await ofetch.raw(url, {
             method: 'POST',
-            form: {
+            headers: {
+                'Content-Type': 'application/x-www-form-urlencoded',
+            },
+            body: new URLSearchParams({
                 username: this.config.username ?? '',
                 password: this.config.password ?? '',
-            },
-            followRedirect: false,
-            retry: { limit: 0 },
-            timeout: { request: this.config.timeout },
-            // allow proxy agent
-            ...(this.config.agent ? { agent: this.config.agent } : {}),
+            }),
+            redirect: 'manual',
+            retry: false,
+            timeout: this.config.timeout,
+            // ...(this.config.agent ? { agent: this.config.agent } : {}),
         });
-        // eslint-disable-next-line @typescript-eslint/prefer-optional-chain
-        if (!res.headers['set-cookie'] || !res.headers['set-cookie'].length) {
+        if (!res.headers.get('set-cookie')?.length) {
             throw new Error('Cookie not found. Auth Failed.');
         }
-        const cookie = Cookie.parse(res.headers['set-cookie'][0]);
+        const cookie = Cookie.parse(res.headers.get('set-cookie'));
         if (!cookie || cookie.key !== 'SID') {
             throw new Error('Invalid cookie');
         }
@@ -586,130 +548,46 @@ export class QBittorrent {
         return true;
     }
     // eslint-disable-next-line max-params
-    async request(path, method, params = {}, body, form, headers = {}, json = true) {
+    async request(path, method, params, body, headers = {}, json = true) {
         if (!this._sid || !this._exp || this._exp.getTime() < new Date().getTime()) {
             const authed = await this.login();
             if (!authed) {
                 throw new Error('Auth Failed');
             }
         }
-        const url = urlJoin(this.config.baseUrl, this.config.path, path);
-        const res = await got(url, {
-            isStream: false,
-            resolveBodyOnly: false,
+        const url = joinURL(this.config.baseUrl, this.config.path, path);
+        const res = await ofetch(url, {
             method,
             headers: {
                 Cookie: `SID=${this._sid ?? ''}`,
                 ...headers,
             },
-            retry: { limit: 0 },
             body,
-            form,
-            searchParams: new URLSearchParams(params),
+            params,
             // allow proxy agent
-            timeout: { request: this.config.timeout },
+            retry: 0,
+            timeout: this.config.timeout,
             responseType: json ? 'json' : 'text',
-            ...(this.config.agent ? { agent: this.config.agent } : {}),
+            // @ts-expect-error for some reason agent is not in the type
+            agent: this.config.agent,
         });
         return res;
     }
-    /**
-     * Normalizes hashes
-     * @returns hashes as string seperated by `|`
-     */
-    _normalizeHashes(hashes) {
-        if (Array.isArray(hashes)) {
-            return hashes.join('|');
-        }
-        return hashes;
-    }
-    _normalizeTorrentData(torrent) {
-        let state = NormalizedTorrentState.unknown;
-        let stateMessage = '';
-        let { eta } = torrent;
-        /**
-         * Good references https://github.com/qbittorrent/qBittorrent/blob/master/src/webui/www/private/scripts/dynamicTable.js#L933
-         * https://github.com/Radarr/Radarr/blob/develop/src/NzbDrone.Core/Download/Clients/QBittorrent/QBittorrent.cs#L242
-         */
-        switch (torrent.state) {
-            case TorrentState.Error:
-                state = NormalizedTorrentState.warning;
-                stateMessage = 'qBittorrent is reporting an error';
-                break;
-            case TorrentState.PausedDL:
-                state = NormalizedTorrentState.paused;
-                break;
-            case TorrentState.QueuedDL: // queuing is enabled and torrent is queued for download
-            case TorrentState.CheckingDL: // same as checkingUP, but torrent has NOT finished downloading
-            case TorrentState.CheckingUP: // torrent has finished downloading and is being checked. Set when `recheck torrent on completion` is enabled. In the event the check fails we shouldn't treat it as completed.
-                state = NormalizedTorrentState.queued;
-                break;
-            case TorrentState.MetaDL: // Metadl could be an error if DHT is not enabled
-            case TorrentState.ForcedDL: // torrent is being downloaded, and was forced started
-            case TorrentState.ForcedMetaDL: // torrent metadata is being forcibly downloaded
-            case TorrentState.Downloading: // torrent is being downloaded and data is being transferred
-                state = NormalizedTorrentState.downloading;
-                break;
-            case TorrentState.Allocating:
-                // state = 'stalledDL';
-                state = NormalizedTorrentState.queued;
-                break;
-            case TorrentState.StalledDL:
-                state = NormalizedTorrentState.warning;
-                stateMessage = 'The download is stalled with no connection';
-                break;
-            case TorrentState.PausedUP: // torrent is paused and has finished downloading:
-            case TorrentState.Uploading: // torrent is being seeded and data is being transferred
-            case TorrentState.StalledUP: // torrent is being seeded, but no connection were made
-            case TorrentState.QueuedUP: // queuing is enabled and torrent is queued for upload
-            case TorrentState.ForcedUP: // torrent has finished downloading and is being forcibly seeded
-                // state = 'completed';
-                state = NormalizedTorrentState.seeding;
-                eta = 0; // qBittorrent sends eta=8640000 for completed torrents
-                break;
-            case TorrentState.Moving: // torrent is being moved from a folder
-            case TorrentState.QueuedForChecking:
-            case TorrentState.CheckingResumeData:
-                state = NormalizedTorrentState.checking;
-                break;
-            case TorrentState.Unknown:
-                state = NormalizedTorrentState.error;
-                break;
-            case TorrentState.MissingFiles:
-                state = NormalizedTorrentState.error;
-                stateMessage = 'The download is missing files';
-                break;
-            default:
-                break;
-        }
-        const isCompleted = torrent.progress === 1;
-        const result = {
-            id: torrent.hash,
-            name: torrent.name,
-            stateMessage,
-            state,
-            eta,
-            dateAdded: new Date(torrent.added_on * 1000).toISOString(),
-            isCompleted,
-            progress: torrent.progress,
-            label: torrent.category,
-            tags: torrent.tags.split(', '),
-            dateCompleted: new Date(torrent.completion_on * 1000).toISOString(),
-            savePath: torrent.save_path,
-            uploadSpeed: torrent.upspeed,
-            downloadSpeed: torrent.dlspeed,
-            queuePosition: torrent.priority,
-            connectedPeers: torrent.num_leechs,
-            connectedSeeds: torrent.num_seeds,
-            totalPeers: torrent.num_incomplete,
-            totalSeeds: torrent.num_complete,
-            totalSelected: torrent.size,
-            totalSize: torrent.total_size,
-            totalUploaded: torrent.uploaded,
-            totalDownloaded: torrent.downloaded,
-            ratio: torrent.ratio,
-            raw: torrent,
-        };
-        return result;
+}
+/**
+ * Normalizes hashes
+ * @returns hashes as string seperated by `|`
+ */
+function normalizeHashes(hashes) {
+    if (Array.isArray(hashes)) {
+        return hashes.join('|');
+    }
+    return hashes;
+}
+function objToUrlSearchParams(obj) {
+    const params = new URLSearchParams();
+    for (const [key, value] of Object.entries(obj)) {
+        params.append(key, value.toString());
     }
+    return params;
 }

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/dist/src/types.js

@@ -81,7 +81,7 @@ export var TorrentState;
      * Torrent data files is missing
      */
     TorrentState["MissingFiles"] = "missingFiles";
-})(TorrentState = TorrentState || (TorrentState = {}));
+})(TorrentState || (TorrentState = {}));
 export var TorrentTrackerStatus;
 (function (TorrentTrackerStatus) {
     /**
@@ -104,7 +104,7 @@ export var TorrentTrackerStatus;
      * Tracker has been contacted, but it is not working (or doesn't send proper replies)
      */
     TorrentTrackerStatus[TorrentTrackerStatus["Errored"] = 4] = "Errored";
-})(TorrentTrackerStatus = TorrentTrackerStatus || (TorrentTrackerStatus = {}));
+})(TorrentTrackerStatus || (TorrentTrackerStatus = {}));
 export var TorrentFilePriority;
 (function (TorrentFilePriority) {
     /**
@@ -123,7 +123,7 @@ export var TorrentFilePriority;
      * Maximal priority
      */
     TorrentFilePriority[TorrentFilePriority["MaxPriority"] = 7] = "MaxPriority";
-})(TorrentFilePriority = TorrentFilePriority || (TorrentFilePriority = {}));
+})(TorrentFilePriority || (TorrentFilePriority = {}));
 export var TorrentPieceState;
 (function (TorrentPieceState) {
     /**
@@ -138,4 +138,4 @@ export var TorrentPieceState;
      * Already downloaded
      */
     TorrentPieceState[TorrentPieceState["Downloaded"] = 2] = "Downloaded";
-})(TorrentPieceState = TorrentPieceState || (TorrentPieceState = {}));
+})(TorrentPieceState || (TorrentPieceState = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/qbittorrent",
-  "version": "6.0.0",
+  "version": "7.0.0",
   "description": "TypeScript api wrapper for qbittorrent using got",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",
@@ -14,7 +14,8 @@
   ],
   "sideEffects": false,
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "keywords": [
     "typescript",
@@ -31,25 +32,24 @@
     "test:ci": "vitest run --coverage --reporter=default --reporter=junit --outputFile=./junit.xml"
   },
   "dependencies": {
-    "@ctrl/magnet-link": "^3.1.1",
-    "@ctrl/shared-torrent": "^4.3.2",
-    "@ctrl/torrent-file": "^2.0.2",
-    "@ctrl/url-join": "^2.0.2",
-    "formdata-node": "^5.0.0",
-    "got": "^12.6.0",
-    "tough-cookie": "^4.1.2"
+    "@ctrl/magnet-link": "^3.1.2",
+    "@ctrl/shared-torrent": "^5.0.0",
+    "@ctrl/torrent-file": "^3.0.0",
+    "node-fetch-native": "^1.4.0",
+    "ofetch": "^1.3.3",
+    "tough-cookie": "^4.1.3",
+    "ufo": "^1.3.0"
   },
   "devDependencies": {
-    "@ctrl/eslint-config": "3.7.0",
-    "@sindresorhus/tsconfig": "3.0.1",
-    "@types/node": "18.16.3",
-    "@types/tough-cookie": "4.0.2",
-    "@vitest/coverage-c8": "0.31.0",
-    "c8": "7.13.0",
+    "@ctrl/eslint-config": "4.0.7",
+    "@sindresorhus/tsconfig": "4.0.0",
+    "@types/node": "20.6.5",
+    "@types/tough-cookie": "4.0.3",
+    "@vitest/coverage-v8": "0.34.5",
     "p-wait-for": "5.0.2",
-    "typedoc": "0.24.6",
-    "typescript": "5.0.4",
-    "vitest": "0.31.0"
+    "typedoc": "0.25.1",
+    "typescript": "5.2.2",
+    "vitest": "0.34.5"
   },
   "release": {
     "branches": [
@@ -57,6 +57,6 @@
     ]
   },
   "engines": {
-    "node": ">=14.16"
+    "node": ">=18"
   }
 }