@zohodesk/i18n 1.0.0-beta.4 → 1.0.0-beta.41-murphy

package/lib/index.js

@@ -1,243 +1,222 @@
-'use strict';
+"use strict";
 
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.NewDateFormat = exports.getI18NValue = exports.UserTimeDiffFormat = exports.DateTimeDiffFormat = exports.PluralFormat = exports.FormatText = exports.HOCI18N = exports.I18N = exports.i18NProviderUtils = exports.I18NProvider = exports.I18NContext = exports.getTimezoneOffset = exports.unpack = exports.getFormatedDate = exports.getSuffix = exports.getLyears = exports.getDiffObj = exports.userDateFormat = exports.convertUserTzToUtc = exports.convertUtcToUserTz = exports.getUtcTimeStamp = exports.convertTimezone = exports.isTwoWeeksOrMore = exports.isWithinAWeek = exports.isTomorrow = exports.isYesterday = exports.isToday = exports.getI18NInfo = exports.getValues = exports.unescapeUnicode = exports.replaceI18NValuesWithRegex = exports.pad = exports.formatDate = exports.browserOffset = undefined;
-
-var _utils = require('./utils');
-
-Object.defineProperty(exports, 'browserOffset', {
+Object.defineProperty(exports, "DateTimeDiffFormat", {
   enumerable: true,
   get: function get() {
-    return _utils.browserOffset;
+    return _DateTimeDiffFormat["default"];
   }
 });
-Object.defineProperty(exports, 'formatDate', {
+Object.defineProperty(exports, "FormatText", {
   enumerable: true,
   get: function get() {
-    return _utils.formatDate;
+    return _FormatText["default"];
   }
 });
-Object.defineProperty(exports, 'pad', {
+Object.defineProperty(exports, "HOCI18N", {
   enumerable: true,
   get: function get() {
-    return _utils.pad;
+    return _HOCI18N["default"];
   }
 });
-Object.defineProperty(exports, 'replaceI18NValuesWithRegex', {
+Object.defineProperty(exports, "I18N", {
   enumerable: true,
   get: function get() {
-    return _utils.replaceI18NValuesWithRegex;
+    return _I18N["default"];
   }
 });
-Object.defineProperty(exports, 'unescapeUnicode', {
+Object.defineProperty(exports, "I18NContext", {
   enumerable: true,
   get: function get() {
-    return _utils.unescapeUnicode;
+    return _I18NContext.I18NContext;
   }
 });
-Object.defineProperty(exports, 'getValues', {
+Object.defineProperty(exports, "I18NProvider", {
   enumerable: true,
   get: function get() {
-    return _utils.getValues;
+    return _I18NProvider["default"];
   }
 });
-Object.defineProperty(exports, 'getI18NInfo', {
+Object.defineProperty(exports, "I18N_ERROR_TYPES", {
   enumerable: true,
   get: function get() {
-    return _utils.getI18NInfo;
+    return _errorReporter.I18N_ERROR_TYPES;
   }
 });
-Object.defineProperty(exports, 'isToday', {
+Object.defineProperty(exports, "PluralFormat", {
   enumerable: true,
   get: function get() {
-    return _utils.isToday;
+    return _PluralFormat["default"];
   }
 });
-Object.defineProperty(exports, 'isYesterday', {
+Object.defineProperty(exports, "UserTimeDiffFormat", {
   enumerable: true,
   get: function get() {
-    return _utils.isYesterday;
+    return _UserTimeDiffFormat["default"];
   }
 });
-Object.defineProperty(exports, 'isTomorrow', {
+Object.defineProperty(exports, "dayi18n", {
   enumerable: true,
   get: function get() {
-    return _utils.isTomorrow;
+    return _utils.dayi18n;
   }
 });
-Object.defineProperty(exports, 'isWithinAWeek', {
+Object.defineProperty(exports, "formatDate", {
   enumerable: true,
   get: function get() {
-    return _utils.isWithinAWeek;
+    return _utils.formatDate;
   }
 });
-Object.defineProperty(exports, 'isTwoWeeksOrMore', {
+Object.defineProperty(exports, "getDatePatternWithoutYear", {
   enumerable: true,
   get: function get() {
-    return _utils.isTwoWeeksOrMore;
+    return _utils.getDatePatternWithoutYear;
   }
 });
-Object.defineProperty(exports, 'convertTimezone', {
+Object.defineProperty(exports, "getDiffObj", {
   enumerable: true,
   get: function get() {
-    return _utils.convertTimezone;
+    return _utils.getDiffObj;
   }
 });
-Object.defineProperty(exports, 'getUtcTimeStamp', {
+Object.defineProperty(exports, "getI18NInfo", {
   enumerable: true,
   get: function get() {
-    return _utils.getUtcTimeStamp;
+    return _utils.getI18NInfo;
   }
 });
-Object.defineProperty(exports, 'convertUtcToUserTz', {
+exports.getI18NValue = void 0;
+Object.defineProperty(exports, "getLyears", {
   enumerable: true,
   get: function get() {
-    return _utils.convertUtcToUserTz;
+    return _utils.getLyears;
   }
 });
-Object.defineProperty(exports, 'convertUserTzToUtc', {
+Object.defineProperty(exports, "getSuffix", {
   enumerable: true,
   get: function get() {
-    return _utils.convertUserTzToUtc;
+    return _utils.getSuffix;
   }
 });
-Object.defineProperty(exports, 'userDateFormat', {
+Object.defineProperty(exports, "getValues", {
   enumerable: true,
   get: function get() {
-    return _utils.userDateFormat;
+    return _utils.getValues;
   }
 });
-Object.defineProperty(exports, 'getDiffObj', {
+Object.defineProperty(exports, "i18NProviderUtils", {
   enumerable: true,
   get: function get() {
-    return _utils.getDiffObj;
+    return _I18NProvider.i18NProviderUtils;
   }
 });
-Object.defineProperty(exports, 'getLyears', {
+Object.defineProperty(exports, "isToday", {
   enumerable: true,
   get: function get() {
-    return _utils.getLyears;
+    return _utils.isToday;
   }
 });
-Object.defineProperty(exports, 'getSuffix', {
+Object.defineProperty(exports, "isTomorrow", {
   enumerable: true,
   get: function get() {
-    return _utils.getSuffix;
+    return _utils.isTomorrow;
   }
 });
-Object.defineProperty(exports, 'getFormatedDate', {
+Object.defineProperty(exports, "isTwoWeeksOrMore", {
   enumerable: true,
   get: function get() {
-    return _utils.getFormatedDate;
+    return _utils.isTwoWeeksOrMore;
   }
 });
-
-var _timezones = require('./timezones');
-
-Object.defineProperty(exports, 'unpack', {
+Object.defineProperty(exports, "isWithinAWeek", {
   enumerable: true,
   get: function get() {
-    return _timezones.unpack;
+    return _utils.isWithinAWeek;
   }
 });
-Object.defineProperty(exports, 'getTimezoneOffset', {
+Object.defineProperty(exports, "isYesterday", {
   enumerable: true,
   get: function get() {
-    return _timezones.getTimezoneOffset;
+    return _utils.isYesterday;
   }
 });
-
-var _I18NContext = require('./I18NContext');
-
-Object.defineProperty(exports, 'I18NContext', {
+Object.defineProperty(exports, "monthi18n", {
   enumerable: true,
   get: function get() {
-    return _I18NContext.I18NContext;
+    return _utils.monthi18n;
   }
 });
-
-var _I18NProvider = require('./components/I18NProvider');
-
-Object.defineProperty(exports, 'I18NProvider', {
+Object.defineProperty(exports, "pad", {
   enumerable: true,
   get: function get() {
-    return _interopRequireDefault(_I18NProvider).default;
+    return _utils.pad;
   }
 });
-Object.defineProperty(exports, 'i18NProviderUtils', {
+Object.defineProperty(exports, "placeComponentForTags", {
   enumerable: true,
   get: function get() {
-    return _I18NProvider.i18NProviderUtils;
+    return _jsxTranslations.placeComponentForTags;
   }
 });
-
-var _I18N = require('./components/I18N');
-
-Object.defineProperty(exports, 'I18N', {
+Object.defineProperty(exports, "replaceI18NValuesWithRegex", {
   enumerable: true,
   get: function get() {
-    return _interopRequireDefault(_I18N).default;
+    return _utils.replaceI18NValuesWithRegex;
   }
 });
-
-var _HOCI18N = require('./components/HOCI18N');
-
-Object.defineProperty(exports, 'HOCI18N', {
+Object.defineProperty(exports, "reportI18NError", {
   enumerable: true,
   get: function get() {
-    return _interopRequireDefault(_HOCI18N).default;
+    return _errorReporter.reportI18NError;
   }
 });
-
-var _FormatText = require('./components/FormatText');
-
-Object.defineProperty(exports, 'FormatText', {
+Object.defineProperty(exports, "setI18NKeyMapping", {
   enumerable: true,
   get: function get() {
-    return _interopRequireDefault(_FormatText).default;
+    return _utils.setI18NKeyMapping;
   }
 });
-
-var _PluralFormat = require('./components/PluralFormat');
-
-Object.defineProperty(exports, 'PluralFormat', {
+Object.defineProperty(exports, "setLocalizedData", {
   enumerable: true,
   get: function get() {
-    return _interopRequireDefault(_PluralFormat).default;
+    return _utils.setLocalizedData;
   }
 });
-
-var _DateTimeDiffFormat = require('./components/DateTimeDiffFormat');
-
-Object.defineProperty(exports, 'DateTimeDiffFormat', {
+Object.defineProperty(exports, "timei18n", {
   enumerable: true,
   get: function get() {
-    return _interopRequireDefault(_DateTimeDiffFormat).default;
+    return _utils.timei18n;
   }
 });
-
-var _UserTimeDiffFormat = require('./components/UserTimeDiffFormat');
-
-Object.defineProperty(exports, 'UserTimeDiffFormat', {
+Object.defineProperty(exports, "unescapeUnicode", {
   enumerable: true,
   get: function get() {
-    return _interopRequireDefault(_UserTimeDiffFormat).default;
+    return _utils.unescapeUnicode;
   }
 });
-
-var _NewDateFormat = require('./components/NewDateFormat');
-
-Object.defineProperty(exports, 'NewDateFormat', {
+Object.defineProperty(exports, "userDateFormat", {
   enumerable: true,
   get: function get() {
-    return _interopRequireDefault(_NewDateFormat).default;
+    return _utils.userDateFormat;
   }
 });
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
+var _utils = require("./utils");
+var _errorReporter = require("./utils/errorReporter");
+var _I18NContext = require("./I18NContext");
+var _I18NProvider = _interopRequireWildcard(require("./components/I18NProvider"));
+var _I18N = _interopRequireDefault(require("./components/I18N"));
+var _HOCI18N = _interopRequireDefault(require("./components/HOCI18N"));
+var _FormatText = _interopRequireDefault(require("./components/FormatText"));
+var _PluralFormat = _interopRequireDefault(require("./components/PluralFormat"));
+var _DateTimeDiffFormat = _interopRequireDefault(require("./components/DateTimeDiffFormat"));
+var _UserTimeDiffFormat = _interopRequireDefault(require("./components/UserTimeDiffFormat"));
+var _jsxTranslations = require("./utils/jsxTranslations");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { "default": e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n["default"] = e, t && t.set(e, n), n; }
 var getI18NValue = exports.getI18NValue = function getI18NValue(i18n, key, values) {
   return (0, _utils.getI18NValue)(i18n)(key, values);
 };

package/lib/utils/__tests__/jsxTranslations.spec.js

@@ -0,0 +1,172 @@
+"use strict";
+
+var _react = _interopRequireDefault(require("react"));
+var _jsxTranslations = require("../jsxTranslations");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function Bold(_ref) {
+  var children = _ref.children;
+  return /*#__PURE__*/_react["default"].createElement("b", null, children);
+}
+function Simple(props) {
+  return /*#__PURE__*/_react["default"].createElement("span", null, props.children);
+}
+describe('Verifying splitMatchedExp method', function () {
+  it('A string with no match test', function () {
+    var response = (0, _jsxTranslations.splitMatchedExp)({
+      expression: '{[0-9]+?}',
+      charLenToOmit: 1,
+      string: "Hello"
+    });
+    var expected = {
+      splitString: ['Hello'],
+      matchedExpKeys: []
+    };
+    expect(response).toEqual(expected);
+  });
+  it('A string with JSX Tag placeholder test', function () {
+    var response = (0, _jsxTranslations.splitMatchedExp)({
+      expression: '<[A-Za-z0-9]+?>',
+      charLenToOmit: 1,
+      string: "Hi <00Good> occurs <01Strong>"
+    });
+    var expected = {
+      splitString: ["Hi ", " occurs ", ""],
+      matchedExpKeys: ['00Good', '01Strong']
+    };
+    expect(response).toEqual(expected);
+  });
+  it('A string with String placeholder test', function () {
+    var response = (0, _jsxTranslations.splitMatchedExp)({
+      expression: '{[0-9]+?}',
+      charLenToOmit: 1,
+      string: "Hi {0} occurs {1}"
+    });
+    var expected = {
+      splitString: ["Hi ", " occurs ", ""],
+      matchedExpKeys: ['0', '1']
+    };
+    expect(response).toEqual(expected);
+  });
+});
+describe('Verifying generateChildren Method', function () {
+  it('A string with Tag Placeholder and String placeholders', function () {
+    var children = {
+      '00Good': function Good() {},
+      '01Strong': function Strong() {}
+    };
+    var response = (0, _jsxTranslations.generateChildren)({
+      children: children,
+      child: 'Hi <00Good>{0}<01Strong>'
+    });
+    var expected = {
+      newChildren: [['Hi '], children['00Good'], ['', ''], children['01Strong']],
+      stringPlaceHolders: {
+        0: [],
+        2: ['0']
+      }
+    };
+    expect(response).toEqual(expected);
+  });
+});
+describe('Verifying the replaceWithComponentPlaceHolder method', function () {
+  it('A JSX Tag with string', function () {
+    var response = (0, _jsxTranslations.replaceWithComponentPlaceHolder)({
+      componentId: 'Simple',
+      i18nKey: '<Simple>Hi everyone</Simple>',
+      childrenLength: 1
+    });
+    var expected = '<01Simple>';
+    expect(response).toBe(expected);
+  });
+  it('A string with multiple JSX Tags', function () {
+    var response = (0, _jsxTranslations.replaceWithComponentPlaceHolder)({
+      componentId: 'Simple',
+      i18nKey: 'Greetings <Simple>Hi everyone</Simple> for the <Simple>Day</Simple>',
+      childrenLength: 1
+    });
+    var expected = 'Greetings <01Simple> for the <Simple>Day</Simple>';
+    expect(response).toBe(expected);
+  });
+});
+describe('Verifying the createElement method', function () {
+  it('A component Id with JSX children and Dynamic String placeholders', function () {
+    var jsxChild = (0, _jsxTranslations.createElement)({
+      componentId: 'Simple',
+      children: [['Greetings']],
+      stringPlaceHolders: {
+        0: []
+      }
+    });
+    var response = (0, _jsxTranslations.createElement)({
+      componentId: -1,
+      children: [['Hi ', ','], jsxChild, [' for the day']],
+      stringPlaceHolders: {
+        0: ['0'],
+        2: []
+      }
+    })({
+      components: {
+        Simple: {
+          type: Simple
+        }
+      },
+      values: ['Zoho Desk']
+    });
+    var expected = /*#__PURE__*/_react["default"].createElement(_react["default"].Fragment, null, "Hi Zoho Desk,", /*#__PURE__*/_react["default"].createElement(Simple, null, "Greetings"), " for the day");
+    expect(JSON.stringify(response)).toEqual(JSON.stringify(expected));
+  });
+});
+describe('Verifying the prepareI18NFunc method', function () {
+  //Hi <Bo01ld>Gigiee</Bo01ld>,<Simple> How are you</Simple><Simple>Make it simple</Simple>
+  it('A text with sibling JSX tags and alphanumeric JSX Tags', function () {
+    var response = (0, _jsxTranslations.prepareI18NFunc)({
+      i18nKey: 'Hi <Bo01ld>Gigiee</Bo01ld>,<Simple>How are you</Simple><Simple>Make it simple</Simple>'
+    })({
+      components: {
+        'Bo01ld': {
+          type: Bold
+        },
+        Simple: {
+          type: Simple
+        }
+      }
+    });
+    var expected = /*#__PURE__*/_react["default"].createElement(_react["default"].Fragment, null, "Hi ", /*#__PURE__*/_react["default"].createElement(Bold, null, "Gigiee"), ",", /*#__PURE__*/_react["default"].createElement(Simple, null, "How are you"), /*#__PURE__*/_react["default"].createElement(Simple, null, "Make it simple"));
+    expect(JSON.stringify(response)).toEqual(JSON.stringify(expected));
+  });
+});
+describe('Verifying getI18NComponent method', function () {
+  it('An i18n key with JSX tag in its value', function () {
+    var i18n = {
+      'support.demo': 'Hi <Bo01ld>Gigiee</Bo01ld>,<Simple>How are you</Simple><Simple>Make it simple</Simple>'
+    };
+    var I18N = (0, _jsxTranslations.getI18NComponent)(i18n);
+    var response = I18N('support.demo')({
+      components: {
+        'Bo01ld': {
+          type: Bold
+        },
+        Simple: {
+          type: Simple
+        }
+      }
+    });
+    var expected = /*#__PURE__*/_react["default"].createElement(_react["default"].Fragment, null, "Hi ", /*#__PURE__*/_react["default"].createElement(Bold, null, "Gigiee"), ",", /*#__PURE__*/_react["default"].createElement(Simple, null, "How are you"), /*#__PURE__*/_react["default"].createElement(Simple, null, "Make it simple"));
+    expect(JSON.stringify(response)).toEqual(JSON.stringify(expected));
+  });
+  it('Testing absence of i18n object', function () {
+    var I18N = (0, _jsxTranslations.getI18NComponent)();
+    var response = I18N('support.demo');
+    var expected = 'support.demo';
+    expect(expected).toBe(response);
+  });
+  it('Testing of missing i18n key', function () {
+    var i18n = {
+      'support.demo': 'Demo'
+    };
+    var I18N = (0, _jsxTranslations.getI18NComponent)(i18n);
+    var response = I18N('support.need');
+    var expected = 'support.need';
+    expect(expected).toBe(response);
+  });
+});

package/lib/utils/errorReporter.js

@@ -0,0 +1,49 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.I18N_ERROR_TYPES = void 0;
+exports.getFallbackText = getFallbackText;
+exports.reportI18NError = reportI18NError;
+var I18N_ERROR_TYPES = exports.I18N_ERROR_TYPES = {
+  UNDEFINED_OBJECT: 'I18N_UNDEFINED_OBJECT',
+  MISSING_KEY: 'I18N_MISSING_KEY',
+  NUMERIC_FALLBACK: 'I18N_NUMERIC_FALLBACK'
+};
+var reportedKeys = new Set();
+function reportI18NError(type, key) {
+  var dedupeKey = "".concat(type, ":").concat(key);
+  if (reportedKeys.has(dedupeKey)) {
+    console.log("[i18n-reporter] SKIPPED (already reported): ".concat(dedupeKey));
+    return;
+  }
+  var errorMessage = "i18n ".concat(type, ": ").concat(key);
+  var errorData = {
+    errorType: type,
+    i18nKey: key,
+    category: 'i18n'
+  };
+  try {
+    if (typeof window._windowDeskCustomError === 'function') {
+      console.log("[i18n-reporter] Using DESK path (deskCustomError): ".concat(dedupeKey));
+      window._windowDeskCustomError(errorData, errorMessage, errorData);
+    } else if (window.murphy) {
+      console.log("[i18n-reporter] Using IM path (murphy direct): ".concat(dedupeKey));
+      window.murphy.addCustomTracking(errorData);
+      var error = new Error(errorMessage);
+      error.name = type;
+      window.murphy.error(error);
+    } else {
+      console.log("[i18n-reporter] SKIPPED (Murphy not loaded): ".concat(dedupeKey));
+      return;
+    }
+  } catch (err) {
+    console.error("[i18n-reporter] ERROR reporting: ".concat(dedupeKey), err);
+  }
+  reportedKeys.add(dedupeKey);
+}
+function getFallbackText(key) {
+  var isNumeric = /^\d+$/.test(key);
+  return isNumeric ? "text.unavailable.".concat(key) : key;
+}