@next-core/brick-kit 2.130.0 → 2.131.0

package/dist/index.esm.js

@@ -4,7 +4,7 @@ import _objectWithoutProperties from '@babel/runtime/helpers/objectWithoutProper
 import _asyncToGenerator$3 from '@babel/runtime/helpers/asyncToGenerator';
 import _defineProperty$1 from '@babel/runtime/helpers/defineProperty';
 import React, { useState, useEffect, useRef, forwardRef, useImperativeHandle, useMemo, useContext, createContext, useReducer, useCallback } from 'react';
-import { JsonStorage, toPath, computeRealRoutePath, hasOwnProperty, isObject, isEvaluable, transformAndInject, transform, trackContext, trackState, scanPermissionActionsInStoryboard, precookFunction, cook, resolveContextConcurrently, syncResolveContextConcurrently, shouldAllowRecursiveEvaluations, preevaluate, inject, deepFreeze, createProviderClass, getTemplateDepsOfStoryboard, getDllAndDepsOfStoryboard, asyncProcessStoryboard, getDllAndDepsByResource, scanRouteAliasInStoryboard, prefetchScript, scanBricksInBrickConf, scanProcessorsInAny, loadScript, matchPath, scanAppGetMenuInAny, asyncProcessBrick, scanInstalledAppsInStoryboard, restoreDynamicTemplates, scanStoryboard, mapCustomApisToNameAndNamespace } from '@next-core/brick-utils';
+import { JsonStorage, toPath, computeRealRoutePath, hasOwnProperty, isObject, isEvaluable, transformAndInject, transform, trackContext, trackState, scanPermissionActionsInStoryboard, precookFunction, cook, resolveContextConcurrently, syncResolveContextConcurrently, trackUsedState, trackUsedContext, shouldAllowRecursiveEvaluations, preevaluate, inject, deepFreeze, createProviderClass, getTemplateDepsOfStoryboard, getDllAndDepsOfStoryboard, asyncProcessStoryboard, getDllAndDepsByResource, scanRouteAliasInStoryboard, prefetchScript, scanBricksInBrickConf, scanProcessorsInAny, loadScript, matchPath, scanAppGetMenuInAny, asyncProcessBrick, scanInstalledAppsInStoryboard, restoreDynamicTemplates, scanStoryboard, mapCustomApisToNameAndNamespace } from '@next-core/brick-utils';
 import _, { set, get, difference, identity, uniqueId, cloneDeep, clamp, isNil, isEmpty, sortBy, merge, isObject as isObject$1, pick, orderBy, omit, findLastIndex, noop, isString } from 'lodash';
 import { http, HttpResponseError, HttpFetchError } from '@next-core/brick-http';
 import moment from 'moment';
@@ -2041,7 +2041,7 @@ class StoryboardContextWrapper {
   }
 
   updateValue(name, value, method) {
-    var _item$eventTarget;
+    var _item$eventTarget2;
 
     if (!this.data.has(name)) {
       if (this.tplContextId) {
@@ -2065,6 +2065,22 @@ class StoryboardContextWrapper {
       return;
     }
 
+    if (method === "refresh") {
+      if (!item.refresh) {
+        throw new Error("You can not refresh the storyboard context \"".concat(name, "\" which has no resolve."));
+      }
+
+      item.refresh().then(val => {
+        var _item$eventTarget;
+
+        item.value = val;
+        (_item$eventTarget = item.eventTarget) === null || _item$eventTarget === void 0 ? void 0 : _item$eventTarget.dispatchEvent(new CustomEvent(this.tplContextId ? "state.change" : "context.change", {
+          detail: item.value
+        }));
+      }, handleHttpError);
+      return;
+    }
+
     if (method === "replace") {
       item.value = value;
     } else {
@@ -2077,7 +2093,7 @@ class StoryboardContextWrapper {
       }
     }
 
-    (_item$eventTarget = item.eventTarget) === null || _item$eventTarget === void 0 ? void 0 : _item$eventTarget.dispatchEvent(new CustomEvent(this.tplContextId ? "state.change" : "context.change", {
+    (_item$eventTarget2 = item.eventTarget) === null || _item$eventTarget2 === void 0 ? void 0 : _item$eventTarget2.dispatchEvent(new CustomEvent(this.tplContextId ? "state.change" : "context.change", {
       detail: item.value
     }));
   }
@@ -2158,30 +2174,65 @@ function _resolveNormalStoryboardContext() {
       return false;
     }
 
-    var isResolve = false;
-    var value = getDefinedTemplateState(!!storyboardContextWrapper.tplContextId, contextConf, brick);
+    var isTemplateState = !!storyboardContextWrapper.tplContextId;
+    var value = getDefinedTemplateState(isTemplateState, contextConf, brick);
+    var refresh = null;
+    var isLazyResolve = false;
 
     if (value === undefined) {
       if (contextConf.resolve) {
         if (looseCheckIf(contextConf.resolve, mergedContext)) {
-          isResolve = true;
-          var valueConf = {};
-          yield _internalApiGetResolver().resolveOne("reference", _objectSpread({
-            transform: "value",
-            transformMapArray: false
-          }, contextConf.resolve), valueConf, null, mergedContext);
-          value = valueConf.value;
+          refresh = /*#__PURE__*/function () {
+            var _ref = _asyncToGenerator$3(function* () {
+              var valueConf = {};
+              yield _internalApiGetResolver().resolveOne("reference", _objectSpread({
+                transform: "value",
+                transformMapArray: false
+              }, contextConf.resolve), valueConf, null, mergedContext);
+              return valueConf.value;
+            });
+
+            return function refresh() {
+              return _ref.apply(this, arguments);
+            };
+          }();
+
+          isLazyResolve = contextConf.resolve.lazy;
+
+          if (!isLazyResolve) {
+            value = yield refresh();
+          }
         } else if (!hasOwnProperty(contextConf, "value")) {
           return false;
         }
       }
 
-      if (!isResolve && contextConf.value !== undefined) {
+      if ((!refresh || isLazyResolve) && contextConf.value !== undefined) {
+        // If the context has no resolve, just use its `value`.
+        // Or if the resolve is ignored or lazy, use its `value` as a fallback.
         value = computeRealValue(contextConf.value, mergedContext, true);
       }
+
+      if (contextConf.track) {
+        // Track its dependencies and auto update when each of them changed.
+        var deps = (isTemplateState ? trackUsedState : trackUsedContext)(refresh ? contextConf.resolve : contextConf.value);
+
+        for (var dep of deps) {
+          var _eventTarget;
+
+          var ctx = storyboardContextWrapper.get().get(dep);
+          ctx === null || ctx === void 0 ? void 0 : (_eventTarget = ctx.eventTarget) === null || _eventTarget === void 0 ? void 0 : _eventTarget.addEventListener(isTemplateState ? "state.change" : "context.change", () => {
+            if (refresh) {
+              storyboardContextWrapper.updateValue(contextConf.name, undefined, "refresh");
+            } else {
+              storyboardContextWrapper.updateValue(contextConf.name, computeRealValue(contextConf.value, mergedContext, true), "replace");
+            }
+          });
+        }
+      }
     }
 
-    resolveFreeVariableValue(value, contextConf, mergedContext, storyboardContextWrapper, brick);
+    resolveFreeVariableValue(value, contextConf, mergedContext, storyboardContextWrapper, brick, refresh);
     return true;
   });
   return _resolveNormalStoryboardContext.apply(this, arguments);
@@ -2212,12 +2263,13 @@ function getDefinedTemplateState(isTemplateState, contextConf, brick) {
   }
 }
 
-function resolveFreeVariableValue(value, contextConf, mergedContext, storyboardContextWrapper, brick) {
+function resolveFreeVariableValue(value, contextConf, mergedContext, storyboardContextWrapper, brick, refresh) {
   var newContext = {
     type: "free-variable",
     value,
     // This is required for tracking context, even if no `onChange` is specified.
-    eventTarget: new EventTarget$1()
+    eventTarget: new EventTarget$1(),
+    refresh
   };
 
   if (contextConf.onChange) {
@@ -6288,10 +6340,12 @@ function listenerFactory(handler, context, runtimeBrick) {
 
       case "context.assign":
       case "context.replace":
+      case "context.refresh":
         return builtinContextListenerFactory(method, handler.args, handler, context);
 
       case "state.update":
-        return builtinStateListenerFactory(handler.args, handler, context);
+      case "state.refresh":
+        return builtinStateListenerFactory(method, handler.args, handler, context);
 
       case "tpl.dispatchEvent":
         return builtinTplDispatchEventFactory(handler.args, handler, context);
@@ -6435,7 +6489,7 @@ function builtinContextListenerFactory(method, args, ifContainer, context) {
   };
 }
 
-function builtinStateListenerFactory(args, ifContainer, context) {
+function builtinStateListenerFactory(method, args, ifContainer, context) {
   return function (event) {
     if (!looseCheckIf(ifContainer, _objectSpread(_objectSpread({}, context), {}, {
       event
@@ -6445,7 +6499,7 @@ function builtinStateListenerFactory(args, ifContainer, context) {
 
     var tplContext = getTplContext(context.tplContextId);
     var [name, value] = argsFactory(args, context, event);
-    tplContext.state.updateValue(name, value, "replace");
+    tplContext.state.updateValue(name, value, method === "refresh" ? method : "replace");
   };
 }
 
@@ -10802,7 +10856,7 @@ class LocationContext {
       if (expandedBrickConf.exports) {
         for (var [prop, ctxName] of Object.entries(expandedBrickConf.exports)) {
           if (typeof ctxName === "string" && ctxName.startsWith("CTX.")) {
-            _this6.storyboardContextWrapper.set(ctxName.substr(4), {
+            _this6.storyboardContextWrapper.set(ctxName.substring(4), {
               type: "brick-property",
               brick,
               prop
@@ -11381,19 +11435,33 @@ class Resolver {
         }
       }
 
-      var cacheKey = JSON.stringify({
-        provider,
-        useProvider,
-        method,
-        args
-      });
+      var actualArgs = args ? ref ? args // `args` are already computed for `defineResolves`
+      : context ? computeRealValue(args, context, true) : args : providerBrick.args || [];
+      var cacheKey;
+
+      try {
+        // `actualArgs` may contain circular references, which makes
+        // JSON stringify failed, thus we fallback to original args.
+        cacheKey = JSON.stringify({
+          provider,
+          useProvider,
+          method,
+          actualArgs
+        });
+      } catch (e) {
+        cacheKey = JSON.stringify({
+          provider,
+          useProvider,
+          method,
+          args
+        });
+      }
+
       var promise;
 
       if (_this2.cache.has(cacheKey)) {
         promise = _this2.cache.get(cacheKey);
       } else {
-        var actualArgs = args ? ref ? args // `args` are already computed for `defineResolves`
-        : context ? computeRealValue(args, context, true) : args : providerBrick.args || [];
         promise = _asyncToGenerator$3(function* () {
           if (useProvider) {
             actualArgs = yield getArgsOfCustomApi(useProvider, actualArgs);