@ctrl/qbittorrent 3.0.0 → 4.0.1

package/dist/src/qbittorrent.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
 import { Options as GotOptions, Response } from 'got';
 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';

package/dist/src/qbittorrent.js

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-redundant-type-constituents */
 /* eslint-disable @typescript-eslint/ban-types */
 import { existsSync } from 'fs';
 import { URLSearchParams } from 'url';
@@ -373,7 +374,6 @@ export class QBittorrent {
         return true;
     }
     async addTorrent(torrent, options = {}) {
-        var _a, _b;
         const form = new FormData();
         // remove options.filename, not used in form
         if (options.filename) {
@@ -382,7 +382,7 @@ export class QBittorrent {
         const type = { type: 'application/x-bittorrent' };
         if (typeof torrent === 'string') {
             if (existsSync(torrent)) {
-                const file = await fileFromPath(torrent, (_a = options.filename) !== null && _a !== void 0 ? _a : 'torrent', type);
+                const file = await fileFromPath(torrent, options.filename ?? 'torrent', type);
                 form.set('file', file);
             }
             else {
@@ -390,7 +390,7 @@ export class QBittorrent {
             }
         }
         else {
-            const file = new File([torrent], (_b = options.filename) !== null && _b !== void 0 ? _b : 'torrent', type);
+            const file = new File([torrent], options.filename ?? 'torrent', type);
             form.set('file', file);
         }
         if (options) {
@@ -542,14 +542,13 @@ export class QBittorrent {
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#login}
      */
     async login() {
-        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 : '',
+                username: this.config.username ?? '',
+                password: this.config.password ?? '',
             },
             followRedirect: false,
             retry: { limit: 0 },
@@ -575,7 +574,6 @@ export class QBittorrent {
     }
     // eslint-disable-next-line max-params
     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();
             if (!authed) {
@@ -588,7 +586,7 @@ export class QBittorrent {
             resolveBodyOnly: false,
             method,
             headers: {
-                Cookie: `SID=${(_a = this._sid) !== null && _a !== void 0 ? _a : ''}`,
+                Cookie: `SID=${this._sid ?? ''}`,
                 ...headers,
             },
             retry: { limit: 0 },

package/dist/src/types.d.ts

@@ -1,22 +1,22 @@
 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;
 }
@@ -534,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
      */
@@ -549,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
      */
@@ -660,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
      */
@@ -798,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
      */
@@ -845,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
      */
@@ -869,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;
     /**
@@ -891,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
      */
@@ -907,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
      */
@@ -963,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
      */
@@ -995,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
      */
@@ -1031,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/src/types.js

@@ -77,7 +77,7 @@ export var TorrentState;
      * Torrent data files is missing
      */
     TorrentState["MissingFiles"] = "missingFiles";
-})(TorrentState || (TorrentState = {}));
+})(TorrentState = TorrentState || (TorrentState = {}));
 export var TorrentTrackerStatus;
 (function (TorrentTrackerStatus) {
     /**
@@ -100,7 +100,7 @@ export var TorrentTrackerStatus;
      * Tracker has not been contacted yet
      */
     TorrentTrackerStatus[TorrentTrackerStatus["Waiting"] = 4] = "Waiting";
-})(TorrentTrackerStatus || (TorrentTrackerStatus = {}));
+})(TorrentTrackerStatus = TorrentTrackerStatus || (TorrentTrackerStatus = {}));
 export var TorrentFilePriority;
 (function (TorrentFilePriority) {
     /**
@@ -119,7 +119,7 @@ export var TorrentFilePriority;
      * Maximal priority
      */
     TorrentFilePriority[TorrentFilePriority["MaxPriority"] = 7] = "MaxPriority";
-})(TorrentFilePriority || (TorrentFilePriority = {}));
+})(TorrentFilePriority = TorrentFilePriority || (TorrentFilePriority = {}));
 export var TorrentPieceState;
 (function (TorrentPieceState) {
     /**
@@ -134,4 +134,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": "3.0.0",
+  "version": "4.0.1",
   "description": "TypeScript api wrapper for qbittorrent using got",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",
@@ -8,7 +8,7 @@
   "homepage": "https://qbittorrent.vercel.app",
   "type": "module",
   "main": "./dist/src/index.js",
-  "typings": "./dist/src/index.d.ts",
+  "types": "./dist/src/index.d.ts",
   "files": [
     "dist/src"
   ],
@@ -26,44 +26,34 @@
     "prepare": "npm run build",
     "build": "tsc",
     "build:docs": "typedoc",
-    "test": "ava",
-    "test:watch": "ava --watch",
-    "test:ci": "c8 --reporter=text --reporter=lcov ava"
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:ci": "vitest run --coverage --reporter=junit --outputFile=./junit.xml"
   },
   "dependencies": {
-    "@ctrl/magnet-link": "^3.1.0",
-    "@ctrl/shared-torrent": "^4.1.0",
+    "@ctrl/magnet-link": "^3.1.1",
+    "@ctrl/shared-torrent": "^4.1.1",
     "@ctrl/torrent-file": "^2.0.1",
     "@ctrl/url-join": "^2.0.0",
     "formdata-node": "^4.3.2",
-    "got": "^12.0.1",
+    "got": "^12.1.0",
     "tough-cookie": "^4.0.0"
   },
   "devDependencies": {
-    "@ctrl/eslint-config": "3.3.1",
-    "@sindresorhus/tsconfig": "2.0.0",
-    "@types/node": "17.0.21",
-    "@types/tough-cookie": "4.0.1",
-    "ava": "4.0.1",
-    "c8": "7.11.0",
+    "@ctrl/eslint-config": "3.4.4",
+    "@sindresorhus/tsconfig": "3.0.1",
+    "@types/node": "17.0.40",
+    "@types/tough-cookie": "4.0.2",
+    "c8": "7.11.3",
     "p-wait-for": "4.1.0",
-    "ts-node": "10.5.0",
-    "typedoc": "0.22.12",
-    "typescript": "4.5.5"
-  },
-  "ava": {
-    "files": [
-      "test/**/*.spec.ts"
-    ],
-    "extensions": {
-      "ts": "module"
-    },
-    "nodeArguments": [
-      "--loader=ts-node/esm"
-    ]
+    "typedoc": "0.22.17",
+    "typescript": "4.7.3",
+    "vitest": "0.14.0"
   },
   "release": {
-    "branch": "master"
+    "branches": [
+      "master"
+    ]
   },
   "engines": {
     "node": ">=14.16"