@fett/synology-api 0.0.1-beta.7 → 0.0.1-beta.9

package/lib/cjs/index.js

@@ -76,7 +76,7 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 
 // src/core.ts
-var import_axios4 = __toESM(require("axios"));
+var import_ky4 = __toESM(require("ky"));
 
 // src/types/apiInfo.ts
 var SynologyApiInfo = /* @__PURE__ */ ((SynologyApiInfo2) => {
@@ -122,7 +122,7 @@ function getSongList(params) {
         library: "all"
       }, params)
     });
-    return res.data;
+    return res;
   });
 }
 
@@ -141,7 +141,7 @@ function getInfo() {
         method: "get"
       }
     });
-    return res.data;
+    return res;
   });
 }
 
@@ -171,7 +171,7 @@ function getFileList() {
         folder_path: params.folder_path
       }, params)
     });
-    return res.data;
+    return res;
   });
 }
 function getFileListShare() {
@@ -184,7 +184,7 @@ function getFileListShare() {
         onlywritable
       }, params)
     });
-    return res.data;
+    return res;
   });
 }
 
@@ -242,7 +242,7 @@ Object.defineProperties(BaseSynologyApi.prototype, {
 });
 
 // src/helpers.ts
-var import_axios = __toESM(require("axios"));
+var import_ky = __toESM(require("ky"));
 
 // src/constants.ts
 var GLOBAL_QUICK_CONNECT_URL = "https://global.quickconnect.cn/Serv.php";
@@ -272,7 +272,7 @@ var getServersFromServerInfo = (serverInfo) => __async(null, null, function* ()
   }
 });
 var getServerInfo = (quickConnectId) => __async(null, null, function* () {
-  var _a, _b, _c, _d;
+  var _a, _b;
   const params = {
     version: 1,
     id: "dsm",
@@ -280,8 +280,8 @@ var getServerInfo = (quickConnectId) => __async(null, null, function* () {
     get_ca_fingerprints: true,
     command: "get_server_info"
   };
-  const serverInfo = yield import_axios.default.post(GLOBAL_QUICK_CONNECT_URL, params);
-  if (!((_b = (_a = serverInfo.data) == null ? void 0 : _a.service) == null ? void 0 : _b.relay_ip) && !((_d = (_c = serverInfo.data) == null ? void 0 : _c.service) == null ? void 0 : _d.relay_port)) {
+  const serverInfo = yield import_ky.default.post(GLOBAL_QUICK_CONNECT_URL, { json: params }).json();
+  if (!((_a = serverInfo == null ? void 0 : serverInfo.service) == null ? void 0 : _a.relay_ip) && !((_b = serverInfo == null ? void 0 : serverInfo.service) == null ? void 0 : _b.relay_port)) {
     const relayRequestParams = {
       version: 1,
       id: "dsm",
@@ -289,21 +289,16 @@ var getServerInfo = (quickConnectId) => __async(null, null, function* () {
       platform: "web",
       command: "request_tunnel"
     };
-    const result = yield import_axios.default.post(
-      `https://${serverInfo.data.env.control_host}/Serv.php`,
-      relayRequestParams
-    );
-    return getServersFromServerInfo(result.data);
+    const result = yield import_ky.default.post(`https://${serverInfo.env.control_host}/Serv.php`, { json: relayRequestParams }).json();
+    return getServersFromServerInfo(result);
   } else {
-    return getServersFromServerInfo(serverInfo.data);
+    return getServersFromServerInfo(serverInfo);
   }
 });
 var pingpang = (server) => __async(null, null, function* () {
   try {
-    const result = yield import_axios.default.get(`${server}/${QUICK_CONNECT_PINGPANG_API}`, {
-      timeout: 3e3
-    });
-    if (result.data.success) {
+    const result = yield import_ky.default.get(`${server}/${QUICK_CONNECT_PINGPANG_API}`).json();
+    if (result.success) {
       return true;
     } else {
       return false;
@@ -314,7 +309,7 @@ var pingpang = (server) => __async(null, null, function* () {
 });
 
 // src/modules/Api/Auth.ts
-var import_axios2 = __toESM(require("axios"));
+var import_ky2 = __toESM(require("ky"));
 function login(core) {
   return __async(this, null, function* () {
     const params = {
@@ -326,11 +321,11 @@ function login(core) {
       format: "sid"
     };
     const url = `${core.baseUrl}entry.cgi`;
-    const result = yield import_axios2.default.get(url, { params });
-    if (!result.data.success) {
-      throw new Error(result.data.error.message);
+    const result = yield import_ky2.default.get(url, { searchParams: params }).json();
+    if (!result.success) {
+      throw new Error(result.error.message);
     }
-    return result.data;
+    return result;
   });
 }
 function logout(core) {
@@ -341,15 +336,15 @@ function logout(core) {
       method: "logout"
     };
     const url = `${core.baseUrl}entry.cgi`;
-    const result = yield import_axios2.default.get(url, { params });
-    if (!result.data.success) {
-      throw new Error(result.data.error.message);
+    const result = yield import_ky2.default.get(url, { searchParams: params }).json();
+    if (!result.success) {
+      throw new Error(result.error.message);
     }
   });
 }
 
 // src/modules/Api/Info.ts
-var import_axios3 = __toESM(require("axios"));
+var import_ky3 = __toESM(require("ky"));
 function getApiInfo(core) {
   return __async(this, null, function* () {
     const params = {
@@ -358,11 +353,11 @@ function getApiInfo(core) {
       method: "query"
     };
     const url = `${core.baseUrl}entry.cgi`;
-    const result = yield import_axios3.default.get(url, { params });
-    if (!result.data.success) {
-      throw new Error(result.data.error.message);
+    const result = yield import_ky3.default.get(url, { searchParams: params }).json();
+    if (!result.success) {
+      throw new Error(result.error.message);
     }
-    return result.data;
+    return result;
   });
 }
 
@@ -547,14 +542,14 @@ var SynologyApi = class extends BaseSynologyApi {
       }, params);
       let result = null;
       if (method === "get") {
-        result = yield import_axios4.default.get(url, { params: externalParams, data, headers });
+        result = yield import_ky4.default.get(url, { searchParams: externalParams, headers }).json();
       }
       if (method === "post") {
-        result = yield import_axios4.default.post(url, { params: externalParams, data, headers });
+        result = yield import_ky4.default.post(url, { searchParams: externalParams, json: data, headers }).json();
       }
       const apiKey = getApiKey(apiName);
       if (!isUndfined(apiKey)) {
-        result.data = resWithErrorCode(apiKey, result.data);
+        result = resWithErrorCode(apiKey, result);
       }
       return result;
     });
@@ -714,7 +709,7 @@ var apiCmdRegister = () => {
 function loadCli() {
   return __async(this, null, function* () {
     const pkg = yield import_fs_extra2.default.readJSON(import_path2.default.join(__dirname, "../../package.json"));
-    import_commander3.program.name("synology").usage("<command> [options]").description("synology api cli tool").version(pkg.version);
+    import_commander3.program.name("synology").usage("<command> [options]").description("synology api cli tool").version(pkg.version, "-v, --version", "output the version number");
     configCmdRegister();
     apiCmdRegister();
     import_commander3.program.parse(process.argv);

package/lib/esm/cli/index.js

@@ -21,7 +21,7 @@ export function loadCli() {
             .name("synology")
             .usage("<command> [options]")
             .description("synology api cli tool")
-            .version(pkg.version);
+            .version(pkg.version, "-v, --version", "output the version number");
         // register commands
         configCmdRegister();
         apiCmdRegister();

package/lib/esm/core.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 // reference: https://kb.synology.com/zh-tw/DSM/tutorial/What_websites_does_Synology_NAS_connect_to_when_running_services_or_updating_software
-import axios from "axios";
+import ky from "ky";
 import { BaseSynologyApi } from "./modules";
 import { isHttpUrl, getApiKey, isUndfined } from "./utils";
 import { getServerInfo } from "./helpers";
@@ -95,15 +95,15 @@ export class SynologyApi extends BaseSynologyApi {
             const externalParams = Object.assign({ api: apiName, version: api.maxVersion, _sid: this.authInfo.sid }, params);
             let result = null;
             if (method === "get") {
-                result = yield axios.get(url, { params: externalParams, data, headers });
+                result = yield ky.get(url, { searchParams: externalParams, headers }).json();
             }
             if (method === "post") {
-                result = yield axios.post(url, { params: externalParams, data, headers });
+                result = yield ky.post(url, { searchParams: externalParams, json: data, headers }).json();
             }
             // match error code msg
             const apiKey = getApiKey(apiName);
             if (!isUndfined(apiKey)) {
-                result.data = resWithErrorCode(apiKey, result.data);
+                result = resWithErrorCode(apiKey, result);
             }
             return result;
         });

package/lib/esm/helpers.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import axios from "axios";
+import ky from "ky";
 import { GLOBAL_QUICK_CONNECT_URL, QUICK_CONNECT_PINGPANG_API } from "./constants";
 const getServersFromServerInfo = (serverInfo) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b, _c, _d, _e, _f;
@@ -34,9 +34,8 @@ const getServersFromServerInfo = (serverInfo) => __awaiter(void 0, void 0, void
         }
     }
 });
-// get server ip
 export const getServerInfo = (quickConnectId) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b, _c, _d;
+    var _a, _b;
     const params = {
         version: 1,
         id: "dsm",
@@ -44,8 +43,8 @@ export const getServerInfo = (quickConnectId) => __awaiter(void 0, void 0, void
         get_ca_fingerprints: true,
         command: "get_server_info",
     };
-    const serverInfo = yield axios.post(GLOBAL_QUICK_CONNECT_URL, params);
-    if (!((_b = (_a = serverInfo.data) === null || _a === void 0 ? void 0 : _a.service) === null || _b === void 0 ? void 0 : _b.relay_ip) && !((_d = (_c = serverInfo.data) === null || _c === void 0 ? void 0 : _c.service) === null || _d === void 0 ? void 0 : _d.relay_port)) {
+    const serverInfo = yield ky.post(GLOBAL_QUICK_CONNECT_URL, { json: params }).json();
+    if (!((_a = serverInfo === null || serverInfo === void 0 ? void 0 : serverInfo.service) === null || _a === void 0 ? void 0 : _a.relay_ip) && !((_b = serverInfo === null || serverInfo === void 0 ? void 0 : serverInfo.service) === null || _b === void 0 ? void 0 : _b.relay_port)) {
         const relayRequestParams = {
             version: 1,
             id: "dsm",
@@ -53,20 +52,22 @@ export const getServerInfo = (quickConnectId) => __awaiter(void 0, void 0, void
             platform: "web",
             command: "request_tunnel",
         };
-        const result = yield axios.post(`https://${serverInfo.data.env.control_host}/Serv.php`, relayRequestParams);
-        return getServersFromServerInfo(result.data);
+        const result = yield ky
+            .post(`https://${serverInfo.env.control_host}/Serv.php`, { json: relayRequestParams })
+            .json();
+        return getServersFromServerInfo(result);
     }
     else {
-        return getServersFromServerInfo(serverInfo.data);
+        return getServersFromServerInfo(serverInfo);
     }
 });
 // pingpang
 export const pingpang = (server) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        const result = yield axios.get(`${server}/${QUICK_CONNECT_PINGPANG_API}`, {
-            timeout: 3000,
-        });
-        if (result.data.success) {
+        const result = yield ky
+            .get(`${server}/${QUICK_CONNECT_PINGPANG_API}`)
+            .json();
+        if (result.success) {
             return true;
         }
         else {

package/lib/esm/modules/Api/Auth.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import axios from "axios";
+import ky from "ky";
 import { SynologyApiInfo } from "../../types";
 export function login(core) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -20,11 +20,11 @@ export function login(core) {
             format: "sid",
         };
         const url = `${core.baseUrl}entry.cgi`;
-        const result = yield axios.get(url, { params });
-        if (!result.data.success) {
-            throw new Error(result.data.error.message);
+        const result = yield ky.get(url, { searchParams: params }).json();
+        if (!result.success) {
+            throw new Error(result.error.message);
         }
-        return result.data;
+        return result;
     });
 }
 export function logout(core) {
@@ -35,9 +35,9 @@ export function logout(core) {
             method: "logout",
         };
         const url = `${core.baseUrl}entry.cgi`;
-        const result = yield axios.get(url, { params });
-        if (!result.data.success) {
-            throw new Error(result.data.error.message);
+        const result = yield ky.get(url, { searchParams: params }).json();
+        if (!result.success) {
+            throw new Error(result.error.message);
         }
     });
 }

package/lib/esm/modules/Api/Info.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import axios from "axios";
+import ky from "ky";
 import { SynologyApiInfo } from "../../types";
 export function getApiInfo(core) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -17,10 +17,10 @@ export function getApiInfo(core) {
             method: "query",
         };
         const url = `${core.baseUrl}entry.cgi`;
-        const result = yield axios.get(url, { params });
-        if (!result.data.success) {
-            throw new Error(result.data.error.message);
+        const result = yield ky.get(url, { searchParams: params }).json();
+        if (!result.success) {
+            throw new Error(result.error.message);
         }
-        return result.data;
+        return result;
     });
 }

package/lib/esm/modules/AudioStation/Song.js

@@ -13,6 +13,6 @@ export function getSongList(params) {
         const res = yield this.run(AudioStationApi.Song, {
             params: Object.assign({ method: "list", library: "all" }, params),
         });
-        return res.data;
+        return res;
     });
 }

package/lib/esm/modules/FileStation/Info.js

@@ -15,6 +15,6 @@ export function getInfo() {
                 method: "get",
             },
         });
-        return res.data;
+        return res;
     });
 }

package/lib/esm/modules/FileStation/List.js

@@ -18,7 +18,7 @@ export function getFileList() {
         const res = yield this.run(FileStationApi.List, {
             params: Object.assign({ method: "list", additional: JSON.stringify(additional), filetype: filetype, folder_path: params.folder_path }, params),
         });
-        return res.data;
+        return res;
     });
 }
 export function getFileListShare() {
@@ -27,6 +27,6 @@ export function getFileListShare() {
         const res = yield this.run(FileStationApi.List, {
             params: Object.assign({ method: "list_share", additional: JSON.stringify(additional), onlywritable: onlywritable }, params),
         });
-        return res.data;
+        return res;
     });
 }

package/lib/types/helpers.d.ts

@@ -1,2 +1,19 @@
+export type ServerInfo = {
+    env: {
+        control_host: string;
+    };
+    server: {
+        external: {
+            ip: string;
+        };
+        interface: {
+            ip: string;
+        }[];
+    };
+    service: {
+        relay_ip: string;
+        relay_port: number;
+    };
+};
 export declare const getServerInfo: (quickConnectId: string) => Promise<string>;
 export declare const pingpang: (server: string) => Promise<boolean>;

package/lib/types/modules/Api/Auth.d.ts

@@ -1,3 +1,4 @@
+import { SynologyApiResponse } from "../../types";
 import { SynologyApi } from "../../core";
-export declare function login(core: SynologyApi): Promise<any>;
+export declare function login(core: SynologyApi): Promise<SynologyApiResponse>;
 export declare function logout(core: SynologyApi): Promise<void>;

package/lib/types/modules/Api/Info.d.ts

@@ -1,2 +1,3 @@
+import { SynologyApiResponse } from "../../types";
 import { SynologyApi } from "../../core";
-export declare function getApiInfo(core: SynologyApi): Promise<any>;
+export declare function getApiInfo(core: SynologyApi): Promise<SynologyApiResponse>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fett/synology-api",
-  "version": "0.0.1-beta.7",
+  "version": "0.0.1-beta.9",
   "description": "synology api for nodejs",
   "module": "./lib/esm/index.js",
   "main": "./lib/cjs/index.js",
@@ -9,7 +9,8 @@
     ".": {
       "require": "./lib/cjs/index.js",
       "import": "./lib/esm/index.js"
-    }
+    },
+    "./browser": "./lib/esm/core.js"
   },
   "bin": {
     "synology": "./bin/syno",
@@ -64,10 +65,10 @@
     "vitest": "^3.1.3"
   },
   "dependencies": {
-    "axios": "^1.9.0",
     "chalk": "^5.4.1",
     "commander": "^14.0.0",
     "fs-extra": "^11.3.0",
+    "ky": "^1.8.1",
     "ora": "^8.2.0"
   }
 }