@ctrl/deluge 3.3.0 → 4.0.0

package/dist/{index.d.ts → src/deluge.d.ts}

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { Response } from 'got';
 import { AddTorrentOptions as NormalizedAddTorrentOptions, AllClientData, NormalizedTorrent, TorrentClient, TorrentSettings } from '@ctrl/shared-torrent';
-import { AddTorrentOptions, BooleanStatus, ConfigResponse, DefaultResponse, DelugeSettings, GetHostsResponse, GetHostStatusResponse, ListMethods, PluginInfo, PluginsListResponse, StringStatus, TorrentFiles, TorrentInfo, TorrentListResponse, TorrentOptions, TorrentStatus, Tracker, UploadResponse, AddTorrentResponse } from './types';
+import { 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 {
     config: TorrentSettings;
     private _msgId;
@@ -57,6 +57,13 @@ export declare class Deluge implements TorrentClient {
      */
     listMethods(auth?: boolean): Promise<ListMethods>;
     upload(torrent: string | Buffer): Promise<UploadResponse>;
+    /**
+     * Download a torrent from url, pass the result to {@link Deluge.addTorrent}
+     * @param url
+     * @param cookies
+     * @returns file path
+     */
+    downloadFromUrl(url: string, cookies?: string): Promise<string>;
     addTorrent(torrent: string | Buffer, config?: Partial<AddTorrentOptions>): Promise<AddTorrentResponse>;
     normalizedAddTorrent(torrent: string | Buffer, options?: Partial<NormalizedAddTorrentOptions>): Promise<NormalizedTorrent>;
     addTorrentMagnet(magnet: string, config?: Partial<AddTorrentOptions>): Promise<BooleanStatus>;

package/dist/{index.js → src/deluge.js}

@@ -1,24 +1,37 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Deluge = void 0;
-const fs_1 = require("fs");
-const form_data_1 = __importDefault(require("form-data"));
-const got_1 = __importDefault(require("got"));
-const tough_cookie_1 = require("tough-cookie");
-const url_join_1 = require("@ctrl/url-join");
-const shared_torrent_1 = require("@ctrl/shared-torrent");
+import { existsSync } from 'fs';
+import { File, FormData } from 'formdata-node';
+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, } from '@ctrl/shared-torrent';
+import { urlJoin } from '@ctrl/url-join';
 const defaults = {
     baseUrl: 'http://localhost:8112/',
     path: '/json',
     password: 'deluge',
     timeout: 5000,
 };
-class Deluge {
+export class Deluge {
     constructor(options = {}) {
-        this._msgId = 0;
+        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() {
@@ -93,7 +106,7 @@ class Deluge {
                     return true;
                 }
             }
-            catch (_b) {
+            catch {
                 // do nothing
             }
         }
@@ -110,7 +123,7 @@ class Deluge {
         if (!res.body.result || !res.headers || !res.headers['set-cookie']) {
             throw new Error('Auth failed, incorrect password');
         }
-        this._cookie = tough_cookie_1.Cookie.parse(res.headers['set-cookie'][0]);
+        this._cookie = Cookie.parse(res.headers['set-cookie'][0]);
         return true;
     }
     /**
@@ -152,36 +165,58 @@ class Deluge {
         if (!isConnected) {
             await this.connect();
         }
-        const form = new form_data_1.default();
+        const form = new FormData();
+        const type = { type: 'application/x-bittorrent' };
         if (typeof torrent === 'string') {
-            if (fs_1.existsSync(torrent)) {
-                form.append('file', Buffer.from(fs_1.readFileSync(torrent)), 'temp.torrent');
+            if (existsSync(torrent)) {
+                const file = await fileFromPath(torrent, 'temp.torrent', type);
+                form.set('file', file);
             }
             else {
-                form.append('file', Buffer.from(torrent, 'base64'), 'temp.torrent');
+                form.set('file', new File([Buffer.from(torrent, 'base64')], 'file.torrent', type));
             }
         }
         else {
-            form.append('file', torrent, 'temp.torrent');
+            const file = new File([torrent], 'torrent', type);
+            form.set('file', file);
         }
-        const url = url_join_1.urlJoin(this.config.baseUrl, '/upload');
-        const res = await got_1.default.post(url, {
-            headers: form.getHeaders(),
+        const url = urlJoin(this.config.baseUrl, '/upload');
+        const res = await got.post(url, {
             body: form,
-            retry: 0,
+            retry: { limit: 0 },
+            timeout: { request: this.config.timeout },
             // allow proxy agent
-            agent: this.config.agent,
-            timeout: this.config.timeout,
+            ...(this.config.agent ? { agent: this.config.agent } : {}),
         });
         // repsonse is json but in a string, cannot use native got.json()
         return JSON.parse(res.body);
     }
+    /**
+     * Download a torrent from url, pass the result to {@link Deluge.addTorrent}
+     * @param url
+     * @param cookies
+     * @returns file path
+     */
+    async downloadFromUrl(url, cookies = '') {
+        const res = await this.request('web.download_torrent_from_url', [url, cookies]);
+        if (!res.body.result) {
+            throw new Error('Failed to download torrent');
+        }
+        return res.body.result;
+    }
     async addTorrent(torrent, config = {}) {
-        const upload = await this.upload(torrent);
-        if (!upload.success || !upload.files.length) {
-            throw new Error('Failed to upload');
+        let path;
+        if (Buffer.isBuffer(torrent) || !torrent.startsWith('/tmp/')) {
+            const upload = await this.upload(torrent);
+            if (!upload.success || !upload.files.length) {
+                throw new Error('Failed to upload');
+            }
+            path = upload.files[0];
+        }
+        else {
+            /** Assume paths starting with /tmp/ are from {@link Deluge.addTorrent} */
+            path = torrent;
         }
-        const path = upload.files[0];
         const options = {
             file_priorities: [],
             add_paused: false,
@@ -212,11 +247,21 @@ class Deluge {
         if (options.startPaused) {
             torrentOptions.add_paused = true;
         }
-        if (!Buffer.isBuffer(torrent)) {
-            torrent = Buffer.from(torrent);
+        let torrentHash;
+        if (typeof torrent === 'string' && torrent.startsWith('magnet:')) {
+            torrentHash = magnetDecode(torrent).infoHash;
+            if (!torrentHash) {
+                throw new Error('Magnet did not contain hash');
+            }
+            await this.addTorrentMagnet(torrent, torrentOptions);
+        }
+        else {
+            if (!Buffer.isBuffer(torrent)) {
+                torrent = Buffer.from(torrent);
+            }
+            const res = await this.addTorrent(torrent, torrentOptions);
+            torrentHash = res.result[0][1];
         }
-        const res = await this.addTorrent(torrent, torrentOptions);
-        const torrentHash = res.result[0][1];
         if (options.label) {
             // sets the label but it might not set the label right away
             // sometimes takes a few seconds for label to reflect in results
@@ -266,7 +311,7 @@ class Deluge {
         }
         // update current password to new password
         this.config.password = password;
-        this._cookie = tough_cookie_1.Cookie.parse(res.headers['set-cookie'][0]);
+        this._cookie = Cookie.parse(res.headers['set-cookie'][0]);
         return res.body;
     }
     async getAllData() {
@@ -495,19 +540,19 @@ class Deluge {
         const headers = {
             Cookie: (_b = (_a = this._cookie) === null || _a === void 0 ? void 0 : _a.cookieString) === null || _b === void 0 ? void 0 : _b.call(_a),
         };
-        const url = url_join_1.urlJoin(this.config.baseUrl, this.config.path);
-        const res = await got_1.default.post(url, {
+        const url = urlJoin(this.config.baseUrl, this.config.path);
+        const res = await got.post(url, {
             json: {
                 method,
                 params,
                 id: this._msgId++,
             },
             headers,
-            retry: 0,
-            // allow proxy agent
-            agent: this.config.agent,
-            timeout: this.config.timeout,
+            retry: { limit: 0 },
+            timeout: { request: this.config.timeout },
             responseType: 'json',
+            // allow proxy agent
+            ...(this.config.agent ? { agent: this.config.agent } : {}),
         });
         const err = (_d = (_c = res.body) === null || _c === void 0 ? void 0 : _c.error) !== null && _d !== void 0 ? _d : (typeof res.body === 'string' && res.body);
         if (err) {
@@ -518,9 +563,9 @@ class Deluge {
     _normalizeTorrentData(id, torrent) {
         const dateAdded = new Date(torrent.time_added * 1000).toISOString();
         // normalize state to enum
-        let state = shared_torrent_1.TorrentState.unknown;
-        if (Object.keys(shared_torrent_1.TorrentState).includes(torrent.state.toLowerCase())) {
-            state = shared_torrent_1.TorrentState[torrent.state.toLowerCase()];
+        let state = TorrentState.unknown;
+        if (Object.keys(TorrentState).includes(torrent.state.toLowerCase())) {
+            state = TorrentState[torrent.state.toLowerCase()];
         }
         const isCompleted = torrent.progress >= 100;
         const result = {
@@ -560,4 +605,3 @@ class Deluge {
         }
     }
 }
-exports.Deluge = Deluge;

package/dist/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './deluge.js';
+export * from './types.js';

package/dist/src/index.js

@@ -0,0 +1,2 @@
+export * from './deluge.js';
+export * from './types.js';

package/dist/src/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/deluge",
-  "version": "3.3.0",
+  "version": "4.0.0",
   "description": "TypeScript api wrapper for deluge using got",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",
@@ -10,50 +10,52 @@
     "deluge",
     "typescript"
   ],
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "type": "module",
+  "main": "./dist/src/index.js",
+  "typings": "./dist/src/index.d.ts",
   "files": [
-    "dist"
+    "dist/src"
   ],
   "sideEffects": false,
   "scripts": {
     "lint": "eslint --ext .js,.ts, .",
     "lint:fix": "eslint --fix --ext .js,.ts, .",
     "prepare": "npm run build",
-    "build": "tsc -p tsconfig.build.json",
-    "build:docs": "typedoc --out docs --hideGenerator --target ES6 --mode file src && touch docs/.nojekyll",
-    "test": "jest --runInBand",
-    "test:watch": "jest --watch --runInBand",
-    "test:ci": "jest --runInBand --coverage --no-cache"
+    "build": "tsc",
+    "build:docs": "typedoc",
+    "test": "ava",
+    "test:watch": "ava --watch",
+    "test:ci": "c8 --reporter=text --reporter=lcov ava"
   },
   "dependencies": {
-    "@ctrl/shared-torrent": "^3.0.4",
-    "@ctrl/url-join": "^1.0.2",
-    "form-data": "^3.0.0",
-    "got": "^11.8.1",
+    "@ctrl/magnet-link": "^3.1.0",
+    "@ctrl/shared-torrent": "^4.1.0",
+    "@ctrl/url-join": "^2.0.0",
+    "formdata-node": "^4.3.2",
+    "got": "^12.0.1",
     "tough-cookie": "^4.0.0"
   },
   "devDependencies": {
-    "@babel/plugin-transform-modules-commonjs": "7.12.1",
-    "@babel/preset-typescript": "7.12.7",
-    "@ctrl/eslint-config": "1.2.8",
-    "@jest/globals": "26.6.2",
-    "@types/node": "14.14.13",
-    "@types/tough-cookie": "4.0.0",
-    "jest": "26.6.3",
-    "p-wait-for": "3.1.0",
-    "typedoc": "0.19.2",
-    "typescript": "4.1.3"
+    "@ctrl/eslint-config": "3.3.1",
+    "@sindresorhus/tsconfig": "2.0.0",
+    "@types/node": "17.0.21",
+    "@types/tough-cookie": "4.0.1",
+    "ava": "4.0.1",
+    "c8": "7.11.0",
+    "ts-node": "10.5.0",
+    "p-wait-for": "4.1.0",
+    "typedoc": "0.22.12",
+    "typescript": "4.5.5"
   },
-  "jest": {
-    "testEnvironment": "node"
-  },
-  "babel": {
-    "presets": [
-      "@babel/preset-typescript"
+  "ava": {
+    "files": [
+      "test/**/*.spec.ts"
     ],
-    "plugins": [
-      "@babel/plugin-transform-modules-commonjs"
+    "extensions": {
+      "ts": "module"
+    },
+    "nodeArguments": [
+      "--loader=ts-node/esm"
     ]
   },
   "publishConfig": {
@@ -63,6 +65,6 @@
     "branch": "master"
   },
   "engines": {
-    "node": ">=10.19.0"
+    "node": ">=14.16"
   }
 }

package/dist/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });