@aemforms/af-formatters 0.22.23 → 0.22.26

package/lib/esm/date/SkeletonParser.js

@@ -1,53 +1,97 @@
 /*************************************************************************
-* ADOBE CONFIDENTIAL
-* ___________________
-*
-* Copyright 2022 Adobe
-* All Rights Reserved.
-*
-* NOTICE: All information contained herein is, and remains
-* the property of Adobe and its suppliers, if any. The intellectual
-* and technical concepts contained herein are proprietary to Adobe
-* and its suppliers and are protected by all applicable intellectual
-* property laws, including trade secret and copyright laws.
-* Dissemination of this information or reproduction of this material
-* is strictly forbidden unless prior written permission is obtained
-* from Adobe.
-
-* Adobe permits you to use and modify this file solely in accordance with
-* the terms of the Adobe license agreement accompanying it.
-*************************************************************************/
-
+ * ADOBE CONFIDENTIAL
+ * ___________________
+ *
+ *  Copyright 2022 Adobe
+ *  All Rights Reserved.
+ *
+ * NOTICE:  All information contained herein is, and remains
+ * the property of Adobe and its suppliers, if any. The intellectual
+ * and technical concepts contained herein are proprietary to Adobe
+ * and its suppliers and are protected by all applicable intellectual
+ * property laws, including trade secret and copyright laws.
+ * Dissemination of this information or reproduction of this material
+ * is strictly forbidden unless prior written permission is obtained
+ * from Adobe.
+ **************************************************************************/
+/**
+ * https://unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table
+ * Credit: https://git.corp.adobe.com/dc/dfl/blob/master/src/patterns/parseDateTimeSkeleton.js
+ * Created a separate library to be used elsewhere as well.
+ */
 const DATE_TIME_REGEX =
+    // eslint-disable-next-line max-len
     /(?:[Eec]{1,6}|G{1,5}|[Qq]{1,5}|(?:[yYur]+|U{1,5})|[ML]{1,5}|d{1,2}|D{1,3}|F{1}|[abB]{1,5}|[hkHK]{1,2}|w{1,2}|W{1}|m{1,2}|s{1,2}|[zZOvV]{1,5}|[zZOvVxX]{1,3}|S{1,3}|'(?:[^']|'')*')|[^a-zA-Z']+/g;
-const ShorthandStyles = ["full", "long", "medium", "short"];
-function getSkeleton(skeleton, language) {
+
+export const ShorthandStyles = ["full", "long", "medium", "short"]
+
+const testDate = new Date(2000, 2, 1, 2, 3, 4);
+
+/**
+ * Since the formatted month names are different than standalone month names, we need to identify the correct option
+ * to pass for formatting
+ * @param value {string} formatted value of the month
+ * @param language {string} language in which the month is formatted
+ * @param isMediumFormatStyle {boolean} if shorthand style used for formatting was medium
+ */
+function deduceMonthOption(value,
+                           language,
+                           isMediumFormatStyle) {
+
+    const formattedMarch = value;
+    const longMarch = new Intl.DateTimeFormat(language, {month: 'long'}).formatToParts(testDate)[0].value;
+    const shortMarch = new Intl.DateTimeFormat(language, {month: 'short'}).formatToParts(testDate)[0].value;
+
+    const monthOptions = {
+        [longMarch]: 'long',
+        [shortMarch]: 'short',
+        '03': '2-digit',
+        '3': 'numeric'
+    }
+    if (formattedMarch !== undefined) {
+        monthOptions[formattedMarch] = isMediumFormatStyle ? 'short' : 'long'
+    }
+    return monthOptions[value];
+}
+
+export function getSkeleton(skeleton, language) {
     if (ShorthandStyles.find(type => skeleton.includes(type))) {
         const parsed = parseDateStyle(skeleton, language);
-        const result = [];
+        const result = []
         const symbols = {
             month : 'M',
             year : 'Y',
             day : 'd'
-        };
+        }
         parsed.forEach(([type, option, length]) => {
             if (type in symbols) {
-                result.push(Array(length).fill(symbols[type]).join(''));
+                result.push(Array(length).fill(symbols[type]).join(''))
             } else if (type === 'literal') {
-                result.push(option);
+                result.push(option)
             }
-        });
+        })
         return result.join('');
     }
     return skeleton;
 }
+
+/**
+ *
+ * @param skeleton shorthand style for the date concatenated with shorthand style of time. The
+ * Shorthand style for both date and time is one of ['full', 'long', 'medium', 'short'].
+ * @param language {string} language to parse the date shorthand style
+ * @returns {[*,string][]}
+ */
 function parseDateStyle(skeleton, language) {
     const options = {};
+    // the skeleton could have two keywords -- one for date, one for time
     const styles = skeleton.split(/\s/).filter(s => s.length);
     options.dateStyle = styles[0];
     if (styles.length > 1) options.timeStyle = styles[1];
+
     const testDate = new Date(2000, 2, 1, 2, 3, 4);
     const parts = new Intl.DateTimeFormat(language, options).formatToParts(testDate);
+    // oddly, the formatted month name can be different from the standalone month name
     const formattedMarch = parts.find(p => p.type === 'month').value;
     const longMarch = new Intl.DateTimeFormat(language, {month: 'long'}).formatToParts(testDate)[0].value;
     const shortMarch = new Intl.DateTimeFormat(language, {month: 'short'}).formatToParts(testDate)[0].value;
@@ -71,7 +115,12 @@ function parseDateStyle(skeleton, language) {
     });
     return result;
 }
-function parseDateTimeSkeleton(skeleton, language) {
+
+/**
+ * Parse Date time skeleton into Intl.DateTimeFormatOptions parts
+ * Ref: https://unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table
+ */
+export function parseDateTimeSkeleton(skeleton, language) {
     if (ShorthandStyles.find(type => skeleton.includes(type))) {
         return parseDateStyle(skeleton, language);
     }
@@ -79,9 +128,11 @@ function parseDateTimeSkeleton(skeleton, language) {
     skeleton.replace(DATE_TIME_REGEX, match => {
         const len = match.length;
         switch (match[0]) {
+            // Era
             case 'G':
                 result.push(['era', len === 4 ? 'long' : len === 5 ? 'narrow' : 'short', len]);
                 break;
+            // Year
             case 'y':
                 result.push(['year', len === 2 ? '2-digit' : 'numeric', len]);
                 break;
@@ -92,13 +143,16 @@ function parseDateTimeSkeleton(skeleton, language) {
                 throw new RangeError(
                     '`Y/u/U/r` (year) patterns are not supported, use `y` instead'
                 );
+            // Quarter
             case 'q':
             case 'Q':
                 throw new RangeError('`q/Q` (quarter) patterns are not supported');
+            // Month
             case 'M':
             case 'L':
                 result.push(['month', ['numeric', '2-digit', 'short', 'long', 'narrow'][len - 1], len]);
                 break;
+            // Week
             case 'w':
             case 'W':
                 throw new RangeError('`w/W` (week) patterns are not supported');
@@ -111,6 +165,7 @@ function parseDateTimeSkeleton(skeleton, language) {
                 throw new RangeError(
                     '`D/F/g` (day) patterns are not supported, use `d` instead'
                 );
+            // Weekday
             case 'E':
                 result.push(['weekday', ['short', 'short', 'short', 'long', 'narrow', 'narrow'][len - 1], len]);
                 break;
@@ -126,14 +181,16 @@ function parseDateTimeSkeleton(skeleton, language) {
                 }
                 result.push(['weekday', ['short', 'long', 'narrow', 'short'][len - 3], len]);
                 break;
-            case 'a':
+            // Period
+            case 'a': // AM, PM
                 result.push(['hour12', true, 1]);
                 break;
-            case 'b':
-            case 'B':
+            case 'b': // am, pm, noon, midnight
+            case 'B': // flexible day periods
                 throw new RangeError(
                     '`b/B` (period) patterns are not supported, use `a` instead'
                 );
+            // Hour
             case 'h':
                 result.push(['hourCycle', 'h12']);
                 result.push(['hour', ['numeric', '2-digit'][len - 1], len]);
@@ -156,9 +213,11 @@ function parseDateTimeSkeleton(skeleton, language) {
                 throw new RangeError(
                     '`j/J/C` (hour) patterns are not supported, use `h/H/K/k` instead'
                 );
+            // Minute
             case 'm':
                 result.push(['minute', ['numeric', '2-digit'][len - 1], len]);
                 break;
+            // Second
             case 's':
                 result.push(['second', ['numeric', '2-digit'][len - 1], len]);
                 break;
@@ -169,19 +228,23 @@ function parseDateTimeSkeleton(skeleton, language) {
                 throw new RangeError(
                     '`S/A` (millisecond) patterns are not supported, use `s` instead'
                 );
-            case 'O':
+            // Zone
+            case 'O': // timeZone GMT-8 or GMT-08:00
                 result.push(['timeZoneName', len < 4 ? 'shortOffset' : 'longOffset', len]);
                 result.push(['x-timeZoneName', len < 4 ? 'O' : 'OOOO', len]);
                 break;
-            case 'X':
-            case 'x':
-            case 'Z':
+            case 'X': // 1, 2, 3, 4: The ISO8601 varios formats
+            case 'x': // 1, 2, 3, 4: The ISO8601 varios formats
+            case 'Z': // 1..3, 4, 5: The ISO8601 varios formats
+                // Z, ZZ, ZZZ should produce -0800
+                // ZZZZ should produce GMT-08:00
+                // ZZZZZ should produce -8:00 or -07:52:58
                 result.push(['timeZoneName', 'longOffset', 1]);
                 result.push(['x-timeZoneName', match, 1]);
                 break;
-            case 'z':
-            case 'v':
-            case 'V':
+            case 'z': // 1..3, 4: specific non-location format
+            case 'v': // 1, 4: generic non-location format
+            case 'V': // 1, 2, 3, 4: time zone ID or city
                 throw new RangeError(
                     'z/v/V` (timeZone) patterns are not supported, use `X/x/Z/O` instead'
                 );
@@ -195,5 +258,3 @@ function parseDateTimeSkeleton(skeleton, language) {
     });
     return result;
 }
-
-export { ShorthandStyles, getSkeleton, parseDateTimeSkeleton };

package/lib/esm/date/index.js

@@ -1,22 +1,20 @@
 /*************************************************************************
-* ADOBE CONFIDENTIAL
-* ___________________
-*
-* Copyright 2022 Adobe
-* All Rights Reserved.
-*
-* NOTICE: All information contained herein is, and remains
-* the property of Adobe and its suppliers, if any. The intellectual
-* and technical concepts contained herein are proprietary to Adobe
-* and its suppliers and are protected by all applicable intellectual
-* property laws, including trade secret and copyright laws.
-* Dissemination of this information or reproduction of this material
-* is strictly forbidden unless prior written permission is obtained
-* from Adobe.
+ * ADOBE CONFIDENTIAL
+ * ___________________
+ *
+ *  Copyright 2022 Adobe
+ *  All Rights Reserved.
+ *
+ * NOTICE:  All information contained herein is, and remains
+ * the property of Adobe and its suppliers, if any. The intellectual
+ * and technical concepts contained herein are proprietary to Adobe
+ * and its suppliers and are protected by all applicable intellectual
+ * property laws, including trade secret and copyright laws.
+ * Dissemination of this information or reproduction of this material
+ * is strictly forbidden unless prior written permission is obtained
+ * from Adobe.
+ **************************************************************************/
 
-* Adobe permits you to use and modify this file solely in accordance with
-* the terms of the Adobe license agreement accompanying it.
-*************************************************************************/
-
-export { formatDate, parseDate } from './DateParser.js';
-export { getSkeleton } from './SkeletonParser.js';
+import { parseDate, formatDate } from './DateParser.js';
+import {getSkeleton} from "./SkeletonParser.js";
+export {parseDate, formatDate, getSkeleton}

package/lib/esm/index.js

@@ -1,39 +1,17 @@
-/*************************************************************************
-* ADOBE CONFIDENTIAL
-* ___________________
-*
-* Copyright 2022 Adobe
-* All Rights Reserved.
-*
-* NOTICE: All information contained herein is, and remains
-* the property of Adobe and its suppliers, if any. The intellectual
-* and technical concepts contained herein are proprietary to Adobe
-* and its suppliers and are protected by all applicable intellectual
-* property laws, including trade secret and copyright laws.
-* Dissemination of this information or reproduction of this material
-* is strictly forbidden unless prior written permission is obtained
-* from Adobe.
-
-* Adobe permits you to use and modify this file solely in accordance with
-* the terms of the Adobe license agreement accompanying it.
-*************************************************************************/
-
-import { formatDate, parseDate } from './date/DateParser.js';
-export { getSkeleton as parseDateSkeleton } from './date/SkeletonParser.js';
-import { formatNumber, parseNumber } from './number/NumberParser.js';
-import './number/SkeletonParser.js';
-import './number/currencies.js';
+import {parseDate, formatDate, getSkeleton as parseDateSkeleton} from "./date/index.js";
+import {parseNumber, formatNumber} from "./number/NumberParser.js"
 
 const getCategory = function (skeleton) {
     const chkCategory = skeleton?.match(/^(?:(num|date)\|)?(.+)/);
     return [chkCategory?.[1], chkCategory?.[2]]
-};
-const format = function (value, locale, skeleton, timezone) {
-    const [category, skelton] = getCategory(skeleton);
+}
+
+export const format = function (value, locale, skeleton, timezone) {
+    const [category, skelton] = getCategory(skeleton)
     switch (category) {
         case 'date':
             if (!(value instanceof Date)) {
-                value = new Date(value);
+                value = new Date(value)
             }
             return formatDate(value, locale, skelton, timezone)
         case 'num':
@@ -41,9 +19,10 @@ const format = function (value, locale, skeleton, timezone) {
         default:
             throw `unable to deduce the format. The skeleton should be date|<format> for date formats and num|<format> for numbers`
     }
-};
-const parse = function (value, locale, skeleton, timezone) {
-    const [category, skelton] = getCategory(skeleton);
+}
+
+export const parse = function (value, locale, skeleton, timezone) {
+    const [category, skelton] = getCategory(skeleton)
     switch (category) {
         case 'date':
             return parseDate(value, locale, skelton, timezone)
@@ -52,6 +31,6 @@ const parse = function (value, locale, skeleton, timezone) {
         default:
             throw `unable to deduce the format. The skeleton should be date|<format> for date formats and num|<format> for numbers`
     }
-};
+}
 
-export { format, formatDate, formatNumber, parse, parseDate, parseNumber };
+export {parseDate, formatDate, parseDateSkeleton, parseNumber, formatNumber}

package/lib/esm/number/NumberParser.js

@@ -1,51 +1,34 @@
-/*************************************************************************
-* ADOBE CONFIDENTIAL
-* ___________________
-*
-* Copyright 2022 Adobe
-* All Rights Reserved.
-*
-* NOTICE: All information contained herein is, and remains
-* the property of Adobe and its suppliers, if any. The intellectual
-* and technical concepts contained herein are proprietary to Adobe
-* and its suppliers and are protected by all applicable intellectual
-* property laws, including trade secret and copyright laws.
-* Dissemination of this information or reproduction of this material
-* is strictly forbidden unless prior written permission is obtained
-* from Adobe.
+import {parseNumberSkeleton} from "./SkeletonParser.js";
 
-* Adobe permits you to use and modify this file solely in accordance with
-* the terms of the Adobe license agreement accompanying it.
-*************************************************************************/
-
-import { parseNumberSkeleton } from './SkeletonParser.js';
-import './currencies.js';
-
-function formatNumber(numberValue, language, skeletn) {
-    if (skeletn.startsWith('num|')) {
-        skeletn = skel.split('|')[1];
-    }
+export function formatNumber(numberValue, language, skeletn) {
     if (!skeletn) return numberValue
-    language = language || "en";
+    language = language || "en"
     const {options, order} = parseNumberSkeleton(skeletn, language);
     return new Intl.NumberFormat(language, options).format(numberValue);
 }
+
 function getMetaInfo(language, skel) {
     const parts = {};
+    // gather digits and radix symbol
     let options = new Intl.NumberFormat(language, {style:'decimal', useGrouping:false}).formatToParts(9876543210.1);
     parts.digits = options.find(p => p.type === 'integer').value.split('').reverse();
     parts.decimal = options.find(p => p.type === 'decimal').value;
+
+    // extract type values from the parts
     const gather = type => {
         const find = options.find(p => p.type === type);
         if (find) parts[type] = find.value;
     };
+    // now gather the localized parts that correspond to the provided skeleton.
     const parsed = parseNumberSkeleton(skel);
     const nf = new Intl.NumberFormat(language, parsed);
     options = nf.formatToParts(-987654321);
     gather('group');
     gather('minusSign');
     gather('percentSign');
+    // it's possible to have multiple currency representations in a single value
     parts.currency = options.filter(p => p.type === 'currency').map(p => p.value);
+    // collect all literals.  Most likely a literal is an accounting bracket
     parts.literal = options.filter(p => p.type === 'literal').map(p => p.value);
     options = nf.formatToParts(987654321);
     gather('plusSign');
@@ -53,11 +36,10 @@ function getMetaInfo(language, skel) {
     gather('unit');
     return parts;
 }
-function parseNumber(numberString, language, skel) {
+
+export function parseNumber(numberString, language, skel) {
     try {
-        if (skel.startsWith('num|')) {
-            skel = skel.split('|')[1];
-        }
+        // factor will be updated to reflect: negative, percent, exponent etc.
         let factor = 1;
         let number = numberString;
         const meta = getMetaInfo(language, skel);
@@ -92,9 +74,8 @@ function parseNumber(numberString, language, skel) {
         return numberString;
     }
 }
-function parseDefaultNumber(numberString, language) {
+
+export function parseDefaultNumber(numberString, language) {
     const currency = currencies[language] || 'USD';
     return parseNumber(numberString, language, `currency/${currency}`);
 }
-
-export { formatNumber, parseDefaultNumber, parseNumber };