resolve-accept-language 2.1.23 → 3.0.0

package/README.md

@@ -9,6 +9,8 @@ Resolve the best locale based on the value of an `Accept-Language` HTTP header.
 
 ## Usage
 
+> ⚠ In March 2024, version 3 of this package was released, which includes breaking changes. Please refer to the [upgrade guide](./V2-TO-V3-UPGRADE-GUIDE.md) before upgrading.
+
 Add the package as a dependency:
 
 ```
@@ -18,7 +20,7 @@ npm install resolve-accept-language
 Code example:
 
 ```ts
-import resolveAcceptLanguage from 'resolve-accept-language'
+import { resolveAcceptLanguage } from 'resolve-accept-language'
 
 /**
  * The API is well documented from within your IDE using TSDoc. The arguments are as follows:
@@ -45,26 +47,29 @@ fr-CA
 
 ## Advanced use cases
 
-You may want to control exactly the behavior depending on the type of match. For example, you could want to display a language picker on your home page if the match is not satisfactory. In those cases, you will need to use the `ResolveAcceptLanguage` class instead. It offers more visibility into the selection process while matching a locale:
+You may want to control exactly the behavior depending on the type of match. For example, you might want to display a language picker on your home page if the match is not satisfactory. In those cases, you will need to use the `{ returnMatchType: true }` option. It offers more visibility into the selection process while matching a locale:
 
 ```ts
-import { MATCH_TYPES, ResolveAcceptLanguage } from 'resolve-accept-language'
+import { MATCH_TYPES, resolveAcceptLanguage } from 'resolve-accept-language'
 
-const resolveAcceptLanguage = new ResolveAcceptLanguage(
+const { match, matchType } = resolveAcceptLanguage(
   'fr-CA;q=0.01,en-CA;q=0.1,en-US;q=0.001' as const,
   ['en-US', 'fr-CA'],
-  'fr-CA'
+  'fr-CA',
+  { returnMatchType: true }
 )
 
-console.log(`A locale was matched: ${resolveAcceptLanguage.getMatch()}`)
+console.log(`A locale was matched: ${match}`)
 
-if (resolveAcceptLanguage.getMatchType() === MATCH_TYPES.localeBased) {
+if (matchType === MATCH_TYPES.locale) {
   console.log('The match is locale-based')
-} else if (resolveAcceptLanguage.getMatchType() === MATCH_TYPES.languageBased) {
+} else if (matchType === MATCH_TYPES.languageSpecificLocale) {
+  console.log('The match is language specific locale-based')
+} else if (matchType === MATCH_TYPES.language) {
   console.log('The match is language-based')
-} else if (resolveAcceptLanguage.getMatchType() === MATCH_TYPES.relatedLocaleBased) {
+} else if (matchType === MATCH_TYPES.relatedLocale) {
   console.log('The match is related-locale-based')
-} else if (resolveAcceptLanguage.getMatchType() === MATCH_TYPES.defaultLocale) {
+} else if (matchType === MATCH_TYPES.defaultLocale) {
   console.log('The match is the default locale')
 }
 ```
@@ -75,14 +80,19 @@ As per RFC 4647, this package uses the "lookup" matching scheme. This means that
 
 The matching strategy will use the following logic:
 
-1. The default locale (when provided) will always be put as the first locale being evaluated since it is considered the highest quality content available. Otherwise, the locales will be evaluated in the order provided, where the first is the highest quality and the last the lowest.
-2. All locales and languages are extracted from the HTTP header and sorted by quality factor. Locales and languages that are in the HTTP header but not in scope are discarded.
-3. Three different matching patterns (based on the HTTP header's quality factor and order of the provided locales):
-   1. If there were any matches, get the highest-ranked (quality factor) locale or language code:
-      1. **Locale-based match**: Is the highest-ranked a locale? If yes, this is the best match.
-      2. **Language-based match**: Otherwise, find the first locale that matches the highest-ranked language.
-   2. **Related-locale-based match**: If there is no match, find the first locale with a language that matches the highest-ranked language of locales that were not in scope. This is a bit of a "fuzzy match", but the presumption is that it's better to show content in a language that can be understood even if the country is wrong.
-4. When using `resolveAcceptLanguage` return the default locale as a last resort option.
+1. The default locale will always be placed as the first locale being evaluated since it is considered the highest quality content available. Otherwise, the locales will be evaluated in the order provided.
+2. All locales and languages are extracted from the HTTP header and sorted by quality factor and position in the header.
+3. The following matching logic will be performed:
+   1. Perform a first loop on the directives
+      1. If the directive is a locale, then try to find an exact locale match (**locale match**)
+      2. If the directive is a language, then
+         1. Create a new list of directives that have locales matching the language
+         2. Loop through this new list, and try to find an exact locale match (**language-specific locale match**)
+         3. If no match is found, then try to find a locale that matches the language (**language match**)
+   2. Perform a second loop on the directives
+      1. Create a new list of languages from the locales
+      2. Loop through this new list, then try to find a locale that matches the language (**related-locale match**)
+   3. If everything fails, then the fallback is the default locale (**default locale match**)
 
 ## Why another `Accept-Language` package?
 

package/lib/cjs/directives.d.ts

@@ -0,0 +1,27 @@
+/** An object representing an HTTP `Accept-Language` header directive. */
+type Directive = {
+    /** The ISO 639-1 alpha-2 language code. */
+    languageCode: string;
+    /** The locale identifier using the BCP 47 `language`-`country` in case-normalized format. */
+    locale?: string;
+    /** The quality factor (default is 1; values can range from 0 to 1 with up to 3 decimals). */
+    quality: number;
+};
+/** A directive object including the position in its HTTP header. */
+type IndexedDirective = Directive & {
+    /** This is the position of the directive in the HTTP header. */
+    headerPosition: number;
+};
+/** A directive object including the position in its HTTP header and the locale. */
+export type IndexedDirectiveWithLocale = IndexedDirective & {
+    locale: string;
+};
+/**
+ * Get a list of directives from an HTTP `Accept-Language` header.
+ *
+ * @param acceptLanguageHeader - The value of an HTTP request `Accept-Language` header (also known as a "language priority list").
+ *
+ * @returns A list of `IndexedDirective` objects sorted by quality and header position.
+ */
+export declare const getDirectives: (acceptLanguageHeader: string) => IndexedDirective[];
+export {};

package/lib/cjs/directives.js

@@ -0,0 +1 @@
+"use strict";var __assign=this&&this.__assign||function(){return __assign=Object.assign||function(e){for(var r,t=1,a=arguments.length;t<a;t++)for(var i in r=arguments[t])Object.prototype.hasOwnProperty.call(r,i)&&(e[i]=r[i]);return e},__assign.apply(this,arguments)},__read=this&&this.__read||function(e,r){var t="function"==typeof Symbol&&e[Symbol.iterator];if(!t)return e;var a,i,o=t.call(e),n=[];try{for(;(void 0===r||r-- >0)&&!(a=o.next()).done;)n.push(a.value)}catch(e){i={error:e}}finally{try{a&&!a.done&&(t=o.return)&&t.call(o)}finally{if(i)throw i.error}}return n},__spreadArray=this&&this.__spreadArray||function(e,r,t){if(t||2===arguments.length)for(var a,i=0,o=r.length;i<o;i++)!a&&i in r||(a||(a=Array.prototype.slice.call(r,0,i)),a[i]=r[i]);return e.concat(a||Array.prototype.slice.call(r))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.getDirectives=void 0;var getDirective=function(e){var r=e.match(/^((?<matchedLanguageCode>([a-z]{2}))(-(?<matchedCountryCode>[a-z]{2}|419))?)(;q=(?<matchedQuality>(1(\.0{0,3})?)|(0(\.\d{0,3})?)))?$/i);if(null==r?void 0:r.groups){var t=r.groups,a=t.matchedLanguageCode,i=t.matchedCountryCode,o=t.matchedQuality,n=a.toLowerCase(),s=i?i.toUpperCase():void 0;if("419"!==s||"es"===n){var c=void 0===o?1:Number.parseFloat(o);return{languageCode:n,locale:s?"".concat(n,"-").concat(s):void 0,quality:c}}}},getDirectives=function(e){var r=[],t=0;e.split(",").forEach((function(e){var a=getDirective(e.trim());a&&(r.some((function(e){return e.languageCode===a.languageCode&&e.locale===a.locale}))||(r.push(__assign(__assign({},a),{headerPosition:t})),t++))}));var a=r.findIndex((function(e){return"es-419"===e.locale}));if(a>=0){var i=r[a],o=["es-AR","es-CL","es-CO","es-CR","es-HN","es-MX","es-PE","es-US","es-UY","es-VE"].map((function(e){return __assign(__assign({},i),{locale:e})}));r.splice.apply(r,__spreadArray([a,1],__read(o),!1))}return r.sort((function(e,r){var t=r.quality-e.quality;return t||e.headerPosition-r.headerPosition}))};exports.getDirectives=getDirectives;

package/lib/cjs/index.d.ts

@@ -0,0 +1,42 @@
+/** The type of matches. */
+export type MatchType = 'locale' | 'languageSpecificLocale' | 'language' | 'relatedLocale' | 'defaultLocale';
+/** The type of matches enumeration. */
+export declare const MATCH_TYPES: {
+    readonly [K in MatchType]: K;
+};
+/** Type to normalize the locale format. */
+export type NormalizeLocale<Remainder extends string> = Remainder extends `${infer LanguageCode}-${infer CountryCode}` ? `${Lowercase<LanguageCode>}-${Uppercase<CountryCode>}` : Remainder;
+/** Additional options to apply. */
+type Options<WithMatchType extends boolean | undefined> = {
+    /** Should the match type be returned? */
+    returnMatchType?: WithMatchType;
+};
+type Result<Locales extends string[], WithMatchType extends boolean | undefined> = WithMatchType extends true ? {
+    /** The best locale match. */
+    match: NormalizeLocale<Locales[number]>;
+    /** The type of match. */
+    matchType: MatchType;
+} : NormalizeLocale<Locales[number]>;
+/**
+ * Resolve the preferred locale from an HTTP `Accept-Language` header.
+ *
+ * All locale identifiers provided as parameters must following the BCP 47 `language`-`country` (case insensitive).
+ *
+ * @param acceptLanguageHeader - The value of an HTTP request `Accept-Language` header (also known as a "language priority list").
+ * @param locales - An array of locale identifiers that must include the default locale. The order will be used for matching where
+ * the first identifier will be more likely to be matched than the last identifier.
+ * @param defaultLocale - The default locale identifier when no match is found.
+ * @param options - Additional options to apply.
+ *
+ * @returns Either the best locale match or a match object, depending on options.
+ *
+ * @example
+ * // returns 'fr-CA'
+ * resolveAcceptLanguage(
+ *   'fr-CA;q=0.01,en-CA;q=0.1,en-US;q=0.001',
+ *   ['en-US', 'fr-CA'],
+ *   'en-US'
+ * )
+ */
+export declare const resolveAcceptLanguage: <Locales extends string[], WithMatchType extends boolean | undefined = undefined>(acceptLanguageHeader: string, locales: Locales, defaultLocale: Locales[number], options?: Options<WithMatchType> | undefined) => Result<Locales, WithMatchType>;
+export {};

package/lib/cjs/index.js

@@ -0,0 +1 @@
+"use strict";var __read=this&&this.__read||function(e,a){var r="function"==typeof Symbol&&e[Symbol.iterator];if(!r)return e;var t,o,l=r.call(e),n=[];try{for(;(void 0===a||a-- >0)&&!(t=l.next()).done;)n.push(t.value)}catch(e){o={error:e}}finally{try{t&&!t.done&&(r=l.return)&&r.call(l)}finally{if(o)throw o.error}}return n},__spreadArray=this&&this.__spreadArray||function(e,a,r){if(r||2===arguments.length)for(var t,o=0,l=a.length;o<l;o++)!t&&o in a||(t||(t=Array.prototype.slice.call(a,0,o)),t[o]=a[o]);return e.concat(t||Array.prototype.slice.call(a))},__values=this&&this.__values||function(e){var a="function"==typeof Symbol&&Symbol.iterator,r=a&&e[a],t=0;if(r)return r.call(e);if(e&&"number"==typeof e.length)return{next:function(){return e&&t>=e.length&&(e=void 0),{value:e&&e[t++],done:!e}}};throw new TypeError(a?"Object is not iterable.":"Symbol.iterator is not defined.")};Object.defineProperty(exports,"__esModule",{value:!0}),exports.resolveAcceptLanguage=exports.MATCH_TYPES=void 0;var directives_1=require("./directives"),locales_1=require("./locales");exports.MATCH_TYPES={locale:"locale",languageSpecificLocale:"languageSpecificLocale",language:"language",relatedLocale:"relatedLocale",defaultLocale:"defaultLocale"};var resolveAcceptLanguage=function(e,a,r,t){if(a.forEach((function(e){if(!(0,locales_1.isLocale)(e,!1))throw new Error("Invalid locale identifier '".concat(e,"'. A valid locale should follow the BCP 47 'language-country' format."))})),!(0,locales_1.isLocale)(r,!1))throw new Error("Invalid default locale identifier '".concat(r,"'. A valid locale should follow the BCP 47 'language-country' format."));if(!a.some((function(e){return e.toLowerCase()===r.toLowerCase()})))throw new Error("The default locale '".concat(r,"' must be included in the locales array because it is used as a fallback when no match is found."));var o=new locales_1.Locale(r).identifier,l=new Set(__spreadArray([o],__read(a.map((function(e){return new locales_1.Locale(e).identifier}))),!1)),n=function(){var a,r,t,n,c=new locales_1.LocaleList(l),i=(0,directives_1.getDirectives)(e),u=function(e){var a=e.locale,r=e.languageCode;if(!c.languages.has(r))return"continue";if(void 0!==a)return c.locales.has(a)?{value:{match:a,matchType:exports.MATCH_TYPES.locale}}:"continue";var t=i.find((function(e){return e.languageCode===r&&void 0!==e.locale&&c.locales.has(e.locale)}));if(t)return{value:{match:t.locale,matchType:exports.MATCH_TYPES.languageSpecificLocale}};var o=c.objects.find((function(e){return e.languageCode===r}));return o?{value:{match:o.identifier,matchType:exports.MATCH_TYPES.language}}:void 0};try{for(var f=__values(i),s=f.next();!s.done;s=f.next()){var d=u(s.value);if("object"==typeof d)return d.value}}catch(e){a={error:e}}finally{try{s&&!s.done&&(r=f.return)&&r.call(f)}finally{if(a)throw a.error}}var v=function(e){if(!c.languages.has(e.languageCode))return"continue";var a=c.objects.find((function(a){return a.languageCode===e.languageCode}));return a?{value:{match:a.identifier,matchType:exports.MATCH_TYPES.relatedLocale}}:void 0};try{for(var h=__values(i),g=h.next();!g.done;g=h.next()){var y=v(g.value);if("object"==typeof y)return y.value}}catch(e){t={error:e}}finally{try{g&&!g.done&&(n=h.return)&&n.call(h)}finally{if(t)throw t.error}}return{match:o,matchType:exports.MATCH_TYPES.defaultLocale}}();return(null==t?void 0:t.returnMatchType)?n:n.match};exports.resolveAcceptLanguage=resolveAcceptLanguage;

package/lib/cjs/locales.d.ts

@@ -0,0 +1,42 @@
+/** Class to manage a locale identifier using the BCP 47 `language`-`country` format. */
+export declare class Locale {
+    /** The ISO 3166-1 alpha-2 country code. */
+    readonly countryCode: string;
+    /** The locale identifier using the BCP 47 `language`-`country` case-normalized format. */
+    readonly identifier: string;
+    /** The ISO 639-1 alpha-2 language code. */
+    readonly languageCode: string;
+    /**
+     * Create a new `Locale` object.
+     *
+     * @param identifier - A locale identifier using the BCP 47 `language`-`country` format (case insensitive).
+     *
+     * @throws An error if the `identifier` format is invalid.
+     */
+    constructor(identifier: string);
+}
+export declare class LocaleList {
+    /** A set of ISO 3166-1 alpha-2 country codes. */
+    readonly countries: Set<string>;
+    /** A set of ISO 639-1 alpha-2 language codes. */
+    readonly languages: Set<string>;
+    /** A set of locale identifiers using the BCP 47 `language`-`country` case-normalized format. */
+    readonly locales: Set<string>;
+    /** A list of locale objects. */
+    readonly objects: Locale[];
+    /**
+     * Create a list of locale identifiers.
+     *
+     * @param locales - An set of unique locale identifiers using the BCP 47 `language`-`country` format (case insensitive).
+     *
+     * @throws Will throw an error if one of the locale's format is invalid.
+     */
+    constructor(locales: Set<string>);
+}
+/**
+ * Is a given string a locale identifier following the BCP 47 `language`-`country` format.
+ *
+ * @param identifier - A potential locale identify to verify.
+ * @param caseNormalized - Should we verify if the identifier is using the case-normalized format?
+ */
+export declare const isLocale: (identifier: string, caseNormalized?: boolean) => boolean;

package/lib/cjs/locales.js

@@ -0,0 +1 @@
+"use strict";var __read=this&&this.__read||function(e,o){var t="function"==typeof Symbol&&e[Symbol.iterator];if(!t)return e;var a,r,i=t.call(e),s=[];try{for(;(void 0===o||o-- >0)&&!(a=i.next()).done;)s.push(a.value)}catch(e){r={error:e}}finally{try{a&&!a.done&&(t=i.return)&&t.call(i)}finally{if(r)throw r.error}}return s};Object.defineProperty(exports,"__esModule",{value:!0}),exports.isLocale=exports.LocaleList=exports.Locale=void 0;var Locale=function(e){if(!(0,exports.isLocale)(e,!1))throw new Error("invalid locale identifier '".concat(e,"'"));var o=__read(e.split("-"),2),t=o[0],a=o[1];this.languageCode=t.toLowerCase(),this.countryCode=a.toUpperCase(),this.identifier="".concat(this.languageCode,"-").concat(this.countryCode)};exports.Locale=Locale;var LocaleList=function(e){var o=this;this.countries=new Set,this.languages=new Set,this.locales=new Set,this.objects=[],e.forEach((function(e){var t=new Locale(e);o.objects.push(t),o.locales.add(t.identifier),o.languages.add(t.languageCode),o.countries.add(t.countryCode)}))};exports.LocaleList=LocaleList;var isLocale=function(e,o){return void 0===o&&(o=!0),new RegExp(/^[a-z]{2}-[A-Z]{2}$/,o?void 0:"i").test(e)};exports.isLocale=isLocale;

package/lib/esm/directives.d.ts

@@ -0,0 +1,27 @@
+/** An object representing an HTTP `Accept-Language` header directive. */
+type Directive = {
+    /** The ISO 639-1 alpha-2 language code. */
+    languageCode: string;
+    /** The locale identifier using the BCP 47 `language`-`country` in case-normalized format. */
+    locale?: string;
+    /** The quality factor (default is 1; values can range from 0 to 1 with up to 3 decimals). */
+    quality: number;
+};
+/** A directive object including the position in its HTTP header. */
+type IndexedDirective = Directive & {
+    /** This is the position of the directive in the HTTP header. */
+    headerPosition: number;
+};
+/** A directive object including the position in its HTTP header and the locale. */
+export type IndexedDirectiveWithLocale = IndexedDirective & {
+    locale: string;
+};
+/**
+ * Get a list of directives from an HTTP `Accept-Language` header.
+ *
+ * @param acceptLanguageHeader - The value of an HTTP request `Accept-Language` header (also known as a "language priority list").
+ *
+ * @returns A list of `IndexedDirective` objects sorted by quality and header position.
+ */
+export declare const getDirectives: (acceptLanguageHeader: string) => IndexedDirective[];
+export {};

package/lib/esm/directives.js

@@ -0,0 +1 @@
+var __assign=this&&this.__assign||function(){return __assign=Object.assign||function(e){for(var r,a=1,t=arguments.length;a<t;a++)for(var n in r=arguments[a])Object.prototype.hasOwnProperty.call(r,n)&&(e[n]=r[n]);return e},__assign.apply(this,arguments)},__read=this&&this.__read||function(e,r){var a="function"==typeof Symbol&&e[Symbol.iterator];if(!a)return e;var t,n,o=a.call(e),i=[];try{for(;(void 0===r||r-- >0)&&!(t=o.next()).done;)i.push(t.value)}catch(e){n={error:e}}finally{try{t&&!t.done&&(a=o.return)&&a.call(o)}finally{if(n)throw n.error}}return i},__spreadArray=this&&this.__spreadArray||function(e,r,a){if(a||2===arguments.length)for(var t,n=0,o=r.length;n<o;n++)!t&&n in r||(t||(t=Array.prototype.slice.call(r,0,n)),t[n]=r[n]);return e.concat(t||Array.prototype.slice.call(r))},getDirective=function(e){var r=e.match(/^((?<matchedLanguageCode>([a-z]{2}))(-(?<matchedCountryCode>[a-z]{2}|419))?)(;q=(?<matchedQuality>(1(\.0{0,3})?)|(0(\.\d{0,3})?)))?$/i);if(null==r?void 0:r.groups){var a=r.groups,t=a.matchedLanguageCode,n=a.matchedCountryCode,o=a.matchedQuality,i=t.toLowerCase(),s=n?n.toUpperCase():void 0;if("419"!==s||"es"===i){var l=void 0===o?1:Number.parseFloat(o);return{languageCode:i,locale:s?"".concat(i,"-").concat(s):void 0,quality:l}}}};export var getDirectives=function(e){var r=[],a=0;e.split(",").forEach((function(e){var t=getDirective(e.trim());t&&(r.some((function(e){return e.languageCode===t.languageCode&&e.locale===t.locale}))||(r.push(__assign(__assign({},t),{headerPosition:a})),a++))}));var t=r.findIndex((function(e){return"es-419"===e.locale}));if(t>=0){var n=r[t],o=["es-AR","es-CL","es-CO","es-CR","es-HN","es-MX","es-PE","es-US","es-UY","es-VE"].map((function(e){return __assign(__assign({},n),{locale:e})}));r.splice.apply(r,__spreadArray([t,1],__read(o),!1))}return r.sort((function(e,r){var a=r.quality-e.quality;return a||e.headerPosition-r.headerPosition}))};

package/lib/esm/index.d.ts

@@ -0,0 +1,42 @@
+/** The type of matches. */
+export type MatchType = 'locale' | 'languageSpecificLocale' | 'language' | 'relatedLocale' | 'defaultLocale';
+/** The type of matches enumeration. */
+export declare const MATCH_TYPES: {
+    readonly [K in MatchType]: K;
+};
+/** Type to normalize the locale format. */
+export type NormalizeLocale<Remainder extends string> = Remainder extends `${infer LanguageCode}-${infer CountryCode}` ? `${Lowercase<LanguageCode>}-${Uppercase<CountryCode>}` : Remainder;
+/** Additional options to apply. */
+type Options<WithMatchType extends boolean | undefined> = {
+    /** Should the match type be returned? */
+    returnMatchType?: WithMatchType;
+};
+type Result<Locales extends string[], WithMatchType extends boolean | undefined> = WithMatchType extends true ? {
+    /** The best locale match. */
+    match: NormalizeLocale<Locales[number]>;
+    /** The type of match. */
+    matchType: MatchType;
+} : NormalizeLocale<Locales[number]>;
+/**
+ * Resolve the preferred locale from an HTTP `Accept-Language` header.
+ *
+ * All locale identifiers provided as parameters must following the BCP 47 `language`-`country` (case insensitive).
+ *
+ * @param acceptLanguageHeader - The value of an HTTP request `Accept-Language` header (also known as a "language priority list").
+ * @param locales - An array of locale identifiers that must include the default locale. The order will be used for matching where
+ * the first identifier will be more likely to be matched than the last identifier.
+ * @param defaultLocale - The default locale identifier when no match is found.
+ * @param options - Additional options to apply.
+ *
+ * @returns Either the best locale match or a match object, depending on options.
+ *
+ * @example
+ * // returns 'fr-CA'
+ * resolveAcceptLanguage(
+ *   'fr-CA;q=0.01,en-CA;q=0.1,en-US;q=0.001',
+ *   ['en-US', 'fr-CA'],
+ *   'en-US'
+ * )
+ */
+export declare const resolveAcceptLanguage: <Locales extends string[], WithMatchType extends boolean | undefined = undefined>(acceptLanguageHeader: string, locales: Locales, defaultLocale: Locales[number], options?: Options<WithMatchType> | undefined) => Result<Locales, WithMatchType>;
+export {};

package/lib/esm/index.js

@@ -0,0 +1 @@
+var __read=this&&this.__read||function(e,a){var r="function"==typeof Symbol&&e[Symbol.iterator];if(!r)return e;var t,o,l=r.call(e),n=[];try{for(;(void 0===a||a-- >0)&&!(t=l.next()).done;)n.push(t.value)}catch(e){o={error:e}}finally{try{t&&!t.done&&(r=l.return)&&r.call(l)}finally{if(o)throw o.error}}return n},__spreadArray=this&&this.__spreadArray||function(e,a,r){if(r||2===arguments.length)for(var t,o=0,l=a.length;o<l;o++)!t&&o in a||(t||(t=Array.prototype.slice.call(a,0,o)),t[o]=a[o]);return e.concat(t||Array.prototype.slice.call(a))},__values=this&&this.__values||function(e){var a="function"==typeof Symbol&&Symbol.iterator,r=a&&e[a],t=0;if(r)return r.call(e);if(e&&"number"==typeof e.length)return{next:function(){return e&&t>=e.length&&(e=void 0),{value:e&&e[t++],done:!e}}};throw new TypeError(a?"Object is not iterable.":"Symbol.iterator is not defined.")};import{getDirectives}from"./directives.js";import{Locale,LocaleList,isLocale}from"./locales.js";export var MATCH_TYPES={locale:"locale",languageSpecificLocale:"languageSpecificLocale",language:"language",relatedLocale:"relatedLocale",defaultLocale:"defaultLocale"};export var resolveAcceptLanguage=function(e,a,r,t){if(a.forEach((function(e){if(!isLocale(e,!1))throw new Error("Invalid locale identifier '".concat(e,"'. A valid locale should follow the BCP 47 'language-country' format."))})),!isLocale(r,!1))throw new Error("Invalid default locale identifier '".concat(r,"'. A valid locale should follow the BCP 47 'language-country' format."));if(!a.some((function(e){return e.toLowerCase()===r.toLowerCase()})))throw new Error("The default locale '".concat(r,"' must be included in the locales array because it is used as a fallback when no match is found."));var o=new Locale(r).identifier,l=new Set(__spreadArray([o],__read(a.map((function(e){return new Locale(e).identifier}))),!1)),n=function(){var a,r,t,n,i=new LocaleList(l),c=getDirectives(e),u=function(e){var a=e.locale,r=e.languageCode;if(!i.languages.has(r))return"continue";if(void 0!==a)return i.locales.has(a)?{value:{match:a,matchType:MATCH_TYPES.locale}}:"continue";var t=c.find((function(e){return e.languageCode===r&&void 0!==e.locale&&i.locales.has(e.locale)}));if(t)return{value:{match:t.locale,matchType:MATCH_TYPES.languageSpecificLocale}};var o=i.objects.find((function(e){return e.languageCode===r}));return o?{value:{match:o.identifier,matchType:MATCH_TYPES.language}}:void 0};try{for(var f=__values(c),d=f.next();!d.done;d=f.next()){var s=u(d.value);if("object"==typeof s)return s.value}}catch(e){a={error:e}}finally{try{d&&!d.done&&(r=f.return)&&r.call(f)}finally{if(a)throw a.error}}var v=function(e){if(!i.languages.has(e.languageCode))return"continue";var a=i.objects.find((function(a){return a.languageCode===e.languageCode}));return a?{value:{match:a.identifier,matchType:MATCH_TYPES.relatedLocale}}:void 0};try{for(var h=__values(c),g=h.next();!g.done;g=h.next()){var y=v(g.value);if("object"==typeof y)return y.value}}catch(e){t={error:e}}finally{try{g&&!g.done&&(n=h.return)&&n.call(h)}finally{if(t)throw t.error}}return{match:o,matchType:MATCH_TYPES.defaultLocale}}();return(null==t?void 0:t.returnMatchType)?n:n.match};

package/lib/esm/locales.d.ts

@@ -0,0 +1,42 @@
+/** Class to manage a locale identifier using the BCP 47 `language`-`country` format. */
+export declare class Locale {
+    /** The ISO 3166-1 alpha-2 country code. */
+    readonly countryCode: string;
+    /** The locale identifier using the BCP 47 `language`-`country` case-normalized format. */
+    readonly identifier: string;
+    /** The ISO 639-1 alpha-2 language code. */
+    readonly languageCode: string;
+    /**
+     * Create a new `Locale` object.
+     *
+     * @param identifier - A locale identifier using the BCP 47 `language`-`country` format (case insensitive).
+     *
+     * @throws An error if the `identifier` format is invalid.
+     */
+    constructor(identifier: string);
+}
+export declare class LocaleList {
+    /** A set of ISO 3166-1 alpha-2 country codes. */
+    readonly countries: Set<string>;
+    /** A set of ISO 639-1 alpha-2 language codes. */
+    readonly languages: Set<string>;
+    /** A set of locale identifiers using the BCP 47 `language`-`country` case-normalized format. */
+    readonly locales: Set<string>;
+    /** A list of locale objects. */
+    readonly objects: Locale[];
+    /**
+     * Create a list of locale identifiers.
+     *
+     * @param locales - An set of unique locale identifiers using the BCP 47 `language`-`country` format (case insensitive).
+     *
+     * @throws Will throw an error if one of the locale's format is invalid.
+     */
+    constructor(locales: Set<string>);
+}
+/**
+ * Is a given string a locale identifier following the BCP 47 `language`-`country` format.
+ *
+ * @param identifier - A potential locale identify to verify.
+ * @param caseNormalized - Should we verify if the identifier is using the case-normalized format?
+ */
+export declare const isLocale: (identifier: string, caseNormalized?: boolean) => boolean;

package/lib/esm/locales.js

@@ -0,0 +1 @@
+var __read=this&&this.__read||function(e,t){var o="function"==typeof Symbol&&e[Symbol.iterator];if(!o)return e;var a,r,i=o.call(e),n=[];try{for(;(void 0===t||t-- >0)&&!(a=i.next()).done;)n.push(a.value)}catch(e){r={error:e}}finally{try{a&&!a.done&&(o=i.return)&&o.call(i)}finally{if(r)throw r.error}}return n},Locale=function(e){if(!isLocale(e,!1))throw new Error("invalid locale identifier '".concat(e,"'"));var t=__read(e.split("-"),2),o=t[0],a=t[1];this.languageCode=o.toLowerCase(),this.countryCode=a.toUpperCase(),this.identifier="".concat(this.languageCode,"-").concat(this.countryCode)};export{Locale};var LocaleList=function(e){var t=this;this.countries=new Set,this.languages=new Set,this.locales=new Set,this.objects=[],e.forEach((function(e){var o=new Locale(e);t.objects.push(o),t.locales.add(o.identifier),t.languages.add(o.languageCode),t.countries.add(o.countryCode)}))};export{LocaleList};export var isLocale=function(e,t){return void 0===t&&(t=!0),new RegExp(/^[a-z]{2}-[A-Z]{2}$/,t?void 0:"i").test(e)};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "resolve-accept-language",
-  "version": "2.1.23",
+  "version": "3.0.0",
   "description": "Resolve the preferred locale based on the value of an `Accept-Language` HTTP header.",
   "keywords": [
     "accept-language",
@@ -26,35 +26,37 @@
   "exports": {
     ".": {
       "import": {
-        "types": "./lib/esm/resolve-accept-language.d.ts",
-        "default": "./lib/esm/resolve-accept-language.js"
+        "types": "./lib/esm/index.d.ts",
+        "default": "./lib/esm/index.js"
       },
       "require": {
-        "types": "./lib/cjs/resolve-accept-language.d.ts",
-        "default": "./lib/cjs/resolve-accept-language.js"
+        "types": "./lib/cjs/index.d.ts",
+        "default": "./lib/cjs/index.js"
       }
     }
   },
-  "main": "lib/cjs/resolve-accept-language.js",
-  "module": "lib/esm/resolve-accept-language.js",
-  "types": "lib/esm/resolve-accept-language.d.ts",
+  "main": "lib/cjs/index.js",
+  "module": "lib/esm/index.js",
+  "types": "lib/esm/index.d.ts",
   "files": [
     "lib"
   ],
   "scripts": {
-    "build": "npm run prettier && npm run lint-fix && rm -Rf ./lib && tsc -p tsconfig.cjs.json && tsc -p tsconfig.esm.json && echo '{ \"type\": \"commonjs\" }' > lib/cjs/package.json && npm run test",
-    "lint-check": "eslint --ext .js --ext .jsx --ext .ts --ext .tsx --ext .json .",
+    "build": "npm run prettier && npm run lint-fix && rm -Rf ./lib && tsc -p tsconfig.cjs.json && tsc -p tsconfig.esm.json && echo '{ \"type\": \"commonjs\" }' > lib/cjs/package.json && tsc -p tsconfig.build-scripts.json && node lib/build-scripts/build.js && npm run test",
+    "depcheck": "depcheck",
     "lint-fix": "eslint --fix .",
-    "lint-print-config": "eslint --print-config ./eslintrc.yaml",
     "prettier": "prettier --write .",
     "release": "dotenv -- release-it --only-version",
     "test": "jest --coverage"
   },
   "devDependencies": {
+    "@eslint/js": "^8.57.0",
     "@release-it/conventional-changelog": "8.0.1",
     "@types/jest": "29.5.12",
-    "@typescript-eslint/eslint-plugin": "7.0.2",
-    "@typescript-eslint/parser": "7.0.2",
+    "@types/node": "^20.11.24",
+    "@typescript-eslint/eslint-plugin": "7.1.1",
+    "@typescript-eslint/parser": "7.1.1",
+    "depcheck": "^1.4.7",
     "dotenv-cli": "7.3.0",
     "eslint": "8.57.0",
     "eslint-config-prettier": "9.1.0",
@@ -64,7 +66,7 @@
     "eslint-plugin-jest": "27.9.0",
     "eslint-plugin-jsdoc": "48.2.0",
     "eslint-plugin-json-files": "4.1.0",
-    "eslint-plugin-prefer-arrow-functions": "3.3.1",
+    "eslint-plugin-prefer-arrow-functions": "3.3.2",
     "eslint-plugin-prettier": "5.1.3",
     "eslint-plugin-tsdoc": "0.2.17",
     "eslint-plugin-unicorn": "51.0.1",
@@ -75,8 +77,8 @@
     "prettier-plugin-organize-imports": "3.2.4",
     "prettier-plugin-sh": "0.14.0",
     "release-it": "17.1.1",
+    "terser": "^5.28.1",
     "ts-jest": "29.1.2",
-    "ts-node": "10.9.2",
     "typescript": "5.3.3"
   },
   "engines": {

package/lib/cjs/locale-list.d.ts

@@ -1,19 +0,0 @@
-import Locale from './locale';
-export default class LocaleList<TLocales extends readonly string[]> {
-    /** A set of ISO 3166-1 alpha-2 country codes. */
-    readonly countries: Set<string>;
-    /** A set of ISO 639-1 alpha-2 language codes. */
-    readonly languages: Set<string>;
-    /** A set of locale identifiers using the BCP 47 `language`-`country` case-normalized format. */
-    readonly locales: Set<string>;
-    /** A list of locale objects. */
-    readonly objects: Locale[];
-    /**
-     * Create a list of locale identifiers.
-     *
-     * @param locales - An array of locale identifiers using the BCP 47 `language`-`country` format.
-     *
-     * @throws Will throw an error if one of the locale's format is invalid.
-     */
-    constructor(locales: TLocales extends string[] ? TLocales[number][] : TLocales);
-}

package/lib/cjs/locale-list.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var locale_1 = require("./locale");
-var LocaleList = /** @class */ (function () {
-    /**
-     * Create a list of locale identifiers.
-     *
-     * @param locales - An array of locale identifiers using the BCP 47 `language`-`country` format.
-     *
-     * @throws Will throw an error if one of the locale's format is invalid.
-     */
-    function LocaleList(locales) {
-        var _this = this;
-        /** A set of ISO 3166-1 alpha-2 country codes. */
-        this.countries = new Set();
-        /** A set of ISO 639-1 alpha-2 language codes. */
-        this.languages = new Set();
-        /** A set of locale identifiers using the BCP 47 `language`-`country` case-normalized format. */
-        this.locales = new Set();
-        /** A list of locale objects. */
-        this.objects = [];
-        locales.forEach(function (locale) {
-            var localeObject = new locale_1.default(locale);
-            if (!_this.locales.has(localeObject.identifier)) {
-                _this.objects.push(localeObject);
-                _this.locales.add(localeObject.identifier);
-                _this.languages.add(localeObject.languageCode);
-                _this.countries.add(localeObject.countryCode);
-            }
-        });
-    }
-    return LocaleList;
-}());
-exports.default = LocaleList;

package/lib/cjs/locale.d.ts

@@ -1,39 +0,0 @@
-import { NormalizeLocale } from './resolve-accept-language';
-/** Class to manage a locale identifier using the BCP 47 `language`-`country` format. */
-export default class Locale<TLocale extends string = string> {
-    /** The ISO 3166-1 alpha-2 country code. */
-    readonly countryCode: string;
-    /** The locale identifier using the BCP 47 `language`-`country` case-normalized format. */
-    readonly identifier: NormalizeLocale<TLocale>;
-    /** The ISO 639-1 alpha-2 language code. */
-    readonly languageCode: string;
-    /**
-     * Create a new `Locale` object.
-     *
-     * @param identifier - A locale identifier using the BCP 47 `language`-`country` format (case insensitive).
-     *
-     * @throws An error if the `identifier` format is invalid.
-     */
-    constructor(identifier: string);
-    /**
-     * Is a given string an ISO 3166-1 alpha-2 country code.
-     *
-     * @param countryCode - An ISO 3166-1 alpha-2 country code.
-     * @param caseNormalized - Should we verify if the identifier is using the case-normalized format?
-     */
-    static isCountryCode(countryCode: string, caseNormalized?: boolean): boolean;
-    /**
-     * Is a given string an ISO 639-1 alpha-2 language code.
-     *
-     * @param languageCode - An ISO 639-1 alpha-2 language code.
-     * @param caseNormalized - Should we verify if the identifier is using the case-normalized format?
-     */
-    static isLanguageCode(languageCode: string, caseNormalized?: boolean): boolean;
-    /**
-     * Is a given string a locale identifier following the BCP 47 `language`-`country` format.
-     *
-     * @param identifier - A potential locale identify to verify.
-     * @param caseNormalized - Should we verify if the identifier is using the case-normalized format?
-     */
-    static isLocale(identifier: string, caseNormalized?: boolean): boolean;
-}

package/lib/cjs/locale.js

@@ -1,56 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/** Class to manage a locale identifier using the BCP 47 `language`-`country` format. */
-var Locale = /** @class */ (function () {
-    /**
-     * Create a new `Locale` object.
-     *
-     * @param identifier - A locale identifier using the BCP 47 `language`-`country` format (case insensitive).
-     *
-     * @throws An error if the `identifier` format is invalid.
-     */
-    function Locale(identifier) {
-        if (!Locale.isLocale(identifier, false)) {
-            throw new Error("invalid locale identifier '".concat(identifier, "'"));
-        }
-        var _a = identifier.split('-'), languageCode = _a[0], countryCode = _a[1];
-        this.languageCode = languageCode.toLowerCase();
-        this.countryCode = countryCode.toUpperCase();
-        this.identifier = "".concat(this.languageCode, "-").concat(this.countryCode);
-    }
-    /**
-     * Is a given string an ISO 3166-1 alpha-2 country code.
-     *
-     * @param countryCode - An ISO 3166-1 alpha-2 country code.
-     * @param caseNormalized - Should we verify if the identifier is using the case-normalized format?
-     */
-    Locale.isCountryCode = function (countryCode, caseNormalized) {
-        if (caseNormalized === void 0) { caseNormalized = true; }
-        var regExp = new RegExp(/^[A-Z]{2}$/, caseNormalized ? undefined : 'i');
-        return regExp.test(countryCode);
-    };
-    /**
-     * Is a given string an ISO 639-1 alpha-2 language code.
-     *
-     * @param languageCode - An ISO 639-1 alpha-2 language code.
-     * @param caseNormalized - Should we verify if the identifier is using the case-normalized format?
-     */
-    Locale.isLanguageCode = function (languageCode, caseNormalized) {
-        if (caseNormalized === void 0) { caseNormalized = true; }
-        var regExp = new RegExp(/^[a-z]{2}$/, caseNormalized ? undefined : 'i');
-        return regExp.test(languageCode);
-    };
-    /**
-     * Is a given string a locale identifier following the BCP 47 `language`-`country` format.
-     *
-     * @param identifier - A potential locale identify to verify.
-     * @param caseNormalized - Should we verify if the identifier is using the case-normalized format?
-     */
-    Locale.isLocale = function (identifier, caseNormalized) {
-        if (caseNormalized === void 0) { caseNormalized = true; }
-        var regExp = new RegExp(/^[a-z]{2}-[A-Z]{2}$/, caseNormalized ? undefined : 'i');
-        return regExp.test(identifier);
-    };
-    return Locale;
-}());
-exports.default = Locale;