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

package/README.md

@@ -1,2 +1,22 @@
 # synology-api
+
 nodejs synology api wrapper
+
+## Usage
+
+```js
+import SynologyApi from '@fett/synology-api';
+
+// Create a new instance
+const synologyApi = new SynologyApi(
+     server: "https:192.168.1.1:5001",
+    username: "admin",
+    password: "password",
+);
+
+// Connect to the server
+await synologyApi.connect();
+
+```
+
+## API

package/dist/constants.d.ts

@@ -1,2 +1,4 @@
 export declare const SYNOLOGY_API_AUTH = "SYNO.API.Auth";
 export declare const SYNOLOGY_API_INFO = "SYNO.API.Info";
+export declare const GLOBAL_QUICK_CONNECT_URL = "https://global.quickconnect.cn/Serv.php";
+export declare const QUICK_CONNECT_PINGPANG_API = "/webman/pingpong.cgi?action=cors&quickconnect=true";

package/dist/constants.js

@@ -1,2 +1,4 @@
 export const SYNOLOGY_API_AUTH = "SYNO.API.Auth";
 export const SYNOLOGY_API_INFO = "SYNO.API.Info";
+export const GLOBAL_QUICK_CONNECT_URL = "https://global.quickconnect.cn/Serv.php";
+export const QUICK_CONNECT_PINGPANG_API = "/webman/pingpong.cgi?action=cors&quickconnect=true";

package/dist/core.d.ts

@@ -27,7 +27,7 @@ export declare class SynologyApi extends BaseSynologyApi {
     constructor(options: SynologyApiOptions);
     connect(): Promise<boolean>;
     disconnect(): Promise<boolean>;
-    _getApiInfo(): Promise<void>;
+    private _getApiInfo;
     hasApi(apiName: string): any;
     run(apiName: string, options: {
         method?: "get" | "post";

package/dist/core.js

@@ -7,9 +7,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+// reference: https://kb.synology.com/zh-tw/DSM/tutorial/What_websites_does_Synology_NAS_connect_to_when_running_services_or_updating_software
 import axios from "axios";
-import { SYNOLOGY_API_AUTH, SYNOLOGY_API_INFO } from "./constants";
 import { BaseSynologyApi } from "./modules";
+import { isHttpUrl } from "./utils";
+import { getServerInfo } from "./helpers";
+import { login, logout, getApiInfo } from "./modules/Api";
 export class SynologyApi extends BaseSynologyApi {
     constructor(options) {
         super();
@@ -23,21 +26,15 @@ export class SynologyApi extends BaseSynologyApi {
     }
     connect() {
         return __awaiter(this, void 0, void 0, function* () {
-            const params = {
-                api: SYNOLOGY_API_AUTH,
-                version: 6,
-                method: "login",
-                account: this.username,
-                passwd: this.password,
-                format: "sid",
-            };
+            // if quickconnect id
+            if (!isHttpUrl(this.server)) {
+                this.server = yield getServerInfo(this.server);
+                // reset base url
+                this.baseUrl = `${this.server}/webapi/`;
+            }
             try {
-                const url = `${this.baseUrl}entry.cgi`;
-                const result = yield axios.get(url, { params });
-                if (!result.data.success) {
-                    throw new Error(result.data.error.message);
-                }
-                this.authInfo = result.data.data;
+                const result = yield login(this);
+                this.authInfo = result.data;
                 this.isConnecting = true;
                 yield this._getApiInfo();
                 return true;
@@ -50,17 +47,8 @@ export class SynologyApi extends BaseSynologyApi {
     }
     disconnect() {
         return __awaiter(this, void 0, void 0, function* () {
-            const params = {
-                api: SYNOLOGY_API_AUTH,
-                version: 6,
-                method: "logout",
-            };
             try {
-                const url = `${this.baseUrl}entry.cgi`;
-                const result = yield axios.get(url, { params });
-                if (!result.data.success) {
-                    throw new Error(result.data.error.message);
-                }
+                yield logout(this);
                 this.authInfo = null;
                 this.apiInfo = {};
                 this.isConnecting = false;
@@ -74,18 +62,9 @@ export class SynologyApi extends BaseSynologyApi {
     }
     _getApiInfo() {
         return __awaiter(this, void 0, void 0, function* () {
-            const params = {
-                api: SYNOLOGY_API_INFO,
-                version: 1,
-                method: "query",
-            };
             try {
-                const url = `${this.baseUrl}entry.cgi`;
-                const result = yield axios.get(url, { params });
-                if (!result.data.success) {
-                    throw new Error(result.data.error.message);
-                }
-                this.apiInfo = result.data.data;
+                const result = yield getApiInfo(this);
+                this.apiInfo = result.data;
             }
             catch (err) {
                 console.error(err);

package/dist/helpers.d.ts

@@ -0,0 +1,2 @@
+export declare const getServerInfo: (quickConnectId: string) => Promise<string>;
+export declare const pingpang: (server: string) => Promise<boolean>;

package/dist/helpers.js

@@ -0,0 +1,80 @@
+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 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;
+    // proxy server
+    if (serverInfo.service.relay_ip) {
+        const server = `http://${serverInfo.service.relay_ip}:${serverInfo.service.relay_port}`;
+        const res = yield pingpang(server);
+        if (res) {
+            return server;
+        }
+    }
+    // WAN IP
+    if (serverInfo.server.external.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 (yield pingpang(server)) {
+            return server;
+        }
+    }
+});
+// get server ip
+export const getServerInfo = (quickConnectId) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c, _d;
+    const params = {
+        version: 1,
+        id: "dsm",
+        serverID: quickConnectId,
+        get_ca_fingerprints: true,
+        command: "get_server_info",
+    };
+    const serverInfo = yield axios.post(GLOBAL_QUICK_CONNECT_URL, params);
+    if (!((_b = (_a = serverInfo.data) === null || _a === void 0 ? void 0 : _a.service) === null || _b === void 0 ? void 0 : _b.relay_ip) && !((_d = (_c = serverInfo.data) === null || _c === void 0 ? void 0 : _c.service) === null || _d === void 0 ? void 0 : _d.relay_port)) {
+        const relayRequestParams = {
+            version: 1,
+            id: "dsm",
+            serverID: quickConnectId,
+            platform: "web",
+            command: "request_tunnel",
+        };
+        const result = yield axios.post(`https://${serverInfo.data.env.control_host}/Serv.php`, relayRequestParams);
+        return getServersFromServerInfo(result.data);
+    }
+    else {
+        return getServersFromServerInfo(serverInfo.data);
+    }
+});
+// pingpang
+export const pingpang = (server) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const result = yield axios.get(`${server}/${QUICK_CONNECT_PINGPANG_API}`, {
+            timeout: 3000,
+        });
+        if (result.data.success) {
+            return true;
+        }
+        else {
+            return false;
+        }
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    }
+    catch (_err) {
+        return false;
+    }
+});

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./core";
 export * from "./modules";
+export { SynologyApi as default } from "./core";

package/dist/index.js

@@ -1,2 +1,3 @@
 export * from "./core";
 export * from "./modules";
+export { SynologyApi as default } from "./core";

package/dist/modules/Api/Auth.d.ts

@@ -0,0 +1,3 @@
+import { SynologyApi } from "../../core";
+export declare function login(core: SynologyApi): Promise<any>;
+export declare function logout(core: SynologyApi): Promise<void>;

package/dist/modules/Api/Auth.js

@@ -0,0 +1,43 @@
+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 axios from "axios";
+import { SYNOLOGY_API_AUTH } from "../../constants";
+export function login(core) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const params = {
+            api: SYNOLOGY_API_AUTH,
+            version: 6,
+            method: "login",
+            account: core.username,
+            passwd: core.password,
+            format: "sid",
+        };
+        const url = `${core.baseUrl}entry.cgi`;
+        const result = yield axios.get(url, { params });
+        if (!result.data.success) {
+            throw new Error(result.data.error.message);
+        }
+        return result.data;
+    });
+}
+export function logout(core) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const params = {
+            api: SYNOLOGY_API_AUTH,
+            version: 6,
+            method: "logout",
+        };
+        const url = `${core.baseUrl}entry.cgi`;
+        const result = yield axios.get(url, { params });
+        if (!result.data.success) {
+            throw new Error(result.data.error.message);
+        }
+    });
+}

package/dist/modules/Api/Info.d.ts

@@ -0,0 +1,2 @@
+import { SynologyApi } from "../../core";
+export declare function getApiInfo(core: SynologyApi): Promise<any>;

package/dist/modules/Api/Info.js

@@ -0,0 +1,26 @@
+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 axios from "axios";
+import { SYNOLOGY_API_INFO } from "../../constants";
+export function getApiInfo(core) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const params = {
+            api: SYNOLOGY_API_INFO,
+            version: 1,
+            method: "query",
+        };
+        const url = `${core.baseUrl}entry.cgi`;
+        const result = yield axios.get(url, { params });
+        if (!result.data.success) {
+            throw new Error(result.data.error.message);
+        }
+        return result.data;
+    });
+}

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

@@ -0,0 +1,2 @@
+export * from "./Auth";
+export * from "./Info";

package/dist/modules/Api/index.js

@@ -0,0 +1,2 @@
+export * from "./Auth";
+export * from "./Info";

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

@@ -0,0 +1,5 @@
+import { AudioStationSongListRequest, AudioStationSongListResponse } from "./types";
+/**
+ * fetch song list
+ * */
+export declare function getSongList(params: AudioStationSongListRequest): Promise<AudioStationSongListResponse>;

package/dist/modules/{AudioStation.js → AudioStation/Song/index.js}

@@ -7,7 +7,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-function getSongList(params) {
+/**
+ * fetch song list
+ * */
+export function getSongList(params) {
     return __awaiter(this, void 0, void 0, function* () {
         const res = yield this.run("SYNO.AudioStation.Song", {
             params: {
@@ -20,7 +23,3 @@ function getSongList(params) {
         return res.data;
     });
 }
-export const AudioStationMethods = {
-    getSongList,
-};
-export const AudioStationProp = "AudioStation";

package/dist/{types/AudioStation.Song.d.ts → modules/AudioStation/Song/types.d.ts}

@@ -1,17 +1,18 @@
+import { SynologyApiResponse } from "../../../types";
 export type AudioStationSongListRequest = {
     limit?: number;
     offset?: number;
-    method?: number;
-    library?: number;
+    method?: string;
+    library?: string;
     additional?: string;
     version?: number;
     sort_by?: string;
     sort_direction?: string;
 };
-export type AudioStationSongListResponse = {
+export type AudioStationSongListResponse = SynologyApiResponse<{
     offset: number;
     total: number;
     songs: {
         [key: string]: any;
     };
-};
+}>;

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

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

package/dist/modules/AudioStation/index.js

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

package/dist/modules/index.d.ts

@@ -1,5 +1,5 @@
-import { AudioStationProp, AudioStationMethods } from "./AudioStation";
+import { AudioStationKey, AudioStationMethods } from "./AudioStation";
 export declare class BaseSynologyApi {
-    [AudioStationProp]: typeof AudioStationMethods;
+    [AudioStationKey]: typeof AudioStationMethods;
     constructor();
 }

package/dist/modules/index.js

@@ -1,15 +1,20 @@
-import { AudioStationProp, AudioStationMethods } from "./AudioStation";
+import { AudioStationKey, AudioStationMethods } from "./AudioStation";
+// bind methods to BaseSynologyApi instance
+function methodsBundler(instance, methods) {
+    const output = {};
+    for (const key in methods) {
+        output[key] = methods[key].bind(instance);
+    }
+    return output;
+}
 export class BaseSynologyApi {
     constructor() { }
 }
-const instanceBindings = new WeakMap();
-Object.defineProperty(BaseSynologyApi.prototype, AudioStationProp, {
-    get() {
-        if (!instanceBindings.has(this)) {
-            instanceBindings.set(this, {
-                getSongList: AudioStationMethods.getSongList.bind(this),
-            });
-        }
-        return instanceBindings.get(this);
+// proxy methods namespace to BaseSynologyApi instance
+Object.defineProperties(BaseSynologyApi.prototype, {
+    [AudioStationKey]: {
+        get() {
+            return methodsBundler(this, AudioStationMethods);
+        },
     },
 });

package/dist/types/API.d.ts

@@ -0,0 +1,9 @@
+export type SynologyApiResponse<T = any> = {
+    data: T;
+    error: {
+        code: number;
+        errors: Record<string, string>;
+        message: string;
+    };
+    success: boolean;
+};

package/dist/types/API.js

@@ -1 +1,2 @@
-// export type 
+// export response
+export {};

package/dist/types/index.d.ts

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

package/dist/types/index.js

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

package/dist/utils.d.ts

@@ -1,2 +1,3 @@
-export declare function isEmpty(obj: Record<string, any>): boolean;
+export declare function isObjEmpty(obj: Record<string, any>): boolean;
 export declare function queryObjToString(params: Record<string, any>): string;
+export declare function isHttpUrl(url: string): boolean;

package/dist/utils.js

@@ -1,11 +1,14 @@
-export function isEmpty(obj) {
-    return Object.keys(obj).length === 0;
+export function isObjEmpty(obj) {
+    return obj && typeof obj === "object" && Object.keys(obj).length === 0;
 }
 export function queryObjToString(params) {
-    if (isEmpty(params)) {
+    if (isObjEmpty(params)) {
         return "";
     }
     return Object.keys(params)
         .map((key) => encodeURIComponent(key) + "=" + encodeURIComponent(params[key]))
         .join("&");
 }
+export function isHttpUrl(url) {
+    return /^https?:\/\//.test(url);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fett/synology-api",
-  "version": "0.0.1-beta.0",
+  "version": "0.0.1-beta.1",
   "description": "synology api for nodejs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -10,6 +10,7 @@
     "synology",
     "api",
     "nodejs",
+    "browser",
     "typescript",
     "esmodule"
   ],
@@ -17,8 +18,8 @@
     "dist"
   ],
   "scripts": {
-    "dev": "tsc --sourceMap --watch",
-    "build": "npm run clean && tsc",
+    "dev": "tsc && tsc-alias  --sourceMap --watch",
+    "build": "npm run clean && tsc && tsc-alias",
     "lint": "eslint src --ext .ts --fix",
     "prettier": "prettier --write 'src/**/*.ts'",
     "format": "npm run prettier && npm run lint",
@@ -37,6 +38,7 @@
     "prettier": "3.5.3",
     "rimraf": "^6.0.1",
     "ts-node": "^10.9.2",
+    "tsc-alias": "^1.8.16",
     "typescript": "~5.8.3",
     "typescript-eslint": "^8.32.0",
     "vite": "^6.3.5",

package/dist/modules/AudioStation.d.ts

@@ -1,7 +0,0 @@
-import { AudioStationSongListRequest, AudioStationSongListResponse } from "../types/AudioStation.Song";
-declare function getSongList(params: AudioStationSongListRequest): Promise<AudioStationSongListResponse>;
-export declare const AudioStationMethods: {
-    getSongList: typeof getSongList;
-};
-export declare const AudioStationProp = "AudioStation";
-export {};