@braze/sanity-plugin-ai-translation 0.2.73 → 0.2.74

package/dist/index.d.ts

@@ -332,6 +332,20 @@ export declare interface PluginConfig {
    * ```
    */
   excludeFields?: string[];
+  /**
+   * Fields to completely remove from the translated document.
+   * Unlike `excludeFields` (which preserves fields with their original values),
+   * `unsetFields` strips matched fields entirely so they are absent from the output.
+   * Supports the same pattern syntax as `excludeFields`: field names (e.g., 'courseId'),
+   * nested paths (e.g., 'meta.internalId'), wildcard arrays (e.g., 'sections[*].legacyId'),
+   * and hierarchical matches (e.g., '**.tmpField').
+   *
+   * @example
+   * ```typescript
+   * unsetFields: ['courseId', 'meta.internalId', 'sections[*].legacyId']
+   * ```
+   */
+  unsetFields?: string[];
   /**
    * Optional telemetry configuration for monitoring translation operations.
    * Provides callbacks for lightweight events and detailed error bundles.

package/dist/index.js

@@ -1360,6 +1360,16 @@ const COMMON_ENUM_FIELDS = [
   /** SEO and URL-related fields that often shouldn't be translated */
   seo: ["slug", "handle", "permalink", "canonical", "redirect", "robots", "sitemap"]
 };
+function unsetDocumentFields(document, unsetFields) {
+  if (!unsetFields.length)
+    return document;
+  const { filteredDocument, excludedValues } = filterExcludedFields(document, unsetFields);
+  return Object.keys(excludedValues).length > 0 && devLog.info("Unset fields from document (permanently removed)", {
+    documentId: document._id || "unknown",
+    unsetFieldCount: Object.keys(excludedValues).length,
+    unsetFields: Object.keys(excludedValues)
+  }), filteredDocument;
+}
 function applyTransforms({
   document,
   registry,
@@ -2630,11 +2640,17 @@ ${protectedPhrases.join(", ")}`, buildStyleGuideSection = (globalPrompt, localeP
   openaiConfig,
   releaseId,
   excludeFields = [],
+  unsetFields = [],
   replaceExisting = !1,
   mainSourceDocumentId,
   telemetryConfig
 }) => {
-  const startTime = Date.now(), sourceLanguage = sourceDocument[languageFieldName], safeExcludeFields = excludeFields.filter((field) => field !== languageFieldName);
+  const startTime = Date.now(), sourceLanguage = sourceDocument[languageFieldName], safeUnsetFields = unsetFields.filter((field) => field !== languageFieldName);
+  unsetFields.length !== safeUnsetFields.length && devLog.warn("Language field was in unsetFields - removing it to prevent translation errors", {
+    documentId: sourceDocument._id,
+    languageFieldName
+  });
+  const documentAfterUnset = unsetDocumentFields(sourceDocument, safeUnsetFields), safeExcludeFields = excludeFields.filter((field) => field !== languageFieldName);
   excludeFields.length !== safeExcludeFields.length && devLog.warn("Language field was in excludeFields - removing it to prevent translation errors", {
     documentId: sourceDocument._id,
     languageFieldName,
@@ -2645,10 +2661,10 @@ ${protectedPhrases.join(", ")}`, buildStyleGuideSection = (globalPrompt, localeP
     documentType: sourceDocument._type,
     excludeFields: safeExcludeFields,
     excludeFieldsLength: safeExcludeFields?.length ?? 0,
-    sourceHasTitle: "title" in sourceDocument,
-    sourceTitleValue: sourceDocument.title
+    sourceHasTitle: "title" in documentAfterUnset,
+    sourceTitleValue: documentAfterUnset.title
   });
-  const { filteredDocument, excludedValues } = filterExcludedFields(sourceDocument, safeExcludeFields);
+  const { filteredDocument, excludedValues } = filterExcludedFields(documentAfterUnset, safeExcludeFields);
   devLog.info("After filtering excluded fields", {
     documentId: sourceDocument._id,
     filteredHasTitle: "title" in filteredDocument,
@@ -2871,6 +2887,7 @@ ${protectedPhrases.join(", ")}`, buildStyleGuideSection = (globalPrompt, localeP
   openaiConfig,
   releaseId,
   excludeFields,
+  unsetFields,
   replaceExisting,
   mainSourceDocumentId,
   telemetryConfig
@@ -2900,6 +2917,7 @@ ${protectedPhrases.join(", ")}`, buildStyleGuideSection = (globalPrompt, localeP
       openaiConfig,
       releaseId,
       excludeFields,
+      unsetFields,
       replaceExisting,
       mainSourceDocumentId,
       telemetryConfig
@@ -3015,6 +3033,7 @@ ${protectedPhrases.join(", ")}`, buildStyleGuideSection = (globalPrompt, localeP
   translationMode,
   openaiConfig,
   excludeFields,
+  unsetFields,
   releaseConfig,
   telemetryConfig
 }) => {
@@ -3135,6 +3154,7 @@ ${protectedPhrases.join(", ")}`, buildStyleGuideSection = (globalPrompt, localeP
                 openaiConfig,
                 releaseId,
                 excludeFields,
+                unsetFields,
                 replaceExisting: releaseConfig.replaceExisting,
                 // Pass main source document ID for active translations tracking
                 mainSourceDocumentId: sourceDocument._id,
@@ -3319,6 +3339,7 @@ ${protectedPhrases.join(", ")}`, buildStyleGuideSection = (globalPrompt, localeP
         translationMode,
         openaiConfig: config.openai,
         excludeFields: config.excludeFields,
+        unsetFields: config.unsetFields,
         releaseConfig: {
           ...releaseConfig,
           replaceExisting,
@@ -3341,6 +3362,7 @@ ${protectedPhrases.join(", ")}`, buildStyleGuideSection = (globalPrompt, localeP
       config.maxReferenceDepth,
       config.openai,
       config.excludeFields,
+      config.unsetFields,
       config.telemetry,
       filteredReferences,
       translationMode,