@cloudbase/js-sdk 2.21.3 → 2.21.5

package/index.d.ts

@@ -1,95 +1,95 @@
-import { CloudbaseAdapter } from '@cloudbase/adapter-interface';
-import { ICloudbaseUpgradedConfig, ICloudbase, Persistence } from '@cloudbase/types';
-import { OrmClient, OrmRawQueryClient } from '@cloudbase/model';
-import { authModels } from '@cloudbase/oauth';
-import { AI } from '@cloudbase/ai';
-import { LANGS } from '@cloudbase/types';
+import { CloudbaseAdapter, ResponseObject } from '@cloudbase/adapter-interface'
+import { ICloudbaseUpgradedConfig, ICloudbase, Persistence, ICloudbaseApis } from '@cloudbase/types'
+import { OrmClient, OrmRawQueryClient } from '@cloudbase/model'
+import { authModels } from '@cloudbase/oauth'
+import { AI } from '@cloudbase/ai'
+import { LANGS } from '@cloudbase/types'
+import { ICustomReqOpts } from '@cloudbase/types/functions'
 
 type KV<T> = {
-  [key: string]: T;
-};
+  [key: string]: T
+}
 
-type ExcludeOf<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
+type ExcludeOf<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>
 
 /**
  * module
  */
 declare namespace cloudbase {
-
   interface SimpleStorage {
-    getItem: (key: string) => Promise<string | null>;
-    removeItem: (key: string) => Promise<void>;
-    setItem: (key: string, value: string) => Promise<void>;
-    getItemSync: (key: string) => string | null;
-    removeItemSync: (key: string) => void;
-    setItemSync: (key: string, value: string) => void;
+    getItem: (key: string) => Promise<string | null>
+    removeItem: (key: string) => Promise<void>
+    setItem: (key: string, value: string) => Promise<void>
+    getItemSync: (key: string) => string | null
+    removeItemSync: (key: string) => void
+    setItemSync: (key: string, value: string) => void
   }
 
   interface ICloudbaseConfig {
-    env: string;
-    region?: string;
-    timeout?: number;
-    persistence?: Persistence;
+    env: string
+    region?: string
+    timeout?: number
+    persistence?: Persistence
     oauthClient?: any
-    debug?: boolean;
-    _fromApp?: ICloudbase;
+    debug?: boolean
+    _fromApp?: ICloudbase
     clientId?: string
-    oauthInstance?: any;
+    oauthInstance?: any
     wxCloud?: any
     i18n?: {
-      t: (text: string) => string;
-      LANG_HEADER_KEY: string;
-      lang: LANGS;
+      t: (text: string) => string
+      LANG_HEADER_KEY: string
+      lang: LANGS
     }
     accessKey?: string
     endPointMode?: EndPointKey
   }
 
   interface ICloudbaseExtension {
-    name: string;
-    invoke(opts: any, app: ICloudbase): Promise<any>;
+    name: string
+    invoke(opts: any, app: ICloudbase): Promise<any>
   }
 
   interface Listeners {
-    [key: string]: Function[];
+    [key: string]: Function[]
   }
 
   interface ICloudbaseEvent {
-    name: string;
-    target: any;
-    data: any;
+    name: string
+    target: any
+    data: any
   }
 
   interface ICloudbaseEventEmitter {
-    on(name: string, listener: Function): this;
-    off(name: string, listener: Function): this;
-    fire(event: string | ICloudbaseEvent, data?: any): this;
+    on(name: string, listener: Function): this
+    off(name: string, listener: Function): this
+    fire(event: string | ICloudbaseEvent, data?: any): this
   }
 
   interface ICloudbaseComponent {
-    name: string;
-    entity: any;
-    namespace?: string;
+    name: string
+    entity: any
+    namespace?: string
     injectEvents?: {
-      bus: ICloudbaseEventEmitter,
-      events: string[];
-    };
+      bus: ICloudbaseEventEmitter
+      events: string[]
+    }
     IIFE?: boolean
   }
 
   interface ICloudbaseHook {
-    entity: any;
-    target: string;
+    entity: any
+    target: string
   }
 
-  type EndPointKey = 'CLOUD_API' | 'GATEWAY';
+  type EndPointKey = 'CLOUD_API' | 'GATEWAY'
 
   interface ISetEndPointWithKey {
-    key: EndPointKey;
-    url?: string;
-    protocol?: 'http' | 'https';
+    key: EndPointKey
+    url?: string
+    protocol?: 'http' | 'https'
   }
-  
+
   /**
    * 初始化Cloudbase
    *
@@ -107,11 +107,11 @@ declare namespace cloudbase {
    *
    * @return {!cloudbase.app.App} 初始化成功的Cloudbase实例
    */
-  function init(config: ICloudbaseConfig & { lang?: LANGS }): cloudbase.app.App;
+  function init(config: ICloudbaseConfig & { lang?: LANGS }): cloudbase.app.App
+
+  function updateConfig(config: ICloudbaseUpgradedConfig): void
 
-  function updateConfig(config: ICloudbaseUpgradedConfig): void;
-  
-  function updateLang(lang: LANGS): void;
+  function updateLang(lang: LANGS): void
   /**
    * 使用适配器，使用方式参考 {@link https://docs.cloudbase.net/api-reference/webv3/adapter#%E7%AC%AC-1-%E6%AD%A5%E5%AE%89%E8%A3%85%E5%B9%B6%E5%BC%95%E5%85%A5%E9%80%82%E9%85%8D%E5%99%A8}
    *
@@ -127,7 +127,7 @@ declare namespace cloudbase {
    * @param adapters 适配器对象，入参可以为单个适配器对象，也可以是多个适配器对象的数组
    * @param options 适配器参数，可以在genAdapter中获取到该参数
    */
-  function useAdapters(adapters: CloudbaseAdapter | CloudbaseAdapter[], options?: any): void;
+  function useAdapters(adapters: CloudbaseAdapter | CloudbaseAdapter[], options?: any): void
   /**
    * 注册扩展能力插件，使用方式参考 {@link https://docs.cloudbase.net/extension/abilities/image-examination.html#shi-yong-kuo-zhan}
    *
@@ -138,7 +138,7 @@ declare namespace cloudbase {
    *
    * @param ext 扩展能力插件对象
    */
-  function registerExtension(ext: ICloudbaseExtension): void;
+  function registerExtension(ext: ICloudbaseExtension): void
   /**
    * 【谨慎操作】注册SDK的版本
    *
@@ -149,7 +149,7 @@ declare namespace cloudbase {
    *
    * @param version SDK版本
    */
-  function registerVersion(version: string): void;
+  function registerVersion(version: string): void
   /**
    * 【谨慎操作】注册SDK的名称
    *
@@ -160,7 +160,7 @@ declare namespace cloudbase {
    *
    * @param name SDK名称
    */
-  function registerSdkName(name: string): void;
+  function registerSdkName(name: string): void
   /**
    * 【谨慎操作】修改SDK请求的云开发服务地址
    *
@@ -172,21 +172,21 @@ declare namespace cloudbase {
    * @param url 服务地址
    * @param protocol 【可选】强制使用某种协议，默认与主站协议一致
    */
-  function registerEndPoint(url: string, protocol?: 'http' | 'https'): void;
+  function registerEndPoint(url: string, protocol?: 'http' | 'https'): void
   /**
    * 【谨慎操作】修改SDK请求的「云开发/网关」服务地址
    *
    * @example
    * ```javascript
-   * cloudbase.registerEndPointWithKey({ 
-   *   key: "GATEWAY", 
-   *   url: "", 
+   * cloudbase.registerEndPointWithKey({
+   *   key: "GATEWAY",
+   *   url: "",
    *   protocol: ""
    * });
    * ```
    *
    */
-  function registerEndPointWithKey(props: ISetEndPointWithKey): void;
+  function registerEndPointWithKey(props: ISetEndPointWithKey): void
   /**
    * 【谨慎操作】注册功能模块
    *
@@ -197,7 +197,7 @@ declare namespace cloudbase {
    *
    * @param component 功能模块对象
    */
-  function registerComponent(component: ICloudbaseComponent): void;
+  function registerComponent(component: ICloudbaseComponent): void
   /**
    * 【谨慎操作】注册hook
    *
@@ -208,9 +208,9 @@ declare namespace cloudbase {
    *
    * @param hook hook对象
    */
-  function registerHook(hook: ICloudbaseHook): void;
+  function registerHook(hook: ICloudbaseHook): void
 
-  export interface models extends OrmClient, OrmRawQueryClient { }
+  export interface models extends OrmClient, OrmRawQueryClient {}
 }
 /**
  * instance
@@ -237,9 +237,7 @@ declare namespace cloudbase.app {
      *
      * @return {!cloudbase.auth.App} Auth实例
      */
-    auth(options?: {
-      persistence: cloudbase.auth.Persistence
-    }): cloudbase.auth.App;
+    auth(options?: { persistence: cloudbase.auth.Persistence }): cloudbase.auth.App
     /**
      * 调用云函数
      *
@@ -268,7 +266,49 @@ declare namespace cloudbase.app {
      *
      * @return Promise-函数执行结果
      */
-    callFunction(options: cloudbase.functions.ICallFunctionOptions, callback?: Function): Promise<cloudbase.functions.ICallFunctionResponse>;
+    callFunction(
+      options: cloudbase.functions.ICallFunctionOptions,
+      callback?: Function,
+      customReqOpts?: ICustomReqOpts,
+    ): Promise<cloudbase.functions.ICallFunctionResponse>
+    /**
+     * 调用云托管
+     *
+     * {@link https://docs.cloudbase.net/api-reference/webv3/cloudrun}
+     *
+     * @example
+     * ```javascript
+     * const app = cloudbase.init({
+     *   env: 'your-envid'
+     * });
+     * app
+     * .callContainer({
+     * name: 'helloworld',
+     * method: 'POST',
+     * path: '/abc',
+     * header:{
+     *   'Content-Type': 'application/json; charset=utf-8'
+     * },
+     * data: {
+     *   key1: 'test value 1',
+     *   key2: 'test value 2'
+     * },
+     * })
+     * .then((res) => {
+     * console.log(res)
+     * });
+     * ```
+     *
+     * @param options 被调用的云托管信息
+     * @param options.name 云托管的名称
+     * @param options.data 【可选】云托管的参数，默认为空
+     *
+     * @return Promise-云托管执行结果
+     */
+    callContainer(
+      options: cloudbase.functions.ICallFunctionOptions,
+      customReqOpts?: ICustomReqOpts,
+    ): Promise<ResponseObject>
     /**
      * 云存储-上传文件
      *
@@ -299,7 +339,10 @@ declare namespace cloudbase.app {
      *
      * @return Promise-上传结果
      */
-    uploadFile(params: cloudbase.storage.ICloudbaseUploadFileParams, callback?: Function): Promise<cloudbase.storage.ICloudbaseUploadFileResult>;
+    uploadFile(
+      params: cloudbase.storage.ICloudbaseUploadFileParams,
+      callback?: Function,
+    ): Promise<cloudbase.storage.ICloudbaseUploadFileResult>
     /**
      * 云存储-下载文件
      *
@@ -320,7 +363,40 @@ declare namespace cloudbase.app {
      *
      * @return Promise-下载结果
      */
-    downloadFile(params: cloudbase.storage.ICloudbaseDownloadFileParams, callback?: Function): Promise<cloudbase.storage.ICloudbaseDownloadFileResult>;
+    downloadFile(
+      params: cloudbase.storage.ICloudbaseDownloadFileParams,
+      callback?: Function,
+    ): Promise<cloudbase.storage.ICloudbaseDownloadFileResult>
+    /**
+     * 云存储-批量复制文件
+     *
+     *
+     * @example
+     * ```javascript
+     * const app = cloudbase.init({
+     *   env: 'your-envid'
+     * });
+     * app.copyFile({
+     *   fileList: [
+     *     {
+     *       srcPath: '源文件的绝对路径，包含文件名。例如 foo/bar.jpg、foo/bar/baz.jpg 等，不能包含除[0-9 , a-z , A-Z]、/、!、-、_、.、、*和中文以外的字符，使用 / 字符来实现类似传统文件系统的层级结构',
+     *       dstPath: '目标文件的绝对路径，包含文件名。例如 foo/bar.jpg、foo/bar/baz.jpg 等，不能包含除[0-9 , a-z , A-Z]、/、!、-、_、.、、*和中文以外的字符，使用 / 字符来实现类似传统文件系统的层级结构',
+     *       overwrite: '当目标文件已经存在时，是否允许覆盖已有文件，默认 true',
+     *       removeOriginal: '复制文件后是否删除源文件，默认 false'
+     *     }
+     *   ]
+     * });
+     * ```
+     *
+     * @param params
+     * @param params.fileList 要复制的文件信息组成的数组
+     *
+     * @return Promise-复制结果
+     */
+    copyFile(
+      params: cloudbase.storage.ICloudbaseCopyFileParams,
+      callback?: Function,
+    ): Promise<cloudbase.storage.ICloudbaseCopyFileResult>
     /**
      * 云存储-获取文件的下载链接
      *
@@ -349,7 +425,10 @@ declare namespace cloudbase.app {
      *
      * @return Promise-文件下载链接
      */
-    getTempFileURL(params: cloudbase.storage.ICloudbaseGetTempFileURLParams, callback?: Function): Promise<cloudbase.storage.ICloudbaseGetTempFileURLResult>;
+    getTempFileURL(
+      params: cloudbase.storage.ICloudbaseGetTempFileURLParams,
+      callback?: Function,
+    ): Promise<cloudbase.storage.ICloudbaseGetTempFileURLResult>
     /**
      * 云存储-删除文件
      *
@@ -373,15 +452,23 @@ declare namespace cloudbase.app {
      *
      * @return Promise-删除结果
      */
-    deleteFile(params: cloudbase.storage.ICloudbaseDeleteFileParams, callback?: Function): Promise<cloudbase.storage.ICloudbaseDeleteFileResult>;
+    deleteFile(
+      params: cloudbase.storage.ICloudbaseDeleteFileParams,
+      callback?: Function,
+    ): Promise<cloudbase.storage.ICloudbaseDeleteFileResult>
+
+    getFileInfo(
+      params: cloudbase.storage.ICloudbaseGetTempFileURLParams,
+      callback?: Function,
+    ): Promise<cloudbase.storage.ICloudbaseGetTempFileURLResult>
     /**
      * 云存储-获取上传元信息
-     * 
-     * 
-     * @param params 
-     * @param callback 
+     *
+     *
+     * @param params
+     * @param callback
      */
-    getUploadMetadata(params: cloudbase.storage.ICloudbaseGetUploadMetadataParams, callback?: Function): Promise<any>;
+    getUploadMetadata(params: cloudbase.storage.ICloudbaseGetUploadMetadataParams, callback?: Function): Promise<any>
     /**
      * 获取数据库实例
      *
@@ -397,7 +484,7 @@ declare namespace cloudbase.app {
      *
      * @return 数据库实例
      */
-    database(): cloudbase.database.App;
+    database(dbConfig?: object): cloudbase.database.App
     /**
      * 调用扩展能力插件功能
      *
@@ -419,9 +506,9 @@ declare namespace cloudbase.app {
      *
      * @return Promise-扩展能力插件执行结果
      */
-    invokeExtension(name: string, opts: any): Promise<any>;
+    invokeExtension(name: string, opts: any): Promise<any>
 
-    eventBus: any;
+    eventBus: any
 
     /**
      * 调用 数据模型 SDK
@@ -440,63 +527,65 @@ declare namespace cloudbase.app {
         models.$runSQL() // 执行原生 SQL 语句
       * ```
       */
-    models: OrmClient & OrmRawQueryClient;
+    models: OrmClient & OrmRawQueryClient
 
-    ai(): AI;
+    ai(): AI
+
+    apis: ICloudbaseApis
   }
 }
 /**
  * auth
  */
 declare namespace cloudbase.auth {
-  type Persistence = 'local' | 'session' | 'none';
+  type Persistence = 'local' | 'session' | 'none'
 
   interface IAccessTokenInfo {
-    accessToken: string;
-    env: string;
+    accessToken: string
+    env: string
   }
 
   interface ILoginState {
     /**
      * 当前登录用户的信息
      */
-    user: IUser;
+    user: IUser
   }
 
   interface ICredential {
-    accessToken?: string;
-    accessTokenExpire?: string;
+    accessToken?: string
+    accessTokenExpire?: string
   }
 
   interface IAuthProvider {
-    signInWithRedirect: () => any;
+    signInWithRedirect: () => any
   }
 
   /**
    * 用户信息
    */
   interface IUserInfo {
-    uid?: string;
-    loginType?: string;
-    openid?: string;
-    wxOpenId?: string;
-    wxPublicId?: string;
-    unionId?: string;
-    qqMiniOpenId?: string;
-    customUserId?: string;
-    name?: string;
-    gender?: string;
-    email?: string;
-    username?: string;
-    hasPassword?: boolean;
+    uid?: string
+    loginType?: string
+    openid?: string
+    wxOpenId?: string
+    wxPublicId?: string
+    unionId?: string
+    qqMiniOpenId?: string
+    customUserId?: string
+    name?: string
+    gender?: string
+    email?: string
+    username?: string
+    hasPassword?: boolean
     location?: {
-      country?: string;
-      province?: string;
-      city?: string;
-    };
-    country?: string;
-    province?: string;
-    city?: string;
+      country?: string
+      province?: string
+      city?: string
+    }
+    country?: string
+    province?: string
+    city?: string
   }
 
   interface IUser extends IUserInfo {
@@ -522,7 +611,7 @@ declare namespace cloudbase.auth {
      * @return Promise
      *
      */
-    update(userinfo: IUserInfo): Promise<void>;
+    update(userinfo: IUserInfo): Promise<void>
     /**
      * 刷新本地用户信息
      *
@@ -541,20 +630,20 @@ declare namespace cloudbase.auth {
      * @return Promise-刷新后的用户信息
      *
      */
-    refresh(): Promise<IUserInfo>;
+    refresh(): Promise<IUserInfo>
     /**
      * 同步获取本地用户信息
      */
-    checkLocalInfo: () => void;
+    checkLocalInfo: () => void
     /**
      * 异步获取本地用户信息
      */
-    checkLocalInfoAsync: () => Promise<void>;
-    linkWithTicket?: (ticket: string) => Promise<void>;
-    linkWithRedirect?: (provider: IAuthProvider) => void;
-    getLinkedUidList?: () => Promise<{ hasPrimaryUid: boolean, users: IUserInfo[] }>;
-    setPrimaryUid?: (uid: string) => Promise<void>;
-    unlink?: (loginType: 'CUSTOM' | 'WECHAT-OPEN' | 'WECHAT-PUBLIC' | 'WECHAT-UNION') => Promise<void>;
+    checkLocalInfoAsync: () => Promise<void>
+    linkWithTicket?: (ticket: string) => Promise<void>
+    linkWithRedirect?: (provider: IAuthProvider) => void
+    getLinkedUidList?: () => Promise<{ hasPrimaryUid: boolean; users: IUserInfo[] }>
+    setPrimaryUid?: (uid: string) => Promise<void>
+    unlink?: (loginType: 'CUSTOM' | 'WECHAT-OPEN' | 'WECHAT-PUBLIC' | 'WECHAT-UNION') => Promise<void>
   }
 
   interface App {
@@ -573,7 +662,7 @@ declare namespace cloudbase.auth {
      *
      * @return 用户信息，如果未登录返回`null`
      */
-    currentUser: IUser | null;
+    currentUser: IUser | null
     /**
      * 获取当前登录的用户信息-异步操作，文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetcurrentuser}
      *
@@ -592,90 +681,90 @@ declare namespace cloudbase.auth {
     getCurrentUser(): Promise<IUser | null>
     /**
      * 绑定手机号码
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authbindphonenumber}
-     * 
-     * @param params 
+     *
+     * @param params
      */
     bindPhoneNumber(params: authModels.BindPhoneRequest): Promise<void>
     /**
      * 绑定邮箱
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authbindemail}
-     * 
-     * @param params 
+     *
+     * @param params
      */
     bindEmail(params: authModels.BindEmailRequest): Promise<void>
     /**
      * 解除三方绑定
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authunbindprovider}
-     * 
-     * @param params 
+     *
+     * @param params
      */
     unbindProvider(params: authModels.UnbindProviderRequest): Promise<void>
 
     /**
      * 验证码验证
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authverify}
-     * 
-     * @param params 
+     *
+     * @param params
      */
     verify(params: authModels.VerifyRequest): Promise<authModels.VerifyResponse>
     /**
      * 获取验证码
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetverification}
-     * 
-     * @param params 
+     *
+     * @param params
      */
     getVerification(params: authModels.GetVerificationRequest): Promise<authModels.GetVerificationResponse>
     /**
      * 匿名登录
-     * 
-     * 
+     *
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninanonymously}
-     * 
+     *
      */
     signInAnonymously(data?: { provider_token?: string }): Promise<ILoginState>
     /**
      * 设置获取自定义登录 ticket 的函数
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsetcustomsignfunc}
-     * 
-     * 
-     * @param getTickFn 
+     *
+     *
+     * @param getTickFn
      */
     setCustomSignFunc(getTickFn: authModels.GetCustomSignTicketFn): void
     /**
      * 使用自定义登录 ticket 登录
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithcustomticket}
      */
     signInWithCustomTicket(): Promise<ILoginState>
     /**
      * 用户登录，目前支持手机号，邮箱，用户名密码登录
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsignin}
      */
     signIn(params: authModels.SignInRequest): Promise<ILoginState>
     /**
      * 用户注册，目前支持手机号验证码注册，邮箱验证码注册
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsignup}
      */
     signUp(params: authModels.SignUpRequest): Promise<ILoginState>
     /**
      * 设置密码（已登录状态下，更新用户密码）
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsetpassword}
-     * 
+     *
      */
     setPassword(params: authModels.SetPasswordRequest): Promise<void>
     /**
      * 获取用户信息
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetuserinfo}
      */
     getUserInfo(): Promise<IUserInfo>
@@ -694,7 +783,7 @@ declare namespace cloudbase.auth {
      *
      * @return 登录态信息，如果未登录返回`null`
      */
-    hasLoginState(): ILoginState | null;
+    hasLoginState(): ILoginState | null
     /**
      * 获取本地登录态-异步操作
      *
@@ -712,78 +801,80 @@ declare namespace cloudbase.auth {
      *
      * @return Promise-登录态信息，如果未登录返回`null`
      */
-    getLoginState(): Promise<ILoginState | null>;
+    getLoginState(): Promise<ILoginState | null>
     /**
      * @deprecated
      */
     getAuthHeader(): {}
     /**
      * 为已有账户绑定第三方账户
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authbindwithprovider}
      */
-    bindWithProvider(params: authModels.BindWithProviderRequest,): Promise<void>
+    bindWithProvider(params: authModels.BindWithProviderRequest): Promise<void>
     /**
      * 查询用户（自定义登录场景和匿名登录场景，不支持使用该接口查询用户信息）
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authqueryuser}
-     * 
+     *
      */
     queryUser(queryObj: authModels.QueryUserProfileRequest): Promise<authModels.QueryUserProfileResponse>
     /**
      * 获取当前登录用户的访问凭证
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetaccesstoken}
      */
-    getAccessToken(): Promise<{ accessToken: string, env: string }>
+    getAccessToken(): Promise<{ accessToken: string; env: string }>
     /**
      * 提供第三方平台登录 token
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgrantprovidertoken}
      */
     grantProviderToken(params: authModels.GrantProviderTokenRequest): Promise<authModels.GrantProviderTokenResponse>
     patchProviderToken(params: authModels.PatchProviderTokenRequest): Promise<authModels.PatchProviderTokenResponse>
     /**
      * 第三方平台登录
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithprovider}
      */
     signInWithProvider(params: authModels.SignInWithProviderRequest): Promise<ILoginState>
     grantToken(params: authModels.GrantTokenRequest): Promise<ILoginState>
     /**
      * 生成第三方平台授权 Uri （如微信二维码扫码授权网页）
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgenproviderredirecturi}
      */
-    genProviderRedirectUri(params: authModels.GenProviderRedirectUriRequest): Promise<authModels.GenProviderRedirectUriResponse>
+    genProviderRedirectUri(
+      params: authModels.GenProviderRedirectUriRequest,
+    ): Promise<authModels.GenProviderRedirectUriResponse>
     /**
      * 重置密码（用户忘记密码无法登录时，可使用该接口强制设置密码）
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authresetpassword}
      */
     resetPassword(params: authModels.ResetPasswordRequest): Promise<void>
     deviceAuthorize(params: authModels.DeviceAuthorizeRequest): Promise<authModels.DeviceAuthorizeResponse>
     /**
      * 通过 sudo 接口获取高级操作权限，如修改用户密码，修改手机号，邮箱等操作
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsudo}
      */
     sudo(params: authModels.SudoRequest): Promise<authModels.SudoResponse>
     /**
      * 删除用户
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authdeleteme}
      */
     deleteMe(params: authModels.WithSudoRequest): Promise<authModels.UserProfile>
     /**
      * 获取第三方绑定列表
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetproviders}
      */
     getProviders(): Promise<authModels.UserProfileProvider>
     /**
      * 用于查询用户是否为匿名登录状态
-     * 
+     *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authloginscope}
      */
     loginScope(): Promise<string>
@@ -805,7 +896,7 @@ declare namespace cloudbase.auth {
      *
      * @return Promise
      */
-    signOut(): Promise<void>;
+    signOut(): Promise<void>
     /**
      * 检查用户名是否被绑定过
      *
@@ -827,9 +918,11 @@ declare namespace cloudbase.auth {
      *
      * @return Promise-用户是否被绑定
      */
-    isUsernameRegistered(username: string): Promise<boolean>;
+    isUsernameRegistered(username: string): Promise<boolean>
     getMiniProgramQrCode(params: authModels.GetMiniProgramCodeRequest): Promise<authModels.GetMiniProgramCodeResponse>
-    getMiniProgramQrCodeStatus(params: authModels.CheckMiniProgramCodeRequest): Promise<authModels.CheckMiniProgramCodeResponse>
+    getMiniProgramQrCodeStatus(
+      params: authModels.CheckMiniProgramCodeRequest,
+    ): Promise<authModels.CheckMiniProgramCodeResponse>
   }
 }
 /**
@@ -837,16 +930,16 @@ declare namespace cloudbase.auth {
  */
 declare namespace cloudbase.functions {
   interface ICallFunctionOptions {
-    name: string;
-    data?: KV<any>;
-    query?: KV<any>;
-    search?: string;
-    parse?: boolean;
+    name: string
+    data?: KV<any>
+    query?: KV<any>
+    search?: string
+    parse?: boolean
   }
 
   interface ICallFunctionResponse {
-    requestId: string;
-    result: any;
+    requestId: string
+    result: any
   }
 }
 /**
@@ -854,75 +947,101 @@ declare namespace cloudbase.functions {
  */
 declare namespace cloudbase.storage {
   interface ICloudbaseUploadFileParams {
-    cloudPath: string;
-    filePath: string;
-    method?: 'post' | 'put';
-    headers?: KV<string>;
-    onUploadProgress?: Function;
+    cloudPath: string
+    filePath?: string
+    method?: 'post' | 'put'
+    headers?: KV<string>
+    onUploadProgress?: Function
+    // 文件内容 Buffer 或 文件可读流, node端使用
+    fileContent?: any
+    customReqOpts?: ICustomReqOpts
   }
   interface ICloudbaseUploadFileResult {
-    fileID: string;
-    requestId: string;
+    fileID: string
+    requestId: string
   }
   interface ICloudbaseGetUploadMetadataParams {
-    cloudPath: string;
+    cloudPath: string
+    customReqOpts?: ICustomReqOpts
   }
   interface ICloudbaseDeleteFileParams {
-    fileList: string[];
+    fileList: string[]
+    customReqOpts?: ICustomReqOpts
   }
   interface ICloudbaseDeleteFileResult {
-    code?: string;
-    message?: string;
+    code?: string
+    message?: string
     fileList?: {
-      code?: string;
-      fileID: string;
-    }[];
-    requestId?: string;
+      code?: string
+      fileID: string
+    }[]
+    requestId?: string
   }
 
   interface ICloudbaseFileInfo {
-    fileID: string;
-    maxAge: number;
+    fileID: string
+    maxAge: number
   }
 
   interface ICloudbaseGetTempFileURLParams {
-    fileList: string[] | ICloudbaseFileInfo[];
+    fileList: string[] | ICloudbaseFileInfo[]
+    customReqOpts?: ICustomReqOpts
   }
 
   interface ICloudbaseGetTempFileURLResult {
-    code?: string;
-    message?: string;
+    code?: string
+    message?: string
     fileList?: {
-      code?: string;
-      message?: string;
-      fileID: string;
-      tempFileURL: string;
-      download_url?: string;
-    }[];
-    requestId?: string;
+      code?: string
+      message?: string
+      fileID: string
+      tempFileURL: string
+      download_url?: string
+    }[]
+    requestId?: string
   }
   interface ICloudbaseDownloadFileParams {
-    fileID: string;
-    tempFilePath?: string;
+    fileID: string
+    tempFilePath?: string
+    customReqOpts?: ICustomReqOpts
   }
   interface ICloudbaseDownloadFileResult {
-    code?: string;
-    message?: string;
-    fileContent?: any;
-    requestId?: string;
+    code?: string
+    message?: string
+    fileContent?: any
+    requestId?: string
   }
   interface ICloudbaseFileMetaData {
-    url: string;
-    token: string;
-    authorization: string;
-    fileId: string;
-    cosFileId: string;
+    url: string
+    token: string
+    authorization: string
+    fileId: string
+    cosFileId: string
     download_url: string
   }
 
   interface ICloudbaseFileMetaDataRes {
-    data: ICloudbaseFileMetaData;
-    requestId: string;
+    data: ICloudbaseFileMetaData
+    requestId: string
+  }
+
+  interface ICloudbaseCopyFileParams {
+    fileList: Array<{
+      srcPath: string
+      dstPath: string
+      overwrite?: boolean
+      removeOriginal?: boolean
+    }>
+    customReqOpts?: ICustomReqOpts
+  }
+
+  interface ICloudbaseCopyFileResult {
+    fileList: Array<{
+      fileId?: string
+      code?: string
+      message?: string
+    }>
+    requestId?: string
   }
 }
 
@@ -960,8 +1079,8 @@ declare namespace cloudbase.database {
      */
     close: () => void
   }
-  type DataType = 'init' | 'update' | 'add' | 'remove' | 'replace' | 'limit';
-  type QueueType = 'init' | 'enqueue' | 'dequeue' | 'update';
+  type DataType = 'init' | 'update' | 'add' | 'remove' | 'replace' | 'limit'
+  type QueueType = 'init' | 'enqueue' | 'dequeue' | 'update'
   interface ISnapshot {
     id: number
     docChanges: ISingleDBEvent[]
@@ -979,7 +1098,7 @@ declare namespace cloudbase.database {
     removedFields?: any
   }
 
-  type SnapshotType = 'init';
+  type SnapshotType = 'init'
 
   interface IWatchable {
     /**
@@ -1005,7 +1124,7 @@ declare namespace cloudbase.database {
      *
      * @return 实时推送进程实例
      */
-    watch(options: IWatchOptions): DBRealtimeListener;
+    watch(options: IWatchOptions): DBRealtimeListener
   }
   /**
    * collection types
@@ -1018,7 +1137,7 @@ declare namespace cloudbase.database {
      *
      * @param data 文档数据
      */
-    add(data: Object): Promise<Pick<SetRes, 'code' | 'message'>>;
+    add(data: Object): Promise<Pick<SetRes, 'code' | 'message'>>
     /**
      * 获取一条文档的引用
      *
@@ -1026,7 +1145,7 @@ declare namespace cloudbase.database {
      *
      * @param id 文档ID
      */
-    doc(id: string): IDocument;
+    doc(id: string): IDocument
   }
   /**
    * command types
@@ -1040,7 +1159,7 @@ declare namespace cloudbase.database {
     geometry: IPolygon | IMultiPolygon
   }
   interface IGeoIntersectsOptions {
-    geometry: IPoint | ILineString | IMultiPoint | IMultiLineString | IPolygon | IMultiPolygon;
+    geometry: IPoint | ILineString | IMultiPoint | IMultiLineString | IPolygon | IMultiPolygon
   }
   interface ICommand {
     /**
@@ -1057,7 +1176,7 @@ declare namespace cloudbase.database {
      * @param val 接受一个字面量 (literal)，可以是 `number`, `boolean`, `string`, `object`, `array`
      *
      */
-    eq(val: number | string | boolean | Object | any[]): any;
+    eq(val: number | string | boolean | Object | any[]): any
     /**
      * 表示字段不等于某个值
      *
@@ -1072,7 +1191,7 @@ declare namespace cloudbase.database {
      * @param val 接受一个字面量 (literal)，可以是 `number`, `boolean`, `string`, `object`, `array`
      *
      */
-    neq(val: number | string | boolean | Object | any[]): any;
+    neq(val: number | string | boolean | Object | any[]): any
     /**
      * 字段大于指定值
      *
@@ -1087,7 +1206,7 @@ declare namespace cloudbase.database {
      * @param val 数字
      *
      */
-    gt(val: number): any;
+    gt(val: number): any
     /**
      * 字段大于或等于指定值
      *
@@ -1102,7 +1221,7 @@ declare namespace cloudbase.database {
      * @param val 数字
      *
      */
-    gte(val: number): any;
+    gte(val: number): any
     /**
      * 字段小于指定值
      *
@@ -1117,7 +1236,7 @@ declare namespace cloudbase.database {
      * @param val 数字
      *
      */
-    lt(val: number): any;
+    lt(val: number): any
     /**
      * 字段小于或等于指定值
      *
@@ -1132,7 +1251,7 @@ declare namespace cloudbase.database {
      * @param val 数字
      *
      */
-    lte(val: number): any;
+    lte(val: number): any
     /**
      * 字段值在给定的数组中
      *
@@ -1147,7 +1266,7 @@ declare namespace cloudbase.database {
      * @param list 数组
      *
      */
-    in(list: any[]): any;
+    in(list: any[]): any
     /**
      * 字段值不在给定的数组中
      *
@@ -1162,7 +1281,7 @@ declare namespace cloudbase.database {
      * @param list 数组
      *
      */
-    nin(list: any[]): any;
+    nin(list: any[]): any
     /**
      * 表示需同时满足指定的两个或以上的条件
      *
@@ -1177,7 +1296,7 @@ declare namespace cloudbase.database {
      * @param args 多个条件
      *
      */
-    and(...args: any[]): any;
+    and(...args: any[]): any
     /**
      * 表示需满足所有指定条件中的至少一个
      *
@@ -1192,7 +1311,7 @@ declare namespace cloudbase.database {
      * @param args 多个条件
      *
      */
-    or(...args: any[]): any;
+    or(...args: any[]): any
     /**
      * 用于设定字段等于指定值
      *
@@ -1213,7 +1332,7 @@ declare namespace cloudbase.database {
      * @param val 被设定的属性对象
      *
      */
-    set(val: any): any;
+    set(val: any): any
     /**
      * 用于指示字段自增某个值
      *
@@ -1232,7 +1351,7 @@ declare namespace cloudbase.database {
      * @param val 自增的值
      *
      */
-    inc(val: number): any;
+    inc(val: number): any
     /**
      * 用于指示字段自乘某个值
      *
@@ -1251,7 +1370,7 @@ declare namespace cloudbase.database {
      * @param val 自乘的值
      *
      */
-    mul(val: number): any;
+    mul(val: number): any
     /**
      * 用于表示删除某个字段
      *
@@ -1266,7 +1385,7 @@ declare namespace cloudbase.database {
      *   });
      *
      */
-    remove(): any;
+    remove(): any
     /**
      * 向数组尾部追加元素
      *
@@ -1282,7 +1401,7 @@ declare namespace cloudbase.database {
      *
      * @param val 支持传入单个元素或数组
      */
-    push(val: any): any;
+    push(val: any): any
     /**
      * 删除数组尾部元素
      *
@@ -1297,7 +1416,7 @@ declare namespace cloudbase.database {
      *   });
      *
      */
-    pop(): any;
+    pop(): any
     /**
      * 向数组头部添加元素
      *
@@ -1313,7 +1432,7 @@ declare namespace cloudbase.database {
      *
      * @param val 支持传入单个元素或数组
      */
-    unshift(val: any): any;
+    unshift(val: any): any
     /**
      * 删除数组头部元素
      *
@@ -1328,7 +1447,7 @@ declare namespace cloudbase.database {
      *   });
      *
      */
-    shift(): any;
+    shift(): any
     /**
      * 按从近到远的顺序，找出字段值在给定点的附近的文档
      *
@@ -1349,7 +1468,7 @@ declare namespace cloudbase.database {
      * @param options.maxDistance 【可选】最大距离，米为单位
      * @param options.minDistance 【可选】最小距离，米为单位
      */
-    geoNear(options: IGeoNearOptions): any;
+    geoNear(options: IGeoNearOptions): any
     /**
      * 找出字段值在指定 Polygon / MultiPolygon 内的文档，无排序
      *
@@ -1368,7 +1487,7 @@ declare namespace cloudbase.database {
      * @param options
      * @param options.geometry 地理位置
      */
-    geoWithin(options: IGeoWithinOptions): any;
+    geoWithin(options: IGeoWithinOptions): any
     /**
      * 找出字段值和给定的地理位置图形相交的文档
      *
@@ -1385,7 +1504,7 @@ declare namespace cloudbase.database {
      * @param options
      * @param options.geometry 地理位置
      */
-    geoIntersects(options: IGeoIntersectsOptions): any;
+    geoIntersects(options: IGeoIntersectsOptions): any
   }
   /**
    * document types
@@ -1406,7 +1525,7 @@ declare namespace cloudbase.database {
      *
      * @return Promise
      */
-    set(data: Object): Promise<SetRes>;
+    set(data: Object): Promise<SetRes>
     /**
      * 获取查询结果
      *
@@ -1420,7 +1539,7 @@ declare namespace cloudbase.database {
      *
      * @return Promise-查询结果
      */
-    get(): Promise<GetRes>;
+    get(): Promise<GetRes>
     /**
      * 更新文档，如果要更新的文档不存在什么也不会做
      *
@@ -1436,7 +1555,7 @@ declare namespace cloudbase.database {
      *
      * @return Promise
      */
-    update(data: Object): Promise<SetRes>;
+    update(data: Object): Promise<SetRes>
     /**
      * 删除一条文档
      *
@@ -1450,31 +1569,31 @@ declare namespace cloudbase.database {
      *
      * @return Promise
      */
-    remove(): Promise<any>;
+    remove(): Promise<any>
   }
   /**
    * query types
    */
   interface SetRes {
-    code?: string;
-    message?: string;
-    updated?: number;
-    upsertedId?: number;
-    requestId: string;
+    code?: string
+    message?: string
+    updated?: number
+    upsertedId?: number
+    requestId: string
   }
   interface GetRes {
-    data: any[];
-    requestId: string;
-    code?: string;
-    message?: string;
+    data: any[]
+    requestId: string
+    code?: string
+    message?: string
   }
 
   interface UpdateRes {
     requestId: string
     updated?: number
     upsertId?: string
-    code?: string;
-    message?: string;
+    code?: string
+    message?: string
   }
 
   interface QueryOrder {
@@ -1506,7 +1625,7 @@ declare namespace cloudbase.database {
      *
      * @return Promise-查询结果
      */
-    get(): Promise<GetRes>;
+    get(): Promise<GetRes>
     /**
      * 更新数据库文档
      *
@@ -1540,7 +1659,7 @@ declare namespace cloudbase.database {
      *
      * @return Promise-查询结果
      */
-    count(): Promise<any>;
+    count(): Promise<any>
     /**
      * 设置过滤条件
      *
@@ -1555,7 +1674,7 @@ declare namespace cloudbase.database {
      * @param query 可接收对象作为参数，表示筛选出拥有和传入对象相同的 key-value 的文档
      *
      */
-    where(query: Object): ExcludeOf<IQuery, 'where'>;
+    where(query: Object): ExcludeOf<IQuery, 'where'>
     /**
      * 指定查询结果集数量上限
      *
@@ -1570,7 +1689,7 @@ declare namespace cloudbase.database {
      *
      * @param limit 查询结果数量上限
      */
-    limit(limit: number): ExcludeOf<IQuery, 'where'>;
+    limit(limit: number): ExcludeOf<IQuery, 'where'>
     /**
      * 指定查询返回结果时从指定序列后的结果开始返回，常用于分页
      *
@@ -1585,7 +1704,7 @@ declare namespace cloudbase.database {
      *
      * @param offset 跳过的条目数量
      */
-    skip(offset: number): ExcludeOf<IQuery, 'where'>;
+    skip(offset: number): ExcludeOf<IQuery, 'where'>
     /**
      * 指定查询排序条件
      *
@@ -1601,7 +1720,7 @@ declare namespace cloudbase.database {
      * @param field 排序的字段
      * @param orderType 排序的顺序，升序(asc) 或 降序(desc)
      */
-    orderBy(field: string, orderType: 'desc' | 'asc'): ExcludeOf<IQuery, 'where'>;
+    orderBy(field: string, orderType: 'desc' | 'asc'): ExcludeOf<IQuery, 'where'>
     /**
      * 指定返回结果中文档需返回的字段
      *
@@ -1616,7 +1735,7 @@ declare namespace cloudbase.database {
      *
      * @param projection 要过滤的字段集合，不返回传 false，返回传 true
      */
-    field(projection: Object): ExcludeOf<IQuery, 'where'>;
+    field(projection: Object): ExcludeOf<IQuery, 'where'>
     /**
      * 删除查询到的结果
      *
@@ -1631,17 +1750,17 @@ declare namespace cloudbase.database {
      *
      * @return Promise
      */
-    remove(): Promise<any>;
+    remove(): Promise<any>
   }
   /**
    * geo types
    */
-  interface IPoint { }
-  interface ILineString { }
-  interface IPolygon { }
-  interface IMultiPoint { }
-  interface IMultiLineString { }
-  interface IMultiPolygon { }
+  interface IPoint {}
+  interface ILineString {}
+  interface IPolygon {}
+  interface IMultiPoint {}
+  interface IMultiLineString {}
+  interface IMultiPolygon {}
   interface IGeo {
     /**
      * 用于表示地理位置点
@@ -1657,8 +1776,8 @@ declare namespace cloudbase.database {
      * @return Point
      */
     Point: {
-      new(longitude: number, latitude: number): IPoint;
-    };
+      new (longitude: number, latitude: number): IPoint
+    }
     /**
      * 用于表示地理路径，是由两个或者更多的 Point 组成的线段
      *
@@ -1672,7 +1791,7 @@ declare namespace cloudbase.database {
      * @return LineString
      */
     LineString: {
-      new(points: IPoint[]): ILineString;
+      new (points: IPoint[]): ILineString
     }
     /**
      * 用于表示地理上的一个多边形
@@ -1687,7 +1806,7 @@ declare namespace cloudbase.database {
      * @return Polygon
      */
     Polygon: {
-      new(lines: ILineString[]): IPolygon;
+      new (lines: ILineString[]): IPolygon
     }
     /**
      * 用于表示多个点 Point 的集合
@@ -1702,7 +1821,7 @@ declare namespace cloudbase.database {
      * @return MultiPoint
      */
     MultiPoint: {
-      new(points: IPoint[]): IMultiPoint;
+      new (points: IPoint[]): IMultiPoint
     }
     /**
      * 用于表示多个地理路径 LineString 的集合
@@ -1717,7 +1836,7 @@ declare namespace cloudbase.database {
      * @return MultiLineString
      */
     MultiLineString: {
-      new(lines: ILineString[]): IMultiLineString;
+      new (lines: ILineString[]): IMultiLineString
     }
     /**
      * 用于表示多个地理多边形 Polygon 的集合
@@ -1732,18 +1851,18 @@ declare namespace cloudbase.database {
      * @return MultiPolygon
      */
     MultiPolygon: {
-      new(polygons: IPolygon[]): IMultiPolygon;
+      new (polygons: IPolygon[]): IMultiPolygon
     }
   }
   /**
    * regexp types
    */
   interface IRegExpOptions {
-    regexp: string;
-    options?: string;
+    regexp: string
+    options?: string
   }
   interface IRegExp {
-    (options: IRegExpOptions): any;
+    (options: IRegExpOptions): any
   }
   /**
    * instance types
@@ -1754,13 +1873,13 @@ declare namespace cloudbase.database {
      *
      * {@link https://docs.cloudbase.net/api-reference/webv3/database#%E6%9F%A5%E8%AF%A2%E6%8C%87%E4%BB%A4}
      */
-    command: ICommand;
+    command: ICommand
     /**
      * 数据库Geo地理位置
      *
      * {@link https://docs.cloudbase.net/api-reference/webv3/database.html#geo-shu-ju-lei-xing}
      */
-    Geo: IGeo;
+    Geo: IGeo
     /**
      * 根据正则表达式进行筛选
      *
@@ -1778,7 +1897,7 @@ declare namespace cloudbase.database {
      * @param options.regexp 正则表达式Pattern
      * @param options.options 正则表达式Flags
      */
-    RegExp: IRegExp;
+    RegExp: IRegExp
     /**
      * 创建集合的引用
      *
@@ -1791,10 +1910,9 @@ declare namespace cloudbase.database {
      *
      * @return 集合的引用
      */
-    collection(name: string): ICollection;
+    collection(name: string): ICollection
   }
 }
 
-
-export default cloudbase;
-export as namespace cloudbase;
+export default cloudbase
+export as namespace cloudbase