@alicloud/alfa-core 1.3.0-alpha.1 → 1.3.0-alpha.2

package/lib/base.js

@@ -0,0 +1,213 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+
+var _consoleOsKernal = require("@alicloud/console-os-kernal");
+
+var _utils = require("./utils");
+
+var _hookManager = _interopRequireDefault(require("./utils/hookManager"));
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+var BaseLoader = /*#__PURE__*/function () {
+  function BaseLoader() {
+    (0, _classCallCheck2.default)(this, BaseLoader);
+    this.beforeResolve = new _hookManager.default();
+    this.afterResolve = new _hookManager.default();
+    this.beforeLoad = new _hookManager.default();
+    this.afterLoad = new _hookManager.default();
+  }
+
+  (0, _createClass2.default)(BaseLoader, [{
+    key: "register",
+    value: function () {
+      var _register = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(config) {
+        var chains, flattenHookHandlers, promise;
+        return _regenerator.default.wrap(function _callee$(_context) {
+          while (1) {
+            switch (_context.prev = _context.next) {
+              case 0:
+                if (config) {
+                  _context.next = 2;
+                  break;
+                }
+
+                return _context.abrupt("return", Promise.reject(new Error('[alfa-core] register config is not existed.')));
+
+              case 2:
+                this.config = config;
+                chains = [];
+
+                flattenHookHandlers = function flattenHookHandlers(handler) {
+                  var fulfilled = handler.fulfilled,
+                      rejected = handler.rejected;
+                  chains.push(fulfilled, rejected);
+                }; // resolve entry from config
+
+
+                this.beforeResolve.handlers.forEach(flattenHookHandlers); // TODO: handle beforeResolve error
+
+                chains.push(this.resolve, undefined); // modify resolved config
+
+                this.afterResolve.handlers.forEach(flattenHookHandlers); // update props before load
+
+                this.beforeLoad.handlers.forEach(flattenHookHandlers); // TODO: handle beforeLoad error
+
+                chains.push(this.load, undefined); // modify context after load
+
+                this.afterLoad.handlers.forEach(flattenHookHandlers);
+                promise = Promise.resolve(this.config);
+
+                while (chains.length) {
+                  promise = promise.then(chains.shift(), chains.shift());
+                }
+
+                return _context.abrupt("return", promise);
+
+              case 14:
+              case "end":
+                return _context.stop();
+            }
+          }
+        }, _callee, this);
+      }));
+
+      function register(_x) {
+        return _register.apply(this, arguments);
+      }
+
+      return register;
+    }()
+    /**
+     * resolve config and rewrite manifest and url
+     * @param config
+     * @returns
+     */
+
+  }, {
+    key: "resolve",
+    value: function () {
+      var _resolve = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(config) {
+        var manifest, url;
+        return _regenerator.default.wrap(function _callee2$(_context2) {
+          while (1) {
+            switch (_context2.prev = _context2.next) {
+              case 0:
+                manifest = (0, _utils.getManifestFromConfig)(config);
+                url = (0, _utils.getURL)(config);
+
+                if (!(!manifest && !url)) {
+                  _context2.next = 4;
+                  break;
+                }
+
+                throw new Error("No entry or manifest in ".concat(config.name));
+
+              case 4:
+                return _context2.abrupt("return", _objectSpread(_objectSpread({}, config), {}, {
+                  manifest: manifest,
+                  url: url
+                }));
+
+              case 5:
+              case "end":
+                return _context2.stop();
+            }
+          }
+        }, _callee2);
+      }));
+
+      function resolve(_x2) {
+        return _resolve.apply(this, arguments);
+      }
+
+      return resolve;
+    }()
+    /**
+     * loadApp from remote
+     * @param config
+     * @returns
+     */
+
+  }, {
+    key: "load",
+    value: function () {
+      var _load = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(config) {
+        var name, container, manifest, props, deps, url, beforeMount, afterMount, beforeUnmount, afterUnmount, beforeUpdate, sandbox, logger, app;
+        return _regenerator.default.wrap(function _callee3$(_context3) {
+          while (1) {
+            switch (_context3.prev = _context3.next) {
+              case 0:
+                name = config.name, container = config.container, manifest = config.manifest, props = config.props, deps = config.deps, url = config.url, beforeMount = config.beforeMount, afterMount = config.afterMount, beforeUnmount = config.beforeUnmount, afterUnmount = config.afterUnmount, beforeUpdate = config.beforeUpdate, sandbox = config.sandbox, logger = config.logger;
+                _context3.next = 3;
+                return (0, _consoleOsKernal.createMicroApp)({
+                  name: name,
+                  dom: container,
+                  manifest: manifest,
+                  customProps: props,
+                  deps: deps,
+                  url: url,
+                  logger: logger,
+                  appWillMount: beforeMount,
+                  appDidMount: afterMount,
+                  appWillUnmount: beforeUnmount,
+                  appDidUnmount: afterUnmount,
+                  appWillUpdate: beforeUpdate
+                }, {
+                  sandbox: sandbox // parcel
+
+                });
+
+              case 3:
+                app = _context3.sent;
+                _context3.next = 6;
+                return app.load();
+
+              case 6:
+                return _context3.abrupt("return", _objectSpread(_objectSpread({}, config), {}, {
+                  app: app
+                }));
+
+              case 7:
+              case "end":
+                return _context3.stop();
+            }
+          }
+        }, _callee3);
+      }));
+
+      function load(_x3) {
+        return _load.apply(this, arguments);
+      }
+
+      return load;
+    }()
+  }], [{
+    key: "create",
+    value: // just create instance, will be mounted in loader
+    function create() {
+      return new this();
+    }
+  }]);
+  return BaseLoader;
+}();
+
+exports.default = BaseLoader;

package/lib/createMicroApp.js

@@ -9,6 +9,7 @@ var _consoleOsKernal = require("@alicloud/console-os-kernal");
 
 var _utils = require("./utils");
 
+// TODO: deprecate in next major version
 var createMicroApp = function createMicroApp(appConfig) {
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   var manifest = (0, _utils.getManifestFromConfig)(appConfig);

package/lib/index.d.ts

@@ -2,5 +2,6 @@ export { createMicroApp } from './createMicroApp';
 export { getManifest } from './utils/getAlfaManifest';
 export { getConfig } from './utils/getAlfaConfig';
 export { getLocale } from './utils/getAlfaLocale';
+export { default as BaseLoader } from './base';
 export { createEventBus, prefetch } from '@alicloud/console-os-kernal';
-export { IAppConfig, IOptions, AlfaFactoryOption, AlfaDynamicConfig as AlfaConfig, IWin } from './types';
+export { IAppConfig, IOptions, AlfaFactoryOption, AlfaDynamicConfig as AlfaConfig, IWin, EnvEnum as AlfaEnvEnum } from './types';

package/lib/index.js

@@ -1,5 +1,7 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -9,12 +11,24 @@ Object.defineProperty(exports, "AlfaConfig", {
     return _types.AlfaDynamicConfig;
   }
 });
+Object.defineProperty(exports, "AlfaEnvEnum", {
+  enumerable: true,
+  get: function get() {
+    return _types.EnvEnum;
+  }
+});
 Object.defineProperty(exports, "AlfaFactoryOption", {
   enumerable: true,
   get: function get() {
     return _types.AlfaFactoryOption;
   }
 });
+Object.defineProperty(exports, "BaseLoader", {
+  enumerable: true,
+  get: function get() {
+    return _base.default;
+  }
+});
 Object.defineProperty(exports, "IAppConfig", {
   enumerable: true,
   get: function get() {
@@ -78,6 +92,8 @@ var _getAlfaConfig = require("./utils/getAlfaConfig");
 
 var _getAlfaLocale = require("./utils/getAlfaLocale");
 
+var _base = _interopRequireDefault(require("./base"));
+
 var _consoleOsKernal = require("@alicloud/console-os-kernal");
 
 var _types = require("./types");

package/lib/types/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { OSApplication, SandBoxOption } from '@alicloud/console-os-kernal';
+import { OSApplication, SandBoxOption, AppInfo } from '@alicloud/console-os-kernal';
 declare type Channel = string;
 declare type ChannelLinks = Partial<Record<string, string>>;
 declare type ChannelFeatures = Partial<Record<string, {
@@ -11,10 +11,10 @@ declare type ChannelFeatures = Partial<Record<string, {
         };
     };
 }>>;
-declare type FeatureStatus = Partial<Record<string, string>>;
+declare type FeatureStatus = Partial<Record<string, boolean>>;
 export interface IWin {
     ALIYUN_CONSOLE_I18N_MESSAGE?: Record<string, string>;
-    ALIYUN_CONSOLE_CONFIG?: {
+    ALIYUN_CONSOLE_CONFIG?: Partial<{
         fEnv: string;
         LOCALE: string;
         CHANNEL: string;
@@ -25,18 +25,20 @@ export interface IWin {
         portalType: string;
         MAIN_ACCOUNT_PK: string;
         CURRENT_PK: string;
-    };
+    }>;
 }
 export interface IAppManifest {
     scripts: string[];
     styles?: string[];
 }
-export interface IAppConfig<T = any> {
+export interface IAppConfig<P = any> extends IOptions {
     entry?: IAppManifest | string;
     name: string;
+    version?: string;
     container?: HTMLElement | null;
-    props?: Record<string, T>;
-    manifest?: string;
+    props?: P;
+    manifest?: AppInfo['manifest'];
+    url?: string;
     logger?: {
         debug: () => {};
         error: () => {};
@@ -46,15 +48,17 @@ export interface IAppConfig<T = any> {
     deps?: {
         [key: string]: any;
     };
+    app?: OSApplication;
+    env?: EnvEnum;
 }
 export interface IOptions {
-    sandbox?: boolean | SandBoxOption;
-    beforeMount?: (app: OSApplication) => void;
-    afterMount?: (app: OSApplication) => void;
-    beforeUnmount?: (app: OSApplication) => void;
-    afterUnmount?: (app: OSApplication) => void;
-    beforeUpdate?: (app: OSApplication) => void;
-    afterUpdate?: (app: OSApplication) => void;
+    sandbox?: SandBoxOption;
+    beforeMount?: AppInfo['appWillMount'];
+    afterMount?: AppInfo['appDidMount'];
+    beforeUnmount?: AppInfo['appWillUnmount'];
+    afterUnmount?: AppInfo['appDidUnmount'];
+    beforeUpdate?: AppInfo['appWillUpdate'];
+    afterUpdate?: AppInfo['appWillUpdate'];
 }
 export interface AlfaVersion {
     entry: string;
@@ -63,11 +67,15 @@ export declare type LOCALE = 'en_US' | 'zh_CN' | 'zh_TW' | 'zh_HK' | 'ja_JP';
 export declare type AlfaLocaleVersion = {
     [key in LOCALE | 'entry']: string;
 };
-declare type Version = string;
+export declare type Version = string;
+export interface AlfaConfigVersion {
+    [key: string]: string;
+}
 export interface AlfaReleaseConfig {
-    'dist-tags': Record<string, string>;
-    versions: Record<Version, AlfaVersion>;
-    'locales-versions': Record<Version, AlfaLocaleVersion>;
+    'dist-tags'?: Partial<Record<string, string>>;
+    versions?: Record<Version, Partial<AlfaVersion>>;
+    'locales-versions'?: Record<Version, Partial<AlfaLocaleVersion>>;
+    'config-versions'?: Record<Version, Partial<AlfaConfigVersion>>;
 }
 declare type AlfaChannelLinks = Partial<Record<Channel, ChannelLinks>>;
 declare type AlfaChannelFeatures = Partial<Record<Channel, ChannelFeatures>>;
@@ -86,7 +94,10 @@ export interface AlfaDynamicConfig {
     ALL_FEATURE_STATUS: AlfaFeatures;
 }
 export declare type EnvEnum = 'prod' | 'local' | 'pre' | 'daily';
-export interface AlfaFactoryOption extends IOptions {
+/**
+   * @deprecated
+   */
+export interface AlfaFactoryOption extends IAppConfig {
     name: string;
     version?: string;
     env?: EnvEnum;
@@ -94,6 +105,5 @@ export interface AlfaFactoryOption extends IOptions {
     url?: string;
     manifest?: string;
     dependencies?: Record<string, any>;
-    dynamicConfig?: boolean;
 }
 export {};

package/lib/utils/cacheManager.d.ts

@@ -0,0 +1,11 @@
+declare class Cache {
+    static create(): Cache;
+    store: Record<string, unknown>;
+    constructor();
+    getRemote<T = any>(url: string): Promise<T>;
+    get<V = any>(key: string): V;
+    set<V = any>(key: string, value: V): void;
+    clear(): void;
+}
+declare const _default: Cache;
+export default _default;

package/lib/utils/cacheManager.js

@@ -0,0 +1,92 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+
+var _axios = _interopRequireDefault(require("axios"));
+
+var Cache = /*#__PURE__*/function () {
+  function Cache() {
+    (0, _classCallCheck2.default)(this, Cache);
+    this.store = {};
+  }
+
+  (0, _createClass2.default)(Cache, [{
+    key: "getRemote",
+    value: function () {
+      var _getRemote = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(url) {
+        var res, result;
+        return _regenerator.default.wrap(function _callee$(_context) {
+          while (1) {
+            switch (_context.prev = _context.next) {
+              case 0:
+                if (!this.store[url]) {
+                  _context.next = 2;
+                  break;
+                }
+
+                return _context.abrupt("return", this.store[url]);
+
+              case 2:
+                _context.next = 4;
+                return _axios.default.get(url);
+
+              case 4:
+                res = _context.sent;
+                result = res.data;
+                if (result) this.store[url] = result;
+                return _context.abrupt("return", result);
+
+              case 8:
+              case "end":
+                return _context.stop();
+            }
+          }
+        }, _callee, this);
+      }));
+
+      function getRemote(_x) {
+        return _getRemote.apply(this, arguments);
+      }
+
+      return getRemote;
+    }()
+  }, {
+    key: "get",
+    value: function get(key) {
+      return this.store[key];
+    }
+  }, {
+    key: "set",
+    value: function set(key, value) {
+      this.store[key] = value;
+    }
+  }, {
+    key: "clear",
+    value: function clear() {
+      this.store = {};
+    }
+  }], [{
+    key: "create",
+    value: function create() {
+      return new this();
+    }
+  }]);
+  return Cache;
+}();
+
+var _default = Cache.create();
+
+exports.default = _default;

package/lib/utils/getAlfaConfig.d.ts

@@ -1,7 +1,7 @@
-import { AlfaFactoryOption, AlfaDynamicConfig } from '../types';
+import { IAppConfig } from '../types';
 /**
  * 获取 Alfa 平台配置的 Config
- * @param option
+ * @param config
  * @returns
  */
-export declare const getConfig: (option: AlfaFactoryOption) => Promise<AlfaDynamicConfig>;
+export declare const getConfig: (config: IAppConfig) => Promise<{}>;

package/lib/utils/getAlfaConfig.js

@@ -9,20 +9,12 @@ exports.getConfig = void 0;
 
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 
-var _axios = _interopRequireDefault(require("axios"));
-
-var _ = require(".");
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+var _getAlfaRelease = require("./getAlfaRelease");
 
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+var _cacheManager = _interopRequireDefault(require("./cacheManager"));
 
-var cachedConfig = {};
-var productReg = /@ali\/alfa-cloud-([a-zA-z]*)-(app|widget)-.*/;
 var defaultConfig = {
   ALL_CHANNEL_FEATURE_STATUS: {},
   ALL_CHANNEL_LINKS: {},
@@ -30,60 +22,58 @@ var defaultConfig = {
 };
 /**
  * 获取 Alfa 平台配置的 Config
- * @param option
+ * @param config
  * @returns
  */
 
 var getConfig = /*#__PURE__*/function () {
-  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(option) {
-    var matches, configId, resp, configData;
+  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(config) {
+    var _releaseConfig$distT, _releaseConfig$config, _releaseConfig$config2;
+
+    var releaseConfig, version, configEntry, configData;
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) {
         switch (_context.prev = _context.next) {
           case 0:
-            matches = option.name.match(productReg);
+            _context.next = 2;
+            return (0, _getAlfaRelease.getRelease)(config);
+
+          case 2:
+            releaseConfig = _context.sent;
+            version = (_releaseConfig$distT = releaseConfig['dist-tags']) === null || _releaseConfig$distT === void 0 ? void 0 : _releaseConfig$distT['config-latest'];
+            configEntry = (_releaseConfig$config = releaseConfig['config-versions']) === null || _releaseConfig$config === void 0 ? void 0 : (_releaseConfig$config2 = _releaseConfig$config[version]) === null || _releaseConfig$config2 === void 0 ? void 0 : _releaseConfig$config2.entry; // when config is not valid, return empty
 
-            if (matches) {
-              _context.next = 3;
+            if (!(!version || configEntry)) {
+              _context.next = 7;
               break;
             }
 
-            return _context.abrupt("return", defaultConfig);
+            return _context.abrupt("return", {});
 
-          case 3:
-            configId = matches[1] || option.name;
+          case 7:
+            configData = defaultConfig;
+            _context.prev = 8;
+            _context.next = 11;
+            return _cacheManager.default.getRemote(configEntry);
 
-            if (cachedConfig[configId]) {
-              _context.next = 15;
-              break;
-            }
-
-            _context.prev = 5;
-            _context.next = 8;
-            return _axios.default.get((0, _.resolveConfigUrl)(_objectSpread(_objectSpread({}, option), {}, {
-              name: configId
-            })));
-
-          case 8:
-            resp = _context.sent;
-            configData = resp.data;
-            cachedConfig[configId] = configData;
-            _context.next = 15;
+          case 11:
+            configData = _context.sent;
+            _context.next = 16;
             break;
 
-          case 13:
-            _context.prev = 13;
-            _context.t0 = _context["catch"](5);
-
-          case 15:
-            return _context.abrupt("return", cachedConfig[configId] || defaultConfig);
+          case 14:
+            _context.prev = 14;
+            _context.t0 = _context["catch"](8);
 
           case 16:
+            return _context.abrupt("return", configData);
+
+          case 17:
           case "end":
             return _context.stop();
         }
       }
-    }, _callee, null, [[5, 13]]);
+    }, _callee, null, [[8, 14]]);
   }));
 
   return function getConfig(_x) {

package/lib/utils/getAlfaLocale.d.ts

@@ -1,2 +1,7 @@
-import { AlfaFactoryOption } from '../types';
-export declare const getLocale: (option: AlfaFactoryOption) => Promise<Record<string, string>>;
+import { IAppConfig } from '../types';
+/**
+ * 获取国际化文案
+ * @param config
+ * @returns
+ */
+export declare const getLocale: (config: IAppConfig) => Promise<Record<string, string>>;