@ctrl/qbittorrent 5.1.0 → 6.0.0

package/README.md

@@ -105,3 +105,19 @@ All of the following npm modules provide the same normalized functions along wit
 deluge - https://github.com/scttcper/deluge  
 transmission - https://github.com/scttcper/transmission  
 utorrent - https://github.com/scttcper/utorrent
+
+### Start a test docker container
+
+```
+docker run -d \
+  --name=qbittorrent \
+  -e PUID=1000 \
+  -e PGID=1000 \
+  -e TZ=Etc/UTC \
+  -e WEBUI_PORT=8080 \
+  -p 8080:8080 \
+  -p 6881:6881 \
+  -p 6881:6881/udp \
+  --restart unless-stopped \
+  lscr.io/linuxserver/qbittorrent:latest
+```

package/dist/src/qbittorrent.js

@@ -110,10 +110,10 @@ export class QBittorrent {
         if (filter) {
             params.filter = filter;
         }
-        if (category) {
+        if (category !== undefined) {
             params.category = category;
         }
-        if (tag) {
+        if (tag !== undefined) {
             params.tag = tag;
         }
         if (offset !== undefined) {
@@ -330,7 +330,7 @@ export class QBittorrent {
         const params = {
             hashes: this._normalizeHashes(hashes),
         };
-        await this.request('/torrents/pause', 'GET', params);
+        await this.request('/torrents/pause', 'POST', undefined, undefined, params);
         return true;
     }
     /**
@@ -340,7 +340,7 @@ export class QBittorrent {
         const params = {
             hashes: this._normalizeHashes(hashes),
         };
-        await this.request('/torrents/resume', 'GET', params);
+        await this.request('/torrents/resume', 'POST', undefined, undefined, params);
         return true;
     }
     /**
@@ -351,7 +351,7 @@ export class QBittorrent {
             hashes: this._normalizeHashes(hashes),
             deleteFiles,
         };
-        await this.request('/torrents/delete', 'GET', params);
+        await this.request('/torrents/delete', 'POST', undefined, undefined, params);
         return true;
     }
     /**
@@ -361,7 +361,7 @@ export class QBittorrent {
         const params = {
             hashes: this._normalizeHashes(hashes),
         };
-        await this.request('/torrents/recheck', 'GET', params);
+        await this.request('/torrents/recheck', 'POST', undefined, undefined, params);
         return true;
     }
     /**
@@ -371,7 +371,7 @@ export class QBittorrent {
         const params = {
             hashes: this._normalizeHashes(hashes),
         };
-        await this.request('/torrents/reannounce', 'GET', params);
+        await this.request('/torrents/reannounce', 'POST', undefined, undefined, params);
         return true;
     }
     async addTorrent(torrent, options = {}) {
@@ -491,7 +491,7 @@ export class QBittorrent {
      */
     async addTrackers(hash, urls) {
         const params = { hash, urls };
-        await this.request('/torrents/addTrackers', 'GET', params);
+        await this.request('/torrents/addTrackers', 'POST', undefined, undefined, params);
         return true;
     }
     /**
@@ -499,7 +499,7 @@ export class QBittorrent {
      */
     async editTrackers(hash, origUrl, newUrl) {
         const params = { hash, origUrl, newUrl };
-        await this.request('/torrents/editTrackers', 'GET', params);
+        await this.request('/torrents/editTrackers', 'POST', undefined, undefined, params);
         return true;
     }
     /**
@@ -507,7 +507,7 @@ export class QBittorrent {
      */
     async removeTrackers(hash, urls) {
         const params = { hash, urls };
-        await this.request('/torrents/editTrackers', 'GET', params);
+        await this.request('/torrents/removeTrackers', 'POST', undefined, undefined, params);
         return true;
     }
     /**
@@ -517,7 +517,7 @@ export class QBittorrent {
         const params = {
             hashes: this._normalizeHashes(hashes),
         };
-        await this.request('/torrents/increasePrio', 'GET', params);
+        await this.request('/torrents/increasePrio', 'POST', undefined, undefined, params);
         return true;
     }
     /**
@@ -527,7 +527,7 @@ export class QBittorrent {
         const params = {
             hashes: this._normalizeHashes(hashes),
         };
-        await this.request('/torrents/decreasePrio', 'GET', params);
+        await this.request('/torrents/decreasePrio', 'POST', undefined, undefined, params);
         return true;
     }
     /**
@@ -537,7 +537,7 @@ export class QBittorrent {
         const params = {
             hashes: this._normalizeHashes(hashes),
         };
-        await this.request('/torrents/topPrio', 'GET', params);
+        await this.request('/torrents/topPrio', 'POST', undefined, undefined, params);
         return true;
     }
     /**
@@ -547,7 +547,7 @@ export class QBittorrent {
         const params = {
             hashes: this._normalizeHashes(hashes),
         };
-        await this.request('/torrents/bottomPrio', 'GET', params);
+        await this.request('/torrents/bottomPrio', 'POST', undefined, undefined, params);
         return true;
     }
     /**
@@ -568,6 +568,7 @@ export class QBittorrent {
             // allow proxy agent
             ...(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) {
             throw new Error('Cookie not found. Auth Failed.');
         }

package/dist/src/types.d.ts

@@ -20,7 +20,7 @@ export interface BuildInfo {
      */
     bitness: string;
 }
-export declare type TorrentFilters = 'all' | 'downloading' | 'completed' | 'paused' | 'active' | 'inactive' | 'resumed' | 'stalled' | 'stalled_uploading' | 'stalled_downloading';
+export type TorrentFilters = 'all' | 'downloading' | 'completed' | 'paused' | 'active' | 'inactive' | 'resumed' | 'stalled' | 'stalled_uploading' | 'stalled_downloading';
 export interface Torrent {
     /**
      * Torrent name
@@ -175,7 +175,7 @@ export interface Torrent {
      */
     tags: string;
 }
-export declare type TorrentCategories = Record<string, Category>;
+export type TorrentCategories = Record<string, Category>;
 interface Category {
     name: string;
     savePath: string;
@@ -521,7 +521,7 @@ export declare enum TorrentPieceState {
      */
     Downloaded = 2
 }
-declare type TrueFalseStr = 'true' | 'false';
+type TrueFalseStr = 'true' | 'false';
 export interface AddTorrentOptions {
     /**
      * not totally sure what its for but its required

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/qbittorrent",
-  "version": "5.1.0",
+  "version": "6.0.0",
   "description": "TypeScript api wrapper for qbittorrent using got",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",
@@ -32,24 +32,24 @@
   },
   "dependencies": {
     "@ctrl/magnet-link": "^3.1.1",
-    "@ctrl/shared-torrent": "^4.3.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.5.0",
+    "got": "^12.6.0",
     "tough-cookie": "^4.1.2"
   },
   "devDependencies": {
-    "@ctrl/eslint-config": "3.5.0",
+    "@ctrl/eslint-config": "3.7.0",
     "@sindresorhus/tsconfig": "3.0.1",
-    "@types/node": "18.7.18",
+    "@types/node": "18.16.3",
     "@types/tough-cookie": "4.0.2",
-    "@vitest/coverage-c8": "0.23.4",
-    "c8": "7.12.0",
-    "p-wait-for": "5.0.0",
-    "typedoc": "0.23.15",
-    "typescript": "4.8.3",
-    "vitest": "0.23.4"
+    "@vitest/coverage-c8": "0.31.0",
+    "c8": "7.13.0",
+    "p-wait-for": "5.0.2",
+    "typedoc": "0.24.6",
+    "typescript": "5.0.4",
+    "vitest": "0.31.0"
   },
   "release": {
     "branches": [