@ctrl/rqbit 2.0.0 → 2.0.1

package/README.md

@@ -111,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/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.
      */

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}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/rqbit",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "TypeScript api wrapper for rqbit using ofetch",
   "keywords": [
     "rqbit",
@@ -42,7 +42,7 @@
     "test:watch": "vitest"
   },
   "dependencies": {
-    "@ctrl/shared-torrent": "^6.5.4",
+    "@ctrl/shared-torrent": "^6.6.0",
     "ofetch": "^1.5.1",
     "type-fest": "^5.10.0",
     "ufo": "^1.6.4",