@ctrl/deluge 6.0.0 → 7.0.0

package/dist/src/deluge.d.ts

@@ -1,4 +1,4 @@
-import { FetchResponse } from 'ofetch';
+import { ofetch } from 'ofetch';
 import type { AddTorrentOptions as NormalizedAddTorrentOptions, AllClientData, NormalizedTorrent, TorrentClient, TorrentSettings } from '@ctrl/shared-torrent';
 import type { AddTorrentOptions, AddTorrentResponse, BooleanStatus, ConfigResponse, DefaultResponse, DelugeSettings, GetHostsResponse, GetHostStatusResponse, ListMethods, PluginInfo, PluginsListResponse, StringStatus, TorrentFiles, TorrentInfo, TorrentListResponse, TorrentOptions, TorrentStatus, Tracker, UploadResponse } from './types.js';
 export declare class Deluge implements TorrentClient {
@@ -69,7 +69,7 @@ export declare class Deluge implements TorrentClient {
     /**
      *
      * @param torrentId torrent id from list torrents
-     * @param removeData true will delete all data from disk
+     * @param removeData (default: false) If true, remove the data from disk
      */
     removeTorrent(torrentId: string, removeData?: boolean): Promise<BooleanStatus>;
     changePassword(password: string): Promise<BooleanStatus>;
@@ -105,6 +105,6 @@ export declare class Deluge implements TorrentClient {
     getPluginInfo(plugins: string[]): Promise<PluginInfo>;
     enablePlugin(plugins: string[]): Promise<DefaultResponse>;
     disablePlugin(plugins: string[]): Promise<DefaultResponse>;
-    request<T extends object>(method: string, params?: any[], needsAuth?: boolean, autoConnect?: boolean): Promise<FetchResponse<T>>;
+    request<T extends object>(method: string, params?: any[], needsAuth?: boolean, autoConnect?: boolean): Promise<ReturnType<typeof ofetch.raw<T>>>;
     private _validateAuth;
 }

package/dist/src/deluge.js

@@ -167,8 +167,7 @@ export class Deluge {
             retry: 0,
             timeout: this.config.timeout,
             parseResponse: JSON.parse,
-            // @ts-expect-error for some reason agent is not in the type
-            agent: this.config.agent,
+            dispatcher: this.config.dispatcher,
         });
         return res;
     }
@@ -188,7 +187,8 @@ export class Deluge {
     }
     async addTorrent(torrent, config = {}) {
         let path;
-        if (isUint8Array(torrent) || !torrent.startsWith('/tmp/')) {
+        const isUploaded = typeof torrent === 'string' && torrent.includes('delugeweb-');
+        if (isUint8Array(torrent) || !isUploaded) {
             const upload = await this.upload(torrent);
             if (!upload.success || !upload.files.length) {
                 throw new Error('Failed to upload');
@@ -196,7 +196,10 @@ export class Deluge {
             path = upload.files[0];
         }
         else {
-            /** Assume paths starting with /tmp/ are from {@link Deluge.addTorrent} */
+            /**
+             * Assume paths starting with /tmp/ are from {@link Deluge.upload}
+             * Example temp path: /run/deluged-temp/delugeweb-s0jy917j/ubuntu-20.10-desktop-amd64.iso.torrent
+             */
             path = torrent;
         }
         const options = {
@@ -278,9 +281,9 @@ export class Deluge {
     /**
      *
      * @param torrentId torrent id from list torrents
-     * @param removeData true will delete all data from disk
+     * @param removeData (default: false) If true, remove the data from disk
      */
-    async removeTorrent(torrentId, removeData = true) {
+    async removeTorrent(torrentId, removeData = false) {
         const req = await this.request('core.remove_torrent', [torrentId, removeData]);
         return req._data;
     }
@@ -508,7 +511,6 @@ export class Deluge {
         const req = await this.request('core.disable_plugin', plugins);
         return req._data;
     }
-    // eslint-disable-next-line @typescript-eslint/ban-types
     async request(method, params = [], needsAuth = true, autoConnect = true) {
         if (this._msgId === 4096) {
             this._msgId = 0;
@@ -538,8 +540,7 @@ export class Deluge {
             timeout: this.config.timeout,
             responseType: 'json',
             parseResponse: JSON.parse,
-            // @ts-expect-error for some reason agent is not in the type
-            agent: this.config.agent,
+            dispatcher: this.config.dispatcher,
         });
         const err = res.body?.error ?? (typeof res.body === 'string' && res.body);
         if (err) {

package/dist/src/normalizeTorrentData.d.ts

@@ -1,3 +1,3 @@
-import { NormalizedTorrent } from '@ctrl/shared-torrent';
-import { Torrent } from './types.js';
+import { type NormalizedTorrent } from '@ctrl/shared-torrent';
+import type { Torrent } from './types.js';
 export declare function normalizeTorrentData(id: string, torrent: Torrent): NormalizedTorrent;

package/dist/src/types.d.ts

@@ -16,7 +16,7 @@ export interface ListMethods extends DefaultResponse {
     result: string[];
 }
 export interface AddTorrentResponse extends DefaultResponse {
-    result: Array<[boolean, string]>;
+    result: [boolean, string][];
 }
 /**
  * ex -
@@ -35,7 +35,7 @@ export interface GetHostsResponse extends DefaultResponse {
      * port - 58846
      * status - "Online"
      */
-    result: Array<[string, string, number, string]>;
+    result: [string, string, number, string][];
 }
 export type HostStatus = 'Online' | 'Offline' | 'Connected';
 export interface GetHostStatusResponse extends DefaultResponse {
@@ -101,9 +101,9 @@ export interface TorrentList {
  * ['label', 'id']
  */
 export interface TorrentFilters {
-    state: Array<[string, number]>;
-    tracker_host: Array<[string, number]>;
-    label?: Array<[string, number]>;
+    state: [string, number][];
+    tracker_host: [string, number][];
+    label?: [string, number][];
 }
 export interface Stats {
     upload_protocol_rate: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/deluge",
-  "version": "6.0.0",
+  "version": "7.0.0",
   "description": "TypeScript api wrapper for deluge using got",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",
@@ -20,10 +20,10 @@
   "scripts": {
     "lint": "pnpm run '/^(lint:biome|lint:eslint)$/'",
     "lint:biome": "biome check .",
-    "lint:eslint": "eslint --ext .ts,.tsx .",
+    "lint:eslint": "eslint .",
     "lint:fix": "pnpm run '/^(lint:biome|lint:eslint):fix$/'",
-    "lint:eslint:fix": "eslint --ext .ts,.tsx . --fix",
-    "lint:biome:fix": "biome check . --apply",
+    "lint:eslint:fix": "eslint . --fix",
+    "lint:biome:fix": "biome check . --write",
     "prepare": "npm run build",
     "build": "tsc",
     "build:docs": "typedoc",
@@ -32,25 +32,24 @@
     "test:ci": "vitest run --coverage --reporter=default --reporter=junit --outputFile=./junit.xml"
   },
   "dependencies": {
-    "@ctrl/magnet-link": "^4.0.1",
-    "@ctrl/shared-torrent": "^6.0.0",
-    "node-fetch-native": "^1.6.2",
-    "ofetch": "^1.3.3",
-    "tough-cookie": "^4.1.3",
-    "ufo": "^1.4.0",
-    "uint8array-extras": "^1.1.0"
+    "@ctrl/magnet-link": "^4.0.2",
+    "@ctrl/shared-torrent": "^6.1.0",
+    "node-fetch-native": "^1.6.4",
+    "ofetch": "^1.4.1",
+    "tough-cookie": "^5.0.0",
+    "ufo": "^1.5.4",
+    "uint8array-extras": "^1.4.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.5.3",
-    "@ctrl/eslint-config-biome": "2.0.9",
-    "@sindresorhus/tsconfig": "5.0.0",
-    "@types/node": "20.11.24",
-    "@types/tough-cookie": "4.0.5",
-    "@vitest/coverage-v8": "1.3.1",
+    "@biomejs/biome": "1.9.4",
+    "@ctrl/eslint-config-biome": "4.2.11",
+    "@sindresorhus/tsconfig": "6.0.0",
+    "@types/node": "22.9.0",
+    "@vitest/coverage-v8": "2.1.4",
     "p-wait-for": "5.0.2",
-    "typedoc": "0.25.10",
-    "typescript": "5.3.3",
-    "vitest": "1.3.1"
+    "typedoc": "0.26.11",
+    "typescript": "5.6.3",
+    "vitest": "2.1.4"
   },
   "publishConfig": {
     "access": "public",