@cloudbase/types 1.2.3-alpha.0 → 1.8.2

package/auth.d.ts

@@ -1,6 +1,6 @@
 import { ICloudbaseConfig, KV, ICloudbase } from '.';
 
-export type ICloudbaseAuthConfig = Pick<ICloudbaseConfig, 'env' | 'region' | 'persistence' | 'debug' | '_fromApp'>;
+export type ICloudbaseAuthConfig = Pick<ICloudbaseConfig, 'env'|'region'|'persistence'|'debug'>;
 
 export interface IAccessTokenInfo {
   accessToken: string;
@@ -37,14 +37,14 @@ export interface IUserInfo {
   province?: string;
   city?: string;
 }
-export interface IUser extends IUserInfo {
+export interface IUser extends IUserInfo{
   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>;
+  unlink(loginType: 'CUSTOM'| 'WECHAT-OPEN' | 'WECHAT-PUBLIC' | 'WECHAT-UNION'): Promise<void>;
   update(userinfo: IUserInfo): Promise<void>;
   refresh(): Promise<IUserInfo>;
 }
@@ -64,8 +64,8 @@ export interface ICloudbaseAuth {
   anonymousAuthProvider: any;
   customAuthProvider: any;
   getAccessToken(): IAccessTokenInfo;
-  getLoginState(): Promise<ILoginState | null>;
-  hasLoginState(): Promise<ILoginState | null>;
+  getLoginState(): Promise<ILoginState|null>;
+  hasLoginState(): Promise<ILoginState|null>;
   getUserInfo(): Promise<any>;
   getAuthHeader(): Promise<KV<string>>;
   onLoginStateChanged(callback: Function): void;
@@ -76,9 +76,9 @@ export interface ICloudbaseAuth {
   shouldRefreshAccessToken(hook: Function): void;
 }
 
-type IProvider = new (...args: any[]) => any;
+type IProvider = new(...args: any[]) => any;
 
 export interface ICloudbaseAuthModule {
   registerAuth(app: ICloudbase): void,
   registerProvider(name: string, provider: IProvider): void;
-}
+}

package/cache.d.ts

@@ -1,4 +1,4 @@
-import { ICloudbasePlatformInfo, KV,ICloudbaseConfig } from ".";
+import { ICloudbasePlatformInfo, KV, ICloudbaseConfig } from '.';
 
 export type ICacheConfig = Pick < ICloudbaseConfig, 'debug' | 'persistence' > & {
   platformInfo?: ICloudbasePlatformInfo;
@@ -7,20 +7,20 @@ export type ICacheConfig = Pick < ICloudbaseConfig, 'debug' | 'persistence' > &
 };
 
 export interface ICloudbaseCache {
-  keys:KV<string>;
+  keys: KV<string>;
   mode: 'async' | 'sync';
-  
-  setStore(key: string, value: any, version?: string):void;
-  setStoreAsync(key: string, value: any, version?: string):Promise<void>;
 
-  getStore(key: string, version?: string):any;
-  getStoreAsync(key: string, version?: string):Promise<any>;
-  
-  removeStore(key:string):void;
-  removeStoreAsync(key:string):Promise<void>;
-  
-  updatePersistence?(persistence:string):void;
-  updatePersistenceAsync?(persistence:string):Promise<void>;
-  
-  clear?():void;
-}
+  setStore(key: string, value: any, version?: string): void;
+  setStoreAsync(key: string, value: any, version?: string): Promise<void>;
+
+  getStore(key: string, version?: string): any;
+  getStoreAsync(key: string, version?: string): Promise<any>;
+
+  removeStore(key: string): void;
+  removeStoreAsync(key: string): Promise<void>;
+
+  updatePersistence?(persistence: string): void;
+  updatePersistenceAsync?(persistence: string): Promise<void>;
+
+  clear?(): void;
+}

package/component.d.ts

@@ -14,4 +14,4 @@ export interface ICloudbaseComponent {
 export interface ICloudbaseHook {
   entity: any;
   target: string;
-}
+}

package/database.d.ts

@@ -1,5 +1,5 @@
-export type DataType = 'init' | 'update' | 'add' | 'remove' | 'replace' | 'limit'
-export type QueueType = 'init' | 'enqueue' | 'dequeue' | 'update'
+export type DataType = 'init' | 'update' | 'add' | 'remove' | 'replace' | 'limit';
+export type QueueType = 'init' | 'enqueue' | 'dequeue' | 'update';
 
 export interface ISingleDBEvent {
   id: number
@@ -28,4 +28,4 @@ export interface IServiceContext {
   // identifiers: IRuntimeIdentifiers
   // debug: boolean
   env?: string
-}
+}

package/events.d.ts

@@ -2,12 +2,12 @@ export interface Listeners {
   [key: string]: Function[];
 }
 export interface ICloudbaseEvent {
-  name:string;
+  name: string;
   target: any;
-  data:any;
+  data: any;
 }
 export interface ICloudbaseEventEmitter {
   on(name: string, listener: Function): this;
   off(name: string, listener: Function): this;
   fire(event: string | ICloudbaseEvent, data?: any): this;
-}
+}

package/functions.d.ts

@@ -1,4 +1,4 @@
-import { KV } from ".";
+import { KV } from '.';
 
 export interface ICallFunctionOptions {
   name: string;
@@ -13,6 +13,4 @@ export interface ICallFunctionResponse {
   result: any;
 }
 
-export interface ICallFunction{
-  (options: ICallFunctionOptions,callback?: Function):Promise<ICallFunctionResponse>;
-}
+export type ICallFunction = (options: ICallFunctionOptions, callback?: Function) => Promise<ICallFunctionResponse>;

package/index.d.ts

@@ -1,8 +1,7 @@
 import { CloudbaseAdapter, SDKAdapterInterface } from '@cloudbase/adapter-interface';
-import { ICloudbaseComponent, ICloudbaseHook } from "./component";
-import { ICloudbaseRequest } from "./request";
-import { ICloudbaseCache } from "./cache";
-import { ICloudbaseAuth } from './auth'
+import { ICloudbaseComponent, ICloudbaseHook } from './component';
+import { ICloudbaseRequest } from './request';
+import { ICloudbaseCache } from './cache';
 
 export type Persistence = 'local' | 'session' | 'none';
 
@@ -21,33 +20,28 @@ export interface ICloudbaseConfig {
   timeout?: number;
   persistence?: Persistence;
   appSecret?: ICloudbaseAppSecret;
-  oauthClient?: any
   appSign?: string;
   debug?: boolean;
-  _fromApp?: ICloudbase
 }
 // 可更新的配置字段
-export type ICloudbaseUpgradedConfig = Pick<ICloudbaseConfig, 'persistence' | 'region' | 'debug'>;
+export type ICloudbaseUpgradedConfig = Pick<ICloudbaseConfig, 'persistence'|'region'|'debug'>;
 
 export interface ICloudbaseExtension {
   name: string;
   invoke(opts: any, app: ICloudbase): Promise<any>;
 }
 
-export interface ICloudbase {
+export interface ICloudbase{
   config: ICloudbaseConfig;
   platform: ICloudbasePlatformInfo;
   cache: ICloudbaseCache;
   request: ICloudbaseRequest;
-  oauthClient: any;
   localCache: ICloudbaseCache;
-  authInstance?: ICloudbaseAuth;
-  oauthInstance?: any;
   init(config: ICloudbaseConfig): ICloudbase;
   updateConfig(config: ICloudbaseUpgradedConfig): void;
   registerExtension(ext: ICloudbaseExtension): void;
   invokeExtension(name: string, opts: any): Promise<any>;
-  useAdapters(adapters: CloudbaseAdapter | CloudbaseAdapter[]): void;
+  useAdapters(adapters: CloudbaseAdapter|CloudbaseAdapter[]): void;
   registerComponent(component: ICloudbaseComponent): void;
   registerHook(hook: ICloudbaseHook): void;
   registerVersion(version: string): void;
@@ -63,4 +57,4 @@ export interface IGenericError<T extends string, P = any> extends Error {
   type: T
   payload: P
   generic: boolean
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudbase/types",
-  "version": "1.2.3-alpha.0",
+  "version": "1.8.2",
   "description": "cloudbase javascript sdk types",
   "files": [
     "index.js",
@@ -38,12 +38,9 @@
   "dependencies": {
     "@cloudbase/adapter-interface": "^0.4.0"
   },
-  "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^3.10.1",
-    "@typescript-eslint/parser": "^3.10.1",
-    "eslint": "^7.7.0",
-    "eslint-config-alloy": "^3.8.0",
-    "typescript": "^4.0.2"
+  "scripts": {
+    "lint": "eslint --fix \"./**/*.ts\"",
+    "precommit": "npm run lint"
   },
-  "gitHead": "eb161dd3c79b90a95a877984bf7c07cdb4563077"
+  "gitHead": "5b3ac0446269ebb9ad2b22cdcb48c379ded1cb07"
 }

package/realtime.d.ts

@@ -1,4 +1,4 @@
-import { DataType, QueueType, ISingleDBEvent } from './database'
+import { DataType, QueueType, ISingleDBEvent } from './database';
 
 export type IRequestMsgType =
   | 'LOGIN' // 鉴权（环境维度）
@@ -6,7 +6,7 @@ export type IRequestMsgType =
   | 'REBUILD_WATCH' // 重建监听，1）数据失序时 2）checkLast 不一致时
   | 'CHECK_LAST' // 检查是否有未收到的消息
   | 'CLOSE_WATCH' // 取消监听
-  | 'PING' // 心跳 ping
+  | 'PING'; // 心跳 ping
 
 export type IResponseMsgType =
   | 'LOGIN_RES' // LOGIN 回包
@@ -14,7 +14,7 @@ export type IResponseMsgType =
   | 'NEXT_EVENT' // 服务端主动推变更事件
   | 'CHECK_EVENT' // CHECK_LAST 回包
   | 'PONG' // 心跳 PING 回包
-  | 'ERROR' // 错误异常
+  | 'ERROR'; // 错误异常
 
 export interface IRequestMessageBase<W extends boolean = true> {
   watchId: W extends true ? string : undefined
@@ -29,7 +29,7 @@ export type IRequestMessageMsgData =
   | IRequestMessageRebuildWatchData
   | IRequestMessageCheckLastData
   | IRequestMessageCloseWatchData
-  | IRequestMessagePingData
+  | IRequestMessagePingData;
 
 export type IRequestMessage =
   | IRequestMessageInitWatchMsg
@@ -37,7 +37,7 @@ export type IRequestMessage =
   | IRequestMessageRebuildWatchMsg
   | IRequestMessageCheckLastMsg
   | IRequestMessageCloseWatchMsg
-  | IRequestMessagePingMsg
+  | IRequestMessagePingMsg;
 
 export interface IRequestMessageLoginData {
   envId: string
@@ -95,14 +95,14 @@ export interface IRequestMessageCheckLastMsg extends IRequestMessageBase {
   msgData: IRequestMessageCheckLastData
 }
 
-export type IRequestMessageCloseWatchData = null
+export type IRequestMessageCloseWatchData = null;
 
 export interface IRequestMessageCloseWatchMsg extends IRequestMessageBase {
   msgType: 'CLOSE_WATCH'
   msgData: IRequestMessageCloseWatchData
 }
 
-export type IRequestMessagePingData = null
+export type IRequestMessagePingData = null;
 
 export interface IRequestMessagePingMsg extends IRequestMessageBase<false> {
   msgType: 'PING'
@@ -125,7 +125,7 @@ export type IResponseMessageMsgData =
   | IResponseMessageNextEventData
   | IResponseMessageCheckEventData
   | IResponseMessagePongData
-  | IResponseMessageErrorData
+  | IResponseMessageErrorData;
 
 export type IResponseMessage =
   | IResponseMessageLoginResMsg
@@ -133,11 +133,11 @@ export type IResponseMessage =
   | IResponseMessageNextEventMsg
   | IResponseMessageCheckEventMsg
   | IResponseMessagePongMsg
-  | IResponseMessageErrorMsg
+  | IResponseMessageErrorMsg;
 
 export type IResponseMessageLoginResData = {
   envId: string
-} & Partial<IResponseMessageErrorData>
+} & Partial<IResponseMessageErrorData>;
 
 export interface IResponseMessageLoginResMsg
   extends IResponseMessageBase<false> {
@@ -177,7 +177,7 @@ export interface IResponseMessageCheckEventMsg extends IResponseMessageBase {
   msgData: IResponseMessageCheckEventData
 }
 
-export type IResponseMessagePongData = null
+export type IResponseMessagePongData = null;
 
 export interface IResponseMessagePongMsg extends IResponseMessageBase {
   msgType: 'PONG'
@@ -194,14 +194,14 @@ export type IResponseMessageErrorData = {
   | { code: 'INVALIID_ENV' } // 环境无效
   | { code: 'SIGN_PARAM_INVALID' } // cam签名无效
   | { code: 'COLLECTION_PERMISSION_DENIED' } // 没有集合操作权限
-  | { code: 'QUERYID_INVALID_ERROR' }) // queryID 无效
+  | { code: 'QUERYID_INVALID_ERROR' }); // queryID 无效
 
 export interface IResponseMessageErrorMsg extends IResponseMessageBase {
   msgType: 'ERROR'
   msgData: IResponseMessageErrorData
 }
 
-export type IDBEvent = IDBInitEvent | IDBNextEvent
+export type IDBEvent = IDBInitEvent | IDBNextEvent;
 
 export interface IDBEventBase {
   ID: number // event id
@@ -237,21 +237,21 @@ export type IDBNextEvent =
   | IDBNextEventDataReplace
   | IDBNextEventDataAdd
   | IDBNextEventDataRemove
-  | IDBNextEventDataLimit
+  | IDBNextEventDataLimit;
 
 export type IDBNextEventDataUpdate =
   | IDBNextEventDataUpdateQueueUpdate
   | IDBNextEventDataUpdateQueueEnqueue
-  | IDBNextEventDataUpdateQueueDequeue
+  | IDBNextEventDataUpdateQueueDequeue;
 
 export type IDBNextEventDataReplace =
   | IDBNextEventDataReplaceQueueUpdate
   | IDBNextEventDataReplaceQueueEnqueue
-  | IDBNextEventDataReplaceQueueDequeue
+  | IDBNextEventDataReplaceQueueDequeue;
 
-export type IDBNextEventDataLimit = 
+export type IDBNextEventDataLimit =
   | IDBNextEventDataLimitQueueEnqueue
-  | IDBNextEventDataLimitQueueDequeue
+  | IDBNextEventDataLimitQueueDequeue;
 
 export interface IDBNextEventDataUpdateQueueUpdate extends IDBEventBase {
   DataType: 'update'
@@ -347,9 +347,6 @@ export interface DBRealtimeListener {
   close: () => void
 }
 
-export interface IRealtimeListenerConstructorOptions extends IWatchOptions {
-  // ws: any
-  // query: string
-}
+export type IRealtimeListenerConstructorOptions = IWatchOptions;
 
-export type SnapshotType = 'init'
+export type SnapshotType = 'init';

package/request.d.ts

@@ -1,7 +1,4 @@
-import {
-  IRequestOptions, IUploadRequestOptions, ResponseObject
-} from '@cloudbase/adapter-interface';
-
+import { IRequestOptions, ResponseObject, IUploadRequestOptions } from '@cloudbase/adapter-interface';
 import { ICloudbaseConfig, KV } from '.';
 
 export interface IGetAccessTokenResult {
@@ -9,20 +6,19 @@ export interface IGetAccessTokenResult {
   accessTokenExpire: number;
 }
 
-export type ICloudbaseRequestConfig = Pick<ICloudbaseConfig, 'env' | 'region' | 'timeout' | 'appSecret' | 'appSign' | 'oauthClient' | '_fromApp'>;
+export type ICloudbaseRequestConfig = Pick<ICloudbaseConfig, 'env'|'region'|'timeout'|'appSecret'|'appSign'>;
 
-export interface IAppendedRequestInfo {
+export type IAppendedRequestInfo = {
   data: KV<any>;
   headers: KV<string>;
-}
+};
 export type IRequestBeforeHook = (...args: any[]) => IAppendedRequestInfo;
 export interface ICloudbaseRequest {
-  fetch: (urlOrPath: string, init?: RequestInit) => Promise<Response>;
-  post: (options: IRequestOptions) => Promise<ResponseObject>;
-  upload: (options: IUploadRequestOptions) => Promise<ResponseObject>;
-  download: (options: IRequestOptions) => Promise<ResponseObject>;
-  refreshAccessToken: () => Promise<IGetAccessTokenResult>;
-  getAccessToken: () => Promise<IGetAccessTokenResult>;
-  request: (action: string, params: KV<any>, options?: KV<any>) => Promise<ResponseObject>;
-  send: (action: string, data: KV<any>) => Promise<any>;
-}
+  post(options: IRequestOptions): Promise<ResponseObject>;
+  upload(options: IUploadRequestOptions): Promise<ResponseObject>;
+  download(options: IRequestOptions): Promise<ResponseObject>;
+  refreshAccessToken(): Promise<IGetAccessTokenResult>;
+  getAccessToken(): Promise<IGetAccessTokenResult>;
+  request(action: string, params: KV<any>, options?: KV<any>): Promise<ResponseObject>;
+  send(action: string, data: KV<any>): Promise<any>;
+}

package/storage.d.ts

@@ -9,25 +9,19 @@ export interface ICloudbaseUploadFileResult {
   requestId: string;
 }
 
-export interface ICloudbaseUploadFile {
-  (params: ICloudbaseUploadFileParams, callback?: Function): Promise<ICloudbaseUploadFileResult>;
-}
+export type ICloudbaseUploadFile = (params: ICloudbaseUploadFileParams, callback?: Function) => Promise<ICloudbaseUploadFileResult>;
 
 export interface ICloudbaseGetUploadMetadataParams {
   cloudPath: string;
 }
 
-export interface ICloudbaseGetUploadMetadata {
-  (params: ICloudbaseGetUploadMetadataParams, callback?: Function): Promise<any>;
-}
+export type ICloudbaseGetUploadMetadata = (params: ICloudbaseGetUploadMetadataParams, callback?: Function) => Promise<any>;
 
 export interface ICloudbaseDeleteFileParams {
   fileList: string[];
 }
 
-export interface ICloudbaseDeleteFile {
-  (params: ICloudbaseDeleteFileParams, callback?: Function): Promise<ICloudbaseDeleteFileResult>;
-}
+export type ICloudbaseDeleteFile = (params: ICloudbaseDeleteFileParams, callback?: Function) => Promise<ICloudbaseDeleteFileResult>;
 
 export interface ICloudbaseDeleteFileResult {
   code?: string;
@@ -61,9 +55,7 @@ export interface ICloudbaseGetTempFileURLResult {
   requestId?: string;
 }
 
-export interface ICloudbaseGetTempFileURL {
-  (params: ICloudbaseGetTempFileURLParams, callback?: Function): Promise<ICloudbaseGetTempFileURLResult>;
-}
+export type ICloudbaseGetTempFileURL = (params: ICloudbaseGetTempFileURLParams, callback?: Function) => Promise<ICloudbaseGetTempFileURLResult>;
 
 export interface ICloudbaseDownloadFileParams {
   fileID: string;
@@ -77,9 +69,7 @@ export interface ICloudbaseDownloadFileResult {
   requestId?: string;
 }
 
-export interface ICloudbaseDownloadFile {
-  (params: ICloudbaseDownloadFileParams, callback?: Function): Promise<ICloudbaseDownloadFileResult>;
-}
+export type ICloudbaseDownloadFile = (params: ICloudbaseDownloadFileParams, callback?: Function) => Promise<ICloudbaseDownloadFileResult>;
 
 export interface ICloudbaseFileMetaData {
   url: string;
@@ -93,4 +83,4 @@ export interface ICloudbaseFileMetaData {
 export interface ICloudbaseFileMetaDataRes {
   data: ICloudbaseFileMetaData;
   requestId: string;
-}
+}