@ctrl/transmission 7.0.0 → 7.2.0

package/README.md

@@ -71,6 +71,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 = Transmission.createFromState(config, state);
+```
+
 ### See Also
 All of the following npm modules provide the same normalized functions along with supporting the unique apis for each client.  
 

package/dist/src/transmission.d.ts

@@ -1,10 +1,18 @@
 import { ofetch } from 'ofetch';
-import type { AddTorrentOptions as NormalizedAddTorrentOptions, AllClientData, NormalizedTorrent, TorrentClient, TorrentSettings } from '@ctrl/shared-torrent';
+import type { Jsonify } from 'type-fest';
+import type { AddTorrentOptions as NormalizedAddTorrentOptions, AllClientData, NormalizedTorrent, TorrentClient, TorrentClientConfig, TorrentClientState } from '@ctrl/shared-torrent';
 import type { AddTorrentOptions, AddTorrentResponse, DefaultResponse, FreeSpaceResponse, GetTorrentRepsonse, NormalizedTorrentIds, RenamePathOptions, SessionArguments, SessionResponse, SetTorrentOptions } from './types.js';
+interface TransmissionState extends TorrentClientState {
+    auth?: {
+        sessionId: string;
+    };
+}
 export declare class Transmission implements TorrentClient {
-    config: TorrentSettings;
-    sessionId?: string;
-    constructor(options?: Partial<TorrentSettings>);
+    static createFromState(config: Readonly<TorrentClientConfig>, state: Readonly<Jsonify<TransmissionState>>): Transmission;
+    config: TorrentClientConfig;
+    state: TransmissionState;
+    constructor(options?: Partial<TorrentClientConfig>);
+    exportState(): Jsonify<TransmissionState>;
     getSession(): Promise<SessionResponse>;
     setSession(args: Partial<SessionArguments>): Promise<SessionResponse>;
     queueTop(id: NormalizedTorrentIds): Promise<DefaultResponse>;
@@ -56,3 +64,4 @@ export declare class Transmission implements TorrentClient {
     request<T>(method: string, args?: any): Promise<ReturnType<typeof ofetch.raw<T>>>;
     private _handleNormalizedIds;
 }
+export {};

package/dist/src/transmission.js

@@ -11,11 +11,24 @@ const defaults = {
     timeout: 5000,
 };
 export class Transmission {
+    static createFromState(config, state) {
+        const client = new Transmission(config);
+        client.state = {
+            ...state,
+            auth: {
+                sessionId: state.auth?.sessionId,
+            },
+        };
+        return client;
+    }
     config;
-    sessionId;
+    state = {};
     constructor(options = {}) {
         this.config = { ...defaults, ...options };
     }
+    exportState() {
+        return JSON.parse(JSON.stringify(this.state));
+    }
     async getSession() {
         const res = await this.request('session-get');
         return res._data;
@@ -276,11 +289,11 @@ export class Transmission {
         return res._data;
     }
     async request(method, args = {}) {
-        if (!this.sessionId && method !== 'session-get') {
+        if (!this.state.auth?.sessionId && method !== 'session-get') {
             await this.getSession();
         }
         const headers = {
-            'X-Transmission-Session-Id': this.sessionId,
+            'X-Transmission-Session-Id': this.state.auth?.sessionId,
             'Content-Type': 'application/json',
         };
         if (this.config.username || this.config.password) {
@@ -297,7 +310,6 @@ export class Transmission {
                 }),
                 headers,
                 retry: 0,
-                // allow proxy agent
                 timeout: this.config.timeout,
                 responseType: 'json',
                 parseResponse(body) {
@@ -308,14 +320,15 @@ export class Transmission {
                         return body;
                     }
                 },
-                // @ts-expect-error agent is not in the type
-                agent: this.config.agent,
+                dispatcher: this.config.dispatcher,
             });
             return res;
         }
         catch (error) {
             if (error instanceof FetchError && error.response.status === 409) {
-                this.sessionId = error.response.headers.get('x-transmission-session-id');
+                this.state.auth = {
+                    sessionId: error.response.headers.get('x-transmission-session-id'),
+                };
                 // eslint-disable-next-line no-return-await, @typescript-eslint/return-await
                 return await this.request(method, args);
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/transmission",
-  "version": "7.0.0",
+  "version": "7.2.0",
   "description": "TypeScript api wrapper for transmission using got",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",
@@ -22,7 +22,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",
@@ -32,23 +32,24 @@
   },
   "dependencies": {
     "@ctrl/magnet-link": "^4.0.2",
-    "@ctrl/shared-torrent": "^6.0.0",
-    "ofetch": "^1.3.4",
+    "@ctrl/shared-torrent": "^6.2.1",
+    "ofetch": "^1.4.1",
+    "type-fest": "^4.30.2",
     "ufo": "^1.5.4",
     "uint8array-extras": "^1.4.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.8.3",
-    "@ctrl/eslint-config-biome": "4.1.5",
+    "@biomejs/biome": "1.9.4",
+    "@ctrl/eslint-config-biome": "4.3.1",
     "@ctrl/magnet-link": "^4.0.2",
-    "@ctrl/shared-torrent": "^6.0.0",
-    "@sindresorhus/tsconfig": "6.0.0",
-    "@types/node": "22.5.1",
-    "@vitest/coverage-v8": "2.0.5",
+    "@ctrl/shared-torrent": "^6.2.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.6",
-    "typescript": "5.5.4",
-    "vitest": "2.0.5"
+    "typedoc": "0.27.5",
+    "typescript": "5.7.2",
+    "vitest": "2.1.8"
   },
   "publishConfig": {
     "access": "public",