@next-core/brick-kit 2.134.2 → 2.136.0

package/CHANGELOG.md

@@ -3,6 +3,42 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.136.0](https://github.com/easyops-cn/next-core/compare/@next-core/brick-kit@2.135.1...@next-core/brick-kit@2.136.0) (2022-09-05)
+
+
+### Features
+
+* support context/state load/refresh callback ([4dfdd8b](https://github.com/easyops-cn/next-core/commit/4dfdd8bc8e91430a99857154237bae290c685329))
+
+
+
+
+
+## [2.135.1](https://github.com/easyops-cn/next-core/compare/@next-core/brick-kit@2.135.0...@next-core/brick-kit@2.135.1) (2022-09-02)
+
+**Note:** Version bump only for package @next-core/brick-kit
+
+
+
+
+
+# [2.135.0](https://github.com/easyops-cn/next-core/compare/@next-core/brick-kit@2.134.2...@next-core/brick-kit@2.135.0) (2022-09-02)
+
+
+### Bug Fixes
+
+* ignore cache when refresh context ([a7d5f86](https://github.com/easyops-cn/next-core/commit/a7d5f864475ebff6f6e7ebd1abbf09afb6a77473))
+
+
+### Features
+
+* support context.load ([bf09ab1](https://github.com/easyops-cn/next-core/commit/bf09ab1aa650a4cd80b83650ad8c2173d8941d14))
+* support context.load ([7056edd](https://github.com/easyops-cn/next-core/commit/7056eddb088e4fa3fd6aadafd8e027eaddcd63db))
+
+
+
+
+
 ## [2.134.2](https://github.com/easyops-cn/next-core/compare/@next-core/brick-kit@2.134.1...@next-core/brick-kit@2.134.2) (2022-09-01)
 
 **Note:** Version bump only for package @next-core/brick-kit

package/dist/index.bundle.js

@@ -1971,7 +1971,7 @@
       return (_this$data$get = this.data.get(name)) === null || _this$data$get === void 0 ? void 0 : _this$data$get.value;
     }
 
-    updateValue(name, value, method) {
+    updateValue(name, value, method, callback) {
       var _item$eventTarget2;
 
       if (!this.data.has(name)) {
@@ -1992,23 +1992,60 @@
 
       if (item.type !== "free-variable") {
         // eslint-disable-next-line no-console
-        console.error("Conflict storyboard context \"".concat(name, "\", expected \"free-variable\", received \"").concat(item.type, "\"."));
+        console.error("Unexpected storyboard context \"".concat(name, "\", expected \"free-variable\", received \"").concat(item.type, "\"."));
         return;
       }
 
-      if (method === "refresh") {
-        if (!item.refresh) {
-          throw new Error("You can not refresh the storyboard context \"".concat(name, "\" which has no resolve."));
+      if (method === "refresh" || method === "load") {
+        if (!item.load) {
+          throw new Error("You can not ".concat(method, " the storyboard context \"").concat(name, "\" which has no resolve."));
         }
 
-        item.refresh().then(val => {
-          var _item$eventTarget;
+        var promise;
+
+        if (method === "load") {
+          // Try to reuse previous request when calling `load`.
+          if (item.loaded) {
+            promise = Promise.resolve(item.value);
+          } else if (item.loading) {
+            promise = item.loading;
+          }
+        }
+
+        if (!promise) {
+          promise = item.loading = item.load(_objectSpread__default["default"]({
+            cache: method === "load" ? "default" : "reload"
+          }, value)); // Do not use the chained promise, since the callbacks need the original promise.
+
+          promise.then(val => {
+            var _item$eventTarget;
+
+            item.loaded = true;
+            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
+            }));
+          }, err => {
+            // Let users to override error handling.
+            if (!(callback !== null && callback !== void 0 && callback.error)) {
+              handleHttpError(err);
+            }
+          });
+        }
+
+        if (callback) {
+          var callbackFactory = eventCallbackFactory(callback, () => this.getResolveOptions(_internalApiGetCurrentContext()).mergedContext);
+          promise.then(val => {
+            callbackFactory("success")({
+              value: val
+            });
+            callbackFactory("finally")();
+          }, err => {
+            callbackFactory("error")(err);
+            callbackFactory("finally")();
+          });
+        }
 
-          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;
       }
 
@@ -2107,23 +2144,23 @@
 
       var isTemplateState = !!storyboardContextWrapper.tplContextId;
       var value = getDefinedTemplateState(isTemplateState, contextConf, brick);
-      var refresh = null;
+      var load = null;
       var isLazyResolve = false;
 
       if (value === undefined) {
         if (contextConf.resolve) {
           if (looseCheckIf(contextConf.resolve, mergedContext)) {
-            refresh = /*#__PURE__*/function () {
-              var _ref = _asyncToGenerator__default["default"](function* () {
+            load = /*#__PURE__*/function () {
+              var _ref = _asyncToGenerator__default["default"](function* (options) {
                 var valueConf = {};
                 yield _internalApiGetResolver().resolveOne("reference", _objectSpread__default["default"]({
                   transform: "value",
                   transformMapArray: false
-                }, contextConf.resolve), valueConf, null, mergedContext);
+                }, contextConf.resolve), valueConf, null, mergedContext, options);
                 return valueConf.value;
               });
 
-              return function refresh() {
+              return function load(_x9) {
                 return _ref.apply(this, arguments);
               };
             }();
@@ -2131,14 +2168,14 @@
             isLazyResolve = contextConf.resolve.lazy;
 
             if (!isLazyResolve) {
-              value = yield refresh();
+              value = yield load();
             }
           } else if (!brickUtils.hasOwnProperty(contextConf, "value")) {
             return false;
           }
         }
 
-        if ((!refresh || isLazyResolve) && contextConf.value !== undefined) {
+        if ((!load || 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);
@@ -2146,15 +2183,17 @@
 
         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);
+          var deps = (isTemplateState ? brickUtils.trackUsedState : brickUtils.trackUsedContext)(load ? 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");
+              if (load) {
+                storyboardContextWrapper.updateValue(contextConf.name, {
+                  cache: "default"
+                }, "refresh");
               } else {
                 storyboardContextWrapper.updateValue(contextConf.name, computeRealValue(contextConf.value, mergedContext, true), "replace");
               }
@@ -2163,7 +2202,7 @@
         }
       }
 
-      resolveFreeVariableValue(value, contextConf, mergedContext, storyboardContextWrapper, brick, refresh);
+      resolveFreeVariableValue(value, contextConf, mergedContext, storyboardContextWrapper, brick, load, !isLazyResolve);
       return true;
     });
     return _resolveNormalStoryboardContext.apply(this, arguments);
@@ -2194,13 +2233,14 @@
     }
   }
 
-  function resolveFreeVariableValue(value, contextConf, mergedContext, storyboardContextWrapper, brick, refresh) {
+  function resolveFreeVariableValue(value, contextConf, mergedContext, storyboardContextWrapper, brick, load, loaded) {
     var newContext = {
       type: "free-variable",
       value,
       // This is required for tracking context, even if no `onChange` is specified.
       eventTarget: new EventTarget$1(),
-      refresh
+      load,
+      loaded
     };
 
     if (contextConf.onChange) {
@@ -6291,11 +6331,13 @@
         case "context.assign":
         case "context.replace":
         case "context.refresh":
-          return builtinContextListenerFactory(method, handler.args, handler, context);
+        case "context.load":
+          return builtinContextListenerFactory(method, handler.args, handler, handler.callback, context);
 
         case "state.update":
         case "state.refresh":
-          return builtinStateListenerFactory(method, handler.args, handler, context);
+        case "state.load":
+          return builtinStateListenerFactory(method, handler.args, handler, handler.callback, context);
 
         case "tpl.dispatchEvent":
           return builtinTplDispatchEventFactory(handler.args, handler, context);
@@ -6424,7 +6466,7 @@
     };
   }
 
-  function builtinContextListenerFactory(method, args, ifContainer, context) {
+  function builtinContextListenerFactory(method, args, ifContainer, callback, context) {
     return function (event) {
       if (!looseCheckIf(ifContainer, _objectSpread__default["default"](_objectSpread__default["default"]({}, context), {}, {
         event
@@ -6435,11 +6477,11 @@
       var storyboardContext = _internalApiGetStoryboardContextWrapper();
 
       var [name, value] = argsFactory(args, context, event);
-      storyboardContext.updateValue(name, value, method);
+      storyboardContext.updateValue(name, value, method, callback);
     };
   }
 
-  function builtinStateListenerFactory(method, args, ifContainer, context) {
+  function builtinStateListenerFactory(method, args, ifContainer, callback, context) {
     return function (event) {
       if (!looseCheckIf(ifContainer, _objectSpread__default["default"](_objectSpread__default["default"]({}, context), {}, {
         event
@@ -6449,7 +6491,7 @@
 
       var tplContext = getTplContext(context.tplContextId);
       var [name, value] = argsFactory(args, context, event);
-      tplContext.state.updateValue(name, value, method === "refresh" ? method : "replace");
+      tplContext.state.updateValue(name, value, method === "update" ? "replace" : method, callback);
     };
   }
 
@@ -6650,13 +6692,39 @@
     };
   }
 
+  function eventCallbackFactory(callback, getContext) {
+    return function callbackFactory(type) {
+      return function (result) {
+        if (callback !== null && callback !== void 0 && callback[type]) {
+          try {
+            var event = new CustomEvent("callback.".concat(type), {
+              detail: result
+            });
+            var context = getContext();
+            [].concat(callback[type]).forEach(eachHandler => {
+              listenerFactory(eachHandler, context, null)(event);
+            });
+          } catch (err) {
+            // Do not throw errors in `callback.success` or `callback.progress`,
+            // to avoid the following triggering of `callback.error`.
+            // eslint-disable-next-line
+            console.error(err);
+          }
+        } else if (type === "error") {
+          // eslint-disable-next-line
+          console.error("Unhandled callback error:", result);
+        }
+      };
+    };
+  }
+
   function brickCallback(_x2, _x3, _x4, _x5, _x6, _x7, _x8) {
     return _brickCallback.apply(this, arguments);
   }
 
   function _brickCallback() {
     _brickCallback = _asyncToGenerator__default["default"](function* (target, handler, method, context, runtimeBrick, event, options) {
-      var _handler$callback, _poll;
+      var _poll;
 
       if (typeof target[method] !== "function") {
         // eslint-disable-next-line no-console
@@ -6683,45 +6751,17 @@
         };
       }();
 
-      var {
-        success,
-        error,
-        finally: finallyHook,
-        progress
-      } = (_handler$callback = handler.callback) !== null && _handler$callback !== void 0 ? _handler$callback : {};
-
-      if (!(success || error || finallyHook || progress)) {
+      if (!handler.callback) {
         task();
         return;
       }
 
-      var callbackFactory = (eventType, specificHandler) => result => {
-        if (specificHandler) {
-          try {
-            var _event = new CustomEvent(eventType, {
-              detail: result
-            });
-
-            [].concat(specificHandler).forEach(eachHandler => {
-              listenerFactory(eachHandler, context, runtimeBrick)(_event);
-            });
-          } catch (err) {
-            // Do not throw errors in `callback.success` or `callback.progress`,
-            // to avoid the following triggering of `callback.error`.
-            // eslint-disable-next-line
-            console.error(err);
-          }
-        } else if (eventType === "callback.error") {
-          // eslint-disable-next-line
-          console.error("Unhandled callback error:", result);
-        }
-      };
-
+      var callbackFactory = eventCallbackFactory(handler.callback, () => context);
       var pollableCallback = {
-        progress: callbackFactory("callback.progress", progress),
-        success: callbackFactory("callback.success", success),
-        error: callbackFactory("callback.error", error),
-        finally: callbackFactory("callback.finally", finallyHook)
+        progress: callbackFactory("progress"),
+        success: callbackFactory("success"),
+        error: callbackFactory("error"),
+        finally: callbackFactory("finally")
       };
       var poll;
 
@@ -11264,7 +11304,7 @@
       })();
     }
 
-    resolveOne(type, resolveConf, conf, brick, context) {
+    resolveOne(type, resolveConf, conf, brick, context, options) {
       var _this2 = this;
 
       return _asyncToGenerator__default["default"](function* () {
@@ -11369,7 +11409,7 @@
 
         var promise;
 
-        if (_this2.cache.has(cacheKey)) {
+        if ((options === null || options === void 0 ? void 0 : options.cache) !== "reload" && _this2.cache.has(cacheKey)) {
           promise = _this2.cache.get(cacheKey);
         } else {
           promise = _asyncToGenerator__default["default"](function* () {