feat(mf2)!: Drop the notation, compactDisplay, & numberingSystem options (unicode-org/message-format-wg#1015)

Author: XM5jDcsHTyGJtQqlCi

mf2/messageformat/src/functions/currency.ts

@@ -1,6 +1,11 @@
 import { MessageError, MessageResolutionError } from '../errors.js';
 import type { MessageFunctionContext } from './index.js';
-import { type MessageNumber, number, readNumericOperand } from './number.js';
+import {
+  type MessageNumber,
+  type MessageNumberOptions,
+  getMessageNumber,
+  readNumericOperand
+} from './number.js';
 import { asPositiveInteger, asString } from './utils.js';
 
 /**
@@ -17,22 +22,15 @@ export function currency(
   const { source } = ctx;
   const input = readNumericOperand(operand, source);
   const value = input.value;
-  const options: Intl.NumberFormatOptions &
-    Intl.PluralRulesOptions & { select?: 'exact' | 'cardinal' } = Object.assign(
-    {},
-    input.options
-  );
+  const options: MessageNumberOptions = Object.assign({}, input.options);
 
   options.style = 'currency';
   for (const [name, optval] of Object.entries(exprOpt)) {
     if (optval === undefined) continue;
     try {
       switch (name) {
-        case 'compactDisplay':
         case 'currency':
         case 'currencySign':
-        case 'notation':
-        case 'numberingSystem':
         case 'roundingMode':
         case 'roundingPriority':
         case 'trailingZeroDisplay':
@@ -109,5 +107,5 @@ export function currency(
     throw new MessageResolutionError('bad-operand', msg, source);
   }
 
-  return number(ctx, {}, { valueOf: () => value, options });
+  return getMessageNumber(ctx, value, options);
 }

mf2/messageformat/src/functions/datetime.ts

@@ -111,7 +111,6 @@ export const date = (
             res[name] = asBoolean(value);
             break;
           case 'calendar':
-          case 'numberingSystem':
           case 'timeZone':
             res[name] = asString(value);
         }
@@ -149,7 +148,6 @@ export const time = (
             res[name] = asBoolean(value);
             break;
           case 'calendar':
-          case 'numberingSystem':
           case 'timeZone':
             res[name] = asString(value);
         }

mf2/messageformat/src/functions/number.ts

@@ -37,6 +37,9 @@ export interface MessageNumberPart extends MessageExpressionPart {
   parts: Intl.NumberFormatPart[];
 }
 
+export type MessageNumberOptions = Intl.NumberFormatOptions &
+  Intl.PluralRulesOptions & { select?: 'exact' | 'cardinal' | 'ordinal' };
+
 const INT = Symbol('INT');
 
 export function readNumericOperand(
@@ -65,6 +68,57 @@ export function readNumericOperand(
   return { value, options };
 }
 
+export function getMessageNumber(
+  { dir, locales, source }: MessageFunctionContext,
+  value: number | bigint,
+  options: MessageNumberOptions
+): MessageNumber {
+  let locale: string | undefined;
+  let nf: Intl.NumberFormat | undefined;
+  let cat: Intl.LDMLPluralRule | undefined;
+  let str: string | undefined;
+  return {
+    type: 'number',
+    source,
+    get dir() {
+      if (dir == null) {
+        locale ??= Intl.NumberFormat.supportedLocalesOf(locales, options)[0];
+        dir = getLocaleDir(locale);
+      }
+      return dir;
+    },
+    get options() {
+      return { ...options };
+    },
+    selectKey(keys) {
+      const str = String(value);
+      if (keys.has(str)) return str;
+      if (options.select === 'exact') return null;
+      const pluralOpt = options.select
+        ? { ...options, select: undefined, type: options.select }
+        : options;
+      // Intl.PluralRules needs a number, not bigint
+      cat ??= new Intl.PluralRules(locales, pluralOpt).select(Number(value));
+      return keys.has(cat) ? cat : null;
+    },
+    toParts() {
+      nf ??= new Intl.NumberFormat(locales, options);
+      const parts = nf.formatToParts(value);
+      locale ??= nf.resolvedOptions().locale;
+      dir ??= getLocaleDir(locale);
+      return dir === 'ltr' || dir === 'rtl'
+        ? [{ type: 'number', source, dir, locale, parts }]
+        : [{ type: 'number', source, locale, parts }];
+    },
+    toString() {
+      nf ??= new Intl.NumberFormat(locales, options);
+      str ??= nf.format(value);
+      return str;
+    },
+    valueOf: () => value
+  };
+}
+
 /**
  * `number` accepts a number, BigInt or string representing a JSON number as input
  * and formats it with the same options as
@@ -79,23 +133,17 @@ export function number(
   exprOpt: Record<string | symbol, unknown>,
   operand?: unknown
 ): MessageNumber {
-  const { locales, source } = ctx;
-  const options: Intl.NumberFormatOptions &
-    Intl.PluralRulesOptions & { select?: 'exact' | 'cardinal' | 'ordinal' } = {
-    localeMatcher: ctx.localeMatcher
-  };
-  const input = readNumericOperand(operand, source);
+  const input = readNumericOperand(operand, ctx.source);
   const value = input.value;
-  Object.assign(options, input.options);
+  const options: MessageNumberOptions = Object.assign(
+    { localeMatcher: ctx.localeMatcher },
+    input.options
+  );
 
   for (const [name, optval] of Object.entries(exprOpt)) {
     if (optval === undefined) continue;
     try {
       switch (name) {
-        case 'locale':
-        case 'style': // https://github.com/unicode-org/message-format-wg/pull/988
-        case 'type': // used internally by Intl.PluralRules, but called 'select' here
-          break;
         case 'minimumIntegerDigits':
         case 'minimumFractionDigits':
         case 'maximumFractionDigits':
@@ -111,13 +159,17 @@ export function number(
           options[name] = strval === 'never' ? false : strval;
           break;
         }
-        default:
-          // @ts-expect-error Unknown options will be ignored
+        case 'roundingMode':
+        case 'roundingPriority':
+        case 'select': // Called 'type' in Intl.PluralRules
+        case 'signDisplay':
+        case 'trailingZeroDisplay':
+          // @ts-expect-error Let Intl.NumberFormat construction fail
           options[name] = asString(optval);
       }
     } catch {
       const msg = `Value ${optval} is not valid for :number option ${name}`;
-      ctx.onError(new MessageResolutionError('bad-option', msg, source));
+      ctx.onError(new MessageResolutionError('bad-option', msg, ctx.source));
     }
   }
 
@@ -126,51 +178,7 @@ export function number(
       ? Math.round(value as number)
       : value;
 
-  let locale: string | undefined;
-  let dir = ctx.dir;
-  let nf: Intl.NumberFormat | undefined;
-  let cat: Intl.LDMLPluralRule | undefined;
-  let str: string | undefined;
-  return {
-    type: 'number',
-    source,
-    get dir() {
-      if (dir == null) {
-        locale ??= Intl.NumberFormat.supportedLocalesOf(locales, options)[0];
-        dir = getLocaleDir(locale);
-      }
-      return dir;
-    },
-    get options() {
-      return { ...options };
-    },
-    selectKey(keys) {
-      const str = String(num);
-      if (keys.has(str)) return str;
-      if (options.select === 'exact') return null;
-      const pluralOpt = options.select
-        ? { ...options, select: undefined, type: options.select }
-        : options;
-      // Intl.PluralRules needs a number, not bigint
-      cat ??= new Intl.PluralRules(locales, pluralOpt).select(Number(num));
-      return keys.has(cat) ? cat : null;
-    },
-    toParts() {
-      nf ??= new Intl.NumberFormat(locales, options);
-      const parts = nf.formatToParts(num);
-      locale ??= nf.resolvedOptions().locale;
-      dir ??= getLocaleDir(locale);
-      return dir === 'ltr' || dir === 'rtl'
-        ? [{ type: 'number', source, dir, locale, parts }]
-        : [{ type: 'number', source, locale, parts }];
-    },
-    toString() {
-      nf ??= new Intl.NumberFormat(locales, options);
-      str ??= nf.format(num);
-      return str;
-    },
-    valueOf: () => num
-  };
+  return getMessageNumber(ctx, num, options);
 }
 
 /**