@uniformdev/tms-sdk 19.154.1-alpha.18 → 19.154.1-alpha.22

package/dist/index.esm.js

@@ -3,20 +3,207 @@ import {
   bindVariables,
   walkNodeTree
 } from "@uniformdev/canvas";
+import { isRichTextValue, isRichTextValueConsideredEmpty as isRichTextValueConsideredEmpty2 } from "@uniformdev/richtext";
 
 // src/constants.ts
 var TRANSLATION_PAYLOAD_SOURCE_KEY = "source";
 var TRANSLATION_PAYLOAD_TARGET_KEY = "target";
 var TRANSLATION_PAYLOAD_ORIGINAL_TARGET_KEY = "originalTarget";
+var SUPPORTED_PARAM_TYPES = {
+  text: "text",
+  richText: "richText"
+};
 
-// src/collectTranslationPayload.ts
+// src/translationHelpers.ts
+import { isRichTextValueConsideredEmpty } from "@uniformdev/richtext";
+import { dequal } from "dequal/lite";
 var MERGE_TRANSLATION_ERRORS = {
   unknown: "Unknown error",
   "invalid-args": "Invalid arguments",
-  "entity-source-locale-missing": "Entity does not include specified  Uniform source locale"
+  "project-id-mismatch": "Project ID mismatch",
+  "entity-id-mismatch": "Enity ID mismatch",
+  "entity-locales-mismatch": "Entity does not include required locales"
 };
 var createErrorResult = (errorKind) => {
-  return { errorKind, errorText: MERGE_TRANSLATION_ERRORS[errorKind] };
+  return { updated: false, errorKind, errorText: MERGE_TRANSLATION_ERRORS[errorKind] };
+};
+var processComponentTranslation = ({
+  uniformSourceLocale,
+  uniformTargetLocale,
+  overrideModifiedTargetLocale,
+  originalNode,
+  translatedComponent
+}) => {
+  var _a, _b;
+  let updated = false;
+  if (!originalNode.type || !originalNode._id) {
+    return { updated };
+  }
+  const componentParameters = "parameters" in originalNode ? originalNode.parameters : void 0;
+  const entryFields = "fields" in originalNode ? originalNode.fields : void 0;
+  const originalParametersOrFields = componentParameters != null ? componentParameters : entryFields;
+  Object.entries((_a = translatedComponent.parameters) != null ? _a : {}).forEach(([paramKey, parameter]) => {
+    const originalParameter = originalParametersOrFields == null ? void 0 : originalParametersOrFields[paramKey];
+    if (!originalParameter) {
+      return;
+    }
+    const result = processParameterTranslation({
+      uniformSourceLocale,
+      uniformTargetLocale,
+      overrideModifiedTargetLocale,
+      originalParameter,
+      parameter
+    });
+    if (result.updated) {
+      updated = true;
+    }
+  });
+  Object.entries((_b = translatedComponent._overrides) != null ? _b : {}).forEach(([overrideKey, override]) => {
+    var _a2;
+    const originalOverride = (_a2 = originalNode._overrides) == null ? void 0 : _a2[overrideKey];
+    if (!originalOverride) {
+      return;
+    }
+    const result = processOverrideTranslation({
+      uniformSourceLocale,
+      uniformTargetLocale,
+      overrideModifiedTargetLocale,
+      originalOverride,
+      override
+    });
+    if (result.updated) {
+      updated = true;
+    }
+  });
+  return { updated };
+};
+var processParameterTranslation = ({
+  uniformSourceLocale,
+  uniformTargetLocale,
+  overrideModifiedTargetLocale,
+  originalParameter,
+  parameter
+}) => {
+  var _a, _b, _c;
+  if (!originalParameter.locales) {
+    return { updated: false };
+  }
+  if (originalParameter.type !== parameter.type) {
+    return { updated: false };
+  }
+  const sourceValue = (_a = parameter.locales) == null ? void 0 : _a[TRANSLATION_PAYLOAD_SOURCE_KEY];
+  const targetValue = (_b = parameter.locales) == null ? void 0 : _b[TRANSLATION_PAYLOAD_TARGET_KEY];
+  const originalTargetValue = (_c = parameter.locales) == null ? void 0 : _c[TRANSLATION_PAYLOAD_ORIGINAL_TARGET_KEY];
+  const isSourceValueUntouched = isSameParameterValue({
+    parameterType: originalParameter.type,
+    left: originalParameter.locales[uniformSourceLocale],
+    right: sourceValue
+  });
+  const isTargetValueUntouched = overrideModifiedTargetLocale || isSameParameterValue({
+    parameterType: originalParameter.type,
+    left: originalParameter.locales[uniformTargetLocale],
+    right: originalTargetValue
+  });
+  if (targetValue && isSourceValueUntouched && isTargetValueUntouched) {
+    originalParameter.locales[uniformTargetLocale] = targetValue;
+    return { updated: true };
+  }
+  return { updated: false };
+};
+var processOverrideTranslation = ({
+  uniformSourceLocale,
+  uniformTargetLocale,
+  overrideModifiedTargetLocale,
+  originalOverride,
+  override
+}) => {
+  var _a, _b;
+  let updated = false;
+  Object.entries((_a = override.parameters) != null ? _a : {}).forEach(([paramKey, parameter]) => {
+    var _a2, _b2, _c, _d;
+    const originalParameter = (_a2 = originalOverride.parameters) == null ? void 0 : _a2[paramKey];
+    if (!originalParameter || !originalParameter.locales) {
+      return;
+    }
+    if (originalParameter.type !== parameter.type) {
+      return;
+    }
+    const sourceValue = (_b2 = parameter.locales) == null ? void 0 : _b2[TRANSLATION_PAYLOAD_SOURCE_KEY];
+    const targetValue = (_c = parameter.locales) == null ? void 0 : _c[TRANSLATION_PAYLOAD_TARGET_KEY];
+    const originalTargetValue = (_d = parameter.locales) == null ? void 0 : _d[TRANSLATION_PAYLOAD_ORIGINAL_TARGET_KEY];
+    const isSourceValueUntouched = isSameParameterValue({
+      parameterType: originalParameter.type,
+      left: originalParameter.locales[uniformSourceLocale],
+      right: sourceValue
+    });
+    const isTargetValueUntouched = overrideModifiedTargetLocale || isSameParameterValue({
+      parameterType: originalParameter.type,
+      left: originalParameter.locales[uniformTargetLocale],
+      right: originalTargetValue
+    });
+    if (targetValue && isSourceValueUntouched && isTargetValueUntouched) {
+      originalParameter.locales[uniformTargetLocale] = targetValue;
+      updated = true;
+    }
+  });
+  Object.entries((_b = override.slots) != null ? _b : {}).forEach(([slotKey, slotComponents]) => {
+    var _a2;
+    const originalSlotComponents = (_a2 = originalOverride.slots) == null ? void 0 : _a2[slotKey];
+    if (!(originalSlotComponents == null ? void 0 : originalSlotComponents.length)) {
+      return;
+    }
+    slotComponents.forEach((slotComponent) => {
+      if (!slotComponent.type || !slotComponent._id) {
+        return;
+      }
+      const originalComponent = originalSlotComponents.find(
+        (x) => x._id === slotComponent._id && x.type === slotComponent.type
+      );
+      if (!originalComponent) {
+        return;
+      }
+      const { updated: isComponentUpdated } = processComponentTranslation({
+        uniformSourceLocale,
+        uniformTargetLocale,
+        overrideModifiedTargetLocale,
+        originalNode: originalComponent,
+        translatedComponent: slotComponent
+      });
+      if (isComponentUpdated) {
+        updated = true;
+      }
+    });
+  });
+  return { updated };
+};
+var isSameParameterValue = ({
+  parameterType,
+  left,
+  right
+}) => {
+  switch (parameterType) {
+    case SUPPORTED_PARAM_TYPES.text:
+      return left === right || !left && !right;
+      break;
+    case SUPPORTED_PARAM_TYPES.richText:
+      if (isRichTextValueConsideredEmpty(left) && isRichTextValueConsideredEmpty(right)) {
+        return true;
+      }
+      return dequal(left, right);
+      break;
+    default:
+      return left === right;
+  }
+};
+
+// src/collectTranslationPayload.ts
+var MERGE_TRANSLATION_ERRORS2 = {
+  unknown: "Unknown error",
+  "invalid-args": "Invalid arguments",
+  "entity-source-locale-missing": "Entity does not include specified  Uniform source locale"
+};
+var createErrorResult2 = (errorKind) => {
+  return { errorKind, errorText: MERGE_TRANSLATION_ERRORS2[errorKind] };
 };
 var collectTranslationPayload = ({
   uniformProjectId,
@@ -29,10 +216,10 @@ var collectTranslationPayload = ({
   overrideModifiedTargetLocale
 }) => {
   if (!uniformSourceLocale || !uniformTargetLocale || !targetLang || !entity) {
-    return createErrorResult("invalid-args");
+    return createErrorResult2("invalid-args");
   }
   if (!entity._locales || !entity._locales.includes(uniformSourceLocale)) {
-    return createErrorResult("entity-source-locale-missing");
+    return createErrorResult2("entity-source-locale-missing");
   }
   const payload = {
     schemaVersion: 1,
@@ -90,7 +277,7 @@ var collectFromNode = ({
     if (!canTranslateParameterValue(param, sourceLocaleValue)) {
       return;
     }
-    if (!overrideModifiedTargetLocale && !isTargetLocaleUntouched(sourceLocaleValue, targetLocaleValue)) {
+    if (!overrideModifiedTargetLocale && !isTargetLocaleUntouched(param.type, sourceLocaleValue, targetLocaleValue)) {
       return;
     }
     parameters[paramKey] = {
@@ -111,7 +298,7 @@ var collectFromNode = ({
       if (!canTranslateParameterValue(param, sourceLocaleValue)) {
         return;
       }
-      if (!overrideModifiedTargetLocale && !isTargetLocaleUntouched(sourceLocaleValue, targetLocaleValue)) {
+      if (!overrideModifiedTargetLocale && !isTargetLocaleUntouched(param.type, sourceLocaleValue, targetLocaleValue)) {
         return;
       }
       (_c = overrides[overrideKey]) != null ? _c : overrides[overrideKey] = {};
@@ -162,7 +349,7 @@ var collectFromNode = ({
   };
 };
 var canTranslateParameterValue = (parameter, value) => {
-  if (parameter.type === "text") {
+  if (parameter.type === SUPPORTED_PARAM_TYPES.text) {
     if (typeof value !== "string" || !value) {
       return false;
     }
@@ -179,13 +366,26 @@ var canTranslateParameterValue = (parameter, value) => {
       return false;
     }
     return true;
-  } else if (parameter.type === "richText") {
-    return typeof value === "object" && !!value;
+  } else if (parameter.type === SUPPORTED_PARAM_TYPES.richText) {
+    return isRichTextValue(value) && !isRichTextValueConsideredEmpty2(value);
   }
   return false;
 };
-var isTargetLocaleUntouched = (sourceLocaleValue, targetLocaleValue) => {
-  return targetLocaleValue === void 0 || targetLocaleValue === null || targetLocaleValue === "" || targetLocaleValue === sourceLocaleValue;
+var isTargetLocaleUntouched = (parameterType, sourceLocaleValue, targetLocaleValue) => {
+  if (targetLocaleValue === void 0 || targetLocaleValue === null) {
+    return true;
+  }
+  if (parameterType === SUPPORTED_PARAM_TYPES.text && !targetLocaleValue) {
+    return true;
+  }
+  if (parameterType === SUPPORTED_PARAM_TYPES.richText && isRichTextValueConsideredEmpty2(targetLocaleValue)) {
+    return true;
+  }
+  return isSameParameterValue({
+    parameterType,
+    left: sourceLocaleValue,
+    right: targetLocaleValue
+  });
 };
 
 // src/getCompositionForTranslation.ts
@@ -244,180 +444,6 @@ import { CANVAS_DRAFT_STATE as CANVAS_DRAFT_STATE4 } from "@uniformdev/canvas";
 // src/translateComposition.ts
 import { CANVAS_DRAFT_STATE as CANVAS_DRAFT_STATE3, walkNodeTree as walkNodeTree2 } from "@uniformdev/canvas";
 import { produce } from "immer";
-
-// src/translationHelpers.ts
-import { dequal } from "dequal/lite";
-var MERGE_TRANSLATION_ERRORS2 = {
-  unknown: "Unknown error",
-  "invalid-args": "Invalid arguments",
-  "project-id-mismatch": "Project ID mismatch",
-  "entity-id-mismatch": "Enity ID mismatch",
-  "entity-locales-mismatch": "Entity does not include required locales"
-};
-var createErrorResult2 = (errorKind) => {
-  return { updated: false, errorKind, errorText: MERGE_TRANSLATION_ERRORS2[errorKind] };
-};
-var processComponentTranslation = ({
-  uniformSourceLocale,
-  uniformTargetLocale,
-  overrideModifiedTargetLocale,
-  originalNode,
-  translatedComponent
-}) => {
-  var _a, _b;
-  let updated = false;
-  if (!originalNode.type || !originalNode._id) {
-    return { updated };
-  }
-  const componentParameters = "parameters" in originalNode ? originalNode.parameters : void 0;
-  const entryFields = "fields" in originalNode ? originalNode.fields : void 0;
-  const originalParametersOrFields = componentParameters != null ? componentParameters : entryFields;
-  Object.entries((_a = translatedComponent.parameters) != null ? _a : {}).forEach(([paramKey, parameter]) => {
-    const originalParameter = originalParametersOrFields == null ? void 0 : originalParametersOrFields[paramKey];
-    if (!originalParameter) {
-      return;
-    }
-    const result = processParameterTranslation({
-      uniformSourceLocale,
-      uniformTargetLocale,
-      overrideModifiedTargetLocale,
-      originalParameter,
-      parameter
-    });
-    if (result.updated) {
-      updated = true;
-    }
-  });
-  Object.entries((_b = translatedComponent._overrides) != null ? _b : {}).forEach(([overrideKey, override]) => {
-    var _a2;
-    const originalOverride = (_a2 = originalNode._overrides) == null ? void 0 : _a2[overrideKey];
-    if (!originalOverride) {
-      return;
-    }
-    const result = processOverrideTranslation({
-      uniformSourceLocale,
-      uniformTargetLocale,
-      overrideModifiedTargetLocale,
-      originalOverride,
-      override
-    });
-    if (result.updated) {
-      updated = true;
-    }
-  });
-  return { updated };
-};
-var processParameterTranslation = ({
-  uniformSourceLocale,
-  uniformTargetLocale,
-  overrideModifiedTargetLocale,
-  originalParameter,
-  parameter
-}) => {
-  var _a, _b, _c;
-  if (!originalParameter.locales) {
-    return { updated: false };
-  }
-  const sourceValue = (_a = parameter.locales) == null ? void 0 : _a[TRANSLATION_PAYLOAD_SOURCE_KEY];
-  const targetValue = (_b = parameter.locales) == null ? void 0 : _b[TRANSLATION_PAYLOAD_TARGET_KEY];
-  const originalTargetValue = (_c = parameter.locales) == null ? void 0 : _c[TRANSLATION_PAYLOAD_ORIGINAL_TARGET_KEY];
-  const isSourceValueUntouched = isSameParameterValue({
-    parameterType: originalParameter.type,
-    originalValue: originalParameter.locales[uniformSourceLocale],
-    value: sourceValue
-  });
-  const isTargetValueUntouched = overrideModifiedTargetLocale || isSameParameterValue({
-    parameterType: originalParameter.type,
-    originalValue: originalParameter.locales[uniformTargetLocale],
-    value: originalTargetValue
-  });
-  if (targetValue && isSourceValueUntouched && isTargetValueUntouched) {
-    originalParameter.locales[uniformTargetLocale] = targetValue;
-    return { updated: true };
-  }
-  return { updated: false };
-};
-var processOverrideTranslation = ({
-  uniformSourceLocale,
-  uniformTargetLocale,
-  overrideModifiedTargetLocale,
-  originalOverride,
-  override
-}) => {
-  var _a, _b;
-  let updated = false;
-  Object.entries((_a = override.parameters) != null ? _a : {}).forEach(([paramKey, parameter]) => {
-    var _a2, _b2, _c, _d;
-    const originalParameter = (_a2 = originalOverride.parameters) == null ? void 0 : _a2[paramKey];
-    if (!originalParameter || !originalParameter.locales) {
-      return;
-    }
-    const sourceValue = (_b2 = parameter.locales) == null ? void 0 : _b2[TRANSLATION_PAYLOAD_SOURCE_KEY];
-    const targetValue = (_c = parameter.locales) == null ? void 0 : _c[TRANSLATION_PAYLOAD_TARGET_KEY];
-    const originalTargetValue = (_d = parameter.locales) == null ? void 0 : _d[TRANSLATION_PAYLOAD_ORIGINAL_TARGET_KEY];
-    const isSourceValueUntouched = isSameParameterValue({
-      parameterType: originalParameter.type,
-      originalValue: originalParameter.locales[uniformSourceLocale],
-      value: sourceValue
-    });
-    const isTargetValueUntouched = overrideModifiedTargetLocale || isSameParameterValue({
-      parameterType: originalParameter.type,
-      originalValue: originalParameter.locales[uniformTargetLocale],
-      value: originalTargetValue
-    });
-    if (targetValue && isSourceValueUntouched && isTargetValueUntouched) {
-      originalParameter.locales[uniformTargetLocale] = targetValue;
-      updated = true;
-    }
-  });
-  Object.entries((_b = override.slots) != null ? _b : {}).forEach(([slotKey, slotComponents]) => {
-    var _a2;
-    const originalSlotComponents = (_a2 = originalOverride.slots) == null ? void 0 : _a2[slotKey];
-    if (!(originalSlotComponents == null ? void 0 : originalSlotComponents.length)) {
-      return;
-    }
-    slotComponents.forEach((slotComponent) => {
-      if (!slotComponent.type || !slotComponent._id) {
-        return;
-      }
-      const originalComponent = originalSlotComponents.find(
-        (x) => x._id === slotComponent._id && x.type === slotComponent.type
-      );
-      if (!originalComponent) {
-        return;
-      }
-      const { updated: isComponentUpdated } = processComponentTranslation({
-        uniformSourceLocale,
-        uniformTargetLocale,
-        overrideModifiedTargetLocale,
-        originalNode: originalComponent,
-        translatedComponent: slotComponent
-      });
-      if (isComponentUpdated) {
-        updated = true;
-      }
-    });
-  });
-  return { updated };
-};
-var isSameParameterValue = ({
-  parameterType,
-  originalValue,
-  value
-}) => {
-  switch (parameterType) {
-    case "text":
-      return originalValue === value || !originalValue && !value;
-      break;
-    case "richText":
-      return dequal(originalValue, value);
-      break;
-    default:
-      return originalValue === value;
-  }
-};
-
-// src/translateComposition.ts
 var translateComposition = ({
   composition,
   translationPayload,
@@ -425,19 +451,19 @@ var translateComposition = ({
 }) => {
   var _a;
   if (!composition || !composition.composition || !translationPayload) {
-    return createErrorResult2("invalid-args");
+    return createErrorResult("invalid-args");
   }
   if (composition.projectId !== translationPayload.metadata.uniformProjectId) {
-    return createErrorResult2("project-id-mismatch");
+    return createErrorResult("project-id-mismatch");
   }
   if (composition.composition._id !== translationPayload.metadata.entity.id) {
-    return createErrorResult2("entity-id-mismatch");
+    return createErrorResult("entity-id-mismatch");
   }
   const compositionLocales = (_a = composition.composition._locales) != null ? _a : [];
   const uniformSourceLocale = translationPayload.metadata.uniformSourceLocale;
   const uniformTargetLocale = translationPayload.metadata.uniformTargetLocale;
   if (!compositionLocales.includes(uniformSourceLocale)) {
-    return createErrorResult2("entity-locales-mismatch");
+    return createErrorResult("entity-locales-mismatch");
   }
   let updated = false;
   const translatedComposition = produce(composition, (draft) => {
@@ -555,19 +581,19 @@ var translateEntry = ({
 }) => {
   var _a;
   if (!entry || !translationPayload) {
-    return createErrorResult2("invalid-args");
+    return createErrorResult("invalid-args");
   }
   if (entry.projectId !== translationPayload.metadata.uniformProjectId) {
-    return createErrorResult2("project-id-mismatch");
+    return createErrorResult("project-id-mismatch");
   }
   if ((entry == null ? void 0 : entry.entry._id) !== translationPayload.metadata.entity.id) {
-    return createErrorResult2("entity-id-mismatch");
+    return createErrorResult("entity-id-mismatch");
   }
   const entryLocales = (_a = entry.entry._locales) != null ? _a : [];
   const uniformSourceLocale = translationPayload.metadata.uniformSourceLocale;
   const uniformTargetLocale = translationPayload.metadata.uniformTargetLocale;
   if (!entryLocales.includes(uniformSourceLocale)) {
-    return createErrorResult2("entity-locales-mismatch");
+    return createErrorResult("entity-locales-mismatch");
   }
   let updated = false;
   const translatedEntry = produce2(entry, (draft) => {