@cloudbase/app 2.0.2-alpha.0 → 2.5.0-beta.0

package/src/index.ts

@@ -1,68 +1,68 @@
-import { adapters, constants, utils, helpers } from '@cloudbase/utilities';
-import { SDKAdapterInterface, CloudbaseAdapter, IRequestConfig } from '@cloudbase/adapter-interface';
-import { ICloudbaseConfig, ICloudbaseUpgradedConfig, ICloudbase, ICloudbaseExtension, KV, ICloudbasePlatformInfo } from '@cloudbase/types';
-import { ICloudbaseAuth } from '@cloudbase/types/auth';
-import adapterForWxMp from 'cloudbase-adapter-wx_mp';
-import { registerComponent, registerHook } from './libs/component';
-import { Platform } from './libs/adapter';
-import { ICloudbaseComponent, ICloudbaseHook } from '@cloudbase/types/component';
-import { ICloudbaseCache } from '@cloudbase/types/cache';
-import { initCache, getCacheByEnvId, getLocalCache } from './libs/cache';
-import { ICloudbaseRequest } from '@cloudbase/types/request';
-import { initRequest, getRequestByEnvId } from './libs/request';
-import { getSdkName, setSdkVersion, setEndPoint, setRegionLevelEndpoint, setSdkName } from './constants/common';
+import { adapters, constants, utils, helpers } from '@cloudbase/utilities'
+import { SDKAdapterInterface, CloudbaseAdapter, IRequestConfig } from '@cloudbase/adapter-interface'
+import { ICloudbaseConfig, ICloudbaseUpgradedConfig, ICloudbase, ICloudbaseExtension, KV, ICloudbasePlatformInfo } from '@cloudbase/types'
+import { ICloudbaseAuth } from '@cloudbase/types/auth'
+import adapterForWxMp from 'cloudbase-adapter-wx_mp'
+import { registerComponent, registerHook } from './libs/component'
+import { Platform } from './libs/adapter'
+import { ICloudbaseComponent, ICloudbaseHook } from '@cloudbase/types/component'
+import { ICloudbaseCache } from '@cloudbase/types/cache'
+import { initCache, getCacheByEnvId, getLocalCache } from './libs/cache'
+import { ICloudbaseRequest } from '@cloudbase/types/request'
+import { initRequest, getRequestByEnvId } from './libs/request'
+import { getSdkName, setSdkVersion, setEndPoint, setRegionLevelEndpoint, setSdkName } from './constants/common'
 export { getBaseEndPoint } from './constants/common'
-const { useAdapters, useDefaultAdapter, RUNTIME } = adapters;
-const { ERRORS, COMMUNITY_SITE_URL } = constants;
-const { printWarn } = utils;
-const { catchErrorsDecorator } = helpers;
+const { useAdapters, useDefaultAdapter, RUNTIME } = adapters
+const { ERRORS, COMMUNITY_SITE_URL } = constants
+const { printWarn } = utils
+const { catchErrorsDecorator } = helpers
 
 /**
  * @constant 默认配置
  */
 const DEFAULT_INIT_CONFIG: Partial<ICloudbaseConfig> = {
   timeout: 15000,
-  persistence: 'local'
-};
+  persistence: 'local',
+}
 
 // timeout上限10分钟
-const MAX_TIMEOUT = 1000 * 60 * 10;
+const MAX_TIMEOUT = 1000 * 60 * 10
 // timeout下限100ms
-const MIN_TIMEOUT = 100;
+const MIN_TIMEOUT = 100
 
-const extensionMap: KV<ICloudbaseExtension> = {};
+const extensionMap: KV<ICloudbaseExtension> = {}
 
 class Cloudbase implements ICloudbase {
-  public authInstance: ICloudbaseAuth;
-  public oauthInstance: any;
-  public requestClient: any;
+  public authInstance: ICloudbaseAuth
+  public oauthInstance: any
+  public requestClient: any
   public oauthClient: any
-  private _config: ICloudbaseConfig;
+  private cloudbaseConfig: ICloudbaseConfig
 
   constructor(config?: ICloudbaseConfig) {
-    this._config = config ? config : this._config;
-    this.authInstance = null;
+    this.cloudbaseConfig = config ? config : this.cloudbaseConfig
+    this.authInstance = null
     this.oauthInstance = null
   }
 
   get config() {
-    return this._config;
+    return this.cloudbaseConfig
   }
 
   get platform(): ICloudbasePlatformInfo {
-    return Platform;
+    return Platform
   }
 
   get cache(): ICloudbaseCache {
-    return getCacheByEnvId(this._config.env);
+    return getCacheByEnvId(this.cloudbaseConfig.env)
   }
 
   get localCache(): ICloudbaseCache {
-    return getLocalCache(this._config.env);
+    return getLocalCache(this.cloudbaseConfig.env)
   }
 
   get request(): ICloudbaseRequest {
-    return getRequestByEnvId(this._config.env);
+    return getRequestByEnvId(this.cloudbaseConfig.env)
   }
 
 
@@ -73,78 +73,80 @@ class Cloudbase implements ICloudbase {
       '请确认以下各项：',
       '  1 - 调用 cloudbase.init() 的语法或参数是否正确',
       '  2 - 如果是非浏览器环境，是否配置了安全应用来源（https://docs.cloudbase.net/api-reference/webv2/adapter.html#jie-ru-liu-cheng）',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public init(config: ICloudbaseConfig): Cloudbase {
     if (!config.env) {
       throw new Error(JSON.stringify({
         code: ERRORS.INVALID_PARAMS,
-        msg: 'env must not be specified'
-      }));
+        msg: 'env must not be specified',
+      }))
     }
     // 初始化时若未兼容平台，则使用默认adapter
     if (!Platform.adapter) {
-      this._useDefaultAdapter();
+      this.useDefaultAdapter()
     }
 
-    this.requestClient = new Platform.adapter.reqClass({
+    const reqConfig: IRequestConfig = {
       timeout: config.timeout || 5000,
-      timeoutMsg: `[${getSdkName()}][REQUEST TIMEOUT] request had been abort since didn\'t finished within${config.timeout / 1000}s`
-    } as IRequestConfig);
+      timeoutMsg: `[${getSdkName()}][REQUEST TIMEOUT] request had been abort since didn't finished within${config.timeout / 1000}s`,
+    }
+
+    this.requestClient = new Platform.adapter.reqClass(reqConfig)
     if (Platform.runtime !== RUNTIME.WEB) {
       if (!config.appSecret) {
         throw new Error(JSON.stringify({
           code: ERRORS.INVALID_PARAMS,
-          msg: 'invalid appSecret'
-        }));
+          msg: 'invalid appSecret',
+        }))
       }
       // adapter提供获取应用标识的接口
-      const appSign = Platform.adapter.getAppSign ? Platform.adapter.getAppSign() : '';
+      const appSign = Platform.adapter.getAppSign ? Platform.adapter.getAppSign() : ''
       if (config.appSign && appSign && config.appSign !== appSign) {
         // 传入的appSign与sdk获取的不一致
         throw new Error(JSON.stringify({
           code: ERRORS.INVALID_PARAMS,
-          msg: 'invalid appSign'
-        }));
+          msg: 'invalid appSign',
+        }))
       }
-      appSign && (config.appSign = appSign);
+      appSign && (config.appSign = appSign)
       if (!config.appSign) {
         throw new Error(JSON.stringify({
           code: ERRORS.INVALID_PARAMS,
-          msg: 'invalid appSign'
-        }));
+          msg: 'invalid appSign',
+        }))
       }
     }
-    this._config = {
+    this.cloudbaseConfig = {
       ...DEFAULT_INIT_CONFIG,
-      ...config
-    };
+      ...config,
+    }
     // 修正timeout取值
-    this._config.timeout = this._formatTimeout(this._config.timeout);
+    this.cloudbaseConfig.timeout = this.formatTimeout(this.cloudbaseConfig.timeout)
     // 初始化cache和request
-    const { env, persistence, debug, timeout, appSecret, appSign, oauthClient } = this._config;
-    initCache({ env, persistence, debug, platformInfo: this.platform });
+    const { env, persistence, debug, timeout, appSecret, appSign, oauthClient } = this.cloudbaseConfig
+    initCache({ env, persistence, debug, platformInfo: this.platform })
 
 
     setRegionLevelEndpoint(env, config.region || '')
 
-    const app = new Cloudbase(this._config);
-    initRequest({ env, region: config.region || '', timeout, appSecret, appSign, oauthClient, _fromApp: app });
-    app.requestClient = this.requestClient;
-    return app;
+    const app = new Cloudbase(this.cloudbaseConfig)
+    initRequest({ env, region: config.region || '', timeout, appSecret, appSign, oauthClient, _fromApp: app })
+    app.requestClient = this.requestClient
+    return app
   }
 
   public updateConfig(config: ICloudbaseUpgradedConfig) {
-    const { persistence, debug } = config;
-    this._config.persistence = persistence;
-    this._config.debug = debug;
+    const { persistence, debug } = config
+    this.cloudbaseConfig.persistence = persistence
+    this.cloudbaseConfig.debug = debug
     // persistence改动影响cache
-    initCache({ env: this._config.env, persistence, debug, platformInfo: this.platform });
+    initCache({ env: this.cloudbaseConfig.env, persistence, debug, platformInfo: this.platform })
   }
 
   public registerExtension(ext: ICloudbaseExtension) {
-    extensionMap[ext.name] = ext;
+    extensionMap[ext.name] = ext
   }
   @catchErrorsDecorator({
     title: '调用扩展能力失败',
@@ -152,25 +154,25 @@ class Cloudbase implements ICloudbase {
       '请确认以下各项：',
       '  1 - 调用 invokeExtension() 的语法或参数是否正确',
       '  2 - 被调用的扩展能力是否已经安装并通过 registerExtension() 注册',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public async invokeExtension(name: string, opts: any) {
-    const ext = extensionMap[name];
+    const ext = extensionMap[name]
     if (!ext) {
       throw new Error(JSON.stringify({
         code: ERRORS.INVALID_PARAMS,
-        msg: `extension:${name} must be registered before invoke`
-      }));
+        msg: `extension:${name} must be registered before invoke`,
+      }))
     }
 
-    return await ext.invoke(opts, this);
+    return await ext.invoke(opts, this)
   }
 
   public useAdapters(adapters: CloudbaseAdapter | CloudbaseAdapter[]) {
-    const { adapter, runtime } = useAdapters(adapters) || {};
-    adapter && (Platform.adapter = adapter as SDKAdapterInterface);
-    runtime && (Platform.runtime = runtime as string);
+    const { adapter, runtime } = useAdapters(adapters) || {}
+    adapter && (Platform.adapter = adapter as SDKAdapterInterface)
+    runtime && (Platform.runtime = runtime as string)
   }
 
   public registerHook(hook: ICloudbaseHook) {
@@ -178,42 +180,42 @@ class Cloudbase implements ICloudbase {
   }
 
   public registerComponent(component: ICloudbaseComponent) {
-    registerComponent(Cloudbase, component);
+    registerComponent(Cloudbase, component)
   }
 
   public registerVersion(version: string) {
-    setSdkVersion(version);
+    setSdkVersion(version)
   }
 
   public registerSdkName(name: string) {
-    setSdkName(name);
+    setSdkName(name)
   }
 
   public registerEndPoint(url: string, protocol?: 'http' | 'https') {
     setEndPoint(url, protocol)
   }
 
-  private _useDefaultAdapter() {
-    const { adapter, runtime } = useDefaultAdapter();
-    Platform.adapter = adapter as SDKAdapterInterface;
-    Platform.runtime = runtime as string;
+  private useDefaultAdapter() {
+    const { adapter, runtime } = useDefaultAdapter()
+    Platform.adapter = adapter as SDKAdapterInterface
+    Platform.runtime = runtime as string
   }
 
-  private _formatTimeout(timeout: number) {
+  private formatTimeout(timeout: number) {
     switch (true) {
       case timeout > MAX_TIMEOUT:
-        printWarn(ERRORS.INVALID_PARAMS, 'timeout is greater than maximum value[10min]');
-        return MAX_TIMEOUT;
+        printWarn(ERRORS.INVALID_PARAMS, 'timeout is greater than maximum value[10min]')
+        return MAX_TIMEOUT
       case timeout < MIN_TIMEOUT:
-        printWarn(ERRORS.INVALID_PARAMS, 'timeout is less than maximum value[100ms]');
-        return MIN_TIMEOUT;
+        printWarn(ERRORS.INVALID_PARAMS, 'timeout is less than maximum value[100ms]')
+        return MIN_TIMEOUT
       default:
-        return timeout;
+        return timeout
     }
   }
 }
 
-export const cloudbase: ICloudbase = new Cloudbase();
-cloudbase.useAdapters(adapterForWxMp);
+export const cloudbase: ICloudbase = new Cloudbase()
+cloudbase.useAdapters(adapterForWxMp)
 
-export default cloudbase;
+export default cloudbase

package/src/libs/adapter.ts

@@ -1,3 +1,3 @@
-import { ICloudbasePlatformInfo } from "@cloudbase/types";
+import { ICloudbasePlatformInfo } from '@cloudbase/types'
 
-export const Platform:ICloudbasePlatformInfo = {};
+export const Platform: ICloudbasePlatformInfo = {}

package/src/libs/cache.ts

@@ -1,59 +1,41 @@
-import { KV } from "@cloudbase/types";
-import { cache } from "@cloudbase/utilities";
-import { ICloudbaseCache, ICacheConfig } from "@cloudbase/types/cache";
+import { KV } from '@cloudbase/types'
+import { cache } from '@cloudbase/utilities'
+import { ICloudbaseCache, ICacheConfig } from '@cloudbase/types/cache'
 
-const USER_INFO_KEY = 'user_info';
-// const KEY_ACCESS_TOKEN = 'access_token';
-// const KEY_ACCESS_TOKEN_EXPIRE = 'access_token_expire';
-// const KEY_REFRESH_TOKEN = 'refresh_token';
-// const KEY_ANONYMOUS_UUID = 'anonymous_uuid';
-// const KEY_LOGIN_TYPE = 'login_type';
-// const DEVICE_INFO = 'device_id';
+const USER_INFO_KEY = 'user_info'
 
-const { CloudbaseCache } = cache;
+const { CloudbaseCache } = cache
 
-const cacheMap: KV<ICloudbaseCache> = {};
+const cacheMap: KV<ICloudbaseCache> = {}
 // 本地存储
-const localCacheMap: KV<ICloudbaseCache> = {};
+const localCacheMap: KV<ICloudbaseCache> = {}
 
 export function initCache(config: ICacheConfig & { env: string }) {
-  const { env, platformInfo } = config;
+  const { env, platformInfo } = config
 
-  // const accessTokenKey = `${KEY_ACCESS_TOKEN}_${env}`;
-  // const accessTokenExpireKey = `${KEY_ACCESS_TOKEN_EXPIRE}_${env}`;
-  // const refreshTokenKey      = `${KEY_REFRESH_TOKEN}_${env}`;
-  // const anonymousUuidKey     = `${KEY_ANONYMOUS_UUID}_${env}`;
-  // const loginTypeKey         = `${KEY_LOGIN_TYPE}_${env}`;
-  const userInfoKey = `${USER_INFO_KEY}_${env}`;
-  // const deviceIdKey = `${DEVICE_INFO}`; // 非环境级别
+  const userInfoKey = `${USER_INFO_KEY}_${env}`
 
   const keys = {
     userInfoKey,
-    // accessTokenKey,
-    // accessTokenExpireKey,
-    // refreshTokenKey,
-    // anonymousUuidKey,
-    // loginTypeKey,
-    // deviceIdKey
-  };
+  }
   // 若指定env已存在cache则尝试更新persistence
   cacheMap[env] = cacheMap[env] || (new CloudbaseCache({
     ...config,
     keys,
     platformInfo,
-  }));
+  }))
   localCacheMap[env] = localCacheMap[env] || new CloudbaseCache({
     ...config,
     keys,
     platformInfo,
-    persistence: 'local'
-  });
+    persistence: 'local',
+  })
 }
 
 export function getCacheByEnvId(env: string): ICloudbaseCache {
-  return cacheMap[env];
+  return cacheMap[env]
 }
 
 export function getLocalCache(env: string): ICloudbaseCache {
-  return localCacheMap[env];
+  return localCacheMap[env]
 }

package/src/libs/component.ts

@@ -1,113 +1,116 @@
-import { KV } from '@cloudbase/types';
-import { ICloudbaseComponent, ICloudbaseHook } from '@cloudbase/types/component';
-import { constants } from '@cloudbase/utilities';
+import { KV } from '@cloudbase/types'
+import { ICloudbaseComponent, ICloudbaseHook } from '@cloudbase/types/component'
+import { constants } from '@cloudbase/utilities'
 
-const { ERRORS } = constants;
+const { ERRORS } = constants
 
-const components:KV<ICloudbaseComponent> = {};
+const components: KV<ICloudbaseComponent> = {}
 
-export function registerComponent(app:any,component:ICloudbaseComponent){
-  const { name, namespace, entity, injectEvents, IIFE=false } = component;
+export function registerComponent(app: any, component: ICloudbaseComponent) {
+  const { name, namespace, entity, injectEvents, IIFE = false } = component
   // 不允许重复注册或命名空间重名
-  if(components[name]||(namespace&&app[namespace])){
+  if (components[name] || (namespace && app[namespace])) {
     throw new Error(JSON.stringify({
       code: ERRORS.INVALID_OPERATION,
-      msg: `Duplicate component ${name}`
-    }));
+      msg: `Duplicate component ${name}`,
+    }))
   }
   // IIFE类型的组件以app为scope执行entity函数，不挂载到app.prototype上
-  if(IIFE){
-    if(!entity||typeof entity !== 'function'){
+  if (IIFE) {
+    if (!entity || typeof entity !== 'function') {
       throw new Error(JSON.stringify({
         code: ERRORS.INVALID_PARAMS,
-        msg: 'IIFE component\'s entity must be a function'
-      }));
+        msg: 'IIFE component\'s entity must be a function',
+      }))
     }
-    entity.call(app);
+    entity.call(app)
   }
 
-  components[name] = component;
+  components[name] = component
 
-  if(namespace){
-    (app as any).prototype[namespace] = entity;
-  }else{
-    deepExtend((app as any).prototype,entity);
+  if (namespace) {
+    (app as any).prototype[namespace] = entity
+  } else {
+    deepExtend((app as any).prototype, entity)
   }
-  if(injectEvents){
-    const { bus, events } = injectEvents;
-    if(!bus||!events||events.length===0){
+  if (injectEvents) {
+    const { bus, events } = injectEvents
+    if (!bus || !events || events.length === 0) {
       return
     }
-    const originCallback = (app as any).prototype.fire || function(){};
-    if(!(app as any).prototype.events){
-      (app as any).prototype.events = {};
+    const originCallback = (app as any).prototype.fire || function () {}
+    if (!(app as any).prototype.events) {
+      (app as any).prototype.events = {}
     }
-    const originEvents:KV<any> = (app as any).prototype.events || {};
-    if(originEvents[name]){
-      (app as any).prototype.events[name].events = [...(app as any).prototype.events[name].events,...events];
-    }else{
-      (app as any).prototype.events[name] = {bus,events};
+    const originEvents: KV<any> = (app as any).prototype.events || {}
+    if (originEvents[name]) {
+      (app as any).prototype.events[name].events = [...(app as any).prototype.events[name].events, ...events]
+    } else {
+      (app as any).prototype.events[name] = { bus, events }
     }
-    (app as any).prototype.fire = function(eventName:string,data?:any){
-      originCallback(eventName,data);
-      for(const name in this.events){
-        const { bus, events:eventList } = this.events[name];
-        if(eventList.includes(eventName)){
-          bus.fire(eventName,data);
-          break;
+    (app as any).prototype.fire = function (eventName: string, data?: any) {
+      originCallback(eventName, data)
+      const eventNames = Object.keys(this.events)
+      for (const name of eventNames) {
+        const { bus, events: eventList } = this.events[name]
+        if (eventList.includes(eventName)) {
+          bus.fire(eventName, data)
+          break
         }
       }
     }
   }
 }
 
-function deepExtend(target:any,source:any):KV<any>{
+function deepExtend(target: any, source: any): KV<any> {
   if (!(source instanceof Object)) {
-    return source;
+    return source
   }
 
   switch (source.constructor) {
-    case Date:
-      const dateValue = source as Date;
-      return new Date(dateValue.getTime());
+    case Date: {
+      const dateValue = source as Date
+      return new Date(dateValue.getTime())
+    }
     case Object:
       if (target === undefined) {
-        target = {};
+        target = {}
       }
-      break;
+      break
     case Array:
-      target = [];
-      break;
+      target = []
+      break
     default:
-      return source;
+      return source
   }
-  for (const key in source) {
-    if (!source.hasOwnProperty(key)) {
-      continue;
+  const sourceKeys = Object.keys(source)
+  for (const key of sourceKeys) {
+    if (!Object.prototype.hasOwnProperty.call(source, key)) {
+      continue
     }
-    target[key] = deepExtend(target[key],source[key]);
+    target[key] = deepExtend(target[key], source[key])
   }
 
-  return target;
+  return target
 }
 
-export function registerHook(app:any,hook:ICloudbaseHook){
-  const { entity, target } = hook;
-  if(!app.prototype.hasOwnProperty(target)){
+export function registerHook(app: any, hook: ICloudbaseHook) {
+  const { entity, target } = hook
+  if (Object.prototype.hasOwnProperty.call(app, target)) {
     throw new Error(JSON.stringify({
       code: ERRORS.INVALID_OPERATION,
-      msg: `target:${target} is not exist`
-    }));
+      msg: `target:${target} is not exist`,
+    }))
   }
-  const originMethod = app.prototype[target];
-  if(typeof originMethod !== 'function'){
+  const originMethod = app.prototype[target]
+  if (typeof originMethod !== 'function') {
     throw new Error(JSON.stringify({
       code: ERRORS.INVALID_OPERATION,
-      msg: `target:${target} is not a function which is the only type supports hook`
-    }));
+      msg: `target:${target} is not a function which is the only type supports hook`,
+    }))
   }
-  app.prototype[target] = function(...args:any){
-    entity.call(this,...args);
-    return originMethod.call(this,...args);
+  app.prototype[target] = function (...args: any) {
+    entity.call(this, ...args)
+    return originMethod.call(this, ...args)
   }
-}
+}