@ctrl/qbittorrent 9.5.2 → 9.7.0

package/README.md

@@ -28,7 +28,7 @@ async function main() {
 ### API
 
 Docs: https://qbittorrent.vercel.app  
-qBittorrent Api Docs: https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)  
+qBittorrent Api Docs: https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)
 
 ### Normalized API
 
@@ -103,7 +103,7 @@ console.log(result);
 If you're shutting down the server often (serverless?) you can export the state
 
 ```ts
-const state = client.exportState()
+const state = client.exportState();
 const client = QBittorrent.createFromState(config, state);
 ```
 

package/dist/src/qbittorrent.d.ts

@@ -178,10 +178,18 @@ export declare class QBittorrent implements TorrentClient {
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#pause-torrents}
      */
+    stopTorrent(hashes: string | string[] | 'all'): Promise<boolean>;
+    /**
+     * @deprecated Alias for {@link stopTorrent}.
+     */
     pauseTorrent(hashes: string | string[] | 'all'): Promise<boolean>;
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#resume-torrents}
      */
+    startTorrent(hashes: string | string[] | 'all'): Promise<boolean>;
+    /**
+     * @deprecated Alias for {@link startTorrent}.
+     */
     resumeTorrent(hashes: string | string[] | 'all'): Promise<boolean>;
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#delete-torrents}
@@ -196,8 +204,8 @@ export declare class QBittorrent implements TorrentClient {
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#reannounce-torrents}
      */
     reannounceTorrent(hashes: string | string[] | 'all'): Promise<boolean>;
-    addTorrent(torrent: string | Uint8Array, options?: Partial<AddTorrentOptions>): Promise<boolean>;
-    normalizedAddTorrent(torrent: string | Uint8Array, options?: Partial<NormalizedAddTorrentOptions>): Promise<NormalizedTorrent>;
+    addTorrent(torrent: string | Uint8Array<ArrayBuffer>, options?: Partial<AddTorrentOptions>): Promise<boolean>;
+    normalizedAddTorrent(torrent: string | Uint8Array<ArrayBuffer>, options?: Partial<NormalizedAddTorrentOptions>): Promise<NormalizedTorrent>;
     /**
      * @param hash Hash for desired torrent
      * @param oldPath id of the file to be renamed

package/dist/src/qbittorrent.js

@@ -145,6 +145,22 @@ export class QBittorrent {
             params.hashes = normalizeHashes(hashes);
         }
         if (filter) {
+            if (this.state.version?.isVersion5OrHigher) {
+                if (filter === 'paused') {
+                    filter = 'stopped';
+                }
+                else if (filter === 'resumed') {
+                    filter = 'running';
+                }
+            }
+            else if (filter === 'stopped') {
+                // For versions < 5
+                filter = 'paused';
+            }
+            else if (filter === 'running') {
+                // For versions < 5
+                filter = 'resumed';
+            }
             params.filter = filter;
         }
         if (category !== undefined) {
@@ -365,16 +381,22 @@ export class QBittorrent {
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#pause-torrents}
      */
-    async pauseTorrent(hashes) {
+    async stopTorrent(hashes) {
         const endpoint = this.state.version?.isVersion5OrHigher ? '/torrents/stop' : '/torrents/pause';
         const data = { hashes: normalizeHashes(hashes) };
         await this.request(endpoint, 'POST', undefined, objToUrlSearchParams(data));
         return true;
     }
+    /**
+     * @deprecated Alias for {@link stopTorrent}.
+     */
+    async pauseTorrent(hashes) {
+        return this.stopTorrent(hashes);
+    }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#resume-torrents}
      */
-    async resumeTorrent(hashes) {
+    async startTorrent(hashes) {
         const endpoint = this.state.version?.isVersion5OrHigher
             ? '/torrents/start'
             : '/torrents/resume';
@@ -382,6 +404,12 @@ export class QBittorrent {
         await this.request(endpoint, 'POST', undefined, objToUrlSearchParams(data));
         return true;
     }
+    /**
+     * @deprecated Alias for {@link startTorrent}.
+     */
+    async resumeTorrent(hashes) {
+        return this.startTorrent(hashes);
+    }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#delete-torrents}
      * @param deleteFiles (default: false) remove files from disk

package/dist/src/types.d.ts

@@ -20,7 +20,15 @@ export interface BuildInfo {
      */
     bitness: string;
 }
-export type TorrentFilters = 'all' | 'downloading' | 'seeding' | 'completed' | 'paused' | 'stopped' | 'active' | 'inactive' | 'resumed' | 'running' | 'stalled' | 'stalled_uploading' | 'stalled_downloading' | 'checking' | 'moving' | 'errored';
+/**
+ * @deprecated Replaced by 'running' in qBittorrent v5.
+ */
+type TorrentFilterResumed = 'resumed';
+/**
+ * @deprecated Replaced by 'stopped' in qBittorrent v5.
+ */
+type TorrentFilterPaused = 'paused';
+export type TorrentFilters = 'all' | 'downloading' | 'seeding' | 'completed' | TorrentFilterPaused | 'stopped' | 'active' | 'inactive' | TorrentFilterResumed | 'running' | 'stalled' | 'stalled_uploading' | 'stalled_downloading' | 'checking' | 'moving' | 'errored';
 export interface Torrent {
     /**
      * Torrent name

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/qbittorrent",
-  "version": "9.5.2",
+  "version": "9.7.0",
   "description": "TypeScript api wrapper for qbittorrent using got",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",
@@ -22,12 +22,8 @@
     "qbittorrent"
   ],
   "scripts": {
-    "lint": "pnpm run '/^(lint:biome|lint:eslint)$/'",
-    "lint:biome": "biome check .",
-    "lint:eslint": "eslint .",
-    "lint:fix": "pnpm run '/^(lint:biome|lint:eslint):fix$/'",
-    "lint:eslint:fix": "eslint . --fix",
-    "lint:biome:fix": "biome check . --write",
+    "lint": "oxlint . && prettier --check . --experimental-cli",
+    "lint:fix": "oxlint . --fix && prettier --write . --log-level=error --experimental-cli",
     "prepare": "npm run build",
     "build": "tsc",
     "build:docs": "typedoc",
@@ -37,28 +33,27 @@
   },
   "dependencies": {
     "@ctrl/magnet-link": "^4.0.2",
-    "@ctrl/shared-torrent": "^6.2.1",
+    "@ctrl/shared-torrent": "^6.3.0",
     "@ctrl/torrent-file": "^4.1.0",
     "cookie": "^1.0.2",
-    "node-fetch-native": "^1.6.6",
+    "node-fetch-native": "^1.6.7",
     "ofetch": "^1.4.1",
-    "type-fest": "^4.39.1",
-    "ufo": "^1.5.4",
-    "uint8array-extras": "^1.4.0"
+    "type-fest": "^4.41.0",
+    "ufo": "^1.6.1",
+    "uint8array-extras": "^1.5.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.9.4",
-    "@ctrl/eslint-config-biome": "4.3.4",
-    "@eslint/compat": "^1.2.8",
-    "@sindresorhus/tsconfig": "7.0.0",
-    "@types/cookie": "1.0.0",
-    "@types/node": "22.14.0",
-    "@vitest/coverage-v8": "3.1.1",
-    "eslint": "^9.23.0",
+    "@ctrl/oxlint-config": "1.2.3",
+    "@sindresorhus/tsconfig": "8.0.1",
+    "@trivago/prettier-plugin-sort-imports": "5.2.2",
+    "@types/node": "24.3.0",
+    "@vitest/coverage-v8": "3.2.4",
+    "oxlint": "1.14.0",
     "p-wait-for": "5.0.2",
-    "typedoc": "0.28.1",
-    "typescript": "5.8.2",
-    "vitest": "3.1.1"
+    "prettier": "3.6.2",
+    "typedoc": "0.28.11",
+    "typescript": "5.9.2",
+    "vitest": "3.2.4"
   },
   "release": {
     "branches": [
@@ -67,5 +62,26 @@
   },
   "engines": {
     "node": ">=18"
+  },
+  "packageManager": "pnpm@10.15.0",
+  "prettier": {
+    "singleQuote": true,
+    "trailingComma": "all",
+    "arrowParens": "avoid",
+    "semi": true,
+    "printWidth": 100,
+    "plugins": [
+      "@trivago/prettier-plugin-sort-imports"
+    ],
+    "importOrder": [
+      "^node:.*$",
+      "<THIRD_PARTY_MODULES>",
+      "^(@ctrl)(/.*|$)",
+      "^\\.\\./(?!.*\\.css$)",
+      "^\\./(?!.*\\.css$)(?=.*/)",
+      "^\\./(?!.*\\.css$)(?!.*/)"
+    ],
+    "importOrderSeparation": true,
+    "importOrderSortSpecifiers": false
   }
 }