@ctrl/transmission 4.2.0 → 5.0.0

package/README.md

@@ -1,4 +1,4 @@
-# transmission [![npm](https://img.shields.io/npm/v/@ctrl/transmission.svg?maxAge=3600)](https://www.npmjs.com/package/@ctrl/transmission) [![CircleCI](https://circleci.com/gh/scttcper/transmission.svg?style=svg)](https://circleci.com/gh/scttcper/transmission) [![coverage status](https://codecov.io/gh/scttcper/transmission/branch/master/graph/badge.svg)](https://codecov.io/gh/scttcper/transmission)
+# transmission [![npm](https://img.shields.io/npm/v/@ctrl/transmission.svg?maxAge=3600)](https://www.npmjs.com/package/@ctrl/transmission) [![coverage status](https://codecov.io/gh/scttcper/transmission/branch/master/graph/badge.svg)](https://codecov.io/gh/scttcper/transmission)
 
 > TypeScript api wrapper for [transmission](https://transmissionbt.com/) using [got](https://github.com/sindresorhus/got)
 
@@ -77,3 +77,21 @@ All of the following npm modules provide the same normalized functions along wit
 deluge - https://github.com/scttcper/deluge  
 qbittorrent - https://github.com/scttcper/qbittorrent  
 utorrent - https://github.com/scttcper/utorrent  
+
+### Start a test docker container
+
+```
+docker run -d \
+  --name=transmission \
+  -e PUID=1000 \
+  -e PGID=1000 \
+  -e TZ=Etc/UTC \
+  -p 9091:9091 \
+  -p 51413:51413 \
+  -p 51413:51413/udp \
+  -v ~/Documents/transmission/config:/config \
+  -v ~/Documents/transmission/downloads:/downloads \
+  -v ~/Documents/transmission/watch:/watch \
+  --restart unless-stopped \
+  lscr.io/linuxserver/transmission:latest
+```

package/dist/src/normalizeTorrentData.d.ts

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

package/dist/src/normalizeTorrentData.js

@@ -0,0 +1,49 @@
+import { TorrentState } from '@ctrl/shared-torrent';
+export function normalizeTorrentData(torrent) {
+    const dateAdded = new Date(torrent.addedDate * 1000).toISOString();
+    const dateCompleted = new Date(torrent.doneDate * 1000).toISOString();
+    // normalize state to enum
+    // https://github.com/transmission/transmission/blob/c11f2870fd18ff781ca06ce84b6d43541f3293dd/web/javascript/torrent.js#L18
+    let state = TorrentState.unknown;
+    if (torrent.status === 6) {
+        state = TorrentState.seeding;
+    }
+    else if (torrent.status === 4) {
+        state = TorrentState.downloading;
+    }
+    else if (torrent.status === 0) {
+        state = TorrentState.paused;
+    }
+    else if (torrent.status === 2) {
+        state = TorrentState.checking;
+    }
+    else if (torrent.status === 3 || torrent.status === 5) {
+        state = TorrentState.queued;
+    }
+    return {
+        id: torrent.hashString,
+        name: torrent.name,
+        state,
+        isCompleted: torrent.leftUntilDone < 1,
+        stateMessage: '',
+        progress: torrent.percentDone,
+        ratio: torrent.uploadRatio,
+        dateAdded,
+        dateCompleted,
+        label: torrent.labels?.length ? torrent.labels[0] : undefined,
+        savePath: torrent.downloadDir,
+        uploadSpeed: torrent.rateUpload,
+        downloadSpeed: torrent.rateDownload,
+        eta: torrent.eta,
+        queuePosition: torrent.queuePosition,
+        connectedPeers: torrent.peersSendingToUs,
+        connectedSeeds: torrent.peersGettingFromUs,
+        totalPeers: torrent.peersConnected,
+        totalSeeds: torrent.peersConnected,
+        totalSelected: torrent.sizeWhenDone,
+        totalSize: torrent.totalSize,
+        totalUploaded: torrent.uploadedEver,
+        totalDownloaded: torrent.downloadedEver,
+        raw: torrent,
+    };
+}

package/dist/src/transmission.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, DefaultResponse, FreeSpaceResponse, GetTorrentRepsonse, NormalizedTorrentIds, RenamePathOptions, SessionArguments, SessionResponse, SetTorrentOptions } from './types.js';
 export declare class Transmission implements TorrentClient {
@@ -53,7 +53,6 @@ export declare class Transmission implements TorrentClient {
     getTorrent(id: NormalizedTorrentIds): Promise<NormalizedTorrent>;
     getAllData(): Promise<AllClientData>;
     listTorrents(id?: NormalizedTorrentIds, additionalFields?: string[]): Promise<GetTorrentRepsonse>;
-    request<T>(method: string, args?: any): Promise<Response<T>>;
+    request<T>(method: string, args?: any): Promise<FetchResponse<T>>;
     private _handleNormalizedIds;
-    private _normalizeTorrentData;
 }

package/dist/src/transmission.js

@@ -1,8 +1,7 @@
-import { existsSync, readFileSync } from 'fs';
-import got from 'got';
+import { FetchError, ofetch } from 'ofetch';
+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:9091/',
     path: '/transmission/rpc',
@@ -11,67 +10,57 @@ const defaults = {
     timeout: 5000,
 };
 export class Transmission {
+    config;
+    sessionId;
     constructor(options = {}) {
-        Object.defineProperty(this, "config", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "sessionId", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
         this.config = { ...defaults, ...options };
     }
     async getSession() {
         const res = await this.request('session-get');
-        return res.body;
+        return res._data;
     }
     async setSession(args) {
         const res = await this.request('session-set', args);
-        return res.body;
+        return res._data;
     }
     async queueTop(id) {
         const ids = this._handleNormalizedIds(id);
         const res = await this.request('queue-move-top', { ids });
-        return res.body;
+        return res._data;
     }
     async queueBottom(id) {
         const ids = this._handleNormalizedIds(id);
         const res = await this.request('queue-move-bottom', { ids });
-        return res.body;
+        return res._data;
     }
     async queueUp(id) {
         const ids = this._handleNormalizedIds(id);
         const res = await this.request('queue-move-up', { ids });
-        return res.body;
+        return res._data;
     }
     async queueDown(id) {
         const ids = this._handleNormalizedIds(id);
         const res = await this.request('queue-move-down', { ids });
-        return res.body;
+        return res._data;
     }
     async freeSpace(path = '/downloads/complete') {
         const res = await this.request('free-space', { path });
-        return res.body;
+        return res._data;
     }
     async pauseTorrent(id) {
         const ids = this._handleNormalizedIds(id);
         const res = await this.request('torrent-stop', { ids });
-        return res.body;
+        return res._data;
     }
     async resumeTorrent(id) {
         const ids = this._handleNormalizedIds(id);
         const res = await this.request('torrent-start', { ids });
-        return res.body;
+        return res._data;
     }
     async verifyTorrent(id) {
         const ids = this._handleNormalizedIds(id);
         const res = await this.request('torrent-verify', { ids });
-        return res.body;
+        return res._data;
     }
     /**
      * ask tracker for more peers
@@ -79,7 +68,7 @@ export class Transmission {
     async reannounceTorrent(id) {
         const ids = this._handleNormalizedIds(id);
         const res = await this.request('torrent-reannounce', { ids });
-        return res.body;
+        return res._data;
     }
     async moveTorrent(id, location) {
         const ids = this._handleNormalizedIds(id);
@@ -88,7 +77,7 @@ export class Transmission {
             move: true,
             location,
         });
-        return res.body;
+        return res._data;
     }
     /**
      * Torrent Mutators
@@ -97,7 +86,7 @@ export class Transmission {
         const ids = this._handleNormalizedIds(id);
         options.ids = ids;
         const res = await this.request('torrent-set', options);
-        return res.body;
+        return res._data;
     }
     /**
      * Renaming a Torrent's Path
@@ -106,7 +95,7 @@ export class Transmission {
         const ids = this._handleNormalizedIds(id);
         options.ids = ids;
         const res = await this.request('torrent-rename-path', options);
-        return res.body;
+        return res._data;
     }
     /**
      * Removing a Torrent
@@ -117,7 +106,7 @@ export class Transmission {
             ids,
             'delete-local-data': removeData,
         });
-        return res.body;
+        return res._data;
     }
     /**
      * An alias for {@link Transmission.addMagnet}
@@ -139,7 +128,7 @@ export class Transmission {
         };
         args.filename = url;
         const res = await this.request('torrent-add', args);
-        return res.body;
+        return res._data;
     }
     /**
      * Adding a torrent
@@ -152,15 +141,13 @@ export class Transmission {
             ...options,
         };
         if (typeof torrent === 'string') {
-            args.metainfo = existsSync(torrent)
-                ? Buffer.from(readFileSync(torrent)).toString('base64')
-                : Buffer.from(torrent, 'base64').toString('base64');
+            args.metainfo = Buffer.from(torrent, 'base64').toString('base64');
         }
         else {
             args.metainfo = torrent.toString('base64');
         }
         const res = await this.request('torrent-add', args);
-        return res.body;
+        return res._data;
     }
     async normalizedAddTorrent(torrent, options = {}) {
         const torrentOptions = {};
@@ -192,11 +179,11 @@ export class Transmission {
         if (!result.arguments.torrents || result.arguments.torrents.length === 0) {
             throw new Error('Torrent not found');
         }
-        return this._normalizeTorrentData(result.arguments.torrents[0]);
+        return normalizeTorrentData(result.arguments.torrents[0]);
     }
     async getAllData() {
         const listTorrents = await this.listTorrents();
-        const torrents = listTorrents.arguments.torrents.map((n) => this._normalizeTorrentData(n));
+        const torrents = listTorrents.arguments.torrents.map((n) => normalizeTorrentData(n));
         const labels = [];
         for (const torrent of torrents) {
             if (!torrent.label) {
@@ -212,6 +199,7 @@ export class Transmission {
         const results = {
             torrents,
             labels,
+            raw: listTorrents,
         };
         return results;
     }
@@ -283,7 +271,7 @@ export class Transmission {
             args.ids = ids;
         }
         const res = await this.request('torrent-get', args);
-        return res.body;
+        return res._data;
     }
     async request(method, args = {}) {
         if (!this.sessionId && method !== 'session-get') {
@@ -291,30 +279,41 @@ export class Transmission {
         }
         const headers = {
             'X-Transmission-Session-Id': this.sessionId,
+            'Content-Type': 'application/json',
         };
         if (this.config.username || this.config.password) {
             const str = `${this.config.username ?? ''}:${this.config.password ?? ''}`;
             headers.Authorization = 'Basic ' + Buffer.from(str).toString('base64');
         }
-        const url = urlJoin(this.config.baseUrl, this.config.path);
+        const url = joinURL(this.config.baseUrl, this.config.path);
         try {
-            const res = await got.post(url, {
-                json: {
+            const res = await ofetch.raw(url, {
+                method: 'POST',
+                body: JSON.stringify({
                     method,
                     arguments: args,
-                },
+                }),
                 headers,
-                retry: { limit: 0 },
+                retry: 0,
                 // allow proxy agent
-                timeout: { request: this.config.timeout },
+                timeout: this.config.timeout,
                 responseType: 'json',
-                ...(this.config.agent ? { agent: this.config.agent } : {}),
+                parseResponse(body) {
+                    try {
+                        return JSON.parse(body);
+                    }
+                    catch (error) {
+                        return body;
+                    }
+                },
+                // @ts-expect-error agent is not in the type
+                agent: this.config.agent,
             });
             return res;
         }
         catch (error) {
-            if (error?.response?.statusCode === 409) {
-                this.sessionId = error.response.headers['x-transmission-session-id'];
+            if (error instanceof FetchError && error.response.status === 409) {
+                this.sessionId = error.response.headers.get('x-transmission-session-id');
                 // eslint-disable-next-line no-return-await
                 return await this.request(method, args);
             }
@@ -328,51 +327,4 @@ export class Transmission {
         }
         return ids;
     }
-    _normalizeTorrentData(torrent) {
-        const dateAdded = new Date(torrent.addedDate * 1000).toISOString();
-        const dateCompleted = new Date(torrent.doneDate * 1000).toISOString();
-        // normalize state to enum
-        // https://github.com/transmission/transmission/blob/c11f2870fd18ff781ca06ce84b6d43541f3293dd/web/javascript/torrent.js#L18
-        let state = TorrentState.unknown;
-        if (torrent.status === 6) {
-            state = TorrentState.seeding;
-        }
-        else if (torrent.status === 4) {
-            state = TorrentState.downloading;
-        }
-        else if (torrent.status === 0) {
-            state = TorrentState.paused;
-        }
-        else if (torrent.status === 2) {
-            state = TorrentState.checking;
-        }
-        else if (torrent.status === 3 || torrent.status === 5) {
-            state = TorrentState.queued;
-        }
-        return {
-            id: torrent.hashString,
-            name: torrent.name,
-            state,
-            isCompleted: torrent.leftUntilDone < 1,
-            stateMessage: '',
-            progress: torrent.percentDone,
-            ratio: torrent.uploadRatio,
-            dateAdded,
-            dateCompleted,
-            label: torrent.labels?.length ? torrent.labels[0] : undefined,
-            savePath: torrent.downloadDir,
-            uploadSpeed: torrent.rateUpload,
-            downloadSpeed: torrent.rateDownload,
-            eta: torrent.eta,
-            queuePosition: torrent.queuePosition,
-            connectedPeers: torrent.peersSendingToUs,
-            connectedSeeds: torrent.peersGettingFromUs,
-            totalPeers: torrent.peersConnected,
-            totalSeeds: torrent.peersConnected,
-            totalSelected: torrent.sizeWhenDone,
-            totalSize: torrent.totalSize,
-            totalUploaded: torrent.uploadedEver,
-            totalDownloaded: torrent.downloadedEver,
-        };
-    }
 }

package/dist/src/types.d.ts

@@ -45,11 +45,11 @@ export interface FreeSpaceResponse extends DefaultResponse {
  * 2. a list of torrent id numbers, sha1 hash strings, or both
  * 3. a string, "recently-active", for recently-active torrents
  */
-export declare type TorrentIds = number | 'recently-active' | Array<number | string>;
+export type TorrentIds = number | 'recently-active' | Array<number | string>;
 /**
  * Allows the user to pass a single hash, this will be converted to an array
  */
-export declare type NormalizedTorrentIds = TorrentIds | string;
+export type NormalizedTorrentIds = TorrentIds | string;
 export interface GetTorrentRepsonse extends DefaultResponse {
     arguments: {
         removed: Torrent[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/transmission",
-  "version": "4.2.0",
+  "version": "5.0.0",
   "description": "TypeScript api wrapper for transmission using got",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",
@@ -24,31 +24,27 @@
     "build:docs": "typedoc",
     "test": "vitest run",
     "test:watch": "vitest",
-    "test:ci": "vitest run --coverage"
+    "test:ci": "vitest run --coverage --reporter=default --reporter=junit --outputFile=./junit.xml"
   },
   "dependencies": {
-    "@ctrl/magnet-link": "^3.1.1",
-    "@ctrl/shared-torrent": "^4.2.0",
-    "@ctrl/url-join": "^2.0.2",
-    "got": "^12.3.1"
+    "@ctrl/magnet-link": "^3.1.2",
+    "@ctrl/shared-torrent": "^5.0.0",
+    "ofetch": "^1.3.3",
+    "ufo": "^1.3.0"
   },
   "devDependencies": {
-    "@ctrl/eslint-config": "3.4.10",
-    "@sindresorhus/tsconfig": "3.0.1",
-    "@types/node": "18.7.14",
-    "@vitest/coverage-c8": "0.22.1",
-    "c8": "7.12.0",
-    "p-wait-for": "5.0.0",
-    "typedoc": "0.23.12",
-    "typescript": "4.8.2",
-    "vitest": "0.22.1"
-  },
-  "jest": {
-    "testEnvironment": "node",
-    "coverageProvider": "v8"
+    "@ctrl/eslint-config": "4.0.7",
+    "@sindresorhus/tsconfig": "4.0.0",
+    "@types/node": "20.6.5",
+    "@vitest/coverage-v8": "0.34.5",
+    "p-wait-for": "5.0.2",
+    "typedoc": "0.25.1",
+    "typescript": "5.2.2",
+    "vitest": "0.34.5"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "release": {
     "branches": [
@@ -56,6 +52,6 @@
     ]
   },
   "engines": {
-    "node": ">=14.16"
+    "node": ">=18"
   }
 }