@fett/synology-api 0.1.1 → 0.1.3

package/README.md

@@ -28,6 +28,7 @@ npm install @fett/synology-api
 | :--------------------: | :-----------------: | :----------------------------------------------------------- | :-----: |
 |         server         |       string        | Synology NAS address or QuickConnectId                       |    -    |
 | quickConnectServerType | proxy \| wan \| lan | QuickConnect server type when connecting via QuickConnect ID |  proxy  |
+|      lanPriority       |       boolean       | Prioritize LAN IP when quickConnectServerType is not lan     |  false  |
 |        username        |       string        | Synology NAS username                                        |    -    |
 |        password        |       string        | Synology NAS password                                        |    -    |
 

package/lib/cli/apis.js

@@ -42,7 +42,7 @@ export const onMethodCall = (module) => async (method, options) => {
     }
     if (options.output) {
         try {
-            let out_path = path.resolve(options.output);
+            const out_path = path.resolve(options.output);
             if (!fse.existsSync(out_path)) {
                 fse.ensureFileSync(out_path);
                 console.log(chalk.yellowBright(`Output file created: ${out_path}`));

package/lib/core.d.ts

@@ -54,12 +54,14 @@ export declare class SynologyApi extends BaseModuleSynologyApi {
         params?: Record<string, any>;
         data?: Record<string, any>;
         headers?: Record<string, any>;
+        responseType?: AxiosRequestConfig["responseType"];
     }): Promise<AxiosRequestConfig>;
     protected run(apiName: string, options: {
         method?: "get" | "post";
         params?: Record<string, any>;
         data?: Record<string, any>;
         headers?: Record<string, any>;
+        responseType?: AxiosRequestConfig["responseType"];
     }): Promise<any>;
 }
 export {};

package/lib/core.js

@@ -103,6 +103,7 @@ export class SynologyApi extends BaseModuleSynologyApi {
                 "x-syno-token": this.authInfo.synotoken,
             },
             data: options.data ?? null,
+            responseType: options.responseType ?? "json",
         };
         // https agent for node
         if (isNode) {
@@ -123,7 +124,7 @@ export class SynologyApi extends BaseModuleSynologyApi {
         const apiKey = getApiKey(apiName);
         try {
             let result = (await Axios(requestOptions)).data;
-            if (!isUndfined(apiKey)) {
+            if (!isUndfined(apiKey) && options.responseType === "json") {
                 result = resWithErrorCode(apiKey, result);
             }
             return result;

package/lib/errorcodes.d.ts

@@ -99,12 +99,4 @@ export declare const SYNOLOGY_ERROR_CODES: {
         9999: string;
     };
 };
-export declare const resWithErrorCode: (apiKey: string, res: SynologyApiResponse<any>) => SynologyApiResponse<any> | {
-    error: {
-        reason: any;
-        code: number;
-        message?: string;
-    };
-    data?: any;
-    success: boolean;
-};
+export declare const resWithErrorCode: (apiKey: string, res: SynologyApiResponse<any> | any) => any;

package/lib/helpers.js

@@ -22,7 +22,7 @@ const getServersFromServerInfo = async (serverInfo, quickConnectServerType, lanP
         serverMap[QuickConnectServerType.lan] =
             `http://${serverInfo.server.interface?.[0].ip}:${serverInfo.service.port}`;
     }
-    let server = serverMap[quickConnectServerType];
+    const server = serverMap[quickConnectServerType];
     if (lanPriority && serverMap[QuickConnectServerType.lan]) {
         const lanServer = serverMap[QuickConnectServerType.lan];
         if (lanServer && (await pingpang(lanServer))) {

package/lib/modules/FileStation/Download.d.ts

@@ -1,7 +1,8 @@
-import { SynologyApiResponse } from "../../types/index.js";
+import { AxiosRequestConfig } from "axios";
 export type DownloadFileParams = {
     path: string;
     mode?: "download" | "open";
+    responseType?: AxiosRequestConfig["responseType"];
 };
-export type DownloadFileResponse = SynologyApiResponse<string>;
+export type DownloadFileResponse = DownloadFileParams["responseType"];
 export declare function getDownloadFile(params: DownloadFileParams): Promise<DownloadFileResponse>;

package/lib/modules/FileStation/Download.js

@@ -1,19 +1,13 @@
 import { FileStationApi } from "../../types/index.js";
-import { buildUrlWithQuery } from "../../utils/index.js";
 export async function getDownloadFile(params) {
-    const { path, mode = "download" } = params;
-    const api = this.getApiInfoByName(FileStationApi.Download);
-    const query = {
-        method: "download",
-        path,
-        mode,
-        version: api.maxVersion,
-        api: FileStationApi.Download,
-        _sid: this.authInfo.sid,
-    };
-    const url = buildUrlWithQuery(`${this.baseUrl}${api.path}`, query);
-    return {
-        data: url,
-        success: true,
-    };
+    const { path, mode = "download", responseType } = params;
+    const res = await this.run(FileStationApi.Download, {
+        params: {
+            path,
+            mode,
+            method: "download",
+        },
+        responseType,
+    });
+    return res;
 }

package/lib/modules/FileStation/Thumb.js

@@ -2,15 +2,22 @@ import { FileStationApi } from "../../types/index.js";
 import { buildUrlWithQuery } from "../../utils/index.js";
 export async function getThumbUrl(params) {
     const { path, size = "small", rotate = 0 } = params;
+    if (!this.isConnecting) {
+        await this.connect();
+    }
+    const apiInfo = this.getApiInfoByName(FileStationApi.Thumb);
     const options = await this.genRequestOptions(FileStationApi.Thumb, {
-        method: "get",
         params: {
             path,
             size,
             rotate,
+            method: "get",
+            version: apiInfo.maxVersion || apiInfo.minVersion,
+            SynoToken: this.authInfo.synotoken,
+            _sid: this.authInfo.sid,
         },
     });
-    const thumbUrl = buildUrlWithQuery(options.url, options.params);
+    const thumbUrl = buildUrlWithQuery(`${this.baseUrl}${apiInfo.path}`, options.params);
     return {
         success: true,
         data: thumbUrl,

package/lib/modules/FileStation/Upload.js

@@ -12,7 +12,7 @@ export async function uploadFile(params) {
     }
     const api = this.getApiInfoByName(FileStationApi.Upload);
     const { path, file, overwrite = OverwriteEnum.OVERWRITE, create_parents = true } = params;
-    let formData = createFormData();
+    const formData = createFormData();
     formData.append("method", "upload");
     formData.append("version", String(api?.maxVersion));
     formData.append("api", FileStationApi.Upload);

package/lib/modules/FileStation/Upload.rn.js

@@ -11,7 +11,7 @@ export async function uploadFile(params) {
     }
     const api = this.getApiInfoByName(FileStationApi.Upload);
     const { path, file, overwrite = OverwriteEnum.OVERWRITE, create_parents = true } = params;
-    let formData = createFormData();
+    const formData = createFormData();
     formData.append("method", "upload");
     formData.append("version", String(api?.maxVersion));
     formData.append("api", FileStationApi.Upload);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fett/synology-api",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "synology api for nodejs",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -58,6 +58,7 @@
     "pub": "npm publish --access=public",
     "pub:beta": "npm publish --access=public --tag=beta",
     "test": "vitest",
+    "test:debug": "node --inspect-brk=9230 ./node_modules/vitest/vitest.mjs run --pool=forks",
     "coverage": "vitest run --coverage"
   },
   "devDependencies": {