transl8-srt 1.0.1 → 1.1.0

package/README.md

@@ -59,9 +59,11 @@ console.log(result.stats);
 //   totalCues: 2,
 //   totalSentences: 1,
 //   totalBatches: 1,
+//   failedBatches: [],
 //   inputTokens: 312,
 //   outputTokens: 48,
 //   estimatedCostUsd: 0.0000528,
+//   costTracked: true,
 //   durationMs: 843
 // }
 ```
@@ -131,6 +133,23 @@ const client = new OpenAI({
 const result = await translate(content, {targetLang: "es"}, client);
 ```
 
+### Bring custom models - like Deepseek
+
+```typescript
+import OpenAI from "openai";
+import { translate } from "transl8-srt";
+
+const client = new OpenAI({
+  baseURL: "https://api.deepseek.com",
+  apiKey: process.env.DEEPSEEK_API_KEY,
+});
+
+const result = await translate(content, {
+  targetLang: "fr",
+  model: "deepseek-chat",   // ← explicitly set — no auto-selection for custom providers
+}, client);
+```
+
 ---
 
 ## Options reference
@@ -149,11 +168,23 @@ interface TranslateOptions {
     batchSize?: number;     // Sentences per API call. Default: 25
     contextOverlap?: number;     // Overlap sentences from prior batch. Default: 4
     concurrency?: number;     // Parallel API requests. Default: 8
+    maxBatchTokens?: number; // Soft token budget/batch (~4 chars/token heuristic). Default: 4000
+    jsonMode?: boolean;     // Request response_format: json_object. Default: true
     model?: "gpt-4o" | "gpt-4o-mini"; // Auto-selected based on targetLang if omitted
     primer?: boolean;    // AI-inferred style profile. Default: false
 }
 ```
 
+A batch closes as soon as either `batchSize` sentences or `maxBatchTokens`
+(estimated) is reached — whichever comes first. This keeps a batch of a few
+long, run-on sentences from producing an oversized request even though it's
+under the sentence-count cap.
+
+If a batch fails after retries, `translate()` does **not** throw — that
+batch's cues keep their original (untranslated) text, and the batch's index
+is reported in `result.stats.failedBatches` so you can detect and re-run
+just the failed portion if needed.
+
 ### Auto model selection
 
 | Target language                              | Auto model                   |