@dcloudio/uni-app-x 0.7.90 → 0.7.91

package/types/uni-cloud/interface.d.ts

@@ -291,11 +291,11 @@ type UniCloudUserInfo = {
 };
 
 declare class UniCloudError extends Error {
-  code: any;
-  errMsg: string;
-  errCode: any;
-  errSubject?: string;
-  requestId?: string;
+  code: any
+  errMsg: string
+  errCode: any
+  errSubject?: string
+  requestId?: string
   /**
    * 错误详情
    * @description 合并查询请求
@@ -328,55 +328,72 @@ declare class UniCloudError extends Error {
    *   }
    * }
    */
-  detail?: UTSJSONObject;
+  detail?: UTSJSONObject
+
   constructor(message: string, code: string, subject?: string, options?: UTSJSONObject);
-  private _init;
+
+  private _init
+
   toJson(): UTSJSONObject;
 }
 
 declare class EventEmitter<T> {
-  private _callbacks;
+  private _callbacks
+
   constructor();
+
   on(eventName: string, callback: UniCloudCallback<T>): void;
+
   off(eventName: string, callback: UniCloudCallback<T>): void;
+
   emit(eventName: string, arg: T): void;
 }
 
 declare class UniCloudUnified {
-  config: UniCloudInitOptions;
-  private _client;
-  private _baseSystemInfo;
-  private _hasBaseSystemInfo;
-  private _provider;
-  private _spaceId;
-  private _prepareLocalServerHub;
-  responseEventEmitter: EventEmitter<UniCloudResponseEvent>;
-  refreshTokenEventEmitter: EventEmitter<UniCloudRefreshTokenEvent>;
+  config: UniCloudInitOptions
+  private _client
+  private _baseSystemInfo
+  private _hasBaseSystemInfo
+  private _provider
+  private _spaceId
+  private _prepareLocalServerHub
+  responseEventEmitter: EventEmitter<UniCloudResponseEvent>
+  refreshTokenEventEmitter: EventEmitter<UniCloudRefreshTokenEvent>
+
   constructor(options: UniCloudInitOptions);
-  private _getBaseSystemInfo;
-  private _getSystemInfo;
-  private _getUniIdToken;
-  private _isServerOk;
-  private _pingLocalServer;
-  private _prepareLocalServer;
-  private _checkFunction;
-  private _prepareFunction;
-  private _getCallFunctionOptions;
-  private _callCloudFunction;
-  private _callLocalFunction;
+
+  private _getBaseSystemInfo
+  private _getSystemInfo
+  private _getUniIdToken
+  private _isServerOk
+  private _pingLocalServer
+  private _prepareLocalServer
+  private _checkFunction
+  private _prepareFunction
+  private _getCallFunctionOptions
+  private _callCloudFunction
+  private _callLocalFunction
+
   callFunction<T = UTSJSONObject>(options: UniCloudCallFunctionOptions): Promise<UniCloudCallFunctionResult<T>>;
+
   uploadFile(options: UniCloudUploadFileOptions): Promise<UniCloudUploadFileResult>;
+
   getTempFileURL(options: UniCloudGetTempFileURLOptions): Promise<UniCloudGetTempFileURLResult>;
+
   importObject(objectName: string, options: UniCloudImportObjectOptions): UniCloudCloudObjectCaller;
 }
 
 declare class InternalUniCloudCloudObjectCaller {
-  protected _obj: InternalUniCloudCloudObject;
+  protected _obj: InternalUniCloudCloudObject
+
   constructor(obj: InternalUniCloudCloudObject);
+
   protected _getArgs(...args: Array<any | null>): Array<any | null>;
 }
 
-type UniCloudCloudObjectCaller = InternalUniCloudCloudObjectCaller & Record<string, <T = UTSJSONObject>(...args: Array<any | null>) => Promise<T>>;
+type UniCloudCloudObjectCaller =
+  InternalUniCloudCloudObjectCaller
+  & Record<string, <T = UTSJSONObject>(...args: Array<any | null>) => Promise<T>>;
 
 type UniCloudImportObjectLoadingOptions = {
   /**
@@ -444,154 +461,226 @@ type UniCloudImportObjectOptions = {
    */
   secretMethods?: Record<string, SecretType>;
 };
+
 declare class InternalUniCloudCloudObject {
-  private _name;
-  private _client;
-  private _customUI;
-  private _loadingUITitle;
-  private _loadingUIMask;
-  private _errorUIType;
-  private _errorUIRetry;
+  private _name
+  private _client
+  private _customUI
+  private _loadingUITitle
+  private _loadingUIMask
+  private _errorUIType
+  private _errorUIRetry
+
   constructor(client: UniCloudUnified, name: string, options: UniCloudImportObjectOptions);
-  private _initUIOptions;
-  private _internalCallMethod;
+
+  private _initUIOptions
+  private _internalCallMethod
+
   callMethod<T = UTSJSONObject>(methodName: string, args: Array<any | null>): Promise<T>;
 }
 
 declare class Stage {
-  $method: string;
-  $param?: Array<any> | null;
+  $method: string
+  $param?: Array<any> | null
+
   constructor($method: string, $param?: Array<any> | null);
 }
+
 declare class Stages {
-  private _client?;
-  private _stages;
-  private _isNew;
+  private _client?
+  private _stages
+  private _isNew
+
   constructor(stages?: Array<Stage>, isNew?: boolean, client?: UniCloudUnified | null);
+
   push(stage: Stage): Stages;
+
   toJSON(): UTSJSONObject;
-  private _emitResponse;
+
+  private _emitResponse
+
   sendAdd(): Promise<UniCloudDBAddResult>;
+
   sendBatchAdd(): Promise<UniCloudDBBatchAddResult>;
+
   sendUpdate(): Promise<UniCloudDBUpdateResult>;
+
   sendRemove(): Promise<UniCloudDBRemoveResult>;
+
   sendGet(): Promise<UniCloudDBGetResult>;
+
   sendCount(): Promise<UniCloudDBCountResult>;
-  private _send;
+
+  private _send
 }
 
 declare class UniCloudDBQuery {
-  private _client;
-  private _stages;
+  private _client
+  private _stages
+
   constructor(client: UniCloudUnified, stages: Stages);
+
   get(arg?: UTSJSONObject | null): Promise<UniCloudDBGetResult>;
+
   count(): Promise<UniCloudDBCountResult>;
+
   getTemp(): UTSJSONObject;
+
   field(filed: string): UniCloudDBQuery;
+
   skip(num: number): UniCloudDBQuery;
+
   limit(num: number): UniCloudDBQuery;
+
   orderBy(order: string): UniCloudDBQuery;
+
   groupBy(field: string): UniCloudDBQuery;
+
   groupField(field: string): UniCloudDBQuery;
+
   distinct(field: string): UniCloudDBQuery;
+
   geoNear(options: UTSJSONObject): UniCloudDBQuery;
 }
 
 declare class UniCloudDBFilter {
-  private _client;
-  private _stages;
+  private _client
+  private _stages
+
   constructor(client: UniCloudUnified, stages: Stages);
+
   get(arg?: UTSJSONObject | null): Promise<UniCloudDBGetResult>;
+
   count(): Promise<UniCloudDBCountResult>;
+
   update(data: UTSJSONObject): Promise<UniCloudDBUpdateResult>;
+
   remove(): Promise<UniCloudDBRemoveResult>;
+
   getTemp(): UTSJSONObject;
+
   where(condition: any): UniCloudDBFilter;
+
   doc(docId: string): UniCloudDBFilter;
+
   field(filed: string): UniCloudDBQuery;
+
   skip(num: number): UniCloudDBQuery;
+
   limit(num: number): UniCloudDBQuery;
+
   orderBy(order: string): UniCloudDBQuery;
+
   groupBy(field: string): UniCloudDBQuery;
+
   groupField(field: string): UniCloudDBQuery;
+
   distinct(field: string): UniCloudDBQuery;
+
   geoNear(options: UTSJSONObject): UniCloudDBQuery;
 }
 
 declare class Collection {
-  private _client;
-  private _collectionList;
-  private _stages;
+  private _client
+  private _collectionList
+  private _stages
+
   constructor(client: UniCloudUnified, collectionList: Array<any>);
+
   where(condition: any): UniCloudDBFilter;
+
   doc(docId: string): UniCloudDBFilter;
+
   aggregate(): UniCloudDBFilter;
+
   foreignKey(foreignKey: string): UniCloudDBFilter;
+
   add(data: UTSJSONObject): Promise<UniCloudDBAddResult>;
   add(data: UTSJSONObject[]): Promise<UniCloudDBBatchAddResult>;
+
   get(arg?: UTSJSONObject | null): Promise<UniCloudDBGetResult>;
+
   count(): Promise<UniCloudDBCountResult>;
+
   getTemp(): UTSJSONObject;
+
   field(filed: string): UniCloudDBQuery;
+
   skip(num: number): UniCloudDBQuery;
+
   limit(num: number): UniCloudDBQuery;
+
   orderBy(order: string): UniCloudDBQuery;
 }
 
 declare class UniCloudDBCommand {
-  private static _push;
+  private static _push
+
   /**
    * 查询操作符，用于表示逻辑 "与" 的关系，表示需同时满足多个查询筛选条件
    */
   static and(args: Array<UTSJSONObject>): UTSJSONObject;
+
   /**
    * 查询操作符，用于表示逻辑 "或" 的关系，表示需同时满足多个查询筛选条件
    */
   static or(args: Array<UTSJSONObject>): UTSJSONObject;
+
   /**
    * 查询操作符，用于表示逻辑 "非" 的关系，表示需不满足指定的条件
    */
   static not(arg: UTSJSONObject): UTSJSONObject;
+
   /**
    * 查询操作符，用于表示逻辑 "都不" 的关系，表示需不满足指定的所有条件
    */
   static nor(args: Array<UTSJSONObject>): UTSJSONObject;
+
   /**
    * 查询筛选条件，表示字段等于某个值
    */
   static eq(arg: any): UTSJSONObject;
+
   /**
    * 查询筛选条件，表示字段不等于某个值
    */
   static neq(arg: any): UTSJSONObject;
+
   /**
    * 查询筛选操作符，表示需小于指定值
    */
   static lt(arg: any): UTSJSONObject;
+
   /**
    * 查询筛选操作符，表示需小于或等于指定值
    */
   static lte(arg: any): UTSJSONObject;
+
   /**
    * 查询筛选操作符，表示需大于指定值
    */
   static gt(arg: any): UTSJSONObject;
+
   /**
    * 查询筛选操作符，表示需大于或等于指定值
    */
   static gte(arg: any): UTSJSONObject;
+
   /**
    * 查询筛选操作符，表示要求值在给定的数组内
    */
   static in(arr: Array<any>): UTSJSONObject;
+
   /**
    * 查询筛选操作符，表示要求值不在给定的数组内
    */
   static nin(arr: Array<any>): UTSJSONObject;
+
   /**
    * 判断字段是否存在
    */
   static exists(arg: boolean): UTSJSONObject;
+
   /**
    * 查询筛选操作符，给定除数 divisor 和余数 remainder
    * @param divisor 除数
@@ -599,26 +688,32 @@ declare class UniCloudDBCommand {
    * @returns
    */
   static mod(divisor: number, remainder: number): UTSJSONObject;
+
   /**
    * 数组查询操作符。用于数组字段的查询筛选条件，要求数组字段中包含给定数组的所有元素
    */
   static all(arr: Array<any>): UTSJSONObject;
+
   /**
    * 用于数组字段的查询筛选条件，要求数组中包含至少一个满足 elemMatch 给定的所有条件的元素
    */
   static elemMatch(arg: UTSJSONObject): UTSJSONObject;
+
   /**
    * 更新操作符，用于数组字段的查询筛选条件，要求数组长度为给定值
    */
   static size(arg: number): UTSJSONObject;
+
   /**
    * 按从近到远的顺序，找出字段值在给定点的附近的记录
    */
   static geoNear(arg: UTSJSONObject): UTSJSONObject;
+
   /**
    * 找出字段值在指定区域内的记录，无排序。指定的区域必须是多边形（Polygon）或多边形集合（MultiPolygon）
    */
   static geoWithin(arg: UTSJSONObject): UTSJSONObject;
+
   /**
    * 找出给定的地理位置图形相交的记录
    */
@@ -628,45 +723,57 @@ declare class UniCloudDBCommand {
 declare class Geometry extends UTSJSONObject {
   constructor(arg: UTSJSONObject);
 }
+
 declare class GeoPoint extends Geometry {
   constructor(lat: number, lng: number);
 }
+
 declare class GeoLineString extends Geometry {
   constructor(points: Array<GeoPoint>);
 }
+
 declare class GeoPolygon extends Geometry {
   constructor(lines: Array<GeoLineString>);
 }
+
 declare class GeoMultiPoint extends Geometry {
   constructor(points: Array<GeoPoint>);
 }
+
 declare class GeoMultiLineString extends Geometry {
   constructor(lines: Array<GeoLineString>);
 }
+
 declare class GeoMultiPolygon extends Geometry {
   constructor(polygons: Array<GeoPolygon>);
 }
+
 declare class UniCloudDBGeo {
   /**
    * 地理位置点
    */
   static get Point(): typeof GeoPoint;
+
   /**
    * 地理路径，是由两个或者更多的 Point 组成的线段
    */
   static get LineString(): typeof GeoLineString;
+
   /**
    * 地理上的一个多边形（有洞或无洞均可），它是由一个或多个闭环 LineString 组成的几何图形
    */
   static get Polygon(): typeof GeoPolygon;
+
   /**
    * 多个地理位置点 Point 的集合
    */
   static get MultiPoint(): typeof GeoMultiPoint;
+
   /**
    * 多个地理路径 LineString 的集合
    */
   static get MultiLineString(): typeof GeoMultiLineString;
+
   /**
    * 多个地理多边形 Polygon 的集合
    */
@@ -674,11 +781,16 @@ declare class UniCloudDBGeo {
 }
 
 declare class Database {
-  private _client;
+  private _client
+
   constructor(client: UniCloudUnified);
+
   collection(...args: Array<any>): Collection;
+
   get command(): typeof UniCloudDBCommand;
+
   get Geo(): typeof UniCloudDBGeo;
+
   /**
    * 合并查询请求
    * @description 合并查询请求
@@ -755,19 +867,23 @@ type UniCloudConnectWebSocketOptions = {
 
 declare class SSEChannel implements IJSONStringify {
   constructor();
+
   /**
    * @description 开启通道，注意只有开启之后才能把SSEChannel实例传入云函数
    */
   open(): Promise<void>;
+
   toJSON(): {
     appId: string;
     pushClientId: string;
     seqId: string;
   };
+
   /**
    * @description 关闭通道
    */
   close(): void;
+
   /**
    * @description 监听消息接收事件
    */
@@ -788,6 +904,7 @@ declare class SSEChannel implements IJSONStringify {
    * @description 监听连接错误事件
    */
   on(event: 'error', callback: (error: UniCloudError) => void): void;
+
   /**
    * @description 取消监听消息接收事件
    */
@@ -810,13 +927,26 @@ declare class SSEChannel implements IJSONStringify {
   off(event: 'error', callback: (error: UniCloudError) => void): void;
 }
 
+
+/** 故障切换事件回调参数 */
+type UniCloudFailoverEvent = {
+  /** 是否启用故障切换 */
+  isEnabled: boolean
+  /** 状态是否有变化 */
+  hasStatusChanged: boolean
+  /** 备用服务空间配置 */
+  failoverSpace?: UniCloudInitOptions
+}
+
 declare class UniCloud {
-  private _client;
-  private _provider;
-  private _spaceId;
-  config: UniCloudInitOptions;
-  mixinDatacom: typeof mixinDatacom;
+  private _client
+  private _provider
+  private _spaceId
+  config: UniCloudInitOptions
+  mixinDatacom: typeof mixinDatacom
+
   constructor(options: UniCloudInitOptions);
+
   // /**
   //  * 连接其他服务空间
   //  * @uniPlatform {
@@ -904,6 +1034,7 @@ declare class UniCloud {
    * }
    */
   callFunction<T = UTSJSONObject>(options: UniCloudCallFunctionOptions): Promise<UniCloudCallFunctionResult<T>>;
+
   /**
    * 上传文件到云存储
    * @description 上传文件到云存储
@@ -937,6 +1068,7 @@ declare class UniCloud {
    * }
    */
   uploadFile(options: UniCloudUploadFileOptions): Promise<UniCloudUploadFileResult>;
+
   /**
    * 获取文件临时URL
    * @description 获取文件临时URL
@@ -970,6 +1102,7 @@ declare class UniCloud {
    * }
    */
   getTempFileURL(options: UniCloudGetTempFileURLOptions): Promise<UniCloudGetTempFileURLResult>;
+
   /**
    * 引用云对象
    * @description 引用云对象
@@ -1007,6 +1140,7 @@ declare class UniCloud {
    * }
    */
   importObject(objectName: string | string.CloudObjectString, options?: UniCloudImportObjectOptions): UniCloudCloudObjectCaller;
+
   /**
    * 监听响应事件
    * @description 监听响应事件
@@ -1040,6 +1174,7 @@ declare class UniCloud {
    * }
    */
   onResponse(callback: UniCloudCallback<UniCloudResponseEvent>): void;
+
   /**
    * 移除响应事件监听
    * @description 移除响应事件监听
@@ -1073,6 +1208,7 @@ declare class UniCloud {
    * }
    */
   offResponse(callback: UniCloudCallback<UniCloudResponseEvent>): void;
+
   /**
    * 监听token刷新事件
    * @description 监听token刷新事件
@@ -1106,6 +1242,7 @@ declare class UniCloud {
    * }
    */
   onRefreshToken(callback: UniCloudCallback<UniCloudRefreshTokenEvent>): void;
+
   /**
    * 移除token刷新事件监听
    * @description 移除token刷新事件监听
@@ -1139,6 +1276,7 @@ declare class UniCloud {
    * }
    */
   offRefreshToken(callback: UniCloudCallback<UniCloudRefreshTokenEvent>): void;
+
   /**
    * 获取数据库操作实例
    * @description 获取数据库操作实例
@@ -1172,6 +1310,7 @@ declare class UniCloud {
    * }
    */
   databaseForJQL(): Database;
+
   /**
    * 获取token内缓存的用户信息
    * @description 获取token内缓存的用户信息
@@ -1205,6 +1344,7 @@ declare class UniCloud {
    * }
    */
   getCurrentUserInfo(): UniCloudUserInfo;
+
   /**
    * 选择并上传文件
    * @description 选择并上传文件
@@ -1238,6 +1378,7 @@ declare class UniCloud {
    * }
    */
   chooseAndUploadFile(options: UniCloudChooseAndUploadFileOptions): Promise<UniCloudChooseAndUploadFileResult>;
+
   /**
    * 连接 WebSocket
    * @description 连接 WebSocket
@@ -1271,6 +1412,7 @@ declare class UniCloud {
    * }
    */
   connectWebSocket(options: UniCloudConnectWebSocketOptions): SocketTask;
+
   /**
    * 服务端通知通道
    * @description 服务端通知通道
@@ -1304,8 +1446,109 @@ declare class UniCloud {
    * }
    */
   get SSEChannel(): typeof SSEChannel;
+
+  /**
+   * 监听故障切换事件
+   * @description 监听故障切换事件
+   * @uniPlatform {
+   *   "app": {
+   *     "android": {
+   *       "osVer": "5.0",
+   *       "uniVer": "√",
+   *       "unixVer": "5.0"
+   *     },
+   *     "ios": {
+   *       "uniVer": "√",
+   *       "unixVer": "5.0"
+   *     },
+   *     "harmony": {
+   *      "uniVer": "√",
+   *      "unixVer": "5.0"
+   *     }
+   *   },
+   *   "mp": {
+   *     "weixin": {
+   *       "osVer": "√",
+   *       "uniVer": "√",
+   *       "unixVer": "5.0"
+   *     }
+   *   },
+   *   "web": {
+   *      "uniVer": "√",
+   *      "unixVer": "5.0"
+   *   }
+   * }
+   */
+  onFailover(callback: UniCloudCallback<UniCloudFailoverEvent>): void
+
+  /**
+   * 移除故障切换事件监听
+   * @description 移除故障切换事件监听
+   * @uniPlatform {
+   *   "app": {
+   *     "android": {
+   *       "osVer": "5.0",
+   *       "uniVer": "√",
+   *       "unixVer": "5.0"
+   *     },
+   *     "ios": {
+   *       "uniVer": "√",
+   *       "unixVer": "5.0"
+   *     },
+   *     "harmony": {
+   *      "uniVer": "√",
+   *      "unixVer": "5.0"
+   *     }
+   *   },
+   *   "mp": {
+   *     "weixin": {
+   *       "osVer": "√",
+   *       "uniVer": "√",
+   *       "unixVer": "5.0"
+   *     }
+   *   },
+   *   "web": {
+   *      "uniVer": "√",
+   *      "unixVer": "5.0"
+   *   }
+   * }
+   */
+  offFailover(callback: UniCloudCallback<UniCloudFailoverEvent>): void
 }
 
-declare const uniCloud: UniCloud;
+declare const uniCloud: UniCloud
 
-export { type UniCloudCallFunctionOptions, type UniCloudCallFunctionResult, type UniCloudChooseAndUploadFileOptions, type UniCloudChooseAndUploadFileResult, type UniCloudChooseAndUploadFileItem, type UniCloudChooseAndUploadFileProgressEvent, type UniCloudDBAddResult, type UniCloudDBBatchAddResult, type UniCloudDBCountResult, UniCloudDBFilter, type UniCloudDBGetResult, UniCloudDBQuery, type UniCloudDBRemoveResult, type UniCloudDBUpdateResult, type UniCloudDBMultiSendResultItem, type UniCloudDBMultiSendResult, UniCloudError, type UniCloudGetTempFileURLOptions, type UniCloudGetTempFileURLResult, type UniCloudGetTempFileURLResultItem, type UniCloudImportObjectErrorOptions, type UniCloudImportObjectLoadingOptions, type UniCloudImportObjectOptions, type UniCloudInitOptions, type UniCloudRefreshTokenEvent, type UniCloudResponseEvent, type UniCloudUploadFileOptions, type UniCloudUploadFileResult, type UniCloudUploadProgress, type UniCloudUserInfo, uniCloud };
+export {
+  type UniCloudCallFunctionOptions,
+  type UniCloudCallFunctionResult,
+  type UniCloudChooseAndUploadFileOptions,
+  type UniCloudChooseAndUploadFileResult,
+  type UniCloudChooseAndUploadFileItem,
+  type UniCloudChooseAndUploadFileProgressEvent,
+  type UniCloudDBAddResult,
+  type UniCloudDBBatchAddResult,
+  type UniCloudDBCountResult,
+  UniCloudDBFilter,
+  type UniCloudDBGetResult,
+  UniCloudDBQuery,
+  type UniCloudDBRemoveResult,
+  type UniCloudDBUpdateResult,
+  type UniCloudDBMultiSendResultItem,
+  type UniCloudDBMultiSendResult,
+  UniCloudError,
+  type UniCloudGetTempFileURLOptions,
+  type UniCloudGetTempFileURLResult,
+  type UniCloudGetTempFileURLResultItem,
+  type UniCloudImportObjectErrorOptions,
+  type UniCloudImportObjectLoadingOptions,
+  type UniCloudImportObjectOptions,
+  type UniCloudInitOptions,
+  type UniCloudRefreshTokenEvent,
+  type UniCloudResponseEvent,
+  type UniCloudUploadFileOptions,
+  type UniCloudUploadFileResult,
+  type UniCloudUploadProgress,
+  type UniCloudUserInfo,
+  type UniCloudFailoverEvent,
+  uniCloud
+}