@ctrl/qbittorrent 4.0.1 → 5.0.0

package/README.md

@@ -1,4 +1,4 @@
-# qBittorrent [![npm](https://badgen.net/npm/v/@ctrl/qbittorrent)](https://www.npmjs.com/package/@ctrl/qbittorrent) [![CircleCI](https://badgen.net/circleci/github/scttcper/qbittorrent)](https://circleci.com/gh/scttcper/qbittorrent) [![coverage](https://badgen.net/codecov/c/github/scttcper/qbittorrent)](https://codecov.io/gh/scttcper/qbittorrent) [![bundlesize](https://badgen.net/bundlephobia/min/@ctrl/qbittorrent)](https://bundlephobia.com/result?p=@ctrl/qbittorrent)
+# qBittorrent [![npm](https://badgen.net/npm/v/@ctrl/qbittorrent)](https://www.npmjs.com/package/@ctrl/qbittorrent) [![CircleCI](https://badgen.net/circleci/github/scttcper/qbittorrent)](https://circleci.com/gh/scttcper/qbittorrent) [![coverage](https://badgen.net/codecov/c/github/scttcper/qbittorrent)](https://codecov.io/gh/scttcper/qbittorrent)
 
 > TypeScript api wrapper for [qBittorrent](https://www.qbittorrent.org/) using [got](https://github.com/sindresorhus/got)
 

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;
     /**
@@ -160,6 +160,10 @@ export declare class QBittorrent implements TorrentClient {
      * @param name new name to be assigned to the file
      */
     renameFile(hash: string, id: number, name: string): Promise<boolean>;
+    /**
+     * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#rename-folder}
+     */
+    renameFolder(hash: string, oldPath: string, newPath: string): Promise<boolean>;
     /**
      * @param urls URLs separated with newlines
      * @param options

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',
@@ -449,6 +449,17 @@ export class QBittorrent {
         await this.request('/torrents/renameFile', 'POST', undefined, form, undefined, false);
         return true;
     }
+    /**
+     * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#rename-folder}
+     */
+    async renameFolder(hash, oldPath, newPath) {
+        const form = new FormData();
+        form.append('hash', hash);
+        form.append('oldPath', oldPath);
+        form.append('newPath', newPath);
+        await this.request('/torrents/renameFolder', 'POST', undefined, form, undefined, false);
+        return true;
+    }
     /**
      * @param urls URLs separated with newlines
      * @param options
@@ -612,39 +623,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;
@@ -653,8 +684,9 @@ 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,
@@ -663,7 +695,6 @@ export class QBittorrent {
             savePath: torrent.save_path,
             uploadSpeed: torrent.upspeed,
             downloadSpeed: torrent.dlspeed,
-            eta: torrent.eta,
             queuePosition: torrent.priority,
             connectedPeers: torrent.num_leechs,
             connectedSeeds: torrent.num_seeds,

package/dist/src/types.d.ts

@@ -220,6 +220,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
      */
@@ -424,21 +428,21 @@ export declare enum TorrentTrackerStatus {
      */
     Disabled = 0,
     /**
-     * Tracker has been contacted and is working
+     * Tracker has not been contacted yet
      */
-    Working = 1,
+    Waiting = 1,
     /**
-     * Tracker is currently being updated
+     * Tracker has been contacted and is working
      */
-    Updating = 2,
+    Working = 2,
     /**
-     * Tracker has been contacted, but it is not working (or doesn't send proper replies)
+     * Tracker is updating
      */
-    Errored = 3,
+    Updating = 3,
     /**
-     * Tracker has not been contacted yet
+     * Tracker has been contacted, but it is not working (or doesn't send proper replies)
      */
-    Waiting = 4
+    Errored = 4
 }
 export interface WebSeed {
     /**

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
      */
@@ -85,21 +89,21 @@ export var TorrentTrackerStatus;
      */
     TorrentTrackerStatus[TorrentTrackerStatus["Disabled"] = 0] = "Disabled";
     /**
-     * Tracker has been contacted and is working
+     * Tracker has not been contacted yet
      */
-    TorrentTrackerStatus[TorrentTrackerStatus["Working"] = 1] = "Working";
+    TorrentTrackerStatus[TorrentTrackerStatus["Waiting"] = 1] = "Waiting";
     /**
-     * Tracker is currently being updated
+     * Tracker has been contacted and is working
      */
-    TorrentTrackerStatus[TorrentTrackerStatus["Updating"] = 2] = "Updating";
+    TorrentTrackerStatus[TorrentTrackerStatus["Working"] = 2] = "Working";
     /**
-     * Tracker has been contacted, but it is not working (or doesn't send proper replies)
+     * Tracker is updating
      */
-    TorrentTrackerStatus[TorrentTrackerStatus["Errored"] = 3] = "Errored";
+    TorrentTrackerStatus[TorrentTrackerStatus["Updating"] = 3] = "Updating";
     /**
-     * Tracker has not been contacted yet
+     * Tracker has been contacted, but it is not working (or doesn't send proper replies)
      */
-    TorrentTrackerStatus[TorrentTrackerStatus["Waiting"] = 4] = "Waiting";
+    TorrentTrackerStatus[TorrentTrackerStatus["Errored"] = 4] = "Errored";
 })(TorrentTrackerStatus = TorrentTrackerStatus || (TorrentTrackerStatus = {}));
 export var TorrentFilePriority;
 (function (TorrentFilePriority) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/qbittorrent",
-  "version": "4.0.1",
+  "version": "5.0.0",
   "description": "TypeScript api wrapper for qbittorrent using got",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",
@@ -32,23 +32,24 @@
   },
   "dependencies": {
     "@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.1.0",
-    "tough-cookie": "^4.0.0"
+    "@ctrl/shared-torrent": "^4.2.0",
+    "@ctrl/torrent-file": "^2.0.2",
+    "@ctrl/url-join": "^2.0.2",
+    "formdata-node": "^5.0.0",
+    "got": "^12.3.1",
+    "tough-cookie": "^4.1.2"
   },
   "devDependencies": {
-    "@ctrl/eslint-config": "3.4.4",
+    "@ctrl/eslint-config": "3.4.10",
     "@sindresorhus/tsconfig": "3.0.1",
-    "@types/node": "17.0.40",
+    "@types/node": "18.7.14",
     "@types/tough-cookie": "4.0.2",
-    "c8": "7.11.3",
-    "p-wait-for": "4.1.0",
-    "typedoc": "0.22.17",
-    "typescript": "4.7.3",
-    "vitest": "0.14.0"
+    "@vitest/coverage-c8": "0.22.1",
+    "c8": "7.12.0",
+    "p-wait-for": "5.0.0",
+    "typedoc": "0.23.11",
+    "typescript": "4.8.2",
+    "vitest": "0.22.1"
   },
   "release": {
     "branches": [