@ctrl/deluge 6.1.0 → 7.1.0

package/README.md

@@ -70,6 +70,15 @@ const res = await client.removeTorrent('torrent_id', true);
 console.log(res);
 ```
 
+##### export and create from state
+
+If you're shutting down the server often (serverless?) you can export the state
+
+```ts
+const state = client.exportState()
+const client = Deluge.createFromState(config, state);
+```
+
 ### See Also
 transmission - https://github.com/scttcper/transmission  
 qbittorrent - https://github.com/scttcper/qbittorrent  

package/dist/src/deluge.d.ts

@@ -1,11 +1,20 @@
 import { ofetch } from 'ofetch';
-import type { AddTorrentOptions as NormalizedAddTorrentOptions, AllClientData, NormalizedTorrent, TorrentClient, TorrentSettings } from '@ctrl/shared-torrent';
+import { Cookie } from 'tough-cookie';
+import type { Jsonify } from 'type-fest';
+import type { AddTorrentOptions as NormalizedAddTorrentOptions, AllClientData, NormalizedTorrent, TorrentClient, TorrentClientConfig, TorrentClientState } 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';
+interface DelugeState extends TorrentClientState {
+    auth: {
+        cookie?: Cookie;
+        msgId: number;
+    };
+}
 export declare class Deluge implements TorrentClient {
-    config: TorrentSettings;
-    private _msgId;
-    private _cookie?;
-    constructor(options?: Partial<TorrentSettings>);
+    static createFromState(config: Readonly<TorrentClientConfig>, state: Readonly<Jsonify<DelugeState>>): Deluge;
+    config: TorrentClientConfig;
+    state: DelugeState;
+    constructor(options?: Partial<TorrentClientConfig>);
+    exportState(): Jsonify<DelugeState>;
     resetSession(): void;
     getHosts(): Promise<GetHostsResponse>;
     /**
@@ -69,7 +78,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>;
@@ -108,3 +117,4 @@ export declare class Deluge implements TorrentClient {
     request<T extends object>(method: string, params?: any[], needsAuth?: boolean, autoConnect?: boolean): Promise<ReturnType<typeof ofetch.raw<T>>>;
     private _validateAuth;
 }
+export {};

package/dist/src/deluge.js

@@ -12,15 +12,37 @@ const defaults = {
     timeout: 5000,
 };
 export class Deluge {
+    static createFromState(config, state) {
+        const deluge = new Deluge(config);
+        deluge.state = {
+            ...state,
+            auth: state.auth
+                ? {
+                    cookie: Cookie.fromJSON(state.auth.cookie),
+                    msgId: state.auth.msgId,
+                }
+                : { msgId: 0 },
+        };
+        return deluge;
+    }
     config;
-    _msgId = 0;
-    _cookie;
+    state = { auth: { msgId: 0 } };
     constructor(options = {}) {
         this.config = { ...defaults, ...options };
     }
+    exportState() {
+        return JSON.parse(JSON.stringify({
+            ...this.state,
+            auth: this.state.auth
+                ? {
+                    cookie: this.state.auth.cookie.toJSON(),
+                    msgId: this.state.auth.msgId,
+                }
+                : { msgId: 0 },
+        }));
+    }
     resetSession() {
-        this._cookie = undefined;
-        this._msgId = 0;
+        this.state.auth = { msgId: 0 };
     }
     async getHosts() {
         const res = await this.request('web.get_hosts', [], true, false);
@@ -75,15 +97,15 @@ export class Deluge {
      */
     async checkSession() {
         // cookie is missing or expires in x seconds
-        if (this._cookie) {
+        if (this.state.auth.cookie) {
             // eslint-disable-next-line new-cap
-            if (this._cookie.TTL() < 5000) {
+            if (this.state.auth.cookie.TTL() < 5000) {
                 this.resetSession();
                 return false;
             }
             return true;
         }
-        if (this._cookie) {
+        if (this.state.auth.cookie) {
             try {
                 const check = await this.request('auth.check_session', undefined, false);
                 const body = await check.json();
@@ -108,7 +130,7 @@ export class Deluge {
         if (!res.ok || !res.headers?.get('set-cookie')?.length) {
             throw new Error('Auth failed, incorrect password');
         }
-        this._cookie = Cookie.parse(res.headers.get('set-cookie'));
+        this.state.auth.cookie = Cookie.parse(res.headers.get('set-cookie'));
         return true;
     }
     /**
@@ -167,8 +189,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 +209,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 +218,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 +303,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;
     }
@@ -295,7 +320,7 @@ export class Deluge {
         }
         // update current password to new password
         this.config.password = password;
-        this._cookie = Cookie.parse(res.headers.get('set-cookie'));
+        this.state.auth.cookie = Cookie.parse(res.headers.get('set-cookie'));
         return body;
     }
     async getAllData() {
@@ -508,10 +533,9 @@ 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;
+        if (this.state.auth.msgId === 4096) {
+            this.state.auth.msgId = 0;
         }
         if (needsAuth) {
             await this._validateAuth();
@@ -523,7 +547,7 @@ export class Deluge {
             }
         }
         const headers = {
-            Cookie: this._cookie?.cookieString?.(),
+            Cookie: this.state.auth.cookie?.cookieString?.(),
         };
         const url = joinURL(this.config.baseUrl, this.config.path);
         const res = await ofetch.raw(url, {
@@ -531,15 +555,14 @@ export class Deluge {
             body: JSON.stringify({
                 method,
                 params,
-                id: this._msgId++,
+                id: this.state.auth.msgId++,
             }),
             headers,
             retry: 0,
             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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/deluge",
-  "version": "6.1.0",
+  "version": "7.1.0",
   "description": "TypeScript api wrapper for deluge using got",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",
@@ -23,7 +23,7 @@
     "lint:eslint": "eslint .",
     "lint:fix": "pnpm run '/^(lint:biome|lint:eslint):fix$/'",
     "lint:eslint:fix": "eslint . --fix",
-    "lint:biome:fix": "biome check . --apply",
+    "lint:biome:fix": "biome check . --write",
     "prepare": "npm run build",
     "build": "tsc",
     "build:docs": "typedoc",
@@ -33,24 +33,24 @@
   },
   "dependencies": {
     "@ctrl/magnet-link": "^4.0.2",
-    "@ctrl/shared-torrent": "^6.0.0",
+    "@ctrl/shared-torrent": "^6.2.1",
     "node-fetch-native": "^1.6.4",
-    "ofetch": "^1.3.4",
-    "tough-cookie": "^4.1.4",
-    "ufo": "^1.5.3",
-    "uint8array-extras": "^1.2.0"
+    "ofetch": "^1.4.1",
+    "tough-cookie": "^5.0.0",
+    "type-fest": "^4.30.2",
+    "ufo": "^1.5.4",
+    "uint8array-extras": "^1.4.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.8.3",
-    "@ctrl/eslint-config-biome": "3.1.3",
-    "@sindresorhus/tsconfig": "6.0.0",
-    "@types/node": "20.14.9",
-    "@types/tough-cookie": "4.0.5",
-    "@vitest/coverage-v8": "1.6.0",
+    "@biomejs/biome": "1.9.4",
+    "@ctrl/eslint-config-biome": "4.3.1",
+    "@sindresorhus/tsconfig": "7.0.0",
+    "@types/node": "22.10.2",
+    "@vitest/coverage-v8": "2.1.8",
     "p-wait-for": "5.0.2",
-    "typedoc": "0.26.3",
-    "typescript": "5.5.3",
-    "vitest": "1.6.0"
+    "typedoc": "0.27.5",
+    "typescript": "5.7.2",
+    "vitest": "2.1.8"
   },
   "publishConfig": {
     "access": "public",