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

package/es/index.js

@@ -1,4 +1,5 @@
 export { formatDate, pad, replaceI18NValuesWithRegex, unescapeUnicode, getValues, getI18NInfo, isToday, isYesterday, isTomorrow, isWithinAWeek, isTwoWeeksOrMore, userDateFormat, getDiffObj, getLyears, getSuffix, getDatePatternWithoutYear, setLocalizedData, setI18NKeyMapping, dayi18n, monthi18n, timei18n } from "./utils";
+export { reportI18NError, clearReportedKeys, I18N_ERROR_TYPES } from "./utils/errorReporter";
 import { getI18NValue as getI18NValue1 } from "./utils";
 export { I18NContext } from "./I18NContext";
 export { default as I18NProvider, i18NProviderUtils } from "./components/I18NProvider";

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

@@ -1,17 +1,13 @@
 import React from 'react';
 import { splitMatchedExp, generateChildren, replaceWithComponentPlaceHolder, createElement, prepareI18NFunc, getI18NComponent } from "../jsxTranslations";
-
-function Bold(_ref) {
-  let {
-    children
-  } = _ref;
+function Bold({
+  children
+}) {
   return /*#__PURE__*/React.createElement("b", null, children);
 }
-
 function Simple(props) {
   return /*#__PURE__*/React.createElement("span", null, props.children);
 }
-
 describe('Verifying splitMatchedExp method', () => {
   it('A string with no match test', () => {
     const response = splitMatchedExp({

package/es/utils/errorReporter.js

@@ -0,0 +1,35 @@
+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/es/utils/index.js

@@ -1,5 +1,6 @@
 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',
   'Mon': 'deskreact.calendar.daynameshort.monday',
@@ -68,36 +69,29 @@ export function formatDate(dateMill, mask, dateDiffObj) {
       betweenleepYears,
       crntMonth
     } = dateDiffObj;
-
     if (years > 0) {
       return `${years}y`;
     } else if (yDays > 0) {
       let isFeb = crntMonth === 1;
       let isThoneMonth = [0, 2, 4, 6, 7, 9, 11].indexOf(crntMonth) != -1;
-
       let weekCal = function (calDays) {
         let weeks = calDays / 7;
         return weeks < 1 ? `${calDays}d` : `${Math.trunc(weeks)}w`;
       };
-
       if (!isFeb) {
         return isThoneMonth === true ? yDays === 31 ? '1m' : weekCal(yDays) : yDays === 30 ? '1m' : weekCal(yDays);
       }
-
       if (betweenleepYears != 0) {
         return isFeb === true && yDays === 28 ? '1m' : weekCal(yDays);
       }
-
       return isFeb === true && yDays === 29 ? '1m' : weekCal(yDays);
     } else if (hours < 24 && hours > 0) {
       return `${hours}h`;
     } else if (minutes < 60 && hours > 1) {
       return `${minutes}m`;
     }
-
     return seconds === 0 ? 'now' : `${seconds}s`;
   }
-
   let date = new Date(dateMill);
   let d = date.getDate();
   let D = date.getDay();
@@ -143,14 +137,11 @@ export function formatDate(dateMill, mask, dateDiffObj) {
     if (match in flags) {
       return flags[match];
     }
-
     return match.slice(1, match.length - 1);
   });
   return dat;
 }
-export function pad(n) {
-  let width = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 1;
-  let z = arguments.length > 2 ? arguments[2] : undefined;
+export function pad(n, width = 1, z) {
   z = z || '0';
   n = `${n}`;
   return n.length >= width ? n : new Array(width - n.length + 1).join(z) + n;
@@ -165,15 +156,12 @@ export function replaceI18NValuesWithRegex(i18nStr, values) {
       i18nStr = i18nStr.replace(new RegExp('\\{0\\}', 'g'), values);
     }
   }
-
   return i18nStr;
 }
 export function unescapeUnicode(str) {
   return str.replace(/\\u([a-fA-F0-9]{4})/g, (g, m1) => String.fromCharCode(parseInt(m1, 16)));
 }
-export function getValues() {
-  let params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
-  let diff = arguments.length > 1 ? arguments[1] : undefined;
+export function getValues(params = [], diff) {
   return params.map(param => diff[param]);
 }
 export function isObject(item) {
@@ -181,26 +169,19 @@ export function isObject(item) {
 }
 let localizedData = {};
 let localizedStringData = {};
-
 let getMappedKey = key => key;
-
-function setLocalizedStringData(data) {
-  let keyString = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
-
+function setLocalizedStringData(data, keyString = '') {
   if (typeof data === 'string') {
     localizedStringData[keyString] = data;
     return;
   }
-
   const keys = Object.keys(data);
-
   for (let i = 0; i < keys.length; i++) {
     const key = keys[i];
     const newKeyString = keyString ? `${keyString}.${key}` : key;
     setLocalizedStringData(data[key], newKeyString);
   }
 }
-
 export function setLocalizedData(data) {
   const translationData = isObject(data) ? data : {};
   localizedData = translationData;
@@ -209,33 +190,29 @@ export function setLocalizedData(data) {
 export function setI18NKeyMapping(func) {
   getMappedKey = func;
 }
-export function getLocalizedValue() {
-  let {
-    type,
-    moduleName,
-    deptName,
-    folderName,
-    reportId,
-    reportName,
-    apiName,
-    fieldValue,
-    layoutName
-  } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+export function getLocalizedValue({
+  type,
+  moduleName,
+  deptName,
+  folderName,
+  reportId,
+  reportName,
+  apiName,
+  fieldValue,
+  layoutName
+} = {}) {
   let localizedValue = localizedData;
-
   switch (type) {
     case 'field':
       ['Field', moduleName, apiName].map(key => {
         localizedValue = localizedValue[key] || '';
       });
       break;
-
     case 'picklist':
       ['PickListValue', moduleName, apiName, fieldValue].map(key => {
         localizedValue = localizedValue[key] || '';
       });
       break;
-
     case 'layout':
       if (deptName != null) {
         ['Layout', moduleName, deptName, layoutName].map(() => {
@@ -246,48 +223,44 @@ export function getLocalizedValue() {
           localizedValue = localizedValue[key] || '';
         });
       }
-
       break;
-
     case 'report':
       ['Report', deptName, folderName, reportName, reportId].map(key => {
         localizedValue = localizedValue[key] || '';
       });
-
     default:
       return null;
   }
-
   return localizedValue || null;
 }
 export function getI18NValue(i18n) {
   if (typeof i18n === 'undefined') {
+    reportI18NError(I18N_ERROR_TYPES.UNDEFINED_OBJECT, 'i18n_object');
     return key => key;
   }
-
   return (key, values, localizedProps) => {
     const localizedValue = localizedProps ? getLocalizedValue(localizedProps) : localizedStringData[key];
     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);
   };
-} // function getValues(params = [], diff) {
+}
+
+// function getValues(params = [], diff) {
 //   return params.map(param => {
 //     return diff[param];
 //   });
 // }
-
 export function getI18NInfo(toDateObj, props, diffObj) {
   let key = null,
-      values,
-      text = null;
-
+    values,
+    text = null;
   if (typeof props === 'function') {
     let value = props(diffObj1);
     key = value.key;
@@ -298,7 +271,6 @@ export function getI18NInfo(toDateObj, props, diffObj) {
   } else if (typeof props === 'string') {
     text = toDateObj.format(props);
   }
-
   return {
     key,
     values,
@@ -326,7 +298,6 @@ export function isTwoWeeksOrMore(fromDate, toDate) {
 export function getDatePatternWithoutYear(datePattern) {
   let dateObj;
   let delemiter;
-
   if (datePattern.indexOf('.') !== -1) {
     dateObj = datePattern.split('.');
     delemiter = '.';
@@ -340,26 +311,21 @@ export function getDatePatternWithoutYear(datePattern) {
     dateObj = datePattern.split(' ');
     delemiter = ' ';
   }
-
   return dateObj.filter(data => ['yy', 'yyyy'].indexOf(data) === -1).join(delemiter);
 }
 export function userDateFormat(getI18NValue, timezoneData, timeFormat, datePattern, isEnabledCurrentYear) {
-  return function (to, _ref, ago, later) {
-    let {
-      today,
-      yesterday,
-      tomorrow,
-      others
-    } = _ref;
-    let isSuffixEnable = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : false;
-    let format = arguments.length > 5 ? arguments[5] : undefined;
+  return (to, {
+    today,
+    yesterday,
+    tomorrow,
+    others
+  }, ago, later, isSuffixEnable = false, format) => {
     let fromDateObj = datetime.toDate(datetime.tz.utcToTz(null, timezoneData));
     let toDateObj = datetime.toDate(datetime.tz.utcToTz(to, timezoneData));
     let diffMin = new Date(to).getTime() - new Date().getTime();
     let from = new Date();
     from = from.toISOString();
     let suffix;
-
     if (diffMin < 0) {
       suffix = ago || '';
     } else if (diffMin > 0) {
@@ -367,7 +333,6 @@ export function userDateFormat(getI18NValue, timezoneData, timeFormat, datePatte
     } else {
       suffix = '';
     }
-
     let diff = getDiffObj(diffMin);
     let withInAWeak = diff.y === 0 && diff.yd <= 7;
     let diffObj = {
@@ -397,9 +362,10 @@ export function userDateFormat(getI18NValue, timezoneData, timeFormat, datePatte
       timeFormat: timeFormat,
       datePattern: datePattern,
       dateTimePattern: `${datePattern} ${timeFormat}`
-    }; //In if condition we'll remove year and set date format  if the current year is not required
-    //In else part we'll set the date format as it is
+    };
 
+    //In if condition we'll remove year and set date format  if the current year is not required
+    //In else part we'll set the date format as it is
     if (isEnabledCurrentYear === true && diffObj1.years === 0 && diffObj1.tYear === diffObj1.crntYear) {
       let dateFormat = getDatePatternWithoutYear(datePattern);
       diffObj1.dateFormat = dateFormat;
@@ -407,23 +373,23 @@ export function userDateFormat(getI18NValue, timezoneData, timeFormat, datePatte
     } else {
       diffObj1.dateFormat = datePattern;
       diffObj1.dateTimeFormat = `${datePattern} ${timeFormat}`;
-    } //var daysDiff = toDateObj.diff(fromDateObj, 'days');
+    }
 
+    //var daysDiff = toDateObj.diff(fromDateObj, 'days');
 
     let key = '';
     let values = [];
     let text = null;
-
     if (format) {
       let years, months, days, hours, minutes, seconds;
-      years = diffObj1.years > 1 ? '2' : diffObj1.years; //  months = diffObj1.months > 1 ? '2' : diffObj1.months;
+      years = diffObj1.years > 1 ? '2' : diffObj1.years;
+      //  months = diffObj1.months > 1 ? '2' : diffObj1.months;
       //  days = diffObj1.days > 1 ? '2' : diffObj1.days;
-
       days = diff.yd > 1 ? '2' : diff.yd;
       hours = diffObj1.hours > 1 ? '2' : diffObj1.hours;
-      minutes = diffObj1.minutes > 1 ? '2' : diffObj1.minutes; //seconds = diffObj1.seconds > 1 ? '2' : diffObj1.seconds;
+      minutes = diffObj1.minutes > 1 ? '2' : diffObj1.minutes;
+      //seconds = diffObj1.seconds > 1 ? '2' : diffObj1.seconds;
       // let pattern = '' + years + months + days + hours + minutes + seconds;
-
       let count = 0;
       let pattern = [years, days, hours, minutes].reduce((res, next) => {
         if (count === 2 || next === 0) {
@@ -434,11 +400,9 @@ export function userDateFormat(getI18NValue, timezoneData, timeFormat, datePatte
         } else {
           res = res + next;
         }
-
         return res;
       }, '');
       let value = format(diffObj1, pattern);
-
       if (value && typeof value === 'object') {
         key = value.key;
         values = getValues(value.params, diffObj);
@@ -449,32 +413,28 @@ export function userDateFormat(getI18NValue, timezoneData, timeFormat, datePatte
     } else {
       let dateObj = new Date(toDateObj);
       let curDateObj = new Date(fromDateObj);
-      let diffDayType = diffObj1.yDays; //In this condition, to calculate different days we have copied it from live --> diffDayType
+      let diffDayType = diffObj1.yDays;
 
+      //In this condition, to calculate different days we have copied it from live --> diffDayType
       if (isOverdue && dateObj.getDate() < curDateObj.getDate() && diffObj1.yDays == 0) {
         diffDayType = -1;
       }
-
       if (!isOverdue) {
         let diffHr = dateObj.getHours() - curDateObj.getHours();
-
         if (diffHr < 0) {
           diffDayType += 1;
         } else if (diffHr == 0) {
           let diffMins = dateObj.getMinutes() - curDateObj.getMinutes();
-
           if (diffMins < 0) {
             diffDayType += 1;
           } else if (diffMins == 0) {
             let diffSec = dateObj.getSeconds() - curDateObj.getSeconds();
-
             if (diffSec < 0) {
               diffDayType += 1;
             }
           }
         }
       }
-
       if (diff.y === 0 && (diffDayType === 0 || diffDayType === 1)) {
         if (today && dateObj.getDate() === curDateObj.getDate()) {
           if (typeof today === 'object') {
@@ -500,7 +460,6 @@ export function userDateFormat(getI18NValue, timezoneData, timeFormat, datePatte
           }
         } else {
           let value = others(diffObj1);
-
           if (typeof value === 'object') {
             key = value.key;
             values = getValues(value.params, diffObj);
@@ -511,7 +470,6 @@ export function userDateFormat(getI18NValue, timezoneData, timeFormat, datePatte
         }
       } else {
         let value = others(diffObj1);
-
         if (typeof value === 'object') {
           key = value.key;
           values = getValues(value.params, diffObj);
@@ -521,7 +479,6 @@ export function userDateFormat(getI18NValue, timezoneData, timeFormat, datePatte
         }
       }
     }
-
     let key1 = isSuffixEnable && suffix != '' ? `${key}.${suffix}` : key;
     return text || getI18NValue(key1, values);
   };
@@ -530,15 +487,12 @@ let oneYearInMillis = 31536000000;
 let oneDayInMillis = 86400000;
 let oneHourInMillis = 3600000;
 let oneMinuteInMillis = 60000;
-
 function convertAsNonExponential(number) {
   if (number.toString().toLowerCase().indexOf('e') !== -1) {
     return number.toFixed(20);
   }
-
   return number;
 }
-
 export function getDiffObj(diff) {
   diff = Math.abs(diff);
   let diffYears = diff / oneYearInMillis;
@@ -564,22 +518,19 @@ export function getDiffObj(diff) {
 }
 export function getLyears(from, to) {
   let dFrom = new Date(from),
-      dTo = new Date(to);
+    dTo = new Date(to);
   let fromYear = dFrom.getFullYear();
   let toYear = dTo.getFullYear();
   let arrayofLeapYears = [];
-
   for (let loopYear = fromYear; loopYear <= toYear; loopYear++) {
     if (loopYear % 4 === 0 && loopYear % 100 !== 0 || loopYear % 100 === 0 && loopYear % 400 === 0) {
       arrayofLeapYears.push(loopYear);
     }
   }
-
   return arrayofLeapYears.length;
 }
 export function getSuffix(min, ago, later) {
   let suffix;
-
   if (min < 0) {
     suffix = ago || '';
   } else if (min > 0) {
@@ -587,6 +538,5 @@ export function getSuffix(min, ago, later) {
   } else {
     suffix = '';
   }
-
   return suffix;
 }

package/es/utils/jsxTranslations.js

@@ -1,34 +1,30 @@
 import React from 'react';
 import { unescapeUnicode } from "./index";
 import { i18NProviderUtils } from "../components/I18NProvider";
-export function splitMatchedExp(_ref) {
-  let {
-    expression,
-    charLenToOmit,
-    string
-  } = _ref;
+import { reportI18NError, I18N_ERROR_TYPES, getFallbackText } from "./errorReporter";
+export function splitMatchedExp({
+  expression,
+  charLenToOmit,
+  string
+}) {
   let splitString = string.split(new RegExp(expression, 'g'));
   let matchedExpAll = string.matchAll(new RegExp(expression, 'g'));
   let matchedExpKeys = [];
-
   for (let match of matchedExpAll) {
     const value = match[0];
     matchedExpKeys.push(value.substring(charLenToOmit, value.length - charLenToOmit));
   }
-
   return {
     splitString,
     matchedExpKeys
   };
 }
-export function generateChildren(_ref2) {
-  let {
-    children,
-    child
-  } = _ref2;
+export function generateChildren({
+  children,
+  child
+}) {
   let newChildren = [],
-      stringPlaceHolders = {};
-
+    stringPlaceHolders = {};
   const handleString = string => {
     if (string) {
       let {
@@ -43,7 +39,6 @@ export function generateChildren(_ref2) {
       newChildren.push(splitString);
     }
   };
-
   let {
     splitString: splitChild,
     matchedExpKeys: childrenKeys
@@ -63,17 +58,15 @@ export function generateChildren(_ref2) {
     stringPlaceHolders
   };
 }
-export function createElement() {
-  let {
-    componentId,
-    children = [],
-    stringPlaceHolders = {}
-  } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  return function () {
-    let {
-      components = {},
-      values = []
-    } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+export function createElement({
+  componentId,
+  children = [],
+  stringPlaceHolders = {}
+} = {}) {
+  return ({
+    components = {},
+    values = []
+  } = {}) => {
     const {
       type = React.Fragment,
       props
@@ -85,46 +78,39 @@ export function createElement() {
           values
         });
       }
-
       let string = '',
-          stringIndex = 0;
+        stringIndex = 0;
       (stringPlaceHolders[index] || []).map((stringId, index) => {
         if (child[index]) {
           string += child[index];
         }
-
         string += values[stringId];
         stringIndex++;
       });
-
       if (child[stringIndex]) {
         string += child[stringIndex];
       }
-
       return string;
     });
     return /*#__PURE__*/React.createElement(type, props, ...childElements);
   };
 }
 ;
-export function replaceWithComponentPlaceHolder(_ref3) {
-  let {
-    componentId,
-    i18nKey,
-    childrenLength
-  } = _ref3;
+export function replaceWithComponentPlaceHolder({
+  componentId,
+  i18nKey,
+  childrenLength
+}) {
   const closingTagIndex = i18nKey.indexOf(`</${componentId}>`);
   const childWithOpenTag = i18nKey.substring(0, closingTagIndex);
   const openTagIndex = childWithOpenTag.lastIndexOf(`<${componentId}>`);
   return i18nKey.substring(0, openTagIndex) + `<0${childrenLength}${componentId}>` + i18nKey.substring(closingTagIndex + `${componentId}`.length + 3);
 }
-export function prepareI18NFunc() {
-  let {
-    i18nKey,
-    children = {}
-  } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+export function prepareI18NFunc({
+  i18nKey,
+  children = {}
+} = {}) {
   const componentIdMatch = i18nKey.match(/<\/[A-Za-z0-9]+?>/);
-
   if (componentIdMatch) {
     const componentId = componentIdMatch[0].substring(2, componentIdMatch[0].length - 1);
     const childWithOpenTag = (i18nKey.match(new RegExp(`(.*?)(?=<\/${componentId}>)`)) || [])[0] || '';
@@ -152,7 +138,6 @@ export function prepareI18NFunc() {
       children
     });
   }
-
   const {
     newChildren,
     stringPlaceHolders
@@ -166,7 +151,6 @@ export function prepareI18NFunc() {
     stringPlaceHolders
   });
 }
-
 function i18nMechanismForComponents(i18nValue, key) {
   if (typeof i18nValue === 'string') {
     i18nValue = unescapeUnicode(i18nValue);
@@ -178,26 +162,24 @@ function i18nMechanismForComponents(i18nValue, key) {
     });
     i18nValue = value;
   }
-
   return i18nValue;
 }
-
 export function placeComponentForTags(i18nValue) {
   const value = i18NProviderUtils.getI18NComponent(i18nValue);
   return i18nMechanismForComponents(value, value);
 }
 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);
   };
 }

package/lib/I18NContext.js

@@ -4,11 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.I18NContext = void 0;
-
 var _react = _interopRequireDefault(require("react"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
-var I18NContext = /*#__PURE__*/_react["default"].createContext();
-
-exports.I18NContext = I18NContext;
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+var I18NContext = exports.I18NContext = /*#__PURE__*/_react["default"].createContext();