@dxtmisha/scripts 0.4.5 → 0.5.0

package/bin/ai-doc.ts

@@ -0,0 +1,9 @@
+#!/usr/bin/env vite-node
+
+import { AiDoc } from '../src/classes/Ai/AiDoc'
+
+const name: string = process.argv?.[2] ?? 'src/storybook'
+
+new AiDoc(name)
+  .make()
+  .then()

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dxtmisha/scripts",
   "private": false,
-  "version": "0.4.5",
+  "version": "0.5.0",
   "type": "module",
   "description": "Development scripts and CLI tools for DXT UI projects - automated component generation, library building and project management tools",
   "keywords": [
@@ -40,6 +40,7 @@
   "main": "./src/library.ts",
   "module": "./src/library.ts",
   "bin": {
+    "dxt-ai-doc": "bin/ai-doc.ts",
     "dxt-component": "bin/design-component.ts",
     "dxt-component-wiki": "bin/design-component-wiki.ts",
     "dxt-constructor": "bin/design-constructor.ts",
@@ -49,6 +50,7 @@
   },
   "exports": {
     ".": "./src/library.ts",
+    "./ai": "./src/library-ai.ts",
     "./config": "./src/config.ts",
     "./properties.json": "./src/media/properties.json"
   },
@@ -56,12 +58,12 @@
     "node": ">=18.0.0"
   },
   "peerDependencies": {
-    "@dxtmisha/configuration": ">=0.3.9",
-    "@dxtmisha/functional": ">=1.0.3",
-    "@dxtmisha/styles": ">=1.0.2",
-    "@dxtmisha/wiki": ">=0.23.5",
-    "typescript": ">=5.0.0",
-    "vue": ">=3.0.0"
+    "@dxtmisha/configuration": "*",
+    "@dxtmisha/functional": "*",
+    "@dxtmisha/styles": "*",
+    "@dxtmisha/wiki": "*",
+    "typescript": "*",
+    "vue": "*"
   },
   "dependencies": {}
 }

package/src/classes/Ai/AiAbstract.ts

@@ -1,4 +1,4 @@
-import { PropertiesConfig } from '../Properties/PropertiesConfig'
+import type { AiImageItem, AiImageList } from '../../types/aiTypes'
 
 /**
  * Abstract AI base class providing common mechanics for AI integrations.
@@ -21,26 +21,69 @@ import { PropertiesConfig } from '../Properties/PropertiesConfig'
  * - response(): конкретный вызов модели
  */
 export abstract class AiAbstract<AI = any> {
-  /** API key / API ключ */
-  protected key: string
-
   /** AI client instance / Экземпляр AI-клиента */
   protected ai?: AI
 
-  /** Active model id / Идентификатор активной модели */
-  protected model: string
-
   /** Prompt prefix / Префикс prompt */
   protected prompt: string = ''
 
+  /** Accumulated image list / Накопленный список изображений */
+  protected images: AiImageList = []
+
+  /** Accumulated contents / Накопленные содержимое */
+  protected contents: string[] = []
+
   /**
    * Constructor initializes implementation specific resources.
    *
    * Конструктор инициализирует ресурсы конкретной реализации.
+   * @param key - API key / API ключ
+   * @param model - initial model id / начальный идентификатор модели
+   */
+  constructor(
+    protected key: string,
+    protected model: string
+  ) {
+  }
+
+  /**
+   * Returns accumulated image list.
+   *
+   * Возвращает накопленный список изображений.
+   */
+  getImages(): AiImageList {
+    return this.images
+  }
+
+  /**
+   * Returns accumulated contents.
+   *
+   * Возвращает накопленное содержимое.
+   */
+  getContents(): string[] {
+    return this.contents
+  }
+
+  /**
+   * Appends an image to the accumulated image list.
+   *
+   * Добавляет изображение к накопленному списку изображений.
+   * @param image - image item / элемент изображения
+   */
+  addImage(image: AiImageItem): this {
+    this.images.push(image)
+    return this
+  }
+
+  /**
+   * Appends content to the accumulated contents.
+   *
+   * Добавляет содержимое к накопленному содержимому.
+   * @param content - content string / строка содержимого
    */
-  constructor() {
-    this.key = PropertiesConfig.getAiKey()
-    this.model = PropertiesConfig.getAiModel()
+  addContent(content: string): this {
+    this.contents.push(content)
+    return this
   }
 
   /**
@@ -52,6 +95,26 @@ export abstract class AiAbstract<AI = any> {
     this.prompt += `\n${prompt}`
   }
 
+  /**
+   * Clears entire accumulated image list.
+   *
+   * Очищает весь накопленный список изображений.
+   */
+  resetImages(): this {
+    this.images = []
+    return this
+  }
+
+  /**
+   * Clears entire accumulated contents.
+   *
+   * Очищает все накопленное содержимое.
+   */
+  resetContents(): this {
+    this.contents = []
+    return this
+  }
+
   /**
    * Clears entire accumulated prompt.
    *
@@ -104,10 +167,14 @@ export abstract class AiAbstract<AI = any> {
     if (this.ai) {
       console.log('[Ai] Generating')
 
-      return await this.response(
+      const generate = await this.response(
         this.model,
-        this.getContents(contents)
+        this.getMainContents(contents)
       )
+
+      console.log(`[Ai] End (length: ${generate.length})`)
+
+      return generate
     }
 
     return ''
@@ -118,7 +185,7 @@ export abstract class AiAbstract<AI = any> {
    *
    * Объединяет постоянный префикс prompt с переданным содержимым.
    */
-  protected getContents(contents: string): string {
+  protected getMainContents(contents: string): string {
     return `${this.prompt}\n${contents}`
   }
 
@@ -129,6 +196,20 @@ export abstract class AiAbstract<AI = any> {
    */
   protected abstract init(): void
 
+  /**
+   * Implementation hook: convert accumulated images to model-specific format.
+   *
+   * Хук реализации: преобразовать накопленные изображения в формат, специфичный для модели.
+   */
+  protected abstract toImages(): void
+
+  /**
+   * Implementation hook: convert accumulated contents to model-specific format.
+   *
+   * Хук реализации: преобразовать накопленное содержимое в формат, специфичный для модели.
+   */
+  protected abstract toContents(): void
+
   /**
    * Implementation hook: perform model call and return textual result.
    *

package/src/classes/Ai/AiDoc.ts

@@ -0,0 +1,62 @@
+import { PropertiesConfig } from '../Properties/PropertiesConfig'
+import { GitRead } from '../Git/GitRead'
+import { AiDocType } from './AiDocType'
+
+/**
+ * Class for generating AI documentation.
+ *
+ * Класс для генерации AI документации.
+ */
+export class AiDoc {
+  /**
+   * Main method to generate documentation.
+   *
+   * Основной метод для генерации документации.
+   */
+  async make() {
+    const dirs = PropertiesConfig.getAiDocDirectory()
+    const path = PropertiesConfig.getAiDocStorybookPath()
+
+    console.log(`AI documentation: ${path}`)
+
+    if (
+      dirs
+      && dirs.length
+    ) {
+      for (const dir of dirs) {
+        await this.makeDirectory(dir)
+      }
+    }
+  }
+
+  /**
+   * Process a specific directory.
+   *
+   * Обрабатывает конкретную директорию.
+   * @param dir - directory path / путь к директории
+   */
+  async makeDirectory(dir: string) {
+    console.log('')
+    console.log(`Dir: ${dir}...`)
+
+    for (const item of this.getListByDirectory(dir)) {
+      try {
+        await AiDocType.make(item)
+      } catch (e) {
+        console.error(`Error processing file ${item}:`, e)
+      }
+    }
+  }
+
+  /**
+   * Get list of files in a directory.
+   *
+   * Получает список файлов в директории.
+   * @param dir - directory path / путь к директории
+   */
+  protected getListByDirectory(dir: string) {
+    return GitRead.filterByDirectory(
+      GitRead.getListByDirectory(dir)
+    )
+  }
+}

package/src/classes/Ai/AiDocItem.ts

@@ -0,0 +1,20 @@
+import { AiDocItemAbstract } from './AiDocItemAbstract'
+
+/** Sample prompt template path / Путь к шаблону промпта */
+const FILE_PROMPT_SAMPLE = [__dirname, '..', '..', 'media', 'templates', 'prompts']
+
+/** Sample prompt template path for functions / Путь к шаблону промпта для функций */
+const FILE_PROMPT_SAMPLE_ITEM = [...FILE_PROMPT_SAMPLE, 'aiDocFunctionPrompt.en.txt']
+
+/** Sample demo file path for functions / Путь к демо файлу для функций */
+const FILE_DEMO_SAMPLE_ITEM = [...FILE_PROMPT_SAMPLE, 'demoDocEn.mdx']
+
+/**
+ * Class for generating documentation for Functions.
+ *
+ * Класс для генерации документации для Функций.
+ */
+export class AiDocItem extends AiDocItemAbstract {
+  protected pathDemo: string[] = FILE_DEMO_SAMPLE_ITEM
+  protected pathPrompt: string[] = FILE_PROMPT_SAMPLE_ITEM
+}

package/src/classes/Ai/AiDocItemAbstract.ts

@@ -0,0 +1,198 @@
+import { Datetime, removeCommonPrefix } from '@dxtmisha/functional-basic'
+import { useAi } from '../../composables/useAi'
+
+import { PropertiesFile } from '../Properties/PropertiesFile'
+import { PropertiesConfig } from '../Properties/PropertiesConfig'
+import { GitRead } from '../Git/GitRead'
+import { BuildItem } from '../BuildItem'
+import { ComponentWikiFile } from '../Component/ComponentWikiFile'
+
+import type { AiAbstract } from './AiAbstract'
+import type { GitFileItem } from '../../types/gitTypes'
+
+import { UI_DIR_IN, UI_FILE_PACKAGE } from '../../config'
+
+export abstract class AiDocItemAbstract {
+  /** Demo file path / Путь к файлу демо */
+  protected abstract pathDemo: string[]
+  /** Prompt template path / Путь к шаблону промпта */
+  protected abstract pathPrompt: string[]
+
+  /** Build item / Элемент сборки */
+  protected readonly build: BuildItem
+
+  /** Markdown file / Файл в формате Markdown */
+  protected readonly mdFile: ComponentWikiFile
+
+  /** Code file / Файл с кодом */
+  protected readonly code: ComponentWikiFile
+
+  /** Property file data / Данные из файла свойств */
+  protected readonly projectName: string
+
+  /** AI instance / Экземпляр ИИ */
+  protected readonly ai?: AiAbstract
+
+  /** Description from AI / Описание от ИИ */
+  protected description?: string
+
+  /**
+   * Constructor
+   * @param path source file path / путь к исходному файлу
+   * @param item git file item / элемент файла git
+   */
+  constructor(
+    protected readonly path: string,
+    protected readonly item: GitFileItem
+  ) {
+    this.build = new BuildItem(this.item.path)
+    this.mdFile = new ComponentWikiFile(this.getPathWiki(), true, false)
+    this.code = new ComponentWikiFile(this.item.pathByOS, false, false)
+    this.projectName = PropertiesFile.readFile<Record<string, any>>(UI_FILE_PACKAGE)?.name ?? 'Library'
+    this.ai = useAi()
+  }
+
+  /**
+   * Generates documentation using AI.
+   *
+   * Генерирует документацию с использованием ИИ.
+   */
+  async make() {
+    const date = this.mdFile.getDate()
+
+    if (
+      this.ai
+      && this.getItemDate() > date.getDate()
+    ) {
+      console.log(
+        `${this.projectName}/File:`,
+        this.item.path,
+        PropertiesConfig.getWikiLanguage()
+      )
+
+      const status = await this.build.make()
+
+      if (status) {
+        this.makeAi()
+
+        const generate = await this.ai.generate(
+          this.readPrompt()
+        )
+
+        if (generate) {
+          const read = generate.split('#########')
+
+          if (read?.[0]) {
+            this.description = read[0].trim()
+          }
+
+          if (
+            read?.[1]
+            && !read[1].match('--FULL--')
+          ) {
+            this.code.write(read[1])
+          }
+
+          if (read?.[2]) {
+            this.mdFile.write(this.initName(read[2]))
+          }
+        }
+      }
+
+      this.build.removeDir()
+    } else if (!this.ai) {
+      console.error('AI is not configured.')
+    }
+  }
+
+  /**
+   * Returns the path to the Wiki file.
+   *
+   * Возвращает путь к Wiki файлу.
+   */
+  protected getPathWiki(): string[] {
+    const fileName = removeCommonPrefix(this.item.path, this.path)
+      .replace(/\.ts$/, '')
+
+    return [
+      ...GitRead.splitPath(this.path),
+      ...GitRead.splitPath(`${fileName}.mdx`)
+    ]
+  }
+
+  /**
+   * Returns the file modification date.
+   *
+   * Возвращает дату изменения файла.
+   */
+  protected getItemDate(): Date {
+    return new Datetime(this.item.date).getDate()
+  }
+
+  /**
+   * Returns the title for the documentation.
+   *
+   * Возвращает заголовок для документации.
+   */
+  protected getTitle() {
+    let title = this.projectName
+      + '/'
+      + this.item.path
+        .replace(UI_DIR_IN + '/', '')
+        .replace(/\.ts$/, '')
+
+    if (this.description) {
+      title += ` - ${this.description}`
+    }
+
+    return title
+  }
+
+  /**
+   * Reads the demo file content.
+   *
+   * Читает содержимое демо-файла.
+   */
+  protected readDemo(): string {
+    return new ComponentWikiFile(this.pathDemo).read()
+  }
+
+  /**
+   * Reads the prompt template.
+   *
+   * Читает шаблон промпта.
+   */
+  protected readPrompt(): string {
+    return new ComponentWikiFile(this.pathPrompt)
+      .read()
+      .replace(/\[wikiLanguage]/g, PropertiesConfig.getWikiLanguage())
+  }
+
+  /**
+   * Prepares context for AI.
+   *
+   * Подготавливает контекст для ИИ.
+   */
+  protected makeAi(): void {
+    if (this.ai) {
+      this.ai.addContent(`Code: ${this.build.getCode()}`)
+      this.ai.addContent(`Original code: ${this.code.read()}`)
+      this.ai.addContent(`Demo (only for template analysis, all data is fake): ${this.readDemo()}`)
+      this.ai.addContent(`Original MDX: ${this.mdFile.read()}`)
+    }
+  }
+
+  /**
+   * Initializes the title in the content.
+   *
+   * Инициализирует заголовок в контенте.
+   * @param content content / контент
+   */
+  protected initName(content: string): string {
+    if (content.match('[title]')) {
+      return content.replace('[title]', this.getTitle())
+    }
+
+    return content
+  }
+}

package/src/classes/Ai/AiDocItemClasses.ts

@@ -0,0 +1,20 @@
+import { AiDocItemAbstract } from './AiDocItemAbstract'
+
+/** Sample prompt template path / Путь к шаблону промпта */
+const FILE_PROMPT_SAMPLE = [__dirname, '..', '..', 'media', 'templates', 'prompts']
+
+/** Sample prompt template for classes / Шаблон промпта для классов */
+const FILE_PROMPT_SAMPLE_CLASS = [...FILE_PROMPT_SAMPLE, 'aiDocClassPrompt.en.txt']
+
+/** Sample demo file for classes / Пример демонстрационного файла для классов */
+const FILE_DEMO_SAMPLE_CLASS = [...FILE_PROMPT_SAMPLE, 'demoClassEn.mdx']
+
+/**
+ * AI Documentation Item for Classes.
+ *
+ * Элемент документации AI для классов.
+ */
+export class AiDocItemClasses extends AiDocItemAbstract {
+  protected pathDemo: string[] = FILE_DEMO_SAMPLE_CLASS
+  protected pathPrompt: string[] = FILE_PROMPT_SAMPLE_CLASS
+}

package/src/classes/Ai/AiDocItemComposables.ts

@@ -0,0 +1,13 @@
+import { AiDocItemAbstract } from './AiDocItemAbstract'
+
+/** Sample prompt template path / Путь к шаблону промпта */
+const FILE_PROMPT_SAMPLE = [__dirname, '..', '..', 'media', 'templates', 'prompts']
+
+const FILE_PROMPT_SAMPLE_COMPOSABLE = [...FILE_PROMPT_SAMPLE, 'aiDocComposablePrompt.en.txt']
+
+const FILE_DEMO_SAMPLE_COMPOSABLE = [...FILE_PROMPT_SAMPLE, 'demoComposableEn.mdx']
+
+export class AiDocItemComposables extends AiDocItemAbstract {
+  protected pathDemo: string[] = FILE_DEMO_SAMPLE_COMPOSABLE
+  protected pathPrompt: string[] = FILE_PROMPT_SAMPLE_COMPOSABLE
+}

package/src/classes/Ai/AiDocType.ts

@@ -0,0 +1,45 @@
+import { PropertiesConfig } from '../Properties/PropertiesConfig'
+
+import type { AiDocTypeItem } from '../../types/aiTypes'
+import type { GitFileItem } from '../../types/gitTypes'
+
+import { aiDocTypes } from '../../media/ai/ai-doc-types'
+
+/**
+ * Class for managing AI documentation types.
+ *
+ * Класс для управления типами документации ИИ.
+ */
+export class AiDocType {
+  /** List of available documentation types / Список доступных типов документации */
+  protected static types = [...aiDocTypes]
+
+  /**
+   * Adds a new documentation type to the list.
+   *
+   * Добавляет новый тип документации в список.
+   * @param type documentation type item / элемент типа документации
+   */
+  static add(type: AiDocTypeItem) {
+    this.types.unshift(type)
+  }
+
+  /**
+   * Generates documentation for a file item.
+   *
+   * Генерирует документацию для элемента файла.
+   * @param item git file item / элемент файла git
+   */
+  static async make(item: GitFileItem) {
+    const path = PropertiesConfig.getAiDocStorybookPath()
+
+    for (const docType of aiDocTypes) {
+      if (docType.check(item)) {
+        const docItem = new docType.item(path, item)
+        await docItem.make()
+
+        break
+      }
+    }
+  }
+}

package/src/classes/Ai/AiGoogle.ts

@@ -1,5 +1,5 @@
-import { AiAbstract } from './AiAbstract'
-import { GoogleGenAI } from '@google/genai'
+import { getConfigAi } from '../../functions/getConfigAi'
+import { AiGoogleLite } from './AiGoogleLite'
 
 /**
  * Google AI (Gemini) implementation of AiAbstract.
@@ -17,32 +17,10 @@ import { GoogleGenAI } from '@google/genai'
  * - Model must be set via setModel() before generate() / Модель нужно задать через setModel()
  * - Returns empty string if response is missing / Возвращает пустую строку при отсутствии результата
  */
-export class AiGoogle extends AiAbstract<GoogleGenAI> {
-  /**
-   * Initializes GoogleGenAI client instance.
-   *
-   * Инициализирует экземпляр клиента GoogleGenAI.
-   */
-  protected init(): void {
-    this.ai = new GoogleGenAI({ apiKey: this.key })
-  }
-
-  /**
-   * Performs content generation request and returns textual result.
-   *
-   * Выполняет запрос генерации контента и возвращает текстовый результат.
-   * @param model Model identifier / Идентификатор модели
-   * @param contents Composed contents for generation / Собранный контент для генерации
-   */
-  protected async response(
-    model: string,
-    contents: string
-  ): Promise<string> {
-    const response = await this.ai?.models.generateContent({
-      model,
-      contents
-    })
-
-    return response?.text ?? ''
+export class AiGoogle extends AiGoogleLite {
+  constructor() {
+    super(
+      ...getConfigAi()
+    )
   }
 }

package/src/classes/Ai/AiGoogleCli.ts

@@ -0,0 +1,24 @@
+import { getConfigAi } from '../../functions/getConfigAi'
+import { AiGoogleCliLite } from './AiGoogleCliLite'
+
+/**
+ * Google AI (Gemini) implementation via CLI.
+ * Extends AiGoogleCliLite and provides configuration from the project environment.
+ *
+ * Реализация Google AI (Gemini) через CLI.
+ * Расширяет AiGoogleCliLite и предоставляет конфигурацию из окружения проекта.
+ *
+ * Responsibilities / Ответственности:
+ * - Provide API key and model from config / Предоставить API ключ и модель из конфигурации
+ * - Initialize CLI wrapper / Инициализировать обертку CLI
+ *
+ * Notes / Примечания:
+ * - Uses getConfigAi() to retrieve credentials / Использует getConfigAi() для получения учетных данных
+ */
+export class AiGoogleCli extends AiGoogleCliLite {
+  constructor() {
+    super(
+      ...getConfigAi()
+    )
+  }
+}