@gasket/plugin-intl/lib/utils/get-preferred-locale.js

NodeJS script to build localization files.

import debug from 'debug';
const debugLog = debug('gasket:plugin:intl:utils');
import { getIntlConfig } from './configure-utils.js';
import Negotiator from 'negotiator';

/**
 * Capitalize the first letter of a string.
 * @param {string} str - String to capitalize
 * @returns {string} capitalized string
 */
function capitalize(str) {
  return str[0].toUpperCase() + str.substring(1).toLowerCase();
}

/**
 * Ensure consistent locale format coming from accept-language header.
 * @example
 * - az-AZ
 * - az-Arab
 * - az-AZ-Latn
 * @type {import('../internal.d.ts').formatLocale}
 */
function formatLocale(language) {
  const [lang, ...rest] = language ? language.split('-') : [];
  return [
    lang.toLowerCase(),
    ...rest.map((o) => (o.length === 2 ? o.toUpperCase() : capitalize(o)))
  ].join('-');
}

/**
 * Get the preferred locale from the request headers.
 * @type {import('../internal.d.ts').getLocaleFromHeaders}
 */
function getLocaleFromHeaders(gasket, req, locales, defaultLocale) {
  let preferredLocale = defaultLocale;
  /** @type {string} */
  const acceptLanguage = req.headers['accept-language'];
  const negotiator = new Negotiator(req);
  if (acceptLanguage) {
    debugLog(`Received accept-language of ${acceptLanguage}`);
    try {
      // Get highest or highest from locales if configured
      preferredLocale = formatLocale(negotiator.language(locales));
      debugLog(`Using ${preferredLocale} as starting locale`);
    } catch (error) {
      gasket.logger.debug(
        `Unable to parse accept-language header: ${error.message}`
      );
    }
  } else {
    debugLog(
      `No accept-language header; starting with default ${preferredLocale}`
    );
  }

  return preferredLocale;
}

/**
 * Get the preferred locale from the request headers.
 * @type {import('../internal.d.ts').getPreferredLocale}
 */
export default function getPreferredLocale(gasket, req) {
  const {
    defaultLocale,
    locales
  } = getIntlConfig(gasket);

  const preferredLocale = getLocaleFromHeaders(
    gasket,
    req,
    locales,
    defaultLocale
  );

  return preferredLocale;
}