@fett/synology-api 0.1.0 → 0.1.2

package/README.md

@@ -7,7 +7,8 @@
 
 ![NPM Version](https://img.shields.io/npm/v/%40fett%2Fsynology-api) ![NPM Downloads](https://img.shields.io/npm/dm/%40fett%2Fsynology-api) ![GitHub](https://img.shields.io/github/license/chrissong1994/synology-api) ![vitest](https://img.shields.io/badge/tested_with-vitest-brightgreen)
 
-👉🏻 [API Document ](https://chrissong1994.github.io/synology-api)
+📖 [中文 README](./README_zh.md)
+🔎 [API Document ](https://chrissong1994.github.io/synology-api)
 
 Synology Api Javascript wrapper can be used in Browser、CLI or Nodejs to interact with Synology NAS.
 You can use domain or ip address, also supports Synology Quick Connect connect Synology server.
@@ -27,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

@@ -17,6 +17,7 @@ export interface SynologyApiOptions {
     password: string;
     quickConnectServerType?: QuickConnectServerType;
     agent?: Agent;
+    lanPriority?: boolean;
 }
 export interface SynologyApiInfoData {
     maxVersion: number;
@@ -38,6 +39,7 @@ export declare class SynologyApi extends BaseModuleSynologyApi {
     baseUrl: string;
     isConnecting: boolean;
     quickConnectServerType?: QuickConnectServerType;
+    lanPriority?: boolean;
     private authInfo;
     private apiInfo;
     constructor(options: SynologyApiOptions);
@@ -52,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

@@ -17,13 +17,14 @@ export class SynologyApi extends BaseModuleSynologyApi {
         this.username = options.username;
         this.password = options.password;
         this.quickConnectServerType = options.quickConnectServerType ?? QuickConnectServerType.proxy;
+        this.lanPriority = options.lanPriority ?? false;
         this.baseUrl = `${this.server}/webapi/`;
         this.agent = options.agent ?? undefined;
     }
     async connect() {
         // if quickconnect id
         if (!isHttpUrl(this.server)) {
-            this.server = await getServerInfo(this.server, this.quickConnectServerType);
+            this.server = await getServerInfo(this.server, this.quickConnectServerType, this.lanPriority);
             this.baseUrl = `${this.server}/webapi/`;
         }
         try {
@@ -103,6 +104,9 @@ export class SynologyApi extends BaseModuleSynologyApi {
             },
             data: options.data ?? null,
         };
+        if (options.responseType) {
+            requestOptions.responseType = options.responseType;
+        }
         // https agent for node
         if (isNode) {
             if (this.agent?.https) {

package/lib/helpers.d.ts

@@ -16,5 +16,5 @@ export type ServerInfo = {
         relay_port: number;
     };
 };
-export declare const getServerInfo: (quickConnectId: string, quickConnectServerType: QuickConnectServerType) => Promise<any>;
+export declare const getServerInfo: (quickConnectId: string, quickConnectServerType: QuickConnectServerType, lanPriority?: boolean) => Promise<any>;
 export declare const pingpang: (server: string) => Promise<boolean>;

package/lib/helpers.js

@@ -1,7 +1,7 @@
 import Axios from "axios";
 import { GLOBAL_QUICK_CONNECT_URL, QUICK_CONNECT_PINGPANG_API } from "./constants.js";
 import { QuickConnectServerType } from "./types/index.js";
-const getServersFromServerInfo = async (serverInfo, quickConnectServerType) => {
+const getServersFromServerInfo = async (serverInfo, quickConnectServerType, lanPriority) => {
     const serverMap = {
         [QuickConnectServerType.proxy]: undefined,
         [QuickConnectServerType.lan]: undefined,
@@ -23,6 +23,12 @@ const getServersFromServerInfo = async (serverInfo, quickConnectServerType) => {
             `http://${serverInfo.server.interface?.[0].ip}:${serverInfo.service.port}`;
     }
     const server = serverMap[quickConnectServerType];
+    if (lanPriority && serverMap[QuickConnectServerType.lan]) {
+        const lanServer = serverMap[QuickConnectServerType.lan];
+        if (lanServer && (await pingpang(lanServer))) {
+            return lanServer;
+        }
+    }
     if (!server) {
         return Promise.reject(`${quickConnectServerType} server not found`);
     }
@@ -34,7 +40,7 @@ const getServersFromServerInfo = async (serverInfo, quickConnectServerType) => {
         return server;
     }
 };
-export const getServerInfo = async (quickConnectId, quickConnectServerType) => {
+export const getServerInfo = async (quickConnectId, quickConnectServerType, lanPriority) => {
     const params = {
         version: 1,
         id: "dsm",
@@ -53,10 +59,10 @@ export const getServerInfo = async (quickConnectId, quickConnectServerType) => {
         };
         // get replay tunnel
         const result = (await Axios.post(`https://${serverInfo.env.control_host}/Serv.php`, relayRequestParams)).data;
-        return getServersFromServerInfo(result, quickConnectServerType);
+        return getServersFromServerInfo(result, quickConnectServerType, lanPriority);
     }
     else {
-        return getServersFromServerInfo(serverInfo, quickConnectServerType);
+        return getServersFromServerInfo(serverInfo, quickConnectServerType, lanPriority);
     }
 };
 // pingpang

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

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

package/lib/modules/FileStation/Download.js

@@ -1,19 +1,35 @@
 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,
-    };
+import { isNode } from "../../utils/index.js";
+export async function getDownload(params) {
+    const { path } = params;
+    const res = await this.run(FileStationApi.Download, {
+        responseType: "arraybuffer",
+        params: {
+            path,
+            mode: "download",
+        },
+    });
+    return isNode ? Buffer.from(res) : res;
 }
+// export async function getFileOpenUrl(params: DownloadFileParams): Promise<{
+//   data: string;
+//   success: boolean;
+// }> {
+//   if (!this.isConnecting) {
+//     await this.connect();
+//   }
+//   const { path } = params;
+//   const apiInfo = this.getApiInfoByName(FileStationApi.Download);
+//   const url = buildUrlWithQuery(`${this.baseUrl}${apiInfo.path}`, {
+//     api: FileStationApi.Download,
+//     method:"download",
+//     path,
+//     mode: "open",
+//     version: apiInfo.maxVersion,
+//     _sid: this.authInfo?.sid,
+//   });
+//   return {
+//     data: url,
+//     success: true,
+//   };
+// }

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

@@ -1,4 +1,3 @@
-import { SynologyApiResponse } from "../../types/index.js";
 export type GetThumbRequest = {
     path: string;
     size?: "small" | "medium" | "large" | "original";
@@ -14,5 +13,5 @@ export type GetThumbRequest = {
     */
     rotate?: 0 | 1 | 2 | 3 | 4;
 };
-export type GetThumbResponse = SynologyApiResponse<{}>;
-export declare function getThumbUrl(params: GetThumbRequest): Promise<GetThumbResponse>;
+export type GetThumbResponse = Buffer;
+export declare function getThumb(params: GetThumbRequest): Promise<GetThumbResponse>;

package/lib/modules/FileStation/Thumb.js

@@ -1,18 +1,14 @@
 import { FileStationApi } from "../../types/index.js";
-import { buildUrlWithQuery } from "../../utils/index.js";
-export async function getThumbUrl(params) {
+import { isNode } from "../../utils/index.js";
+export async function getThumb(params) {
     const { path, size = "small", rotate = 0 } = params;
-    const options = await this.genRequestOptions(FileStationApi.Thumb, {
-        method: "get",
+    const res = await this.run(FileStationApi.Thumb, {
+        responseType: "arraybuffer",
         params: {
             path,
             size,
             rotate,
         },
     });
-    const thumbUrl = buildUrlWithQuery(options.url, options.params);
-    return {
-        success: true,
-        data: thumbUrl,
-    };
+    return isNode ? Buffer.from(res) : res;
 }

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/lib/modules/FileStation/index.base.d.ts

@@ -6,9 +6,9 @@ import { getFileList, getShareFileList, getVirtualFolderList } from "./List.js";
 import { addFavorite, deleteFavorite, getFavoriteList, clearBrokenFavorite, editFavorite } from "./Favorite.js";
 import { startSearch, stopSearch, getSearchList, cleanSearch } from "./Search.js";
 import { createFolder } from "./CreateFolder.js";
-import { getDownloadFile } from "./Download.js";
+import { getDownload } from "./Download.js";
 import { stopDeleteFile, startDeleteFile, getDeleteFileStatus } from "./Delete.js";
-import { getThumbUrl } from "./Thumb.js";
+import { getThumb } from "./Thumb.js";
 import { startDirSizeCalc, stopDirSizeCalc, getDirSizeCalcStatus } from "./DirSize.js";
 import { startMD5Calc, stopMD5Calc, getMD5CalcStatus } from "./MD5.js";
 import { checkPermission } from "./CheckPermission.js";
@@ -31,11 +31,11 @@ export declare const METHODS: {
     getSearchList: typeof getSearchList;
     cleanSearch: typeof cleanSearch;
     createFolder: typeof createFolder;
-    getDownloadFile: typeof getDownloadFile;
+    getDownload: typeof getDownload;
     stopDeleteFile: typeof stopDeleteFile;
     startDeleteFile: typeof startDeleteFile;
     getDeleteFileStatus: typeof getDeleteFileStatus;
-    getThumbUrl: typeof getThumbUrl;
+    getThumb: typeof getThumb;
     startDirSizeCalc: typeof startDirSizeCalc;
     stopDirSizeCalc: typeof stopDirSizeCalc;
     getDirSizeCalcStatus: typeof getDirSizeCalcStatus;

package/lib/modules/FileStation/index.base.js

@@ -6,9 +6,9 @@ import { getFileList, getShareFileList, getVirtualFolderList } from "./List.js";
 import { addFavorite, deleteFavorite, getFavoriteList, clearBrokenFavorite, editFavorite, } from "./Favorite.js";
 import { startSearch, stopSearch, getSearchList, cleanSearch } from "./Search.js";
 import { createFolder } from "./CreateFolder.js";
-import { getDownloadFile } from "./Download.js";
+import { getDownload } from "./Download.js";
 import { stopDeleteFile, startDeleteFile, getDeleteFileStatus } from "./Delete.js";
-import { getThumbUrl } from "./Thumb.js";
+import { getThumb } from "./Thumb.js";
 import { startDirSizeCalc, stopDirSizeCalc, getDirSizeCalcStatus } from "./DirSize.js";
 import { startMD5Calc, stopMD5Calc, getMD5CalcStatus } from "./MD5.js";
 import { checkPermission } from "./CheckPermission.js";
@@ -32,11 +32,12 @@ export const METHODS = {
     getSearchList,
     cleanSearch,
     createFolder,
-    getDownloadFile,
+    getDownload,
+    //   getFileOpenUrl,
     stopDeleteFile,
     startDeleteFile,
     getDeleteFileStatus,
-    getThumbUrl,
+    getThumb,
     startDirSizeCalc,
     stopDirSizeCalc,
     getDirSizeCalcStatus,

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

@@ -15,11 +15,11 @@ export declare const METHODS: {
     getSearchList: typeof import("./Search.js").getSearchList;
     cleanSearch: typeof import("./Search.js").cleanSearch;
     createFolder: typeof import("./CreateFolder.js").createFolder;
-    getDownloadFile: typeof import("./Download.js").getDownloadFile;
+    getDownload: typeof import("./Download.js").getDownload;
     stopDeleteFile: typeof import("./Delete.js").stopDeleteFile;
     startDeleteFile: typeof import("./Delete.js").startDeleteFile;
     getDeleteFileStatus: typeof import("./Delete.js").getDeleteFileStatus;
-    getThumbUrl: typeof import("./Thumb.js").getThumbUrl;
+    getThumb: typeof import("./Thumb.js").getThumb;
     startDirSizeCalc: typeof import("./DirSize.js").startDirSizeCalc;
     stopDirSizeCalc: typeof import("./DirSize.js").stopDirSizeCalc;
     getDirSizeCalcStatus: typeof import("./DirSize.js").getDirSizeCalcStatus;

package/lib/modules/FileStation/index.rn.d.ts

@@ -15,11 +15,11 @@ export declare const METHODS: {
     getSearchList: typeof import("./Search.js").getSearchList;
     cleanSearch: typeof import("./Search.js").cleanSearch;
     createFolder: typeof import("./CreateFolder.js").createFolder;
-    getDownloadFile: typeof import("./Download.js").getDownloadFile;
+    getDownload: typeof import("./Download.js").getDownload;
     stopDeleteFile: typeof import("./Delete.js").stopDeleteFile;
     startDeleteFile: typeof import("./Delete.js").startDeleteFile;
     getDeleteFileStatus: typeof import("./Delete.js").getDeleteFileStatus;
-    getThumbUrl: typeof import("./Thumb.js").getThumbUrl;
+    getThumb: typeof import("./Thumb.js").getThumb;
     startDirSizeCalc: typeof import("./DirSize.js").startDirSizeCalc;
     stopDirSizeCalc: typeof import("./DirSize.js").stopDirSizeCalc;
     getDirSizeCalcStatus: typeof import("./DirSize.js").getDirSizeCalcStatus;

package/lib/modules/VideoStation/Streaming.js

@@ -21,7 +21,8 @@ export async function getStreamUrl(params) {
             allow_api: VideoStationApi.Streaming,
             allow_methods: ["stream"],
         });
-        const url = `${this.baseUrl}entry.cgi/1.mp4`;
+        const apiInfo = this.getApiInfoByName(VideoStationApi.Streaming);
+        const url = `${this.baseUrl}${apiInfo.path}/1.mp4`;
         const query = {
             ...params,
             api: VideoStationApi.Streaming,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fett/synology-api",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "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": {