@domql/utils 2.5.200 → 3.0.1

package/extends.js

@@ -0,0 +1,425 @@
+'use strict'
+
+import { joinArrays, removeDuplicatesInArray } from './array.js'
+import { matchesComponentNaming } from './component.js'
+import { deepClone, exec } from './object.js'
+import { isArray, isObject, isString } from './types.js'
+const ENV = process.env.NODE_ENV
+
+export const createExtendsFromKeys = key => {
+  if (key.includes('+')) {
+    return key.split('+').filter(matchesComponentNaming)
+  }
+
+  if (key.includes('_')) {
+    const [first] = key.split('_')
+    return [first]
+  }
+
+  if (key.includes('.') && !matchesComponentNaming(key.split('.')[1])) {
+    const [first] = key.split('.')
+    return [first]
+  }
+
+  return [key]
+}
+
+// Initial extend creation
+export const createExtends = (element, parent, key) => {
+  let __extends = []
+  const keyExtends = createExtendsFromKeys(key)
+  if (keyExtends) __extends = [...keyExtends]
+  const elementExtends = element.extends
+  if (elementExtends) {
+    __extends = isArray(elementExtends)
+      ? [...__extends, ...elementExtends]
+      : [...__extends, elementExtends]
+  }
+  return __extends
+}
+
+export const addExtends = (newExtends, element) => {
+  const { __ref: ref } = element
+  let { __extends } = ref
+
+  if (!newExtends) return __extends
+
+  // Check if the first extend has a variant in components
+  const variant = element.props?.variant
+  const context = element.context
+  if (
+    variant &&
+    context?.components &&
+    !Array.isArray(newExtends) &&
+    typeof newExtends === 'string'
+  ) {
+    const variantKey = `${newExtends}.${variant}`
+    if (context.components[variantKey]) {
+      newExtends = variantKey
+    }
+  }
+
+  if (!__extends.includes(newExtends)) {
+    __extends = Array.isArray(newExtends)
+      ? [...__extends, ...newExtends]
+      : [...__extends, newExtends]
+    ref.__extends = __extends
+  }
+  return __extends
+}
+
+export const concatAddExtends = (newExtend, element) => {
+  if (!newExtend) return element
+  const { extend: elementExtend } = element
+  const originalArray = isArray(elementExtend) ? elementExtend : [elementExtend]
+  const receivedArray = isArray(newExtend) ? newExtend : [newExtend]
+  return {
+    ...element,
+    extends: joinArrays(receivedArray, originalArray)
+  }
+}
+
+export const generateHash = () => Math.random().toString(36).substring(2)
+
+// hashing
+export const extendStackRegistry = {}
+export const extendCachedRegistry = {}
+
+export const getHashedExtend = extend => {
+  return extendStackRegistry[extend.__hash]
+}
+
+export const setHashedExtend = (extend, stack) => {
+  const hash = generateHash()
+  if (!isString(extend)) {
+    extend.__hash = hash
+  }
+  if (!['__proto__', 'constructor', 'prototype'].includes(hash)) {
+    extendStackRegistry[hash] = stack
+  }
+  return stack
+}
+
+export const getExtendsStackRegistry = (extend, stack) => {
+  if (extend.__hash) {
+    return stack.concat(getHashedExtend(extend))
+  }
+  return setHashedExtend(extend, stack) // stack .concat(hashedExtend)
+}
+
+// stacking
+export const extractArrayExtend = (
+  extend,
+  stack,
+  context,
+  processed = new Set()
+) => {
+  for (const each of extend) {
+    if (isArray(each)) {
+      extractArrayExtend(each, stack, context, processed)
+    } else {
+      flattenExtend(each, stack, context, processed)
+    }
+  }
+  return stack
+}
+
+export const deepExtend = (extend, stack, context, processed = new Set()) => {
+  const extendOflattenExtend = extend.extends
+  // Remove extends property before adding to stack
+  const cleanExtend = { ...extend }
+  delete cleanExtend.extends
+  if (Object.keys(cleanExtend).length > 0) {
+    stack.push(cleanExtend)
+  }
+  if (extendOflattenExtend) {
+    flattenExtend(extendOflattenExtend, stack, context, processed)
+  }
+  return stack
+}
+
+export const flattenExtend = (
+  extend,
+  stack,
+  context,
+  processed = new Set()
+) => {
+  if (!extend) return stack
+  if (processed.has(extend)) return stack
+
+  if (isArray(extend)) {
+    return extractArrayExtend(extend, stack, context, processed)
+  }
+
+  if (isString(extend)) {
+    extend = mapStringsWithContextComponents(extend, context)
+  }
+
+  processed.add(extend)
+
+  if (extend?.extends) {
+    deepExtend(extend, stack, context, processed)
+  } else if (extend) {
+    stack.push(extend)
+  }
+
+  return stack
+}
+
+export const deepMergeExtends = (element, extend) => {
+  // Clone extend to prevent mutations
+  extend = deepClone(extend)
+
+  for (const e in extend) {
+    if (['parent', 'node', '__ref'].indexOf(e) > -1) continue
+    if (e === '__proto__') continue
+
+    const elementProp = element[e]
+    const extendProp = extend[e]
+
+    // Skip if the property is undefined in the extend object
+    if (extendProp === undefined) continue
+
+    // Handle only properties that exist in the extend object
+    if (
+      Object.prototype.hasOwnProperty.call(extend, e) &&
+      !['__proto__', 'constructor', 'prototype'].includes(e)
+    ) {
+      if (elementProp === undefined) {
+        // For undefined properties in element, copy from extend
+        element[e] = isObject(extendProp) ? deepClone(extendProp) : extendProp
+      } else if (isObject(elementProp) && isObject(extendProp)) {
+        // For objects, merge based on type
+        if (matchesComponentNaming(e)) {
+          // For components, override base properties with extended ones
+          element[e] = deepMergeExtends(elementProp, deepClone(extendProp))
+        } else {
+          // For other objects, merge normally
+          deepMergeExtends(elementProp, extendProp)
+        }
+      }
+      // If elementProp is defined and not an object, keep it (don't override)
+      // This preserves properties from earlier in the extend chain
+    }
+  }
+  return element
+}
+
+export const cloneAndMergeArrayExtend = stack => {
+  return stack.reduce((acc, current) => {
+    // Clone current extend to avoid mutations
+    const cloned = deepClone(current)
+    // Merge into accumulator, giving priority to current extend
+    return deepMergeExtends(acc, cloned)
+  }, {})
+}
+
+export const mapStringsWithContextComponents = (
+  extend,
+  context,
+  options = {},
+  variant
+) => {
+  const COMPONENTS = (context && context.components) || options.components
+  const PAGES = (context && context.pages) || options.pages
+  if (isString(extend)) {
+    const componentExists =
+      COMPONENTS &&
+      (COMPONENTS[extend + '.' + variant] ||
+        COMPONENTS[extend] ||
+        COMPONENTS['smbls.' + extend])
+    const pageExists = PAGES && extend.startsWith('/') && PAGES[extend]
+    if (componentExists) return componentExists
+    else if (pageExists) return pageExists
+    else {
+      if (options.verbose && (ENV === 'test' || ENV === 'development')) {
+        console.warn('Extend is string but component was not found:', extend)
+      }
+      return
+    }
+  }
+  return extend
+}
+
+// joint stacks
+export const jointStacks = (extendStack, childExtendsStack) => {
+  return []
+    .concat(extendStack.slice(0, 1))
+    .concat(childExtendsStack.slice(0, 1))
+    .concat(extendStack.slice(1))
+    .concat(childExtendsStack.slice(1))
+}
+
+// init
+export const getExtendsStack = (extend, context) => {
+  if (!extend) return []
+  if (extend.__hash) return getHashedExtend(extend) || []
+  const processed = new Set()
+  const stack = flattenExtend(extend, [], context, processed)
+  return getExtendsStackRegistry(extend, stack)
+}
+
+export const addExtend = (newExtends, elementExtends) => {
+  if (!newExtends) return elementExtends
+  const receivedArray = isArray(newExtends) ? newExtends : [newExtends]
+  return joinArrays(receivedArray, elementExtends)
+}
+
+export const getExtendsInElement = obj => {
+  let result = []
+
+  function traverse (o) {
+    for (const key in o) {
+      if (Object.hasOwnProperty.call(o, key)) {
+        // Check if the key starts with a capital letter and exclude keys like @mobileL, $propsCollection
+        if (matchesComponentNaming(key)) {
+          result.push(key)
+        }
+
+        // Check if the key is "extend" and it's either a string or an array
+        if (key === 'extends') {
+          // Add the value of the extend key to the result array
+          if (typeof o[key] === 'string') {
+            result.push(o[key])
+          } else if (Array.isArray(o[key])) {
+            result = result.concat(o[key])
+          }
+        }
+
+        // If the property is an object, traverse it
+        if (typeof o[key] === 'object' && o[key] !== null) {
+          traverse(o[key])
+        }
+      }
+    }
+  }
+
+  traverse(obj)
+  return result
+}
+
+export const createElementExtends = (element, parent, options = {}) => {
+  const { __ref: ref } = element
+  const context = element.context || parent.context
+  const variant = element.props?.variant
+
+  // Add the extends property from element if it exists
+  if (element.extends) {
+    if (Array.isArray(element.extends) && element.extends.length > 0) {
+      // Handle first item in array specially for variant
+      const [firstExtend, ...restExtends] = element.extends
+      if (typeof firstExtend === 'string' && variant && context?.components) {
+        const variantKey = `${firstExtend}.${variant}`
+        if (context.components[variantKey]) {
+          addExtends([variantKey, ...restExtends], element)
+        } else {
+          addExtends(element.extends, element)
+        }
+      } else {
+        addExtends(element.extends, element)
+      }
+    } else if (
+      typeof element.extends === 'string' &&
+      variant &&
+      context?.components
+    ) {
+      const variantKey = `${element.extends}.${variant}`
+      if (context.components[variantKey]) {
+        addExtends(variantKey, element)
+      } else {
+        addExtends(element.extends, element)
+      }
+    } else {
+      addExtends(element.extends, element)
+    }
+  }
+
+  inheritChildPropsExtends(element, parent, options)
+  inheritChildExtends(element, parent, options)
+  inheritRecursiveChildExtends(element, parent, options)
+
+  if (element.component) {
+    addExtends(exec(element.component, element), element)
+  }
+
+  if (context.defaultExtends) {
+    addExtends(context.defaultExtends, element)
+  }
+
+  return removeDuplicatesInArray(ref.__extends)
+}
+
+export const inheritChildPropsExtends = (element, parent, options = {}) => {
+  const { props, __ref: ref } = element
+  const ignoreChildExtends =
+    options.ignoreChildExtends || props?.ignoreChildExtends
+  if (!ignoreChildExtends) {
+    if (parent.props?.childProps?.extends) {
+      addExtends(parent.props?.childProps.extends, element)
+    }
+  }
+  return ref.__extends
+}
+
+export const inheritChildExtends = (element, parent, options = {}) => {
+  const { props, __ref: ref } = element
+  const ignoreChildExtends =
+    options.ignoreChildExtends || props?.ignoreChildExtends
+
+  if (!ignoreChildExtends && parent.childExtends) {
+    // Use else if to avoid double-adding
+    addExtends(parent.childExtends, element)
+  }
+  return ref.__extends
+}
+
+export const inheritRecursiveChildExtends = (element, parent, options = {}) => {
+  const { props, __ref: ref } = element
+  const childExtendsRecursive = parent.childExtendsRecursive
+  const ignoreChildExtendsRecursive =
+    options.ignoreChildExtendsRecursive || props?.ignoreChildExtendsRecursive
+  const isText = element.key === '__text'
+  if (childExtendsRecursive && !isText && !ignoreChildExtendsRecursive) {
+    addExtends(childExtendsRecursive, element)
+  }
+  return ref.__extends
+}
+
+export const createExtendsStack = (element, parent, options = {}) => {
+  const { props, __ref: ref } = element
+  const context = element.context || parent.context
+
+  // if (ENV !== 'test' && ENV !== 'development') delete element.extends
+  const variant = element.variant || props?.variant
+
+  const __extends = removeDuplicatesInArray(
+    ref.__extends.map((val, i) => {
+      return mapStringsWithContextComponents(
+        val,
+        context,
+        options,
+        i === 0 && variant
+      )
+    })
+  )
+
+  const stack = getExtendsStack(__extends, context)
+  ref.__extendsStack = stack
+
+  return ref.__extendsStack
+}
+
+export const finalizeExtends = (element, parent, options = {}) => {
+  const { __ref: ref } = element
+  const { __extendsStack } = ref
+  const flattenExtends = cloneAndMergeArrayExtend(__extendsStack)
+
+  return deepMergeExtends(element, flattenExtends)
+}
+
+export const applyExtends = (element, parent, options = {}) => {
+  createElementExtends(element, parent, options)
+  createExtendsStack(element, parent, options)
+  finalizeExtends(element, parent, options)
+  return element
+}

package/if.js

@@ -0,0 +1,14 @@
+'use strict'
+
+import { isFunction } from './types.js'
+
+export const createIfConditionFlag = (element, parent) => {
+  const { __ref: ref } = element
+
+  if (
+    isFunction(element.if) &&
+    !element.if(element, element.state, element.context)
+  ) {
+    delete ref.__if
+  } else ref.__if = true
+}

package/index.js

@@ -7,9 +7,19 @@ export * from './object.js'
 export * from './function.js'
 export * from './array.js'
 export * from './node.js'
+export * from './if.js'
 export * from './log.js'
 export * from './string.js'
 export * from './globals.js'
 export * from './cookie.js'
 export * from './tags.js'
 export * from './component.js'
+export * from './props.js'
+export * from './extends.js'
+export * from './element.js'
+export * from './state.js'
+export * from './keys.js'
+export * from './scope.js'
+export * from './methods.js'
+export * from './cache.js'
+export * from './update.js'

package/key.js

@@ -1,5 +1,7 @@
 'use strict'
 
+import { exec } from './object.js'
+
 export const generateKey = (function () {
   let index = 0
 
@@ -12,3 +14,7 @@ export const generateKey = (function () {
 })()
 
 export const createSnapshotId = generateKey
+
+export const createKey = (element, parent, key) => {
+  return (exec(key, element) || key || element.key || generateKey()).toString()
+}

package/keys.js

@@ -0,0 +1,157 @@
+'use strict'
+
+export const DOMQ_PROPERTIES = [
+  'attr',
+  'style',
+  'text',
+  'html',
+  'content',
+  'data',
+  'class',
+  'state',
+  'scope',
+  'deps',
+  'extends',
+  '$router',
+  'routes',
+  'children',
+  'childExtends',
+  'childExtendsRecursive',
+  'props',
+  'if',
+  'define',
+  '__name',
+  '__ref',
+  '__hash',
+  '__text',
+  'key',
+  'tag',
+  'query',
+  'parent',
+  'node',
+  'variables',
+  'on',
+  'component',
+  'context'
+]
+
+export const PARSED_DOMQ_PROPERTIES = [
+  'attr',
+  'style',
+  'text',
+  'html',
+  'content',
+  'data',
+  'class',
+  'state',
+  'scope',
+  'children',
+  'props',
+  'if',
+  'key',
+  'tag',
+  'query',
+  'on',
+  'context'
+]
+
+export const STATE_PROPERTIES = [
+  'ref',
+  'parent',
+  '__element',
+  '__depends',
+  '__ref',
+  '__children',
+  'root'
+]
+
+export const STATE_METHODS = [
+  'update',
+  'parse',
+  'clean',
+  'create',
+  'destroy',
+  'add',
+  'toggle',
+  'remove',
+  'apply',
+  'set',
+  'reset',
+  'replace',
+  'quietReplace',
+  'quietUpdate',
+  'applyReplace',
+  'applyFunction',
+  'keys',
+  'values',
+  'ref',
+  'rootUpdate',
+  'parentUpdate',
+  'parent',
+  '__element',
+  '__depends',
+  '__ref',
+  '__children',
+  'root',
+  'setByPath',
+  'setPathCollection',
+  'removeByPath',
+  'removePathCollection',
+  'getByPath'
+]
+
+export const PROPS_METHODS = ['update', '__element']
+
+export const METHODS = [
+  'set',
+  'reset',
+  'update',
+  'remove',
+  'updateContent',
+  'removeContent',
+  'lookup',
+  'lookdown',
+  'lookdownAll',
+  'getRef',
+  'getPath',
+  'setNodeStyles',
+  'spotByPath',
+  'keys',
+  'parse',
+  'setProps',
+  'parseDeep',
+  'variables',
+  'if',
+  'log',
+  'verbose',
+  'warn',
+  'error',
+  'call',
+  'nextElement',
+  'previousElement'
+]
+
+export const METHODS_EXL = [
+  ...['node', 'context', 'extends', '__element', '__ref'],
+  ...METHODS,
+  ...STATE_METHODS,
+  ...PROPS_METHODS
+]
+
+export const DOMQL_EVENTS = [
+  'init',
+  'beforeClassAssign',
+  'render',
+  'renderRouter',
+  'attachNode',
+  'stateInit',
+  'stateCreated',
+  'beforeStateUpdate',
+  'stateUpdate',
+  'beforeUpdate',
+  'done',
+  'create',
+  'complete',
+  'frame',
+  'update'
+]

package/log.js

@@ -1,6 +1,9 @@
 'use strict'
 
-export const logIf = (bool, ...arg) => { if (bool) arg.map(v => console.log(v)) }
+export const logIf = (bool, ...arg) => {
+  if (bool) arg.map(v => console.log(v))
+}
+
 export const logGroupIf = (bool, key, ...arg) => {
   if (bool) {
     console.group(key)