@ctrl/transmission 2.5.0 → 3.0.0

package/dist/transmission.d.ts

@@ -1,45 +1,38 @@
 /// <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';
-/**
- * TODO: remove when hash is available on normalized torrent
- * @deprecated
- */
-export declare type TransmissionNormalizedTorrent = NormalizedTorrent & {
-    hash: string;
-};
+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(ids: TorrentIds): Promise<DefaultResponse>;
-    queueBottom(ids: TorrentIds): Promise<DefaultResponse>;
-    queueUp(ids: TorrentIds): Promise<DefaultResponse>;
-    queueDown(ids: TorrentIds): Promise<DefaultResponse>;
+    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(ids: TorrentIds): Promise<DefaultResponse>;
-    resumeTorrent(ids: TorrentIds): Promise<DefaultResponse>;
-    verifyTorrent(ids: TorrentIds): Promise<DefaultResponse>;
+    pauseTorrent(id: NormalizedTorrentIds): Promise<DefaultResponse>;
+    resumeTorrent(id: NormalizedTorrentIds): Promise<DefaultResponse>;
+    verifyTorrent(id: NormalizedTorrentIds): Promise<DefaultResponse>;
     /**
      * ask tracker for more peers
      */
-    reannounceTorrent(ids: TorrentIds): Promise<DefaultResponse>;
-    moveTorrent(ids: TorrentIds, location: string): Promise<DefaultResponse>;
+    reannounceTorrent(id: NormalizedTorrentIds): Promise<DefaultResponse>;
+    moveTorrent(id: NormalizedTorrentIds, location: string): Promise<DefaultResponse>;
     /**
      * Torrent Mutators
      */
-    setTorrent(ids: TorrentIds, options?: Partial<SetTorrentOptions>): Promise<DefaultResponse>;
+    setTorrent(id: NormalizedTorrentIds, options?: Partial<SetTorrentOptions>): Promise<DefaultResponse>;
     /**
      * Renaming a Torrent's Path
      */
-    renamePath(ids: TorrentIds, options?: Partial<RenamePathOptions>): Promise<DefaultResponse>;
+    renamePath(id: NormalizedTorrentIds, options?: Partial<RenamePathOptions>): Promise<DefaultResponse>;
     /**
      * Removing a Torrent
      */
-    removeTorrent(ids: TorrentIds, removeData?: boolean): Promise<AddTorrentResponse>;
+    removeTorrent(id: NormalizedTorrentIds, removeData?: boolean): Promise<AddTorrentResponse>;
     /**
      * An alias for {@link Transmission.addMagnet}
      */
@@ -56,10 +49,11 @@ export declare class Transmission implements TorrentClient {
      * @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<TransmissionNormalizedTorrent>;
-    getTorrent(id: TorrentIds): Promise<TransmissionNormalizedTorrent>;
+    normalizedAddTorrent(torrent: string | Buffer, options?: Partial<NormalizedAddTorrentOptions>): Promise<NormalizedTorrent>;
+    getTorrent(id: NormalizedTorrentIds): Promise<NormalizedTorrent>;
     getAllData(): Promise<AllClientData>;
-    listTorrents(ids?: TorrentIds, additionalFields?: string[]): Promise<GetTorrentRepsonse>;
+    listTorrents(id?: NormalizedTorrentIds, additionalFields?: string[]): Promise<GetTorrentRepsonse>;
     request<T>(method: string, args?: any): Promise<Response<T>>;
+    private _handleNormalizedIds;
     private _normalizeTorrentData;
 }

package/dist/transmission.js

@@ -27,19 +27,23 @@ class Transmission {
         const res = await this.request('session-set', args);
         return res.body;
     }
-    async queueTop(ids) {
+    async queueTop(id) {
+        const ids = this._handleNormalizedIds(id);
         const res = await this.request('queue-move-top', { ids });
         return res.body;
     }
-    async queueBottom(ids) {
+    async queueBottom(id) {
+        const ids = this._handleNormalizedIds(id);
         const res = await this.request('queue-move-bottom', { ids });
         return res.body;
     }
-    async queueUp(ids) {
+    async queueUp(id) {
+        const ids = this._handleNormalizedIds(id);
         const res = await this.request('queue-move-up', { ids });
         return res.body;
     }
-    async queueDown(ids) {
+    async queueDown(id) {
+        const ids = this._handleNormalizedIds(id);
         const res = await this.request('queue-move-down', { ids });
         return res.body;
     }
@@ -47,26 +51,31 @@ class Transmission {
         const res = await this.request('free-space', { path });
         return res.body;
     }
-    async pauseTorrent(ids) {
+    async pauseTorrent(id) {
+        const ids = this._handleNormalizedIds(id);
         const res = await this.request('torrent-stop', { ids });
         return res.body;
     }
-    async resumeTorrent(ids) {
+    async resumeTorrent(id) {
+        const ids = this._handleNormalizedIds(id);
         const res = await this.request('torrent-start', { ids });
         return res.body;
     }
-    async verifyTorrent(ids) {
+    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(ids) {
+    async reannounceTorrent(id) {
+        const ids = this._handleNormalizedIds(id);
         const res = await this.request('torrent-reannounce', { ids });
         return res.body;
     }
-    async moveTorrent(ids, location) {
+    async moveTorrent(id, location) {
+        const ids = this._handleNormalizedIds(id);
         const res = await this.request('torrent-set-location', {
             ids,
             move: true,
@@ -77,7 +86,8 @@ class Transmission {
     /**
      * Torrent Mutators
      */
-    async setTorrent(ids, options = {}) {
+    async setTorrent(id, options = {}) {
+        const ids = this._handleNormalizedIds(id);
         options.ids = ids;
         const res = await this.request('torrent-set', options);
         return res.body;
@@ -85,7 +95,8 @@ class Transmission {
     /**
      * Renaming a Torrent's Path
      */
-    async renamePath(ids, options = {}) {
+    async renamePath(id, options = {}) {
+        const ids = this._handleNormalizedIds(id);
         options.ids = ids;
         const res = await this.request('torrent-rename-path', options);
         return res.body;
@@ -93,7 +104,8 @@ class Transmission {
     /**
      * Removing a Torrent
      */
-    async removeTorrent(ids, removeData = true) {
+    async removeTorrent(id, removeData = true) {
+        const ids = this._handleNormalizedIds(id);
         const res = await this.request('torrent-remove', {
             ids,
             'delete-local-data': removeData,
@@ -152,11 +164,11 @@ class Transmission {
             torrent = Buffer.from(torrent);
         }
         const res = await this.addTorrent(torrent, torrentOptions);
-        const torrentId = res.arguments['torrent-added'].id;
+        const torrentHash = [res.arguments['torrent-added'].hashString];
         if (options.label) {
-            await this.setTorrent(torrentId, { labels: [options.label] });
+            await this.setTorrent(torrentHash, { labels: [options.label] });
         }
-        return this.getTorrent(torrentId);
+        return this.getTorrent(torrentHash);
     }
     async getTorrent(id) {
         const result = await this.listTorrents(id);
@@ -186,7 +198,7 @@ class Transmission {
         };
         return results;
     }
-    async listTorrents(ids, additionalFields = []) {
+    async listTorrents(id, additionalFields = []) {
         const fields = [
             'id',
             'addedDate',
@@ -249,7 +261,8 @@ class Transmission {
             ...additionalFields,
         ];
         const args = { fields };
-        if (ids) {
+        if (id) {
+            const ids = this._handleNormalizedIds(id);
             args.ids = ids;
         }
         const res = await this.request('torrent-get', args);
@@ -293,6 +306,12 @@ class Transmission {
             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();
@@ -316,8 +335,7 @@ class Transmission {
             state = shared_torrent_1.TorrentState.queued;
         }
         return {
-            id: torrent.id,
-            hash: torrent.hashString,
+            id: torrent.hashString,
             name: torrent.name,
             state,
             isCompleted: torrent.leftUntilDone < 1,

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[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/transmission",
-  "version": "2.5.0",
+  "version": "3.0.0",
   "description": "TypeScript api wrapper for transmission using got",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",