@fett/synology-api 0.1.2 → 0.1.3

package/lib/core.js

@@ -103,10 +103,8 @@ export class SynologyApi extends BaseModuleSynologyApi {
                 "x-syno-token": this.authInfo.synotoken,
             },
             data: options.data ?? null,
+            responseType: options.responseType ?? "json",
         };
-        if (options.responseType) {
-            requestOptions.responseType = options.responseType;
-        }
         // https agent for node
         if (isNode) {
             if (this.agent?.https) {
@@ -126,7 +124,7 @@ export class SynologyApi extends BaseModuleSynologyApi {
         const apiKey = getApiKey(apiName);
         try {
             let result = (await Axios(requestOptions)).data;
-            if (!isUndfined(apiKey)) {
+            if (!isUndfined(apiKey) && options.responseType === "json") {
                 result = resWithErrorCode(apiKey, result);
             }
             return result;

package/lib/errorcodes.d.ts

@@ -99,12 +99,4 @@ export declare const SYNOLOGY_ERROR_CODES: {
         9999: string;
     };
 };
-export declare const resWithErrorCode: (apiKey: string, res: SynologyApiResponse<any>) => SynologyApiResponse<any> | {
-    error: {
-        reason: any;
-        code: number;
-        message?: string;
-    };
-    data?: any;
-    success: boolean;
-};
+export declare const resWithErrorCode: (apiKey: string, res: SynologyApiResponse<any> | any) => any;

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

@@ -1,5 +1,8 @@
+import { AxiosRequestConfig } from "axios";
 export type DownloadFileParams = {
     path: string;
+    mode?: "download" | "open";
+    responseType?: AxiosRequestConfig["responseType"];
 };
-export type DownloadFileResponse = Buffer;
-export declare function getDownload(params: DownloadFileParams): Promise<DownloadFileResponse>;
+export type DownloadFileResponse = DownloadFileParams["responseType"];
+export declare function getDownloadFile(params: DownloadFileParams): Promise<DownloadFileResponse>;

package/lib/modules/FileStation/Download.js

@@ -1,35 +1,13 @@
 import { FileStationApi } from "../../types/index.js";
-import { isNode } from "../../utils/index.js";
-export async function getDownload(params) {
-    const { path } = params;
+export async function getDownloadFile(params) {
+    const { path, mode = "download", responseType } = params;
     const res = await this.run(FileStationApi.Download, {
-        responseType: "arraybuffer",
         params: {
             path,
-            mode: "download",
+            mode,
+            method: "download",
         },
+        responseType,
     });
-    return isNode ? Buffer.from(res) : res;
+    return res;
 }
-// export async function getFileOpenUrl(params: DownloadFileParams): Promise<{
-//   data: string;
-//   success: boolean;
-// }> {
-//   if (!this.isConnecting) {
-//     await this.connect();
-//   }
-//   const { path } = params;
-//   const apiInfo = this.getApiInfoByName(FileStationApi.Download);
-//   const url = buildUrlWithQuery(`${this.baseUrl}${apiInfo.path}`, {
-//     api: FileStationApi.Download,
-//     method:"download",
-//     path,
-//     mode: "open",
-//     version: apiInfo.maxVersion,
-//     _sid: this.authInfo?.sid,
-//   });
-//   return {
-//     data: url,
-//     success: true,
-//   };
-// }

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

@@ -1,3 +1,4 @@
+import { SynologyApiResponse } from "../../types/index.js";
 export type GetThumbRequest = {
     path: string;
     size?: "small" | "medium" | "large" | "original";
@@ -13,5 +14,5 @@ export type GetThumbRequest = {
     */
     rotate?: 0 | 1 | 2 | 3 | 4;
 };
-export type GetThumbResponse = Buffer;
-export declare function getThumb(params: GetThumbRequest): Promise<GetThumbResponse>;
+export type GetThumbResponse = SynologyApiResponse<{}>;
+export declare function getThumbUrl(params: GetThumbRequest): Promise<GetThumbResponse>;

package/lib/modules/FileStation/Thumb.js

@@ -1,14 +1,25 @@
 import { FileStationApi } from "../../types/index.js";
-import { isNode } from "../../utils/index.js";
-export async function getThumb(params) {
+import { buildUrlWithQuery } from "../../utils/index.js";
+export async function getThumbUrl(params) {
     const { path, size = "small", rotate = 0 } = params;
-    const res = await this.run(FileStationApi.Thumb, {
-        responseType: "arraybuffer",
+    if (!this.isConnecting) {
+        await this.connect();
+    }
+    const apiInfo = this.getApiInfoByName(FileStationApi.Thumb);
+    const options = await this.genRequestOptions(FileStationApi.Thumb, {
         params: {
             path,
             size,
             rotate,
+            method: "get",
+            version: apiInfo.maxVersion || apiInfo.minVersion,
+            SynoToken: this.authInfo.synotoken,
+            _sid: this.authInfo.sid,
         },
     });
-    return isNode ? Buffer.from(res) : res;
+    const thumbUrl = buildUrlWithQuery(`${this.baseUrl}${apiInfo.path}`, options.params);
+    return {
+        success: true,
+        data: thumbUrl,
+    };
 }

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

@@ -6,9 +6,9 @@ import { getFileList, getShareFileList, getVirtualFolderList } from "./List.js";
 import { addFavorite, deleteFavorite, getFavoriteList, clearBrokenFavorite, editFavorite } from "./Favorite.js";
 import { startSearch, stopSearch, getSearchList, cleanSearch } from "./Search.js";
 import { createFolder } from "./CreateFolder.js";
-import { getDownload } from "./Download.js";
+import { getDownloadFile } from "./Download.js";
 import { stopDeleteFile, startDeleteFile, getDeleteFileStatus } from "./Delete.js";
-import { getThumb } from "./Thumb.js";
+import { getThumbUrl } from "./Thumb.js";
 import { startDirSizeCalc, stopDirSizeCalc, getDirSizeCalcStatus } from "./DirSize.js";
 import { startMD5Calc, stopMD5Calc, getMD5CalcStatus } from "./MD5.js";
 import { checkPermission } from "./CheckPermission.js";
@@ -31,11 +31,11 @@ export declare const METHODS: {
     getSearchList: typeof getSearchList;
     cleanSearch: typeof cleanSearch;
     createFolder: typeof createFolder;
-    getDownload: typeof getDownload;
+    getDownloadFile: typeof getDownloadFile;
     stopDeleteFile: typeof stopDeleteFile;
     startDeleteFile: typeof startDeleteFile;
     getDeleteFileStatus: typeof getDeleteFileStatus;
-    getThumb: typeof getThumb;
+    getThumbUrl: typeof getThumbUrl;
     startDirSizeCalc: typeof startDirSizeCalc;
     stopDirSizeCalc: typeof stopDirSizeCalc;
     getDirSizeCalcStatus: typeof getDirSizeCalcStatus;

package/lib/modules/FileStation/index.base.js

@@ -6,9 +6,9 @@ import { getFileList, getShareFileList, getVirtualFolderList } from "./List.js";
 import { addFavorite, deleteFavorite, getFavoriteList, clearBrokenFavorite, editFavorite, } from "./Favorite.js";
 import { startSearch, stopSearch, getSearchList, cleanSearch } from "./Search.js";
 import { createFolder } from "./CreateFolder.js";
-import { getDownload } from "./Download.js";
+import { getDownloadFile } from "./Download.js";
 import { stopDeleteFile, startDeleteFile, getDeleteFileStatus } from "./Delete.js";
-import { getThumb } from "./Thumb.js";
+import { getThumbUrl } from "./Thumb.js";
 import { startDirSizeCalc, stopDirSizeCalc, getDirSizeCalcStatus } from "./DirSize.js";
 import { startMD5Calc, stopMD5Calc, getMD5CalcStatus } from "./MD5.js";
 import { checkPermission } from "./CheckPermission.js";
@@ -32,12 +32,11 @@ export const METHODS = {
     getSearchList,
     cleanSearch,
     createFolder,
-    getDownload,
-    //   getFileOpenUrl,
+    getDownloadFile,
     stopDeleteFile,
     startDeleteFile,
     getDeleteFileStatus,
-    getThumb,
+    getThumbUrl,
     startDirSizeCalc,
     stopDirSizeCalc,
     getDirSizeCalcStatus,

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

@@ -15,11 +15,11 @@ export declare const METHODS: {
     getSearchList: typeof import("./Search.js").getSearchList;
     cleanSearch: typeof import("./Search.js").cleanSearch;
     createFolder: typeof import("./CreateFolder.js").createFolder;
-    getDownload: typeof import("./Download.js").getDownload;
+    getDownloadFile: typeof import("./Download.js").getDownloadFile;
     stopDeleteFile: typeof import("./Delete.js").stopDeleteFile;
     startDeleteFile: typeof import("./Delete.js").startDeleteFile;
     getDeleteFileStatus: typeof import("./Delete.js").getDeleteFileStatus;
-    getThumb: typeof import("./Thumb.js").getThumb;
+    getThumbUrl: typeof import("./Thumb.js").getThumbUrl;
     startDirSizeCalc: typeof import("./DirSize.js").startDirSizeCalc;
     stopDirSizeCalc: typeof import("./DirSize.js").stopDirSizeCalc;
     getDirSizeCalcStatus: typeof import("./DirSize.js").getDirSizeCalcStatus;

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

@@ -15,11 +15,11 @@ export declare const METHODS: {
     getSearchList: typeof import("./Search.js").getSearchList;
     cleanSearch: typeof import("./Search.js").cleanSearch;
     createFolder: typeof import("./CreateFolder.js").createFolder;
-    getDownload: typeof import("./Download.js").getDownload;
+    getDownloadFile: typeof import("./Download.js").getDownloadFile;
     stopDeleteFile: typeof import("./Delete.js").stopDeleteFile;
     startDeleteFile: typeof import("./Delete.js").startDeleteFile;
     getDeleteFileStatus: typeof import("./Delete.js").getDeleteFileStatus;
-    getThumb: typeof import("./Thumb.js").getThumb;
+    getThumbUrl: typeof import("./Thumb.js").getThumbUrl;
     startDirSizeCalc: typeof import("./DirSize.js").startDirSizeCalc;
     stopDirSizeCalc: typeof import("./DirSize.js").stopDirSizeCalc;
     getDirSizeCalcStatus: typeof import("./DirSize.js").getDirSizeCalcStatus;

package/lib/modules/VideoStation/Streaming.js

@@ -21,8 +21,7 @@ export async function getStreamUrl(params) {
             allow_api: VideoStationApi.Streaming,
             allow_methods: ["stream"],
         });
-        const apiInfo = this.getApiInfoByName(VideoStationApi.Streaming);
-        const url = `${this.baseUrl}${apiInfo.path}/1.mp4`;
+        const url = `${this.baseUrl}entry.cgi/1.mp4`;
         const query = {
             ...params,
             api: VideoStationApi.Streaming,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fett/synology-api",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "synology api for nodejs",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",