@kcuf/messenger 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Alibaba Cloud
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,82 @@
+# @kcuf/messenger
+
+封装 `postMessage`，有可以将 `postMessage` 转化成 `Promise` 的方法。
+
+注意：需要使用者自己保证 `Promise`。
+
+## 兼容性
+
+`postMessage` 的 [兼容性](https://caniuse.com/#search=postMessage) 已经很好了，我们不做无谓判断。
+
+## INSTALL
+
+```shell
+pnpm add @kcuf/messenger
+```
+
+## Usage
+
+```ts
+import messenger from '@kcuf/messenger';
+
+messenger.emit<P>(type, payload); // 这里 P 是 `payload` 的类型定义
+messenger.on<P>(type, payload => {
+  // ...
+});
+messenger.once<P>(type, payload => {
+  // ...
+});
+
+messenger.emitPromise<P>(type, payload);
+messenger.onPromise<P>(type, payload => {
+  // ...
+});
+```
+
+## APIs
+
+* `messenger.emit(type, payload?)` 相当于 `postMessage({ type, payload })`
+* `messenger.emitPromise(type, payload?)` 也是 `postMessage`，返回 `Promise`，必须要有 `onPromise` 来承接，否则此 Promise 将永远无法结束
+* `messenger.on(type, fn)` 相当于 `addEventListener('message' ...` 并判断 `e.data.type === type`
+* `messenger.once(type, fn)` 相当于 `on`，调用后自动解绑
+* `messenger.onPromise(type, fn)` 相当于 `on`，调用后自动解绑
+
+## FAQ
+
+### 如何向其他窗口（比如父 `parent` 或 `top`，甚至某个 `iframe` 的窗口）进行 `postMessage`？
+
+给 `emit` / `emitPromise` 传第三个参数：
+
+```ts
+messenger.emit(type, payload, {
+  targetWindow: 'parent' // 或 'top' 或其他 Window 对象
+})
+```
+
+### 如何解绑？
+
+之所以没有类似 `off` 之类的 API，是因为 `on`、`once`、`onPromise` 这几个方法的返回就是一个无参的解绑函数。
+
+使用 hook 的例子
+
+```tsx
+import {
+  useEffect
+} from 'react';
+
+import messenger from '@kcuf/messenger';
+
+function useEffectOnMessengerXx(): void {
+  useEffect(() => messenger.on(_MESSAGE_TYPE_ENUM_, () => {
+    // ... do sth
+  }), []);
+}
+```
+
+### 必须 `@kcuf/messenger#emit` 联合 `@kcuf/messenger#on` 使用吗？
+
+并不是。
+
+你还是可以用原生的 `addEventListener('messenger', ...)` 来监听，唯一的区别就是你要自己去判断 `e.data.type` 等。
+
+同样的，`@kcuf/messenger#on` 也可以接收裸写的 `postMessage({ type, data })`。只不过，你裸写 `postMessage` 很可能漏掉 `targetOrigin`。

package/dist/cjs/index.js

@@ -0,0 +1,10 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _messenger = _interopRequireDefault(require("./messenger"));
+// the globally solo messenger instance
+var _default = exports.default = new _messenger.default();

package/dist/cjs/messenger/index.js

@@ -0,0 +1,192 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _util = require("../util");
+/**
+ * 封装 `postMessage`，全局只有一个监听事件
+ */
+var Messenger = exports.default = /*#__PURE__*/function () {
+  function Messenger() {
+    var _this = this;
+    (0, _classCallCheck2.default)(this, Messenger);
+    (0, _defineProperty2.default)(this, "messageReceiverMap", {});
+    var thisWindow = (0, _util.getTargetWindow)();
+    thisWindow.addEventListener('message', function (e) {
+      var _e$data = e.data,
+        type = _e$data.type,
+        payload = _e$data.payload;
+      var _this$getReceivers = _this.getReceivers(type),
+        _this$getReceivers2 = (0, _slicedToArray2.default)(_this$getReceivers, 2),
+        receivers = _this$getReceivers2[0],
+        receiversOnce = _this$getReceivers2[1];
+      receivers.forEach(function (v) {
+        return v.fn(payload);
+      });
+      receiversOnce.forEach(function (v) {
+        return v.fn(payload);
+      });
+      receiversOnce.forEach(function (v) {
+        return _this.removeReceiver(type, v);
+      });
+    });
+  }
+
+  /**
+   * 广播消息，当传入的对象 payload 不是 plain 对象的时候（如 Error、function、DOMElement、JSX 等），这里会报错
+   * 「Uncaught DOMException: The object could not be cloned.」或 「DataCloneError: The object could not be cloned.」
+   * 这个错误不能吃掉，因为使用者需要同步地知道调用失败了
+   */
+  return (0, _createClass2.default)(Messenger, [{
+    key: "emit",
+    value:
+    // eslint-disable-line @typescript-eslint/no-unnecessary-type-parameters
+    function emit(type, payload) {
+      var _options$targetOrigin;
+      var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+      var theWindow = (0, _util.getTargetWindow)(options.targetWindow);
+      theWindow.postMessage({
+        type: type,
+        payload: payload
+      }, (_options$targetOrigin = options.targetOrigin) !== null && _options$targetOrigin !== void 0 ? _options$targetOrigin : theWindow.location.origin);
+    }
+
+    /**
+     * 广播事件，返回 Promise，必须要有 `onPromise` 来承接该事件，否则此 `Promise` 将永远无法结束
+     */
+  }, {
+    key: "emitPromise",
+    value:
+    // eslint-disable-line @typescript-eslint/no-unnecessary-type-parameters
+    function emitPromise(type, payload, options) {
+      var _this2 = this;
+      var payloadForPromise = (0, _util.buildPayloadForPromise)(type, payload);
+
+      // 触发 `onPromise` 的回调，不要放到 `new Promise` 内部，因为它可能会报错，这个错需要保持是同步的
+      this.emit(type, payloadForPromise, options);
+      return new Promise(function (resolve, reject) {
+        // `onPromise` 的回调返回的是 `Promise`，它 `resolve` 或 `reject` 都会广播一个以 `_dismiss_` 为类型的 `message`，
+        // 这里使用单次订阅是因为这个 `message` 只需要消费一次。
+        _this2.once(payloadForPromise._dismiss_, function (payloadBack) {
+          if (!payloadBack) {
+            // 一般来说不可能没有 payloadBack，但代码需要严谨
+            reject(new Error('Messenger:emitPromise MessengerPayloadPromiseBack is missing.'));
+            return;
+          }
+          var value = payloadBack.value,
+            error = payloadBack.error;
+          if (error) {
+            reject((0, _util.plainToError)(error));
+          } else {
+            resolve(value);
+          }
+        });
+      });
+    }
+
+    /**
+     * 注册回调，返回用于注销的方法
+     */
+  }, {
+    key: "on",
+    value:
+    // eslint-disable-line @typescript-eslint/no-unnecessary-type-parameters
+    function on(type, fn) {
+      return this.addReceiver(type, fn);
+    }
+
+    /**
+     * 注册单次回调，运行一次后将自动注销
+     */
+  }, {
+    key: "once",
+    value:
+    // eslint-disable-line @typescript-eslint/no-unnecessary-type-parameters
+    function once(type, fn) {
+      return this.addReceiver(type, fn, true);
+    }
+
+    /**
+     * 对 emitPromise 对应的 type 进行响应，这里关心的 payload 还是 emitPromise 所传入的 payload
+     */
+  }, {
+    key: "onPromise",
+    value:
+    // eslint-disable-line @typescript-eslint/no-unnecessary-type-parameters
+    function onPromise(type, fn) {
+      var _this3 = this;
+      return this.on(type, function (payload) {
+        if (!(payload !== null && payload !== void 0 && payload._dismiss_)) {
+          // 得到的 payload 下有 _dismiss_ 参数才响应，否则 pass
+          return;
+        }
+
+        // 这里广播是事件会被 `emitPromise` 方法内部的 once 消化
+        Promise.resolve(fn(payload.payload)).then(function (value) {
+          _this3.emit(payload._dismiss_, {
+            value: value
+          });
+        }, function (err) {
+          _this3.emit(payload._dismiss_, {
+            error: (0, _util.errorToPlain)(err)
+          });
+        });
+      });
+    }
+  }, {
+    key: "getReceivers",
+    value: function getReceivers(type) {
+      var _receiversForType$red;
+      var receiversForType = this.messageReceiverMap[type];
+      var receiversTuple = [[], []];
+      return (_receiversForType$red = receiversForType === null || receiversForType === void 0 ? void 0 : receiversForType.reduce(function (result, v) {
+        if (v.once) {
+          result[1].push(v);
+        } else {
+          result[0].push(v);
+        }
+        return result;
+      }, receiversTuple)) !== null && _receiversForType$red !== void 0 ? _receiversForType$red : receiversTuple;
+    }
+  }, {
+    key: "addReceiver",
+    value: function addReceiver(type, fn, once) {
+      var _this4 = this;
+      var receivers = this.messageReceiverMap[type];
+      if (!receivers) {
+        receivers = [];
+        this.messageReceiverMap[type] = receivers;
+      }
+      var receiver = {
+        fn: fn,
+        once: once
+      };
+      receivers.push(receiver);
+      return function () {
+        return _this4.removeReceiver(type, receiver);
+      };
+    }
+  }, {
+    key: "removeReceiver",
+    value: function removeReceiver(type, receiver) {
+      var receivers = this.messageReceiverMap[type];
+      if (!receivers) {
+        return;
+      }
+      var index = receivers.indexOf(receiver);
+      if (index >= 0) {
+        receivers.splice(index, 1);
+      }
+      if (!receivers.length) {
+        delete this.messageReceiverMap[type]; // eslint-disable-line @typescript-eslint/no-dynamic-delete
+      }
+    }
+  }]);
+}();

package/dist/cjs/types/index.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/cjs/util/build-payload-for-promise.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = buildPayloadForPromise;
+function buildPayloadForPromise(type, payload) {
+  // 生成一个事件 type，用于 onPromise 里进行事件回调，因为 `postMessage` 无法传输 function，
+  // 所以只好经由这种「曲线救国」的方式。
+  return {
+    _dismiss_: "".concat(type, "/end/").concat(Date.now(), "-").concat(Math.round(Math.random() * 100000)),
+    payload: payload
+  };
+}

package/dist/cjs/util/error-to-plain.js

@@ -0,0 +1,27 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = errorToPlain;
+var _isError2 = _interopRequireDefault(require("lodash/isError"));
+var _forEach2 = _interopRequireDefault(require("lodash/forEach"));
+/**
+ * `postMessage` 不支持传 Error 对象
+ */
+function errorToPlain(err) {
+  if (!(0, _isError2.default)(err)) {
+    return err;
+  }
+  var plain = {};
+  (0, _forEach2.default)(err, function (v, k) {
+    plain[k] = v;
+  });
+  ['message', 'name', 'stack'].forEach(function (v) {
+    if (!plain[v]) {
+      plain[v] = err[v];
+    }
+  });
+  return plain;
+}

package/dist/cjs/util/get-target-window.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = getTargetWindow;
+var _sandboxEscape = require("@kcuf/sandbox-escape");
+var thisWindow = (0, _sandboxEscape.getWindow)();
+function getTargetWindow() {
+  var _thisWindow$top;
+  var targetWindow = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : thisWindow;
+  switch (targetWindow) {
+    case 'top':
+      return (_thisWindow$top = thisWindow.top) !== null && _thisWindow$top !== void 0 ? _thisWindow$top : thisWindow;
+    case 'parent':
+      return thisWindow.parent;
+    default:
+      return targetWindow;
+  }
+}

package/dist/cjs/util/index.js

@@ -0,0 +1,34 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "buildPayloadForPromise", {
+  enumerable: true,
+  get: function get() {
+    return _buildPayloadForPromise.default;
+  }
+});
+Object.defineProperty(exports, "errorToPlain", {
+  enumerable: true,
+  get: function get() {
+    return _errorToPlain.default;
+  }
+});
+Object.defineProperty(exports, "getTargetWindow", {
+  enumerable: true,
+  get: function get() {
+    return _getTargetWindow.default;
+  }
+});
+Object.defineProperty(exports, "plainToError", {
+  enumerable: true,
+  get: function get() {
+    return _plainToError.default;
+  }
+});
+var _getTargetWindow = _interopRequireDefault(require("./get-target-window"));
+var _buildPayloadForPromise = _interopRequireDefault(require("./build-payload-for-promise"));
+var _errorToPlain = _interopRequireDefault(require("./error-to-plain"));
+var _plainToError = _interopRequireDefault(require("./plain-to-error"));

package/dist/cjs/util/plain-to-error.js

@@ -0,0 +1,19 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = plainToError;
+var _isPlainObject2 = _interopRequireDefault(require("lodash/isPlainObject"));
+var _forEach2 = _interopRequireDefault(require("lodash/forEach"));
+function plainToError(o) {
+  if (!(0, _isPlainObject2.default)(o)) {
+    return o;
+  }
+  var err = new Error();
+  (0, _forEach2.default)(o, function (_v, k) {
+    err[k] = o[k];
+  });
+  return err;
+}

package/dist/esm/index.js

@@ -0,0 +1,5 @@
+import Messenger from './messenger';
+
+// the globally solo messenger instance
+export default new Messenger();
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["Messenger"],"sources":["../../src/index.ts"],"sourcesContent":["import Messenger from './messenger';\n\n// the globally solo messenger instance\nexport default new Messenger();\n"],"mappings":"AAAA,OAAOA,SAAS,MAAM,aAAa;;AAEnC;AACA,eAAe,IAAIA,SAAS,CAAC,CAAC","ignoreList":[]}

package/dist/esm/messenger/index.js

@@ -0,0 +1,188 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _createClass from "@babel/runtime/helpers/createClass";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { buildPayloadForPromise, errorToPlain, getTargetWindow, plainToError } from '../util';
+
+/**
+ * 封装 `postMessage`，全局只有一个监听事件
+ */
+var Messenger = /*#__PURE__*/function () {
+  function Messenger() {
+    var _this = this;
+    _classCallCheck(this, Messenger);
+    _defineProperty(this, "messageReceiverMap", {});
+    var thisWindow = getTargetWindow();
+    thisWindow.addEventListener('message', function (e) {
+      var _e$data = e.data,
+        type = _e$data.type,
+        payload = _e$data.payload;
+      var _this$getReceivers = _this.getReceivers(type),
+        _this$getReceivers2 = _slicedToArray(_this$getReceivers, 2),
+        receivers = _this$getReceivers2[0],
+        receiversOnce = _this$getReceivers2[1];
+      receivers.forEach(function (v) {
+        return v.fn(payload);
+      });
+      receiversOnce.forEach(function (v) {
+        return v.fn(payload);
+      });
+      receiversOnce.forEach(function (v) {
+        return _this.removeReceiver(type, v);
+      });
+    });
+  }
+
+  /**
+   * 广播消息，当传入的对象 payload 不是 plain 对象的时候（如 Error、function、DOMElement、JSX 等），这里会报错
+   * 「Uncaught DOMException: The object could not be cloned.」或 「DataCloneError: The object could not be cloned.」
+   * 这个错误不能吃掉，因为使用者需要同步地知道调用失败了
+   */
+  return _createClass(Messenger, [{
+    key: "emit",
+    value:
+    // eslint-disable-line @typescript-eslint/no-unnecessary-type-parameters
+    function emit(type, payload) {
+      var _options$targetOrigin;
+      var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+      var theWindow = getTargetWindow(options.targetWindow);
+      theWindow.postMessage({
+        type: type,
+        payload: payload
+      }, (_options$targetOrigin = options.targetOrigin) !== null && _options$targetOrigin !== void 0 ? _options$targetOrigin : theWindow.location.origin);
+    }
+
+    /**
+     * 广播事件，返回 Promise，必须要有 `onPromise` 来承接该事件，否则此 `Promise` 将永远无法结束
+     */
+  }, {
+    key: "emitPromise",
+    value:
+    // eslint-disable-line @typescript-eslint/no-unnecessary-type-parameters
+    function emitPromise(type, payload, options) {
+      var _this2 = this;
+      var payloadForPromise = buildPayloadForPromise(type, payload);
+
+      // 触发 `onPromise` 的回调，不要放到 `new Promise` 内部，因为它可能会报错，这个错需要保持是同步的
+      this.emit(type, payloadForPromise, options);
+      return new Promise(function (resolve, reject) {
+        // `onPromise` 的回调返回的是 `Promise`，它 `resolve` 或 `reject` 都会广播一个以 `_dismiss_` 为类型的 `message`，
+        // 这里使用单次订阅是因为这个 `message` 只需要消费一次。
+        _this2.once(payloadForPromise._dismiss_, function (payloadBack) {
+          if (!payloadBack) {
+            // 一般来说不可能没有 payloadBack，但代码需要严谨
+            reject(new Error('Messenger:emitPromise MessengerPayloadPromiseBack is missing.'));
+            return;
+          }
+          var value = payloadBack.value,
+            error = payloadBack.error;
+          if (error) {
+            reject(plainToError(error));
+          } else {
+            resolve(value);
+          }
+        });
+      });
+    }
+
+    /**
+     * 注册回调，返回用于注销的方法
+     */
+  }, {
+    key: "on",
+    value:
+    // eslint-disable-line @typescript-eslint/no-unnecessary-type-parameters
+    function on(type, fn) {
+      return this.addReceiver(type, fn);
+    }
+
+    /**
+     * 注册单次回调，运行一次后将自动注销
+     */
+  }, {
+    key: "once",
+    value:
+    // eslint-disable-line @typescript-eslint/no-unnecessary-type-parameters
+    function once(type, fn) {
+      return this.addReceiver(type, fn, true);
+    }
+
+    /**
+     * 对 emitPromise 对应的 type 进行响应，这里关心的 payload 还是 emitPromise 所传入的 payload
+     */
+  }, {
+    key: "onPromise",
+    value:
+    // eslint-disable-line @typescript-eslint/no-unnecessary-type-parameters
+    function onPromise(type, fn) {
+      var _this3 = this;
+      return this.on(type, function (payload) {
+        if (!(payload !== null && payload !== void 0 && payload._dismiss_)) {
+          // 得到的 payload 下有 _dismiss_ 参数才响应，否则 pass
+          return;
+        }
+
+        // 这里广播是事件会被 `emitPromise` 方法内部的 once 消化
+        Promise.resolve(fn(payload.payload)).then(function (value) {
+          _this3.emit(payload._dismiss_, {
+            value: value
+          });
+        }, function (err) {
+          _this3.emit(payload._dismiss_, {
+            error: errorToPlain(err)
+          });
+        });
+      });
+    }
+  }, {
+    key: "getReceivers",
+    value: function getReceivers(type) {
+      var _receiversForType$red;
+      var receiversForType = this.messageReceiverMap[type];
+      var receiversTuple = [[], []];
+      return (_receiversForType$red = receiversForType === null || receiversForType === void 0 ? void 0 : receiversForType.reduce(function (result, v) {
+        if (v.once) {
+          result[1].push(v);
+        } else {
+          result[0].push(v);
+        }
+        return result;
+      }, receiversTuple)) !== null && _receiversForType$red !== void 0 ? _receiversForType$red : receiversTuple;
+    }
+  }, {
+    key: "addReceiver",
+    value: function addReceiver(type, fn, once) {
+      var _this4 = this;
+      var receivers = this.messageReceiverMap[type];
+      if (!receivers) {
+        receivers = [];
+        this.messageReceiverMap[type] = receivers;
+      }
+      var receiver = {
+        fn: fn,
+        once: once
+      };
+      receivers.push(receiver);
+      return function () {
+        return _this4.removeReceiver(type, receiver);
+      };
+    }
+  }, {
+    key: "removeReceiver",
+    value: function removeReceiver(type, receiver) {
+      var receivers = this.messageReceiverMap[type];
+      if (!receivers) {
+        return;
+      }
+      var index = receivers.indexOf(receiver);
+      if (index >= 0) {
+        receivers.splice(index, 1);
+      }
+      if (!receivers.length) {
+        delete this.messageReceiverMap[type]; // eslint-disable-line @typescript-eslint/no-dynamic-delete
+      }
+    }
+  }]);
+}();
+export { Messenger as default };
+//# sourceMappingURL=index.js.map

package/dist/esm/messenger/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["buildPayloadForPromise","errorToPlain","getTargetWindow","plainToError","Messenger","_this","_classCallCheck","_defineProperty","thisWindow","addEventListener","e","_e$data","data","type","payload","_this$getReceivers","getReceivers","_this$getReceivers2","_slicedToArray","receivers","receiversOnce","forEach","v","fn","removeReceiver","_createClass","key","value","emit","_options$targetOrigin","options","arguments","length","undefined","theWindow","targetWindow","postMessage","targetOrigin","location","origin","emitPromise","_this2","payloadForPromise","Promise","resolve","reject","once","_dismiss_","payloadBack","Error","error","on","addReceiver","onPromise","_this3","then","err","_receiversForType$red","receiversForType","messageReceiverMap","receiversTuple","reduce","result","push","_this4","receiver","index","indexOf","splice","default"],"sources":["../../../src/messenger/index.ts"],"sourcesContent":["import {\n  TFnOff,\n  IMessageData,\n  TMessengerCallback,\n  TMessengerReceiverMap,\n  IMessengerEmitOptions,\n  IMessengerPayloadPromise,\n  IMessengerPayloadPromiseBack,\n  IMessengerReceiver\n} from '../types';\nimport {\n  buildPayloadForPromise,\n  errorToPlain,\n  getTargetWindow,\n  plainToError\n} from '../util';\n\n/**\n * 封装 `postMessage`，全局只有一个监听事件\n */\nexport default class Messenger {\n  private messageReceiverMap: TMessengerReceiverMap = {};\n  \n  constructor() {\n    const thisWindow = getTargetWindow();\n    \n    thisWindow.addEventListener('message', (e: MessageEvent<IMessageData>): void => {\n      const {\n        data: {\n          type,\n          payload\n        }\n      } = e;\n      const [receivers, receiversOnce] = this.getReceivers(type);\n      \n      receivers.forEach(v => v.fn(payload));\n      receiversOnce.forEach(v => v.fn(payload));\n      \n      receiversOnce.forEach(v => this.removeReceiver(type, v));\n    });\n  }\n  \n  /**\n   * 广播消息，当传入的对象 payload 不是 plain 对象的时候（如 Error、function、DOMElement、JSX 等），这里会报错\n   * 「Uncaught DOMException: The object could not be cloned.」或 「DataCloneError: The object could not be cloned.」\n   * 这个错误不能吃掉，因为使用者需要同步地知道调用失败了\n   */\n  emit(type: string): void;\n  emit(type: string, payload: undefined, options: IMessengerEmitOptions): void;\n  emit<P = unknown>(type: string, payload: P, options?: IMessengerEmitOptions): void; // eslint-disable-line @typescript-eslint/no-unnecessary-type-parameters\n  emit(type: string, payload?: unknown, options: IMessengerEmitOptions = {}): void {\n    const theWindow = getTargetWindow(options.targetWindow);\n    \n    theWindow.postMessage({\n      type,\n      payload\n    }, options.targetOrigin ?? theWindow.location.origin);\n  }\n  \n  /**\n   * 广播事件，返回 Promise，必须要有 `onPromise` 来承接该事件，否则此 `Promise` 将永远无法结束\n   */\n  emitPromise<T = void>(type: string): Promise<T>;\n  emitPromise<T = void>(type: string, payload: undefined, options: IMessengerEmitOptions): Promise<T>;\n  emitPromise<T = void, P = unknown>(type: string, payload: P, options?: IMessengerEmitOptions): Promise<T>; // eslint-disable-line @typescript-eslint/no-unnecessary-type-parameters\n  emitPromise<T = void, P = unknown>(type: string, payload?: P, options?: IMessengerEmitOptions): Promise<T> {\n    const payloadForPromise = buildPayloadForPromise<P | undefined>(type, payload);\n    \n    // 触发 `onPromise` 的回调，不要放到 `new Promise` 内部，因为它可能会报错，这个错需要保持是同步的\n    this.emit<IMessengerPayloadPromise<P | undefined>>(type, payloadForPromise, options);\n    \n    return new Promise<T>((resolve, reject) => {\n      // `onPromise` 的回调返回的是 `Promise`，它 `resolve` 或 `reject` 都会广播一个以 `_dismiss_` 为类型的 `message`，\n      // 这里使用单次订阅是因为这个 `message` 只需要消费一次。\n      this.once<IMessengerPayloadPromiseBack<T>>(payloadForPromise._dismiss_, (payloadBack?: IMessengerPayloadPromiseBack<T>): void => {\n        if (!payloadBack) { // 一般来说不可能没有 payloadBack，但代码需要严谨\n          reject(new Error('Messenger:emitPromise MessengerPayloadPromiseBack is missing.'));\n          \n          return;\n        }\n        \n        const {\n          value,\n          error\n        } = payloadBack;\n        \n        if (error) {\n          reject(plainToError(error));\n        } else {\n          resolve(value as T);\n        }\n      });\n    });\n  }\n  \n  /**\n   * 注册回调，返回用于注销的方法\n   */\n  on(type: string, fn: () => void): TFnOff;\n  on<P = unknown>(type: string, fn: (payload: P) => void): TFnOff; // eslint-disable-line @typescript-eslint/no-unnecessary-type-parameters\n  on(type: string, fn: (payload: unknown) => void): TFnOff {\n    return this.addReceiver(type, fn);\n  }\n  \n  /**\n   * 注册单次回调，运行一次后将自动注销\n   */\n  once(type: string, fn: () => void): TFnOff;\n  once<P = unknown>(type: string, fn: (payload: P) => void): TFnOff; // eslint-disable-line @typescript-eslint/no-unnecessary-type-parameters\n  once<P = unknown>(type: string, fn: (payload: P) => void): TFnOff {\n    return this.addReceiver(type, fn, true);\n  }\n  \n  /**\n   * 对 emitPromise 对应的 type 进行响应，这里关心的 payload 还是 emitPromise 所传入的 payload\n   */\n  onPromise<T = void>(type: string, fn: () => T | Promise<T>): TFnOff;\n  onPromise<T, P = unknown>(type: string, fn: (payload: P) => T | Promise<T>): TFnOff; // eslint-disable-line @typescript-eslint/no-unnecessary-type-parameters\n  onPromise<T, P = unknown>(type: string, fn: (payload: P) => T | Promise<T>): TFnOff {\n    return this.on(type, (payload?: IMessengerPayloadPromise<P>) => {\n      if (!payload?._dismiss_) { // 得到的 payload 下有 _dismiss_ 参数才响应，否则 pass\n        return;\n      }\n      \n      // 这里广播是事件会被 `emitPromise` 方法内部的 once 消化\n      Promise.resolve(fn(payload.payload)).then((value: T) => {\n        this.emit<IMessengerPayloadPromiseBack<T>>(payload._dismiss_, {\n          value\n        });\n      }, (err: unknown) => {\n        this.emit<IMessengerPayloadPromiseBack<T>>(payload._dismiss_, {\n          error: errorToPlain(err)\n        });\n      });\n    });\n  }\n  \n  private getReceivers(type: string): [IMessengerReceiver[], IMessengerReceiver[]] {\n    const receiversForType = this.messageReceiverMap[type];\n    const receiversTuple: [IMessengerReceiver[], IMessengerReceiver[]] = [[], []];\n    \n    return receiversForType?.reduce((result: [IMessengerReceiver[], IMessengerReceiver[]], v) => {\n      if (v.once) {\n        result[1].push(v);\n      } else {\n        result[0].push(v);\n      }\n      \n      return result;\n    }, receiversTuple) ?? receiversTuple;\n  }\n  \n  private addReceiver<P>(type: string, fn: TMessengerCallback<P>, once?: boolean): TFnOff {\n    let receivers = this.messageReceiverMap[type];\n    \n    if (!receivers) {\n      receivers = [];\n      this.messageReceiverMap[type] = receivers;\n    }\n    \n    const receiver: IMessengerReceiver = {\n      fn,\n      once\n    };\n    \n    receivers.push(receiver);\n    \n    return () => this.removeReceiver(type, receiver);\n  }\n  \n  private removeReceiver(type: string, receiver: IMessengerReceiver): void {\n    const receivers = this.messageReceiverMap[type];\n    \n    if (!receivers) {\n      return;\n    }\n    \n    const index = receivers.indexOf(receiver);\n    \n    if (index >= 0) {\n      receivers.splice(index, 1);\n    }\n    \n    if (!receivers.length) {\n      delete this.messageReceiverMap[type]; // eslint-disable-line @typescript-eslint/no-dynamic-delete\n    }\n  };\n}\n"],"mappings":";;;;AAUA,SACEA,sBAAsB,EACtBC,YAAY,EACZC,eAAe,EACfC,YAAY,QACP,SAAS;;AAEhB;AACA;AACA;AAFA,IAGqBC,SAAS;EAG5B,SAAAA,UAAA,EAAc;IAAA,IAAAC,KAAA;IAAAC,eAAA,OAAAF,SAAA;IAAAG,eAAA,6BAFsC,CAAC,CAAC;IAGpD,IAAMC,UAAU,GAAGN,eAAe,CAAC,CAAC;IAEpCM,UAAU,CAACC,gBAAgB,CAAC,SAAS,EAAE,UAACC,CAA6B,EAAW;MAC9E,IAAAC,OAAA,GAKID,CAAC,CAJHE,IAAI;QACFC,IAAI,GAAAF,OAAA,CAAJE,IAAI;QACJC,OAAO,GAAAH,OAAA,CAAPG,OAAO;MAGX,IAAAC,kBAAA,GAAmCV,KAAI,CAACW,YAAY,CAACH,IAAI,CAAC;QAAAI,mBAAA,GAAAC,cAAA,CAAAH,kBAAA;QAAnDI,SAAS,GAAAF,mBAAA;QAAEG,aAAa,GAAAH,mBAAA;MAE/BE,SAAS,CAACE,OAAO,CAAC,UAAAC,CAAC;QAAA,OAAIA,CAAC,CAACC,EAAE,CAACT,OAAO,CAAC;MAAA,EAAC;MACrCM,aAAa,CAACC,OAAO,CAAC,UAAAC,CAAC;QAAA,OAAIA,CAAC,CAACC,EAAE,CAACT,OAAO,CAAC;MAAA,EAAC;MAEzCM,aAAa,CAACC,OAAO,CAAC,UAAAC,CAAC;QAAA,OAAIjB,KAAI,CAACmB,cAAc,CAACX,IAAI,EAAES,CAAC,CAAC;MAAA,EAAC;IAC1D,CAAC,CAAC;EACJ;;EAEA;AACF;AACA;AACA;AACA;EAJE,OAAAG,YAAA,CAAArB,SAAA;IAAAsB,GAAA;IAAAC,KAAA;IAOoF;IACpF,SAAAC,IAAIA,CAACf,IAAY,EAAEC,OAAiB,EAA6C;MAAA,IAAAe,qBAAA;MAAA,IAA3CC,OAA8B,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,CAAC;MACvE,IAAMG,SAAS,GAAGhC,eAAe,CAAC4B,OAAO,CAACK,YAAY,CAAC;MAEvDD,SAAS,CAACE,WAAW,CAAC;QACpBvB,IAAI,EAAJA,IAAI;QACJC,OAAO,EAAPA;MACF,CAAC,GAAAe,qBAAA,GAAEC,OAAO,CAACO,YAAY,cAAAR,qBAAA,cAAAA,qBAAA,GAAIK,SAAS,CAACI,QAAQ,CAACC,MAAM,CAAC;IACvD;;IAEA;AACF;AACA;EAFE;IAAAb,GAAA;IAAAC,KAAA;IAK2G;IAC3G,SAAAa,WAAWA,CAAwB3B,IAAY,EAAEC,OAAW,EAAEgB,OAA+B,EAAc;MAAA,IAAAW,MAAA;MACzG,IAAMC,iBAAiB,GAAG1C,sBAAsB,CAAgBa,IAAI,EAAEC,OAAO,CAAC;;MAE9E;MACA,IAAI,CAACc,IAAI,CAA0Cf,IAAI,EAAE6B,iBAAiB,EAAEZ,OAAO,CAAC;MAEpF,OAAO,IAAIa,OAAO,CAAI,UAACC,OAAO,EAAEC,MAAM,EAAK;QACzC;QACA;QACAJ,MAAI,CAACK,IAAI,CAAkCJ,iBAAiB,CAACK,SAAS,EAAE,UAACC,WAA6C,EAAW;UAC/H,IAAI,CAACA,WAAW,EAAE;YAAE;YAClBH,MAAM,CAAC,IAAII,KAAK,CAAC,+DAA+D,CAAC,CAAC;YAElF;UACF;UAEA,IACEtB,KAAK,GAEHqB,WAAW,CAFbrB,KAAK;YACLuB,KAAK,GACHF,WAAW,CADbE,KAAK;UAGP,IAAIA,KAAK,EAAE;YACTL,MAAM,CAAC1C,YAAY,CAAC+C,KAAK,CAAC,CAAC;UAC7B,CAAC,MAAM;YACLN,OAAO,CAACjB,KAAU,CAAC;UACrB;QACF,CAAC,CAAC;MACJ,CAAC,CAAC;IACJ;;IAEA;AACF;AACA;EAFE;IAAAD,GAAA;IAAAC,KAAA;IAIiE;IACjE,SAAAwB,EAAEA,CAACtC,IAAY,EAAEU,EAA8B,EAAU;MACvD,OAAO,IAAI,CAAC6B,WAAW,CAACvC,IAAI,EAAEU,EAAE,CAAC;IACnC;;IAEA;AACF;AACA;EAFE;IAAAG,GAAA;IAAAC,KAAA;IAImE;IACnE,SAAAmB,IAAIA,CAAcjC,IAAY,EAAEU,EAAwB,EAAU;MAChE,OAAO,IAAI,CAAC6B,WAAW,CAACvC,IAAI,EAAEU,EAAE,EAAE,IAAI,CAAC;IACzC;;IAEA;AACF;AACA;EAFE;IAAAG,GAAA;IAAAC,KAAA;IAIqF;IACrF,SAAA0B,SAASA,CAAiBxC,IAAY,EAAEU,EAAkC,EAAU;MAAA,IAAA+B,MAAA;MAClF,OAAO,IAAI,CAACH,EAAE,CAACtC,IAAI,EAAE,UAACC,OAAqC,EAAK;QAC9D,IAAI,EAACA,OAAO,aAAPA,OAAO,eAAPA,OAAO,CAAEiC,SAAS,GAAE;UAAE;UACzB;QACF;;QAEA;QACAJ,OAAO,CAACC,OAAO,CAACrB,EAAE,CAACT,OAAO,CAACA,OAAO,CAAC,CAAC,CAACyC,IAAI,CAAC,UAAC5B,KAAQ,EAAK;UACtD2B,MAAI,CAAC1B,IAAI,CAAkCd,OAAO,CAACiC,SAAS,EAAE;YAC5DpB,KAAK,EAALA;UACF,CAAC,CAAC;QACJ,CAAC,EAAE,UAAC6B,GAAY,EAAK;UACnBF,MAAI,CAAC1B,IAAI,CAAkCd,OAAO,CAACiC,SAAS,EAAE;YAC5DG,KAAK,EAAEjD,YAAY,CAACuD,GAAG;UACzB,CAAC,CAAC;QACJ,CAAC,CAAC;MACJ,CAAC,CAAC;IACJ;EAAC;IAAA9B,GAAA;IAAAC,KAAA,EAED,SAAQX,YAAYA,CAACH,IAAY,EAAgD;MAAA,IAAA4C,qBAAA;MAC/E,IAAMC,gBAAgB,GAAG,IAAI,CAACC,kBAAkB,CAAC9C,IAAI,CAAC;MACtD,IAAM+C,cAA4D,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC;MAE7E,QAAAH,qBAAA,GAAOC,gBAAgB,aAAhBA,gBAAgB,uBAAhBA,gBAAgB,CAAEG,MAAM,CAAC,UAACC,MAAoD,EAAExC,CAAC,EAAK;QAC3F,IAAIA,CAAC,CAACwB,IAAI,EAAE;UACVgB,MAAM,CAAC,CAAC,CAAC,CAACC,IAAI,CAACzC,CAAC,CAAC;QACnB,CAAC,MAAM;UACLwC,MAAM,CAAC,CAAC,CAAC,CAACC,IAAI,CAACzC,CAAC,CAAC;QACnB;QAEA,OAAOwC,MAAM;MACf,CAAC,EAAEF,cAAc,CAAC,cAAAH,qBAAA,cAAAA,qBAAA,GAAIG,cAAc;IACtC;EAAC;IAAAlC,GAAA;IAAAC,KAAA,EAED,SAAQyB,WAAWA,CAAIvC,IAAY,EAAEU,EAAyB,EAAEuB,IAAc,EAAU;MAAA,IAAAkB,MAAA;MACtF,IAAI7C,SAAS,GAAG,IAAI,CAACwC,kBAAkB,CAAC9C,IAAI,CAAC;MAE7C,IAAI,CAACM,SAAS,EAAE;QACdA,SAAS,GAAG,EAAE;QACd,IAAI,CAACwC,kBAAkB,CAAC9C,IAAI,CAAC,GAAGM,SAAS;MAC3C;MAEA,IAAM8C,QAA4B,GAAG;QACnC1C,EAAE,EAAFA,EAAE;QACFuB,IAAI,EAAJA;MACF,CAAC;MAED3B,SAAS,CAAC4C,IAAI,CAACE,QAAQ,CAAC;MAExB,OAAO;QAAA,OAAMD,MAAI,CAACxC,cAAc,CAACX,IAAI,EAAEoD,QAAQ,CAAC;MAAA;IAClD;EAAC;IAAAvC,GAAA;IAAAC,KAAA,EAED,SAAQH,cAAcA,CAACX,IAAY,EAAEoD,QAA4B,EAAQ;MACvE,IAAM9C,SAAS,GAAG,IAAI,CAACwC,kBAAkB,CAAC9C,IAAI,CAAC;MAE/C,IAAI,CAACM,SAAS,EAAE;QACd;MACF;MAEA,IAAM+C,KAAK,GAAG/C,SAAS,CAACgD,OAAO,CAACF,QAAQ,CAAC;MAEzC,IAAIC,KAAK,IAAI,CAAC,EAAE;QACd/C,SAAS,CAACiD,MAAM,CAACF,KAAK,EAAE,CAAC,CAAC;MAC5B;MAEA,IAAI,CAAC/C,SAAS,CAACa,MAAM,EAAE;QACrB,OAAO,IAAI,CAAC2B,kBAAkB,CAAC9C,IAAI,CAAC,CAAC,CAAC;MACxC;IACF;EAAC;AAAA;AAAA,SAtKkBT,SAAS,IAAAiE,OAAA","ignoreList":[]}

package/dist/esm/types/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/esm/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../../src/types/index.ts"],"sourcesContent":["export type TTargetWindow = Window | 'top' | 'parent';\n\nexport interface IMessageData {\n  type: string;\n  payload: never;\n}\n\nexport interface IMessengerEmitOptions {\n  targetWindow?: TTargetWindow;\n  targetOrigin?: string;\n}\n\nexport type TMessengerCallback<P = unknown> = (payload: P) => void;\n\nexport interface IMessengerReceiver<P = never> {\n  fn: TMessengerCallback<P>;\n  once?: boolean;\n  // priority?: number; // 优先级，越大越优先\n}\n\n/**\n * 为每个 MessageEvent.data 的 `type`，建立一个接收序列\n */\nexport type TMessengerReceiverMap = Record<string, IMessengerReceiver[]>;\n\n/**\n * 以 Promise 的形式广播事件的时候的 payload 包裹\n */\nexport interface IMessengerPayloadPromise<P = void> {\n  _dismiss_: string; // onPromise 中会将此包裹打开，如果里边有该值，表明此事件合法，否则不会响应\n  payload: P; // 原 payload\n}\n\n/**\n * `emitPromise` 和 `onPromise` 的纽带\n */\nexport interface IMessengerPayloadPromiseBack<T> {\n  value?: T;\n  error?: Record<string, unknown>; // 可能是 string、对象或 Error\n}\n\nexport type TFnOff = () => void;\n"],"mappings":"","ignoreList":[]}

package/dist/esm/util/build-payload-for-promise.js

@@ -0,0 +1,9 @@
+export default function buildPayloadForPromise(type, payload) {
+  // 生成一个事件 type，用于 onPromise 里进行事件回调，因为 `postMessage` 无法传输 function，
+  // 所以只好经由这种「曲线救国」的方式。
+  return {
+    _dismiss_: "".concat(type, "/end/").concat(Date.now(), "-").concat(Math.round(Math.random() * 100000)),
+    payload: payload
+  };
+}
+//# sourceMappingURL=build-payload-for-promise.js.map

package/dist/esm/util/build-payload-for-promise.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-payload-for-promise.js","names":["buildPayloadForPromise","type","payload","_dismiss_","concat","Date","now","Math","round","random"],"sources":["../../../src/util/build-payload-for-promise.ts"],"sourcesContent":["import {\n  IMessengerPayloadPromise\n} from '../types';\n\nexport default function buildPayloadForPromise<P = unknown>(type: string, payload: P): IMessengerPayloadPromise<P> {\n  // 生成一个事件 type，用于 onPromise 里进行事件回调，因为 `postMessage` 无法传输 function，\n  // 所以只好经由这种「曲线救国」的方式。\n  return {\n    _dismiss_: `${type}/end/${Date.now()}-${Math.round(Math.random() * 100000)}`,\n    payload\n  };\n}\n"],"mappings":"AAIA,eAAe,SAASA,sBAAsBA,CAAcC,IAAY,EAAEC,OAAU,EAA+B;EACjH;EACA;EACA,OAAO;IACLC,SAAS,KAAAC,MAAA,CAAKH,IAAI,WAAAG,MAAA,CAAQC,IAAI,CAACC,GAAG,CAAC,CAAC,OAAAF,MAAA,CAAIG,IAAI,CAACC,KAAK,CAACD,IAAI,CAACE,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,CAAE;IAC5EP,OAAO,EAAPA;EACF,CAAC;AACH","ignoreList":[]}

package/dist/esm/util/error-to-plain.js

@@ -0,0 +1,22 @@
+import _isError from 'lodash/isError';
+import _forEach from 'lodash/forEach';
+
+/**
+ * `postMessage` 不支持传 Error 对象
+ */
+export default function errorToPlain(err) {
+  if (!_isError(err)) {
+    return err;
+  }
+  var plain = {};
+  _forEach(err, function (v, k) {
+    plain[k] = v;
+  });
+  ['message', 'name', 'stack'].forEach(function (v) {
+    if (!plain[v]) {
+      plain[v] = err[v];
+    }
+  });
+  return plain;
+}
+//# sourceMappingURL=error-to-plain.js.map

package/dist/esm/util/error-to-plain.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-to-plain.js","names":["_isError","_forEach","errorToPlain","err","plain","v","k","forEach"],"sources":["../../../src/util/error-to-plain.ts"],"sourcesContent":["import _isError from 'lodash/isError';\nimport _forEach from 'lodash/forEach';\n\n/**\n * `postMessage` 不支持传 Error 对象\n */\nexport default function errorToPlain(err: unknown): Record<string, unknown> {\n  if (!_isError(err)) {\n    return err as Record<string, unknown>;\n  }\n  \n  const plain: Record<string, unknown> = {};\n  \n  _forEach(err, (v, k) => {\n    plain[k] = v;\n  });\n  \n  ['message', 'name', 'stack'].forEach(v => {\n    if (!plain[v]) {\n      plain[v] = (err as unknown as Record<string, unknown>)[v];\n    }\n  });\n  \n  return plain;\n}\n"],"mappings":"AAAA,OAAOA,QAAQ,MAAM,gBAAgB;AACrC,OAAOC,QAAQ,MAAM,gBAAgB;;AAErC;AACA;AACA;AACA,eAAe,SAASC,YAAYA,CAACC,GAAY,EAA2B;EAC1E,IAAI,CAACH,QAAQ,CAACG,GAAG,CAAC,EAAE;IAClB,OAAOA,GAAG;EACZ;EAEA,IAAMC,KAA8B,GAAG,CAAC,CAAC;EAEzCH,QAAQ,CAACE,GAAG,EAAE,UAACE,CAAC,EAAEC,CAAC,EAAK;IACtBF,KAAK,CAACE,CAAC,CAAC,GAAGD,CAAC;EACd,CAAC,CAAC;EAEF,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,CAACE,OAAO,CAAC,UAAAF,CAAC,EAAI;IACxC,IAAI,CAACD,KAAK,CAACC,CAAC,CAAC,EAAE;MACbD,KAAK,CAACC,CAAC,CAAC,GAAIF,GAAG,CAAwCE,CAAC,CAAC;IAC3D;EACF,CAAC,CAAC;EAEF,OAAOD,KAAK;AACd","ignoreList":[]}

package/dist/esm/util/get-target-window.js

@@ -0,0 +1,15 @@
+import { getWindow } from '@kcuf/sandbox-escape';
+var thisWindow = getWindow();
+export default function getTargetWindow() {
+  var _thisWindow$top;
+  var targetWindow = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : thisWindow;
+  switch (targetWindow) {
+    case 'top':
+      return (_thisWindow$top = thisWindow.top) !== null && _thisWindow$top !== void 0 ? _thisWindow$top : thisWindow;
+    case 'parent':
+      return thisWindow.parent;
+    default:
+      return targetWindow;
+  }
+}
+//# sourceMappingURL=get-target-window.js.map

package/dist/esm/util/get-target-window.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-target-window.js","names":["getWindow","thisWindow","getTargetWindow","_thisWindow$top","targetWindow","arguments","length","undefined","top","parent"],"sources":["../../../src/util/get-target-window.ts"],"sourcesContent":["import {\n  getWindow\n} from '@kcuf/sandbox-escape';\n\nimport {\n  TTargetWindow\n} from '../types';\n\nconst thisWindow = getWindow();\n\nexport default function getTargetWindow(targetWindow: TTargetWindow = thisWindow): Window {\n  switch (targetWindow) {\n  case 'top':\n    return thisWindow.top ?? thisWindow;\n  case 'parent':\n    return thisWindow.parent;\n  default:\n    return targetWindow;\n  }\n}\n"],"mappings":"AAAA,SACEA,SAAS,QACJ,sBAAsB;AAM7B,IAAMC,UAAU,GAAGD,SAAS,CAAC,CAAC;AAE9B,eAAe,SAASE,eAAeA,CAAA,EAAmD;EAAA,IAAAC,eAAA;EAAA,IAAlDC,YAA2B,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAGJ,UAAU;EAC9E,QAAQG,YAAY;IACpB,KAAK,KAAK;MACR,QAAAD,eAAA,GAAOF,UAAU,CAACO,GAAG,cAAAL,eAAA,cAAAA,eAAA,GAAIF,UAAU;IACrC,KAAK,QAAQ;MACX,OAAOA,UAAU,CAACQ,MAAM;IAC1B;MACE,OAAOL,YAAY;EACrB;AACF","ignoreList":[]}

package/dist/esm/util/index.js

@@ -0,0 +1,5 @@
+export { default as getTargetWindow } from './get-target-window';
+export { default as buildPayloadForPromise } from './build-payload-for-promise';
+export { default as errorToPlain } from './error-to-plain';
+export { default as plainToError } from './plain-to-error';
+//# sourceMappingURL=index.js.map

package/dist/esm/util/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["default","getTargetWindow","buildPayloadForPromise","errorToPlain","plainToError"],"sources":["../../../src/util/index.ts"],"sourcesContent":["export { default as getTargetWindow } from './get-target-window';\nexport { default as buildPayloadForPromise } from './build-payload-for-promise';\nexport { default as errorToPlain } from './error-to-plain';\nexport { default as plainToError } from './plain-to-error';\n"],"mappings":"AAAA,SAASA,OAAO,IAAIC,eAAe,QAAQ,qBAAqB;AAChE,SAASD,OAAO,IAAIE,sBAAsB,QAAQ,6BAA6B;AAC/E,SAASF,OAAO,IAAIG,YAAY,QAAQ,kBAAkB;AAC1D,SAASH,OAAO,IAAII,YAAY,QAAQ,kBAAkB","ignoreList":[]}

package/dist/esm/util/plain-to-error.js

@@ -0,0 +1,13 @@
+import _isPlainObject from 'lodash/isPlainObject';
+import _forEach from 'lodash/forEach';
+export default function plainToError(o) {
+  if (!_isPlainObject(o)) {
+    return o;
+  }
+  var err = new Error();
+  _forEach(o, function (_v, k) {
+    err[k] = o[k];
+  });
+  return err;
+}
+//# sourceMappingURL=plain-to-error.js.map

package/dist/esm/util/plain-to-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plain-to-error.js","names":["_isPlainObject","_forEach","plainToError","o","err","Error","_v","k"],"sources":["../../../src/util/plain-to-error.ts"],"sourcesContent":["import _isPlainObject from 'lodash/isPlainObject';\nimport _forEach from 'lodash/forEach';\n\nexport default function plainToError(o: Record<string, unknown>): Error {\n  if (!_isPlainObject(o)) {\n    return o as unknown as Error;\n  }\n  \n  const err = new Error();\n  \n  _forEach(o, (_v, k) => {\n    (err as unknown as Record<string, unknown>)[k] = o[k];\n  });\n  \n  return err;\n}\n"],"mappings":"AAAA,OAAOA,cAAc,MAAM,sBAAsB;AACjD,OAAOC,QAAQ,MAAM,gBAAgB;AAErC,eAAe,SAASC,YAAYA,CAACC,CAA0B,EAAS;EACtE,IAAI,CAACH,cAAc,CAACG,CAAC,CAAC,EAAE;IACtB,OAAOA,CAAC;EACV;EAEA,IAAMC,GAAG,GAAG,IAAIC,KAAK,CAAC,CAAC;EAEvBJ,QAAQ,CAACE,CAAC,EAAE,UAACG,EAAE,EAAEC,CAAC,EAAK;IACpBH,GAAG,CAAwCG,CAAC,CAAC,GAAGJ,CAAC,CAACI,CAAC,CAAC;EACvD,CAAC,CAAC;EAEF,OAAOH,GAAG;AACZ","ignoreList":[]}

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+import Messenger from './messenger';
+declare const _default: Messenger;
+export default _default;

package/dist/types/messenger/index.d.ts

@@ -0,0 +1,40 @@
+import { TFnOff, IMessengerEmitOptions } from '../types';
+/**
+ * 封装 `postMessage`，全局只有一个监听事件
+ */
+export default class Messenger {
+    private messageReceiverMap;
+    constructor();
+    /**
+     * 广播消息，当传入的对象 payload 不是 plain 对象的时候（如 Error、function、DOMElement、JSX 等），这里会报错
+     * 「Uncaught DOMException: The object could not be cloned.」或 「DataCloneError: The object could not be cloned.」
+     * 这个错误不能吃掉，因为使用者需要同步地知道调用失败了
+     */
+    emit(type: string): void;
+    emit(type: string, payload: undefined, options: IMessengerEmitOptions): void;
+    emit<P = unknown>(type: string, payload: P, options?: IMessengerEmitOptions): void;
+    /**
+     * 广播事件，返回 Promise，必须要有 `onPromise` 来承接该事件，否则此 `Promise` 将永远无法结束
+     */
+    emitPromise<T = void>(type: string): Promise<T>;
+    emitPromise<T = void>(type: string, payload: undefined, options: IMessengerEmitOptions): Promise<T>;
+    emitPromise<T = void, P = unknown>(type: string, payload: P, options?: IMessengerEmitOptions): Promise<T>;
+    /**
+     * 注册回调，返回用于注销的方法
+     */
+    on(type: string, fn: () => void): TFnOff;
+    on<P = unknown>(type: string, fn: (payload: P) => void): TFnOff;
+    /**
+     * 注册单次回调，运行一次后将自动注销
+     */
+    once(type: string, fn: () => void): TFnOff;
+    once<P = unknown>(type: string, fn: (payload: P) => void): TFnOff;
+    /**
+     * 对 emitPromise 对应的 type 进行响应，这里关心的 payload 还是 emitPromise 所传入的 payload
+     */
+    onPromise<T = void>(type: string, fn: () => T | Promise<T>): TFnOff;
+    onPromise<T, P = unknown>(type: string, fn: (payload: P) => T | Promise<T>): TFnOff;
+    private getReceivers;
+    private addReceiver;
+    private removeReceiver;
+}

package/dist/types/types/index.d.ts

@@ -0,0 +1,33 @@
+export type TTargetWindow = Window | 'top' | 'parent';
+export interface IMessageData {
+    type: string;
+    payload: never;
+}
+export interface IMessengerEmitOptions {
+    targetWindow?: TTargetWindow;
+    targetOrigin?: string;
+}
+export type TMessengerCallback<P = unknown> = (payload: P) => void;
+export interface IMessengerReceiver<P = never> {
+    fn: TMessengerCallback<P>;
+    once?: boolean;
+}
+/**
+ * 为每个 MessageEvent.data 的 `type`，建立一个接收序列
+ */
+export type TMessengerReceiverMap = Record<string, IMessengerReceiver[]>;
+/**
+ * 以 Promise 的形式广播事件的时候的 payload 包裹
+ */
+export interface IMessengerPayloadPromise<P = void> {
+    _dismiss_: string;
+    payload: P;
+}
+/**
+ * `emitPromise` 和 `onPromise` 的纽带
+ */
+export interface IMessengerPayloadPromiseBack<T> {
+    value?: T;
+    error?: Record<string, unknown>;
+}
+export type TFnOff = () => void;

package/dist/types/util/build-payload-for-promise.d.ts

@@ -0,0 +1,2 @@
+import { IMessengerPayloadPromise } from '../types';
+export default function buildPayloadForPromise<P = unknown>(type: string, payload: P): IMessengerPayloadPromise<P>;

package/dist/types/util/error-to-plain.d.ts

@@ -0,0 +1,4 @@
+/**
+ * `postMessage` 不支持传 Error 对象
+ */
+export default function errorToPlain(err: unknown): Record<string, unknown>;

package/dist/types/util/get-target-window.d.ts

@@ -0,0 +1,2 @@
+import { TTargetWindow } from '../types';
+export default function getTargetWindow(targetWindow?: TTargetWindow): Window;

package/dist/types/util/index.d.ts

@@ -0,0 +1,4 @@
+export { default as getTargetWindow } from './get-target-window';
+export { default as buildPayloadForPromise } from './build-payload-for-promise';
+export { default as errorToPlain } from './error-to-plain';
+export { default as plainToError } from './plain-to-error';

package/dist/types/util/plain-to-error.d.ts

@@ -0,0 +1 @@
+export default function plainToError(o: Record<string, unknown>): Error;

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@kcuf/messenger",
+  "version": "0.0.1",
+  "description": "A simple and type safe post-message enhancement.",
+  "keywords": [
+    "postMessage",
+    "promise",
+    "emit",
+    "once",
+    "broadcast",
+    "subscribe"
+  ],
+  "license": "MIT",
+  "sideEffects": false,
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/justnewbee/kcuf.git"
+  },
+  "homepage": "https://github.com/justnewbee/kcuf/tree/main/packages-util/messenger",
+  "bugs": "https://github.com/justnewbee/kcuf/issues",
+  "author": {
+    "name": "Jianchun Wang",
+    "email": "justnewbee@gmail.com"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.28.6",
+    "@babel/core": "^7.28.6",
+    "@babel/plugin-transform-runtime": "^7.28.5",
+    "@babel/preset-env": "^7.28.6",
+    "@babel/preset-typescript": "^7.28.5",
+    "@types/lodash": "^4.17.23",
+    "@vitest/coverage-v8": "^4.0.18",
+    "jsdom": "^27.4.0",
+    "rimraf": "^6.1.2",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18",
+    "@kcuf/ts-config": "^0.1.0"
+  },
+  "peerDependencies": {
+    "@babel/runtime": ">=7.0.0"
+  },
+  "dependencies": {
+    "lodash": "^4.17.23",
+    "@kcuf/sandbox-escape": "^0.0.1"
+  },
+  "scripts": {
+    "build:clean": "rimraf dist",
+    "build:esm": "ESM=1 babel src -d dist/esm --extensions .ts,.tsx --source-maps",
+    "build:cjs": "ESM=0 babel src -d dist/cjs --extensions .ts,.tsx",
+    "build:types": "tsc -rootDir src --outDir dist/types --declaration --noEmit false --emitDeclarationOnly --isolatedModules false",
+    "build": "pnpm build:esm && pnpm build:cjs && pnpm build:types",
+    "watch": "pnpm build:esm -w",
+    "test": "vitest",
+    "test:cov": "vitest --coverage --coverage.include=src"
+  }
+}