@ctrl/qbittorrent 9.2.0 → 9.4.0

package/dist/src/normalizeTorrentData.js

@@ -14,6 +14,7 @@ export function normalizeTorrentData(torrent) {
             stateMessage = 'qBittorrent is reporting an error';
             break;
         case TorrentState.PausedDL:
+        case TorrentState.StoppedDL:
             state = NormalizedTorrentState.paused;
             break;
         case TorrentState.QueuedDL: // queuing is enabled and torrent is queued for download
@@ -35,7 +36,8 @@ export function normalizeTorrentData(torrent) {
             state = NormalizedTorrentState.warning;
             stateMessage = 'The download is stalled with no connection';
             break;
-        case TorrentState.PausedUP: // torrent is paused and has finished downloading:
+        case TorrentState.StoppedUP: // torrent is paused and has finished downloading
+        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

package/dist/src/qbittorrent.d.ts

@@ -1,6 +1,6 @@
 import type { Jsonify } from 'type-fest';
 import type { AddTorrentOptions as NormalizedAddTorrentOptions, AllClientData, NormalizedTorrent, TorrentClient, TorrentClientConfig, TorrentClientState } from '@ctrl/shared-torrent';
-import type { AddMagnetOptions, AddTorrentOptions, BuildInfo, Preferences, Torrent, TorrentCategories, TorrentFile, TorrentFilePriority, TorrentFilters, TorrentPeersResponse, TorrentPieceState, TorrentProperties, TorrentTrackers, WebSeed } from './types.js';
+import type { AddMagnetOptions, AddTorrentOptions, BuildInfo, DownloadSpeed, Preferences, Torrent, TorrentCategories, TorrentFile, TorrentFilePriority, TorrentFilters, TorrentPeersResponse, TorrentPieceState, TorrentProperties, TorrentTrackers, UploadSpeed, WebSeed } from './types.js';
 interface QBittorrentState extends TorrentClientState {
     auth?: {
         /**
@@ -48,6 +48,22 @@ export declare class QBittorrent implements TorrentClient {
      */
     getBuildInfo(): Promise<BuildInfo>;
     getTorrent(hash: string): Promise<NormalizedTorrent>;
+    /**
+     * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-download-limit}
+     */
+    getTorrentDownloadLimit(hash: string | string[]): Promise<DownloadSpeed>;
+    /**
+     * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#set-torrent-download-limit}
+     */
+    setTorrentDownloadLimit(hash: string | string[], limitBytesPerSecond: number): Promise<boolean>;
+    /**
+     * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-upload-limit}
+     */
+    getTorrentUploadLimit(hash: string | string[]): Promise<UploadSpeed>;
+    /**
+     * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#set-torrent-upload-limit}
+     */
+    setTorrentUploadLimit(hash: string | string[], limitBytesPerSecond: number): Promise<boolean>;
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-application-preferences}
      */

package/dist/src/qbittorrent.js

@@ -76,6 +76,46 @@ export class QBittorrent {
         }
         return normalizeTorrentData(torrentData);
     }
+    /**
+     * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-download-limit}
+     */
+    async getTorrentDownloadLimit(hash) {
+        const downloadLimit = await this.request('/torrents/downloadLimit', 'POST', undefined, objToUrlSearchParams({
+            hashes: normalizeHashes(hash),
+        }), undefined);
+        return downloadLimit;
+    }
+    /**
+     * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#set-torrent-download-limit}
+     */
+    async setTorrentDownloadLimit(hash, limitBytesPerSecond) {
+        const data = {
+            limit: limitBytesPerSecond.toString(),
+            hashes: normalizeHashes(hash),
+        };
+        await this.request('/torrents/setDownloadLimit', 'POST', undefined, objToUrlSearchParams(data));
+        return true;
+    }
+    /**
+     * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-upload-limit}
+     */
+    async getTorrentUploadLimit(hash) {
+        const UploadLimit = await this.request('/torrents/uploadLimit', 'POST', undefined, objToUrlSearchParams({
+            hashes: normalizeHashes(hash),
+        }), undefined);
+        return UploadLimit;
+    }
+    /**
+     * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#set-torrent-upload-limit}
+     */
+    async setTorrentUploadLimit(hash, limitBytesPerSecond) {
+        const data = {
+            limit: limitBytesPerSecond.toString(),
+            hashes: normalizeHashes(hash),
+        };
+        await this.request('/torrents/setUploadLimit', 'POST', undefined, objToUrlSearchParams(data));
+        return true;
+    }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-application-preferences}
      */

package/dist/src/types.d.ts

@@ -187,10 +187,12 @@ export declare enum TorrentState {
     Error = "error",
     /**
      * Torrent is paused and has finished downloading
+     * ``pausedUP`` was renamed to ``stoppedUP`` in Web API v2.11.0
      */
     PausedUP = "pausedUP",
     /**
      * Torrent is paused and has NOT finished downloading
+     * ``pausedDL`` was renamed to ``stoppedDL`` in Web API v2.11.0
      */
     PausedDL = "pausedDL",
     /**
@@ -221,6 +223,14 @@ export declare enum TorrentState {
      * Torrent is being downloaded and data is being transferred
      */
     Downloading = "downloading",
+    /**
+     * Torrent has been stopped while downloading
+     */
+    StoppedDL = "stoppedDL",
+    /**
+     * Torrent has been stopped while downloading
+     */
+    StoppedUP = "stoppedUP",
     /**
      * Torrent is being downloaded, but no connection were made
      */
@@ -1268,4 +1278,6 @@ export interface TorrentPeer {
     up_speed?: number;
     uploaded?: number;
 }
+export type DownloadSpeed = Record<string, number>;
+export type UploadSpeed = Record<string, number>;
 export {};

package/dist/src/types.js

@@ -6,10 +6,12 @@ export var TorrentState;
     TorrentState["Error"] = "error";
     /**
      * Torrent is paused and has finished downloading
+     * ``pausedUP`` was renamed to ``stoppedUP`` in Web API v2.11.0
      */
     TorrentState["PausedUP"] = "pausedUP";
     /**
      * Torrent is paused and has NOT finished downloading
+     * ``pausedDL`` was renamed to ``stoppedDL`` in Web API v2.11.0
      */
     TorrentState["PausedDL"] = "pausedDL";
     /**
@@ -40,6 +42,14 @@ export var TorrentState;
      * Torrent is being downloaded and data is being transferred
      */
     TorrentState["Downloading"] = "downloading";
+    /**
+     * Torrent has been stopped while downloading
+     */
+    TorrentState["StoppedDL"] = "stoppedDL";
+    /**
+     * Torrent has been stopped while downloading
+     */
+    TorrentState["StoppedUP"] = "stoppedUP";
     /**
      * Torrent is being downloaded, but no connection were made
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/qbittorrent",
-  "version": "9.2.0",
+  "version": "9.4.0",
   "description": "TypeScript api wrapper for qbittorrent using got",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",
@@ -40,24 +40,25 @@
     "@ctrl/shared-torrent": "^6.2.1",
     "@ctrl/torrent-file": "^4.1.0",
     "cookie": "^1.0.2",
-    "node-fetch-native": "^1.6.4",
+    "node-fetch-native": "^1.6.6",
     "ofetch": "^1.4.1",
-    "type-fest": "^4.30.2",
+    "type-fest": "^4.34.1",
     "ufo": "^1.5.4",
     "uint8array-extras": "^1.4.0"
   },
   "devDependencies": {
     "@biomejs/biome": "1.9.4",
-    "@ctrl/eslint-config-biome": "4.3.1",
-    "@eslint/compat": "^1.2.4",
+    "@ctrl/eslint-config-biome": "4.3.2",
+    "@eslint/compat": "^1.2.6",
     "@sindresorhus/tsconfig": "7.0.0",
     "@types/cookie": "1.0.0",
-    "@types/node": "22.10.2",
-    "@vitest/coverage-v8": "2.1.8",
+    "@types/node": "22.13.1",
+    "@vitest/coverage-v8": "3.0.5",
+    "eslint": "^9.20.1",
     "p-wait-for": "5.0.2",
-    "typedoc": "0.27.5",
-    "typescript": "5.7.2",
-    "vitest": "2.1.8"
+    "typedoc": "0.27.7",
+    "typescript": "5.7.3",
+    "vitest": "3.0.5"
   },
   "release": {
     "branches": [