@webkrafters/react-observable-context 4.0.0 → 4.1.0-alpha.0

package/README.md

@@ -207,6 +207,198 @@ store.setState({ ...state, a: { ...state.a, b: [ { ...first, y: 30 }, 22, ...res
 // Refrain from doing this, please!
 ```
 
+<h3 id="setstate-tags"><b><i><u>Rewriting state using tag commands</u></i></b></h3>
+By default setState merges new changes into the current state slices. To overwrite current state slices with new state values, <b>7</b> tag commands have been provided for:
+<ol>
+	<li><span style="margin-left: 10px"><b><code>@@CLEAR:</code></b> setting state slice to its corresponding empty value</span></li>
+	<li><span style="margin-left: 10px"><b><code>@@DELETE:</code></b> deleting properties</span></li>
+	<li><span style="margin-left: 10px"><b><code>@@MOVE:</code></b> moving array elements</span></li>
+	<li><span style="margin-left: 10px"><b><code>@@PUSH:</code></b> pushing new items into an array</span></li>
+	<li><span style="margin-left: 10px"><b><code>@@REPLACE:</code></b> replacing property values</span></li>
+	<li><span style="margin-left: 10px"><b><code>@@SET:</code></b> setting property values</span></li>
+	<li><span style="margin-left: 10px"><b><code>@@SPLICE:</code></b> splicing array items</span></li>
+</ol>
+<strong>Examples:</strong>
+
+<b><code>@@CLEAR:</code></b> <i>takes no arguments.</i>
+
+```jsx
+const state = {
+	a: { b: [{ x: 7, y: 8, z: 9 }, { x: 17, y: 18, z: 19 }] },
+	j: 10
+};
+
+store.setState( '@@CLEAR' ) // or store.setState({ @@CLEAR: <anything> })
+
+/* empties the value at state.a.b; sets state.a.b = [] */
+store.setState({ a: { b: '@@CLEAR' } }) // or store.setState({ a: { b: { @@CLEAR: <anything> } } })
+
+/* empties the value at state.a.j; sets state.a.j = null */
+store.setState({ a: { j: '@@CLEAR' } }) // or store.setState({ a: { j: { @@CLEAR: <anything> } } })
+
+/* empties the value at state.a.b[ 0 ]; sets state.a.b = [{}] */
+store.setState({ a: { b: [ '@@CLEAR' ] } }) // or store.setState({ a: { b: [ { @@CLEAR: <anything> } ] } })
+
+/* empties the value at state.a.b[0]; sets state.a.b = [{}, state.a.b[1]] */
+store.setState({ a: { b: [ '@@CLEAR', state.a.b[1] ] } }) // or store.setState({ a: { b: [ { @@CLEAR: <anything> }, state.a.b[1] ] } })
+
+/* empties the value at state.a.b[0]; sets state.a.b = [{}, a.b[1]] using indexing (RECOMMENDED) */
+store.setState({ a: { b: { 0: '@@CLEAR' } } }) // or store.setState({ a: { b: { 0: { @@CLEAR: <anything> } } } })
+```
+
+<b><code>@@DELETE:</code></b> <i>takes an array argument listing property keys to delete.</i>
+
+```jsx
+const state = {
+	a: { b: [{ x: 7, y: 8, z: 9 }, { x: 17, y: 18, z: 19 }] },
+	j: 10
+};
+
+store.setState({ '@@DELETE': [ 'a' ] }) // removes state.a; sets state = {j: 10}
+
+store.setState({ a: { '@@DELETE': [ 'b' ] } }) // removes state.a.b; sets state.a = {}
+
+/* removes state.a.b[0]; leaving state.a.b = [{ x: 17, y: 18, z: 19 }] */
+store.setState({ a: { b: { '@@DELETE': [ 0 ] } } }) // or store.setState({ a: { b: { '@@DELETE': [ -2 ] } } })
+
+/* removes `x` and `z` properties from state.a.b[1]; sets state.a.b = [{ x: 7, y: 8, z: 9 }, {y: 18}] */
+store.setState({ a: { b: [ state.a.b[ 0 ], { '@@DELETE': [ 'x', 'z' ] } ] } })
+
+/* removes `x` and `z` properties from state.a.b[1]; sets state.a.b = [{ x: 7, y: 8, z: 9 }, {y: 18}] using indexing (RECOMMENDED) */
+store.setState({ a: { b: { 1: { '@@DELETE': [ 'x', 'z' ] } } } })
+```
+
+<b><code>@@MOVE:</code></b> <i>takes an array argument listing: -/+fromIndex, -/+toIndex and optional +numItems?. numItems = 1 by default. </i>
+
+```jsx
+const state = {
+	a: { b: [{ x: 7, y: 8, z: 9 }, { x: 17, y: 18, z: 19 }] },
+	j: 10,
+	q: [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ]
+};
+
+store.setState({ a: { '@@MOVE': [ 0, 1 ] } }) // assigning a @@MOVE command to a non-array property has no effect.
+
+/* moves state.a.b[0] into index 1; leaving state.a.b = [{ x: 17, y: 18, z: 19 }, { x: 7, y: 8, z: 9 }] */
+store.setState({ a: { b: { '@@MOVE': [ 0, 1 ] } } }) // or store.setState({ a: { b: { '@@MOVE': [ -2, -1 ] } } })
+
+/* moves state.q[4] - [7] into indexes 1 - 4; leaving state.q = [ 1, 5, 6, 7, 8, 2, 3, 4, 9 ] */
+store.setState({ a: { q: { '@@MOVE': [ 4, 1, 4 ] } } }) // or store.setState({ a: { q: { '@@MOVE': [ -5, -8, 4 ] } } })
+```
+
+<b><code>@@PUSH:</code></b> <i>takes an array argument listing new values to append. </i>
+
+```jsx
+const state = {
+	a: { b: [{ x: 7, y: 8, z: 9 }, { x: 17, y: 18, z: 19 }] },
+	j: 10
+};
+
+store.setState({ a: { '@@PUSH': [{ n: 5 }] } }) // assigning a @@PUSH command to a non-array property has no effect.
+
+/* appends 2 new items into state.a.b; leaving state.a.b = [...state.a.b, { x: 27, y: 28, z: 29 }, { x: 37, y: 38, z: 39 }] */
+store.setState({ a: { b: { '@@PUSH': [{ x: 27, y: 28, z: 29 }, { x: 37, y: 38, z: 39 }] } } })
+```
+
+<b><code>@@REPLACE:</code></b> <i>takes an argument holding the replacment value. </i>
+
+```jsx
+const state = {
+	a: { b: [{ x: 7, y: 8, z: 9 }, { x: 17, y: 18, z: 19 }] },
+	j: 10
+};
+
+store.setState({ '@@REPLACE': { a: 'Demo', j: 17 } }) // rewrites state to { a: 'Demo', j: 17 };
+
+store.setState({ a: { '@@REPLACE': { message: 'Testing...' } } }) // rewrites state.a.b to { message: 'Testing...' }
+
+/* rewrites state.a.b[1] to { x: 97, y: 98, z: 99 }; leaving state.a.b = [{ x: 7, y: 8, z: 9 }, { x: 97, y: 98, z: 99 }] */
+store.setState({ a: { b: [ state.a.b[ 0 ], { '@@REPLACE': { x: 97, y: 98, z: 99 } } ] } })
+
+/* rewrites state.a.b[1] to { x: 97, y: 98, z: 99 }; leaving state.a.b = [{ x: 7, y: 8, z: 9 }, { x: 97, y: 98, z: 99 }] using indexing (RECOMMENDED) */
+store.setState({ a: { b: { 1: { '@@REPLACE': { x: 97, y: 98, z: 99 } } } } })
+```
+
+<b><code>@@SET:</code></b> <i>takes an argument holding either the replacment value or a compute function returning the replacement value. </i>
+
+```jsx
+/*
+	@@SET and @@REPLACE tags are functionally equivalent when using replacement value argument.
+	However, @@SET also accepts a compute function argument for calculating a replacement value based on current value.
+	This tag is for handling edge cases only. Please use sparingly. In most cases, store.setState with or without any of the other tags is sufficient and most efficient.
+*/
+
+const state = {
+	a: { b: [{ x: 7, y: 8, z: 9 }, { x: 17, y: 18, z: 19 }] },
+	j: 10
+};
+
+store.setState({ '@@SET': currentValue => ({ ...currentValue, a: 'Demo', j: 17 }) }) // rewrites state to { ...state, a: 'Demo', j: 17 };
+
+store.setState({ a: { '@@SET': currentValue => ({ ...currentValue, message: 'Testing...' }) } }) // rewrites state.a.b to { ...state, message: 'Testing...' }
+
+/* rewrites state.a.b[1] to { x: 97, y: 98, z: 99 }; leaving state.a.b = [{ x: 7, y: 8, z: 9 }, { x: 97, y: 98, z: 99 }] */
+store.setState({ a: { b: [ state.a.b[ 0 ], { '@@SET': currentValue => ({ ...currentValue, x: 97, y: 98, z: 99 }) } ] } })
+
+/* rewrites state.a.b[1] to { x: 97, y: 98, z: 99 }; leaving state.a.b = [{ x: 7, y: 8, z: 9 }, { x: 97, y: 98, z: 99 }] using indexing (RECOMMENDED) */
+store.setState({ a: { b: { 1: { '@@SET': currentValue => ({ ...currentValue, x: 97, y: 98, z: 99 }) } } } })
+
+/** be aware: currentValue may be `undefined` when adding new state slice properties. */
+```
+
+<b><code>@@SPLICE:</code></b> <i>takes an array argument listing: -/+fromIndex, +deleteCount and optional ...newItems? newItems = ...[] by default. </i>
+
+```jsx
+const state = {
+	a: { b: [{ x: 7, y: 8, z: 9 }, { x: 17, y: 18, z: 19 }] },
+	j: 10,
+	q: [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ]
+};
+
+store.setState({ a: { '@@SPLICE': [ 0, 1 ] } }) // assigning a @@SPLICE command to a non-array property has no effect.
+
+/* removes state.a.b[0]; leaving state.a.b = [{ x: 17, y: 18, z: 19 }] */
+store.setState({ a: { b: { '@@SPLICE': [ 0, 1 ] } } }) // or store.setState({ a: { b: { SPLICE': [ -2, -1 ] } } })
+
+/* replaces state.q[4] - [7] with 2 items; leaving state.q = [ 1, 2, 3, 4, 33, 88, 9 ] */
+store.setState({ a: { q: { '@@SPLICE': [ 4, 4, 33, 88 ] } } }) // or store.setState({ a: { q: { '@@SPLICE': [ -5, 4, 33, 88 ] } } })
+```
+
+<b><code>Combination Usage:</code></b>
+
+These tags may be used in combination with the default usage where all nth-level tag command results are sequentially merged into state followed by the merging of the rest of the nth-level changes.
+
+<strong>Example:</strong>
+
+```jsx
+const state = {
+	a: { b: [{ x: 7, y: 8, z: 9 }, { x: 17, y: 18, z: 19 }] },
+	j: 10,
+	q: [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ]
+};
+
+store.setState({
+	a: {
+		b: {
+			/* evaluated 1st */ '@@DELETE': [ 0 ], // upon deleting state.a.b[0] -> state.a.b[1] becomes the new state.a.b[0]
+			/* evaluated 3rd */ 0: '@@CLEAR', // clear the new state.a.b[0]
+			/* evaluated 4th */ 2: { x: 47, y: 48, z: 49 }, // add new item at state.a.b[2],
+			/* evaluated 2md */ '@@PUSH': [{ x: 107, y: 108, z: 109 }] // appends state.a.b[1]
+		},
+		j: { '@@SET': currentValue => currentValue < 10 ? currentValue : 0 },
+		q: {
+			/* evaluated 1st */ '@@MOVE': [ 5, 3, 2 ],
+			/* evaluated 2md */ 12: 11
+		}
+	}
+})
+// => {
+// 		a: { b: [{}, { x: 107, y: 108, z: 109 }, { x: 47, y: 48, z: 49 }] },
+// 		j: 0,
+// 		q: [ 1, 2, 3, 6, 7, 4, 5, 8, 9, <empty>, <empty>, <empty>, 11 ]
+// }
+```
+
 # API
 
 The React-Observable-Context module contains **4** exports namely:
@@ -389,6 +581,15 @@ ReactDOM.render( <Provider />, document.getElementById( 'root' ) );
 ```
 
 <h1 id="changes">What's Changed?</h1>
+<b>v4.1.0</b>
+<table>
+	<tbody>
+		<tr><td><b>1.</b></td><td>Added new setState command <a href="#setstate-tags">tags</a>: <b><code>@@CLEAR<b><code>, <b><code>@@DELETE</code></b>, <b><code>@@MOVE</code></b>, <b><code>@@PUSH</code></b>, <b><code>@@REPLACE</code></b>, <b><code>@@SET</code></b> and <b><code>@@SPLICE</code></b>.</td></tr>
+	</tbody>
+</table>
+<hr />
+
+<b>v4.0.0</b>
 <table>
 	<tbody>
 		<tr><td><b>1.</b></td><td>Added the <a href="#connect"><code>connect</code></a> function to facilitate the encapsulated context-usage method.</td></tr>

package/dist/constants.d.ts

@@ -1,2 +1,9 @@
+export const CLEAR_TAG: "@@CLEAR";
+export const DELETE_TAG: "@@DELETE";
 export const FULL_STATE_SELECTOR: "@@STATE";
-export const NULL_STATE_SELECTOR: "";
+export const MOVE_TAG: "@@MOVE";
+export const NULL_STATE_SELECTOR: "";
+export const PUSH_TAG: "@@PUSH";
+export const REPLACE_TAG: "@@REPLACE";
+export const SET_TAG: "@@SET";
+export const SPLICE_TAG: "@@SPLICE";

package/dist/constants.js

@@ -2,8 +2,22 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.NULL_STATE_SELECTOR = exports.FULL_STATE_SELECTOR = void 0;
+exports.SPLICE_TAG = exports.SET_TAG = exports.REPLACE_TAG = exports.PUSH_TAG = exports.NULL_STATE_SELECTOR = exports.MOVE_TAG = exports.FULL_STATE_SELECTOR = exports.DELETE_TAG = exports.CLEAR_TAG = void 0;
+var CLEAR_TAG = '@@CLEAR';
+exports.CLEAR_TAG = CLEAR_TAG;
+var DELETE_TAG = '@@DELETE';
+exports.DELETE_TAG = DELETE_TAG;
 var FULL_STATE_SELECTOR = '@@STATE';
 exports.FULL_STATE_SELECTOR = FULL_STATE_SELECTOR;
+var MOVE_TAG = '@@MOVE';
+exports.MOVE_TAG = MOVE_TAG;
 var NULL_STATE_SELECTOR = '';
-exports.NULL_STATE_SELECTOR = NULL_STATE_SELECTOR;
+exports.NULL_STATE_SELECTOR = NULL_STATE_SELECTOR;
+var PUSH_TAG = '@@PUSH';
+exports.PUSH_TAG = PUSH_TAG;
+var REPLACE_TAG = '@@REPLACE';
+exports.REPLACE_TAG = REPLACE_TAG;
+var SET_TAG = '@@SET';
+exports.SET_TAG = SET_TAG;
+var SPLICE_TAG = '@@SPLICE';
+exports.SPLICE_TAG = SPLICE_TAG;

package/dist/main/hooks/use-state-manager/index.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _react = require("react");
-var _lodash = _interopRequireDefault(require("lodash.clonedeep"));
+var _utils = require("../../../utils");
 var _accessorCache = _interopRequireDefault(require("../../../model/accessor-cache"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
 function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
@@ -15,7 +15,7 @@ function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefine
 function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 var useStateManager = function useStateManager(initStateValue) {
   var _useState = (0, _react.useState)(function () {
-      return (0, _lodash["default"])(initStateValue);
+      return (0, _utils.clonedeep)(initStateValue);
     }),
     _useState2 = _slicedToArray(_useState, 1),
     state = _useState2[0];

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

@@ -4,6 +4,7 @@ export namespace deps {
 }
 export default useStore;
 export type IStorage<T extends import("../../../types").State> = import("../../../types").IStorage<T>;
+export type UpdatePayload<T extends import("../../../types").State> = import("../../../types").UpdatePayload<PartialState<T>>;
 export type PartialState<T extends import("../../../types").State> = import('../../../types').PartialState<T>;
 export type Prehooks<T extends import("../../../types").State> = import("../../../types").Prehooks<T>;
 export type StoreInternal<T extends import("../../../types").State> = import("../../../types").StoreInternal<T>;
@@ -15,7 +16,7 @@ declare function useStore<T extends import("../../../types").State>(prehooks: Pr
         [propertyPaths: string]: Readonly<any>;
     };
     resetState: (propertyPaths?: string[]) => void;
-    setState: (changes: import("../../../types").PartialState<T>) => void;
+    setState: (changes: import("../../../types").UpdatePayload<import("../../../types").PartialState<T>>) => void;
     subscribe: (listener: import("../../../types").Listener<T>) => VoidFunction;
     unlinkCache: (clientId: string) => void;
 };

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

@@ -4,8 +4,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.deps = exports["default"] = void 0;
 var _react = require("react");
-var _lodash = _interopRequireDefault(require("lodash.clonedeep"));
-var _lodash2 = _interopRequireDefault(require("lodash.isboolean"));
+var _lodash = _interopRequireDefault(require("lodash.isboolean"));
 var _uuid = require("uuid");
 var _constants = require("../../../constants");
 var _utils = require("../../../utils");
@@ -34,7 +33,7 @@ function runPrehook(prehooks, name, args) {
     return true;
   }
   var res = prehooks[name].apply(prehooks, _toConsumableArray(args));
-  if (!(0, _lodash2["default"])(res)) {
+  if (!(0, _lodash["default"])(res)) {
     throw new TypeError("`".concat(name, "` prehook must return a boolean value."));
   }
   return res;
@@ -75,12 +74,12 @@ var useStore = function useStore(prehooks, value, storage) {
     var original = _storage.clone(_storage.getItem(storageKey.current));
     var resetData = !propertyPaths.length ? {} : propertyPaths.includes(_constants.FULL_STATE_SELECTOR) ? original : (0, _utils.mapPathsToObject)(original, propertyPaths);
     runPrehook(prehooksRef.current, 'resetState', [resetData, {
-      current: (0, _lodash["default"])(state),
+      current: (0, _utils.clonedeep)(state),
       original: original
     }]) && deps.setState(state, resetData, onChange);
   }, []);
   var setState = (0, _react.useCallback)(function (changes) {
-    changes = (0, _lodash["default"])(changes);
+    changes = (0, _utils.clonedeep)(changes);
     runPrehook(prehooksRef.current, 'setState', [changes]) && deps.setState(state, changes, onChange);
   }, []);
   var subscribe = (0, _react.useCallback)(function (listener) {
@@ -101,7 +100,7 @@ var useStore = function useStore(prehooks, value, storage) {
       mounted.current = true;
       return;
     }
-    setState((0, _lodash["default"])(value));
+    setState((0, _utils.clonedeep)(value));
   }, [value]);
   (0, _react.useEffect)(function () {
     if (!listeners.size) {

package/dist/main/index.d.ts

@@ -1,6 +1,6 @@
 /**
  * @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 a Store.data property holding a state slice and `value` => property path to a state slice used by this component: see examples below. May add a mapping for a certain arbitrary key='state' and value='@@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', note that any change within the state object will result in this component render.
+ * @param {SelectorMap<T>} [selectorMap] Key:value pairs where `key` => arbitrary key given to a Store.data property holding a state slice and `value` => property path to a state slice used by this component: see examples below. May add a mapping for a certain arbitrary key='state' and value='@@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', note that any change within the state object will result in this component render.
  * @returns {(WrappedComponent: C) => MemoExoticComponent<P>}
  * @template {State} T
  * @template {PartialStore<T> & {[x:string]:*}} [P=PartialStore<T>]
@@ -10,9 +10,7 @@
  */
 export function connect<T extends import("../types").State, P extends PartialStore<T> & {
     [x: string]: any;
-} = PartialStore<T>, C extends ComponentType<P> | import("react").ExoticComponent<ComponentType<P>>>(context: ObservableContext<T>, selectorMap?: {
-    [selectorKey: string]: string | keyof T;
-}): (WrappedComponent: C) => MemoExoticComponent<P>;
+} = PartialStore<T>, C extends ComponentType<P> | import("react").ExoticComponent<ComponentType<P>>>(context: ObservableContext<T>, selectorMap?: SelectorMap<T>): (WrappedComponent: C) => MemoExoticComponent<P>;
 
 /**
  * @returns {ObservableContext<T>} Refers to the IObservableContext<T> type of the ObservableContext<T>
@@ -27,7 +25,7 @@ export class UsageError extends Error {
  * 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 a Store.data property holding a state slice and `value` => property path to a state slice used by this component: see examples below. May add a mapping for a certain arbitrary key='state' and value='@@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', note that any change within the state object will result in this component render.
+ * @param {SelectorMap<T>} [selectorMap = {}] Key:value pairs where `key` => arbitrary key given to a Store.data property holding a state slice and `value` => property path to a state slice used by this component: see examples below. May add a mapping for a certain arbitrary key='state' and value='@@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', note that any change within the state object will result in this component render.
  * @returns {Store<T>}
  * @template {State} T
  * @see {ObservableContext<T>}
@@ -48,9 +46,7 @@ export class UsageError extends Error {
  * {myX: 'd.e.f[1].x'} or {myX: 'd.e.f.1.x'} => {myX: 7} // same applies to {myY: 'd.e.f[1].y'} = {myY: 8}; {myZ: 'd.e.f[1].z'} = {myZ: 9}
  * {myData: '@@STATE'} => {myData: state}
  */
-export function useContext<T extends import("../types").State>(context: ObservableContext<T>, selectorMap?: {
-    [selectorKey: string]: string | keyof T;
-}): Store<T>;
+export function useContext<T extends import("../types").State>(context: ObservableContext<T>, selectorMap?: SelectorMap<T>): Store<T>;
 export type ObservableContext<T extends import("../types").State> = IObservableContext<T> | PublicObservableContext<T>;
 export type PublicObservableContext<T extends import("../types").State> = WithObservableProvider<Context<Store<T>>, T>;
 export type IObservableContext<T extends import("../types").State> = WithObservableProvider<Context<IStore>, T>;
@@ -66,11 +62,16 @@ export type ObservableProvider<T extends import("../types").State> = FC<{
 export type State = import("../types").State;
 export type PartialState<T extends import("../types").State> = import("../types").PartialState<T>;
 export type Prehooks<T extends import("../types").State> = import("../types").Prehooks<T>;
+export type SelectorMap<T extends import("../types").State> = {
+    [dataPropKey: string]: string | keyof T;
+} & {
+    [dataPropKey: string]: "@@STATE";
+};
 export type StoreInternal<T extends import("../types").State> = import("../types").StoreInternal<T>;
 export type PartialStore<T extends import("../types").State> = {
     data?: import("../types").Data;
     resetState?: (propertyPaths?: string[]) => void;
-    setState?: (changes: import("../types").PartialState<T>) => void;
+    setState?: (changes: import("../types").UpdatePayload<import("../types").PartialState<T>>) => void;
 };
 export type Store<T extends import("../types").State> = import("../types").Store<T>;
 export type IStore = import("../types").IStore;

package/dist/main/set-state/index.d.ts

@@ -1,4 +1,5 @@
 export default setState;
+export type TagKey = import("./tag-functions").TagKey;
 export type HasArrayRoot<K extends KeyTypes = string> = HasRoot<K, Array<any>>;
 export type HasObjectRoot<K extends KeyTypes = string> = K extends number ? {
     [rootKey: number]: {
@@ -24,9 +25,8 @@ export type HasRoot<K extends KeyTypes = string, T> = K extends number ? {
 };
 export type KeyTypes = number | string | symbol;
 export type Listener<T extends import("../../types").State> = import("../../types").Listener<T>;
+export type UpdatePayload<T> = import("../../types").UpdatePayload<T>;
 export type PartialState<T extends import("../../types").State> = import("../../types").PartialState<T>;
 export type State = import("../../types").State;
-export type Stats = {
-    hasChanges: boolean;
-};
-declare function setState<T extends import("../../types").State>(state: T, newState: import("../../types").PartialState<T>, onStateChange?: Listener<T>): void;
+export type Stats = import("../../types").UpdateStats;
+declare function setState<T extends import("../../types").State>(state: T, changes: UpdatePayload<import("../../types").PartialState<T>>, onStateChange?: Listener<T>): void;

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

@@ -3,95 +3,122 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _lodash = _interopRequireDefault(require("lodash.clonedeep"));
-var _lodash2 = _interopRequireDefault(require("lodash.isequal"));
-var _lodash3 = _interopRequireDefault(require("lodash.isplainobject"));
+var _lodash = _interopRequireDefault(require("lodash.isequal"));
+var _lodash2 = _interopRequireDefault(require("lodash.isplainobject"));
+var _utils = require("../../utils");
+var _tagFunctions = _interopRequireWildcard(require("./tag-functions"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": 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(_e) { throw _e; }, 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(_e2) { didErr = true; err = _e2; }, 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 _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 _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
-function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
-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; }
-var isIndexBasedObj = function isIndexBasedObj(obj) {
-  return Object.keys(obj).every(function (k) {
-    var i = +k;
-    return Number.isInteger(i) && i > -1;
-  });
-};
-function setAtomic(state, newState, stateKey, stats) {
-  if ((0, _lodash2["default"])(state[stateKey], newState[stateKey])) {
-    return;
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+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 _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+var _default = setState;
+exports["default"] = _default;
+function isIndexBasedObj(obj) {
+  for (var k in obj) {
+    if (!(k in _tagFunctions["default"] || Number.isInteger(+k))) {
+      return false;
+    }
   }
-  var isPlainObjectNewState = (0, _lodash3["default"])(newState[stateKey]);
-  var isArrayNewState = Array.isArray(newState[stateKey]);
-  if (Array.isArray(state[stateKey])) {
-    if (isArrayNewState) {
-      return setArray(state, newState, stateKey, stats);
+  return true;
+}
+function resolveTags(state, changes, stateKey, stats) {
+  var resolvedTags = [];
+  if ((0, _tagFunctions.isClosedTag)(changes[stateKey])) {
+    changes[stateKey] = _defineProperty({}, changes[stateKey], null);
+  }
+  if (!(0, _utils.isDataContainer)(changes[stateKey])) {
+    return resolvedTags;
+  }
+  for (var k in changes[stateKey]) {
+    if (!(stateKey in changes)) {
+      break;
     }
-    if (isPlainObjectNewState && isIndexBasedObj(newState[stateKey])) {
-      return setArrayIndex(state, newState, stateKey, stats);
+    if ((0, _tagFunctions.isClosedTag)(changes[stateKey][k])) {
+      changes[stateKey][k] = _defineProperty({}, changes[stateKey][k], null);
+    }
+    if (k in _tagFunctions["default"]) {
+      _tagFunctions["default"][k](state, stateKey, stats, changes);
+      resolvedTags.push(k);
     }
   }
-  if (isPlainObjectNewState && (0, _lodash3["default"])(state[stateKey])) {
-    return setPlainObject(state, newState, stateKey, stats);
+  return resolvedTags;
+}
+function set(state, changes, stats) {
+  for (var k in changes) {
+    setAtomic(state, changes, k, stats);
   }
-  stats.hasChanges = true;
-  state[stateKey] = isArrayNewState || isPlainObjectNewState ? (0, _lodash["default"])(newState[stateKey]) : newState[stateKey];
 }
-;
-function setArray(state, newState, rootKey, stats) {
-  var nsLength = newState[rootKey].length;
+function setArray(state, changes, rootKey, stats) {
+  var nsLength = changes[rootKey].length;
   if (state[rootKey].length !== nsLength) {
     state[rootKey].length = nsLength;
     stats.hasChanges = true;
   }
   for (var i = 0; i < nsLength; i++) {
-    setAtomic(state[rootKey], newState[rootKey], i, stats);
+    setAtomic(state[rootKey], changes[rootKey], i, stats);
   }
 }
-;
-function setArrayIndex(state, newState, rootKey, stats) {
-  var incomingIndexes = Object.keys(newState[rootKey]).map(function (i) {
-    return +i;
-  });
-  var maxIncomingIndex = Math.max.apply(Math, _toConsumableArray(incomingIndexes));
+function setArrayIndex(state, changes, rootKey, stats) {
+  var incomingIndexes = [];
+  for (var k in changes[rootKey]) {
+    var index = +k;
+    if (index < 0) {
+      index = state[rootKey].length + index;
+      changes[rootKey][index] = changes[rootKey][k];
+      delete changes[rootKey][k];
+    }
+    index >= 0 && incomingIndexes.push(index);
+  }
+  var maxIncomingIndex = Math.max.apply(Math, incomingIndexes);
   if (maxIncomingIndex >= state[rootKey].length) {
     state[rootKey].length = maxIncomingIndex + 1;
     stats.hasChanges = true;
   }
-  var _iterator = _createForOfIteratorHelper(incomingIndexes),
-    _step;
-  try {
-    for (_iterator.s(); !(_step = _iterator.n()).done;) {
-      var i = _step.value;
-      setAtomic(state[rootKey], newState[rootKey], i, stats);
-    }
-  } catch (err) {
-    _iterator.e(err);
-  } finally {
-    _iterator.f();
+  for (var _i = 0, _incomingIndexes = incomingIndexes; _i < _incomingIndexes.length; _i++) {
+    var i = _incomingIndexes[_i];
+    setAtomic(state[rootKey], changes[rootKey], i, stats);
   }
 }
-;
-function setPlainObject(state, newState, rootKey, stats) {
-  set(state[rootKey], newState[rootKey], stats);
-}
-;
-function set(state, newState, stats) {
-  for (var k in newState) {
-    setAtomic(state, newState, k, stats);
+function setAtomic(state, changes, stateKey, stats) {
+  if ((0, _lodash["default"])(state[stateKey], changes[stateKey])) {
+    return;
+  }
+  var tagsResolved = resolveTags(state, changes, stateKey, stats);
+  var isPlainObjectNewState = (0, _lodash2["default"])(changes[stateKey]);
+  var isArrayNewState = Array.isArray(changes[stateKey]);
+  if (Array.isArray(state[stateKey])) {
+    if (isArrayNewState) {
+      return setArray(state, changes, stateKey, stats);
+    }
+    if (isPlainObjectNewState && isIndexBasedObj(changes[stateKey])) {
+      return setArrayIndex(state, changes, stateKey, stats);
+    }
+  }
+  if (isPlainObjectNewState && (0, _lodash2["default"])(state[stateKey])) {
+    return setPlainObject(state, changes, stateKey, stats);
   }
+  if (tagsResolved.length || !(stateKey in changes)) {
+    return;
+  }
+  ;
+  stats.hasChanges = true;
+  state[stateKey] = isArrayNewState || isPlainObjectNewState ? (0, _utils.clonedeep)(changes[stateKey]) : changes[stateKey];
+}
+function setPlainObject(state, changes, rootKey, stats) {
+  set(state[rootKey], changes[rootKey], stats);
 }
-;
-function setState(state, newState, onStateChange) {
+function setState(state, changes, onStateChange) {
   var stats = {
     hasChanges: false
   };
-  set(state, newState, stats);
-  stats.hasChanges && (onStateChange === null || onStateChange === void 0 ? void 0 : onStateChange(newState));
-}
-;
-var _default = setState;
-exports["default"] = _default;
+  var changeRequest = {
+    state: (0, _utils.clonedeep)(changes)
+  };
+  set({
+    state: state
+  }, changeRequest, stats);
+  stats.hasChanges && (onStateChange === null || onStateChange === void 0 ? void 0 : onStateChange(changes));
+}