ilib-localematcher 1.0.0 → 1.0.1

package/README.md

@@ -48,7 +48,7 @@ for specifics.
 
 ## License
 
-Copyright © 2021, JEDLSoft
+Copyright © 2021-2022, JEDLSoft
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -65,7 +65,16 @@ limitations under the License.
 
 ## Release Notes
 
+### v1.0.2
+
+- updated dependencies
+- added docs in markdown format as well
+
+### v1.0.1
+
+- updated dependencies
+
 ### v1.0.0
 
 - initial version
-- copied from ilib 14.9.0
+- copied from ilib 14.9.0

package/docs/LocaleMatcher.html

@@ -1225,7 +1225,7 @@ current locale and other locale
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Mon May 17 2021 22:40:28 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Mon Mar 14 2022 16:28:47 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/LocaleMatcher.js.html

@@ -451,7 +451,7 @@ export default LocaleMatcher;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Mon May 17 2021 22:40:28 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Mon Mar 14 2022 16:28:47 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/ilibLocaleMatcher.md

@@ -0,0 +1,235 @@
+<a name="LocaleMatcher"></a>
+
+## LocaleMatcher
+Represent a locale matcher instance, which is used
+to see which locales can be matched with each other in
+various ways.
+
+**Kind**: global class  
+
+* [LocaleMatcher](#LocaleMatcher)
+    * [new LocaleMatcher(options)](#new_LocaleMatcher_new)
+    * [.getLocale()](#LocaleMatcher+getLocale) ⇒ <code>Locale</code> \| <code>undefined</code>
+    * [.getLikelyLocale()](#LocaleMatcher+getLikelyLocale) ⇒ <code>Locale</code>
+    * [.getLikelyLocaleMinimal()](#LocaleMatcher+getLikelyLocaleMinimal) ⇒ <code>Locale</code>
+    * [.match(locale)](#LocaleMatcher+match) ⇒ <code>number</code>
+    * [.getMacroLanguage()](#LocaleMatcher+getMacroLanguage) ⇒ <code>string</code>
+    * [.getRegionContainment()](#LocaleMatcher+getRegionContainment) ⇒ <code>Array.&lt;string&gt;</code>
+    * [.smallestCommonRegion(otherLocale)](#LocaleMatcher+smallestCommonRegion) ⇒ <code>string</code>
+
+
+* * *
+
+<a name="new_LocaleMatcher_new"></a>
+
+### new LocaleMatcher(options)
+Create a new locale matcher instance. This is used
+to see which locales can be matched with each other in
+various ways.<p>
+
+The options object may contain any of the following properties:
+
+<ul>
+<li><i>locale</i> - the locale instance or locale spec to match
+</ul>
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| options | <code>Object</code> | parameters to initialize this matcher |
+
+
+* * *
+
+<a name="LocaleMatcher+getLocale"></a>
+
+### localeMatcher.getLocale() ⇒ <code>Locale</code> \| <code>undefined</code>
+Return the locale used to construct this instance.
+
+**Kind**: instance method of [<code>LocaleMatcher</code>](#LocaleMatcher)  
+**Returns**: <code>Locale</code> \| <code>undefined</code> - the locale for this matcher  
+
+* * *
+
+<a name="LocaleMatcher+getLikelyLocale"></a>
+
+### localeMatcher.getLikelyLocale() ⇒ <code>Locale</code>
+Return an Locale instance that is fully specified based on partial information
+given to the constructor of this locale matcher instance. For example, if the locale
+spec given to this locale matcher instance is simply "ru" (for the Russian language),
+then it will fill in the missing region and script tags and return a locale with
+the specifier "ru-Cyrl-RU". (ie. Russian language, Cyrillic, Russian Federation).
+Any one or two of the language, script, or region parts may be left unspecified,
+and the other one or two parts will be filled in automatically. If this
+class has no information about the given locale, then the locale of this
+locale matcher instance is returned unchanged.
+
+**Kind**: instance method of [<code>LocaleMatcher</code>](#LocaleMatcher)  
+**Returns**: <code>Locale</code> - the most likely completion of the partial locale given
+to the constructor of this locale matcher instance  
+
+* * *
+
+<a name="LocaleMatcher+getLikelyLocaleMinimal"></a>
+
+### localeMatcher.getLikelyLocaleMinimal() ⇒ <code>Locale</code>
+Return an Locale instance that is specified based on partial information
+given to the constructor of this locale matcher instance but which leaves out any
+part of the locale specifier that is so common that it is understood. For example,
+if the locale
+spec given to this locale matcher instance is simply "ru" (for the Russian language),
+then it will fill in the missing region and/or script tags and return a locale with
+the specifier "ru-RU". (ie. Russian language, Russian Federation). Note that the
+default script "Cyrl" is left out because the vast majority of text written in
+Russian is written with the Cyrllic script, so that part of the locale is understood
+and is commonly left out.<p>
+
+Any one or two of the language, script, or region parts may be left unspecified,
+and the other one or two parts will be filled in automatically. If this
+class has no information about the given locale, then the locale of this
+locale matcher instance is returned unchanged.<p>
+
+This method returns the same information as getLikelyLocale but with the very common
+parts left out.
+
+**Kind**: instance method of [<code>LocaleMatcher</code>](#LocaleMatcher)  
+**Returns**: <code>Locale</code> - the most likely "minimal" completion of the partial locale given
+to the constructor of this locale matcher instance where the commonly understood
+parts are left out.  
+
+* * *
+
+<a name="LocaleMatcher+match"></a>
+
+### localeMatcher.match(locale) ⇒ <code>number</code>
+Return the degree that the given locale matches the current locale of this
+matcher. This method returns an integer from 0 to 100. A value of 100 is
+a 100% match, meaning that the two locales are exactly equivalent to each
+other. (eg. "ja-JP" and "ja-JP") A value of 0 means that there 0% match or
+that the two locales have nothing in common. (eg. "en-US" and "ja-JP") <p>
+
+Locale matching is not the same as equivalence, as the degree of matching
+is returned. (See Locale.equals for equivalence.)<p>
+
+The match score is calculated based on matching the 4 locale components,
+weighted by importance:
+
+<ul>
+<li> language - this accounts for 50% of the match score
+<li> region - accounts for 25% of the match score
+<li> script - accounts for 20% of the match score
+<li> variant - accounts for 5% of the match score
+</ul>
+
+The score is affected by the following things:
+
+<ul>
+<li> A large language score is given when the language components of the locales
+match exactly.
+<li> Higher language scores are given when the languages are linguistically
+close to each other, such as dialects.
+<li> A small score is given when two languages are in the same
+linguistic family, but one is not a dialect of the other, such as German
+and Dutch.
+<li> A large region score is given when two locales share the same region.
+<li> A smaller region score is given when one region is contained within
+another. For example, Hong Kong is part of China, so a moderate score is
+given instead of a full score.
+<li> A small score is given if two regions are geographically close to
+each other or are tied by history. For example, Ireland and Great Britain
+are both adjacent and tied by history, so they receive a moderate score.
+<li> A high script score is given if the two locales share the same script.
+The legibility of a common script means that there is some small kinship of the
+different languages.
+<li> A high variant score is given if the two locales share the same
+variant. Full score is given when both locales have no variant at all.
+<li> Locale components that are unspecified in both locales are given high
+scores.
+<li> Locales where a particular locale component is missing in only one
+locale can still match when the default for that locale component matches
+the component in the other locale. The
+default value for the missing component is determined using the likely locales
+data. (See getLikelyLocale()) For example, "en-US" and "en-Latn-US" receive
+a high script score because the default script for "en" is "Latn".
+</ul>
+
+The intention of this method is that it can be used to determine
+compatibility of locales. For example, when a user signs up for an
+account on a web site, the locales that the web site supports and
+the locale of the user's browser may differ, and the site needs to
+pick the best locale to show the user. Let's say the
+web site supports a selection of European languages such as "it-IT",
+"fr-FR", "de-DE", and "en-GB". The user's
+browser may be set to "it-CH". The web site code can then match "it-CH"
+against each of the supported locales to find the one with the
+highest score. In
+this case, the best match would be "it-IT" because it shares a
+language and script in common with "it-CH" and differs only in the region
+component. It is not a 100% match, but it is pretty good. The web site
+may decide if the match scores all fall
+below a chosen threshold (perhaps 50%?), it should show the user the
+default language "en-GB", because that is probably a better choice
+than any other supported locale.<p>
+
+**Kind**: instance method of [<code>LocaleMatcher</code>](#LocaleMatcher)  
+**Returns**: <code>number</code> - an integer from 0 to 100 that indicates the degree to
+which these locales match each other  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| locale | <code>Locale</code> | the other locale to match against the current one |
+
+
+* * *
+
+<a name="LocaleMatcher+getMacroLanguage"></a>
+
+### localeMatcher.getMacroLanguage() ⇒ <code>string</code>
+Return the macrolanguage associated with this locale. If the
+locale's language is not part of a macro-language, then the
+locale's language is returned as-is.
+
+**Kind**: instance method of [<code>LocaleMatcher</code>](#LocaleMatcher)  
+**Returns**: <code>string</code> - the ISO code for the macrolanguage associated
+with this locale, or language of the locale  
+
+* * *
+
+<a name="LocaleMatcher+getRegionContainment"></a>
+
+### localeMatcher.getRegionContainment() ⇒ <code>Array.&lt;string&gt;</code>
+Return the list of regions that this locale is contained within. Regions are
+nested, so locales can be in multiple regions. (eg. US is in Northern North
+America, North America, the Americas, the World.) Most regions are specified
+using UN.49 region numbers, though some, like "EU", are letters. If the
+locale is underspecified, this method will use the most likely locale method
+to get the region first. For example, the locale "ja" (Japanese) is most
+likely "ja-JP" (Japanese for Japan), and the region containment info for Japan
+is returned.
+
+**Kind**: instance method of [<code>LocaleMatcher</code>](#LocaleMatcher)  
+**Returns**: <code>Array.&lt;string&gt;</code> - an array of region specifiers that this locale is within  
+
+* * *
+
+<a name="LocaleMatcher+smallestCommonRegion"></a>
+
+### localeMatcher.smallestCommonRegion(otherLocale) ⇒ <code>string</code>
+Find the smallest region that contains both the current locale and the other locale.
+If the current or other locales are underspecified, this method will use the most
+likely locale method
+to get their regions first. For example, the locale "ja" (Japanese) is most
+likely "ja-JP" (Japanese for Japan), and the region containment info for Japan
+is checked against the other locale's region containment info.
+
+**Kind**: instance method of [<code>LocaleMatcher</code>](#LocaleMatcher)  
+**Returns**: <code>string</code> - the region specifier of the smallest region containing both the
+current locale and other locale  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| otherLocale | <code>string</code> \| <code>Locale</code> | a locale specifier or a Locale instance to compare against |
+
+
+* * *
+

package/docs/index.html

@@ -68,7 +68,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Mon May 17 2021 22:40:28 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Mon Mar 14 2022 16:28:47 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/lib/LocaleMatcher.js

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports["default"]=void 0;var _ilibCommon=require("ilib-common");var _ilibLocale=_interopRequireDefault(require("ilib-locale"));var _localematch=_interopRequireDefault(require("../locale/localematch.json"));function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{"default":obj}}function _classCallCheck(instance,Constructor){if(!(instance instanceof Constructor)){throw new TypeError("Cannot call a class as a function")}}function _defineProperties(target,props){for(var i=0;i<props.length;i++){var descriptor=props[i];descriptor.enumerable=descriptor.enumerable||false;descriptor.configurable=true;if("value"in descriptor)descriptor.writable=true;Object.defineProperty(target,descriptor.key,descriptor)}}function _createClass(Constructor,protoProps,staticProps){if(protoProps)_defineProperties(Constructor.prototype,protoProps);if(staticProps)_defineProperties(Constructor,staticProps);return Constructor}var componentWeights=[0.5,0.2,0.25,0.05];var multiScriptLanguages={"az":true,"kk":true,"ku":true,"ky":true,"pa":true,"sr":true,"tg":true,"uz":true,"zh":true};var LocaleMatcher=function(){function LocaleMatcher(options){_classCallCheck(this,LocaleMatcher);this.locale=new _ilibLocale["default"];if(options&&typeof options.locale!=="undefined"){this.locale=typeof options.locale==="string"?new _ilibLocale["default"](options.locale):options.locale}}_createClass(LocaleMatcher,[{key:"getLocale",value:function getLocale(){return this.locale}},{key:"_getLikelyLocale",value:function _getLikelyLocale(locale){if(locale.language&&locale.script&&locale.region)return locale;if(typeof _localematch["default"].likelyLocales[locale.getSpec()]==="undefined"){var partial=_localematch["default"].likelyLocales[new _ilibLocale["default"](locale.language,undefined,locale.region).getSpec()];if(typeof partial!=="undefined")return new _ilibLocale["default"](partial);partial=_localematch["default"].likelyLocales[new _ilibLocale["default"](locale.language,locale.script,undefined).getSpec()];if(typeof partial!=="undefined")return new _ilibLocale["default"](partial);partial=_localematch["default"].likelyLocales[new _ilibLocale["default"](locale.language,undefined,undefined).getSpec()];if(typeof partial!=="undefined")return new _ilibLocale["default"](partial);partial=_localematch["default"].likelyLocales[new _ilibLocale["default"](undefined,locale.script,locale.region).getSpec()];if(typeof partial!=="undefined")return new _ilibLocale["default"](partial);partial=_localematch["default"].likelyLocales[new _ilibLocale["default"](undefined,undefined,locale.region).getSpec()];if(typeof partial!=="undefined")return new _ilibLocale["default"](partial);partial=_localematch["default"].likelyLocales[new _ilibLocale["default"](undefined,locale.script,undefined).getSpec()];if(typeof partial!=="undefined")return new _ilibLocale["default"](partial);return locale}return new _ilibLocale["default"](_localematch["default"].likelyLocales[locale.getSpec()])}},{key:"getLikelyLocale",value:function getLikelyLocale(){return this._getLikelyLocale(this.locale)}},{key:"getLikelyLocaleMinimal",value:function getLikelyLocaleMinimal(){var fullLocale=this._getLikelyLocale(this.locale);var langLocale=this._getLikelyLocale(new _ilibLocale["default"](fullLocale.language));return fullLocale.script===langLocale.script&&!multiScriptLanguages[fullLocale.language]?new _ilibLocale["default"](fullLocale.language,undefined,fullLocale.region):fullLocale}},{key:"match",value:function match(locale){var other=new _ilibLocale["default"](locale);var scores=[0,0,0,0];var thisfull,otherfull,i;if(this.locale.language===other.language){scores[0]=100}else{if(!this.locale.language||!other.language){thisfull=this.getLikelyLocale();otherfull=new _ilibLocale["default"](_localematch["default"].likelyLocales[other.getSpec()]||other.getSpec());if(thisfull.language===otherfull.language){scores[0]=100}}else{var mlthis=_localematch["default"].macroLanguagesReverse[this.locale.language]||this.locale.language;var mlother=_localematch["default"].macroLanguagesReverse[other.language]||other.language;if(mlthis===mlother){scores[0]=90}else{var pair=this.locale.language+"-"+other.language;scores[0]=_localematch["default"].mutualIntelligibility[pair]||0}}}if(this.locale.script===other.script){scores[1]=100}else{if(!this.locale.script||!other.script){thisfull=this.locale.script?this.locale:new _ilibLocale["default"](_localematch["default"].likelyLocales[this.locale.language]);otherfull=other.script?other:new _ilibLocale["default"](_localematch["default"].likelyLocales[other.language]);if(thisfull.script===otherfull.script){scores[1]=100}}}if(this.locale.region===other.region){scores[2]=100}else{if(!this.locale.region||!other.region){thisfull=this.getLikelyLocale();otherfull=new _ilibLocale["default"](_localematch["default"].likelyLocales[other.getSpec()]||other.getSpec());if(thisfull.region===otherfull.region){scores[2]=100}}else{var containers=_localematch["default"].territoryContainmentReverse[this.locale.region]||[];for(i=containers.length-1;i>0;i--){var container=_localematch["default"].territoryContainment[containers[i]];if(container&&container.indexOf(other.region)>-1){scores[2]=(i+1)*100/containers.length*0.2;break}}}}if(this.locale.variant===other.variant){scores[3]=100}var total=0;for(i=0;i<4;i++){total+=scores[i]*componentWeights[i]}return Math.round(total)}},{key:"getMacroLanguage",value:function getMacroLanguage(){return _localematch["default"].macroLanguagesReverse[this.locale.language]||this.locale.language}},{key:"_getRegionContainment",value:function _getRegionContainment(region){return _localematch["default"].territoryContainmentReverse[region]||[]}},{key:"getRegionContainment",value:function getRegionContainment(){var region=this.locale.region||this.getLikelyLocale().region;return this._getRegionContainment(region)}},{key:"smallestCommonRegion",value:function smallestCommonRegion(otherLocale){if(typeof otherLocale==="undefined")return"001";var thisRegion=this.locale.region||this.getLikelyLocale().region;var otherLoc=typeof otherLocale==="string"?new _ilibLocale["default"](otherLocale):otherLocale;var otherRegion=this._getLikelyLocale(otherLoc).region;var thisRegions=this._getRegionContainment(thisRegion);var otherRegions=this._getRegionContainment(otherRegion);for(var i=thisRegions.length-1;i>0;i--){if(otherRegions.indexOf(thisRegions[i])>-1){return thisRegions[i]}}return"001"}}]);return LocaleMatcher}();;var _default=LocaleMatcher;exports["default"]=_default;module.exports=exports.default;
+"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports["default"]=void 0;var _ilibCommon=require("ilib-common");var _ilibLocale=_interopRequireDefault(require("ilib-locale"));var _localematch=_interopRequireDefault(require("../locale/localematch.json"));function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{"default":obj}}function _classCallCheck(instance,Constructor){if(!(instance instanceof Constructor)){throw new TypeError("Cannot call a class as a function")}}function _defineProperties(target,props){for(var i=0;i<props.length;i++){var descriptor=props[i];descriptor.enumerable=descriptor.enumerable||false;descriptor.configurable=true;if("value"in descriptor)descriptor.writable=true;Object.defineProperty(target,descriptor.key,descriptor)}}function _createClass(Constructor,protoProps,staticProps){if(protoProps)_defineProperties(Constructor.prototype,protoProps);if(staticProps)_defineProperties(Constructor,staticProps);Object.defineProperty(Constructor,"prototype",{writable:false});return Constructor}var componentWeights=[0.5,0.2,0.25,0.05];var multiScriptLanguages={"az":true,"kk":true,"ku":true,"ky":true,"pa":true,"sr":true,"tg":true,"uz":true,"zh":true};var LocaleMatcher=function(){function LocaleMatcher(options){_classCallCheck(this,LocaleMatcher);this.locale=new _ilibLocale["default"];if(options&&typeof options.locale!=="undefined"){this.locale=typeof options.locale==="string"?new _ilibLocale["default"](options.locale):options.locale}}_createClass(LocaleMatcher,[{key:"getLocale",value:function getLocale(){return this.locale}},{key:"_getLikelyLocale",value:function _getLikelyLocale(locale){if(locale.language&&locale.script&&locale.region)return locale;if(typeof _localematch["default"].likelyLocales[locale.getSpec()]==="undefined"){var partial=_localematch["default"].likelyLocales[new _ilibLocale["default"](locale.language,undefined,locale.region).getSpec()];if(typeof partial!=="undefined")return new _ilibLocale["default"](partial);partial=_localematch["default"].likelyLocales[new _ilibLocale["default"](locale.language,locale.script,undefined).getSpec()];if(typeof partial!=="undefined")return new _ilibLocale["default"](partial);partial=_localematch["default"].likelyLocales[new _ilibLocale["default"](locale.language,undefined,undefined).getSpec()];if(typeof partial!=="undefined")return new _ilibLocale["default"](partial);partial=_localematch["default"].likelyLocales[new _ilibLocale["default"](undefined,locale.script,locale.region).getSpec()];if(typeof partial!=="undefined")return new _ilibLocale["default"](partial);partial=_localematch["default"].likelyLocales[new _ilibLocale["default"](undefined,undefined,locale.region).getSpec()];if(typeof partial!=="undefined")return new _ilibLocale["default"](partial);partial=_localematch["default"].likelyLocales[new _ilibLocale["default"](undefined,locale.script,undefined).getSpec()];if(typeof partial!=="undefined")return new _ilibLocale["default"](partial);return locale}return new _ilibLocale["default"](_localematch["default"].likelyLocales[locale.getSpec()])}},{key:"getLikelyLocale",value:function getLikelyLocale(){return this._getLikelyLocale(this.locale)}},{key:"getLikelyLocaleMinimal",value:function getLikelyLocaleMinimal(){var fullLocale=this._getLikelyLocale(this.locale);var langLocale=this._getLikelyLocale(new _ilibLocale["default"](fullLocale.language));return fullLocale.script===langLocale.script&&!multiScriptLanguages[fullLocale.language]?new _ilibLocale["default"](fullLocale.language,undefined,fullLocale.region):fullLocale}},{key:"match",value:function match(locale){var other=new _ilibLocale["default"](locale);var scores=[0,0,0,0];var thisfull,otherfull,i;if(this.locale.language===other.language){scores[0]=100}else{if(!this.locale.language||!other.language){thisfull=this.getLikelyLocale();otherfull=new _ilibLocale["default"](_localematch["default"].likelyLocales[other.getSpec()]||other.getSpec());if(thisfull.language===otherfull.language){scores[0]=100}}else{var mlthis=_localematch["default"].macroLanguagesReverse[this.locale.language]||this.locale.language;var mlother=_localematch["default"].macroLanguagesReverse[other.language]||other.language;if(mlthis===mlother){scores[0]=90}else{var pair=this.locale.language+"-"+other.language;scores[0]=_localematch["default"].mutualIntelligibility[pair]||0}}}if(this.locale.script===other.script){scores[1]=100}else{if(!this.locale.script||!other.script){thisfull=this.locale.script?this.locale:new _ilibLocale["default"](_localematch["default"].likelyLocales[this.locale.language]);otherfull=other.script?other:new _ilibLocale["default"](_localematch["default"].likelyLocales[other.language]);if(thisfull.script===otherfull.script){scores[1]=100}}}if(this.locale.region===other.region){scores[2]=100}else{if(!this.locale.region||!other.region){thisfull=this.getLikelyLocale();otherfull=new _ilibLocale["default"](_localematch["default"].likelyLocales[other.getSpec()]||other.getSpec());if(thisfull.region===otherfull.region){scores[2]=100}}else{var containers=_localematch["default"].territoryContainmentReverse[this.locale.region]||[];for(i=containers.length-1;i>0;i--){var container=_localematch["default"].territoryContainment[containers[i]];if(container&&container.indexOf(other.region)>-1){scores[2]=(i+1)*100/containers.length*0.2;break}}}}if(this.locale.variant===other.variant){scores[3]=100}var total=0;for(i=0;i<4;i++){total+=scores[i]*componentWeights[i]}return Math.round(total)}},{key:"getMacroLanguage",value:function getMacroLanguage(){return _localematch["default"].macroLanguagesReverse[this.locale.language]||this.locale.language}},{key:"_getRegionContainment",value:function _getRegionContainment(region){return _localematch["default"].territoryContainmentReverse[region]||[]}},{key:"getRegionContainment",value:function getRegionContainment(){var region=this.locale.region||this.getLikelyLocale().region;return this._getRegionContainment(region)}},{key:"smallestCommonRegion",value:function smallestCommonRegion(otherLocale){if(typeof otherLocale==="undefined")return"001";var thisRegion=this.locale.region||this.getLikelyLocale().region;var otherLoc=typeof otherLocale==="string"?new _ilibLocale["default"](otherLocale):otherLocale;var otherRegion=this._getLikelyLocale(otherLoc).region;var thisRegions=this._getRegionContainment(thisRegion);var otherRegions=this._getRegionContainment(otherRegion);for(var i=thisRegions.length-1;i>0;i--){if(otherRegions.indexOf(thisRegions[i])>-1){return thisRegions[i]}}return"001"}}]);return LocaleMatcher}();;var _default=LocaleMatcher;exports["default"]=_default;module.exports=exports.default;
 //# sourceMappingURL=LocaleMatcher.js.map

package/lib/LocaleMatcher.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/LocaleMatcher.js"],"names":["componentWeights","multiScriptLanguages","LocaleMatcher","options","locale","Locale","language","script","region","matchdata","likelyLocales","getSpec","partial","undefined","_getLikelyLocale","fullLocale","langLocale","other","scores","thisfull","otherfull","i","getLikelyLocale","mlthis","macroLanguagesReverse","mlother","pair","mutualIntelligibility","containers","territoryContainmentReverse","length","container","territoryContainment","indexOf","variant","total","Math","round","_getRegionContainment","otherLocale","thisRegion","otherLoc","otherRegion","thisRegions","otherRegions"],"mappings":"gGAqBA,uCACA,+DAEA,+E,wsBAEA,GAAMA,CAAAA,gBAAgB,CAAG,CACrB,GADqB,CAErB,GAFqB,CAGrB,IAHqB,CAIrB,IAJqB,CAAzB,CASA,GAAMC,CAAAA,oBAAoB,CAAG,CACzB,KAAM,IADmB,CAEzB,KAAM,IAFmB,CAGzB,KAAM,IAHmB,CAIzB,KAAM,IAJmB,CAKzB,KAAM,IALmB,CAMzB,KAAM,IANmB,CAOzB,KAAM,IAPmB,CAQzB,KAAM,IARmB,CASzB,KAAM,IATmB,CAA7B,C,GAiBMC,CAAAA,a,YAeF,uBAAYC,OAAZ,CAAqB,qCACjB,KAAKC,MAAL,CAAc,GAAIC,uBAAlB,CAEA,GAAIF,OAAO,EAAI,MAAOA,CAAAA,OAAO,CAACC,MAAf,GAA2B,WAA1C,CAAuD,CACnD,KAAKA,MAAL,CAAe,MAAOD,CAAAA,OAAO,CAACC,MAAf,GAA2B,QAA5B,CAAwC,GAAIC,uBAAJ,CAAWF,OAAO,CAACC,MAAnB,CAAxC,CAAqED,OAAO,CAACC,MAC9F,CACJ,C,mDAMD,oBAAY,CACR,MAAO,MAAKA,MACf,C,gCAMD,0BAAiBA,MAAjB,CAAyB,CAErB,GAAIA,MAAM,CAACE,QAAP,EAAmBF,MAAM,CAACG,MAA1B,EAAoCH,MAAM,CAACI,MAA/C,CAAuD,MAAOJ,CAAAA,MAAP,CAEvD,GAAI,MAAOK,yBAAUC,aAAV,CAAwBN,MAAM,CAACO,OAAP,EAAxB,CAAP,GAAsD,WAA1D,CAAuE,CAEnE,GAAIC,CAAAA,OAAO,CAAGH,wBAAUC,aAAV,CAAwB,GAAIL,uBAAJ,CAAWD,MAAM,CAACE,QAAlB,CAA4BO,SAA5B,CAAuCT,MAAM,CAACI,MAA9C,EAAsDG,OAAtD,EAAxB,CAAd,CACA,GAAI,MAAOC,CAAAA,OAAP,GAAoB,WAAxB,CAAqC,MAAO,IAAIP,uBAAJ,CAAWO,OAAX,CAAP,CAErCA,OAAO,CAAGH,wBAAUC,aAAV,CAAwB,GAAIL,uBAAJ,CAAWD,MAAM,CAACE,QAAlB,CAA4BF,MAAM,CAACG,MAAnC,CAA2CM,SAA3C,EAAsDF,OAAtD,EAAxB,CAAV,CACA,GAAI,MAAOC,CAAAA,OAAP,GAAoB,WAAxB,CAAqC,MAAO,IAAIP,uBAAJ,CAAWO,OAAX,CAAP,CAErCA,OAAO,CAAGH,wBAAUC,aAAV,CAAwB,GAAIL,uBAAJ,CAAWD,MAAM,CAACE,QAAlB,CAA4BO,SAA5B,CAAuCA,SAAvC,EAAkDF,OAAlD,EAAxB,CAAV,CACA,GAAI,MAAOC,CAAAA,OAAP,GAAoB,WAAxB,CAAqC,MAAO,IAAIP,uBAAJ,CAAWO,OAAX,CAAP,CAErCA,OAAO,CAAGH,wBAAUC,aAAV,CAAwB,GAAIL,uBAAJ,CAAWQ,SAAX,CAAsBT,MAAM,CAACG,MAA7B,CAAqCH,MAAM,CAACI,MAA5C,EAAoDG,OAApD,EAAxB,CAAV,CACA,GAAI,MAAOC,CAAAA,OAAP,GAAoB,WAAxB,CAAqC,MAAO,IAAIP,uBAAJ,CAAWO,OAAX,CAAP,CAErCA,OAAO,CAAGH,wBAAUC,aAAV,CAAwB,GAAIL,uBAAJ,CAAWQ,SAAX,CAAsBA,SAAtB,CAAiCT,MAAM,CAACI,MAAxC,EAAgDG,OAAhD,EAAxB,CAAV,CACA,GAAI,MAAOC,CAAAA,OAAP,GAAoB,WAAxB,CAAqC,MAAO,IAAIP,uBAAJ,CAAWO,OAAX,CAAP,CAErCA,OAAO,CAAGH,wBAAUC,aAAV,CAAwB,GAAIL,uBAAJ,CAAWQ,SAAX,CAAsBT,MAAM,CAACG,MAA7B,CAAqCM,SAArC,EAAgDF,OAAhD,EAAxB,CAAV,CACA,GAAI,MAAOC,CAAAA,OAAP,GAAoB,WAAxB,CAAqC,MAAO,IAAIP,uBAAJ,CAAWO,OAAX,CAAP,CAErC,MAAOR,CAAAA,MACV,CAED,MAAO,IAAIC,uBAAJ,CAAWI,wBAAUC,aAAV,CAAwBN,MAAM,CAACO,OAAP,EAAxB,CAAX,CACV,C,+BAgBD,0BAAkB,CACd,MAAO,MAAKG,gBAAL,CAAsB,KAAKV,MAA3B,CACV,C,sCA0BD,iCAAyB,CACrB,GAAMW,CAAAA,UAAU,CAAG,KAAKD,gBAAL,CAAsB,KAAKV,MAA3B,CAAnB,CACA,GAAMY,CAAAA,UAAU,CAAG,KAAKF,gBAAL,CAAsB,GAAIT,uBAAJ,CAAWU,UAAU,CAACT,QAAtB,CAAtB,CAAnB,CACA,MAAOS,CAAAA,UAAU,CAACR,MAAX,GAAsBS,UAAU,CAACT,MAAjC,EAA2C,CAACN,oBAAoB,CAACc,UAAU,CAACT,QAAZ,CAAhE,CACH,GAAID,uBAAJ,CAAWU,UAAU,CAACT,QAAtB,CAAgCO,SAAhC,CAA2CE,UAAU,CAACP,MAAtD,CADG,CAEHO,UACP,C,qBA4ED,eAAMX,MAAN,CAAc,CACV,GAAMa,CAAAA,KAAK,CAAG,GAAIZ,uBAAJ,CAAWD,MAAX,CAAd,CACA,GAAIc,CAAAA,MAAM,CAAG,CAAC,CAAD,CAAI,CAAJ,CAAO,CAAP,CAAU,CAAV,CAAb,CACA,GAAIC,CAAAA,QAAJ,CAAcC,SAAd,CAAyBC,CAAzB,CAEA,GAAI,KAAKjB,MAAL,CAAYE,QAAZ,GAAyBW,KAAK,CAACX,QAAnC,CAA6C,CACzCY,MAAM,CAAC,CAAD,CAAN,CAAY,GACf,CAFD,IAEO,CACH,GAAI,CAAC,KAAKd,MAAL,CAAYE,QAAb,EAAyB,CAACW,KAAK,CAACX,QAApC,CAA8C,CAE1Ca,QAAQ,CAAG,KAAKG,eAAL,EAAX,CACAF,SAAS,CAAG,GAAIf,uBAAJ,CAAWI,wBAAUC,aAAV,CAAwBO,KAAK,CAACN,OAAN,EAAxB,GAA4CM,KAAK,CAACN,OAAN,EAAvD,CAAZ,CACA,GAAIQ,QAAQ,CAACb,QAAT,GAAsBc,SAAS,CAACd,QAApC,CAA8C,CAC1CY,MAAM,CAAC,CAAD,CAAN,CAAY,GACf,CACJ,CAPD,IAOO,CAEH,GAAMK,CAAAA,MAAM,CAAGd,wBAAUe,qBAAV,CAAgC,KAAKpB,MAAL,CAAYE,QAA5C,GAAyD,KAAKF,MAAL,CAAYE,QAApF,CACA,GAAMmB,CAAAA,OAAO,CAAGhB,wBAAUe,qBAAV,CAAgCP,KAAK,CAACX,QAAtC,GAAmDW,KAAK,CAACX,QAAzE,CACA,GAAIiB,MAAM,GAAKE,OAAf,CAAwB,CACpBP,MAAM,CAAC,CAAD,CAAN,CAAY,EACf,CAFD,IAEO,CAEH,GAAMQ,CAAAA,IAAI,CAAG,KAAKtB,MAAL,CAAYE,QAAZ,CAAuB,GAAvB,CAA6BW,KAAK,CAACX,QAAhD,CACAY,MAAM,CAAC,CAAD,CAAN,CAAYT,wBAAUkB,qBAAV,CAAgCD,IAAhC,GAAyC,CACxD,CACJ,CACJ,CAED,GAAI,KAAKtB,MAAL,CAAYG,MAAZ,GAAuBU,KAAK,CAACV,MAAjC,CAAyC,CACrCW,MAAM,CAAC,CAAD,CAAN,CAAY,GACf,CAFD,IAEO,CACH,GAAI,CAAC,KAAKd,MAAL,CAAYG,MAAb,EAAuB,CAACU,KAAK,CAACV,MAAlC,CAA0C,CAEtCY,QAAQ,CAAG,KAAKf,MAAL,CAAYG,MAAZ,CAAqB,KAAKH,MAA1B,CAAmC,GAAIC,uBAAJ,CAAWI,wBAAUC,aAAV,CAAwB,KAAKN,MAAL,CAAYE,QAApC,CAAX,CAA9C,CACAc,SAAS,CAAGH,KAAK,CAACV,MAAN,CAAeU,KAAf,CAAuB,GAAIZ,uBAAJ,CAAWI,wBAAUC,aAAV,CAAwBO,KAAK,CAACX,QAA9B,CAAX,CAAnC,CACA,GAAIa,QAAQ,CAACZ,MAAT,GAAoBa,SAAS,CAACb,MAAlC,CAA0C,CACtCW,MAAM,CAAC,CAAD,CAAN,CAAY,GACf,CACJ,CACJ,CAED,GAAI,KAAKd,MAAL,CAAYI,MAAZ,GAAuBS,KAAK,CAACT,MAAjC,CAAyC,CACrCU,MAAM,CAAC,CAAD,CAAN,CAAY,GACf,CAFD,IAEO,CACH,GAAI,CAAC,KAAKd,MAAL,CAAYI,MAAb,EAAuB,CAACS,KAAK,CAACT,MAAlC,CAA0C,CAEtCW,QAAQ,CAAG,KAAKG,eAAL,EAAX,CACAF,SAAS,CAAG,GAAIf,uBAAJ,CAAWI,wBAAUC,aAAV,CAAwBO,KAAK,CAACN,OAAN,EAAxB,GAA4CM,KAAK,CAACN,OAAN,EAAvD,CAAZ,CACA,GAAIQ,QAAQ,CAACX,MAAT,GAAoBY,SAAS,CAACZ,MAAlC,CAA0C,CACtCU,MAAM,CAAC,CAAD,CAAN,CAAY,GACf,CACJ,CAPD,IAOO,CAEH,GAAMU,CAAAA,UAAU,CAAGnB,wBAAUoB,2BAAV,CAAsC,KAAKzB,MAAL,CAAYI,MAAlD,GAA6D,EAAhF,CAEA,IAAKa,CAAC,CAAGO,UAAU,CAACE,MAAX,CAAkB,CAA3B,CAA8BT,CAAC,CAAG,CAAlC,CAAqCA,CAAC,EAAtC,CAA0C,CACtC,GAAMU,CAAAA,SAAS,CAAGtB,wBAAUuB,oBAAV,CAA+BJ,UAAU,CAACP,CAAD,CAAzC,CAAlB,CACA,GAAIU,SAAS,EAAIA,SAAS,CAACE,OAAV,CAAkBhB,KAAK,CAACT,MAAxB,EAAkC,CAAC,CAApD,CAAuD,CAEnDU,MAAM,CAAC,CAAD,CAAN,CAAa,CAACG,CAAC,CAAC,CAAH,EAAQ,GAAR,CAAcO,UAAU,CAACE,MAA1B,CAAoC,GAAhD,CACA,KACH,CACJ,CACJ,CACJ,CAED,GAAI,KAAK1B,MAAL,CAAY8B,OAAZ,GAAwBjB,KAAK,CAACiB,OAAlC,CAA2C,CACvChB,MAAM,CAAC,CAAD,CAAN,CAAY,GACf,CAED,GAAIiB,CAAAA,KAAK,CAAG,CAAZ,CAEA,IAAKd,CAAC,CAAG,CAAT,CAAYA,CAAC,CAAG,CAAhB,CAAmBA,CAAC,EAApB,CAAwB,CACpBc,KAAK,EAAIjB,MAAM,CAACG,CAAD,CAAN,CAAYrB,gBAAgB,CAACqB,CAAD,CACxC,CAED,MAAOe,CAAAA,IAAI,CAACC,KAAL,CAAWF,KAAX,CACV,C,gCAUD,2BAAmB,CACf,MAAO1B,yBAAUe,qBAAV,CAAgC,KAAKpB,MAAL,CAAYE,QAA5C,GAAyD,KAAKF,MAAL,CAAYE,QAC/E,C,qCAMD,+BAAsBE,MAAtB,CAA8B,CAC1B,MAAOC,yBAAUoB,2BAAV,CAAsCrB,MAAtC,GAAiD,EAC3D,C,oCAcD,+BAAuB,CACnB,GAAMA,CAAAA,MAAM,CAAG,KAAKJ,MAAL,CAAYI,MAAZ,EAAsB,KAAKc,eAAL,GAAuBd,MAA5D,CACA,MAAO,MAAK8B,qBAAL,CAA2B9B,MAA3B,CACV,C,oCAeD,8BAAqB+B,WAArB,CAAkC,CAC9B,GAAI,MAAOA,CAAAA,WAAP,GAAwB,WAA5B,CAAyC,MAAO,KAAP,CAEzC,GAAMC,CAAAA,UAAU,CAAG,KAAKpC,MAAL,CAAYI,MAAZ,EAAsB,KAAKc,eAAL,GAAuBd,MAAhE,CACA,GAAMiC,CAAAA,QAAQ,CAAG,MAAOF,CAAAA,WAAP,GAAwB,QAAxB,CAAmC,GAAIlC,uBAAJ,CAAWkC,WAAX,CAAnC,CAA6DA,WAA9E,CACA,GAAMG,CAAAA,WAAW,CAAG,KAAK5B,gBAAL,CAAsB2B,QAAtB,EAAgCjC,MAApD,CAEA,GAAMmC,CAAAA,WAAW,CAAG,KAAKL,qBAAL,CAA2BE,UAA3B,CAApB,CACA,GAAMI,CAAAA,YAAY,CAAG,KAAKN,qBAAL,CAA2BI,WAA3B,CAArB,CAIA,IAAK,GAAIrB,CAAAA,CAAC,CAAGsB,WAAW,CAACb,MAAZ,CAAmB,CAAhC,CAAmCT,CAAC,CAAG,CAAvC,CAA0CA,CAAC,EAA3C,CAA+C,CAC3C,GAAIuB,YAAY,CAACX,OAAb,CAAqBU,WAAW,CAACtB,CAAD,CAAhC,EAAuC,CAAC,CAA5C,CAA+C,CAC3C,MAAOsB,CAAAA,WAAW,CAACtB,CAAD,CACrB,CACJ,CAGD,MAAO,KACV,C,4BACJ,C,aAEcnB,a","sourcesContent":["/*\n * LocaleMatcher.js - Locale matcher definition\n *\n * Copyright © 2013-2015, 2018-2019, 2021 JEDLSoft\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n *\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n// !data localematch\n\nimport { Utils } from 'ilib-common';\nimport Locale from 'ilib-locale';\n\nimport matchdata from '../locale/localematch.json';\n\nconst componentWeights = [\n    0.5,   // language\n    0.2,   // script\n    0.25,  // region\n    0.05   // variant\n];\n\n// these are languages where you have to put the script all the time,\n// as none of the scripts are default for the language\nconst multiScriptLanguages = {\n    \"az\": true,   // Azerbaijani\n    \"kk\": true,   // Kazakh\n    \"ku\": true,   // Kurdish\n    \"ky\": true,   // Kyrgyz\n    \"pa\": true,   // Panjabi\n    \"sr\": true,   // Serbian\n    \"tg\": true,   // Tajik\n    \"uz\": true,   // Uzbek\n    \"zh\": true    // Chinese\n};\n\n/**\n * @class Represent a locale matcher instance, which is used\n * to see which locales can be matched with each other in\n * various ways.\n */\nclass LocaleMatcher {\n    /**\n     * Create a new locale matcher instance. This is used\n     * to see which locales can be matched with each other in\n     * various ways.<p>\n     *\n     * The options object may contain any of the following properties:\n     *\n     * <ul>\n     * <li><i>locale</i> - the locale instance or locale spec to match\n     * </ul>\n     *\n     * @constructor\n     * @param {Object} options parameters to initialize this matcher\n     */\n    constructor(options) {\n        this.locale = new Locale();\n\n        if (options && typeof(options.locale) !== 'undefined') {\n            this.locale = (typeof(options.locale) === 'string') ? new Locale(options.locale) : options.locale;\n        }\n    }\n\n    /**\n     * Return the locale used to construct this instance.\n     * @return {Locale|undefined} the locale for this matcher\n     */\n    getLocale() {\n        return this.locale;\n    }\n\n    /**\n     * Do the work\n     * @private\n     */\n    _getLikelyLocale(locale) {\n        // already full specified\n        if (locale.language && locale.script && locale.region) return locale;\n\n        if (typeof(matchdata.likelyLocales[locale.getSpec()]) === 'undefined') {\n            // try various partials before giving up\n            let partial = matchdata.likelyLocales[new Locale(locale.language, undefined, locale.region).getSpec()];\n            if (typeof(partial) !== 'undefined') return new Locale(partial);\n\n            partial = matchdata.likelyLocales[new Locale(locale.language, locale.script, undefined).getSpec()];\n            if (typeof(partial) !== 'undefined') return new Locale(partial);\n\n            partial = matchdata.likelyLocales[new Locale(locale.language, undefined, undefined).getSpec()];\n            if (typeof(partial) !== 'undefined') return new Locale(partial);\n\n            partial = matchdata.likelyLocales[new Locale(undefined, locale.script, locale.region).getSpec()];\n            if (typeof(partial) !== 'undefined') return new Locale(partial);\n\n            partial = matchdata.likelyLocales[new Locale(undefined, undefined, locale.region).getSpec()];\n            if (typeof(partial) !== 'undefined') return new Locale(partial);\n\n            partial = matchdata.likelyLocales[new Locale(undefined, locale.script, undefined).getSpec()];\n            if (typeof(partial) !== 'undefined') return new Locale(partial);\n\n            return locale;\n        }\n\n        return new Locale(matchdata.likelyLocales[locale.getSpec()]);\n    }\n\n    /**\n     * Return an Locale instance that is fully specified based on partial information\n     * given to the constructor of this locale matcher instance. For example, if the locale\n     * spec given to this locale matcher instance is simply \"ru\" (for the Russian language),\n     * then it will fill in the missing region and script tags and return a locale with\n     * the specifier \"ru-Cyrl-RU\". (ie. Russian language, Cyrillic, Russian Federation).\n     * Any one or two of the language, script, or region parts may be left unspecified,\n     * and the other one or two parts will be filled in automatically. If this\n     * class has no information about the given locale, then the locale of this\n     * locale matcher instance is returned unchanged.\n     *\n     * @returns {Locale} the most likely completion of the partial locale given\n     * to the constructor of this locale matcher instance\n     */\n    getLikelyLocale() {\n        return this._getLikelyLocale(this.locale);\n    }\n\n    /**\n     * Return an Locale instance that is specified based on partial information\n     * given to the constructor of this locale matcher instance but which leaves out any\n     * part of the locale specifier that is so common that it is understood. For example,\n     * if the locale\n     * spec given to this locale matcher instance is simply \"ru\" (for the Russian language),\n     * then it will fill in the missing region and/or script tags and return a locale with\n     * the specifier \"ru-RU\". (ie. Russian language, Russian Federation). Note that the\n     * default script \"Cyrl\" is left out because the vast majority of text written in\n     * Russian is written with the Cyrllic script, so that part of the locale is understood\n     * and is commonly left out.<p>\n     *\n     * Any one or two of the language, script, or region parts may be left unspecified,\n     * and the other one or two parts will be filled in automatically. If this\n     * class has no information about the given locale, then the locale of this\n     * locale matcher instance is returned unchanged.<p>\n     *\n     * This method returns the same information as getLikelyLocale but with the very common\n     * parts left out.\n     *\n     * @returns {Locale} the most likely \"minimal\" completion of the partial locale given\n     * to the constructor of this locale matcher instance where the commonly understood\n     * parts are left out.\n     */\n    getLikelyLocaleMinimal() {\n        const fullLocale = this._getLikelyLocale(this.locale);\n        const langLocale = this._getLikelyLocale(new Locale(fullLocale.language));\n        return fullLocale.script === langLocale.script && !multiScriptLanguages[fullLocale.language] ?\n            new Locale(fullLocale.language, undefined, fullLocale.region) :\n            fullLocale;\n    }\n\n    /**\n     * Return the degree that the given locale matches the current locale of this\n     * matcher. This method returns an integer from 0 to 100. A value of 100 is\n     * a 100% match, meaning that the two locales are exactly equivalent to each\n     * other. (eg. \"ja-JP\" and \"ja-JP\") A value of 0 means that there 0% match or\n     * that the two locales have nothing in common. (eg. \"en-US\" and \"ja-JP\") <p>\n     *\n     * Locale matching is not the same as equivalence, as the degree of matching\n     * is returned. (See Locale.equals for equivalence.)<p>\n     *\n     * The match score is calculated based on matching the 4 locale components,\n     * weighted by importance:\n     *\n     * <ul>\n     * <li> language - this accounts for 50% of the match score\n     * <li> region - accounts for 25% of the match score\n     * <li> script - accounts for 20% of the match score\n     * <li> variant - accounts for 5% of the match score\n     * </ul>\n     *\n     * The score is affected by the following things:\n     *\n     * <ul>\n     * <li> A large language score is given when the language components of the locales\n     * match exactly.\n     * <li> Higher language scores are given when the languages are linguistically\n     * close to each other, such as dialects.\n     * <li> A small score is given when two languages are in the same\n     * linguistic family, but one is not a dialect of the other, such as German\n     * and Dutch.\n     * <li> A large region score is given when two locales share the same region.\n     * <li> A smaller region score is given when one region is contained within\n     * another. For example, Hong Kong is part of China, so a moderate score is\n     * given instead of a full score.\n     * <li> A small score is given if two regions are geographically close to\n     * each other or are tied by history. For example, Ireland and Great Britain\n     * are both adjacent and tied by history, so they receive a moderate score.\n     * <li> A high script score is given if the two locales share the same script.\n     * The legibility of a common script means that there is some small kinship of the\n     * different languages.\n     * <li> A high variant score is given if the two locales share the same\n     * variant. Full score is given when both locales have no variant at all.\n     * <li> Locale components that are unspecified in both locales are given high\n     * scores.\n     * <li> Locales where a particular locale component is missing in only one\n     * locale can still match when the default for that locale component matches\n     * the component in the other locale. The\n     * default value for the missing component is determined using the likely locales\n     * data. (See getLikelyLocale()) For example, \"en-US\" and \"en-Latn-US\" receive\n     * a high script score because the default script for \"en\" is \"Latn\".\n     * </ul>\n     *\n     * The intention of this method is that it can be used to determine\n     * compatibility of locales. For example, when a user signs up for an\n     * account on a web site, the locales that the web site supports and\n     * the locale of the user's browser may differ, and the site needs to\n     * pick the best locale to show the user. Let's say the\n     * web site supports a selection of European languages such as \"it-IT\",\n     * \"fr-FR\", \"de-DE\", and \"en-GB\". The user's\n     * browser may be set to \"it-CH\". The web site code can then match \"it-CH\"\n     * against each of the supported locales to find the one with the\n     * highest score. In\n     * this case, the best match would be \"it-IT\" because it shares a\n     * language and script in common with \"it-CH\" and differs only in the region\n     * component. It is not a 100% match, but it is pretty good. The web site\n     * may decide if the match scores all fall\n     * below a chosen threshold (perhaps 50%?), it should show the user the\n     * default language \"en-GB\", because that is probably a better choice\n     * than any other supported locale.<p>\n     *\n     * @param {Locale} locale the other locale to match against the current one\n     * @return {number} an integer from 0 to 100 that indicates the degree to\n     * which these locales match each other\n     */\n    match(locale) {\n        const other = new Locale(locale);\n        let scores = [0, 0, 0, 0];\n        let thisfull, otherfull, i;\n\n        if (this.locale.language === other.language) {\n            scores[0] = 100;\n        } else {\n            if (!this.locale.language || !other.language) {\n                // check for default language\n                thisfull = this.getLikelyLocale();\n                otherfull = new Locale(matchdata.likelyLocales[other.getSpec()] || other.getSpec());\n                if (thisfull.language === otherfull.language) {\n                    scores[0] = 100;\n                }\n            } else {\n                // check for macro languages\n                const mlthis = matchdata.macroLanguagesReverse[this.locale.language] || this.locale.language;\n                const mlother = matchdata.macroLanguagesReverse[other.language] || other.language;\n                if (mlthis === mlother) {\n                    scores[0] = 90;\n                } else {\n                    // check for mutual intelligibility\n                    const pair = this.locale.language + \"-\" + other.language;\n                    scores[0] = matchdata.mutualIntelligibility[pair] || 0;\n                }\n            }\n        }\n\n        if (this.locale.script === other.script) {\n            scores[1] = 100;\n        } else {\n            if (!this.locale.script || !other.script) {\n                // check for default script\n                thisfull = this.locale.script ? this.locale : new Locale(matchdata.likelyLocales[this.locale.language]);\n                otherfull = other.script ? other : new Locale(matchdata.likelyLocales[other.language]);\n                if (thisfull.script === otherfull.script) {\n                    scores[1] = 100;\n                }\n            }\n        }\n\n        if (this.locale.region === other.region) {\n            scores[2] = 100;\n        } else {\n            if (!this.locale.region || !other.region) {\n                // check for default region\n                thisfull = this.getLikelyLocale();\n                otherfull = new Locale(matchdata.likelyLocales[other.getSpec()] || other.getSpec());\n                if (thisfull.region === otherfull.region) {\n                    scores[2] = 100;\n                }\n            } else {\n                // check for containment\n                const containers = matchdata.territoryContainmentReverse[this.locale.region] || [];\n                // end at 1 because 0 is \"001\" which is \"the whole world\" -- which is not useful\n                for (i = containers.length-1; i > 0; i--) {\n                    const container = matchdata.territoryContainment[containers[i]];\n                    if (container && container.indexOf(other.region) > -1) {\n                        // same area only accounts for 20% of the region score\n                        scores[2] = ((i+1) * 100 / containers.length) * 0.2;\n                        break;\n                    }\n                }\n            }\n        }\n\n        if (this.locale.variant === other.variant) {\n            scores[3] = 100;\n        }\n\n        let total = 0;\n\n        for (i = 0; i < 4; i++) {\n            total += scores[i] * componentWeights[i];\n        }\n\n        return Math.round(total);\n    }\n\n    /**\n     * Return the macrolanguage associated with this locale. If the\n     * locale's language is not part of a macro-language, then the\n     * locale's language is returned as-is.\n     *\n     * @returns {string} the ISO code for the macrolanguage associated\n     * with this locale, or language of the locale\n     */\n    getMacroLanguage() {\n        return matchdata.macroLanguagesReverse[this.locale.language] || this.locale.language;\n    }\n\n    /**\n     * Return the containment array for the given region code.\n     * @private\n     */\n    _getRegionContainment(region) {\n        return matchdata.territoryContainmentReverse[region] || [];\n    }\n\n    /**\n     * Return the list of regions that this locale is contained within. Regions are\n     * nested, so locales can be in multiple regions. (eg. US is in Northern North\n     * America, North America, the Americas, the World.) Most regions are specified\n     * using UN.49 region numbers, though some, like \"EU\", are letters. If the\n     * locale is underspecified, this method will use the most likely locale method\n     * to get the region first. For example, the locale \"ja\" (Japanese) is most\n     * likely \"ja-JP\" (Japanese for Japan), and the region containment info for Japan\n     * is returned.\n     *\n     * @returns {Array.<string>} an array of region specifiers that this locale is within\n     */\n    getRegionContainment() {\n        const region = this.locale.region || this.getLikelyLocale().region;\n        return this._getRegionContainment(region);\n    }\n\n    /**\n     * Find the smallest region that contains both the current locale and the other locale.\n     * If the current or other locales are underspecified, this method will use the most\n     * likely locale method\n     * to get their regions first. For example, the locale \"ja\" (Japanese) is most\n     * likely \"ja-JP\" (Japanese for Japan), and the region containment info for Japan\n     * is checked against the other locale's region containment info.\n     *\n     * @param {string|Locale} otherLocale a locale specifier or a Locale instance to\n     * compare against\n     * @returns {string} the region specifier of the smallest region containing both the\n     * current locale and other locale\n     */\n    smallestCommonRegion(otherLocale) {\n        if (typeof(otherLocale) === \"undefined\") return \"001\";\n\n        const thisRegion = this.locale.region || this.getLikelyLocale().region;\n        const otherLoc = typeof(otherLocale) === \"string\" ? new Locale(otherLocale) : otherLocale;\n        const otherRegion = this._getLikelyLocale(otherLoc).region;\n\n        const thisRegions = this._getRegionContainment(thisRegion);\n        const otherRegions = this._getRegionContainment(otherRegion);\n\n        // region containment arrays are arranged from largest to smallest, so start\n        // at the end of the array\n        for (let i = thisRegions.length-1; i > 0; i--) {\n            if (otherRegions.indexOf(thisRegions[i]) > -1) {\n                return thisRegions[i];\n            }\n        }\n\n        // this default should never be reached because the world should be common to all regions\n        return \"001\";\n    }\n};\n\nexport default LocaleMatcher;\n"],"file":"LocaleMatcher.js"}
+{"version":3,"sources":["../src/LocaleMatcher.js"],"names":["componentWeights","multiScriptLanguages","LocaleMatcher","options","locale","Locale","language","script","region","matchdata","likelyLocales","getSpec","partial","undefined","_getLikelyLocale","fullLocale","langLocale","other","scores","thisfull","otherfull","i","getLikelyLocale","mlthis","macroLanguagesReverse","mlother","pair","mutualIntelligibility","containers","territoryContainmentReverse","length","container","territoryContainment","indexOf","variant","total","Math","round","_getRegionContainment","otherLocale","thisRegion","otherLoc","otherRegion","thisRegions","otherRegions"],"mappings":"gGAqBA,uCACA,+DAEA,+E,wwBAEA,GAAMA,CAAAA,gBAAgB,CAAG,CACrB,GADqB,CAErB,GAFqB,CAGrB,IAHqB,CAIrB,IAJqB,CAAzB,CASA,GAAMC,CAAAA,oBAAoB,CAAG,CACzB,KAAM,IADmB,CAEzB,KAAM,IAFmB,CAGzB,KAAM,IAHmB,CAIzB,KAAM,IAJmB,CAKzB,KAAM,IALmB,CAMzB,KAAM,IANmB,CAOzB,KAAM,IAPmB,CAQzB,KAAM,IARmB,CASzB,KAAM,IATmB,CAA7B,C,GAiBMC,CAAAA,a,YAeF,uBAAYC,OAAZ,CAAqB,qCACjB,KAAKC,MAAL,CAAc,GAAIC,uBAAlB,CAEA,GAAIF,OAAO,EAAI,MAAOA,CAAAA,OAAO,CAACC,MAAf,GAA2B,WAA1C,CAAuD,CACnD,KAAKA,MAAL,CAAe,MAAOD,CAAAA,OAAO,CAACC,MAAf,GAA2B,QAA5B,CAAwC,GAAIC,uBAAJ,CAAWF,OAAO,CAACC,MAAnB,CAAxC,CAAqED,OAAO,CAACC,MAC9F,CACJ,C,mDAMD,oBAAY,CACR,MAAO,MAAKA,MACf,C,gCAMD,0BAAiBA,MAAjB,CAAyB,CAErB,GAAIA,MAAM,CAACE,QAAP,EAAmBF,MAAM,CAACG,MAA1B,EAAoCH,MAAM,CAACI,MAA/C,CAAuD,MAAOJ,CAAAA,MAAP,CAEvD,GAAI,MAAOK,yBAAUC,aAAV,CAAwBN,MAAM,CAACO,OAAP,EAAxB,CAAP,GAAsD,WAA1D,CAAuE,CAEnE,GAAIC,CAAAA,OAAO,CAAGH,wBAAUC,aAAV,CAAwB,GAAIL,uBAAJ,CAAWD,MAAM,CAACE,QAAlB,CAA4BO,SAA5B,CAAuCT,MAAM,CAACI,MAA9C,EAAsDG,OAAtD,EAAxB,CAAd,CACA,GAAI,MAAOC,CAAAA,OAAP,GAAoB,WAAxB,CAAqC,MAAO,IAAIP,uBAAJ,CAAWO,OAAX,CAAP,CAErCA,OAAO,CAAGH,wBAAUC,aAAV,CAAwB,GAAIL,uBAAJ,CAAWD,MAAM,CAACE,QAAlB,CAA4BF,MAAM,CAACG,MAAnC,CAA2CM,SAA3C,EAAsDF,OAAtD,EAAxB,CAAV,CACA,GAAI,MAAOC,CAAAA,OAAP,GAAoB,WAAxB,CAAqC,MAAO,IAAIP,uBAAJ,CAAWO,OAAX,CAAP,CAErCA,OAAO,CAAGH,wBAAUC,aAAV,CAAwB,GAAIL,uBAAJ,CAAWD,MAAM,CAACE,QAAlB,CAA4BO,SAA5B,CAAuCA,SAAvC,EAAkDF,OAAlD,EAAxB,CAAV,CACA,GAAI,MAAOC,CAAAA,OAAP,GAAoB,WAAxB,CAAqC,MAAO,IAAIP,uBAAJ,CAAWO,OAAX,CAAP,CAErCA,OAAO,CAAGH,wBAAUC,aAAV,CAAwB,GAAIL,uBAAJ,CAAWQ,SAAX,CAAsBT,MAAM,CAACG,MAA7B,CAAqCH,MAAM,CAACI,MAA5C,EAAoDG,OAApD,EAAxB,CAAV,CACA,GAAI,MAAOC,CAAAA,OAAP,GAAoB,WAAxB,CAAqC,MAAO,IAAIP,uBAAJ,CAAWO,OAAX,CAAP,CAErCA,OAAO,CAAGH,wBAAUC,aAAV,CAAwB,GAAIL,uBAAJ,CAAWQ,SAAX,CAAsBA,SAAtB,CAAiCT,MAAM,CAACI,MAAxC,EAAgDG,OAAhD,EAAxB,CAAV,CACA,GAAI,MAAOC,CAAAA,OAAP,GAAoB,WAAxB,CAAqC,MAAO,IAAIP,uBAAJ,CAAWO,OAAX,CAAP,CAErCA,OAAO,CAAGH,wBAAUC,aAAV,CAAwB,GAAIL,uBAAJ,CAAWQ,SAAX,CAAsBT,MAAM,CAACG,MAA7B,CAAqCM,SAArC,EAAgDF,OAAhD,EAAxB,CAAV,CACA,GAAI,MAAOC,CAAAA,OAAP,GAAoB,WAAxB,CAAqC,MAAO,IAAIP,uBAAJ,CAAWO,OAAX,CAAP,CAErC,MAAOR,CAAAA,MACV,CAED,MAAO,IAAIC,uBAAJ,CAAWI,wBAAUC,aAAV,CAAwBN,MAAM,CAACO,OAAP,EAAxB,CAAX,CACV,C,+BAgBD,0BAAkB,CACd,MAAO,MAAKG,gBAAL,CAAsB,KAAKV,MAA3B,CACV,C,sCA0BD,iCAAyB,CACrB,GAAMW,CAAAA,UAAU,CAAG,KAAKD,gBAAL,CAAsB,KAAKV,MAA3B,CAAnB,CACA,GAAMY,CAAAA,UAAU,CAAG,KAAKF,gBAAL,CAAsB,GAAIT,uBAAJ,CAAWU,UAAU,CAACT,QAAtB,CAAtB,CAAnB,CACA,MAAOS,CAAAA,UAAU,CAACR,MAAX,GAAsBS,UAAU,CAACT,MAAjC,EAA2C,CAACN,oBAAoB,CAACc,UAAU,CAACT,QAAZ,CAAhE,CACH,GAAID,uBAAJ,CAAWU,UAAU,CAACT,QAAtB,CAAgCO,SAAhC,CAA2CE,UAAU,CAACP,MAAtD,CADG,CAEHO,UACP,C,qBA4ED,eAAMX,MAAN,CAAc,CACV,GAAMa,CAAAA,KAAK,CAAG,GAAIZ,uBAAJ,CAAWD,MAAX,CAAd,CACA,GAAIc,CAAAA,MAAM,CAAG,CAAC,CAAD,CAAI,CAAJ,CAAO,CAAP,CAAU,CAAV,CAAb,CACA,GAAIC,CAAAA,QAAJ,CAAcC,SAAd,CAAyBC,CAAzB,CAEA,GAAI,KAAKjB,MAAL,CAAYE,QAAZ,GAAyBW,KAAK,CAACX,QAAnC,CAA6C,CACzCY,MAAM,CAAC,CAAD,CAAN,CAAY,GACf,CAFD,IAEO,CACH,GAAI,CAAC,KAAKd,MAAL,CAAYE,QAAb,EAAyB,CAACW,KAAK,CAACX,QAApC,CAA8C,CAE1Ca,QAAQ,CAAG,KAAKG,eAAL,EAAX,CACAF,SAAS,CAAG,GAAIf,uBAAJ,CAAWI,wBAAUC,aAAV,CAAwBO,KAAK,CAACN,OAAN,EAAxB,GAA4CM,KAAK,CAACN,OAAN,EAAvD,CAAZ,CACA,GAAIQ,QAAQ,CAACb,QAAT,GAAsBc,SAAS,CAACd,QAApC,CAA8C,CAC1CY,MAAM,CAAC,CAAD,CAAN,CAAY,GACf,CACJ,CAPD,IAOO,CAEH,GAAMK,CAAAA,MAAM,CAAGd,wBAAUe,qBAAV,CAAgC,KAAKpB,MAAL,CAAYE,QAA5C,GAAyD,KAAKF,MAAL,CAAYE,QAApF,CACA,GAAMmB,CAAAA,OAAO,CAAGhB,wBAAUe,qBAAV,CAAgCP,KAAK,CAACX,QAAtC,GAAmDW,KAAK,CAACX,QAAzE,CACA,GAAIiB,MAAM,GAAKE,OAAf,CAAwB,CACpBP,MAAM,CAAC,CAAD,CAAN,CAAY,EACf,CAFD,IAEO,CAEH,GAAMQ,CAAAA,IAAI,CAAG,KAAKtB,MAAL,CAAYE,QAAZ,CAAuB,GAAvB,CAA6BW,KAAK,CAACX,QAAhD,CACAY,MAAM,CAAC,CAAD,CAAN,CAAYT,wBAAUkB,qBAAV,CAAgCD,IAAhC,GAAyC,CACxD,CACJ,CACJ,CAED,GAAI,KAAKtB,MAAL,CAAYG,MAAZ,GAAuBU,KAAK,CAACV,MAAjC,CAAyC,CACrCW,MAAM,CAAC,CAAD,CAAN,CAAY,GACf,CAFD,IAEO,CACH,GAAI,CAAC,KAAKd,MAAL,CAAYG,MAAb,EAAuB,CAACU,KAAK,CAACV,MAAlC,CAA0C,CAEtCY,QAAQ,CAAG,KAAKf,MAAL,CAAYG,MAAZ,CAAqB,KAAKH,MAA1B,CAAmC,GAAIC,uBAAJ,CAAWI,wBAAUC,aAAV,CAAwB,KAAKN,MAAL,CAAYE,QAApC,CAAX,CAA9C,CACAc,SAAS,CAAGH,KAAK,CAACV,MAAN,CAAeU,KAAf,CAAuB,GAAIZ,uBAAJ,CAAWI,wBAAUC,aAAV,CAAwBO,KAAK,CAACX,QAA9B,CAAX,CAAnC,CACA,GAAIa,QAAQ,CAACZ,MAAT,GAAoBa,SAAS,CAACb,MAAlC,CAA0C,CACtCW,MAAM,CAAC,CAAD,CAAN,CAAY,GACf,CACJ,CACJ,CAED,GAAI,KAAKd,MAAL,CAAYI,MAAZ,GAAuBS,KAAK,CAACT,MAAjC,CAAyC,CACrCU,MAAM,CAAC,CAAD,CAAN,CAAY,GACf,CAFD,IAEO,CACH,GAAI,CAAC,KAAKd,MAAL,CAAYI,MAAb,EAAuB,CAACS,KAAK,CAACT,MAAlC,CAA0C,CAEtCW,QAAQ,CAAG,KAAKG,eAAL,EAAX,CACAF,SAAS,CAAG,GAAIf,uBAAJ,CAAWI,wBAAUC,aAAV,CAAwBO,KAAK,CAACN,OAAN,EAAxB,GAA4CM,KAAK,CAACN,OAAN,EAAvD,CAAZ,CACA,GAAIQ,QAAQ,CAACX,MAAT,GAAoBY,SAAS,CAACZ,MAAlC,CAA0C,CACtCU,MAAM,CAAC,CAAD,CAAN,CAAY,GACf,CACJ,CAPD,IAOO,CAEH,GAAMU,CAAAA,UAAU,CAAGnB,wBAAUoB,2BAAV,CAAsC,KAAKzB,MAAL,CAAYI,MAAlD,GAA6D,EAAhF,CAEA,IAAKa,CAAC,CAAGO,UAAU,CAACE,MAAX,CAAkB,CAA3B,CAA8BT,CAAC,CAAG,CAAlC,CAAqCA,CAAC,EAAtC,CAA0C,CACtC,GAAMU,CAAAA,SAAS,CAAGtB,wBAAUuB,oBAAV,CAA+BJ,UAAU,CAACP,CAAD,CAAzC,CAAlB,CACA,GAAIU,SAAS,EAAIA,SAAS,CAACE,OAAV,CAAkBhB,KAAK,CAACT,MAAxB,EAAkC,CAAC,CAApD,CAAuD,CAEnDU,MAAM,CAAC,CAAD,CAAN,CAAa,CAACG,CAAC,CAAC,CAAH,EAAQ,GAAR,CAAcO,UAAU,CAACE,MAA1B,CAAoC,GAAhD,CACA,KACH,CACJ,CACJ,CACJ,CAED,GAAI,KAAK1B,MAAL,CAAY8B,OAAZ,GAAwBjB,KAAK,CAACiB,OAAlC,CAA2C,CACvChB,MAAM,CAAC,CAAD,CAAN,CAAY,GACf,CAED,GAAIiB,CAAAA,KAAK,CAAG,CAAZ,CAEA,IAAKd,CAAC,CAAG,CAAT,CAAYA,CAAC,CAAG,CAAhB,CAAmBA,CAAC,EAApB,CAAwB,CACpBc,KAAK,EAAIjB,MAAM,CAACG,CAAD,CAAN,CAAYrB,gBAAgB,CAACqB,CAAD,CACxC,CAED,MAAOe,CAAAA,IAAI,CAACC,KAAL,CAAWF,KAAX,CACV,C,gCAUD,2BAAmB,CACf,MAAO1B,yBAAUe,qBAAV,CAAgC,KAAKpB,MAAL,CAAYE,QAA5C,GAAyD,KAAKF,MAAL,CAAYE,QAC/E,C,qCAMD,+BAAsBE,MAAtB,CAA8B,CAC1B,MAAOC,yBAAUoB,2BAAV,CAAsCrB,MAAtC,GAAiD,EAC3D,C,oCAcD,+BAAuB,CACnB,GAAMA,CAAAA,MAAM,CAAG,KAAKJ,MAAL,CAAYI,MAAZ,EAAsB,KAAKc,eAAL,GAAuBd,MAA5D,CACA,MAAO,MAAK8B,qBAAL,CAA2B9B,MAA3B,CACV,C,oCAeD,8BAAqB+B,WAArB,CAAkC,CAC9B,GAAI,MAAOA,CAAAA,WAAP,GAAwB,WAA5B,CAAyC,MAAO,KAAP,CAEzC,GAAMC,CAAAA,UAAU,CAAG,KAAKpC,MAAL,CAAYI,MAAZ,EAAsB,KAAKc,eAAL,GAAuBd,MAAhE,CACA,GAAMiC,CAAAA,QAAQ,CAAG,MAAOF,CAAAA,WAAP,GAAwB,QAAxB,CAAmC,GAAIlC,uBAAJ,CAAWkC,WAAX,CAAnC,CAA6DA,WAA9E,CACA,GAAMG,CAAAA,WAAW,CAAG,KAAK5B,gBAAL,CAAsB2B,QAAtB,EAAgCjC,MAApD,CAEA,GAAMmC,CAAAA,WAAW,CAAG,KAAKL,qBAAL,CAA2BE,UAA3B,CAApB,CACA,GAAMI,CAAAA,YAAY,CAAG,KAAKN,qBAAL,CAA2BI,WAA3B,CAArB,CAIA,IAAK,GAAIrB,CAAAA,CAAC,CAAGsB,WAAW,CAACb,MAAZ,CAAmB,CAAhC,CAAmCT,CAAC,CAAG,CAAvC,CAA0CA,CAAC,EAA3C,CAA+C,CAC3C,GAAIuB,YAAY,CAACX,OAAb,CAAqBU,WAAW,CAACtB,CAAD,CAAhC,EAAuC,CAAC,CAA5C,CAA+C,CAC3C,MAAOsB,CAAAA,WAAW,CAACtB,CAAD,CACrB,CACJ,CAGD,MAAO,KACV,C,4BACJ,C,aAEcnB,a","sourcesContent":["/*\n * LocaleMatcher.js - Locale matcher definition\n *\n * Copyright © 2013-2015, 2018-2019, 2021 JEDLSoft\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n *\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n// !data localematch\n\nimport { Utils } from 'ilib-common';\nimport Locale from 'ilib-locale';\n\nimport matchdata from '../locale/localematch.json';\n\nconst componentWeights = [\n    0.5,   // language\n    0.2,   // script\n    0.25,  // region\n    0.05   // variant\n];\n\n// these are languages where you have to put the script all the time,\n// as none of the scripts are default for the language\nconst multiScriptLanguages = {\n    \"az\": true,   // Azerbaijani\n    \"kk\": true,   // Kazakh\n    \"ku\": true,   // Kurdish\n    \"ky\": true,   // Kyrgyz\n    \"pa\": true,   // Panjabi\n    \"sr\": true,   // Serbian\n    \"tg\": true,   // Tajik\n    \"uz\": true,   // Uzbek\n    \"zh\": true    // Chinese\n};\n\n/**\n * @class Represent a locale matcher instance, which is used\n * to see which locales can be matched with each other in\n * various ways.\n */\nclass LocaleMatcher {\n    /**\n     * Create a new locale matcher instance. This is used\n     * to see which locales can be matched with each other in\n     * various ways.<p>\n     *\n     * The options object may contain any of the following properties:\n     *\n     * <ul>\n     * <li><i>locale</i> - the locale instance or locale spec to match\n     * </ul>\n     *\n     * @constructor\n     * @param {Object} options parameters to initialize this matcher\n     */\n    constructor(options) {\n        this.locale = new Locale();\n\n        if (options && typeof(options.locale) !== 'undefined') {\n            this.locale = (typeof(options.locale) === 'string') ? new Locale(options.locale) : options.locale;\n        }\n    }\n\n    /**\n     * Return the locale used to construct this instance.\n     * @return {Locale|undefined} the locale for this matcher\n     */\n    getLocale() {\n        return this.locale;\n    }\n\n    /**\n     * Do the work\n     * @private\n     */\n    _getLikelyLocale(locale) {\n        // already full specified\n        if (locale.language && locale.script && locale.region) return locale;\n\n        if (typeof(matchdata.likelyLocales[locale.getSpec()]) === 'undefined') {\n            // try various partials before giving up\n            let partial = matchdata.likelyLocales[new Locale(locale.language, undefined, locale.region).getSpec()];\n            if (typeof(partial) !== 'undefined') return new Locale(partial);\n\n            partial = matchdata.likelyLocales[new Locale(locale.language, locale.script, undefined).getSpec()];\n            if (typeof(partial) !== 'undefined') return new Locale(partial);\n\n            partial = matchdata.likelyLocales[new Locale(locale.language, undefined, undefined).getSpec()];\n            if (typeof(partial) !== 'undefined') return new Locale(partial);\n\n            partial = matchdata.likelyLocales[new Locale(undefined, locale.script, locale.region).getSpec()];\n            if (typeof(partial) !== 'undefined') return new Locale(partial);\n\n            partial = matchdata.likelyLocales[new Locale(undefined, undefined, locale.region).getSpec()];\n            if (typeof(partial) !== 'undefined') return new Locale(partial);\n\n            partial = matchdata.likelyLocales[new Locale(undefined, locale.script, undefined).getSpec()];\n            if (typeof(partial) !== 'undefined') return new Locale(partial);\n\n            return locale;\n        }\n\n        return new Locale(matchdata.likelyLocales[locale.getSpec()]);\n    }\n\n    /**\n     * Return an Locale instance that is fully specified based on partial information\n     * given to the constructor of this locale matcher instance. For example, if the locale\n     * spec given to this locale matcher instance is simply \"ru\" (for the Russian language),\n     * then it will fill in the missing region and script tags and return a locale with\n     * the specifier \"ru-Cyrl-RU\". (ie. Russian language, Cyrillic, Russian Federation).\n     * Any one or two of the language, script, or region parts may be left unspecified,\n     * and the other one or two parts will be filled in automatically. If this\n     * class has no information about the given locale, then the locale of this\n     * locale matcher instance is returned unchanged.\n     *\n     * @returns {Locale} the most likely completion of the partial locale given\n     * to the constructor of this locale matcher instance\n     */\n    getLikelyLocale() {\n        return this._getLikelyLocale(this.locale);\n    }\n\n    /**\n     * Return an Locale instance that is specified based on partial information\n     * given to the constructor of this locale matcher instance but which leaves out any\n     * part of the locale specifier that is so common that it is understood. For example,\n     * if the locale\n     * spec given to this locale matcher instance is simply \"ru\" (for the Russian language),\n     * then it will fill in the missing region and/or script tags and return a locale with\n     * the specifier \"ru-RU\". (ie. Russian language, Russian Federation). Note that the\n     * default script \"Cyrl\" is left out because the vast majority of text written in\n     * Russian is written with the Cyrllic script, so that part of the locale is understood\n     * and is commonly left out.<p>\n     *\n     * Any one or two of the language, script, or region parts may be left unspecified,\n     * and the other one or two parts will be filled in automatically. If this\n     * class has no information about the given locale, then the locale of this\n     * locale matcher instance is returned unchanged.<p>\n     *\n     * This method returns the same information as getLikelyLocale but with the very common\n     * parts left out.\n     *\n     * @returns {Locale} the most likely \"minimal\" completion of the partial locale given\n     * to the constructor of this locale matcher instance where the commonly understood\n     * parts are left out.\n     */\n    getLikelyLocaleMinimal() {\n        const fullLocale = this._getLikelyLocale(this.locale);\n        const langLocale = this._getLikelyLocale(new Locale(fullLocale.language));\n        return fullLocale.script === langLocale.script && !multiScriptLanguages[fullLocale.language] ?\n            new Locale(fullLocale.language, undefined, fullLocale.region) :\n            fullLocale;\n    }\n\n    /**\n     * Return the degree that the given locale matches the current locale of this\n     * matcher. This method returns an integer from 0 to 100. A value of 100 is\n     * a 100% match, meaning that the two locales are exactly equivalent to each\n     * other. (eg. \"ja-JP\" and \"ja-JP\") A value of 0 means that there 0% match or\n     * that the two locales have nothing in common. (eg. \"en-US\" and \"ja-JP\") <p>\n     *\n     * Locale matching is not the same as equivalence, as the degree of matching\n     * is returned. (See Locale.equals for equivalence.)<p>\n     *\n     * The match score is calculated based on matching the 4 locale components,\n     * weighted by importance:\n     *\n     * <ul>\n     * <li> language - this accounts for 50% of the match score\n     * <li> region - accounts for 25% of the match score\n     * <li> script - accounts for 20% of the match score\n     * <li> variant - accounts for 5% of the match score\n     * </ul>\n     *\n     * The score is affected by the following things:\n     *\n     * <ul>\n     * <li> A large language score is given when the language components of the locales\n     * match exactly.\n     * <li> Higher language scores are given when the languages are linguistically\n     * close to each other, such as dialects.\n     * <li> A small score is given when two languages are in the same\n     * linguistic family, but one is not a dialect of the other, such as German\n     * and Dutch.\n     * <li> A large region score is given when two locales share the same region.\n     * <li> A smaller region score is given when one region is contained within\n     * another. For example, Hong Kong is part of China, so a moderate score is\n     * given instead of a full score.\n     * <li> A small score is given if two regions are geographically close to\n     * each other or are tied by history. For example, Ireland and Great Britain\n     * are both adjacent and tied by history, so they receive a moderate score.\n     * <li> A high script score is given if the two locales share the same script.\n     * The legibility of a common script means that there is some small kinship of the\n     * different languages.\n     * <li> A high variant score is given if the two locales share the same\n     * variant. Full score is given when both locales have no variant at all.\n     * <li> Locale components that are unspecified in both locales are given high\n     * scores.\n     * <li> Locales where a particular locale component is missing in only one\n     * locale can still match when the default for that locale component matches\n     * the component in the other locale. The\n     * default value for the missing component is determined using the likely locales\n     * data. (See getLikelyLocale()) For example, \"en-US\" and \"en-Latn-US\" receive\n     * a high script score because the default script for \"en\" is \"Latn\".\n     * </ul>\n     *\n     * The intention of this method is that it can be used to determine\n     * compatibility of locales. For example, when a user signs up for an\n     * account on a web site, the locales that the web site supports and\n     * the locale of the user's browser may differ, and the site needs to\n     * pick the best locale to show the user. Let's say the\n     * web site supports a selection of European languages such as \"it-IT\",\n     * \"fr-FR\", \"de-DE\", and \"en-GB\". The user's\n     * browser may be set to \"it-CH\". The web site code can then match \"it-CH\"\n     * against each of the supported locales to find the one with the\n     * highest score. In\n     * this case, the best match would be \"it-IT\" because it shares a\n     * language and script in common with \"it-CH\" and differs only in the region\n     * component. It is not a 100% match, but it is pretty good. The web site\n     * may decide if the match scores all fall\n     * below a chosen threshold (perhaps 50%?), it should show the user the\n     * default language \"en-GB\", because that is probably a better choice\n     * than any other supported locale.<p>\n     *\n     * @param {Locale} locale the other locale to match against the current one\n     * @return {number} an integer from 0 to 100 that indicates the degree to\n     * which these locales match each other\n     */\n    match(locale) {\n        const other = new Locale(locale);\n        let scores = [0, 0, 0, 0];\n        let thisfull, otherfull, i;\n\n        if (this.locale.language === other.language) {\n            scores[0] = 100;\n        } else {\n            if (!this.locale.language || !other.language) {\n                // check for default language\n                thisfull = this.getLikelyLocale();\n                otherfull = new Locale(matchdata.likelyLocales[other.getSpec()] || other.getSpec());\n                if (thisfull.language === otherfull.language) {\n                    scores[0] = 100;\n                }\n            } else {\n                // check for macro languages\n                const mlthis = matchdata.macroLanguagesReverse[this.locale.language] || this.locale.language;\n                const mlother = matchdata.macroLanguagesReverse[other.language] || other.language;\n                if (mlthis === mlother) {\n                    scores[0] = 90;\n                } else {\n                    // check for mutual intelligibility\n                    const pair = this.locale.language + \"-\" + other.language;\n                    scores[0] = matchdata.mutualIntelligibility[pair] || 0;\n                }\n            }\n        }\n\n        if (this.locale.script === other.script) {\n            scores[1] = 100;\n        } else {\n            if (!this.locale.script || !other.script) {\n                // check for default script\n                thisfull = this.locale.script ? this.locale : new Locale(matchdata.likelyLocales[this.locale.language]);\n                otherfull = other.script ? other : new Locale(matchdata.likelyLocales[other.language]);\n                if (thisfull.script === otherfull.script) {\n                    scores[1] = 100;\n                }\n            }\n        }\n\n        if (this.locale.region === other.region) {\n            scores[2] = 100;\n        } else {\n            if (!this.locale.region || !other.region) {\n                // check for default region\n                thisfull = this.getLikelyLocale();\n                otherfull = new Locale(matchdata.likelyLocales[other.getSpec()] || other.getSpec());\n                if (thisfull.region === otherfull.region) {\n                    scores[2] = 100;\n                }\n            } else {\n                // check for containment\n                const containers = matchdata.territoryContainmentReverse[this.locale.region] || [];\n                // end at 1 because 0 is \"001\" which is \"the whole world\" -- which is not useful\n                for (i = containers.length-1; i > 0; i--) {\n                    const container = matchdata.territoryContainment[containers[i]];\n                    if (container && container.indexOf(other.region) > -1) {\n                        // same area only accounts for 20% of the region score\n                        scores[2] = ((i+1) * 100 / containers.length) * 0.2;\n                        break;\n                    }\n                }\n            }\n        }\n\n        if (this.locale.variant === other.variant) {\n            scores[3] = 100;\n        }\n\n        let total = 0;\n\n        for (i = 0; i < 4; i++) {\n            total += scores[i] * componentWeights[i];\n        }\n\n        return Math.round(total);\n    }\n\n    /**\n     * Return the macrolanguage associated with this locale. If the\n     * locale's language is not part of a macro-language, then the\n     * locale's language is returned as-is.\n     *\n     * @returns {string} the ISO code for the macrolanguage associated\n     * with this locale, or language of the locale\n     */\n    getMacroLanguage() {\n        return matchdata.macroLanguagesReverse[this.locale.language] || this.locale.language;\n    }\n\n    /**\n     * Return the containment array for the given region code.\n     * @private\n     */\n    _getRegionContainment(region) {\n        return matchdata.territoryContainmentReverse[region] || [];\n    }\n\n    /**\n     * Return the list of regions that this locale is contained within. Regions are\n     * nested, so locales can be in multiple regions. (eg. US is in Northern North\n     * America, North America, the Americas, the World.) Most regions are specified\n     * using UN.49 region numbers, though some, like \"EU\", are letters. If the\n     * locale is underspecified, this method will use the most likely locale method\n     * to get the region first. For example, the locale \"ja\" (Japanese) is most\n     * likely \"ja-JP\" (Japanese for Japan), and the region containment info for Japan\n     * is returned.\n     *\n     * @returns {Array.<string>} an array of region specifiers that this locale is within\n     */\n    getRegionContainment() {\n        const region = this.locale.region || this.getLikelyLocale().region;\n        return this._getRegionContainment(region);\n    }\n\n    /**\n     * Find the smallest region that contains both the current locale and the other locale.\n     * If the current or other locales are underspecified, this method will use the most\n     * likely locale method\n     * to get their regions first. For example, the locale \"ja\" (Japanese) is most\n     * likely \"ja-JP\" (Japanese for Japan), and the region containment info for Japan\n     * is checked against the other locale's region containment info.\n     *\n     * @param {string|Locale} otherLocale a locale specifier or a Locale instance to\n     * compare against\n     * @returns {string} the region specifier of the smallest region containing both the\n     * current locale and other locale\n     */\n    smallestCommonRegion(otherLocale) {\n        if (typeof(otherLocale) === \"undefined\") return \"001\";\n\n        const thisRegion = this.locale.region || this.getLikelyLocale().region;\n        const otherLoc = typeof(otherLocale) === \"string\" ? new Locale(otherLocale) : otherLocale;\n        const otherRegion = this._getLikelyLocale(otherLoc).region;\n\n        const thisRegions = this._getRegionContainment(thisRegion);\n        const otherRegions = this._getRegionContainment(otherRegion);\n\n        // region containment arrays are arranged from largest to smallest, so start\n        // at the end of the array\n        for (let i = thisRegions.length-1; i > 0; i--) {\n            if (otherRegions.indexOf(thisRegions[i]) > -1) {\n                return thisRegions[i];\n            }\n        }\n\n        // this default should never be reached because the world should be common to all regions\n        return \"001\";\n    }\n};\n\nexport default LocaleMatcher;\n"],"file":"LocaleMatcher.js"}