@ctrl/transmission 7.1.0 → 7.3.0

package/README.md

@@ -26,13 +26,15 @@ async function main() {
 
 ### Api
 
-Docs: https://transmission.vercel.app   
-API Docs: https://github.com/transmission/transmission/blob/master/extras/rpc-spec.txt  
+Docs: https://transmission.vercel.app  
+API Docs: https://github.com/transmission/transmission/blob/master/extras/rpc-spec.txt
 
 ### Normalized API
+
 These functions have been normalized between torrent clients. Can easily support multiple torrent clients. See below for alternative supported torrent clients
 
 ##### getAllData
+
 Returns all torrent data and an array of label objects. Data has been normalized and does not match the output of native `listTorrents()`.
 
 ```ts
@@ -41,6 +43,7 @@ console.log(data.torrents);
 ```
 
 ##### getTorrent
+
 Returns one torrent data
 
 ```ts
@@ -49,6 +52,7 @@ console.log(data);
 ```
 
 ##### pauseTorrent and resumeTorrent
+
 Pause or resume a torrent
 
 ```ts
@@ -59,6 +63,7 @@ console.log(resumed);
 ```
 
 ##### removeTorrent
+
 Remove a torrent. Does not remove data on disk by default.
 
 ```ts
@@ -71,12 +76,22 @@ 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.  
+
+All of the following npm modules provide the same normalized functions along with supporting the unique apis for each client.
 
 deluge - https://github.com/scttcper/deluge  
 qbittorrent - https://github.com/scttcper/qbittorrent  
-utorrent - https://github.com/scttcper/utorrent  
+utorrent - https://github.com/scttcper/utorrent
 
 ### Start a test docker container
 

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>;
@@ -48,11 +56,12 @@ export declare class Transmission implements TorrentClient {
      * Adding a torrent
      * @param torrent a stream of file content or contents of the file as base64 string
      */
-    addTorrent(torrent: string | Uint8Array, options?: Partial<AddTorrentOptions>): Promise<AddTorrentResponse>;
-    normalizedAddTorrent(torrent: string | Uint8Array, options?: Partial<NormalizedAddTorrentOptions>): Promise<NormalizedTorrent>;
+    addTorrent(torrent: string | Uint8Array<ArrayBuffer>, options?: Partial<AddTorrentOptions>): Promise<AddTorrentResponse>;
+    normalizedAddTorrent(torrent: string | Uint8Array<ArrayBuffer>, options?: Partial<NormalizedAddTorrentOptions>): Promise<NormalizedTorrent>;
     getTorrent(id: NormalizedTorrentIds): Promise<NormalizedTorrent>;
     getAllData(): Promise<AllClientData>;
     listTorrents(id?: NormalizedTorrentIds, additionalFields?: string[]): Promise<GetTorrentRepsonse>;
     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) {
@@ -313,7 +326,9 @@ export class Transmission {
         }
         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.1.0",
+  "version": "7.3.0",
   "description": "TypeScript api wrapper for transmission using got",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",
@@ -17,12 +17,8 @@
   ],
   "sideEffects": false,
   "scripts": {
-    "lint": "pnpm run '/^(lint:biome|lint:eslint)$/'",
-    "lint:biome": "biome check .",
-    "lint:eslint": "eslint .",
-    "lint:fix": "pnpm run '/^(lint:biome|lint:eslint):fix$/'",
-    "lint:eslint:fix": "eslint . --fix",
-    "lint:biome:fix": "biome check . --write",
+    "lint": "oxlint . && prettier --check . --experimental-cli",
+    "lint:fix": "oxlint . --fix && prettier --write . --log-level=error --experimental-cli",
     "prepare": "npm run build",
     "build": "tsc",
     "build:docs": "typedoc",
@@ -32,23 +28,26 @@
   },
   "dependencies": {
     "@ctrl/magnet-link": "^4.0.2",
-    "@ctrl/shared-torrent": "^6.1.0",
+    "@ctrl/shared-torrent": "^6.3.0",
     "ofetch": "^1.4.1",
-    "ufo": "^1.5.4",
-    "uint8array-extras": "^1.4.0"
+    "type-fest": "^4.41.0",
+    "ufo": "^1.6.1",
+    "uint8array-extras": "^1.5.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.9.4",
-    "@ctrl/eslint-config-biome": "4.2.11",
-    "@ctrl/magnet-link": "^4.0.2",
-    "@ctrl/shared-torrent": "^6.1.0",
-    "@sindresorhus/tsconfig": "6.0.0",
-    "@types/node": "22.9.0",
-    "@vitest/coverage-v8": "2.1.4",
+    "@ctrl/oxlint-config": "1.2.3",
+    "@ctrl/magnet-link": "4.0.2",
+    "@ctrl/shared-torrent": "6.3.0",
+    "@sindresorhus/tsconfig": "8.0.1",
+    "@trivago/prettier-plugin-sort-imports": "5.2.2",
+    "@types/node": "24.3.0",
+    "@vitest/coverage-v8": "3.2.4",
+    "oxlint": "1.14.0",
     "p-wait-for": "5.0.2",
-    "typedoc": "0.26.11",
-    "typescript": "5.6.3",
-    "vitest": "2.1.4"
+    "prettier": "3.6.2",
+    "typedoc": "0.28.11",
+    "typescript": "5.9.2",
+    "vitest": "3.2.4"
   },
   "publishConfig": {
     "access": "public",
@@ -61,5 +60,26 @@
   },
   "engines": {
     "node": ">=18"
+  },
+  "packageManager": "pnpm@10.15.0",
+  "prettier": {
+    "singleQuote": true,
+    "trailingComma": "all",
+    "arrowParens": "avoid",
+    "semi": true,
+    "printWidth": 100,
+    "plugins": [
+      "@trivago/prettier-plugin-sort-imports"
+    ],
+    "importOrder": [
+      "^node:.*$",
+      "<THIRD_PARTY_MODULES>",
+      "^(@ctrl)(/.*|$)",
+      "^\\.\\./(?!.*\\.css$)",
+      "^\\./(?!.*\\.css$)(?=.*/)",
+      "^\\./(?!.*\\.css$)(?!.*/)"
+    ],
+    "importOrderSeparation": true,
+    "importOrderSortSpecifiers": false
   }
 }