@enact/limestone 1.3.0

package/internal/SharedStateDecorator/SharedStateDecorator.js

@@ -0,0 +1,167 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = exports.SharedStateDecorator = exports.SharedState = void 0;
+var _hoc = _interopRequireDefault(require("@enact/core/hoc"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _react = require("react");
+var _jsxRuntime = require("react/jsx-runtime");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _objectDestructuringEmpty(t) { if (null == t) throw new TypeError("Cannot destructure " + t); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
+function _possibleConstructorReturn(t, e) { if (e && ("object" == typeof e || "function" == typeof e)) return e; if (void 0 !== e) throw new TypeError("Derived constructors may only return object or undefined"); return _assertThisInitialized(t); }
+function _assertThisInitialized(e) { if (void 0 === e) throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); return e; }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+function _getPrototypeOf(t) { return _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function (t) { return t.__proto__ || Object.getPrototypeOf(t); }, _getPrototypeOf(t); }
+function _inherits(t, e) { if ("function" != typeof e && null !== e) throw new TypeError("Super expression must either be null or a function"); t.prototype = Object.create(e && e.prototype, { constructor: { value: t, writable: !0, configurable: !0 } }), Object.defineProperty(t, "prototype", { writable: !1 }), e && _setPrototypeOf(t, e); }
+function _setPrototypeOf(t, e) { return _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function (t, e) { return t.__proto__ = e, t; }, _setPrototypeOf(t, e); }
+var SharedState = exports.SharedState = /*#__PURE__*/(0, _react.createContext)(null);
+var defaultConfig = {
+  idProp: 'id',
+  updateOnMount: false
+};
+
+/**
+ * Adds shared state to a component.
+ *
+ * The purpose of shared state is to store framework component state at significant container
+ * boundaries in order to restore it when the "same" component is mounted later.
+ *
+ * "Sameness" is determined by the `idProp` config member (defaults to "id"). If multiple
+ * descendants have the same `idProp` within the subtree, SharedStateDecorator will not distinguish
+ * between them and will allow each to read from and write over each other's data.
+ *
+ * For example, Panels and Panel are considered "significant container boundaries" since they are
+ * key building blocks for limestone applications. When components are rendered within a Panel, we
+ * may want to store those components state on unmount so that we can restore it when returning to
+ * the panel. Panel can (and does) use SharedStateDecorator to establish a shared state which can be
+ * used by contained components.
+ *
+ * It's important to note that SharedStateDecorator doesn't prescribe how or what is stored nor how
+ * the data is managed. That is left to the consuming component to determine. Also, unlike React
+ * state or third-party state management solutions like Redux, updating shared state will not
+ * initiate an update cycle in React. The intent is only to restore state on mount.
+ *
+ * If shared state is used in the render method for a component, it may be necessary to use the
+ * `updateOnMount` config member which will initiate an update cycle within React once the data is
+ * available from an upstream shared state.
+ *
+ * @hoc
+ * @private
+ */
+var SharedStateDecorator = exports.SharedStateDecorator = (0, _hoc["default"])(defaultConfig, function (config, Wrapped) {
+  var _Class;
+  var idProp = config.idProp,
+    updateOnMount = config.updateOnMount;
+  return _Class = /*#__PURE__*/function (_Component) {
+    function _Class(props) {
+      var _this;
+      _classCallCheck(this, _Class);
+      _this = _callSuper(this, _Class, [props]);
+      _this.data = {};
+      _this.sharedState = _this.initSharedState();
+      _this.state = {
+        updateOnMount: false
+      };
+      return _this;
+    }
+    _inherits(_Class, _Component);
+    return _createClass(_Class, [{
+      key: "componentDidMount",
+      value: function componentDidMount() {
+        this.loadFromContext();
+      }
+    }, {
+      key: "componentDidUpdate",
+      value: function componentDidUpdate(prevProps) {
+        if (!prevProps.noSharedState && this.props.noSharedState) {
+          this.data = {};
+        } else if (prevProps.noSharedState && !this.props.noSharedState) {
+          this.loadFromContext();
+        }
+      }
+    }, {
+      key: "isUpdateable",
+      value: function isUpdateable() {
+        var _this$props = this.props,
+          id = _this$props[idProp],
+          noSharedState = _this$props.noSharedState;
+        return !noSharedState && (id || id === 0);
+      }
+    }, {
+      key: "initSharedState",
+      value: function initSharedState() {
+        var _this2 = this;
+        return {
+          set: function set(key, value) {
+            var id = _this2.props[idProp];
+            if (_this2.isUpdateable()) {
+              _this2.data[id] = _this2.data[id] || {};
+              _this2.data[id][key] = value;
+            }
+          },
+          get: function get(key) {
+            var id = _this2.props[idProp];
+            return _this2.isUpdateable() && _this2.data[id] ? _this2.data[id][key] : null;
+          },
+          "delete": function _delete(key) {
+            var id = _this2.props[idProp];
+            if (_this2.isUpdateable() && _this2.data[id]) {
+              delete _this2.data[id][key];
+            }
+          }
+        };
+      }
+    }, {
+      key: "loadFromContext",
+      value: function loadFromContext() {
+        var _this$props2 = this.props,
+          id = _this$props2[idProp],
+          noSharedState = _this$props2.noSharedState;
+        if (!noSharedState && this.context && this.context.get) {
+          var data = this.context.get(id);
+          if (data) {
+            this.data = data;
+          } else {
+            this.context.set(id, this.data);
+          }
+          if (updateOnMount) {
+            this.setState({
+              updateOnMount: true
+            });
+          }
+        }
+      }
+    }, {
+      key: "render",
+      value: function render() {
+        var props = Object.assign({}, (_objectDestructuringEmpty(this.props), this.props));
+        delete props.noSharedState;
+        return /*#__PURE__*/(0, _jsxRuntime.jsx)(SharedState, {
+          value: this.sharedState,
+          children: /*#__PURE__*/(0, _jsxRuntime.jsx)(Wrapped, _objectSpread({}, props))
+        });
+      }
+    }]);
+  }(_react.Component), _Class.displayName = 'SharedStateDecorator', _Class.contextType = SharedState, _Class.propTypes = {
+    /**
+     * Prevents the component from setting or restoring any framework shared state.
+     *
+     * @type {Boolean}
+     * @default false
+     * @public
+     */
+    noSharedState: _propTypes["default"].bool
+  }, _Class;
+});
+var _default = exports["default"] = SharedStateDecorator;

package/internal/SharedStateDecorator/package.json

@@ -0,0 +1,3 @@
+{
+    "main": "SharedStateDecorator.js"
+}

package/internal/SharedStateDecorator/tests/SharedStateDecorator-specs.js

@@ -0,0 +1,277 @@
+"use strict";
+
+require("@testing-library/jest-dom");
+var _react = require("@testing-library/react");
+var _react2 = require("react");
+var _SharedStateDecorator = _interopRequireWildcard(require("../SharedStateDecorator"));
+var _jsxRuntime = require("react/jsx-runtime");
+var _excluded = ["children"],
+  _excluded2 = ["children", "value"];
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, "default": e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
+function _possibleConstructorReturn(t, e) { if (e && ("object" == typeof e || "function" == typeof e)) return e; if (void 0 !== e) throw new TypeError("Derived constructors may only return object or undefined"); return _assertThisInitialized(t); }
+function _assertThisInitialized(e) { if (void 0 === e) throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); return e; }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+function _getPrototypeOf(t) { return _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function (t) { return t.__proto__ || Object.getPrototypeOf(t); }, _getPrototypeOf(t); }
+function _inherits(t, e) { if ("function" != typeof e && null !== e) throw new TypeError("Super expression must either be null or a function"); t.prototype = Object.create(e && e.prototype, { constructor: { value: t, writable: !0, configurable: !0 } }), Object.defineProperty(t, "prototype", { writable: !1 }), e && _setPrototypeOf(t, e); }
+function _setPrototypeOf(t, e) { return _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function (t, e) { return t.__proto__ = e, t; }, _setPrototypeOf(t, e); }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
+function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
+describe('SharedStateDecorator Specs', function () {
+  test('should provide a set method via context', function () {
+    var fn = jest.fn();
+    var ComponentSet = (0, _SharedStateDecorator["default"])(function () {
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_SharedStateDecorator.SharedState.Consumer, {
+        children: function children(value) {
+          fn(value.set);
+          return null;
+        }
+      });
+    });
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(ComponentSet, {}));
+    var expected = 'function';
+    var actual = typeof fn.mock.calls[0][0];
+    expect(actual).toBe(expected);
+  });
+  test('should provide a get method via context', function () {
+    var fn = jest.fn();
+    var ComponentGet = (0, _SharedStateDecorator["default"])(function () {
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_SharedStateDecorator.SharedState.Consumer, {
+        children: function children(value) {
+          fn(value.get);
+          return null;
+        }
+      });
+    });
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(ComponentGet, {}));
+    var expected = 'function';
+    var actual = typeof fn.mock.calls[0][0];
+    expect(actual).toBe(expected);
+  });
+  test('should provide a delete method via context', function () {
+    var fn = jest.fn();
+    var ComponentDelete = (0, _SharedStateDecorator["default"])(function () {
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_SharedStateDecorator.SharedState.Consumer, {
+        children: function children(value) {
+          fn(value["delete"]);
+          return null;
+        }
+      });
+    });
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(ComponentDelete, {}));
+    var expected = 'function';
+    var actual = typeof fn.mock.calls[0][0];
+    expect(actual).toBe(expected);
+  });
+  test('should supporting setting and getting a value by key when {id} is set', function () {
+    var Component = (0, _SharedStateDecorator["default"])(function () {
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_SharedStateDecorator.SharedState.Consumer, {
+        children: function children(value) {
+          value.set('key', 'value');
+          return value.get('key');
+        }
+      });
+    });
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(Component, {
+      id: "outer"
+    }));
+    var actual = _react.screen.getByText('value');
+    expect(actual).toBeInTheDocument();
+  });
+  test('should supporting setting and getting a value by key when {id} is set to a non-zero value', function () {
+    var Component = (0, _SharedStateDecorator["default"])(function () {
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_SharedStateDecorator.SharedState.Consumer, {
+        children: function children(value) {
+          value.set('key', 'value');
+          return value.get('key');
+        }
+      });
+    });
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(Component, {
+      id: -1
+    }));
+    var actual = _react.screen.getByText('value');
+    expect(actual).toBeInTheDocument();
+  });
+  test('should supporting setting and getting a value by key when {id} is set to zero', function () {
+    var Component = (0, _SharedStateDecorator["default"])(function () {
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_SharedStateDecorator.SharedState.Consumer, {
+        children: function children(value) {
+          value.set('key', 'value');
+          return value.get('key');
+        }
+      });
+    });
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(Component, {
+      id: 0
+    }));
+    var actual = _react.screen.getByText('value');
+    expect(actual).toBeInTheDocument();
+  });
+  test('should not set or return values when {id} is not set', function () {
+    var Component = (0, _SharedStateDecorator["default"])(function () {
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_SharedStateDecorator.SharedState.Consumer, {
+        children: function children(value) {
+          value.set('key', 'value');
+          return value.get('key');
+        }
+      });
+    });
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(Component, {}));
+    var actual = _react.screen.queryByText('value');
+    expect(actual).toBeNull();
+  });
+  test('should not set or return values when {id} is set to an empty string', function () {
+    var Component = (0, _SharedStateDecorator["default"])(function () {
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_SharedStateDecorator.SharedState.Consumer, {
+        children: function children(value) {
+          value.set('key', 'value');
+          return value.get('key');
+        }
+      });
+    });
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(Component, {
+      id: ""
+    }));
+    var actual = _react.screen.queryByText('value');
+    expect(actual).toBeNull();
+  });
+  test('should not set or return values when {id} is set to null', function () {
+    var Component = (0, _SharedStateDecorator["default"])(function () {
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_SharedStateDecorator.SharedState.Consumer, {
+        children: function children(value) {
+          value.set('key', 'value');
+          return value.get('key');
+        }
+      });
+    });
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(Component, {
+      id: null
+    }));
+    var actual = _react.screen.queryByText('value');
+    expect(actual).toBeNull();
+  });
+  test('should not set or return values when {id} and {noSharedState} are set', function () {
+    var Component = (0, _SharedStateDecorator["default"])(function () {
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_SharedStateDecorator.SharedState.Consumer, {
+        children: function children(value) {
+          value.set('key', 'value');
+          return value.get('key');
+        }
+      });
+    });
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(Component, {
+      id: "outer",
+      noSharedState: true
+    }));
+    var actual = _react.screen.queryByText('value');
+    expect(actual).toBeNull();
+  });
+  test('should supporting deleting a value by key when {id} is set', function () {
+    var Component = (0, _SharedStateDecorator["default"])(function () {
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_SharedStateDecorator.SharedState.Consumer, {
+        children: function children(value) {
+          value.set('key', 'value');
+          value["delete"]('key');
+          return value.get('key');
+        }
+      });
+    });
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(Component, {
+      id: "outer"
+    }));
+    var actual = _react.screen.queryByText('value');
+    expect(actual).toBeNull();
+  });
+  test('should share data upstream when inside another SharedStateDecorator', function () {
+    var Component = (0, _SharedStateDecorator["default"])(function (_ref) {
+      var _children = _ref.children,
+        rest = _objectWithoutProperties(_ref, _excluded);
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_SharedStateDecorator.SharedState.Consumer, {
+        children: function children(value) {
+          value.set('key', 'value');
+          return /*#__PURE__*/(0, _jsxRuntime.jsxs)("div", _objectSpread(_objectSpread({}, rest), {}, {
+            children: [/*#__PURE__*/(0, _jsxRuntime.jsx)("span", {
+              children: value.get('key')
+            }), _children]
+          }));
+        }
+      });
+    });
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(Component, {
+      id: "outer",
+      children: /*#__PURE__*/(0, _jsxRuntime.jsx)(Component, {
+        id: "inner"
+      })
+    }));
+    var expected = '<div id="outer"><span>value</span><div id="inner"><span>value</span></div></div>';
+    var actual = _react.screen.getAllByText('value')[0].parentElement.parentElement.innerHTML;
+    expect(actual).toEqual(expected);
+  });
+  test('should restore shared state from ancestor', function () {
+    var Base = /*#__PURE__*/function (_ReactComponent) {
+      function Base() {
+        _classCallCheck(this, Base);
+        return _callSuper(this, Base, arguments);
+      }
+      _inherits(Base, _ReactComponent);
+      return _createClass(Base, [{
+        key: "render",
+        value: function render() {
+          var _this$props = this.props,
+            children = _this$props.children,
+            propValue = _this$props.value,
+            rest = _objectWithoutProperties(_this$props, _excluded2);
+          if (propValue) {
+            this.context.set('key', propValue);
+          }
+          return /*#__PURE__*/(0, _jsxRuntime.jsxs)("div", _objectSpread(_objectSpread({}, rest), {}, {
+            children: [/*#__PURE__*/(0, _jsxRuntime.jsx)("span", {
+              children: this.context.get('key')
+            }), children]
+          }));
+        }
+      }]);
+    }(_react2.Component);
+    Base.contextType = _SharedStateDecorator.SharedState;
+    var Component = (0, _SharedStateDecorator["default"])({
+      updateOnMount: true
+    }, Base);
+    var _render = (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(Component, {
+        id: "outer",
+        value: "value",
+        children: /*#__PURE__*/(0, _jsxRuntime.jsx)(Component, {
+          id: "inner",
+          value: "from-prop"
+        })
+      })),
+      rerender = _render.rerender;
+
+    // remove the children which drops inner's shared state
+    rerender(/*#__PURE__*/(0, _jsxRuntime.jsx)(Component, {
+      id: "outer",
+      value: "value"
+    }));
+
+    // recreate it with the same id but no initial value to validate the previous state is
+    // restored. updateOnMount is used above to coerce a re-render on mount since the shared
+    // state value is used in the render method and isn't available on first render otherwise.
+    rerender(/*#__PURE__*/(0, _jsxRuntime.jsx)(Component, {
+      id: "outer",
+      value: "value",
+      children: /*#__PURE__*/(0, _jsxRuntime.jsx)(Component, {
+        id: "inner"
+      })
+    }));
+    var actual = _react.screen.getByText('from-prop');
+    expect(actual).toBeInTheDocument();
+  });
+});

package/internal/WindowEventable/WindowEventable.js

@@ -0,0 +1,114 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _hoc = _interopRequireDefault(require("@enact/core/hoc"));
+var _handle = require("@enact/core/handle");
+var _dispatcher = require("@enact/core/dispatcher");
+var _react = require("react");
+var _jsxRuntime = require("react/jsx-runtime");
+var _excluded = ["globalNode"]; //
+// WindowEventable (Eventful?)
+//
+// DEV NOTE: These docs are just plain docs since this component is still under consideration for
+// inclusion outside Input's specific use-case. True jsDoc comments will be added at a later time.
+//
+/*
+ * Easily create and add events to the window, document, or other global node.
+ *
+ * This accepts an arbitrary number of events, in either function or string (referring to an
+ * incoming prop) as the callback values.
+ *
+ * It is recommended to use {@link core/handle} to maintain a consistent event callback signature.
+ */
+/*
+ * Use the `globalNode` key in the config to change which node the relevant events are attached to.
+ */
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
+function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
+function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
+function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
+var defaultConfig = {
+  globalNode: 'window'
+};
+
+// In config, extract all the config stuff we know about. Everything else is an event.
+var WindowEventable = (0, _hoc["default"])(defaultConfig, function (_ref, Wrapped) {
+  var globalNode = _ref.globalNode,
+    events = _objectWithoutProperties(_ref, _excluded);
+  // eslint-disable-next-line no-shadow
+  var WindowEventable = function WindowEventable(props) {
+    (0, _react.useEffect)(function () {
+      switch (globalNode) {
+        case 'window':
+          globalNode = window;
+          break;
+        case 'document':
+          globalNode = document;
+          break;
+      }
+      var localEvents = {};
+      var _loop = function _loop() {
+        var _Object$entries$_i = _slicedToArray(_Object$entries[_i], 2),
+          eventName = _Object$entries$_i[0],
+          fn = _Object$entries$_i[1];
+        // Tailored event names (convert from React style to browser style naming)
+        if (eventName.indexOf('on') === 0) {
+          eventName = eventName.substring(2).toLowerCase();
+        }
+        if (typeof fn === 'function') {
+          // Support functions passed directly into the config
+          localEvents[eventName] = (0, _handle.handle)(function (eventPayload) {
+            return fn(eventPayload, props);
+          });
+        } else if (typeof fn === 'string') {
+          // Support strings, representing a callback in the props list
+          localEvents[eventName] = (0, _handle.handle)((0, _handle.forward)(fn, props));
+        }
+      };
+      for (var _i = 0, _Object$entries = Object.entries(events); _i < _Object$entries.length; _i++) {
+        _loop();
+      }
+      if (typeof globalNode === 'object') {
+        for (var _i2 = 0, _Object$entries2 = Object.entries(localEvents); _i2 < _Object$entries2.length; _i2++) {
+          var _Object$entries2$_i = _slicedToArray(_Object$entries2[_i2], 2),
+            eventName = _Object$entries2$_i[0],
+            fn = _Object$entries2$_i[1];
+          (0, _dispatcher.on)(eventName, fn, globalNode);
+        }
+      }
+      return function () {
+        if (typeof globalNode === 'object') {
+          for (var _i3 = 0, _Object$entries3 = Object.entries(localEvents); _i3 < _Object$entries3.length; _i3++) {
+            var _Object$entries3$_i = _slicedToArray(_Object$entries3[_i3], 2),
+              _eventName = _Object$entries3$_i[0],
+              _fn = _Object$entries3$_i[1];
+            (0, _dispatcher.off)(_eventName, _fn, globalNode);
+          }
+        }
+      };
+    }, []); // eslint-disable-line react-hooks/exhaustive-deps
+
+    var rest = Object.assign({}, props);
+    for (var _i4 = 0, _Object$keys = Object.keys(events); _i4 < _Object$keys.length; _i4++) {
+      var eventName = _Object$keys[_i4];
+      delete rest[eventName];
+    }
+    return /*#__PURE__*/(0, _jsxRuntime.jsx)(Wrapped, _objectSpread({}, rest));
+  };
+  WindowEventable.displayName = 'WindowEventable';
+  return WindowEventable;
+});
+var _default = exports["default"] = WindowEventable;

package/internal/WindowEventable/package.json

@@ -0,0 +1,3 @@
+{
+	"main": "WindowEventable.js"
+}

package/internal/util/package.json

@@ -0,0 +1,3 @@
+{
+	"main": "util.js"
+}

package/internal/util/util.js

@@ -0,0 +1,79 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.onlyUpdateForProps = exports.extractVoiceProps = exports.compareChildren = void 0;
+var _equals = _interopRequireDefault(require("ramda/src/equals"));
+var _react = require("react");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+/**
+ * Removes voice control related props from `props` and returns them in a new object.
+ *
+ * @function
+ * @param   {Object}    props    Props object
+ *
+ * @returns {Object}             voice control related props
+ * @memberof limestone/internal/util
+ * @private
+ */
+var extractVoiceProps = exports.extractVoiceProps = function extractVoiceProps(props) {
+  var obj = {};
+  Object.keys(props).forEach(function (key) {
+    if (key.indexOf('data-webos-voice-') === 0) {
+      obj[key] = props[key];
+      delete props[key];
+    }
+  });
+  return obj;
+};
+
+/**
+ * Compares two children and returns true if they are equivalent, false otherwise.
+ *
+ * @function
+ * @param   {children}    a    children props
+*  @param   {children}    b    children props
+ *
+ * @returns {Boolean}          `true` if same
+ * @memberof limestone/internal/util
+ * @private
+ */
+var compareChildren = exports.compareChildren = function compareChildren(a, b) {
+  if (!a || !b || a.length !== b.length) return false;
+  var type = null;
+  for (var i = 0; i < a.length; i++) {
+    type = type || typeof a[i];
+    if (type === 'string') {
+      if (a[i] !== b[i]) {
+        return false;
+      }
+    } else if (!(0, _equals["default"])(a[i], b[i])) {
+      return false;
+    }
+  }
+  return true;
+};
+
+/**
+ * Updates component only when given props are not shallowly equivalent, not updating otherwise.
+ *
+ * @function
+ * @param   {any}    wrapped    A component
+*  @param   {Array}  propKeys   Prop keys to compare
+ *
+ * @returns {any}               Conditionally memoized component
+ * @memberof limestone/internal/util
+ * @private
+ */
+var onlyUpdateForProps = exports.onlyUpdateForProps = function onlyUpdateForProps(wrapped, propKeys) {
+  return /*#__PURE__*/(0, _react.memo)(wrapped, function (prevProps, nextProps) {
+    var hasOwn = Object.prototype.hasOwnProperty;
+    if (Array.isArray(propKeys)) {
+      return propKeys.every(function (key) {
+        return hasOwn.call(prevProps, key) && hasOwn.call(nextProps, key) && Object.is(prevProps[key], nextProps[key]);
+      });
+    }
+    return false;
+  });
+};

package/internal/validators/package.json

@@ -0,0 +1,4 @@
+{
+	"main": "validators.js"
+}
+