@dxtmisha/figma-code 0.1.0

package/dist/classes/FigmaFrame.d.ts

@@ -0,0 +1,167 @@
+import { UiFigmaFramesList, UiFigmaFrameStylesCssList, UiFigmaFrameStylesList } from '@dxtmisha/figma';
+import { FigmaItem } from './FigmaItem';
+import { UiFigmaItemText, UiFigmaNode } from '../types/figmaTypes';
+/**
+ * Class for working with Figma frames and their elements.
+ *
+ * Класс для работы с фреймами Figma и их элементами.
+ */
+export declare class FigmaFrame {
+    protected readonly page: UiFigmaNode;
+    protected readonly selection: boolean;
+    /** List of main Figma items/ Список основных элементов Figma */
+    protected mainItem: FigmaItem[];
+    /**
+     * List of all Figma items.
+     *
+     * Список всех элементов Figma.
+     */
+    protected items: FigmaItem[];
+    /**
+     * Constructor
+     * @param page Figma page or node / страница или узел Figma
+     * @param selection whether to use the current selection or the entire page / использовать текущее выделение или всю страницу
+     */
+    constructor(page: UiFigmaNode, selection?: boolean);
+    /**
+     * Checks if the current context is a selection.
+     *
+     * Проверяет, является ли текущий контекст выделением.
+     * @returns true if the context is a selection / true, если контекст является выделением
+     */
+    isSelection(): this is {
+        page: PageNode;
+    };
+    /**
+     * Returns all frame items.
+     *
+     * Возвращает все элементы-фреймы.
+     * @returns list of frame items / список элементов-фреймов
+     */
+    getItemsFrame(): FigmaItem<FrameNode>[];
+    /**
+     * Returns all section items.
+     *
+     * Возвращает все элементы-секции.
+     * @returns list of section items / список элементов-секций
+     */
+    getItemsSection(): FigmaItem<SectionNode>[];
+    /**
+     * Returns all text items.
+     *
+     * Возвращает все текстовые элементы.
+     * @returns list of text items / список текстовых элементов
+     */
+    getItemsText(): FigmaItem<TextNode>[];
+    /**
+     * Returns a list of frames with their names, IDs, and screenshots.
+     *
+     * Возвращает список фреймов с их названиями, идентификаторами и скриншотами.
+     * @returns promise with frame information list / промис со списком информации о фреймах
+     */
+    getItemsInfo(): Promise<UiFigmaFramesList>;
+    /**
+     * Returns CSS styles for all items.
+     *
+     * Возвращает CSS-стили для всех элементов.
+     * @returns promise with CSS styles list / промис со списком CSS-стилей
+     */
+    getItemsCss(): Promise<UiFigmaFrameStylesCssList>;
+    /**
+     * Returns a list of frames with their styles.
+     *
+     * Возвращает список фреймов с их стилями.
+     * @returns promise with frame styles list / промис со списком стилей фреймов
+     */
+    getItemsStyles(): Promise<UiFigmaFrameStylesList>;
+    /**
+     * Returns main frames from the root node.
+     *
+     * Возвращает основные фреймы из корневого узла.
+     * @returns list of main frame items / список основных элементов-фреймов
+     */
+    getMainFrames(): FigmaItem[];
+    /**
+     * Returns a list of frames with their names, IDs, and screenshots.
+     *
+     * Возвращает список фреймов с их названиями, идентификаторами и скриншотами.
+     * @returns promise with frame information list / промис со списком информации о фреймах
+     */
+    getMainItemsInfo(): Promise<UiFigmaFramesList>;
+    /**
+     * Returns a list of main frames with their styles.
+     *
+     * Возвращает список основных фреймов с их стилями.
+     * @returns promise with frame styles list / промис со списком стилей фреймов
+     */
+    getMainItemsStyles(): Promise<UiFigmaFrameStylesList>;
+    /**
+     * Returns all text nodes with their IDs grouped by text content.
+     *
+     * Возвращает все текстовые узлы с их идентификаторами, сгруппированные по текстовому содержимому.
+     * @returns list of grouped text items / список сгруппированных текстовых элементов
+     */
+    getTexts(): UiFigmaItemText[];
+    /**
+     * Takes screenshots of the main items.
+     *
+     * Делает скриншоты основных элементов.
+     * @returns promise with list of screenshots as Uint8Array / промис со списком скриншотов в формате Uint8Array
+     */
+    screenshot(): Promise<Uint8Array<ArrayBufferLike>[]>;
+    /**
+     * Returns information about the specified items.
+     *
+     * Возвращает информацию об указанных элементах.
+     * @param items list of items / список элементов
+     * @returns promise with information list / промис со списком информации
+     */
+    protected getInfoByItems(items: FigmaItem[]): Promise<UiFigmaFramesList>;
+    /**
+     * Returns styles for the specified items.
+     *
+     * Возвращает стили для указанных элементов.
+     * @param items list of items / список элементов
+     * @param subStyle whether to include child styles / нужно ли включать стили дочерних элементов
+     * @returns promise with styles list / промис со списком стилей
+     */
+    protected getStylesByItems(items: FigmaItem[], subStyle?: boolean): Promise<UiFigmaFrameStylesList>;
+    /**
+     * Initializes main items based on selection or entire page.
+     *
+     * Инициализирует основные элементы на основе выделения или всей страницы.
+     * @returns list of main Figma items / список основных элементов Figma
+     */
+    protected initMain(): FigmaItem<UiFigmaNode>[];
+    /**
+     * Recursively initializes all items from the page.
+     *
+     * Рекурсивно инициализирует все элементы со страницы.
+     * @param page Figma page or node / страница или узел Figma
+     * @returns list of initialized Figma items / список инициализированных элементов Figma
+     */
+    protected initItems(page: UiFigmaNode): FigmaItem[];
+    /**
+     * Initializes items based on the current selection or entire page.
+     *
+     * Инициализирует элементы на основе текущего выделения или всей страницы.
+     * @returns list of initialized Figma items / список инициализированных элементов Figma
+     */
+    protected initBySelection(): FigmaItem<UiFigmaNode>[];
+    /**
+     * Filters items by the specified condition.
+     *
+     * Фильтрует элементы по указанному условию.
+     * @param callback filter function/ функция фильтрации
+     * @returns filtered list of items / отфильтрованный список элементов
+     */
+    protected filter<R extends UiFigmaNode>(callback: (item: FigmaItem) => boolean): FigmaItem<R>[];
+    /**
+     * Returns the main (root) item in the hierarchy.
+     *
+     * Возвращает главный (корневой) элемент в иерархии.
+     * @param item starting item / начальный элемент
+     * @returns root Figma item / корневой элемент Figma
+     */
+    protected toMain(item?: FigmaItem): FigmaItem;
+}

package/dist/classes/FigmaFramesSelected.d.ts

@@ -0,0 +1,75 @@
+import { FigmaStorage } from './FigmaStorage';
+/**
+ * Class for managing and synchronizing the list of selected frames in the Figma plugin.
+ *
+ * Класс для управления и синхронизации списка выбранных фреймов в плагине Figma.
+ */
+export declare class FigmaFramesSelected {
+    /** Storage for persistent selected frames / Хранилище для постоянного списка выбранных фреймов */
+    protected static storage: FigmaStorage<string[]>;
+    /** Cached list of selected frame IDs / Кэшированный список идентификаторов выбранных фреймов */
+    protected static selected: string[] | undefined;
+    /**
+     * Checks if a frame with the given ID is selected.
+     *
+     * Проверяет, выбран ли фрейм с указанным идентификатором.
+     * @param id Frame ID / Идентификатор фрейма
+     * @returns `true` if selected / `true`, если выбран
+     */
+    static has(id: string): boolean;
+    /**
+     * Retrieves the current list of selected frame IDs, using cache if available.
+     *
+     * Получает текущий список идентификаторов выбранных фреймов, используя кэш при его наличии.
+     * @returns An array of selected frame IDs / Массив идентификаторов выбранных фреймов
+     */
+    static get(): string[];
+    /**
+     * Adds a frame ID to the selection list.
+     *
+     * Добавляет идентификатор фрейма в список выбора.
+     * @param id Frame ID / Идентификатор фрейма
+     */
+    static add(id: string): void;
+    /**
+     * Removes a frame ID from the selection list.
+     *
+     * Удаляет идентификатор фрейма из списка выбора.
+     * @param id Frame ID / Идентификатор фрейма
+     */
+    static remove(id: string): void;
+    /**
+     * Toggles the selection state of a frame.
+     *
+     * Переключает состояние выбора фрейма.
+     * @param id Frame ID / Идентификатор фрейма
+     * @param selected Whether to select or deselect / Выбрать или отменить выбор
+     */
+    static toggle(id: string, selected: boolean): void;
+    /**
+     * Sets up communication via the plugin messenger to handle selection state.
+     *
+     * Настраивает связь через мессенджер плагина для управления состоянием выбора.
+     */
+    static send(): void;
+    /**
+     * Retrieves the raw selection list from storage.
+     *
+     * Получает необработанный список выбора из хранилища.
+     * @returns An array of frame IDs / Массив идентификаторов фреймов
+     */
+    protected static getList(): string[];
+    /**
+     * Updates the selection list in cache and storage.
+     *
+     * Обновляет список выбора в кэше и хранилище.
+     * @param selected New selection list / Новый список выбора
+     */
+    protected static set(selected: string[]): void;
+    /**
+     * Posts the current selection list to the Figma UI.
+     *
+     * Публикует текущий список выбора в интерфейс Figma.
+     */
+    protected static post(): void;
+}

package/dist/classes/FigmaItem.d.ts

@@ -0,0 +1,223 @@
+import { UiFigmaFramesItem, UiFigmaFrameStylesData, UiFigmaFrameStylesItem, UiFigmaFrameStylesJson } from '@dxtmisha/figma';
+import { UiFigmaExportFormat, UiFigmaNode } from '../types/figmaTypes';
+/**
+ * Class for working with Figma nodes.
+ *
+ * Класс для работы с узлами Figma.
+ * @template T type of Figma node/ тип узла Figma
+ */
+export declare class FigmaItem<T extends UiFigmaNode = UiFigmaNode> {
+    protected item: T;
+    /**
+     * Constructor
+     * @param item Figma node/ узел Figma
+     */
+    constructor(item: T);
+    /**
+     * Checks if the node is a document.
+     *
+     * Проверяет, является ли узел документом.
+     * @returns true if the node is a document / true, если узел является документом
+     */
+    isDocument(): this is {
+        item: DocumentNode;
+    };
+    /**
+     * Checks if the node is a frame.
+     *
+     * Проверяет, является ли узел фреймом.
+     * @returns true if the node is a frame / true, если узел является фреймом
+     */
+    isFrame(): this is {
+        item: FrameNode;
+    };
+    /**
+     * Checks if the node is a section.
+     *
+     * Проверяет, является ли узел секцией.
+     * @returns true if the node is a section / true, если узел является секцией
+     */
+    isSection(): this is {
+        item: SectionNode;
+    };
+    /**
+     * Checks if the node is a text node.
+     *
+     * Проверяет, является ли узел текстовым узлом.
+     * @returns true if the node is a text node / true, если узел является текстовым узлом
+     */
+    isText(): this is {
+        item: TextNode;
+    };
+    /**
+     * Checks if the node is a text node with a meaningful value.
+     *
+     * Проверяет, является ли узел текстовым узлом с осмысленным значением.
+     * @returns true if it is a text node with a value / true, если это текстовый узел со значением
+     */
+    isTextNoValue(): this is {
+        item: TextNode;
+    };
+    /**
+     * Checks if the node is in the current page.
+     *
+     * Проверяет, находится ли узел на текущей странице.
+     * @returns true if the node is in the current page / true, если узел находится на текущей странице
+     */
+    inCurrentPage(): boolean;
+    /**
+     * Returns the Figma node.
+     *
+     * Возвращает узел Figma.
+     * @returns Figma node / узел Figma
+     */
+    get(): T;
+    /**
+     * Returns the type of the node.
+     *
+     * Возвращает тип узла.
+     * @returns node type / тип узла
+     */
+    getType(): "SLICE" | "FRAME" | "GROUP" | "COMPONENT_SET" | "COMPONENT" | "INSTANCE" | "BOOLEAN_OPERATION" | "VECTOR" | "STAR" | "LINE" | "ELLIPSE" | "POLYGON" | "RECTANGLE" | "TEXT" | "TEXT_PATH" | "TRANSFORM_GROUP" | "STICKY" | "CONNECTOR" | "SHAPE_WITH_TEXT" | "CODE_BLOCK" | "STAMP" | "WIDGET" | "EMBED" | "LINK_UNFURL" | "MEDIA" | "SECTION" | "HIGHLIGHT" | "WASHI_TAPE" | "TABLE" | "SLIDE" | "SLIDE_ROW" | "SLIDE_GRID" | "SLOT" | "INTERACTIVE_SLIDE_ELEMENT" | "DOCUMENT" | "PAGE" | undefined;
+    /**
+     * Returns the parent node.
+     *
+     * Возвращает родительский узел.
+     * @returns parent node / родительский узел
+     */
+    getParent(): (BaseNode & ChildrenMixin) | undefined;
+    /**
+     * Returns the parent node wrapped in FigmaItem.
+     *
+     * Возвращает родительский узел, обернутый в FigmaItem.
+     * @returns parent FigmaItem / родительский FigmaItem
+     */
+    getParentItem(): FigmaItem | undefined;
+    /**
+     * Returns the parent page.
+     *
+     * Возвращает родительскую страницу.
+     * @returns parent page / родительская страница
+     */
+    getParentPage(): PageNode | undefined;
+    /**
+     * Returns the parent page wrapped in FigmaItem.
+     *
+     * Возвращает родительскую страницу, обернутую в FigmaItem.
+     * @returns parent page FigmaItem / родительская страница FigmaItem
+     */
+    getParentPageItem(): FigmaItem | undefined;
+    /**
+     * Returns the child nodes.
+     *
+     * Возвращает дочерние узлы.
+     * @returns list of child nodes / список дочерних узлов
+     */
+    getChildren(): UiFigmaNode[];
+    /**
+     * Returns the child nodes wrapped in FigmaItem.
+     *
+     * Возвращает дочерние узлы, обернутые в FigmaItem.
+     * @returns list of child FigmaItems / список дочерних FigmaItems
+     */
+    getChildrenItems(): FigmaItem[];
+    /**
+     * Returns the node ID.
+     *
+     * Возвращает идентификатор узла.
+     * @returns node ID / идентификатор узла
+     */
+    getId(): string;
+    /**
+     * Returns the node name.
+     *
+     * Возвращает имя узла.
+     * @returns node name / имя узла
+     */
+    getName(): string;
+    /**
+     * Returns the text content of the node.
+     *
+     * Возвращает текстовое содержимое узла.
+     * @returns text content / текстовое содержимое
+     */
+    getText(): string;
+    /**
+     * Returns the CSS styles of the node.
+     *
+     * Возвращает CSS-стили узла.
+     * @returns promise with CSS styles / промис с CSS-стилями
+     */
+    getCss(): Promise<Record<string, string>>;
+    /**
+     * Returns information about the node.
+     *
+     * Возвращает информацию об узле.
+     * @returns promise with node information / промис с информацией об узле
+     */
+    getInfo(): Promise<UiFigmaFramesItem>;
+    /**
+     * Returns the styles of the node.
+     *
+     * Возвращает стили узла.
+     * @returns promise with node styles / промис со стилями узла
+     */
+    getStyles(): Promise<UiFigmaFrameStylesItem>;
+    /**
+     * Exports the node as JPG.
+     *
+     * Экспортирует узел в формате JPG.
+     * @returns promise with image data as Uint8Array / промис с данными изображения в формате Uint8Array
+     */
+    exportJpg(): Promise<Uint8Array<ArrayBufferLike> | "">;
+    /**
+     * Exports the node as JSON.
+     *
+     * Экспортирует узел в формате JSON.
+     * @returns promise with node data in JSON format / промис с данными узла в формате JSON
+     */
+    exportJson(): Promise<Uint8Array<ArrayBufferLike> | "">;
+    /**
+     * Exports the node as compact JSON.
+     *
+     * Экспортирует узел в формате компактного JSON.
+     * @returns promise with compact JSON data / промис с компактными данными JSON
+     */
+    exportJsonCompact(): Promise<UiFigmaFrameStylesData | undefined>;
+    /**
+     * Selects the node.
+     *
+     * Выделяет узел.
+     */
+    toSelection(): void;
+    /**
+     * Moves to the page containing the node and selects it.
+     *
+     * Перемещает на страницу, содержащую узел, и выделяет его.
+     */
+    toPageAndSelection(): Promise<void>;
+    /**
+     * Converts format settings to ExportSettings.
+     *
+     * Преобразует настройки формата в ExportSettings.
+     * @param formatSettings format settings / настройки формата
+     * @returns export settings / настройки экспорта
+     */
+    protected getExportSettings(formatSettings: UiFigmaExportFormat | ExportSettings): ExportSettings;
+    /**
+     * Exports the node in the specified format.
+     *
+     * Экспортирует узел в указанном формате.
+     * @param formatSettings format settings / настройки формата
+     * @returns promise with exported data / промис с экспортированными данными
+     */
+    protected exportItem(formatSettings: UiFigmaExportFormat | ExportSettings): Promise<Uint8Array<ArrayBufferLike> | "">;
+    /**
+     * Converts node data to compact JSON format.
+     *
+     * Преобразует данные узла в компактный формат JSON.
+     * @param data node data / данные узла
+     * @returns compact JSON data / компактные данные JSON
+     */
+    protected toJsonCompact(data: Record<string, any>): UiFigmaFrameStylesJson;
+}

package/dist/classes/FigmaPluginMessenger.d.ts

@@ -0,0 +1,29 @@
+import { FigmaPostAbstract } from '@dxtmisha/figma';
+/**
+ * Messenger for the Figma plugin side (backend).
+ *
+ * Мессенджер для стороны плагина Figma (backend).
+ */
+export declare class FigmaPluginMessenger extends FigmaPostAbstract {
+    /**
+     * Getting an instance of the class for working with Figma plugin messenger (backend).
+     *
+     * Получение экземпляра класса для работы с мессенджером плагина Figma (backend).
+     * @returns current instance/ текущий экземпляр
+     */
+    static getInstance(): FigmaPluginMessenger;
+    /**
+     * Sends a message to the Figma UI.
+     *
+     * Отправляет сообщение в UI Figma.
+     * @param type The type of the message / Тип сообщения
+     * @param message The message data / Данные сообщения
+     */
+    post<Message>(type: string, message?: Message): void;
+    /**
+     * Initializes the listener using the figma.ui.onmessage API.
+     *
+     * Инициализирует слушатель, используя API figma.ui.onmessage.
+     */
+    protected prepare(): void;
+}

package/dist/classes/FigmaStorage.d.ts

@@ -0,0 +1,74 @@
+import { FigmaStorageData, FigmaStorageDataValue } from './FigmaStorageData';
+import { UiFigmaNode } from '../types/figmaTypes';
+/**
+ * Class for working with Figma storage (PluginData).
+ *
+ * Класс для работы с хранилищем Figma (PluginData).
+ */
+export declare class FigmaStorage<T> {
+    protected readonly name: string;
+    protected readonly item: PluginDataMixin;
+    protected readonly cache?: number | undefined;
+    /**
+     * Getting an instance of the class for working with Figma storage (PluginData).
+     *
+     * Получение экземпляра класса для работы с хранилищем Figma (PluginData).
+     * @param name value name/ название значения
+     * @param item object for storing data/ объект для хранения данных
+     * @returns current instance/ текущий экземпляр
+     */
+    static getInstance<T>(name: string, item?: UiFigmaNode): FigmaStorage<T>;
+    /**
+     * Getting an instance of the class for working with Figma storage (PluginData).
+     *
+     * Получение экземпляра класса для работы с хранилищем Figma (PluginData).
+     * @param name value name/ название значения
+     * @param id object id/ id объекта
+     * @returns current instance/ текущий экземпляр
+     */
+    static getInstanceById<T>(name: string, id?: string): Promise<FigmaStorage<T>>;
+    protected data: FigmaStorageData<T>;
+    /**
+     * Constructor
+     * @param name value name/ название значения
+     * @param item object for storing data/ объект для хранения данных
+     * @param cache cache time/ время кэширования
+     */
+    constructor(name: string, item?: PluginDataMixin, cache?: number | undefined);
+    /**
+     * Getting data from storage.
+     *
+     * Получение данных из хранилища.
+     * @param defaultValue default value/ значение по умолчанию
+     */
+    get(defaultValue?: T | (() => T)): T | undefined;
+    /**
+     * Changing data in storage.
+     *
+     * Изменение данных в хранилище.
+     * @param value new values/ новые значения
+     * @returns current value/ текущее значение
+     */
+    set(value?: T | (() => T)): T | undefined;
+    /**
+     * Removing data from storage.
+     *
+     * Удаление данных из хранилища.
+     * @returns current instance/ текущий экземпляр
+     */
+    remove(): this;
+    /**
+     * Getting data from storage.
+     *
+     * Получение данных из хранилища.
+     * @returns data from storage/ данные из хранилища
+     */
+    protected getValue(): FigmaStorageDataValue<T> | undefined;
+    /**
+     * Making an instance from storage data.
+     *
+     * Создание экземпляра из данных хранилища.
+     * @returns current instance/ текущий экземпляр
+     */
+    protected make(): this;
+}

package/dist/classes/FigmaStorageData.d.ts

@@ -0,0 +1,117 @@
+/** Type for storing data in Figma Storage/ Тип для хранения данных в Figma Storage */
+export type FigmaStorageDataValue<T> = {
+    /** Value/ Значение */
+    value: T;
+    /** Age/ Возраст */
+    age: number;
+};
+/**
+ * Class for managing Figma storage data.
+ *
+ * Класс для управления данными хранилища Figma.
+ * @template T type of data/ тип данных
+ */
+export declare class FigmaStorageData<T> {
+    protected readonly name: string;
+    protected readonly cache?: number | undefined;
+    /** Current value in the instance/ Текущее значение в экземпляре */
+    protected value?: T;
+    /** Value update time/ Время обновления значения */
+    protected age?: number;
+    /**
+     * Constructor
+     * @param name value name/ название значения
+     * @param cache cache time/ время кэширования
+     */
+    constructor(name: string, cache?: number | undefined);
+    /**
+     * Checks if the value is null or undefined.
+     *
+     * Проверяет, является ли значение null или undefined.
+     */
+    isNull(): boolean;
+    /**
+     * Checks for storage time limit.
+     *
+     * Проверяет на лимит времени хранения.
+     */
+    isCache(): boolean;
+    /**
+     * Checks if the value is defined and within the cache limit.
+     *
+     * Проверяет, определено ли значение и находится ли оно в пределах лимита кэша.
+     */
+    isValue(): boolean;
+    /**
+     * Returns the current value.
+     *
+     * Возвращает текущее значение.
+     */
+    get(): T | undefined;
+    /**
+     * Returns the update time of the value.
+     *
+     * Возвращает время обновления значения.
+     */
+    getAge(): number | undefined;
+    /**
+     * Returns the storage key name.
+     *
+     * Возвращает имя ключа в хранилище.
+     */
+    getName(): string;
+    /**
+     * Returns the cache time.
+     *
+     * Возвращает время кэширования.
+     */
+    getCache(): number | undefined;
+    /**
+     * Sets the value and age.
+     *
+     * Устанавливает значение и время.
+     * @param value new value/ новое значение
+     * @param age update time/ время обновления
+     */
+    set(value?: T, age?: number): this;
+    /**
+     * Sets data from a FigmaStorageDataValue object.
+     *
+     * Устанавливает данные из объекта FigmaStorageDataValue.
+     * @param value data object/ объект данных
+     */
+    setByObject(value?: FigmaStorageDataValue<T>): this;
+    /**
+     * Sets the value.
+     *
+     * Устанавливает значение.
+     * @param value new value/ новое значение
+     */
+    setValue(value?: T): this;
+    /**
+     * Sets the update time.
+     *
+     * Устанавливает время обновления.
+     * @param age update time/ время обновления
+     */
+    setAge(age?: number): this;
+    /**
+     * Updates the value and sets the current time as age.
+     *
+     * Обновляет значение и устанавливает текущее время.
+     * @param value new value/ новое значение
+     */
+    update(value?: T): this;
+    /**
+     * Removes the data.
+     *
+     * Удаляет данные.
+     */
+    remove(): this;
+    /**
+     * Converts data to a FigmaStorageDataValue object for storage.
+     *
+     * Преобразует данные в объект FigmaStorageDataValue для хранения.
+     */
+    toValue(): FigmaStorageDataValue<T>;
+}