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

package/README.md

@@ -1,4 +1,4 @@
-# synology-api
+# Synology Api
 
 nodejs synology api wrapper
 
@@ -14,9 +14,13 @@ const synologyApi = new SynologyApi(
     password: "password",
 );
 
-// Connect to the server
-await synologyApi.connect();
+// you can now use the api by calling the methods
+const info = await synologyApi.FileStation.getInfo();
 
 ```
 
 ## API
+
+### FileStation
+
+### AudioStation

package/dist/cjs/index.js

@@ -1,6 +1,8 @@
 var __create = Object.create;
 var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getOwnPropSymbols = Object.getOwnPropertySymbols;
 var __getProtoOf = Object.getPrototypeOf;
@@ -18,6 +20,7 @@ var __spreadValues = (a, b) => {
     }
   return a;
 };
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -63,7 +66,10 @@ var __async = (__this, __arguments, generator) => {
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  AudioStationApi: () => AudioStationApi,
+  FileStationApi: () => FileStationApi,
   SynologyApi: () => SynologyApi,
+  SynologyApiInfo: () => SynologyApiInfo,
   default: () => index_default
 });
 module.exports = __toCommonJS(index_exports);
@@ -71,16 +77,49 @@ module.exports = __toCommonJS(index_exports);
 // src/core.ts
 var import_axios4 = __toESM(require("axios"));
 
-// src/modules/AudioStation/Song/index.ts
+// src/types/apiInfo.ts
+var SynologyApiInfo = /* @__PURE__ */ ((SynologyApiInfo2) => {
+  SynologyApiInfo2["Auth"] = "SYNO.API.Auth";
+  SynologyApiInfo2["Info"] = "SYNO.API.Info";
+  SynologyApiInfo2["OTP"] = "SYNO.API.OTP";
+  return SynologyApiInfo2;
+})(SynologyApiInfo || {});
+var AudioStationApi = /* @__PURE__ */ ((AudioStationApi2) => {
+  AudioStationApi2["Song"] = "SYNO.AudioStation.Song";
+  AudioStationApi2["Album"] = "SYNO.AudioStation.Album";
+  AudioStationApi2["Artist"] = "SYNO.AudioStation.Artist";
+  AudioStationApi2["Genre"] = "SYNO.AudioStation.Genre";
+  AudioStationApi2["Playlist"] = "SYNO.AudioStation.Playlist";
+  AudioStationApi2["Folder"] = "SYNO.AudioStation.Folder";
+  AudioStationApi2["Cover"] = "SYNO.AudioStation.Cover";
+  AudioStationApi2["Download"] = "SYNO.AudioStation.Download";
+  AudioStationApi2["Info"] = "SYNO.AudioStation.Info";
+  AudioStationApi2["Lyrics"] = "SYNO.AudioStation.Lyrics";
+  AudioStationApi2["LyricsSearch"] = "SYNO.AudioStation.LyricsSearch";
+  AudioStationApi2["Radio"] = "SYNO.AudioStation.Radio";
+  AudioStationApi2["Stream"] = "SYNO.AudioStation.Stream";
+  AudioStationApi2["Tag"] = "SYNO.AudioStation.Tag";
+  return AudioStationApi2;
+})(AudioStationApi || {});
+var FileStationApi = /* @__PURE__ */ ((FileStationApi2) => {
+  FileStationApi2["File"] = "SYNO.FileStation.File";
+  FileStationApi2["Info"] = "SYNO.FileStation.Info";
+  FileStationApi2["List"] = "SYNO.FileStation.List";
+  FileStationApi2["Quota"] = "SYNO.FileStation.Quota";
+  FileStationApi2["Share"] = "SYNO.FileStation.Share";
+  FileStationApi2["Thumb"] = "SYNO.FileStation.Thumb";
+  FileStationApi2["Upload"] = "SYNO.FileStation.Upload";
+  return FileStationApi2;
+})(FileStationApi || {});
+
+// src/modules/AudioStation/Song.ts
 function getSongList(params) {
   return __async(this, null, function* () {
-    const res = yield this.run("SYNO.AudioStation.Song", {
-      params: {
+    const res = yield this.run("SYNO.AudioStation.Song" /* Song */, {
+      params: __spreadValues({
         method: "list",
-        library: "all",
-        limit: params.limit,
-        offset: params.offset
-      }
+        library: "all"
+      }, params)
     });
     return res.data;
   });
@@ -92,7 +131,75 @@ var AudioStationMethods = {
 };
 var AudioStationKey = "AudioStation";
 
+// src/modules/FileStation/Info.ts
+function getInfo() {
+  return __async(this, null, function* () {
+    const res = yield this.run("SYNO.FileStation.Info" /* Info */, {
+      params: {
+        method: "get"
+      }
+    });
+    return res.data;
+  });
+}
+
+// src/utils.ts
+function isHttpUrl(url) {
+  return /^https?:\/\//.test(url);
+}
+function isUndfined(value) {
+  return value === void 0;
+}
+function getApiKey(apiName) {
+  return apiName.split(".")[1];
+}
+
+// src/modules/FileStation/List.ts
+function getFileList() {
+  return __async(this, arguments, function* (params = {}) {
+    const { additional = ["real_path", "size", "owner", "time"], filetype = "all" } = params;
+    if (isUndfined(params.folder_path)) {
+      throw new Error("folder_path is required");
+    }
+    const res = yield this.run("SYNO.FileStation.List" /* List */, {
+      params: __spreadValues({
+        method: "list",
+        additional: JSON.stringify(additional),
+        filetype,
+        folder_path: params.folder_path
+      }, params)
+    });
+    return res.data;
+  });
+}
+function getFileListShare() {
+  return __async(this, arguments, function* (params = {}) {
+    const { additional = ["real_path", "size", "owner", "time"], onlywritable = false } = params;
+    const res = yield this.run("SYNO.FileStation.List" /* List */, {
+      params: __spreadValues({
+        method: "list_share",
+        additional: JSON.stringify(additional),
+        onlywritable
+      }, params)
+    });
+    return res.data;
+  });
+}
+
+// src/modules/FileStation/index.ts
+var FileStationMethods = {
+  getInfo,
+  getFileList,
+  getFileListShare
+};
+var FileStationKey = "FileStation";
+
 // src/modules/index.ts
+AudioStationKey, FileStationKey;
+var BaseSynologyApi = class {
+  constructor() {
+  }
+};
 function methodsBundler(instance, methods) {
   const output = {};
   for (const key in methods) {
@@ -100,12 +207,12 @@ function methodsBundler(instance, methods) {
   }
   return output;
 }
-AudioStationKey;
-var BaseSynologyApi = class {
-  constructor() {
-  }
-};
 Object.defineProperties(BaseSynologyApi.prototype, {
+  [FileStationKey]: {
+    get() {
+      return methodsBundler(this, FileStationMethods);
+    }
+  },
   [AudioStationKey]: {
     get() {
       return methodsBundler(this, AudioStationMethods);
@@ -113,17 +220,10 @@ Object.defineProperties(BaseSynologyApi.prototype, {
   }
 });
 
-// src/utils.ts
-function isHttpUrl(url) {
-  return /^https?:\/\//.test(url);
-}
-
 // src/helpers.ts
 var import_axios = __toESM(require("axios"));
 
 // src/constants.ts
-var SYNOLOGY_API_AUTH = "SYNO.API.Auth";
-var SYNOLOGY_API_INFO = "SYNO.API.Info";
 var GLOBAL_QUICK_CONNECT_URL = "https://global.quickconnect.cn/Serv.php";
 var QUICK_CONNECT_PINGPANG_API = "/webman/pingpong.cgi?action=cors&quickconnect=true";
 
@@ -197,7 +297,7 @@ var import_axios2 = __toESM(require("axios"));
 function login(core) {
   return __async(this, null, function* () {
     const params = {
-      api: SYNOLOGY_API_AUTH,
+      api: "SYNO.API.Auth" /* Auth */,
       version: 6,
       method: "login",
       account: core.username,
@@ -215,7 +315,7 @@ function login(core) {
 function logout(core) {
   return __async(this, null, function* () {
     const params = {
-      api: SYNOLOGY_API_AUTH,
+      api: "SYNO.API.Auth" /* Auth */,
       version: 6,
       method: "logout"
     };
@@ -232,7 +332,7 @@ var import_axios3 = __toESM(require("axios"));
 function getApiInfo(core) {
   return __async(this, null, function* () {
     const params = {
-      api: SYNOLOGY_API_INFO,
+      api: "SYNO.API.Info" /* Info */,
       version: 1,
       method: "query"
     };
@@ -245,6 +345,106 @@ function getApiInfo(core) {
   });
 }
 
+// src/errorcodes.ts
+var CODE_SUCCESS = 0;
+var CODE_UNKNOWN = 9999;
+var SYNOLOGY_ERROR_CODES = {
+  [FileStationKey]: {
+    400: "Invalid parameter of file operation",
+    401: "Unknown error of file operation",
+    402: "System is too busy",
+    403: "Invalid user does this file operation",
+    404: "Invalid group does this file operation",
+    405: "Invalid user and group does this file operation",
+    406: "Can't get user/group information from the account server",
+    407: "Operation not permitted",
+    408: "No such file or directory",
+    409: "Non-supported file system",
+    410: "Failed to connect internet-based file system (e.g., CIFS)",
+    411: "Read-only file system",
+    412: "Filename too long in the non-encrypted file system",
+    413: "Filename too long in the encrypted file system",
+    414: "File already exists",
+    415: "Disk quota exceeded",
+    416: "No space left on device",
+    417: "Input/output error",
+    418: "Illegal name or path",
+    419: "Illegal file name",
+    420: "Illegal file name on FAT file system",
+    421: "Device or resource busy",
+    599: "No such task of the file operation"
+  },
+  [AudioStationKey]: {},
+  COMMON_CODES: {
+    [CODE_SUCCESS]: "Success",
+    100: "Unknown error",
+    101: "No parameter of API, method or version",
+    102: "The requested API does not exist",
+    103: "The requested method does not exist",
+    104: "The requested version does not support the functionality",
+    105: "The logged in session does not have permission",
+    106: "Session timeout",
+    107: "Session interrupted by duplicated login",
+    108: "Failed to upload the file",
+    109: "The network connection is unstable or the system is busy",
+    110: "The network connection is unstable or the system is busy",
+    111: "The network connection is unstable or the system is busy",
+    112: "Preserve for other purpose",
+    113: "Preserve for other purpose",
+    114: "Lost parameters for this API",
+    115: "Not allowed to upload a file",
+    116: "Not allowed to perform for a demo site",
+    117: "The network connection is unstable or the system is busy",
+    118: "The network connection is unstable or the system is busy",
+    119: "Invalid session / SID not found.",
+    // # 120-149 Preserve for other purpose
+    120: "Preserve for other purpose",
+    121: "Preserve for other purpose",
+    122: "Preserve for other purpose",
+    123: "Preserve for other purpose",
+    124: "Preserve for other purpose",
+    125: "Preserve for other purpose",
+    126: "Preserve for other purpose",
+    127: "Preserve for other purpose",
+    128: "Preserve for other purpose",
+    129: "Preserve for other purpose",
+    130: "Preserve for other purpose",
+    131: "Preserve for other purpose",
+    132: "Preserve for other purpose",
+    133: "Preserve for other purpose",
+    134: "Preserve for other purpose",
+    135: "Preserve for other purpose",
+    136: "Preserve for other purpose",
+    137: "Preserve for other purpose",
+    138: "Preserve for other purpose",
+    139: "Preserve for other purpose",
+    140: "Preserve for other purpose",
+    141: "Preserve for other purpose",
+    142: "Preserve for other purpose",
+    143: "Preserve for other purpose",
+    144: "Preserve for other purpose",
+    145: "Preserve for other purpose",
+    146: "Preserve for other purpose",
+    147: "Preserve for other purpose",
+    148: "Preserve for other purpose",
+    149: "Preserve for other purpose",
+    150: "Request source IP does not match the login IP",
+    160: "Insufficient application privilege",
+    [CODE_UNKNOWN]: "Unknown error"
+  }
+};
+var resWithErrorCode = (apiKey, res) => {
+  var _a, _b;
+  const errorCodes = SYNOLOGY_ERROR_CODES[apiKey];
+  const code = (_a = res == null ? void 0 : res.error) == null ? void 0 : _a.code;
+  if (isUndfined(code)) return res;
+  return __spreadProps(__spreadValues({}, res), {
+    error: __spreadProps(__spreadValues({}, res.error), {
+      message: ((_b = res == null ? void 0 : res.error) == null ? void 0 : _b.message) || (errorCodes == null ? void 0 : errorCodes[code]) || "Unknown error"
+    })
+  });
+};
+
 // src/core.ts
 var SynologyApi = class extends BaseSynologyApi {
   constructor(options) {
@@ -308,7 +508,10 @@ var SynologyApi = class extends BaseSynologyApi {
   run(apiName, options) {
     return __async(this, null, function* () {
       if (!this.isConnecting) {
-        throw new Error("Not connected");
+        const res = yield this.connect();
+        if (!res) {
+          throw new Error("Not connected");
+        }
       }
       if (!this.hasApi(apiName)) {
         throw new Error(`${apiName} not found`);
@@ -328,6 +531,10 @@ var SynologyApi = class extends BaseSynologyApi {
       if (method === "post") {
         result = yield import_axios4.default.post(url, { params: externalParams, data, headers });
       }
+      const apiKey = getApiKey(apiName);
+      if (!isUndfined(apiKey)) {
+        result.data = resWithErrorCode(apiKey, result.data);
+      }
       return result;
     });
   }
@@ -337,5 +544,8 @@ var SynologyApi = class extends BaseSynologyApi {
 var index_default = SynologyApi;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  SynologyApi
+  AudioStationApi,
+  FileStationApi,
+  SynologyApi,
+  SynologyApiInfo
 });

package/dist/esm/constants.js

@@ -1,4 +1,5 @@
-export const SYNOLOGY_API_AUTH = "SYNO.API.Auth";
-export const SYNOLOGY_API_INFO = "SYNO.API.Info";
+/**
+ * synology constants
+*/
 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/esm/core.js

@@ -10,9 +10,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 // 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 { BaseSynologyApi } from "./modules";
-import { isHttpUrl } from "./utils";
+import { isHttpUrl, getApiKey, isUndfined } from "./utils";
 import { getServerInfo } from "./helpers";
 import { login, logout, getApiInfo } from "./modules/Api";
+import { resWithErrorCode } from "./errorcodes";
 export class SynologyApi extends BaseSynologyApi {
     constructor(options) {
         super();
@@ -80,7 +81,10 @@ export class SynologyApi extends BaseSynologyApi {
     run(apiName, options) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!this.isConnecting) {
-                throw new Error("Not connected");
+                const res = yield this.connect();
+                if (!res) {
+                    throw new Error("Not connected");
+                }
             }
             if (!this.hasApi(apiName)) {
                 throw new Error(`${apiName} not found`);
@@ -96,6 +100,11 @@ export class SynologyApi extends BaseSynologyApi {
             if (method === "post") {
                 result = yield axios.post(url, { params: externalParams, data, headers });
             }
+            // match error code msg
+            const apiKey = getApiKey(apiName);
+            if (!isUndfined(apiKey)) {
+                result.data = resWithErrorCode(apiKey, result.data);
+            }
             return result;
         });
     }

package/dist/esm/errorcodes.js

@@ -0,0 +1,97 @@
+import { FileStationKey, AudioStationKey } from "./modules";
+import { isUndfined } from "./utils";
+const CODE_SUCCESS = 0;
+const CODE_UNKNOWN = 9999;
+export const SYNOLOGY_ERROR_CODES = {
+    [FileStationKey]: {
+        400: "Invalid parameter of file operation",
+        401: "Unknown error of file operation",
+        402: "System is too busy",
+        403: "Invalid user does this file operation",
+        404: "Invalid group does this file operation",
+        405: "Invalid user and group does this file operation",
+        406: "Can't get user/group information from the account server",
+        407: "Operation not permitted",
+        408: "No such file or directory",
+        409: "Non-supported file system",
+        410: "Failed to connect internet-based file system (e.g., CIFS)",
+        411: "Read-only file system",
+        412: "Filename too long in the non-encrypted file system",
+        413: "Filename too long in the encrypted file system",
+        414: "File already exists",
+        415: "Disk quota exceeded",
+        416: "No space left on device",
+        417: "Input/output error",
+        418: "Illegal name or path",
+        419: "Illegal file name",
+        420: "Illegal file name on FAT file system",
+        421: "Device or resource busy",
+        599: "No such task of the file operation",
+    },
+    [AudioStationKey]: {},
+    COMMON_CODES: {
+        [CODE_SUCCESS]: "Success",
+        100: "Unknown error",
+        101: "No parameter of API, method or version",
+        102: "The requested API does not exist",
+        103: "The requested method does not exist",
+        104: "The requested version does not support the functionality",
+        105: "The logged in session does not have permission",
+        106: "Session timeout",
+        107: "Session interrupted by duplicated login",
+        108: "Failed to upload the file",
+        109: "The network connection is unstable or the system is busy",
+        110: "The network connection is unstable or the system is busy",
+        111: "The network connection is unstable or the system is busy",
+        112: "Preserve for other purpose",
+        113: "Preserve for other purpose",
+        114: "Lost parameters for this API",
+        115: "Not allowed to upload a file",
+        116: "Not allowed to perform for a demo site",
+        117: "The network connection is unstable or the system is busy",
+        118: "The network connection is unstable or the system is busy",
+        119: "Invalid session / SID not found.",
+        // # 120-149 Preserve for other purpose
+        120: "Preserve for other purpose",
+        121: "Preserve for other purpose",
+        122: "Preserve for other purpose",
+        123: "Preserve for other purpose",
+        124: "Preserve for other purpose",
+        125: "Preserve for other purpose",
+        126: "Preserve for other purpose",
+        127: "Preserve for other purpose",
+        128: "Preserve for other purpose",
+        129: "Preserve for other purpose",
+        130: "Preserve for other purpose",
+        131: "Preserve for other purpose",
+        132: "Preserve for other purpose",
+        133: "Preserve for other purpose",
+        134: "Preserve for other purpose",
+        135: "Preserve for other purpose",
+        136: "Preserve for other purpose",
+        137: "Preserve for other purpose",
+        138: "Preserve for other purpose",
+        139: "Preserve for other purpose",
+        140: "Preserve for other purpose",
+        141: "Preserve for other purpose",
+        142: "Preserve for other purpose",
+        143: "Preserve for other purpose",
+        144: "Preserve for other purpose",
+        145: "Preserve for other purpose",
+        146: "Preserve for other purpose",
+        147: "Preserve for other purpose",
+        148: "Preserve for other purpose",
+        149: "Preserve for other purpose",
+        150: "Request source IP does not match the login IP",
+        160: "Insufficient application privilege",
+        [CODE_UNKNOWN]: "Unknown error",
+    },
+};
+export const resWithErrorCode = (apiKey, res) => {
+    var _a, _b;
+    const errorCodes = SYNOLOGY_ERROR_CODES[apiKey];
+    const code = (_a = res === null || res === void 0 ? void 0 : res.error) === null || _a === void 0 ? void 0 : _a.code;
+    if (isUndfined(code))
+        return res;
+    return Object.assign(Object.assign({}, res), { error: Object.assign(Object.assign({}, res.error), { message: ((_b = res === null || res === void 0 ? void 0 : res.error) === null || _b === void 0 ? void 0 : _b.message) || (errorCodes === null || errorCodes === void 0 ? void 0 : errorCodes[code]) || "Unknown error" }) });
+};

package/dist/esm/index.js

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

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

@@ -8,11 +8,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import axios from "axios";
-import { SYNOLOGY_API_AUTH } from "../../constants";
+import { SynologyApiInfo } from "../../types";
 export function login(core) {
     return __awaiter(this, void 0, void 0, function* () {
         const params = {
-            api: SYNOLOGY_API_AUTH,
+            api: SynologyApiInfo.Auth,
             version: 6,
             method: "login",
             account: core.username,
@@ -30,7 +30,7 @@ export function login(core) {
 export function logout(core) {
     return __awaiter(this, void 0, void 0, function* () {
         const params = {
-            api: SYNOLOGY_API_AUTH,
+            api: SynologyApiInfo.Auth,
             version: 6,
             method: "logout",
         };

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

@@ -8,11 +8,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import axios from "axios";
-import { SYNOLOGY_API_INFO } from "../../constants";
+import { SynologyApiInfo } from "../../types";
 export function getApiInfo(core) {
     return __awaiter(this, void 0, void 0, function* () {
         const params = {
-            api: SYNOLOGY_API_INFO,
+            api: SynologyApiInfo.Info,
             version: 1,
             method: "query",
         };

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

@@ -7,18 +7,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-/**
- * fetch song list
- * */
+import { AudioStationApi } from "../../types";
 export 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,
-            },
+        const res = yield this.run(AudioStationApi.Song, {
+            params: Object.assign({ method: "list", library: "all" }, params),
         });
         return res.data;
     });

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

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

package/dist/esm/modules/FileStation/Info.js

@@ -0,0 +1,20 @@
+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 { FileStationApi } from "../../types";
+export function getInfo() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const res = yield this.run(FileStationApi.Info, {
+            params: {
+                method: "get",
+            },
+        });
+        return res.data;
+    });
+}

package/dist/esm/modules/FileStation/List.js

@@ -0,0 +1,32 @@
+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 { FileStationApi } from "../../types";
+import { isUndfined } from "../../utils";
+export function getFileList() {
+    return __awaiter(this, arguments, void 0, function* (params = {}) {
+        const { additional = ["real_path", "size", "owner", "time"], filetype = "all" } = params;
+        if (isUndfined(params.folder_path)) {
+            throw new Error("folder_path is required");
+        }
+        const res = yield this.run(FileStationApi.List, {
+            params: Object.assign({ method: "list", additional: JSON.stringify(additional), filetype: filetype, folder_path: params.folder_path }, params),
+        });
+        return res.data;
+    });
+}
+export function getFileListShare() {
+    return __awaiter(this, arguments, void 0, function* (params = {}) {
+        const { additional = ["real_path", "size", "owner", "time"], onlywritable = false } = params;
+        const res = yield this.run(FileStationApi.List, {
+            params: Object.assign({ method: "list_share", additional: JSON.stringify(additional), onlywritable: onlywritable }, params),
+        });
+        return res.data;
+    });
+}

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

@@ -0,0 +1,11 @@
+/**
+ * reference :https://global.download.synology.com/download/Document/Software/DeveloperGuide/Package/FileStation/All/enu/Synology_File_Station_API_Guide.pdf
+ */
+import { getInfo } from "./Info";
+import { getFileList, getFileListShare } from "./List";
+export const FileStationMethods = {
+    getInfo,
+    getFileList,
+    getFileListShare,
+};
+export const FileStationKey = "FileStation";

package/dist/esm/modules/index.js

@@ -1,4 +1,10 @@
 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 = {};
@@ -7,11 +13,13 @@ function methodsBundler(instance, methods) {
     }
     return output;
 }
-export class BaseSynologyApi {
-    constructor() { }
-}
 // proxy methods namespace to BaseSynologyApi instance
 Object.defineProperties(BaseSynologyApi.prototype, {
+    [FileStationKey]: {
+        get() {
+            return methodsBundler(this, FileStationMethods);
+        },
+    },
     [AudioStationKey]: {
         get() {
             return methodsBundler(this, AudioStationMethods);

package/dist/esm/types/apiInfo.js

@@ -0,0 +1,42 @@
+/**
+ * api info
+ * */
+export var SynologyApiInfo;
+(function (SynologyApiInfo) {
+    SynologyApiInfo["Auth"] = "SYNO.API.Auth";
+    SynologyApiInfo["Info"] = "SYNO.API.Info";
+    SynologyApiInfo["OTP"] = "SYNO.API.OTP";
+})(SynologyApiInfo || (SynologyApiInfo = {}));
+/**
+ * AudioStation
+ * */
+export var AudioStationApi;
+(function (AudioStationApi) {
+    AudioStationApi["Song"] = "SYNO.AudioStation.Song";
+    AudioStationApi["Album"] = "SYNO.AudioStation.Album";
+    AudioStationApi["Artist"] = "SYNO.AudioStation.Artist";
+    AudioStationApi["Genre"] = "SYNO.AudioStation.Genre";
+    AudioStationApi["Playlist"] = "SYNO.AudioStation.Playlist";
+    AudioStationApi["Folder"] = "SYNO.AudioStation.Folder";
+    AudioStationApi["Cover"] = "SYNO.AudioStation.Cover";
+    AudioStationApi["Download"] = "SYNO.AudioStation.Download";
+    AudioStationApi["Info"] = "SYNO.AudioStation.Info";
+    AudioStationApi["Lyrics"] = "SYNO.AudioStation.Lyrics";
+    AudioStationApi["LyricsSearch"] = "SYNO.AudioStation.LyricsSearch";
+    AudioStationApi["Radio"] = "SYNO.AudioStation.Radio";
+    AudioStationApi["Stream"] = "SYNO.AudioStation.Stream";
+    AudioStationApi["Tag"] = "SYNO.AudioStation.Tag";
+})(AudioStationApi || (AudioStationApi = {}));
+/**
+ * FileStation API
+ */
+export var FileStationApi;
+(function (FileStationApi) {
+    FileStationApi["File"] = "SYNO.FileStation.File";
+    FileStationApi["Info"] = "SYNO.FileStation.Info";
+    FileStationApi["List"] = "SYNO.FileStation.List";
+    FileStationApi["Quota"] = "SYNO.FileStation.Quota";
+    FileStationApi["Share"] = "SYNO.FileStation.Share";
+    FileStationApi["Thumb"] = "SYNO.FileStation.Thumb";
+    FileStationApi["Upload"] = "SYNO.FileStation.Upload";
+})(FileStationApi || (FileStationApi = {}));

package/dist/esm/types/index.js

@@ -1 +1,2 @@
-export * from "./API";
+export * from "./request";
+export * from "./apiInfo";

package/dist/esm/utils.js

@@ -12,3 +12,9 @@ export function queryObjToString(params) {
 export function isHttpUrl(url) {
     return /^https?:\/\//.test(url);
 }
+export function isUndfined(value) {
+    return value === undefined;
+}
+export function getApiKey(apiName) {
+    return apiName.split('.')[1];
+}

package/dist/types/constants.d.ts

@@ -1,4 +1,5 @@
-export declare const SYNOLOGY_API_AUTH = "SYNO.API.Auth";
-export declare const SYNOLOGY_API_INFO = "SYNO.API.Info";
+/**
+ * synology constants
+*/
 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/types/core.d.ts

@@ -4,7 +4,7 @@ export interface SynologyApiOptions {
     username: string;
     password: string;
 }
-export interface SynologyApiInfo {
+export interface SynologyApiInfoData {
     maxVersion: number;
     minVersion: number;
     path: string;

package/dist/types/errorcodes.d.ts

@@ -0,0 +1,93 @@
+import { SynologyApiResponse } from "./types";
+export declare const SYNOLOGY_ERROR_CODES: {
+    FileStation: {
+        400: string;
+        401: string;
+        402: string;
+        403: string;
+        404: string;
+        405: string;
+        406: string;
+        407: string;
+        408: string;
+        409: string;
+        410: string;
+        411: string;
+        412: string;
+        413: string;
+        414: string;
+        415: string;
+        416: string;
+        417: string;
+        418: string;
+        419: string;
+        420: string;
+        421: string;
+        599: string;
+    };
+    AudioStation: {};
+    COMMON_CODES: {
+        0: string;
+        100: string;
+        101: string;
+        102: string;
+        103: string;
+        104: string;
+        105: string;
+        106: string;
+        107: string;
+        108: string;
+        109: string;
+        110: string;
+        111: string;
+        112: string;
+        113: string;
+        114: string;
+        115: string;
+        116: string;
+        117: string;
+        118: string;
+        119: string;
+        120: string;
+        121: string;
+        122: string;
+        123: string;
+        124: string;
+        125: string;
+        126: string;
+        127: string;
+        128: string;
+        129: string;
+        130: string;
+        131: string;
+        132: string;
+        133: string;
+        134: string;
+        135: string;
+        136: string;
+        137: string;
+        138: string;
+        139: string;
+        140: string;
+        141: string;
+        142: string;
+        143: string;
+        144: string;
+        145: string;
+        146: string;
+        147: string;
+        148: string;
+        149: string;
+        150: string;
+        160: string;
+        9999: string;
+    };
+};
+export declare const resWithErrorCode: (apiKey: string, res: SynologyApiResponse<any>) => SynologyApiResponse<any> | {
+    error: {
+        message: any;
+        code: number;
+    };
+    data?: any;
+    success: boolean;
+};

package/dist/types/index.d.ts

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

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

@@ -1,4 +1,7 @@
-import { SynologyApiResponse } from "../../../types";
+import { SynologyApiResponse } from "../../types";
+/**
+ * fetch song list
+ * */
 export type AudioStationSongListRequest = {
     limit?: number;
     offset?: number;
@@ -16,3 +19,4 @@ export type AudioStationSongListResponse = SynologyApiResponse<{
         [key: string]: any;
     };
 }>;
+export declare function getSongList(params: AudioStationSongListRequest): Promise<AudioStationSongListResponse>;

package/dist/types/modules/FileStation/Info.d.ts

@@ -0,0 +1,11 @@
+import { SynologyApiResponse } from "../../types";
+/**
+ * get filestation info
+ */
+export type FileStationInfoResponse = SynologyApiResponse<{
+    is_manager: boolean;
+    support_virtual_protocol: number;
+    support_sharing: boolean;
+    hostname: string;
+}>;
+export declare function getInfo(): Promise<FileStationInfoResponse>;

package/dist/types/modules/FileStation/List.d.ts

@@ -0,0 +1,59 @@
+import { SynologyApiResponse } from "../../types";
+/**
+ * fetch filestation list
+ */
+export type FileStationFileListRequest = {
+    limit?: number;
+    offset?: number;
+    sort_by?: string;
+    sort_direction?: "ASC" | "DESC";
+    version?: number;
+    filetype?: "file" | "dir" | "all";
+    folder_path?: string;
+    additional?: string[];
+};
+export type FileStationFileListItem = {
+    isdir: boolean;
+    name: string;
+    path: string;
+    additional?: {
+        type: string;
+        size: number;
+        time: {
+            atime: number;
+            mtime: number;
+            ctime: number;
+            btime: number;
+        };
+        real_path: string;
+        mount_point_type: string;
+        indexed: boolean;
+        description: Record<string, any>;
+    };
+};
+export type FileStationFileListResponse = SynologyApiResponse<{
+    files: FileStationFileListItem[];
+    offset: number;
+    total: number;
+}>;
+export declare function getFileList(params?: FileStationFileListRequest): Promise<FileStationFileListResponse>;
+/**
+ * fetch file share list
+ * */
+export type FileStationFileShareListRequest = {
+    limit?: number;
+    offset?: number;
+    sort_by?: string;
+    sort_direction?: "ASC" | "DESC";
+    additional?: string[];
+    onlywritable?: boolean;
+};
+export type FileStationFileShareListResponse = SynologyApiResponse<{
+    shares: FileStationFileListItem & {
+        hybridshare_cache_status: number;
+        hybridshare_pin_status: number;
+    }[];
+    offset: number;
+    total: number;
+}>;
+export declare function getFileListShare(params?: FileStationFileShareListRequest): Promise<FileStationFileShareListResponse>;

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

@@ -0,0 +1,11 @@
+/**
+ * reference :https://global.download.synology.com/download/Document/Software/DeveloperGuide/Package/FileStation/All/enu/Synology_File_Station_API_Guide.pdf
+ */
+import { getInfo } from "./Info";
+import { getFileList, getFileListShare } from "./List";
+export declare const FileStationMethods: {
+    getInfo: typeof getInfo;
+    getFileList: typeof getFileList;
+    getFileListShare: typeof getFileListShare;
+};
+export declare const FileStationKey = "FileStation";

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

@@ -1,5 +1,9 @@
 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();
 }

package/dist/types/types/apiInfo.d.ts

@@ -0,0 +1,39 @@
+/**
+ * api info
+ * */
+export declare enum SynologyApiInfo {
+    Auth = "SYNO.API.Auth",
+    Info = "SYNO.API.Info",
+    OTP = "SYNO.API.OTP"
+}
+/**
+ * AudioStation
+ * */
+export declare enum AudioStationApi {
+    Song = "SYNO.AudioStation.Song",
+    Album = "SYNO.AudioStation.Album",
+    Artist = "SYNO.AudioStation.Artist",
+    Genre = "SYNO.AudioStation.Genre",
+    Playlist = "SYNO.AudioStation.Playlist",
+    Folder = "SYNO.AudioStation.Folder",
+    Cover = "SYNO.AudioStation.Cover",
+    Download = "SYNO.AudioStation.Download",
+    Info = "SYNO.AudioStation.Info",
+    Lyrics = "SYNO.AudioStation.Lyrics",
+    LyricsSearch = "SYNO.AudioStation.LyricsSearch",
+    Radio = "SYNO.AudioStation.Radio",
+    Stream = "SYNO.AudioStation.Stream",
+    Tag = "SYNO.AudioStation.Tag"
+}
+/**
+ * FileStation API
+ */
+export declare enum FileStationApi {
+    File = "SYNO.FileStation.File",
+    Info = "SYNO.FileStation.Info",
+    List = "SYNO.FileStation.List",
+    Quota = "SYNO.FileStation.Quota",
+    Share = "SYNO.FileStation.Share",
+    Thumb = "SYNO.FileStation.Thumb",
+    Upload = "SYNO.FileStation.Upload"
+}

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

@@ -1 +1,2 @@
-export * from "./API";
+export * from "./request";
+export * from "./apiInfo";

package/dist/types/types/{API.d.ts → request.d.ts}

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

package/dist/types/utils.d.ts

@@ -1,3 +1,5 @@
 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;
+export declare function isUndfined(value: any): boolean;
+export declare function getApiKey(apiName: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fett/synology-api",
-  "version": "0.0.1-beta.3",
+  "version": "0.0.1-beta.4",
   "description": "synology api for nodejs",
   "module": "./dist/esm/index.js",
   "main": "./dist/cjs/index.js",

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

@@ -1 +0,0 @@
-export {};

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

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