@cloudbase/types 2.23.3 → 2.24.0

package/auth.d.ts

@@ -1,78 +1,93 @@
 import { ICloudbaseConfig, KV, ICloudbase } from '.'
+import { UserInfo } from '@cloudbase/oauth'
 
-export type ICloudbaseAuthConfig = Pick<ICloudbaseConfig, 'env' | 'clientId' | 'region' | 'persistence' | 'debug' | '_fromApp' | 'oauthInstance' | 'wxCloud' | 'i18n' | 'accessKey' | 'useWxCloud'>;
+export type ICloudbaseAuthConfig = Pick<
+ICloudbaseConfig,
+| 'env'
+| 'clientId'
+| 'region'
+| 'persistence'
+| 'debug'
+| '_fromApp'
+| 'oauthInstance'
+| 'wxCloud'
+| 'i18n'
+| 'accessKey'
+| 'useWxCloud'
+> &
+ICloudbaseConfig['auth']
 
 export interface IAccessTokenInfo {
-  accessToken: string;
-  env: string;
+  accessToken: string
+  env: string
 }
 export interface ICredential {
   // refreshToken: string;
-  accessToken?: string;
-  accessTokenExpire?: string;
+  accessToken?: string
+  accessTokenExpire?: string
 }
 export interface IAuthProvider {
-  signInWithRedirect: () => any;
+  signInWithRedirect: () => any
 }
 export 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
 }
 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: (params?: {version?: string;}) => 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: (params?: { version?: string }) => Promise<IUserInfo>
 }
 export interface ILoginState {
-  user: IUser;
+  user: IUser
 }
 export interface ICloudbaseAuth {
-  config: ICloudbaseConfig;
-  loginType: string;
-  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;
+  config: ICloudbaseConfig
+  loginType: string
+  weixinAuthProvider: any
+  anonymousAuthProvider: any
+  customAuthProvider: any
+  getAccessToken: () => IAccessTokenInfo
+  getLoginState: () => Promise<ILoginState | null>
+  hasLoginState: () => Promise<ILoginState | null>
+  getUserInfo: () => Promise<UserInfo & IUser>
+  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;
+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/index.d.ts

@@ -1,4 +1,4 @@
-import { CloudbaseAdapter, SDKAdapterInterface } from '@cloudbase/adapter-interface'
+import { CloudbaseAdapter, SDKAdapterInterface, ResponseObject } from '@cloudbase/adapter-interface'
 import { ICloudbaseComponent, ICloudbaseHook } from './component'
 import { ICloudbaseRequest } from './request'
 import { ICloudbaseCache } from './cache'
@@ -41,6 +41,9 @@ export interface ICloudbaseConfig {
   accessKey?: string
   endPointMode?: EndPointKey // auth请求域名模式，默认CLOUD_API
   useWxCloud?: boolean // 是否使用微信云开发链路
+  auth?: {
+    detectSessionInUrl?: boolean
+  }
 }
 // 可更新的配置字段
 export type ICloudbaseUpgradedConfig = Pick<ICloudbaseConfig, 'persistence' | 'region' | 'debug'>
@@ -78,9 +81,9 @@ export interface ICloudbase {
   fire?: (...args: any[]) => void
   updateLang?: (lang: LANGS) => void
   getEndPointWithKey?: (key: EndPointKey) => {
-    BASE_URL: string;
-    PROTOCOL: string;
-  },
+    BASE_URL: string
+    PROTOCOL: string
+  }
   auth?: (options?: { persistence: cloudbase.auth.Persistence }) => cloudbase.auth.App
 }
 export interface ICloudbasePlatformInfo {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudbase/types",
-  "version": "2.23.3",
+  "version": "2.24.0",
   "description": "cloudbase javascript sdk types",
   "files": [
     "index.js",
@@ -43,5 +43,5 @@
     "lint": "eslint --fix \"./**/*.ts\"",
     "precommit": "npm run lint"
   },
-  "gitHead": "d5f566dbd448be5d75127c4a506bcaf0ff3ae84b"
+  "gitHead": "7dac230344ecae3eec15358b2f85d782fde51839"
 }

package/storage.d.ts

@@ -5,7 +5,7 @@ export interface ICloudbaseUploadFileParams {
   cloudPath: string;
   filePath: string;
   method?: 'post' | 'put';
-  headers?: KVstring[];
+  headers?: KVstring;
   onUploadProgress?: Function;
   // 文件内容 Buffer 或 文件可读流, node端使用
   fileContent?: any;
@@ -15,7 +15,7 @@ export interface ICloudbaseUploadFileParams {
 export interface ICloudbaseUploadFileByPutParams {
   cloudPath: string;
   filePath: string;
-  headers?: KVstring[];
+  headers?: KVstring;
   onUploadProgress?: Function;
 }