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

package/es/base.js

@@ -9,13 +9,13 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
 import { createMicroApp } from '@alicloud/console-os-kernal';
-import { getManifestFromConfig, getURL, getAlfaEnv } from './utils';
+import { getManifestFromConfig, getURL, getEnv } from './utils';
 import Hook from './utils/hookManager';
 import Logger from './utils/logger';
 
 var mergeConfig = function mergeConfig(appConfig, logger) {
   return _objectSpread(_objectSpread({}, appConfig), {}, {
-    env: appConfig.env || getAlfaEnv(),
+    env: getEnv(appConfig.env),
     logger: appConfig.logger || logger
   });
 };
@@ -48,6 +48,7 @@ var BaseLoader = /*#__PURE__*/function () {
                 }
 
                 logger.error({
+                  E_CODE: 'RuntimeError',
                   E_MSG: 'cannot find config before start.'
                 });
                 return _context.abrupt("return", Promise.reject(new Error('[alfa-core] cannot find config before start.')));

package/es/index.js

@@ -1,8 +1,9 @@
 export { createMicroApp } from './createMicroApp';
-export { getRelease } from './utils/getAlfaRelease';
-export { getManifest } from './utils/getAlfaManifest';
-export { getConfig } from './utils/getAlfaConfig';
-export { getLocale } from './utils/getAlfaLocale';
+export { getRelease } from './utils/getRelease';
+export { getManifest } from './utils/getManifest';
+export { getConfig } from './utils/getConfig';
+export { getI18nMessages } from './utils/getI18nMessages';
+export { getLocale, getEnv } from './utils';
 export { default as BaseLoader } from './base';
 export { default as Logger } from './utils/logger';
 export * from './utils/index';

package/es/utils/env.js

@@ -0,0 +1,16 @@
+/**
+ * get alfa env
+ * @returns
+ */
+export var getEnv = function getEnv(value) {
+  var _window, _window$ALIYUN_CONSOL;
+
+  if (value) return value;
+
+  if (process.env.NODE_ENV === 'development') {
+    return 'local';
+  } // default return prod
+
+
+  return ((_window = window) === null || _window === void 0 ? void 0 : (_window$ALIYUN_CONSOL = _window.ALIYUN_CONSOLE_CONFIG) === null || _window$ALIYUN_CONSOL === void 0 ? void 0 : _window$ALIYUN_CONSOL.fEnv) || 'prod';
+};

package/es/utils/getConfig.js

@@ -0,0 +1,75 @@
+import _asyncToGenerator from "@babel/runtime/helpers/esm/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+import { getRelease } from './getRelease';
+import cache from './cacheManager';
+var defaultConfig = {
+  ALL_CHANNEL_FEATURE_STATUS: {},
+  ALL_CHANNEL_LINKS: {},
+  ALL_FEATURE_STATUS: {},
+  GLOBAL_DATA: {}
+};
+/**
+ * 获取 Alfa 平台配置的 Config
+ * @param config
+ * @returns
+ */
+
+export var getConfig = /*#__PURE__*/function () {
+  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(config) {
+    var _releaseConfig$distT, _releaseConfig$config, _releaseConfig$config2;
+
+    var releaseConfig, logger, configVersion, configEntry, configData;
+    return _regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            _context.next = 2;
+            return getRelease(config);
+
+          case 2:
+            releaseConfig = _context.sent;
+            logger = config.logger;
+            configVersion = ((_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[configVersion]) === null || _releaseConfig$config2 === void 0 ? void 0 : _releaseConfig$config2.entry;
+            configData = defaultConfig; // when config is not valid, return empty
+
+            if (!(!configVersion || !configEntry)) {
+              _context.next = 9;
+              break;
+            }
+
+            return _context.abrupt("return", configData);
+
+          case 9:
+            _context.prev = 9;
+            _context.next = 12;
+            return cache.getRemote(configEntry);
+
+          case 12:
+            configData = _context.sent;
+            _context.next = 18;
+            break;
+
+          case 15:
+            _context.prev = 15;
+            _context.t0 = _context["catch"](9);
+            (logger === null || logger === void 0 ? void 0 : logger.error) && logger.error({
+              E_CODE: 'GetConfigError',
+              E_MSG: _context.t0.message
+            });
+
+          case 18:
+            return _context.abrupt("return", configData);
+
+          case 19:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee, null, [[9, 15]]);
+  }));
+
+  return function getConfig(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();

package/es/utils/getI18nMessages.js

@@ -0,0 +1,71 @@
+import _asyncToGenerator from "@babel/runtime/helpers/esm/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+import { getLocale } from './locale';
+import { getRelease } from './getRelease';
+import cache from './cacheManager';
+/**
+ * 获取国际化文案
+ * @param config
+ * @returns
+ */
+
+export var getI18nMessages = /*#__PURE__*/function () {
+  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(config) {
+    var _releaseConfig$distT, _releaseConfig$locale, _releaseConfig$locale2;
+
+    var releaseConfig, logger, locale, localeVersion, localeEntry, messages;
+    return _regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            _context.next = 2;
+            return getRelease(config);
+
+          case 2:
+            releaseConfig = _context.sent;
+            logger = config.logger;
+            locale = getLocale(config.locale);
+            localeVersion = ((_releaseConfig$distT = releaseConfig['dist-tags']) === null || _releaseConfig$distT === void 0 ? void 0 : _releaseConfig$distT['locales-latest']) || '';
+            localeEntry = (_releaseConfig$locale = releaseConfig['locales-versions']) === null || _releaseConfig$locale === void 0 ? void 0 : (_releaseConfig$locale2 = _releaseConfig$locale[localeVersion]) === null || _releaseConfig$locale2 === void 0 ? void 0 : _releaseConfig$locale2[locale];
+            messages = {};
+
+            if (localeVersion) {
+              _context.next = 10;
+              break;
+            }
+
+            return _context.abrupt("return", messages);
+
+          case 10:
+            _context.prev = 10;
+            _context.next = 13;
+            return cache.getRemote(localeEntry);
+
+          case 13:
+            messages = _context.sent;
+            _context.next = 19;
+            break;
+
+          case 16:
+            _context.prev = 16;
+            _context.t0 = _context["catch"](10);
+            (logger === null || logger === void 0 ? void 0 : logger.error) && logger.error({
+              E_CODE: 'GetLocaleError',
+              E_MSG: _context.t0.message
+            });
+
+          case 19:
+            return _context.abrupt("return", messages);
+
+          case 20:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee, null, [[10, 16]]);
+  }));
+
+  return function getI18nMessages(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();

package/es/utils/getManifest.js

@@ -0,0 +1,123 @@
+import _asyncToGenerator from "@babel/runtime/helpers/esm/asyncToGenerator";
+import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+import { getRelease } from './getRelease';
+import cache from './cacheManager';
+var devHostname = '//dev.g.alicdn.com/';
+
+var replaceHost = function replaceHost(origin) {
+  return origin.replace('//g.alicdn.com/', devHostname);
+};
+/**
+ * format url in manifest json
+ * @param manifest
+ */
+
+
+var formatManifest = function formatManifest(manifestContent, manifestUrl) {
+  if (manifestUrl.indexOf(devHostname) === -1) return manifestContent;
+  var name = manifestContent.name,
+      resources = manifestContent.resources,
+      runtime = manifestContent.runtime,
+      externals = manifestContent.externals,
+      entrypoints = manifestContent.entrypoints;
+  var entrypoint = Object.keys(entrypoints)[0];
+  return {
+    name: name,
+    resources: Object.keys(resources).reduce(function (map, key) {
+      map[key] = replaceHost(resources[key]);
+      return map;
+    }, {}),
+    runtime: runtime,
+    externals: externals,
+    entrypoints: _defineProperty({}, entrypoint, {
+      css: entrypoints[entrypoint].css.map(replaceHost),
+      js: entrypoints[entrypoint].js.map(replaceHost)
+    })
+  };
+};
+
+export var getManifest = /*#__PURE__*/function () {
+  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(config) {
+    var _releaseConfig$distT;
+
+    var releaseConfig, latestVersion, manifest, logger, entry, _config$version, version, _releaseConfig$distT2, _releaseConfig$versio, result;
+
+    return _regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            _context.next = 2;
+            return getRelease(config);
+
+          case 2:
+            releaseConfig = _context.sent;
+            latestVersion = (_releaseConfig$distT = releaseConfig['dist-tags']) === null || _releaseConfig$distT === void 0 ? void 0 : _releaseConfig$distT.latest;
+            manifest = config.manifest, logger = config.logger;
+            entry = ''; // if user has custom manifest
+
+            if (!manifest) {
+              _context.next = 12;
+              break;
+            }
+
+            if (!(typeof manifest !== 'string')) {
+              _context.next = 9;
+              break;
+            }
+
+            return _context.abrupt("return", manifest);
+
+          case 9:
+            entry = manifest;
+            _context.next = 14;
+            break;
+
+          case 12:
+            _config$version = config.version, version = _config$version === void 0 ? latestVersion : _config$version;
+
+            if (version) {
+              // if version is in dist-tags, return value
+              if ((_releaseConfig$distT2 = releaseConfig['dist-tags']) !== null && _releaseConfig$distT2 !== void 0 && _releaseConfig$distT2[version]) {
+                version = releaseConfig['dist-tags'][version] || '';
+              }
+
+              entry = ((_releaseConfig$versio = releaseConfig.versions) === null || _releaseConfig$versio === void 0 ? void 0 : _releaseConfig$versio[version].entry) || '';
+            }
+
+          case 14:
+            _context.prev = 14;
+            _context.next = 17;
+            return cache.getRemote(entry);
+
+          case 17:
+            result = _context.sent;
+            (logger === null || logger === void 0 ? void 0 : logger.setContext) && logger.setContext({
+              manifest: JSON.stringify(result)
+            });
+            return _context.abrupt("return", formatManifest(result, entry));
+
+          case 22:
+            _context.prev = 22;
+            _context.t0 = _context["catch"](14);
+            (logger === null || logger === void 0 ? void 0 : logger.error) && logger.error({
+              E_CODE: 'GetManifestError',
+              E_MSG: _context.t0.message,
+              data: JSON.stringify(releaseConfig)
+            });
+
+          case 25:
+            return _context.abrupt("return", '');
+
+          case 26:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee, null, [[14, 22]]);
+  }));
+
+  return function getManifest(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();

package/es/utils/getRelease.js

@@ -0,0 +1,77 @@
+import _asyncToGenerator from "@babel/runtime/helpers/esm/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+import cache from './cacheManager';
+import { getEnv } from './env';
+/**
+ * get alfa release url
+ * @param appId
+ * @param env
+ * @returns
+ */
+
+export var getReleaseUrl = function getReleaseUrl(name, env) {
+  var cdnUrl = "https://cws.alicdn.com/Release/alfa/".concat(name, "/release.json");
+  var cdnPreUrl = "https://cws2.alicdn.com/Prepub/alfa/".concat(name, "/release.json");
+
+  switch (env) {
+    case 'local':
+      return process.env.ALFA_RELEASE_URL || cdnPreUrl;
+
+    case 'daily':
+      return cdnPreUrl;
+
+    case 'pre':
+      return cdnPreUrl;
+
+    case 'prod':
+      return cdnUrl;
+
+    default:
+      break;
+  }
+
+  return undefined;
+};
+export var getRelease = /*#__PURE__*/function () {
+  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(config) {
+    var logger, name, env, releaseConfig;
+    return _regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            logger = config.logger, name = config.name;
+            env = getEnv(config.env);
+            _context.prev = 2;
+            _context.next = 5;
+            return cache.getRemote(getReleaseUrl(name, env));
+
+          case 5:
+            releaseConfig = _context.sent;
+            (logger === null || logger === void 0 ? void 0 : logger.setContext) && logger.setContext({
+              release: JSON.stringify(releaseConfig)
+            });
+            return _context.abrupt("return", releaseConfig);
+
+          case 10:
+            _context.prev = 10;
+            _context.t0 = _context["catch"](2);
+            (logger === null || logger === void 0 ? void 0 : logger.error) && logger.error({
+              E_CODE: 'GetReleaseError',
+              E_MSG: _context.t0.message
+            });
+
+          case 13:
+            return _context.abrupt("return", {});
+
+          case 14:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee, null, [[2, 10]]);
+  }));
+
+  return function getRelease(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();

package/es/utils/index.js

@@ -1,100 +1,5 @@
-/**
- * get alfa env
- * @returns
- */
-export var getAlfaEnv = function getAlfaEnv() {
-  var _window, _window$ALIYUN_CONSOL;
-
-  if (process.env.NODE_ENV === 'development') {
-    return 'local';
-  } // default return prod
-
-
-  return ((_window = window) === null || _window === void 0 ? void 0 : (_window$ALIYUN_CONSOL = _window.ALIYUN_CONSOLE_CONFIG) === null || _window$ALIYUN_CONSOL === void 0 ? void 0 : _window$ALIYUN_CONSOL.fEnv) || 'prod';
-};
-/**
- * get alfa Locale and replace '-' to '_'
- * example: en-US => en_US
- * @returns
- */
-
-export var getAlfaLocale = function getAlfaLocale() {
-  var _window2, _window2$ALIYUN_CONSO;
-
-  var locale = (((_window2 = window) === null || _window2 === void 0 ? void 0 : (_window2$ALIYUN_CONSO = _window2.ALIYUN_CONSOLE_CONFIG) === null || _window2$ALIYUN_CONSO === void 0 ? void 0 : _window2$ALIYUN_CONSO.LOCALE) || '').replace('-', '_');
-  if (['zh_CN', 'en_US', 'ja_JP', 'zh_TW', 'zh-HK'].includes(locale)) return locale;
-  return 'en_US';
-};
-/**
- * get alfa release url
- * @param appId
- * @param env
- * @returns
- */
-
-export var getReleaseUrl = function getReleaseUrl(name, env) {
-  var cdnUrl = "https://cws.alicdn.com/Release/alfa/".concat(name, "/release.json");
-  var cdnPreUrl = "https://cws2.alicdn.com/Prepub/alfa/".concat(name, "/release.json");
-
-  switch (env) {
-    case 'local':
-      return process.env.ALFA_RELEASE_URL || cdnPreUrl;
-
-    case 'daily':
-      return cdnPreUrl;
-
-    case 'pre':
-      return cdnPreUrl;
-
-    case 'prod':
-      return cdnUrl;
-
-    default:
-      break;
-  }
-
-  return undefined;
-};
-/**
- * get alfa config url
- * @param appId
- * @param env
- * @returns
- */
-
-export var getConfigUrl = function getConfigUrl(name, env) {
-  var configUrl = "https://cws.alicdn.com/Release/alfa-products/".concat(name, "/config.json");
-  var configPreUrl = "https://cws2.alicdn.com/Prepub/alfa-products/".concat(name, "/config.json");
-
-  switch (env) {
-    case 'local':
-      return configPreUrl;
-
-    case 'daily':
-      return configPreUrl;
-
-    case 'pre':
-      return configPreUrl;
-
-    case 'prod':
-      return configUrl;
-
-    default:
-      break;
-  }
-
-  return undefined;
-};
-export var resolveReleaseUrl = function resolveReleaseUrl(config) {
-  var name = config.name,
-      env = config.env;
-  return getReleaseUrl(name, env || getAlfaEnv());
-};
-export var resolveConfigUrl = function resolveConfigUrl(config) {
-  var name = config.name,
-      env = config.env;
-  return getConfigUrl(name, env || getAlfaEnv());
-};
+export { getEnv } from './env';
+export { getLocale } from './locale';
 export var getURL = function getURL(appConfig) {
   var entry = appConfig.entry;
   var url = '';

package/es/utils/locale.js

@@ -0,0 +1,22 @@
+var globalLocale = 'en_US';
+/**
+ * x-X-Y to x_X_Y
+ * @param key
+ * @returns
+ */
+
+var formatLocale = function formatLocale(key) {
+  return key === null || key === void 0 ? void 0 : key.replace('-', '_');
+};
+/**
+ * getLocale
+ * @returns
+ */
+
+
+export var getLocale = function getLocale(key) {
+  var _window, _window$ALIYUN_CONSOL;
+
+  var locale = formatLocale(key || ((_window = window) === null || _window === void 0 ? void 0 : (_window$ALIYUN_CONSOL = _window.ALIYUN_CONSOLE_CONFIG) === null || _window$ALIYUN_CONSOL === void 0 ? void 0 : _window$ALIYUN_CONSOL.LOCALE));
+  return locale || globalLocale;
+};

package/lib/base.js

@@ -31,7 +31,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 var mergeConfig = function mergeConfig(appConfig, logger) {
   return _objectSpread(_objectSpread({}, appConfig), {}, {
-    env: appConfig.env || (0, _utils.getAlfaEnv)(),
+    env: (0, _utils.getEnv)(appConfig.env),
     logger: appConfig.logger || logger
   });
 };
@@ -63,6 +63,7 @@ var BaseLoader = /*#__PURE__*/function () {
                 }
 
                 logger.error({
+                  E_CODE: 'RuntimeError',
                   E_MSG: 'cannot find config before start.'
                 });
                 return _context.abrupt("return", Promise.reject(new Error('[alfa-core] cannot find config before start.')));

package/lib/index.d.ts

@@ -1,8 +1,9 @@
 export { createMicroApp } from './createMicroApp';
-export { getRelease } from './utils/getAlfaRelease';
-export { getManifest } from './utils/getAlfaManifest';
-export { getConfig } from './utils/getAlfaConfig';
-export { getLocale } from './utils/getAlfaLocale';
+export { getRelease } from './utils/getRelease';
+export { getManifest } from './utils/getManifest';
+export { getConfig } from './utils/getConfig';
+export { getI18nMessages } from './utils/getI18nMessages';
+export { getLocale, getEnv } from './utils';
 export { default as BaseLoader } from './base';
 export { default as Logger } from './utils/logger';
 export * from './utils/index';

package/lib/index.js

@@ -10,7 +10,9 @@ var _exportNames = {
   getRelease: true,
   getManifest: true,
   getConfig: true,
+  getI18nMessages: true,
   getLocale: true,
+  getEnv: true,
   BaseLoader: true,
   Logger: true,
   createEventBus: true,
@@ -92,25 +94,37 @@ Object.defineProperty(exports, "createMicroApp", {
 Object.defineProperty(exports, "getConfig", {
   enumerable: true,
   get: function get() {
-    return _getAlfaConfig.getConfig;
+    return _getConfig.getConfig;
+  }
+});
+Object.defineProperty(exports, "getEnv", {
+  enumerable: true,
+  get: function get() {
+    return _utils.getEnv;
+  }
+});
+Object.defineProperty(exports, "getI18nMessages", {
+  enumerable: true,
+  get: function get() {
+    return _getI18nMessages.getI18nMessages;
   }
 });
 Object.defineProperty(exports, "getLocale", {
   enumerable: true,
   get: function get() {
-    return _getAlfaLocale.getLocale;
+    return _utils.getLocale;
   }
 });
 Object.defineProperty(exports, "getManifest", {
   enumerable: true,
   get: function get() {
-    return _getAlfaManifest.getManifest;
+    return _getManifest.getManifest;
   }
 });
 Object.defineProperty(exports, "getRelease", {
   enumerable: true,
   get: function get() {
-    return _getAlfaRelease.getRelease;
+    return _getRelease.getRelease;
   }
 });
 Object.defineProperty(exports, "prefetch", {
@@ -122,13 +136,15 @@ Object.defineProperty(exports, "prefetch", {
 
 var _createMicroApp = require("./createMicroApp");
 
-var _getAlfaRelease = require("./utils/getAlfaRelease");
+var _getRelease = require("./utils/getRelease");
+
+var _getManifest = require("./utils/getManifest");
 
-var _getAlfaManifest = require("./utils/getAlfaManifest");
+var _getConfig = require("./utils/getConfig");
 
-var _getAlfaConfig = require("./utils/getAlfaConfig");
+var _getI18nMessages = require("./utils/getI18nMessages");
 
-var _getAlfaLocale = require("./utils/getAlfaLocale");
+var _utils = require("./utils");
 
 var _base = _interopRequireDefault(require("./base"));
 

package/lib/types/index.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="react" />
 import { OSApplication, SandBoxOption, AppInfo } from '@alicloud/console-os-kernal';
 export declare class AlfaLogger<P = any> {
+    setContext?: (params: P) => void;
     record?: (params: P) => void;
     send?: () => void;
     info?: (params: P) => void;
@@ -54,6 +55,7 @@ export interface IAppConfig<P = any> extends IOptions {
     };
     app?: OSApplication;
     env?: EnvEnum;
+    locale?: string;
 }
 export interface IOptions {
     sandbox?: SandBoxOption;
@@ -68,9 +70,7 @@ export interface AlfaVersion {
     entry: string;
 }
 export declare type LOCALE = 'en_US' | 'zh_CN' | 'zh_TW' | 'zh_HK' | 'ja_JP';
-export declare type AlfaLocaleVersion = {
-    [key in LOCALE | 'entry']: string;
-};
+export declare type AlfaLocaleVersion = Partial<Record<string, string>>;
 export declare type Version = string;
 export interface AlfaConfigVersion {
     [key: string]: string;

package/lib/utils/env.d.ts

@@ -0,0 +1,6 @@
+import { EnvEnum } from '../types';
+/**
+ * get alfa env
+ * @returns
+ */
+export declare const getEnv: (value?: "prod" | "local" | "pre" | "daily" | undefined) => EnvEnum;