fix(@formatjs/intl-displaynames): follow ES2021 spec and make type op…

…tion required (#2103)
formatjs · Sep 17, 2020 · 3e00688 · 3e00688
1 parent 9988a8a
commit 3e00688
Show file tree

Hide file tree

Showing 21 changed files with 1,015 additions and 1,001 deletions.
diff --git a/packages/intl-displaynames/index.ts b/packages/intl-displaynames/index.ts
@@ -17,7 +17,7 @@ import {
 export interface DisplayNamesOptions {
   localeMatcher?: 'lookup' | 'best fit';
   style?: 'narrow' | 'short' | 'long';
-  type?: 'language' | 'region' | 'script' | 'currency';
+  type: 'language' | 'region' | 'script' | 'currency';
   fallback?: 'code' | 'none';
 }
 
@@ -69,8 +69,12 @@ export class DisplayNames {
       'type',
       'string',
       ['language', 'currency', 'region', 'script'],
-      'language'
+      undefined
     );
+    if (type === undefined) {
+      throw TypeError(`Intl.DisplayNames constructor requires "type" option`);
+    }
+
     setSlot(this, 'type', type);
 
     const fallback = GetOption(

diff --git a/packages/intl-displaynames/tests/index.test.ts b/packages/intl-displaynames/tests/index.test.ts
@@ -20,22 +20,26 @@ describe('.of()', () => {
   });
 
   it('preserves unrecognized region subtag in language code when fallback option is code', () => {
-    expect(new DisplayNames('zh', {fallback: 'code'}).of('zh-Hans-Xy')).toBe(
-      '简体中文（XY）'
-    );
+    expect(
+      new DisplayNames('zh', {type: 'language', fallback: 'code'}).of(
+        'zh-Hans-Xy'
+      )
+    ).toBe('简体中文（XY）');
   });
 
   describe('with fallback set to "none"', () => {
     it('returns undefined when called with language code that has unrecognized region subtag', () => {
-      expect(new DisplayNames('zh', {fallback: 'none'}).of('zh-Hans-XY')).toBe(
-        undefined
-      );
+      expect(
+        new DisplayNames('zh', {type: 'language', fallback: 'none'}).of(
+          'zh-Hans-XY'
+        )
+      ).toBe(undefined);
     });
 
     it('returns undefined when called with language code that valid region subtag but invalid language subtag', () => {
-      expect(new DisplayNames('zh', {fallback: 'none'}).of('xx-CN')).toBe(
-        undefined
-      );
+      expect(
+        new DisplayNames('zh', {type: 'language', fallback: 'none'}).of('xx-CN')
+      ).toBe(undefined);
     });
   });
 });

diff --git a/packages/intl/src/displayName.ts b/packages/intl/src/displayName.ts
@@ -24,7 +24,7 @@ export function formatDisplayName(
   },
   getDisplayNames: Formatters['getDisplayNames'],
   value: Parameters<IntlFormatters['formatDisplayName']>[0],
-  options: Parameters<IntlFormatters['formatDisplayName']>[1] = {}
+  options: Parameters<IntlFormatters['formatDisplayName']>[1]
 ): string | undefined {
   const DisplayNames: typeof IntlDisplayNames = (Intl as any).DisplayNames;
   if (!DisplayNames) {

diff --git a/packages/intl/src/types.ts b/packages/intl/src/types.ts
@@ -134,7 +134,7 @@ export interface IntlFormatters<T = any, R = T> {
   ): T | string | Array<string | T>;
   formatDisplayName(
     value: Parameters<DisplayNames['of']>[0],
-    opts?: FormatDisplayNameOptions
+    opts: FormatDisplayNameOptions
   ): string | undefined;
 }
 

diff --git a/packages/intl/tests/formatDisplayNames.test.ts b/packages/intl/tests/formatDisplayNames.test.ts
@@ -42,17 +42,20 @@ describe('format API', () => {
     });
 
     it('should return locale display name as string', function () {
-      expect(formatDisplayName('zh-Hans-SG')).toBe(
+      expect(formatDisplayName('zh-Hans-SG', {type: 'language'})).toBe(
         'Simplified Chinese (Singapore)'
       );
     });
 
     it('will return undefined if Intl.DisplayName would return undefined', function () {
       const displayName = new (Intl as any).DisplayNames('en', {
+        type: 'language',
         fallback: 'none',
       });
       expect(displayName.of('xx-XX')).toBeUndefined();
-      expect(formatDisplayName('xx-XX', {fallback: 'none'})).toBeUndefined();
+      expect(
+        formatDisplayName('xx-XX', {type: 'language', fallback: 'none'})
+      ).toBeUndefined();
     });
   });
 });
diff --git a/packages/react-intl/tests/unit/components/__snapshots__/displayName.tsx.snap b/packages/react-intl/tests/unit/components/__snapshots__/displayName.tsx.snap
@@ -12,6 +12,7 @@ exports[`<FormattedDisplayName /> accepts Intl.DisplayNames options 1`] = `
 exports[`<FormattedDisplayName /> renders an empty <> when the underlying DisplayNames would return undefined 1`] = `
 <FormattedDisplayName
   fallback="none"
+  type="language"
   value="xx-XX"
 />
 `;
diff --git a/packages/react-intl/tests/unit/components/displayName.tsx b/packages/react-intl/tests/unit/components/displayName.tsx
@@ -41,13 +41,15 @@ describe('<FormattedDisplayName />', () => {
   it('renders an empty <> when the underlying DisplayNames would return undefined', () => {
     // When fallback is none, it will return undefined if no display name is available.
     const displayNames = new (Intl as any).DisplayNames('en', {
+      type: 'language',
       fallback: 'none',
     });
     expect(displayNames.of('xx-XX')).toBeUndefined();
 
     // Now let's do the same with <FormattedDisplayNames />
     const rendered = mountWithProvider(
       {
+        type: 'language',
         fallback: 'none',
         value: 'xx-XX',
       },