@next-core/brick-kit 2.130.0 → 2.131.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.131.0](https://github.com/easyops-cn/next-core/compare/@next-core/brick-kit@2.130.0...@next-core/brick-kit@2.131.0) (2022-08-25)
+
+
+### Features
+
+* context can track its deps now ([4993308](https://github.com/easyops-cn/next-core/commit/49933089e1ff6ec1ec5f01eeac5609dde07c1e2e))
+* support lazy context ([39fdffb](https://github.com/easyops-cn/next-core/commit/39fdffb0500df36d5bb9447d63a448bd2b78df14))
+
+
+
+
+
 # [2.130.0](https://github.com/easyops-cn/next-core/compare/@next-core/brick-kit@2.129.3...@next-core/brick-kit@2.130.0) (2022-08-23)
 
 

package/dist/index.bundle.js

@@ -2040,7 +2040,7 @@
     }
 
     updateValue(name, value, method) {
-      var _item$eventTarget;
+      var _item$eventTarget2;
 
       if (!this.data.has(name)) {
         if (this.tplContextId) {
@@ -2064,6 +2064,22 @@
         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 {
@@ -2076,7 +2092,7 @@
         }
       }
 
-      (_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
       }));
     }
@@ -2157,30 +2173,65 @@
         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__default["default"]({
-              transform: "value",
-              transformMapArray: false
-            }, contextConf.resolve), valueConf, null, mergedContext);
-            value = valueConf.value;
+            refresh = /*#__PURE__*/function () {
+              var _ref = _asyncToGenerator__default["default"](function* () {
+                var valueConf = {};
+                yield _internalApiGetResolver().resolveOne("reference", _objectSpread__default["default"]({
+                  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 (!brickUtils.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 ? brickUtils.trackUsedState : brickUtils.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);
@@ -2211,12 +2262,13 @@
     }
   }
 
-  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) {
@@ -6287,10 +6339,12 @@
 
         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);
@@ -6434,7 +6488,7 @@
     };
   }
 
-  function builtinStateListenerFactory(args, ifContainer, context) {
+  function builtinStateListenerFactory(method, args, ifContainer, context) {
     return function (event) {
       if (!looseCheckIf(ifContainer, _objectSpread__default["default"](_objectSpread__default["default"]({}, context), {}, {
         event
@@ -6444,7 +6498,7 @@
 
       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");
     };
   }
 
@@ -10801,7 +10855,7 @@
         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
@@ -11380,19 +11434,33 @@
           }
         }
 
-        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__default["default"](function* () {
             if (useProvider) {
               actualArgs = yield getArgsOfCustomApi(useProvider, actualArgs);