@formatjs/ecma402-abstract 1.11.8 → 1.11.9

package/types/number.ts

@@ -0,0 +1,240 @@
+import {LDMLPluralRule} from './plural-rules'
+import {LocaleData} from './core'
+
+export type NumberFormatNotation =
+  | 'standard'
+  | 'scientific'
+  | 'engineering'
+  | 'compact'
+
+export type NumberFormatRoundingType =
+  | 'significantDigits'
+  | 'fractionDigits'
+  | 'compactRounding'
+
+export interface NumberFormatDigitOptions {
+  minimumIntegerDigits?: number
+  minimumSignificantDigits?: number
+  maximumSignificantDigits?: number
+  minimumFractionDigits?: number
+  maximumFractionDigits?: number
+}
+
+export interface NumberFormatDigitInternalSlots {
+  minimumIntegerDigits: number
+  minimumSignificantDigits?: number
+  maximumSignificantDigits?: number
+  roundingType: NumberFormatRoundingType
+  // These two properties are only used when `roundingType` is "fractionDigits".
+  minimumFractionDigits?: number
+  maximumFractionDigits?: number
+  notation?: NumberFormatNotation
+}
+
+// All fields are optional due to de-duping
+export type RawNumberLocaleData = LocaleData<NumberFormatLocaleInternalData>
+
+export interface NumberFormatLocaleInternalData {
+  units: UnitDataTable
+  currencies: Record<string, CurrencyData>
+  numbers: RawNumberData
+  // Bc of relevantExtensionKeys in the spec
+  nu: string[]
+}
+
+export interface UnitDataTable {
+  simple: Record<string, UnitData>
+  compound: Record<string, CompoundUnitData>
+}
+
+export interface UnitData {
+  // A pattern where {0} is number placeholder. Example: "摂氏 {0} 度".
+  long: LDMLPluralRuleMap<string>
+  short: LDMLPluralRuleMap<string>
+  narrow: LDMLPluralRuleMap<string>
+  // perUnitPattern. See http://unicode.org/reports/tr35/tr35-general.html#perUnitPatterns
+  perUnit: Record<'narrow' | 'short' | 'long', string | undefined>
+}
+
+// The values are patterns on how to compose simple units.
+// For example, "{0} per {1}".
+export interface CompoundUnitData {
+  long: string
+  short: string
+  narrow: string
+}
+
+export interface CurrencyData {
+  displayName: LDMLPluralRuleMap<string>
+  symbol: string
+  narrow: string
+}
+
+export type DecimalFormatNum =
+  | '1000'
+  | '10000'
+  | '100000'
+  | '1000000'
+  | '10000000'
+  | '100000000'
+  | '1000000000'
+  | '10000000000'
+  | '100000000000'
+  | '1000000000000'
+  | '10000000000000'
+  | '100000000000000'
+export type NumberingSystem = string
+
+/**
+ * We only care about insertBetween bc we assume
+ * `currencyMatch` & `surroundingMatch` are all the same
+ *
+ * @export
+ * @interface CurrencySpacingData
+ */
+export interface CurrencySpacingData {
+  beforeInsertBetween: string
+  afterInsertBetween: string
+}
+
+export interface RawCurrencyData {
+  currencySpacing: CurrencySpacingData
+  standard: string
+  accounting: string
+  short?: Record<DecimalFormatNum, LDMLPluralRuleMap<string>>
+  // IMPORTANT: We're making the assumption here that currency unitPattern
+  // are the same for all LDMLPluralRule
+  unitPattern: string
+}
+
+export interface SymbolsData {
+  decimal: string
+  group: string
+  list: string
+  percentSign: string
+  plusSign: string
+  minusSign: string
+  exponential: string
+  superscriptingExponent: string
+  perMille: string
+  infinity: string
+  nan: string
+  timeSeparator: string
+}
+
+export interface RawNumberData {
+  nu: string[]
+  // numberingSystem -> pattern
+  symbols: Record<NumberingSystem, SymbolsData>
+  // numberingSystem -> pattern
+  decimal: Record<
+    NumberingSystem,
+    {
+      // The standard number pattern of the decimal.
+      standard: string
+      // These two are compact notation mappings.
+      long: Record<DecimalFormatNum, LDMLPluralRuleMap<string>>
+      short: Record<DecimalFormatNum, LDMLPluralRuleMap<string>>
+    }
+  >
+  percent: Record<NumberingSystem, string>
+  currency: Record<NumberingSystem, RawCurrencyData>
+}
+
+export type LDMLPluralRuleMap<T> = Omit<
+  Partial<Record<LDMLPluralRule, T>>,
+  'other'
+> & {
+  other: T
+}
+
+export interface RawNumberFormatResult {
+  formattedString: string
+  roundedNumber: number
+  integerDigitsCount: number
+}
+
+export type NumberFormatOptionsLocaleMatcher = 'lookup' | 'best fit'
+export type NumberFormatOptionsStyle =
+  | 'decimal'
+  | 'percent'
+  | 'currency'
+  | 'unit'
+export type NumberFormatOptionsCompactDisplay = 'short' | 'long'
+export type NumberFormatOptionsCurrencyDisplay =
+  | 'symbol'
+  | 'code'
+  | 'name'
+  | 'narrowSymbol'
+export type NumberFormatOptionsCurrencySign = 'standard' | 'accounting'
+export type NumberFormatOptionsNotation = NumberFormatNotation
+export type NumberFormatOptionsSignDisplay =
+  | 'auto'
+  | 'always'
+  | 'never'
+  | 'exceptZero'
+export type NumberFormatOptionsUnitDisplay = 'long' | 'short' | 'narrow'
+
+export interface NumberFormatInternal extends NumberFormatDigitInternalSlots {
+  locale: string
+  dataLocale: string
+  style: NumberFormatOptionsStyle
+  currency?: string
+  currencyDisplay: NumberFormatOptionsCurrencyDisplay
+  unit?: string
+  unitDisplay: NumberFormatOptionsUnitDisplay
+  currencySign: NumberFormatOptionsCurrencySign
+  notation: NumberFormatOptionsNotation
+  compactDisplay: NumberFormatOptionsCompactDisplay
+  signDisplay: NumberFormatOptionsSignDisplay
+  useGrouping: boolean
+  pl: Intl.PluralRules
+  boundFormat?: Intl.NumberFormat['format']
+  numberingSystem: string
+  // Locale-dependent formatter data
+  dataLocaleData: NumberFormatLocaleInternalData
+}
+
+export type NumberFormatOptions = Omit<
+  Intl.NumberFormatOptions,
+  'signDisplay'
+> &
+  NumberFormatDigitOptions & {
+    localeMatcher?: NumberFormatOptionsLocaleMatcher
+    style?: NumberFormatOptionsStyle
+    compactDisplay?: NumberFormatOptionsCompactDisplay
+    currencyDisplay?: NumberFormatOptionsCurrencyDisplay
+    currencySign?: NumberFormatOptionsCurrencySign
+    notation?: NumberFormatOptionsNotation
+    signDisplay?: NumberFormatOptionsSignDisplay
+    unit?: string
+    unitDisplay?: NumberFormatOptionsUnitDisplay
+    numberingSystem?: string
+    trailingZeroDisplay?: 'auto' | 'stripIfInteger'
+    roundingPriority?: 'auto' | 'morePrecision' | 'lessPrecision'
+  }
+
+export type ResolvedNumberFormatOptions = Intl.ResolvedNumberFormatOptions &
+  Pick<
+    NumberFormatInternal,
+    | 'currencySign'
+    | 'unit'
+    | 'unitDisplay'
+    | 'notation'
+    | 'compactDisplay'
+    | 'signDisplay'
+  >
+
+export type NumberFormatPartTypes =
+  | Intl.NumberFormatPartTypes
+  | 'exponentSeparator'
+  | 'exponentMinusSign'
+  | 'exponentInteger'
+  | 'compact'
+  | 'unit'
+  | 'literal'
+
+export interface NumberFormatPart {
+  type: NumberFormatPartTypes
+  value: string
+}

package/types/plural-rules.ts

@@ -0,0 +1,18 @@
+import {LocaleData} from './core'
+import {NumberFormatDigitInternalSlots} from './number'
+export type LDMLPluralRule = 'zero' | 'one' | 'two' | 'few' | 'many' | 'other'
+export interface PluralRulesData {
+  categories: {
+    cardinal: string[]
+    ordinal: string[]
+  }
+  fn: (val: number | string, ord?: boolean) => LDMLPluralRule
+}
+
+export type PluralRulesLocaleData = LocaleData<PluralRulesData>
+
+export interface PluralRulesInternal extends NumberFormatDigitInternalSlots {
+  initializedPluralRules: boolean
+  locale: string
+  type: 'cardinal' | 'ordinal'
+}

package/types/relative-time.ts

@@ -0,0 +1,74 @@
+import {LocaleData} from './core'
+import {LDMLPluralRule} from './plural-rules'
+
+export interface FieldData {
+  '0'?: string
+  '1'?: string
+  '-1'?: string
+  '2'?: string
+  '-2'?: string
+  '3'?: string
+  '-3'?: string
+  future: RelativeTimeData
+  past: RelativeTimeData
+}
+
+type RelativeTimeData = {[u in LDMLPluralRule]?: string}
+
+export type UnpackedLocaleFieldsData = {
+  [f in RelativeTimeField]?: FieldData
+} & {nu: Array<string | null>}
+
+export type LocaleFieldsData = {
+  [f in RelativeTimeField]?: FieldData
+} & {nu?: Array<string | null>}
+
+export type RelativeTimeField =
+  | 'second'
+  | 'second-short'
+  | 'second-narrow'
+  | 'minute'
+  | 'minute-short'
+  | 'minute-narrow'
+  | 'hour'
+  | 'hour-short'
+  | 'hour-narrow'
+  | 'day'
+  | 'day-short'
+  | 'day-narrow'
+  | 'week'
+  | 'week-short'
+  | 'week-narrow'
+  | 'month'
+  | 'month-short'
+  | 'month-narrow'
+  | 'quarter'
+  | 'quarter-short'
+  | 'quarter-narrow'
+  | 'year'
+  | 'year-short'
+  | 'year-narrow'
+
+export type RelativeTimeFormatSingularUnit = Exclude<
+  Intl.RelativeTimeFormatUnit,
+  | 'seconds'
+  | 'minutes'
+  | 'hours'
+  | 'days'
+  | 'weeks'
+  | 'months'
+  | 'quarters'
+  | 'years'
+>
+
+export type RelativeTimeLocaleData = LocaleData<LocaleFieldsData>
+export interface RelativeTimeFormatInternal {
+  numberFormat: Intl.NumberFormat
+  pluralRules: Intl.PluralRules
+  locale: string
+  fields: LocaleFieldsData
+  style: Intl.ResolvedRelativeTimeFormatOptions['style']
+  numeric: Intl.ResolvedRelativeTimeFormatOptions['numeric']
+  numberingSystem: string
+  initializedRelativeTimeFormat: boolean
+}

package/utils.ts

@@ -0,0 +1,128 @@
+/**
+ * Cannot do Math.log(x) / Math.log(10) bc if IEEE floating point issue
+ * @param x number
+ */
+export function getMagnitude(x: number): number {
+  // Cannot count string length via Number.toString because it may use scientific notation
+  // for very small or very large numbers.
+  return Math.floor(Math.log(x) * Math.LOG10E)
+}
+
+export function repeat(s: string, times: number): string {
+  if (typeof s.repeat === 'function') {
+    return s.repeat(times)
+  }
+  const arr = new Array(times)
+  for (let i = 0; i < arr.length; i++) {
+    arr[i] = s
+  }
+  return arr.join('')
+}
+
+export function setInternalSlot<
+  Instance extends object,
+  Internal extends object,
+  Field extends keyof Internal
+>(
+  map: WeakMap<Instance, Internal>,
+  pl: Instance,
+  field: Field,
+  value: NonNullable<Internal>[Field]
+) {
+  if (!map.get(pl)) {
+    map.set(pl, Object.create(null))
+  }
+  const slots = map.get(pl)!
+  slots[field] = value
+}
+
+export function setMultiInternalSlots<
+  Instance extends object,
+  Internal extends object,
+  K extends keyof Internal
+>(
+  map: WeakMap<Instance, Internal>,
+  pl: Instance,
+  props: Pick<NonNullable<Internal>, K>
+) {
+  for (const k of Object.keys(props) as K[]) {
+    setInternalSlot(map, pl, k, props[k])
+  }
+}
+
+export function getInternalSlot<
+  Instance extends object,
+  Internal extends object,
+  Field extends keyof Internal
+>(
+  map: WeakMap<Instance, Internal>,
+  pl: Instance,
+  field: Field
+): Internal[Field] {
+  return getMultiInternalSlots(map, pl, field)[field]
+}
+
+export function getMultiInternalSlots<
+  Instance extends object,
+  Internal extends object,
+  Field extends keyof Internal
+>(
+  map: WeakMap<Instance, Internal>,
+  pl: Instance,
+  ...fields: Field[]
+): Pick<Internal, Field> {
+  const slots = map.get(pl)
+  if (!slots) {
+    throw new TypeError(`${pl} InternalSlot has not been initialized`)
+  }
+  return fields.reduce((all, f) => {
+    all[f] = slots[f]
+    return all
+  }, Object.create(null) as Pick<Internal, Field>)
+}
+
+export interface LiteralPart {
+  type: 'literal'
+  value: string
+}
+
+export function isLiteralPart(
+  patternPart: LiteralPart | {type: string; value?: string}
+): patternPart is LiteralPart {
+  return patternPart.type === 'literal'
+}
+
+/*
+  17 ECMAScript Standard Built-in Objects:
+    Every built-in Function object, including constructors, that is not
+    identified as an anonymous function has a name property whose value
+    is a String.
+
+    Unless otherwise specified, the name property of a built-in Function
+    object, if it exists, has the attributes { [[Writable]]: false,
+    [[Enumerable]]: false, [[Configurable]]: true }.
+*/
+export function defineProperty<T extends object>(
+  target: T,
+  name: string | symbol,
+  {value}: {value: any} & ThisType<any>
+) {
+  Object.defineProperty(target, name, {
+    configurable: true,
+    enumerable: false,
+    writable: true,
+    value,
+  })
+}
+
+export const UNICODE_EXTENSION_SEQUENCE_REGEX = /-u(?:-[0-9a-z]{2,8})+/gi
+
+export function invariant(
+  condition: boolean,
+  message: string,
+  Err: any = Error
+): asserts condition {
+  if (!condition) {
+    throw new Err(message)
+  }
+}

package/262.d.ts

@@ -1,92 +0,0 @@
-/**
- * https://tc39.es/ecma262/#sec-tostring
- */
-export declare function ToString(o: unknown): string;
-/**
- * https://tc39.es/ecma262/#sec-tonumber
- * @param val
- */
-export declare function ToNumber(val: any): number;
-/**
- * https://tc39.es/ecma262/#sec-timeclip
- * @param time
- */
-export declare function TimeClip(time: number): number;
-/**
- * https://tc39.es/ecma262/#sec-toobject
- * @param arg
- */
-export declare function ToObject<T>(arg: T): T extends null ? never : T extends undefined ? never : T;
-/**
- * https://www.ecma-international.org/ecma-262/11.0/index.html#sec-samevalue
- * @param x
- * @param y
- */
-export declare function SameValue(x: any, y: any): boolean;
-/**
- * https://www.ecma-international.org/ecma-262/11.0/index.html#sec-arraycreate
- * @param len
- */
-export declare function ArrayCreate(len: number): any[];
-/**
- * https://www.ecma-international.org/ecma-262/11.0/index.html#sec-hasownproperty
- * @param o
- * @param prop
- */
-export declare function HasOwnProperty(o: object, prop: string): boolean;
-/**
- * https://www.ecma-international.org/ecma-262/11.0/index.html#sec-type
- * @param x
- */
-export declare function Type(x: any): "Null" | "Undefined" | "Object" | "Number" | "Boolean" | "String" | "Symbol" | "BigInt" | undefined;
-/**
- * https://tc39.es/ecma262/#eqn-Day
- * @param t
- */
-export declare function Day(t: number): number;
-/**
- * https://tc39.es/ecma262/#sec-week-day
- * @param t
- */
-export declare function WeekDay(t: number): number;
-/**
- * https://tc39.es/ecma262/#sec-year-number
- * @param y
- */
-export declare function DayFromYear(y: number): number;
-/**
- * https://tc39.es/ecma262/#sec-year-number
- * @param y
- */
-export declare function TimeFromYear(y: number): number;
-/**
- * https://tc39.es/ecma262/#sec-year-number
- * @param t
- */
-export declare function YearFromTime(t: number): number;
-export declare function DaysInYear(y: number): 365 | 366;
-export declare function DayWithinYear(t: number): number;
-export declare function InLeapYear(t: number): 0 | 1;
-/**
- * https://tc39.es/ecma262/#sec-month-number
- * @param t
- */
-export declare function MonthFromTime(t: number): 0 | 1 | 2 | 3 | 4 | 7 | 5 | 6 | 8 | 9 | 10 | 11;
-export declare function DateFromTime(t: number): number;
-export declare function HourFromTime(t: number): number;
-export declare function MinFromTime(t: number): number;
-export declare function SecFromTime(t: number): number;
-/**
- * The abstract operation OrdinaryHasInstance implements
- * the default algorithm for determining if an object O
- * inherits from the instance object inheritance path
- * provided by constructor C.
- * @param C class
- * @param O object
- * @param internalSlots internalSlots
- */
-export declare function OrdinaryHasInstance(C: Object, O: any, internalSlots?: {
-    boundTargetFunction: any;
-}): boolean;
-export declare function msFromTime(t: number): number;
-//# sourceMappingURL=262.d.ts.map

package/262.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"262.d.ts","sourceRoot":"","sources":["../../../../../packages/ecma402-abstract/262.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,OAAO,GAAG,MAAM,CAM3C;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,CAiBzC;AAwBD;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,UAQpC;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EACxB,GAAG,EAAE,CAAC,GACL,CAAC,SAAS,IAAI,GAAG,KAAK,GAAG,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,CAAC,CAK1D;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,WAYvC;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,SAEtC;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,WAErD;AAED;;;GAGG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,GAAG,uGAyB1B;AAcD;;;GAGG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,MAAM,UAE5B;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,UAEhC;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,UAEpC;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,UAErC;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,UAErC;AAED,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,aAWnC;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,UAEtC;AAED,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,GAAG,CAAC,CAE3C;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,mDAwCtC;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,UAyCrC;AASD,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,UAErC;AAED,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,UAEpC;AAED,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,UAEpC;AAMD;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CACjC,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,GAAG,EACN,aAAa,CAAC,EAAE;IAAC,mBAAmB,EAAE,GAAG,CAAA;CAAC,WAmB3C;AAED,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAE5C"}