gt-sanity 0.0.5 → 0.0.6

package/dist/index.js

@@ -1,13 +1,73 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: !0 });
-var jsxRuntime = require("react/jsx-runtime"), o = require("react"), sanity = require("sanity"), content = require("@sanity/util/content"), ui = require("@sanity/ui"), icons = require("@sanity/icons"), sanityNaiveHtmlSerializer = require("sanity-naive-html-serializer"), generaltranslation = require("generaltranslation"), internal = require("generaltranslation/internal");
+var jsxRuntime = require("react/jsx-runtime"), o = require("react"), sanity = require("sanity"), content = require("@sanity/util/content"), ui = require("@sanity/ui"), generaltranslation = require("generaltranslation"), internal = require("generaltranslation/internal"), icons = require("@sanity/icons"), sanityNaiveHtmlSerializer = require("sanity-naive-html-serializer"), jsonpathPlus = require("jsonpath-plus"), JSONPointer = require("jsonpointer");
 function _interopDefaultCompat(e) {
   return e && typeof e == "object" && "default" in e ? e : { default: e };
 }
-var o__default = /* @__PURE__ */ _interopDefaultCompat(o);
+var o__default = /* @__PURE__ */ _interopDefaultCompat(o), JSONPointer__default = /* @__PURE__ */ _interopDefaultCompat(JSONPointer);
 const TranslationContext = o__default.default.createContext(
   null
-);
+), SECRETS_NAMESPACE = "generaltranslation", gt = new generaltranslation.GT();
+function overrideConfig(secrets) {
+  gt.setConfig({
+    ...secrets?.project && { projectId: secrets?.project },
+    ...secrets?.secret && { apiKey: secrets?.secret }
+  });
+}
+class GTConfig {
+  secretsNamespace;
+  languageField;
+  sourceLocale;
+  locales;
+  singletons;
+  singletonMapping;
+  ignoreFields;
+  translateDocuments;
+  static instance;
+  constructor(secretsNamespace, languageField, sourceLocale, locales, singletons, singletonMapping, ignoreFields, translateDocuments) {
+    this.secretsNamespace = secretsNamespace, this.languageField = languageField, this.sourceLocale = sourceLocale, this.locales = locales, this.singletons = singletons, this.singletonMapping = singletonMapping, this.ignoreFields = ignoreFields, this.translateDocuments = translateDocuments;
+  }
+  static getInstance() {
+    return this.instance || (this.instance = new GTConfig(
+      SECRETS_NAMESPACE,
+      "language",
+      gt.sourceLocale || internal.libraryDefaultLocale,
+      [],
+      [],
+      () => "",
+      [],
+      []
+    )), this.instance;
+  }
+  init(secretsNamespace, languageField, sourceLocale, locales, singletons, singletonMapping, ignoreFields, translateDocuments) {
+    this.secretsNamespace = secretsNamespace, this.languageField = languageField, this.sourceLocale = sourceLocale, this.locales = locales, this.singletons = singletons, this.singletonMapping = singletonMapping, this.ignoreFields = ignoreFields, this.translateDocuments = translateDocuments;
+  }
+  getSecretsNamespace() {
+    return this.secretsNamespace;
+  }
+  getLanguageField() {
+    return this.languageField;
+  }
+  getSourceLocale() {
+    return this.sourceLocale;
+  }
+  getLocales() {
+    return this.locales;
+  }
+  getSingletons() {
+    return this.singletons;
+  }
+  getSingletonMapping() {
+    return this.singletonMapping;
+  }
+  getIgnoreFields() {
+    return this.ignoreFields;
+  }
+  getTranslateDocuments() {
+    return this.translateDocuments;
+  }
+}
+const gtConfig = GTConfig.getInstance();
 var __assign = function() {
   return __assign = Object.assign || function(t) {
     for (var s, i = 1, n = arguments.length; i < n; i++) {
@@ -1549,7 +1609,7 @@ const LanguageStatus = ({
     ] }) })
   ] });
 }, TranslationView = () => {
-  const [locales, setLocales] = o.useState([]), [task, setTask] = o.useState(null), context = o.useContext(TranslationContext), toast = ui.useToast();
+  const [locales, setLocales] = o.useState([]), [task, setTask] = o.useState(null), context = o.useContext(TranslationContext), toast = ui.useToast(), currentDocumentLanguage = o.useMemo(() => !context?.document || !context?.languageField ? null : context.document[context.languageField] || gtConfig.getSourceLocale(), [context?.document, context?.languageField]), shouldShowTranslationComponents = o.useMemo(() => currentDocumentLanguage ? currentDocumentLanguage === gtConfig.getSourceLocale() : !1, [currentDocumentLanguage]);
   o.useEffect(() => {
     async function fetchData() {
       if (!context) {
@@ -1589,11 +1649,16 @@ const LanguageStatus = ({
     );
     task2 && setTask(task2);
   }, [context, setTask]);
-  return /* @__PURE__ */ jsxRuntime.jsxs(ui.Stack, { space: 6, children: [
+  return shouldShowTranslationComponents ? /* @__PURE__ */ jsxRuntime.jsxs(ui.Stack, { space: 6, children: [
     /* @__PURE__ */ jsxRuntime.jsx(NewTask, { locales, refreshTask }),
     task && /* @__PURE__ */ jsxRuntime.jsx(TaskView, { task, locales, refreshTask })
-  ] });
-}, useClient = () => sanity.useClient({ apiVersion: "2022-12-07" });
+  ] }) : /* @__PURE__ */ jsxRuntime.jsx(ui.Card, { padding: 4, tone: "neutral", border: !0, children: /* @__PURE__ */ jsxRuntime.jsxs(ui.Text, { size: 1, muted: !0, children: [
+    "Translation tools are only available for",
+    " ",
+    /* @__PURE__ */ jsxRuntime.jsx("code", { children: gtConfig.getSourceLocale() }),
+    " documents."
+  ] }) });
+}, useClient = () => sanity.useClient({ apiVersion: "2025-09-15" });
 function useSecrets(id) {
   const [loading, setLoading] = o.useState(!0), [secrets, setSecrets] = o.useState(null), client = useClient();
   return o.useEffect(() => {
@@ -1668,6 +1733,8 @@ const TranslationTab = (props) => {
       {
         value: {
           documentInfo: { documentId, versionId: revisionId },
+          document: displayed,
+          languageField: props.options.languageField || "language",
           secrets,
           importTranslation,
           exportForTranslation,
@@ -1681,40 +1748,99 @@ const TranslationTab = (props) => {
       }
     )
   ] }) }) }) }) : /* @__PURE__ */ jsxRuntime.jsx(ui.ThemeProvider, { children: /* @__PURE__ */ jsxRuntime.jsx(ui.Box, { padding: 4, children: /* @__PURE__ */ jsxRuntime.jsx(ui.Card, { tone: "caution", padding: [2, 3, 4, 4], shadow: 1, radius: 2, children: /* @__PURE__ */ jsxRuntime.jsx(ui.Text, { children: "Can't find secrets for your translation service. Did you load them into this dataset?" }) }) }) });
-}, findDocumentAtRevision = async (documentId, rev, client) => {
-  const baseUrl = `/data/history/${client.config().dataset}/documents/${documentId}?revision=${rev}`, url = client.getUrl(baseUrl);
-  return await fetch(url, { credentials: "include" }).then((req) => req.json()).then((req) => req.documents && req.documents.length ? req.documents[0] : null);
 }, findLatestDraft = (documentId, client) => {
   const query = "*[_id == $id || _id == $draftId]", params = { id: documentId, draftId: `drafts.${documentId}` };
   return client.fetch(query, params).then(
     (docs) => docs.find((doc) => doc._id.startsWith("drafts.")) ?? docs[0]
   );
-}, createI18nDocAndPatchMetadata = (translatedDoc, localeId, client, translationMetadata, languageField = "language") => {
+}, findDocumentAtRevision = async (documentId, rev, client) => {
+  const baseUrl = `/data/history/${client.config().dataset}/documents/${documentId}?revision=${rev}`, url = client.getUrl(baseUrl);
+  return await fetch(url, { credentials: "include" }).then((req) => req.json()).then((req) => req.documents && req.documents.length ? req.documents[0] : null);
+};
+function applyDocuments(documentId, sourceDocument, targetDocument, ignore) {
+  const ignoreFields = ignore.filter(
+    (field) => field.documentId === documentId || field.documentId === void 0 || field.documentId === null
+  ), mergedDocument = { ...sourceDocument };
+  for (const [key, value] of Object.entries(targetDocument))
+    mergedDocument[key] = value;
+  for (const ignoreField of ignoreFields)
+    if (ignoreField.fields)
+      for (const field of ignoreField.fields) {
+        const { property, type } = field;
+        try {
+          const sourceResults = jsonpathPlus.JSONPath({
+            json: sourceDocument,
+            path: property,
+            resultType: "all",
+            flatten: !0,
+            wrap: !0
+          });
+          sourceResults && sourceResults.length > 0 && sourceResults.forEach((result) => {
+            const sourceValue = result.value;
+            type !== void 0 ? typeof sourceValue == "object" && sourceValue !== null && sourceValue._type === type && JSONPointer__default.default.set(mergedDocument, result.pointer, sourceValue) : JSONPointer__default.default.set(mergedDocument, result.pointer, sourceValue);
+          });
+        } catch (error) {
+          console.warn(`Invalid JSONPath: ${property}`, error);
+        }
+      }
+  return mergedDocument;
+}
+async function createI18nDocAndPatchMetadata(sourceDocument, translatedDoc, localeId, client, translationMetadata, sourceDocumentId, languageField = "language", publish = !1) {
   translatedDoc[languageField] = localeId;
   const existingLocaleKey = translationMetadata.translations.find(
     (translation) => translation._key === localeId
-  ), operation = existingLocaleKey ? "replace" : "after", location = existingLocaleKey ? `translations[_key == "${localeId}"]` : "translations[-1]", { _updatedAt, _createdAt, ...rest } = translatedDoc;
-  client.create({ ...rest, _id: "drafts." }).then((doc) => {
-    const _ref = doc._id.replace("drafts.", "");
-    client.transaction().patch(
-      translationMetadata._id,
-      (p) => p.insert(operation, location, [
-        {
-          _key: localeId,
-          _type: "internationalizedArrayReferenceValue",
-          value: {
-            _type: "reference",
-            _ref,
-            _weak: !0,
-            _strengthenOnPublish: {
-              type: doc._type
-            }
+  ), operation = existingLocaleKey ? "replace" : "after", location = existingLocaleKey ? `translations[_key == "${localeId}"]` : "translations[-1]", { _updatedAt, _createdAt, ...rest } = translatedDoc, appliedDocument = applyDocuments(
+    sourceDocumentId,
+    sourceDocument,
+    rest,
+    gtConfig.getIgnoreFields()
+  ), isSingleton = gtConfig.getSingletons().includes(sourceDocumentId);
+  let createDocumentPromise;
+  if (isSingleton) {
+    const translatedDocId = gtConfig.getSingletonMapping()(sourceDocumentId, localeId);
+    createDocumentPromise = client.create({
+      ...appliedDocument,
+      _type: rest._type,
+      _id: `drafts.${translatedDocId}`
+    });
+  } else
+    createDocumentPromise = client.create({
+      ...appliedDocument,
+      _type: rest._type,
+      _id: "drafts."
+    });
+  const doc = await createDocumentPromise, _ref = doc._id.replace("drafts.", "");
+  if (await client.transaction().patch(
+    translationMetadata._id,
+    (p) => p.insert(operation, location, [
+      {
+        _key: localeId,
+        _type: "internationalizedArrayReferenceValue",
+        value: {
+          _type: "reference",
+          _ref,
+          _weak: !0,
+          _strengthenOnPublish: {
+            type: doc._type
           }
         }
-      ])
-    ).commit();
-  });
-}, getOrCreateTranslationMetadata = async (documentId, baseDocument, client, baseLanguage) => {
+      }
+    ])
+  ).commit(), publish)
+    try {
+      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);
+    }
+}
+const getOrCreateTranslationMetadata = async (documentId, baseDocument, client, baseLanguage) => {
   const existingMetadata = await client.fetch(
     `*[
         _type == 'translation.metadata' &&
@@ -1759,43 +1885,38 @@ const TranslationTab = (props) => {
       return metadata;
     throw error;
   }
-}, patchI18nDoc = (i18nDocId, mergedDocument, translatedFields, client) => {
+}, SYSTEM_FIELDS = ["_id", "_rev", "_updatedAt", "language"], isSystemField = (field) => SYSTEM_FIELDS.includes(field);
+async function patchI18nDoc(sourceDocumentId, i18nDocId, sourceDocument, mergedDocument, translatedFields, client, publish = !1) {
   const cleanedMerge = {};
   Object.entries(mergedDocument).forEach(([key, value]) => {
     key in translatedFields && //don't overwrite any existing system values on the i18n doc
-    !["_id", "_rev", "_updatedAt", "language"].includes(key) && (cleanedMerge[key] = value);
-  }), client.transaction().patch(i18nDocId, (p) => p.set(cleanedMerge)).commit();
-}, gt = new generaltranslation.GT();
-function overrideConfig(secrets) {
-  gt.setConfig({
-    ...secrets?.project && { projectId: secrets?.project },
-    ...secrets?.secret && { apiKey: secrets?.secret }
+    !isSystemField(key) && (cleanedMerge[key] = value);
   });
+  const cleanedSourceDocument = {};
+  Object.entries(sourceDocument).forEach(([key, value]) => {
+    isSystemField(key) || (cleanedSourceDocument[key] = value);
+  });
+  const appliedDocument = applyDocuments(
+    sourceDocumentId,
+    cleanedSourceDocument,
+    cleanedMerge,
+    gtConfig.getIgnoreFields()
+  ), newDocument = await client.patch(i18nDocId, { set: appliedDocument }).commit();
+  if (publish)
+    try {
+      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);
+    }
 }
-class GTConfig {
-  sourceLocale;
-  locales;
-  static instance;
-  constructor(sourceLocale, locales) {
-    this.sourceLocale = sourceLocale, this.locales = locales;
-  }
-  static getInstance() {
-    return this.instance || (this.instance = new GTConfig(gt.sourceLocale || internal.libraryDefaultLocale, [])), this.instance;
-  }
-  setSourceLocale(sourceLocale) {
-    this.sourceLocale = sourceLocale;
-  }
-  getSourceLocale() {
-    return this.sourceLocale;
-  }
-  setLocales(locales) {
-    this.locales = locales;
-  }
-  getLocales() {
-    return this.locales;
-  }
-}
-const gtConfig = GTConfig.getInstance(), documentLevelPatch = async (docInfo, translatedFields, localeId, client, languageField = "language", mergeWithTargetLocale = !1) => {
+const documentLevelPatch = async (docInfo, translatedFields, localeId, client, languageField = "language", mergeWithTargetLocale = !1, publish = !1) => {
   const baseLanguage = gtConfig.getSourceLocale();
   let baseDoc = null, i18nDoc = null;
   docInfo.documentId && docInfo.versionId && (baseDoc = await findDocumentAtRevision(
@@ -1818,31 +1939,24 @@ const gtConfig = GTConfig.getInstance(), documentLevelPatch = async (docInfo, tr
     translatedFields,
     baseDoc
   );
-  i18nDoc ? patchI18nDoc(docInfo.documentId, merged, translatedFields, client) : createI18nDocAndPatchMetadata(
+  i18nDoc ? await patchI18nDoc(
+    docInfo.documentId,
+    i18nDoc._id,
+    baseDoc,
+    merged,
+    translatedFields,
+    client,
+    publish
+  ) : await createI18nDocAndPatchMetadata(
+    baseDoc,
     merged,
     localeId,
     client,
     translationMetadata,
-    languageField
-  );
-}, legacyDocumentLevelPatch = async (docInfo, translatedFields, localeId, client) => {
-  let baseDoc = null;
-  docInfo.documentId && docInfo.versionId && (baseDoc = await findDocumentAtRevision(
     docInfo.documentId,
-    docInfo.versionId,
-    client
-  )), baseDoc || (baseDoc = await findLatestDraft(docInfo.documentId, client));
-  const merged = sanityNaiveHtmlSerializer.BaseDocumentMerger.documentLevelMerge(
-    translatedFields,
-    baseDoc
-  ), targetId = `drafts.${docInfo.documentId}__i18n_${localeId}`, i18nDoc = await findLatestDraft(targetId, client);
-  if (i18nDoc) {
-    const cleanedMerge = {};
-    Object.entries(merged).forEach(([key, value]) => {
-      Object.keys(translatedFields).includes(key) && !["_id", "_rev", "_updatedAt"].includes(key) && (cleanedMerge[key] = value);
-    }), await client.transaction().patch(i18nDoc._id, (p) => p.set(cleanedMerge)).commit();
-  } else
-    merged._id = targetId, merged.__i18n_lang = localeId, await client.create(merged);
+    languageField,
+    publish
+  );
 }, baseDocumentLevelConfig = {
   exportForTranslation: async (...params) => {
     const [
@@ -1882,7 +1996,8 @@ const gtConfig = GTConfig.getInstance(), documentLevelPatch = async (docInfo, tr
       context,
       serializationOptions = {},
       languageField = "language",
-      mergeWithTargetLocale = !1
+      mergeWithTargetLocale = !1,
+      publish = !1
     ] = params, { client } = context, deserializers = {
       types: {
         ...serializationOptions.additionalDeserializers ?? {}
@@ -1902,33 +2017,11 @@ const gtConfig = GTConfig.getInstance(), documentLevelPatch = async (docInfo, tr
       localeId,
       client,
       languageField,
-      mergeWithTargetLocale
+      mergeWithTargetLocale,
+      publish
     );
   },
   secretsNamespace: "translationService"
-}, legacyDocumentLevelConfig$1 = {
-  ...baseDocumentLevelConfig,
-  importTranslation: (...params) => {
-    const [docInfo, localeId, document2, context, serializationOptions = {}] = params, { client } = context, deserializers = {
-      types: {
-        ...serializationOptions.additionalDeserializers ?? {}
-      }
-    }, blockDeserializers = [
-      ...serializationOptions.additionalBlockDeserializers ?? [],
-      ...sanityNaiveHtmlSerializer.customBlockDeserializers
-    ], deserialized = sanityNaiveHtmlSerializer.BaseDocumentDeserializer.deserializeDocument(
-      document2,
-      deserializers,
-      blockDeserializers
-    );
-    return legacyDocumentLevelPatch(
-      docInfo,
-      // versionId is not used here, since we just use the _rev id in the deserialized HTML itself
-      deserialized,
-      localeId,
-      client
-    );
-  }
 }, fieldLevelPatch = async (docInfo, translatedFields, localeId, client, mergeWithTargetLocale = !1) => {
   let baseDoc;
   const baseLanguage = gtConfig.getSourceLocale();
@@ -2028,7 +2121,7 @@ const gtConfig = GTConfig.getInstance(), documentLevelPatch = async (docInfo, tr
   versionId: documentInfo.versionId || void 0,
   locale: localeId
 })) : "", createTask = async (documentInfo, serializedDocument, localeIds, secrets, workflowUid, callbackUrl) => {
-  const fileName = `sanity-${documentInfo.documentId}`;
+  const fileName = `sanity/${documentInfo.documentId}`;
   overrideConfig(secrets);
   const uploadResult = await gt.uploadSourceFiles(
     [
@@ -2060,22 +2153,42 @@ const gtConfig = GTConfig.getInstance(), documentLevelPatch = async (docInfo, tr
   ...baseDocumentLevelConfig,
   adapter: GTAdapter,
   secretsNamespace: "generaltranslation"
-}, legacyDocumentLevelConfig = {
-  ...legacyDocumentLevelConfig$1,
-  adapter: GTAdapter,
-  secretsNamespace: "generaltranslation"
 }, defaultFieldLevelConfig = {
   ...baseFieldLevelConfig,
   adapter: GTAdapter,
   secretsNamespace: "generaltranslation"
-}, gtPlugin = sanity.definePlugin(({ sourceLocale, locales, customMapping, apiKey, projectId }) => (gtConfig.setLocales(locales), gtConfig.setSourceLocale(sourceLocale || internal.libraryDefaultLocale), gt.setConfig({
-  sourceLocale,
-  customMapping,
-  apiKey,
-  projectId
-}), {
-  name: "@generaltranslation/sanity"
-}));
+}, gtPlugin = sanity.definePlugin(
+  ({
+    languageField = "language",
+    sourceLocale = internal.libraryDefaultLocale,
+    locales,
+    customMapping,
+    apiKey,
+    projectId,
+    singletons,
+    singletonMapping,
+    ignoreFields,
+    translateDocuments,
+    secretsNamespace = SECRETS_NAMESPACE
+  }) => (translateDocuments = translateDocuments?.filter((filter2) => !!(filter2.documentId || filter2.type)), gtConfig.init(
+    secretsNamespace,
+    languageField,
+    sourceLocale,
+    locales,
+    singletons || [],
+    // singletons is a string array of singleton document ids
+    singletonMapping || ((sourceDocumentId, locale) => `${sourceDocumentId}-${locale}`),
+    ignoreFields || [],
+    translateDocuments || []
+  ), gt.setConfig({
+    sourceLocale,
+    customMapping,
+    apiKey,
+    projectId
+  }), {
+    name: "gt-sanity"
+  })
+);
 Object.defineProperty(exports, "BaseDocumentDeserializer", {
   enumerable: !0,
   get: function() {
@@ -2114,6 +2227,4 @@ exports.documentLevelPatch = documentLevelPatch;
 exports.fieldLevelPatch = fieldLevelPatch;
 exports.findLatestDraft = findLatestDraft;
 exports.gtPlugin = gtPlugin;
-exports.legacyDocumentLevelConfig = legacyDocumentLevelConfig;
-exports.legacyDocumentLevelPatch = legacyDocumentLevelPatch;
 //# sourceMappingURL=index.js.map