intl-messageformat 8.2.1 → 8.3.2

package/CHANGELOG.md

@@ -3,6 +3,58 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.3.2](https://github.com/formatjs/formatjs/compare/intl-messageformat@8.3.1...intl-messageformat@8.3.2) (2020-03-28)
+
+
+### Bug Fixes
+
+* **intl-messageformat:** add FormatXMLElementFn generic return type ([9b4516c](https://github.com/formatjs/formatjs/commit/9b4516cd1be9fcc1d98fecef31949caa415530c2))
+
+
+
+
+
+## [8.3.1](https://github.com/formatjs/formatjs/compare/intl-messageformat@8.3.0...intl-messageformat@8.3.1) (2020-03-26)
+
+
+### Bug Fixes
+
+* **intl-messageformat:** add missing import to formatters ([be26f59](https://github.com/formatjs/formatjs/commit/be26f591fb373cfca5c0469572bf6a24692bacdc))
+
+
+
+
+
+# [8.3.0](https://github.com/formatjs/formatjs/compare/intl-messageformat@8.2.3...intl-messageformat@8.3.0) (2020-03-26)
+
+
+### Features
+
+* **intl-messageformat:** add more debug info to errors ([58dd475](https://github.com/formatjs/formatjs/commit/58dd475f90d1d11c8085fa554c9229b0f1f65a1d))
+
+
+
+
+
+## [8.2.3](https://github.com/formatjs/formatjs/compare/intl-messageformat@8.2.2...intl-messageformat@8.2.3) (2020-03-21)
+
+
+### Bug Fixes
+
+* **intl-messageformat:** change ErrorCode to string enum ([db8662a](https://github.com/formatjs/formatjs/commit/db8662aaf7571ce035f716611901882a89e193da))
+
+
+
+
+
+## [8.2.2](https://github.com/formatjs/formatjs/compare/intl-messageformat@8.2.1...intl-messageformat@8.2.2) (2020-03-18)
+
+**Note:** Version bump only for package intl-messageformat
+
+
+
+
+
 ## [8.2.1](https://github.com/formatjs/formatjs/compare/intl-messageformat@8.2.0...intl-messageformat@8.2.1) (2020-03-05)
 
 

package/dist/core.d.ts

@@ -12,8 +12,8 @@ export declare class IntlMessageFormat {
     private readonly message;
     private readonly formatterCache;
     constructor(message: string | MessageFormatElement[], locales?: string | string[], overrideFormats?: Partial<Formats>, opts?: Options);
-    format: <T = void>(values?: Record<string, string | number | boolean | Date | T | FormatXMLElementFn<T> | null | undefined> | undefined) => string | T | (string | T)[];
-    formatToParts: <T>(values?: Record<string, string | number | boolean | Date | T | FormatXMLElementFn<T> | null | undefined> | undefined) => MessageFormatPart<T>[];
+    format: <T = void>(values?: Record<string, string | number | boolean | Date | T | FormatXMLElementFn<T, string | (string | T)[]> | null | undefined> | undefined) => string | T | (string | T)[];
+    formatToParts: <T>(values?: Record<string, string | number | boolean | Date | T | FormatXMLElementFn<T, string | (string | T)[]> | null | undefined> | undefined) => MessageFormatPart<T>[];
     resolvedOptions: () => {
         locale: string;
     };

package/dist/error.d.ts

@@ -1,15 +1,26 @@
 export declare const enum ErrorCode {
-    MISSING_VALUE = 0,
-    INVALID_VALUE = 1,
-    MISSING_INTL_API = 2
+    MISSING_VALUE = "MISSING_VALUE",
+    INVALID_VALUE = "INVALID_VALUE",
+    MISSING_INTL_API = "MISSING_INTL_API"
 }
 export declare class FormatError extends Error {
     readonly code: ErrorCode;
-    constructor(msg: string, code: ErrorCode);
+    /**
+     * Original message we're trying to format
+     * `undefined` if we're only dealing w/ AST
+     *
+     * @type {(string | undefined)}
+     * @memberof FormatError
+     */
+    readonly originalMessage: string | undefined;
+    constructor(msg: string, code: ErrorCode, originalMessage?: string);
     toString(): string;
 }
 export declare class InvalidValueError extends FormatError {
-    constructor(variableId: string, value: any, options: string[]);
+    constructor(variableId: string, value: any, options: string[], originalMessage?: string);
+}
+export declare class InvalidValueTypeError extends FormatError {
+    constructor(value: any, type: string, originalMessage?: string);
 }
 export declare class MissingValueError extends FormatError {
     constructor(variableId: string, originalMessage?: string);

package/dist/error.js

@@ -13,11 +13,21 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
+var ErrorCode;
+(function (ErrorCode) {
+    // When we have a placeholder but no value to format
+    ErrorCode["MISSING_VALUE"] = "MISSING_VALUE";
+    // When value supplied is invalid
+    ErrorCode["INVALID_VALUE"] = "INVALID_VALUE";
+    // When we need specific Intl API but it's not available
+    ErrorCode["MISSING_INTL_API"] = "MISSING_INTL_API";
+})(ErrorCode = exports.ErrorCode || (exports.ErrorCode = {}));
 var FormatError = /** @class */ (function (_super) {
     __extends(FormatError, _super);
-    function FormatError(msg, code) {
+    function FormatError(msg, code, originalMessage) {
         var _this = _super.call(this, msg) || this;
         _this.code = code;
+        _this.originalMessage = originalMessage;
         return _this;
     }
     FormatError.prototype.toString = function () {
@@ -28,16 +38,24 @@ var FormatError = /** @class */ (function (_super) {
 exports.FormatError = FormatError;
 var InvalidValueError = /** @class */ (function (_super) {
     __extends(InvalidValueError, _super);
-    function InvalidValueError(variableId, value, options) {
-        return _super.call(this, "Invalid values for \"" + variableId + "\": \"" + value + "\". Options are \"" + Object.keys(options).join('", "') + "\"", 1 /* INVALID_VALUE */) || this;
+    function InvalidValueError(variableId, value, options, originalMessage) {
+        return _super.call(this, "Invalid values for \"" + variableId + "\": \"" + value + "\". Options are \"" + Object.keys(options).join('", "') + "\"", "INVALID_VALUE" /* INVALID_VALUE */, originalMessage) || this;
     }
     return InvalidValueError;
 }(FormatError));
 exports.InvalidValueError = InvalidValueError;
+var InvalidValueTypeError = /** @class */ (function (_super) {
+    __extends(InvalidValueTypeError, _super);
+    function InvalidValueTypeError(value, type, originalMessage) {
+        return _super.call(this, "Value for \"" + value + "\" must be of type " + type, "INVALID_VALUE" /* INVALID_VALUE */, originalMessage) || this;
+    }
+    return InvalidValueTypeError;
+}(FormatError));
+exports.InvalidValueTypeError = InvalidValueTypeError;
 var MissingValueError = /** @class */ (function (_super) {
     __extends(MissingValueError, _super);
     function MissingValueError(variableId, originalMessage) {
-        return _super.call(this, "The intl string context variable \"" + variableId + "\" was not provided to the string \"" + originalMessage + "\"", 0 /* MISSING_VALUE */) || this;
+        return _super.call(this, "The intl string context variable \"" + variableId + "\" was not provided to the string \"" + originalMessage + "\"", "MISSING_VALUE" /* MISSING_VALUE */, originalMessage) || this;
     }
     return MissingValueError;
 }(FormatError));

package/dist/formatters.d.ts

@@ -29,4 +29,4 @@ export interface ObjectPart<T = any> {
 export declare type MessageFormatPart<T> = LiteralPart | ObjectPart<T>;
 export declare type PrimitiveType = string | number | boolean | null | undefined | Date;
 export declare function formatToParts<T>(els: MessageFormatElement[], locales: string | string[], formatters: Formatters, formats: Formats, values?: Record<string, PrimitiveType | T | FormatXMLElementFn<T>>, currentPluralValue?: number, originalMessage?: string): MessageFormatPart<T>[];
-export declare type FormatXMLElementFn<T> = (...args: Array<string | T>) => string | Array<string | T>;
+export declare type FormatXMLElementFn<T, R = string | Array<string | T>> = (...args: Array<string | T>) => R;

package/dist/formatters.js

@@ -2,6 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 var intl_messageformat_parser_1 = require("intl-messageformat-parser");
 var error_1 = require("./error");
+var PART_TYPE;
+(function (PART_TYPE) {
+    PART_TYPE[PART_TYPE["literal"] = 0] = "literal";
+    PART_TYPE[PART_TYPE["object"] = 1] = "object";
+})(PART_TYPE = exports.PART_TYPE || (exports.PART_TYPE = {}));
 function mergeLiteral(parts) {
     if (parts.length < 2) {
         return parts;
@@ -121,7 +126,7 @@ originalMessage) {
             var children = el.children, value_1 = el.value;
             var formatFn = values[value_1];
             if (!isFormatXMLElementFn(formatFn)) {
-                throw new TypeError("Value for \"" + value_1 + "\" must be a function");
+                throw new error_1.InvalidValueTypeError(value_1, 'function', originalMessage);
             }
             var parts = formatToParts(children, locales, formatters, formats, values);
             var chunks = formatFn.apply(void 0, parts.map(function (p) { return p.value; }));
@@ -138,7 +143,7 @@ originalMessage) {
         if (intl_messageformat_parser_1.isSelectElement(el)) {
             var opt = el.options[value] || el.options.other;
             if (!opt) {
-                throw new error_1.InvalidValueError(el.value, value, Object.keys(el.options));
+                throw new error_1.InvalidValueError(el.value, value, Object.keys(el.options), originalMessage);
             }
             result.push.apply(result, formatToParts(opt.value, locales, formatters, formats, values));
             continue;
@@ -147,7 +152,7 @@ originalMessage) {
             var opt = el.options["=" + value];
             if (!opt) {
                 if (!Intl.PluralRules) {
-                    throw new error_1.FormatError("Intl.PluralRules is not available in this environment.\nTry polyfilling it using \"@formatjs/intl-pluralrules\"\n", 2 /* MISSING_INTL_API */);
+                    throw new error_1.FormatError("Intl.PluralRules is not available in this environment.\nTry polyfilling it using \"@formatjs/intl-pluralrules\"\n", "MISSING_INTL_API" /* MISSING_INTL_API */, originalMessage);
                 }
                 var rule = formatters
                     .getPluralRules(locales, { type: el.pluralType })
@@ -155,7 +160,7 @@ originalMessage) {
                 opt = el.options[rule] || el.options.other;
             }
             if (!opt) {
-                throw new error_1.InvalidValueError(el.value, value, Object.keys(el.options));
+                throw new error_1.InvalidValueError(el.value, value, Object.keys(el.options), originalMessage);
             }
             result.push.apply(result, formatToParts(opt.value, locales, formatters, formats, values, value - (el.offset || 0)));
             continue;

package/dist/umd/intl-messageformat.js

@@ -44,6 +44,11 @@
          */
         TYPE[TYPE["tag"] = 8] = "tag";
     })(TYPE || (TYPE = {}));
+    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
      */
@@ -3510,11 +3515,20 @@
             d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
         };
     })();
+    (function (ErrorCode) {
+        // When we have a placeholder but no value to format
+        ErrorCode["MISSING_VALUE"] = "MISSING_VALUE";
+        // When value supplied is invalid
+        ErrorCode["INVALID_VALUE"] = "INVALID_VALUE";
+        // When we need specific Intl API but it's not available
+        ErrorCode["MISSING_INTL_API"] = "MISSING_INTL_API";
+    })(exports.ErrorCode || (exports.ErrorCode = {}));
     var FormatError = /** @class */ (function (_super) {
         __extends$1(FormatError, _super);
-        function FormatError(msg, code) {
+        function FormatError(msg, code, originalMessage) {
             var _this = _super.call(this, msg) || this;
             _this.code = code;
+            _this.originalMessage = originalMessage;
             return _this;
         }
         FormatError.prototype.toString = function () {
@@ -3524,19 +3538,30 @@
     }(Error));
     var InvalidValueError = /** @class */ (function (_super) {
         __extends$1(InvalidValueError, _super);
-        function InvalidValueError(variableId, value, options) {
-            return _super.call(this, "Invalid values for \"" + variableId + "\": \"" + value + "\". Options are \"" + Object.keys(options).join('", "') + "\"", 1 /* INVALID_VALUE */) || this;
+        function InvalidValueError(variableId, value, options, originalMessage) {
+            return _super.call(this, "Invalid values for \"" + variableId + "\": \"" + value + "\". Options are \"" + Object.keys(options).join('", "') + "\"", "INVALID_VALUE" /* INVALID_VALUE */, originalMessage) || this;
         }
         return InvalidValueError;
     }(FormatError));
+    var InvalidValueTypeError = /** @class */ (function (_super) {
+        __extends$1(InvalidValueTypeError, _super);
+        function InvalidValueTypeError(value, type, originalMessage) {
+            return _super.call(this, "Value for \"" + value + "\" must be of type " + type, "INVALID_VALUE" /* INVALID_VALUE */, originalMessage) || this;
+        }
+        return InvalidValueTypeError;
+    }(FormatError));
     var MissingValueError = /** @class */ (function (_super) {
         __extends$1(MissingValueError, _super);
         function MissingValueError(variableId, originalMessage) {
-            return _super.call(this, "The intl string context variable \"" + variableId + "\" was not provided to the string \"" + originalMessage + "\"", 0 /* MISSING_VALUE */) || this;
+            return _super.call(this, "The intl string context variable \"" + variableId + "\" was not provided to the string \"" + originalMessage + "\"", "MISSING_VALUE" /* MISSING_VALUE */, originalMessage) || this;
         }
         return MissingValueError;
     }(FormatError));
 
+    (function (PART_TYPE) {
+        PART_TYPE[PART_TYPE["literal"] = 0] = "literal";
+        PART_TYPE[PART_TYPE["object"] = 1] = "object";
+    })(exports.PART_TYPE || (exports.PART_TYPE = {}));
     function mergeLiteral(parts) {
         if (parts.length < 2) {
             return parts;
@@ -3656,7 +3681,7 @@
                 var children = el.children, value_1 = el.value;
                 var formatFn = values[value_1];
                 if (!isFormatXMLElementFn(formatFn)) {
-                    throw new TypeError("Value for \"" + value_1 + "\" must be a function");
+                    throw new InvalidValueTypeError(value_1, 'function', originalMessage);
                 }
                 var parts = formatToParts(children, locales, formatters, formats, values);
                 var chunks = formatFn.apply(void 0, parts.map(function (p) { return p.value; }));
@@ -3673,7 +3698,7 @@
             if (isSelectElement(el)) {
                 var opt = el.options[value] || el.options.other;
                 if (!opt) {
-                    throw new InvalidValueError(el.value, value, Object.keys(el.options));
+                    throw new InvalidValueError(el.value, value, Object.keys(el.options), originalMessage);
                 }
                 result.push.apply(result, formatToParts(opt.value, locales, formatters, formats, values));
                 continue;
@@ -3682,7 +3707,7 @@
                 var opt = el.options["=" + value];
                 if (!opt) {
                     if (!Intl.PluralRules) {
-                        throw new FormatError("Intl.PluralRules is not available in this environment.\nTry polyfilling it using \"@formatjs/intl-pluralrules\"\n", 2 /* MISSING_INTL_API */);
+                        throw new FormatError("Intl.PluralRules is not available in this environment.\nTry polyfilling it using \"@formatjs/intl-pluralrules\"\n", "MISSING_INTL_API" /* MISSING_INTL_API */, originalMessage);
                     }
                     var rule = formatters
                         .getPluralRules(locales, { type: el.pluralType })
@@ -3690,7 +3715,7 @@
                     opt = el.options[rule] || el.options.other;
                 }
                 if (!opt) {
-                    throw new InvalidValueError(el.value, value, Object.keys(el.options));
+                    throw new InvalidValueError(el.value, value, Object.keys(el.options), originalMessage);
                 }
                 result.push.apply(result, formatToParts(opt.value, locales, formatters, formats, values, value - (el.offset || 0)));
                 continue;
@@ -3881,6 +3906,7 @@
     exports.FormatError = FormatError;
     exports.IntlMessageFormat = IntlMessageFormat;
     exports.InvalidValueError = InvalidValueError;
+    exports.InvalidValueTypeError = InvalidValueTypeError;
     exports.MissingValueError = MissingValueError;
     exports.createDefaultFormatters = createDefaultFormatters;
     exports.default = IntlMessageFormat;