@cloudbase/types 1.2.3-alpha.0 → 2.0.0-alpha.0

package/auth.d.ts

@@ -1,18 +1,18 @@
 import { ICloudbaseConfig, KV, ICloudbase } from '.';
 
-export type ICloudbaseAuthConfig = Pick<ICloudbaseConfig, 'env' | 'region' | 'persistence' | 'debug' | '_fromApp'>;
+export type ICloudbaseAuthConfig = Pick<ICloudbaseConfig, 'env' | 'region' | 'persistence' | 'debug' | '_fromApp' | 'oauthInstance'>;
 
 export interface IAccessTokenInfo {
   accessToken: string;
   env: string;
 }
 export interface ICredential {
-  refreshToken: string;
+  // refreshToken: string;
   accessToken?: string;
   accessTokenExpire?: string;
 }
 export interface IAuthProvider {
-  signInWithRedirect(): any;
+  signInWithRedirect: () => any;
 }
 export interface IUserInfo {
   uid?: string;
@@ -23,10 +23,12 @@ export interface IUserInfo {
   unionId?: string;
   qqMiniOpenId?: string;
   customUserId?: string;
-  nickName?: string;
+  // nickName?: string;
+  name?: string;
   gender?: string;
   avatarUrl?: string;
   email?: string;
+  username?: string;
   hasPassword?: boolean;
   location?: {
     country?: string;
@@ -38,24 +40,24 @@ export interface IUserInfo {
   city?: string;
 }
 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>;
-  update(userinfo: IUserInfo): Promise<void>;
-  refresh(): Promise<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>;
+  update: (userinfo: IUserInfo) => Promise<void>;
+  refresh: () => Promise<IUserInfo>;
 }
 export interface ILoginState {
-  credential: ICredential;
+  // credential: ICredential;
   user: IUser;
-  isAnonymousAuth: boolean;
-  isCustomAuth: boolean;
-  isWeixinAuth: boolean;
-  isUsernameAuth: boolean;
-  loginType: string;
+  // isAnonymousAuth: boolean;
+  // isCustomAuth: boolean;
+  // isWeixinAuth: boolean;
+  // isUsernameAuth: boolean;
+  // loginType: string;
 }
 export interface ICloudbaseAuth {
   config: ICloudbaseConfig;
@@ -63,22 +65,22 @@ export interface ICloudbaseAuth {
   weixinAuthProvider: any;
   anonymousAuthProvider: any;
   customAuthProvider: any;
-  getAccessToken(): IAccessTokenInfo;
-  getLoginState(): Promise<ILoginState | null>;
-  hasLoginState(): Promise<ILoginState | null>;
-  getUserInfo(): Promise<any>;
-  getAuthHeader(): Promise<KV<string>>;
-  onLoginStateChanged(callback: Function): void;
-  onLoginStateExpired(callback: Function): void;
-  onAccessTokenRefreshed(callback: Function): void;
-  onAnonymousConverted(callback: Function): void;
-  onLoginTypeChanged(callback: Function): void;
-  shouldRefreshAccessToken(hook: Function): void;
+  getAccessToken: () => IAccessTokenInfo;
+  getLoginState: () => Promise<ILoginState | null>;
+  hasLoginState: () => Promise<ILoginState | null>;
+  getUserInfo: () => Promise<any>;
+  getAuthHeader: () => Promise<KV<string>>;
+  onLoginStateChanged: (callback: Function) => void;
+  onLoginStateExpired: (callback: Function) => void;
+  onAccessTokenRefreshed: (callback: Function) => void;
+  onAnonymousConverted: (callback: Function) => void;
+  onLoginTypeChanged: (callback: Function) => void;
+  shouldRefreshAccessToken: (hook: Function) => void;
 }
 
 type IProvider = new (...args: any[]) => any;
 
 export interface ICloudbaseAuthModule {
-  registerAuth(app: ICloudbase): void,
-  registerProvider(name: string, provider: IProvider): void;
+  registerAuth: (app: ICloudbase) => void,
+  registerProvider: (name: string, provider: IProvider) => void;
 }

package/cache.d.ts

@@ -9,18 +9,18 @@ export type ICacheConfig = Pick < ICloudbaseConfig, 'debug' | 'persistence' > &
 export interface ICloudbaseCache {
   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>;
+  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>;
   
-  clear?():void;
+  removeStore: (key:string) => void;
+  removeStoreAsync: (key:string) => Promise<void>;
+
+  updatePersistence?: (persistence:string) => void;
+  updatePersistenceAsync?: (persistence:string) => Promise<void>;
+
+  clear?: () => void;
 }

package/index.d.ts

@@ -6,9 +6,9 @@ import { ICloudbaseAuth } from './auth'
 
 export type Persistence = 'local' | 'session' | 'none';
 
-export type KV<T> = {
+export interface KV<T> {
   [key: string]: T;
-};
+}
 
 export interface ICloudbaseAppSecret {
   appAccessKeyId: string;
@@ -24,14 +24,16 @@ export interface ICloudbaseConfig {
   oauthClient?: any
   appSign?: string;
   debug?: boolean;
-  _fromApp?: ICloudbase
+  _fromApp?: ICloudbase;
+  clientId?: string
+  oauthInstance?: any;
 }
 // 可更新的配置字段
 export type ICloudbaseUpgradedConfig = Pick<ICloudbaseConfig, 'persistence' | 'region' | 'debug'>;
 
 export interface ICloudbaseExtension {
   name: string;
-  invoke(opts: any, app: ICloudbase): Promise<any>;
+  invoke: (opts: any, app: ICloudbase) => Promise<any>;
 }
 
 export interface ICloudbase {
@@ -43,15 +45,15 @@ export interface ICloudbase {
   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;
-  registerComponent(component: ICloudbaseComponent): void;
-  registerHook(hook: ICloudbaseHook): void;
-  registerVersion(version: string): void;
-  fire?(...args: any[]): void;
+  init: (config: ICloudbaseConfig) => ICloudbase;
+  updateConfig: (config: ICloudbaseUpgradedConfig) => void;
+  registerExtension: (ext: ICloudbaseExtension) => void;
+  invokeExtension: (name: string, opts: any) => Promise<any>;
+  useAdapters: (adapters: CloudbaseAdapter | CloudbaseAdapter[]) => void;
+  registerComponent: (component: ICloudbaseComponent) => void;
+  registerHook: (hook: ICloudbaseHook) => void;
+  registerVersion: (version: string) => void;
+  fire?: (...args: any[]) => void;
 }
 
 export interface ICloudbasePlatformInfo {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudbase/types",
-  "version": "1.2.3-alpha.0",
+  "version": "2.0.0-alpha.0",
   "description": "cloudbase javascript sdk types",
   "files": [
     "index.js",
@@ -45,5 +45,5 @@
     "eslint-config-alloy": "^3.8.0",
     "typescript": "^4.0.2"
   },
-  "gitHead": "eb161dd3c79b90a95a877984bf7c07cdb4563077"
+  "gitHead": "9ab9ea4322a548cd981d5fe747b6dee911272a6d"
 }

package/request.d.ts

@@ -17,12 +17,12 @@ export interface IAppendedRequestInfo {
 }
 export type IRequestBeforeHook = (...args: any[]) => IAppendedRequestInfo;
 export interface ICloudbaseRequest {
-  fetch: (urlOrPath: string, init?: RequestInit) => Promise<Response>;
+  // 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>;
+  // 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>;
 }