zammad/app/frontend/shared/form/utils/extendSchemaDefinition.ts

// Copyright (C) 2012-2024 Zammad Foundation, https://zammad-foundation.org/

import { cloneDeep } from 'lodash-es'
import type {
  FormKitExtendableSchemaRoot,
  FormKitNode,
  FormKitSchemaCondition,
  FormKitSchemaNode,
} from '@formkit/core'
import { FormSchemaExtendType } from '#shared/types/form.ts'
import { extend } from '@formkit/utils'

// Can later be switched to in built-in feature from FormKit (when it's available).
const extendSchemaDefinition = (
  node: FormKitNode,
  sectionKey: string,
  schemaExtension: FormKitSchemaCondition | Partial<FormKitSchemaNode>,
  extendType: FormSchemaExtendType = FormSchemaExtendType.Merge,
  cloneDefinition = false,
  // eslint-disable-next-line sonarjs/cognitive-complexity
) => {
  const { props } = node

  if (!props.definition) return

  const definition = cloneDefinition
    ? cloneDeep(props.definition)
    : props.definition

  const originalSchema = definition.schema as FormKitExtendableSchemaRoot

  definition.schema = (extensions) => {
    let sectionSchemaExtension:
      | FormKitSchemaCondition
      | Partial<FormKitSchemaNode>

    const currentExtension = extensions[sectionKey] || {}

    if (extendType === FormSchemaExtendType.Merge) {
      // When current extenstions is a string, replace it.
      if (typeof currentExtension === 'string') {
        sectionSchemaExtension = schemaExtension
      } else {
        sectionSchemaExtension = extend(currentExtension, schemaExtension) as
          | FormKitSchemaCondition
          | Partial<FormKitSchemaNode>
      }
    } else if (extendType === FormSchemaExtendType.Replace) {
      sectionSchemaExtension = schemaExtension
    } else {
      let currentChildren: Maybe<
        (FormKitSchemaCondition | Partial<FormKitSchemaNode>)[]
      > = null
      if (
        currentExtension &&
        typeof currentExtension === 'object' &&
        'children' in currentExtension &&
        Array.isArray(currentExtension.children)
      ) {
        currentChildren = currentExtension.children
      }

      if (currentChildren) {
        sectionSchemaExtension = {
          children:
            extendType === FormSchemaExtendType.Append
              ? [...currentChildren, schemaExtension]
              : [schemaExtension, ...currentChildren],
        } as Partial<FormKitSchemaNode>
      } else {
        sectionSchemaExtension = {
          children: [schemaExtension],
        } as Partial<FormKitSchemaNode>
      }
    }

    const localExtensions = {
      ...extensions,
      [sectionKey]: sectionSchemaExtension,
    }
    return originalSchema(localExtensions)
  }

  props.definition = definition
}

export default extendSchemaDefinition