@dxtmisha/constructor 0.23.0 → 0.39.3

package/src/constructors/Menu/MenuInclude.ts

@@ -1,110 +0,0 @@
-import { computed, ref, type VNode } from 'vue'
-import {
-  type ConstrBind,
-  DesignComponents,
-  getRef,
-  type RawSlots,
-  type RefOrNormal,
-  toBind
-} from '@dxtmisha/functional'
-
-import type { MenuComponentInclude, MenuExposeInclude, MenuPropsInclude } from './basicTypes'
-import type { MenuExpose, MenuSlots } from './types'
-import type { MenuProps } from './props'
-
-/**
- * MenuInclude class provides functionality for conditionally rendering menu components
- * within other components. It manages the logic for determining when to display menu
- * and configures the appropriate properties.
- *
- * Класс MenuInclude предоставляет функциональность для условного рендеринга компонентов
- * меню внутри других компонентов. Он управляет логикой определения необходимости
- * отображения меню и настраивает соответствующие свойства.
- */
-export class MenuInclude<
-  Props extends MenuPropsInclude = MenuPropsInclude,
-  PropsExtra extends ConstrBind<MenuProps> = ConstrBind<MenuProps>
-> {
-  /** Reference to menu element/ Ссылка на элемент меню */
-  protected readonly element = ref<ConstrBind<MenuExpose> | undefined>()
-
-  /**
-   * Constructor
-   * @param props input parameter/ входной параметр
-   * @param className class name/ название класса
-   * @param components object for working with components/ объект для работы с компонентами
-   * @param extra additional parameter or property name/ дополнительный параметр или имя свойства
-   * @param index index identifier/ идентификатор индекса
-   */
-  constructor(
-    protected readonly props: Readonly<Props>,
-    protected readonly className: string,
-    protected readonly components?: DesignComponents<MenuComponentInclude, Props>,
-    protected readonly extra?: RefOrNormal<PropsExtra>,
-    protected readonly index?: string
-  ) {
-  }
-
-  /**
-   * Checks whether menu should be displayed/
-   * Проверяет, нужно ли отображать меню
-   */
-  readonly is = computed(() => Boolean(!this.props.disabled && this.components))
-
-  /** Computed bindings for the menu/ Вычисляемые привязки для меню */
-  readonly binds = computed<PropsExtra>(() => {
-    const props = toBind<PropsExtra>(
-      toBind(
-        getRef(this.extra) ?? {},
-        this.props.menuAttrs ?? {}
-      ),
-      { class: `${this.className}__menu` }
-    )
-
-    return {
-      ...props,
-      disabled: this.props.disabled
-    }
-  })
-
-  /** Menu expose functionality/ Функциональность экспорта меню */
-  readonly expose: MenuExposeInclude = {
-    open: computed(() => Boolean(this.element.value?.open)),
-    setOpen: async (open: boolean) => this.element.value?.setOpen(open),
-    toOpen: async () => this.element.value?.toOpen(),
-    toClose: async () => this.element.value?.toClose(),
-    toggle: async () => this.element.value?.toggle(),
-
-    menuElement: this.element
-  }
-
-  /**
-   * Render the Menu component
-   *
-   * Рендер компонента меню
-   * @param slotsChildren menu slots/ слоты меню
-   * @param attrs additional attributes/ дополнительные атрибуты
-   * @returns VNode array/ массив VNode
-   */
-  readonly render = (
-    slotsChildren?: MenuSlots,
-    attrs?: Record<string, any>
-  ): VNode[] => {
-    if (this.components && this.is.value) {
-      return this.components.render(
-        'menu',
-        {
-          ref: this.element,
-          ...toBind(
-            attrs ?? {},
-            this.binds.value
-          )
-        },
-        slotsChildren as RawSlots,
-        this.index
-      )
-    }
-
-    return []
-  }
-}

package/src/constructors/Menu/MenuRequest.ts

@@ -1,101 +0,0 @@
-import { computed, ref } from 'vue'
-import { Api, executePromise, isFunction, type ListRecord } from '@dxtmisha/functional'
-
-import type { MenuProps } from './props'
-
-/**
- * Class for working with list data requests.
- *
- * Класс для работы с запросами данных списка.
- */
-export class MenuRequest {
-  readonly progress = ref<boolean>(false)
-
-  protected readonly buffer = ref<ListRecord>()
-
-  /**
-   * Constructor
-   * @param props input data/ входные данные
-   */
-  constructor(
-    protected readonly props: MenuProps
-  ) {
-  }
-
-  /**
-   * Returns current list data.
-   *
-   * Возвращает текущие данные списка.
-   */
-  readonly item = computed(() => this.buffer.value ?? this.props.list ?? [])
-
-  /**
-   * Checks whether a request is needed.
-   *
-   * Проверяет, нужно ли делать запрос.
-   */
-  is(): boolean {
-    return Boolean(
-      this.props.ajax
-      || this.props.request
-    )
-  }
-
-  /**
-   * Prepares data.
-   *
-   * Подготавливает данные.
-   */
-  async preparation(): Promise<boolean> {
-    await this.update()
-
-    return true
-  }
-
-  /**
-   * Updates data.
-   *
-   * Обновляет данные.
-   */
-  async update(): Promise<void> {
-    await this.read(data => (this.buffer.value = data))
-  }
-
-  /**
-   * Returns data from AJAX or request function.
-   *
-   * Возвращает данные из AJAX или функции запроса.
-   */
-  protected async getAjax(): Promise<ListRecord | undefined> {
-    if (isFunction(this.props.ajax)) {
-      return executePromise(this.props.ajax)
-    }
-
-    return await Api.request<Record<string, any>>({
-      path: this.props.ajax,
-      ...this.props.request
-    })
-  }
-
-  /**
-   * Executes a request to retrieve data.
-   *
-   * Выполняет запрос для получения данных.
-   */
-  protected async read(callback: (data: ListRecord | undefined) => void): Promise<void> {
-    if (this.is()) {
-      if (
-        this.props.cache
-        && this.buffer.value !== undefined
-      ) {
-        callback(this.buffer.value)
-      }
-
-      this.progress.value = true
-
-      callback(await this.getAjax())
-
-      this.progress.value = false
-    }
-  }
-}

package/src/constructors/Menu/MenuSearch.ts

@@ -1,49 +0,0 @@
-import { ref } from 'vue'
-import { isFilled } from '@dxtmisha/functional'
-
-/**
- * Class for working with search.
- *
- * Класс для работы с поиском.
- */
-export class MenuSearch {
-  readonly item = ref<string>()
-
-  /**
-   * Sets the search string.
-   *
-   * Устанавливает строку поиска.
-   * @param value new value/ новое значение
-   */
-  set(value?: string) {
-    const data = this.getValue(value)
-
-    if (this.item.value !== data) {
-      this.item.value = data
-    }
-  }
-
-  /**
-   * Resets the search string.
-   *
-   * Сбрасывает строку поиска.
-   */
-  reset(): this {
-    this.set()
-    return this
-  }
-
-  /**
-   * Returns a processed value.
-   *
-   * Возвращает обработанное значение.
-   * @param value source value/ исходное значение
-   */
-  protected getValue(value?: string): string | undefined {
-    if (isFilled(value)) {
-      return value.trim()
-    }
-
-    return undefined
-  }
-}

package/src/constructors/Menu/MenuValue.ts

@@ -1,73 +0,0 @@
-import { computed, ref, type ToRefs, watch } from 'vue'
-import { type ConstrEmit, isObject, type ListSelectedList } from '@dxtmisha/functional'
-
-import { ModelInclude } from '../../classes/ModelInclude'
-
-import type { MenuEmits } from './types'
-import type { MenuProps } from './props'
-
-/**
- * Value manager for Menu
- *
- * Менеджер значения для Menu
- */
-export class MenuValue {
-  readonly value = ref<ListSelectedList>()
-
-  /**
-   * Constructor
-   * @param props input data/ входные данные
-   * @param refs input data in the form of reactive elements/ входные данные в виде реактивных элементов
-   * @param emits the function is called when an event is triggered/ функция вызывается, когда срабатывает событие
-   */
-  constructor(
-    protected readonly props: MenuProps,
-    protected readonly refs: ToRefs<MenuProps>,
-    protected readonly emits?: ConstrEmit<MenuEmits>
-  ) {
-    if (this.props.isSelectedByValue) {
-      new ModelInclude('value', this.emits, this.value)
-
-      if (refs.selected) {
-        watch(
-          refs.selected,
-          (value) => {
-            this.value.value = value
-          },
-          { immediate: true }
-        )
-      }
-    }
-  }
-
-  /**
-   * Computed selected value
-   *
-   * Вычисляемое выбранное значение
-   */
-  readonly selected = computed(() => {
-    if (this.props.isSelectedByValue) {
-      return this.value.value
-    }
-
-    return this.props.selected
-  })
-
-  /**
-   * Sets a new selected value if it has changed and returns the instance for chaining.
-   *
-   * Устанавливает новое выбранное значение, если оно изменилось, и возвращает экземпляр для чейнинга.
-   * @param value selected list value/ выбранное значение списка
-   * @returns this
-   */
-  setValue(value: ListSelectedList): this {
-    if (
-      this.props.isSelectedByValue
-      && !isObject(value)
-      && this.value.value !== value
-    ) {
-      this.value.value = value
-    }
-    return this
-  }
-}

package/src/constructors/Menu/MenuWindow.ts

@@ -1,89 +0,0 @@
-import { ref } from 'vue'
-
-import { MenuRequest } from './MenuRequest'
-
-import type { WindowProps } from '../Window'
-import type { MenuProps } from './props'
-
-/**
- * Window manager for Menu component
- *
- * Класс управления окном для компонента Menu
- */
-export class MenuWindow {
-  readonly lite = ref<boolean>()
-  readonly control = ref<boolean>()
-
-  /**
-   * Constructor
-   * @param props input data/ входные данные
-   * @param request menu request handler/ обработчик запросов меню
-   */
-  constructor(
-    protected readonly props: MenuProps,
-    protected readonly request: MenuRequest
-  ) {
-  }
-
-  /**
-   * Returns extra methods for window management
-   *
-   * Возвращает дополнительные методы для управления окном
-   * @returns object with window management methods/ объект с методами управления окном
-   */
-  getExtra(): WindowProps {
-    return {
-      adaptive: 'menu',
-      preparation: this.preparation,
-      opening: this.opening,
-      closing: this.closing
-    }
-  }
-
-  /**
-   * Preparing data before opening the menu
-   *
-   * Подготовка данных перед открытием меню
-   * @returns Promise that resolves to true when preparation is complete/
-   * Promise, который разрешается в true после завершения подготовки
-   */
-  protected readonly preparation = async (): Promise<void> => {
-    await this.request.preparation()
-
-    if (
-      this.props.list
-      && this.props.liteThreshold
-      && Number(this.props.liteThreshold) <= Object.keys(this.props.list).length
-    ) {
-      this.lite.value = true
-    }
-  }
-
-  /**
-   * Actions performed after opening the window
-   *
-   * Действия, выполняемые после открытия окна
-   * @returns Promise that resolves to true when opening actions are complete/
-   * Promise, который разрешается в true после завершения действий открытия
-   */
-  protected readonly opening = async (): Promise<boolean> => {
-    this.lite.value = false
-    this.control.value = true
-
-    return true
-  }
-
-  /**
-   * Actions performed when closing the window
-   *
-   * Действия, выполняемые при закрытии окна
-   * @returns Promise that resolves to true when closing actions are complete/
-   * Promise, который разрешается в true после завершения действий закрытия
-   */
-  protected readonly closing = async (): Promise<boolean> => {
-    this.lite.value = false
-    this.control.value = false
-
-    return true
-  }
-}

package/src/constructors/Menu/basicTypes.ts

@@ -1,41 +0,0 @@
-import type { ComputedRef, Ref } from 'vue'
-import type { ConstrBind } from '@dxtmisha/functional'
-import type { WindowControlItem } from '../Window'
-
-import type { ListExpose } from '../List'
-import type { MenuExpose } from './types'
-import type { MenuProps } from './props'
-
-export type MenuControlBasic
-  = ListExpose
-    & {
-      loading: Ref<boolean>
-    }
-
-export type MenuControlItem
-  = MenuControlBasic
-    & WindowControlItem
-
-export type MenuComponentInclude = {
-  menu?: object
-}
-
-/** Type for menu expose functionality/ Тип для функциональности экспорта меню */
-export interface MenuExposeInclude {
-  open: ComputedRef<boolean>
-
-  setOpen(open: boolean): Promise<void>
-
-  toOpen: MenuExpose['toOpen']
-  toClose: MenuExpose['toClose']
-
-  toggle(): Promise<void>
-
-  menuElement: Ref<ConstrBind<MenuExpose> | undefined>
-}
-
-/** Interface for menu include props/ Интерфейс для свойств включения меню */
-export interface MenuPropsInclude {
-  disabled?: boolean
-  menuAttrs?: ConstrBind<MenuProps>
-}

package/src/constructors/Menu/index.ts

@@ -1,6 +0,0 @@
-export * from './Menu'
-export * from './MenuDesign'
-export * from './MenuInclude'
-export * from './props'
-export * from './types'
-export * from './basicTypes'

package/src/constructors/Menu/properties.json

@@ -1,17 +0,0 @@
-{
-  "barsDisplay": {
-    "_type": "var"
-  },
-  "#bars": {},
-  "#list": {},
-  "~hideList": {},
-  "~barsAdaptive": {
-    "showAlways": {
-      "barsDisplay": "flex"
-    },
-    "group|show": {
-      "link|barsAdaptive-show": "{??barsAdaptive.showAlways}",
-      "_type": "media-group"
-    }
-  }
-}

package/src/constructors/Menu/props.ts

@@ -1,79 +0,0 @@
-import type {
-  ApiFetch,
-  ConstrBind,
-  ListRecord,
-  ListSelectedList,
-  NormalOrPromise
-} from '@dxtmisha/functional'
-
-import type { ListPropsBasic } from '../List'
-import type { ListItemProps, ListItemPropsBasic } from '../ListItem'
-import type { BarsPropsBasic, BarsPropsInclude } from '../Bars'
-import type { WindowPropsBasic, WindowPropsInclude } from '../Window'
-import type { ModelProps } from '../../types/modelTypes'
-
-interface MenuPropsToken {
-  // :type [!] System label / Системная метка
-  hideList?: boolean
-  barsAdaptive?: 'showAlways'
-  // :type [!] System label / Системная метка
-}
-
-export interface MenuPropsBasic<
-  List extends ListPropsBasic = ListPropsBasic,
-  ListItem extends ListItemPropsBasic = ListItemPropsBasic,
-  Bars extends BarsPropsBasic = BarsPropsBasic,
-  Window extends WindowPropsBasic = WindowPropsBasic
-> extends BarsPropsInclude<Bars>,
-  WindowPropsInclude<Window>,
-  ModelProps {
-  // Status
-  selected?: ListSelectedList
-  highlightLengthStart?: number
-  hideList?: boolean
-
-  // Value
-  list?: ListRecord<ListItem>
-  liteThreshold?: number
-
-  ajax?: string | (() => NormalOrPromise<ListRecord<ListItem>>)
-  request?: ApiFetch
-  cache?: boolean
-
-  keyLabel?: string
-  keyValue?: string
-
-  // Style
-  tag?: ListItemProps['tag']
-
-  listAttrs?: ConstrBind<List>
-  itemAttrs?: ConstrBind<ListItem>
-
-  // Technical
-  isSelectedByValue?: boolean
-}
-
-/**
- * Type describing incoming properties.
- *
- * Тип, описывающий входящие свойства.
- */
-export interface MenuProps extends MenuPropsBasic, MenuPropsToken {
-}
-
-/**
- * Default value for property.
- *
- * Значение по умолчанию для свойства.
- */
-export const defaultsMenu = {
-  liteThreshold: 40,
-  barsHide: true,
-  barsBackHide: true,
-  tag: 'a',
-  autoClose: true,
-  ...{
-    // :default [!] System label / Системная метка
-    // :default [!] System label / Системная метка
-  }
-}

package/src/constructors/Menu/types.ts

@@ -1,79 +0,0 @@
-import type { ConstrClass } from '@dxtmisha/functional'
-
-import type { EventClickEmits } from '../../types/eventClickTypes'
-
-import type { ListComponentInclude, ListSlots } from '../List'
-import type { BarsComponentInclude, BarsEmitsInclude } from '../Bars'
-import type { WindowComponentInclude, WindowEmitsInclude, WindowExposeInclude } from '../Window'
-import type { ModelEmits } from '../../types/modelTypes'
-
-import type { MenuControlBasic, MenuControlItem } from './basicTypes'
-
-/**
- * Interface for describing which components need to be connected for work.
- *
- * Интерфейс для описания, какие компоненты надо подключить для работы.
- */
-export type MenuComponents
-  = ListComponentInclude
-    & BarsComponentInclude
-    & WindowComponentInclude
-
-/**
- * Type describing available events.
- *
- * Тип, описывающий доступные события.
- */
-export type MenuEmits
-  = BarsEmitsInclude
-    & EventClickEmits
-    & WindowEmitsInclude
-    & ModelEmits
-    & {
-      clickSlot: [value?: string]
-    }
-
-/**
- * Type describing available properties.
- *
- * Тип, описывающий доступные свойства.
- */
-export interface MenuExpose extends WindowExposeInclude, MenuControlBasic {
-}
-
-/**
- * Type describing available slots.
- *
- * Тип, описывающий доступные слоты.
- */
-export type MenuSlots
-  = ListSlots
-    & {
-      /** Control slot for window management / Слот управления для управления окном */
-      control?(props: MenuControlItem): any
-
-      /** Footer slot for window bottom / Слот подвала для низа окна */
-      title?(props: MenuControlItem): any
-
-      /** Footer slot for window bottom/ Слот подвала для низа окна */
-      footer?(props: MenuControlItem): any
-
-      /** Context slot for top area / Слот контекстной области сверху */
-      contextTop?(props: MenuControlItem): any
-
-      /** Context slot for bottom area / Слот контекстной области снизу */
-      contextBottom?(props: MenuControlItem): any
-    }
-
-/**
- * Type describing subclasses.
- *
- * Тип, описывающий подклассы.
- */
-export type MenuClasses = {
-  main: ConstrClass
-  // :classes [!] System label / Системная метка
-  bars: string
-  list: string
-  // :classes [!] System label / Системная метка
-}