Merge pull request #15 from telerik/local-format-datefields

feat: localized field name based on format specifier

Author: ggkrustev

docs/cldr/api.md

@@ -86,6 +86,55 @@ The names.
 
 If the type is `"dayPeriods"` or `"eras"`, an object is returned. For the other types, the result is `Array`.
 
+### dateFieldName
+
+Returns a localized date field name based on a specific format specifier.
+
+#### dateFieldName Parameters
+
+##### options `Object`
+
+The options that determine the returned date field name.
+
+##### options.type `String`
+
+The type of the date field name.
+
+The supported values are:
+* `"era"`
+* `"year"`
+* `"quarter"`
+* `"month"`
+* `"week"`
+* `"day"`
+* `"weekday"`
+* `"dayperiod"`
+* `"hour"`
+* `"minute"`
+* `"second"`
+* `"zone"`
+
+##### options.nameType `String`
+
+The format name type.
+
+The supported values are:
+* `"wide"`
+* `"narrow"`
+* `"short"`
+
+##### locale `String`
+
+The locale id.
+
+#### dateFieldName Return Value
+
+##### Returns `String`
+
+The date field name.
+
+If an information for the specified date field type is missing, a `undefined` is returned.
+
 ### numberSymbols
 
 Returns the number symbols from the specified locale.

docs/cldr/index.md

@@ -25,6 +25,7 @@ The following table provides the data formats that are required for number and d
 | Currency                     | `cldr/main/locale/currencies.json` and `cldr/supplemental/currencyData.json` |
 | Basic dates                  | `cldr/main/locale/ca-gregorian.json`   |
 | Localized timezone           | `cldr/main/locale/timeZoneNames.json`  |
+| Localized date field names   | `cldr/main/locale/dateFields.json`     |
 | Numeric week day formatting  | `cldr/supplemental/weekData.json`      |
 
 ## Getting CLDR Data
@@ -43,6 +44,7 @@ const numbers = require("cldr-data/main/bg/numbers.json");
 const timeZoneNames = require("cldr-data/main/bg/timeZoneNames.json");
 const calendar = require("cldr-data/main/bg/ca-gregorian.json");
 const currencies = require("cldr-data/main/bg/currencies.json");
+const currencies = require("cldr-data/main/bg/dateFields.json");
 const weekData = require("cldr-data/supplemental/weekData.json");
 const currencyData = require("cldr-data/supplemental/currencyData.json");
 
@@ -53,6 +55,7 @@ load(
     numbers,
     currencies,
     calendar,
+    dateFields,
     timeZoneNames
 );
 

src/cldr.d.ts

@@ -32,6 +32,50 @@ export interface DateFormatNameOptions {
  */
 export function dateFormatNames(locale: string, options: DateFormatNameOptions): any;
 
+/**
+ * Settings for the dateFieldName function.
+ */
+export interface DateFieldNameOptions {
+    /**
+     * Specifies the type of names.
+     */
+    type: 'era'         |
+          'year'        |
+          'quarter'     |
+          'month'       |
+          'week'        |
+          'day'         |
+          'weekday'     |
+          'dayperiod'   |
+          'hour'        |
+          'minute'      |
+          'second'      |
+          'millisecond' |
+          'zone';
+
+    /**
+     * Specifies the names form.
+     */
+    nameType?: 'wide' | 'narrow' | 'short';
+}
+
+/**
+ * Returns a localized date field name based on a specific format specifier.
+ *
+ * @param options The dateFieldName options.
+ * @param locale The optional locale id. If not specified, the `"en"` locale id is used.
+ * @returns The localized date field name determined by the dateFieldName options.
+ *
+ * @example
+ * ```
+ * dateFieldName({ type: 'day' });                      //returns 'day';
+ * dateFieldName({ type: 'day', nameType: 'wide' });    //returns 'day';
+ * dateFieldName({ type: 'month', nameType: 'short' }); //returns 'mo.';
+ * dateFieldName({ type: 'month', nameType: 'wide' });  //returns 'month';
+ * ```
+ */
+export function dateFieldName(options: DateFieldNameOptions, locale?: string): string;
+
 /**
  * Returns the first day index starting from Sunday based on the specified locale.
  *

src/cldr.js

@@ -1,6 +1,7 @@
 export { default as load } from './cldr/load';
+export { default as dateFieldName } from './cldr/date-field-name';
 export { default as dateFormatNames } from './cldr/date-format-names';
 export { cldr, localeInfo } from './cldr/info';
 export { currencyDisplays, currencyDisplay, currencyFractionOptions, territoryCurrencyCode, localeCurrency } from './cldr/currency';
 export { default as firstDay } from './cldr/first-day';
-export { default as numberSymbols } from './cldr/number-symbols';
+export { default as numberSymbols } from './cldr/number-symbols';

src/cldr/date-field-name.js

@@ -0,0 +1,9 @@
+import { localeInfo } from './info';
+
+export default function(options, locale = "en") {
+    const info = localeInfo(locale);
+    const dateFields = info.calendar.dateFields || {};
+    const fieldNameInfo = dateFields[options.type] || {};
+
+    return fieldNameInfo[options.nameType] || fieldNameInfo['wide'];
+}

src/cldr/default-data.js

@@ -576,6 +576,60 @@ const defaultData = {
                         "1-alt-variant": "CE"
                     }
                 }
+            },
+            "dateFields": {
+                "era": {
+                    "wide": "era"
+                },
+                "year": {
+                    "wide": 'year',
+                    "short": 'yr.',
+                    "narrow": 'yr.'
+                },
+                "quarter": {
+                    "wide": 'quarter',
+                    "short": 'qtr.',
+                    "narrow": 'qtr.'
+                },
+                "month": {
+                    "wide": 'month',
+                    "short": 'mo.',
+                    "narrow": 'mo.'
+                },
+                "week": {
+                    "wide": 'week',
+                    "short": 'wk.',
+                    "narrow": 'wk.'
+                },
+                "day": {
+                    "wide": 'day',
+                    "short": 'day',
+                    "narrow": 'day'
+                },
+                "weekday": {
+                    "wide": 'day of the week'
+                },
+                "dayperiod": {
+                    "wide": 'AM/PM'
+                },
+                "hour": {
+                    "wide": 'hour',
+                    "short": 'hr.',
+                    "narrow": 'hr.'
+                },
+                "minute": {
+                    "wide": 'minute',
+                    "short": 'min.',
+                    "narrow": 'min.'
+                },
+                "second": {
+                    "wide": 'second',
+                    "short": 'sec.',
+                    "narrow": 'sec.'
+                },
+                "zone": {
+                    "wide": 'time zone'
+                }
             }
         }
     },
@@ -601,4 +655,4 @@ const defaultData = {
         }
     }
 };
-export default defaultData;
+export default defaultData;

src/cldr/load-dates.js

@@ -67,6 +67,24 @@ function loadCalendarNames(locale, calendar) {
     localeCalendar.eras = getEraNames(calendar.eras);
 }
 
+function loadCalendarDateFields(locale, fields) {
+    const localeCalendar = cldr[locale].calendar;
+    const dateFields = {};
+
+    for (let field in fields) {
+        const [ fieldName, formatType = 'wide' ] = field.split('-');
+        const fieldInfo = dateFields[fieldName] || {};
+        const displayName = fields[field].displayName;
+
+        if (!displayName) { continue; }
+
+        fieldInfo[formatType] = displayName;
+        dateFields[fieldName] = fieldInfo;
+    }
+
+    localeCalendar.dateFields = dateFields;
+}
+
 function getPredefinedFormat(paths, calendar) {
     const result = [];
 
@@ -108,6 +126,8 @@ export default function loadCalendarInfo(locale, info) {
         } else if (field === "calendars" && info[field].gregorian) {
             loadCalendarPatterns(locale, info[field].gregorian);
             loadCalendarNames(locale, info[field].gregorian);
+        } else if (field === "fields") {
+            loadCalendarDateFields(locale, info.fields);
         }
     }
-}
+}

src/dates.js

@@ -1,3 +1,3 @@
 export { default as formatDate } from './dates/format-date';
 export { default as parseDate } from './dates/parse-date';
-export { default as splitDateFormat } from './dates/split-date-format';
+export { default as splitDateFormat } from './dates/split-date-format';

src/dates/format-date.js

@@ -194,4 +194,4 @@ export default function formatDate(date, format, locale = "en") {
 
         return result;
     });
-}
+}