@ctrl/qbittorrent 4.0.0 → 4.1.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,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';
@@ -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

@@ -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) {
@@ -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
@@ -542,14 +553,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 +585,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 +597,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

@@ -424,21 +424,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

@@ -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) {
     /**
@@ -85,22 +85,22 @@ 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 = {}));
+    TorrentTrackerStatus[TorrentTrackerStatus["Errored"] = 4] = "Errored";
+})(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": "4.0.0",
+  "version": "4.1.0",
   "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,45 +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 --tap | tap-junit -o junit -n test-result.xml"
+    "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/torrent-file": "^2.0.1",
-    "@ctrl/url-join": "^2.0.0",
-    "formdata-node": "^4.3.2",
-    "got": "^12.0.4",
+    "@ctrl/magnet-link": "^3.1.1",
+    "@ctrl/shared-torrent": "^4.1.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"
   },
   "devDependencies": {
-    "@ctrl/eslint-config": "3.4.2",
-    "@sindresorhus/tsconfig": "2.0.0",
-    "@types/node": "17.0.31",
+    "@ctrl/eslint-config": "3.4.6",
+    "@sindresorhus/tsconfig": "3.0.1",
+    "@types/node": "18.0.3",
     "@types/tough-cookie": "4.0.2",
-    "ava": "4.2.0",
-    "c8": "7.11.2",
+    "c8": "7.11.3",
     "p-wait-for": "4.1.0",
-    "tap-junit": "5.0.2",
-    "ts-node": "10.7.0",
-    "typedoc": "0.22.15",
-    "typescript": "4.6.4"
-  },
-  "ava": {
-    "files": [
-      "test/**/*.spec.ts"
-    ],
-    "extensions": {
-      "ts": "module"
-    },
-    "nodeArguments": [
-      "--loader=ts-node/esm"
-    ]
+    "typedoc": "0.23.7",
+    "typescript": "4.7.4",
+    "vitest": "0.18.0"
   },
   "release": {
-    "branch": "master"
+    "branches": [
+      "master"
+    ]
   },
   "engines": {
     "node": ">=14.16"