@ctrl/deluge 4.3.1 → 5.0.1

package/README.md

@@ -1,6 +1,6 @@
-# deluge [![npm](https://img.shields.io/npm/v/@ctrl/deluge.svg?maxAge=3600)](https://www.npmjs.com/package/@ctrl/deluge) [![CircleCI](https://circleci.com/gh/scttcper/deluge.svg?style=svg)](https://circleci.com/gh/scttcper/deluge) [![coverage status](https://codecov.io/gh/scttcper/deluge/branch/master/graph/badge.svg)](https://codecov.io/gh/scttcper/deluge)
+# deluge [![npm](https://img.shields.io/npm/v/@ctrl/deluge.svg?maxAge=3600)](https://www.npmjs.com/package/@ctrl/deluge) [![coverage status](https://codecov.io/gh/scttcper/deluge/branch/master/graph/badge.svg)](https://codecov.io/gh/scttcper/deluge)
 
-> TypeScript api wrapper for [deluge](https://deluge-torrent.org/) using [got](https://github.com/sindresorhus/got)
+> TypeScript api wrapper for [deluge](https://deluge-torrent.org/) using [ofetch](https://github.com/unjs/ofetch)
 
 ### Install
 
@@ -75,3 +75,19 @@ transmission - https://github.com/scttcper/transmission
 qbittorrent - https://github.com/scttcper/qbittorrent  
 utorrent - https://github.com/scttcper/utorrent  
 rtorrent - https://github.com/scttcper/rtorrent  
+
+### Start a test docker container
+
+```
+docker run -d \
+  --name=deluge \
+  -e PUID=1000 \
+  -e PGID=1000 \
+  -e TZ=Etc/UTC \
+  -e DELUGE_LOGLEVEL=error `#optional` \
+  -p 8112:8112 \
+  -p 6881:6881 \
+  -p 6881:6881/udp \
+  --restart unless-stopped \
+  lscr.io/linuxserver/deluge:latest
+```

package/dist/src/deluge.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" resolution-mode="require"/>
-import type { Response } from 'got';
+import { FetchResponse } 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 {
@@ -106,7 +106,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<Response<T>>;
-    private _normalizeTorrentData;
+    request<T extends object>(method: string, params?: any[], needsAuth?: boolean, autoConnect?: boolean): Promise<FetchResponse<T>>;
     private _validateAuth;
 }

package/dist/src/deluge.js

@@ -1,11 +1,9 @@
-import { existsSync } from 'fs';
-import { File, FormData } from 'formdata-node';
-import { fileFromPath } from 'formdata-node/file-from-path';
-import got from 'got';
+import { FormData } from 'node-fetch-native';
+import { ofetch } from 'ofetch';
 import { Cookie } from 'tough-cookie';
+import { joinURL } from 'ufo';
 import { magnetDecode } from '@ctrl/magnet-link';
-import { TorrentState } from '@ctrl/shared-torrent';
-import { urlJoin } from '@ctrl/url-join';
+import { normalizeTorrentData } from './normalizeTorrentData.js';
 const defaults = {
     baseUrl: 'http://localhost:8112/',
     path: '/json',
@@ -13,25 +11,10 @@ const defaults = {
     timeout: 5000,
 };
 export class Deluge {
+    config;
+    _msgId = 0;
+    _cookie;
     constructor(options = {}) {
-        Object.defineProperty(this, "config", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "_msgId", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: 0
-        });
-        Object.defineProperty(this, "_cookie", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
         this.config = { ...defaults, ...options };
     }
     resetSession() {
@@ -40,7 +23,7 @@ export class Deluge {
     }
     async getHosts() {
         const res = await this.request('web.get_hosts', [], true, false);
-        return res.body;
+        return res._data;
     }
     /**
      * Gets host status
@@ -48,7 +31,7 @@ export class Deluge {
      */
     async getHostStatus(host) {
         const res = await this.request('web.get_host_status', [host], true, false);
-        return res.body;
+        return res._data;
     }
     /**
      * Connects deluge and returns a list of available methods
@@ -65,11 +48,11 @@ export class Deluge {
             throw new Error('No hosts found');
         }
         const res = await this.request('web.connect', [host], true, false);
-        return res.body;
+        return res._data;
     }
     async connected() {
         const res = await this.request('web.connected', [], true, false);
-        return res.body.result;
+        return res._data.result;
     }
     /**
      * Disconnects deluge - warning all instances connected to this client will also be disconnected.
@@ -77,12 +60,13 @@ export class Deluge {
      */
     async disconnect() {
         const res = await this.request('web.disconnect', [], true, false);
+        const body = res._data;
         // deluge 1.x returns a boolean and 2.x returns a string
-        if (typeof res.body.result === 'boolean') {
-            return res.body.result;
+        if (typeof body.result === 'boolean') {
+            return body.result;
         }
         // "Connection was closed cleanly."
-        return res.body.result.includes('closed cleanly');
+        return body.result.includes('closed cleanly');
     }
     /**
      * Checks current session is valid
@@ -101,7 +85,8 @@ export class Deluge {
         if (this._cookie) {
             try {
                 const check = await this.request('auth.check_session', undefined, false);
-                if (check?.body?.result) {
+                const body = await check.json();
+                if (body?.result) {
                     return true;
                 }
             }
@@ -119,10 +104,10 @@ export class Deluge {
     async login() {
         this.resetSession();
         const res = await this.request('auth.login', [this.config.password], false);
-        if (!res.body.result || !res.headers || !res.headers['set-cookie']) {
+        if (!res.ok || !res.headers?.get('set-cookie')?.length) {
             throw new Error('Auth failed, incorrect password');
         }
-        this._cookie = Cookie.parse(res.headers['set-cookie'][0]);
+        this._cookie = Cookie.parse(res.headers.get('set-cookie'));
         return true;
     }
     /**
@@ -131,15 +116,16 @@ export class Deluge {
      */
     async logout() {
         const res = await this.request('auth.delete_session');
+        const body = res._data;
         this.resetSession();
-        return res.body.result;
+        return body.result;
     }
     /**
      * returns the version ex - `2.0.3-2-201906121747-ubuntu18.04.1`
      */
     async getVersion() {
         const req = await this.request('daemon.get_version');
-        return req.body;
+        return req._data;
     }
     /**
      * used to get torrent info before adding
@@ -147,7 +133,7 @@ export class Deluge {
      */
     async getTorrentInfo(tmpPath) {
         const res = await this.request('web.get_torrent_info', [tmpPath]);
-        return res.body;
+        return res._data;
     }
     /**
      * Lists methods
@@ -156,7 +142,7 @@ export class Deluge {
      */
     async listMethods(auth = true) {
         const req = await this.request('system.listMethods', undefined, auth);
-        return req.body;
+        return req._data;
     }
     async upload(torrent) {
         await this._validateAuth();
@@ -167,28 +153,23 @@ export class Deluge {
         const form = new FormData();
         const type = { type: 'application/x-bittorrent' };
         if (typeof torrent === 'string') {
-            if (existsSync(torrent)) {
-                const file = await fileFromPath(torrent, 'temp.torrent', type);
-                form.set('file', file);
-            }
-            else {
-                form.set('file', new File([Buffer.from(torrent, 'base64')], 'file.torrent', type));
-            }
+            form.set('file', new File([Buffer.from(torrent, 'base64')], 'file.torrent', type));
         }
         else {
             const file = new File([torrent], 'torrent', type);
             form.set('file', file);
         }
-        const url = urlJoin(this.config.baseUrl, '/upload');
-        const res = await got.post(url, {
+        const url = joinURL(this.config.baseUrl, '/upload');
+        const res = await ofetch(url, {
+            method: 'POST',
             body: form,
-            retry: { limit: 0 },
-            timeout: { request: this.config.timeout },
-            // allow proxy agent
-            ...(this.config.agent ? { agent: this.config.agent } : {}),
+            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,
         });
-        // repsonse is json but in a string, cannot use native got.json()
-        return JSON.parse(res.body);
+        return res;
     }
     /**
      * Download a torrent from url, pass the result to {@link Deluge.addTorrent}
@@ -198,10 +179,11 @@ export class Deluge {
      */
     async downloadFromUrl(url, cookies = '') {
         const res = await this.request('web.download_torrent_from_url', [url, cookies]);
-        if (!res.body.result) {
+        const body = res._data;
+        if (!body.result) {
             throw new Error('Failed to download torrent');
         }
-        return res.body.result;
+        return body.result;
     }
     async addTorrent(torrent, config = {}) {
         let path;
@@ -236,10 +218,11 @@ export class Deluge {
             ...config,
         };
         const res = await this.request('web.add_torrents', [[{ path, options }]]);
-        if (!res.body.result) {
+        const body = res._data;
+        if (!body.result) {
             throw new Error('Failed to add torrent');
         }
-        return res.body;
+        return body;
     }
     async normalizedAddTorrent(torrent, options = {}) {
         const torrentOptions = {};
@@ -289,7 +272,7 @@ export class Deluge {
             ...config,
         };
         const res = await this.request('core.add_torrent_magnet', [magnet, options]);
-        return res.body;
+        return res._data;
     }
     /**
      *
@@ -298,20 +281,21 @@ export class Deluge {
      */
     async removeTorrent(torrentId, removeData = true) {
         const req = await this.request('core.remove_torrent', [torrentId, removeData]);
-        return req.body;
+        return req._data;
     }
     async changePassword(password) {
         const res = await this.request('auth.change_password', [
             this.config.password,
             password,
         ]);
-        if (!res.body.result || !res.headers || !res.headers['set-cookie']) {
+        const body = res._data;
+        if (!body.result || !res.headers.get('set-cookie')?.length) {
             throw new Error('Old password incorrect');
         }
         // update current password to new password
         this.config.password = password;
-        this._cookie = Cookie.parse(res.headers['set-cookie'][0]);
-        return res.body;
+        this._cookie = Cookie.parse(res.headers.get('set-cookie'));
+        return body;
     }
     async getAllData() {
         const listTorrents = await this.listTorrents();
@@ -322,7 +306,7 @@ export class Deluge {
         };
         for (const id of Object.keys(listTorrents.result.torrents)) {
             const torrent = listTorrents.result.torrents[id];
-            const torrentData = this._normalizeTorrentData(id, torrent);
+            const torrentData = normalizeTorrentData(id, torrent);
             results.torrents.push(torrentData);
         }
         if (listTorrents.result.filters.label) {
@@ -369,11 +353,11 @@ export class Deluge {
             [...new Set(fields)],
             filter,
         ]);
-        return req.body;
+        return req._data;
     }
     async getTorrent(id) {
         const torrentResponse = await this.getTorrentStatus(id);
-        return this._normalizeTorrentData(id, torrentResponse.result);
+        return normalizeTorrentData(id, torrentResponse.result);
     }
     /**
      * get torrent state/status
@@ -424,103 +408,104 @@ export class Deluge {
             ...additionalFields,
         ];
         const req = await this.request('web.get_torrent_status', [torrentId, fields]);
-        if (!req.body.result || !Object.keys(req.body.result).length) {
+        const body = req._data;
+        if (!body.result || !Object.keys(body.result).length) {
             throw new Error('Torrent not found');
         }
-        return req.body;
+        return body;
     }
     /**
      * Get list of files for a torrent
      */
     async getTorrentFiles(torrentId) {
         const req = await this.request('web.get_torrent_files', [torrentId]);
-        return req.body;
+        return req._data;
     }
     async pauseTorrent(torrentId) {
         const req = await this.request('core.pause_torrent', [[torrentId]]);
-        return req.body;
+        return req._data;
     }
     async resumeTorrent(torrentId) {
         const req = await this.request('core.resume_torrent', [[torrentId]]);
-        return req.body;
+        return req._data;
     }
     async setTorrentOptions(torrentId, options = {}) {
         const req = await this.request('core.set_torrent_options', [
             [torrentId],
             options,
         ]);
-        return req.body;
+        return req._data;
     }
     async setTorrentTrackers(torrentId, trackers = []) {
         const req = await this.request('core.set_torrent_trackers', [
             [torrentId],
             trackers,
         ]);
-        return req.body;
+        return req._data;
     }
     async updateTorrentTrackers(torrentId) {
         const req = await this.request('core.force_reannounce', [[torrentId]]);
-        return req.body;
+        return req._data;
     }
     async verifyTorrent(torrentId) {
         const req = await this.request('core.force_recheck', [[torrentId]]);
-        return req.body;
+        return req._data;
     }
     async setTorrentLabel(torrentId, label) {
         const req = await this.request('label.set_torrent', [torrentId, label]);
-        return req.body;
+        return req._data;
     }
     async addLabel(label) {
         const req = await this.request('label.add', [label]);
-        return req.body;
+        return req._data;
     }
     async removeLabel(label) {
         const req = await this.request('label.remove', [label]);
-        return req.body;
+        return req._data;
     }
     async getLabels() {
         const req = await this.request('label.get_labels', []);
-        return req.body;
+        return req._data;
     }
     async queueTop(torrentId) {
         const req = await this.request('core.queue_top', [[torrentId]]);
-        return req.body;
+        return req._data;
     }
     async queueBottom(torrentId) {
         const req = await this.request('core.queue_bottom', [[torrentId]]);
-        return req.body;
+        return req._data;
     }
     async queueUp(torrentId) {
         const req = await this.request('core.queue_up', [[torrentId]]);
-        return req.body;
+        return req._data;
     }
     async queueDown(torrentId) {
         const req = await this.request('core.queue_down', [[torrentId]]);
-        return req.body;
+        return req._data;
     }
     async getConfig() {
         const req = await this.request('core.get_config', []);
-        return req.body;
+        return req._data;
     }
     async setConfig(config) {
         const req = await this.request('core.set_config', [config]);
-        return req.body;
+        return req._data;
     }
     async getPlugins() {
         const req = await this.request('web.get_plugins', []);
-        return req.body;
+        return req._data;
     }
     async getPluginInfo(plugins) {
         const req = await this.request('web.get_plugin_info', plugins);
-        return req.body;
+        return req._data;
     }
     async enablePlugin(plugins) {
         const req = await this.request('core.enable_plugin', plugins);
-        return req.body;
+        return req._data;
     }
     async disablePlugin(plugins) {
         const req = await this.request('core.disable_plugin', plugins);
-        return req.body;
+        return req._data;
     }
     // eslint-disable-next-line @typescript-eslint/ban-types
     async request(method, params = [], needsAuth = true, autoConnect = true) {
@@ -539,19 +524,21 @@ export class Deluge {
         const headers = {
             Cookie: this._cookie?.cookieString?.(),
         };
-        const url = urlJoin(this.config.baseUrl, this.config.path);
-        const res = await got.post(url, {
-            json: {
+        const url = joinURL(this.config.baseUrl, this.config.path);
+        const res = await ofetch.raw(url, {
+            method: 'POST',
+            body: JSON.stringify({
                 method,
                 params,
                 id: this._msgId++,
-            },
+            }),
             headers,
-            retry: { limit: 0 },
-            timeout: { request: this.config.timeout },
+            retry: 0,
+            timeout: this.config.timeout,
             responseType: 'json',
-            // allow proxy agent
-            ...(this.config.agent ? { agent: this.config.agent } : {}),
+            parseResponse: JSON.parse,
+            // @ts-expect-error for some reason agent is not in the type
+            agent: this.config.agent,
         });
         const err = res.body?.error ?? (typeof res.body === 'string' && res.body);
         if (err) {
@@ -559,42 +546,6 @@ export class Deluge {
         }
         return res;
     }
-    _normalizeTorrentData(id, torrent) {
-        const dateAdded = new Date(torrent.time_added * 1000).toISOString();
-        // normalize state to enum
-        let state = TorrentState.unknown;
-        if (Object.keys(TorrentState).includes(torrent.state.toLowerCase())) {
-            state = TorrentState[torrent.state.toLowerCase()];
-        }
-        const isCompleted = torrent.progress >= 100;
-        const result = {
-            id,
-            name: torrent.name,
-            state,
-            isCompleted,
-            stateMessage: torrent.state,
-            progress: torrent.progress / 100,
-            ratio: torrent.ratio,
-            dateAdded,
-            dateCompleted: undefined,
-            label: torrent.label,
-            savePath: torrent.save_path,
-            uploadSpeed: torrent.upload_payload_rate,
-            downloadSpeed: torrent.download_payload_rate,
-            eta: torrent.eta,
-            queuePosition: torrent.queue + 1,
-            connectedPeers: torrent.num_peers,
-            connectedSeeds: torrent.num_seeds,
-            totalPeers: torrent.total_peers,
-            totalSeeds: torrent.total_seeds,
-            totalSelected: torrent.total_wanted,
-            totalSize: torrent.total_size,
-            totalUploaded: torrent.total_uploaded,
-            totalDownloaded: torrent.total_done,
-            raw: torrent,
-        };
-        return result;
-    }
     async _validateAuth() {
         let validAuth = await this.checkSession();
         if (!validAuth) {

package/dist/src/normalizeTorrentData.d.ts

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

package/dist/src/normalizeTorrentData.js

@@ -0,0 +1,37 @@
+import { TorrentState } from '@ctrl/shared-torrent';
+export function normalizeTorrentData(id, torrent) {
+    const dateAdded = new Date(torrent.time_added * 1000).toISOString();
+    // normalize state to enum
+    let state = TorrentState.unknown;
+    if (Object.keys(TorrentState).includes(torrent.state.toLowerCase())) {
+        state = TorrentState[torrent.state.toLowerCase()];
+    }
+    const isCompleted = torrent.progress >= 100;
+    const result = {
+        id,
+        name: torrent.name,
+        state,
+        isCompleted,
+        stateMessage: torrent.state,
+        progress: torrent.progress / 100,
+        ratio: torrent.ratio,
+        dateAdded,
+        dateCompleted: undefined,
+        label: torrent.label,
+        savePath: torrent.save_path,
+        uploadSpeed: torrent.upload_payload_rate,
+        downloadSpeed: torrent.download_payload_rate,
+        eta: torrent.eta,
+        queuePosition: torrent.queue + 1,
+        connectedPeers: torrent.num_peers,
+        connectedSeeds: torrent.num_seeds,
+        totalPeers: torrent.total_peers,
+        totalSeeds: torrent.total_seeds,
+        totalSelected: torrent.total_wanted,
+        totalSize: torrent.total_size,
+        totalUploaded: torrent.total_uploaded,
+        totalDownloaded: torrent.total_done,
+        raw: torrent,
+    };
+    return result;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/deluge",
-  "version": "4.3.1",
+  "version": "5.0.1",
   "description": "TypeScript api wrapper for deluge using got",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",
@@ -28,27 +28,27 @@
     "test:ci": "vitest run --coverage --reporter=default --reporter=junit --outputFile=./junit.xml"
   },
   "dependencies": {
-    "@ctrl/magnet-link": "^3.1.1",
-    "@ctrl/shared-torrent": "^4.3.2",
-    "@ctrl/url-join": "^2.0.2",
-    "formdata-node": "^5.0.0",
-    "got": "^12.6.0",
-    "tough-cookie": "^4.1.2"
+    "@ctrl/magnet-link": "^3.1.2",
+    "@ctrl/shared-torrent": "^5.0.0",
+    "node-fetch-native": "^1.4.1",
+    "ofetch": "^1.3.3",
+    "tough-cookie": "^4.1.3",
+    "ufo": "^1.3.1"
   },
   "devDependencies": {
-    "@ctrl/eslint-config": "3.6.2",
-    "@sindresorhus/tsconfig": "3.0.1",
-    "@types/node": "18.15.0",
-    "@types/tough-cookie": "4.0.2",
-    "@vitest/coverage-c8": "0.29.2",
-    "c8": "7.13.0",
-    "p-wait-for": "5.0.0",
-    "typedoc": "0.23.26",
-    "typescript": "4.9.5",
-    "vitest": "0.29.2"
+    "@ctrl/eslint-config": "4.0.9",
+    "@sindresorhus/tsconfig": "5.0.0",
+    "@types/node": "20.8.10",
+    "@types/tough-cookie": "4.0.4",
+    "@vitest/coverage-v8": "0.34.6",
+    "p-wait-for": "5.0.2",
+    "typedoc": "0.25.3",
+    "typescript": "5.2.2",
+    "vitest": "0.34.6"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "release": {
     "branches": [
@@ -56,6 +56,6 @@
     ]
   },
   "engines": {
-    "node": ">=14.16"
+    "node": ">=18"
   }
 }