gt-sanity 0.0.6 → 1.0.0

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

@@ -1,7 +1,7 @@
 // adapted from https://github.com/sanity-io/sanity-translations-tab. See LICENSE.md for more details.
 
 import { SanityClient, SanityDocumentLike } from 'sanity';
-import { gtConfig } from '../../../adapter/core';
+import { pluginConfig } from '../../../adapter/core';
 import { applyDocuments } from '../../../utils/applyDocuments';
 
 export async function createI18nDocAndPatchMetadata(
@@ -11,8 +11,7 @@ export async function createI18nDocAndPatchMetadata(
   client: SanityClient,
   translationMetadata: SanityDocumentLike,
   sourceDocumentId: string,
-  languageField: string = 'language',
-  publish: boolean = false
+  languageField: string = 'language'
 ): Promise<void> {
   translatedDoc[languageField] = localeId;
   const translations = translationMetadata.translations as Record<
@@ -34,16 +33,16 @@ export async function createI18nDocAndPatchMetadata(
     sourceDocumentId,
     sourceDocument,
     rest,
-    gtConfig.getIgnoreFields()
+    pluginConfig.getIgnoreFields()
   );
 
   // Check if this is a singleton document and apply singleton mapping
-  const singletons = gtConfig.getSingletons();
+  const singletons = pluginConfig.getSingletons();
   const isSingleton = singletons.includes(sourceDocumentId);
 
   let createDocumentPromise;
   if (isSingleton) {
-    const singletonMapping = gtConfig.getSingletonMapping();
+    const singletonMapping = pluginConfig.getSingletonMapping();
     const translatedDocId = singletonMapping(sourceDocumentId, localeId);
     createDocumentPromise = client.create({
       ...appliedDocument,
@@ -79,22 +78,4 @@ export async function createI18nDocAndPatchMetadata(
       ])
     )
     .commit();
-
-  if (publish) {
-    try {
-      // only publish if the document is a draft
-      if (doc._id.startsWith('drafts.')) {
-        await client.action(
-          {
-            actionType: 'sanity.action.document.publish',
-            draftId: doc._id,
-            publishedId: doc._id.replace('drafts.', ''),
-          },
-          {}
-        );
-      }
-    } catch (error) {
-      console.error('Error publishing document', error);
-    }
-  }
 }

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

@@ -2,7 +2,7 @@
 
 import { SanityClient, SanityDocumentLike } from 'sanity';
 import { applyDocuments } from '../../../utils/applyDocuments';
-import { gtConfig } from '../../../adapter/core';
+import { pluginConfig } from '../../../adapter/core';
 
 const SYSTEM_FIELDS = ['_id', '_rev', '_updatedAt', 'language'];
 
@@ -14,8 +14,7 @@ export async function patchI18nDoc(
   sourceDocument: SanityDocumentLike,
   mergedDocument: SanityDocumentLike,
   translatedFields: Record<string, any>,
-  client: SanityClient,
-  publish: boolean = false
+  client: SanityClient
 ): Promise<void> {
   const cleanedMerge: Record<string, any> = {};
   Object.entries(mergedDocument).forEach(([key, value]) => {
@@ -37,32 +36,13 @@ export async function patchI18nDoc(
       cleanedSourceDocument[key] = value;
     }
   });
-
   const appliedDocument = applyDocuments(
     sourceDocumentId,
     cleanedSourceDocument,
     cleanedMerge,
-    gtConfig.getIgnoreFields()
+    pluginConfig.getIgnoreFields()
   );
   const newDocument = await client
     .patch(i18nDocId, { set: appliedDocument })
     .commit();
-
-  if (publish) {
-    try {
-      // only publish if the document is a draft
-      if (newDocument._id.startsWith('drafts.')) {
-        await client.action(
-          {
-            actionType: 'sanity.action.document.publish',
-            draftId: newDocument._id,
-            publishedId: newDocument._id.replace('drafts.', ''),
-          },
-          {}
-        );
-      }
-    } catch (error) {
-      console.error('Error publishing document', error);
-    }
-  }
 }

package/src/configuration/baseDocumentLevelConfig/index.ts

@@ -5,50 +5,22 @@ import {
   GTSerializedDocument,
   ImportTranslation,
 } from '../../types';
-import { SanityDocument } from 'sanity';
 import { findLatestDraft } from '../utils/findLatestDraft';
-import { documentLevelPatch } from './documentLevelPatch';
-import {
-  BaseDocumentDeserializer,
-  BaseDocumentSerializer,
-  defaultStopTypes,
-  customSerializers,
-  customBlockDeserializers,
-} from 'sanity-naive-html-serializer';
-import { gtConfig } from '../../adapter/core';
+import { pluginConfig } from '../../adapter/core';
+import { importDocument } from '../../translation/importDocument';
+import { serializeDocument } from '../../utils/serialize';
 
 export const baseDocumentLevelConfig = {
   exportForTranslation: async (
-    ...params: Parameters<ExportForTranslation>
+    docInfo: Parameters<ExportForTranslation>[0],
+    context: Parameters<ExportForTranslation>[1]
   ): Promise<GTSerializedDocument> => {
-    const [
-      docInfo,
-      context,
-      serializationOptions = {},
-      languageField = 'language',
-    ] = params;
     const { client, schema } = context;
-    const stopTypes = [
-      ...(serializationOptions.additionalStopTypes ?? []),
-      ...defaultStopTypes,
-    ];
-    const serializers = {
-      ...customSerializers,
-      types: {
-        ...customSerializers.types,
-        ...(serializationOptions.additionalSerializers ?? {}),
-      },
-    };
+    const languageField = pluginConfig.getLanguageField();
     const doc = await findLatestDraft(docInfo.documentId, client);
     delete doc[languageField];
-    const baseLanguage = gtConfig.getSourceLocale();
-    const serialized = BaseDocumentSerializer(schema).serializeDocument(
-      doc,
-      'document',
-      baseLanguage,
-      stopTypes,
-      serializers
-    );
+    const baseLanguage = pluginConfig.getSourceLocale();
+    const serialized = serializeDocument(doc, schema, baseLanguage);
     return {
       content: serialized.content,
       documentId: docInfo.documentId,
@@ -56,43 +28,19 @@ export const baseDocumentLevelConfig = {
     };
   },
   importTranslation: (
-    ...params: Parameters<ImportTranslation>
+    docInfo: Parameters<ImportTranslation>[0],
+    localeId: Parameters<ImportTranslation>[1],
+    document: Parameters<ImportTranslation>[2],
+    context: Parameters<ImportTranslation>[3],
+    mergeWithTargetLocale: boolean = false
   ): Promise<void> => {
-    const [
+    return importDocument(
       docInfo,
       localeId,
       document,
       context,
-      serializationOptions = {},
-      languageField = 'language',
-      mergeWithTargetLocale = false,
-      publish = false,
-    ] = params;
-    const { client } = context;
-    const deserializers = {
-      types: {
-        ...(serializationOptions.additionalDeserializers ?? {}),
-      },
-    };
-    const blockDeserializers = [
-      ...(serializationOptions.additionalBlockDeserializers ?? []),
-      ...customBlockDeserializers,
-    ];
-
-    const deserialized = BaseDocumentDeserializer.deserializeDocument(
-      document,
-      deserializers,
-      blockDeserializers
-    ) as SanityDocument;
-    return documentLevelPatch(
-      docInfo, // versionId is not used here, since we just use the _rev id in the deserialized HTML itself
-      deserialized,
-      localeId,
-      client,
-      languageField,
-      mergeWithTargetLocale,
-      publish
+      mergeWithTargetLocale
     );
   },
-  secretsNamespace: 'translationService',
+  secretsNamespace: 'generaltranslation',
 };

package/src/configuration/baseFieldLevelConfig.ts

@@ -8,7 +8,7 @@ import {
   defaultStopTypes,
   customSerializers,
   customBlockDeserializers,
-} from 'sanity-naive-html-serializer';
+} from '../serialization/';
 
 import type {
   ExportForTranslation,
@@ -18,7 +18,8 @@ import type {
 } from '../types';
 import { findLatestDraft } from './utils/findLatestDraft';
 import { findDocumentAtRevision } from './utils/findDocumentAtRevision';
-import { gtConfig } from '../adapter/core';
+import { pluginConfig } from '../adapter/core';
+import { deserializeDocument, serializeDocument } from '../utils/serialize';
 
 export const fieldLevelPatch = async (
   docInfo: GTFile,
@@ -28,7 +29,7 @@ export const fieldLevelPatch = async (
   mergeWithTargetLocale: boolean = false
 ): Promise<void> => {
   let baseDoc: SanityDocument;
-  const baseLanguage = gtConfig.getSourceLocale();
+  const baseLanguage = pluginConfig.getSourceLocale();
   if (docInfo.documentId && docInfo.versionId) {
     baseDoc = await findDocumentAtRevision(
       docInfo.documentId,
@@ -51,30 +52,13 @@ export const fieldLevelPatch = async (
 
 export const baseFieldLevelConfig = {
   exportForTranslation: async (
-    ...params: Parameters<ExportForTranslation>
+    docInfo: Parameters<ExportForTranslation>[0],
+    context: Parameters<ExportForTranslation>[1]
   ): Promise<GTSerializedDocument> => {
-    const [docInfo, context, serializationOptions = {}] = params;
-    const baseLanguage = gtConfig.getSourceLocale();
+    const baseLanguage = pluginConfig.getSourceLocale();
     const { client, schema } = context;
-    const stopTypes = [
-      ...(serializationOptions.additionalStopTypes ?? []),
-      ...defaultStopTypes,
-    ];
-    const serializers = {
-      ...customSerializers,
-      types: {
-        ...customSerializers.types,
-        ...(serializationOptions.additionalSerializers ?? {}),
-      },
-    };
     const doc = await findLatestDraft(docInfo.documentId, client);
-    const serialized = BaseDocumentSerializer(schema).serializeDocument(
-      doc,
-      'field',
-      baseLanguage,
-      stopTypes,
-      serializers
-    );
+    const serialized = serializeDocument(doc, schema, baseLanguage);
     return {
       content: serialized.content,
       documentId: docInfo.documentId,
@@ -82,33 +66,14 @@ export const baseFieldLevelConfig = {
     };
   },
   importTranslation: (
-    ...params: Parameters<ImportTranslation>
+    docInfo: Parameters<ImportTranslation>[0],
+    localeId: Parameters<ImportTranslation>[1],
+    document: Parameters<ImportTranslation>[2],
+    context: Parameters<ImportTranslation>[3],
+    mergeWithTargetLocale: boolean = false
   ): Promise<void> => {
-    const [
-      docInfo,
-      localeId,
-      document,
-      context,
-      serializationOptions = {},
-      ,
-      mergeWithTargetLocale,
-    ] = params;
     const { client } = context;
-    const deserializers = {
-      types: {
-        ...(serializationOptions.additionalDeserializers ?? {}),
-      },
-    };
-    const blockDeserializers = [
-      ...(serializationOptions.additionalBlockDeserializers ?? []),
-      ...customBlockDeserializers,
-    ];
-
-    const deserialized = BaseDocumentDeserializer.deserializeDocument(
-      document,
-      deserializers,
-      blockDeserializers
-    ) as SanityDocument;
+    const deserialized = deserializeDocument(document);
     return fieldLevelPatch(
       docInfo,
       deserialized,
@@ -117,5 +82,5 @@ export const baseFieldLevelConfig = {
       mergeWithTargetLocale
     );
   },
-  secretsNamespace: 'translationService',
+  secretsNamespace: 'generaltranslation',
 };

package/src/index.ts

@@ -1,4 +1,4 @@
-import TranslationsTab from './components/TranslationsTab';
+import TranslationsTab from './components/tab/TranslationsTab';
 import {
   Secrets,
   Adapter,
@@ -6,13 +6,8 @@ import {
   ImportTranslation,
   TranslationFunctionContext,
   TranslationsTabConfigOptions,
-  GTFile,
 } from './types';
-import { baseDocumentLevelConfig } from './configuration/baseDocumentLevelConfig';
-import { baseFieldLevelConfig } from './configuration/baseFieldLevelConfig';
 import { findLatestDraft } from './configuration/utils/findLatestDraft';
-import { documentLevelPatch } from './configuration/baseDocumentLevelConfig/documentLevelPatch';
-import { fieldLevelPatch } from './configuration/baseFieldLevelConfig';
 import {
   BaseDocumentSerializer,
   BaseDocumentDeserializer,
@@ -20,7 +15,7 @@ import {
   defaultStopTypes,
   customSerializers,
   SerializedDocument,
-} from 'sanity-naive-html-serializer';
+} from './serialization';
 
 export type {
   Secrets,
@@ -35,53 +30,24 @@ export {
   TranslationsTab,
   //helpers for end developers who may need to customize serialization
   findLatestDraft,
-  documentLevelPatch,
-  fieldLevelPatch,
   BaseDocumentSerializer,
   BaseDocumentDeserializer,
   BaseDocumentMerger,
   defaultStopTypes,
   customSerializers,
+  attachGTData,
+  detachGTData,
 };
 
-import { GTAdapter } from './adapter';
 import { definePlugin } from 'sanity';
 import { route } from 'sanity/router';
-import { gt, gtConfig } from './adapter/core';
-import { GTSerializedDocument } from './types';
+import { gt, pluginConfig } from './adapter/core';
 import { libraryDefaultLocale } from 'generaltranslation/internal';
 import type { IgnoreFields, TranslateDocumentFilter } from './adapter/types';
 import TranslationsTool from './components/page/TranslationsTool';
 import { SECRETS_NAMESPACE } from './utils/shared';
-
-interface ConfigOptions {
-  adapter: Adapter;
-  secretsNamespace: string | null;
-  exportForTranslation: (
-    docInfo: GTFile,
-    context: TranslationFunctionContext
-  ) => Promise<GTSerializedDocument>;
-  importTranslation: (
-    docInfo: GTFile,
-    localeId: string,
-    doc: string,
-    context: TranslationFunctionContext
-  ) => Promise<void>;
-}
-
-export const defaultDocumentLevelConfig: ConfigOptions = {
-  ...baseDocumentLevelConfig,
-  adapter: GTAdapter,
-  secretsNamespace: 'generaltranslation',
-};
-
-export const defaultFieldLevelConfig: ConfigOptions = {
-  ...baseFieldLevelConfig,
-  adapter: GTAdapter,
-  secretsNamespace: 'generaltranslation',
-};
-
-export { GTAdapter };
+import type { PortableTextHtmlComponents } from '@portabletext/to-html';
+import { attachGTData, detachGTData } from './serialization/data';
 
 export type GTPluginConfig = Omit<
   Parameters<typeof gt.setConfig>[0],
@@ -96,6 +62,10 @@ export type GTPluginConfig = Omit<
   languageField?: string;
   translateDocuments?: TranslateDocumentFilter[];
   secretsNamespace?: string;
+  additionalStopTypes?: string[];
+  additionalSerializers?: Partial<PortableTextHtmlComponents>;
+  additionalDeserializers?: Record<string, any>;
+  additionalBlockDeserializers?: any[];
 };
 
 /**
@@ -124,6 +94,10 @@ export const gtPlugin = definePlugin<GTPluginConfig>(
     ignoreFields,
     translateDocuments,
     secretsNamespace = SECRETS_NAMESPACE,
+    additionalStopTypes = [],
+    additionalSerializers = {},
+    additionalDeserializers = {},
+    additionalBlockDeserializers = [],
   }) => {
     // Validate the translateDocuments
     translateDocuments = translateDocuments?.filter((filter) => {
@@ -133,7 +107,7 @@ export const gtPlugin = definePlugin<GTPluginConfig>(
       return false;
     });
 
-    gtConfig.init(
+    pluginConfig.init(
       secretsNamespace,
       languageField,
       sourceLocale,
@@ -143,7 +117,11 @@ export const gtPlugin = definePlugin<GTPluginConfig>(
       singletonMapping ||
         ((sourceDocumentId, locale) => `${sourceDocumentId}-${locale}`),
       ignoreFields || [],
-      translateDocuments || []
+      translateDocuments || [],
+      additionalStopTypes,
+      additionalSerializers,
+      additionalDeserializers,
+      additionalBlockDeserializers
     );
     gt.setConfig({
       sourceLocale: sourceLocale,
@@ -153,6 +131,14 @@ export const gtPlugin = definePlugin<GTPluginConfig>(
     });
     return {
       name: 'gt-sanity',
+      tools: [
+        {
+          name: 'translations',
+          title: 'Translations',
+          component: TranslationsTool,
+          router: route.create('/*'),
+        },
+      ],
     };
   }
 );

package/src/sanity-api/findDocuments.ts

@@ -0,0 +1,44 @@
+import { SanityClient } from 'sanity';
+import { pluginConfig } from '../adapter/core';
+
+export async function findTranslatedDocuments(
+  documentId: string,
+  client: SanityClient
+) {
+  const documents = await client.fetch(
+    `*[_type == "translation.metadata" && references($documentId)]`
+  );
+  return documents;
+}
+
+export async function findTranslatedDocumentForLocale(
+  sourceDocumentId: string,
+  localeId: string,
+  client: SanityClient
+) {
+  const cleanDocId = sourceDocumentId.replace('drafts.', '');
+
+  // Try both clean and original IDs to be safe, and use -> to directly fetch the translated doc
+  const query = `*[
+    _type == "translation.metadata" &&
+    (
+      translations[_key == $sourceLocale][0].value._ref == $cleanDocId
+    ) &&
+    defined(translations[_key == $localeId])
+  ][0].translations[_key == $localeId][0].value->`;
+
+  const translatedDoc = await client.fetch(query, {
+    sourceLocale: pluginConfig.getSourceLocale(),
+    cleanDocId,
+    localeId,
+  });
+
+  return translatedDoc || null;
+}
+
+export async function findDocument(documentId: string, client: SanityClient) {
+  const query = `*[_id == $id]`;
+  const params = { id: documentId };
+  const document = await client.fetch(query, params);
+  return document[0] || null;
+}

package/src/sanity-api/publishDocuments.ts

@@ -0,0 +1,49 @@
+import { SanityClient } from 'sanity';
+import { processBatch } from '../utils/batchProcessor';
+import { findDocument } from './findDocuments';
+
+export async function publishDocument(
+  documentId: string,
+  client: SanityClient
+) {
+  try {
+    // only publish if the document is a draft
+    if (documentId.startsWith('drafts.')) {
+      await client.action(
+        {
+          actionType: 'sanity.action.document.publish',
+          draftId: documentId,
+          publishedId: documentId.replace('drafts.', ''),
+        },
+        {}
+      );
+    }
+  } catch (error) {
+    console.error('Error publishing document', error);
+  }
+}
+
+export async function publishTranslations(
+  documentIds: string[],
+  client: SanityClient
+) {
+  const publishedDocumentIds: string[] = [];
+  await processBatch(
+    documentIds,
+    async (documentId) => {
+      const document = await findDocument(`drafts.${documentId}`, client);
+      if (!document) {
+        return { documentId, published: false };
+      }
+      await publishDocument(document._id, client);
+      publishedDocumentIds.push(documentId);
+      return { documentId, published: true };
+    },
+    {
+      onItemFailure: (documentId, error) => {
+        console.error(`Failed to publish document ${documentId}:`, error);
+      },
+    }
+  );
+  return publishedDocumentIds;
+}