@alicloud/alfa-core 1.2.2 → 1.3.0-canary.1

package/es/createMicroApp.js

@@ -1,8 +1,8 @@
 import { createMicroApp as createConsoleOSMicroApp } from '@alicloud/console-os-kernal';
-import { getManifest, getURL } from './utils';
+import { getManifestFromConfig, getURL } from './utils';
 export var createMicroApp = function createMicroApp(appConfig) {
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  var manifest = getManifest(appConfig);
+  var manifest = getManifestFromConfig(appConfig);
   var url = getURL(appConfig);
 
   if (!manifest && !url) {

package/es/index.js

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

package/es/resolveAlfaRelease.js

@@ -0,0 +1,29 @@
+import _asyncToGenerator from "@babel/runtime/helpers/esm/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+import axios from 'axios';
+import { resolveReleaseUrl } from './utils';
+export var getRelease = /*#__PURE__*/function () {
+  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(option) {
+    var resp;
+    return _regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            _context.next = 2;
+            return axios.get(resolveReleaseUrl(option));
+
+          case 2:
+            resp = _context.sent;
+
+          case 3:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee);
+  }));
+
+  return function getRelease(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();

package/es/utils/getAlfaConfig.js

@@ -0,0 +1,79 @@
+import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
+import _asyncToGenerator from "@babel/runtime/helpers/esm/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+
+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) { _defineProperty(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; }
+
+import axios from 'axios';
+import { resolveConfigUrl } from '.';
+var cachedConfig = {};
+var productReg = /@ali\/alfa-cloud-([a-zA-z]*)-(app|widget)-.*/;
+var defaultConfig = {
+  ALL_CHANNEL_FEATURE_STATUS: {},
+  ALL_CHANNEL_LINKS: {},
+  ALL_FEATURE_STATUS: {}
+};
+/**
+ * 获取 Alfa 平台配置的 Config
+ * @param option
+ * @returns
+ */
+
+export var getConfig = /*#__PURE__*/function () {
+  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(option) {
+    var matches, configId, resp, configData;
+    return _regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            matches = option.name.match(productReg);
+
+            if (matches) {
+              _context.next = 3;
+              break;
+            }
+
+            return _context.abrupt("return", defaultConfig);
+
+          case 3:
+            configId = matches[1] || option.name;
+
+            if (cachedConfig[configId]) {
+              _context.next = 15;
+              break;
+            }
+
+            _context.prev = 5;
+            _context.next = 8;
+            return axios.get(resolveConfigUrl(_objectSpread(_objectSpread({}, option), {}, {
+              name: configId
+            })));
+
+          case 8:
+            resp = _context.sent;
+            configData = resp.data;
+            cachedConfig[configId] = configData;
+            _context.next = 15;
+            break;
+
+          case 13:
+            _context.prev = 13;
+            _context.t0 = _context["catch"](5);
+
+          case 15:
+            return _context.abrupt("return", cachedConfig[configId] || defaultConfig);
+
+          case 16:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee, null, [[5, 13]]);
+  }));
+
+  return function getConfig(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();

package/es/utils/getAlfaLocale.js

@@ -0,0 +1,56 @@
+import _asyncToGenerator from "@babel/runtime/helpers/esm/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+import axios from 'axios';
+import { resolveReleaseUrl, getAlfaLocale } from './index';
+export var getLocale = /*#__PURE__*/function () {
+  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(option) {
+    var _releaseConfig$distT, _releaseConfig$locale, _releaseConfig$locale2;
+
+    var resp, locale, releaseConfig, version, localeEntry, messages, res;
+    return _regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            _context.next = 2;
+            return axios.get(resolveReleaseUrl(option));
+
+          case 2:
+            resp = _context.sent;
+            locale = getAlfaLocale();
+            releaseConfig = resp.data;
+            version = (_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[version]) === null || _releaseConfig$locale2 === void 0 ? void 0 : _releaseConfig$locale2[locale];
+
+            if (!localeEntry) {// throw new Error(`${option.name} ${locale} entry is not found, please check you release.`);
+            }
+
+            messages = {};
+            _context.prev = 9;
+            _context.next = 12;
+            return axios.get(localeEntry);
+
+          case 12:
+            res = _context.sent;
+            messages = res.data;
+            _context.next = 18;
+            break;
+
+          case 16:
+            _context.prev = 16;
+            _context.t0 = _context["catch"](9);
+
+          case 18:
+            return _context.abrupt("return", messages);
+
+          case 19:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee, null, [[9, 16]]);
+  }));
+
+  return function getLocale(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();

package/es/utils/getAlfaManifest.js

@@ -0,0 +1,55 @@
+import _asyncToGenerator from "@babel/runtime/helpers/esm/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+import axios from 'axios';
+import { resolveReleaseUrl } from '.';
+export var getManifest = /*#__PURE__*/function () {
+  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(option) {
+    var _releaseConfig$distT2;
+
+    var resp, releaseConfig, version, _releaseConfig$distT, configByVersion;
+
+    return _regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            _context.next = 2;
+            return axios.get(resolveReleaseUrl(option));
+
+          case 2:
+            resp = _context.sent;
+            releaseConfig = resp.data;
+            version = option.version;
+
+            if (!option.version) {
+              version = (_releaseConfig$distT = releaseConfig['dist-tags']) === null || _releaseConfig$distT === void 0 ? void 0 : _releaseConfig$distT.latest;
+            } // if version is in dist-tags, return value
+
+
+            if ((_releaseConfig$distT2 = releaseConfig['dist-tags']) !== null && _releaseConfig$distT2 !== void 0 && _releaseConfig$distT2[option.version]) {
+              version = releaseConfig['dist-tags'][option.version];
+            }
+
+            configByVersion = releaseConfig.versions[version];
+
+            if (configByVersion) {
+              _context.next = 10;
+              break;
+            }
+
+            throw new Error("".concat(option.name, "@").concat(version, " is not found, please check you release."));
+
+          case 10:
+            return _context.abrupt("return", releaseConfig.versions[version].entry);
+
+          case 11:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee);
+  }));
+
+  return function getManifest(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();

package/es/utils/index.js

@@ -0,0 +1,120 @@
+/**
+ * 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(option) {
+  return getReleaseUrl(option.name, option.env || getAlfaEnv());
+};
+export var resolveConfigUrl = function resolveConfigUrl(option) {
+  return getConfigUrl(option.name, option.env || getAlfaEnv());
+};
+export var getURL = function getURL(appConfig) {
+  var entry = appConfig.entry;
+  var url = '';
+
+  if (typeof entry === 'string') {
+    url = entry;
+  }
+
+  return url;
+};
+export var getManifestFromConfig = function getManifestFromConfig(appConfig) {
+  // 定义了 entry 时，优先从 entry 生成 manifest
+  if (appConfig.entry && typeof appConfig.entry !== 'string') {
+    return {
+      name: appConfig.name,
+      resources: {},
+      entrypoints: {
+        index: {
+          js: appConfig.entry.scripts,
+          css: appConfig.entry.styles
+        }
+      }
+    };
+  }
+
+  return appConfig.manifest;
+};

package/lib/createMicroApp.d.ts

@@ -1,2 +1,2 @@
 import { IAppConfig, IOptions } from './types';
-export declare const createMicroApp: <T>(appConfig: IAppConfig<T>, options?: IOptions<T>) => Promise<import("@alicloud/console-os-kernal/lib/application/Application").Application>;
+export declare const createMicroApp: <T>(appConfig: IAppConfig<T>, options?: IOptions) => Promise<import("@alicloud/console-os-kernal/lib/application/Application").Application>;

package/lib/createMicroApp.js

@@ -11,7 +11,7 @@ var _utils = require("./utils");
 
 var createMicroApp = function createMicroApp(appConfig) {
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  var manifest = (0, _utils.getManifest)(appConfig);
+  var manifest = (0, _utils.getManifestFromConfig)(appConfig);
   var url = (0, _utils.getURL)(appConfig);
 
   if (!manifest && !url) {

package/lib/index.d.ts

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

package/lib/index.js

@@ -12,13 +12,31 @@ Object.defineProperty(exports, "createMicroApp", {
 Object.defineProperty(exports, "getManifest", {
   enumerable: true,
   get: function get() {
-    return _resolveAlfaManifest.getManifest;
+    return _getAlfaManifest.getManifest;
   }
 });
 Object.defineProperty(exports, "getConfig", {
   enumerable: true,
   get: function get() {
-    return _resolveAlfaConfig.getConfig;
+    return _getAlfaConfig.getConfig;
+  }
+});
+Object.defineProperty(exports, "getLocale", {
+  enumerable: true,
+  get: function get() {
+    return _getAlfaLocale.getLocale;
+  }
+});
+Object.defineProperty(exports, "createEventBus", {
+  enumerable: true,
+  get: function get() {
+    return _consoleOsKernal.createEventBus;
+  }
+});
+Object.defineProperty(exports, "prefetch", {
+  enumerable: true,
+  get: function get() {
+    return _consoleOsKernal.prefetch;
   }
 });
 Object.defineProperty(exports, "IAppConfig", {
@@ -45,25 +63,21 @@ Object.defineProperty(exports, "AlfaConfig", {
     return _types.AlfaDynamicConfig;
   }
 });
-Object.defineProperty(exports, "createEventBus", {
-  enumerable: true,
-  get: function get() {
-    return _consoleOsKernal.createEventBus;
-  }
-});
-Object.defineProperty(exports, "prefetch", {
+Object.defineProperty(exports, "IWin", {
   enumerable: true,
   get: function get() {
-    return _consoleOsKernal.prefetch;
+    return _types.IWin;
   }
 });
 
 var _createMicroApp = require("./createMicroApp");
 
-var _resolveAlfaManifest = require("./resolveAlfaManifest");
+var _getAlfaManifest = require("./utils/getAlfaManifest");
+
+var _getAlfaConfig = require("./utils/getAlfaConfig");
 
-var _resolveAlfaConfig = require("./resolveAlfaConfig");
+var _getAlfaLocale = require("./utils/getAlfaLocale");
 
-var _types = require("./types");
+var _consoleOsKernal = require("@alicloud/console-os-kernal");
 
-var _consoleOsKernal = require("@alicloud/console-os-kernal");
+var _types = require("./types");

package/lib/resolveAlfaRelease.d.ts

@@ -0,0 +1,2 @@
+import { AlfaFactoryOption } from './types';
+export declare const getRelease: (option: AlfaFactoryOption) => Promise<void>;

package/lib/resolveAlfaRelease.js

@@ -0,0 +1,44 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getRelease = void 0;
+
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+
+var _axios = _interopRequireDefault(require("axios"));
+
+var _utils = require("./utils");
+
+var getRelease = /*#__PURE__*/function () {
+  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(option) {
+    var resp;
+    return _regenerator.default.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            _context.next = 2;
+            return _axios.default.get((0, _utils.resolveReleaseUrl)(option));
+
+          case 2:
+            resp = _context.sent;
+
+          case 3:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee);
+  }));
+
+  return function getRelease(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();
+
+exports.getRelease = getRelease;

package/lib/types/index.d.ts

@@ -0,0 +1,99 @@
+/// <reference types="react" />
+import { OSApplication, SandBoxOption } from '@alicloud/console-os-kernal';
+declare type Channel = string;
+declare type ChannelLinks = Partial<Record<string, string>>;
+declare type ChannelFeatures = Partial<Record<string, {
+    status: boolean;
+    attribute: {
+        customAttrs: Record<string, unknown>;
+        regions: {
+            region: string[];
+        };
+    };
+}>>;
+declare type FeatureStatus = Partial<Record<string, string>>;
+export interface IWin {
+    ALIYUN_CONSOLE_I18N_MESSAGE?: Record<string, string>;
+    ALIYUN_CONSOLE_CONFIG?: {
+        fEnv: string;
+        LOCALE: string;
+        CHANNEL: string;
+        CHANNEL_LINKS: ChannelLinks;
+        CHANNEL_FEATURE_STATUS: ChannelFeatures;
+        FEATURE_STATUS: FeatureStatus;
+        SEC_TOKEN: string;
+        portalType: string;
+        MAIN_ACCOUNT_PK: string;
+        CURRENT_PK: string;
+    };
+}
+export interface IAppManifest {
+    scripts: string[];
+    styles?: string[];
+}
+export interface IAppConfig<T = any> {
+    entry?: IAppManifest | string;
+    name: string;
+    container?: HTMLElement | null;
+    props?: Record<string, T>;
+    manifest?: string;
+    logger?: {
+        debug: () => {};
+        error: () => {};
+        warn: () => {};
+        info: () => {};
+    };
+    deps?: {
+        [key: string]: any;
+    };
+}
+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;
+}
+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;
+};
+declare type Version = string;
+export interface AlfaReleaseConfig {
+    'dist-tags': Record<string, string>;
+    versions: Record<Version, AlfaVersion>;
+    'locales-versions': Record<Version, AlfaLocaleVersion>;
+}
+declare type AlfaChannelLinks = Partial<Record<Channel, ChannelLinks>>;
+declare type AlfaChannelFeatures = Partial<Record<Channel, ChannelFeatures>>;
+interface AlfaFeature {
+    enableSampling: boolean;
+    enableWhiteList: boolean;
+    enableBlockList: boolean;
+    sampling: number;
+    whiteList: string[];
+    blockList: string[];
+}
+declare type AlfaFeatures = Partial<Record<string, AlfaFeature>>;
+export interface AlfaDynamicConfig {
+    ALL_CHANNEL_LINKS: AlfaChannelLinks;
+    ALL_CHANNEL_FEATURE_STATUS: AlfaChannelFeatures;
+    ALL_FEATURE_STATUS: AlfaFeatures;
+}
+export declare type EnvEnum = 'prod' | 'local' | 'pre' | 'daily';
+export interface AlfaFactoryOption extends IOptions {
+    name: string;
+    version?: string;
+    env?: EnvEnum;
+    loading?: boolean | React.ReactChild;
+    url?: string;
+    manifest?: string;
+    dependencies?: Record<string, any>;
+    dynamicConfig?: boolean;
+}
+export {};

package/lib/types/index.js

@@ -0,0 +1 @@
+"use strict";

package/lib/utils/getAlfaConfig.d.ts

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