@ctrl/transmission 4.0.0 → 4.2.0

package/dist/src/transmission.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" resolution-mode="require"/>
-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.js';
+import type { Response } from 'got';
+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 {
     config: TorrentSettings;
     sessionId?: string;

package/dist/src/transmission.js

@@ -1,6 +1,7 @@
 import { existsSync, readFileSync } from 'fs';
 import got from 'got';
-import { TorrentState, } from '@ctrl/shared-torrent';
+import { magnetDecode } from '@ctrl/magnet-link';
+import { TorrentState } from '@ctrl/shared-torrent';
 import { urlJoin } from '@ctrl/url-join';
 const defaults = {
     baseUrl: 'http://localhost:9091/',
@@ -166,11 +167,21 @@ export class Transmission {
         if (options.startPaused) {
             torrentOptions.paused = true;
         }
-        if (!Buffer.isBuffer(torrent)) {
-            torrent = Buffer.from(torrent);
+        let torrentHash;
+        if (typeof torrent === 'string' && torrent.startsWith('magnet:')) {
+            torrentHash = magnetDecode(torrent).infoHash;
+            if (!torrentHash) {
+                throw new Error('Magnet did not contain hash');
+            }
+            await this.addMagnet(torrent, torrentOptions);
+        }
+        else {
+            if (!Buffer.isBuffer(torrent)) {
+                torrent = Buffer.from(torrent);
+            }
+            const res = await this.addTorrent(torrent, torrentOptions);
+            torrentHash = res.arguments['torrent-added'].hashString;
         }
-        const res = await this.addTorrent(torrent, torrentOptions);
-        const torrentHash = [res.arguments['torrent-added'].hashString];
         if (options.label) {
             await this.setTorrent(torrentHash, { labels: [options.label] });
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/transmission",
-  "version": "4.0.0",
+  "version": "4.2.0",
   "description": "TypeScript api wrapper for transmission using got",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",
@@ -13,7 +13,7 @@
   "main": "./dist/src/index.js",
   "typings": "./dist/src/index.d.ts",
   "files": [
-    "dist"
+    "dist/src"
   ],
   "sideEffects": false,
   "scripts": {
@@ -27,19 +27,21 @@
     "test:ci": "vitest run --coverage"
   },
   "dependencies": {
-    "@ctrl/shared-torrent": "^4.1.0",
-    "@ctrl/url-join": "^2.0.0",
-    "got": "^12.1.0"
+    "@ctrl/magnet-link": "^3.1.1",
+    "@ctrl/shared-torrent": "^4.2.0",
+    "@ctrl/url-join": "^2.0.2",
+    "got": "^12.3.1"
   },
   "devDependencies": {
-    "@ctrl/eslint-config": "3.4.4",
+    "@ctrl/eslint-config": "3.4.10",
     "@sindresorhus/tsconfig": "3.0.1",
-    "@types/node": "17.0.38",
-    "c8": "7.11.3",
-    "p-wait-for": "4.1.0",
-    "typedoc": "0.22.17",
-    "typescript": "4.7.2",
-    "vitest": "0.13.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",

package/dist/test/transmission.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/test/transmission.spec.js

@@ -1,130 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import pWaitFor from 'p-wait-for';
-import { afterEach, describe, expect, it } from 'vitest';
-import { TorrentState } from '@ctrl/shared-torrent';
-import { Transmission } from '../src/index.js';
-const baseUrl = 'http://localhost:9091/';
-const torrentName = 'ubuntu-18.04.1-desktop-amd64.iso';
-const torrentFile = path.join(__dirname, '/ubuntu-18.04.1-desktop-amd64.iso.torrent');
-async function setupTorrent(transmission) {
-    const res = await transmission.addTorrent(torrentFile);
-    await pWaitFor(async () => {
-        const r = await transmission.listTorrents(undefined, ['id']);
-        return r.arguments.torrents.length === 1;
-    }, { timeout: 10000, interval: 200 });
-    return res.arguments['torrent-added'].hashString;
-}
-describe('Transmission', () => {
-    afterEach(async () => {
-        const transmission = new Transmission({ baseUrl });
-        const res = await transmission.listTorrents();
-        // clean up all torrents
-        for (const torrent of res.arguments.torrents) {
-            // eslint-disable-next-line no-await-in-loop
-            await transmission.removeTorrent(torrent.id, false);
-        }
-    });
-    it('should be instantiable', () => {
-        const transmission = new Transmission({ baseUrl });
-        expect(transmission).toBeTruthy();
-    });
-    it('should add torrent from file path string', async () => {
-        const transmission = new Transmission({ baseUrl });
-        const res = await transmission.addTorrent(torrentFile);
-        expect(res.result).toBe('success');
-    });
-    it('should add magnet link', async () => {
-        const magnet = 'magnet:?xt=urn:btih:B0B81206633C42874173D22E564D293DAEFC45E2&dn=Ubuntu+11+10+Alternate+Amd64+Iso&tr=udp%3A%2F%2Ftracker.coppersurfer.tk%3A6969%2Fannounce&tr=udp%3A%2F%2F9.rarbg.to%3A2710%2Fannounce&tr=udp%3A%2F%2Ftracker.opentrackr.org%3A1337%2Fannounce&tr=udp%3A%2F%2Ftracker.leechers-paradise.org%3A6969%2Fannounce&tr=udp%3A%2F%2Ftracker.open-internet.nl%3A6969%2Fannounce&tr=udp%3A%2F%2Fopen.demonii.si%3A1337%2Fannounce&tr=udp%3A%2F%2Ftracker.pirateparty.gr%3A6969%2Fannounce&tr=udp%3A%2F%2Fdenis.stalker.upeer.me%3A6969%2Fannounce&tr=udp%3A%2F%2Fp4p.arenabg.com%3A1337%2Fannounce&tr=udp%3A%2F%2Fexodus.desync.com%3A6969%2Fannounce';
-        const client = new Transmission({ baseUrl });
-        const res = await client.addMagnet(magnet);
-        expect(res.result).toBe('success');
-    });
-    it('should add torrent from file buffer', async () => {
-        const transmission = new Transmission({ baseUrl });
-        const res = await transmission.addTorrent(fs.readFileSync(torrentFile));
-        expect(res.result).toBe('success');
-    });
-    it('should add torrent from file contents base64', async () => {
-        const transmission = new Transmission({ baseUrl });
-        const contents = Buffer.from(fs.readFileSync(torrentFile)).toString('base64');
-        const res = await transmission.addTorrent(contents);
-        expect(res.result).toBe('success');
-    });
-    it('should get torrents', async () => {
-        const transmission = new Transmission({ baseUrl });
-        await setupTorrent(transmission);
-        const res = await transmission.listTorrents(undefined, ['id']);
-        expect(res.arguments.torrents).toHaveLength(1);
-    });
-    it('should get normalized all torrent data', async () => {
-        const transmission = new Transmission({ baseUrl });
-        await setupTorrent(transmission);
-        const res = await transmission.getAllData();
-        expect(res.torrents).toHaveLength(1);
-        expect(res.torrents[0].name).toBe(torrentName);
-    });
-    it('should get normalized torrent data', async () => {
-        const transmission = new Transmission({ baseUrl });
-        const id = await setupTorrent(transmission);
-        const res = await transmission.getTorrent(id);
-        expect(res.name).toBe(torrentName);
-    });
-    it('should remove torrent', async () => {
-        const transmission = new Transmission({ baseUrl });
-        const key = await setupTorrent(transmission);
-        await transmission.removeTorrent(key, false);
-    });
-    it('should verify torrent', async () => {
-        const transmission = new Transmission({ baseUrl });
-        const key = await setupTorrent(transmission);
-        await transmission.verifyTorrent(key);
-    });
-    it('should move in queue', async () => {
-        const transmission = new Transmission({ baseUrl });
-        const key = await setupTorrent(transmission);
-        await transmission.queueUp(key);
-        await transmission.queueDown(key);
-        await transmission.queueTop(key);
-        await transmission.queueBottom(key);
-    });
-    it('should report free space', async () => {
-        const transmission = new Transmission({ baseUrl });
-        const p = '/downloads';
-        const res = await transmission.freeSpace(p);
-        expect(res.result).toBe('success');
-        expect(res.arguments.path).toBe(p);
-        expect(typeof res.arguments['size-bytes']).toBe('number');
-    });
-    it('should add from url', async () => {
-        const transmission = new Transmission({ baseUrl });
-        const res = await transmission.addUrl('https://releases.ubuntu.com/20.10/ubuntu-20.10-desktop-amd64.iso.torrent');
-        expect(res.result).toBe('success');
-    });
-    it('should add torrent with normalized response', async () => {
-        const client = new Transmission({ baseUrl });
-        const torrent = await client.normalizedAddTorrent(fs.readFileSync(torrentFile), {
-            label: 'test',
-        });
-        expect(torrent.connectedPeers).toBe(0);
-        expect(torrent.connectedSeeds).toBe(0);
-        expect(torrent.downloadSpeed).toBe(0);
-        expect(torrent.eta).toBe(-1);
-        expect(torrent.isCompleted).toBe(false);
-        expect(torrent.label).toBe('test');
-        expect(torrent.name).toBe(torrentName);
-        expect(torrent.progress).toBeGreaterThanOrEqual(0);
-        expect(torrent.queuePosition).toBe(0);
-        // expect(torrent.ratio).toBe(0);
-        expect(torrent.savePath).toBe('/downloads');
-        expect(torrent.state).toBe(TorrentState.checking);
-        expect(torrent.stateMessage).toBe('');
-        expect(torrent.totalDownloaded).toBe(0);
-        expect(torrent.totalPeers).toBe(0);
-        expect(torrent.totalSeeds).toBe(0);
-        expect(torrent.totalSelected).toBe(1953349632);
-        // expect(torrent.totalSize).toBe(undefined);
-        expect(torrent.totalUploaded).toBe(0);
-        expect(torrent.uploadSpeed).toBe(0);
-    });
-});

package/dist/vitest.config.d.ts

@@ -1,2 +0,0 @@
-declare const _default: any;
-export default _default;

package/dist/vitest.config.js

@@ -1,7 +0,0 @@
-// @ts-expect-error
-import { defineConfig } from 'vitest/config';
-export default defineConfig({
-    test: {
-        threads: false,
-    },
-});