gt-sanity 2.0.7 → 2.0.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gt-sanity",
-  "version": "2.0.7",
+  "version": "2.0.8",
   "description": "General Translation integration with Sanity",
   "keywords": [
     "sanity",
@@ -52,7 +52,7 @@
     "jsonpointer": "^5.0.1",
     "@sanity/document-internationalization": "^6.0.6",
     "lodash.merge": "^4.6.2",
-    "generaltranslation": "8.2.6"
+    "generaltranslation": "8.2.7"
   },
   "devDependencies": {
     "@portabletext/types": "^2.0.15",

package/src/adapter/core.ts

@@ -3,6 +3,7 @@ import { libraryDefaultLocale } from 'generaltranslation/internal';
 import type { Secrets } from '../types';
 import type {
   TranslateDocumentFilter,
+  DedupeFields,
   IgnoreFields,
   SkipFields,
 } from './types';
@@ -25,6 +26,7 @@ export class GTConfig {
   singletons: string[];
   singletonMapping: (sourceDocumentId: string, locale: string) => string;
   ignoreFields: IgnoreFields[];
+  dedupeFields: DedupeFields[];
   skipFields: SkipFields[];
   translateDocuments: TranslateDocumentFilter[];
   additionalStopTypes: string[];
@@ -41,6 +43,7 @@ export class GTConfig {
     singletons: string[],
     singletonMapping: (sourceDocumentId: string, locale: string) => string,
     ignoreFields: IgnoreFields[],
+    dedupeFields: DedupeFields[],
     skipFields: SkipFields[],
     translateDocuments: TranslateDocumentFilter[],
     additionalStopTypes: string[] = [],
@@ -55,6 +58,7 @@ export class GTConfig {
     this.singletons = singletons;
     this.singletonMapping = singletonMapping;
     this.ignoreFields = ignoreFields;
+    this.dedupeFields = dedupeFields;
     this.skipFields = skipFields;
     this.translateDocuments = translateDocuments;
     this.additionalStopTypes = additionalStopTypes;
@@ -76,6 +80,7 @@ export class GTConfig {
         [],
         [],
         [],
+        [],
         {},
         {},
         []
@@ -92,6 +97,7 @@ export class GTConfig {
     singletons: string[],
     singletonMapping: (sourceDocumentId: string, locale: string) => string,
     ignoreFields: IgnoreFields[],
+    dedupeFields: DedupeFields[],
     skipFields: SkipFields[],
     translateDocuments: TranslateDocumentFilter[],
     additionalStopTypes: string[] = [],
@@ -106,6 +112,7 @@ export class GTConfig {
     this.singletons = singletons;
     this.singletonMapping = singletonMapping;
     this.ignoreFields = ignoreFields;
+    this.dedupeFields = dedupeFields;
     this.skipFields = skipFields;
     this.translateDocuments = translateDocuments;
     this.additionalStopTypes = additionalStopTypes;
@@ -137,6 +144,9 @@ export class GTConfig {
   getIgnoreFields() {
     return this.ignoreFields;
   }
+  getDedupeFields() {
+    return this.dedupeFields;
+  }
   getSkipFields() {
     return this.skipFields;
   }

package/src/adapter/types.ts

@@ -1,12 +1,13 @@
-export type IgnoreFields = {
+export type FieldMatcher = {
   documentId?: string;
   fields?: { property: string; type?: string }[];
 };
 
-export type SkipFields = {
-  documentId?: string;
-  fields?: { property: string; type?: string }[];
-};
+export type IgnoreFields = FieldMatcher;
+
+export type DedupeFields = FieldMatcher;
+
+export type SkipFields = FieldMatcher;
 
 export type TranslateDocumentFilter = {
   documentId?: string;

package/src/configuration/baseDocumentLevelConfig/documentLevelPatch.ts

@@ -99,7 +99,8 @@ export const documentLevelPatch = async (
       baseDoc,
       merged,
       translatedFields,
-      client
+      client,
+      i18nDoc
     );
   }
   //otherwise, create a new document

package/src/configuration/baseDocumentLevelConfig/helpers/createI18nDocAndPatchMetadata.ts

@@ -35,7 +35,9 @@ export async function createI18nDocAndPatchMetadata(
     sourceDocument,
     rest,
     pluginConfig.getIgnoreFields(),
-    pluginConfig.getSkipFields()
+    pluginConfig.getSkipFields(),
+    pluginConfig.getDedupeFields(),
+    localeId
   );
 
   // Check if this is a singleton document and apply singleton mapping

package/src/configuration/baseDocumentLevelConfig/helpers/patchI18nDoc.test.ts

@@ -0,0 +1,52 @@
+import { afterEach, describe, expect, test, vi } from 'vitest';
+import { pluginConfig } from '../../../adapter/core';
+import { patchI18nDoc } from './patchI18nDoc';
+
+describe('patchI18nDoc', () => {
+  afterEach(() => {
+    vi.restoreAllMocks();
+  });
+
+  test('preserves existing translated dedupe fields during re-import', async () => {
+    vi.spyOn(pluginConfig, 'getIgnoreFields').mockReturnValue([]);
+    vi.spyOn(pluginConfig, 'getSkipFields').mockReturnValue([]);
+    vi.spyOn(pluginConfig, 'getDedupeFields').mockReturnValue([
+      { fields: [{ property: '$.slug', type: 'slug' }] },
+    ]);
+
+    const commit = vi.fn().mockResolvedValue({});
+    const patch = vi.fn().mockReturnValue({ commit });
+    const client = { patch } as any;
+
+    await patchI18nDoc(
+      'doc-1',
+      'drafts.doc-1-es',
+      {
+        _id: 'doc-1',
+        _type: 'article',
+        title: 'About',
+        slug: { _type: 'slug', current: 'about' },
+      },
+      {
+        _id: 'doc-1',
+        _type: 'article',
+        title: 'Acerca de',
+      },
+      { title: 'Acerca de' },
+      client,
+      {
+        _id: 'drafts.doc-1-es',
+        _type: 'article',
+        title: 'Acerca de',
+        slug: { _type: 'slug', current: 'custom-spanish-slug' },
+      }
+    );
+
+    expect(patch).toHaveBeenCalledWith('drafts.doc-1-es', {
+      set: expect.objectContaining({
+        title: 'Acerca de',
+        slug: { _type: 'slug', current: 'custom-spanish-slug' },
+      }),
+    });
+  });
+});

package/src/configuration/baseDocumentLevelConfig/helpers/patchI18nDoc.ts

@@ -1,7 +1,12 @@
 // adapted from https://github.com/sanity-io/sanity-translations-tab. See LICENSE.md for more details.
 
 import { SanityClient, SanityDocumentLike } from 'sanity';
-import { applyDocuments } from '../../../utils/applyDocuments';
+import JSONPointer from 'jsonpointer';
+import {
+  applyDocuments,
+  deleteMatchingFields,
+  forEachMatchingField,
+} from '../../../utils/applyDocuments';
 import { pluginConfig } from '../../../adapter/core';
 
 const SYSTEM_FIELDS = ['_id', '_rev', '_updatedAt', 'language'];
@@ -14,7 +19,8 @@ export async function patchI18nDoc(
   sourceDocument: SanityDocumentLike,
   mergedDocument: SanityDocumentLike,
   translatedFields: Record<string, any>,
-  client: SanityClient
+  client: SanityClient,
+  existingDocument?: SanityDocumentLike
 ): Promise<void> {
   const cleanedMerge: Record<string, any> = {};
   Object.entries(mergedDocument).forEach(([key, value]) => {
@@ -43,6 +49,18 @@ export async function patchI18nDoc(
     pluginConfig.getIgnoreFields(),
     pluginConfig.getSkipFields()
   );
+  const dedupeFields = pluginConfig.getDedupeFields();
+  deleteMatchingFields(sourceDocumentId, appliedDocument, dedupeFields);
+  if (existingDocument) {
+    forEachMatchingField(
+      sourceDocumentId,
+      existingDocument,
+      dedupeFields,
+      (result) => {
+        JSONPointer.set(appliedDocument, result.pointer, result.value);
+      }
+    );
+  }
   const newDocument = await client
     .patch(i18nDocId, { set: appliedDocument })
     .commit();

package/src/index.ts

@@ -61,6 +61,7 @@ import { gt, pluginConfig } from './adapter/core';
 import { libraryDefaultLocale } from 'generaltranslation/internal';
 import { getLocaleProperties } from 'generaltranslation';
 import type {
+  DedupeFields,
   IgnoreFields,
   SkipFields,
   TranslateDocumentFilter,
@@ -83,6 +84,7 @@ export type GTPluginConfig = Omit<
   // By default, the translated singleton document is is `${sourceDocumentId}-${locale}`
   singletonMapping?: (sourceDocumentId: string, locale: string) => string;
   ignoreFields?: IgnoreFields[];
+  dedupeFields?: DedupeFields[];
   skipFields?: SkipFields[];
   languageField?: string;
   translateDocuments?: TranslateDocumentFilter[] | string[];
@@ -122,6 +124,7 @@ export const gtPlugin = definePlugin<GTPluginConfig>(
     singletons,
     singletonMapping,
     ignoreFields,
+    dedupeFields,
     skipFields,
     translateDocuments,
     secretsNamespace = SECRETS_NAMESPACE,
@@ -153,6 +156,7 @@ export const gtPlugin = definePlugin<GTPluginConfig>(
       singletonMapping ||
         ((sourceDocumentId, locale) => `${sourceDocumentId}-${locale}`),
       ignoreFields || [],
+      dedupeFields || [],
       skipFields || [],
       normalizedTranslateDocuments || [],
       additionalStopTypes,

package/src/utils/__tests__/forEachMatchingField.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, test, vi } from 'vitest';
-import { forEachMatchingField } from '../applyDocuments';
+import { applyDocuments, forEachMatchingField } from '../applyDocuments';
 import type { IgnoreFields } from '../../adapter/types';
 
 describe('forEachMatchingField', () => {
@@ -169,3 +169,73 @@ describe('forEachMatchingField', () => {
     expect(cb.mock.calls[0][0].pointer).toBe('/metadata/seo/title');
   });
 });
+
+describe('applyDocuments dedupe fields', () => {
+  test('restores slug fields with a locale suffix', () => {
+    const sourceDoc = {
+      _id: 'doc-1',
+      title: 'Hello',
+      slug: { _type: 'slug', current: 'hello-world' },
+    };
+    const translatedDoc = {
+      _id: 'doc-1-es',
+      title: 'Hola',
+    };
+
+    const result = applyDocuments(
+      'doc-1',
+      sourceDoc,
+      translatedDoc,
+      [],
+      [],
+      [{ fields: [{ property: '$.slug' }] }],
+      'es'
+    );
+
+    expect(result).toEqual({
+      _id: 'doc-1-es',
+      title: 'Hola',
+      slug: { _type: 'slug', current: 'hello-world-es' },
+    });
+  });
+
+  test('dedupes string fields directly when the JSONPath targets a string', () => {
+    const sourceDoc = {
+      _id: 'doc-1',
+      title: 'Hello',
+      slug: { _type: 'slug', current: 'hello-world' },
+    };
+
+    const result = applyDocuments(
+      'doc-1',
+      sourceDoc,
+      { title: 'Bonjour' },
+      [],
+      [],
+      [{ fields: [{ property: '$.slug.current' }] }],
+      'fr-CA'
+    );
+
+    expect(result.slug.current).toBe('hello-world-fr-ca');
+  });
+
+  test('does not append the same locale suffix twice', () => {
+    const sourceDoc = {
+      _id: 'doc-1',
+      title: 'Hello',
+      slug: { _type: 'slug', current: 'hello-world-fr' },
+    };
+
+    const result = applyDocuments(
+      'doc-1',
+      sourceDoc,
+      { title: 'Bonjour' },
+      [],
+      [],
+      [{ fields: [{ property: '$.slug' }] }],
+      'fr'
+    );
+
+    expect(result.slug.current).toBe('hello-world-fr');
+  });
+});

package/src/utils/applyDocuments.ts

@@ -1,11 +1,11 @@
 import { JSONPath } from 'jsonpath-plus';
 import JSONPointer from 'jsonpointer';
-import type { IgnoreFields, SkipFields } from '../adapter/types';
+import type { DedupeFields, FieldMatcher, SkipFields } from '../adapter/types';
 
 export function forEachMatchingField(
   documentId: string,
   document: Record<string, any>,
-  fields: IgnoreFields[],
+  fields: FieldMatcher[],
   callback: (result: {
     pointer: string;
     value: any;
@@ -67,7 +67,7 @@ export function forEachMatchingField(
 export function deleteMatchingFields(
   documentId: string,
   document: Record<string, any>,
-  fields: IgnoreFields[]
+  fields: FieldMatcher[]
 ): void {
   const arrayRemovals: Array<{ parent: any[]; index: number }> = [];
 
@@ -93,8 +93,10 @@ export function applyDocuments(
   documentId: string,
   sourceDocument: Record<string, any>,
   targetDocument: Record<string, any>,
-  ignore: IgnoreFields[],
-  skip: SkipFields[] = []
+  ignore: FieldMatcher[],
+  skip: SkipFields[] = [],
+  dedupe: DedupeFields[] = [],
+  localeId?: string
 ) {
   // Deep copy both documents so mutations (e.g. skip-field deletions) never affect the originals
   const mergedDocument = JSON.parse(JSON.stringify(sourceDocument));
@@ -110,8 +112,57 @@ export function applyDocuments(
     JSONPointer.set(mergedDocument, result.pointer, result.value);
   });
 
+  // Restore de-duped fields from the source document with a deterministic locale suffix.
+  forEachMatchingField(documentId, sourceDocument, dedupe, (result) => {
+    JSONPointer.set(
+      mergedDocument,
+      result.pointer,
+      dedupeFieldValue(result.value, localeId)
+    );
+  });
+
   // Remove skip fields from merged document
   deleteMatchingFields(documentId, mergedDocument, skip);
 
   return mergedDocument;
 }
+
+function dedupeFieldValue(value: any, localeId?: string): any {
+  if (!localeId) return value;
+
+  if (typeof value === 'string') {
+    return appendLocaleSuffix(value, localeId);
+  }
+
+  if (
+    value &&
+    typeof value === 'object' &&
+    !Array.isArray(value) &&
+    typeof value.current === 'string'
+  ) {
+    return {
+      ...value,
+      current: appendLocaleSuffix(value.current, localeId),
+    };
+  }
+
+  return value;
+}
+
+function appendLocaleSuffix(value: string, localeId: string): string {
+  if (!value) return value;
+
+  const suffix = createLocaleSuffix(localeId);
+  if (!suffix || value.endsWith(suffix)) return value;
+
+  return `${value}${suffix}`;
+}
+
+function createLocaleSuffix(localeId: string): string {
+  const normalized = localeId
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, '-')
+    .replace(/^-|-$/g, '');
+
+  return normalized ? `-${normalized}` : '';
+}

package/src/utils/serialize.ts

@@ -10,7 +10,7 @@ import { PortableTextHtmlComponents } from '@portabletext/to-html';
 import { pluginConfig } from '../adapter/core';
 import merge from 'lodash.merge';
 import { deleteMatchingFields } from './applyDocuments';
-import type { IgnoreFields } from '../adapter/types';
+import type { FieldMatcher } from '../adapter/types';
 
 export function deserializeDocument(document: string) {
   const deserializers = merge(
@@ -45,7 +45,8 @@ export function serializeDocument(
 
   const docToSerialize = stripIgnoredFields(
     document,
-    pluginConfig.getIgnoreFields()
+    pluginConfig.getIgnoreFields(),
+    pluginConfig.getDedupeFields()
   );
 
   const serialized = BaseDocumentSerializer(schema).serializeDocument(
@@ -60,16 +61,18 @@ export function serializeDocument(
 
 function stripIgnoredFields(
   document: SanityDocument,
-  ignoreFields: IgnoreFields[]
+  ignoreFields: FieldMatcher[],
+  dedupeFields: FieldMatcher[]
 ): SanityDocument {
-  if (ignoreFields.length === 0) return document;
+  const fieldsToStrip = [...ignoreFields, ...dedupeFields];
+  if (fieldsToStrip.length === 0) return document;
 
   const strippedDoc = JSON.parse(JSON.stringify(document)) as SanityDocument;
 
   deleteMatchingFields(
     document._id.replace('drafts.', ''),
     strippedDoc,
-    ignoreFields
+    fieldsToStrip
   );
 
   return strippedDoc;