@dxtmisha/scripts/src/classes/Properties/PropertiesSeparator.ts

Development scripts and CLI tools for DXT UI projects - automated component generation, library building and project management tools

import { forEach, isObjectNotArray, replaceRecursive } from '@dxtmisha/functional'

import { PropertiesConfig } from './PropertiesConfig'
import { PropertiesKeys } from './PropertiesKeys'

import {
  type PropertyItem,
  PropertyKey,
  type PropertyList
} from '../../types/propertyTypes'

/**
 * Class for working with property splitting into multiple sub-properties.
 *
 * Класс для работы с разделением свойства на множество под-свойств.
 */
export class PropertiesSeparator {
  /**
   * Checks if the structure has grouped records.
   *
   * Проверяет, есть ли у структуры сгруппированные записи.
   * @param properties an array that needs to be transformed/
   * массив, который нужно преобразовать
   * @param limit the maximum permissible level of verification/
   * максимальный допустимый уровень проверки
   */
  static is(
    properties: PropertyList,
    limit = PropertiesConfig.getSeparatorLimit()
  ): boolean {
    if (limit > 0) {
      for (const index in properties) {
        if (PropertiesKeys.isSeparator(index)) {
          return true
        }

        const value = properties?.[index]?.value

        if (
          value
          && isObjectNotArray(value)
          && this.is(value, limit - 1)
        ) {
          return true
        }
      }
    }

    return false
  }

  /**
   * Transforming a property with long names with separators into a set of sub-properties.
   *
   * Преобразование свойства с длинными названиями с разделителями на множество под-свойств.
   * @param properties an array that needs to be transformed/ массив, который нужно преобразовать
   */
  static to(properties: PropertyList): PropertyList {
    let data: PropertyList = {}

    forEach(properties, (item, name) => {
      const newItem: PropertyItem = {
        ...item,
        value: isObjectNotArray(item.value) ? this.to(item.value) : item.value
      }

      if (PropertiesKeys.isSeparator(name)) {
        data = replaceRecursive(data, this.wrap(newItem, this.removeBasicName(name)))
      } else {
        data = replaceRecursive(data, { [name]: newItem })
      }
    })

    return data
  }

  /**
   * Removing unnecessary characters from the name.
   *
   * Удаление лишних символов из названия.
   * @param name property names/ названия свойств
   */
  private static removeBasicName(name: string): string[] {
    const separator = PropertiesConfig.getSeparator()
    const basicName = PropertiesConfig.getSeparatorBasicName()

    return name
      .replace(new RegExp(`${separator}${basicName}`, 'g'), '')
      .replace(new RegExp(`${separator}$`), '')
      .split(separator)
  }

  /**
   * Packs a property into objects by an array of titles.
   *
   * Упаковывает свойство в объекты по массиву названий.
   * @param item property values/ значения свойств
   * @param list array of titles/ массив названий
   */
  private static wrap(item: PropertyItem, list: string[]): PropertyList {
    let data = item;

    [...list]
      .reverse()
      .forEach((name) => {
        data = {
          value: {
            [name]: {
              ...data,
              [PropertyKey.wrap]: true
            }
          }
        }
      })

    return data.value as PropertyList
  }
}