npm - @carbon/ibmdotcom-services - Versions diffs - 1.55.1 → 1.56.0 - Mend

@carbon/ibmdotcom-services 1.55.1 → 1.56.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/es/internal/vendor/@carbon/ibmdotcom-utilities/utilities/settings/settings.js +3 -3
package/es/services/Locale/Locale.js +234 -143
package/lib/internal/vendor/@carbon/ibmdotcom-utilities/utilities/settings/settings.js +3 -3
package/lib/services/Locale/Locale.js +233 -143
package/package.json +2 -2
package/umd/ibmdotcom-services.js +235 -144
package/umd/ibmdotcom-services.min.js +2 -2

package/es/internal/vendor/@carbon/ibmdotcom-utilities/utilities/settings/settings.js CHANGED Viewed

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2020, 2023
+ * Copyright IBM Corp. 2020, 2024
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
@@ -11,10 +11,10 @@
  * @exports ibmdotcom.settings
  * @type {object} Settings object
  * @property {string} [prefix=dds]
- * Carbon for IBM.com v1.55.0',
+ * Carbon for IBM.com v1.56.0',
  */
 var settings = {
-  version: 'Carbon for IBM.com v1.55.0',
+  version: 'Carbon for IBM.com v1.56.0',
   stablePrefix: 'dds'
 };
 export default settings;

package/es/services/Locale/Locale.js CHANGED Viewed

@@ -1,10 +1,10 @@
 import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
-import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 /**
- * Copyright IBM Corp. 2020, 2022
+ * Copyright IBM Corp. 2020, 2024
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
@@ -16,15 +16,21 @@ import ipcinfoCookie from '../../internal/vendor/@carbon/ibmdotcom-utilities/uti
 import root from 'window-or-global';
 /**
- * @constant {string | string} Host for the Locale API call
+ * @typedef {object} Locale
+ * @property {string} cc The country code.
+ * @property {string} lc The language code.
+ */
+/**
+ * @constant {string | string} Host for the Locale API call.
  * @private
  */
 var _host = process && (process.env.REACT_APP_TRANSLATION_HOST || process.env.TRANSLATION_HOST) || 'https://1.www.s81c.com';
 /**
- * Sets the default location if nothing is returned
+ * Sets the default location if nothing is returned.
  *
- * @type {object}
+ * @type {Locale}
  * @private
  */
 var _localeDefault = {
@@ -33,7 +39,7 @@ var _localeDefault = {
 };
 /**
- * Default display name for lang combination
+ * Default display name for lang combination.
  *
  * @type {string}
  * @private
@@ -41,7 +47,7 @@ var _localeDefault = {
 var _localeNameDefault = 'United States — English';
 /**
- * Locale API endpoint
+ * Locale API endpoint.
  *
  * @type {string}
  * @private
@@ -49,7 +55,7 @@ var _localeNameDefault = 'United States — English';
 var _endpoint = "".concat(_host, "/common/js/dynamicnav/www/countrylist/jsononly");
 /**
- * Configuration for axios
+ * Configuration for axios.
  *
  * @type {{headers: {'Content-Type': string}}}
  * @private
@@ -61,7 +67,7 @@ var _axiosConfig = {
 };
 /**
- * Session Storage key for country list
+ * Session Storage key for country list.
  *
  * @type {string}
  * @private
@@ -77,44 +83,141 @@ var _sessionListKey = 'dds-countrylist';
 var _twoHours = 60 * 60 * 2000;
 /**
- * Use the <html> lang attr to determine a return locale object
+ * The cache for in-flight or resolved requests for the country list, keyed by
+ * the initiating locale.
  *
  * @type {object}
  * @private
  */
-var _getLocaleByLangAttr = function _getLocaleByLangAttr() {
+var _requestsList = {};
+/**
+ * Retrieves the default locale.
+ *
+ * @returns {Locale} The default locale.
+ */
+var _getLocaleDefault = function _getLocaleDefault() {
+  return _localeDefault;
+};
+/**
+ * Use the <html> lang attr to determine a return locale object, or "false"
+ * when it's not available so the consumer can decide what to do next.
+ *
+ * @type {(Locale | boolean)}
+ * @private
+ */
+function _getLocaleFromLangAttr() {
   var _root$document;
   if ((_root$document = root.document) !== null && _root$document !== void 0 && (_root$document = _root$document.documentElement) !== null && _root$document !== void 0 && _root$document.lang) {
     var lang = root.document.documentElement.lang.toLowerCase();
+    var locale = {};
     if (lang.indexOf('-') === -1) {
-      return {
-        lc: lang
-      };
+      locale.lc = lang;
     } else {
       var codes = lang.split('-');
-      return {
-        cc: codes[1],
-        lc: codes[0]
-      };
+      locale.cc = codes[1];
+      locale.lc = codes[0];
     }
-  } else {
-    return _localeDefault;
+    return locale;
   }
-};
+  return false;
+}
 /**
- * The cache for in-flight or resolved requests for the country list, keyed by the initiating locale.
+ * Gets the locale from the cookie and returns it if both 'cc' and 'lc' values
+ * are present.
  *
- * @type {object}
- * @private
+ * @async
+ * @returns {Promise<Locale|boolean>} The cookie object if 'cc' and 'lc' values are present, otherwise false.
  */
-var _requestsList = {};
+var _getLocaleFromCookie = /*#__PURE__*/function () {
+  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
+    var cookie;
+    return _regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          cookie = ipcinfoCookie.get();
+          if (!(cookie && cookie.cc && cookie.lc)) {
+            _context.next = 5;
+            break;
+          }
+          _context.next = 4;
+          return LocaleAPI.getList(cookie);
+        case 4:
+          return _context.abrupt("return", cookie);
+        case 5:
+          return _context.abrupt("return", false);
+        case 6:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  }));
+  return function _getLocaleFromCookie() {
+    return _ref.apply(this, arguments);
+  };
+}();
 /**
- * Return a locale object based on the DDO API, or "false"
- * so the consumer can decide what to do next
+ * Get the locale from the user's browser.
  *
- * @type {(object | boolean)}
+ * @async
+ * @returns {Promise<Locale|boolean>} The verified locale or false if not found.
+ */
+var _getLocaleFromBrowser = /*#__PURE__*/function () {
+  var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2() {
+    var cc, lang, lc, list, verifiedCodes;
+    return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          _context2.prev = 0;
+          _context2.next = 3;
+          return DDOAPI.getLocation();
+        case 3:
+          cc = _context2.sent;
+          // Language preference from browser can return in either 'en-US' format or
+          // 'en' so will need to extract language only.
+          lang = root.navigator.language;
+          lc = lang.split('-')[0];
+          if (!(cc && lc)) {
+            _context2.next = 13;
+            break;
+          }
+          _context2.next = 9;
+          return LocaleAPI.getList({
+            cc: cc,
+            lc: lc
+          });
+        case 9:
+          list = _context2.sent;
+          verifiedCodes = LocaleAPI.verifyLocale(cc, lc, list); // Set the ipcInfo cookie.
+          ipcinfoCookie.set(verifiedCodes);
+          return _context2.abrupt("return", verifiedCodes);
+        case 13:
+          _context2.next = 17;
+          break;
+        case 15:
+          _context2.prev = 15;
+          _context2.t0 = _context2["catch"](0);
+        case 17:
+          return _context2.abrupt("return", false);
+        case 18:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee2, null, [[0, 15]]);
+  }));
+  return function _getLocaleFromBrowser() {
+    return _ref2.apply(this, arguments);
+  };
+}();
+/**
+ * Return a locale object based on the DDO API, or "false" so the consumer can
+ * decide what to do next.
+ *
+ * @returns {(Locale | boolean)} Locale from the DDO, or "false" if not present.
  * @private
  */
 function _getLocaleFromDDO() {
@@ -152,8 +255,7 @@ function _getLocaleFromDDO() {
 }
 /**
- * Locale API class with method of fetching user's locale for
- * ibm.com
+ * Locale API class with method of fetching user's locale for ibm.com.
  */
 var LocaleAPI = /*#__PURE__*/function () {
   function LocaleAPI() {
@@ -180,14 +282,18 @@ var LocaleAPI = /*#__PURE__*/function () {
     }
     /**
-     * Gets the user's locale
+     * Gets the user's locale.
      *
-     * Grab the locale from the `lang` attribute from html, else
-     * check if ipcinfo cookie exists (ipcinfoCookie util)
-     * if not, retrieve the user's locale through DDO service + gets user's
-     * browser language preference then set the cookie
+     * Grab the locale from the available information on the page in the following
+     * order:
      *
-     * @returns {object} object with lc and cc
+     * 1. DDO
+     * 2. HTML lang attribute
+     * 3. ipcInfo cookie
+     * 4. Browser (navigator.language)
+     * 5. Default (us-EN)
+     *
+     * @returns {Promise<Locale>} Locale object.
      * @example
      * import { LocaleAPI } from '@carbon/ibmdotcom-services';
      *
@@ -199,60 +305,39 @@ var LocaleAPI = /*#__PURE__*/function () {
   }, {
     key: "getLocale",
     value: function () {
-      var _getLocale = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
-        var cookie, lang, cc, _lang, lc, list, verifiedCodes;
-        return _regeneratorRuntime.wrap(function _callee$(_context) {
-          while (1) switch (_context.prev = _context.next) {
+      var _getLocale = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3() {
+        var localeGetters, _i, _localeGetters, getter, locale;
+        return _regeneratorRuntime.wrap(function _callee3$(_context3) {
+          while (1) switch (_context3.prev = _context3.next) {
             case 0:
-              cookie = ipcinfoCookie.get();
-              _context.next = 3;
-              return this.getLang();
-            case 3:
-              lang = _context.sent;
-              if (!lang) {
-                _context.next = 8;
-                break;
-              }
-              return _context.abrupt("return", lang);
-            case 8:
-              if (!(cookie && cookie.cc && cookie.lc)) {
-                _context.next = 14;
+              localeGetters = [_getLocaleFromDDO, _getLocaleFromLangAttr, _getLocaleFromCookie, _getLocaleFromBrowser];
+              _i = 0, _localeGetters = localeGetters;
+            case 2:
+              if (!(_i < _localeGetters.length)) {
+                _context3.next = 12;
                 break;
               }
-              _context.next = 11;
-              return this.getList(cookie);
-            case 11:
-              return _context.abrupt("return", cookie);
-            case 14:
-              _context.next = 16;
-              return DDOAPI.getLocation();
-            case 16:
-              cc = _context.sent;
-              /**
-               * get language preference from browser
-               * can return in either 'en-US' format or 'en' so will need to extract language only
-               */
-              _lang = root.navigator.language;
-              lc = _lang.split('-')[0];
-              if (!(cc && lc)) {
-                _context.next = 26;
+              getter = _localeGetters[_i];
+              _context3.next = 6;
+              return getter();
+            case 6:
+              locale = _context3.sent;
+              if (!locale) {
+                _context3.next = 9;
                 break;
               }
-              _context.next = 22;
-              return this.getList({
-                cc: cc,
-                lc: lc
-              });
-            case 22:
-              list = _context.sent;
-              verifiedCodes = this.verifyLocale(cc, lc, list); // set the ipcInfo cookie
-              ipcinfoCookie.set(verifiedCodes);
-              return _context.abrupt("return", verifiedCodes);
-            case 26:
+              return _context3.abrupt("return", locale);
+            case 9:
+              _i++;
+              _context3.next = 2;
+              break;
+            case 12:
+              return _context3.abrupt("return", _getLocaleDefault());
+            case 13:
             case "end":
-              return _context.stop();
+              return _context3.stop();
           }
-        }, _callee, this);
+        }, _callee3);
       }));
       function getLocale() {
         return _getLocale.apply(this, arguments);
@@ -260,62 +345,69 @@ var LocaleAPI = /*#__PURE__*/function () {
       return getLocale;
     }()
     /**
-     * Checks for DDO object to return the correct cc and lc
-     * Otherwise gets those values from the <html> lang attribute
+     * Gets the user's locale.
      *
-     * @returns {object} locale object
+     * @returns {Promise<Locale>} Locale object.
      * @example
      * import { LocaleAPI } from '@carbon/ibmdotcom-services';
      *
      * function async getLocale() {
      *    const locale = await LocaleAPI.getLang();
      * }
+     *
+     * @deprecated in favor of LocalAPI.getLocale.
      */
   }, {
     key: "getLang",
-    value: function getLang() {
-      return new Promise(function (resolve) {
-        var getLocaleFromDDO = _getLocaleFromDDO();
-        if (getLocaleFromDDO) {
-          resolve(getLocaleFromDDO);
-        } else {
-          resolve(_getLocaleByLangAttr());
-        }
-      });
-    }
+    value: function () {
+      var _getLang = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4() {
+        return _regeneratorRuntime.wrap(function _callee4$(_context4) {
+          while (1) switch (_context4.prev = _context4.next) {
+            case 0:
+              return _context4.abrupt("return", this.getLocale());
+            case 1:
+            case "end":
+              return _context4.stop();
+          }
+        }, _callee4, this);
+      }));
+      function getLang() {
+        return _getLang.apply(this, arguments);
+      }
+      return getLang;
+    }()
     /**
-     * This fetches the language display name based on language/locale combo
+     * This fetches the language display name based on locale.
      *
-     * @param {object} langCode lang code with cc and lc
-     * @returns {Promise<string>} Display name of locale/language
+     * @param {(Locale | boolean)} locale (optional) If not given, uses LocaleAPI.getLocale logic.
+     * @returns {Promise<string>} Display name of locale/language.
      */
   }, {
     key: "getLangDisplay",
     value: function () {
-      var _getLangDisplay = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(langCode) {
+      var _getLangDisplay = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee5(locale) {
         var lang, list, countries, location;
-        return _regeneratorRuntime.wrap(function _callee2$(_context2) {
-          while (1) switch (_context2.prev = _context2.next) {
+        return _regeneratorRuntime.wrap(function _callee5$(_context5) {
+          while (1) switch (_context5.prev = _context5.next) {
             case 0:
-              if (!langCode) {
-                _context2.next = 4;
+              if (!locale) {
+                _context5.next = 4;
                 break;
               }
-              _context2.t0 = langCode;
-              _context2.next = 7;
+              _context5.t0 = locale;
+              _context5.next = 7;
               break;
             case 4:
-              _context2.next = 6;
-              return this.getLang();
+              _context5.next = 6;
+              return this.getLocale();
             case 6:
-              _context2.t0 = _context2.sent;
+              _context5.t0 = _context5.sent;
             case 7:
-              lang = _context2.t0;
-              _context2.next = 10;
+              lang = _context5.t0;
+              _context5.next = 10;
               return this.getList(lang);
             case 10:
-              list = _context2.sent;
+              list = _context5.sent;
               // combines the countryList arrays
               countries = [];
               list.regionList.forEach(function (region) {
@@ -337,17 +429,17 @@ var LocaleAPI = /*#__PURE__*/function () {
                 }
               });
               if (!location.length) {
-                _context2.next = 18;
+                _context5.next = 18;
                 break;
               }
-              return _context2.abrupt("return", "".concat(location[0].name, " \u2014 ").concat(location[0].locale[0][1]));
+              return _context5.abrupt("return", "".concat(location[0].name, " \u2014 ").concat(location[0].locale[0][1]));
             case 18:
-              return _context2.abrupt("return", _localeNameDefault);
+              return _context5.abrupt("return", _localeNameDefault);
             case 19:
             case "end":
-              return _context2.stop();
+              return _context5.stop();
           }
-        }, _callee2, this);
+        }, _callee5, this);
       }));
       function getLangDisplay(_x) {
         return _getLangDisplay.apply(this, arguments);
@@ -356,12 +448,12 @@ var LocaleAPI = /*#__PURE__*/function () {
     }()
     /**
      * Get the country list of all supported countries and their languages
-     * if it is not already stored in session storage
+     * if it is not already stored in session storage.
      *
-     * @param {object} params params object
-     * @param {string} params.cc country code
-     * @param {string} params.lc language code
-     * @returns {Promise<any>} promise object
+     * @param {Locale} locale Locale object.
+     * @param {string} locale.cc Country code.
+     * @param {string} locale.lc Language code.
+     * @returns {Promise<any>} Promise object.
      * @example
      * import { LocaleAPI } from '@carbon/ibmdotcom-services';
      *
@@ -373,21 +465,21 @@ var LocaleAPI = /*#__PURE__*/function () {
   }, {
     key: "getList",
     value: function () {
-      var _getList = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(_ref) {
+      var _getList = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee6(_ref3) {
         var _this = this;
         var cc, lc;
-        return _regeneratorRuntime.wrap(function _callee3$(_context3) {
-          while (1) switch (_context3.prev = _context3.next) {
+        return _regeneratorRuntime.wrap(function _callee6$(_context6) {
+          while (1) switch (_context6.prev = _context6.next) {
             case 0:
-              cc = _ref.cc, lc = _ref.lc;
-              return _context3.abrupt("return", new Promise(function (resolve, reject) {
+              cc = _ref3.cc, lc = _ref3.lc;
+              return _context6.abrupt("return", new Promise(function (resolve, reject) {
                 _this.fetchList(cc, lc, resolve, reject);
               }));
             case 2:
             case "end":
-              return _context3.stop();
+              return _context6.stop();
           }
-        }, _callee3);
+        }, _callee6);
       }));
       function getList(_x2) {
         return _getList.apply(this, arguments);
@@ -395,12 +487,12 @@ var LocaleAPI = /*#__PURE__*/function () {
       return getList;
     }()
     /**
-     * Fetches the list data based on cc/lc combination
+     * Fetches the list data based on cc/lc combination.
      *
-     * @param {string} cc country code
-     * @param {string} lc language code
-     * @param {Function} resolve resolves the Promise
-     * @param {Function} reject rejects the promise
+     * @param {string} cc Country code.
+     * @param {string} lc Language code.
+     * @param {Function} resolve Resolves the Promise.
+     * @param {Function} reject Rejects the promise.
      */
   }, {
     key: "fetchList",
@@ -432,13 +524,12 @@ var LocaleAPI = /*#__PURE__*/function () {
     }
     /**
-     * Verify that the cc and lc combo is in the list of
-     * supported cc-lc combos
+     * Verify that the cc and lc combo is in the list of supported cc-lc combos.
      *
-     * @param {string} cc country code
-     * @param {string} lc language code
-     * @param {object} list country list
-     * @returns {object} object with lc and cc
+     * @param {string} cc Country code.
+     * @param {string} lc Language code.
+     * @param {object} list Country list.
+     * @returns {object} Object with lc and cc.
      * @example
      * import { LocaleAPI } from '@carbon/ibmdotcom-services';
      *
@@ -455,8 +546,8 @@ var LocaleAPI = /*#__PURE__*/function () {
       var language = list && list.regionList.forEach(function (region) {
         return region.countryList.forEach(function (country) {
           var code = country.locale[0][0].split('-');
-          var countryCode = code[1];
           var languageCode = code[0];
+          var countryCode = code[1];
           if (countryCode === cc && languageCode === lc) {
             locale = {
               cc: cc,
@@ -481,7 +572,7 @@ var LocaleAPI = /*#__PURE__*/function () {
     /**
      * Retrieves session cache and checks if cache needs to be refreshed
      *
-     * @param   {string} key session storage key
+     * @param {string} key Session storage key.
      */
   }, {
     key: "getSessionCache",

package/lib/internal/vendor/@carbon/ibmdotcom-utilities/utilities/settings/settings.js CHANGED Viewed

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 /**
- * Copyright IBM Corp. 2020, 2023
+ * Copyright IBM Corp. 2020, 2024
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
@@ -17,10 +17,10 @@ exports.default = void 0;
  * @exports ibmdotcom.settings
  * @type {object} Settings object
  * @property {string} [prefix=dds]
- * Carbon for IBM.com v1.55.0',
+ * Carbon for IBM.com v1.56.0',
  */
 var settings = {
-  version: 'Carbon for IBM.com v1.55.0',
+  version: 'Carbon for IBM.com v1.56.0',
   stablePrefix: 'dds'
 };
 var _default = exports.default = settings;