@formatjs/icu-messageformat-parser 2.11.3 → 3.0.0

package/lib/types.d.ts

@@ -1,120 +0,0 @@
-import type { NumberFormatOptions } from '@formatjs/ecma402-abstract';
-import { NumberSkeletonToken } from '@formatjs/icu-skeleton-parser';
-export interface ExtendedNumberFormatOptions extends NumberFormatOptions {
-    scale?: number;
-}
-export declare enum TYPE {
-    /**
-     * Raw text
-     */
-    literal = 0,
-    /**
-     * Variable w/o any format, e.g `var` in `this is a {var}`
-     */
-    argument = 1,
-    /**
-     * Variable w/ number format
-     */
-    number = 2,
-    /**
-     * Variable w/ date format
-     */
-    date = 3,
-    /**
-     * Variable w/ time format
-     */
-    time = 4,
-    /**
-     * Variable w/ select format
-     */
-    select = 5,
-    /**
-     * Variable w/ plural format
-     */
-    plural = 6,
-    /**
-     * Only possible within plural argument.
-     * This is the `#` symbol that will be substituted with the count.
-     */
-    pound = 7,
-    /**
-     * XML-like tag
-     */
-    tag = 8
-}
-export declare enum SKELETON_TYPE {
-    number = 0,
-    dateTime = 1
-}
-export interface LocationDetails {
-    offset: number;
-    line: number;
-    column: number;
-}
-export interface Location {
-    start: LocationDetails;
-    end: LocationDetails;
-}
-export interface BaseElement<T extends TYPE> {
-    type: T;
-    value: string;
-    location?: Location;
-}
-export type LiteralElement = BaseElement<TYPE.literal>;
-export type ArgumentElement = BaseElement<TYPE.argument>;
-export interface TagElement extends BaseElement<TYPE.tag> {
-    children: MessageFormatElement[];
-}
-export interface SimpleFormatElement<T extends TYPE, S extends Skeleton> extends BaseElement<T> {
-    style?: string | S | null;
-}
-export type NumberElement = SimpleFormatElement<TYPE.number, NumberSkeleton>;
-export type DateElement = SimpleFormatElement<TYPE.date, DateTimeSkeleton>;
-export type TimeElement = SimpleFormatElement<TYPE.time, DateTimeSkeleton>;
-export type ValidPluralRule = 'zero' | 'one' | 'two' | 'few' | 'many' | 'other' | string;
-export interface PluralOrSelectOption {
-    value: MessageFormatElement[];
-    location?: Location;
-}
-export interface SelectElement extends BaseElement<TYPE.select> {
-    options: Record<string, PluralOrSelectOption>;
-}
-export interface PluralElement extends BaseElement<TYPE.plural> {
-    options: Record<ValidPluralRule, PluralOrSelectOption>;
-    offset: number;
-    pluralType: Intl.PluralRulesOptions['type'];
-}
-export interface PoundElement {
-    type: TYPE.pound;
-    location?: Location;
-}
-export type MessageFormatElement = ArgumentElement | DateElement | LiteralElement | NumberElement | PluralElement | PoundElement | SelectElement | TagElement | TimeElement;
-export interface NumberSkeleton {
-    type: SKELETON_TYPE.number;
-    tokens: NumberSkeletonToken[];
-    location?: Location;
-    parsedOptions: ExtendedNumberFormatOptions;
-}
-export interface DateTimeSkeleton {
-    type: SKELETON_TYPE.dateTime;
-    pattern: string;
-    location?: Location;
-    parsedOptions: Intl.DateTimeFormatOptions;
-}
-export type Skeleton = NumberSkeleton | DateTimeSkeleton;
-/**
- * Type Guards
- */
-export declare function isLiteralElement(el: MessageFormatElement): el is LiteralElement;
-export declare function isArgumentElement(el: MessageFormatElement): el is ArgumentElement;
-export declare function isNumberElement(el: MessageFormatElement): el is NumberElement;
-export declare function isDateElement(el: MessageFormatElement): el is DateElement;
-export declare function isTimeElement(el: MessageFormatElement): el is TimeElement;
-export declare function isSelectElement(el: MessageFormatElement): el is SelectElement;
-export declare function isPluralElement(el: MessageFormatElement): el is PluralElement;
-export declare function isPoundElement(el: MessageFormatElement): el is PoundElement;
-export declare function isTagElement(el: MessageFormatElement): el is TagElement;
-export declare function isNumberSkeleton(el: NumberElement['style'] | Skeleton): el is NumberSkeleton;
-export declare function isDateTimeSkeleton(el?: DateElement['style'] | TimeElement['style'] | Skeleton): el is DateTimeSkeleton;
-export declare function createLiteralElement(value: string): LiteralElement;
-export declare function createNumberElement(value: string, style?: string | null): NumberElement;

package/lib/types.js

@@ -1,94 +0,0 @@
-export var TYPE;
-(function (TYPE) {
-    /**
-     * Raw text
-     */
-    TYPE[TYPE["literal"] = 0] = "literal";
-    /**
-     * Variable w/o any format, e.g `var` in `this is a {var}`
-     */
-    TYPE[TYPE["argument"] = 1] = "argument";
-    /**
-     * Variable w/ number format
-     */
-    TYPE[TYPE["number"] = 2] = "number";
-    /**
-     * Variable w/ date format
-     */
-    TYPE[TYPE["date"] = 3] = "date";
-    /**
-     * Variable w/ time format
-     */
-    TYPE[TYPE["time"] = 4] = "time";
-    /**
-     * Variable w/ select format
-     */
-    TYPE[TYPE["select"] = 5] = "select";
-    /**
-     * Variable w/ plural format
-     */
-    TYPE[TYPE["plural"] = 6] = "plural";
-    /**
-     * Only possible within plural argument.
-     * This is the `#` symbol that will be substituted with the count.
-     */
-    TYPE[TYPE["pound"] = 7] = "pound";
-    /**
-     * XML-like tag
-     */
-    TYPE[TYPE["tag"] = 8] = "tag";
-})(TYPE || (TYPE = {}));
-export var SKELETON_TYPE;
-(function (SKELETON_TYPE) {
-    SKELETON_TYPE[SKELETON_TYPE["number"] = 0] = "number";
-    SKELETON_TYPE[SKELETON_TYPE["dateTime"] = 1] = "dateTime";
-})(SKELETON_TYPE || (SKELETON_TYPE = {}));
-/**
- * Type Guards
- */
-export function isLiteralElement(el) {
-    return el.type === TYPE.literal;
-}
-export function isArgumentElement(el) {
-    return el.type === TYPE.argument;
-}
-export function isNumberElement(el) {
-    return el.type === TYPE.number;
-}
-export function isDateElement(el) {
-    return el.type === TYPE.date;
-}
-export function isTimeElement(el) {
-    return el.type === TYPE.time;
-}
-export function isSelectElement(el) {
-    return el.type === TYPE.select;
-}
-export function isPluralElement(el) {
-    return el.type === TYPE.plural;
-}
-export function isPoundElement(el) {
-    return el.type === TYPE.pound;
-}
-export function isTagElement(el) {
-    return el.type === TYPE.tag;
-}
-export function isNumberSkeleton(el) {
-    return !!(el && typeof el === 'object' && el.type === SKELETON_TYPE.number);
-}
-export function isDateTimeSkeleton(el) {
-    return !!(el && typeof el === 'object' && el.type === SKELETON_TYPE.dateTime);
-}
-export function createLiteralElement(value) {
-    return {
-        type: TYPE.literal,
-        value: value,
-    };
-}
-export function createNumberElement(value, style) {
-    return {
-        type: TYPE.number,
-        value: value,
-        style: style,
-    };
-}