{"_id":"@breadstone/ziegel-platform-translation","_rev":"9-1f85dd9dd38c02a486fa8d1f108e940d","name":"@breadstone/ziegel-platform-translation","dist-tags":{"latest":"0.0.9"},"versions":{"0.0.1":{"name":"@breadstone/ziegel-platform-translation","version":"0.0.1","author":{"url":"https://www.breadstone.de","name":"andre.wehlert","email":"awehlert@breadstone.de"},"license":"MIT","_id":"@breadstone/ziegel-platform-translation@0.0.1","maintainers":[{"name":"ruederennes","email":"realsancezz@gmail.com"}],"bugs":{"url":"https://breadstone.visualstudio.com/ziegel/_workitems/create/Bug"},"dist":{"shasum":"cf9a8bc2aa989bf74328db2da3439d49891dd690","tarball":"https://registry.npmjs.org/@breadstone/ziegel-platform-translation/-/ziegel-platform-translation-0.0.1.tgz","fileCount":59,"integrity":"sha512-C74AMB2h837vcqb6DsQpWG3FocbmM3g9afLgYkOB0Xw1DyObxHXk3KK3s/hD88mK8GFzmQbwJ4urjcOcCTZIqQ==","signatures":[{"sig":"MEYCIQCjAxv4crVPg/iMmJSI17Nc4lWy6Zt19FO4dvV6bhxMygIhAP8hY/MHb2bRJGLuQhsha82MpqQ+0BPhgNJ07VXAqi9Y","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":95015},"main":"./Index.js","types":"./Index.d.ts","module":"./Index.js","gitHead":"6e85e7a52b57c3f29013f4fd6383076cd22dc9a0","typings":"./Index.d.ts","_npmUser":{"name":"ruederennes","actor":{"name":"ruederennes","type":"user","email":"realsancezz@gmail.com"},"email":"realsancezz@gmail.com"},"commonjs":"./Index.js","repository":{"url":"https://breadstone.visualstudio.com/ziegel/_git/ziegel","type":"git"},"_npmVersion":"11.3.0","description":"A powerful translation service framework for TypeScript applications that provides AI-powered translation capabilities, multiple translation modes, and extensible provider architecture.","directories":{},"_nodeVersion":"24.0.1","dependencies":{"rxjs":"^7.8.2","tslib":"^2.8.1","@breadstone/ziegel-core":"0.0.1"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/ziegel-platform-translation_0.0.1_1750993754092_0.8596741430811605","host":"s3://npm-registry-packages-npm-production"}},"0.0.2":{"name":"@breadstone/ziegel-platform-translation","version":"0.0.2","author":{"url":"https://www.breadstone.de","name":"andre.wehlert","email":"awehlert@breadstone.de"},"license":"MIT","_id":"@breadstone/ziegel-platform-translation@0.0.2","maintainers":[{"name":"ruederennes","email":"realsancezz@gmail.com"}],"bugs":{"url":"https://breadstone.visualstudio.com/ziegel/_workitems/create/Bug"},"dist":{"shasum":"b9ea8fcb1741e7c3dcf52a4ebdf2dd92fbd93038","tarball":"https://registry.npmjs.org/@breadstone/ziegel-platform-translation/-/ziegel-platform-translation-0.0.2.tgz","fileCount":60,"integrity":"sha512-e+W9L8C+UHTr08hTJ1JYFNYFHm0NTVNxyGadjyevhBI9jOZBgQqRujY50xLqNU6wJv5LkNC72L1HiIZxfs86OQ==","signatures":[{"sig":"MEUCIDFZiot8FuYsHjz23RtkW54P57rQnHgPDVHFnImeSJaMAiEAlMxrKNM0n19TSljjOzhlaCniysU37F1Bdl1vdeq7jAU=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":95478},"main":"./Index.js","types":"./Index.d.ts","module":"./Index.js","gitHead":"810d476703d4a1544150277fa8510b8110622415","typings":"./Index.d.ts","_npmUser":{"name":"ruederennes","actor":{"name":"ruederennes","type":"user","email":"realsancezz@gmail.com"},"email":"realsancezz@gmail.com"},"commonjs":"./Index.js","repository":{"url":"https://breadstone.visualstudio.com/ziegel/_git/ziegel","type":"git"},"_npmVersion":"11.3.0","description":"A powerful translation service framework for TypeScript applications that provides AI-powered translation capabilities, multiple translation modes, and extensible provider architecture.","directories":{},"_nodeVersion":"24.0.1","dependencies":{"rxjs":"^7.8.2","tslib":"^2.8.1","@breadstone/ziegel-core":"0.0.2"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/ziegel-platform-translation_0.0.2_1750994532989_0.20707670746839235","host":"s3://npm-registry-packages-npm-production"}},"0.0.3":{"name":"@breadstone/ziegel-platform-translation","version":"0.0.3","author":{"url":"https://www.breadstone.de","name":"andre.wehlert","email":"awehlert@breadstone.de"},"license":"MIT","_id":"@breadstone/ziegel-platform-translation@0.0.3","maintainers":[{"name":"ruederennes","email":"npm@breadstone.de"}],"homepage":"https://github.com/RueDeRennes/ziegel#readme","bugs":{"url":"https://github.com/RueDeRennes/ziegel/issues"},"dist":{"shasum":"7cbc2e605776797e92e6556ed55015101cc22851","tarball":"https://registry.npmjs.org/@breadstone/ziegel-platform-translation/-/ziegel-platform-translation-0.0.3.tgz","fileCount":56,"integrity":"sha512-IhJr+bz4pxRrdfCf8O9K8A+ou4eOAlv8QLHLKVOn8N+LNaDQmMF/b00mM0bipDXh4vX+AHiPNTG82/ozrmDhNQ==","signatures":[{"sig":"MEUCIF/qTfoXAjVY4GZzwzRW/J3bbVtfj/t1O0294vKv5LJgAiEAiFNG8J8aEDZJMH+vayrpCEzeXI6xzfzyTJ6n593WpnE=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":39934},"main":"./Index.js","types":"./Index.d.ts","module":"./Index.js","gitHead":"b4d03ca0908154138403f2a27ca8efb54bee6e80","typings":"./Index.d.ts","_npmUser":{"name":"ruederennes","actor":{"name":"ruederennes","type":"user","email":"npm@breadstone.de"},"email":"npm@breadstone.de"},"commonjs":"./Index.js","repository":{"url":"git+https://github.com/RueDeRennes/ziegel.git","type":"git"},"_npmVersion":"10.9.2","description":"A powerful translation service framework for TypeScript applications that provides AI-powered translation capabilities, multiple translation modes, and extensible provider architecture.","directories":{},"_nodeVersion":"22.17.0","dependencies":{"rxjs":"^7.8.2","tslib":"^2.8.1","@breadstone/ziegel-core":"0.0.3"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/ziegel-platform-translation_0.0.3_1751575611324_0.027847365505818233","host":"s3://npm-registry-packages-npm-production"}},"0.0.4":{"name":"@breadstone/ziegel-platform-translation","version":"0.0.4","author":{"url":"https://www.breadstone.de","name":"andre.wehlert","email":"awehlert@breadstone.de"},"license":"MIT","_id":"@breadstone/ziegel-platform-translation@0.0.4","maintainers":[{"name":"ruederennes","email":"npm@breadstone.de"}],"homepage":"https://github.com/RueDeRennes/ziegel#readme","bugs":{"url":"https://github.com/RueDeRennes/ziegel/issues"},"dist":{"shasum":"ff7d78af197668b9fe21b8d1902b839997fc5611","tarball":"https://registry.npmjs.org/@breadstone/ziegel-platform-translation/-/ziegel-platform-translation-0.0.4.tgz","fileCount":56,"integrity":"sha512-IS4nOs+5zjaqa/TT1WkiB3B+h/WgZ4rlOrDOSq8OKzvH5NFWwLn9vl44Kg+eYnGCkicW06jBGyU0Xhg5THm+gw==","signatures":[{"sig":"MEYCIQCvpBRZpAP7h6Z11b0HWJBHTw+N/6O3ONeYY1iyLW7eMQIhALgQwjVi0pPGtAeHV83Qnm2DzYPQLLHF7hv851Oa1UAZ","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":39934},"main":"./Index.js","types":"./Index.d.ts","module":"./Index.js","gitHead":"87efb239ae0aa6121dc170cd110bc9be7bb0c622","typings":"./Index.d.ts","_npmUser":{"name":"ruederennes","actor":{"name":"ruederennes","type":"user","email":"npm@breadstone.de"},"email":"npm@breadstone.de"},"commonjs":"./Index.js","repository":{"url":"git+https://github.com/RueDeRennes/ziegel.git","type":"git"},"_npmVersion":"10.9.2","description":"A powerful translation service framework for TypeScript applications that provides AI-powered translation capabilities, multiple translation modes, and extensible provider architecture.","directories":{},"_nodeVersion":"22.17.0","dependencies":{"rxjs":"^7.8.2","tslib":"^2.8.1","@breadstone/ziegel-core":"0.0.4"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/ziegel-platform-translation_0.0.4_1751576128617_0.2681159196776173","host":"s3://npm-registry-packages-npm-production"}},"0.0.5":{"name":"@breadstone/ziegel-platform-translation","version":"0.0.5","author":{"url":"https://www.breadstone.de","name":"andre.wehlert","email":"awehlert@breadstone.de"},"license":"MIT","_id":"@breadstone/ziegel-platform-translation@0.0.5","maintainers":[{"name":"ruederennes","email":"npm@breadstone.de"}],"homepage":"https://github.com/RueDeRennes/ziegel#readme","bugs":{"url":"https://github.com/RueDeRennes/ziegel/issues"},"dist":{"shasum":"cc37f8b1a2fa9ceaeca4488a7fe4ca4426ed3986","tarball":"https://registry.npmjs.org/@breadstone/ziegel-platform-translation/-/ziegel-platform-translation-0.0.5.tgz","fileCount":56,"integrity":"sha512-kfYZ+z3sRHKcnCWLgaKBmkqBTcKkvk0fS6cNKpYJefJLwx8dq+nuSmhPmp9SoRrICnfrKBdLKQAKt4dd3GkshA==","signatures":[{"sig":"MEUCIF1BVOngjg/96SlE4PDSzrCQjACjaHFK8OGCiV4E9TJKAiEAgWByh0dGYnqLgobGmekO4W2CdxMhEwyfBKGHi+io4to=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":43677},"main":"./Index.js","types":"./Index.d.ts","module":"./Index.js","gitHead":"7eb0efd9f6fa2d25da83ba6a3bd737a0da028bf7","typings":"./Index.d.ts","_npmUser":{"name":"ruederennes","actor":{"name":"ruederennes","type":"user","email":"npm@breadstone.de"},"email":"npm@breadstone.de"},"commonjs":"./Index.js","repository":{"url":"git+https://github.com/RueDeRennes/ziegel.git","type":"git"},"_npmVersion":"9.8.1","description":"A powerful translation service framework for TypeScript applications that provides AI-powered translation capabilities, multiple translation modes, and extensible provider architecture.","directories":{},"_nodeVersion":"22.16.0","dependencies":{"rxjs":"^7.8.2","tslib":"^2.8.1","@breadstone/ziegel-core":"0.0.5"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/ziegel-platform-translation_0.0.5_1751699307322_0.22825669749784794","host":"s3://npm-registry-packages-npm-production"}},"0.0.6":{"name":"@breadstone/ziegel-platform-translation","version":"0.0.6","author":{"url":"https://www.breadstone.de","name":"andre.wehlert","email":"awehlert@breadstone.de"},"license":"MIT","_id":"@breadstone/ziegel-platform-translation@0.0.6","maintainers":[{"name":"ruederennes","email":"npm@breadstone.de"}],"homepage":"https://github.com/RueDeRennes/ziegel#readme","bugs":{"url":"https://github.com/RueDeRennes/ziegel/issues"},"dist":{"shasum":"c82ef115a0def7ca05e4487a4d2240c7f32be336","tarball":"https://registry.npmjs.org/@breadstone/ziegel-platform-translation/-/ziegel-platform-translation-0.0.6.tgz","fileCount":56,"integrity":"sha512-0zMgRjM17jiJMZSkhIO9xdlYRxb1H7Gkcal6jZNr33/7I1GmAG/BlUkNohSDpeSpEBJqdIrgcgq1ny9wvRgRiA==","signatures":[{"sig":"MEYCIQDnHBg/SdW3TkoSCuMgxrELqF4hkwh1k4pUAF0+iXx4UAIhAKWv/gHx30dejiyjW5nhObKOdpvhwLuJKnvgRszAa15J","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":48190},"main":"./Index.js","types":"./Index.d.ts","module":"./Index.js","gitHead":"2513477b6a87dede7a429076b048197086e267b2","typings":"./Index.d.ts","_npmUser":{"name":"ruederennes","email":"npm@breadstone.de"},"commonjs":"./Index.js","repository":{"url":"git+https://github.com/RueDeRennes/ziegel.git","type":"git"},"_npmVersion":"11.4.2","description":"A powerful translation service framework for TypeScript applications that provides AI-powered translation capabilities, multiple translation modes, and extensible provider architecture.","directories":{},"_nodeVersion":"24.4.1","dependencies":{"rxjs":"^7.8.2","tslib":"^2.8.1","@breadstone/ziegel-core":"0.0.6"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/ziegel-platform-translation_0.0.6_1754467872809_0.6462028251718066","host":"s3://npm-registry-packages-npm-production"}},"0.0.7":{"name":"@breadstone/ziegel-platform-translation","version":"0.0.7","author":{"url":"https://www.breadstone.de","name":"andre.wehlert","email":"awehlert@breadstone.de"},"license":"MIT","_id":"@breadstone/ziegel-platform-translation@0.0.7","maintainers":[{"name":"ruederennes","email":"npm@breadstone.de"}],"homepage":"https://github.com/RueDeRennes/ziegel#readme","bugs":{"url":"https://github.com/RueDeRennes/ziegel/issues"},"dist":{"shasum":"f70bfcf6d28dc9cb9c42b9c5c0e8f4ff0394ae07","tarball":"https://registry.npmjs.org/@breadstone/ziegel-platform-translation/-/ziegel-platform-translation-0.0.7.tgz","fileCount":56,"integrity":"sha512-AfRAjsw4qn47Ckn3jOVQveByqVMfeo3bQkXz+Ed8DnuytiRlkU8qYIOk2oy+rtH1QppEll467q4SaRUZzLH8Gg==","signatures":[{"sig":"MEUCIASk3gjmUOo957k367i+GrNjOpUyPXOz9F/bvdpC+FiJAiEAsxpiBV+8cKnIM6FuKfE6WT4BQubN6LJCt9DqQtuc2pw=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":48190},"main":"./Index.js","types":"./Index.d.ts","module":"./Index.js","gitHead":"7647e351d85d9dfbae9e9e9d84095559a75822d3","typings":"./Index.d.ts","_npmUser":{"name":"ruederennes","email":"npm@breadstone.de"},"commonjs":"./Index.js","repository":{"url":"git+https://github.com/RueDeRennes/ziegel.git","type":"git"},"_npmVersion":"11.4.2","description":"A powerful translation service framework for TypeScript applications that provides AI-powered translation capabilities, multiple translation modes, and extensible provider architecture.","directories":{},"_nodeVersion":"24.4.1","dependencies":{"rxjs":"^7.8.2","tslib":"^2.8.1","@breadstone/ziegel-core":"0.0.7"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/ziegel-platform-translation_0.0.7_1754468276541_0.8844312428462959","host":"s3://npm-registry-packages-npm-production"}},"0.0.8":{"name":"@breadstone/ziegel-platform-translation","version":"0.0.8","author":{"url":"https://www.breadstone.de","name":"andre.wehlert","email":"awehlert@breadstone.de"},"license":"MIT","_id":"@breadstone/ziegel-platform-translation@0.0.8","maintainers":[{"name":"ruederennes","email":"npm@breadstone.de"}],"homepage":"https://github.com/RueDeRennes/ziegel#readme","bugs":{"url":"https://github.com/RueDeRennes/ziegel/issues"},"dist":{"shasum":"f75747cdb4aeb315d3f4d477cf837ff88aeb1b21","tarball":"https://registry.npmjs.org/@breadstone/ziegel-platform-translation/-/ziegel-platform-translation-0.0.8.tgz","fileCount":56,"integrity":"sha512-vVVYunTUn40QraYF36HteML6phtzN8Oa5mMT+/MOwdQTfWdcyqctKX+/VaoeLlNMBvkg8YatZUE76LSqLGDwkQ==","signatures":[{"sig":"MEQCIE19BeIR7CMkma12BpP9jAQsviNdJAowWy8XGY1gEUsZAiAUnyzJVdnHJSo9nFdDs8+rcP5AZEeyqjq6PnYorIs0QA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":46930},"main":"./Index.js","types":"./Index.d.ts","module":"./Index.js","gitHead":"e3ad0a5eb92747c06f8642ef6b1b2e012ef6cb77","typings":"./Index.d.ts","_npmUser":{"name":"ruederennes","email":"npm@breadstone.de"},"commonjs":"./Index.js","repository":{"url":"git+https://github.com/RueDeRennes/ziegel.git","type":"git"},"_npmVersion":"11.4.2","description":"A powerful translation service framework for TypeScript applications that provides AI-powered translation capabilities, multiple translation modes, and extensible provider architecture.","directories":{},"_nodeVersion":"24.4.1","dependencies":{"rxjs":"^7.8.2","tslib":"^2.8.1","@breadstone/ziegel-core":"0.0.8"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/ziegel-platform-translation_0.0.8_1754745299076_0.09805373796154226","host":"s3://npm-registry-packages-npm-production"}},"0.0.9":{"name":"@breadstone/ziegel-platform-translation","version":"0.0.9","description":"A powerful translation service framework for TypeScript applications that provides AI-powered translation capabilities, multiple translation modes, and extensible provider architecture.","license":"MIT","author":{"name":"andre.wehlert","email":"awehlert@breadstone.de","url":"https://www.breadstone.de"},"main":"./Index.js","module":"./Index.js","commonjs":"./Index.js","typings":"./Index.d.ts","types":"./Index.d.ts","repository":{"type":"git","url":"git+https://github.com/RueDeRennes/ziegel.git"},"bugs":{"url":"https://github.com/RueDeRennes/ziegel/issues"},"dependencies":{"@breadstone/ziegel-core":"0.0.9","rxjs":"^7.8.2","tslib":"^2.8.1"},"_id":"@breadstone/ziegel-platform-translation@0.0.9","gitHead":"efc417cb60db843da253c8b83aa7ea54fe94ed5f","homepage":"https://github.com/RueDeRennes/ziegel#readme","_nodeVersion":"24.4.1","_npmVersion":"11.4.2","dist":{"integrity":"sha512-ZAroWevElArtQLrU3C/LMcBe/HBoFZk/AcpnzjfXzeB7AxGwj2iE/CIjJ2qy11M8jrD48zMgmvORD4GaKTDR3w==","shasum":"22d46fc4af5758f1b9a3d45845ded12a0a09c385","tarball":"https://registry.npmjs.org/@breadstone/ziegel-platform-translation/-/ziegel-platform-translation-0.0.9.tgz","fileCount":56,"unpackedSize":46930,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCTYf42JGxshI+lWoJlHMyt2WJa8oJd5UWbGg0gStRwLgIhAJ+0TG8fAVXF2d8exYruQ/sNkik4Kl3Nnd7A66pwjc/+"}]},"_npmUser":{"name":"ruederennes","email":"npm@breadstone.de"},"directories":{},"maintainers":[{"name":"ruederennes","email":"npm@breadstone.de"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/ziegel-platform-translation_0.0.9_1756450329909_0.4902172726393055"},"_hasShrinkwrap":false}},"time":{"created":"2025-06-27T03:09:13.925Z","modified":"2025-08-29T06:52:10.327Z","0.0.1":"2025-06-27T03:09:14.261Z","0.0.2":"2025-06-27T03:22:13.172Z","0.0.3":"2025-07-03T20:46:51.511Z","0.0.4":"2025-07-03T20:55:28.781Z","0.0.5":"2025-07-05T07:08:27.515Z","0.0.6":"2025-08-06T08:11:12.999Z","0.0.7":"2025-08-06T08:17:56.769Z","0.0.8":"2025-08-09T13:14:59.285Z","0.0.9":"2025-08-29T06:52:10.096Z"},"bugs":{"url":"https://github.com/RueDeRennes/ziegel/issues"},"author":{"name":"andre.wehlert","email":"awehlert@breadstone.de","url":"https://www.breadstone.de"},"license":"MIT","homepage":"https://github.com/RueDeRennes/ziegel#readme","repository":{"type":"git","url":"git+https://github.com/RueDeRennes/ziegel.git"},"description":"A powerful translation service framework for TypeScript applications that provides AI-powered translation capabilities, multiple translation modes, and extensible provider architecture.","maintainers":[{"name":"ruederennes","email":"npm@breadstone.de"}],"readme":"# @breadstone/ziegel-platform-translation\n\nA powerful translation service framework for TypeScript applications that provides AI-powered translation capabilities, multiple translation modes, and extensible provider architecture.\n\n## Features\n\n- **AI-Powered Translation**: Integration with OpenAI GPT models for high-quality translations\n- **Multiple Translation Modes**: Support for translate, polishing, summarization, and code explanation\n- **Extensible Architecture**: Provider-based system for integrating different translation services\n- **Language Detection**: Automatic source and target language detection\n- **Async/Promise-based**: Modern async/await support for all translation operations\n- **Type Safety**: Fully typed interfaces for queries, results, and configurations\n- **Request Factory Pattern**: Flexible HTTP request handling with custom factory functions\n- **Configuration Management**: Comprehensive configuration system for provider settings\n\n## Architecture\n\nThe translation system is built around several key components:\n\n- **ITranslationProvider**: Interface for translation service providers\n- **TranslationProviderBase**: Abstract base class for implementing custom providers\n- **OpenAiTranslationProvider**: Ready-to-use OpenAI GPT integration\n- **ITranslateQuery**: Interface defining translation request parameters\n- **ITranslateResult**: Interface for translation response data\n- **IRequestFactoryFn**: Factory function for HTTP request handling\n\n## Installation\n\n```bash\nnpm install @breadstone/ziegel-platform-translation\n```\n\n## Usage\n\n### OpenAI Translation Setup\n\n```typescript\nimport {\n    OpenAiTranslationProvider,\n    IOpenAiTranslationProviderConfig,\n    FETCH_REQUEST_FACTORY_FN\n} from '@breadstone/ziegel-platform-translation';\n\n// Configure OpenAI provider\nconst config: IOpenAiTranslationProviderConfig = {\n    apiUrl: 'https://api.openai.com',\n    apiKey: 'your-openai-api-key',\n    model: 'gpt-4',\n    temperature: 0.3,\n    maxTokens: 2000,\n    topP: 1,\n    frequencyPenalty: 0,\n    presencePenalty: 0\n};\n\n// Create translation provider\nconst translationProvider = new OpenAiTranslationProvider(\n    config,\n    FETCH_REQUEST_FACTORY_FN\n);\n```\n\n### Basic Translation\n\n```typescript\nimport {\n    ITranslateQuery,\n    TranslateMode\n} from '@breadstone/ziegel-platform-translation';\n\n// Create translation query\nconst query: ITranslateQuery = {\n    text: 'Hello, how are you today?',\n    detectFrom: 'en',\n    detectTo: 'de',\n    mode: 'translate'\n};\n\n// Perform translation\nconst result = await translationProvider.translate(query);\nconsole.log(result); // German translation\n```\n\n### Different Translation Modes\n\n```typescript\n// Standard translation\nconst translateQuery: ITranslateQuery = {\n    text: 'This is a sample text for translation.',\n    detectFrom: 'en',\n    detectTo: 'fr',\n    mode: 'translate'\n};\n\n// Text polishing/improvement\nconst polishQuery: ITranslateQuery = {\n    text: 'This text needs some polishing and refinement.',\n    detectFrom: 'en',\n    detectTo: 'en',\n    mode: 'polishing'\n};\n\n// Text summarization\nconst summarizeQuery: ITranslateQuery = {\n    text: 'Long article text that needs to be summarized...',\n    detectFrom: 'en',\n    detectTo: 'en',\n    mode: 'summarize'\n};\n\n// Code explanation\nconst explainCodeQuery: ITranslateQuery = {\n    text: 'const result = array.map(item => item * 2);',\n    detectFrom: 'javascript',\n    detectTo: 'en',\n    mode: 'explain-code'\n};\n\n// Execute translations\nconst translation = await translationProvider.translate(translateQuery);\nconst polished = await translationProvider.translate(polishQuery);\nconst summary = await translationProvider.translate(summarizeQuery);\nconst explanation = await translationProvider.translate(explainCodeQuery);\n```\n\n### Localization File Translation\n\n```typescript\n// Translate i18n locale files\nconst localizationQuery: ITranslateQuery = {\n    text: JSON.stringify({\n        \"welcome\": \"Welcome to our application\",\n        \"login\": \"Log in to continue\",\n        \"error.required\": \"This field is required\"\n    }),\n    detectFrom: 'en',\n    detectTo: 'es',\n    mode: 'translate'\n};\n\nconst translatedLocale = await translationProvider.translate(localizationQuery);\n// Result will preserve the key structure while translating values\n```\n\n### Custom Translation Provider\n\n```typescript\nimport {\n    TranslationProviderBase,\n    ITranslationProviderConfig,\n    ITranslateQuery,\n    ITranslateResult\n} from '@breadstone/ziegel-platform-translation';\n\n// Define custom configuration\ninterface CustomProviderConfig extends ITranslationProviderConfig {\n    customApiUrl: string;\n    customApiKey: string;\n    customModel: string;\n}\n\n// Implement custom provider\nclass CustomTranslationProvider extends TranslationProviderBase<CustomProviderConfig> {\n    constructor(config: CustomProviderConfig) {\n        super(config, {\n            customApiUrl: 'https://api.custom-service.com',\n            customApiKey: '',\n            customModel: 'default-model'\n        } as CustomProviderConfig);\n    }\n\n    async translate(query: ITranslateQuery): Promise<ITranslateResult> {\n        // Custom translation logic\n        const response = await fetch(`${this.config.customApiUrl}/translate`, {\n            method: 'POST',\n            headers: {\n                'Authorization': `Bearer ${this.config.customApiKey}`,\n                'Content-Type': 'application/json'\n            },\n            body: JSON.stringify({\n                text: query.text,\n                from: query.detectFrom,\n                to: query.detectTo,\n                mode: query.mode\n            })\n        });\n\n        const result = await response.json();\n        return {\n            translatedText: result.translation,\n            sourceLanguage: query.detectFrom,\n            targetLanguage: query.detectTo,\n            confidence: result.confidence || 1.0\n        };\n    }\n}\n```\n\n### Custom Request Factory\n\n```typescript\nimport { IRequestFactoryFn } from '@breadstone/ziegel-platform-translation';\n\n// Create custom request factory with additional headers\nconst customRequestFactory: IRequestFactoryFn = () => {\n    return async (url: string, options?: RequestInit) => {\n        const customOptions = {\n            ...options,\n            headers: {\n                ...options?.headers,\n                'User-Agent': 'MyApp/1.0',\n                'X-Custom-Header': 'custom-value'\n            }\n        };\n\n        return fetch(url, customOptions);\n    };\n};\n\n// Use with provider\nconst provider = new OpenAiTranslationProvider(config, customRequestFactory);\n```\n\n### Batch Translation\n\n```typescript\n// Translate multiple texts\nconst queries: ITranslateQuery[] = [\n    { text: 'Hello', detectFrom: 'en', detectTo: 'es', mode: 'translate' },\n    { text: 'Goodbye', detectFrom: 'en', detectTo: 'es', mode: 'translate' },\n    { text: 'Thank you', detectFrom: 'en', detectTo: 'es', mode: 'translate' }\n];\n\n// Process in parallel\nconst results = await Promise.all(\n    queries.map(query => translationProvider.translate(query))\n);\n\nconsole.log('Translated texts:', results);\n```\n\n### Error Handling\n\n```typescript\ntry {\n    const result = await translationProvider.translate({\n        text: 'Text to translate',\n        detectFrom: 'en',\n        detectTo: 'invalid-language',\n        mode: 'translate'\n    });\n} catch (error) {\n    console.error('Translation failed:', error);\n    // Handle translation errors appropriately\n}\n```\n\n### Advanced Configuration\n\n```typescript\n// Advanced OpenAI configuration\nconst advancedConfig: IOpenAiTranslationProviderConfig = {\n    apiUrl: 'https://api.openai.com',\n    apiKey: process.env.OPENAI_API_KEY,\n    model: 'gpt-4-turbo-preview',\n    temperature: 0.1, // Lower for more consistent translations\n    maxTokens: 4000,\n    topP: 0.95,\n    frequencyPenalty: 0.2,\n    presencePenalty: 0.1\n};\n\n// Fine-tuned provider for specific use cases\nconst precisionProvider = new OpenAiTranslationProvider(\n    advancedConfig,\n    FETCH_REQUEST_FACTORY_FN\n);\n```\n\n## Package import points\n\n```typescript\nimport {\n    // Core interfaces\n    ITranslationProvider,\n    ITranslateQuery,\n    ITranslateResult,\n    ITranslationProviderConfig,\n    IRequestFactoryFn,\n\n    // Main classes\n    TranslationProviderBase,\n    OpenAiTranslationProvider,\n\n    // Configuration types\n    IOpenAiTranslationProviderConfig,\n\n    // Utilities\n    TranslateMode,\n    FETCH_REQUEST_FACTORY_FN\n} from '@breadstone/ziegel-platform-translation';\n```\n\n## API Documentation\n\nFor detailed API documentation, visit: [API Docs](./../../.docs/api/ziegel-platform-translation/index.md)\n\n## Supported Translation Modes\n\n- **`translate`**: Standard text translation between languages\n- **`polishing`**: Text improvement and refinement in the same language\n- **`summarize`**: Text summarization to extract key points\n- **`explain-code`**: Code explanation and documentation generation\n\n## Related Packages\n\n- **@breadstone/ziegel-core**: Fundamental utilities and type definitions\n- **rxjs**: Observable patterns for reactive programming\n\n## License\n\nMIT\n\n## Issues\n\nReport issues at: [GitHub Issues](https://github.com/RueDeRennes/ziegel/issues)","readmeFilename":"README.md"}