@domql/state 2.3.123 → 2.3.126

package/createState.js

@@ -3,18 +3,18 @@
 import { triggerEventOn } from '@domql/event'
 import { deepClone, exec, is, isFunction, isObject } from '@domql/utils'
 import { IGNORE_STATE_PARAMS } from './ignore'
-import { add, apply, clean, destroy, parse, remove, rootUpdate, toggle } from './methods'
+import { add, apply, clean, destroy, parse, remove, rootUpdate, set, toggle } from './methods'
 import { updateState } from './updateState'
 import { checkIfInherits, createInheritedState } from './inherit'
 
-export const createState = function (element, parent, opts) {
-  const skip = (opts && opts.skip) ? opts.skip : false
+export const createState = function (element, parent, options) {
+  const skip = (options && options.skip) ? options.skip : false
 
   const objectizeState = checkForTypes(element)
   if (objectizeState === false) return parent.state || {}
   else element.state = deepClone(objectizeState, IGNORE_STATE_PARAMS)
 
-  const whatInitReturns = triggerEventOn('stateInit', element)
+  const whatInitReturns = triggerEventOn('stateInit', element, options)
   if (whatInitReturns === false) return element.state
 
   if (checkIfInherits(element)) {
@@ -84,6 +84,7 @@ const applyMethods = (element) => {
   state.remove = remove
   state.apply = apply
   state.parent = element.parent.state
+  state.set = set
   state.__element = element
   state.__children = {}
   state.__root = ref.__root ? ref.__root.state : state

package/dist/cjs/createState.js

@@ -27,14 +27,14 @@ var import_ignore = require("./ignore");
 var import_methods = require("./methods");
 var import_updateState = require("./updateState");
 var import_inherit = require("./inherit");
-const createState = function(element, parent, opts) {
-  const skip = opts && opts.skip ? opts.skip : false;
+const createState = function(element, parent, options) {
+  const skip = options && options.skip ? options.skip : false;
   const objectizeState = checkForTypes(element);
   if (objectizeState === false)
     return parent.state || {};
   else
     element.state = (0, import_utils.deepClone)(objectizeState, import_ignore.IGNORE_STATE_PARAMS);
-  const whatInitReturns = (0, import_event.triggerEventOn)("stateInit", element);
+  const whatInitReturns = (0, import_event.triggerEventOn)("stateInit", element, options);
   if (whatInitReturns === false)
     return element.state;
   if ((0, import_inherit.checkIfInherits)(element)) {
@@ -93,6 +93,7 @@ const applyMethods = (element) => {
   state.remove = import_methods.remove;
   state.apply = import_methods.apply;
   state.parent = element.parent.state;
+  state.set = import_methods.set;
   state.__element = element;
   state.__children = {};
   state.__root = ref.__root ? ref.__root.state : state;

package/dist/cjs/ignore.js

@@ -31,6 +31,7 @@ const IGNORE_STATE_PARAMS = [
   "toggle",
   "remove",
   "apply",
+  "set",
   "rootUpdate",
   "parent",
   "__element",

package/dist/cjs/methods.js

@@ -25,6 +25,7 @@ __export(methods_exports, {
   parse: () => parse,
   remove: () => remove,
   rootUpdate: () => rootUpdate,
+  set: () => set,
   toggle: () => toggle
 });
 module.exports = __toCommonJS(methods_exports);
@@ -51,12 +52,19 @@ const clean = function(options = {}) {
       delete state[param];
     }
   }
-  state.update(state, { skipOverwrite: true, options });
+  if (!options.preventStateUpdate) {
+    state.update(state, { replace: true, options });
+  }
   return state;
 };
-const destroy = function() {
+const destroy = function(options = {}) {
   const state = this;
   const element = state.__element;
+  const stateKey = element.__ref.__state;
+  if ((0, import_utils.isString)(stateKey)) {
+    element.parent.state.remove(stateKey, { isHoisted: true, ...options });
+    return element.state;
+  }
   delete element.state;
   element.state = state.parent;
   if (state.parent) {
@@ -70,13 +78,14 @@ const destroy = function() {
       }
     }
   }
-  element.state.update();
+  element.state.update({}, { isHoisted: true, ...options });
   return element.state;
 };
 const rootUpdate = function(obj, options = {}) {
   const state = this;
   if (!state)
     return;
+  console.log(options);
   const rootState = state.__element.__ref.__root.state;
   return rootState.update(obj, options);
 };
@@ -84,7 +93,7 @@ const add = function(value, options = {}) {
   const state = this;
   if ((0, import_utils.isArray)(state)) {
     state.push(value);
-    state.update(state.parse(), { replace: true, ...options });
+    state.update(state.parse(), { overwrite: "replace", ...options });
   } else if ((0, import_utils.isObject)(state)) {
     const key = Object.keys(state).length;
     state.update({ [key]: value }, options);
@@ -102,10 +111,14 @@ const remove = function(key, options = {}) {
     (0, import_utils.removeFromObject)(state, key);
   return state.update(state.parse(), { replace: true, ...options });
 };
+const set = function(value, options = {}) {
+  const state = this;
+  return state.clean({ preventStateUpdate: true }).update(value, { replace: true, ...options });
+};
 const apply = function(func, options = {}) {
   const state = this;
   if ((0, import_utils.isFunction)(func)) {
     func(state);
-    return state.update(state, { replace: true, ...options });
+    return state.update(state, { overwrite: "replace", ...options });
   }
 };

package/dist/cjs/updateState.js

@@ -27,37 +27,51 @@ var import_ignore = require("./ignore");
 var import_utils = require("@domql/utils");
 var import_inherit = require("./inherit");
 const STATE_UPDATE_OPTIONS = {
-  preventHoistElementUpdate: true
+  overwrite: true,
+  preventHoistElementUpdate: false,
+  updateByState: true,
+  execStateFunction: true,
+  stateFunctionOverwrite: "replace"
 };
 const updateState = function(obj, options = STATE_UPDATE_OPTIONS) {
   const state = this;
   const element = state.__element;
+  if (!options.updateByState)
+    (0, import_utils.merge)(options, STATE_UPDATE_OPTIONS);
   if (!state.__element)
     (0, import_report.report)("ElementOnStateIsNotDefined");
+  if (options.preventInheritAtCurrentState === true) {
+    options.preventInheritAtCurrentState = state;
+  } else if (options.preventInheritAtCurrentState)
+    return;
   if (!options.preventInitStateUpdateListener) {
-    const initStateUpdateReturns = (0, import_event.triggerEventOn)("initStateUpdated", element, obj);
+    const initStateUpdateReturns = (0, import_event.triggerEventOnUpdate)("initStateUpdated", obj, element, options);
     if (initStateUpdateReturns === false)
       return element;
   }
   applyOverwrite(state, obj, options);
-  hoistStateUpdate(state, obj, options);
+  const updateIsHoisted = hoistStateUpdate(state, obj, options);
+  if (updateIsHoisted)
+    return state;
   updateDependentState(state, obj, options);
   applyElementUpdate(state, obj, options);
   if (!options.preventStateUpdateListener) {
-    (0, import_event.triggerEventOn)("stateUpdated", element, obj);
+    (0, import_event.triggerEventOnUpdate)("stateUpdated", obj, element, options);
   }
   return state;
 };
 const applyOverwrite = (state, obj, options) => {
-  const { skipOverwrite, shallow } = options;
-  if (skipOverwrite === "merge") {
+  const { overwrite } = options;
+  if (!overwrite)
+    return;
+  const shallow = overwrite === "shallow";
+  const merge2 = overwrite === "merge";
+  if (merge2) {
     (0, import_utils.deepMerge)(state, obj, import_ignore.IGNORE_STATE_PARAMS);
     return;
   }
-  if (!skipOverwrite) {
-    const overwriteFunc = shallow ? import_utils.overwriteShallow : import_utils.overwriteDeep;
-    overwriteFunc(state, obj, import_ignore.IGNORE_STATE_PARAMS);
-  }
+  const overwriteFunc = shallow ? import_utils.overwriteShallow : import_utils.overwriteDeep;
+  overwriteFunc(state, obj, import_ignore.IGNORE_STATE_PARAMS);
 };
 const hoistStateUpdate = (state, obj, options) => {
   const element = state.__element;
@@ -79,10 +93,18 @@ const hoistStateUpdate = (state, obj, options) => {
   if (options.replace)
     targetParent[stateKey] = value;
   targetParent.update(changesValue, {
+    execStateFunction: false,
+    stateFunctionOverwrite: false,
+    isHoisted: true,
     ...options,
     preventUpdate: options.preventHoistElementUpdate,
-    skipOverwrite: options.replace
+    overwrite: !options.replace
   });
+  const hasNotUpdated = !options.preventUpdate || !options.preventHoistElementUpdate;
+  if (!options.preventStateUpdateListener && hasNotUpdated) {
+    (0, import_event.triggerEventOnUpdate)("stateUpdated", obj, element, options);
+  }
+  return true;
 };
 const updateDependentState = (state, obj, options) => {
   if (!state.__depends)
@@ -97,13 +119,11 @@ const applyElementUpdate = (state, obj, options) => {
   if (!options.preventUpdate) {
     element.update({}, {
       ...options,
-      updateByState: true,
-      preventUpdateTriggerStateUpdate: true
+      updateByState: true
     });
   } else if (options.preventUpdate === "recursive") {
     element.update({}, {
       ...options,
-      preventUpdateTriggerStateUpdate: true,
       updateByState: true,
       preventUpdate: true
     });

package/ignore.js

@@ -1,6 +1,6 @@
 'use strict'
 
 export const IGNORE_STATE_PARAMS = [
-  'update', 'parse', 'clean', 'create', 'destroy', 'add', 'toggle', 'remove', 'apply',
+  'update', 'parse', 'clean', 'create', 'destroy', 'add', 'toggle', 'remove', 'apply', 'set',
   'rootUpdate', 'parent', '__element', '__depends', '__ref', '__children', '__root'
 ]

package/methods.js

@@ -1,6 +1,6 @@
 'use strict'
 
-import { isArray, isFunction, isObject, removeFromArray, removeFromObject } from '@domql/utils'
+import { isArray, isFunction, isObject, isString, removeFromArray, removeFromObject } from '@domql/utils'
 
 import { IGNORE_STATE_PARAMS } from './ignore'
 
@@ -26,13 +26,22 @@ export const clean = function (options = {}) {
       delete state[param]
     }
   }
-  state.update(state, { skipOverwrite: true, options })
+  if (!options.preventStateUpdate) {
+    state.update(state, { replace: true, options })
+  }
   return state
 }
 
-export const destroy = function () {
+export const destroy = function (options = {}) {
   const state = this
   const element = state.__element
+
+  const stateKey = element.__ref.__state
+  if (isString(stateKey)) {
+    element.parent.state.remove(stateKey, { isHoisted: true, ...options })
+    return element.state
+  }
+
   delete element.state
   element.state = state.parent
 
@@ -49,13 +58,14 @@ export const destroy = function () {
     }
   }
 
-  element.state.update()
+  element.state.update({}, { isHoisted: true, ...options })
   return element.state
 }
 
 export const rootUpdate = function (obj, options = {}) {
   const state = this
   if (!state) return
+  console.log(options)
   const rootState = (state.__element.__ref.__root).state
   return rootState.update(obj, options)
 }
@@ -64,9 +74,8 @@ export const add = function (value, options = {}) {
   const state = this
   if (isArray(state)) {
     state.push(value)
-    state.update(state.parse(), { replace: true, ...options })
-  }
-  else if (isObject(state)) {
+    state.update(state.parse(), { overwrite: 'replace', ...options })
+  } else if (isObject(state)) {
     const key = Object.keys(state).length
     state.update({ [key]: value }, options)
   }
@@ -84,10 +93,16 @@ export const remove = function (key, options = {}) {
   return state.update(state.parse(), { replace: true, ...options })
 }
 
+export const set = function (value, options = {}) {
+  const state = this
+  return state.clean({ preventStateUpdate: true })
+    .update(value, { replace: true, ...options })
+}
+
 export const apply = function (func, options = {}) {
   const state = this
   if (isFunction(func)) {
     func(state)
-    return state.update(state, { replace: true, ...options })
+    return state.update(state, { overwrite: 'replace', ...options })
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@domql/state",
-  "version": "2.3.123",
+  "version": "2.3.126",
   "license": "MIT",
   "type": "module",
   "module": "dist/esm/index.js",
@@ -26,5 +26,5 @@
     "@domql/report": "latest",
     "@domql/utils": "latest"
   },
-  "gitHead": "feb0d24eb5924f0f9ebea660a93afffc7d6a2059"
+  "gitHead": "6329de71d2e831d0efd9d59e765567aa8c563481"
 }

package/updateState.js

@@ -1,53 +1,65 @@
 'use strict'
 
 import { report } from '@domql/report'
-import { triggerEventOn } from '@domql/event'
+import { triggerEventOnUpdate } from '@domql/event'
 import { IGNORE_STATE_PARAMS } from './ignore'
-import { deepMerge, overwriteDeep, overwriteShallow } from '@domql/utils'
+import { deepMerge, merge, overwriteDeep, overwriteShallow } from '@domql/utils'
 import { checkIfInherits, createChangesByKey, findInheritedState, getParentStateInKey } from './inherit'
 
 const STATE_UPDATE_OPTIONS = {
-  preventHoistElementUpdate: true
+  overwrite: true,
+  preventHoistElementUpdate: false,
+  updateByState: true,
+  execStateFunction: true,
+  stateFunctionOverwrite: 'replace'
 }
 
 export const updateState = function (obj, options = STATE_UPDATE_OPTIONS) {
   const state = this
   const element = state.__element
 
+  if (!options.updateByState) merge(options, STATE_UPDATE_OPTIONS)
+
   if (!state.__element) report('ElementOnStateIsNotDefined')
+  if (options.preventInheritAtCurrentState === true) {
+    options.preventInheritAtCurrentState = state
+  } else if (options.preventInheritAtCurrentState) return
 
   if (!options.preventInitStateUpdateListener) {
-    const initStateUpdateReturns = triggerEventOn('initStateUpdated', element, obj)
+    const initStateUpdateReturns = triggerEventOnUpdate('initStateUpdated', obj, element, options)
     if (initStateUpdateReturns === false) return element
   }
 
   applyOverwrite(state, obj, options)
 
-  hoistStateUpdate(state, obj, options)
+  const updateIsHoisted = hoistStateUpdate(state, obj, options)
+  if (updateIsHoisted) return state
 
   updateDependentState(state, obj, options)
 
   applyElementUpdate(state, obj, options)
 
   if (!options.preventStateUpdateListener) {
-    triggerEventOn('stateUpdated', element, obj)
+    triggerEventOnUpdate('stateUpdated', obj, element, options)
   }
 
   return state
 }
 
 const applyOverwrite = (state, obj, options) => {
-  const { skipOverwrite, shallow } = options
+  const { overwrite } = options
+  if (!overwrite) return
+
+  const shallow = overwrite === 'shallow'
+  const merge = overwrite === 'merge'
 
-  if (skipOverwrite === 'merge') {
+  if (merge) {
     deepMerge(state, obj, IGNORE_STATE_PARAMS)
     return
   }
 
-  if (!skipOverwrite) {
-    const overwriteFunc = shallow ? overwriteShallow : overwriteDeep
-    overwriteFunc(state, obj, IGNORE_STATE_PARAMS)
-  }
+  const overwriteFunc = shallow ? overwriteShallow : overwriteDeep
+  overwriteFunc(state, obj, IGNORE_STATE_PARAMS)
 }
 
 const hoistStateUpdate = (state, obj, options) => {
@@ -70,10 +82,18 @@ const hoistStateUpdate = (state, obj, options) => {
   const targetParent = findGrandParentState || parent.state
   if (options.replace) targetParent[stateKey] = value
   targetParent.update(changesValue, {
+    execStateFunction: false,
+    stateFunctionOverwrite: false,
+    isHoisted: true,
     ...options,
     preventUpdate: options.preventHoistElementUpdate,
-    skipOverwrite: options.replace
+    overwrite: !options.replace
   })
+  const hasNotUpdated = !options.preventUpdate || !options.preventHoistElementUpdate
+  if (!options.preventStateUpdateListener && hasNotUpdated) {
+    triggerEventOnUpdate('stateUpdated', obj, element, options)
+  }
+  return true
 }
 
 const updateDependentState = (state, obj, options) => {
@@ -89,13 +109,11 @@ const applyElementUpdate = (state, obj, options) => {
   if (!options.preventUpdate) {
     element.update({}, {
       ...options,
-      updateByState: true,
-      preventUpdateTriggerStateUpdate: true
+      updateByState: true
     })
   } else if (options.preventUpdate === 'recursive') {
     element.update({}, {
       ...options,
-      preventUpdateTriggerStateUpdate: true,
       updateByState: true,
       preventUpdate: true
     })