@ctrl/transmission 2.3.0 → 3.0.0

package/README.md

@@ -4,7 +4,7 @@
 
 ### Install
 
-```console
+```sh
 npm install @ctrl/transmission
 ```
 

package/dist/index.d.ts

@@ -1,58 +1,2 @@
-/// <reference types="node" />
-import { Response } from 'got';
-import { AddTorrentOptions as NormalizedAddTorrentOptions, AllClientData, NormalizedTorrent, TorrentClient, TorrentSettings } from '@ctrl/shared-torrent';
-import { AddTorrentOptions, AddTorrentResponse, DefaultResponse, FreeSpaceResponse, GetTorrentRepsonse, RenamePathOptions, SessionArguments, SessionResponse, SetTorrentOptions, TorrentIds } from './types';
-export declare class Transmission implements TorrentClient {
-    config: TorrentSettings;
-    sessionId?: string;
-    constructor(options?: Partial<TorrentSettings>);
-    getSession(): Promise<SessionResponse>;
-    setSession(args: Partial<SessionArguments>): Promise<SessionResponse>;
-    queueTop(ids: TorrentIds): Promise<DefaultResponse>;
-    queueBottom(ids: TorrentIds): Promise<DefaultResponse>;
-    queueUp(ids: TorrentIds): Promise<DefaultResponse>;
-    queueDown(ids: TorrentIds): Promise<DefaultResponse>;
-    freeSpace(path?: string): Promise<FreeSpaceResponse>;
-    pauseTorrent(ids: TorrentIds): Promise<DefaultResponse>;
-    resumeTorrent(ids: TorrentIds): Promise<DefaultResponse>;
-    verifyTorrent(ids: TorrentIds): Promise<DefaultResponse>;
-    /**
-     * ask tracker for more peers
-     */
-    reannounceTorrent(ids: TorrentIds): Promise<DefaultResponse>;
-    moveTorrent(ids: TorrentIds, location: string): Promise<DefaultResponse>;
-    /**
-     * Torrent Mutators
-     */
-    setTorrent(ids: TorrentIds, options?: Partial<SetTorrentOptions>): Promise<DefaultResponse>;
-    /**
-     * Renaming a Torrent's Path
-     */
-    renamePath(ids: TorrentIds, options?: Partial<RenamePathOptions>): Promise<DefaultResponse>;
-    /**
-     * Removing a Torrent
-     */
-    removeTorrent(ids: TorrentIds, removeData?: boolean): Promise<AddTorrentResponse>;
-    /**
-     * An alias for {@link Transmission.addMagnet}
-     */
-    addUrl(...args: Parameters<Transmission['addMagnet']>): Promise<AddTorrentResponse>;
-    /**
-     * note: This is the same "torrent-add" action with different options,
-     * less confusing to add it as its own method
-     * @param url magnet link
-     * @param options
-     */
-    addMagnet(url: string, options?: Partial<AddTorrentOptions>): Promise<AddTorrentResponse>;
-    /**
-     * Adding a torrent
-     * @param torrent a string of file path or contents of the file as base64 string
-     */
-    addTorrent(torrent: string | Buffer, options?: Partial<AddTorrentOptions>): Promise<AddTorrentResponse>;
-    normalizedAddTorrent(torrent: string | Buffer, options?: Partial<NormalizedAddTorrentOptions>): Promise<NormalizedTorrent>;
-    getTorrent(id: TorrentIds): Promise<NormalizedTorrent>;
-    getAllData(): Promise<AllClientData>;
-    listTorrents(ids?: TorrentIds, additionalFields?: string[]): Promise<GetTorrentRepsonse>;
-    request<T>(method: string, args?: any): Promise<Response<T>>;
-    private _normalizeTorrentData;
-}
+export * from './transmission';
+export * from './types';

package/dist/index.js

@@ -1,350 +1,14 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Transmission = void 0;
-const fs_1 = require("fs");
-const got_1 = __importDefault(require("got"));
-const shared_torrent_1 = require("@ctrl/shared-torrent");
-const url_join_1 = require("@ctrl/url-join");
-const defaults = {
-    baseUrl: 'http://localhost:9091/',
-    path: '/transmission/rpc',
-    username: '',
-    password: '',
-    timeout: 5000,
-};
-class Transmission {
-    constructor(options = {}) {
-        this.config = { ...defaults, ...options };
-    }
-    async getSession() {
-        const res = await this.request('session-get');
-        return res.body;
-    }
-    async setSession(args) {
-        const res = await this.request('session-set', args);
-        return res.body;
-    }
-    async queueTop(ids) {
-        const res = await this.request('queue-move-top', { ids });
-        return res.body;
-    }
-    async queueBottom(ids) {
-        const res = await this.request('queue-move-bottom', { ids });
-        return res.body;
-    }
-    async queueUp(ids) {
-        const res = await this.request('queue-move-up', { ids });
-        return res.body;
-    }
-    async queueDown(ids) {
-        const res = await this.request('queue-move-down', { ids });
-        return res.body;
-    }
-    async freeSpace(path = '/downloads/complete') {
-        const res = await this.request('free-space', { path });
-        return res.body;
-    }
-    async pauseTorrent(ids) {
-        const res = await this.request('torrent-stop', { ids });
-        return res.body;
-    }
-    async resumeTorrent(ids) {
-        const res = await this.request('torrent-start', { ids });
-        return res.body;
-    }
-    async verifyTorrent(ids) {
-        const res = await this.request('torrent-verify', { ids });
-        return res.body;
-    }
-    /**
-     * ask tracker for more peers
-     */
-    async reannounceTorrent(ids) {
-        const res = await this.request('torrent-reannounce', { ids });
-        return res.body;
-    }
-    async moveTorrent(ids, location) {
-        const res = await this.request('torrent-set-location', {
-            ids,
-            move: true,
-            location,
-        });
-        return res.body;
-    }
-    /**
-     * Torrent Mutators
-     */
-    async setTorrent(ids, options = {}) {
-        options.ids = ids;
-        const res = await this.request('torrent-set', options);
-        return res.body;
-    }
-    /**
-     * Renaming a Torrent's Path
-     */
-    async renamePath(ids, options = {}) {
-        options.ids = ids;
-        const res = await this.request('torrent-rename-path', options);
-        return res.body;
-    }
-    /**
-     * Removing a Torrent
-     */
-    async removeTorrent(ids, removeData = true) {
-        const res = await this.request('torrent-remove', {
-            ids,
-            'delete-local-data': removeData,
-        });
-        return res.body;
-    }
-    /**
-     * An alias for {@link Transmission.addMagnet}
-     */
-    async addUrl(...args) {
-        return this.addMagnet(...args);
-    }
-    /**
-     * note: This is the same "torrent-add" action with different options,
-     * less confusing to add it as its own method
-     * @param url magnet link
-     * @param options
-     */
-    async addMagnet(url, options = {}) {
-        const args = {
-            'download-dir': '/downloads',
-            paused: false,
-            ...options,
-        };
-        args.filename = url;
-        const res = await this.request('torrent-add', args);
-        return res.body;
-    }
-    /**
-     * Adding a torrent
-     * @param torrent a string of file path or contents of the file as base64 string
-     */
-    async addTorrent(torrent, options = {}) {
-        const args = {
-            'download-dir': '/downloads',
-            paused: false,
-            ...options,
-        };
-        if (typeof torrent === 'string') {
-            args.metainfo = fs_1.existsSync(torrent)
-                ? Buffer.from(fs_1.readFileSync(torrent)).toString('base64')
-                : Buffer.from(torrent, 'base64').toString('base64');
-        }
-        else {
-            args.metainfo = torrent.toString('base64');
-        }
-        const res = await this.request('torrent-add', args);
-        return res.body;
-    }
-    async normalizedAddTorrent(torrent, options = {}) {
-        const torrentOptions = {};
-        if (options.startPaused) {
-            torrentOptions.paused = true;
-        }
-        if (!Buffer.isBuffer(torrent)) {
-            torrent = Buffer.from(torrent);
-        }
-        const res = await this.addTorrent(torrent, torrentOptions);
-        const torrentId = res.arguments['torrent-added'].id;
-        if (options.label) {
-            const res = await this.setTorrent(torrentId, { labels: [options.label] });
-            console.log(res);
-        }
-        return this.getTorrent(torrentId);
-    }
-    async getTorrent(id) {
-        const result = await this.listTorrents(id);
-        if (!result.arguments.torrents || result.arguments.torrents.length === 0) {
-            throw new Error('Torrent not found');
-        }
-        return this._normalizeTorrentData(result.arguments.torrents[0]);
-    }
-    async getAllData() {
-        const listTorrents = await this.listTorrents();
-        const torrents = listTorrents.arguments.torrents.map((n) => this._normalizeTorrentData(n));
-        const labels = [];
-        for (const torrent of torrents) {
-            if (!torrent.label) {
-                continue;
-            }
-            const existing = labels.find((n) => n.id === torrent.label);
-            if (existing) {
-                existing.count += 1;
-                continue;
-            }
-            labels.push({ id: torrent.label, name: torrent.label, count: 1 });
-        }
-        const results = {
-            torrents,
-            labels,
-        };
-        return results;
-    }
-    async listTorrents(ids, additionalFields = []) {
-        const fields = [
-            'id',
-            'addedDate',
-            'creator',
-            'doneDate',
-            'comment',
-            'name',
-            'totalSize',
-            'error',
-            'errorString',
-            'eta',
-            'etaIdle',
-            'isFinished',
-            'isStalled',
-            'isPrivate',
-            'files',
-            'fileStats',
-            'hashString',
-            'leftUntilDone',
-            'metadataPercentComplete',
-            'peers',
-            'peersFrom',
-            'peersConnected',
-            'peersGettingFromUs',
-            'peersSendingToUs',
-            'percentDone',
-            'queuePosition',
-            'rateDownload',
-            'rateUpload',
-            'secondsDownloading',
-            'secondsSeeding',
-            'recheckProgress',
-            'seedRatioMode',
-            'seedRatioLimit',
-            'seedIdleLimit',
-            'sizeWhenDone',
-            'status',
-            'trackers',
-            'downloadDir',
-            'downloadLimit',
-            'downloadLimited',
-            'uploadedEver',
-            'downloadedEver',
-            'corruptEver',
-            'uploadRatio',
-            'webseedsSendingToUs',
-            'haveUnchecked',
-            'haveValid',
-            'honorsSessionLimits',
-            'manualAnnounceTime',
-            'activityDate',
-            'desiredAvailable',
-            'labels',
-            'magnetLink',
-            'maxConnectedPeers',
-            'peer-limit',
-            'priorities',
-            'wanted',
-            'webseeds',
-            ...additionalFields,
-        ];
-        const args = { fields };
-        if (ids) {
-            args.ids = ids;
-        }
-        const res = await this.request('torrent-get', args);
-        return res.body;
-    }
-    // async getTorrent(id: TorrentIds): Promise<NormalizedTorrent> {
-    //   const torrent: any = {};
-    //   return torrent;
-    // }
-    async request(method, args = {}) {
-        var _a, _b, _c;
-        if (!this.sessionId && method !== 'session-get') {
-            await this.getSession();
-        }
-        const headers = {
-            'X-Transmission-Session-Id': this.sessionId,
-        };
-        if (this.config.username || this.config.password) {
-            const str = `${(_a = this.config.username) !== null && _a !== void 0 ? _a : ''}:${(_b = this.config.password) !== null && _b !== void 0 ? _b : ''}`;
-            headers.Authorization = 'Basic ' + Buffer.from(str).toString('base64');
-        }
-        const url = url_join_1.urlJoin(this.config.baseUrl, this.config.path);
-        try {
-            const res = await got_1.default.post(url, {
-                json: {
-                    method,
-                    arguments: args,
-                },
-                headers,
-                retry: 0,
-                // allow proxy agent
-                agent: this.config.agent,
-                timeout: this.config.timeout,
-                responseType: 'json',
-            });
-            return res;
-        }
-        catch (error) {
-            if (((_c = error === null || error === void 0 ? void 0 : error.response) === null || _c === void 0 ? void 0 : _c.statusCode) === 409) {
-                this.sessionId = error.response.headers['x-transmission-session-id'];
-                // eslint-disable-next-line no-return-await
-                return await this.request(method, args);
-            }
-            throw error;
-        }
-    }
-    _normalizeTorrentData(torrent) {
-        var _a;
-        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 = shared_torrent_1.TorrentState.unknown;
-        if (torrent.status === 6) {
-            state = shared_torrent_1.TorrentState.seeding;
-        }
-        else if (torrent.status === 4) {
-            state = shared_torrent_1.TorrentState.downloading;
-        }
-        else if (torrent.status === 0) {
-            state = shared_torrent_1.TorrentState.paused;
-        }
-        else if (torrent.status === 2) {
-            state = shared_torrent_1.TorrentState.checking;
-        }
-        else if (torrent.status === 3 || torrent.status === 5) {
-            state = shared_torrent_1.TorrentState.queued;
-        }
-        const result = {
-            id: torrent.id,
-            name: torrent.name,
-            state,
-            isCompleted: torrent.leftUntilDone < 1,
-            stateMessage: '',
-            progress: torrent.percentDone,
-            ratio: torrent.uploadRatio,
-            dateAdded,
-            dateCompleted,
-            label: ((_a = torrent.labels) === null || _a === void 0 ? void 0 : _a.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,
-        };
-        return result;
-    }
-}
-exports.Transmission = Transmission;
+__exportStar(require("./transmission"), exports);
+__exportStar(require("./types"), exports);

package/dist/transmission.d.ts

@@ -0,0 +1,59 @@
+/// <reference types="node" />
+import { Response } from 'got';
+import { AddTorrentOptions as NormalizedAddTorrentOptions, AllClientData, NormalizedTorrent, TorrentClient, TorrentSettings } from '@ctrl/shared-torrent';
+import { AddTorrentOptions, AddTorrentResponse, DefaultResponse, FreeSpaceResponse, GetTorrentRepsonse, NormalizedTorrentIds, RenamePathOptions, SessionArguments, SessionResponse, SetTorrentOptions } from './types';
+export declare class Transmission implements TorrentClient {
+    config: TorrentSettings;
+    sessionId?: string;
+    constructor(options?: Partial<TorrentSettings>);
+    getSession(): Promise<SessionResponse>;
+    setSession(args: Partial<SessionArguments>): Promise<SessionResponse>;
+    queueTop(id: NormalizedTorrentIds): Promise<DefaultResponse>;
+    queueBottom(id: NormalizedTorrentIds): Promise<DefaultResponse>;
+    queueUp(id: NormalizedTorrentIds): Promise<DefaultResponse>;
+    queueDown(id: NormalizedTorrentIds): Promise<DefaultResponse>;
+    freeSpace(path?: string): Promise<FreeSpaceResponse>;
+    pauseTorrent(id: NormalizedTorrentIds): Promise<DefaultResponse>;
+    resumeTorrent(id: NormalizedTorrentIds): Promise<DefaultResponse>;
+    verifyTorrent(id: NormalizedTorrentIds): Promise<DefaultResponse>;
+    /**
+     * ask tracker for more peers
+     */
+    reannounceTorrent(id: NormalizedTorrentIds): Promise<DefaultResponse>;
+    moveTorrent(id: NormalizedTorrentIds, location: string): Promise<DefaultResponse>;
+    /**
+     * Torrent Mutators
+     */
+    setTorrent(id: NormalizedTorrentIds, options?: Partial<SetTorrentOptions>): Promise<DefaultResponse>;
+    /**
+     * Renaming a Torrent's Path
+     */
+    renamePath(id: NormalizedTorrentIds, options?: Partial<RenamePathOptions>): Promise<DefaultResponse>;
+    /**
+     * Removing a Torrent
+     */
+    removeTorrent(id: NormalizedTorrentIds, removeData?: boolean): Promise<AddTorrentResponse>;
+    /**
+     * An alias for {@link Transmission.addMagnet}
+     */
+    addUrl(...args: Parameters<Transmission['addMagnet']>): Promise<AddTorrentResponse>;
+    /**
+     * note: This is the same "torrent-add" action with different options,
+     * less confusing to add it as its own method
+     * @param url magnet link
+     * @param options
+     */
+    addMagnet(url: string, options?: Partial<AddTorrentOptions>): Promise<AddTorrentResponse>;
+    /**
+     * Adding a torrent
+     * @param torrent a string of file path or contents of the file as base64 string
+     */
+    addTorrent(torrent: string | Buffer, options?: Partial<AddTorrentOptions>): Promise<AddTorrentResponse>;
+    normalizedAddTorrent(torrent: string | Buffer, 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<Response<T>>;
+    private _handleNormalizedIds;
+    private _normalizeTorrentData;
+}

package/dist/transmission.js

@@ -0,0 +1,364 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Transmission = void 0;
+const fs_1 = require("fs");
+const got_1 = __importDefault(require("got"));
+const shared_torrent_1 = require("@ctrl/shared-torrent");
+const url_join_1 = require("@ctrl/url-join");
+const defaults = {
+    baseUrl: 'http://localhost:9091/',
+    path: '/transmission/rpc',
+    username: '',
+    password: '',
+    timeout: 5000,
+};
+class Transmission {
+    constructor(options = {}) {
+        this.config = { ...defaults, ...options };
+    }
+    async getSession() {
+        const res = await this.request('session-get');
+        return res.body;
+    }
+    async setSession(args) {
+        const res = await this.request('session-set', args);
+        return res.body;
+    }
+    async queueTop(id) {
+        const ids = this._handleNormalizedIds(id);
+        const res = await this.request('queue-move-top', { ids });
+        return res.body;
+    }
+    async queueBottom(id) {
+        const ids = this._handleNormalizedIds(id);
+        const res = await this.request('queue-move-bottom', { ids });
+        return res.body;
+    }
+    async queueUp(id) {
+        const ids = this._handleNormalizedIds(id);
+        const res = await this.request('queue-move-up', { ids });
+        return res.body;
+    }
+    async queueDown(id) {
+        const ids = this._handleNormalizedIds(id);
+        const res = await this.request('queue-move-down', { ids });
+        return res.body;
+    }
+    async freeSpace(path = '/downloads/complete') {
+        const res = await this.request('free-space', { path });
+        return res.body;
+    }
+    async pauseTorrent(id) {
+        const ids = this._handleNormalizedIds(id);
+        const res = await this.request('torrent-stop', { ids });
+        return res.body;
+    }
+    async resumeTorrent(id) {
+        const ids = this._handleNormalizedIds(id);
+        const res = await this.request('torrent-start', { ids });
+        return res.body;
+    }
+    async verifyTorrent(id) {
+        const ids = this._handleNormalizedIds(id);
+        const res = await this.request('torrent-verify', { ids });
+        return res.body;
+    }
+    /**
+     * ask tracker for more peers
+     */
+    async reannounceTorrent(id) {
+        const ids = this._handleNormalizedIds(id);
+        const res = await this.request('torrent-reannounce', { ids });
+        return res.body;
+    }
+    async moveTorrent(id, location) {
+        const ids = this._handleNormalizedIds(id);
+        const res = await this.request('torrent-set-location', {
+            ids,
+            move: true,
+            location,
+        });
+        return res.body;
+    }
+    /**
+     * Torrent Mutators
+     */
+    async setTorrent(id, options = {}) {
+        const ids = this._handleNormalizedIds(id);
+        options.ids = ids;
+        const res = await this.request('torrent-set', options);
+        return res.body;
+    }
+    /**
+     * Renaming a Torrent's Path
+     */
+    async renamePath(id, options = {}) {
+        const ids = this._handleNormalizedIds(id);
+        options.ids = ids;
+        const res = await this.request('torrent-rename-path', options);
+        return res.body;
+    }
+    /**
+     * Removing a Torrent
+     */
+    async removeTorrent(id, removeData = true) {
+        const ids = this._handleNormalizedIds(id);
+        const res = await this.request('torrent-remove', {
+            ids,
+            'delete-local-data': removeData,
+        });
+        return res.body;
+    }
+    /**
+     * An alias for {@link Transmission.addMagnet}
+     */
+    async addUrl(...args) {
+        return this.addMagnet(...args);
+    }
+    /**
+     * note: This is the same "torrent-add" action with different options,
+     * less confusing to add it as its own method
+     * @param url magnet link
+     * @param options
+     */
+    async addMagnet(url, options = {}) {
+        const args = {
+            'download-dir': '/downloads',
+            paused: false,
+            ...options,
+        };
+        args.filename = url;
+        const res = await this.request('torrent-add', args);
+        return res.body;
+    }
+    /**
+     * Adding a torrent
+     * @param torrent a string of file path or contents of the file as base64 string
+     */
+    async addTorrent(torrent, options = {}) {
+        const args = {
+            'download-dir': '/downloads',
+            paused: false,
+            ...options,
+        };
+        if (typeof torrent === 'string') {
+            args.metainfo = (0, fs_1.existsSync)(torrent)
+                ? Buffer.from((0, fs_1.readFileSync)(torrent)).toString('base64')
+                : Buffer.from(torrent, 'base64').toString('base64');
+        }
+        else {
+            args.metainfo = torrent.toString('base64');
+        }
+        const res = await this.request('torrent-add', args);
+        return res.body;
+    }
+    async normalizedAddTorrent(torrent, options = {}) {
+        const torrentOptions = {};
+        if (options.startPaused) {
+            torrentOptions.paused = true;
+        }
+        if (!Buffer.isBuffer(torrent)) {
+            torrent = Buffer.from(torrent);
+        }
+        const res = await this.addTorrent(torrent, torrentOptions);
+        const torrentHash = [res.arguments['torrent-added'].hashString];
+        if (options.label) {
+            await this.setTorrent(torrentHash, { labels: [options.label] });
+        }
+        return this.getTorrent(torrentHash);
+    }
+    async getTorrent(id) {
+        const result = await this.listTorrents(id);
+        if (!result.arguments.torrents || result.arguments.torrents.length === 0) {
+            throw new Error('Torrent not found');
+        }
+        return this._normalizeTorrentData(result.arguments.torrents[0]);
+    }
+    async getAllData() {
+        const listTorrents = await this.listTorrents();
+        const torrents = listTorrents.arguments.torrents.map((n) => this._normalizeTorrentData(n));
+        const labels = [];
+        for (const torrent of torrents) {
+            if (!torrent.label) {
+                continue;
+            }
+            const existing = labels.find((n) => n.id === torrent.label);
+            if (existing) {
+                existing.count += 1;
+                continue;
+            }
+            labels.push({ id: torrent.label, name: torrent.label, count: 1 });
+        }
+        const results = {
+            torrents,
+            labels,
+        };
+        return results;
+    }
+    async listTorrents(id, additionalFields = []) {
+        const fields = [
+            'id',
+            'addedDate',
+            'creator',
+            'doneDate',
+            'comment',
+            'name',
+            'totalSize',
+            'error',
+            'errorString',
+            'eta',
+            'etaIdle',
+            'isFinished',
+            'isStalled',
+            'isPrivate',
+            'files',
+            'fileStats',
+            'hashString',
+            'leftUntilDone',
+            'metadataPercentComplete',
+            'peers',
+            'peersFrom',
+            'peersConnected',
+            'peersGettingFromUs',
+            'peersSendingToUs',
+            'percentDone',
+            'queuePosition',
+            'rateDownload',
+            'rateUpload',
+            'secondsDownloading',
+            'secondsSeeding',
+            'recheckProgress',
+            'seedRatioMode',
+            'seedRatioLimit',
+            'seedIdleLimit',
+            'sizeWhenDone',
+            'status',
+            'trackers',
+            'downloadDir',
+            'downloadLimit',
+            'downloadLimited',
+            'uploadedEver',
+            'downloadedEver',
+            'corruptEver',
+            'uploadRatio',
+            'webseedsSendingToUs',
+            'haveUnchecked',
+            'haveValid',
+            'honorsSessionLimits',
+            'manualAnnounceTime',
+            'activityDate',
+            'desiredAvailable',
+            'labels',
+            'magnetLink',
+            'maxConnectedPeers',
+            'peer-limit',
+            'priorities',
+            'wanted',
+            'webseeds',
+            ...additionalFields,
+        ];
+        const args = { fields };
+        if (id) {
+            const ids = this._handleNormalizedIds(id);
+            args.ids = ids;
+        }
+        const res = await this.request('torrent-get', args);
+        return res.body;
+    }
+    async request(method, args = {}) {
+        var _a, _b, _c;
+        if (!this.sessionId && method !== 'session-get') {
+            await this.getSession();
+        }
+        const headers = {
+            'X-Transmission-Session-Id': this.sessionId,
+        };
+        if (this.config.username || this.config.password) {
+            const str = `${(_a = this.config.username) !== null && _a !== void 0 ? _a : ''}:${(_b = this.config.password) !== null && _b !== void 0 ? _b : ''}`;
+            headers.Authorization = 'Basic ' + Buffer.from(str).toString('base64');
+        }
+        const url = (0, url_join_1.urlJoin)(this.config.baseUrl, this.config.path);
+        try {
+            const res = await got_1.default.post(url, {
+                json: {
+                    method,
+                    arguments: args,
+                },
+                headers,
+                retry: 0,
+                // allow proxy agent
+                agent: this.config.agent,
+                timeout: this.config.timeout,
+                responseType: 'json',
+            });
+            return res;
+        }
+        catch (error) {
+            if (((_c = error === null || error === void 0 ? void 0 : error.response) === null || _c === void 0 ? void 0 : _c.statusCode) === 409) {
+                this.sessionId = error.response.headers['x-transmission-session-id'];
+                // eslint-disable-next-line no-return-await
+                return await this.request(method, args);
+            }
+            // eslint-disable-next-line @typescript-eslint/no-throw-literal
+            throw error;
+        }
+    }
+    _handleNormalizedIds(ids) {
+        if (typeof ids === 'string' && ids !== 'recently-active') {
+            return [ids];
+        }
+        return ids;
+    }
+    _normalizeTorrentData(torrent) {
+        var _a;
+        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 = shared_torrent_1.TorrentState.unknown;
+        if (torrent.status === 6) {
+            state = shared_torrent_1.TorrentState.seeding;
+        }
+        else if (torrent.status === 4) {
+            state = shared_torrent_1.TorrentState.downloading;
+        }
+        else if (torrent.status === 0) {
+            state = shared_torrent_1.TorrentState.paused;
+        }
+        else if (torrent.status === 2) {
+            state = shared_torrent_1.TorrentState.checking;
+        }
+        else if (torrent.status === 3 || torrent.status === 5) {
+            state = shared_torrent_1.TorrentState.queued;
+        }
+        return {
+            id: torrent.hashString,
+            name: torrent.name,
+            state,
+            isCompleted: torrent.leftUntilDone < 1,
+            stateMessage: '',
+            progress: torrent.percentDone,
+            ratio: torrent.uploadRatio,
+            dateAdded,
+            dateCompleted,
+            label: ((_a = torrent.labels) === null || _a === void 0 ? void 0 : _a.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,
+        };
+    }
+}
+exports.Transmission = Transmission;

package/dist/types.d.ts

@@ -39,12 +39,17 @@ export interface FreeSpaceResponse extends DefaultResponse {
 /**
  * "ids", which specifies which torrents to use.
  * All torrents are used if the "ids" argument is omitted.
+ *
  * "ids" should be one of the following:
- * (1) an integer referring to a torrent id
- * (2) a list of torrent id numbers, sha1 hash strings, or both
- * (3) a string, "recently-active", for recently-active torrents
+ * 1. an integer referring to a torrent id
+ * 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>;
+/**
+ * Allows the user to pass a single hash, this will be converted to an array
+ */
+export declare type NormalizedTorrentIds = TorrentIds | string;
 export interface GetTorrentRepsonse extends DefaultResponse {
     arguments: {
         removed: Torrent[];
@@ -132,7 +137,7 @@ export interface Torrent {
     totalSize: number;
     status: number;
     trackers: Tracker[];
-    files: FileStats[];
+    files: Files[];
     fileStats: FileStats[];
     hashString: string;
     creator: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/transmission",
-  "version": "2.3.0",
+  "version": "3.0.0",
   "description": "TypeScript api wrapper for transmission using got",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",
@@ -16,36 +16,35 @@
   ],
   "sideEffects": false,
   "scripts": {
-    "lint": "eslint --ext .js,.ts, .",
-    "lint:fix": "eslint --fix --ext .js,.ts, .",
+    "lint": "eslint --ext .ts .",
+    "lint:fix": "eslint --fix --ext .ts .",
     "prepare": "npm run build",
     "build": "tsc -p tsconfig.build.json",
     "build:docs": "typedoc",
     "test": "jest --runInBand",
     "test:watch": "jest --watch --runInBand",
-    "test:ci": "jest --coverage --no-cache --runInBand"
+    "test:ci": "jest --ci --runInBand --reporters=default --reporters=jest-junit --coverage"
   },
   "dependencies": {
     "@ctrl/shared-torrent": "^3.0.5",
-    "got": "^11.8.2",
+    "got": "^11.8.3",
     "@ctrl/url-join": "^1.0.4"
   },
   "devDependencies": {
-    "@babel/plugin-transform-modules-commonjs": "7.14.0",
-    "@babel/preset-typescript": "7.13.0",
-    "@ctrl/eslint-config": "2.0.8",
-    "@jest/globals": "27.0.3",
-    "@types/jest": "26.0.23",
-    "@types/node": "15.12.2",
-    "@types/url-join": "4.0.0",
-    "jest": "27.0.4",
-    "jest-junit": "12.1.0",
+    "@babel/plugin-transform-modules-commonjs": "7.16.8",
+    "@babel/preset-typescript": "7.16.7",
+    "@ctrl/eslint-config": "3.3.1",
+    "@jest/globals": "27.4.6",
+    "@types/node": "17.0.14",
+    "jest": "27.4.7",
+    "jest-junit": "13.0.0",
     "p-wait-for": "3.2.0",
-    "typedoc": "0.21.0-beta.2",
-    "typescript": "4.3.2"
+    "typedoc": "0.22.11",
+    "typescript": "4.5.5"
   },
   "jest": {
-    "testEnvironment": "node"
+    "testEnvironment": "node",
+    "coverageProvider": "v8"
   },
   "babel": {
     "presets": [