@dxtmisha/wiki 0.39.5 → 0.39.6

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dxtmisha/wiki",
   "private": false,
-  "version": "0.39.5",
+  "version": "0.39.6",
   "type": "module",
   "description": "Wiki documentation and storybook utilities for DXT UI design system",
   "keywords": [
@@ -26,10 +26,16 @@
     "url": "https://github.com/dxtmisha/dxt-ui/issues"
   },
   "scripts": {
+    "dev": "vite",
+    "build": "vue-tsc -b && vite build",
+    "preview": "vite preview",
+    "prepublishOnly": "npm run build",
     "publish-to-npm": "npm publish --access public"
   },
   "files": [
-    "src",
+    "dist",
+    "src/media/functional",
+    "src/styles",
     "README.md",
     "package.json",
     "LICENSE"
@@ -38,13 +44,20 @@
   "module": "src/library.ts",
   "types": "src/library.ts",
   "exports": {
-    ".": "./src/library.ts",
-    "./lite": "./src/library-lite.ts",
-    "./media": "./src/media.ts",
+    ".": {
+      "import": "./dist/library.js",
+      "types": "./dist/library.d.ts"
+    },
+    "./media": {
+      "import": "./dist/media.js",
+      "types": "./dist/media.d.ts"
+    },
     "./functional/*": "./src/media/functional/*.mdx",
-    "./storybook": "./src/storybook.tsx",
-    "./storybook/styles": "./src/styles/storybookStyle.scss",
-    "./package.json": "./package.json"
+    "./storybook": {
+      "import": "./dist/storybook.js",
+      "types": "./dist/storybook.d.ts"
+    },
+    "./storybook/styles": "./src/styles/storybookStyle.scss"
   },
   "engines": {
     "node": ">=20.0.0"

package/src/library.ts

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

package/src/classes/WikiStorybook.ts

@@ -1,353 +0,0 @@
-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,
-  type StorybookProp,
-  type StorybookProps
-} from '../types/storybookTypes'
-
-/**
- * Class representing a Storybook wiki
- *
- * Класс, представляющий wiki для Storybook
- */
-export class WikiStorybook {
-  protected list: WikiStorybookItem[]
-
-  /**
-   * Creates a new instance of WikiStorybook
-   *
-   * Создает новый экземпляр WikiStorybook
-   * @param component - Component name/ Название компонента
-   * @param props - Properties for the component/ свойства для компонента
-   * @param defaults - Default values for the component/ значения по умолчанию для компонента
-   * @param wikiDesign - Design values for the wiki/ значения дизайна для wiki
-   * @param wikiBasic - Basic values for the wiki/ базовые значения для wiki
-   * @param wikiDescriptions - Component descriptions for the wiki/ описания компонентов для wiki
-   */
-  constructor(
-    protected readonly component: string,
-    protected readonly props: StorybookProps,
-    protected readonly defaults: Record<string, any>,
-    protected readonly wikiDesign: StorybookArgsToList = {},
-    protected readonly wikiBasic: StorybookArgsToList = {},
-    protected readonly wikiDescriptions: StorybookComponentsDescription = []
-  ) {
-    this.list = this.initList()
-  }
-
-  /**
-   * Returns the name of the component
-   *
-   * Возвращает имя компонента
-   */
-  getName(): string {
-    return this.component
-  }
-
-  /**
-   * Returns the properties wiki for the component
-   *
-   * Возвращает wiki свойств для компонента
-   * @return The properties wiki for the component/ wiki свойств для компонента
-   */
-  getWiki(): StorybookArgs {
-    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
-   *
-   * Возвращает описание компонента из wiki
-   * @return The description of the component/ описание компонента
-   */
-  getDescription(): string {
-    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
-   *
-   * Возвращает значения элементов wiki
-   * @return An object containing the values of the wiki items/ объект, содержащий значения элементов wiki
-   */
-  getValues(): Record<string, any> {
-    const values: Record<string, any> = {}
-
-    this.list.forEach((item) => {
-      values[item.getName()] = item.getValue()
-    })
-
-    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
-   *
-   * Возвращает элемент Storybook по его ID
-   * @param id - The ID of the story/ ID истории
-   */
-  getStoryItem(id: string): StorybookComponentsDescriptionStory | undefined {
-    const item = this.getDescriptionItem()
-
-    if (
-      item
-      && item.stories
-    ) {
-      return item.stories.find(story => story.id === id)
-    }
-
-    return undefined
-  }
-
-  /**
-   * Returns the name of the story by its ID
-   *
-   * Возвращает имя истории по ее ID
-   * @param id - The ID of the story/ ID истории
-   */
-  getStoryName(id: string): string | undefined {
-    return this.toDescriptionText(
-      this.getStoryItem(id)?.name
-    )
-  }
-
-  /**
-   * 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 the AI hide of the component
-   *
-   * Возвращает AI скрыть компонента
-   */
-  getAiHide(): boolean {
-    return this.getDescriptionItem()?.ai?.hide ?? false
-  }
-
-  /**
-   * Returns a wiki item by its name
-   *
-   * Возвращает элемент wiki по его имени
-   * @param name - The name of the wiki item/ имя элемента wiki
-   */
-  protected getWikiItem(name: string): StorybookArgsToItem | undefined {
-    if (
-      name in this.wikiBasic
-      || name in this.wikiDesign
-    ) {
-      return {
-        ...(this.wikiBasic?.[name] ?? {}),
-        ...(this.wikiDesign?.[name] ?? {})
-      } as StorybookArgsToItem
-    }
-
-    return undefined
-  }
-
-  /**
-   * Returns the description item for the component
-   *
-   * Возвращает элемент описания для компонента
-   * @return The description item for the component/ элемент описания для компонента
-   */
-  private getDescriptionItem(): StorybookComponentsDescriptionItem | undefined {
-    return this.wikiDescriptions.find(item => item.name === this.component)
-  }
-
-  /**
-   * Adds a default value to the wiki item and a list of options
-   *
-   * Добавляет значение по умолчанию к элементу wiki и список опций
-   * @param item - The item to convert/ элемент для преобразования
-   * @param wiki - The wiki item to which the default value and options will be added/
-   * элемент wiki, к которому будут добавлены значение по умолчанию и опции
-   */
-  protected toWikiItemChanged(
-    item: StorybookProp,
-    wiki: StorybookArgsToItem
-  ): StorybookArgsToItem {
-    return {
-      ...wiki,
-      options: {
-        ...wiki.options,
-        type: wiki.options?.type ?? item.type,
-        defaultValue: this.defaults[item.name],
-        options: item.option ?? wiki.options?.options ?? undefined
-      }
-    }
-  }
-
-  /**
-   * Converts the descriptions to text format
-   *
-   * Преобразует описания в текстовый формат
-   * @param descriptions - The descriptions to convert/ Описания для преобразования
-   */
-  private toDescriptionText(descriptions?: StorybookArgsToDescription): string {
-    if (descriptions) {
-      const language = Geo.getLanguage()
-
-      if (isObjectNotArray(descriptions)) {
-        return String(
-          descriptions?.[language]
-          ?? Object.values(descriptions)?.[0]
-        )
-      }
-
-      return descriptions
-    }
-
-    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
-   *
-   * Инициализирует список элементов wiki для компонента
-   * @return The list of wiki items for the component/ список элементов wiki для компонента
-   */
-  initList(): WikiStorybookItem[] {
-    const list: WikiStorybookItem[] = []
-
-    this.props.forEach((item) => {
-      const nameByComponent = `${toCamelCase(this.component)}.${item.name}`
-      const wiki = this.getWikiItem(nameByComponent) ?? this.getWikiItem(item.name)
-
-      if (wiki) {
-        list.push(
-          new WikiStorybookItem(
-            item.name,
-            this.toWikiItemChanged(item, wiki)
-          )
-        )
-      } else {
-        console.error(`[WikiStorybook] ${item.name} not found`)
-      }
-    })
-
-    list.sort((a, b) => {
-      const aOrder = a.getOrder()
-      const bOrder = b.getOrder()
-
-      if (aOrder === bOrder) {
-        return a.getName() > b.getName() ? 1 : -1
-      }
-
-      return aOrder > bOrder ? 1 : -1
-    })
-
-    return list
-  }
-
-  /**
-   * Initializes the properties list for the component
-   *
-   * Инициализирует список свойств для компонента
-   * @return The list of properties for the component/ список свойств для компонента
-   */
-  initPropsWiki(): StorybookArgs {
-    const list: StorybookArgs = {}
-
-    this.list.forEach((item) => {
-      list[item.getName()] = item.to()
-    })
-
-    return list
-  }
-}

package/src/classes/WikiStorybookDescriptions.ts

@@ -1,77 +0,0 @@
-import { executeFunction, Geo, isObjectNotArray } from '@dxtmisha/functional'
-
-import type {
-  StorybookComponentsDescription,
-  StorybookComponentsDescriptionItem,
-  StorybookComponentsMdx,
-  StorybookComponentsMdxItem
-} from '../types/storybookTypes'
-
-/**
- * Class for working with Storybook component descriptions in the wiki
- *
- * Класс для работы с описаниями компонентов Storybook в вики
- */
-export class WikiStorybookDescriptions {
-  private readonly item?: StorybookComponentsDescriptionItem
-  private readonly mdx?: StorybookComponentsMdxItem
-
-  private static wikiDescriptions?: StorybookComponentsDescription
-  private static wikiMdx?: StorybookComponentsMdx
-
-  /**
-   * Set the wiki descriptions and mdx
-   *
-   * Устанавливает описания вики и mdx
-   * @param descriptions - Descriptions of the components/ Описания компонентов
-   * @param mdx - MDX descriptions of the components/ Описания компонентов в формате MDX
-   */
-  static setWiki(
-    descriptions?: StorybookComponentsDescription,
-    mdx?: StorybookComponentsMdx
-  ) {
-    this.wikiDescriptions = descriptions
-    this.wikiMdx = mdx
-  }
-
-  /**
-   * Constructor
-   * @param name - Name of the component to find in the descriptions/ Имя компонента для поиска в описаниях
-   */
-  constructor(name: string) {
-    this.item = WikiStorybookDescriptions.wikiDescriptions?.find(item => item.name === name)
-    this.mdx = WikiStorybookDescriptions.wikiMdx?.find(item => item.name === name)
-  }
-
-  /**
-   * Get the description of the component
-   *
-   * Возвращает описание компонента
-   * @return The description of the component or undefined if not found/ Описание компонента или undefined, если не найдено
-   */
-  getItem(): StorybookComponentsDescriptionItem | undefined {
-    return this.item
-  }
-
-  /**
-   * Get an additional description of the component for a specific type
-   *
-   * Возвращает дополнительное описание компонента для конкретного типа
-   * @param type - Type of the description to retrieve/ тип описания для получения
-   */
-  getDescriptionByType(type: string): any {
-    const descriptions = this.mdx?.descriptions?.[type]
-
-    return executeFunction((() => {
-      if (descriptions) {
-        if (isObjectNotArray(descriptions)) {
-          return descriptions[Geo.getLanguage()]
-        }
-
-        return descriptions
-      }
-
-      return ''
-    })())
-  }
-}