@yartsun/chat-widget-types 1.0.2 → 1.0.5

package/src/config.types.ts

@@ -1,63 +1,165 @@
+import config from '../examples/configV2.json'
 /**
- * Типы для конфигурации виджета чата
+ * Типы для конфигурации виджета чата (V2)
  */
 
 // Базовые типы
 export type Size = 'sm' | 'md' | 'lg'
 export type BorderRadius = '0' | 'sm' | 'md' | 'lg'
 export type BtnType = 'icon' | 'text' | 'both'
-export type LaunchView = 'closed' | 'compact' | 'open'
+export type LaunchView = 'closed' | 'compact'
+export type ChipStyle = 'filled' | 'outlined' | 'invisible'
+export type Loader = 'dots' | 'dots-pulse' | 'circle-pulse' | 'circle-pulse-1'
+export type BgType = 'plain' | 'bubble'
+export type InputStyle = 'inside' | 'stacked'
+export type ButtonStyle = 'filled' | 'outlined' | 'invisible'
+export type WarningStyle = 'gradient' | 'filled' | 'faded'
+
+// Схема конфигурации
+export interface ConfigSchema {
+  version: string
+  required: string[]
+}
+
+// Настройки виджета
+export interface WidgetSettings {
+  bgChat: string
+  gapMessageLine: number
+  fontFamily: string
+  borderRadius: BorderRadius
+  launchView: LaunchView
+  letterSpacing: number
+  logo: string
+  fontWeight: number
+  loader: Loader
+}
+
+// Тексты виджета
+export interface WidgetTexts {
+  welcomeMessage: string
+  widgetTitle: string
+  launchIssueTitle: string
+  launchIssueText: string
+  issueText: string
+  reconnectText: string
+  inputPlaceholder: string
+  disableInputText: string
+  disclaimer: string
+}
+
+// Базовые типы для элементов
+export interface BorderStyle {
+  borderColor: string
+  borderWidth?: number
+}
+
 export interface ColorItems {
   color?: string
   bgColor?: string
 }
-// Типы для элементов интерфейса
+
 export interface UIElement {
   color: string
   bgColor?: string
   type?: BtnType
+  bgType?: BgType
 }
 
-export interface SectionParams {
-  size: Size
+export interface InputSendElement extends UIElement {
+  inputStyle: InputStyle
+  borderStyle: BorderStyle
 }
 
-// Типы для настроек
-export interface WidgetSettings {
-  widgetTitle: string
-  welcomeMessage: string
-  bgChat: string
-  gapMessageLine: number
-  paddingChat: number
-  fontFamily: string
-  borderRadius: BorderRadius
-  launchView: LaunchView
-  letterSpacing: number 
-  logo: string
+// Типы для Active Snippet
+export interface ActiveSnippetParams {
+  buttonType: BtnType
+  buttonStyle: ButtonStyle
+}
+
+export interface ActiveSnippetElement {
+  params: ActiveSnippetParams
+  color: string
+  bgColor: string
+  headerChip: ColorItems
+  propertyColor: string
+  valueColor: string
+  yesButton: ColorItems
+  noButton: ColorItems
+}
+
+// Типы для предупреждений
+export interface WarningParams {
+  warningStyle: WarningStyle
+  showIcon: boolean
+  icon: string
+}
+
+export interface WarningElement {
+  params: WarningParams
+  iconColor: string
+  bgColor: string
+  headlineColor?: string
+  color: string
+  resetButton?: {
+    color: string
+    bgColor: string
+  }
+}
+
+export interface WarningsSection {
+  launchIssue: WarningElement
+  connectionIssue: WarningElement
+  reconnectIssue: WarningElement
+  disableInputIssue: {
+    iconColor: string
+    bgColor: string
+    color: string
+  }
+}
+
+// Типы для лоадера
+export interface LoaderSection {
+  completeStep: string
+  activeStep: string
 }
 
 // Типы для секций
 export interface TopSection {
-  params: SectionParams
-  chipWidgetTitle: UIElement
-  btnClose: UIElement
+  params: {
+    size: Size
+    chipStyle: ChipStyle
+    chipType: BtnType
+    buttonStyle: ButtonStyle
+    buttonType: BtnType
+  }
+  chipWidgetTitle: ColorItems
+  buttons: ColorItems
 }
 
 export interface InsideSection {
-  params: SectionParams
+  params: {
+    size: Size
+  }
   messageUser: UIElement
   messageBot: UIElement
+  activeSnippet: ActiveSnippetElement
   welcomeMessage: UIElement
 }
 
 export interface BottomSection {
-  params: SectionParams
-  inputSend: UIElement
+  params: {
+    size: Size
+    disclaimerShow: boolean
+  }
+  inputSend: InputSendElement
+  warningAlert: UIElement
   btnSend: UIElement
   activeBtn: UIElement
 }
 
 export interface WidgetSections {
+  warnings: WarningsSection
+  loader: LoaderSection
   top: TopSection
   inside: InsideSection
   bottom: BottomSection
@@ -65,18 +167,22 @@ export interface WidgetSections {
 
 // Основной тип конфигурации
 export interface WidgetConfig {
+  schema: ConfigSchema
   settings: WidgetSettings
+  texts: WidgetTexts
   sections: WidgetSections
 }
 
 // Типы для частичного обновления конфигурации
 export type PartialWidgetConfig = Partial<WidgetConfig>
 export type PartialWidgetSettings = Partial<WidgetSettings>
+export type PartialWidgetTexts = Partial<WidgetTexts>
 export type PartialWidgetSections = Partial<WidgetSections>
 
 // Утилитарные типы
 export type ConfigKey = keyof WidgetConfig
 export type SettingsKey = keyof WidgetSettings
+export type TextsKey = keyof WidgetTexts
 export type SectionsKey = keyof WidgetSections
 
 // Типы для валидации
@@ -85,101 +191,9 @@ export interface ConfigValidationResult {
   errors: string[]
 }
 
-
-export type GeneralSettings = Pick<WidgetSettings, 'widgetTitle' | 'welcomeMessage' | 'launchView' | 'logo'>
-
-export type ShapesSettings = Pick<
-  WidgetSettings,
-  'gapMessageLine' | 'paddingChat' | 'fontFamily' | 'borderRadius'
-> & {
-  bottomSize: WidgetConfig['sections']['bottom']['params']['size']
-  sendButtonType: BtnType
-  headerSize: WidgetConfig['sections']['top']['params']['size']
-  messageSize: WidgetConfig['sections']['inside']['params']['size']
-}
-export type EmittedColorElement = {
-  bgChat: ColorItems
-  chipWidgetTitle: ColorItems
-  btnClose: ColorItems
-  messageUser: ColorItems
-  messageBot: ColorItems
-  inputSend: ColorItems
-  btnSend: ColorItems
-  activeBtn: ColorItems
-  welcomeMessage: ColorItems
-}
-export interface FontSettings {
-  fontFamily: string
-  letterSpacing: number
-}
-
-// Экспорт дефолтной конфигурации (для типизации)
-export const DEFAULT_CONFIG: WidgetConfig = {
-  settings: {
-    widgetTitle: 'HyperShadow',
-    welcomeMessage:
-      '🖖 Hi there — I’m your assistant for finding documents, tracking access, and making sense of your files. \n\nHow can I help?',
-    bgChat: 'rgba(47, 47, 49, 0.90)',
-    gapMessageLine: 12,
-    paddingChat: 8,
-    fontFamily: 'MacPaw Fixel',
-    borderRadius: 'lg',
-    launchView: 'closed',
-    letterSpacing: 0,
-    logo: '',
-  },
-  sections: {
-    top: {
-      params: {
-        size: 'md',
-      },
-      chipWidgetTitle: {
-        color: '#BEB6E9',
-        bgColor: '#5E4AC6',
-      },
-      btnClose: {
-        color: '#BBBBBD',
-        bgColor: '#2F2F31',
-      },
-    },
-    inside: {
-      params: {
-        size: 'md',
-      },
-      messageUser: {
-        color: '#F9F8F8',
-        bgColor: '#F8F8F933',
-      },
-      messageBot: {
-        color: '#fff',
-        bgColor: '#5E4AC6',
-      },
-      welcomeMessage: {
-        color: '#fff',
-      },
-    },
-    bottom: {
-      params: {
-        size: 'sm',
-      },
-      inputSend: {
-        color: '#EEECEC',
-        bgColor: '#1E1E1E',
-      },
-      btnSend: {
-        color: '#1E1E1E',
-        bgColor: 'rgba(255, 255, 255, 0.50)',
-        type: 'both',
-      },
-      activeBtn: {
-        color: '#fff',
-        bgColor: '#F8F8F933',
-      },
-    },
-  },
-}
-
 // Утилитарный тип для глубоких частичных объектов
 export type DeepPartial<T> = {
   [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P]
-}
+}
+
+export const DEFAULT_CONFIG: WidgetConfig = config as WidgetConfig

package/src/index.ts

@@ -1,2 +1,28 @@
 export * from './config.types'
 export * from './utils'
+
+// Система миграции конфигураций
+// Явный реэкспорт с алиасом для конфликтующего имени ConfigSchema
+export {
+  ConfigVersion,
+  MigrationResult,
+  MigrationContext,
+  MigrationOptions,
+  MigrationStrategy,
+  MigrationStepResult,
+  MigrationCommand,
+  VersionDetector,
+  ConfigValidator,
+  ConfigSchema as MigrationConfigSchema,
+  MigrationReport,
+  MigrationLogger,
+  ConfigV1,
+  ConfigV2,
+  ConfigByVersion,
+  ConfigFactory,
+} from './migration/types'
+export * from './migration/strategies'  
+export * from './migration/commands'
+export * from './migration/migrator'
+export * from './migration/facade'
+export * from './migration/examples'

package/src/migration/commands.ts

@@ -0,0 +1,314 @@
+/**
+ * Команды для системы миграции конфигураций
+ */
+
+import { 
+  MigrationCommand, 
+  MigrationStepResult, 
+  ConfigVersion, 
+  VersionDetector,
+  ConfigValidator 
+} from './types'
+// Команды для системы миграции конфигураций
+
+/** Команда детекции версии конфигурации */
+export class DetectVersionCommand implements MigrationCommand {
+  name = 'DetectVersion'
+  description = 'Определяет версию конфигурации'
+
+  execute(config: any): MigrationStepResult {
+    try {
+      const detector = new DefaultVersionDetector()
+      const version = detector.detect(config)
+      
+      if (!version) {
+        return {
+          success: false,
+          errors: ['Не удалось определить версию конфигурации'],
+          warnings: [],
+          modified: false
+        }
+      }
+
+      return {
+        success: true,
+        data: { version, config },
+        errors: [],
+        warnings: [],
+        modified: false
+      }
+    } catch (error) {
+      return {
+        success: false,
+        errors: [`Ошибка при детекции версии: ${error}`],
+        warnings: [],
+        modified: false
+      }
+    }
+  }
+}
+
+/** Команда валидации конфигурации */
+export class ValidateConfigCommand implements MigrationCommand {
+  name = 'ValidateConfig'
+  description = 'Валидирует конфигурацию для указанной версии'
+
+  execute(config: any, options: { version: ConfigVersion }): MigrationStepResult {
+    try {
+      const validator = new DefaultConfigValidator()
+      const result = validator.validate(config, options.version)
+      
+      return {
+        success: result.isValid,
+        data: { validationResult: result, config },
+        errors: result.errors,
+        warnings: result.warnings,
+        modified: false
+      }
+    } catch (error) {
+      return {
+        success: false,
+        errors: [`Ошибка при валидации: ${error}`],
+        warnings: [],
+        modified: false
+      }
+    }
+  }
+}
+
+/** Команда очистки конфигурации от неизвестных полей */
+export class CleanConfigCommand implements MigrationCommand {
+  name = 'CleanConfig'
+  description = 'Очищает конфигурацию от неизвестных полей для указанной версии'
+
+  execute(config: any, options: { version: ConfigVersion; preserveUnknown?: boolean }): MigrationStepResult {
+    try {
+      if (options.preserveUnknown) {
+        return {
+          success: true,
+          data: config,
+          errors: [],
+          warnings: ['Очистка пропущена - preserveUnknown: true'],
+          modified: false
+        }
+      }
+
+      // Здесь можно реализовать логику очистки на основе схем
+      const cleanedConfig = this.cleanConfigForVersion(config, options.version)
+      
+      return {
+        success: true,
+        data: cleanedConfig,
+        errors: [],
+        warnings: ['Конфигурация очищена от неизвестных полей'],
+        modified: true
+      }
+    } catch (error) {
+      return {
+        success: false,
+        errors: [`Ошибка при очистке конфигурации: ${error}`],
+        warnings: [],
+        modified: false
+      }
+    }
+  }
+
+  private cleanConfigForVersion(config: any, _version: ConfigVersion): any {
+    // Базовая реализация - возвращаем как есть
+    // В реальном проекте здесь была бы логика очистки на основе схем
+    return { ...config }
+  }
+}
+
+/** Команда создания резервной копии */
+export class BackupConfigCommand implements MigrationCommand {
+  name = 'BackupConfig'
+  description = 'Создает резервную копию конфигурации'
+
+  execute(config: any, options?: { timestamp?: boolean }): MigrationStepResult {
+    try {
+      const timestamp = options?.timestamp ? Date.now() : undefined
+      const backup = {
+        original: JSON.parse(JSON.stringify(config)),
+        timestamp: timestamp || Date.now(),
+        version: new DefaultVersionDetector().detect(config)
+      }
+
+      return {
+        success: true,
+        data: { backup, config },
+        errors: [],
+        warnings: [],
+        modified: false
+      }
+    } catch (error) {
+      return {
+        success: false,
+        errors: [`Ошибка при создании резервной копии: ${error}`],
+        warnings: [],
+        modified: false
+      }
+    }
+  }
+}
+
+/** Дефолтный детектор версий */
+export class DefaultVersionDetector implements VersionDetector {
+  detect(config: any): ConfigVersion | null {
+    try {
+      // Проверяем структуру для определения версии
+      if (!config || !config.settings || !config.sections) {
+        return null
+      }
+
+      // V2 признаки: наличие новых полей
+      const hasV2Features = [
+        config.settings.loader !== undefined,
+        config.settings.buttonStyle !== undefined,
+        config.settings.buttonType !== undefined,
+        config.sections.top.params?.chipStyle !== undefined,
+        config.sections.inside.messageUser?.bgType !== undefined,
+        config.sections.inside.aprooveButton !== undefined,
+        config.sections.bottom.inputSend?.borderStyle !== undefined,
+        config.sections.bottom.warningAlert !== undefined,
+        config.sections.bottom.disclaimer !== undefined
+      ]
+
+      // Если есть хотя бы 3 признака V2, считаем это V2
+      const v2FeaturesCount = hasV2Features.filter(Boolean).length
+      if (v2FeaturesCount >= 3) {
+        return '2.0'
+      }
+
+      // Базовая проверка на V1
+      const hasV1Structure = [
+        config.settings.widgetTitle !== undefined,
+        config.settings.bgChat !== undefined,
+        config.sections.top !== undefined,
+        config.sections.inside !== undefined,
+        config.sections.bottom !== undefined
+      ].every(Boolean)
+
+      if (hasV1Structure) {
+        return '1.0'
+      }
+
+      return null
+    } catch (error) {
+      console.error('Ошибка при детекции версии:', error)
+      return null
+    }
+  }
+}
+
+/** Дефолтный валидатор конфигураций */
+export class DefaultConfigValidator implements ConfigValidator {
+  validate(config: any, version: ConfigVersion): { isValid: boolean; errors: string[]; warnings: string[] } {
+    const errors: string[] = []
+    const warnings: string[] = []
+
+    try {
+      if (!config) {
+        errors.push('Конфигурация не может быть пустой')
+        return { isValid: false, errors, warnings }
+      }
+
+      // Базовая валидация структуры
+      if (!config.settings) {
+        errors.push('Отсутствует секция settings')
+      }
+
+      if (!config.sections) {
+        errors.push('Отсутствует секция sections')
+      }
+
+      if (config.sections) {
+        if (!config.sections.top) errors.push('Отсутствует секция sections.top')
+        if (!config.sections.inside) errors.push('Отсутствует секция sections.inside')
+        if (!config.sections.bottom) errors.push('Отсутствует секция sections.bottom')
+      }
+
+      // Версионная валидация
+      switch (version) {
+        case '1.0':
+          this.validateV1(config, errors, warnings)
+          break
+        case '2.0':
+          this.validateV2(config, errors, warnings)
+          break
+        default:
+          warnings.push(`Валидация для версии ${version} не реализована`)
+      }
+
+      return {
+        isValid: errors.length === 0,
+        errors,
+        warnings
+      }
+    } catch (error) {
+      errors.push(`Ошибка при валидации: ${error}`)
+      return { isValid: false, errors, warnings }
+    }
+  }
+
+  private validateV1(config: any, errors: string[], _warnings: string[]): void {
+    // Проверяем обязательные поля V1
+    const requiredV1Fields = [
+      'settings.widgetTitle',
+      'settings.welcomeMessage',
+      'settings.bgChat'
+    ]
+
+    for (const field of requiredV1Fields) {
+      if (!this.getNestedValue(config, field)) {
+        errors.push(`Отсутствует обязательное поле: ${field}`)
+      }
+    }
+  }
+
+  private validateV2(config: any, errors: string[], warnings: string[]): void {
+    // Сначала валидируем как V1
+    this.validateV1(config, errors, warnings)
+
+    // Дополнительные проверки для V2
+    const expectedV2Fields = [
+      'settings.loader',
+      'settings.buttonStyle',
+      'sections.inside.aprooveButton',
+      'sections.bottom.warningAlert'
+    ]
+
+    for (const field of expectedV2Fields) {
+      if (!this.getNestedValue(config, field)) {
+        warnings.push(`Рекомендуется добавить поле V2: ${field}`)
+      }
+    }
+  }
+
+  private getNestedValue(obj: any, path: string): any {
+    return path.split('.').reduce((current, key) => current?.[key], obj)
+  }
+}
+
+/** Фабрика команд */
+export class CommandFactory {
+  private static commands = new Map<string, () => MigrationCommand>([
+    ['DetectVersion', () => new DetectVersionCommand()],
+    ['ValidateConfig', () => new ValidateConfigCommand()],
+    ['CleanConfig', () => new CleanConfigCommand()],
+    ['BackupConfig', () => new BackupConfigCommand()]
+  ])
+
+  static createCommand(name: string): MigrationCommand | null {
+    const factory = this.commands.get(name)
+    return factory ? factory() : null
+  }
+
+  static getAllCommands(): string[] {
+    return Array.from(this.commands.keys())
+  }
+
+  static registerCommand(name: string, factory: () => MigrationCommand): void {
+    this.commands.set(name, factory)
+  }
+}