@cloudbase/storage 2.0.3-alpha.0 → 2.5.0-beta.0

package/src/index.ts

@@ -1,6 +1,6 @@
-import { constants, utils, helpers } from '@cloudbase/utilities';
-import { ICloudbase } from '@cloudbase/types';
-import { ICloudbaseComponent } from '@cloudbase/types/component';
+import { constants, utils, helpers } from '@cloudbase/utilities'
+import { ICloudbase } from '@cloudbase/types'
+import { ICloudbaseComponent } from '@cloudbase/types/component'
 import {
   ICloudbaseFileMetaDataRes,
   ICloudbaseFileInfo,
@@ -12,27 +12,27 @@ import {
   ICloudbaseGetTempFileURLResult,
   ICloudbaseGetTempFileURLParams,
   ICloudbaseDownloadFileResult,
-  ICloudbaseDownloadFileParams
-} from '@cloudbase/types/storage';
+  ICloudbaseDownloadFileParams,
+} from '@cloudbase/types/storage'
 
-declare const cloudbase: ICloudbase;
+declare const cloudbase: ICloudbase
 
 enum EUploadMethod {
   put = 'put',
   post = 'post'
 }
 
-const { getSdkName, ERRORS, COMMUNITY_SITE_URL } = constants;
-const { isArray, isString, isPalinObject, execCallback } = utils;
-const { catchErrorsDecorator } = helpers;
+const { getSdkName, ERRORS, COMMUNITY_SITE_URL } = constants
+const { isArray, isString, isPalinObject, execCallback } = utils
+const { catchErrorsDecorator } = helpers
 
-const COMPONENT_NAME = 'storage';
+const COMPONENT_NAME = 'storage'
 
 class CloudbaseStorage {
   @catchErrorsDecorator({
     customInfo: {
       className: 'Cloudbase',
-      methodName: 'uploadFile'
+      methodName: 'uploadFile',
     },
     title: '上传文件失败',
     messages: [
@@ -40,45 +40,46 @@ class CloudbaseStorage {
       '  1 - 调用 uploadFile() 的语法或参数是否正确',
       '  2 - 当前域名是否在安全域名列表中：https://console.cloud.tencent.com/tcb/env/safety',
       '  3 - 云存储安全规则是否限制了当前登录状态访问',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public async uploadFile(
     params: ICloudbaseUploadFileParams,
     callback?: Function
   ): Promise<ICloudbaseUploadFileResult> {
-    const { cloudPath, filePath, onUploadProgress, method = 'post', headers = {} } = params;
+    const { cloudPath, filePath, onUploadProgress, method = 'put', headers = {} } = params
     if (!isString(cloudPath) || !filePath) {
       throw new Error(JSON.stringify({
         code: ERRORS.INVALID_PARAMS,
-        msg: `[${COMPONENT_NAME}.uploadFile] invalid params`
-      }));
+        msg: `[${COMPONENT_NAME}.uploadFile] invalid params`,
+      }))
     }
-    const uploadMethod = { put: EUploadMethod.put, post: EUploadMethod.post }[method.toLocaleLowerCase()] || EUploadMethod.post;
+    const uploadMethod = { put: EUploadMethod.put, post: EUploadMethod.post }[method.toLocaleLowerCase()] || EUploadMethod.put
 
-    const action = 'storage.getUploadMetadata';
+    const action = 'storage.getUploadMetadata'
     // @ts-ignore
-    const request = this.request;
+    const { request } = this
     const metaDataParam = {
       path: cloudPath,
       method: uploadMethod,
     }
     if (uploadMethod === EUploadMethod.put) {
-      metaDataParam["headers"] = headers;
+      /* eslint-disable-next-line */
+      metaDataParam["headers"] = headers
     }
-    const metaData: ICloudbaseFileMetaDataRes = await request.send(action, metaDataParam);
+    const metaData: ICloudbaseFileMetaDataRes = await request.send(action, metaDataParam)
 
     const {
-      data: { url, authorization, token, fileId, cosFileId, download_url },
-      requestId
-    } = metaData;
+      data: { url, authorization, token, fileId, cosFileId, download_url: downloadUrl },
+      requestId,
+    } = metaData
 
     const commonParams = {
       url,
       file: filePath,
       name: cloudPath,
-      onUploadProgress
-    };
+      onUploadProgress,
+    }
 
     const putParams = {
       ...commonParams,
@@ -88,47 +89,47 @@ class CloudbaseStorage {
         authorization,
         'x-cos-meta-fileid': cosFileId,
         'x-cos-security-token': token,
-      }
-    };
+      },
+    }
 
     const postParams = {
       ...commonParams,
+      method: EUploadMethod.post,
       data: {
         key: cloudPath,
         signature: authorization,
         'x-cos-meta-fileid': cosFileId,
-        'success_action_status': '201',
-        'x-cos-security-token': token
-      }
-    };
+        success_action_status: '201',
+        'x-cos-security-token': token,
+      },
+    }
 
     const uploadConfig = {
       [EUploadMethod.put]: {
         params: putParams,
-        successCode: 200,
+        isSuccess: (code: number) => code >= 200 && code < 300,
       },
       [EUploadMethod.post]: {
         params: postParams,
-        successCode: 201,
-      }
+        isSuccess: (code: number) => code === 201,
+      },
     }
 
-    const res = await request.upload(uploadConfig[uploadMethod].params);
+    const res = await request.upload(uploadConfig[uploadMethod].params)
 
-    if (res.statusCode === uploadConfig[uploadMethod].successCode) {
+    if (uploadConfig[uploadMethod].isSuccess(res.statusCode)) {
       return execCallback(callback, null, {
         fileID: fileId,
-        download_url,
-        requestId
-      });
-    } else {
-      return execCallback(callback, new Error(`[${getSdkName()}][${ERRORS.OPERATION_FAIL}][${COMPONENT_NAME}]:${res.data}`));
+        download_url: downloadUrl,
+        requestId,
+      })
     }
+    return execCallback(callback, new Error(`[${getSdkName()}][${ERRORS.OPERATION_FAIL}][${COMPONENT_NAME}]:${res.data}`))
   }
   @catchErrorsDecorator({
     customInfo: {
       className: 'Cloudbase',
-      methodName: 'getUploadMetadata'
+      methodName: 'getUploadMetadata',
     },
     title: '获取上传元信息失败',
     messages: [
@@ -136,37 +137,37 @@ class CloudbaseStorage {
       '  1 - 调用 getUploadMetadata() 的语法或参数是否正确',
       '  2 - 当前域名是否在安全域名列表中：https://console.cloud.tencent.com/tcb/env/safety',
       '  3 - 云存储安全规则是否限制了当前登录状态访问',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public async getUploadMetadata(
     params: ICloudbaseGetUploadMetadataParams,
     callback?: Function
   ): Promise<any> {
-    const { cloudPath } = params;
+    const { cloudPath } = params
     if (!isString(cloudPath)) {
       throw new Error(JSON.stringify({
         code: ERRORS.INVALID_PARAMS,
-        msg: `[${COMPONENT_NAME}.getUploadMetadata] invalid cloudPath`
-      }));
+        msg: `[${COMPONENT_NAME}.getUploadMetadata] invalid cloudPath`,
+      }))
     }
     // @ts-ignore
-    const request = this.request;
-    const action = 'storage.getUploadMetadata';
+    const { request } = this
+    const action = 'storage.getUploadMetadata'
 
     try {
       const metaData = await request.send(action, {
-        path: cloudPath
-      });
-      return execCallback(callback, null, metaData);
+        path: cloudPath,
+      })
+      return execCallback(callback, null, metaData)
     } catch (err) {
-      return execCallback(callback, err);
+      return execCallback(callback, err)
     }
   }
   @catchErrorsDecorator({
     customInfo: {
       className: 'Cloudbase',
-      methodName: 'deleteFile'
+      methodName: 'deleteFile',
     },
     title: '删除文件失败',
     messages: [
@@ -174,51 +175,51 @@ class CloudbaseStorage {
       '  1 - 调用 deleteFile() 的语法或参数是否正确',
       '  2 - 当前域名是否在安全域名列表中：https://console.cloud.tencent.com/tcb/env/safety',
       '  3 - 云存储安全规则是否限制了当前登录状态访问',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public async deleteFile(
     params: ICloudbaseDeleteFileParams,
     callback?: Function
   ): Promise<ICloudbaseDeleteFileResult> {
-    const { fileList } = params;
+    const { fileList } = params
 
     if (!fileList || !isArray(fileList) || fileList.length === 0) {
       throw new Error(JSON.stringify({
         code: ERRORS.INVALID_PARAMS,
-        msg: `[${COMPONENT_NAME}.deleteFile] fileList must not be empty`
-      }));
+        msg: `[${COMPONENT_NAME}.deleteFile] fileList must not be empty`,
+      }))
     }
 
     for (const fileId of fileList) {
       if (!fileId || !isString(fileId)) {
         throw new Error(JSON.stringify({
           code: ERRORS.INVALID_PARAMS,
-          msg: `[${COMPONENT_NAME}.deleteFile] fileID must be string`
-        }));
+          msg: `[${COMPONENT_NAME}.deleteFile] fileID must be string`,
+        }))
       }
     }
 
-    const action = 'storage.batchDeleteFile';
+    const action = 'storage.batchDeleteFile'
     // @ts-ignore
-    const request = this.request;
+    const { request } = this
     const res = await request.send(action, {
-      fileid_list: fileList
-    });
+      fileid_list: fileList,
+    })
 
     if (res.code) {
-      return execCallback(callback, null, res);
+      return execCallback(callback, null, res)
     }
     const data = {
       fileList: res.data.delete_list,
-      requestId: res.requestId
-    };
-    return execCallback(callback, null, data);;
+      requestId: res.requestId,
+    }
+    return execCallback(callback, null, data)
   }
   @catchErrorsDecorator({
     customInfo: {
       className: 'Cloudbase',
-      methodName: 'getTempFileURL'
+      methodName: 'getTempFileURL',
     },
     title: '获取文件下载链接',
     messages: [
@@ -226,67 +227,68 @@ class CloudbaseStorage {
       '  1 - 调用 getTempFileURL() 的语法或参数是否正确',
       '  2 - 当前域名是否在安全域名列表中：https://console.cloud.tencent.com/tcb/env/safety',
       '  3 - 云存储安全规则是否限制了当前登录状态访问',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public async getTempFileURL(
     params: ICloudbaseGetTempFileURLParams,
     callback?: Function
   ): Promise<ICloudbaseGetTempFileURLResult> {
-    const { fileList } = params;
+    const { fileList } = params
 
     if (!fileList || !isArray(fileList) || fileList.length === 0) {
       throw new Error(JSON.stringify({
         code: ERRORS.INVALID_PARAMS,
-        msg: `[${COMPONENT_NAME}.getTempFileURL] fileList must not be empty`
-      }));
+        msg: `[${COMPONENT_NAME}.getTempFileURL] fileList must not be empty`,
+      }))
     }
 
-    const file_list = [];
+    const convertedFileList = []
     for (const file of fileList) {
       if (isPalinObject(file)) {
-        if (!file.hasOwnProperty('fileID') || !file.hasOwnProperty('maxAge')) {
+        if (!Object.prototype.hasOwnProperty.call(file, 'fileID')
+          || !Object.prototype.hasOwnProperty.call(file, 'maxAge')) {
           throw new Error(JSON.stringify({
             code: ERRORS.INVALID_PARAMS,
-            msg: `[${COMPONENT_NAME}.getTempFileURL] file info must include fileID and maxAge`
-          }));
+            msg: `[${COMPONENT_NAME}.getTempFileURL] file info must include fileID and maxAge`,
+          }))
         }
 
-        file_list.push({
+        convertedFileList.push({
           fileid: (file as ICloudbaseFileInfo).fileID,
-          max_age: (file as ICloudbaseFileInfo).maxAge
-        });
+          max_age: (file as ICloudbaseFileInfo).maxAge,
+        })
       } else if (isString(file)) {
-        file_list.push({
-          fileid: file
-        });
+        convertedFileList.push({
+          fileid: file,
+        })
       } else {
         throw new Error(JSON.stringify({
           code: ERRORS.INVALID_PARAMS,
-          msg: `[${COMPONENT_NAME}.getTempFileURL] invalid fileList`
-        }));
+          msg: `[${COMPONENT_NAME}.getTempFileURL] invalid fileList`,
+        }))
       }
     }
 
-    const action = 'storage.batchGetDownloadUrl';
+    const action = 'storage.batchGetDownloadUrl'
     // @ts-ignore
-    const request = this.request;
+    const { request } = this
 
-    const res = await request.send(action, { file_list });
+    const res = await request.send(action, { file_list: convertedFileList })
 
     if (res.code) {
-      return execCallback(callback, null, res);
+      return execCallback(callback, null, res)
     }
 
     return execCallback(callback, null, {
       fileList: res.data.download_list,
-      requestId: res.requestId
-    });
+      requestId: res.requestId,
+    })
   }
   @catchErrorsDecorator({
     customInfo: {
       className: 'Cloudbase',
-      methodName: 'downloadFile'
+      methodName: 'downloadFile',
     },
     title: '下载文件失败',
     messages: [
@@ -294,44 +296,44 @@ class CloudbaseStorage {
       '  1 - 调用 downloadFile() 的语法或参数是否正确',
       '  2 - 当前域名是否在安全域名列表中：https://console.cloud.tencent.com/tcb/env/safety',
       '  3 - 云存储安全规则是否限制了当前登录状态访问',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public async downloadFile(
     params: ICloudbaseDownloadFileParams,
     callback?: Function
   ): Promise<ICloudbaseDownloadFileResult> {
-    const { fileID } = params;
+    const { fileID } = params
     if (!isString(fileID)) {
       throw new Error(JSON.stringify({
         code: ERRORS.INVALID_PARAMS,
-        msg: `[${COMPONENT_NAME}.getTempFileURL] fileID must be string`
-      }));
+        msg: `[${COMPONENT_NAME}.getTempFileURL] fileID must be string`,
+      }))
     }
 
     const tmpUrlRes = await this.getTempFileURL.call(this, {
       fileList: [{
         fileID,
-        maxAge: 600
-      }]
-    });
+        maxAge: 600,
+      }],
+    })
 
-    const res = tmpUrlRes.fileList[0];
+    const res = tmpUrlRes.fileList[0]
 
     if (res.code !== 'SUCCESS') {
-      return execCallback(callback, res);
+      return execCallback(callback, res)
     }
     // @ts-ignore
-    const request = this.request;
+    const { request } = this
 
-    const tmpUrl = encodeURI(res.download_url);
+    const tmpUrl = encodeURI(res.download_url)
 
-    const result = await request.download({ url: tmpUrl });
-    return execCallback(callback, null, result);
+    const result = await request.download({ url: tmpUrl })
+    return execCallback(callback, null, result)
   }
 }
 
-const cloudbaseStorage = new CloudbaseStorage();
+const cloudbaseStorage = new CloudbaseStorage()
 const component: ICloudbaseComponent = {
   name: COMPONENT_NAME,
   entity: {
@@ -339,18 +341,18 @@ const component: ICloudbaseComponent = {
     deleteFile: cloudbaseStorage.deleteFile,
     getTempFileURL: cloudbaseStorage.getTempFileURL,
     downloadFile: cloudbaseStorage.downloadFile,
-    getUploadMetadata: cloudbaseStorage.getUploadMetadata
-  }
+    getUploadMetadata: cloudbaseStorage.getUploadMetadata,
+  },
 }
 
 try {
-  cloudbase.registerComponent(component);
+  cloudbase.registerComponent(component)
 } catch (e) { }
 
 export function registerStorage(app: Pick<ICloudbase, 'registerComponent'>) {
   try {
-    app.registerComponent(component);
+    app.registerComponent(component)
   } catch (e) {
-    console.warn(e);
+    console.warn(e)
   }
-}
+}

package/.eslintrc

@@ -1,29 +0,0 @@
-{
-    "extends": [
-        "eslint-config-alloy/typescript"
-    ],
-    "rules": {
-        "indent": [
-            "error",
-            2,
-            {
-                "SwitchCase": 1,
-                "flatTernaryExpressions": true
-            }
-        ],
-        "guard-for-in": 0,
-        "no-param-reassign": 0,
-        "no-undefined": 0,
-        "@typescript-eslint/explicit-member-accessibility": 0,
-        "@typescript-eslint/no-invalid-this": 0,
-        "@typescript-eslint/no-loss-of-precision": 0,
-        "@typescript-eslint/no-duplicate-imports": 0
-    },
-    "parserOptions": {
-        "ecmaVersion": 6,
-        "sourceType": "module",
-        "ecmaFeatures": {
-            "modules": true
-        }
-    }
-}