sanity-plugin-studio-smartling 1.1.5 → 1.3.0

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,14 +1,14 @@
 import { TranslationsTab } from 'sanity-translations-tab';
-import { BaseDocumentDeserializer, BaseDocumentSerializer, BaseDocumentPatcher, defaultStopTypes, customSerializers } from 'sanity-naive-html-serializer';
+import { BaseDocumentDeserializer, BaseDocumentSerializer, BaseDocumentMerger, defaultStopTypes, customSerializers } from 'sanity-naive-html-serializer';
 import { SmartlingAdapter } from './adapter';
 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;
 };
 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;
 };
-export { TranslationsTab, BaseDocumentDeserializer, BaseDocumentSerializer, BaseDocumentPatcher, defaultStopTypes, customSerializers, SmartlingAdapter, defaultDocumentLevelConfig, defaultFieldLevelConfig, };
+export { TranslationsTab, BaseDocumentDeserializer, BaseDocumentSerializer, BaseDocumentMerger, defaultStopTypes, customSerializers, SmartlingAdapter, defaultDocumentLevelConfig, defaultFieldLevelConfig, };

package/dist/sanity-plugin-studio-smartling.cjs.development.js

@@ -1,7 +1,10 @@
 'use strict';
 
+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 {
@@ -976,7 +979,7 @@ var getTranslationTask = /*#__PURE__*/function () {
               locales = smartlingTask.contentProgressReport.map(function (item) {
                 return {
                   localeId: item.targetLocaleId,
-                  progress: item.progress.percentComplete
+                  progress: item.progress ? item.progress.percentComplete : 0
                 };
               });
             }
@@ -1001,28 +1004,30 @@ var getTranslationTask = /*#__PURE__*/function () {
   };
 }();
 
-var uploadFile = /*#__PURE__*/function () {
-  var _ref = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee(documentId, projectId, document, accessToken) {
-    var url, formData, htmlBuffer;
+var createJob = /*#__PURE__*/function () {
+  var _ref = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee(jobName, projectId, localeIds, accessToken) {
+    var url;
     return runtime_1.wrap(function _callee$(_context) {
       while (1) {
         switch (_context.prev = _context.next) {
           case 0:
-            url = "https://api.smartling.com/files-api/v2/projects/" + projectId + "/file";
-            formData = new FormData();
-            formData.append('fileUri', documentId);
-            formData.append('fileType', 'html');
-            htmlBuffer = Buffer.from(document.content, 'utf-8');
-            formData.append('file', new Blob([htmlBuffer]), document.name + ".html");
+            url = "https://api.smartling.com/jobs-api/v3/projects/" + projectId + "/jobs";
             return _context.abrupt("return", fetch(smartlingProxy, {
               method: 'POST',
-              headers: getHeaders(url, accessToken),
-              body: formData
+              headers: _extends({}, getHeaders(url, accessToken), {
+                'content-type': 'application/json'
+              }),
+              body: JSON.stringify({
+                jobName: jobName,
+                targetLocaleIds: localeIds
+              })
             }).then(function (res) {
               return res.json();
+            }).then(function (res) {
+              return res.response.data.translationJobUid;
             }));
 
-          case 7:
+          case 2:
           case "end":
             return _context.stop();
         }
@@ -1030,32 +1035,39 @@ var uploadFile = /*#__PURE__*/function () {
     }, _callee);
   }));
 
-  return function uploadFile(_x, _x2, _x3, _x4) {
+  return function createJob(_x, _x2, _x3, _x4) {
     return _ref.apply(this, arguments);
   };
 }();
+/* we're using batches here because it eliminates some
+ * new string authorization issues for updating existing jobs,
+ * and is able to be used for new bulk
+ * job functionality.
+ */
+
 
-var assignFileToJob = /*#__PURE__*/function () {
-  var _ref2 = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee2(jobId, documentId, projectId, localeIds, accessToken) {
+var createJobBatch = /*#__PURE__*/function () {
+  var _ref2 = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee2(jobId, projectId, documentName, accessToken) {
     var url;
     return runtime_1.wrap(function _callee2$(_context2) {
       while (1) {
         switch (_context2.prev = _context2.next) {
           case 0:
-            url = "https://api.smartling.com/jobs-api/v3/projects/" + projectId + "/jobs/" + jobId + "/file/add";
+            url = "https://api.smartling.com/job-batches-api/v2/projects/" + projectId + "/batches";
             return _context2.abrupt("return", fetch(smartlingProxy, {
               method: 'POST',
               headers: _extends({}, getHeaders(url, accessToken), {
                 'content-type': 'application/json'
               }),
               body: JSON.stringify({
-                fileUri: documentId,
-                targetLocaleIds: localeIds
+                authorize: true,
+                translationJobUid: jobId,
+                fileUris: [documentName]
               })
             }).then(function (res) {
               return res.json();
             }).then(function (res) {
-              return res.response;
+              return res.response.data.batchUid;
             }));
 
           case 2:
@@ -1066,35 +1078,36 @@ var assignFileToJob = /*#__PURE__*/function () {
     }, _callee2);
   }));
 
-  return function assignFileToJob(_x5, _x6, _x7, _x8, _x9) {
+  return function createJobBatch(_x5, _x6, _x7, _x8) {
     return _ref2.apply(this, arguments);
   };
 }();
 
-var createJob = /*#__PURE__*/function () {
-  var _ref3 = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee3(documentId, projectId, localeIds, accessToken) {
-    var url;
+var uploadFileToBatch = /*#__PURE__*/function () {
+  var _ref3 = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee3(batchUid, document, projectId, localeIds, accessToken) {
+    var url, formData, htmlBuffer;
     return runtime_1.wrap(function _callee3$(_context3) {
       while (1) {
         switch (_context3.prev = _context3.next) {
           case 0:
-            url = "https://api.smartling.com/jobs-api/v3/projects/" + projectId + "/jobs";
+            url = "https://api.smartling.com/job-batches-api/v2/projects/" + projectId + "/batches/" + batchUid + "/file";
+            formData = new FormData();
+            formData.append('fileUri', document.name);
+            formData.append('fileType', 'html');
+            htmlBuffer = Buffer.from(document.content, 'utf-8');
+            formData.append('file', new Blob([htmlBuffer]), document.name + ".html");
+            localeIds.forEach(function (localeId) {
+              return formData.append('localeIdsToAuthorize[]', localeId);
+            });
             return _context3.abrupt("return", fetch(smartlingProxy, {
               method: 'POST',
-              headers: _extends({}, getHeaders(url, accessToken), {
-                'content-type': 'application/json'
-              }),
-              body: JSON.stringify({
-                jobName: documentId,
-                targetLocaleIds: localeIds
-              })
+              headers: getHeaders(url, accessToken),
+              body: formData
             }).then(function (res) {
               return res.json();
-            }).then(function (res) {
-              return res.response.data.translationJobUid;
             }));
 
-          case 2:
+          case 8:
           case "end":
             return _context3.stop();
         }
@@ -1102,108 +1115,64 @@ var createJob = /*#__PURE__*/function () {
     }, _callee3);
   }));
 
-  return function createJob(_x10, _x11, _x12, _x13) {
+  return function uploadFileToBatch(_x9, _x10, _x11, _x12, _x13) {
     return _ref3.apply(this, arguments);
   };
 }();
 
-var authorizeJob = /*#__PURE__*/function () {
-  var _ref4 = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee4(jobId, projectId, localeIds, accessToken) {
-    var url;
+var createTask = /*#__PURE__*/function () {
+  var _ref4 = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee4(documentId, document, localeIds, secrets) {
+    var accessToken, taskId, batchUid, uploadFileRes;
     return runtime_1.wrap(function _callee4$(_context4) {
       while (1) {
         switch (_context4.prev = _context4.next) {
           case 0:
-            url = "https://api.smartling.com/jobs-api/v3/projects/" + projectId + "/jobs/" + jobId + "/authorize";
-            return _context4.abrupt("return", fetch(smartlingProxy, {
-              method: 'POST',
-              headers: _extends({}, getHeaders(url, accessToken), {
-                'content-type': 'application/json'
-              }),
-              body: JSON.stringify({
-                localeWorkflows: localeIds.map(function (l) {
-                  return {
-                    targetLocaleId: l
-                  };
-                })
-              })
-            }).then(function (res) {
-              return res.json();
-            }));
-
-          case 2:
-          case "end":
-            return _context4.stop();
-        }
-      }
-    }, _callee4);
-  }));
-
-  return function authorizeJob(_x14, _x15, _x16, _x17) {
-    return _ref4.apply(this, arguments);
-  };
-}();
-
-var createTask = /*#__PURE__*/function () {
-  var _ref5 = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee5(documentId, document, localeIds, secrets) {
-    var accessToken, uploadFileRes, taskId, assignStatus, authorizeStatus;
-    return runtime_1.wrap(function _callee5$(_context5) {
-      while (1) {
-        switch (_context5.prev = _context5.next) {
-          case 0:
-            _context5.next = 2;
+            _context4.next = 2;
             return authenticate(secrets.secret);
 
           case 2:
-            accessToken = _context5.sent;
-            _context5.next = 5;
-            return uploadFile(documentId, secrets.project, document, accessToken);
+            accessToken = _context4.sent;
+            _context4.next = 5;
+            return findExistingJob(document.name, secrets.project, accessToken);
 
           case 5:
-            uploadFileRes = _context5.sent;
-            console.log('uploadFileRes', uploadFileRes);
-            _context5.next = 9;
-            return findExistingJob(documentId, secrets.project, accessToken);
-
-          case 9:
-            taskId = _context5.sent;
+            taskId = _context4.sent;
 
             if (taskId) {
-              _context5.next = 14;
+              _context4.next = 10;
               break;
             }
 
-            _context5.next = 13;
-            return createJob(documentId, secrets.project, localeIds, accessToken);
+            _context4.next = 9;
+            return createJob(document.name, secrets.project, localeIds, accessToken);
 
-          case 13:
-            taskId = _context5.sent;
+          case 9:
+            taskId = _context4.sent;
 
-          case 14:
-            _context5.next = 16;
-            return assignFileToJob(taskId, documentId, secrets.project, localeIds, accessToken);
+          case 10:
+            _context4.next = 12;
+            return createJobBatch(taskId, secrets.project, document.name, accessToken);
 
-          case 16:
-            assignStatus = _context5.sent;
-            console.log('assign status', assignStatus);
-            _context5.next = 20;
-            return authorizeJob(taskId, secrets.project, localeIds, accessToken);
+          case 12:
+            batchUid = _context4.sent;
+            _context4.next = 15;
+            return uploadFileToBatch(batchUid, document, secrets.project, localeIds, accessToken);
 
-          case 20:
-            authorizeStatus = _context5.sent;
-            console.log('authStatus', authorizeStatus);
-            return _context5.abrupt("return", getTranslationTask(documentId, secrets));
+          case 15:
+            uploadFileRes = _context4.sent;
+            console.log('upload status', uploadFileRes);
+            return _context4.abrupt("return", getTranslationTask(documentId, secrets));
 
-          case 23:
+          case 18:
           case "end":
-            return _context5.stop();
+            return _context4.stop();
         }
       }
-    }, _callee5);
+    }, _callee4);
   }));
 
-  return function createTask(_x18, _x19, _x20, _x21) {
-    return _ref5.apply(this, arguments);
+  return function createTask(_x14, _x15, _x16, _x17) {
+    return _ref4.apply(this, arguments);
   };
 }();
 
@@ -1254,25 +1223,279 @@ var SmartlingAdapter = {
   getTranslation: getTranslation
 };
 
+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'); //needed for lookup by translation tab
+
+              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: SmartlingAdapter
 };
 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'); //needed for lookup by translation tab
+
+              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: SmartlingAdapter
 };
@@ -1289,10 +1512,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', {