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

package/dist/cjs/constants.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QUICK_CONNECT_PINGPANG_API = exports.GLOBAL_QUICK_CONNECT_URL = exports.SYNOLOGY_API_INFO = exports.SYNOLOGY_API_AUTH = void 0;
+exports.SYNOLOGY_API_AUTH = "SYNO.API.Auth";
+exports.SYNOLOGY_API_INFO = "SYNO.API.Info";
+exports.GLOBAL_QUICK_CONNECT_URL = "https://global.quickconnect.cn/Serv.php";
+exports.QUICK_CONNECT_PINGPANG_API = "/webman/pingpong.cgi?action=cors&quickconnect=true";

package/dist/cjs/core.js

@@ -0,0 +1,109 @@
+"use strict";
+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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SynologyApi = void 0;
+// reference: https://kb.synology.com/zh-tw/DSM/tutorial/What_websites_does_Synology_NAS_connect_to_when_running_services_or_updating_software
+const axios_1 = __importDefault(require("axios"));
+const modules_1 = require("./modules");
+const utils_1 = require("./utils");
+const helpers_1 = require("./helpers");
+const Api_1 = require("./modules/Api");
+class SynologyApi extends modules_1.BaseSynologyApi {
+    constructor(options) {
+        super();
+        this.isConnecting = false;
+        this.authInfo = null;
+        this.apiInfo = {};
+        this.server = options.server;
+        this.username = options.username;
+        this.password = options.password;
+        this.baseUrl = `${this.server}/webapi/`;
+    }
+    connect() {
+        return __awaiter(this, void 0, void 0, function* () {
+            // if quickconnect id
+            if (!(0, utils_1.isHttpUrl)(this.server)) {
+                this.server = yield (0, helpers_1.getServerInfo)(this.server);
+                // reset base url
+                this.baseUrl = `${this.server}/webapi/`;
+            }
+            try {
+                const result = yield (0, Api_1.login)(this);
+                this.authInfo = result.data;
+                this.isConnecting = true;
+                yield this._getApiInfo();
+                return true;
+            }
+            catch (err) {
+                console.error(err);
+                return false;
+            }
+        });
+    }
+    disconnect() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield (0, Api_1.logout)(this);
+                this.authInfo = null;
+                this.apiInfo = {};
+                this.isConnecting = false;
+                return true;
+            }
+            catch (err) {
+                console.error(err);
+                return false;
+            }
+        });
+    }
+    _getApiInfo() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const result = yield (0, Api_1.getApiInfo)(this);
+                this.apiInfo = result.data;
+            }
+            catch (err) {
+                console.error(err);
+            }
+        });
+    }
+    hasApi(apiName) {
+        if (!this.isConnecting) {
+            throw new Error("Not connected");
+        }
+        return Object.prototype.hasOwnProperty.call(this.apiInfo, apiName);
+    }
+    run(apiName, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.isConnecting) {
+                throw new Error("Not connected");
+            }
+            if (!this.hasApi(apiName)) {
+                throw new Error(`${apiName} not found`);
+            }
+            const { method = "get", params, data, headers } = options;
+            const api = this.apiInfo[apiName];
+            const url = `${this.baseUrl}${api.path}`;
+            const externalParams = Object.assign({ api: apiName, version: api.maxVersion, _sid: this.authInfo.sid }, params);
+            let result = null;
+            if (method === "get") {
+                result = yield axios_1.default.get(url, { params: externalParams, data, headers });
+            }
+            if (method === "post") {
+                result = yield axios_1.default.post(url, { params: externalParams, data, headers });
+            }
+            return result;
+        });
+    }
+}
+exports.SynologyApi = SynologyApi;

package/dist/cjs/helpers.js

@@ -0,0 +1,88 @@
+"use strict";
+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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pingpang = exports.getServerInfo = void 0;
+const axios_1 = __importDefault(require("axios"));
+const constants_1 = require("./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 (0, exports.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 (0, exports.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 (0, exports.pingpang)(server)) {
+            return server;
+        }
+    }
+});
+// get server ip
+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_1.default.post(constants_1.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_1.default.post(`https://${serverInfo.data.env.control_host}/Serv.php`, relayRequestParams);
+        return getServersFromServerInfo(result.data);
+    }
+    else {
+        return getServersFromServerInfo(serverInfo.data);
+    }
+});
+exports.getServerInfo = getServerInfo;
+// pingpang
+const pingpang = (server) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const result = yield axios_1.default.get(`${server}/${constants_1.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;
+    }
+});
+exports.pingpang = pingpang;

package/dist/cjs/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("./core");
+__exportStar(require("./core"), exports);
+exports.default = core_1.SynologyApi;

package/dist/cjs/modules/Api/Auth.js

@@ -0,0 +1,50 @@
+"use strict";
+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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.login = login;
+exports.logout = logout;
+const axios_1 = __importDefault(require("axios"));
+const constants_1 = require("@/constants");
+function login(core) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const params = {
+            api: constants_1.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_1.default.get(url, { params });
+        if (!result.data.success) {
+            throw new Error(result.data.error.message);
+        }
+        return result.data;
+    });
+}
+function logout(core) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const params = {
+            api: constants_1.SYNOLOGY_API_AUTH,
+            version: 6,
+            method: "logout",
+        };
+        const url = `${core.baseUrl}entry.cgi`;
+        const result = yield axios_1.default.get(url, { params });
+        if (!result.data.success) {
+            throw new Error(result.data.error.message);
+        }
+    });
+}

package/dist/cjs/modules/Api/Info.js

@@ -0,0 +1,32 @@
+"use strict";
+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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getApiInfo = getApiInfo;
+const axios_1 = __importDefault(require("axios"));
+const constants_1 = require("@/constants");
+function getApiInfo(core) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const params = {
+            api: constants_1.SYNOLOGY_API_INFO,
+            version: 1,
+            method: "query",
+        };
+        const url = `${core.baseUrl}entry.cgi`;
+        const result = yield axios_1.default.get(url, { params });
+        if (!result.data.success) {
+            throw new Error(result.data.error.message);
+        }
+        return result.data;
+    });
+}

package/dist/cjs/modules/Api/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Auth"), exports);
+__exportStar(require("./Info"), exports);

package/dist/cjs/modules/AudioStation/Song/index.js

@@ -0,0 +1,28 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSongList = getSongList;
+/**
+ * fetch song list
+ * */
+function getSongList(params) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const res = yield this.run("SYNO.AudioStation.Song", {
+            params: {
+                method: "list",
+                library: "all",
+                limit: params.limit,
+                offset: params.offset,
+            },
+        });
+        return res.data;
+    });
+}

package/dist/cjs/modules/AudioStation/Song/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AudioStationKey = exports.AudioStationMethods = void 0;
+const Song_1 = require("./Song");
+exports.AudioStationMethods = {
+    getSongList: Song_1.getSongList,
+};
+exports.AudioStationKey = "AudioStation";

package/dist/cjs/modules/index.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseSynologyApi = void 0;
+const AudioStation_1 = require("./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;
+}
+class BaseSynologyApi {
+    constructor() { }
+}
+exports.BaseSynologyApi = BaseSynologyApi;
+// proxy methods namespace to BaseSynologyApi instance
+Object.defineProperties(BaseSynologyApi.prototype, {
+    [AudioStation_1.AudioStationKey]: {
+        get() {
+            return methodsBundler(this, AudioStation_1.AudioStationMethods);
+        },
+    },
+});

package/dist/cjs/types/API.js

@@ -0,0 +1,3 @@
+"use strict";
+// export response
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/types/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./API"), exports);

package/dist/cjs/utils.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isObjEmpty = isObjEmpty;
+exports.queryObjToString = queryObjToString;
+exports.isHttpUrl = isHttpUrl;
+function isObjEmpty(obj) {
+    return obj && typeof obj === "object" && Object.keys(obj).length === 0;
+}
+function queryObjToString(params) {
+    if (isObjEmpty(params)) {
+        return "";
+    }
+    return Object.keys(params)
+        .map((key) => encodeURIComponent(key) + "=" + encodeURIComponent(params[key]))
+        .join("&");
+}
+function isHttpUrl(url) {
+    return /^https?:\/\//.test(url);
+}

package/dist/esm/index.js

@@ -0,0 +1,3 @@
+import { SynologyApi } from "./core";
+export * from "./core";
+export default SynologyApi;

package/dist/types/index.d.ts

@@ -1 +1,3 @@
-export * from "./API";
+import { SynologyApi } from "./core";
+export * from "./core";
+export default SynologyApi;

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

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

package/package.json

@@ -1,10 +1,20 @@
 {
   "name": "@fett/synology-api",
-  "version": "0.0.1-beta.1",
+  "version": "0.0.1-beta.2",
   "description": "synology api for nodejs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "module": "./dist/esm/index.js",
+  "main": "./dist/cjs/index.js",
+  "types": "./dist/types/index.d.ts",
   "type": "module",
+  "exports": {
+    ".": {
+      "require": "./dist/cjs/index.js",
+      "import": "./dist/esm/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
   "author": "ChrisSong1994 <https://github.com/ChrisSong1994>",
   "keywords": [
     "synology",
@@ -12,22 +22,23 @@
     "nodejs",
     "browser",
     "typescript",
-    "esmodule"
-  ],
-  "files": [
-    "dist"
+    "esmodule",
+    "cjs",
+    "commonjs"
   ],
   "scripts": {
-    "dev": "tsc && tsc-alias  --sourceMap --watch",
-    "build": "npm run clean && tsc && tsc-alias",
+    "dev": "tsc --sourceMap --watch && tsc-alias",
+    "build:cjs": "tsc --module commonjs --outDir dist/cjs && tsc-alias",
+    "build:esm": "tsc --module esnext --outDir dist/esm && tsc-alias",
+    "build": "npm run clean && npm run build:cjs && npm run build:esm",
+    "clean": "rimraf dist",
     "lint": "eslint src --ext .ts --fix",
     "prettier": "prettier --write 'src/**/*.ts'",
     "format": "npm run prettier && npm run lint",
     "prepublish": "npm run build",
     "pub": "npm publish --access=public",
     "test": "vitest",
-    "coverage": "vitest run --coverage",
-    "clean": "rimraf dist"
+    "coverage": "vitest run --coverage"
   },
   "license": "ISC",
   "packageManager": "pnpm@10.8.1",

package/dist/index.d.ts

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

package/dist/index.js

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