@dxtmisha/scripts 0.11.8 → 1.0.0

package/dist/library-figma.d.ts

@@ -0,0 +1,462 @@
+/**
+ * Class for downloading and processing design assets from Figma API.
+ * Serves as an abstraction for initializing SVG graphics and frame exports from specified Figma files.
+ *
+ * Класс для скачивания и обработки дизайн-ассетов из Figma API.
+ * Служит абстракцией для инициализации SVG-графики и экспорта кадров из указанных файлов Figma.
+ */
+export declare class DesignFigma {
+    protected readonly fileKey: string;
+    protected readonly nodeId?: string | undefined;
+    protected readonly token: string;
+    /** Figma REST API client instance / Экземпляр клиента REST API Figma */
+    protected readonly api: FigmaApi;
+    /**
+     * Creates an instance of DesignFigma.
+     *
+     * Создает экземпляр DesignFigma.
+     * @param fileKey unique Figma file identifier / уникальный идентификатор файла Figma
+     * @param nodeId target node or frame identifier in Figma file / идентификатор целевого узла или кадра в файле Figma
+     * @param token Figma API access token / токен доступа к API Figma
+     */
+    constructor(fileKey: string, nodeId?: string | undefined, token?: string);
+    /**
+     * Executes the main workflow for retrieving and logging Figma design image assets.
+     *
+     * Выполняет основной процесс получения и логирования графических ассетов дизайна Figma.
+     */
+    make(): Promise<void>;
+    /**
+     * Requests SVG image export URLs for the specified node from Figma API.
+     *
+     * Запрашивает URL-адреса экспорта SVG-изображений для указанного узла через API Figma.
+     * @returns map of node IDs to SVG image URLs, or undefined on error / карта ID узлов к URL SVG-изображений или undefined в случае ошибки
+     */
+    initImage(): Promise<Record<string, string> | undefined>;
+}
+
+/**
+ * Class for interacting with the Figma REST API.
+ *
+ * Класс для взаимодействия с Figma REST API.
+ */
+declare class FigmaApi {
+    protected token: string;
+    protected fileKey: string;
+    protected nodeId?: string | undefined;
+    /**
+     * Constructor for FigmaApi.
+     *
+     * Конструктор для FigmaApi.
+     * @param token Figma REST API access token / токен доступа к REST API Figma
+     * @param fileKey unique Figma file identifier / уникальный идентификатор файла Figma
+     * @param nodeId optional target node identifier / необязательный идентификатор целевого узла
+     */
+    constructor(token: string, fileKey: string, nodeId?: string | undefined);
+    /**
+     * Retrieves file content via the files endpoint.
+     *
+     * Получает содержимое файла через эндпоинт files.
+     * @param parameters query parameters / параметры запроса
+     * @returns file content or undefined / содержимое файла или undefined
+     */
+    files(parameters?: FigmaFilesParams): Promise<FigmaFilesResult | undefined>;
+    /**
+     * Retrieves specific nodes from the file via the fileNodes endpoint.
+     *
+     * Получает конкретные узлы из файла через эндпоинт fileNodes.
+     * @param parameters query parameters / параметры запроса
+     * @returns node data or undefined / данные узлов или undefined
+     */
+    fileNodes(parameters: FigmaFileNodesParams): Promise<FigmaFileNodesResult | undefined>;
+    /**
+     * Retrieves images for the file.
+     *
+     * Получает изображения для файла.
+     * @param parameters query parameters / параметры запроса
+     * @returns image data or undefined / данные изображения или undefined
+     */
+    fileImages(parameters: FigmaFileImagesParams): Promise<FigmaFileImagesResult | undefined>;
+    /**
+     * Retrieves specific nodes from the file via the fileStyles endpoint.
+     *
+     * Получает конкретные узлы из файла через эндпоинт fileStyles.
+     * @returns file styles data or undefined / данные стилей файла или undefined
+     */
+    fileStyles(): Promise<FigmaFileStylesResult | undefined>;
+    /**
+     * Retrieves specific style by key via the styles endpoint.
+     *
+     * Получает конкретный стиль по ключу через эндпоинт styles.
+     * @param key the style key / ключ стиля
+     * @returns style data or undefined / данные стиля или undefined
+     */
+    styles(key: string): Promise<FigmaStylesResult | undefined>;
+    /**
+     * Sets the API token.
+     *
+     * Устанавливает токен API.
+     * @param token the API token / токен API
+     * @returns this instance for chaining / этот экземпляр для цепочки вызовов
+     */
+    setToken(token: string): this;
+    /**
+     * Sets the file key.
+     *
+     * Устанавливает ключ файла.
+     * @param fileKey the file key / ключ файла
+     * @returns this instance for chaining / этот экземпляр для цепочки вызовов
+     */
+    setFileKey(fileKey: string): this;
+    /**
+     * Sets the node ID.
+     *
+     * Устанавливает ID узла.
+     * @param nodeId the node ID (optional) / ID узла (необязательно)
+     * @returns this instance for chaining / этот экземпляр для цепочки вызовов
+     */
+    setNodeId(nodeId?: string): this;
+    /**
+     * Constructs the request URL for the Figma API.
+     *
+     * Конструирует URL-адрес запроса для Figma API.
+     * @param method the API endpoint method / метод конечной точки API
+     * @param parameters additional parameters for the request / дополнительные параметры для запроса
+     * @param key the key for specific endpoints (e.g., styles) / ключ для конкретных эндпоинтов (например, styles)
+     * @returns the constructed URL / сконструированный URL
+     */
+    getUrl(method: FigmaApiEndpoint, parameters?: Record<string, any>, key?: string): string;
+    /**
+     * Generic fetch method for making API requests.
+     *
+     * Общий метод fetch для выполнения запросов к API.
+     * @param method the API endpoint method / метод конечной точки API
+     * @param parameters parameters for the request / параметры запроса
+     * @param key the key for specific endpoints (e.g., styles) / ключ для конкретных эндпоинтов (например, styles)
+     * @returns the response data or undefined / данные ответа или undefined
+     */
+    protected fetch(method: FigmaApiEndpoint, parameters?: Record<string, any>, key?: string): Promise<any>;
+}
+
+/**
+ * Figma REST API endpoints enum.
+ *
+ * Перечисление эндпоинтов Figma REST API.
+ */
+declare enum FigmaApiEndpoint {
+    /** Get file content / Получить содержимое файла */
+    files = "files/:file_key",
+    /** Get specific nodes from a file / Получить конкретные узлы из файла */
+    fileNodes = "files/:file_key/nodes",
+    /** Get specific images from a file / Получить конкретные изображения из файла */
+    fileImages = "images/:file_key",
+    /** Get image fills from a file / Получить заливки изображений из файла */
+    fileImageFills = "files/:file_key/images",
+    /** Get file versions / Получить версии файла */
+    fileVersions = "files/:file_key/versions",
+    /** Get file comments / Получить комментарии файла */
+    fileComments = "files/:file_key/comments",
+    /** Get user information / Получить информацию о пользователе */
+    me = "me",
+    /** Get team projects / Получить проекты команды */
+    teamProjects = "teams/:team_id/projects",
+    /** Get project files / Получить файлы проекта */
+    projectFiles = "projects/:project_id/files",
+    /** Get component information / Получить информацию о компоненте */
+    components = "components/:key",
+    /** Get file components / Получить компоненты файла */
+    fileComponents = "files/:file_key/components",
+    /** Get team components / Получить компоненты команды */
+    teamComponents = "teams/:team_id/components",
+    /** Get component set information / Получить информацию о наборе компонентов */
+    componentSets = "component_sets/:key",
+    /** Get file component sets / Получить наборы компонентов файла */
+    fileComponentSets = "files/:file_key/component_sets",
+    /** Get team component sets / Получить наборы компонентов команды */
+    teamComponentSets = "teams/:team_id/component_sets",
+    /** Get style information / Получить информацию о стиле */
+    styles = "styles/:key",
+    /** Get file styles / Получить стили файла */
+    fileStyles = "files/:file_key/styles",
+    /** Get team styles / Получить стили команды */
+    teamStyles = "teams/:team_id/styles"
+}
+
+/**
+ * Parameters for the fileImages endpoint.
+ *
+ * Параметры для эндпоинта fileImages.
+ */
+declare type FigmaFileImagesParams = {
+    /** A comma separated list of node IDs to render / Список ID узлов через запятую для рендеринга */
+    ids: string;
+    /** A number between 0.01 and 4, the image scaling factor / Число от 0.01 до 4, коэффициент масштабирования изображения */
+    scale?: number;
+    /** The image output format, as a string enum / Формат вывода изображения в виде строки enum */
+    format?: 'jpg' | 'png' | 'svg' | 'pdf';
+    /**
+     * Whether text elements are rendered as outlines (vector paths) or as <text> elements in SVGs /
+     * Визуализируются ли текстовые элементы как контуры (векторные контуры) или как элементы <text> в SVG
+     * @default true
+     */
+    svg_outline_text?: boolean;
+    /**
+     * Whether to include id attributes for all SVG elements. Adds the layer name to the id attribute of an svg element /
+     * Включать ли атрибуты id для всех элементов SVG. Добавляет имя слоя в атрибут id элемента svg
+     * @default false
+     */
+    svg_include_id?: boolean;
+    /**
+     * Whether to include node id attributes for all SVG elements. Adds the node id to a data-node-id attribute of an svg element /
+     * Включать ли атрибуты id узла для всех элементов SVG. Добавляет id узла в атрибут data-node-id элемента svg
+     * @default false
+     */
+    svg_include_node_id?: boolean;
+    /**
+     * Whether to simplify inside/outside strokes and use stroke attribute if possible instead of <mask> /
+     * Упрощать ли внутренние/внешние обводки и использовать атрибут stroke, если это возможно, вместо <mask>
+     * @default true
+     */
+    svg_simplify_stroke?: boolean;
+    /**
+     * Whether content that overlaps the node should be excluded from rendering /
+     * Должен ли контент, перекрывающий узел, быть исключен из рендеринга
+     * @default true
+     */
+    contents_only?: boolean;
+    /**
+     * Use the full dimensions of the node regardless of whether or not it is cropped or the space around it is empty /
+     * Использовать полные размеры узла независимо от того, обрезан он или пространство вокруг него пустое
+     * @default false
+     */
+    use_absolute_bounds?: boolean;
+    /** A specific version ID to use / Идентификатор конкретной версии для использования */
+    version?: string;
+};
+
+/**
+ * Result returned by the fileImages endpoint.
+ *
+ * Результат, возвращаемый эндпоинтом fileImages.
+ */
+declare type FigmaFileImagesResult = {
+    /** Error message if the request failed / Сообщение об ошибке, если запрос не удался */
+    err: string | null;
+    /** A mapping from node IDs to URLs of the rendered images / Сопоставление ID узлов с URL-адресами отрендеренных изображений */
+    images: Record<string, string>;
+    /** Status code of the response / Код статуса ответа */
+    status: number;
+};
+
+/**
+ * Parameters for the fileNodes endpoint.
+ *
+ * Параметры для эндпоинта fileNodes.
+ */
+declare type FigmaFileNodesParams = {
+    /** A comma separated list of node IDs to retrieve and convert / Список ID узлов через запятую для получения и преобразования */
+    ids: string;
+    /** A specific version ID to get / Идентификатор конкретной версии для получения */
+    version?: string;
+    /** How deep into the node tree to traverse / Насколько глубоко по дереву узлов нужно пройтись */
+    depth?: number;
+    /** Set to "paths" to export vector data / Установите "paths" для экспорта векторных данных */
+    geometry?: 'paths';
+    /** A comma separated list of plugin IDs to include their data / Список ID плагинов через запятую для включения их данных */
+    plugin_data?: string;
+};
+
+/**
+ * Result returned by the fileNodes endpoint.
+ *
+ * Результат, возвращаемый эндпоинтом fileNodes.
+ */
+declare type FigmaFileNodesResult = {
+    /** File name / Название файла */
+    name: string;
+    /** User's role in the file / Роль пользователя в файле */
+    role: string;
+    /** Last modified date / Дата последнего изменения */
+    lastModified: string;
+    /** Editor type (figma or figjam) / Тип редактора (figma или figjam) */
+    editorType: string;
+    /** URL to the file thumbnail / URL миниатюры файла */
+    thumbnailUrl: string;
+    /** Error message if any / Сообщение об ошибке, если есть */
+    err?: string;
+    /** Map of node IDs to node data / Карта ID узлов и данных узлов */
+    nodes: Record<string, {
+        /** The root node of the requested subtree / Корневой узел запрошенного поддерева */
+        document: any;
+        /** Map of components used in the subtree / Карта компонентов, используемых в поддереве */
+        components: Record<string, any>;
+        /** Map of component sets used in the subtree / Карта наборов компонентов, используемых в поддереве */
+        componentSets: Record<string, any>;
+        /** Schema version / Версия схемы */
+        schemaVersion: number;
+        /** Map of styles used in the subtree / Карта стилей, используемых в поддереве */
+        styles: Record<string, any>;
+    }>;
+};
+
+/**
+ * Parameters for the files endpoint.
+ *
+ * Параметры для эндпоинта files.
+ */
+declare type FigmaFilesParams = {
+    /** A specific version ID to get / Идентификатор конкретной версии для получения */
+    version?: string;
+    /** Comma separated list of nodes that you care about in the document / Список узлов через запятую, которые вас интересуют в документе */
+    ids?: string;
+    /** How deep into the document tree to traverse / Насколько глубоко по дереву документа нужно пройтись */
+    depth?: number;
+    /** Set to "paths" to export vector data / Установите "paths" для экспорта векторных данных */
+    geometry?: 'paths';
+    /** A comma separated list of plugin IDs to include their data / Список ID плагинов через запятую для включения их данных */
+    plugin_data?: string;
+    /**
+     * Returns branch metadata for the requested file /
+     * Возвращает метаданные ветки для запрошенного файла
+     * @default false
+     */
+    branch_data?: boolean;
+};
+
+/**
+ * Result returned by the files endpoint.
+ *
+ * Результат, возвращаемый эндпоинтом files.
+ */
+declare type FigmaFilesResult = {
+    /** File name / Название файла */
+    name: string;
+    /** User's role in the file / Роль пользователя в файле */
+    role: string;
+    /** Last modified date / Дата последнего изменения */
+    lastModified: string;
+    /** Editor type (figma or figjam) / Тип редактора (figma или figjam) */
+    editorType: string;
+    /** URL to the file thumbnail / URL миниатюры файла */
+    thumbnailUrl: string;
+    /** Version ID / Идентификатор версии */
+    version: string;
+    /** The root node of the document / Корневой узел документа */
+    document: any;
+    /** Map of components used in the file / Карта компонентов, используемых в файле */
+    components: Record<string, any>;
+    /** Map of component sets used in the file / Карта наборов компонентов, используемых в файле */
+    componentSets: Record<string, any>;
+    /** Schema version / Версия схемы */
+    schemaVersion: number;
+    /** Map of styles used in the file / Карта стилей, используемых в файле */
+    styles: Record<string, any>;
+    /** Main file key if this is a branch / Ключ основного файла, если это ветка */
+    mainFileKey?: string;
+    /** List of branches for the file / Список веток для файла */
+    branches?: {
+        /** Branch key / Ключ ветки */
+        key: string;
+        /** Branch name / Название ветки */
+        name: string;
+        /** URL to the branch thumbnail / URL миниатюры ветки */
+        thumbnail_url: string;
+        /** Last modified date of the branch / Дата последнего изменения ветки */
+        last_modified: string;
+        /** Link access level / Уровень доступа по ссылке */
+        link_access: string;
+    }[];
+};
+
+/**
+ * Result returned by the fileStyles endpoint.
+ *
+ * Результат, возвращаемый эндпоинтом fileStyles.
+ */
+declare type FigmaFileStylesResult = {
+    /** Status code of the response / Код статуса ответа */
+    status: number;
+    /** Whether an error occurred / Произошла ли ошибка */
+    error: boolean;
+    /** Metadata container / Контейнер метаданных */
+    meta: {
+        /** List of styles in the file / Список стилей в файле */
+        styles: {
+            /** The unique identifier of the style / Уникальный идентификатор стиля */
+            key: string;
+            /** The key of the file the style lives in / Ключ файла, в котором находится стиль */
+            file_key: string;
+            /** The node ID that corresponds to the style / ID узла, соответствующий стилю */
+            node_id: string;
+            /** The type of style (FILL, TEXT, EFFECT, or GRID) / Тип стиля (FILL, TEXT, EFFECT или GRID) */
+            style_type: 'FILL' | 'TEXT' | 'EFFECT' | 'GRID';
+            /** URL to a thumbnail image of the style / URL-адрес миниатюры стиля */
+            thumbnail_url: string;
+            /** Name of the style / Название стиля */
+            name: string;
+            /** Description of the style / Описание стиля */
+            description: string;
+            /** Date the style was last updated / Дата последнего обновления стиля */
+            updated_at: string;
+            /** Date the style was created / Дата создания стиля */
+            created_at: string;
+            /** A sortable string for the style's position / Строка для сортировки позиции стиля */
+            sort_position: string;
+            /** The user who created the style / Пользователь, создавший стиль */
+            user: {
+                /** User's ID / ID пользователя */
+                id: string;
+                /** User's handle / Никнейм пользователя */
+                handle: string;
+                /** URL to the user's avatar / URL-адрес аватара пользователя */
+                img_url: string;
+            };
+        }[];
+    };
+};
+
+/**
+ * Result returned by the styles endpoint.
+ *
+ * Результат, возвращаемый эндпоинтом styles.
+ */
+declare type FigmaStylesResult = {
+    /** Status code of the response / Код статуса ответа */
+    status: number;
+    /** Whether an error occurred / Произошла ли ошибка */
+    error: boolean;
+    /** Metadata about the style / Метаданные о стиле */
+    meta: {
+        /** The unique identifier of the style / Уникальный идентификатор стиля */
+        key: string;
+        /** The key of the file the style lives in / Ключ файла, в котором находится стиль */
+        file_key: string;
+        /** The node ID that corresponds to the style / ID узла, соответствующий стилю */
+        node_id: string;
+        /** The type of style (FILL, TEXT, EFFECT, or GRID) / Тип стиля (FILL, TEXT, EFFECT или GRID) */
+        style_type: 'FILL' | 'TEXT' | 'EFFECT' | 'GRID';
+        /** URL to a thumbnail image of the style / URL-адрес миниатюры стиля */
+        thumbnail_url: string;
+        /** Name of the style / Название стиля */
+        name: string;
+        /** Description of the style / Описание стиля */
+        description: string;
+        /** Date the style was last updated / Дата последнего обновления стиля */
+        updated_at: string;
+        /** Date the style was created / Дата создания стиля */
+        created_at: string;
+        /** A sortable string for the style's position / Строка для сортировки позиции стиля */
+        sort_position: string;
+        /** The user who created the style / Пользователь, создавший стиль */
+        user: {
+            /** User's ID / ID пользователя */
+            id: string;
+            /** User's handle / Никнейм пользователя */
+            handle: string;
+            /** URL to the user's avatar / URL-адрес аватара пользователя */
+            img_url: string;
+        };
+    };
+};
+
+export { }

package/dist/library-figma.js

@@ -0,0 +1,75 @@
+import { t as e } from "./PropertiesConfig-ChizwW5y.js";
+import { n as t, t as n } from "./figmaApiTypes-CArSsNW8.js";
+//#region src/classes/FigmaApi.ts
+var r = class {
+	token;
+	fileKey;
+	nodeId;
+	constructor(e, t, n) {
+		this.token = e, this.fileKey = t, this.nodeId = n;
+	}
+	async files(e = {}) {
+		return await this.fetch(t.files, e);
+	}
+	async fileNodes(e) {
+		return await this.fetch(t.fileNodes, e);
+	}
+	async fileImages(e) {
+		return await this.fetch(t.fileImages, e);
+	}
+	async fileStyles() {
+		return await this.fetch(t.fileStyles);
+	}
+	async styles(e) {
+		return await this.fetch(t.styles, void 0, e);
+	}
+	setToken(e) {
+		return this.token = e, this;
+	}
+	setFileKey(e) {
+		return this.fileKey = e, this;
+	}
+	setNodeId(e) {
+		return this.nodeId = e, this;
+	}
+	getUrl(e, t, r) {
+		let i = {}, a = e.replace(":file_key", this.fileKey).replace(":key", r ?? "");
+		this.nodeId && Object.assign(i, { "node-id": this.nodeId }), t && Object.assign(i, t);
+		let o = Object.keys(i).length > 0 ? `?${new URLSearchParams(i).toString()}` : "";
+		return `${n}${a}${o}`;
+	}
+	async fetch(e, t = {}, n) {
+		let r = this.getUrl(e, t, n), i = {
+			"X-Figma-Token": this.token,
+			"Content-Type": "application/json"
+		}, a = await fetch(r, {
+			method: "GET",
+			headers: i
+		});
+		if (a.ok) return a.json();
+		console.error(`Error fetching Figma API: ${a.status} ${a.statusText}`);
+	}
+}, i = class {
+	fileKey;
+	nodeId;
+	token;
+	api;
+	constructor(t, n, i = e.getFigmaToken()) {
+		this.fileKey = t, this.nodeId = n, this.token = i, this.api = new r(i, t, n);
+	}
+	async make() {
+		console.log("Design Figma", await this.initImage());
+	}
+	async initImage() {
+		let e = await this.api.fileImages({
+			ids: this.nodeId,
+			format: "svg",
+			svg_outline_text: !1,
+			svg_include_id: !0,
+			svg_include_node_id: !0
+		});
+		if (!e?.err) return e?.images;
+	}
+};
+//#endregion
+export { i as DesignFigma };