Hello world
';\nconst htmlResult = await client.translateHTML({\n html,\n source: 'en',\n target: 'fr'\n});\nconsole.log(htmlResult.html);\n// Output: \"Bonjour monde
\"\n```\n\n### CommonJS\n\n```javascript\nconst { TranslatePlusClient } = require('translateplus-js');\n\nconst client = new TranslatePlusClient({\n apiKey: 'your-api-key'\n});\n\nclient.translate({\n text: 'Hello',\n source: 'en',\n target: 'fr'\n}).then(result => {\n console.log(result.translations.translation);\n});\n```\n\n## Documentation\n\n### Client Options\n\n```typescript\nconst client = new TranslatePlusClient({\n apiKey: 'your-api-key', // Required: Your TranslatePlus API key\n baseUrl: 'https://api.translateplus.io', // Optional: API base URL\n timeout: 30000, // Optional: Request timeout in ms (default: 30000)\n maxRetries: 3, // Optional: Maximum retries (default: 3)\n maxConcurrent: 5, // Optional: Max concurrent requests (default: 5)\n});\n```\n\n### Text Translation\n\n#### Single Translation\n\n```typescript\nconst result = await client.translate({\n text: 'My client speaks only French. Will you translate for me?',\n source: 'en', // or 'auto' for auto-detection\n target: 'fr'\n});\n\nconsole.log(result.translations.translation);\nconsole.log(result.translations.source); // Detected source language\nconsole.log(result.translations.target); // Target language\n```\n\n#### Batch Translation\n\n```typescript\nconst texts = [\n 'Hello, how are you?',\n 'What is your name?',\n 'Thank you very much!'\n];\n\nconst result = await client.translateBatch({\n texts,\n source: 'en',\n target: 'fr'\n});\n\nconsole.log(`Total: ${result.total}`);\nconsole.log(`Successful: ${result.successful}`);\nconsole.log(`Failed: ${result.failed}`);\n\nresult.translations.forEach(translation => {\n if (translation.success) {\n console.log(`${translation.text} -> ${translation.translation}`);\n } else {\n console.log(`Error: ${translation.error}`);\n }\n});\n```\n\n#### Concurrent Translation\n\n```typescript\nconst texts = ['Hello', 'Goodbye', 'Thank you', 'Please', 'Sorry'];\n\n// Translate all texts concurrently\nconst results = await client.translateConcurrent(texts, 'en', 'fr');\n\nresults.forEach((result, index) => {\n if ('error' in result) {\n console.log(`Error translating \"${texts[index]}\": ${result.error}`);\n } else {\n console.log(result.translations.translation);\n }\n});\n```\n\n### HTML Translation\n\n```typescript\nconst htmlContent = `\n\n \nThis is a test paragraph.
\n \n\n`;\n\nconst result = await client.translateHTML({\n html: htmlContent,\n source: 'en',\n target: 'fr'\n});\n\nconsole.log(result.html);\n// HTML structure is preserved, only text content is translated\n```\n\n### Email Translation\n\n```typescript\nconst result = await client.translateEmail({\n subject: 'Welcome to our service',\n email_body: 'Thank you for signing up!
We\\'re excited to have you.
',\n source: 'en',\n target: 'fr'\n});\n\nconsole.log(result.subject); // Translated subject\nconsole.log(result.html_body); // Translated HTML body\n```\n\n### Subtitle Translation\n\n```typescript\nconst srtContent = `1\n00:00:01,000 --> 00:00:02,000\nHello world\n\n2\n00:00:03,000 --> 00:00:04,000\nHow are you?\n`;\n\nconst result = await client.translateSubtitles({\n content: srtContent,\n format: 'srt', // or 'vtt'\n source: 'en',\n target: 'fr'\n});\n\nconsole.log(result.content);\n// Timestamps are preserved, only text is translated\n```\n\n### Language Detection\n\n```typescript\nconst result = await client.detectLanguage('Bonjour le monde');\nconsole.log(result.language_detection.language); // 'fr'\nconsole.log(result.language_detection.confidence); // 0.99\n```\n\n### Supported Languages\n\n```typescript\nconst languages = await client.getSupportedLanguages();\nfor (const [code, name] of Object.entries(languages.languages)) {\n console.log(`${code}: ${name}`);\n}\n```\n\n### Account Information\n\n```typescript\nconst summary = await client.getAccountSummary();\nconsole.log(`Credits remaining: ${summary.credits_remaining}`);\nconsole.log(`Current plan: ${summary.plan_name}`);\nconsole.log(`Concurrency limit: ${summary.concurrency_limit}`);\n```\n\n### i18n Translation Jobs\n\n#### Create Job\n\n```typescript\nconst result = await client.createI18nJob({\n file_path: 'locales/en.json',\n target_languages: ['fr', 'es', 'de'],\n source_language: 'en',\n webhook_url: 'https://your-app.com/webhook' // Optional\n});\n\nconst jobId = result.job_id;\nconsole.log(`Job created: ${jobId}`);\n```\n\n#### Check Job Status\n\n```typescript\nconst status = await client.getI18nJobStatus(jobId);\nconsole.log(`Status: ${status.status}`); // pending, processing, completed, failed\nconsole.log(`Progress: ${status.progress || 0}%`);\n```\n\n#### List Jobs\n\n```typescript\nconst jobs = await client.listI18nJobs(1, 20);\nfor (const job of jobs.results) {\n console.log(`Job ${job.id}: ${job.status}`);\n}\n```\n\n#### Download Translated File\n\n```typescript\n// Download French translation\nconst content = await client.downloadI18nFile(jobId, 'fr');\nfs.writeFileSync('locales/fr.json', content);\n```\n\n#### Delete Job\n\n```typescript\nawait client.deleteI18nJob(jobId);\n```\n\n## Error Handling\n\nThe library provides specific exception types for different error scenarios:\n\n```typescript\nimport {\n TranslatePlusClient,\n TranslatePlusError,\n TranslatePlusAPIError,\n TranslatePlusAuthenticationError,\n TranslatePlusRateLimitError,\n TranslatePlusInsufficientCreditsError,\n TranslatePlusValidationError,\n} from 'translateplus-js';\n\nconst client = new TranslatePlusClient({ apiKey: 'your-api-key' });\n\ntry {\n const result = await client.translate({ text: 'Hello', source: 'en', target: 'fr' });\n} catch (error) {\n if (error instanceof TranslatePlusAuthenticationError) {\n console.error('Invalid API key');\n } else if (error instanceof TranslatePlusInsufficientCreditsError) {\n console.error('Insufficient credits');\n } else if (error instanceof TranslatePlusRateLimitError) {\n console.error('Rate limit exceeded');\n } else if (error instanceof TranslatePlusAPIError) {\n console.error(`API error: ${error.message}`);\n console.error(`Status code: ${error.statusCode}`);\n } else if (error instanceof TranslatePlusError) {\n console.error(`Error: ${error.message}`);\n }\n}\n```\n\n## Examples\n\n### Translate a List of Documents\n\n```typescript\nconst documents = [\n 'Document 1 content...',\n 'Document 2 content...',\n 'Document 3 content...',\n];\n\nconst results = await client.translateConcurrent(documents, 'en', 'fr');\n\nresults.forEach((result, index) => {\n if ('error' in result) {\n console.error(`Document ${index + 1} failed: ${result.error}`);\n } else {\n console.log(`Document ${index + 1}: ${result.translations.translation}`);\n }\n});\n```\n\n### Translate HTML Email Template\n\n```typescript\nconst emailTemplate = `\n\n \nThank you for joining us.
\n \n\n`;\n\n// Translate to multiple languages\nconst languages = ['fr', 'es', 'de'];\nconst translations: { [key: string]: string } = {};\n\nfor (const lang of languages) {\n const result = await client.translateHTML({\n html: emailTemplate,\n source: 'en',\n target: lang\n });\n translations[lang] = result.html;\n}\n```\n\n## Requirements\n\n- Node.js 14.0.0 or higher\n- TypeScript 5.1+ (optional, for TypeScript projects)\n\n## License\n\nMIT License - see [LICENSE](LICENSE) file for details.\n\n## Support\n\n- **Documentation**: [https://docs.translateplus.io](https://docs.translateplus.io)\n- **API Reference**: [https://docs.translateplus.io/reference/v2/translation/translate](https://docs.translateplus.io/reference/v2/translation/translate)\n- **Issues**: [GitHub Issues](https://github.com/translateplus/translateplus-js/issues)\n- **Email**: support@translateplus.io\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## Changelog\n\n### 2.0.0 (2024-01-12)\n\n- Initial release\n- Support for all TranslatePlus API endpoints\n- Concurrent translation support\n- Comprehensive error handling\n- Full TypeScript support\n- ESM and CommonJS support\n","readmeFilename":"README.md"}