@dxtmisha/wiki 0.39.4 → 0.39.5

package/src/classes/WikiStorybookItem.ts

@@ -0,0 +1,400 @@
+import { Geo, isArray, isObjectNotArray } from '@dxtmisha/functional'
+
+import {
+  type StorybookArgsItem,
+  type StorybookArgsItemSummary,
+  type StorybookArgsToItem,
+  StorybookCategory,
+  StorybookControl
+} from '../types/storybookTypes'
+
+/**
+ * Class representing a Storybook wiki item
+ *
+ * Класс, представляющий элемент wiki для Storybook
+ */
+export class WikiStorybookItem {
+  /**
+   * Constructor
+   * @param name - The name of the item in the wiki/ Название элемента в wiki
+   * @param item - The item to convert to a Storybook args item/
+   * Элемент, который нужно преобразовать в элемент аргументов Storybook
+   */
+  constructor(
+    private readonly name: string,
+    private readonly item: StorybookArgsToItem
+  ) {
+  }
+
+  /**
+   * Checks if the item is hidden.
+   *
+   * Проверяет, скрыт ли элемент.
+   */
+  isHide(): boolean {
+    return this.item.hide === true
+  }
+
+  /**
+   * Checks if the item is a demo item.
+   *
+   * Проверяет, является ли элемент демонстрационным.
+   */
+  isDemo(): boolean {
+    return this.item.isDemo === true
+  }
+
+  /**
+   * Returns the name of the item in the wiki
+   *
+   * Возвращает название элемента в wiki
+   * @return The name of the item in the wiki/ название элемента в wiki
+   */
+  getName(): string {
+    return this.name
+  }
+
+  /**
+   * Returns the value of the item in the wiki
+   *
+   * Возвращает значение элемента в wiki
+   * @return The value of the item in the wiki/ значение элемента в wiki
+   */
+  getValue(): any {
+    return this.item.options.value
+  }
+
+  /**
+   * Returns the order of the item in the wiki
+   *
+   * Возвращает порядок элемента в wiki
+   * @return The order of the item in the wiki/ порядок элемента в wiki
+   */
+  getOrder(): number {
+    if (this.item.options.order) {
+      return this.item.options.order
+    }
+
+    const category = this.item.options.category
+
+    switch (category) {
+      case StorybookCategory.status:
+        return 3000
+      case StorybookCategory.value:
+        return 5000
+      case StorybookCategory.information:
+        return 5100
+      case StorybookCategory.actions:
+        return 5200
+      case StorybookCategory.icon:
+        return 5200
+      case StorybookCategory.bars:
+        return 5200
+      case StorybookCategory.counter:
+        return 5200
+      case StorybookCategory.mask:
+        return 5200
+      case StorybookCategory.form:
+        return 6000
+      case StorybookCategory.arrow:
+        return 6900
+      case StorybookCategory.hook:
+        return 7000
+      case StorybookCategory.style:
+        return 9000
+      case StorybookCategory.option:
+        return 9100
+      case StorybookCategory.attributes:
+        return 9700
+      case StorybookCategory.text:
+        return 9800
+      case StorybookCategory.aria:
+        return 9900
+      default:
+        return 9999
+    }
+  }
+
+  /**
+   * Converts the Wiki item to a Storybook args item
+   *
+   * Преобразует элемент Wiki в элемент аргументов Storybook
+   */
+  to(): StorybookArgsItem {
+    switch (this.item.type) {
+      case StorybookControl.text:
+      case StorybookControl.string:
+        return this.toString()
+      case StorybookControl.number:
+        return this.toNumber()
+      case StorybookControl.boolean:
+        return this.toBoolean()
+      case StorybookControl.select:
+        return this.toSelect()
+      case StorybookControl.object:
+      case StorybookControl.array:
+        return this.toObject()
+    }
+  }
+
+  /**
+   * Returns the demo property if the item is a demo item.
+   *
+   * Возвращает свойство demo, если элемент является демонстрационным.
+   */
+  private getDemo(): {
+    isDemo?: boolean
+    demo?: any
+    demoOptions?: Record<string, any>
+    hide?: boolean
+  } {
+    if (this.isDemo()) {
+      return {
+        isDemo: true,
+        demo: this.getDemoValue(),
+        demoOptions: this.item.demoOptions,
+        hide: this.item.hide
+      }
+    }
+
+    return {
+      hide: this.item.hide
+    }
+  }
+
+  /**
+   * Returns the demo value.
+   *
+   * Возвращает демонстрационное значение.
+   */
+  private getDemoValue(): any {
+    if (this.item.demo) {
+      return this.item.demo
+    }
+
+    if (this.item.type === StorybookControl.boolean) {
+      return true
+    }
+
+    return undefined
+  }
+
+  /**
+   * Returns the category type of a property
+   *
+   * Возвращает тип категории у свойства
+   */
+  private getCategory(): { category?: StorybookCategory } {
+    const category = this.item.options.category
+
+    if (category) {
+      return { category }
+    }
+
+    return {}
+  }
+
+  /**
+   * Returns the default property values
+   *
+   * Возвращает значения свойства по умолчанию
+   */
+  private getDefaultValue(): { defaultValue?: StorybookArgsItemSummary } {
+    const type = this.item.options.type
+    const defaultValue = this.item.options.defaultValue
+    let value: string | undefined = undefined
+
+    if (defaultValue !== undefined) {
+      switch (typeof defaultValue) {
+        case 'boolean':
+          value = defaultValue ? 'true' : 'false'
+          break
+        default:
+          value = String(defaultValue)
+          break
+      }
+    } else if (type === 'boolean') {
+      value = 'false'
+    }
+
+    if (value) {
+      return {
+        defaultValue: { summary: value }
+      }
+    }
+
+    return {}
+  }
+
+  /**
+   * Returns a property description based on the language
+   *
+   * Возвращает описание свойства с учетом языка
+   */
+  private getDescription(): { description?: string } {
+    const language = Geo.getLanguage()
+    const description = this.item.options.description
+    let value: string | undefined = undefined
+
+    if (typeof description === 'string') {
+      value = description
+    } else if (
+      isObjectNotArray(description)
+      && language in description
+    ) {
+      value = description[language]
+    }
+
+    if (value) {
+      return { description: value }
+    }
+
+    return {}
+  }
+
+  /**
+   * Returns the type of property
+   *
+   * Возвращает тип свойства
+   */
+  private getType(): { type?: StorybookArgsItemSummary } {
+    const type = this.item.options.type
+    const options = this.item.options.options
+    let value: string | undefined = undefined
+
+    if (options) {
+      if (isArray(options)) {
+        value = options.join(' | ')
+      } else if (isObjectNotArray(options)) {
+        value = Object.keys(options).join(' | ')
+      }
+    } else if (type) {
+      if (isArray(type)) {
+        value = type.join(' | ')
+      } else {
+        value = type
+      }
+    } else {
+      switch (this.item.type) {
+        case StorybookControl.select:
+          value = String(StorybookControl.object)
+          break
+        case StorybookControl.text:
+          value = String(StorybookControl.string)
+          break
+        default:
+          value = String(this.item.type)
+      }
+    }
+
+    if (value) {
+      return {
+        type: { summary: value }
+      }
+    }
+
+    return {}
+  }
+
+  /**
+   * Function to create a Storybook args object with boolean type
+   *
+   * Функция для создания объекта аргументов Storybook с типом boolean
+   */
+  private toBoolean(): StorybookArgsItem {
+    return {
+      control: StorybookControl.boolean,
+      table: {
+        ...this.getCategory(),
+        ...this.getDefaultValue(),
+        ...this.getType()
+      },
+      ...this.getDescription(),
+      ...this.getDemo()
+    }
+  }
+
+  /**
+   * Function to create a Storybook args object with number type
+   *
+   * Функция для создания объекта аргументов Storybook с типом number
+   */
+  private toNumber(): StorybookArgsItem {
+    const options = this.item.options
+    const control: StorybookArgsItem['control'] = { type: StorybookControl.number }
+    const table: StorybookArgsItem['table'] = {
+      ...this.getCategory(),
+      ...this.getDefaultValue(),
+      ...this.getType()
+    }
+
+    if ('min' in options) {
+      control.min = options.min
+    }
+
+    if ('max' in options) {
+      control.min = options.max
+    }
+
+    return {
+      control,
+      table,
+      ...this.getDescription(),
+      ...this.getDemo()
+    }
+  }
+
+  /**
+   * Function to create a Storybook args object with object type
+   *
+   * Функция для создания объекта аргументов Storybook с типом object
+   */
+  private toObject(): StorybookArgsItem {
+    return {
+      control: StorybookControl.object,
+      table: {
+        ...this.getCategory(),
+        ...this.getType()
+      },
+      ...this.getDescription(),
+      ...this.getDemo()
+    }
+  }
+
+  /**
+   * Function to create a Storybook args object with select type
+   *
+   * Функция для создания объекта аргументов Storybook с типом select
+   */
+  private toSelect(): StorybookArgsItem {
+    return {
+      control: StorybookControl.select,
+      options: this.item.options.options,
+      table: {
+        ...this.getCategory(),
+        ...this.getDefaultValue(),
+        ...this.getType()
+      },
+      ...this.getDescription(),
+      ...this.getDemo()
+    }
+  }
+
+  /**
+   * Function to create a Storybook args object with string type
+   *
+   * Функция для создания объекта аргументов Storybook с типом string
+   */
+  private toString(): StorybookArgsItem {
+    return {
+      control: StorybookControl.text,
+      table: {
+        ...this.getCategory(),
+        ...this.getDefaultValue(),
+        ...this.getType()
+      },
+      ...this.getDescription(),
+      ...this.getDemo()
+    }
+  }
+}

package/src/classes/WikiStorybookProp.ts

@@ -0,0 +1,118 @@
+import { isString, toKebabCase } from '@dxtmisha/functional-basic'
+import { type StorybookArgsItem, StorybookControl } from '../types/storybookTypes'
+
+/**
+ * Class for working with a single Storybook property.
+ *
+ * Класс для работы с одним свойством Storybook.
+ */
+export class WikiStorybookProp {
+  /**
+   * Constructor
+   * @param name property name / имя свойства
+   * @param item property configuration / конфигурация свойства
+   */
+  constructor(
+    public readonly name: string,
+    protected readonly item: StorybookArgsItem
+  ) {
+  }
+
+  /**
+   * Checks if the item is hidden.
+   *
+   * Проверяет, скрыт ли элемент.
+   */
+  isHide(): boolean {
+    return this.item.hide === true
+  }
+
+  /**
+   * Checks if the item is a demo item.
+   *
+   * Проверяет, является ли элемент демонстрационным.
+   */
+  isDemo(): boolean {
+    return this.item.isDemo === true
+  }
+
+  /**
+   * Returns the property configuration.
+   *
+   * Возвращает конфигурацию свойства.
+   */
+  get(): StorybookArgsItem {
+    return this.item
+  }
+
+  /**
+   * Returns the property name.
+   *
+   * Возвращает имя свойства.
+   */
+  getName(): string {
+    return toKebabCase(this.name)
+  }
+
+  /**
+   * Returns the default value of the property.
+   *
+   * Возвращает значение по умолчанию для свойства.
+   */
+  getDefaultValue(): any {
+    return this.item?.table?.defaultValue?.summary
+  }
+
+  /**
+   * Returns the property type.
+   *
+   * Возвращает тип свойства.
+   */
+  getType(): string {
+    if (this.item?.table?.type?.summary) {
+      return this.item.table.type.summary
+    }
+
+    if (isString(this.item.control)) {
+      return this.item.control
+    }
+
+    return this.item.control?.type ?? StorybookControl.string
+  }
+
+  /**
+   * Returns the property description.
+   *
+   * Возвращает описание свойства.
+   */
+  getDescription(): string {
+    return this.item.description ?? ''
+  }
+
+  /**
+   * Returns the property options.
+   *
+   * Возвращает опции свойства.
+   */
+  getOptions(): StorybookArgsItem['options'] {
+    return this.item.options
+  }
+
+  /**
+   * Returns the demo data.
+   *
+   * Возвращает демонстрационные данные.
+   */
+  getDemo(): any {
+    return this.item.demo
+  }
+
+  /**
+   * Returns the additional demo data.
+   *
+   * Возвращает дополнительные демонстрационные данные.
+   */
+  getDemoOptions(): Record<string, any> {
+    return this.item.demoOptions ?? {}
+  }
+}

package/src/library-lite.ts

@@ -0,0 +1,9 @@
+// Classes
+export * from './classes/WikiStorybook'
+export * from './classes/WikiStorybookDescriptions'
+export * from './classes/WikiStorybookItem'
+export * from './classes/WikiStorybookProp'
+
+// Types
+export * from './types/storybookTypes'
+export * from './types/wikiTypes'

package/src/library.ts

@@ -1,13 +1,11 @@
-// Classes
-export * from './classes/WikiStorybook'
-export * from './classes/WikiStorybookDescriptions'
-export * from './classes/WikiStorybookItem'
-export * from './classes/WikiStorybookProp'
+import { WikiStorybookDescriptions } from './classes/WikiStorybookDescriptions'
 
-// Types
-export * from './types/storybookTypes'
-export * from './types/wikiTypes'
+import { wikiDescriptions } from './media/descriptions/wikiDescriptions'
+import { wikiMdx } from './media/mdx/wikiMdx'
 
-// Media
-export * from './media/props/wiki'
-export * from './media/descriptions/wikiDescriptions'
+WikiStorybookDescriptions.setWiki(
+  wikiDescriptions,
+  wikiMdx
+)
+
+export * from './library-lite'

package/src/media/descriptions/wikiDescriptions.ts

@@ -0,0 +1,109 @@
+import type { StorybookComponentsDescription } from '../../types/storybookTypes'
+
+import { wikiDescriptionsAccordion } from './wikiDescriptionsAccordion'
+import { wikiDescriptionsActions } from './wikiDescriptionsActions'
+import { wikiDescriptionsActionSheet } from './wikiDescriptionsActionSheet'
+import { wikiDescriptionsAnchor } from './wikiDescriptionsAnchor'
+import { wikiDescriptionsArrow } from './wikiDescriptionsArrow'
+import { wikiDescriptionsBadge } from './wikiDescriptionsBadge'
+import { wikiDescriptionsBars } from './wikiDescriptionsBars'
+import { wikiDescriptionsBlock } from './wikiDescriptionsBlock'
+import { wikiDescriptionsButton } from './wikiDescriptionsButton'
+import { wikiDescriptionsCell } from './wikiDescriptionsCell'
+import { wikiDescriptionsCheckbox } from './wikiDescriptionsCheckbox'
+import { wikiDescriptionsChip } from './wikiDescriptionsChip'
+import { wikiDescriptionsChipGroup } from './wikiDescriptionsChipGroup'
+import { wikiDescriptionsDialog } from './wikiDescriptionsDialog'
+import { wikiDescriptionsDummy } from './wikiDescriptionsDummy'
+import { wikiDescriptionsField } from './wikiDescriptionsField'
+import { wikiDescriptionsFieldCounter } from './wikiDescriptionsFieldCounter'
+import { wikiDescriptionsFieldLabel } from './wikiDescriptionsFieldLabel'
+import { wikiDescriptionsFieldMessage } from './wikiDescriptionsFieldMessage'
+import { wikiDescriptionsGrid } from './wikiDescriptionsGrid'
+import { wikiDescriptionsGridItem } from './wikiDescriptionsGridItem'
+import { wikiDescriptionsGroup } from './wikiDescriptionsGroup'
+import { wikiDescriptionsHorizontalScroll } from './wikiDescriptionsHorizontalScroll'
+import { wikiDescriptionsIcon } from './wikiDescriptionsIcon'
+import { wikiDescriptionsImage } from './wikiDescriptionsImage'
+import { wikiDescriptionsInput } from './wikiDescriptionsInput'
+import { wikiDescriptionsList } from './wikiDescriptionsList'
+import { wikiDescriptionsListGroup } from './wikiDescriptionsListGroup'
+import { wikiDescriptionsListItem } from './wikiDescriptionsListItem'
+import { wikiDescriptionsListMenu } from './wikiDescriptionsListMenu'
+import { wikiDescriptionsMask } from './wikiDescriptionsMask'
+import { wikiDescriptionsMenu } from './wikiDescriptionsMenu'
+import { wikiDescriptionsModal } from './wikiDescriptionsModal'
+import { wikiDescriptionsMotionAxis } from './wikiDescriptionsMotionAxis'
+import { wikiDescriptionsMotionTransform } from './wikiDescriptionsMotionTransform'
+import { wikiDescriptionsPage } from './wikiDescriptionsPage'
+import { wikiDescriptionsProgress } from './wikiDescriptionsProgress'
+import { wikiDescriptionsRipple } from './wikiDescriptionsRipple'
+import { wikiDescriptionsScrollbar } from './wikiDescriptionsScrollbar'
+import { wikiDescriptionsSection } from './wikiDescriptionsSection'
+import { wikiDescriptionsSelect } from './wikiDescriptionsSelect'
+import { wikiDescriptionsSelectValue } from './wikiDescriptionsSelectValue'
+import { wikiDescriptionsSkeleton } from './wikiDescriptionsSkeleton'
+import { wikiDescriptionsSnackbar } from './wikiDescriptionsSnackbar'
+import { wikiDescriptionsSnackbarItem } from './wikiDescriptionsSnackbarItem'
+import { wikiDescriptionsTabItem } from './wikiDescriptionsTabItem'
+import { wikiDescriptionsTabs } from './wikiDescriptionsTabs'
+import { wikiDescriptionsTabsNavigation } from './wikiDescriptionsTabsNavigation'
+import { wikiDescriptionsTextarea } from './wikiDescriptionsTextarea'
+import { wikiDescriptionsTextareaAutosize } from './wikiDescriptionsTextareaAutosize'
+import { wikiDescriptionsTooltip } from './wikiDescriptionsTooltip'
+import { wikiDescriptionsWindow } from './wikiDescriptionsWindow'
+
+export const wikiDescriptions: StorybookComponentsDescription = [
+  wikiDescriptionsAccordion,
+  wikiDescriptionsActions,
+  wikiDescriptionsActionSheet,
+  wikiDescriptionsAnchor,
+  wikiDescriptionsArrow,
+  wikiDescriptionsBadge,
+  wikiDescriptionsBars,
+  wikiDescriptionsBlock,
+  wikiDescriptionsButton,
+  wikiDescriptionsCell,
+  wikiDescriptionsCheckbox,
+  wikiDescriptionsChip,
+  wikiDescriptionsChipGroup,
+  wikiDescriptionsDialog,
+  wikiDescriptionsDummy,
+  wikiDescriptionsField,
+  wikiDescriptionsFieldCounter,
+  wikiDescriptionsFieldLabel,
+  wikiDescriptionsFieldMessage,
+  wikiDescriptionsGrid,
+  wikiDescriptionsGridItem,
+  wikiDescriptionsGroup,
+  wikiDescriptionsHorizontalScroll,
+  wikiDescriptionsIcon,
+  wikiDescriptionsInput,
+  wikiDescriptionsImage,
+  wikiDescriptionsList,
+  wikiDescriptionsListGroup,
+  wikiDescriptionsListItem,
+  wikiDescriptionsListMenu,
+  wikiDescriptionsMask,
+  wikiDescriptionsMenu,
+  wikiDescriptionsModal,
+  wikiDescriptionsMotionAxis,
+  wikiDescriptionsMotionTransform,
+  wikiDescriptionsPage,
+  wikiDescriptionsProgress,
+  wikiDescriptionsRipple,
+  wikiDescriptionsScrollbar,
+  wikiDescriptionsSection,
+  wikiDescriptionsSelect,
+  wikiDescriptionsSelectValue,
+  wikiDescriptionsSkeleton,
+  wikiDescriptionsSnackbar,
+  wikiDescriptionsSnackbarItem,
+  wikiDescriptionsTabItem,
+  wikiDescriptionsTabs,
+  wikiDescriptionsTabsNavigation,
+  wikiDescriptionsTextarea,
+  wikiDescriptionsTextareaAutosize,
+  wikiDescriptionsTooltip,
+  wikiDescriptionsWindow
+]