@ctrl/rqbit 1.0.0 → 2.0.1

package/README.md

@@ -8,6 +8,8 @@
 npm install @ctrl/rqbit
 ```
 
+Requires Node.js 24 or newer.
+
 ### Use
 
 ```ts
@@ -66,27 +68,23 @@ console.log(data);
 
 ##### pauseTorrent and resumeTorrent
 
-Pause or resume a torrent
+Pause or resume one or more torrents
 
 ```ts
-const paused = await client.pauseTorrent('torrent-hash');
-console.log(paused);
-const resumed = await client.resumeTorrent('torrent-hash');
-console.log(resumed);
+await client.pauseTorrent('torrent-hash');
+await client.resumeTorrent(['torrent-hash', 'other-torrent-hash']);
 ```
 
 ##### removeTorrent
 
-Remove a torrent. Does not remove data on disk by default.
+Remove one or more torrents, throws if a torrent doesn't exist. Does not remove data on disk by default.
 
 ```ts
 // does not remove data on disk
-const result = await client.removeTorrent('torrent-hash', false);
-console.log(result);
+await client.removeTorrent('torrent-hash', false);
 
 // remove data on disk
-const res = await client.removeTorrent('torrent-hash', true);
-console.log(res);
+await client.removeTorrent(['torrent-hash', 'other-torrent-hash'], true);
 ```
 
 ##### addTorrent
@@ -113,6 +111,22 @@ const result = await client.normalizedAddTorrent('magnet:?xt=urn:btih:...', {
 console.log(result);
 ```
 
+##### Errors
+
+Failed requests throw a `TorrentClientError` from [@ctrl/shared-torrent](https://github.com/scttcper/shared-torrent) with a `code` of `torrent_not_found`, `unauthorized`, `request_failed` or `client_error`, the http `status` when there is one and the original error as the `cause`. rqbit errors are a `RqbitApiError`, a `TorrentClientError` that also has rqbit's error `kind`.
+
+```ts
+import { TorrentClientError } from '@ctrl/rqbit';
+
+try {
+  await client.getTorrent('torrent-hash');
+} catch (error) {
+  if (error instanceof TorrentClientError && error.code === 'torrent_not_found') {
+    // not in the client
+  }
+}
+```
+
 ##### export and create from state
 
 rqbit uses basic auth on every request so there is no session to save, this exists to match the other clients.

package/dist/src/index.d.ts

@@ -1,3 +1,4 @@
 export * from './rqbit.js';
 export * from './normalizeTorrentData.js';
 export type * from './types.js';
+export { TorrentClientError, type TorrentClientErrorCode } from '@ctrl/shared-torrent';

package/dist/src/index.js

@@ -1,2 +1,3 @@
 export * from './rqbit.js';
 export * from './normalizeTorrentData.js';
+export { TorrentClientError } from '@ctrl/shared-torrent';

package/dist/src/normalizeTorrentData.js

@@ -48,7 +48,7 @@ export function normalizeTorrentData(torrent, files) {
         savePath: torrent.output_folder,
         uploadSpeed: live ? Math.round(live.upload_speed.mbps * MIB) : 0,
         downloadSpeed: live ? Math.round(live.download_speed.mbps * MIB) : 0,
-        eta: live?.time_remaining?.duration.secs ?? 0,
+        eta: stats.finished ? 0 : (live?.time_remaining?.duration.secs ?? -1),
         // rqbit has no queue
         queuePosition: 0,
         // rqbit does not report seeds separately from peers

package/dist/src/rqbit.d.ts

@@ -1,4 +1,4 @@
-import type { AddTorrentOptions as NormalizedAddTorrentOptions, AllClientData, NormalizedTorrent, TorrentClient, TorrentClientConfig, TorrentClientState } from '@ctrl/shared-torrent';
+import { type AddTorrentOptions as NormalizedAddTorrentOptions, type AllClientData, type NormalizedTorrent, type TorrentClient, type TorrentClientConfig, TorrentClientError, type TorrentClientState } from '@ctrl/shared-torrent';
 import { type FetchOptions, type MappedResponseType, type ResponseType } from 'ofetch';
 import type { Jsonify } from 'type-fest';
 import type { AddTorrentOptions, AddTorrentResponse, ApiRootResponse, CreateTorrentOptions, CreateTorrentResponse, DhtStats, EmptyResponse, ListTorrentsResponse, PeerStatsResponse, RateLimits, RqbitErrorResponse, SessionStats, TorrentDetails, TorrentIdOrHash, TorrentListItem, TorrentStats, TorrentWithStats } from './types.js';
@@ -21,12 +21,11 @@ export type ResolvedConfig = RqbitConfig & {
 /**
  * Error thrown when a request to rqbit fails, either an error response or a timeout/network error
  */
-export declare class RqbitApiError extends Error {
+/**
+ * A {@link TorrentClientError} with rqbit's error details
+ */
+export declare class RqbitApiError extends TorrentClientError {
     name: string;
-    /**
-     * HTTP status code, undefined when no response was received (timeout or network error)
-     */
-    status?: number;
     /**
      * rqbit error kind, ex - `torrent_not_found`. Undefined when rqbit returned a plain text error.
      */
@@ -89,13 +88,14 @@ export declare class Rqbit implements TorrentClient {
      * rqbit requires basic auth on this url when it is enabled.
      */
     getPlaylistUrl(id?: TorrentIdOrHash): string;
-    pauseTorrent(id: TorrentIdOrHash): Promise<EmptyResponse>;
-    resumeTorrent(id: TorrentIdOrHash): Promise<EmptyResponse>;
+    pauseTorrent(id: TorrentIdOrHash | TorrentIdOrHash[]): Promise<void>;
+    resumeTorrent(id: TorrentIdOrHash | TorrentIdOrHash[]): Promise<void>;
     /**
      * Remove a torrent
      * @param removeData (default: false) If true, remove the downloaded files.
+     * @throws {RqbitApiError} when a torrent doesn't exist
      */
-    removeTorrent(id: TorrentIdOrHash, removeData?: boolean): Promise<EmptyResponse>;
+    removeTorrent(id: TorrentIdOrHash | TorrentIdOrHash[], removeData?: boolean): Promise<void>;
     /**
      * Change which files are downloaded
      * @param fileIds indexes into the torrent's file list
@@ -111,11 +111,11 @@ export declare class Rqbit implements TorrentClient {
     /**
      * rqbit does not support queueing
      */
-    queueUp(_id: TorrentIdOrHash): Promise<never>;
+    queueUp(_id: TorrentIdOrHash | TorrentIdOrHash[]): Promise<never>;
     /**
      * rqbit does not support queueing
      */
-    queueDown(_id: TorrentIdOrHash): Promise<never>;
+    queueDown(_id: TorrentIdOrHash | TorrentIdOrHash[]): Promise<never>;
     /**
      * Add a magnet link or a url to a .torrent file.
      * rqbit resolves magnet metadata from peers before it responds, so this can take a while, see {@link RqbitConfig.addTimeout}

package/dist/src/rqbit.js

@@ -1,3 +1,4 @@
+import { TorrentClientError, } from '@ctrl/shared-torrent';
 import { FetchError, ofetch, } from 'ofetch';
 import { joinURL } from 'ufo';
 import { base64ToUint8Array, stringToBase64 } from 'uint8array-extras';
@@ -13,24 +14,28 @@ const defaults = {
 /**
  * Error thrown when a request to rqbit fails, either an error response or a timeout/network error
  */
-export class RqbitApiError extends Error {
+/**
+ * A {@link TorrentClientError} with rqbit's error details
+ */
+export class RqbitApiError extends TorrentClientError {
     name = 'RqbitApiError';
-    /**
-     * HTTP status code, undefined when no response was received (timeout or network error)
-     */
-    status;
     /**
      * rqbit error kind, ex - `torrent_not_found`. Undefined when rqbit returned a plain text error.
      */
     kind;
     response;
     constructor(status, message, response, cause) {
-        super(message, { cause });
-        this.status = status;
+        super(message, rqbitErrorCode(status, response?.error_kind), { status, cause });
         this.kind = response?.error_kind;
         this.response = response;
     }
 }
+function rqbitErrorCode(status, kind) {
+    if (status === 401 || status === 403) {
+        return 'unauthorized';
+    }
+    return kind === 'torrent_not_found' ? 'torrent_not_found' : 'request_failed';
+}
 /**
  * rqbit has no published api reference. `GET /` on the server lists every endpoint, see {@link Rqbit.getApiInfo}.
  * Routes {@link https://github.com/ikatson/rqbit/blob/v9.0.1/crates/librqbit/src/http_api/handlers/mod.rs}
@@ -126,18 +131,25 @@ export class Rqbit {
         return this.url(id === undefined ? '/torrents/playlist' : `/torrents/${id}/playlist`);
     }
     async pauseTorrent(id) {
-        return this.request(`/torrents/${id}/pause`, { method: 'POST' });
+        for (const i of Array.isArray(id) ? id : [id]) {
+            await this.request(`/torrents/${i}/pause`, { method: 'POST' });
+        }
     }
     async resumeTorrent(id) {
-        return this.request(`/torrents/${id}/start`, { method: 'POST' });
+        for (const i of Array.isArray(id) ? id : [id]) {
+            await this.request(`/torrents/${i}/start`, { method: 'POST' });
+        }
     }
     /**
      * Remove a torrent
      * @param removeData (default: false) If true, remove the downloaded files.
+     * @throws {RqbitApiError} when a torrent doesn't exist
      */
     async removeTorrent(id, removeData = false) {
         const action = removeData ? 'delete' : 'forget';
-        return this.request(`/torrents/${id}/${action}`, { method: 'POST' });
+        for (const i of Array.isArray(id) ? id : [id]) {
+            await this.request(`/torrents/${i}/${action}`, { method: 'POST' });
+        }
     }
     /**
      * Change which files are downloaded

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/rqbit",
-  "version": "1.0.0",
+  "version": "2.0.1",
   "description": "TypeScript api wrapper for rqbit using ofetch",
   "keywords": [
     "rqbit",
@@ -21,6 +21,13 @@
   "sideEffects": false,
   "main": "./dist/src/index.js",
   "types": "./dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "default": "./dist/src/index.js"
+    },
+    "./package.json": "./package.json"
+  },
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -35,7 +42,7 @@
     "test:watch": "vitest"
   },
   "dependencies": {
-    "@ctrl/shared-torrent": "^6.5.2",
+    "@ctrl/shared-torrent": "^6.6.0",
     "ofetch": "^1.5.1",
     "type-fest": "^5.10.0",
     "ufo": "^1.6.4",
@@ -59,7 +66,7 @@
     ]
   },
   "engines": {
-    "node": ">=22"
+    "node": ">=24"
   },
   "packageManager": "pnpm@12.9.1"
 }