@dxtmisha/wiki 0.24.3 → 0.39.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dxtmisha/wiki",
   "private": false,
-  "version": "0.24.3",
+  "version": "0.39.1",
   "type": "module",
   "description": "Wiki documentation and storybook utilities for DXT UI design system",
   "keywords": [
@@ -43,15 +43,15 @@
     "./package.json": "./package.json"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "peerDependencies": {
-    "@dxtmisha/functional": ">=1.0.0",
-    "@dxtmisha/media": ">=0.3.0",
-    "@storybook/addon-docs": ">=9.0.0",
-    "@mdx-js/react": ">=2.0.0",
-    "react": ">=17.0.0",
-    "vue": ">=3.0.0"
+    "@dxtmisha/functional": "*",
+    "@dxtmisha/media": "*",
+    "@storybook/addon-docs": "*",
+    "@mdx-js/react": "*",
+    "react": "*",
+    "vue": "*"
   },
   "dependencies": {}
 }

package/src/classes/WikiStorybook.ts

@@ -1,12 +1,14 @@
-import { Geo, isObjectNotArray, toCamelCase } from '@dxtmisha/functional'
+import { forEach, Geo, isObjectNotArray, toCamelCase } from '@dxtmisha/functional'
 
 import { WikiStorybookItem } from './WikiStorybookItem'
+import { WikiStorybookProp } from './WikiStorybookProp'
 
 import {
   type StorybookArgs,
   type StorybookArgsToDescription,
   type StorybookArgsToItem,
   type StorybookArgsToList,
+  type StorybookArgsToPossibilities,
   type StorybookComponentsDescription,
   type StorybookComponentsDescriptionItem,
   type StorybookComponentsDescriptionStory,
@@ -63,6 +65,23 @@ export class WikiStorybook {
     return this.initPropsWiki()
   }
 
+  /**
+   * Returns the wiki object for the component
+   *
+   * Возвращает объект wiki для компонента
+   * @return The wiki object for the component/ объект wiki для компонента
+   */
+  getWikiObject(): WikiStorybookProp[] {
+    return forEach(
+      this.getWiki(),
+      (item, name) => {
+        if (item) {
+          return new WikiStorybookProp(name, item)
+        }
+      }
+    ) as WikiStorybookProp[]
+  }
+
   /**
    * Returns the description of the component from the wiki
    *
@@ -73,6 +92,16 @@ export class WikiStorybook {
     return this.toDescriptionText(this.getDescriptionItem()?.description)
   }
 
+  /**
+   * Returns the possibilities of the component from the wiki
+   *
+   * Возвращает возможности компонента из wiki
+   * @return A list of possibilities for the component/ список возможностей для компонента
+   */
+  getPossibilities(): string[] {
+    return this.toPossibilitiesText(this.getDescriptionItem()?.possibilities)
+  }
+
   /**
    * Returns the values of the wiki items
    *
@@ -89,6 +118,28 @@ export class WikiStorybook {
     return values
   }
 
+  /**
+   * Returns the filtered values of the wiki items
+   *
+   * Возвращает отфильтрованные значения элементов wiki
+   * @return A list of objects containing the filtered values of the wiki items/
+   * список объектов, содержащих отфильтрованные значения элементов wiki
+   */
+  getFilteredValues(): Record<string, any> {
+    const values: Record<string, any> = {}
+
+    forEach(
+      this.getValues(),
+      (value, key) => {
+        if (value !== undefined) {
+          values[key] = value
+        }
+      }
+    )
+
+    return values
+  }
+
   /**
    * Returns a Storybook item by its ID
    *
@@ -120,6 +171,24 @@ export class WikiStorybook {
     )
   }
 
+  /**
+   * Returns the AI render of the component
+   *
+   * Возвращает AI рендер компонента
+   */
+  getAiRender(): string | undefined {
+    return this.getDescriptionItem()?.ai?.render
+  }
+
+  /**
+   * Returns the AI description of the component
+   *
+   * Возвращает AI описание компонента
+   */
+  getAiDescription(): string | undefined {
+    return this.getDescriptionItem()?.ai?.description
+  }
+
   /**
    * Returns a wiki item by its name
    *
@@ -196,6 +265,28 @@ export class WikiStorybook {
     return ''
   }
 
+  /**
+   * Converts the possibilities to text format
+   *
+   * Преобразует возможности в текстовый формат
+   * @param possibilities - The possibilities to convert/ возможности для преобразования
+   */
+  private toPossibilitiesText(possibilities?: StorybookArgsToPossibilities): string[] {
+    if (possibilities) {
+      const language = Geo.getLanguage()
+
+      if (isObjectNotArray(possibilities)) {
+        return possibilities?.[language]
+          ?? Object.values(possibilities)?.[0]
+          ?? []
+      }
+
+      return possibilities
+    }
+
+    return []
+  }
+
   /**
    * Initializes the list of wiki items for the component
    *

package/src/classes/WikiStorybookItem.ts

@@ -26,6 +26,15 @@ export class WikiStorybookItem {
   ) {
   }
 
+  /**
+   * Checks if the item is a demo item.
+   *
+   * Проверяет, является ли элемент демонстрационным.
+   */
+  isDemo(): boolean {
+    return this.item.isDemo === true
+  }
+
   /**
    * Returns the name of the item in the wiki
    *
@@ -64,8 +73,34 @@ export class WikiStorybookItem {
         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
     }
@@ -93,6 +128,40 @@ export class WikiStorybookItem {
     }
   }
 
+  /**
+   * Returns the demo property if the item is a demo item.
+   *
+   * Возвращает свойство demo, если элемент является демонстрационным.
+   */
+  private getDemo(): { isDemo?: boolean, demo?: any, demoOptions?: Record<string, any> } {
+    if (this.isDemo()) {
+      return {
+        isDemo: true,
+        demo: this.getDemoValue(),
+        demoOptions: this.item.demoOptions
+      }
+    }
+
+    return {}
+  }
+
+  /**
+   * 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
    *
@@ -223,7 +292,8 @@ export class WikiStorybookItem {
         ...this.getDefaultValue(),
         ...this.getType()
       },
-      ...this.getDescription()
+      ...this.getDescription(),
+      ...this.getDemo()
     }
   }
 
@@ -252,7 +322,8 @@ export class WikiStorybookItem {
     return {
       control,
       table,
-      ...this.getDescription()
+      ...this.getDescription(),
+      ...this.getDemo()
     }
   }
 
@@ -268,7 +339,8 @@ export class WikiStorybookItem {
         ...this.getCategory(),
         ...this.getType()
       },
-      ...this.getDescription()
+      ...this.getDescription(),
+      ...this.getDemo()
     }
   }
 
@@ -286,7 +358,8 @@ export class WikiStorybookItem {
         ...this.getDefaultValue(),
         ...this.getType()
       },
-      ...this.getDescription()
+      ...this.getDescription(),
+      ...this.getDemo()
     }
   }
 
@@ -303,7 +376,8 @@ export class WikiStorybookItem {
         ...this.getDefaultValue(),
         ...this.getType()
       },
-      ...this.getDescription()
+      ...this.getDescription(),
+      ...this.getDemo()
     }
   }
 }

package/src/classes/WikiStorybookProp.ts

@@ -0,0 +1,109 @@
+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 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.ts

@@ -2,6 +2,7 @@
 export * from './classes/WikiStorybook'
 export * from './classes/WikiStorybookDescriptions'
 export * from './classes/WikiStorybookItem'
+export * from './classes/WikiStorybookProp'
 
 // Types
 export * from './types/storybookTypes'

package/src/media/descriptions/wikiDescriptions.ts

@@ -1,40 +1,65 @@
 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 { wikiDescriptionsChip } from './wikiDescriptionsChip'
+import { wikiDescriptionsChipGroup } from './wikiDescriptionsChipGroup'
+import { wikiDescriptionsDialog } from './wikiDescriptionsDialog'
 import { wikiDescriptionsField } from './wikiDescriptionsField'
 import { wikiDescriptionsFieldCounter } from './wikiDescriptionsFieldCounter'
 import { wikiDescriptionsFieldLabel } from './wikiDescriptionsFieldLabel'
 import { wikiDescriptionsFieldMessage } from './wikiDescriptionsFieldMessage'
 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 { 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 { 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,
   wikiDescriptionsChip,
+  wikiDescriptionsChipGroup,
+  wikiDescriptionsDialog,
   wikiDescriptionsField,
   wikiDescriptionsFieldCounter,
   wikiDescriptionsFieldLabel,
   wikiDescriptionsFieldMessage,
   wikiDescriptionsIcon,
+  wikiDescriptionsInput,
   wikiDescriptionsImage,
   wikiDescriptionsList,
   wikiDescriptionsListGroup,
@@ -42,10 +67,17 @@ export const wikiDescriptions: StorybookComponentsDescription = [
   wikiDescriptionsListMenu,
   wikiDescriptionsMask,
   wikiDescriptionsMenu,
+  wikiDescriptionsModal,
   wikiDescriptionsMotionTransform,
+  wikiDescriptionsPage,
   wikiDescriptionsProgress,
   wikiDescriptionsRipple,
   wikiDescriptionsScrollbar,
+  wikiDescriptionsSection,
+  wikiDescriptionsSelect,
+  wikiDescriptionsSelectValue,
   wikiDescriptionsSkeleton,
+  wikiDescriptionsTextareaAutosize,
+  wikiDescriptionsTooltip,
   wikiDescriptionsWindow
 ]