@zohodesk/i18n 1.0.0-beta.34 → 1.0.0-beta.36-murphy

package/lib/utils/jsxTranslations.js

@@ -1,5 +1,6 @@
 "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
 });
@@ -10,42 +11,30 @@ exports.placeComponentForTags = placeComponentForTags;
 exports.prepareI18NFunc = prepareI18NFunc;
 exports.replaceWithComponentPlaceHolder = replaceWithComponentPlaceHolder;
 exports.splitMatchedExp = splitMatchedExp;
-
 var _react = _interopRequireDefault(require("react"));
-
 var _index = require("./index");
-
 var _I18NProvider = require("../components/I18NProvider");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
-
+var _errorReporter = require("./errorReporter");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _toConsumableArray(r) { return _arrayWithoutHoles(r) || _iterableToArray(r) || _unsupportedIterableToArray(r) || _nonIterableSpread(); }
 function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
-
-function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
-
-function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
-
-function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
-
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
-
+function _iterableToArray(r) { if ("undefined" != typeof Symbol && null != r[Symbol.iterator] || null != r["@@iterator"]) return Array.from(r); }
+function _arrayWithoutHoles(r) { if (Array.isArray(r)) return _arrayLikeToArray(r); }
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
 function splitMatchedExp(_ref) {
   var expression = _ref.expression,
-      charLenToOmit = _ref.charLenToOmit,
-      string = _ref.string;
+    charLenToOmit = _ref.charLenToOmit,
+    string = _ref.string;
   var splitString = string.split(new RegExp(expression, 'g'));
   var matchedExpAll = string.matchAll(new RegExp(expression, 'g'));
   var matchedExpKeys = [];
-
   var _iterator = _createForOfIteratorHelper(matchedExpAll),
-      _step;
-
+    _step;
   try {
     for (_iterator.s(); !(_step = _iterator.n()).done;) {
       var match = _step.value;
@@ -57,42 +46,36 @@ function splitMatchedExp(_ref) {
   } finally {
     _iterator.f();
   }
-
   return {
     splitString: splitString,
     matchedExpKeys: matchedExpKeys
   };
 }
-
 function generateChildren(_ref2) {
   var children = _ref2.children,
-      child = _ref2.child;
+    child = _ref2.child;
   var newChildren = [],
-      stringPlaceHolders = {};
-
+    stringPlaceHolders = {};
   var handleString = function handleString(string) {
     if (string) {
       var _splitMatchedExp = splitMatchedExp({
-        expression: '{[0-9]+?}',
-        charLenToOmit: 1,
-        string: string
-      }),
-          splitString = _splitMatchedExp.splitString,
-          matchedExpKeys = _splitMatchedExp.matchedExpKeys;
-
+          expression: '{[0-9]+?}',
+          charLenToOmit: 1,
+          string: string
+        }),
+        splitString = _splitMatchedExp.splitString,
+        matchedExpKeys = _splitMatchedExp.matchedExpKeys;
       stringPlaceHolders[newChildren.length] = matchedExpKeys;
       newChildren.push(splitString);
     }
   };
-
   var _splitMatchedExp2 = splitMatchedExp({
-    expression: '<[A-Za-z0-9]+?>',
-    charLenToOmit: 1,
-    string: child
-  }),
-      splitChild = _splitMatchedExp2.splitString,
-      childrenKeys = _splitMatchedExp2.matchedExpKeys;
-
+      expression: '<[A-Za-z0-9]+?>',
+      charLenToOmit: 1,
+      string: child
+    }),
+    splitChild = _splitMatchedExp2.splitString,
+    childrenKeys = _splitMatchedExp2.matchedExpKeys;
   childrenKeys.forEach(function (childKey, childIndex) {
     var matchedChild = splitChild[childIndex];
     handleString(matchedChild);
@@ -104,27 +87,23 @@ function generateChildren(_ref2) {
     stringPlaceHolders: stringPlaceHolders
   };
 }
-
 function createElement() {
   var _ref3 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
-      componentId = _ref3.componentId,
-      _ref3$children = _ref3.children,
-      children = _ref3$children === void 0 ? [] : _ref3$children,
-      _ref3$stringPlaceHold = _ref3.stringPlaceHolders,
-      stringPlaceHolders = _ref3$stringPlaceHold === void 0 ? {} : _ref3$stringPlaceHold;
-
+    componentId = _ref3.componentId,
+    _ref3$children = _ref3.children,
+    children = _ref3$children === void 0 ? [] : _ref3$children,
+    _ref3$stringPlaceHold = _ref3.stringPlaceHolders,
+    stringPlaceHolders = _ref3$stringPlaceHold === void 0 ? {} : _ref3$stringPlaceHold;
   return function () {
     var _ref4 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
-        _ref4$components = _ref4.components,
-        components = _ref4$components === void 0 ? {} : _ref4$components,
-        _ref4$values = _ref4.values,
-        values = _ref4$values === void 0 ? [] : _ref4$values;
-
+      _ref4$components = _ref4.components,
+      components = _ref4$components === void 0 ? {} : _ref4$components,
+      _ref4$values = _ref4.values,
+      values = _ref4$values === void 0 ? [] : _ref4$values;
     var _ref5 = components[componentId] || {},
-        _ref5$type = _ref5.type,
-        type = _ref5$type === void 0 ? _react["default"].Fragment : _ref5$type,
-        props = _ref5.props;
-
+      _ref5$type = _ref5.type,
+      type = _ref5$type === void 0 ? _react["default"].Fragment : _ref5$type,
+      props = _ref5.props;
     var childElements = children.map(function (child, index) {
       if (typeof child === 'function') {
         return child({
@@ -132,60 +111,49 @@ function createElement() {
           values: values
         });
       }
-
       var string = '',
-          stringIndex = 0;
+        stringIndex = 0;
       (stringPlaceHolders[index] || []).map(function (stringId, index) {
         if (child[index]) {
           string += child[index];
         }
-
         string += values[stringId];
         stringIndex++;
       });
-
       if (child[stringIndex]) {
         string += child[stringIndex];
       }
-
       return string;
     });
     return /*#__PURE__*/_react["default"].createElement.apply(_react["default"], [type, props].concat(_toConsumableArray(childElements)));
   };
 }
-
 ;
-
 function replaceWithComponentPlaceHolder(_ref6) {
   var componentId = _ref6.componentId,
-      i18nKey = _ref6.i18nKey,
-      childrenLength = _ref6.childrenLength;
+    i18nKey = _ref6.i18nKey,
+    childrenLength = _ref6.childrenLength;
   var closingTagIndex = i18nKey.indexOf("</".concat(componentId, ">"));
   var childWithOpenTag = i18nKey.substring(0, closingTagIndex);
   var openTagIndex = childWithOpenTag.lastIndexOf("<".concat(componentId, ">"));
   return i18nKey.substring(0, openTagIndex) + "<0".concat(childrenLength).concat(componentId, ">") + i18nKey.substring(closingTagIndex + "".concat(componentId).length + 3);
 }
-
 function prepareI18NFunc() {
   var _ref7 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
-      i18nKey = _ref7.i18nKey,
-      _ref7$children = _ref7.children,
-      children = _ref7$children === void 0 ? {} : _ref7$children;
-
+    i18nKey = _ref7.i18nKey,
+    _ref7$children = _ref7.children,
+    children = _ref7$children === void 0 ? {} : _ref7$children;
   var componentIdMatch = i18nKey.match(/<\/[A-Za-z0-9]+?>/);
-
   if (componentIdMatch) {
     var componentId = componentIdMatch[0].substring(2, componentIdMatch[0].length - 1);
     var childWithOpenTag = (i18nKey.match(new RegExp("(.*?)(?=</".concat(componentId, ">)"))) || [])[0] || '';
     var child = childWithOpenTag.split("<".concat(componentId, ">")).pop();
-
     var _generateChildren = generateChildren({
-      children: children,
-      child: child
-    }),
-        _newChildren = _generateChildren.newChildren,
-        _stringPlaceHolders = _generateChildren.stringPlaceHolders;
-
+        children: children,
+        child: child
+      }),
+      _newChildren = _generateChildren.newChildren,
+      _stringPlaceHolders = _generateChildren.stringPlaceHolders;
     var childrenLength = Object.keys(children).length;
     children["0".concat(childrenLength).concat(componentId)] = createElement({
       componentId: componentId,
@@ -202,21 +170,18 @@ function prepareI18NFunc() {
       children: children
     });
   }
-
   var _generateChildren2 = generateChildren({
-    child: i18nKey,
-    children: children
-  }),
-      newChildren = _generateChildren2.newChildren,
-      stringPlaceHolders = _generateChildren2.stringPlaceHolders;
-
+      child: i18nKey,
+      children: children
+    }),
+    newChildren = _generateChildren2.newChildren,
+    stringPlaceHolders = _generateChildren2.stringPlaceHolders;
   return createElement({
     componentId: -1,
     children: newChildren,
     stringPlaceHolders: stringPlaceHolders
   });
 }
-
 function i18nMechanismForComponents(i18nValue, key) {
   if (typeof i18nValue === 'string') {
     i18nValue = (0, _index.unescapeUnicode)(i18nValue);
@@ -226,30 +191,26 @@ function i18nMechanismForComponents(i18nValue, key) {
     window.loadI18nChunk && window.loadI18nChunk(_defineProperty({}, key, value));
     i18nValue = value;
   }
-
   return i18nValue;
 }
-
 function placeComponentForTags(i18nValue) {
   var value = _I18NProvider.i18NProviderUtils.getI18NComponent(i18nValue);
-
   return i18nMechanismForComponents(value, value);
 }
-
 function getI18NComponent(i18n) {
   if (typeof i18n === 'undefined') {
+    (0, _errorReporter.reportI18NError)(_errorReporter.I18N_ERROR_TYPES.UNDEFINED_OBJECT, 'i18n_object_jsx');
     return function (key) {
       return key;
     };
   }
-
   return function (key) {
     var i18nStr = i18n[key];
-
     if (i18nStr === undefined) {
-      return key;
+      var isNumeric = /^\d+$/.test(key);
+      (0, _errorReporter.reportI18NError)(isNumeric ? _errorReporter.I18N_ERROR_TYPES.NUMERIC_FALLBACK : _errorReporter.I18N_ERROR_TYPES.MISSING_KEY, key);
+      return (0, _errorReporter.getFallbackText)(key);
     }
-
     return i18nMechanismForComponents(i18nStr, key);
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/i18n",
-  "version": "1.0.0-beta.34",
+  "version": "1.0.0-beta.36-murphy",
   "main": "lib/index",
   "module": "es/index.js",
   "jsnext:main": "es/index.js",

package/src/index.js

@@ -21,6 +21,11 @@ export {
   monthi18n,
   timei18n
 } from './utils';
+export {
+  reportI18NError,
+  clearReportedKeys,
+  I18N_ERROR_TYPES
+} from './utils/errorReporter';
 import { getI18NValue as getI18NValue1 } from './utils';
 export { I18NContext } from './I18NContext';
 export {

package/src/utils/errorReporter.js

@@ -0,0 +1,41 @@
+export const I18N_ERROR_TYPES = {
+  UNDEFINED_OBJECT: 'I18N_UNDEFINED_OBJECT',
+  MISSING_KEY: 'I18N_MISSING_KEY',
+  NUMERIC_FALLBACK: 'I18N_NUMERIC_FALLBACK'
+};
+
+const reportedKeys = new Set();
+
+function isMurphyAvailable() {
+  return typeof murphy !== 'undefined' && typeof murphy.error === 'function';
+}
+
+export function reportI18NError(type, key) {
+  const dedupeKey = `${type}:${key}`;
+  if (reportedKeys.has(dedupeKey)) {
+    return;
+  }
+  reportedKeys.add(dedupeKey);
+
+  if (isMurphyAvailable()) {
+    const error = new Error(`i18n ${type}: ${key}`);
+    error.name = type;
+
+    murphy.error(error, undefined, {
+      customTags: {
+        errorType: type,
+        i18nKey: key,
+        category: 'i18n'
+      },
+      preventClientGrouping: true
+    });
+  }
+}
+export function clearReportedKeys() {
+  reportedKeys.clear();
+}
+
+export function getFallbackText(key) {
+  const isNumeric = /^\d+$/.test(key);
+  return isNumeric ? `text.unavailable.${key}` : key;
+}

package/src/utils/index.js

@@ -2,6 +2,7 @@ import datetime from '@zohodesk/datetimejs';
 import {
   i18NProviderUtils
 } from '../components/I18NProvider';
+import { reportI18NError, I18N_ERROR_TYPES, getFallbackText } from './errorReporter';
 
 export const dayi18n = {
   'Sun': 'deskreact.calendar.daynameshort.sunday',
@@ -290,6 +291,7 @@ export function getLocalizedValue({
 }
 export function getI18NValue(i18n) {
   if (typeof i18n === 'undefined') {
+    reportI18NError(I18N_ERROR_TYPES.UNDEFINED_OBJECT, 'i18n_object');
     return (key) => key;
   }
   return (key, values, localizedProps) => {
@@ -297,7 +299,12 @@ export function getI18NValue(i18n) {
     const finalKey = getMappedKey(key);
     let i18nStr = i18n[finalKey];
     if (i18nStr === undefined) {
-      return localizedValue || finalKey;
+      const isNumeric = /^\d+$/.test(finalKey);
+      reportI18NError(
+        isNumeric ? I18N_ERROR_TYPES.NUMERIC_FALLBACK : I18N_ERROR_TYPES.MISSING_KEY,
+        finalKey
+      );
+      return localizedValue || getFallbackText(finalKey);
     }
     i18nStr = replaceI18NValuesWithRegex(i18nStr, values);
     return localizedValue || unescapeUnicode(i18nStr);

package/src/utils/jsxTranslations.js

@@ -5,6 +5,7 @@ import {
 import {
     i18NProviderUtils
 } from "../components/I18NProvider";
+import { reportI18NError, I18N_ERROR_TYPES, getFallbackText } from './errorReporter';
 
 export function splitMatchedExp({
     expression,
@@ -180,12 +181,18 @@ export function placeComponentForTags(i18nValue) {
 
 export function getI18NComponent(i18n) {
     if(typeof i18n === 'undefined') {
+        reportI18NError(I18N_ERROR_TYPES.UNDEFINED_OBJECT, 'i18n_object_jsx');
         return (key) => key;
     }
     return (key) => {
         let i18nStr = i18n[key];
         if (i18nStr === undefined) {
-            return  key;
+            const isNumeric = /^\d+$/.test(key);
+            reportI18NError(
+                isNumeric ? I18N_ERROR_TYPES.NUMERIC_FALLBACK : I18N_ERROR_TYPES.MISSING_KEY,
+                key
+            );
+            return getFallbackText(key);
         }
         return i18nMechanismForComponents(i18nStr, key);
     }