@dxtmisha/scripts/src/classes/Properties/to/PropertiesToSimilar.ts

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

import { isObjectNotArray } from '@dxtmisha/functional'

import { PropertiesToAbstract } from './PropertiesToAbstract'

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

const TYPE = [
  PropertyType.var,
  PropertyType.property
]

const EXCEPTION = [
  PropertyType.classType,
  PropertyType.subclass
]

/**
 * A class for searching for related properties at a higher level to adopt their properties.
 *
 * Класс для поиска родственных свойств на уровне выше для принятия их свойств.
 */
export class PropertiesToSimilar extends PropertiesToAbstract {
  protected readonly FILE_CACHE = '010-similar'

  /**
   * Finding similar data for editing.
   *
   * Поиск похожих данных для редактирования.
   */
  protected init(): void {
    this.items.each(({
      item,
      name,
      parents
    }) => {
      const similar = this.getParent(name, item, parents)

      if (similar) {
        item[PropertyKey.rename] = this.items.getReName(name, similar)
        item[PropertyKey.variable] = similar?.[PropertyKey.variable]
      }
    })
  }

  /**
   * Returns similar values by its name.
   *
   * Возвращает похожие значения по его имени.
   * @param name name of the name/ название имени
   * @param item object for checking/ объект для проверки
   * @param parents array of all ancestor properties along the tree from the top level/
   * массив со всеми свойствами предков по дереву от верхнего уровня
   */
  private getParent(
    name: string,
    item: PropertyItem,
    parents: PropertyItemsParent[]
  ): PropertyItem | undefined {
    const list = [...parents].reverse()

    if (
      !item?.[PropertyKey.type]
      && !item?.[PropertyKey.rename]
      && !this.isException(item)
      && !this.isException(list?.[0]?.item)
    ) {
      list.shift()

      for (const { item } of list) {
        if (isObjectNotArray(item.value)) {
          const similar = item.value?.[name]

          if (this.isException(item)) {
            break
          } else if (
            similar
            && this.is(similar) && (
              similar?.[PropertyKey.type]
              || similar?.[PropertyKey.rename]
            )
          ) {
            return similar
          }
        }
      }
    }

    return undefined
  }

  /**
   * Checks if the property is available for inheritance.
   *
   * Проверяет, доступно ли свойство для наследования.
   * @param item object for checking/ объект для проверки
   */
  private is(item: PropertyItem): boolean {
    if (item?.[PropertyKey.variable]) {
      return TYPE.indexOf(item?.[PropertyKey.variable]) !== -1
    }

    return false
  }

  /**
   * Checks if inheriting the property is prohibited.
   *
   * Проверяет, запрещено ли наследовать свойство.
   * @param item object for checking/ объект для проверки
   */
  private isException(item?: PropertyItem): boolean {
    if (
      item
      && item?.[PropertyKey.variable]
    ) {
      return EXCEPTION.indexOf(item[PropertyKey.variable]) !== -1
    }

    return false
  }
}