@fett/synology-api 0.0.1-beta.4 → 0.0.1-beta.7

package/bin/syno

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+const { loadCli } = require("../lib/cjs/index");
+
+(async () => {
+  await loadCli();
+})();

package/{dist → lib}/cjs/index.js

@@ -70,7 +70,8 @@ __export(index_exports, {
   FileStationApi: () => FileStationApi,
   SynologyApi: () => SynologyApi,
   SynologyApiInfo: () => SynologyApiInfo,
-  default: () => index_default
+  default: () => index_default,
+  loadCli: () => loadCli
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -126,10 +127,11 @@ function getSongList(params) {
 }
 
 // src/modules/AudioStation/index.ts
-var AudioStationMethods = {
+var METHODS = {
   getSongList
 };
-var AudioStationKey = "AudioStation";
+var SPELLING_KEY = "AudioStation";
+var SIMPLIFY_KEY = "as";
 
 // src/modules/FileStation/Info.ts
 function getInfo() {
@@ -187,15 +189,22 @@ function getFileListShare() {
 }
 
 // src/modules/FileStation/index.ts
-var FileStationMethods = {
+var METHODS2 = {
   getInfo,
   getFileList,
   getFileListShare
 };
-var FileStationKey = "FileStation";
+var SPELLING_KEY2 = "FileStation";
+var SIMPLIFY_KEY2 = "fs";
 
 // src/modules/index.ts
-AudioStationKey, FileStationKey;
+var SynologyApiKeys = {
+  FileStation: SPELLING_KEY2,
+  fs: SIMPLIFY_KEY2,
+  AudioStation: SPELLING_KEY,
+  as: SIMPLIFY_KEY
+};
+SPELLING_KEY, SIMPLIFY_KEY, SPELLING_KEY2, SIMPLIFY_KEY2;
 var BaseSynologyApi = class {
   constructor() {
   }
@@ -208,14 +217,26 @@ function methodsBundler(instance, methods) {
   return output;
 }
 Object.defineProperties(BaseSynologyApi.prototype, {
-  [FileStationKey]: {
+  // FileStation
+  [SynologyApiKeys.FileStation]: {
+    get() {
+      return methodsBundler(this, METHODS2);
+    }
+  },
+  [SynologyApiKeys.fs]: {
     get() {
-      return methodsBundler(this, FileStationMethods);
+      return methodsBundler(this, METHODS2);
     }
   },
-  [AudioStationKey]: {
+  // AudioStation
+  [SynologyApiKeys.AudioStation]: {
     get() {
-      return methodsBundler(this, AudioStationMethods);
+      return methodsBundler(this, METHODS);
+    }
+  },
+  [SynologyApiKeys.as]: {
+    get() {
+      return methodsBundler(this, METHODS);
     }
   }
 });
@@ -229,22 +250,22 @@ var QUICK_CONNECT_PINGPANG_API = "/webman/pingpong.cgi?action=cors&quickconnect=
 
 // src/helpers.ts
 var getServersFromServerInfo = (serverInfo) => __async(null, null, function* () {
-  var _a, _b;
-  if (serverInfo.service.relay_ip) {
+  var _a, _b, _c, _d, _e, _f;
+  if ((_a = serverInfo == null ? void 0 : serverInfo.service) == null ? void 0 : _a.relay_ip) {
     const server = `http://${serverInfo.service.relay_ip}:${serverInfo.service.relay_port}`;
     const res = yield pingpang(server);
     if (res) {
       return server;
     }
   }
-  if (serverInfo.server.external.ip) {
+  if ((_c = (_b = serverInfo == null ? void 0 : serverInfo.server) == null ? void 0 : _b.external) == null ? void 0 : _c.ip) {
     const server = `http://${serverInfo.server.external.ip}:${serverInfo.service.port}`;
     if (yield pingpang(server)) {
       return server;
     }
   }
-  if ((_a = serverInfo.server.interface) == null ? void 0 : _a[0]) {
-    const server = `http://${(_b = serverInfo.server.interface) == null ? void 0 : _b[0].ip}:${serverInfo.service.port}`;
+  if ((_e = (_d = serverInfo == null ? void 0 : serverInfo.server) == null ? void 0 : _d.interface) == null ? void 0 : _e[0]) {
+    const server = `http://${(_f = serverInfo.server.interface) == null ? void 0 : _f[0].ip}:${serverInfo.service.port}`;
     if (yield pingpang(server)) {
       return server;
     }
@@ -349,7 +370,7 @@ function getApiInfo(core) {
 var CODE_SUCCESS = 0;
 var CODE_UNKNOWN = 9999;
 var SYNOLOGY_ERROR_CODES = {
-  [FileStationKey]: {
+  [SynologyApiKeys.FileStation]: {
     400: "Invalid parameter of file operation",
     401: "Unknown error of file operation",
     402: "System is too busy",
@@ -374,7 +395,7 @@ var SYNOLOGY_ERROR_CODES = {
     421: "Device or resource busy",
     599: "No such task of the file operation"
   },
-  [AudioStationKey]: {},
+  [SynologyApiKeys.AudioStation]: {},
   COMMON_CODES: {
     [CODE_SUCCESS]: "Success",
     100: "Unknown error",
@@ -540,6 +561,166 @@ var SynologyApi = class extends BaseSynologyApi {
   }
 };
 
+// src/cli/index.ts
+var import_fs_extra2 = __toESM(require("fs-extra"));
+var import_path2 = __toESM(require("path"));
+var import_commander3 = require("commander");
+
+// src/cli/config.ts
+var import_fs_extra = __toESM(require("fs-extra"));
+var import_path = __toESM(require("path"));
+var import_os = __toESM(require("os"));
+var import_commander = require("commander");
+var import_chalk2 = __toESM(require("chalk"));
+
+// src/cli/helper.ts
+var import_chalk = __toESM(require("chalk"));
+function printMessages(messages) {
+  console.log(messages.join("\n"));
+}
+function isLowerCaseEqual(str1, str2) {
+  if (str1 && str2) {
+    return str1.toLowerCase() === str2.toLowerCase();
+  }
+  return !str1 && !str2;
+}
+function padding(message = "", before = 1, after = 1) {
+  return new Array(before).fill(" ").join("") + message + new Array(after).fill(" ").join("");
+}
+function geneDashLine(message, length) {
+  const finalMessage = new Array(Math.max(2, length - message.length + 2)).join(
+    "-"
+  );
+  return padding(import_chalk.default.dim(finalMessage));
+}
+
+// src/cli/config.ts
+var CONFIG_FILE_PATH = process.env.NODE_ENV === "development" ? import_path.default.join(process.cwd(), "./.userdata/.synology-api.json") : import_path.default.join(import_os.default.homedir(), "./.synology-api.json");
+var loadConfig = () => __async(null, null, function* () {
+  if (!(yield import_fs_extra.default.pathExists(CONFIG_FILE_PATH))) {
+    yield import_fs_extra.default.ensureFile(CONFIG_FILE_PATH);
+    yield import_fs_extra.default.writeJSON(CONFIG_FILE_PATH, {
+      used: "",
+      connections: {}
+    });
+  }
+  const config = yield import_fs_extra.default.readJSON(CONFIG_FILE_PATH);
+  return config;
+});
+var updateConfig = (config) => __async(null, null, function* () {
+  yield import_fs_extra.default.writeJSON(CONFIG_FILE_PATH, config);
+});
+var configCmdRegister = () => {
+  const configCmd = import_commander.program.command("config").description("synology api config management");
+  configCmd.command("ls").description("List all the connection config").action(() => __async(null, null, function* () {
+    const config = yield loadConfig();
+    const keys = Object.keys(config.connections);
+    const dashLineLength = Math.max(...keys.map((key) => key.length)) + 3;
+    const messages = keys.map((key) => {
+      const connection = config.connections[key];
+      const prefix = isLowerCaseEqual(key, config.used) ? import_chalk2.default.green.bold("* ") : "  ";
+      return prefix + key + geneDashLine(key, dashLineLength) + connection.server + ":" + connection.username + ":" + connection.password;
+    });
+    printMessages(messages);
+  }));
+  configCmd.command("add [name]").description("Add connection config").requiredOption("-s, --server <server>", "Synology server domain  or QuickConnect ID ").requiredOption("-u, --username <username>", "username").requiredOption("-p,  --password <password>", "password").action((name, options) => __async(null, null, function* () {
+    if (!name.trim()) throw new Error("Plaease input connection name");
+    const config = yield loadConfig();
+    const newConfig = __spreadProps(__spreadValues({}, config), {
+      connections: __spreadProps(__spreadValues({}, config.connections), {
+        [name]: {
+          server: options.server,
+          username: options.username,
+          password: options.password
+        }
+      })
+    });
+    yield updateConfig(newConfig);
+  }));
+  configCmd.command("use [name]").description("Change current connection").action((name) => __async(null, null, function* () {
+    const config = yield loadConfig();
+    if (config.used === name) return;
+    if (!config.connections[name]) {
+      console.log("Connection not found");
+      return;
+    }
+    config.used = name;
+    yield updateConfig(config);
+  }));
+  configCmd.command("del [name]").description("Remove a connection").action((name) => __async(null, null, function* () {
+    console.log("Remove a connection", name);
+    const config = yield loadConfig();
+    if (!config.connections[name]) {
+      console.log("Connection not found");
+      return;
+    }
+    delete config.connections[name];
+    if (config.used === name) {
+      config.used = "";
+    }
+    yield updateConfig(config);
+  }));
+  configCmd.command("rename <name> <newName>").description("Change connection name").action((name, newName) => __async(null, null, function* () {
+    const config = yield loadConfig();
+    if (!config.connections[name]) {
+      console.log("Connection not found");
+      return;
+    }
+    config.connections[newName] = config.connections[name];
+    delete config.connections[name];
+    if (config.used === name) {
+      config.used = newName;
+    }
+    yield updateConfig(config);
+  }));
+};
+
+// src/cli/apis.ts
+var import_commander2 = require("commander");
+var onMethodsCall = (module2) => (method, options) => __async(null, null, function* () {
+  var _a, _b;
+  const config = yield loadConfig();
+  const params = JSON.parse(options.params || "{}");
+  const pretty = options.pretty;
+  const synologyApi = new SynologyApi(config.connections[config.used]);
+  if ((_a = synologyApi[module2]) == null ? void 0 : _a[method]) {
+    const result = yield (_b = synologyApi[module2]) == null ? void 0 : _b[method](params);
+    if (pretty) {
+      console.log(JSON.stringify(result, null, 2));
+    } else {
+      console.log(JSON.stringify(result));
+    }
+  }
+  synologyApi.disconnect();
+  process.exit(0);
+});
+var apisCmdRegisterInfo = [
+  {
+    cmd: SynologyApiKeys.FileStation,
+    alias: SynologyApiKeys.fs
+  },
+  {
+    cmd: SynologyApiKeys.AudioStation,
+    alias: SynologyApiKeys.as
+  }
+];
+var apiCmdRegister = () => {
+  apisCmdRegisterInfo.forEach((info) => {
+    import_commander2.program.command(`${info.cmd} [methods]`).alias(info.alias).option("-p,--params <params>", `${info.cmd} methods params`).option("--pretty", "Prettyprint JSON Output").description(`Synology ${info.cmd} method call`).action(onMethodsCall(info.cmd));
+  });
+};
+
+// src/cli/index.ts
+function loadCli() {
+  return __async(this, null, function* () {
+    const pkg = yield import_fs_extra2.default.readJSON(import_path2.default.join(__dirname, "../../package.json"));
+    import_commander3.program.name("synology").usage("<command> [options]").description("synology api cli tool").version(pkg.version);
+    configCmdRegister();
+    apiCmdRegister();
+    import_commander3.program.parse(process.argv);
+  });
+}
+
 // src/index.ts
 var index_default = SynologyApi;
 // Annotate the CommonJS export names for ESM import in node:
@@ -547,5 +728,6 @@ var index_default = SynologyApi;
   AudioStationApi,
   FileStationApi,
   SynologyApi,
-  SynologyApiInfo
+  SynologyApiInfo,
+  loadCli
 });

package/lib/esm/cli/apis.js

@@ -0,0 +1,53 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { program } from "commander";
+import { loadConfig } from "./config";
+import { SynologyApi } from "../core";
+import { SynologyApiKeys } from "../modules";
+export const onMethodsCall = (module) => (method, options) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
+    const config = yield loadConfig();
+    const params = JSON.parse(options.params || "{}");
+    const pretty = options.pretty;
+    const synologyApi = new SynologyApi(config.connections[config.used]);
+    if ((_a = synologyApi[module]) === null || _a === void 0 ? void 0 : _a[method]) {
+        const result = yield ((_b = synologyApi[module]) === null || _b === void 0 ? void 0 : _b[method](params));
+        if (pretty) {
+            console.log(JSON.stringify(result, null, 2));
+        }
+        else {
+            console.log(JSON.stringify(result));
+        }
+    }
+    synologyApi.disconnect();
+    process.exit(0);
+});
+// register all modules
+const apisCmdRegisterInfo = [
+    {
+        cmd: SynologyApiKeys.FileStation,
+        alias: SynologyApiKeys.fs,
+    },
+    {
+        cmd: SynologyApiKeys.AudioStation,
+        alias: SynologyApiKeys.as,
+    },
+];
+export const apiCmdRegister = () => {
+    apisCmdRegisterInfo.forEach((info) => {
+        program
+            .command(`${info.cmd} [methods]`)
+            .alias(info.alias)
+            .option("-p,--params <params>", `${info.cmd} methods params`)
+            .option("--pretty", "Prettyprint JSON Output")
+            .description(`Synology ${info.cmd} method call`)
+            .action(onMethodsCall(info.cmd));
+    });
+};

package/lib/esm/cli/config.js

@@ -0,0 +1,130 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import fse from "fs-extra";
+import path from "path";
+import os from "os";
+import { program } from "commander";
+import chalk from "chalk";
+import { isLowerCaseEqual, printMessages, geneDashLine } from "./helper";
+const CONFIG_FILE_PATH = process.env.NODE_ENV === "development"
+    ? path.join(process.cwd(), "./.userdata/.synology-api.json") // development
+    : path.join(os.homedir(), "./.synology-api.json");
+// load config
+export const loadConfig = () => __awaiter(void 0, void 0, void 0, function* () {
+    if (!(yield fse.pathExists(CONFIG_FILE_PATH))) {
+        yield fse.ensureFile(CONFIG_FILE_PATH);
+        yield fse.writeJSON(CONFIG_FILE_PATH, {
+            used: "",
+            connections: {},
+        });
+    }
+    const config = yield fse.readJSON(CONFIG_FILE_PATH);
+    return config;
+});
+// update config
+export const updateConfig = (config) => __awaiter(void 0, void 0, void 0, function* () {
+    yield fse.writeJSON(CONFIG_FILE_PATH, config);
+});
+// check config
+export const checkConfig = () => __awaiter(void 0, void 0, void 0, function* () { });
+export const configCmdRegister = () => {
+    const configCmd = program.command("config").description("synology api config management");
+    // list connection config
+    configCmd
+        .command("ls")
+        .description("List all the connection config")
+        .action(() => __awaiter(void 0, void 0, void 0, function* () {
+        const config = yield loadConfig();
+        const keys = Object.keys(config.connections);
+        const dashLineLength = Math.max(...keys.map((key) => key.length)) + 3;
+        const messages = keys.map((key) => {
+            const connection = config.connections[key];
+            const prefix = isLowerCaseEqual(key, config.used) ? chalk.green.bold("* ") : "  ";
+            return (prefix +
+                key +
+                geneDashLine(key, dashLineLength) +
+                connection.server +
+                ":" +
+                connection.username +
+                ":" +
+                connection.password);
+        });
+        printMessages(messages);
+    }));
+    // add connection
+    configCmd
+        .command("add [name]")
+        .description("Add connection config")
+        .requiredOption("-s, --server <server>", "Synology server domain  or QuickConnect ID ")
+        .requiredOption("-u, --username <username>", "username")
+        .requiredOption("-p,  --password <password>", "password")
+        .action((name, options) => __awaiter(void 0, void 0, void 0, function* () {
+        if (!name.trim())
+            throw new Error("Plaease input connection name");
+        // 实际代码中应保存配置到文件
+        const config = yield loadConfig();
+        const newConfig = Object.assign(Object.assign({}, config), { connections: Object.assign(Object.assign({}, config.connections), { [name]: {
+                    server: options.server,
+                    username: options.username,
+                    password: options.password,
+                } }) });
+        yield updateConfig(newConfig);
+    }));
+    // use  connection
+    configCmd
+        .command("use [name]")
+        .description("Change current connection")
+        .action((name) => __awaiter(void 0, void 0, void 0, function* () {
+        const config = yield loadConfig();
+        if (config.used === name)
+            return;
+        if (!config.connections[name]) {
+            console.log("Connection not found");
+            return;
+        }
+        config.used = name;
+        yield updateConfig(config);
+    }));
+    // del connection
+    configCmd
+        .command("del [name]")
+        .description("Remove a connection")
+        .action((name) => __awaiter(void 0, void 0, void 0, function* () {
+        console.log("Remove a connection", name);
+        const config = yield loadConfig();
+        // 删除配置
+        if (!config.connections[name]) {
+            console.log("Connection not found");
+            return;
+        }
+        delete config.connections[name];
+        if (config.used === name) {
+            config.used = "";
+        }
+        yield updateConfig(config);
+    }));
+    // Change connection name
+    configCmd
+        .command("rename <name> <newName>")
+        .description("Change connection name")
+        .action((name, newName) => __awaiter(void 0, void 0, void 0, function* () {
+        const config = yield loadConfig();
+        if (!config.connections[name]) {
+            console.log("Connection not found");
+            return;
+        }
+        config.connections[newName] = config.connections[name];
+        delete config.connections[name];
+        if (config.used === name) {
+            config.used = newName;
+        }
+        yield updateConfig(config);
+    }));
+};

package/lib/esm/cli/helper.js

@@ -0,0 +1,19 @@
+import chalk from "chalk";
+export function printMessages(messages) {
+    console.log(messages.join("\n"));
+}
+export function isLowerCaseEqual(str1, str2) {
+    if (str1 && str2) {
+        return str1.toLowerCase() === str2.toLowerCase();
+    }
+    return !str1 && !str2;
+}
+export function padding(message = '', before = 1, after = 1) {
+    return (new Array(before).fill(' ').join('') +
+        message +
+        new Array(after).fill(' ').join(''));
+}
+export function geneDashLine(message, length) {
+    const finalMessage = new Array(Math.max(2, length - message.length + 2)).join('-');
+    return padding(chalk.dim(finalMessage));
+}

package/lib/esm/cli/index.js

@@ -0,0 +1,30 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import fse from "fs-extra";
+import path from "path";
+import { program } from "commander";
+import { configCmdRegister } from "./config";
+import { apiCmdRegister } from "./apis";
+export function loadCli() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // git program info
+        const pkg = yield fse.readJSON(path.join(__dirname, "../../package.json"));
+        // command
+        program
+            .name("synology")
+            .usage("<command> [options]")
+            .description("synology api cli tool")
+            .version(pkg.version);
+        // register commands
+        configCmdRegister();
+        apiCmdRegister();
+        program.parse(process.argv);
+    });
+}

package/{dist → lib}/esm/errorcodes.js

@@ -1,9 +1,9 @@
-import { FileStationKey, AudioStationKey } from "./modules";
+import { SynologyApiKeys } from "./modules";
 import { isUndfined } from "./utils";
 const CODE_SUCCESS = 0;
 const CODE_UNKNOWN = 9999;
 export const SYNOLOGY_ERROR_CODES = {
-    [FileStationKey]: {
+    [SynologyApiKeys.FileStation]: {
         400: "Invalid parameter of file operation",
         401: "Unknown error of file operation",
         402: "System is too busy",
@@ -28,7 +28,7 @@ export const SYNOLOGY_ERROR_CODES = {
         421: "Device or resource busy",
         599: "No such task of the file operation",
     },
-    [AudioStationKey]: {},
+    [SynologyApiKeys.AudioStation]: {},
     COMMON_CODES: {
         [CODE_SUCCESS]: "Success",
         100: "Unknown error",

package/{dist → lib}/esm/helpers.js

@@ -10,9 +10,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import axios from "axios";
 import { GLOBAL_QUICK_CONNECT_URL, QUICK_CONNECT_PINGPANG_API } from "./constants";
 const getServersFromServerInfo = (serverInfo) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b;
+    var _a, _b, _c, _d, _e, _f;
     // proxy server
-    if (serverInfo.service.relay_ip) {
+    if ((_a = serverInfo === null || serverInfo === void 0 ? void 0 : serverInfo.service) === null || _a === void 0 ? void 0 : _a.relay_ip) {
         const server = `http://${serverInfo.service.relay_ip}:${serverInfo.service.relay_port}`;
         const res = yield pingpang(server);
         if (res) {
@@ -20,15 +20,15 @@ const getServersFromServerInfo = (serverInfo) => __awaiter(void 0, void 0, void
         }
     }
     // WAN IP
-    if (serverInfo.server.external.ip) {
+    if ((_c = (_b = serverInfo === null || serverInfo === void 0 ? void 0 : serverInfo.server) === null || _b === void 0 ? void 0 : _b.external) === null || _c === void 0 ? void 0 : _c.ip) {
         const server = `http://${serverInfo.server.external.ip}:${serverInfo.service.port}`;
         if (yield pingpang(server)) {
             return server;
         }
     }
     // lan ip
-    if ((_a = serverInfo.server.interface) === null || _a === void 0 ? void 0 : _a[0]) {
-        const server = `http://${(_b = serverInfo.server.interface) === null || _b === void 0 ? void 0 : _b[0].ip}:${serverInfo.service.port}`;
+    if ((_e = (_d = serverInfo === null || serverInfo === void 0 ? void 0 : serverInfo.server) === null || _d === void 0 ? void 0 : _d.interface) === null || _e === void 0 ? void 0 : _e[0]) {
+        const server = `http://${(_f = serverInfo.server.interface) === null || _f === void 0 ? void 0 : _f[0].ip}:${serverInfo.service.port}`;
         if (yield pingpang(server)) {
             return server;
         }

package/{dist → lib}/esm/index.js

@@ -1,4 +1,5 @@
 import { SynologyApi } from "./core";
 export * from "./types";
 export * from "./core";
+export * from "./cli";
 export default SynologyApi;

package/lib/esm/modules/AudioStation/index.js

@@ -0,0 +1,7 @@
+import { getSongList } from "./Song";
+export const METHODS = {
+    getSongList,
+};
+// name space
+export const SPELLING_KEY = "AudioStation";
+export const SIMPLIFY_KEY = "as";

package/{dist → lib}/esm/modules/FileStation/index.js

@@ -3,9 +3,12 @@
  */
 import { getInfo } from "./Info";
 import { getFileList, getFileListShare } from "./List";
-export const FileStationMethods = {
+// fs methods
+export const METHODS = {
     getInfo,
     getFileList,
     getFileListShare,
 };
-export const FileStationKey = "FileStation";
+// name space
+export const SPELLING_KEY = "FileStation";
+export const SIMPLIFY_KEY = "fs";

package/lib/esm/modules/index.js

@@ -0,0 +1,46 @@
+import * as AudioStation from "./AudioStation";
+import * as FileStation from "./FileStation";
+export const SynologyApiKeys = {
+    FileStation: FileStation.SPELLING_KEY,
+    fs: FileStation.SIMPLIFY_KEY,
+    AudioStation: AudioStation.SPELLING_KEY,
+    as: AudioStation.SIMPLIFY_KEY,
+};
+// export type BaseSynologyApiKeyMethods = FileStation.IKeyMethods
+export class BaseSynologyApi {
+    constructor() { }
+}
+AudioStation.SPELLING_KEY, AudioStation.SIMPLIFY_KEY, FileStation.SPELLING_KEY, FileStation.SIMPLIFY_KEY;
+// bind methods to BaseSynologyApi instance
+function methodsBundler(instance, methods) {
+    const output = {};
+    for (const key in methods) {
+        output[key] = methods[key].bind(instance);
+    }
+    return output;
+}
+// proxy methods namespace to BaseSynologyApi instance
+Object.defineProperties(BaseSynologyApi.prototype, {
+    // FileStation
+    [SynologyApiKeys.FileStation]: {
+        get() {
+            return methodsBundler(this, FileStation.METHODS);
+        },
+    },
+    [SynologyApiKeys.fs]: {
+        get() {
+            return methodsBundler(this, FileStation.METHODS);
+        },
+    },
+    // AudioStation
+    [SynologyApiKeys.AudioStation]: {
+        get() {
+            return methodsBundler(this, AudioStation.METHODS);
+        },
+    },
+    [SynologyApiKeys.as]: {
+        get() {
+            return methodsBundler(this, AudioStation.METHODS);
+        },
+    },
+});

package/lib/types/cli/apis.d.ts

@@ -0,0 +1,6 @@
+export type MethodOptions = {
+    params?: string;
+    pretty?: boolean;
+};
+export declare const onMethodsCall: (module: string) => (method: string, options: MethodOptions) => Promise<never>;
+export declare const apiCmdRegister: () => void;

package/lib/types/cli/config.d.ts

@@ -0,0 +1,13 @@
+export type ConfigEntry = {
+    server: string;
+    username: string;
+    password: string;
+};
+export type Config = {
+    used: string;
+    connections: Record<string, ConfigEntry>;
+};
+export declare const loadConfig: () => Promise<Config>;
+export declare const updateConfig: (config: Config) => Promise<void>;
+export declare const checkConfig: () => Promise<void>;
+export declare const configCmdRegister: () => void;

package/lib/types/cli/helper.d.ts

@@ -0,0 +1,4 @@
+export declare function printMessages(messages: string[]): void;
+export declare function isLowerCaseEqual(str1: string, str2: string): boolean;
+export declare function padding(message?: string, before?: number, after?: number): string;
+export declare function geneDashLine(message: string, length: number): string;

package/lib/types/cli/index.d.ts

@@ -0,0 +1 @@
+export declare function loadCli(): Promise<void>;

package/{dist → lib}/types/errorcodes.d.ts

@@ -1,6 +1,7 @@
+import { SynologyApiKeys } from "./modules";
 import { SynologyApiResponse } from "./types";
 export declare const SYNOLOGY_ERROR_CODES: {
-    FileStation: {
+    [SynologyApiKeys.FileStation]: {
         400: string;
         401: string;
         402: string;
@@ -25,7 +26,7 @@ export declare const SYNOLOGY_ERROR_CODES: {
         421: string;
         599: string;
     };
-    AudioStation: {};
+    [SynologyApiKeys.AudioStation]: {};
     COMMON_CODES: {
         0: string;
         100: string;

package/{dist → lib}/types/index.d.ts

@@ -1,4 +1,5 @@
 import { SynologyApi } from "./core";
 export * from "./types";
 export * from "./core";
+export * from "./cli";
 export default SynologyApi;

package/lib/types/modules/AudioStation/index.d.ts

@@ -0,0 +1,7 @@
+import { getSongList } from "./Song";
+export declare const METHODS: {
+    getSongList: typeof getSongList;
+};
+export declare const SPELLING_KEY = "AudioStation";
+export declare const SIMPLIFY_KEY = "as";
+export type TMethods = typeof METHODS;

package/{dist → lib}/types/modules/FileStation/index.d.ts

@@ -3,9 +3,11 @@
  */
 import { getInfo } from "./Info";
 import { getFileList, getFileListShare } from "./List";
-export declare const FileStationMethods: {
+export declare const METHODS: {
     getInfo: typeof getInfo;
     getFileList: typeof getFileList;
     getFileListShare: typeof getFileListShare;
 };
-export declare const FileStationKey = "FileStation";
+export declare const SPELLING_KEY = "FileStation";
+export declare const SIMPLIFY_KEY = "fs";
+export type TMethods = typeof METHODS;

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

@@ -0,0 +1,16 @@
+import * as AudioStation from "./AudioStation";
+import * as FileStation from "./FileStation";
+export declare const SynologyApiKeys: {
+    FileStation: string;
+    fs: string;
+    AudioStation: string;
+    as: string;
+};
+export type SynologyApiMethods = FileStation.TMethods | AudioStation.TMethods;
+export declare class BaseSynologyApi {
+    [AudioStation.SPELLING_KEY]: AudioStation.TMethods;
+    [AudioStation.SIMPLIFY_KEY]: AudioStation.TMethods;
+    [FileStation.SPELLING_KEY]: FileStation.TMethods;
+    [FileStation.SIMPLIFY_KEY]: FileStation.TMethods;
+    constructor();
+}

package/package.json

@@ -1,18 +1,23 @@
 {
   "name": "@fett/synology-api",
-  "version": "0.0.1-beta.4",
+  "version": "0.0.1-beta.7",
   "description": "synology api for nodejs",
-  "module": "./dist/esm/index.js",
-  "main": "./dist/cjs/index.js",
-  "types": "./dist/types/index.d.ts",
+  "module": "./lib/esm/index.js",
+  "main": "./lib/cjs/index.js",
+  "types": "./lib/types/index.d.ts",
   "exports": {
     ".": {
-      "require": "./dist/cjs/index.js",
-      "import": "./dist/esm/index.js"
+      "require": "./lib/cjs/index.js",
+      "import": "./lib/esm/index.js"
     }
   },
+  "bin": {
+    "synology": "./bin/syno",
+    "syno": "./bin/syno"
+  },
   "files": [
-    "dist"
+    "lib",
+    "bin"
   ],
   "author": "ChrisSong1994 <https://github.com/ChrisSong1994>",
   "keywords": [
@@ -26,11 +31,12 @@
     "commonjs"
   ],
   "scripts": {
-    "dev": "tsc --sourceMap --watch && tsc-alias",
+    "dev:esm": "tsc --sourceMap --watch && tsc-alias",
+    "dev:cjs": "tsup --config tsup.config.ts --watch --env.NODE_ENV development",
     "build:cjs": "tsup --config tsup.config.ts",
     "build:esm": "tsc  && tsc-alias",
     "build": "npm run clean && npm run build:cjs && npm run build:esm",
-    "clean": "rimraf dist",
+    "clean": "rimraf lib",
     "lint": "eslint src --ext .ts --fix",
     "prettier": "prettier --write 'src/**/*.ts'",
     "format": "npm run prettier && npm run lint",
@@ -43,7 +49,9 @@
   "packageManager": "pnpm@10.8.1",
   "devDependencies": {
     "@eslint/js": "^9.26.0",
+    "cross-env": "^7.0.3",
     "eslint": "9.25.1",
+    "execa": "^9.6.0",
     "globals": "^16.1.0",
     "prettier": "3.5.3",
     "rimraf": "^6.0.1",
@@ -56,6 +64,10 @@
     "vitest": "^3.1.3"
   },
   "dependencies": {
-    "axios": "^1.9.0"
+    "axios": "^1.9.0",
+    "chalk": "^5.4.1",
+    "commander": "^14.0.0",
+    "fs-extra": "^11.3.0",
+    "ora": "^8.2.0"
   }
 }

package/dist/esm/modules/AudioStation/index.js

@@ -1,5 +0,0 @@
-import { getSongList } from "./Song";
-export const AudioStationMethods = {
-    getSongList,
-};
-export const AudioStationKey = "AudioStation";

package/dist/esm/modules/index.js

@@ -1,28 +0,0 @@
-import { AudioStationKey, AudioStationMethods } from "./AudioStation";
-import { FileStationKey, FileStationMethods } from "./FileStation";
-export { AudioStationKey } from "./AudioStation";
-export { FileStationKey } from "./FileStation";
-export class BaseSynologyApi {
-    constructor() { }
-}
-// bind methods to BaseSynologyApi instance
-function methodsBundler(instance, methods) {
-    const output = {};
-    for (const key in methods) {
-        output[key] = methods[key].bind(instance);
-    }
-    return output;
-}
-// proxy methods namespace to BaseSynologyApi instance
-Object.defineProperties(BaseSynologyApi.prototype, {
-    [FileStationKey]: {
-        get() {
-            return methodsBundler(this, FileStationMethods);
-        },
-    },
-    [AudioStationKey]: {
-        get() {
-            return methodsBundler(this, AudioStationMethods);
-        },
-    },
-});

package/dist/types/modules/AudioStation/index.d.ts

@@ -1,5 +0,0 @@
-import { getSongList } from "./Song";
-export declare const AudioStationMethods: {
-    getSongList: typeof getSongList;
-};
-export declare const AudioStationKey = "AudioStation";

package/dist/types/modules/index.d.ts

@@ -1,9 +0,0 @@
-import { AudioStationKey, AudioStationMethods } from "./AudioStation";
-import { FileStationKey, FileStationMethods } from "./FileStation";
-export { AudioStationKey } from "./AudioStation";
-export { FileStationKey } from "./FileStation";
-export declare class BaseSynologyApi {
-    [AudioStationKey]: typeof AudioStationMethods;
-    [FileStationKey]: typeof FileStationMethods;
-    constructor();
-}