@remote-app/transmission-client 0.0.12 → 0.0.14

package/README.md

@@ -0,0 +1,61 @@
+# @remote-app/transmission-client
+
+![npm](https://img.shields.io/npm/v/@remote-app/transmission-client)
+
+A lightweight Transmission RPC client.
+
+## Install
+
+```bash
+$ npm install @remote-app/transmission-client
+```
+
+## Supported methods
+
+### Torrent methods
+- Torrent actions
+  - [x] torrent-start
+  - [x] torrent-start-now
+  - [x] torrent-stop
+  - [x] torrent-verify
+  - [x] torrent-reannounce
+- Torrent mutator
+  - [x] torrent-set
+- Torrent accessor
+  - [x] torrent-get
+- Torrent addition
+  - [x] torrent-add
+- Torrent removal
+  - [x] torrent-remove
+- Move torrent
+  - [x] torrent-set-location
+- Renaming torrent
+  - [ ] torrent-rename-path
+
+### Session methods
+- Session accessor
+  - [x] session-get
+- Session mutator
+   - [x] session-set
+- Session statistics
+  - [x] session-stats
+- Session shutdown
+  - [ ] session-close
+
+### Blocklist
+- Mutator
+  - [ ] blocklist-update
+
+### Port
+- Check
+  - [ ] port-test
+
+### Space
+- Check
+  - [x] free-space
+
+### Groups
+- Group accessor
+  - [ ] group-get
+- Group mutator
+  - [ ] group-set

package/dist/client.d.ts

@@ -1,10 +1,10 @@
 import type { TransmissionConfig } from "./config";
-import type { Methods, Mapping } from "./rpc-call";
+import type { Methods, Calls } from "./rpc-call";
 export declare class TransmissionClient {
     private config;
     private session;
     constructor(config: TransmissionConfig);
-    request<M extends Methods>(body: Mapping[M][0] & {
+    request<M extends Methods>(req: Parameters<Calls[M]>[0] & {
         method: M;
-    }): Promise<Mapping[M][1]>;
+    }): Promise<ReturnType<Calls[M]>>;
 }

package/dist/client.js

@@ -14,7 +14,7 @@ export class TransmissionClient {
         this.config = config;
         this.session = null;
     }
-    request(body) {
+    request(req) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const headers = new Headers({
@@ -30,14 +30,14 @@ export class TransmissionClient {
             const request = new Request(this.config.url, {
                 method: "POST",
                 headers,
-                body: JSON.stringify(body),
+                body: JSON.stringify(req),
             });
             const response = yield fetch(request);
             if (response.status === 409) {
                 this.session = response.headers.get("x-transmission-session-id");
-                return yield this.request(body);
+                return yield this.request(req);
             }
-            if (response.status >= 400) {
+            if (!response.ok) {
                 throw new HTTPError(response.status, response.statusText);
             }
             const json = (yield response.json());

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export type { SessionGetResponse, SessionSetRequest, SessionStatsResponse, FreeSpaceRequest, FreeSpaceResponse, TorrentStartRequest, TorrentStartNowRequest, TorrentStopRequest, TorrentVerifyRequest, TorrentReannounceRequest, TorrentSetRequest, TorrentGetRequest, TorrentGetResponse, TorrentAddRequest, TorrentAddResponse, TorrentRemoveRequest, TorrentSetLocationRequest, } from "./rpc-calls";
+export type { SessionGetRequest, SessionGetResponse, SessionSetRequest, SessionStatsResponse, FreeSpaceRequest, FreeSpaceResponse, TorrentStartRequest, TorrentStartNowRequest, TorrentStopRequest, TorrentVerifyRequest, TorrentReannounceRequest, TorrentSetRequest, TorrentGetRequest, TorrentGetResponse, TorrentAddRequest, TorrentAddResponse, TorrentRemoveRequest, TorrentSetLocationRequest, } from "./rpc-calls";
 export { TorrentStatus } from "./rpc-calls/torrent-get";
 export type { Torrent } from "./rpc-calls/torrent-get";
 export type { Methods } from "./rpc-call";

package/dist/rpc-call.d.ts

@@ -1,32 +1,51 @@
-import type { SessionGetResponse, SessionSetRequest, SessionStatsResponse, FreeSpaceRequest, FreeSpaceResponse, TorrentStartRequest, TorrentStartNowRequest, TorrentStopRequest, TorrentVerifyRequest, TorrentReannounceRequest, TorrentSetRequest, TorrentGetRequest, TorrentGetResponse, TorrentAddRequest, TorrentAddResponse, TorrentRemoveRequest, TorrentSetLocationRequest } from "./rpc-calls";
+import type { SessionGetRequest, SessionGetResponse, SessionSetRequest, SessionStatsResponse, FreeSpaceRequest, FreeSpaceResponse, TorrentStartRequest, TorrentStartNowRequest, TorrentStopRequest, TorrentVerifyRequest, TorrentReannounceRequest, TorrentSetRequest, TorrentGetRequest, TorrentGetResponse, TorrentAddRequest, TorrentAddResponse, TorrentRemoveRequest, TorrentSetLocationRequest } from "./rpc-calls";
 declare type SessionMethods = "session-get" | "session-set" | "session-stats" | "free-space";
 declare type TorrentMethods = "torrent-start" | "torrent-start-now" | "torrent-stop" | "torrent-verify" | "torrent-reannounce" | "torrent-set" | "torrent-get" | "torrent-add" | "torrent-remove" | "torrent-set-location";
 export declare type Methods = SessionMethods | TorrentMethods;
-export declare type RPCRequest<A> = {
-    method: Methods;
-    arguments?: A;
+export declare type RPCRequest<M, T> = {
+    method: M;
+    arguments?: T;
     tag?: number;
 };
-export declare type RPCResponse<B> = {
-    result: "success" | string;
-    arguments?: B;
+export declare type RPCResponse<A> = {
+    result: string;
+    arguments: A;
     tag?: number;
 };
-export declare type RPCCall<A, B = void> = B extends void ? [RPCRequest<A>, void] : [RPCRequest<A>, RPCResponse<B>];
-export declare type Mapping = {
-    "session-get": RPCCall<never, SessionGetResponse>;
-    "session-set": RPCCall<SessionSetRequest>;
-    "session-stats": RPCCall<never, SessionStatsResponse>;
-    "free-space": RPCCall<FreeSpaceRequest, FreeSpaceResponse>;
-    "torrent-start": RPCCall<TorrentStartRequest>;
-    "torrent-start-now": RPCCall<TorrentStartNowRequest>;
-    "torrent-stop": RPCCall<TorrentStopRequest>;
-    "torrent-verify": RPCCall<TorrentVerifyRequest>;
-    "torrent-reannounce": RPCCall<TorrentReannounceRequest>;
-    "torrent-remove": RPCCall<TorrentRemoveRequest>;
-    "torrent-set-location": RPCCall<TorrentSetLocationRequest>;
-    "torrent-get": RPCCall<TorrentGetRequest, TorrentGetResponse>;
-    "torrent-add": RPCCall<TorrentAddRequest, TorrentAddResponse>;
-    "torrent-set": RPCCall<TorrentSetRequest>;
+declare type RPCCall<M extends Methods, TRequest, TResponse = never> = TResponse extends never ? (request: RPCRequest<M, TRequest>) => void : (request: RPCRequest<M, TRequest>) => RPCResponse<TResponse>;
+export declare type MethodRequest = {
+    "session-get": SessionGetRequest;
+    "session-set": SessionSetRequest;
+    "session-stats": never;
+    "free-space": FreeSpaceRequest;
+    "torrent-start": TorrentStartRequest;
+    "torrent-start-now": TorrentStartNowRequest;
+    "torrent-stop": TorrentStopRequest;
+    "torrent-verify": TorrentVerifyRequest;
+    "torrent-reannounce": TorrentReannounceRequest;
+    "torrent-remove": TorrentRemoveRequest;
+    "torrent-set-location": TorrentSetLocationRequest;
+    "torrent-get": TorrentGetRequest;
+    "torrent-add": TorrentAddRequest;
+    "torrent-set": TorrentSetRequest;
+};
+export declare type MethodResponse = {
+    "session-get": SessionGetResponse;
+    "session-set": SessionSetRequest;
+    "session-stats": SessionStatsResponse;
+    "free-space": FreeSpaceResponse;
+    "torrent-start": TorrentStartRequest;
+    "torrent-start-now": TorrentStartNowRequest;
+    "torrent-stop": TorrentStopRequest;
+    "torrent-verify": TorrentVerifyRequest;
+    "torrent-reannounce": TorrentReannounceRequest;
+    "torrent-remove": TorrentRemoveRequest;
+    "torrent-set-location": TorrentSetLocationRequest;
+    "torrent-get": TorrentGetResponse;
+    "torrent-add": TorrentAddResponse;
+    "torrent-set": TorrentSetRequest;
+};
+export declare type Calls = {
+    [K in Methods]: RPCCall<K, MethodRequest[K], MethodResponse[K]>;
 };
 export {};

package/dist/rpc-calls/index.d.ts

@@ -1,4 +1,4 @@
-export type { Response as SessionGetResponse } from "./session-get";
+export type { Request as SessionGetRequest, Response as SessionGetResponse, } from "./session-get";
 export type { Request as SessionSetRequest } from "./session-set";
 export type { Response as SessionStatsResponse } from "./session-stats";
 export type { Request as FreeSpaceRequest, Response as FreeSpaceResponse, } from "./free-space";

package/dist/rpc-calls/session-get.d.ts

@@ -1,3 +1,4 @@
+import { Fields } from "./utils";
 declare type Units = {
     "speed-units": string[];
     "speed-bytes": number;
@@ -56,4 +57,5 @@ export declare type Response = {
     "utp-enabled": boolean;
     version: string;
 };
+export declare type Request = Partial<Fields<keyof Response>>;
 export {};

package/dist/rpc-calls/torrent-get.d.ts

@@ -1,4 +1,4 @@
-import { Identifiers } from "./utils";
+import { Identifiers, Fields } from "./utils";
 declare type File = {
     bytesCompleted: number;
     length: number;
@@ -162,7 +162,5 @@ export declare type Torrent = {
 export declare type Response = {
     torrents: Torrent[];
 };
-export declare type Request = Identifiers & {
-    fields: (keyof Torrent)[];
-};
+export declare type Request = Identifiers & Fields<keyof Torrent>;
 export {};

package/dist/rpc-calls/utils.d.ts

@@ -1,3 +1,6 @@
 export declare type Identifiers = {
     ids?: number | (number | string)[] | "recently-active";
 };
+export declare type Fields<T> = {
+    fields: T[];
+};

package/package.json

@@ -1,17 +1,24 @@
 {
   "name": "@remote-app/transmission-client",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "description": "Transmission RPC client",
+  "keywords": [
+    "transmission",
+    "rpc",
+    "client"
+  ],
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/jgalat/remote-app",
+    "url": "git+https://github.com/jgalat/remote-app.git",
     "directory": "packages/transmission-client"
   },
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "react-native": "src/index.ts",
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "tsc --build"
   },