@prezly/theme-kit-nextjs 1.11.2 → 1.12.0-0

package/src/intl/languages.ts

@@ -71,6 +71,7 @@ export function getLanguageByNeutralLocaleCode(
 
     // Prefer default language
     const defaultLanguage = getDefaultLanguage(languages);
+    // TODO: This doesn't align with other methods logic
     if (defaultLanguage.code === locale.toUnderscoreCode()) {
         return defaultLanguage;
     }
@@ -79,8 +80,7 @@ export function getLanguageByNeutralLocaleCode(
     const usedLanguages = getUsedLanguages(languages);
     const usedLanguage = usedLanguages.find(
         ({ code }) =>
-            LocaleObject.fromAnyCode(code).toNeutralLanguageCode() === neutralLanguageCode ||
-            code === neutralLanguageCode,
+            LocaleObject.fromAnyCode(code).toNeutralLanguageCode() === neutralLanguageCode,
     );
     if (usedLanguage) {
         return usedLanguage;
@@ -89,8 +89,7 @@ export function getLanguageByNeutralLocaleCode(
     // Search in all languages
     return languages.find(
         ({ code }) =>
-            LocaleObject.fromAnyCode(code).toNeutralLanguageCode() === neutralLanguageCode ||
-            code === neutralLanguageCode,
+            LocaleObject.fromAnyCode(code).toNeutralLanguageCode() === neutralLanguageCode,
     );
 }
 
@@ -144,9 +143,6 @@ export function getLanguageFromNextLocaleIsoCode(
             getLanguageByExactLocaleCode(languages, locale) ||
             getLanguageByNeutralLocaleCode(languages, locale) ||
             getLanguageByShortRegionCode(languages, locale);
-        if (targetLanguage) {
-            return targetLanguage;
-        }
     } else {
         targetLanguage = getLanguageByExactLocaleCode(languages, locale);
     }
@@ -175,6 +171,8 @@ export function getCompanyInformation(languages: NewsroomLanguageSettings[], loc
  * First: try shorting to neutral language code (there should be no locales with the same language code)
  * Then: try shorting to region code (there should be no locales with the same region code)
  * Finally: return the original locale code (shorting is not possible)
+ *
+ * @param locale A LocaleObject constructed from FULL locale code (taken straight from the selected language)
  */
 export function getShortestLocaleCode(
     languages: NewsroomLanguageSettings[],
@@ -189,11 +187,6 @@ export function getShortestLocaleCode(
 
     // Try shorting to neutral language code
     const neutralLanguageCode = locale.toNeutralLanguageCode();
-    // The code is already as short as possible
-    if (neutralLanguageCode === localeCode) {
-        return localeCode;
-    }
-
     const matchingLanguagesByNeutralCode = languages.filter(
         ({ code }) =>
             LocaleObject.fromAnyCode(code).toNeutralLanguageCode() === neutralLanguageCode ||
@@ -209,10 +202,11 @@ export function getShortestLocaleCode(
         ({ code }) => LocaleObject.fromAnyCode(code).toRegionCode() === shortRegionCode,
     );
     // Prevent collision with neutral language codes
+    const lowerCasedShortRegionCode = shortRegionCode.toLowerCase();
     const mathchingNeutralLanguagesByRegionCode = languages.filter(
         ({ code }) =>
-            LocaleObject.fromAnyCode(code).toNeutralLanguageCode() === shortRegionCode ||
-            code === shortRegionCode,
+            LocaleObject.fromAnyCode(code).toNeutralLanguageCode() === lowerCasedShortRegionCode ||
+            code === lowerCasedShortRegionCode,
     );
     if (
         matchingLanguagesByRegionCode.length === 1 &&

package/src/intl/locale.test.ts

@@ -0,0 +1,94 @@
+import {
+    DEFAULT_LOCALE,
+    DUMMY_DEFAULT_LOCALE,
+    getLocaleDirection,
+    getRedirectToCanonicalLocale,
+    getSupportedLocaleIsoCode,
+} from './locale';
+import { LocaleObject } from './localeObject';
+
+describe('getSupportedLocaleIsoCode', () => {
+    it('returns a code by exact match', () => {
+        expect(getSupportedLocaleIsoCode(LocaleObject.fromAnyCode('en'))).toBe('en');
+        expect(getSupportedLocaleIsoCode(LocaleObject.fromAnyCode('af'))).toBe('af');
+        expect(getSupportedLocaleIsoCode(LocaleObject.fromAnyCode('pt-BR'))).toBe('pt-BR');
+    });
+
+    it('returns a code by neutral language code match', () => {
+        expect(getSupportedLocaleIsoCode(LocaleObject.fromAnyCode('en-US'))).toBe('en');
+        expect(getSupportedLocaleIsoCode(LocaleObject.fromAnyCode('de-DE'))).toBe('de');
+        expect(getSupportedLocaleIsoCode(LocaleObject.fromAnyCode('uk-UA'))).toBe('uk');
+    });
+
+    it('returns custom mapped codes for Chinese locales', () => {
+        expect(getSupportedLocaleIsoCode(LocaleObject.fromAnyCode('zh-Hant'))).toBe('zh-TW');
+        expect(getSupportedLocaleIsoCode(LocaleObject.fromAnyCode('zh-HK'))).toBe('zh-CN');
+    });
+
+    it('returns default locale code for unsupported languages', () => {
+        const consoleSpy = jest.spyOn(console, 'warn');
+
+        // @ts-expect-error
+        expect(getSupportedLocaleIsoCode(new LocaleObject('aa'))).toBe(DEFAULT_LOCALE);
+        expect(consoleSpy).toHaveBeenCalledWith(
+            'Unsupported locale provided. Please use `LocaleObject.fromAnyCode` to ensure you are using a correct language code',
+        );
+    });
+});
+
+describe('getRedirectToCanonicalLocale', () => {
+    it('returns undefined when no locale or dummy locale is provided', () => {
+        expect(getRedirectToCanonicalLocale('en', undefined, '/')).toBe(undefined);
+        expect(getRedirectToCanonicalLocale('en', DUMMY_DEFAULT_LOCALE, '/')).toBe(undefined);
+    });
+
+    it('returns undefined when locale is already canonical', () => {
+        expect(getRedirectToCanonicalLocale('en', 'en', '/')).toBe(undefined);
+        expect(getRedirectToCanonicalLocale('nl_BE', 'nl-be', '/')).toBe(undefined);
+    });
+
+    it('returns a redirect object when requested locale is not canonical', () => {
+        expect(getRedirectToCanonicalLocale(false, 'en-us', '/test')).toEqual({
+            destination: '/test',
+            permanent: false,
+        });
+
+        expect(getRedirectToCanonicalLocale('en', 'en-us', '/test')).toEqual({
+            destination: '/en/test',
+            permanent: false,
+        });
+
+        expect(getRedirectToCanonicalLocale('en', 'en-us', 'test')).toEqual({
+            destination: '/en/test',
+            permanent: false,
+        });
+    });
+
+    it('preserves query parameters', () => {
+        expect(
+            getRedirectToCanonicalLocale('en', 'en-us', '/test', {
+                page: '1',
+                tags: ['story', 'media'],
+            }),
+        ).toEqual({
+            destination: '/en/test?page=1&tags=story&tags=media',
+            permanent: false,
+        });
+    });
+});
+
+describe('getLocaleDirection', () => {
+    it('returns `rtl` for right-to-left languages', () => {
+        const RTL_LANGUAGES = ['ar', 'ar-AE', 'ar-BH', 'ar-QA', 'ar-SA', 'he-IL', 'ur-PK'];
+        RTL_LANGUAGES.forEach((language) => {
+            expect(getLocaleDirection(LocaleObject.fromAnyCode(language))).toBe('rtl');
+        });
+    });
+
+    it('returns `ltr` for other languages', () => {
+        const LTR_LANGUAGES = ['en', 'en-US', 'fr-FR', 'fil', 'pt-BR', 'nl', 'nl-BE'];
+        LTR_LANGUAGES.forEach((language) => {
+            expect(getLocaleDirection(LocaleObject.fromAnyCode(language))).toBe('ltr');
+        });
+    });
+});

package/src/intl/locale.ts

@@ -51,6 +51,7 @@ const SUPPORTED_LOCALES = [
     'sk',
     'sl',
     'sv',
+    'sw',
     'th',
     'tr',
     'uk',
@@ -74,7 +75,7 @@ export function getSupportedLocaleIsoCode(locale: LocaleObject): string {
         return localeIsoCode;
     }
 
-    const language = localeIsoCode.slice(0, 2);
+    const language = locale.toNeutralLanguageCode();
     const isSupportedLanguage = SUPPORTED_LOCALES.includes(language);
     if (isSupportedLanguage) {
         return language;
@@ -88,6 +89,11 @@ export function getSupportedLocaleIsoCode(locale: LocaleObject): string {
         return 'zh-CN';
     }
 
+    // This code should never be reached, because locale code check is happening in `LocaleObject.fromAnyCode`
+    // eslint-disable-next-line no-console
+    console.warn(
+        'Unsupported locale provided. Please use `LocaleObject.fromAnyCode` to ensure you are using a correct language code',
+    );
     return DEFAULT_LOCALE;
 }
 

package/src/intl/localeList.js

@@ -95,6 +95,7 @@ module.exports = [
     'sk-SK',
     'sl-SI',
     'sv-SE',
+    'sw',
     'th-TH',
     'tr-TR',
     'uk-UA',

package/src/intl/localeObject.test.ts

@@ -0,0 +1,78 @@
+import { LocaleObject } from './localeObject';
+
+it('throws when created from invalid code', () => {
+    // @ts-expect-error
+    expect(() => new LocaleObject('en_US')).toThrow('Invalid locale code provided!');
+    // @ts-expect-error
+    expect(() => new LocaleObject('1234')).toThrow('Invalid locale code provided!');
+    // @ts-expect-error
+    expect(() => new LocaleObject('*!en-US')).toThrow('Invalid locale code provided!');
+});
+
+it('throws when created with unsupported code', () => {
+    const unsupportedCode = 'unknown-code';
+    expect(() => LocaleObject.fromAnyCode(unsupportedCode)).toThrow(
+        `Unsupported locale code provided: "${unsupportedCode}"`,
+    );
+});
+
+it('accepts any valid code type and converts it to hyphen code consistently', () => {
+    expect(LocaleObject.fromAnyCode('en').toHyphenCode()).toBe('en');
+    expect(LocaleObject.fromAnyCode('en-us').toHyphenCode()).toBe('en-US');
+    expect(LocaleObject.fromAnyCode('en-US').toHyphenCode()).toBe('en-US');
+    expect(LocaleObject.fromAnyCode('EN-US').toHyphenCode()).toBe('en-US');
+    expect(LocaleObject.fromAnyCode('en_us').toHyphenCode()).toBe('en-US');
+    expect(LocaleObject.fromAnyCode('en_US').toHyphenCode()).toBe('en-US');
+    expect(LocaleObject.fromAnyCode('EN_US').toHyphenCode()).toBe('en-US');
+});
+
+it('converts to underscore code consistently', () => {
+    expect(LocaleObject.fromAnyCode('en').toUnderscoreCode()).toBe('en');
+    expect(LocaleObject.fromAnyCode('en-us').toUnderscoreCode()).toBe('en_US');
+    expect(LocaleObject.fromAnyCode('en-US').toUnderscoreCode()).toBe('en_US');
+    expect(LocaleObject.fromAnyCode('EN-US').toUnderscoreCode()).toBe('en_US');
+    expect(LocaleObject.fromAnyCode('en_us').toUnderscoreCode()).toBe('en_US');
+    expect(LocaleObject.fromAnyCode('en_US').toUnderscoreCode()).toBe('en_US');
+    expect(LocaleObject.fromAnyCode('EN_US').toUnderscoreCode()).toBe('en_US');
+});
+
+it('converts to URL slug consistently', () => {
+    expect(LocaleObject.fromAnyCode('en').toUrlSlug()).toBe('en');
+    expect(LocaleObject.fromAnyCode('en-us').toUrlSlug()).toBe('en-us');
+    expect(LocaleObject.fromAnyCode('en-US').toUrlSlug()).toBe('en-us');
+    expect(LocaleObject.fromAnyCode('EN-US').toUrlSlug()).toBe('en-us');
+    expect(LocaleObject.fromAnyCode('en_us').toUrlSlug()).toBe('en-us');
+    expect(LocaleObject.fromAnyCode('en_US').toUrlSlug()).toBe('en-us');
+    expect(LocaleObject.fromAnyCode('EN_US').toUrlSlug()).toBe('en-us');
+});
+
+it('converts to neutral language code consistently', () => {
+    expect(LocaleObject.fromAnyCode('en').toNeutralLanguageCode()).toBe('en');
+    expect(LocaleObject.fromAnyCode('en-us').toNeutralLanguageCode()).toBe('en');
+    expect(LocaleObject.fromAnyCode('en-US').toNeutralLanguageCode()).toBe('en');
+    expect(LocaleObject.fromAnyCode('EN-US').toNeutralLanguageCode()).toBe('en');
+    expect(LocaleObject.fromAnyCode('en_us').toNeutralLanguageCode()).toBe('en');
+    expect(LocaleObject.fromAnyCode('en_US').toNeutralLanguageCode()).toBe('en');
+    expect(LocaleObject.fromAnyCode('EN_US').toNeutralLanguageCode()).toBe('en');
+});
+
+it('converts to region code consistently', () => {
+    expect(LocaleObject.fromAnyCode('en').toRegionCode()).toBe('EN');
+    expect(LocaleObject.fromAnyCode('en-us').toRegionCode()).toBe('US');
+    expect(LocaleObject.fromAnyCode('en-US').toRegionCode()).toBe('US');
+    expect(LocaleObject.fromAnyCode('EN-US').toRegionCode()).toBe('US');
+    expect(LocaleObject.fromAnyCode('en_us').toRegionCode()).toBe('US');
+    expect(LocaleObject.fromAnyCode('en_US').toRegionCode()).toBe('US');
+    expect(LocaleObject.fromAnyCode('EN_US').toRegionCode()).toBe('US');
+});
+
+it('can compare two objects', () => {
+    const enUsLocale = LocaleObject.fromAnyCode('en-US');
+    const enUsLocaleDuplicate = LocaleObject.fromAnyCode('en-US');
+    const deDeLocale = LocaleObject.fromAnyCode('de-DE');
+
+    expect(enUsLocale.isEqual(enUsLocaleDuplicate)).toBe(true);
+    expect(enUsLocaleDuplicate.isEqual(enUsLocale)).toBe(true);
+    expect(enUsLocale.isEqual(deDeLocale)).toBe(false);
+    expect(deDeLocale.isEqual(enUsLocale)).toBe(false);
+});

package/src/intl/localeObject.ts

@@ -13,7 +13,7 @@ export class LocaleObject {
     private localeCode: string;
 
     private constructor(localeCode: string) {
-        if (localeCode.indexOf('_') !== -1) {
+        if (!/^([a-zA-Z]+)-?([a-zA-Z\d]+)$/.test(localeCode)) {
             throw new Error('Invalid locale code provided!');
         }