@braze/sanity-plugin-ai-translation 0.2.31 → 0.2.33

package/dist/index.d.ts

@@ -233,7 +233,15 @@ export declare interface PluginConfig {
   maxReferenceDepth?: number;
   openai?: {
     apiKey: string;
-    model?: "gpt-5.1" | "gpt-5" | "gpt-4o" | "gpt-4-turbo" | "gpt-4";
+    model?:
+      | "gpt-5.1"
+      | "gpt-5"
+      | "gpt-5-mini"
+      | "gpt-5-nano"
+      | "gpt-5-pro"
+      | "gpt-4o"
+      | "gpt-4-turbo"
+      | "gpt-4";
     reasoningEffort?: "low" | "medium" | "high";
     enabled?: boolean;
     defaultMode?: TranslationMode;

package/dist/index.js

@@ -1605,7 +1605,109 @@ const fetchTranslationPrompts = async ({
         payload
       });
     }
-}, getExistingTranslationId = (translationMetadata, targetLanguage) => translationMetadata?.translations?.length && translationMetadata.translations.find(
+}, DEFAULT_OPTIONS = {
+  maxRetries: 3,
+  initialDelayMs: 1e3,
+  maxDelayMs: 3e4,
+  backoffMultiplier: 2,
+  jitter: !0
+};
+function isRetryableError(error) {
+  if (error instanceof Error) {
+    const message = error.message.toLowerCase(), name = error.name.toLowerCase(), nonRetryablePatterns = [
+      "schema not found",
+      "invalid schema",
+      "not found",
+      "unauthorized",
+      "forbidden",
+      "invalid api key",
+      "missing api key",
+      "validation failed",
+      "invalid document",
+      "source language not found",
+      "invalid configuration",
+      "type mismatch"
+    ];
+    for (const pattern of nonRetryablePatterns)
+      if (message.includes(pattern) || name.includes(pattern))
+        return !1;
+    const retryablePatterns = [
+      "failed to fetch",
+      "network",
+      "timeout",
+      "econnreset",
+      "econnrefused",
+      "enotfound",
+      "socket",
+      "rate limit",
+      "too many requests",
+      "429",
+      "500",
+      "502",
+      "503",
+      "504",
+      "internal server error",
+      "bad gateway",
+      "service unavailable",
+      "gateway timeout",
+      "temporarily unavailable",
+      "try again"
+    ];
+    for (const pattern of retryablePatterns)
+      if (message.includes(pattern) || name.includes(pattern))
+        return !0;
+  }
+  if (typeof error == "object" && error !== null) {
+    const statusCode = error.statusCode || error.status;
+    if (statusCode) {
+      if (statusCode === 429 || statusCode >= 500 && statusCode < 600)
+        return !0;
+      if (statusCode >= 400 && statusCode < 500)
+        return !1;
+    }
+  }
+  return !0;
+}
+function calculateBackoffDelay(attempt, options) {
+  const { initialDelayMs, maxDelayMs, backoffMultiplier, jitter } = options;
+  let delay = initialDelayMs * backoffMultiplier ** attempt;
+  if (delay = Math.min(delay, maxDelayMs), jitter) {
+    const jitterFactor = 0.75 + Math.random() * 0.5;
+    delay = Math.round(delay * jitterFactor);
+  }
+  return delay;
+}
+function sleep(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+async function withRetry(fn, options = {}) {
+  const opts = { ...DEFAULT_OPTIONS, ...options }, shouldRetry = opts.isRetryable ?? isRetryableError;
+  let lastError, attempts = 0;
+  for (let attempt = 0; attempt <= opts.maxRetries; attempt++) {
+    attempts = attempt + 1;
+    try {
+      return { success: !0, result: await fn(), attempts };
+    } catch (error) {
+      if (lastError = error, attempt >= opts.maxRetries) {
+        devLog.debug("Max retries exhausted", { attempt: attempts, error });
+        break;
+      }
+      if (!shouldRetry(error)) {
+        devLog.debug("Error is not retryable", { attempt: attempts, error });
+        break;
+      }
+      const delay = calculateBackoffDelay(attempt, opts);
+      devLog.debug("Scheduling retry", {
+        attempt: attempts,
+        nextAttempt: attempt + 2,
+        delayMs: delay,
+        error: error instanceof Error ? error.message : String(error)
+      }), opts.onRetry && opts.onRetry(attempt + 1, error, delay), await sleep(delay);
+    }
+  }
+  return { success: !1, error: lastError, attempts };
+}
+const getExistingTranslationId = (translationMetadata, targetLanguage) => translationMetadata?.translations?.length && translationMetadata.translations.find(
   (translation) => translation._key === targetLanguage
 )?.value._ref || null, getTranslationMetadata = async ({
   client,
@@ -1859,9 +1961,10 @@ class TransformRegistry {
     }), matches[0];
   }
 }
-const globalTransformRegistry = new TransformRegistry(), callGPT5 = async (apiKey, request) => (request.model || "gpt-5") === "gpt-5" ? await callGPT5ResponsesAPI(apiKey, request) : await callChatCompletionsAPI(apiKey, request), callGPT5ResponsesAPI = async (apiKey, request) => {
+const globalTransformRegistry = new TransformRegistry(), callGPT5 = async (apiKey, request) => (request.model || "gpt-5").startsWith("gpt-5") ? await callGPT5ResponsesAPI(apiKey, request) : await callChatCompletionsAPI(apiKey, request), callGPT5ResponsesAPI = async (apiKey, request) => {
   const model = request.model || "gpt-5", requestBody = {
-    model: "gpt-5.1",
+    model: model === "gpt-5" ? "gpt-5.1" : model,
+    // Map gpt-5 to gpt-5.1, use others as-is
     input: request.messages
     // Uses 'input' instead of 'messages'
   };
@@ -1951,9 +2054,29 @@ const globalTransformRegistry = new TransformRegistry(), callGPT5 = async (apiKe
 }, calculateCost = (tokens, model) => {
   const pricing = {
     "gpt-5": {
-      input: 2e-6,
-      output: 1e-5,
-      reasoning: 5e-6
+      input: 125e-5,
+      output: 0.01,
+      reasoning: 0
+    },
+    "gpt-5.1": {
+      input: 125e-5,
+      output: 0.01,
+      reasoning: 0
+    },
+    "gpt-5-mini": {
+      input: 25e-5,
+      output: 2e-3,
+      reasoning: 0
+    },
+    "gpt-5-nano": {
+      input: 5e-5,
+      output: 4e-4,
+      reasoning: 0
+    },
+    "gpt-5-pro": {
+      input: 0.015,
+      output: 0.12,
+      reasoning: 0
     },
     "gpt-4o": {
       input: 5e-6,
@@ -1987,7 +2110,7 @@ const globalTransformRegistry = new TransformRegistry(), callGPT5 = async (apiKe
         type: "field",
         name: fieldName,
         text: unescapeXml(text2),
-        attributes: {},
+        attributes: { type: "string" },
         children: []
       };
       if (stack.length > 0) {
@@ -2060,7 +2183,13 @@ const globalTransformRegistry = new TransformRegistry(), callGPT5 = async (apiKe
           parent && parent.children.push(node);
         } else
           root.push(node);
-      } else
+      } else if (attributes.type === "string" && content && content.includes(closingTag))
+        if (node.text = unescapeXml(content.replace(closingTag, "")), stack.length > 0) {
+          const parent = stack[stack.length - 1];
+          parent && parent.children.push(node);
+        } else
+          root.push(node);
+      else
         stack.push(node);
       continue;
     }
@@ -2192,7 +2321,7 @@ const globalTransformRegistry = new TransformRegistry(), callGPT5 = async (apiKe
       return;
     }
     if (typeof value == "string") {
-      value.length > 0 && lines.push(`${fieldName}: ${escapeXml(value)}`);
+      value.length > 0 && lines.push(`${indentStr}<field name="${fieldName}" type="string">${escapeXml(value)}</field>`);
       return;
     }
     (typeof value == "number" || typeof value == "boolean") && lines.push(`${indentStr}<field name="${fieldName}" type="${typeof value}" readonly="true">${value}</field>`);
@@ -2229,7 +2358,7 @@ const globalTransformRegistry = new TransformRegistry(), callGPT5 = async (apiKe
     return;
   }
   if (typeof value == "string" && value.length > 0) {
-    lines.push(`${indentStr}<field name="${fieldName}">${escapeXml(value)}</field>`);
+    lines.push(`${indentStr}<field name="${fieldName}" type="string">${escapeXml(value)}</field>`);
     return;
   }
   (typeof value == "number" || typeof value == "boolean") && lines.push(`${indentStr}<field name="${fieldName}" type="${typeof value}" readonly="true">${value}</field>`);
@@ -2371,7 +2500,19 @@ const globalTransformRegistry = new TransformRegistry(), callGPT5 = async (apiKe
           `Structure validation failed: ${unexpectedErrors.length} errors. First: ${unexpectedErrors[0].type} at ${unexpectedErrors[0].path.join(".")}`
         );
     }
-    return setJobStatus(dispatch, sourceDocument._id, targetLanguage, "translating_with_openai", {
+    const translationValidation = validateTranslationCompleteness(sourceDocument, result, languageFieldName);
+    return translationValidation.valid || (devLog.warn("Translation completeness warning", {
+      ...logContext,
+      skippedFields: translationValidation.skippedFields,
+      warning: "GPT-5 may have skipped some important fields"
+    }), devLog.info("Skipped field details", {
+      ...logContext,
+      skippedFields: translationValidation.skippedFields.map((field) => ({
+        path: field.path,
+        originalValue: field.originalValue,
+        translatedValue: field.translatedValue
+      }))
+    })), setJobStatus(dispatch, sourceDocument._id, targetLanguage, "translating_with_openai", {
       tokensUsed: response.tokensUsed.total,
       estimatedCost: response.cost
     }), result;
@@ -2412,12 +2553,19 @@ ${sourceText}
 
 ## Instructions
 
-1. Translate all text content into ${targetLanguage}
-2. Follow the guidelines and terminology requirements above
-3. Preserve protected phrases exactly as they appear
-4. Return the document in THE EXACT SAME FORMAT
-5. **CRITICAL**: Only modify text content between tags
-6. Never add, remove, or change any tags, attributes, or structure
+1. **TRANSLATE ALL TEXT FIELDS**: Every field marked with type="string" or containing text must be translated
+2. **DO NOT SKIP SIMPLE FIELDS**: Pay special attention to simple fields like "title", "name", "description" - these are often the most important
+3. Follow the guidelines and terminology requirements above
+4. Preserve protected phrases exactly as they appear
+5. Return the document in THE EXACT SAME FORMAT
+6. **CRITICAL**: Only modify text content between tags
+7. Never add, remove, or change any tags, attributes, or structure
+
+**Common fields that must always be translated:**
+- title, name, heading, label
+- description, caption, alt text
+- All text within <field> tags
+- All text within <span> tags
 
 If you used significant reasoning to make translation decisions, you may include a brief summary:
 <reasoning>
@@ -2425,6 +2573,43 @@ Brief summary of key translation decisions and reasoning
 </reasoning>
 
 Then return the translated document:`;
+}, validateTranslationCompleteness = (sourceDoc, translatedDoc, languageFieldName) => {
+  const skippedFields = [], checkField = (source, translated, path = []) => {
+    if (path.length > 0) {
+      const fieldName = path[path.length - 1];
+      if (fieldName.startsWith("_") || fieldName === languageFieldName)
+        return;
+    }
+    if (typeof source == "string" && typeof translated == "string") {
+      if (source.length > 0 && source === translated) {
+        const fieldName = path[path.length - 1] || "unknown";
+        (["title", "name", "heading", "label", "description", "caption", "alt"].includes(
+          fieldName
+        ) || source.length > 10) && skippedFields.push({
+          path: path.join("."),
+          originalValue: source,
+          translatedValue: translated
+        });
+      }
+      return;
+    }
+    if (source && translated && typeof source == "object" && typeof translated == "object") {
+      if (Array.isArray(source) && Array.isArray(translated)) {
+        const maxLength = Math.min(source.length, translated.length);
+        for (let i = 0; i < maxLength; i++)
+          checkField(source[i], translated[i], [...path, String(i)]);
+      } else if (!Array.isArray(source) && !Array.isArray(translated))
+        for (const key of Object.keys(source))
+          !key.startsWith("_") && key !== languageFieldName && checkField(source[key], translated[key], [
+            ...path,
+            key
+          ]);
+    }
+  };
+  return checkField(sourceDoc, translatedDoc), {
+    valid: skippedFields.length === 0,
+    skippedFields
+  };
 }, assembleLanguageSpecs = ({
   sourceDocument,
   languageFieldName,
@@ -2643,23 +2828,50 @@ ${protectedPhrases.join(", ")}`, buildStyleGuideSection = (globalPrompt, localeP
       });
       return;
     }
-    const existingTranslationId = getExistingTranslationId(translationMetadata, targetLanguage), newDocument = await handleTranslation({
-      dispatch,
-      client,
-      schemaId,
-      sourceDocument,
-      targetLanguage,
-      existingTranslationId,
-      languageFieldName,
-      translationPrompts,
-      translationMode,
-      openaiConfig,
-      releaseId
-    });
-    if (!newDocument) {
-      setJobStatus(dispatch, sourceDocument._id, targetLanguage, "error"), devLog.timeEnd("translateDocument"), devLog.groupEnd();
+    const existingTranslationId = getExistingTranslationId(translationMetadata, targetLanguage), translationResult = await withRetry(
+      () => handleTranslation({
+        dispatch,
+        client,
+        schemaId,
+        sourceDocument,
+        targetLanguage,
+        existingTranslationId,
+        languageFieldName,
+        translationPrompts,
+        translationMode,
+        openaiConfig,
+        releaseId
+      }),
+      {
+        maxRetries: 3,
+        initialDelayMs: 1e3,
+        isRetryable: isRetryableError,
+        onRetry: (attempt, error, delayMs) => {
+          devLog.warn("Translation failed, scheduling retry", {
+            ...logContext,
+            attempt,
+            delayMs,
+            error: error instanceof Error ? error.message : String(error)
+          }), setJobStatus(dispatch, sourceDocument._id, targetLanguage, "retrying", {
+            retryCount: attempt,
+            errorMessage: error instanceof Error ? error.message : String(error)
+          });
+        }
+      }
+    );
+    if (!translationResult.success || !translationResult.result) {
+      const errorMessage = translationResult.error instanceof Error ? translationResult.error.message : String(translationResult.error || "Translation failed");
+      devLog.error("Translation failed after retries", translationResult.error, {
+        ...logContext,
+        attempts: translationResult.attempts
+      }), setJobStatus(dispatch, sourceDocument._id, targetLanguage, "error", {
+        errorMessage,
+        retryCount: translationResult.attempts - 1
+        // -1 because attempts includes initial try
+      }), devLog.timeEnd("translateDocument"), devLog.groupEnd();
       return;
     }
+    const newDocument = translationResult.result;
     return setJobStatus(dispatch, sourceDocument._id, targetLanguage, "updating_metadata", {
       targetId: newDocument._id
     }), await updateTranslationMetadata({
@@ -3239,12 +3451,17 @@ ${protectedPhrases.join(", ")}`, buildStyleGuideSection = (globalPrompt, localeP
             job.status === "error" && job.errorMessage ? /* @__PURE__ */ jsx(Card, { tone: "critical", padding: 2, radius: 2, children: /* @__PURE__ */ jsxs(Text, { size: 1, children: [
               "Error: ",
               job.errorMessage
+            ] }) }) : null,
+            job.status === "retrying" && job.errorMessage ? /* @__PURE__ */ jsx(Card, { tone: "caution", padding: 2, radius: 2, children: /* @__PURE__ */ jsxs(Text, { size: 1, children: [
+              "Retrying after: ",
+              job.errorMessage
             ] }) }) : null
           ] })
         ] }),
         /* @__PURE__ */ jsxs(Flex, { gap: 2, align: "center", children: [
           job.status === "skipped" ? /* @__PURE__ */ jsx(SkippedBadge, {}) : null,
-          job.status === "error" ? /* @__PURE__ */ jsx(ErrorBadge, {}) : null,
+          job.status === "error" ? /* @__PURE__ */ jsx(ErrorBadge, { retryCount: job.retryCount }) : null,
+          job.status === "retrying" ? /* @__PURE__ */ jsx(RetryingBadge, { retryCount: job.retryCount }) : null,
           job.targetId ? /* @__PURE__ */ jsx(
             TranslationOpenerButton,
             {
@@ -3324,12 +3541,25 @@ ${protectedPhrases.join(", ")}`, buildStyleGuideSection = (globalPrompt, localeP
     content: /* @__PURE__ */ jsx(Box, { padding: 1, children: /* @__PURE__ */ jsx(Text, { size: 1, muted: !0, children: "There was already a fresh translation for this document and language." }) }),
     children: /* @__PURE__ */ jsx(Badge, { tone: "neutral", children: "Skipped" })
   }
-), ErrorBadge = () => /* @__PURE__ */ jsx(
+), ErrorBadge = ({ retryCount }) => /* @__PURE__ */ jsx(
+  Tooltip,
+  {
+    portal: !0,
+    content: /* @__PURE__ */ jsx(Box, { padding: 1, children: /* @__PURE__ */ jsx(Text, { size: 1, muted: !0, children: retryCount && retryCount > 0 ? `This translation failed after ${retryCount} retry attempt${retryCount > 1 ? "s" : ""}.` : "This translation failed. Check the error message for details." }) }),
+    children: /* @__PURE__ */ jsxs(Badge, { tone: "critical", children: [
+      "Failed",
+      retryCount && retryCount > 0 ? ` (${retryCount} retries)` : ""
+    ] })
+  }
+), RetryingBadge = ({ retryCount }) => /* @__PURE__ */ jsx(
   Tooltip,
   {
     portal: !0,
-    content: /* @__PURE__ */ jsx(Box, { padding: 1, children: /* @__PURE__ */ jsx(Text, { size: 1, muted: !0, children: "This translation failed. Check the error message for details." }) }),
-    children: /* @__PURE__ */ jsx(Badge, { tone: "critical", children: "Failed" })
+    content: /* @__PURE__ */ jsx(Box, { padding: 1, children: /* @__PURE__ */ jsx(Text, { size: 1, muted: !0, children: "Retrying translation after a temporary failure." }) }),
+    children: /* @__PURE__ */ jsxs(Badge, { tone: "caution", children: [
+      "Retry ",
+      retryCount || 1
+    ] })
   }
 ), getStatusLabel = (status) => ({
   idle: "Idle",
@@ -3339,6 +3569,7 @@ ${protectedPhrases.join(", ")}`, buildStyleGuideSection = (globalPrompt, localeP
   translating_with_openai: "Translating with GPT-5...",
   reviewing_with_openai: "Reviewing translation with GPT-5...",
   updating_metadata: "Saving metadata...",
+  retrying: "Retrying...",
   error: "Error",
   skipped: "Skipped",
   completed: "Completed"