@next-core/brick-kit 2.115.1 → 2.117.0

package/CHANGELOG.md

@@ -3,6 +3,41 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.117.0](https://github.com/easyops-cn/next-core/compare/@next-core/brick-kit@2.116.1...@next-core/brick-kit@2.117.0) (2022-04-06)
+
+
+### Bug Fixes
+
+* contract refactor ([a506766](https://github.com/easyops-cn/next-core/commit/a5067664253a51a007b8fea96ddf7efefd7da7d8))
+
+
+### Features
+
+* support previewing template by settings ([b1fa0f9](https://github.com/easyops-cn/next-core/commit/b1fa0f9e4d774a6b4162643348ca49402bde1479))
+
+
+
+
+
+## [2.116.1](https://github.com/easyops-cn/next-core/compare/@next-core/brick-kit@2.116.0...@next-core/brick-kit@2.116.1) (2022-04-06)
+
+**Note:** Version bump only for package @next-core/brick-kit
+
+
+
+
+
+# [2.116.0](https://github.com/easyops-cn/next-core/compare/@next-core/brick-kit@2.115.1...@next-core/brick-kit@2.116.0) (2022-04-01)
+
+
+### Features
+
+* support re-registering custom templates ([ea91d7d](https://github.com/easyops-cn/next-core/commit/ea91d7de23e0a9d3a935c01a9a103fb44b8cdfb3))
+
+
+
+
+
 ## [2.115.1](https://github.com/easyops-cn/next-core/compare/@next-core/brick-kit@2.115.0...@next-core/brick-kit@2.115.1) (2022-03-30)
 
 **Note:** Version bump only for package @next-core/brick-kit

package/dist/index.bundle.js

@@ -3175,6 +3175,11 @@
   function _dev_only_updateStoryboard(appId, storyboardPatch) {
     kernel._dev_only_updateStoryboard(appId, storyboardPatch);
   }
+  /* istanbul ignore next */
+
+  function _dev_only_updateTemplatePreviewSettings(appId, templateId, settings) {
+    kernel._dev_only_updateTemplatePreviewSettings(appId, templateId, settings);
+  }
   class Runtime {
     constructor() {
       _defineProperty__default["default"](this, "registerBrickTemplate", registerBrickTemplate);
@@ -5590,6 +5595,16 @@
     return;
   };
 
+  var contractsMap = new Map();
+  function collectContract(contracts) {
+    contracts === null || contracts === void 0 ? void 0 : contracts.forEach(contract => {
+      contractsMap.set("".concat(contract.namespaceId, ".").concat(contract.name), contract);
+    });
+  }
+  function getContract(name) {
+    return contractsMap.get(name);
+  }
+
   var flowApiDefinitionPromiseMap = new Map(); // Legacy Custom API: `${namespace}@${name}`
   // Flow API: `${namespace}@${name}:${version}`
 
@@ -5623,6 +5638,7 @@
     var {
       uri,
       method,
+      ext_fields,
       name,
       namespace,
       responseWrapper,
@@ -5642,12 +5658,14 @@
     return isFileType ? [fileName, {
       url,
       method,
+      ext_fields,
       responseWrapper: false
     }, ...args, {
       responseType: "blob"
     }] : [{
       url,
       method,
+      ext_fields,
       responseWrapper
     }, ...args];
   }
@@ -5671,7 +5689,8 @@
     }) : api.contract;
     var {
       uri,
-      method = "GET"
+      method = "GET",
+      ext_fields
     } = (_contract$endpoint = contract === null || contract === void 0 ? void 0 : contract.endpoint) !== null && _contract$endpoint !== void 0 ? _contract$endpoint : {};
     var responseWrapper = contract !== null && contract !== void 0 && contract.response ? contract.response.wrapper !== false : false;
 
@@ -5682,6 +5701,7 @@
     return {
       uri,
       method: method.toLowerCase() === "list" ? "get" : method,
+      ext_fields,
       name: api.name,
       namespace: api.namespace,
       version: api.version,
@@ -5742,25 +5762,39 @@
           };
         }
       } else {
-        var {
-          contractData
-        } = yield ContractApi_searchSingleContract({
-          contractName: "".concat(namespaceName, ".").concat(name),
-          version
-        }); // return undefined if don't found contract
-
-        if (contractData) {
-          var _contractData$namespa, _contractData$namespa2;
+        var contract;
 
+        if (contract = getContract("".concat(namespaceName, ".").concat(name))) {
           return {
-            name: contractData.name,
-            namespace: (_contractData$namespa = contractData.namespace) === null || _contractData$namespa === void 0 ? void 0 : (_contractData$namespa2 = _contractData$namespa[0]) === null || _contractData$namespa2 === void 0 ? void 0 : _contractData$namespa2.name,
-            version: contractData.version,
+            name: contract.name,
+            namespace: contract.namespaceId,
+            version: contract.version,
             contract: {
-              endpoint: contractData.endpoint,
-              response: contractData.response
+              endpoint: contract.endpoint,
+              response: contract.response
             }
           };
+        } else {
+          var {
+            contractData
+          } = yield ContractApi_searchSingleContract({
+            contractName: "".concat(namespaceName, ".").concat(name),
+            version
+          }); // return undefined if don't found contract
+
+          if (contractData) {
+            var _contractData$namespa, _contractData$namespa2;
+
+            return {
+              name: contractData.name,
+              namespace: (_contractData$namespa = contractData.namespace) === null || _contractData$namespa === void 0 ? void 0 : (_contractData$namespa2 = _contractData$namespa[0]) === null || _contractData$namespa2 === void 0 ? void 0 : _contractData$namespa2.name,
+              version: contractData.version,
+              contract: {
+                endpoint: contractData.endpoint,
+                response: contractData.response
+              }
+            };
+          }
         }
       }
     });
@@ -6639,26 +6673,74 @@
   }
 
   var CUSTOM_API_PROVIDER = "brick-kit.provider-custom-api";
-  function CustomApi(_x, _x2, _x3) {
+  function processExtFields(ext_fields) {
+
+    var hasFields = type => {
+      return ext_fields.some(item => item.source === type);
+    };
+
+    var hasQueryParams = hasFields("query");
+    var HasBodyParams = hasFields("body");
+
+    for (var _len = arguments.length, args = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
+      args[_key - 1] = arguments[_key];
+    }
+
+    if (hasQueryParams && HasBodyParams) {
+      var [_data, params, _options] = args;
+      return {
+        data: _data,
+        options: _objectSpread__default["default"]({
+          params: params
+        }, _options)
+      };
+    }
+
+    if (hasQueryParams) {
+      var [_params, _options2] = args;
+      return {
+        data: {},
+        options: _objectSpread__default["default"]({
+          params: _params
+        }, _options2)
+      };
+    } // only hasBodyParams or default
+
+
+    var [data, options] = args;
+    return {
+      data,
+      options
+    };
+  }
+  function CustomApi(_x) {
     return _CustomApi.apply(this, arguments);
   }
 
   function _CustomApi() {
-    _CustomApi = _asyncToGenerator__default["default"](function* (_ref, data, options) {
+    _CustomApi = _asyncToGenerator__default["default"](function* (_ref) {
       var {
         url,
         method = "GET",
-        responseWrapper = true
+        responseWrapper = true,
+        ext_fields = []
       } = _ref;
       var isSimpleRequest = ["get", "delete", "head"].includes(method.toLowerCase());
 
+      for (var _len2 = arguments.length, args = new Array(_len2 > 1 ? _len2 - 1 : 0), _key2 = 1; _key2 < _len2; _key2++) {
+        args[_key2 - 1] = arguments[_key2];
+      }
+
       if (isSimpleRequest) {
+        var [data, options] = args;
         var response = yield brickHttp.http.simpleRequest(method, url, _objectSpread__default["default"]({
           params: data
         }, options));
         return responseWrapper ? response.data : response;
       } else {
-        var _response = yield brickHttp.http.requestWithBody(method, url, data, options);
+        var result = processExtFields(ext_fields, ...args);
+
+        var _response = yield brickHttp.http.requestWithBody(method, url, result.data, result.options);
 
         return responseWrapper ? _response.data : _response;
       }
@@ -7903,11 +7985,33 @@
       var storyboard = this.bootstrapData.storyboards.find(item => item.app.id === appId);
       Object.assign(storyboard, _objectSpread__default["default"](_objectSpread__default["default"]({}, storyboardPatch), {}, {
         $$fulfilling: Promise.resolve(),
-        $$fulfilled: true
+        $$fulfilled: true,
+        $$registerCustomTemplateProcessed: false,
+        $$depsProcessed: false
       }));
       this.postProcessStoryboard(storyboard);
     }
 
+    _dev_only_updateTemplatePreviewSettings(appId, templateId, settings) {
+      var {
+        routes
+      } = this.bootstrapData.storyboards.find(item => item.app.id === appId);
+      var previewPath = "${APP.homepage}/_dev_only_/template-preview/".concat(templateId);
+      var previewRouteIndex = routes.findIndex(route => route.path === previewPath);
+      var newPreviewRoute = {
+        path: previewPath,
+        bricks: [_objectSpread__default["default"]({
+          brick: templateId
+        }, lodash.pick(settings, "properties"))]
+      };
+
+      if (previewRouteIndex === -1) {
+        routes.push(newPreviewRoute);
+      } else {
+        routes.splice(previewRouteIndex, 1, newPreviewRoute);
+      }
+    }
+
     loadDepsOfStoryboard(storyboard) {
       var _this6 = this;
 
@@ -9982,7 +10086,7 @@
         var storyboard = locationContext.matchStoryboard(_this3.kernel.bootstrapData.storyboards);
 
         if (storyboard) {
-          var _storyboard$meta, _storyboard$meta2;
+          var _storyboard$meta, _storyboard$meta2, _storyboard$meta3;
 
           yield _this3.kernel.fulfilStoryboard(storyboard); // 将动态解析后的模板还原，以便重新动态解析。
 
@@ -10001,6 +10105,7 @@
 
           registerStoryboardFunctions((_storyboard$meta = storyboard.meta) === null || _storyboard$meta === void 0 ? void 0 : _storyboard$meta.functions, storyboard.app);
           registerMock((_storyboard$meta2 = storyboard.meta) === null || _storyboard$meta2 === void 0 ? void 0 : _storyboard$meta2.mocks);
+          collectContract((_storyboard$meta3 = storyboard.meta) === null || _storyboard$meta3 === void 0 ? void 0 : _storyboard$meta3.contracts);
         }
 
         var {
@@ -10053,7 +10158,13 @@
           };
 
           try {
-            yield locationContext.mountRoutes(storyboard.routes, undefined, mountRoutesResult);
+            yield locationContext.mountRoutes( // Concat with a placeholder when loading template preview settings.
+            storyboard.routes.concat({
+              path: "${APP.homepage}/_dev_only_/template-preview/:templateId",
+              bricks: [{
+                brick: "next-previewer.template-preview-loader"
+              }]
+            }), undefined, mountRoutesResult);
           } catch (error) {
             // eslint-disable-next-line no-console
             console.error(error); // Redirect to login page if not logged in.
@@ -10966,37 +11077,37 @@
   }
 
   function registerCustomTemplate(tplName, tplConstructor, appId) {
-    var _tplConstructor$proxy;
-
     var tagName = tplName; // When a template is registered by an app, its namespace maybe missed.
 
     if (appId && !tplName.includes(".")) {
       tagName = "".concat(appId, ".").concat(tplName);
     }
 
-    if (customTemplateRegistry.has(tagName)) {
+    var registered = customTemplateRegistry.has(tagName);
+
+    if (registered) {
       // When open launchpad, the storyboard will be updated.
       // However, we can't *undefine* a custom element.
       // Just ignore re-registering custom templates.
       if (!appId || appRegistered.has(appId)) {
         // eslint-disable-next-line no-console
-        console.error("Custom template of \"".concat(tagName, "\" already registered."));
+        console.warn("Custom template of \"".concat(tagName, "\" already registered."));
       }
+    } else {
+      registered = !!customElements.get(tagName);
 
-      return;
-    }
+      if (registered) {
+        // eslint-disable-next-line no-console
+        console.warn("Custom template of \"".concat(tagName, "\" already defined by customElements."));
+      }
+    } // Now we allow re-register custom template
 
-    if (customElements.get(tagName)) {
-      // eslint-disable-next-line no-console
-      console.error("Custom template of \"".concat(tagName, "\" already defined by customElements."));
-      return;
-    }
 
     customTemplateRegistry.set(tagName, _objectSpread__default["default"](_objectSpread__default["default"]({}, tplConstructor), {}, {
       name: tagName
     })); // Collect defined properties of the template.
 
-    var props = Object.keys(((_tplConstructor$proxy = tplConstructor.proxy) === null || _tplConstructor$proxy === void 0 ? void 0 : _tplConstructor$proxy.properties) || {});
+    var props = getPropsOfCustomTemplate(tagName);
     var nativeProp = props.find(prop => prop in HTMLElement.prototype); // istanbul ignore if
 
     if (nativeProp !== undefined) {
@@ -11004,13 +11115,17 @@
       console.error("In custom template \"".concat(tagName, "\", \"").concat(nativeProp, "\" is a native HTMLElement property, and should be avoid to be used as a brick property."));
     }
 
+    if (registered) {
+      return;
+    }
+
     customElements.define(tagName, class TplElement extends HTMLElement {
       get $$typeof() {
         return "custom-template";
       }
 
       static get _dev_only_definedProperties() {
-        return props;
+        return getPropsOfCustomTemplate(tagName);
       }
 
       connectedCallback() {
@@ -11028,6 +11143,16 @@
     }
   }
 
+  function getPropsOfCustomTemplate(tagName) {
+    var _state$map, _proxy$properties;
+
+    var {
+      state,
+      proxy
+    } = customTemplateRegistry.get(tagName);
+    return ((_state$map = state === null || state === void 0 ? void 0 : state.map(item => item.name)) !== null && _state$map !== void 0 ? _state$map : []).concat(Object.keys((_proxy$properties = proxy === null || proxy === void 0 ? void 0 : proxy.properties) !== null && _proxy$properties !== void 0 ? _proxy$properties : {}));
+  }
+
   var customProcessorRegistry = new Map();
   function registerCustomProcessor(processorFullName, processorFunc) {
     // `namespace` should be the camelCase of the package name.
@@ -12952,7 +13077,8 @@
 
     /** @deprecated Keep it for backward-compatibility. */
     checkoutTplContext: lodash.noop,
-    updateStoryboard: _dev_only_updateStoryboard
+    updateStoryboard: _dev_only_updateStoryboard,
+    updateTemplatePreviewSettings: _dev_only_updateTemplatePreviewSettings
   };
 
   var _excluded$2 = ["type"];