@dxtmisha/scripts 0.10.15 → 0.11.0

package/src/classes/Design/DesignTypesAi.ts

@@ -0,0 +1,135 @@
+import { getPackageJson } from '../../functions/getPackageJson'
+import { useAi } from '../../composables/useAi'
+
+/**
+ * Class for handling low-level AI interactions, directory configuration, and prompt execution.
+ *
+ * Класс для низкоуровневого взаимодействия с ИИ, конфигурации директории и выполнения промптов.
+ */
+export class DesignTypesAi {
+  /** Cached project name / Кэшированное название проекта */
+  protected projectName: string
+
+  /** Array of directory path segments / Массив сегментов пути директории */
+  protected readonly dirArray: string[]
+
+  /**
+   * Constructor for DesignTypesAi.
+   *
+   * Конструктор для DesignTypesAi.
+   * @param dir input directory path containing declaration files / входной путь к директории, содержащей файлы деклараций
+   * @param isRaw flag disabling AI processing / флаг отключения ИИ обработки
+   */
+  constructor(
+    protected readonly dir: string = 'dist',
+    protected readonly isRaw: boolean = false
+  ) {
+    this.dirArray = this.dir.split('/')
+    this.projectName = getPackageJson()?.name ?? 'none'
+  }
+
+  /**
+   * Returns the array of directory path segments.
+   *
+   * Возвращает массив сегментов пути директории.
+   * @returns directory path segments / сегменты пути директории
+   */
+  getDirArray(): string[] {
+    return this.dirArray
+  }
+
+  /**
+   * Returns the project name from package.json.
+   *
+   * Возвращает название проекта из package.json.
+   * @returns project name or 'none' / название проекта или 'none'
+   */
+  getProjectName(): string {
+    return this.projectName
+  }
+
+  /**
+   * Sends content and a prompt to the AI for processing.
+   *
+   * Отправляет контент и промпт ИИ для обработки.
+   * @param content content for processing / контент для обработки
+   * @param prompt instructions for the AI / инструкции для ИИ
+   * @param code code to optimize / код для оптимизации
+   * @returns AI generated content or undefined / сгенерированный ИИ контент или undefined
+   */
+  async toAi(
+    content: string,
+    prompt: string,
+    code?: string
+  ): Promise<string | undefined> {
+    if (this.isRaw) {
+      return undefined
+    }
+
+    const ai = useAi()
+
+    if (ai) {
+      if (code) {
+        ai.addPrompt(
+          `File JS Code (SUPPLEMENTARY REFERENCE & CONTEXT ONLY):\n`
+          + `The following JavaScript code is provided STRICTLY as supplementary background context to give a full picture of implementation details and logic.\n`
+          + `CRITICAL RESTRICTION: You MUST NOT treat or use this data as "File Content". Do NOT generate, return, or include any classes, methods, functions, or entities from "File JS Code" in the output unless they are explicitly present in "File Content".\n\n`
+          + '```\n'
+          + `${code}\n`
+          + '```'
+        )
+      }
+
+      ai.addPrompt('You are a world-class senior developer and an exceptional technical writer.')
+      ai.addPrompt('CRITICAL DIRECTIVE: No data stored in history, previous chat messages, or prior conversation context must influence the result. Process strictly and exclusively the data provided in the text below.')
+      ai.addPrompt(
+        `TASK INSTRUCTIONS & GOAL:\n`
+        + `The following are the exact rules, requirements, and execution instructions for processing the file content:\n\n`
+        + `${prompt}`
+      )
+      ai.addPrompt(
+        `File Content (PRIMARY DATA TO PROCESS):\n`
+        + `The following is the primary target file content that you MUST process according to the instructions in the prompt above:\n`
+        + '```\n'
+        + `${content}\n`
+        + '```'
+      )
+
+      const generate = await ai.generate('go!')
+
+      if (generate) {
+        return generate
+      }
+    }
+
+    return undefined
+  }
+
+  /**
+   * Sends content and a prompt to the AI for processing and parses the resulting JSON response.
+   *
+   * Отправляет контент и промпт ИИ для обработки и парсит полученный JSON-ответ.
+   * @param content content for processing / контент для обработки
+   * @param prompt instructions for the AI / инструкции для ИИ
+   * @param code code to optimize / код для оптимизации
+   * @returns parsed JSON object or undefined / распарсенный JSON объект или undefined
+   */
+  async toAiJson<T>(
+    content: string,
+    prompt: string,
+    code?: string
+  ): Promise<T | undefined> {
+    const generate = await this.toAi(content, prompt, code)
+
+    if (generate) {
+      try {
+        const cleaned = generate.replace(/```json|```/g, '').trim()
+        return JSON.parse(cleaned) as T
+      } catch {
+        return undefined
+      }
+    }
+
+    return undefined
+  }
+}

package/src/classes/Design/DesignTypesDescription.ts

@@ -0,0 +1,109 @@
+import { PropertiesFile } from '../Properties/PropertiesFile'
+import { DesignTypesAi } from './DesignTypesAi'
+import { DesignTypesMake } from './DesignTypesMake'
+import { DesignTypesPrompts } from './DesignTypesPrompts'
+
+import { UI_FILE_AI_DESCRIPTION } from '../../config'
+
+/**
+ * Class for generating, processing, and saving AI project descriptions.
+ *
+ * Класс для генерации, обработки и сохранения описания проекта ИИ.
+ */
+export class DesignTypesDescription {
+  /** Cached full description content / Кэшированный полный контент описания */
+  protected fullDescription?: string
+
+  /**
+   * Constructor for DesignTypesDescription.
+   *
+   * Конструктор для DesignTypesDescription.
+   * @param ai instance of DesignTypesAi for AI interactions / экземпляр DesignTypesAi для ИИ взаимодействия
+   * @param makeTypes instance of DesignTypesMake for type definitions content access / экземпляр DesignTypesMake для доступа к контенту определений типов
+   * @param prompts instance of DesignTypesPrompts for prompt list management / экземпляр DesignTypesPrompts для управления списком промптов
+   * @param isRaw flag disabling AI processing / флаг отключения ИИ обработки
+   */
+  constructor(
+    protected readonly ai: DesignTypesAi,
+    protected readonly makeTypes: DesignTypesMake,
+    protected readonly prompts: DesignTypesPrompts,
+    protected readonly isRaw: boolean = false
+  ) { }
+
+  /**
+   * Returns the generated full description content.
+   *
+   * Возвращает сгенерированный полный контент описания.
+   * @returns full description string / строка полного описания
+   */
+  getFullDescription(): string {
+    return this.fullDescription ?? ''
+  }
+
+  /**
+   * Generates and saves AI description file.
+   *
+   * Генерирует и сохраняет файл описания ИИ.
+   * @returns current instance / текущий экземпляр
+   */
+  async make(): Promise<this> {
+    let fullDescription = ''
+
+    if (!this.isRaw) {
+      const fullContent = this.makeTypes.getFullContent()
+      const fullJsContent = this.makeTypes.getFullJsContent()
+      const promptsText = await this.prompts.toAiPrompts()
+
+      const aiDescription = await this.toAiDescription(fullContent, fullJsContent)
+
+      fullDescription = `${aiDescription}\n${promptsText}`
+    }
+
+    this.fullDescription = fullDescription
+    this.saveDescription(fullDescription)
+
+    return this
+  }
+
+  /**
+   * Saves the AI-generated project description to a file.
+   *
+   * Сохраняет сгенерированное ИИ описание проекта в файл.
+   * @param content content to save / контент для сохранения
+   */
+  protected saveDescription(content: string): void {
+    PropertiesFile.writeByPath(
+      UI_FILE_AI_DESCRIPTION,
+      content
+    )
+  }
+
+  /**
+   * Generates a project description and usage guidelines using AI.
+   *
+   * Генерирует описание проекта и рекомендации по использованию с помощью ИИ.
+   * @param content cleaned type definitions / очищенные определения типов
+   * @param code JS code for analysis / JS код для анализа
+   * @returns project description string / строка описания проекта
+   */
+  protected async toAiDescription(content: string, code?: string): Promise<string> {
+    const generate = await this.ai.toAi(
+      content,
+      'Goal: Generate a concise package overview for an AI coding assistant detailing what this package is, why to study it, and listing its key capabilities.\n\n'
+      + 'STRUCTURE & CONTENT REQUIREMENTS:\n'
+      + '1. Package Description: 1-2 concise sentences explaining what this package is and its core technical purpose.\n'
+      + '2. Triggers for Studying ai-types.md: Clear explanation of when and why an AI assistant must study "ai-types.md" (specific tasks, keywords, or architectural requirements).\n'
+      + '3. Key Capabilities: A list of key functional capabilities where each item is strictly 1 to 3 words long (e.g. "Form Controls", "API Integration", "Storage State").\n\n'
+      + 'CRITICAL RESTRICTIONS:\n'
+      + '- Each item in the Key Capabilities list MUST be strictly 1 to 3 words.\n'
+      + '- Do NOT list individual method, function, or class names.\n'
+      + '- Analyze ONLY the provided type definitions and JS code.\n'
+      + '- Do NOT wrap output in markdown code blocks (```).\n\n'
+      + 'OUTPUT REQUIREMENTS:\n'
+      + 'Return ONLY the final description text. No explanations, no code blocks, and no conversational fluff.',
+      code
+    )
+
+    return generate ?? ''
+  }
+}