@dxtmisha/scripts 0.7.9 → 0.7.11

package/src/classes/Design/DesignTypes.ts

@@ -1,4 +1,4 @@
-import { forEach } from '@dxtmisha/functional-basic'
+import { forEach, ServerStorage } from '@dxtmisha/functional-basic'
 import { getPackageJson } from '../../functions/getPackageJson'
 import { useAi } from '../../composables/useAi'
 
@@ -6,7 +6,7 @@ import { PropertiesFile } from '../Properties/PropertiesFile'
 
 import type { DesignTypesList } from '../../types/designTypes'
 
-import { UI_DIR_CONSTRUCTOR, UI_FILE_AI_TYPES } from '../../config'
+import { UI_DIR_CONSTRUCTOR, UI_FILE_AI_DESCRIPTION, UI_FILE_AI_TYPES } from '../../config'
 
 /**
  * Engine for generating compressed and AI-optimized TypeScript type definitions.
@@ -32,6 +32,7 @@ export class DesignTypes {
   constructor(
     protected readonly dir: string = 'dist'
   ) {
+    ServerStorage.setErrorStatus(true)
     this.dirArray = this.dir.split('/')
   }
 
@@ -40,19 +41,19 @@ export class DesignTypes {
    *
    * Основной метод для выполнения процесса генерации типов.
    */
-  make() {
+  async make() {
     console.log('DesignTypes: making AI types...')
 
     const files = this.getListByFilter()
     const fullContent = this.toOneFile(files)
 
-    this.toAiEdit(fullContent).then(
-      (aiContent) => {
-        this.save(aiContent)
+    const aiContent = await this.toAiEdit(fullContent)
+    this.save(aiContent)
 
-        console.log('DesignTypes: AI types saved.')
-      }
-    )
+    const aiDescription = await this.toAiDescription(fullContent)
+    this.saveDescription(aiDescription)
+
+    console.log('DesignTypes: AI types saved.')
   }
 
   /**
@@ -167,6 +168,19 @@ export class DesignTypes {
     }
   }
 
+  /**
+   * Saves the AI-generated project description to a file.
+   *
+   * Сохраняет сгенерированное ИИ описание проекта в файл.
+   * @param content content to save / контент для сохранения
+   */
+  protected saveDescription(content: string) {
+    PropertiesFile.writeByPath(
+      UI_FILE_AI_DESCRIPTION,
+      content
+    )
+  }
+
   /**
    * Combines a list of files into a single string.
    *
@@ -182,31 +196,17 @@ export class DesignTypes {
   }
 
   /**
-   * Sends content to AI for optimization.
+   * Sends content and a prompt to the AI for processing.
    *
-   * Отправляет контент ИИ для оптимизации.
-   * @param content content to optimize / контент для оптимизации
+   * Отправляет контент и промпт ИИ для обработки.
+   * @param content content for processing / контент для обработки
+   * @param prompt instructions for the AI / инструкции для ИИ
    */
-  protected async toAiEdit(content: string): Promise<string> {
+  protected async toAi(content: string, prompt: string): Promise<string | undefined> {
     const ai = useAi()
 
     if (ai) {
-      ai.addPrompt(
-        'Remove all Russian comments from this code. '
-        + 'Simplify and shorten all English comments for AI readability while maintaining a clear balance between brevity and context. Do not delete them even if the code seems obvious. '
-        + 'Always keep All JSDoc "@example", "@remarks", "@note", and any other notes or warnings. '
-        + 'Remove all imports. '
-        + 'Remove all non-public content: delete all private and protected class methods and properties, and any non-exported elements. The final output must contain only the members and entities that are accessible from outside. '
-        + 'Remove any code segments or data that do not provide useful information for an AI assistant. '
-        + 'You may remove abstract classes or other structures that provide no practical value for code generation, but do so with extreme caution. Maintain a strict balance: if there is even a 5% chance the item might be relevant for understanding the API or generating code, keep it. Think carefully before every deletion. '
-        + 'Remove any large Enums that add excessive length without providing critical context. '
-        + 'Your goal is to create a compact, context-rich file that enables any AI coding assistant to generate high-quality code for a developer. '
-        + 'Ensure that no public API surface, essential data types, or required logic is lost. '
-        + 'Do not delete any "type" definitions; they are strictly required. '
-        + 'Do not delete file paths (labels starting with "// File:"). '
-        + 'All instructions are mandatory and must be executed perfectly. '
-        + 'Return ONLY the resulting code. No markdown code blocks, no tags, no explanations, and no additional comments from the AI. NOTHING but the pure code.'
-      )
+      ai.addPrompt(prompt)
       ai.addPrompt(`File Content: ${content}`)
 
       const generate = await ai.generate('go!')
@@ -216,6 +216,57 @@ export class DesignTypes {
       }
     }
 
-    return content
+    return undefined
+  }
+
+  /**
+   * Sends content to AI for optimization.
+   *
+   * Отправляет контент ИИ для оптимизации.
+   * @param content content to optimize / контент для оптимизации
+   */
+  protected async toAiEdit(content: string): Promise<string> {
+    const generate = await this.toAi(
+      content,
+      'Remove all Russian comments from this code. '
+      + 'Simplify and shorten all English comments for AI readability while maintaining a clear balance between brevity and context. Do not delete them even if the code seems obvious. '
+      + 'Always keep All JSDoc "@example", "@remarks", "@note", and any other notes or warnings. '
+      + 'Remove all imports. '
+      + 'Remove all non-public content: delete all private and protected class methods and properties, and any non-exported elements. The final output must contain only the members and entities that are accessible from outside. '
+      + 'Remove any code segments or data that do not provide useful information for an AI assistant. '
+      + 'You may remove abstract classes or other structures that provide no practical value for code generation, but do so with extreme caution. Maintain a strict balance: if there is even a 5% chance the item might be relevant for understanding the API or generating code, keep it. Think carefully before every deletion. '
+      + 'Remove any large Enums that add excessive length without providing critical context. '
+      + 'Your goal is to create a compact, context-rich file that enables any AI coding assistant to generate high-quality code for a developer. '
+      + 'Ensure that no public API surface, essential data types, or required logic is lost. '
+      + 'Do not delete any "type" definitions; they are strictly required. '
+      + 'Do not delete file paths (labels starting with "// File:"). '
+      + 'All instructions are mandatory and must be executed perfectly. '
+      + 'Return ONLY the resulting code. No markdown code blocks, no tags, no explanations, and no additional comments from the AI. NOTHING but the pure code.'
+    )
+
+    return generate ?? content
+  }
+
+  /**
+   * Generates a project description and usage guidelines using AI.
+   *
+   * Генерирует описание проекта и рекомендации по использованию с помощью ИИ.
+   * @param content cleaned type definitions / очищенные определения типов
+   */
+  protected async toAiDescription(content: string): Promise<string> {
+    const generate = await this.toAi(
+      content,
+      'Analyze the provided code and generate a highly technical, concise project overview for another AI coding assistant. '
+      + 'Your goal is to help the AI decide whether it needs to study this library to fulfill a user request. '
+      + 'The description must be objective, factual, and free of marketing fluff. '
+      + 'Include: '
+      + '1. Core Purpose: What is the primary function of this library? (e.g., UI component library, state management, utility for X). '
+      + '2. Usage Scenarios: In what specific cases and scenarios is this library indispensable? When should an AI study its API? '
+      + '3. Integration Context: How does it relate to other technologies in the stack (if evident)? '
+      + 'Ensure the structure is clean and enables immediate context retrieval. '
+      + 'Return ONLY the resulting description text. No markdown, no labels like "Description:", no explanations. NOTHING but the pure content.'
+    )
+
+    return generate ?? ''
   }
 }

package/src/classes/FigmaApi.ts

@@ -0,0 +1,190 @@
+import {
+  FIGMA_API_URL,
+  FigmaApiEndpoint,
+  type FigmaFileImagesParams,
+  type FigmaFileImagesResult,
+  type FigmaFileNodesParams,
+  type FigmaFileNodesResult,
+  type FigmaFilesParams,
+  type FigmaFilesResult,
+  type FigmaFileStylesResult,
+  type FigmaStylesResult
+} from '../types/figmaApiTypes'
+
+/**
+ * Class for interacting with the Figma REST API.
+ *
+ * Класс для взаимодействия с Figma REST API.
+ */
+export class FigmaApi {
+  constructor(
+    protected token: string,
+    protected fileKey: string,
+    protected nodeId?: string
+  ) {
+  }
+
+  /**
+   * Retrieves file content via the files endpoint.
+   *
+   * Получает содержимое файла через эндпоинт files.
+   * @param parameters query parameters / параметры запроса
+   * @returns file content or undefined / содержимое файла или undefined
+   */
+  async files(parameters: FigmaFilesParams = {}): Promise<FigmaFilesResult | undefined> {
+    return await this.fetch(FigmaApiEndpoint.files, parameters)
+  }
+
+  /**
+   * Retrieves specific nodes from the file via the fileNodes endpoint.
+   *
+   * Получает конкретные узлы из файла через эндпоинт fileNodes.
+   * @param parameters query parameters / параметры запроса
+   * @returns node data or undefined / данные узлов или undefined
+   */
+  async fileNodes(parameters: FigmaFileNodesParams): Promise<FigmaFileNodesResult | undefined> {
+    return await this.fetch(FigmaApiEndpoint.fileNodes, parameters)
+  }
+
+  /**
+   * Retrieves images for the file.
+   *
+   * Получает изображения для файла.
+   * @param parameters query parameters / параметры запроса
+   * @returns image data or undefined / данные изображения или undefined
+   */
+  async fileImages(parameters: FigmaFileImagesParams): Promise<FigmaFileImagesResult | undefined> {
+    return await this.fetch(FigmaApiEndpoint.fileImages, parameters)
+  }
+
+  /**
+   * Retrieves specific nodes from the file via the fileStyles endpoint.
+   *
+   * Получает конкретные узлы из файла через эндпоинт fileStyles.
+   * @returns file styles data or undefined / данные стилей файла или undefined
+   */
+  async fileStyles(): Promise<FigmaFileStylesResult | undefined> {
+    return await this.fetch(FigmaApiEndpoint.fileStyles)
+  }
+
+  /**
+   * Retrieves specific style by key via the styles endpoint.
+   *
+   * Получает конкретный стиль по ключу через эндпоинт styles.
+   * @param key the style key / ключ стиля
+   * @returns style data or undefined / данные стиля или undefined
+   */
+  async styles(key: string): Promise<FigmaStylesResult | undefined> {
+    return await this.fetch(FigmaApiEndpoint.styles, undefined, key)
+  }
+
+  /**
+   * Sets the API token.
+   *
+   * Устанавливает токен API.
+   * @param token the API token / токен API
+   * @returns this instance for chaining / этот экземпляр для цепочки вызовов
+   */
+  setToken(token: string): this {
+    this.token = token
+    return this
+  }
+
+  /**
+   * Sets the file key.
+   *
+   * Устанавливает ключ файла.
+   * @param fileKey the file key / ключ файла
+   * @returns this instance for chaining / этот экземпляр для цепочки вызовов
+   */
+  setFileKey(fileKey: string): this {
+    this.fileKey = fileKey
+    return this
+  }
+
+  /**
+   * Sets the node ID.
+   *
+   * Устанавливает ID узла.
+   * @param nodeId the node ID (optional) / ID узла (необязательно)
+   * @returns this instance for chaining / этот экземпляр для цепочки вызовов
+   */
+  setNodeId(nodeId?: string): this {
+    this.nodeId = nodeId
+    return 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
+  ) {
+    const request = {}
+    const endpoint = method
+      .replace(':file_key', this.fileKey)
+      .replace(':key', key ?? '')
+
+    if (this.nodeId) {
+      Object.assign(request, { 'node-id': this.nodeId })
+    }
+
+    if (parameters) {
+      Object.assign(request, parameters)
+    }
+
+    console.log('request', request, Object.keys(request).length)
+
+    const queryParams = Object.keys(request).length > 0
+      ? `?${new URLSearchParams(request).toString()}`
+      : ''
+
+    return `${FIGMA_API_URL}${endpoint}${queryParams}`
+  }
+
+  /**
+   * 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 async fetch(
+    method: FigmaApiEndpoint,
+    parameters: Record<string, any> = {},
+    key?: string
+  ): Promise<any> {
+    const url = this.getUrl(method, parameters, key)
+    const headers = {
+      'X-Figma-Token': this.token,
+      'Content-Type': 'application/json'
+    }
+
+    console.log('url', url)
+
+    const response = await fetch(url, {
+      method: 'GET',
+      headers
+    })
+
+    console.log('response', response.ok)
+
+    if (response.ok) {
+      return response.json()
+    }
+
+    console.error(`Error fetching Figma API: ${response.status} ${response.statusText}`)
+
+    return undefined
+  }
+}

package/src/classes/Properties/PropertiesConfig.ts

@@ -121,6 +121,15 @@ export class PropertiesConfig {
     return this.config.aiKey ?? ''
   }
 
+  /**
+   * Returns the Figma access token.
+   *
+   * Возвращает токен доступа к Figma.
+   */
+  static getFigmaToken(): string {
+    return this.config.figmaToken ?? ''
+  }
+
   /**
    * Returns the AI configuration object.
    *

package/src/config.ts

@@ -91,6 +91,7 @@ export const UI_FILE_NAME_VITE_WORKERS = 'vite-workers.config.ts'
 export const UI_FILE_INDEX = 'index.ts'
 
 export const UI_FILE_AI_TYPES = 'ai-types.txt'
+export const UI_FILE_AI_DESCRIPTION = 'ai-description.txt'
 export const UI_FILE_STYLE_SCSS = 'style.scss'
 export const UI_FILE_STYLE_PROPERTIES = 'ui-properties.scss'
 

package/src/library.ts

@@ -1,50 +1,51 @@
-// Classes
-export * from './classes/Ai/AiAbstract'
-export * from './classes/Ai/AiClaude'
-export * from './classes/Ai/AiClaudeCli'
-export * from './classes/Ai/AiClaudeCliLite'
-export * from './classes/Ai/AiClaudeLite'
-export * from './classes/Ai/AiDoc'
-export * from './classes/Ai/AiDocItem'
-export * from './classes/Ai/AiDocItemAbstract'
-export * from './classes/Ai/AiDocItemClasses'
-export * from './classes/Ai/AiDocItemComposables'
-export * from './classes/Ai/AiDocType'
-export * from './classes/Ai/AiGoogle'
-export * from './classes/Ai/AiGoogleCli'
-export * from './classes/Ai/AiGoogleCliLite'
-export * from './classes/Ai/AiGoogleLite'
-export * from './classes/Build/buildFunctional'
-export * from './classes/BuildItem'
-export * from './classes/Design/DesignTypes'
-export * from './classes/Design/DesignTypescript'
-export * from './classes/Design/DesignWikiStorm'
-export * from './classes/Design/DesignWikiStormItem'
-export * from './classes/Git/GitRead'
-export * from './classes/Library/LibraryAiWiki'
-export * from './classes/Library/LibraryAiWikiItem'
-export * from './classes/Library/LibraryExport'
-export * from './classes/Library/LibraryList'
-export * from './classes/Library/LibraryPlugin'
-export * from './classes/Library/LibraryTypes'
-export * from './classes/Properties/PropertiesFile'
-
-// Composables
-export * from './composables/useAi'
-
-// Functions
-export * from './functions/getConfigAi'
-export * from './functions/getDirname'
-export * from './functions/getPackageJson'
-export * from './functions/hasNativeDirname'
-export * from './functions/takeScreenshot'
-
-// Types
-export * from './types/aiTypes'
-export * from './types/configTypes'
-export * from './types/designTypes'
-export * from './types/gitTypes'
-export * from './types/libraryTypes'
-export * from './types/propertyTypes'
-export * from './types/screenshotTypes'
-export * from './types/webTypes'
+// Classes
+export * from './classes/Ai/AiAbstract'
+export * from './classes/Ai/AiClaude'
+export * from './classes/Ai/AiClaudeCli'
+export * from './classes/Ai/AiClaudeCliLite'
+export * from './classes/Ai/AiClaudeLite'
+export * from './classes/Ai/AiDoc'
+export * from './classes/Ai/AiDocItem'
+export * from './classes/Ai/AiDocItemAbstract'
+export * from './classes/Ai/AiDocItemClasses'
+export * from './classes/Ai/AiDocItemComposables'
+export * from './classes/Ai/AiDocType'
+export * from './classes/Ai/AiGoogle'
+export * from './classes/Ai/AiGoogleCli'
+export * from './classes/Ai/AiGoogleCliLite'
+export * from './classes/Ai/AiGoogleLite'
+export * from './classes/BrowserItem'
+export * from './classes/Build/buildFunctional'
+export * from './classes/BuildItem'
+export * from './classes/Design/DesignScreenshot'
+export * from './classes/Design/DesignTypes'
+export * from './classes/Design/DesignTypescript'
+export * from './classes/Design/DesignWikiStorm'
+export * from './classes/Design/DesignWikiStormItem'
+export * from './classes/Git/GitRead'
+export * from './classes/Library/LibraryAiWiki'
+export * from './classes/Library/LibraryAiWikiItem'
+export * from './classes/Library/LibraryExport'
+export * from './classes/Library/LibraryList'
+export * from './classes/Library/LibraryPlugin'
+export * from './classes/Library/LibraryTypes'
+export * from './classes/Properties/PropertiesFile'
+
+// Composables
+export * from './composables/useAi'
+
+// Functions
+export * from './functions/getConfigAi'
+export * from './functions/getDirname'
+export * from './functions/getPackageJson'
+export * from './functions/hasNativeDirname'
+
+// Types
+export * from './types/aiTypes'
+export * from './types/configTypes'
+export * from './types/designTypes'
+export * from './types/gitTypes'
+export * from './types/libraryTypes'
+export * from './types/propertyTypes'
+export * from './types/screenshotTypes'
+export * from './types/webTypes'

package/src/media/templates/componentDoc/figma/run-figma.ts

@@ -0,0 +1,26 @@
+#!/usr/bin/env vite-node
+/// <reference types="node" />
+
+import { spawn } from 'node:child_process'
+
+;(async () => {
+  try {
+    // Figma file key. Can be found in the URL of your Figma file:
+    // figma.com/design/FILE_KEY/...
+    const fileKey = ''
+
+    // Node ID in Figma file. Select an element and find 'node-id=...' in the URL
+    // or use "Copy link to selection" to see it in the URL.
+    const nodeId = ''
+
+    const child = spawn(
+      'npx',
+      ['dxt-figma-layout', fileKey, nodeId],
+      { stdio: 'inherit' }
+    )
+
+    child.on('exit', code => console.log('End:', code))
+  } catch (error) {
+    console.error('Error:', error)
+  }
+})()

package/src/types/configTypes.ts

@@ -56,4 +56,7 @@ export type DesignUiConfig = {
 
   /** AI configuration object / Объект конфигурации ИИ */
   aiConfig?: Record<string, any>
+
+  /** Figma access token for API authentication / Токен доступа Figma для аутентификации API */
+  figmaToken?: string
 }