@dxtmisha/wiki 0.39.2 → 0.39.4

package/dist/classes/WikiStorybook.d.ts

@@ -0,0 +1,161 @@
+import { WikiStorybookItem } from './WikiStorybookItem';
+import { WikiStorybookProp } from './WikiStorybookProp';
+import { StorybookArgs, StorybookArgsToItem, StorybookArgsToList, StorybookComponentsDescription, StorybookComponentsDescriptionStory, StorybookProp, StorybookProps } from '../types/storybookTypes';
+/**
+ * Class representing a Storybook wiki
+ *
+ * Класс, представляющий wiki для Storybook
+ */
+export declare class WikiStorybook {
+    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;
+    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(component: string, props: StorybookProps, defaults: Record<string, any>, wikiDesign?: StorybookArgsToList, wikiBasic?: StorybookArgsToList, wikiDescriptions?: StorybookComponentsDescription);
+    /**
+     * Returns the name of the component
+     *
+     * Возвращает имя компонента
+     */
+    getName(): string;
+    /**
+     * Returns the properties wiki for the component
+     *
+     * Возвращает wiki свойств для компонента
+     * @return The properties wiki for the component/ wiki свойств для компонента
+     */
+    getWiki(): StorybookArgs;
+    /**
+     * Returns the wiki object for the component
+     *
+     * Возвращает объект wiki для компонента
+     * @return The wiki object for the component/ объект wiki для компонента
+     */
+    getWikiObject(): WikiStorybookProp[];
+    /**
+     * Returns the description of the component from the wiki
+     *
+     * Возвращает описание компонента из wiki
+     * @return The description of the component/ описание компонента
+     */
+    getDescription(): string;
+    /**
+     * Returns the possibilities of the component from the wiki
+     *
+     * Возвращает возможности компонента из wiki
+     * @return A list of possibilities for the component/ список возможностей для компонента
+     */
+    getPossibilities(): string[];
+    /**
+     * Returns the values of the wiki items
+     *
+     * Возвращает значения элементов wiki
+     * @return An object containing the values of the wiki items/ объект, содержащий значения элементов wiki
+     */
+    getValues(): Record<string, any>;
+    /**
+     * 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>;
+    /**
+     * Returns a Storybook item by its ID
+     *
+     * Возвращает элемент Storybook по его ID
+     * @param id - The ID of the story/ ID истории
+     */
+    getStoryItem(id: string): StorybookComponentsDescriptionStory | undefined;
+    /**
+     * Returns the name of the story by its ID
+     *
+     * Возвращает имя истории по ее ID
+     * @param id - The ID of the story/ ID истории
+     */
+    getStoryName(id: string): string | undefined;
+    /**
+     * Returns the AI render of the component
+     *
+     * Возвращает AI рендер компонента
+     */
+    getAiRender(): string | undefined;
+    /**
+     * Returns the AI description of the component
+     *
+     * Возвращает AI описание компонента
+     */
+    getAiDescription(): string | undefined;
+    /**
+     * Returns the AI hide of the component
+     *
+     * Возвращает AI скрыть компонента
+     */
+    getAiHide(): boolean;
+    /**
+     * Returns a wiki item by its name
+     *
+     * Возвращает элемент wiki по его имени
+     * @param name - The name of the wiki item/ имя элемента wiki
+     */
+    protected getWikiItem(name: string): StorybookArgsToItem | undefined;
+    /**
+     * Returns the description item for the component
+     *
+     * Возвращает элемент описания для компонента
+     * @return The description item for the component/ элемент описания для компонента
+     */
+    private getDescriptionItem;
+    /**
+     * 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;
+    /**
+     * Converts the descriptions to text format
+     *
+     * Преобразует описания в текстовый формат
+     * @param descriptions - The descriptions to convert/ Описания для преобразования
+     */
+    private toDescriptionText;
+    /**
+     * Converts the possibilities to text format
+     *
+     * Преобразует возможности в текстовый формат
+     * @param possibilities - The possibilities to convert/ возможности для преобразования
+     */
+    private toPossibilitiesText;
+    /**
+     * Initializes the list of wiki items for the component
+     *
+     * Инициализирует список элементов wiki для компонента
+     * @return The list of wiki items for the component/ список элементов wiki для компонента
+     */
+    initList(): WikiStorybookItem[];
+    /**
+     * Initializes the properties list for the component
+     *
+     * Инициализирует список свойств для компонента
+     * @return The list of properties for the component/ список свойств для компонента
+     */
+    initPropsWiki(): StorybookArgs;
+}

package/dist/classes/WikiStorybookDescriptions.d.ts

@@ -0,0 +1,29 @@
+import { StorybookComponentsDescriptionItem } from '../types/storybookTypes';
+/**
+ * Class for working with Storybook component descriptions in the wiki
+ *
+ * Класс для работы с описаниями компонентов Storybook в вики
+ */
+export declare class WikiStorybookDescriptions {
+    private readonly item?;
+    private readonly mdx?;
+    /**
+     * Constructor
+     * @param name - Name of the component to find in the descriptions/ Имя компонента для поиска в описаниях
+     */
+    constructor(name: string);
+    /**
+     * Get the description of the component
+     *
+     * Возвращает описание компонента
+     * @return The description of the component or undefined if not found/ Описание компонента или undefined, если не найдено
+     */
+    getItem(): StorybookComponentsDescriptionItem | undefined;
+    /**
+     * Get an additional description of the component for a specific type
+     *
+     * Возвращает дополнительное описание компонента для конкретного типа
+     * @param type - Type of the description to retrieve/ тип описания для получения
+     */
+    getDescriptionByType(type: string): any;
+}

package/dist/classes/WikiStorybookItem.d.ts

@@ -0,0 +1,122 @@
+import { StorybookArgsItem, StorybookArgsToItem } from '../types/storybookTypes';
+/**
+ * Class representing a Storybook wiki item
+ *
+ * Класс, представляющий элемент wiki для Storybook
+ */
+export declare class WikiStorybookItem {
+    private readonly name;
+    private readonly item;
+    /**
+     * 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(name: string, item: StorybookArgsToItem);
+    /**
+     * Checks if the item is hidden.
+     *
+     * Проверяет, скрыт ли элемент.
+     */
+    isHide(): boolean;
+    /**
+     * Checks if the item is a demo item.
+     *
+     * Проверяет, является ли элемент демонстрационным.
+     */
+    isDemo(): boolean;
+    /**
+     * Returns the name of the item in the wiki
+     *
+     * Возвращает название элемента в wiki
+     * @return The name of the item in the wiki/ название элемента в wiki
+     */
+    getName(): string;
+    /**
+     * Returns the value of the item in the wiki
+     *
+     * Возвращает значение элемента в wiki
+     * @return The value of the item in the wiki/ значение элемента в wiki
+     */
+    getValue(): any;
+    /**
+     * Returns the order of the item in the wiki
+     *
+     * Возвращает порядок элемента в wiki
+     * @return The order of the item in the wiki/ порядок элемента в wiki
+     */
+    getOrder(): number;
+    /**
+     * Converts the Wiki item to a Storybook args item
+     *
+     * Преобразует элемент Wiki в элемент аргументов Storybook
+     */
+    to(): StorybookArgsItem;
+    /**
+     * Returns the demo property if the item is a demo item.
+     *
+     * Возвращает свойство demo, если элемент является демонстрационным.
+     */
+    private getDemo;
+    /**
+     * Returns the demo value.
+     *
+     * Возвращает демонстрационное значение.
+     */
+    private getDemoValue;
+    /**
+     * Returns the category type of a property
+     *
+     * Возвращает тип категории у свойства
+     */
+    private getCategory;
+    /**
+     * Returns the default property values
+     *
+     * Возвращает значения свойства по умолчанию
+     */
+    private getDefaultValue;
+    /**
+     * Returns a property description based on the language
+     *
+     * Возвращает описание свойства с учетом языка
+     */
+    private getDescription;
+    /**
+     * Returns the type of property
+     *
+     * Возвращает тип свойства
+     */
+    private getType;
+    /**
+     * Function to create a Storybook args object with boolean type
+     *
+     * Функция для создания объекта аргументов Storybook с типом boolean
+     */
+    private toBoolean;
+    /**
+     * Function to create a Storybook args object with number type
+     *
+     * Функция для создания объекта аргументов Storybook с типом number
+     */
+    private toNumber;
+    /**
+     * Function to create a Storybook args object with object type
+     *
+     * Функция для создания объекта аргументов Storybook с типом object
+     */
+    private toObject;
+    /**
+     * Function to create a Storybook args object with select type
+     *
+     * Функция для создания объекта аргументов Storybook с типом select
+     */
+    private toSelect;
+    /**
+     * Function to create a Storybook args object with string type
+     *
+     * Функция для создания объекта аргументов Storybook с типом string
+     */
+    private toString;
+}

package/dist/classes/WikiStorybookProp.d.ts

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

package/dist/documentation/storybook/StorybookDescriptions.d.ts

@@ -0,0 +1,12 @@
+import { default as React } from 'react';
+/**
+ * Component for displaying Storybook component descriptions in the wiki
+ *
+ * Компонент для отображения описаний компонентов Storybook в вики
+ * @param componentName - Name of the component to find in the descriptions/ Имя компонента для поиска в описаниях
+ * @param type - Type of the description to retrieve/ тип описания для получения
+ */
+export declare const StorybookDescriptions: ({ componentName, type }: {
+    componentName: string;
+    type: string;
+}) => React.ReactNode;

package/dist/documentation/storybook/StorybookMain.d.ts

@@ -0,0 +1,6 @@
+import { default as React } from 'react';
+export declare const StorybookMain: ({ name, description, story }: {
+    name: string;
+    description: string;
+    story: any;
+}) => React.ReactNode;

package/dist/library.d.ts

@@ -0,0 +1,8 @@
+export * from './classes/WikiStorybook';
+export * from './classes/WikiStorybookDescriptions';
+export * from './classes/WikiStorybookItem';
+export * from './classes/WikiStorybookProp';
+export * from './types/storybookTypes';
+export * from './types/wikiTypes';
+export * from './media/props/wiki';
+export * from './media/descriptions/wikiDescriptions';