@domql/state 2.3.81 → 2.3.112

package/ignore.js

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

package/index.js

@@ -1,44 +1,280 @@
 'use strict'
 
-import { on } from '@domql/event'
-import { deepClone, diff, exec, isFunction, overwriteDeep } from '@domql/utils'
+import { IGNORE_STATE_PARAMS } from './ignore'
 
-export const parseState = function () {
+import { triggerEventOn } from '@domql/event'
+import {
+  is,
+  isObject,
+  exec,
+  isFunction,
+  isUndefined,
+  arrayContainsOtherArray,
+  isObjectLike,
+  isArray,
+  removeFromArray,
+  removeFromObject,
+  deepClone,
+  overwriteShallow,
+  overwriteDeep
+} from '@domql/utils'
+
+export const parse = function () {
+  const state = this
+  if (isObject(state)) {
+    const obj = {}
+    for (const param in state) {
+      if (!IGNORE_STATE_PARAMS.includes(param)) {
+        obj[param] = state[param]
+      }
+    }
+    return obj
+  } else if (isArray(state)) {
+    return state.filter(item => !IGNORE_STATE_PARAMS.includes(item))
+  }
+}
+
+export const clean = function (options = {}) {
   const state = this
-  const parseState = {}
   for (const param in state) {
-    if (param !== '__element' && param !== 'update' && param !== 'parse') {
-      parseState[param] = state[param]
+    if (!IGNORE_STATE_PARAMS.includes(param)) {
+      delete state[param]
     }
   }
-  return parseState
+  state.update(state, { skipOverwrite: true, options })
+  return state
+}
+
+export const destroy = function () {
+  const state = this
+  const element = state.__element
+  delete element.state
+  element.state = state.parent
+
+  if (state.parent) {
+    delete state.parent.__children[element.key]
+  }
+
+  if (state.__children) {
+    for (const key in state.__children) {
+      const child = state.__children[key]
+      if (child.state) {
+        child.parent = state.parent
+      }
+    }
+  }
+
+  element.state.update()
+  return element.state
+}
+
+export const rootUpdate = function (obj, options = {}) {
+  const state = this
+  if (!state) return
+  const rootState = (state.__element.__ref.__root).state
+  return rootState.update(obj, options)
 }
 
 export const updateState = function (obj, options = {}) {
   const state = this
   const element = state.__element
+  const __elementRef = element.__ref
+  const parentState = element.parent.state
+  state.parent = parentState
 
-  const changes = diff(obj, state)
+  for (const param in state) {
+    if (isUndefined(state[param])) {
+      delete state[param]
+    }
+  }
+
+  if (!state.__element) {
+    create(element, element.parent)
+  }
+
+  const initStateUpdateReturns = triggerEventOn('initStateUpdated', element, obj)
+  if (initStateUpdateReturns === false) return element
+
+  if (!options.skipOverwrite) {
+    if (options.shallow) {
+      overwriteShallow(state, obj, IGNORE_STATE_PARAMS)
+    } else {
+      overwriteDeep(state, obj, IGNORE_STATE_PARAMS)
+    }
+  }
+
+  const stateKey = __elementRef.__state
+  const shouldPropagateState = stateKey && parentState && parentState[stateKey] && !options.stopStatePropagation
+  if (shouldPropagateState) {
+    const isStringState = (__elementRef.__stateType === 'string')
+    const value = isStringState ? state.value : state.parse()
+    parentState[stateKey] = value
+    parentState.update(value, { skipOverwrite: true, ...options })
+    return state
+  }
 
-  on.updateStateInit(changes, element)
+  if (!options.preventUpdate) {
+    element.update({}, options)
+  } else if (options.preventUpdate === 'recursive') {
+    element.update({}, { ...options, preventUpdate: true })
+  }
 
-  overwriteDeep(changes, state)
-  if (!options.preventUpdate) element.update()
+  if (state.__depends) {
+    for (const el in state.__depends) {
+      const findElement = state.__depends[el]
+      findElement.clean().update(state.parse(), options)
+    }
+  }
+
+  if (!options.preventUpdateListener) {
+    triggerEventOn('stateUpdated', element, obj)
+  }
 
-  on.updateState(changes, state, element)
+  return state
 }
 
-export function createState (element, parent) {
-  let { state } = element
-  if (!state) return (parent && parent.state) || {}
-  if (isFunction(state)) state = exec(state, element)
+export const remove = function (key, options) {
+  const state = this
+  if (isArray(state)) removeFromArray(state, key)
+  if (isObject(state)) removeFromObject(state, key)
+  return state.update(state, { skipOverwrite: true, options })
+}
 
-  state = deepClone(state, ['update', 'parse', '__element'])
-  state.__element = element
-  state.parse = parseState
-  state.update = updateState
+export const apply = function (func, options) {
+  const state = this
+  if (isFunction(func)) {
+    func(state)
+    return state.update(state, { skipOverwrite: true, options })
+  }
+}
+
+const getParentStateInKey = (stateKey, parentState) => {
+  const arr = stateKey.split('../')
+  const arrLength = arr.length - 1
+  for (let i = 0; i < arrLength; i++) {
+    if (!parentState.parent) return null
+    parentState = parentState.parent
+  }
+  return parentState
+}
+
+const getChildStateInKey = (stateKey, parentState) => {
+  const arr = stateKey.split('/')
+  const arrLength = arr.length - 1
+  for (let i = 0; i < arrLength; i++) {
+    const childKey = arr[i]
+    const grandChildKey = arr[i + 1]
+    const childInParent = parentState[childKey]
+    if (childInParent && childInParent[grandChildKey]) {
+      stateKey = grandChildKey
+      parentState = childInParent
+    } else return
+  }
+  return parentState[stateKey]
+}
+
+const createInheritedState = function (element, parent) {
+  const __elementRef = element.__ref
+  let stateKey = __elementRef.__state
+  if (!stateKey) return element.state
+
+  let parentState = parent.state
+  if (stateKey.includes('../')) {
+    parentState = getParentStateInKey(stateKey, parent.state)
+    stateKey = stateKey.replaceAll('../', '')
+  }
+  if (!parentState) return {}
+
+  const keyInParentState = getChildStateInKey(stateKey, parentState)
+  if (!keyInParentState) return {}
+
+  if (is(keyInParentState)('object', 'array')) {
+    return deepClone(keyInParentState, IGNORE_STATE_PARAMS)
+  } else if (is(keyInParentState)('string', 'number')) {
+    __elementRef.__stateType = 'string'
+    return { value: keyInParentState }
+  }
+
+  console.warn(stateKey, 'is not present. Replacing with', {})
+  return {}
+}
+
+export const createState = function (element, parent, opts) {
+  const skip = (opts && opts.skip) ? opts.skip : false
+  let { state, __ref: __elementRef } = element
+
+  if (isFunction(state)) element.state = exec(state, element)
+
+  if (is(state)('string', 'number')) {
+    __elementRef.__state = state
+    element.state = {}
+  }
+  if (state === true) {
+    __elementRef.__state = element.key
+    element.state = {}
+  }
+
+  // trigger `on.stateInit`
+  triggerEventOn('stateInit', element)
+
+  state = element.state = createInheritedState(element, parent)
+
+  if (!state) {
+    if (parent && parent.state) return parent.state
+    return {}
+  } else {
+    __elementRef.__hasRootState = true
+  }
+
+  // reference other state
+  // TODO: check why __ref is assigned with element
+  // /docs/intro
+  const { __ref } = state
+  if (__ref) {
+    state = deepClone(__ref, IGNORE_STATE_PARAMS)
+    if (isObject(__ref.__depends)) {
+      __ref.__depends[element.key] = state
+    } else __ref.__depends = { [element.key]: state }
+  } else {
+    state = deepClone(state, IGNORE_STATE_PARAMS)
+  }
+
+  element.state = state
+
+  // NOTE: Only true when 'onlyResolveExtends' option is set to true
+  if (skip) return state
 
-  on.createState(state, element)
+  applyMethods(element, state)
+
+  // trigger `on.stateCreated`
+  triggerEventOn('stateCreated', element)
 
   return state
 }
+
+export const isState = function (state) {
+  if (!isObjectLike(state)) return false
+  const keys = Object.keys(state)
+  return arrayContainsOtherArray(keys, ['update', 'parse', 'clean', 'create', 'parent', 'rootUpdate'])
+}
+
+const applyMethods = (element, state) => {
+  const __elementRef = element.__ref
+
+  state.clean = clean
+  state.parse = parse
+  state.destroy = destroy
+  state.update = updateState
+  state.rootUpdate = rootUpdate
+  state.create = createState
+  state.remove = remove
+  state.apply = apply
+  state.parent = element.parent.state
+  state.__element = element
+  state.__children = {}
+  state.__root = __elementRef.__root ? __elementRef.__root.state : state
+
+  if (state.parent) state.parent.__children[element.key] = state
+}
+
+export default createState

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@domql/state",
-  "version": "2.3.81",
+  "version": "2.3.112",
   "main": "index.js",
   "license": "MIT",
   "dependencies": {
     "@domql/event": "latest",
     "@domql/utils": "latest"
   },
-  "gitHead": "11597b3330a1e6a9148a0595c80ba79070dc5f85",
+  "gitHead": "a86dad4cef1731f6a97d43ec445074c31f76760a",
   "source": "index.js"
 }