gt-sanity 2.0.7 → 2.0.8

package/README.md

@@ -32,6 +32,9 @@ export default defineConfig({
     gtPlugin({
       sourceLocale: 'en',
       locales: ['es', 'fr'],
+      // Initialize translated document slugs with a unique locale suffix,
+      // e.g. "hello-world" -> "hello-world-es".
+      dedupeFields: [{ fields: [{ property: '$.slug' }] }],
     }),
   ],
 });

package/dist/index.d.mts

@@ -86,6 +86,8 @@ export declare const BaseDocumentSerializer: (schemas: Schema) => {
 
 export declare const customSerializers: Partial<PortableTextHtmlComponents>;
 
+declare type DedupeFields = FieldMatcher;
+
 export declare const defaultStopTypes: string[];
 
 declare interface Deserializer {
@@ -117,6 +119,14 @@ export declare type ExportForTranslation = (
   context: TranslationFunctionContext
 ) => Promise<GTSerializedDocument>;
 
+declare type FieldMatcher = {
+  documentId?: string;
+  fields?: {
+    property: string;
+    type?: string;
+  }[];
+};
+
 export declare const findLatestDraft: (
   documentId: string,
   client: SanityClient
@@ -153,6 +163,7 @@ export declare type GTPluginConfig = Omit<
   singletons?: string[];
   singletonMapping?: (sourceDocumentId: string, locale: string) => string;
   ignoreFields?: IgnoreFields[];
+  dedupeFields?: DedupeFields[];
   skipFields?: SkipFields[];
   languageField?: string;
   translateDocuments?: TranslateDocumentFilter[] | string[];
@@ -166,13 +177,7 @@ export declare type GTPluginConfig = Omit<
 
 declare type GTSerializedDocument = Omit<SerializedDocument, 'name'> & GTFile;
 
-declare type IgnoreFields = {
-  documentId?: string;
-  fields?: {
-    property: string;
-    type?: string;
-  }[];
-};
+declare type IgnoreFields = FieldMatcher;
 
 export declare type ImportTranslation = (
   documentInfo: GTFile,
@@ -220,13 +225,7 @@ export declare type SerializedDocument = {
   content: string;
 };
 
-declare type SkipFields = {
-  documentId?: string;
-  fields?: {
-    property: string;
-    type?: string;
-  }[];
-};
+declare type SkipFields = FieldMatcher;
 
 export declare const translateAction: DocumentActionComponent;
 

package/dist/index.d.ts

@@ -86,6 +86,8 @@ export declare const BaseDocumentSerializer: (schemas: Schema) => {
 
 export declare const customSerializers: Partial<PortableTextHtmlComponents>;
 
+declare type DedupeFields = FieldMatcher;
+
 export declare const defaultStopTypes: string[];
 
 declare interface Deserializer {
@@ -117,6 +119,14 @@ export declare type ExportForTranslation = (
   context: TranslationFunctionContext
 ) => Promise<GTSerializedDocument>;
 
+declare type FieldMatcher = {
+  documentId?: string;
+  fields?: {
+    property: string;
+    type?: string;
+  }[];
+};
+
 export declare const findLatestDraft: (
   documentId: string,
   client: SanityClient
@@ -153,6 +163,7 @@ export declare type GTPluginConfig = Omit<
   singletons?: string[];
   singletonMapping?: (sourceDocumentId: string, locale: string) => string;
   ignoreFields?: IgnoreFields[];
+  dedupeFields?: DedupeFields[];
   skipFields?: SkipFields[];
   languageField?: string;
   translateDocuments?: TranslateDocumentFilter[] | string[];
@@ -166,13 +177,7 @@ export declare type GTPluginConfig = Omit<
 
 declare type GTSerializedDocument = Omit<SerializedDocument, 'name'> & GTFile;
 
-declare type IgnoreFields = {
-  documentId?: string;
-  fields?: {
-    property: string;
-    type?: string;
-  }[];
-};
+declare type IgnoreFields = FieldMatcher;
 
 export declare type ImportTranslation = (
   documentInfo: GTFile,
@@ -220,13 +225,7 @@ export declare type SerializedDocument = {
   content: string;
 };
 
-declare type SkipFields = {
-  documentId?: string;
-  fields?: {
-    property: string;
-    type?: string;
-  }[];
-};
+declare type SkipFields = FieldMatcher;
 
 export declare const translateAction: DocumentActionComponent;
 

package/dist/index.js

@@ -35,6 +35,7 @@ class GTConfig {
   singletons;
   singletonMapping;
   ignoreFields;
+  dedupeFields;
   skipFields;
   translateDocuments;
   additionalStopTypes;
@@ -42,8 +43,8 @@ class GTConfig {
   additionalDeserializers;
   additionalBlockDeserializers;
   static instance;
-  constructor(secretsNamespace, languageField, sourceLocale, locales, singletons, singletonMapping, ignoreFields, skipFields, translateDocuments, additionalStopTypes = [], additionalSerializers = {}, additionalDeserializers = {}, additionalBlockDeserializers = []) {
-    this.secretsNamespace = secretsNamespace, this.languageField = languageField, this.sourceLocale = sourceLocale, this.locales = locales, this.singletons = singletons, this.singletonMapping = singletonMapping, this.ignoreFields = ignoreFields, this.skipFields = skipFields, this.translateDocuments = translateDocuments, this.additionalStopTypes = additionalStopTypes, this.additionalSerializers = additionalSerializers, this.additionalDeserializers = additionalDeserializers, this.additionalBlockDeserializers = additionalBlockDeserializers;
+  constructor(secretsNamespace, languageField, sourceLocale, locales, singletons, singletonMapping, ignoreFields, dedupeFields, skipFields, translateDocuments, additionalStopTypes = [], additionalSerializers = {}, additionalDeserializers = {}, additionalBlockDeserializers = []) {
+    this.secretsNamespace = secretsNamespace, this.languageField = languageField, this.sourceLocale = sourceLocale, this.locales = locales, this.singletons = singletons, this.singletonMapping = singletonMapping, this.ignoreFields = ignoreFields, this.dedupeFields = dedupeFields, this.skipFields = skipFields, this.translateDocuments = translateDocuments, this.additionalStopTypes = additionalStopTypes, this.additionalSerializers = additionalSerializers, this.additionalDeserializers = additionalDeserializers, this.additionalBlockDeserializers = additionalBlockDeserializers;
   }
   static getInstance() {
     return this.instance || (this.instance = new GTConfig(
@@ -57,13 +58,14 @@ class GTConfig {
       [],
       [],
       [],
+      [],
       {},
       {},
       []
     )), this.instance;
   }
-  init(secretsNamespace, languageField, sourceLocale, locales, singletons, singletonMapping, ignoreFields, skipFields, translateDocuments, additionalStopTypes = [], additionalSerializers = {}, additionalDeserializers = {}, additionalBlockDeserializers = []) {
-    this.secretsNamespace = secretsNamespace, this.languageField = languageField, this.sourceLocale = sourceLocale, this.locales = locales, this.singletons = singletons, this.singletonMapping = singletonMapping, this.ignoreFields = ignoreFields, this.skipFields = skipFields, this.translateDocuments = translateDocuments, this.additionalStopTypes = additionalStopTypes, this.additionalSerializers = additionalSerializers, this.additionalDeserializers = additionalDeserializers, this.additionalBlockDeserializers = additionalBlockDeserializers;
+  init(secretsNamespace, languageField, sourceLocale, locales, singletons, singletonMapping, ignoreFields, dedupeFields, skipFields, translateDocuments, additionalStopTypes = [], additionalSerializers = {}, additionalDeserializers = {}, additionalBlockDeserializers = []) {
+    this.secretsNamespace = secretsNamespace, this.languageField = languageField, this.sourceLocale = sourceLocale, this.locales = locales, this.singletons = singletons, this.singletonMapping = singletonMapping, this.ignoreFields = ignoreFields, this.dedupeFields = dedupeFields, this.skipFields = skipFields, this.translateDocuments = translateDocuments, this.additionalStopTypes = additionalStopTypes, this.additionalSerializers = additionalSerializers, this.additionalDeserializers = additionalDeserializers, this.additionalBlockDeserializers = additionalBlockDeserializers;
   }
   getSecretsNamespace() {
     return this.secretsNamespace;
@@ -86,6 +88,9 @@ class GTConfig {
   getIgnoreFields() {
     return this.ignoreFields;
   }
+  getDedupeFields() {
+    return this.dedupeFields;
+  }
   getSkipFields() {
     return this.skipFields;
   }
@@ -629,14 +634,35 @@ function deleteMatchingFields(documentId, document2, fields) {
   for (const { parent, index } of arrayRemovals)
     parent.splice(index, 1);
 }
-function applyDocuments(documentId, sourceDocument, targetDocument, ignore, skip = []) {
+function applyDocuments(documentId, sourceDocument, targetDocument, ignore, skip = [], dedupe = [], localeId) {
   const mergedDocument = JSON.parse(JSON.stringify(sourceDocument)), clonedTarget = JSON.parse(JSON.stringify(targetDocument));
   for (const [key, value] of Object.entries(clonedTarget))
     mergedDocument[key] = value;
   return forEachMatchingField(documentId, sourceDocument, ignore, (result) => {
     JSONPointer__default.default.set(mergedDocument, result.pointer, result.value);
+  }), forEachMatchingField(documentId, sourceDocument, dedupe, (result) => {
+    JSONPointer__default.default.set(
+      mergedDocument,
+      result.pointer,
+      dedupeFieldValue(result.value, localeId)
+    );
   }), deleteMatchingFields(documentId, mergedDocument, skip), mergedDocument;
 }
+function dedupeFieldValue(value, localeId) {
+  return localeId ? typeof value == "string" ? appendLocaleSuffix(value, localeId) : value && typeof value == "object" && !Array.isArray(value) && typeof value.current == "string" ? {
+    ...value,
+    current: appendLocaleSuffix(value.current, localeId)
+  } : value : value;
+}
+function appendLocaleSuffix(value, localeId) {
+  if (!value) return value;
+  const suffix = createLocaleSuffix(localeId);
+  return !suffix || value.endsWith(suffix) ? value : `${value}${suffix}`;
+}
+function createLocaleSuffix(localeId) {
+  const normalized = localeId.toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-|-$/g, "");
+  return normalized ? `-${normalized}` : "";
+}
 function deserializeDocument(document2) {
   const deserializers = merge__default.default(
     { types: {} },
@@ -660,7 +686,8 @@ function serializeDocument(document2, schema2, baseLanguage) {
     pluginConfig.getAdditionalSerializers()
   ), docToSerialize = stripIgnoredFields(
     document2,
-    pluginConfig.getIgnoreFields()
+    pluginConfig.getIgnoreFields(),
+    pluginConfig.getDedupeFields()
   );
   return BaseDocumentSerializer(schema2).serializeDocument(
     docToSerialize,
@@ -670,13 +697,14 @@ function serializeDocument(document2, schema2, baseLanguage) {
     serializers
   );
 }
-function stripIgnoredFields(document2, ignoreFields) {
-  if (ignoreFields.length === 0) return document2;
+function stripIgnoredFields(document2, ignoreFields, dedupeFields) {
+  const fieldsToStrip = [...ignoreFields, ...dedupeFields];
+  if (fieldsToStrip.length === 0) return document2;
   const strippedDoc = JSON.parse(JSON.stringify(document2));
   return deleteMatchingFields(
     document2._id.replace("drafts.", ""),
     strippedDoc,
-    ignoreFields
+    fieldsToStrip
   ), strippedDoc;
 }
 async function uploadFiles(documents, secrets) {
@@ -788,7 +816,9 @@ async function createI18nDocAndPatchMetadata(sourceDocument, translatedDoc, loca
     sourceDocument,
     rest,
     pluginConfig.getIgnoreFields(),
-    pluginConfig.getSkipFields()
+    pluginConfig.getSkipFields(),
+    pluginConfig.getDedupeFields(),
+    localeId
   ), isSingleton = pluginConfig.getSingletons().includes(sourceDocumentId);
   let createDocumentPromise;
   if (isSingleton) {
@@ -871,7 +901,7 @@ const getOrCreateTranslationMetadata = async (documentId, baseDocument, client,
     throw error;
   }
 }, SYSTEM_FIELDS = ["_id", "_rev", "_updatedAt", "language"], isSystemField = (field) => SYSTEM_FIELDS.includes(field);
-async function patchI18nDoc(sourceDocumentId, i18nDocId, sourceDocument, mergedDocument, translatedFields, client) {
+async function patchI18nDoc(sourceDocumentId, i18nDocId, sourceDocument, mergedDocument, translatedFields, client, existingDocument) {
   const cleanedMerge = {};
   Object.entries(mergedDocument).forEach(([key, value]) => {
     key in translatedFields && //don't overwrite any existing system values on the i18n doc
@@ -887,8 +917,15 @@ async function patchI18nDoc(sourceDocumentId, i18nDocId, sourceDocument, mergedD
     cleanedMerge,
     pluginConfig.getIgnoreFields(),
     pluginConfig.getSkipFields()
-  );
-  await client.patch(i18nDocId, { set: appliedDocument }).commit();
+  ), dedupeFields = pluginConfig.getDedupeFields();
+  deleteMatchingFields(sourceDocumentId, appliedDocument, dedupeFields), existingDocument && forEachMatchingField(
+    sourceDocumentId,
+    existingDocument,
+    dedupeFields,
+    (result) => {
+      JSONPointer__default.default.set(appliedDocument, result.pointer, result.value);
+    }
+  ), await client.patch(i18nDocId, { set: appliedDocument }).commit();
 }
 const documentLevelPatch = async (docInfo, translatedFields, localeId, client, languageField = "language", mergeWithTargetLocale = !1) => {
   const baseLanguage = pluginConfig.getSourceLocale();
@@ -919,7 +956,8 @@ const documentLevelPatch = async (docInfo, translatedFields, localeId, client, l
     baseDoc,
     merged,
     translatedFields,
-    client
+    client,
+    i18nDoc
   ) : await createI18nDocAndPatchMetadata(
     baseDoc,
     merged,
@@ -3697,6 +3735,7 @@ const WrapText = dt(ui.Box)`
     singletons,
     singletonMapping,
     ignoreFields,
+    dedupeFields,
     skipFields,
     translateDocuments,
     secretsNamespace = SECRETS_NAMESPACE,
@@ -3717,6 +3756,7 @@ const WrapText = dt(ui.Box)`
       // singletons is a string array of singleton document ids
       singletonMapping || ((sourceDocumentId, locale) => `${sourceDocumentId}-${locale}`),
       ignoreFields || [],
+      dedupeFields || [],
       skipFields || [],
       normalizedTranslateDocuments || [],
       additionalStopTypes,