@fett/synology-api 0.0.4 → 0.1.0

package/README.md

@@ -5,9 +5,9 @@
 </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/)
+👉🏻 [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 +117,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/package.json

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