@ctrl/qbittorrent 4.1.0 → 5.1.0

package/dist/src/qbittorrent.d.ts

@@ -1,7 +1,7 @@
 /// <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';
+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';
 export declare class QBittorrent implements TorrentClient {
     config: TorrentSettings;
     /**

package/dist/src/qbittorrent.js

@@ -7,10 +7,10 @@ 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 { 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 { TorrentState } from './types.js';
 const defaults = {
     baseUrl: 'http://localhost:9091/',
     path: '/api/v2',
@@ -133,6 +133,7 @@ export class QBittorrent {
         const results = {
             torrents: [],
             labels: [],
+            raw: listTorrents,
         };
         const labels = {};
         for (const torrent of listTorrents) {
@@ -623,39 +624,59 @@ export class QBittorrent {
     }
     _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.ForcedDL:
-            case TorrentState.MetaDL:
+            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.ForcedUP:
-                state = NormalizedTorrentState.seeding;
-                break;
-            case TorrentState.PausedDL:
-                state = NormalizedTorrentState.paused;
+            case TorrentState.StalledDL:
+                state = NormalizedTorrentState.warning;
+                stateMessage = 'The download is stalled with no connection';
                 break;
-            case TorrentState.PausedUP:
+            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.paused;
-                break;
-            case TorrentState.QueuedDL:
-            case TorrentState.QueuedUP:
-                state = NormalizedTorrentState.queued;
+                state = NormalizedTorrentState.seeding;
+                eta = 0; // qBittorrent sends eta=8640000 for completed torrents
                 break;
-            case TorrentState.CheckingDL:
-            case TorrentState.CheckingUP:
+            case TorrentState.Moving: // torrent is being moved from a folder
             case TorrentState.QueuedForChecking:
             case TorrentState.CheckingResumeData:
-            case TorrentState.Moving:
                 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;
@@ -664,17 +685,18 @@ export class QBittorrent {
         const result = {
             id: torrent.hash,
             name: torrent.name,
-            stateMessage: '',
+            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,
-            eta: torrent.eta,
             queuePosition: torrent.priority,
             connectedPeers: torrent.num_leechs,
             connectedSeeds: torrent.num_seeds,
@@ -685,6 +707,7 @@ export class QBittorrent {
             totalUploaded: torrent.uploaded,
             totalDownloaded: torrent.downloaded,
             ratio: torrent.ratio,
+            raw: torrent,
         };
         return result;
     }

package/dist/src/types.d.ts

@@ -96,6 +96,7 @@ export interface Torrent {
      * Torrent tracker
      */
     tracker: string;
+    trackers_count: number;
     /**
      * Torrent download limit
      */
@@ -148,6 +149,10 @@ export interface Torrent {
      * Upload seeding time limit
      */
     seeding_time_limit: number;
+    /**
+     * True if super seeding is enabled
+     */
+    super_seeding: boolean;
     /**
      * Indicates the time when the torrent was last seen complete/whole
      */
@@ -165,6 +170,10 @@ export interface Torrent {
      * Category name
      */
     category: string;
+    /**
+     * Comma-concatenated tag list of the torrent e.g. - "abc, 123"
+     */
+    tags: string;
 }
 export declare type TorrentCategories = Record<string, Category>;
 interface Category {
@@ -220,6 +229,10 @@ export declare enum TorrentState {
      * Torrent is forced to downloading to ignore queue limit
      */
     ForcedDL = "forcedDL",
+    /**
+     * Forced Downloading Metadata
+     */
+    ForcedMetaDL = "ForcedMetaDL",
     /**
      * Torrent is forced to uploading and ignore queue limit
      */

package/dist/src/types.js

@@ -48,6 +48,10 @@ export var TorrentState;
      * Torrent is forced to downloading to ignore queue limit
      */
     TorrentState["ForcedDL"] = "forcedDL";
+    /**
+     * Forced Downloading Metadata
+     */
+    TorrentState["ForcedMetaDL"] = "ForcedMetaDL";
     /**
      * Torrent is forced to uploading and ignore queue limit
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/qbittorrent",
-  "version": "4.1.0",
+  "version": "5.1.0",
   "description": "TypeScript api wrapper for qbittorrent using got",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",
@@ -28,27 +28,28 @@
     "build:docs": "typedoc",
     "test": "vitest run",
     "test:watch": "vitest",
-    "test:ci": "vitest run --coverage --reporter=junit --outputFile=./junit.xml"
+    "test:ci": "vitest run --coverage --reporter=default --reporter=junit --outputFile=./junit.xml"
   },
   "dependencies": {
     "@ctrl/magnet-link": "^3.1.1",
-    "@ctrl/shared-torrent": "^4.1.1",
+    "@ctrl/shared-torrent": "^4.3.1",
     "@ctrl/torrent-file": "^2.0.2",
     "@ctrl/url-join": "^2.0.2",
-    "formdata-node": "^4.3.3",
-    "got": "^12.1.0",
-    "tough-cookie": "^4.0.0"
+    "formdata-node": "^5.0.0",
+    "got": "^12.5.0",
+    "tough-cookie": "^4.1.2"
   },
   "devDependencies": {
-    "@ctrl/eslint-config": "3.4.6",
+    "@ctrl/eslint-config": "3.5.0",
     "@sindresorhus/tsconfig": "3.0.1",
-    "@types/node": "18.0.3",
+    "@types/node": "18.7.18",
     "@types/tough-cookie": "4.0.2",
-    "c8": "7.11.3",
-    "p-wait-for": "4.1.0",
-    "typedoc": "0.23.7",
-    "typescript": "4.7.4",
-    "vitest": "0.18.0"
+    "@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"
   },
   "release": {
     "branches": [