@fett/synology-api 0.0.4 → 0.1.1

package/README.md

@@ -5,9 +5,10 @@
 </p>
 <h1 align="center">Javascript Synology Api</h1>
 
-⚠️ The project is under development ...
+![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:** [chrissong1994.github.io/synology-api/](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.
@@ -117,7 +118,7 @@ then you can use it and exec command
 ```bash
 syno config use ConnetionName
 
-syno fs getInfo --pretty # print file system info
+syno fs getInfo --beautify # print file system info
 
 ```
 

package/lib/cli/apis.d.ts

@@ -1,7 +1,8 @@
 export type MethodOptions = {
     params?: string;
-    pretty?: boolean;
+    beautify?: boolean;
     list?: boolean;
+    output?: string;
 };
 export declare const onMethodCall: (module: string) => (method: string, options: MethodOptions) => Promise<void>;
 export declare const apiCmdRegister: () => void;

package/lib/cli/apis.js

@@ -1,6 +1,8 @@
 import { program } from "commander";
 import chalk from "chalk";
 import ora from "ora";
+import fse from "fs-extra";
+import path from "path";
 import { loadConfig } from "./config.js";
 import { SynologyApi } from "../core.js";
 import { SynologyApiModules, SynologyApiMethods } from "../modules/index.js";
@@ -8,7 +10,7 @@ import { printMessages } from "./helper.js";
 export const onMethodCall = (module) => async (method, options) => {
     const config = await loadConfig();
     const params = JSON.parse(options.params || "{}");
-    const pretty = options.pretty;
+    const beautify = options.beautify ?? false;
     const connection = config.connections?.[config.used];
     if (!connection) {
         throw new Error("Connection undefined");
@@ -32,12 +34,26 @@ export const onMethodCall = (module) => async (method, options) => {
     const spinner = ora("waiting...").start();
     const result = await synologyApi[module]?.[method](params);
     spinner.stop();
-    if (pretty) {
+    if (beautify) {
         console.log(JSON.stringify(result, null, 2));
     }
     else {
         console.log(JSON.stringify(result));
     }
+    if (options.output) {
+        try {
+            let out_path = path.resolve(options.output);
+            if (!fse.existsSync(out_path)) {
+                fse.ensureFileSync(out_path);
+                console.log(chalk.yellowBright(`Output file created: ${out_path}`));
+            }
+            await fse.writeFile(out_path, JSON.stringify(result, null, 2));
+            console.log(chalk.greenBright(`Output file written: ${out_path}`));
+        }
+        catch (e) {
+            console.error(e);
+        }
+    }
     synologyApi.disconnect();
     process.exit(0);
 };
@@ -52,8 +68,9 @@ export const apiCmdRegister = () => {
             .command(`${info.cmd} [method]`)
             .alias(info.alias)
             .option("-p,--params <params>", `${info.cmd} method params`)
-            .option("--pretty", "Prettyprint JSON Output")
-            .option("-l,--list", `list all ${info.cmd} methods`)
+            .option("-b,--beautify", "Print beautify JSON data output")
+            .option("-l,--list", `List all ${info.cmd} methods`)
+            .option("-o,--output <output>", "Specify the output file, no file will be created in the current folder")
             .description(`Synology ${info.cmd} method call`)
             .action(onMethodCall(info.cmd));
     });

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.0.4",
+  "version": "0.1.1",
   "description": "synology api for nodejs",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",