sanity-plugin-transifex 0.9.85 → 1.1.1

package/.github/workflows/main.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        node: ['10.x', '12.x', '14.x']
+        node: ['12.x', '14.x', '16.x']
         os: [ubuntu-latest, windows-latest, macOS-latest]
 
     steps:

package/dist/helpers.d.ts

@@ -0,0 +1,5 @@
+import { SanityDocument } from '@sanity/types';
+export declare const findLatestDraft: (documentId: string, ignoreI18n?: boolean) => any;
+export declare const findDocumentAtRevision: (documentId: string, rev: string) => Promise<any>;
+export declare const documentLevelPatch: (documentId: string, translatedFields: SanityDocument, localeId: string) => Promise<void>;
+export declare const fieldLevelPatch: (documentId: string, translatedFields: SanityDocument, localeId: string) => Promise<void>;

package/dist/index.d.ts

@@ -1,16 +1,16 @@
-import { TranslationsTab as TranslationTab } from 'sanity-translations-tab';
-import { BaseDocumentDeserializer, BaseDocumentSerializer, BaseDocumentPatcher, defaultStopTypes, customSerializers } from 'sanity-naive-html-serializer';
+import { TranslationsTab } from 'sanity-translations-tab';
+import { BaseDocumentDeserializer, BaseDocumentSerializer, BaseDocumentMerger, defaultStopTypes, customSerializers } from 'sanity-naive-html-serializer';
 import { TransifexAdapter } from './transifexAdapter';
-export { TranslationTab, BaseDocumentDeserializer, BaseDocumentSerializer, BaseDocumentPatcher, defaultStopTypes, customSerializers, TransifexAdapter, };
-export declare const defaultDocumentLevelConfig: {
+declare const defaultDocumentLevelConfig: {
     exportForTranslation: (id: string) => Promise<import("sanity-naive-html-serializer/dist/types").SerializedDocument>;
-    importTranslation: (id: string, localeId: string, document: string) => any;
+    importTranslation: (id: string, localeId: string, document: string) => void;
     adapter: import("sanity-translations-tab").Adapter;
     secretsNamespace: string;
 };
-export declare const defaultFieldLevelConfig: {
+declare const defaultFieldLevelConfig: {
     exportForTranslation: (id: string) => Promise<import("sanity-naive-html-serializer/dist/types").SerializedDocument>;
-    importTranslation: (id: string, localeId: string, document: string) => any;
+    importTranslation: (id: string, localeId: string, document: string) => void;
     adapter: import("sanity-translations-tab").Adapter;
     secretsNamespace: string;
 };
+export { TranslationsTab, BaseDocumentDeserializer, BaseDocumentSerializer, BaseDocumentMerger, defaultStopTypes, customSerializers, TransifexAdapter, defaultDocumentLevelConfig, defaultFieldLevelConfig, };

package/dist/sanity-plugin-transifex.cjs.development.js

@@ -2,8 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
+
 var sanityTranslationsTab = require('sanity-translations-tab');
 var sanityNaiveHtmlSerializer = require('sanity-naive-html-serializer');
+var sanityClient = _interopDefault(require('part:@sanity/base/client'));
 
 function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
   try {
@@ -856,9 +859,21 @@ var getTranslationTask = /*#__PURE__*/function () {
       while (1) {
         switch (_context2.prev = _context2.next) {
           case 0:
+            if (!(!documentId || !secrets)) {
+              _context2.next = 2;
+              break;
+            }
+
+            return _context2.abrupt("return", {
+              taskId: documentId,
+              documentId: documentId,
+              locales: []
+            });
+
+          case 2:
             projectFilter = "filter[project]=" + projOrgSlug(secrets);
             resourceFilter = "filter[resource]=" + projOrgSlug(secrets) + ":r:" + documentId;
-            _context2.next = 4;
+            _context2.next = 6;
             return fetch(baseTransifexUrl + "/resource_language_stats?" + projectFilter + "&" + resourceFilter, {
               headers: getHeaders(secrets)
             }).then(function (res) {
@@ -880,18 +895,18 @@ var getTranslationTask = /*#__PURE__*/function () {
                 locales: res.data.map(function (locale) {
                   return {
                     localeId: locale.relationships.language.data.id.split(':')[1],
-                    progress: Math.floor(100 * (locale.attributes.translated_strings / parseFloat(locale.attributes.total_strings)))
+                    progress: Math.floor(100 * (locale.attributes.reviewed_strings / parseFloat(locale.attributes.total_strings)))
                   };
                 })
               };
             });
 
-          case 4:
+          case 6:
             task = _context2.sent;
-            _context2.next = 7;
+            _context2.next = 9;
             return getLocales(secrets);
 
-          case 7:
+          case 9:
             locales = _context2.sent;
             localeIds = locales.map(function (l) {
               return l.localeId;
@@ -904,7 +919,7 @@ var getTranslationTask = /*#__PURE__*/function () {
             task.locales = validLocales;
             return _context2.abrupt("return", task);
 
-          case 12:
+          case 14:
           case "end":
             return _context2.stop();
         }
@@ -1143,33 +1158,284 @@ var TransifexAdapter = {
   getTranslation: getTranslation
 };
 
-//unfortunately this nomenclature was inconsistent between publishing this and publishing the agnostic tab
+var client = /*#__PURE__*/sanityClient.withConfig({
+  apiVersion: '2021-03-25'
+}); //document fetch
+
+var findLatestDraft = function findLatestDraft(documentId, ignoreI18n) {
+  if (ignoreI18n === void 0) {
+    ignoreI18n = true;
+  }
+
+  //eliminates i18n versions
+  var query = "*[_id match $id " + (ignoreI18n ? ' && (_id in path("drafts.*") || _id in path("*"))' : '') + "]";
+  var params = {
+    id: "*" + documentId
+  };
+  return client.fetch(query, params).then(function (docs) {
+    var _docs$find;
+
+    return (_docs$find = docs.find(function (doc) {
+      return doc._id.includes('draft');
+    })) != null ? _docs$find : docs[0];
+  });
+}; //revision fetch
+
+var findDocumentAtRevision = /*#__PURE__*/function () {
+  var _ref = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee(documentId, rev) {
+    var dataset, baseUrl, url, revisionDoc;
+    return runtime_1.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            dataset = client.config().dataset;
+            baseUrl = "/data/history/" + dataset + "/documents/" + documentId + "?revision=" + rev;
+            url = client.getUrl(baseUrl);
+            _context.next = 5;
+            return fetch(url, {
+              credentials: 'include'
+            }).then(function (req) {
+              return req.json();
+            }).then(function (req) {
+              return req.documents[0];
+            });
+
+          case 5:
+            revisionDoc = _context.sent;
+
+            if (!(!revisionDoc || revisionDoc._rev !== rev)) {
+              _context.next = 12;
+              break;
+            }
+
+            baseUrl = "/data/history/" + dataset + "/documents/drafts." + documentId + "?revision=" + rev;
+            url = client.getUrl(baseUrl);
+            _context.next = 11;
+            return fetch(url, {
+              credentials: 'include'
+            }).then(function (req) {
+              return req.json();
+            }).then(function (req) {
+              return req.documents[0];
+            });
+
+          case 11:
+            revisionDoc = _context.sent;
+
+          case 12:
+            return _context.abrupt("return", revisionDoc);
+
+          case 13:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee);
+  }));
+
+  return function findDocumentAtRevision(_x, _x2) {
+    return _ref.apply(this, arguments);
+  };
+}(); //document-level patch
+
+var documentLevelPatch = /*#__PURE__*/function () {
+  var _ref2 = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee2(documentId, translatedFields, localeId) {
+    var baseDoc, merged, targetId, i18nDoc, cleanedMerge;
+    return runtime_1.wrap(function _callee2$(_context2) {
+      while (1) {
+        switch (_context2.prev = _context2.next) {
+          case 0:
+            if (!translatedFields._rev) {
+              _context2.next = 6;
+              break;
+            }
+
+            _context2.next = 3;
+            return findDocumentAtRevision(documentId, translatedFields._rev);
+
+          case 3:
+            baseDoc = _context2.sent;
+            _context2.next = 9;
+            break;
+
+          case 6:
+            _context2.next = 8;
+            return findLatestDraft(documentId);
+
+          case 8:
+            baseDoc = _context2.sent;
+
+          case 9:
+            merged = sanityNaiveHtmlSerializer.BaseDocumentMerger.documentLevelMerge(translatedFields, baseDoc);
+            targetId = "i18n." + documentId + "." + localeId;
+            _context2.next = 13;
+            return findLatestDraft(targetId, false);
+
+          case 13:
+            i18nDoc = _context2.sent;
+
+            if (i18nDoc) {
+              cleanedMerge = {}; //don't overwrite any existing values on the i18n doc
+
+              Object.entries(merged).forEach(function (_ref3) {
+                var key = _ref3[0],
+                    value = _ref3[1];
+
+                if (Object.keys(translatedFields).includes(key) && !['_id', '_rev', '_updatedAt'].includes(key)) {
+                  cleanedMerge[key] = value;
+                }
+              });
+              client.transaction() //@ts-ignore
+              .patch(i18nDoc._id, function (p) {
+                return p.set(cleanedMerge);
+              }).commit();
+            } else {
+              merged._id = "drafts." + targetId; //account for legacy implementations of i18n plugin lang
+
+              if (baseDoc._lang) {
+                merged._lang = localeId;
+              } else if (baseDoc.__i18n_lang) {
+                merged.__i18n_lang = localeId;
+              }
+
+              client.create(merged);
+            }
+
+          case 15:
+          case "end":
+            return _context2.stop();
+        }
+      }
+    }, _callee2);
+  }));
+
+  return function documentLevelPatch(_x3, _x4, _x5) {
+    return _ref2.apply(this, arguments);
+  };
+}(); //field level patch
+
+var fieldLevelPatch = /*#__PURE__*/function () {
+  var _ref4 = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee3(documentId, translatedFields, localeId) {
+    var baseDoc, merged;
+    return runtime_1.wrap(function _callee3$(_context3) {
+      while (1) {
+        switch (_context3.prev = _context3.next) {
+          case 0:
+            if (!translatedFields._rev) {
+              _context3.next = 6;
+              break;
+            }
+
+            _context3.next = 3;
+            return findDocumentAtRevision(documentId, translatedFields._rev);
+
+          case 3:
+            baseDoc = _context3.sent;
+            _context3.next = 9;
+            break;
+
+          case 6:
+            _context3.next = 8;
+            return findLatestDraft(documentId);
+
+          case 8:
+            baseDoc = _context3.sent;
+
+          case 9:
+            merged = sanityNaiveHtmlSerializer.BaseDocumentMerger.fieldLevelMerge(translatedFields, baseDoc, localeId, 'en');
+            client.patch(baseDoc._id).set(merged).commit();
+
+          case 11:
+          case "end":
+            return _context3.stop();
+        }
+      }
+    }, _callee3);
+  }));
+
+  return function fieldLevelPatch(_x6, _x7, _x8) {
+    return _ref4.apply(this, arguments);
+  };
+}();
+
 var defaultDocumentLevelConfig = {
-  exportForTranslation: function exportForTranslation(id) {
-    return sanityNaiveHtmlSerializer.BaseDocumentSerializer.serializeDocument(id, 'document', 'en', sanityNaiveHtmlSerializer.defaultStopTypes, sanityNaiveHtmlSerializer.customSerializers);
-  },
+  exportForTranslation: /*#__PURE__*/function () {
+    var _exportForTranslation = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee(id) {
+      var doc, serialized;
+      return runtime_1.wrap(function _callee$(_context) {
+        while (1) {
+          switch (_context.prev = _context.next) {
+            case 0:
+              _context.next = 2;
+              return findLatestDraft(id);
+
+            case 2:
+              doc = _context.sent;
+              serialized = sanityNaiveHtmlSerializer.BaseDocumentSerializer.serializeDocument(doc, 'document');
+              serialized.name = id;
+              return _context.abrupt("return", serialized);
+
+            case 6:
+            case "end":
+              return _context.stop();
+          }
+        }
+      }, _callee);
+    }));
+
+    function exportForTranslation(_x) {
+      return _exportForTranslation.apply(this, arguments);
+    }
+
+    return exportForTranslation;
+  }(),
   importTranslation: function importTranslation(id, localeId, document) {
-    return sanityNaiveHtmlSerializer.BaseDocumentDeserializer.deserializeDocument(id, document).then(function (deserialized) {
-      return sanityNaiveHtmlSerializer.BaseDocumentPatcher.documentLevelPatch(deserialized, id, localeId);
-    });
+    var deserialized = sanityNaiveHtmlSerializer.BaseDocumentDeserializer.deserializeDocument(document);
+    documentLevelPatch(id, deserialized, localeId);
   },
   adapter: TransifexAdapter,
   secretsNamespace: 'transifex'
 };
 var defaultFieldLevelConfig = {
-  exportForTranslation: function exportForTranslation(id) {
-    return sanityNaiveHtmlSerializer.BaseDocumentSerializer.serializeDocument(id, 'field', 'en', sanityNaiveHtmlSerializer.defaultStopTypes, sanityNaiveHtmlSerializer.customSerializers);
-  },
+  exportForTranslation: /*#__PURE__*/function () {
+    var _exportForTranslation2 = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee2(id) {
+      var doc, serialized;
+      return runtime_1.wrap(function _callee2$(_context2) {
+        while (1) {
+          switch (_context2.prev = _context2.next) {
+            case 0:
+              _context2.next = 2;
+              return findLatestDraft(id);
+
+            case 2:
+              doc = _context2.sent;
+              serialized = sanityNaiveHtmlSerializer.BaseDocumentSerializer.serializeDocument(doc, 'field');
+              serialized.name = id;
+              return _context2.abrupt("return", serialized);
+
+            case 6:
+            case "end":
+              return _context2.stop();
+          }
+        }
+      }, _callee2);
+    }));
+
+    function exportForTranslation(_x2) {
+      return _exportForTranslation2.apply(this, arguments);
+    }
+
+    return exportForTranslation;
+  }(),
   importTranslation: function importTranslation(id, localeId, document) {
-    return sanityNaiveHtmlSerializer.BaseDocumentDeserializer.deserializeDocument(id, document).then(function (deserialized) {
-      return sanityNaiveHtmlSerializer.BaseDocumentPatcher.fieldLevelPatch(deserialized, id, localeId, 'en');
-    });
+    var deserialized = sanityNaiveHtmlSerializer.BaseDocumentDeserializer.deserializeDocument(document);
+    fieldLevelPatch(id, deserialized, localeId);
   },
   adapter: TransifexAdapter,
   secretsNamespace: 'transifex'
 };
 
-Object.defineProperty(exports, 'TranslationTab', {
+Object.defineProperty(exports, 'TranslationsTab', {
   enumerable: true,
   get: function () {
     return sanityTranslationsTab.TranslationsTab;
@@ -1181,10 +1447,10 @@ Object.defineProperty(exports, 'BaseDocumentDeserializer', {
     return sanityNaiveHtmlSerializer.BaseDocumentDeserializer;
   }
 });
-Object.defineProperty(exports, 'BaseDocumentPatcher', {
+Object.defineProperty(exports, 'BaseDocumentMerger', {
   enumerable: true,
   get: function () {
-    return sanityNaiveHtmlSerializer.BaseDocumentPatcher;
+    return sanityNaiveHtmlSerializer.BaseDocumentMerger;
   }
 });
 Object.defineProperty(exports, 'BaseDocumentSerializer', {