@cloudbase/js-sdk 2.25.5-alpha.0 → 2.25.5-alpha.1

package/index.d.ts

@@ -1,6 +1,6 @@
-import { OrmClient, OrmRawQueryClient } from '@cloudbase/model';
-import { IMySqlClient } from '@cloudbase/mysql';
-import { authModels } from '@cloudbase/oauth';
+import { OrmClient, OrmRawQueryClient } from '@cloudbase/model'
+import { IMySqlClient } from '@cloudbase/mysql'
+import { authModels } from '@cloudbase/oauth'
 import type {
   SignInRes,
   GetUserRes,
@@ -28,9 +28,9 @@ import type {
   ResendReq,
   SetSessionReq,
   DeleteMeReq,
-  SignUpRes
-} from '@cloudbase/auth';
-import { AI } from '@cloudbase/ai';
+  SignUpRes,
+} from '@cloudbase/auth'
+import { AI } from '@cloudbase/ai'
 import { CloudbaseAdapter, ResponseObject } from '@cloudbase/adapter-interface'
 import { ICloudbaseUpgradedConfig, ICloudbase, Persistence } from '@cloudbase/types'
 import { LANGS } from '@cloudbase/types'
@@ -42,7 +42,6 @@ type KV<T> = {
 
 type ExcludeOf<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>
 
-
 declare type MethodType = 'request' | 'post' | 'get' | 'head' | 'patch' | 'delete' | 'put'
 
 interface ICallApiOptions {
@@ -95,7 +94,7 @@ declare namespace cloudbase {
     }
     accessKey?: string
     endPointMode?: EndPointKey
-    lang?: LANGS 
+    lang?: LANGS
   }
 
   interface ICloudbaseExtension {
@@ -537,7 +536,7 @@ declare namespace cloudbase.app {
      *
      * @return 数据库实例
      */
-    database(dbConfig?: { instance?: string; database?: string; }): cloudbase.database.App
+    database(dbConfig?: { instance?: string; database?: string }): cloudbase.database.App
     /**
      * 调用扩展能力插件功能
      *
@@ -584,24 +583,24 @@ declare namespace cloudbase.app {
 
     /**
      * MySQL 数据库
-     * 
+     *
      * @example
      * ```javascript
      * const app = cloudbase.init({
      *   env: "xxxx-yyy"
      * });
-     * 
+     *
      * app.mysql().from('todos').select().then((res) => {
      *   console.log(res.data);
      * });
      * ```
      */
-    mysql: IMySqlClient;
-    rdb: IMySqlClient;
+    mysql: IMySqlClient
+    rdb: IMySqlClient
 
-    ai(): AI;
+    ai(): AI
 
-    apis: ICloudbaseApis;
+    apis: ICloudbaseApis
   }
 }
 /**
@@ -790,7 +789,10 @@ declare namespace cloudbase.auth {
      * @param params
      * @param options
      */
-    getVerification(params: authModels.GetVerificationRequest, options?: { withCaptcha: boolean }): Promise<authModels.GetVerificationResponse>
+    getVerification(
+      params: authModels.GetVerificationRequest,
+      options?: { withCaptcha: boolean },
+    ): Promise<authModels.GetVerificationResponse>
     /**
      * 匿名登录
      *
@@ -996,7 +998,10 @@ declare namespace cloudbase.auth {
     loginScope(): Promise<string>
     loginGroups(): Promise<string[]>
     onLoginStateChanged(callback: Function)
-    createLoginState(params?: { version?: string; query?: any }, options?: { asyncRefreshUser?: boolean; userInfo?: any }): Promise<ILoginState>
+    createLoginState(
+      params?: { version?: string; query?: any },
+      options?: { asyncRefreshUser?: boolean; userInfo?: any },
+    ): Promise<ILoginState>
     /**
      * 强制刷新token
      *
@@ -1078,18 +1083,19 @@ declare namespace cloudbase.auth {
      * @return Promise-用户是否被绑定
      */
     isUsernameRegistered(username: string): Promise<boolean>
-    getMiniProgramQrCode(params: authModels.GetMiniProgramQrCodeRequest): Promise<authModels.GetMiniProgramQrCodeResponse>
+    getMiniProgramQrCode(
+      params: authModels.GetMiniProgramQrCodeRequest,
+    ): Promise<authModels.GetMiniProgramQrCodeResponse>
     getMiniProgramQrCodeStatus(
       params: authModels.GetMiniProgramQrCodeStatusRequest,
     ): Promise<authModels.GetMiniProgramQrCodeStatusResponse>
     /**
      * 跳转到默认登录页
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authtodefaultloginpage}
-     * @param params 
+     * @param params
      */
     toDefaultLoginPage(params?: authModels.ToDefaultLoginPage): Promise<CommonRes>
 
-    
     /**
      * 退出登录
      *
@@ -1133,7 +1139,9 @@ declare namespace cloudbase.auth {
      *
      * @param callback
      */
-    onAuthStateChange(callback: OnAuthStateChangeCallback): { data: { subscription: { id: string; callback: Function; unsubscribe: () => void } } }
+    onAuthStateChange(callback: OnAuthStateChangeCallback): {
+      data: { subscription: { id: string; callback: Function; unsubscribe: () => void } }
+    }
     /**
      * 使用用户名和密码登录
      *
@@ -2295,6 +2303,14 @@ declare namespace cloudbase.database {
      * @return 集合的引用
      */
     collection(name: string): ICollection
+
+    runCommands(params: IRunCommandsReq): Promise<{
+      statusCode: number
+      requestId: string
+      list?: Object[][]
+      code?: string
+      message?: string
+    }>
   }
 }