@webkrafters/react-observable-context 4.0.0-alpha.1 → 4.0.0-alpha.3

package/dist/constants.d.ts

@@ -1 +1 @@
-/** @type {null} */
+/** @type {"@@STATE"} */

package/dist/constants.js

@@ -2,7 +2,10 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.DEFAULT_STATE_PATH = void 0;
-/** @type {null} */
-var DEFAULT_STATE_PATH = null;
-exports.DEFAULT_STATE_PATH = DEFAULT_STATE_PATH;
+exports.NULL_STATE_SELECTOR = exports.FULL_STATE_SELECTOR = void 0;
+/** @type {"@@STATE"} */
+var FULL_STATE_SELECTOR = '@@STATE';
+exports.FULL_STATE_SELECTOR = FULL_STATE_SELECTOR;
+/** @type {""} */
+var NULL_STATE_SELECTOR = '';
+exports.NULL_STATE_SELECTOR = NULL_STATE_SELECTOR;

package/dist/main/hooks/use-render-key-provider/index.d.ts

@@ -0,0 +1 @@
+export default useRenderKeyProvider;
    [selectorKey: string]: string | keyof T;
 * @type {Provider<T>}
 * @template {State} T
 */

package/dist/main/hooks/use-render-key-provider/index.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _react = require("react");
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _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(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0) { ; } } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i["return"] && (_r = _i["return"](), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+/**
 * @type {Provider<T>}
 * @template {State} T
 */
+var getCurrKeys = function getCurrKeys(selectorMap) {
+  var currKeys = Object.values(selectorMap);
+  return currKeys.length ? Array.from(new Set(currKeys)) : [];
+};
+/**
 * @type {Provider<T>}
 * @template {State} T
 */
+var useRenderKeyProvider = function useRenderKeyProvider(selectorMap) {
+  var _useState = (0, _react.useState)(function () {
+      return getCurrKeys(selectorMap);
+    }),
+    _useState2 = _slicedToArray(_useState, 2),
+    renderKeys = _useState2[0],
+    setRenderKeys = _useState2[1];
+  var currKeys = getCurrKeys(selectorMap);
+  (renderKeys.length !== currKeys.length || renderKeys.some(function (k, i) {
+    return k !== currKeys[i];
+  })) && setRenderKeys(currKeys);
+  return renderKeys;
+};
+var _default = useRenderKeyProvider;
+/**
 * @callback Provider
 * @param {{[selectorKey: string]: string|keyof T}} selectorMap Key:value pairs where `key` => arbitrary key given to Store.data property holding the state slices and `value` => property paths to state slices used by this component. May use `{..., state: '@@STATE'}` to indicate a desire to obtain the entire state object and assign to a `state` property of Store.data. A change in any of the referenced properties results in this component render. When using `['@@STATE']`, any change in the state object results in this component render.
 * @returns {[string|keyof T]} Property paths
 * @template {State} T
 */
+exports["default"] = _default;

package/dist/main/hooks/use-state-manager/index.d.ts

@@ -1 +1 @@
-export default useStateManager;
 * @param {T} initStateValue
 * @template {State} T
 */
    select: (clientId: string, ...propertyPaths?: string[]) => Readonly<import("../../../types").PartialState<T>>;
    state: T;
    stateWatch: Listener<T>;
    unlink: (clientId: string) => void;
+export default useStateManager;
 * @param {T} initStateValue
 * @template {State} T
 */
    select: (clientId: string, ...propertyPaths?: string[]) => {
        [propertyPaths: string]: Readonly<any>;
    };
    state: T;
    stateWatch: Listener<T>;
    unlink: (clientId: string) => void;

package/dist/main/hooks/use-store/index.d.ts

@@ -1 +1 @@
-export namespace deps {
    export { _setState as setState };
    export { v4 as uuid };
 * @param {Prehooks<T>} prehooks
 * @param {T} value
 * @param {IStorage<T>} [storage] Closed to modification post-initialization
 * @template {State} T
 */
    getState: (clientId: string, ...propertyPaths?: string[]) => Readonly<import("../../../types").PartialState<T>>;
    resetState: VoidFunction;
    setState: (changes: import("../../../types").PartialState<T>) => void;
    subscribe: (listener: import("../../../types").Listener<T>) => VoidFunction;
    unlinkCache: (clientId: string) => void;
+export namespace deps {
    export { _setState as setState };
    export { v4 as uuid };
 * @param {Prehooks<T>} prehooks
 * @param {T} value
 * @param {IStorage<T>} [storage] Closed to modification post-initialization
 * @template {State} T
 */
    getState: (clientId: string, ...propertyPaths?: string[]) => {
        [propertyPaths: string]: Readonly<any>;
    };
    resetState: VoidFunction;
    setState: (changes: import("../../../types").PartialState<T>) => void;
    subscribe: (listener: import("../../../types").Listener<T>) => VoidFunction;
    unlinkCache: (clientId: string) => void;

package/dist/main/hooks/use-store/index.js

@@ -53,9 +53,9 @@ var useStore = function useStore(prehooks, value, storage) {
     _useState4 = _slicedToArray(_useState3, 1),
     _storage = _useState4[0];
   /** @type {Listener<T>} */
-  var onChange = function onChange(state) {
+  var onChange = function onChange(changes) {
     return listeners.forEach(function (listener) {
-      return listener(state);
+      return listener(changes);
     });
   };
   /** @type {StoreInternal<T>["resetState"]} */

package/dist/main/index.d.ts

@@ -1 +1 @@
-export class UsageError extends Error {
    Provider: ObservableProvider<S>;
    children?: ReactNode;
    prehooks?: Prehooks<T>;
    storage?: IStorage<T>;
    value: PartialState<T>;
+export class UsageError extends Error {
    [selectorKey: string]: string | keyof T;
    Provider: ObservableProvider<S>;
    children?: ReactNode;
    prehooks?: Prehooks<T>;
    storage?: IStorage<T>;
    value: PartialState<T>;

package/dist/main/index.js

@@ -4,10 +4,11 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.useContext = exports.createContext = exports.UsageError = void 0;
 var _react = _interopRequireWildcard(require("react"));
-var _lodash = _interopRequireDefault(require("lodash.isequal"));
-var _lodash2 = _interopRequireDefault(require("lodash.omit"));
+var _lodash = _interopRequireDefault(require("lodash.isempty"));
+var _lodash2 = _interopRequireDefault(require("lodash.isequal"));
+var _lodash3 = _interopRequireDefault(require("lodash.omit"));
 var _uuid = require("uuid");
-var _useRenderKeysManager = _interopRequireDefault(require("./hooks/use-render-keys-manager"));
+var _useRenderKeyProvider = _interopRequireDefault(require("./hooks/use-render-key-provider"));
 var _useStore = _interopRequireDefault(require("./hooks/use-store"));
 var _excluded = ["getState", "subscribe", "unlinkCache"];
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
@@ -16,6 +17,7 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e2) { throw _e2; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e3) { didErr = true; err = _e3; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
 function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
 function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
 function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
@@ -64,7 +66,7 @@ var reportNonReactUsage = function reportNonReactUsage() {
 var ChildMemo = function () {
   var useNodeMemo = function useNodeMemo(node) {
     var nodeRef = (0, _react.useRef)(node);
-    if (!(0, _lodash["default"])((0, _lodash2["default"])(nodeRef.current, '_owner'), (0, _lodash2["default"])(node, '_owner'))) {
+    if (!(0, _lodash2["default"])((0, _lodash3["default"])(nodeRef.current, '_owner'), (0, _lodash3["default"])(node, '_owner'))) {
       nodeRef.current = node;
     }
     return nodeRef.current;
@@ -91,7 +93,7 @@ var memoizeImmediateChildTree = function memoizeImmediateChildTree(children) {
       return child;
     }
     if ((_child$props = child.props) !== null && _child$props !== void 0 && _child$props.children) {
-      child = (0, _react.cloneElement)(child, (0, _lodash2["default"])(child.props, 'children'), memoizeImmediateChildTree(child.props.children));
+      child = (0, _react.cloneElement)(child, (0, _lodash3["default"])(child.props, 'children'), memoizeImmediateChildTree(child.props.children));
     }
     return _react["default"].createElement(ChildMemo, {
       child: child
@@ -129,9 +131,9 @@ var createContext = function createContext() {
   return Context;
 };
 exports.createContext = createContext;
-/**
 * Actively monitors the store and triggers component re-render if any of the watched keys in the state objects changes
 *
 * @param {ObservableContext<T>} context Refers to the PublicObservableContext<T> type of the ObservableContext<T>
 * @param {Array<string|keyof T>} [renderKeys = []] a list of paths to state object properties used by this component: see examples below. May use `['@@STATE']` to indicate a desire to obtain the entire state object. A change in any of the referenced properties results in this component render. When using `['@@STATE']`, any change in the state object results in this component render.
 * @returns {Store<T>}
 * @template {State} T
 * @see {ObservableContext<T>}
 * @example
 * a valid renderKey follows the `lodash` object property path convention.
 * for a state = { a: 1, b: 2, c: 3, d: { e: 5, f: [6, { x: 7, y: 8, z: 9 } ] } }
 * Any of the following is a valid renderKey
 * 'a' => 1
 * 'd' => { e: 5, f: [6, { x: 7, y: 8, z: 9 } ] }
 * 'd.e' => 5
 * 'd.e.f => [6, { x: 7, y: 8, z: 9 } ]
 * 'd.e.f[0]' or 'd.e.f.0' => 6
 * 'd.e.f[1]' or 'd.e.f.1' => { x: 7, y: 8, z: 9 }
 * 'd.e.f[1].x' or 'd.e.f.1.x' => 7
 * '@@STATE' => state
 */
+/**
 * Actively monitors the store and triggers component re-render if any of the watched keys in the state objects changes
 *
 * @param {ObservableContext<T>} context Refers to the PublicObservableContext<T> type of the ObservableContext<T>
 * @param {{[selectorKey: string]: string|keyof T}} [selectorMap = {}] Key:value pairs where `key` => arbitrary key given to Store.data property holding the state slices and `value` => property paths to state slices used by this component: see examples below. May use `{..., state: '@@STATE'}` to indicate a desire to obtain the entire state object and assign to a `state` property of Store.data. A change in any of the referenced properties results in this component render. When using `['@@STATE']`, any change in the state object results in this component render.
 * @returns {Store<T>}
 * @template {State} T
 * @see {ObservableContext<T>}
 * @example
 * a valid propertyPath follows the `lodash` object property path convention.
 * for a state = { a: 1, b: 2, c: 3, d: { e: 5, f: [6, { x: 7, y: 8, z: 9 } ] } }
 * Any of the following is an applicable selector map.
 * {count: 'a', myData: 'd'} => {count: 1, myData: { e: 5, f: [6, { x: 7, y: 8, z: 9 } ] }}
 * {count: 'a'} => {count: 1}
 * {myData: 'd'} => {mydata: { e: 5, f: [6, { x: 7, y: 8, z: 9 } ] }}
 * {xyz: 'd.e'} => {xyz: 5}
 * {def: 'd.e.f'} => {def: [6, { x: 7, y: 8, z: 9 } ]}
 * {f1: 'd.e.f[0]'} or {f1: 'd.e.f.0'} => {f1: 6}
 * {secondFElement: 'd.e.f[1]'} or {secondFElement: 'd.e.f.1'} => {secondFElement: { x: 7, y: 8, z: 9 }}
 * {myX: 'd.e.f[1].x'} or {myX: 'd.e.f.1.x'} => {myX: 7}
 * {myData: '@@STATE'} => {myData: state}
 */
 var useContext = function useContext(context) {
-  var renderKeys = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+  var selectorMap = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   /** @type {StoreInternal<T>} */
   var _useContext2 = (0, _react.useContext)(context),
     _getState = _useContext2.getState,
@@ -141,28 +143,80 @@ var useContext = function useContext(context) {
   var _useState = (0, _react.useState)(_uuid.v4),
     _useState2 = _slicedToArray(_useState, 1),
     clientId = _useState2[0];
-  var _renderKeys = (0, _useRenderKeysManager["default"])(renderKeys);
-  /** @returns {Readonly<PartialState<T>>} */
-  var getState = function getState() {
-    return _getState.apply(void 0, [clientId].concat(_toConsumableArray(_renderKeys)));
-  };
-  var _useState3 = (0, _react.useState)(getState),
+  var _renderKeys = (0, _useRenderKeyProvider["default"])(selectorMap);
+  /** @type {{[propertyPath: string]: string}} Reversed selectorMap i.e. {selectorKey: propertyPath} => {propertyPath: selectorKey} */
+  var path2SelectorMap = (0, _react.useMemo)(function () {
+    var map = {};
+    if ((0, _lodash["default"])(_renderKeys)) {
+      return map;
+    }
+    ;
+    for (var selectorKey in selectorMap) {
+      map[selectorMap[selectorKey]] = selectorKey;
+    }
+    return map;
+  }, [_renderKeys]);
+  /** @type {[Data, Function]} */
+  var _useState3 = (0, _react.useState)(function () {
+      var data = {};
+      if ((0, _lodash["default"])(_renderKeys)) {
+        return data;
+      }
+      var state = _getState.apply(void 0, [clientId].concat(_toConsumableArray(_renderKeys)));
+      var _iterator = _createForOfIteratorHelper(_renderKeys),
+        _step;
+      try {
+        for (_iterator.s(); !(_step = _iterator.n()).done;) {
+          var path = _step.value;
+          data[path2SelectorMap[path]] = state[path];
+        }
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+      return data;
+    }),
     _useState4 = _slicedToArray(_useState3, 2),
     data = _useState4[0],
     setData = _useState4[1];
-  (0, _react.useMemo)(function () {
-    return setData(getState());
-  }, [_renderKeys]);
-  (0, _react.useEffect)(function () {
-    return subscribe(function () {
-      return setData(getState());
-    });
-  }, [_renderKeys]);
+  var updateData = function updateData() {
+    var hasChanges = false;
+    var state = _getState.apply(void 0, [clientId].concat(_toConsumableArray(_renderKeys)));
+    var _iterator2 = _createForOfIteratorHelper(_renderKeys),
+      _step2;
+    try {
+      for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+        var path = _step2.value;
+        if (data[path2SelectorMap[path]] !== state[path]) {
+          data[path2SelectorMap[path]] = state[path];
+          hasChanges = true;
+        }
+      }
+    } catch (err) {
+      _iterator2.e(err);
+    } finally {
+      _iterator2.f();
+    }
+    hasChanges && setData(_objectSpread({}, data));
+  };
   (0, _react.useEffect)(function () {
+    if ((0, _lodash["default"])(_renderKeys)) {
+      !(0, _lodash2["default"])({}, data) && setData({});
+      return;
+    }
+    for (var selectorKey in data) {
+      if (!(selectorMap[selectorKey] in path2SelectorMap)) {
+        delete data[selectorKey];
+      }
+    }
+    var unsubscribe = subscribe(updateData);
+    updateData();
     return function () {
-      return unlinkCache(clientId);
+      unsubscribe();
+      unlinkCache(clientId);
     };
-  }, []);
+  }, [_renderKeys]);
   return (0, _react.useMemo)(function () {
     return _objectSpread({
       data: data

package/dist/main/set-state/index.js

@@ -97,7 +97,7 @@ function setState(state, newState, onStateChange) {
     hasChanges: false
   };
   set(state, newState, stats);
-  stats.hasChanges && (onStateChange === null || onStateChange === void 0 ? void 0 : onStateChange(state));
+  stats.hasChanges && (onStateChange === null || onStateChange === void 0 ? void 0 : onStateChange(newState));
 }
 ;
 var _default = setState;

package/dist/model/accessor/index.d.ts

@@ -1 +1 @@
-export default Accessor;
    static "__#5@#NUM_INSTANCES": number;
    /**
     * @param {T} source State object reference from which the accessedPropertyPaths are to be selected.
     * @param {Array<string>} accessedPropertyPaths
     */
    constructor(source: T, accessedPropertyPaths: Array<string>);
    /** @type {boolean} */
    refreshDue: boolean;
    get numClients(): number;
    get id(): number;
    get paths(): string[];
    get value(): Readonly<import("../../types").PartialState<T>>;
    /** @param {string} clientId */
    addClient(clientId: string): void;
    hasClient(clientId: string): boolean;
    removeClient(clientId: string): boolean;
    /**
     * @param {{[propertyPath: string]: Atom}} atoms Curated slices of state currently requested
     * @returns {Readonly<PartialState<State>>}
     */
    refreshValue(atoms: {
        [propertyPath: string]: import("../atom").default;
    }): Readonly<PartialState<State>>;
    #private;
+export default Accessor;
    static "__#5@#NUM_INSTANCES": number;
    /**
     * @param {T} source State object reference from which the accessedPropertyPaths are to be selected.
     * @param {Array<string>} accessedPropertyPaths
     */
    constructor(source: T, accessedPropertyPaths: Array<string>);
    /** @type {Array<string>} */
    outdatedPaths: Array<string>;
    get numClients(): number;
    get id(): number;
    get paths(): string[];
    get value(): {
        [propertyPath: string]: Readonly<any>;
    };
    /** @param {string} clientId */
    addClient(clientId: string): void;
    hasClient(clientId: string): boolean;
    removeClient(clientId: string): boolean;
    /**
     * @param {{[propertyPath: string]: Atom<*>}} atoms Curated slices of state currently requested
     * @returns {{[propertyPath: string]: Readonly<*>}}
     */
    refreshValue(atoms: {
        [propertyPath: string]: import("../atom").default<any>;
    }): {
        [propertyPath: string]: Readonly<any>;
    };
    #private;