@fett/synology-api 0.1.0 → 0.1.1

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.

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);

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 {

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,
@@ -22,7 +22,13 @@ const getServersFromServerInfo = async (serverInfo, quickConnectServerType) => {
         serverMap[QuickConnectServerType.lan] =
             `http://${serverInfo.server.interface?.[0].ip}:${serverInfo.service.port}`;
     }
-    const server = serverMap[quickConnectServerType];
+    let 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fett/synology-api",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "synology api for nodejs",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",