@copart/ops-tool-kit 1.13.0-beta.11 → 1.13.0-beta.12

package/dist/ops-tool-kit.js

@@ -6,6 +6,7 @@ var React = require('react');
 var ReactDOM = require('react-dom');
 var frontEndUtils = require('@copart/front-end-utils');
 var coreComponents = require('@copart/core-components');
+var reactRouterDom = require('react-router-dom');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -47,12 +48,13 @@ var React__namespace = /*#__PURE__*/_interopNamespace(React);
 var ReactDOM__default = /*#__PURE__*/_interopDefaultLegacy(ReactDOM);
 
 const name$1 = "@copart/ops-tool-kit";
-const version$3 = "1.13.0-beta.11";
+const version$3 = "1.13.0-beta.12";
 const main$1 = "dist/ops-tool-kit.js";
 const style = "dist/ops-tool-kit.css";
 const files = [
   "dist",
-  "bin"
+  "bin",
+  "iframe-webpack-facade.js"
 ];
 const bin = {
   "generate-build-meta": "./bin/cli.js"
@@ -106,7 +108,8 @@ const devDependencies$1 = {
 };
 const peerDependencies = {
   "@copart/core-components": "2.3.0-alpha.filters.6",
-  react: "*"
+  react: "*",
+  "react-router-dom": "^5.0.0"
 };
 const dependencies$1 = {
   "@reacting/purist": "0.1.0",
@@ -69561,6 +69564,419 @@ var iframeFacade = {
   }
 };
 
+function normalizeIframePath(uri) {
+  if (uri === '' || uri == null) return '/';
+  return uri.startsWith('/') ? uri : "/".concat(uri);
+}
+
+function serializeNavItems(items) {
+  if (!Array.isArray(items)) return [];
+  return items.map(function (item) {
+    var serialized = {
+      name: item.name,
+      route: item.route
+    };
+    if (item.icon && typeof item.icon === 'string') serialized.icon = item.icon;
+    if (typeof item.disabled === 'function') {
+      try {
+        serialized.disabled = item.disabled();
+      } catch (_) {
+        serialized.disabled = false;
+      }
+    } else if (typeof item.disabled === 'boolean') {
+      serialized.disabled = item.disabled;
+    }
+    if (typeof item.hidden === 'function') {
+      try {
+        serialized.hidden = item.hidden();
+      } catch (_) {
+        serialized.hidden = false;
+      }
+    } else if (typeof item.hidden === 'boolean') {
+      serialized.hidden = item.hidden;
+    }
+    if (item.isLandingPage) serialized.isLandingPage = true;
+    if (item.subMenuItems && item.subMenuItems.length > 0) {
+      serialized.subMenuItems = serializeNavItems(item.subMenuItems);
+    }
+    return serialized;
+  });
+}
+
+function IframeRouteSync(_ref) {
+  var _ref$updateUriIsPath = _ref.updateUriIsPath,
+    updateUriIsPath = _ref$updateUriIsPath === void 0 ? false : _ref$updateUriIsPath,
+    _ref$suppressEcho = _ref.suppressEcho,
+    suppressEcho = _ref$suppressEcho === void 0 ? true : _ref$suppressEcho;
+  var history = reactRouterDom.useHistory();
+  var location = reactRouterDom.useLocation();
+  var initialRef = React.useRef(true);
+  var suppressUpdateUriRef = React.useRef(false);
+  React.useEffect(function () {
+    var remove = addMessageListener(function (data) {
+      if (data.eventType === 'LOAD_URI' && data.eventProps) {
+        var path = normalizeIframePath(data.eventProps.uri);
+        if (suppressEcho) suppressUpdateUriRef.current = true;
+        history.push(path);
+      }
+    });
+    return remove;
+  }, [history, suppressEcho]);
+  React.useEffect(function () {
+    if (initialRef.current) {
+      initialRef.current = false;
+      return;
+    }
+    if (suppressEcho && suppressUpdateUriRef.current) {
+      suppressUpdateUriRef.current = false;
+      return;
+    }
+    var pathname = location.pathname || '/';
+    postUpdateUri(pathname, updateUriIsPath);
+  }, [location.pathname, updateUriIsPath, suppressEcho]);
+  return null;
+}
+
+function defaultToolkitEnv() {
+  return {
+    STACK: process.env.STACK,
+    APP_NAME: process.env.APP_NAME,
+    CORE_CONFIG_URI: process.env.CORE_CONFIG_URI,
+    CONFIG_URI: process.env.CONFIG_URI
+  };
+}
+function AppEnvSender(_ref) {
+  var toolkitEnv = _ref.toolkitEnv,
+    _ref$mihelpAgentProps = _ref.mihelpAgentProps,
+    mihelpAgentProps = _ref$mihelpAgentProps === void 0 ? null : _ref$mihelpAgentProps;
+  var sentRef = React.useRef(false);
+  React.useEffect(function () {
+    if (sentRef.current) return;
+    sentRef.current = true;
+    postAppEnv(toolkitEnv || defaultToolkitEnv(), mihelpAgentProps);
+  }, [toolkitEnv, mihelpAgentProps]);
+  return null;
+}
+
+function NavConfigSender(_ref) {
+  var navItemsLoader = _ref.navItemsLoader,
+    onError = _ref.onError;
+  var sentRef = React.useRef(false);
+  React.useEffect(function () {
+    if (sentRef.current || !navItemsLoader) return;
+    sentRef.current = true;
+    navItemsLoader().then(function (mod) {
+      var items = mod && (mod.default != null ? mod.default : mod);
+      postNavConfig(serializeNavItems(items));
+    }).catch(function (err) {
+      if (onError) {
+        onError(err);
+      } else {
+        console.warn('[Iframe] Failed to load navItems:', err);
+      }
+    });
+  }, [navItemsLoader, onError]);
+  return null;
+}
+
+var defaultContentStyle = {
+  height: '100%',
+  display: 'flex',
+  flexDirection: 'column',
+  overflow: 'hidden'
+};
+function IframeAppRootInner(_ref) {
+  var children = _ref.children,
+    contentStyle = _ref.contentStyle,
+    toolkitEnv = _ref.toolkitEnv,
+    mihelpAgentProps = _ref.mihelpAgentProps,
+    navItemsLoader = _ref.navItemsLoader,
+    navConfigOnError = _ref.navConfigOnError,
+    updateUriIsPath = _ref.updateUriIsPath,
+    suppressRouteSyncEcho = _ref.suppressRouteSyncEcho;
+  var history = reactRouterDom.useHistory();
+  return /*#__PURE__*/React__default["default"].createElement(CrumbProvider, {
+    navigate: function navigate(path) {
+      return history.push(path);
+    }
+  }, /*#__PURE__*/React__default["default"].createElement(AppEnvSender, {
+    toolkitEnv: toolkitEnv,
+    mihelpAgentProps: mihelpAgentProps
+  }), /*#__PURE__*/React__default["default"].createElement(IframeRouteSync, {
+    updateUriIsPath: updateUriIsPath,
+    suppressEcho: suppressRouteSyncEcho
+  }), navItemsLoader ? /*#__PURE__*/React__default["default"].createElement(NavConfigSender, {
+    navItemsLoader: navItemsLoader,
+    onError: navConfigOnError
+  }) : null, /*#__PURE__*/React__default["default"].createElement("div", {
+    style: contentStyle || defaultContentStyle
+  }, children));
+}
+function IframeAppRoot(_ref2) {
+  var _ref2$initialUri = _ref2.initialUri,
+    initialUri = _ref2$initialUri === void 0 ? '/' : _ref2$initialUri,
+    children = _ref2.children,
+    contentStyle = _ref2.contentStyle,
+    toolkitEnv = _ref2.toolkitEnv,
+    _ref2$mihelpAgentProp = _ref2.mihelpAgentProps,
+    mihelpAgentProps = _ref2$mihelpAgentProp === void 0 ? null : _ref2$mihelpAgentProp,
+    navItemsLoader = _ref2.navItemsLoader,
+    navConfigOnError = _ref2.navConfigOnError,
+    _ref2$updateUriIsPath = _ref2.updateUriIsPath,
+    updateUriIsPath = _ref2$updateUriIsPath === void 0 ? false : _ref2$updateUriIsPath,
+    _ref2$suppressRouteSy = _ref2.suppressRouteSyncEcho,
+    suppressRouteSyncEcho = _ref2$suppressRouteSy === void 0 ? true : _ref2$suppressRouteSy;
+  var initialPath = normalizeIframePath(initialUri);
+  return /*#__PURE__*/React__default["default"].createElement(reactRouterDom.MemoryRouter, {
+    initialEntries: [initialPath],
+    initialIndex: 0
+  }, /*#__PURE__*/React__default["default"].createElement(IframeAppRootInner, {
+    contentStyle: contentStyle,
+    toolkitEnv: toolkitEnv,
+    mihelpAgentProps: mihelpAgentProps,
+    navItemsLoader: navItemsLoader,
+    navConfigOnError: navConfigOnError,
+    updateUriIsPath: updateUriIsPath,
+    suppressRouteSyncEcho: suppressRouteSyncEcho
+  }, children));
+}
+
+/**
+ * Register a synchronous LOAD_URI listener before async bootstrap loads.
+ * Call this from the app entry (index.js) before dynamic-importing bootstrap.
+ */
+function registerEarlyLoadUriListener() {
+  if (typeof window === 'undefined') return;
+  if (window.__IFRAME_EARLY_LOAD_URI_LISTENER_REGISTERED) return;
+  window.__IFRAME_EARLY_LOAD_URI_LISTENER_REGISTERED = true;
+  window.__IFRAME_EARLY_LOAD_URI = null;
+  window.addEventListener('message', function (event) {
+    if (event.data && event.data.eventType === 'LOAD_URI' && event.data.eventProps) {
+      window.__IFRAME_EARLY_LOAD_URI = event.data.eventProps.uri || '/';
+    }
+  });
+}
+
+function resolveRootNode(rootSelector) {
+  var selectors = rootSelector ? [rootSelector] : ['#root', '#app'];
+  for (var i = 0; i < selectors.length; i += 1) {
+    var node = document.querySelector(selectors[i]);
+    if (node) return node;
+  }
+  return null;
+}
+function isInIframe() {
+  return typeof window !== 'undefined' && window.self !== window.top;
+}
+function renderStandaloneError(rootNode, message) {
+  rootNode.innerHTML = "<h1>".concat(message, "</h1>");
+}
+function normalizePermissionKeys(permissionKeys) {
+  if (!permissionKeys) return [];
+  return Array.isArray(permissionKeys) ? permissionKeys : [permissionKeys];
+}
+function isValidAppConfig(config, validateAppConfig) {
+  if (validateAppConfig) return validateAppConfig(config);
+  return !!config;
+}
+function hydrateAppConfig(_x) {
+  return _hydrateAppConfig.apply(this, arguments);
+}
+function _hydrateAppConfig() {
+  _hydrateAppConfig = _asyncToGenerator$1(/*#__PURE__*/_regenerator().m(function _callee(_ref) {
+    var appName, sendStorageGet, setExtraLocal, fetcher, configFallbackUri, validateAppConfig, appConfig;
+    return _regenerator().w(function (_context) {
+      while (1) switch (_context.n) {
+        case 0:
+          appName = _ref.appName, sendStorageGet = _ref.sendStorageGet, setExtraLocal = _ref.setExtraLocal, fetcher = _ref.fetcher, configFallbackUri = _ref.configFallbackUri, validateAppConfig = _ref.validateAppConfig;
+          _context.n = 1;
+          return sendStorageGet({
+            op: 'getLocalItem',
+            key: "".concat(appName, ":config")
+          });
+        case 1:
+          appConfig = _context.v;
+          if (!(!isValidAppConfig(appConfig, validateAppConfig) && configFallbackUri && fetcher)) {
+            _context.n = 3;
+            break;
+          }
+          _context.n = 2;
+          return fetcher.getConfig(configFallbackUri);
+        case 2:
+          appConfig = _context.v;
+        case 3:
+          if (isValidAppConfig(appConfig, validateAppConfig)) {
+            setExtraLocal("".concat(appName, ":config"), appConfig);
+          }
+        case 4:
+          return _context.a(2);
+      }
+    }, _callee);
+  }));
+  return _hydrateAppConfig.apply(this, arguments);
+}
+function hydratePermissions(_x2) {
+  return _hydratePermissions.apply(this, arguments);
+}
+/**
+ * Bootstrap an iframe-embedded portal app: init bridge data from shell, then render.
+ *
+ * @param {object} options
+ * @param {string} [options.appName] - Defaults to process.env.APP_NAME
+ * @param {string|string[]} [options.permissionKeys] - Shell localStorage permission key(s)
+ * @param {string} [options.rootSelector] - Root element selector (default: #root then #app)
+ * @param {(initData: *) => void} [options.onInitCache] - Called after setInitCache (e.g. initStoreData)
+ * @param {(initialUri: string, rootNode: HTMLElement) => void} options.render - App render callback
+ * @param {'render'|'error'|'skip'} [options.standaloneMode='render'] - Behavior when not in iframe
+ * @param {(rootNode: HTMLElement) => void} [options.standaloneRender] - Custom standalone UI
+ * @param {string} [options.standaloneErrorMessage] - Message when standaloneMode is 'error'
+ * @param {boolean} [options.fetchConfigFromShell=true] - Fetch app config/permissions from shell
+ * @param {string} [options.configFallbackUri] - Defaults to process.env.CONFIG_URI
+ * @param {(config: *) => boolean} [options.validateAppConfig] - Config validity check before setExtraLocal
+ * @param {boolean} [options.permissionsOnlyIfArray=true] - Only set permissions when shell returns an array
+ */
+function _hydratePermissions() {
+  _hydratePermissions = _asyncToGenerator$1(/*#__PURE__*/_regenerator().m(function _callee3(_ref2) {
+    var permissionKeys, sendStorageGet, setExtraLocal, permissionsOnlyIfArray, keys;
+    return _regenerator().w(function (_context3) {
+      while (1) switch (_context3.n) {
+        case 0:
+          permissionKeys = _ref2.permissionKeys, sendStorageGet = _ref2.sendStorageGet, setExtraLocal = _ref2.setExtraLocal, permissionsOnlyIfArray = _ref2.permissionsOnlyIfArray;
+          keys = normalizePermissionKeys(permissionKeys);
+          _context3.n = 1;
+          return Promise.all(keys.map(/*#__PURE__*/function () {
+            var _ref3 = _asyncToGenerator$1(/*#__PURE__*/_regenerator().m(function _callee2(key) {
+              var perms;
+              return _regenerator().w(function (_context2) {
+                while (1) switch (_context2.n) {
+                  case 0:
+                    _context2.n = 1;
+                    return sendStorageGet({
+                      op: 'getLocalItem',
+                      key: key
+                    });
+                  case 1:
+                    perms = _context2.v;
+                    if (!(permissionsOnlyIfArray && !Array.isArray(perms))) {
+                      _context2.n = 2;
+                      break;
+                    }
+                    return _context2.a(2);
+                  case 2:
+                    if (perms != null) setExtraLocal(key, perms);
+                  case 3:
+                    return _context2.a(2);
+                }
+              }, _callee2);
+            }));
+            return function (_x4) {
+              return _ref3.apply(this, arguments);
+            };
+          }()));
+        case 1:
+          return _context3.a(2);
+      }
+    }, _callee3);
+  }));
+  return _hydratePermissions.apply(this, arguments);
+}
+function bootstrapIframeApp(_x3) {
+  return _bootstrapIframeApp.apply(this, arguments);
+}
+function _bootstrapIframeApp() {
+  _bootstrapIframeApp = _asyncToGenerator$1(/*#__PURE__*/_regenerator().m(function _callee4(options) {
+    var _ref4, _ref4$appName, appName, permissionKeys, rootSelector, onInitCache, render, _ref4$standaloneMode, standaloneMode, standaloneRender, _ref4$standaloneError, standaloneErrorMessage, _ref4$fetchConfigFrom, fetchConfigFromShell, _ref4$configFallbackU, configFallbackUri, validateAppConfig, _ref4$permissionsOnly, permissionsOnlyIfArray, rootNode, bridge, fetcher, getInitialUri, getInitData, setInitCache, setExtraLocal, sendStorageGet, setAppName, _yield$Promise$all, _yield$Promise$all2, initialUri, initData, tasks, _t;
+    return _regenerator().w(function (_context4) {
+      while (1) switch (_context4.p = _context4.n) {
+        case 0:
+          _ref4 = options || {}, _ref4$appName = _ref4.appName, appName = _ref4$appName === void 0 ? process.env.APP_NAME : _ref4$appName, permissionKeys = _ref4.permissionKeys, rootSelector = _ref4.rootSelector, onInitCache = _ref4.onInitCache, render = _ref4.render, _ref4$standaloneMode = _ref4.standaloneMode, standaloneMode = _ref4$standaloneMode === void 0 ? 'render' : _ref4$standaloneMode, standaloneRender = _ref4.standaloneRender, _ref4$standaloneError = _ref4.standaloneErrorMessage, standaloneErrorMessage = _ref4$standaloneError === void 0 ? 'This application must be opened from the parent portal.' : _ref4$standaloneError, _ref4$fetchConfigFrom = _ref4.fetchConfigFromShell, fetchConfigFromShell = _ref4$fetchConfigFrom === void 0 ? true : _ref4$fetchConfigFrom, _ref4$configFallbackU = _ref4.configFallbackUri, configFallbackUri = _ref4$configFallbackU === void 0 ? process.env.CONFIG_URI : _ref4$configFallbackU, validateAppConfig = _ref4.validateAppConfig, _ref4$permissionsOnly = _ref4.permissionsOnlyIfArray, permissionsOnlyIfArray = _ref4$permissionsOnly === void 0 ? true : _ref4$permissionsOnly;
+          if (!(typeof render !== 'function')) {
+            _context4.n = 1;
+            break;
+          }
+          throw new Error('bootstrapIframeApp requires a render(initialUri, rootNode) function');
+        case 1:
+          rootNode = resolveRootNode(rootSelector);
+          if (rootNode) {
+            _context4.n = 2;
+            break;
+          }
+          console.error('[Iframe] No root element found');
+          return _context4.a(2);
+        case 2:
+          if (isInIframe()) {
+            _context4.n = 4;
+            break;
+          }
+          if (!(standaloneMode === 'error')) {
+            _context4.n = 3;
+            break;
+          }
+          if (standaloneRender) standaloneRender(rootNode);else renderStandaloneError(rootNode, standaloneErrorMessage);
+          return _context4.a(2);
+        case 3:
+          if (!(standaloneMode === 'skip')) {
+            _context4.n = 4;
+            break;
+          }
+          return _context4.a(2);
+        case 4:
+          bridge = iframeFacade.bridge, fetcher = iframeFacade.fetcher;
+          getInitialUri = bridge.getInitialUri, getInitData = bridge.getInitData, setInitCache = bridge.setInitCache, setExtraLocal = bridge.setExtraLocal, sendStorageGet = bridge.sendStorageGet, setAppName = bridge.setAppName;
+          _context4.n = 5;
+          return Promise.all([getInitialUri(), getInitData()]);
+        case 5:
+          _yield$Promise$all = _context4.v;
+          _yield$Promise$all2 = _slicedToArray(_yield$Promise$all, 2);
+          initialUri = _yield$Promise$all2[0];
+          initData = _yield$Promise$all2[1];
+          if (appName && typeof setAppName === 'function') setAppName(appName);
+          if (!initData) {
+            _context4.n = 9;
+            break;
+          }
+          setInitCache(initData);
+          if (onInitCache) onInitCache(initData);
+          if (!(fetchConfigFromShell && appName)) {
+            _context4.n = 9;
+            break;
+          }
+          _context4.p = 6;
+          tasks = [hydrateAppConfig({
+            appName: appName,
+            sendStorageGet: sendStorageGet,
+            setExtraLocal: setExtraLocal,
+            fetcher: fetcher,
+            configFallbackUri: configFallbackUri,
+            validateAppConfig: validateAppConfig
+          })];
+          if (permissionKeys) {
+            tasks.push(hydratePermissions({
+              permissionKeys: permissionKeys,
+              sendStorageGet: sendStorageGet,
+              setExtraLocal: setExtraLocal,
+              permissionsOnlyIfArray: permissionsOnlyIfArray
+            }));
+          }
+          _context4.n = 7;
+          return Promise.all(tasks);
+        case 7:
+          _context4.n = 9;
+          break;
+        case 8:
+          _context4.p = 8;
+          _t = _context4.v;
+          console.warn('[Iframe] failed to fetch app config/permissions from shell:', _t);
+        case 9:
+          render(initialUri, rootNode);
+        case 10:
+          return _context4.a(2);
+      }
+    }, _callee4, null, [[6, 8]]);
+  }));
+  return _bootstrapIframeApp.apply(this, arguments);
+}
+
 setup({
   pkg: pkg
 });
@@ -81139,13 +81555,21 @@ var index_es = /*#__PURE__*/Object.freeze({
   vectorsRatio: vectorsRatio
 });
 
+exports.AppEnvSender = AppEnvSender;
 exports.AppFrame = AppFrame;
 exports.AutoRefresh = AutoRefresh;
 exports.CallLogger = CallLogger;
 exports.ContextualHelp = ContextualHelp;
 exports.Crumb = Crumb$1;
+exports.IframeAppRoot = IframeAppRoot;
+exports.IframeRouteSync = IframeRouteSync;
+exports.NavConfigSender = NavConfigSender;
 exports.accessHelpers = accessHelpers$1;
+exports.bootstrapIframeApp = bootstrapIframeApp;
 exports.fetcher = fetcher$1;
 exports.iframeFacade = iframeFacade;
+exports.normalizeIframePath = normalizeIframePath;
+exports.registerEarlyLoadUriListener = registerEarlyLoadUriListener;
+exports.serializeNavItems = serializeNavItems;
 exports.storage = storage$2;
 //# sourceMappingURL=ops-tool-kit.js.map