@dxtmisha/scripts 0.11.8 → 1.0.0

package/dist/library-ui.d.ts

@@ -0,0 +1,586 @@
+import { Canvas } from '@napi-rs/canvas';
+import { SKRSContext2D } from '@napi-rs/canvas';
+
+/**
+ * Automation utility for discovering empty component directories and scaffolding their initial structure.
+ * Scans configured component paths and initializes boilerplate files for newly created component folders.
+ *
+ * Утилита автоматизации для обнаружения пустых директорий компонентов и создания их начальной структуры.
+ * Сканирует настроенные пути компонентов и инициализирует шаблонные файлы для вновь созданных папок компонентов.
+ */
+export declare class ComponentCreator {
+    /**
+     * Constructor initializes ComponentCreator instance.
+     *
+     * Конструктор инициализирует экземпляр ComponentCreator.
+     */
+    constructor();
+    /**
+     * Scans directories and scaffolds component templates.
+     *
+     * Сканирует директории и создает шаблоны компонентов.
+     */
+    make(): void;
+    /**
+     * Collects only empty component directories.
+     *
+     * Собирает только пустые директории компонентов.
+     * @returns array of empty component directory paths / массив путей пустых директорий компонентов
+     */
+    protected getDirs(): string[];
+}
+
+/**
+ * Class for orchestrating the generation and update of multiple design constructors.
+ * It manages the collective lifecycle of component constructors, including bulk updates and shared style generation.
+ *
+ * Класс для управления генерацией и обновлением нескольких конструкторов дизайна.
+ * Управляет коллективным жизненным циклом конструкторов компонентов, включая массовые обновления и генерацию общих стилей.
+ */
+export declare class DesignConstructors {
+    protected readonly name?: string | undefined;
+    /**
+     * Constructor for DesignConstructors.
+     *
+     * Конструктор для DesignConstructors.
+     * @param name optional specific component name to process / необязательное имя конкретного компонента для обработки
+     */
+    constructor(name?: string | undefined);
+    /**
+     * Starts the process of creating or updating constructors.
+     *
+     * Запускает процесс создания или обновления конструкторов.
+     */
+    make(): Promise<void>;
+    /**
+     * Returns a list of components.
+     *
+     * Возвращает список компонентов.
+     * @returns list of component names / список имен компонентов
+     */
+    getComponents(): string[];
+    /**
+     * Returns a list of component styles.
+     *
+     * Возвращает список стилей компонентов.
+     * @returns list of style import strings / список строк импорта стилей
+     */
+    getComponentsStyle(): string[];
+    /**
+     * Returns the directory path for constructors.
+     *
+     * Возвращает путь к директории конструкторов.
+     * @returns directory path segments / сегменты пути директории
+     */
+    protected getDir(): string[];
+    /**
+     * Generates a common style file.
+     *
+     * Генерирует общий файл стилей.
+     */
+    protected makeStyle(): void;
+}
+
+/**
+ * Class for generating a sprite image and CSS mapping from a directory of flag icons.
+ * It automates the creation of a combined webp image and a CSS file with specific background-position utility classes.
+ *
+ * Класс для генерации спрайта и CSS-маппинга из директории иконок флагов.
+ * Автоматизирует создание комбинированного изображения webp и CSS-файла с утилитарными классами для позиционирования фона.
+ */
+export declare class DesignFlags {
+    protected readonly dir: string;
+    protected readonly width: number;
+    protected readonly height: number;
+    protected readonly columns: number;
+    /** List of SVG flag icon filenames / Список имен файлов SVG-иконок флагов */
+    protected list: string[];
+    /** Accumulated sprite data list / Накопленный список данных спрайта */
+    protected data: DesignFlagsList;
+    /** Current column index in sprite grid / Текущий индекс колонки в сетке спрайта */
+    protected x: number;
+    /** Current row index in sprite grid / Текущий индекс строки в сетке спрайта */
+    protected y: number;
+    /** Cell square dimension / Размер квадратной ячейки */
+    protected square: number;
+    /** Top offset inside cell / Смещение сверху внутри ячейки */
+    protected top: number;
+    /** Left offset inside cell / Смещение слева внутри ячейки */
+    protected left: number;
+    /** Canvas instance / Экземпляр canvas */
+    protected canvas: Canvas;
+    /** Canvas 2D rendering context / 2D-контекст отрисовки canvas */
+    protected context: SKRSContext2D;
+    /**
+     * Constructor for DesignFlags.
+     *
+     * Конструктор для DesignFlags.
+     * @param dir path to the directory containing SVG icons / путь к директории с SVG-иконками
+     * @param width width of a single flag in the sprite / ширина одного флага в спрайте
+     * @param height height of a single flag in the sprite / высота одного флага в спрайте
+     * @param columns number of columns in the sprite grid / количество колонок в сетке спрайта
+     */
+    constructor(dir?: string, width?: number, height?: number, columns?: number);
+    /**
+     * Generates the sprite image and corresponding CSS styles.
+     *
+     * Генерирует изображение спрайта и соответствующие CSS-стили.
+     */
+    make(): Promise<void>;
+    /**
+     * Returns total number of rows in sprite grid.
+     *
+     * Возвращает общее количество строк в сетке спрайта.
+     * @returns number of rows / количество строк
+     */
+    getLines(): number;
+    /**
+     * Returns the maximum width of the canvas.
+     *
+     * Возвращает максимальную ширину холста.
+     * @returns canvas width / ширина холста
+     */
+    protected getCanvasWidth(): number;
+    /**
+     * Returns the maximum height of the canvas.
+     *
+     * Возвращает максимальную высоту холста.
+     * @returns canvas height / высота холста
+     */
+    protected getCanvasHeight(): number;
+    /**
+     * Calculates horizontal drawing offset for current cell.
+     *
+     * Вычисляет горизонтальное смещение отрисовки для текущей ячейки.
+     * @returns horizontal offset / горизонтальное смещение
+     */
+    protected getDx(): number;
+    /**
+     * Calculates vertical drawing offset for current cell.
+     *
+     * Вычисляет вертикальное смещение отрисовки для текущей ячейки.
+     * @returns vertical offset / вертикальное смещение
+     */
+    protected getDy(): number;
+    /**
+     * Generates CSS styles with sprite background positions.
+     *
+     * Генерирует CSS-стили с позициями фона в спрайте.
+     * @returns generated CSS string / сгенерированная CSS-строка
+     */
+    protected getStyle(): string;
+    /**
+     * Loads and renders single flag image onto canvas.
+     *
+     * Загружает и отрисовывает изображение отдельного флага на холсте.
+     * @param file filename of SVG flag / имя файла SVG-флага
+     */
+    protected addImage(file: string): Promise<void>;
+    /**
+     * Records metadata and positions for a flag item.
+     *
+     * Записывает метаданные и координаты для элемента флага.
+     * @param file filename of SVG flag / имя файла SVG-флага
+     * @returns flag item metadata / метаданные элемента флага
+     */
+    protected addData(file: string): DesignFlagsItem;
+    /**
+     * Advances grid coordinates to next cell.
+     *
+     * Перемещает координаты сетки к следующей ячейке.
+     */
+    protected next(): void;
+    /**
+     * Saves rendered canvas buffer to webp file.
+     *
+     * Сохраняет буфер отрисованного canvas в файл webp.
+     */
+    protected save(): void;
+    /**
+     * Saves generated CSS styles to file.
+     *
+     * Сохраняет сгенерированные CSS-стили в файл.
+     */
+    protected saveStyle(): void;
+    /**
+     * Initializes canvas and 2D context.
+     *
+     * Инициализирует canvas и 2D-контекст.
+     */
+    protected initGraphics(): Promise<void>;
+    /**
+     * Calculates horizontal left alignment offset.
+     *
+     * Вычисляет горизонтальное смещение выравнивания слева.
+     * @returns left offset / смещение слева
+     */
+    protected initLeft(): number;
+    /**
+     * Reads and filters SVG file list from icons directory.
+     *
+     * Читает и фильтрует список файлов SVG из директории иконок.
+     * @returns list of SVG filenames / список имен SVG-файлов
+     */
+    protected initList(): string[];
+    /**
+     * Calculates square cell dimension based on flag width/height factor.
+     *
+     * Вычисляет размер квадратной ячейки на основе коэффициента ширины/высоты флага.
+     * @returns square cell size / размер квадратной ячейки
+     */
+    protected initSquare(): number;
+    /**
+     * Calculates vertical top alignment offset.
+     *
+     * Вычисляет вертикальное смещение выравнивания сверху.
+     * @returns top offset / смещение сверху
+     */
+    protected initTop(): number;
+}
+
+/**
+ * Design flag item containing flag name and 2D canvas coordinates.
+ *
+ * Элемент флага дизайна, содержащий имя флага и 2D-координаты на холсте.
+ */
+declare type DesignFlagsItem = {
+    /** Flag name / Название флага */
+    name: string;
+    /** X coordinate on the canvas / Координата X на холсте */
+    x: number;
+    /** Y coordinate on the canvas / Координата Y на холсте */
+    y: number;
+};
+
+/**
+ * List of design flag items.
+ *
+ * Список элементов флагов дизайна.
+ */
+declare type DesignFlagsList = DesignFlagsItem[];
+
+/**
+ * Orchestrator class for managing and initializing the Design System UI.
+ * It coordinates the generation of styles, documentation, component structures, and library-level exports (media, plugins, types).
+ *
+ * Класс-оркестратор для управления и инициализации пользовательского интерфейса дизайн-системы.
+ * Координирует генерацию стилей, документации, структур компонентов и экспортов на уровне библиотеки (медиа, плагины, типы).
+ */
+export declare class DesignUi {
+    protected readonly name: string;
+    /** Library items repository instance / Экземпляр репозитория элементов библиотеки */
+    protected readonly components: LibraryItems;
+    /**
+     * Constructor for DesignUi.
+     *
+     * Конструктор для DesignUi.
+     * @param name specific component name to initialize, or empty for all / название конкретного компонента для инициализации или пусто для всех
+     */
+    constructor(name?: string);
+    /**
+     * Returns the component name by its name.
+     *
+     * Возвращает название компонента по имени.
+     * @returns kebab-case component name / имя компонента в kebab-case
+     */
+    protected get component(): string;
+    /**
+     * Initialization of the component.
+     *
+     * Инициализация компоненты.
+     */
+    make(): Promise<void>;
+    /**
+     * Creates or updates the list of components.
+     *
+     * Создает или обновляет список компонентов.
+     * @returns current instance / текущий экземпляр
+     */
+    protected makeConstructorComponent(): Promise<this>;
+    /**
+     * Updates the package.json file by adding export paths for UI styles and saves the changes.
+     *
+     * Обновляет файл package.json, добавляя пути экспорта для стилей UI, и сохраняет изменения.
+     * @returns current instance / текущий экземпляр
+     */
+    protected makePackage(): this;
+    /**
+     * Generates the root ui-properties.scss style file.
+     *
+     * Генерирует корневой файл стилей ui-properties.scss.
+     * @returns current instance / текущий экземпляр
+     */
+    protected makeUiProperties(): this;
+}
+
+/**
+ * Engine for generating `web-types.json` to provide rich metadata and IDE support (IntelliSense) for the design system components in JetBrains editors (IntelliJ IDEA, WebStorm).
+ * It aggregates component tags, attributes, and events from the entire library and formats them into the standard Web-Types schema.
+ *
+ * Движок для генерации `web-types.json`, обеспечивающий расширенные метаданные и поддержку IDE (IntelliSense) для компонентов дизайн-системы в редакторах JetBrains (IntelliJ IDEA, WebStorm).
+ * Он агрегирует теги компонентов, атрибуты и события из всей библиотеки и форматирует их в стандартную схему Web-Types.
+ */
+export declare class DesignWikiStorm {
+    protected dir: string;
+    /** Library items repository instance / Экземпляр репозитория элементов библиотеки */
+    protected readonly components: LibraryItems;
+    /**
+     * Constructor for DesignWikiStorm.
+     *
+     * Конструктор для DesignWikiStorm.
+     * @param dir target directory for saving the `web-types.json` file / целевая директория для сохранения файла `web-types.json`
+     */
+    constructor(dir?: string);
+    /**
+     * Generates the web-types.json file.
+     *
+     * Генерирует файл web-types.json.
+     */
+    make(): Promise<void>;
+    /**
+     * Creates or updates the list of components.
+     *
+     * Создает или обновляет список компонентов.
+     * @returns array of Vue component items for web-types / массив элементов компонентов Vue для web-types
+     */
+    protected getComponents(): Promise<WebTypesVueComponentItem[]>;
+}
+
+/**
+ * List of all library items across the design system.
+ *
+ * Список всех элементов библиотек дизайн-системы.
+ */
+declare type LibraryAll = LibraryItem[];
+
+/**
+ * Library component data with design and path information.
+ *
+ * Данные компонента библиотеки с информацией о дизайне и путях.
+ */
+declare type LibraryData = {
+    /** Design system name / Название дизайн-системы */
+    design: string;
+    /** Component name / Название компонента */
+    name: string;
+    /** Component alias / Псевдоним компонента */
+    alias: string;
+    /** Full component code or identifier / Полный код или идентификатор компонента */
+    codeFull: string;
+    /** Component directory / Директория компонента */
+    dir: string;
+};
+
+/**
+ * Library item containing library name and its associated component collection.
+ *
+ * Элемент библиотеки, содержащий имя библиотеки и связанную коллекцию компонентов.
+ */
+declare type LibraryItem = {
+    /** Library name / Название библиотеки */
+    name: string;
+    /** Array of components / Массив компонентов */
+    components: LibraryData[];
+};
+
+/**
+ * Class for working with the list of components.
+ *
+ * Класс для работы со списком компонентов.
+ */
+declare class LibraryItems {
+    /** Library items array grouped by design / Массив элементов библиотеки, сгруппированных по дизайну */
+    protected readonly items: LibraryAll;
+    /**
+     * Constructor initializes library items.
+     *
+     * Конструктор инициализирует элементы библиотеки.
+     */
+    constructor();
+    /**
+     * Returns the list of components divided by design groups.
+     *
+     * Возвращает список компонентов, разделенных по группам дизайна.
+     * @returns list of components grouped by design / список компонентов, сгруппированных по дизайну
+     */
+    get(): LibraryAll;
+    /**
+     * Returns the list of components as an array.
+     *
+     * Возвращает список компонентов в виде массива.
+     * @returns array of component data items / массив элементов данных компонентов
+     */
+    getComponentList(): LibraryData[];
+    /**
+     * Returns the number of components.
+     *
+     * Возвращает количество компонентов.
+     * @returns total component count / общее количество компонентов
+     */
+    getCount(): number;
+    /**
+     * Returns the path to the design system components directory.
+     *
+     * Возвращает путь к директории компонентов дизайн-системы.
+     * @returns array of directory path segments / массив сегментов пути директории
+     */
+    getComponentsPath(): string[];
+    /**
+     * Writes data in the file.
+     *
+     * Записывает данные в файл.
+     * @param name file name / название файла
+     * @param data values for writing / значения для записи
+     * @param extension file extension (default 'ts') / расширение файла (по умолчанию 'ts')
+     */
+    write(name: string, data: string[], extension?: string): void;
+    /**
+     * Returns a list of components.
+     *
+     * Возвращает список компонентов.
+     * @returns list of component metadata items / список элементов метаданных компонентов
+     */
+    protected getComponents(): LibraryData[];
+    /**
+     * Initializes data about the component.
+     *
+     * Инициализирует данные о компоненте.
+     * @returns library design groups array / массив групп дизайна библиотеки
+     */
+    protected initItems(): LibraryAll;
+}
+
+/**
+ * Class for initializing the package structure and development environment based on templates.
+ *
+ * Класс для инициализации структуры пакета и среды разработки на основе шаблонов.
+ */
+export declare class PackageInit {
+    protected readonly type: string;
+    protected readonly templates?: string | undefined;
+    protected readonly dir: string;
+    /**
+     * Constructor for PackageInit.
+     *
+     * Конструктор для PackageInit.
+     * @param type package type identifier / идентификатор типа пакета
+     * @param templates optional list of templates to apply / необязательный список шаблонов для применения
+     * @param dir base directory for packages / базовая директория для пакетов
+     */
+    constructor(type: string, templates?: string | undefined, dir?: string);
+    /**
+     * Triggers the package creation process and initializes required files.
+     *
+     * Запускает процесс создания пакета и инициализирует необходимые файлы.
+     */
+    make(): void;
+    /**
+     * Returns an array of directory names for package initialization.
+     *
+     * Возвращает массив имен директорий для инициализации пакета.
+     * @returns array of empty package directory names / массив имен пустых директорий пакетов
+     */
+    protected getDirs(): string[];
+}
+
+/**
+ * Event definition for a Web-Types component tag.
+ *
+ * Определение события для тега компонента Web-Types.
+ */
+declare type WebTypesEventItem = WebTypesInfo & {
+    /** List of event arguments / Список аргументов события */
+    arguments?: WebTypesProperties;
+    /** Event type string / Строка типа события */
+    type?: string;
+};
+
+/**
+ * Basic metadata for a Web-Types item (name, description, and documentation URL).
+ *
+ * Базовая метаинформация для элемента Web-Types (имя, описание и URL документации).
+ */
+declare type WebTypesInfo = {
+    /** Item name / Имя элемента */
+    'name': string;
+    /** Item description / Описание элемента */
+    'description'?: string;
+    /** Documentation URL / URL документации */
+    'doc-url'?: string;
+};
+
+/**
+ * List of Web-Types property definitions.
+ *
+ * Список определений свойств Web-Types.
+ */
+declare type WebTypesProperties = WebTypesProperty[];
+
+/**
+ * Property definition for Web-Types (e.g. event arguments or slot scope).
+ *
+ * Определение свойства для Web-Types (например, аргументы событий или область видимости слота).
+ */
+declare type WebTypesProperty = {
+    /** Property name / Имя свойства */
+    name: string;
+    /** Property type expression / Выражение типа свойства */
+    type?: string;
+    /** Property description / Описание свойства */
+    description?: string;
+};
+
+/**
+ * Prop definition for a Vue component in Web-Types.
+ *
+ * Определение входного свойства (prop) для Vue-компонента в Web-Types.
+ */
+declare type WebTypesPropItem = WebTypesInfo & {
+    /** Default prop value / Значение свойства по умолчанию */
+    default?: string;
+    /** TypeScript prop type / TypeScript тип свойства */
+    type?: string;
+};
+
+/**
+ * Slot definition for a Web-Types component tag.
+ *
+ * Определение слота для тега компонента Web-Types.
+ */
+declare type WebTypesSlotItem = WebTypesInfo & {
+    /** Scoped slot properties / Свойства слота с ограниченной областью видимости (scoped) */
+    'vue-properties'?: WebTypesProperties;
+};
+
+/**
+ * List of Web-Types slot definitions.
+ *
+ * Список определений слотов Web-Types.
+ */
+declare type WebTypesSlots = WebTypesSlotItem[];
+
+/**
+ * Vue component definition for Web-Types format.
+ *
+ * Определение Vue-компонента для формата Web-Types.
+ */
+declare type WebTypesVueComponentItem = WebTypesInfo & {
+    /** Source module and symbol / Исходный модуль и символ */
+    source?: {
+        /** Module path / Путь к модулю */
+        module?: string;
+        /** Exported symbol name / Имя экспортируемого символа */
+        symbol?: string;
+    };
+    /** Component props list / Список входных свойств (props) компонента */
+    props?: WebTypesPropItem[];
+    /** Component slots list / Список слотов компонента */
+    slots?: WebTypesSlots;
+    /** JavaScript / events metadata / Метаданные JavaScript и событий */
+    js?: {
+        /** Component emitted events / Эмитируемые события компонента */
+        events?: WebTypesEventItem[];
+    };
+};
+
+export { }