@ctrl/qbittorrent 2.10.0 → 4.0.0

package/dist/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types.js';
+export * from './qbittorrent.js';

package/dist/src/index.js

@@ -0,0 +1,2 @@
+export * from './types.js';
+export * from './qbittorrent.js';

package/dist/{index.d.ts → src/qbittorrent.d.ts}

@@ -1,8 +1,7 @@
 /// <reference types="node" />
 import { Options as GotOptions, Response } from 'got';
-import { AddTorrentOptions as NormalizedAddTorrentOptions, TorrentClient, TorrentSettings } from '@ctrl/shared-torrent';
-import { AddMagnetOptions, AddTorrentOptions, AllClientDataQbittorrent, BuildInfo, Categories, NormalizedTorrentQbittorrent, Preferences, Torrent, TorrentFile, TorrentFilePriority, TorrentFilters, TorrentPieceState, TorrentProperties, TorrentState, TorrentTrackers, TorrentTrackerStatus, WebSeed } from './types';
-export { TorrentState, TorrentTrackerStatus, TorrentFilePriority, TorrentPieceState };
+import { AddTorrentOptions as NormalizedAddTorrentOptions, AllClientData, NormalizedTorrent, TorrentClient, TorrentSettings } from '@ctrl/shared-torrent';
+import { AddMagnetOptions, AddTorrentOptions, BuildInfo, Preferences, Torrent, TorrentCategories, TorrentFile, TorrentFilePriority, TorrentFilters, TorrentPieceState, TorrentProperties, TorrentTrackers, WebSeed } from './types.js';
 export declare class QBittorrent implements TorrentClient {
     config: TorrentSettings;
     /**
@@ -28,7 +27,7 @@ export declare class QBittorrent implements TorrentClient {
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-build-info}
      */
     getBuildInfo(): Promise<BuildInfo>;
-    getTorrent(hash: string): Promise<NormalizedTorrentQbittorrent>;
+    getTorrent(hash: string): Promise<NormalizedTorrent>;
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-application-preferences}
      */
@@ -44,8 +43,16 @@ export declare class QBittorrent implements TorrentClient {
      * @param category Get torrents with the given category (empty string means "without category"; no "category" parameter means "any category")
      * @returns list of torrents
      */
-    listTorrents(hashes?: string | string[], filter?: TorrentFilters, category?: string, sort?: string, offset?: number, reverse?: boolean, tag?: string): Promise<Torrent[]>;
-    getAllData(): Promise<AllClientDataQbittorrent>;
+    listTorrents({ hashes, filter, category, sort, offset, reverse, tag, }?: {
+        hashes?: string | string[];
+        filter?: TorrentFilters;
+        sort?: string;
+        tag?: string;
+        category?: string;
+        offset?: number;
+        reverse?: boolean;
+    }): Promise<Torrent[]>;
+    getAllData(): Promise<AllClientData>;
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-generic-properties}
      */
@@ -95,7 +102,7 @@ export declare class QBittorrent implements TorrentClient {
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-all-categories}
      */
-    getCategories(): Promise<Categories>;
+    getCategories(): Promise<TorrentCategories>;
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#add-new-category}
      */
@@ -146,7 +153,7 @@ export declare class QBittorrent implements TorrentClient {
      */
     reannounceTorrent(hashes: string | string[] | 'all'): Promise<boolean>;
     addTorrent(torrent: string | Buffer, options?: Partial<AddTorrentOptions>): Promise<boolean>;
-    normalizedAddTorrent(torrent: string | Buffer, options?: Partial<NormalizedAddTorrentOptions>): Promise<NormalizedTorrentQbittorrent>;
+    normalizedAddTorrent(torrent: string | Buffer, options?: Partial<NormalizedAddTorrentOptions>): Promise<NormalizedTorrent>;
     /**
      * @param hash Hash for desired torrent
      * @param id id of the file to be renamed
@@ -191,7 +198,7 @@ export declare class QBittorrent implements TorrentClient {
      */
     login(): Promise<boolean>;
     logout(): boolean;
-    request<T extends object | string>(path: string, method: GotOptions['method'], params?: any, body?: GotOptions['body'], headers?: any, json?: boolean): Promise<Response<T>>;
+    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 `|`

package/dist/{index.js → src/qbittorrent.js}

@@ -1,23 +1,15 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.QBittorrent = exports.TorrentPieceState = exports.TorrentFilePriority = exports.TorrentTrackerStatus = exports.TorrentState = void 0;
 /* eslint-disable @typescript-eslint/ban-types */
-const fs_1 = require("fs");
-const url_1 = require("url");
-const form_data_1 = __importDefault(require("form-data"));
-const got_1 = __importDefault(require("got"));
-const tough_cookie_1 = require("tough-cookie");
-const shared_torrent_1 = require("@ctrl/shared-torrent");
-const torrent_file_1 = require("@ctrl/torrent-file");
-const url_join_1 = require("@ctrl/url-join");
-const types_1 = require("./types");
-Object.defineProperty(exports, "TorrentFilePriority", { enumerable: true, get: function () { return types_1.TorrentFilePriority; } });
-Object.defineProperty(exports, "TorrentPieceState", { enumerable: true, get: function () { return types_1.TorrentPieceState; } });
-Object.defineProperty(exports, "TorrentState", { enumerable: true, get: function () { return types_1.TorrentState; } });
-Object.defineProperty(exports, "TorrentTrackerStatus", { enumerable: true, get: function () { return types_1.TorrentTrackerStatus; } });
+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 { Cookie } from 'tough-cookie';
+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';
 const defaults = {
     baseUrl: 'http://localhost:9091/',
     path: '/api/v2',
@@ -25,8 +17,32 @@ const defaults = {
     password: '',
     timeout: 5000,
 };
-class QBittorrent {
+export class QBittorrent {
     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 };
     }
     /**
@@ -40,11 +56,11 @@ 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, false);
+        const res = await this.request('/app/version', 'GET', undefined, undefined, undefined, undefined, false);
         return res.body;
     }
     async getApiVersion() {
-        const res = await this.request('/app/webapiVersion', 'GET', undefined, undefined, undefined, false);
+        const res = await this.request('/app/webapiVersion', 'GET', undefined, undefined, undefined, undefined, false);
         return res.body;
     }
     /**
@@ -55,7 +71,7 @@ class QBittorrent {
         return res.body;
     }
     async getTorrent(hash) {
-        const torrentsResponse = await this.listTorrents(hash);
+        const torrentsResponse = await this.listTorrents({ hashes: hash });
         const torrentData = torrentsResponse[0];
         if (!torrentData) {
             throw new Error('Torrent not found');
@@ -73,9 +89,9 @@ class QBittorrent {
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#set-application-preferences}
      */
     async setPreferences(preferences) {
-        const form = new form_data_1.default();
-        form.append('json', JSON.stringify(preferences));
-        await this.request('/app/setPreferences', 'POST', undefined, form);
+        await this.request('/app/setPreferences', 'POST', undefined, undefined, {
+            json: JSON.stringify(preferences),
+        });
         return true;
     }
     /**
@@ -85,10 +101,7 @@ class QBittorrent {
      * @param category Get torrents with the given category (empty string means "without category"; no "category" parameter means "any category")
      * @returns list of torrents
      */
-    // eslint-disable-next-line max-params
-    async listTorrents(hashes, filter, category, sort, offset, reverse, 
-    // TODO: refactor filters into an object with optional properties
-    tag) {
+    async listTorrents({ hashes, filter, category, sort, offset, reverse, tag, } = {}) {
         const params = {};
         if (hashes) {
             params.hashes = this._normalizeHashes(hashes);
@@ -193,20 +206,20 @@ class QBittorrent {
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#set-torrent-location}
      */
     async setTorrentLocation(hashes, location) {
-        const form = new form_data_1.default();
-        form.append('location', location);
-        form.append('hashes', this._normalizeHashes(hashes));
-        await this.request('/torrents/setLocation', 'POST', undefined, form);
+        await this.request('/torrents/setLocation', 'POST', undefined, undefined, {
+            location,
+            hashes: this._normalizeHashes(hashes),
+        });
         return true;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#set-torrent-name}
      */
     async setTorrentName(hash, name) {
-        const form = new form_data_1.default();
-        form.append('hash', hash);
-        form.append('name', name);
-        await this.request('/torrents/rename', 'POST', undefined, form);
+        await this.request('/torrents/rename', 'POST', undefined, undefined, {
+            hash,
+            name,
+        });
         return true;
     }
     /**
@@ -221,9 +234,9 @@ class QBittorrent {
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#create-tags}
      */
     async createTags(tags) {
-        const form = new form_data_1.default();
-        form.append('tags', tags);
-        await this.request('/torrents/createTags', 'POST', undefined, form, undefined, false);
+        await this.request('/torrents/createTags', 'POST', undefined, undefined, {
+            tags,
+        }, undefined, false);
         return true;
     }
     /**
@@ -231,9 +244,7 @@ class QBittorrent {
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#delete-tags}
      */
     async deleteTags(tags) {
-        const form = new form_data_1.default();
-        form.append('tags', tags);
-        await this.request('/torrents/deleteTags', 'POST', undefined, form, undefined, false);
+        await this.request('/torrents/deleteTags', 'POST', undefined, undefined, { tags }, undefined, false);
         return true;
     }
     /**
@@ -247,39 +258,39 @@ class QBittorrent {
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#add-new-category}
      */
     async createCategory(category, savePath = '') {
-        const form = new form_data_1.default();
-        form.append('category', category);
-        form.append('savePath', savePath);
-        await this.request('/torrents/createCategory', 'POST', undefined, form);
+        await this.request('/torrents/createCategory', 'POST', undefined, undefined, {
+            category,
+            savePath,
+        }, undefined, false);
         return true;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#edit-category}
      */
     async editCategory(category, savePath = '') {
-        const form = new form_data_1.default();
-        form.append('category', category);
-        form.append('savePath', savePath);
-        await this.request('/torrents/editCategory', 'POST', undefined, form, undefined, false);
+        await this.request('/torrents/editCategory', 'POST', undefined, undefined, {
+            category,
+            savePath,
+        }, undefined, false);
         return true;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#remove-categories}
      */
     async removeCategory(categories) {
-        const form = new form_data_1.default();
-        form.append('categories', categories);
-        await this.request('/torrents/removeCategories', 'POST', undefined, form, undefined, false);
+        await this.request('/torrents/removeCategories', 'POST', undefined, undefined, {
+            categories,
+        }, undefined, false);
         return true;
     }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#add-torrent-tags}
      */
     async addTorrentTags(hashes, tags) {
-        const form = new form_data_1.default();
-        form.append('hashes', this._normalizeHashes(hashes));
-        form.append('tags', tags);
-        await this.request('/torrents/addTags', 'POST', undefined, form, undefined, false);
+        await this.request('/torrents/addTags', 'POST', undefined, undefined, {
+            hashes: this._normalizeHashes(hashes),
+            tags,
+        }, undefined, false);
         return true;
     }
     /**
@@ -287,12 +298,11 @@ class QBittorrent {
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#remove-torrent-tags}
      */
     async removeTorrentTags(hashes, tags) {
-        const form = new form_data_1.default();
-        form.append('hashes', this._normalizeHashes(hashes));
+        const form = { hashes: this._normalizeHashes(hashes) };
         if (tags) {
-            form.append('tags', tags);
+            form.tags = tags;
         }
-        await this.request('/torrents/removeTags', 'POST', undefined, form, undefined, false);
+        await this.request('/torrents/removeTags', 'POST', undefined, undefined, form, undefined, false);
         return true;
     }
     /**
@@ -305,10 +315,10 @@ class QBittorrent {
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#set-torrent-category}
      */
     async setTorrentCategory(hashes, category = '') {
-        const form = new form_data_1.default();
-        form.append('hashes', this._normalizeHashes(hashes));
-        form.append('category', category);
-        await this.request('/torrents/setCategory', 'POST', undefined, form);
+        await this.request('/torrents/setCategory', 'POST', undefined, undefined, {
+            hashes: this._normalizeHashes(hashes),
+            category,
+        });
         return true;
     }
     /**
@@ -363,26 +373,25 @@ class QBittorrent {
         return true;
     }
     async addTorrent(torrent, options = {}) {
-        var _a;
-        const form = new form_data_1.default();
-        const fileOptions = {
-            contentType: 'application/x-bittorrent',
-            filename: (_a = options.filename) !== null && _a !== void 0 ? _a : 'torrent',
-        };
+        var _a, _b;
+        const form = new FormData();
         // remove options.filename, not used in form
         if (options.filename) {
             delete options.filename;
         }
+        const type = { type: 'application/x-bittorrent' };
         if (typeof torrent === 'string') {
-            if ((0, fs_1.existsSync)(torrent)) {
-                form.append('file', Buffer.from((0, fs_1.readFileSync)(torrent)), fileOptions);
+            if (existsSync(torrent)) {
+                const file = await fileFromPath(torrent, (_a = options.filename) !== null && _a !== void 0 ? _a : 'torrent', type);
+                form.set('file', file);
             }
             else {
-                form.append('file', Buffer.from(torrent, 'base64'), fileOptions);
+                form.set('file', new File([Buffer.from(torrent, 'base64')], 'file.torrent', type));
             }
         }
         else {
-            form.append('file', torrent, fileOptions);
+            const file = new File([torrent], (_b = options.filename) !== null && _b !== void 0 ? _b : 'torrent', type);
+            form.set('file', file);
         }
         if (options) {
             // disable savepath when autoTMM is defined
@@ -396,7 +405,7 @@ class QBittorrent {
                 form.append(key, value);
             }
         }
-        const res = await this.request('/torrents/add', 'POST', undefined, form, form.getHeaders(), false);
+        const res = await this.request('/torrents/add', 'POST', undefined, form, undefined, undefined, false);
         if (res.body === 'Fails.') {
             throw new Error('Failed to add torrent');
         }
@@ -410,11 +419,21 @@ class QBittorrent {
         if (options.label) {
             torrentOptions.category = options.label;
         }
-        if (!Buffer.isBuffer(torrent)) {
-            torrent = Buffer.from(torrent);
+        let torrentHash;
+        if (typeof torrent === 'string' && torrent.startsWith('magnet:')) {
+            torrentHash = magnetDecode(torrent).infoHash;
+            if (!torrentHash) {
+                throw new Error('Magnet did not contain hash');
+            }
+            await this.addMagnet(torrent, torrentOptions);
+        }
+        else {
+            if (!Buffer.isBuffer(torrent)) {
+                torrent = Buffer.from(torrent);
+            }
+            torrentHash = await hash(torrent);
+            await this.addTorrent(torrent, torrentOptions);
         }
-        const torrentHash = await (0, torrent_file_1.hash)(torrent);
-        await this.addTorrent(torrent, torrentOptions);
         return this.getTorrent(torrentHash);
     }
     /**
@@ -423,11 +442,11 @@ class QBittorrent {
      * @param name new name to be assigned to the file
      */
     async renameFile(hash, id, name) {
-        const form = new form_data_1.default();
+        const form = new FormData();
         form.append('hash', hash);
         form.append('id', id);
         form.append('name', name);
-        await this.request('/torrents/renameFile', 'POST', undefined, form, form.getHeaders(), false);
+        await this.request('/torrents/renameFile', 'POST', undefined, form, undefined, false);
         return true;
     }
     /**
@@ -435,7 +454,7 @@ class QBittorrent {
      * @param options
      */
     async addMagnet(urls, options = {}) {
-        const form = new form_data_1.default();
+        const form = new FormData();
         form.append('urls', urls);
         if (options) {
             // disable savepath when autoTMM is defined
@@ -449,7 +468,7 @@ class QBittorrent {
                 form.append(key, value);
             }
         }
-        const res = await this.request('/torrents/add', 'POST', undefined, form, form.getHeaders(), false);
+        const res = await this.request('/torrents/add', 'POST', undefined, form, undefined, undefined, false);
         if (res.body === 'Fails.') {
             throw new Error('Failed to add torrent');
         }
@@ -523,23 +542,25 @@ class QBittorrent {
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#login}
      */
     async login() {
-        const url = (0, url_join_1.urlJoin)(this.config.baseUrl, this.config.path, '/auth/login');
-        const form = new form_data_1.default();
-        form.append('username', this.config.username);
-        form.append('password', this.config.password);
-        const res = await got_1.default.post(url, {
-            isStream: false,
-            body: form,
+        var _a, _b;
+        const url = urlJoin(this.config.baseUrl, this.config.path, '/auth/login');
+        const res = await got({
+            url,
+            method: 'POST',
+            form: {
+                username: (_a = this.config.username) !== null && _a !== void 0 ? _a : '',
+                password: (_b = this.config.password) !== null && _b !== void 0 ? _b : '',
+            },
             followRedirect: false,
-            retry: 0,
+            retry: { limit: 0 },
+            timeout: { request: this.config.timeout },
             // allow proxy agent
-            agent: this.config.agent,
-            timeout: this.config.timeout,
+            ...(this.config.agent ? { agent: this.config.agent } : {}),
         });
         if (!res.headers['set-cookie'] || !res.headers['set-cookie'].length) {
             throw new Error('Cookie not found. Auth Failed.');
         }
-        const cookie = tough_cookie_1.Cookie.parse(res.headers['set-cookie'][0]);
+        const cookie = Cookie.parse(res.headers['set-cookie'][0]);
         if (!cookie || cookie.key !== 'SID') {
             throw new Error('Invalid cookie');
         }
@@ -553,7 +574,7 @@ class QBittorrent {
         return true;
     }
     // eslint-disable-next-line max-params
-    async request(path, method, params = {}, body, headers = {}, json = true) {
+    async request(path, method, params = {}, body, form, headers = {}, json = true) {
         var _a;
         if (!this._sid || !this._exp || this._exp.getTime() < new Date().getTime()) {
             const authed = await this.login();
@@ -561,8 +582,8 @@ class QBittorrent {
                 throw new Error('Auth Failed');
             }
         }
-        const url = (0, url_join_1.urlJoin)(this.config.baseUrl, this.config.path, path);
-        const res = await (0, got_1.default)(url, {
+        const url = urlJoin(this.config.baseUrl, this.config.path, path);
+        const res = await got(url, {
             isStream: false,
             resolveBodyOnly: false,
             method,
@@ -570,13 +591,14 @@ class QBittorrent {
                 Cookie: `SID=${(_a = this._sid) !== null && _a !== void 0 ? _a : ''}`,
                 ...headers,
             },
-            retry: 0,
+            retry: { limit: 0 },
             body,
-            searchParams: new url_1.URLSearchParams(params),
+            form,
+            searchParams: new URLSearchParams(params),
             // allow proxy agent
-            agent: this.config.agent,
-            timeout: this.config.timeout,
+            timeout: { request: this.config.timeout },
             responseType: json ? 'json' : 'text',
+            ...(this.config.agent ? { agent: this.config.agent } : {}),
         });
         return res;
     }
@@ -591,40 +613,40 @@ class QBittorrent {
         return hashes;
     }
     _normalizeTorrentData(torrent) {
-        let state = shared_torrent_1.TorrentState.unknown;
+        let state = NormalizedTorrentState.unknown;
         switch (torrent.state) {
-            case types_1.TorrentState.ForcedDL:
-            case types_1.TorrentState.MetaDL:
-                state = shared_torrent_1.TorrentState.downloading;
+            case TorrentState.ForcedDL:
+            case TorrentState.MetaDL:
+                state = NormalizedTorrentState.downloading;
                 break;
-            case types_1.TorrentState.Allocating:
+            case TorrentState.Allocating:
                 // state = 'stalledDL';
-                state = shared_torrent_1.TorrentState.queued;
+                state = NormalizedTorrentState.queued;
                 break;
-            case types_1.TorrentState.ForcedUP:
-                state = shared_torrent_1.TorrentState.seeding;
+            case TorrentState.ForcedUP:
+                state = NormalizedTorrentState.seeding;
                 break;
-            case types_1.TorrentState.PausedDL:
-                state = shared_torrent_1.TorrentState.paused;
+            case TorrentState.PausedDL:
+                state = NormalizedTorrentState.paused;
                 break;
-            case types_1.TorrentState.PausedUP:
+            case TorrentState.PausedUP:
                 // state = 'completed';
-                state = shared_torrent_1.TorrentState.paused;
+                state = NormalizedTorrentState.paused;
                 break;
-            case types_1.TorrentState.QueuedDL:
-            case types_1.TorrentState.QueuedUP:
-                state = shared_torrent_1.TorrentState.queued;
+            case TorrentState.QueuedDL:
+            case TorrentState.QueuedUP:
+                state = NormalizedTorrentState.queued;
                 break;
-            case types_1.TorrentState.CheckingDL:
-            case types_1.TorrentState.CheckingUP:
-            case types_1.TorrentState.QueuedForChecking:
-            case types_1.TorrentState.CheckingResumeData:
-            case types_1.TorrentState.Moving:
-                state = shared_torrent_1.TorrentState.checking;
+            case TorrentState.CheckingDL:
+            case TorrentState.CheckingUP:
+            case TorrentState.QueuedForChecking:
+            case TorrentState.CheckingResumeData:
+            case TorrentState.Moving:
+                state = NormalizedTorrentState.checking;
                 break;
-            case types_1.TorrentState.Unknown:
-            case types_1.TorrentState.MissingFiles:
-                state = shared_torrent_1.TorrentState.error;
+            case TorrentState.Unknown:
+            case TorrentState.MissingFiles:
+                state = NormalizedTorrentState.error;
                 break;
             default:
                 break;
@@ -658,4 +680,3 @@ class QBittorrent {
         return result;
     }
 }
-exports.QBittorrent = QBittorrent;

package/dist/{types.d.ts → src/types.d.ts}

@@ -1,32 +1,22 @@
-import { AllClientData, NormalizedTorrent } from '@ctrl/shared-torrent';
-/**
- * refine the normalized torrent options for qbittorrent
- */
-export interface NormalizedTorrentQbittorrent extends NormalizedTorrent {
-    id: string;
-}
-export interface AllClientDataQbittorrent extends AllClientData {
-    torrents: NormalizedTorrentQbittorrent[];
-}
 export interface BuildInfo {
     /**
-     * 	QT version
+     * QT version
      */
     qt: string;
     /**
-     * 	libtorrent version
+     * libtorrent version
      */
     libtorrent: string;
     /**
-     * 	Boost version
+     * Boost version
      */
     boost: string;
     /**
-     * 	OpenSSL version
+     * OpenSSL version
      */
     openssl: string;
     /**
-     * 	Application bitness (e.g. 64-bit)
+     * Application bitness (e.g. 64-bit)
      */
     bitness: string;
 }
@@ -176,8 +166,8 @@ export interface Torrent {
      */
     category: string;
 }
-export declare type Categories = Record<string, Category>;
-export interface Category {
+export declare type TorrentCategories = Record<string, Category>;
+interface Category {
     name: string;
     savePath: string;
 }
@@ -544,9 +534,10 @@ export interface AddTorrentOptions {
      */
     paused: TrueFalseStr;
     /**
-     * Create the root folder. Possible values are true, false, unset (default)
+     * Control filesystem structure for content (added in Web API v2.7)
+     * Migrating from rootFolder example rootFolder ? 'Original' :  'NoSubfolder'
      */
-    root_folder: TrueFalseStr;
+    contentLayout: 'Original' | 'Subfolder' | 'NoSubfolder';
     /**
      * Rename torrent
      */
@@ -559,6 +550,14 @@ export interface AddTorrentOptions {
      * Set torrent download speed limit. Unit in bytes/second
      */
     dlLimit: number;
+    /**
+     * Set torrent share ratio limit
+     */
+    ratioLimit: number;
+    /**
+     * Set torrent seeding time limit. Unit in seconds
+     */
+    seedingTimeLimit: number;
     /**
      * Whether Automatic Torrent Management should be used, disables use of savepath
      */
@@ -670,9 +669,13 @@ export interface Preferences {
      */
     temp_path: string;
     /**
-     * Property: directory to watch for torrent files, value: where torrents loaded from this directory should be downloaded to (see list of possible values below). Slashes are used as path separators; multiple key/value pairs can be specified
+     * Directory to watch for torrent files, value: where torrents loaded from this directory should be downloaded to (see list of possible values below). Slashes are used as path separators; multiple key/value pairs can be specified
+     * Possible values of scan_dirs:
+     * 0	Download to the monitored folder
+     * 1	Download to the default save path
+     * "/path/to/download/to"	Download to this path
      */
-    scan_dirs: Record<string, unknown>;
+    scan_dirs: Record<string, 0 | 1 | string>;
     /**
      * Path to directory to copy .torrent files to. Slashes are used as path separators
      */
@@ -808,11 +811,14 @@ export interface Preferences {
     /**
      * True if the advanced libtorrent option piece_extent_affinity is enabled
      */
-    piece_extent_affinity: boolean;
+    enable_piece_extent_affinity: boolean;
     /**
-     * True if uTP protocol should be enabled; this option is only available in qBittorent built against libtorrent version 0.16.X and higher
+     * Bittorrent Protocol to use
+     * 0	TCP and μTP
+     * 1	TCP
+     * 2	μTP
      */
-    enable_utp: boolean;
+    bittorrent_protocol: 0 | 1 | 2;
     /**
      * True if [du]l_limit should be applied to uTP connections; this option is only available in qBittorent built against libtorrent version 0.16.X and higher
      */
@@ -855,20 +861,22 @@ export interface Preferences {
     schedule_to_min: number;
     /**
      * Scheduler days. See possible values here below
-     */
-    scheduler_days: number;
+     * 0	Every day
+     * 1	Every weekday
+     * 2	Every weekend
+     * 3	Every Monday
+     * 4	Every Tuesday
+     * 5	Every Wednesday
+     * 6	Every Thursday
+     * 7	Every Friday
+     * 8	Every Saturday
+     * 9	Every Sunday
+     */
+    scheduler_days: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
     /**
      * True if DHT is enabled
      */
     dht: boolean;
-    /**
-     * True if DHT port should match TCP port
-     */
-    dhtSameAsBT: boolean;
-    /**
-     * DHT port if dhtSameAsBT is false
-     */
-    dht_port: number;
     /**
      * True if PeX is enabled
      */
@@ -879,10 +887,13 @@ export interface Preferences {
     lsd: boolean;
     /**
      * See list of possible values here below
+     * 0	Prefer encryption
+     * 1	Force encryption on
+     * 2	Force encryption off
      */
-    encryption: number;
+    encryption: 0 | 1 | 2;
     /**
-     * If true anonymous mode will be enabled; read more [here](Anonymous-Mode); this option is only available in qBittorent built against libtorrent version 0.16.X and higher
+     * If true anonymous mode will be enabled; read more [here](https://github.com/qbittorrent/qBittorrent/wiki/Anonymous-Mode); this option is only available in qBittorent built against libtorrent version 0.16.X and higher
      */
     anonymous_mode: boolean;
     /**
@@ -901,10 +912,6 @@ export interface Preferences {
      * True if peer and web seed connections should be proxified; this option will have any effect only in qBittorent built against libtorrent version 0.16.X and higher
      */
     proxy_peer_connections: boolean;
-    /**
-     * True if the connections not supported by the proxy are disabled
-     */
-    force_proxy: boolean;
     /**
      * True proxy requires authentication; doesn't apply to SOCKS4 proxies
      */
@@ -917,6 +924,10 @@ export interface Preferences {
      * Password for proxy authentication
      */
     proxy_password: string;
+    /**
+     * True if proxy is only used for torrents
+     */
+    proxy_torrents_only: boolean;
     /**
      * True if external IP filter should be enabled
      */
@@ -973,6 +984,14 @@ export interface Preferences {
      * WebUI access ban duration in seconds
      */
     web_ui_ban_duration: number;
+    /**
+     * Seconds until WebUI is automatically signed off
+     */
+    web_ui_session_timeout: number;
+    /**
+     * True if WebUI host header validation is enabled
+     */
+    web_ui_host_header_validation_enabled: boolean;
     /**
      * True if authentication challenge for loopback address (127.0.0.1) should be disabled
      */
@@ -1005,6 +1024,14 @@ export interface Preferences {
      * SSL certificate contents (this is a not a path)
      */
     ssl_cert: string;
+    /**
+     * For API ≥ v2.0.1: Path to SSL keyfile
+     */
+    web_ui_https_key_path: string;
+    /**
+     * For API ≥ v2.0.1: Path to SSL certificate
+     */
+    web_ui_https_cert_path: string;
     /**
      * True if server DNS should be updated dynamically
      */
@@ -1041,5 +1068,157 @@ export interface Preferences {
      * Enable auto-downloading of torrents from the RSS feeds
      */
     rss_auto_downloading_enabled: boolean;
+    /**
+     * For API ≥ v2.5.1: Enable downloading of repack/proper Episodes
+     */
+    rss_download_repack_proper_episodes: boolean;
+    /**
+     * For API ≥ v2.5.1: List of RSS Smart Episode Filters
+     */
+    rss_smart_episode_filters: string;
+    /**
+     * Enable automatic adding of trackers to new torrents
+     */
+    add_trackers_enabled: boolean;
+    /**
+     * List of trackers to add to new torrent
+     */
+    add_trackers: string;
+    /**
+     * For API ≥ v2.5.1: Enable custom http headers
+     */
+    web_ui_use_custom_http_headers_enabled: boolean;
+    /**
+     * For API ≥ v2.5.1: List of custom http headers
+     */
+    web_ui_custom_http_headers: string;
+    /**
+     * True enables max seeding time
+     */
+    max_seeding_time_enabled: boolean;
+    /**
+     * Number of minutes to seed a torrent
+     */
+    max_seeding_time: number;
+    /**
+     * TODO
+     */
+    announce_ip: string;
+    /**
+     * True always announce to all tiers
+     */
+    announce_to_all_tiers: boolean;
+    /**
+     * True always announce to all trackers in a tier
+     */
+    announce_to_all_trackers: boolean;
+    /**
+     * Number of asynchronous I/O threads
+     */
+    async_io_threads: number;
+    /**
+     * List of banned IPs
+     */
+    banned_IPs: string;
+    /**
+     * Outstanding memory when checking torrents in MiB
+     */
+    checking_memory_use: number;
+    /**
+     * IP Address to bind to. Empty String means All addresses
+     */
+    current_interface_address: string;
+    /**
+     * Network Interface used
+     */
+    current_network_interface: string;
+    /**
+     * Disk cache used in MiB
+     */
+    disk_cache: number;
+    /**
+     * Disk cache expiry interval in seconds
+     */
+    disk_cache_ttl: number;
+    /**
+     * Port used for embedded tracker
+     */
+    embedded_tracker_port: number;
+    /**
+     * True enables coalesce reads & writes
+     */
+    enable_coalesce_read_write: boolean;
+    /**
+     * True enables embedded tracker
+     */
+    enable_embedded_tracker: boolean;
+    /**
+     * True allows multiple connections from the same IP address
+     */
+    enable_multi_connections_from_same_ip: boolean;
+    /**
+     * True enables os cache
+     */
+    enable_os_cache: boolean;
+    /**
+     * True enables sending of upload piece suggestions
+     */
+    enable_upload_suggestions: boolean;
+    /**
+     * File pool size
+     */
+    file_pool_size: number;
+    /**
+     * Maximal outgoing port (0: Disabled)
+     */
+    outgoing_ports_max: number;
+    /**
+     * Minimal outgoing port (0: Disabled)
+     */
+    outgoing_ports_min: number;
+    /**
+     * True rechecks torrents on completion
+     */
+    recheck_completed_torrents: boolean;
+    /**
+     * True resolves peer countries
+     */
+    resolve_peer_countries: boolean;
+    /**
+     * Save resume data interval in min
+     */
+    save_resume_data_interval: number;
+    /**
+     * Send buffer low watermark in KiB
+     */
+    send_buffer_low_watermark: number;
+    /**
+     * Send buffer watermark in KiB
+     */
+    send_buffer_watermark: number;
+    /**
+     * Send buffer watermark factor in percent
+     */
+    send_buffer_watermark_factor: number;
+    /**
+     * Socket backlog size
+     */
+    socket_backlog_size: number;
+    /**
+     * Upload choking algorithm used (see list of possible values below)
+     */
+    upload_choking_algorithm: number;
+    /**
+     * Upload slots behavior used (see list of possible values below)
+     */
+    upload_slots_behavior: number;
+    /**
+     * UPnP lease duration (0: Permanent lease)
+     */
+    upnp_lease_duration: number;
+    /**
+     * μTP-TCP mixed mode algorithm (see list of possible values below)
+     */
+    utp_tcp_mixed_mode: number;
 }
 export {};

package/dist/{types.js → src/types.js}

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TorrentPieceState = exports.TorrentFilePriority = exports.TorrentTrackerStatus = exports.TorrentState = void 0;
-var TorrentState;
+export var TorrentState;
 (function (TorrentState) {
     /**
      * Some error occurred, applies to paused torrents
@@ -80,8 +77,8 @@ var TorrentState;
      * Torrent data files is missing
      */
     TorrentState["MissingFiles"] = "missingFiles";
-})(TorrentState = exports.TorrentState || (exports.TorrentState = {}));
-var TorrentTrackerStatus;
+})(TorrentState || (TorrentState = {}));
+export var TorrentTrackerStatus;
 (function (TorrentTrackerStatus) {
     /**
      * Tracker is disabled (used for DHT, PeX, and LSD)
@@ -103,8 +100,8 @@ var TorrentTrackerStatus;
      * Tracker has not been contacted yet
      */
     TorrentTrackerStatus[TorrentTrackerStatus["Waiting"] = 4] = "Waiting";
-})(TorrentTrackerStatus = exports.TorrentTrackerStatus || (exports.TorrentTrackerStatus = {}));
-var TorrentFilePriority;
+})(TorrentTrackerStatus || (TorrentTrackerStatus = {}));
+export var TorrentFilePriority;
 (function (TorrentFilePriority) {
     /**
      * Do not download
@@ -122,8 +119,8 @@ var TorrentFilePriority;
      * Maximal priority
      */
     TorrentFilePriority[TorrentFilePriority["MaxPriority"] = 7] = "MaxPriority";
-})(TorrentFilePriority = exports.TorrentFilePriority || (exports.TorrentFilePriority = {}));
-var TorrentPieceState;
+})(TorrentFilePriority || (TorrentFilePriority = {}));
+export var TorrentPieceState;
 (function (TorrentPieceState) {
     /**
      * Not downloaded yet
@@ -137,4 +134,4 @@ var TorrentPieceState;
      * Already downloaded
      */
     TorrentPieceState[TorrentPieceState["Downloaded"] = 2] = "Downloaded";
-})(TorrentPieceState = exports.TorrentPieceState || (exports.TorrentPieceState = {}));
+})(TorrentPieceState || (TorrentPieceState = {}));

package/package.json

@@ -1,14 +1,16 @@
 {
   "name": "@ctrl/qbittorrent",
-  "version": "2.10.0",
+  "version": "4.0.0",
   "description": "TypeScript api wrapper for qbittorrent using got",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",
   "repository": "scttcper/qbittorrent",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "homepage": "https://qbittorrent.vercel.app",
+  "type": "module",
+  "main": "./dist/src/index.js",
+  "typings": "./dist/src/index.d.ts",
   "files": [
-    "dist"
+    "dist/src"
   ],
   "sideEffects": false,
   "publishConfig": {
@@ -22,49 +24,49 @@
     "lint": "eslint --ext .js,.ts, .",
     "lint:fix": "eslint --fix --ext .js,.ts, .",
     "prepare": "npm run build",
-    "build": "tsc -p tsconfig.build.json",
+    "build": "tsc",
     "build:docs": "typedoc",
-    "test": "jest --runInBand",
-    "test:watch": "jest --watch --runInBand",
-    "test:ci": "jest --ci --reporters=default --reporters=jest-junit --runInBand --coverage"
+    "test": "ava",
+    "test:watch": "ava --watch",
+    "test:ci": "c8 --reporter=text --reporter=lcov ava --tap | tap-junit -o junit -n test-result.xml"
   },
   "dependencies": {
-    "@ctrl/shared-torrent": "^3.0.5",
-    "@ctrl/torrent-file": "^1.3.3",
-    "@ctrl/url-join": "^1.0.4",
-    "form-data": "^4.0.0",
-    "got": "^11.8.2",
+    "@ctrl/magnet-link": "^3.1.0",
+    "@ctrl/shared-torrent": "^4.1.0",
+    "@ctrl/torrent-file": "^2.0.1",
+    "@ctrl/url-join": "^2.0.0",
+    "formdata-node": "^4.3.2",
+    "got": "^12.0.4",
     "tough-cookie": "^4.0.0"
   },
   "devDependencies": {
-    "@babel/plugin-transform-modules-commonjs": "7.16.0",
-    "@babel/preset-typescript": "7.16.0",
-    "@ctrl/eslint-config": "3.1.1",
-    "@jest/globals": "27.3.1",
-    "@types/form-data": "2.5.0",
-    "@types/node": "16.11.6",
-    "@types/tough-cookie": "4.0.1",
-    "jest-junit": "13.0.0",
-    "jest": "27.3.1",
-    "p-wait-for": "3.2.0",
-    "typedoc": "0.22.8",
-    "typescript": "4.4.4"
+    "@ctrl/eslint-config": "3.4.2",
+    "@sindresorhus/tsconfig": "2.0.0",
+    "@types/node": "17.0.31",
+    "@types/tough-cookie": "4.0.2",
+    "ava": "4.2.0",
+    "c8": "7.11.2",
+    "p-wait-for": "4.1.0",
+    "tap-junit": "5.0.2",
+    "ts-node": "10.7.0",
+    "typedoc": "0.22.15",
+    "typescript": "4.6.4"
   },
-  "jest": {
-    "testEnvironment": "node"
-  },
-  "babel": {
-    "presets": [
-      "@babel/preset-typescript"
+  "ava": {
+    "files": [
+      "test/**/*.spec.ts"
     ],
-    "plugins": [
-      "@babel/plugin-transform-modules-commonjs"
+    "extensions": {
+      "ts": "module"
+    },
+    "nodeArguments": [
+      "--loader=ts-node/esm"
     ]
   },
   "release": {
     "branch": "master"
   },
   "engines": {
-    "node": ">=10.19.0"
+    "node": ">=14.16"
   }
 }