ai-l10n-sdk 1.3.0 → 1.5.0

package/CHANGELOG.md

@@ -0,0 +1,110 @@
+# Changelog - ai-l10n-sdk
+
+All notable changes to the SDK package will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.5.0] - 2026-04-16
+
+### Changed
+- Updated to use `ai-l10n-core@1.5.0` — all API methods now return `ApiResponse<T>` and never throw
+- `TranslationOutput.remainingBalance` is now sourced from `TranslationResponse.currentBalance` (unchanged behavior for consumers)
+- Error results from `translate()` (previously thrown or null-returned) are now uniformly surfaced as failed `TranslationOutput` entries with the error `message` from `TranslationResponse`
+
+## [1.4.0] - 2026-04-02
+
+### Added
+- **Multi-Format Support** - Translation now works with all text-based localization formats (YAML, PO/gettext, XLIFF, and any format accepted by the API). The `format` field is derived from the source file extension and sent in the request body. See [supported formats](https://l10n.dev/ws/translate-i18n-files#supported-formats)
+  - `I18nProjectManager.detectLanguagesFromProject()` now scans paired extensions: `.yaml`/`.yml` and `.xliff`/`.xlf` (same as `.json`/`.jsonc`)
+  - `TranslationRequest` has a new optional `format?: string` field
+
+### Changed
+- `validateLanguageCode()` and `normalizeLanguageCode()` removed from `I18nProjectManager` — use these functions directly from `ai-l10n-core` instead
+- Moved `ConsoleLogger` and `L10nTranslationService` tests to `ai-l10n-core` package
+- Removed core-library API sections from README (`ILogger`, `ConsoleLogger`, `L10nTranslationService` and related types); now documented in [ai-l10n-core](https://www.npmjs.com/package/ai-l10n-core)
+
+### Migration
+```typescript
+// Before
+manager.validateLanguageCode(code);
+manager.normalizeLanguageCode(code);
+manager.extractLanguageCode(fileName);
+
+// After
+import { validateLanguageCode, normalizeLanguageCode, extractLanguageCode } from 'ai-l10n-core';
+validateLanguageCode(code);
+normalizeLanguageCode(code);
+extractLanguageCode(fileName);
+```
+
+## [1.3.0] - 2026-02-12
+
+### Added
+- **Metadata Translation Control** - Added `translateMetadata` configuration option (default: `false`)
+  - New optional parameter in `TranslationConfig` interface
+  - New optional parameter in `TranslationRequest` interface
+  - Allows control over whether metadata is translated along with UI strings
+  - For example, in Flutter ARB files, metadata entries like `@key` contain descriptions that can optionally be translated
+  - When disabled (default), metadata remains unchanged in target files
+
+## [1.2.0] - 2026-02-04
+
+### Added
+- **JSONC Support** - Added support for `.jsonc` (JSON with Comments) file extension alongside `.json` files
+- **Shopify Theme Localization** - Added support for Shopify theme localization file patterns:
+  - Automatically detects and handles files with `.default.` in the name (e.g., `en.default.schema.json`)
+  - Removes `.default.` from target file names while preserving language code
+  - Preserves `.schema.` suffix in translated files when present in source file
+  - Example: `en.default.schema.json` → `es-ES.schema.json`, `fr.schema.json`
+
+### Changed
+- Enhanced `I18nProjectManager.detectLanguagesFromProject()` to scan for both `.json` and `.jsonc` files
+- Updated `I18nProjectManager.extractLanguageCodeFromFileName()` to handle Shopify theme naming patterns
+- Improved `I18nProjectManager.generateTargetFilePath()` to preserve `.schema` suffix in output files
+
+## [1.1.4] - 2025-12-16
+
+### Changed
+- Version bumped to match main package (no functional changes to SDK)
+
+## [1.1.3] - 2025-12-16
+
+### Changed
+- Version bumped to match main package (no functional changes to SDK)
+
+## [1.1.2] - 2025-12-15
+
+### Fixed
+- **Type Exports** - Added missing type exports for better TypeScript support:
+  - `I18nProjectManager` class and related types
+  - `TranslationRequest`, `TranslationResult`, `FileSchema`, `FinishReason` from translation service
+  - `URLS` constants
+  - All types now properly accessible when importing from the package
+
+## [1.1.1] - 2025-12-15
+
+### Added
+- **Initial Release** - Independent SDK package extracted from ai-l10n
+- Core translation functionality:
+  - `AiTranslator` class with full translation API
+  - `L10nTranslationService` for direct API access
+  - `ApiKeyManager` for secure API key storage
+  - `I18nProjectManager` for project structure detection
+  - `ILogger` interface for custom logging
+  - `ConsoleLogger` implementation
+- Complete TypeScript support with type definitions
+- Comprehensive test suite (139 passing tests)
+- Full documentation with API examples
+- Support for JSON and ARB file formats
+- Custom logger integration for VS Code extensions and other environments
+
+### Features
+- Translate files to 165+ languages
+- Context-aware AI translations
+- Incremental translation (translate only new strings)
+- Type-safe JSON handling
+- Automatic language detection
+- Plural forms generation
+- Content filtering with separate filtered strings output
+- Usage tracking and balance monitoring