@cloudbase/types 3.0.0 → 3.0.2

package/auth.d.ts

@@ -1,78 +1,95 @@
 import { ICloudbaseConfig, KV, ICloudbase } from '.'
+import { authModels, UserInfo } from '@cloudbase/oauth'
+import { ICloudbaseEventEmitter } from './events'
 
-export type ICloudbaseAuthConfig = Pick<ICloudbaseConfig, 'env' | 'clientId' | 'region' | 'persistence' | 'debug' | '_fromApp' | 'oauthInstance' | 'wxCloud' | 'i18n' | 'publishable_key'>;
+export type ICloudbaseAuthConfig = Pick<
+ICloudbaseConfig,
+| 'env'
+| 'clientId'
+| 'region'
+| 'persistence'
+| 'debug'
+| '_fromApp'
+| 'oauthInstance'
+| 'wxCloud'
+| 'i18n'
+| 'accessKey'
+| 'useWxCloud'
+> &
+ICloudbaseConfig['auth']
+& {eventBus?: ICloudbaseEventEmitter}
 
 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: authModels.UserProfile) => Promise<void>
+  refresh: (params?: { version?: string }) => Promise<authModels.UserInfo>
 }
 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/functions.d.ts

@@ -20,3 +20,21 @@ export interface ICallFunctionResponse {
 
 export type ICallFunction = (options: ICallFunctionOptions, callback?: Function) => Promise<ICallFunctionResponse>
 
+export interface IRetryOptions {
+  retries?: number
+  factor?: number
+  minTimeout?: number
+  maxTimeout?: number
+  randomize?: boolean
+  timeouts?: number[]
+  timeoutOps?: {
+    timeout: number
+    cb: function
+  }
+}
+
+export interface ICustomReqOpts {
+  timeout?: number
+  retryOptions?: IRetryOptions
+  from?: 'node-sdk'
+}

package/index.d.ts

@@ -1,8 +1,9 @@
-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'
 import { ICloudbaseAuth } from './auth'
+import { cloudbase } from '../cloudbase/index'
 
 export enum LANGS {
   ZH = 'zh-CN',
@@ -19,6 +20,8 @@ export interface KVstring {
   [key: string]: string
 }
 
+export type EndPointKey = 'CLOUD_API' | 'GATEWAY'
+
 export interface ICloudbaseConfig {
   env: string
   region?: string
@@ -31,11 +34,16 @@ export interface ICloudbaseConfig {
   oauthInstance?: any
   wxCloud?: any
   i18n?: {
-    t: (text: string) => string;
-    LANG_HEADER_KEY: string;
-    lang: LANGS;
+    t: (text: string) => string
+    LANG_HEADER_KEY: string
+    lang: LANGS
+  }
+  accessKey?: string
+  endPointMode?: EndPointKey // auth请求域名模式，默认CLOUD_API
+  useWxCloud?: boolean // 是否使用微信云开发链路
+  auth?: {
+    detectSessionInUrl?: boolean
   }
-  publishable_key?: string
 }
 // 可更新的配置字段
 export type ICloudbaseUpgradedConfig = Pick<ICloudbaseConfig, 'persistence' | 'region' | 'debug'>
@@ -45,6 +53,13 @@ export interface ICloudbaseExtension {
   invoke: (opts: any, app: ICloudbase) => Promise<any>
 }
 
+declare type MethodType = 'request' | 'post' | 'get' | 'head' | 'patch' | 'delete' | 'put'
+export interface ICloudbaseApis {
+  [apiName: string]: {
+    [method in MethodType]: (callApiOptions: ICallApiOptions, opts?: KV<any>) => Promise<ResponseObject['data']>
+  }
+}
+
 export interface ICloudbase {
   config: ICloudbaseConfig
   platform: ICloudbasePlatformInfo
@@ -54,7 +69,8 @@ export interface ICloudbase {
   localCache: ICloudbaseCache
   authInstance?: ICloudbaseAuth
   oauthInstance?: any
-  init: (config: ICloudbaseConfig) => ICloudbase
+  apis: ICloudbaseApis
+  init: (config: ICloudbaseConfig & { lang?: LANGS }) => cloudbase.app
   updateConfig: (config: ICloudbaseUpgradedConfig) => void
   registerExtension: (ext: ICloudbaseExtension) => void
   invokeExtension: (name: string, opts: any) => Promise<any>
@@ -63,6 +79,12 @@ export interface ICloudbase {
   registerHook: (hook: ICloudbaseHook) => void
   registerVersion: (version: string) => void
   fire?: (...args: any[]) => void
+  updateLang?: (lang: LANGS) => void
+  getEndPointWithKey?: (key: EndPointKey) => {
+    BASE_URL: string
+    PROTOCOL: string
+  }
+  auth?: (options?: { persistence: cloudbase.auth.Persistence }) => cloudbase.auth.App
 }
 export interface ICloudbasePlatformInfo {
   adapter?: SDKAdapterInterface
@@ -77,12 +99,12 @@ export interface IGenericError<T extends string, P = any> extends Error {
 
 export interface ICallApiOptions {
   /** api标识 */
-  name: string
+  name?: string
   /** 请求的path */
   path?: string
   method?: string
   headers?: KV<any>
   /** 请求体，根据content-type可以是不同类型 */
   body?: KV<any> | string
-  token?: string;
+  token?: string
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudbase/types",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "cloudbase javascript sdk types",
   "files": [
     "index.js",
@@ -43,5 +43,5 @@
     "lint": "eslint --fix \"./**/*.ts\"",
     "precommit": "npm run lint"
   },
-  "gitHead": "a70e7266db7be901d909b1fa63c1651e2a7943e4"
+  "gitHead": "56b879a3e173e64e44ca36c1260b3fc66d0e822a"
 }

package/request.d.ts

@@ -10,7 +10,7 @@ export interface IGetAccessTokenResult {
   accessTokenExpire: number;
 }
 
-export type ICloudbaseRequestConfig = Pick<ICloudbaseConfig, 'env' | 'region' | 'timeout' | 'oauthClient' | '_fromApp' | 'i18n' | 'publishable_key'>;
+export type ICloudbaseRequestConfig = Pick<ICloudbaseConfig, 'env' | 'region' | 'timeout' | 'oauthClient' | '_fromApp' | 'i18n' | 'endPointMode'>;
 
 export interface IAppendedRequestInfo {
   data: KV<any>;

package/storage.d.ts

@@ -1,17 +1,21 @@
 import { KVstring } from '.'
+import { ICustomReqOpts } from './functions'
 
 export interface ICloudbaseUploadFileParams {
   cloudPath: string;
   filePath: string;
   method?: 'post' | 'put';
-  headers?: KVstring[];
+  headers?: KVstring;
   onUploadProgress?: Function;
+  // 文件内容 Buffer 或 文件可读流, node端使用
+  fileContent?: any;
+  customReqOpts?: ICustomReqOpts;
 }
 
 export interface ICloudbaseUploadFileByPutParams {
   cloudPath: string;
   filePath: string;
-  headers?: KVstring[];
+  headers?: KVstring;
   onUploadProgress?: Function;
 }
 
@@ -24,12 +28,14 @@ export type ICloudbaseUploadFile = (params: ICloudbaseUploadFileParams, callback
 
 export interface ICloudbaseGetUploadMetadataParams {
   cloudPath: string;
+  customReqOpts?: ICustomReqOpts;
 }
 
 export type ICloudbaseGetUploadMetadata = (params: ICloudbaseGetUploadMetadataParams, callback?: Function) => Promise<any>;
 
 export interface ICloudbaseDeleteFileParams {
   fileList: string[];
+  customReqOpts?: ICustomReqOpts;
 }
 
 export type ICloudbaseDeleteFile = (params: ICloudbaseDeleteFileParams, callback?: Function) => Promise<ICloudbaseDeleteFileResult>;
@@ -51,8 +57,8 @@ export interface ICloudbaseFileInfo {
 
 export interface ICloudbaseGetTempFileURLParams {
   fileList: string[] | ICloudbaseFileInfo[];
+  customReqOpts?: ICustomReqOpts;
 }
-
 export interface ICloudbaseGetTempFileURLResult {
   code?: string;
   message?: string;
@@ -66,11 +72,32 @@ export interface ICloudbaseGetTempFileURLResult {
   requestId?: string;
 }
 
+export interface ICloudbaseCopyFileParams {
+  fileList: Array<{
+    srcPath: string
+    dstPath: string
+    overwrite?: boolean
+    removeOriginal?: boolean
+  }>
+  customReqOpts?: ICustomReqOpts;
+}
+
+
+export interface ICloudbaseCopyFileResult {
+  fileList: Array<{
+    fileId?: string
+    code?: string
+    message?: string
+  }>
+  requestId?: string;
+}
+
 export type ICloudbaseGetTempFileURL = (params: ICloudbaseGetTempFileURLParams, callback?: Function) => Promise<ICloudbaseGetTempFileURLResult>;
 
 export interface ICloudbaseDownloadFileParams {
   fileID: string;
   tempFilePath?: string;
+  customReqOpts?: ICustomReqOpts;
 }
 
 export interface ICloudbaseDownloadFileResult {
@@ -88,7 +115,9 @@ export interface ICloudbaseFileMetaData {
   authorization: string;
   fileId: string;
   cosFileId: string;
-  download_url: string
+  download_url: string;
+  code?: string;
+  message?: string;
 }
 
 export interface ICloudbaseFileMetaDataRes {