@fett/synology-api 0.0.1 → 0.0.2-beta.1

package/README.md

@@ -1,9 +1,13 @@
-# Synology Api
+<p align="center">
+  <a >
+    <img width="100" src="assets/logo.png">
+  </a>
+</p>
+<h1 align="center">Javascript Synology Api</h1>
 
 ⚠️ The project is under development ...
 
-[中文文档](./README-zh_CN.md)
-Synology Api Node.js wrapper, can be used in Browser、CLI or Nodejs to interact with Synology NAS.
+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.
 All apis from [https://kb.synology.cn](https://kb.synology.cn/zh-cn/search?query=API&services%5B%5D=File_Station)
 
@@ -13,25 +17,10 @@ All apis from [https://kb.synology.cn](https://kb.synology.cn/zh-cn/search?query
 npm install @fett/synology-api
 ```
 
-## Use In Browser
+## Use In Browser or Node.js
 
 First you need to confirm that you can access across domains,for example in the React Native environment
 
-```js
-import { SynologyApi } from "@fett/synology-api/browser";
-// Create a new instance
-const api = new SynologyApi({
-  server: "https://192.168.1.1:5001",
-  username: "username",
-  password: "password",
-});
-// you can now use the api by calling the methods
-const info = await api.fs.getInfo();
-console.log(info);
-```
-
-## Use In Node.js
-
 ```js
 import SynologyApi from '@fett/synology-api';
 
@@ -94,4 +83,5 @@ syno fs getInfo --pretty # print file system info
 ```
 
 ## License
-[MIT](https://github.com/ChrisSong1994/synology-api/blob/main/LICENSE)
+
+[MIT](https://github.com/ChrisSong1994/synology-api/blob/main/LICENSE)

package/lib/cli/apis.d.ts

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

package/lib/cli/apis.js

@@ -1,47 +1,57 @@
 import { program } from "commander";
+import chalk from "chalk";
 import { loadConfig } from "./config.js";
 import { SynologyApi } from "../core.js";
-import { SynologyApiKeys } from "../modules/index.js";
-export const onMethodsCall = (module) => async (method, options) => {
+import { SynologyApiModules, SynologyApiMethods } from "../modules/index.js";
+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 synologyApi = new SynologyApi(config.connections[config.used]);
-    if (synologyApi[module]?.[method]) {
-        const result = await synologyApi[module]?.[method](params);
-        if (pretty) {
-            console.log(JSON.stringify(result, null, 2));
-        }
-        else {
-            console.log(JSON.stringify(result));
-        }
+    const connection = config.connections?.[config.used];
+    if (!connection) {
+        throw new Error("Connection undefined");
+    }
+    if (!SynologyApiMethods[module]) {
+        throw new Error(`Module ${module} not found`);
+    }
+    // list all module methods
+    if (!method && options.list) {
+        const methods = SynologyApiMethods[module];
+        console.log(chalk.greenBright(`${module} methods list:`));
+        return printMessages(Object.keys(methods));
+    }
+    if (!SynologyApiMethods[module]?.[method]) {
+        throw new Error(`Module method ${module} not found`);
+    }
+    if (typeof SynologyApiMethods[module][method] !== "function") {
+        throw new Error(`Module method ${module} is not a function`);
+    }
+    const synologyApi = new SynologyApi(connection);
+    const result = await synologyApi[module]?.[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,
-    },
-    {
-        cmd: SynologyApiKeys.VideoStation,
-        alias: SynologyApiKeys.vs,
-    },
-];
+const apisCmdRegisterInfo = SynologyApiModules.map((module) => ({
+    cmd: module.KEY,
+    alias: module.ALIAS_KEY,
+}));
 export const apiCmdRegister = () => {
     apisCmdRegisterInfo.forEach((info) => {
         program
-            .command(`${info.cmd} [methods]`)
+            .command(`${info.cmd} [method]`)
             .alias(info.alias)
-            .option("-p,--params <params>", `${info.cmd} methods params`)
+            .option("-p,--params <params>", `${info.cmd} method params`)
             .option("--pretty", "Prettyprint JSON Output")
+            .option("-l,--list", `list all ${info.cmd} methods`)
             .description(`Synology ${info.cmd} method call`)
-            .action(onMethodsCall(info.cmd));
+            .action(onMethodCall(info.cmd));
     });
 };

package/lib/cli/config.d.ts

@@ -9,5 +9,4 @@ export type Config = {
 };
 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/cli/config.js

@@ -23,8 +23,6 @@ export const loadConfig = async () => {
 export const updateConfig = async (config) => {
     await fse.writeJSON(CONFIG_FILE_PATH, config);
 };
-// check config
-export const checkConfig = async () => { };
 export const configCmdRegister = () => {
     const configCmd = program.command("config").description("synology api config management");
     // list connection config
@@ -51,7 +49,7 @@ export const configCmdRegister = () => {
     });
     // add connection
     configCmd
-        .command("add [name]")
+        .command("add <name>")
         .description("Add connection config")
         .requiredOption("-s, --server <server>", "Synology server domain  or QuickConnect ID ")
         .requiredOption("-u, --username <username>", "username")
@@ -62,7 +60,7 @@ export const configCmdRegister = () => {
         // 实际代码中应保存配置到文件
         const config = await loadConfig();
         const newConfig = {
-            ...config,
+            used: config.used || name,
             connections: {
                 ...config.connections,
                 [name]: {
@@ -76,7 +74,7 @@ export const configCmdRegister = () => {
     });
     // use  connection
     configCmd
-        .command("use [name]")
+        .command("use <name>")
         .description("Change current connection")
         .action(async (name) => {
         const config = await loadConfig();
@@ -91,7 +89,7 @@ export const configCmdRegister = () => {
     });
     // del connection
     configCmd
-        .command("del [name]")
+        .command("del <name>")
         .description("Remove a connection")
         .action(async (name) => {
         console.log("Remove a connection", name);

package/lib/decorators/bindMethods.d.ts

@@ -0,0 +1,5 @@
+/**
+ * bind methods to BaseSynologyApi prototype
+ * @param source
+ */
+export declare function BindMethods<T extends object>(source: T): ClassDecorator;

package/lib/decorators/bindMethods.js

@@ -1,45 +1,29 @@
-// export type Method = (...args: any[]) => Promise<any>;
-// type MethodKeys<T> = {
-//   [K in keyof T]: {
-//     [M in keyof T[K]]: Method;
-//   };
-// }[keyof T];
-// /**
-//  * 将源对象的方法绑定到目标类的原型上，并确保方法的 this 指向类实例
-//  * @param source 包含要绑定方法的对象
-//  */
-// export function BindMethods<T extends object>(source: T): ClassDecorator {
-//   return function (target: { prototype: any }) {
-//     // 获取源对象的所有方法键
-//     const methodKeys = Object.getOwnPropertyNames(source).filter(
-//       (key): key is MethodKeys<T> => typeof source[key] === "function"
-//     );
-//     // 为每个方法创建绑定版本并定义到原型上
-//     methodKeys.forEach((methodName) => {
-//       const originalMethod = source[methodName] as Function;
-//       // 创建绑定方法的描述符
-//       const descriptor: PropertyDescriptor = {
-//         configurable: true,
-//         enumerable: false, // 使方法不可枚举
-//         // 使用 getter 确保每个实例都有自己的绑定函数
-//         get() {
-//           // 跳过原型访问，直接返回原始方法
-//           if (this === target.prototype || this === undefined) {
-//             return originalMethod;
-//           }
-//           // 为实例创建绑定方法并缓存
-//           const boundMethod = originalMethod.bind(this);
-//           Object.defineProperty(this, methodName, {
-//             value: boundMethod,
-//             configurable: true,
-//             writable: true,
-//             enumerable: false,
-//           });
-//           return boundMethod;
-//         },
-//       };
-//       // 将绑定方法定义到类原型上
-//       Object.defineProperty(target.prototype, methodName, descriptor);
-//     });
-//   };
-// }
+// bind methods to  context
+function methodsBundler(cxt, methods) {
+    const output = {};
+    for (const key in methods) {
+        output[key] = methods[key].bind(cxt);
+    }
+    return output;
+}
+/**
+ * bind methods to BaseSynologyApi prototype
+ * @param source
+ */
+export function BindMethods(source) {
+    return function (target) {
+        const modulesKeys = Object.getOwnPropertyNames(source);
+        modulesKeys.forEach((moduleName) => {
+            const methods = source[moduleName];
+            const descriptor = {
+                configurable: false,
+                enumerable: true,
+                get() {
+                    return methodsBundler(this, methods);
+                },
+                set() { },
+            };
+            Object.defineProperty(target.prototype, moduleName, descriptor);
+        });
+    };
+}

package/lib/decorators/index.d.ts

@@ -0,0 +1 @@
+export * from "./bindMethods.js";

package/lib/decorators/index.js

@@ -0,0 +1 @@
+export * from "./bindMethods.js";

package/lib/helpers.js

@@ -1,10 +1,20 @@
 import ky from "ky";
 import { GLOBAL_QUICK_CONNECT_URL, QUICK_CONNECT_PINGPANG_API } from "./constants.js";
 const getServersFromServerInfo = async (serverInfo) => {
+    // first lan ip
+    // lan ip
+    if (serverInfo?.server?.interface?.[0]) {
+        const server = `http://${serverInfo.server.interface?.[0].ip}:${serverInfo.service.port}`;
+        const res = await pingpang(server);
+        if (res) {
+            return server;
+        }
+    }
     // WAN IP
     if (serverInfo?.server?.external?.ip) {
         const server = `http://${serverInfo.server.external.ip}:${serverInfo.service.port}`;
-        if (await pingpang(server)) {
+        const res = await pingpang(server);
+        if (res) {
             return server;
         }
     }
@@ -16,13 +26,6 @@ const getServersFromServerInfo = async (serverInfo) => {
             return server;
         }
     }
-    // lan ip
-    if (serverInfo?.server?.interface?.[0]) {
-        const server = `http://${serverInfo.server.interface?.[0].ip}:${serverInfo.service.port}`;
-        if (await pingpang(server)) {
-            return server;
-        }
-    }
 };
 export const getServerInfo = async (quickConnectId) => {
     const params = {

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

@@ -18,6 +18,6 @@ export declare const METHODS: {
     searchLyrics: typeof searchLyrics;
     getInfo: typeof getInfo;
 };
-export declare const SPELLING_KEY = "AudioStation";
-export declare const SIMPLIFY_KEY = "as";
+export declare const KEY = "AudioStation";
+export declare const ALIAS_KEY = "as";
 export type TMethods = typeof METHODS;

package/lib/modules/AudioStation/index.js

@@ -19,5 +19,5 @@ export const METHODS = {
     getInfo,
 };
 // name space
-export const SPELLING_KEY = "AudioStation";
-export const SIMPLIFY_KEY = "as";
+export const KEY = "AudioStation";
+export const ALIAS_KEY = "as";

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

@@ -2,6 +2,6 @@ import { getAuthKeyGrant } from "./AuthKey.js";
 export declare const METHODS: {
     getAuthKeyGrant: typeof getAuthKeyGrant;
 };
-export declare const SPELLING_KEY = "Auth";
-export declare const SIMPLIFY_KEY = "au";
+export declare const KEY = "Auth";
+export declare const ALIAS_KEY = "au";
 export type TMethods = typeof METHODS;

package/lib/modules/Auth/index.js

@@ -4,5 +4,5 @@ export const METHODS = {
     getAuthKeyGrant,
 };
 // name space
-export const SPELLING_KEY = "Auth";
-export const SIMPLIFY_KEY = "au";
+export const KEY = "Auth";
+export const ALIAS_KEY = "au";

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

@@ -8,6 +8,6 @@ export declare const METHODS: {
     getFileList: typeof getFileList;
     getFileListShare: typeof getFileListShare;
 };
-export declare const SPELLING_KEY = "FileStation";
-export declare const SIMPLIFY_KEY = "fs";
+export declare const KEY = "FileStation";
+export declare const ALIAS_KEY = "fs";
 export type TMethods = typeof METHODS;

package/lib/modules/FileStation/index.js

@@ -10,5 +10,5 @@ export const METHODS = {
     getFileListShare,
 };
 // name space
-export const SPELLING_KEY = "FileStation";
-export const SIMPLIFY_KEY = "fs";
+export const KEY = "FileStation";
+export const ALIAS_KEY = "fs";

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

@@ -10,6 +10,6 @@ export declare const METHODS: {
     getMoiveInfo: typeof getMoiveInfo;
     getStreamId: typeof getStreamId;
 };
-export declare const SPELLING_KEY = "VideoStation";
-export declare const SIMPLIFY_KEY = "vs";
+export declare const KEY = "VideoStation";
+export declare const ALIAS_KEY = "vs";
 export type TMethods = typeof METHODS;

package/lib/modules/VideoStation/index.js

@@ -12,5 +12,5 @@ export const METHODS = {
     getStreamId,
 };
 // name space
-export const SPELLING_KEY = "VideoStation";
-export const SIMPLIFY_KEY = "vs";
+export const KEY = "VideoStation";
+export const ALIAS_KEY = "vs";

package/lib/modules/index.d.ts

@@ -2,6 +2,7 @@ import * as AudioStation from "./AudioStation/index.js";
 import * as FileStation from "./FileStation/index.js";
 import * as VideoStation from "./VideoStation/index.js";
 import * as Auth from "./Auth/index.js";
+export declare const SynologyApiModules: (typeof AudioStation | typeof FileStation | typeof VideoStation | typeof Auth)[];
 export declare const SynologyApiKeys: {
     FileStation: string;
     fs: string;
@@ -12,15 +13,15 @@ export declare const SynologyApiKeys: {
     Auth: string;
     au: string;
 };
-export type SynologyApiMethods = FileStation.TMethods | AudioStation.TMethods | VideoStation.TMethods | Auth.TMethods;
+export declare const SynologyApiMethods: {};
 export declare class BaseSynologyApi {
-    [AudioStation.SPELLING_KEY]: AudioStation.TMethods;
-    [AudioStation.SIMPLIFY_KEY]: AudioStation.TMethods;
-    [FileStation.SPELLING_KEY]: FileStation.TMethods;
-    [FileStation.SIMPLIFY_KEY]: FileStation.TMethods;
-    [VideoStation.SPELLING_KEY]: VideoStation.TMethods;
-    [VideoStation.SIMPLIFY_KEY]: VideoStation.TMethods;
-    [Auth.SPELLING_KEY]: Auth.TMethods;
-    [Auth.SIMPLIFY_KEY]: Auth.TMethods;
+    [AudioStation.KEY]: AudioStation.TMethods;
+    [AudioStation.ALIAS_KEY]: AudioStation.TMethods;
+    [FileStation.KEY]: FileStation.TMethods;
+    [FileStation.ALIAS_KEY]: FileStation.TMethods;
+    [VideoStation.KEY]: VideoStation.TMethods;
+    [VideoStation.ALIAS_KEY]: VideoStation.TMethods;
+    [Auth.KEY]: Auth.TMethods;
+    [Auth.ALIAS_KEY]: Auth.TMethods;
     constructor();
 }

package/lib/modules/index.js

@@ -1,74 +1,75 @@
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
 import * as AudioStation from "./AudioStation/index.js";
 import * as FileStation from "./FileStation/index.js";
 import * as VideoStation from "./VideoStation/index.js";
 import * as Auth from "./Auth/index.js";
+import { BindMethods } from "../decorators/index.js";
+export const SynologyApiModules = [FileStation, AudioStation, VideoStation, Auth];
 export const SynologyApiKeys = {
-    FileStation: FileStation.SPELLING_KEY,
-    fs: FileStation.SIMPLIFY_KEY,
-    AudioStation: AudioStation.SPELLING_KEY,
-    as: AudioStation.SIMPLIFY_KEY,
-    VideoStation: VideoStation.SPELLING_KEY,
-    vs: VideoStation.SIMPLIFY_KEY,
-    Auth: Auth.SPELLING_KEY,
-    au: Auth.SIMPLIFY_KEY,
+    FileStation: FileStation.KEY,
+    fs: FileStation.ALIAS_KEY,
+    AudioStation: AudioStation.KEY,
+    as: AudioStation.ALIAS_KEY,
+    VideoStation: VideoStation.KEY,
+    vs: VideoStation.ALIAS_KEY,
+    Auth: Auth.KEY,
+    au: Auth.ALIAS_KEY,
 };
-// export type BaseSynologyApiKeyMethods = FileStation.IKeyMethods
-export class BaseSynologyApi {
-    static { AudioStation.SPELLING_KEY, AudioStation.SIMPLIFY_KEY, FileStation.SPELLING_KEY, FileStation.SIMPLIFY_KEY, VideoStation.SPELLING_KEY, VideoStation.SIMPLIFY_KEY, Auth.SPELLING_KEY, Auth.SIMPLIFY_KEY; }
-    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, {
-    // 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);
-        },
-    },
-    // VideoStation
-    [SynologyApiKeys.VideoStation]: {
-        get() {
-            return methodsBundler(this, VideoStation.METHODS);
-        },
-    },
-    [SynologyApiKeys.vs]: {
-        get() {
-            return methodsBundler(this, VideoStation.METHODS);
-        },
-    },
-    // Auth
-    [SynologyApiKeys.Auth]: {
-        get() {
-            return methodsBundler(this, Auth.METHODS);
-        },
-    },
-    [SynologyApiKeys.au]: {
-        get() {
-            return methodsBundler(this, Auth.METHODS);
-        },
-    },
-});
+export const SynologyApiMethods = SynologyApiModules.reduce((acc, module) => {
+    acc[module.KEY] = module.METHODS;
+    acc[module.ALIAS_KEY] = module.METHODS;
+    return acc;
+}, {});
+let BaseSynologyApi = (() => {
+    let _classDecorators = [BindMethods(SynologyApiMethods)];
+    let _classDescriptor;
+    let _classExtraInitializers = [];
+    let _classThis;
+    var BaseSynologyApi = class {
+        static { _classThis = this; }
+        static { AudioStation.KEY, AudioStation.ALIAS_KEY, FileStation.KEY, FileStation.ALIAS_KEY, VideoStation.KEY, VideoStation.ALIAS_KEY, Auth.KEY, Auth.ALIAS_KEY; }
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
+            __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
+            BaseSynologyApi = _classThis = _classDescriptor.value;
+            if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+            __runInitializers(_classThis, _classExtraInitializers);
+        }
+        constructor() { }
+    };
+    return BaseSynologyApi = _classThis;
+})();
+export { BaseSynologyApi };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fett/synology-api",
-  "version": "0.0.1",
+  "version": "0.0.2-beta.1",
   "description": "synology api for nodejs",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -28,11 +28,14 @@
     "nodejs",
     "browser",
     "typescript",
-    "esmodule"
+    "esmodule",
+    "cli",
+    "vitest"
   ],
   "scripts": {
-    "dev:esm": "tsc --sourceMap --watch && tsc-alias",
+    "dev": "npm run clean && concurrently --kill-others \"tsc --sourceMap -w\" \"tsc-alias -w\"",
     "build": "npm run clean && tsc  && tsc-alias",
+    "build:dev": "cross-env NODE_ENV=development npm run build",
     "docs:dev": "rspress dev",
     "docs:build": "cross-env BASE_PATH=/synology-api/ rspress build",
     "docs:preview": "rspress preview",
@@ -48,6 +51,7 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.26.0",
+    "concurrently": "^9.2.0",
     "cross-env": "^7.0.3",
     "eslint": "9.25.1",
     "execa": "^9.6.0",