i18nizeelement 0.3.0 → 0.5.0

package/dist/i18nizeelement-jamilih-plugin.umd.js

@@ -1,293 +1,312 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
-    typeof define === 'function' && define.amd ? define(factory) :
-    (global = global || self, global.i18nizeElementJamilihPlugin = factory());
-}(this, (function () { 'use strict';
-
-    /**
-     * Copyright 2015, Yahoo! Inc.
-     * Copyrights licensed under the New BSD License. See the accompanying LICENSE file for terms.
-     */
-
-    var self;
-    var RtlDetectLib = self = {
-      // eslint-disable-line consistent-this
-      // Private functions - star
-      _escapeRegExpPattern: function (str) {
-        if (typeof str !== 'string') {
-          return str;
-        }
-
-        return str.replace(/([\.\*\+\^\$\[\]\\\(\)\|\{\}\,\-\:\?])/g, '\\$1'); // eslint-disable-line no-useless-escape
-      },
-      _toLowerCase: function (str, reserveReturnValue) {
-        if (typeof str !== 'string') {
-          return reserveReturnValue && str;
-        }
-
-        return str.toLowerCase();
-      },
-      _toUpperCase: function (str, reserveReturnValue) {
-        if (typeof str !== 'string') {
-          return reserveReturnValue && str;
-        }
-
-        return str.toUpperCase();
-      },
-      _trim: function (str, delimiter, reserveReturnValue) {
-        var patterns = [];
-        var regexp;
-
-        var addPatterns = function (pattern) {
-          // Build trim RegExp pattern and push it to patterns array
-          patterns.push('^' + pattern + '+|' + pattern + '+$');
-        }; // fix reserveReturnValue value
-
-
-        if (typeof delimiter === 'boolean') {
-          reserveReturnValue = delimiter;
-          delimiter = null;
-        }
-
-        if (typeof str !== 'string') {
-          return reserveReturnValue && str;
-        } // Trim based on delimiter array values
-
-
-        if (Array.isArray(delimiter)) {
-          // Loop through delimiter array
-          delimiter.map(function (item) {
-            // Escape delimiter to be valid RegExp Pattern
-            var pattern = self._escapeRegExpPattern(item); // Push pattern to patterns array
-
-
-            addPatterns(pattern);
-          });
-        } // Trim based on delimiter string value
-
-
-        if (typeof delimiter === 'string') {
-          // Escape delimiter to be valid RegExp Pattern
-          var patternDelimiter = self._escapeRegExpPattern(delimiter); // push pattern to patterns array
-
-
-          addPatterns(patternDelimiter);
-        } // If delimiter  is not defined, Trim white spaces
-
-
-        if (!delimiter) {
-          // Push white space pattern to patterns array
-          addPatterns('\\s');
-        } // Build RegExp pattern
-
-
-        var pattern = '(' + patterns.join('|') + ')'; // Build RegExp object
-
-        regexp = new RegExp(pattern, 'g'); // trim string for all patterns
-
-        while (str.match(regexp)) {
-          str = str.replace(regexp, '');
-        } // Return trim string
-
+  typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
+  typeof define === 'function' && define.amd ? define(factory) :
+  (global = typeof globalThis !== 'undefined' ? globalThis : global || self, global.i18nizeElementJamilihPlugin = factory());
+})(this, (function () { 'use strict';
+
+  /**
+   * Copyright 2015, Yahoo! Inc.
+   * Copyrights licensed under the New BSD License. See the accompanying LICENSE file for terms.
+   */
+
+  // Private vars - star
+  const _regexEscape = /([\.\*\+\^\$\[\]\\\(\)\|\{\}\,\-\:\?])/g; // eslint-disable-line no-useless-escape
+  const _regexParseLocale = /^([a-zA-Z]+)([-a-zA-Z]*)$/;
+  // Private vars - end
+
+  class Locale {
+    // eslint-disable-line consistent-this
+
+    constructor(locale) {
+      if (typeof locale !== 'string') {
+        throw new TypeError('A string argument is expected');
+      }
+      if (!_regexParseLocale.test(locale)) {
+        throw new RangeError('A proper locale must be provided');
+      }
+      this._locale = locale;
+    }
 
+    // Private functions - star
+    static _escapeRegExpPattern(str) {
+      if (typeof str !== 'string') {
         return str;
-      },
-      _parseLocale: function (strLocale) {
-        // parse locale regex object
-        var regex = /^([a-zA-Z]*)([_\-a-zA-Z]*)$/;
-        var matches = regex.exec(strLocale); // exec regex
-
-        var parsedLocale;
-        var lang;
-        var countryCode;
-
-        if (!strLocale || !matches) {
-          return;
-        } // fix countryCode string by trimming '-' and '_'
-
-
-        matches[2] = self._trim(matches[2], ['-', '_']);
-        lang = self._toLowerCase(matches[1]);
-        countryCode = self._toUpperCase(matches[2]) || countryCode; // object with lang, countryCode properties
-
-        parsedLocale = {
-          lang: lang,
-          countryCode: countryCode
-        }; // return parsed locale object
-
-        return parsedLocale;
-      },
-      // Private functions - End
-      // Public functions - star
-      isRtlLang: function (strLocale) {
-        var objLocale = self._parseLocale(strLocale);
-
-        if (!objLocale) {
-          return;
-        } // return true if the intel string lang exists in the BID RTL LANGS array else return false
-
-
-        return self._BIDI_RTL_LANGS.indexOf(objLocale.lang) >= 0;
-      },
-      getLangDir: function (strLocale) {
-        // return 'rtl' if the intel string lang exists in the BID RTL LANGS array else return 'ltr'
-        return self.isRtlLang(strLocale) ? 'rtl' : 'ltr';
-      } // Public functions - End
-
-    }; // Const BIDI_RTL_LANGS Array
-    // BIDI_RTL_LANGS ref: http://en.wikipedia.org/wiki/Right-to-left
-    // Table of scripts in Unicode: https://en.wikipedia.org/wiki/Script_(Unicode)
-
-    Object.defineProperty(self, '_BIDI_RTL_LANGS', {
-      value: ['ae',
-      /* Avestan */
-      'ar',
-      /* 'العربية', Arabic */
-      'arc',
-      /* Aramaic */
-      'bcc',
-      /* 'بلوچی مکرانی', Southern Balochi */
-      'bqi',
-      /* 'بختياري', Bakthiari */
-      'ckb',
-      /* 'Soranî / کوردی', Sorani */
-      'dv',
-      /* Dhivehi */
-      'fa',
-      /* 'فارسی', Persian */
-      'glk',
-      /* 'گیلکی', Gilaki */
-      'he',
-      /* 'עברית', Hebrew */
-      'ku',
-      /* 'Kurdî / كوردی', Kurdish */
-      'mzn',
-      /* 'مازِرونی', Mazanderani */
-      'nqo',
-      /* N'Ko */
-      'pnb',
-      /* 'پنجابی', Western Punjabi */
-      'ps',
-      /* 'پښتو', Pashto, */
-      'sd',
-      /* 'سنڌي', Sindhi */
-      'ug',
-      /* 'Uyghurche / ئۇيغۇرچە', Uyghur */
-      'ur',
-      /* 'اردو', Urdu */
-      'yi'
-      /* 'ייִדיש', Yiddish */
-      ],
-      writable: false,
-      enumerable: true,
-      configurable: false
-    });
-    var rtlDetect = RtlDetectLib;
-
-    var rtlDetect_1 = {
-      isRtlLang: rtlDetect.isRtlLang,
-      getLangDir: rtlDetect.getLangDir
-    };
-
-    // e.g., `i18nizeElement(document.title, {language: 'ar-AR'});`
-
-    const i18nizeElement = (element, {
-      language,
-      // These avoid setting if found to be already set with the same value
-      //   on the closest ancestor
-      avoidLangIfSet = true,
-      avoidDirIfSet = true,
-      // This avoids setting LTR if there is no ancestor with `dir` (since
-      //  LTR is the default)
-      avoidLTRByDefault = true
-    } = {}) => {
-      if (!element || !language) {
-        throw new TypeError('You must supply an element and language');
       }
-
-      let presetLangElement; // We set `lang` if:
-      //   1. The user is not avoiding setting `lang` when the supplied language
-      //      is the same as the closest ancestor with `lang`
-      //   2. There is no ancestor with `lang`
-      //   3. The closest ancestor with `lang` has a different language from
-      //       the supplied
-
-      if (avoidLangIfSet) {
-        presetLangElement = element.closest('[lang]');
+      return str.replace(_regexEscape, '\\$1');
+    }
+    static _toLowerCase(str, reserveReturnValue) {
+      if (typeof str !== 'string') {
+        return reserveReturnValue && str;
       }
-
-      if (!presetLangElement || presetLangElement.lang !== language) {
-        element.lang = language;
-      } // See <https://github.com/tc39/ecma402/issues/205> for request for JavaScript to detect this
-      // We set `dir` if:
-      //    1. The user is not avoiding setting `dir` when the supplied
-      //       language's directionality is the same as the closest ancestor
-      //       with `dir`
-      //    2. There is no ancestor with `dir` (and this is either not an LTR
-      //        direction or the user isn't avoiding (the default) LTR)
-      //    3. The closest ancestor with `dir` has a different `dir` from the
-      //        direction of the supplied language
-
-
-      const dir = rtlDetect_1.getLangDir(language);
-      let presetDirElement;
-
-      if (avoidDirIfSet || // If avoiding the default LTR except when different (even if not
-      //   avoiding an (RTL) already-set dir), we need to know if different
-      avoidLTRByDefault && dir === 'ltr') {
-        presetDirElement = element.closest('[dir]');
+      return str.toLowerCase();
+    }
+    static _toUpperCase(str, reserveReturnValue) {
+      if (typeof str !== 'string') {
+        return reserveReturnValue && str;
+      }
+      return str.toUpperCase();
+    }
+    static _trim(str, delimiter, reserveReturnValue) {
+      const patterns = [];
+      let regexp;
+      const addPatterns = function (pattern) {
+        // Build trim RegExp pattern and push it to patterns array
+        patterns.push('^' + pattern + '+|' + pattern + '+$');
+      };
+
+      // fix reserveReturnValue value
+      if (typeof delimiter === 'boolean') {
+        reserveReturnValue = delimiter;
+        delimiter = null;
+      }
+      if (typeof str !== 'string') {
+        return reserveReturnValue && str;
       }
 
-      if ( // If the closest ancestor with `dir` is different, we need to
-      //  set regardless
-      presetDirElement && presetDirElement.dir !== dir || // We set if the user is not avoiding (whether there is no ancestor
-      //   with `div` or even when there is and the language has the same
-      //   directionality as the closest ancestor with `dir`) OR
-      !avoidDirIfSet || // ...if there is no ancestor with `dir` AND...
-      !presetDirElement && ( // this is either not an LTR direction or the user isn't
-      //  avoiding (the default) LTR
-      !avoidLTRByDefault || dir !== 'ltr')) {
-        element.dir = dir;
-        /* istanbul ignore next */
-
-        if (dir === 'ttb') {
-          // Assumes https://github.com/shadiabuhilal/rtl-detect/issues/2
-          element.style.writingMode = 'vertical-lr';
-        }
+      // Trim based on delimiter array values
+      if (Array.isArray(delimiter)) {
+        // Loop through delimiter array
+        delimiter.map(item => {
+          // Escape delimiter to be valid RegExp Pattern
+          const pattern = this._escapeRegExpPattern(item);
+          // Push pattern to patterns array
+          addPatterns(pattern);
+        });
       }
-    };
 
-    const plugin = {
-      name: '$_language',
+      // Trim based on delimiter string value
+      if (typeof delimiter === 'string') {
+        // Escape delimiter to be valid RegExp Pattern
+        const patternDelimiter = this._escapeRegExpPattern(delimiter);
+        // push pattern to patterns array
+        addPatterns(patternDelimiter);
+      }
 
-      async set({
-        element,
-        attribute: {
-          value: options
-        }
-      }) {
-        if (typeof options === 'string') {
-          options = {
-            language: options
-          };
-        } else if (Array.isArray(options)) {
-          options = { ...options[1],
-            language: options[0]
-          };
-        } // We don't immediately internationalize
-        //   because Jamilih has not yet appended
-        //   the child element into the ancestors
-        //   it is being built with
+      // If delimiter  is not defined, Trim white spaces
+      if (!delimiter) {
+        // Push white space pattern to patterns array
+        addPatterns('\\s');
+      }
 
+      // Build RegExp pattern
+      const pattern = '(' + patterns.join('|') + ')';
+      // Build RegExp object
+      regexp = new RegExp(pattern, 'g');
 
-        await Promise.resolve();
-        i18nizeElement(element, { ...options
-        });
+      // trim string for all patterns
+      while (str.match(regexp)) {
+        str = str.replace(regexp, '');
       }
 
-    };
-
-    return plugin;
+      // Return trim string
+      return str;
+    }
+    static _parseLocale(strLocale) {
+      var matches = _regexParseLocale.exec(strLocale); // exec regex
+      let parsedLocale;
+      let lang;
+      let countryCode;
+      if (!strLocale || !matches) {
+        return;
+      }
 
-})));
+      // fix countryCode string by trimming '-' and '_'
+      matches[2] = this._trim(matches[2], ['-', '_']);
+      lang = this._toLowerCase(matches[1]);
+      countryCode = this._toUpperCase(matches[2]) || countryCode;
+
+      // object with lang, countryCode properties
+      parsedLocale = {
+        lang,
+        countryCode
+      };
+
+      // return parsed locale object
+      return parsedLocale;
+    }
+    // Private functions - End
+
+    _isRtlLang() {
+      const objLocale = this.constructor._parseLocale(this._locale);
+
+      // return true if the intel string lang exists in the BID RTL LANGS array else return false
+      return this.constructor._BIDI_RTL_LANGS.indexOf(objLocale.lang) >= 0;
+    }
+
+    // Public functions - star
+    get textInfo() {
+      // return 'rtl' if the intel string lang exists in the BID RTL LANGS array else return 'ltr'
+      const direction = this._isRtlLang() ? 'rtl' : 'ltr';
+      return {
+        direction
+      };
+    }
+
+    // Public functions - End
+  }
+
+  // Why not working as static property
+  Locale._BIDI_RTL_LANGS = [
+  // Const BIDI_RTL_LANGS Array
+  // BIDI_RTL_LANGS ref: http://en.wikipedia.org/wiki/Right-to-left
+  // Table of scripts in Unicode: https://en.wikipedia.org/wiki/Script_(Unicode)
+  'ae', /* Avestan */
+  'ar', /* 'العربية', Arabic */
+  'arc', /* Aramaic */
+  'bcc', /* 'بلوچی مکرانی', Southern Balochi */
+  'bqi', /* 'بختياري', Bakthiari */
+  'ckb', /* 'Soranî / کوردی', Sorani */
+  'dv', /* Dhivehi */
+  'fa', /* 'فارسی', Persian */
+  'glk', /* 'گیلکی', Gilaki */
+  'he', /* 'עברית', Hebrew */
+  'ku', /* 'Kurdî / كوردی', Kurdish */
+  'mzn', /* 'مازِرونی', Mazanderani */
+  'nqo', /* N'Ko */
+  'pnb', /* 'پنجابی', Western Punjabi */
+  'prs', /* 'دری', Darī */
+  'ps', /* 'پښتو', Pashto, */
+  'sd', /* 'سنڌي', Sindhi */
+  'ug', /* 'Uyghurche / ئۇيغۇرچە', Uyghur */
+  'ur', /* 'اردو', Urdu */
+  'yi' /* 'ייִדיש', Yiddish */];
+
+  if (typeof Intl === 'undefined') {
+    globalThis.Intl = {};
+  }
+  if (typeof Intl.Locale === 'undefined') {
+    Intl.Locale = Locale;
+  }
+
+  // e.g., `i18nizeElement(document.title, {language: 'ar-AR'});`
+
+  /**
+   * @param {HTMLElement} element
+   * @param {{
+   *   language?: string,
+   *   avoidLangIfSet?: boolean,
+   *   avoidDirIfSet?: boolean,
+   *   avoidLTRByDefault?: boolean
+   * }} cfg
+   */
+  const i18nizeElement = (element, {
+    language,
+    // These avoid setting if found to be already set with the same value
+    //   on the closest ancestor
+    avoidLangIfSet = true,
+    avoidDirIfSet = true,
+    // This avoids setting LTR if there is no ancestor with `dir` (since
+    //  LTR is the default)
+    avoidLTRByDefault = true
+  } = {}) => {
+    if (!element || !language) {
+      throw new TypeError('You must supply an element and language');
+    }
+    let presetLangElement;
+
+    // We set `lang` if:
+    //   1. The user is not avoiding setting `lang` when the supplied language
+    //      is the same as the closest ancestor with `lang`
+    //   2. There is no ancestor with `lang`
+    //   3. The closest ancestor with `lang` has a different language from
+    //       the supplied
+    if (avoidLangIfSet) {
+      presetLangElement = /** @type {HTMLElement} */
+      element.closest('[lang]');
+    }
+    if (!presetLangElement || presetLangElement.lang !== language) {
+      element.lang = language;
+    }
+
+    // See <https://github.com/tc39/ecma402/issues/205> for request for JavaScript to detect this
+    // We set `dir` if:
+    //    1. The user is not avoiding setting `dir` when the supplied
+    //       language's directionality is the same as the closest ancestor
+    //       with `dir`
+    //    2. There is no ancestor with `dir` (and this is either not an LTR
+    //        direction or the user isn't avoiding (the default) LTR)
+    //    3. The closest ancestor with `dir` has a different `dir` from the
+    //        direction of the supplied language
+    const {
+      direction: dir
+    } =
+    /**
+     * @type {Intl.Locale & {
+     *   textInfo: {direction: "ltr"|"rtl"|"ttb"}
+     * }}
+     */
+    new Intl.Locale(language).textInfo;
+
+    /** @type {HTMLElement|undefined} */
+    let presetDirElement;
+    if (avoidDirIfSet ||
+    // If avoiding the default LTR except when different (even if not
+    //   avoiding an (RTL) already-set dir), we need to know if different
+    avoidLTRByDefault && dir === 'ltr') {
+      presetDirElement = /** @type {HTMLElement} */
+      element.closest('[dir]');
+    }
+    if (
+    // If the closest ancestor with `dir` is different, we need to
+    //  set regardless
+    presetDirElement && presetDirElement.dir !== dir ||
+    // We set if the user is not avoiding (whether there is no ancestor
+    //   with `div` or even when there is and the language has the same
+    //   directionality as the closest ancestor with `dir`) OR
+    !avoidDirIfSet ||
+    // ...if there is no ancestor with `dir` AND...
+    !presetDirElement && (
+    // this is either not an LTR direction or the user isn't
+    //  avoiding (the default) LTR
+    !avoidLTRByDefault || dir !== 'ltr')) {
+      element.dir = dir;
+
+      /* c8 ignore next 3 */
+      if (dir === 'ttb') {
+        element.style.writingMode = 'vertical-lr';
+      }
+    }
+  };
+
+  /** @type {import('jamilih').JamilihPlugin} */
+  const plugin = {
+    name: '$_language',
+    async set({
+      element,
+      attribute: {
+        value
+      }
+    }) {
+      let options = /** @type {import('jamilih').PluginValue} */
+      value;
+      if (typeof options === 'string') {
+        options = {
+          language: options
+        };
+      } else if (Array.isArray(options)) {
+        options = {
+          ...options[1],
+          language: options[0]
+        };
+      }
+      // We don't immediately internationalize
+      //   because Jamilih has not yet appended
+      //   the child element into the ancestors
+      //   it is being built with
+      await Promise.resolve();
+      i18nizeElement( /** @type {HTMLElement} */element, {
+        ...
+        /**
+         * @type {{
+         *   [key: string]: any;
+         * }}
+         */
+        options
+      });
+    }
+  };
+
+  return plugin;
+
+}));
 //# sourceMappingURL=i18nizeelement-jamilih-plugin.umd.js.map