feat: expose weekend range info

Author: danielkaradachki

gulpfile.js

@@ -9,6 +9,7 @@ const currencyData = require("cldr-data/supplemental/currencyData.json");
 const weekData = require("cldr-data/supplemental/weekData.json");
 const fs = require('fs');
 const { toJSObject, buildLocales } = require("./build-locales.js");
+const DEFAULT_TERRITORY = '001';
 
 require('@progress/kendo-package-tasks')(gulp, 'kendo-intl');
 
@@ -48,6 +49,12 @@ gulp.task("build-default-data", ["build-npm-package"], () => {
             weekData: {
                 firstDay: {
                     US: cldr.cldr.supplemental.weekData.firstDay.US
+                },
+                weekendStart: {
+                    [DEFAULT_TERRITORY]: cldr.cldr.supplemental.weekData.weekendStart[DEFAULT_TERRITORY]
+                },
+                weekendEnd: {
+                    [DEFAULT_TERRITORY]: cldr.cldr.supplemental.weekData.weekendEnd[DEFAULT_TERRITORY]
                 }
             }
         }

src/cldr.d.ts

@@ -103,6 +103,22 @@ export function dateFieldName(options: DateFieldNameOptions, locale?: string): s
  */
 export function firstDay(locale: string): number;
 
+/**
+ * The weekend start and end days
+ */
+export interface WeekendRange {
+    start: number;
+    end: number;
+}
+
+/**
+ * Returns and object.
+ *
+ * @param locale - The locale `id`.
+ * @returns - The weekend range.
+ */
+export function weekendRange(locale: string): WeekendRange;
+
 /**
  * Loads CLDR data.
  *

src/cldr.js

@@ -5,5 +5,6 @@ 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 weekendRange } from './cldr/weekend-range';
 export { default as numberSymbols } from './cldr/number-symbols';
 

src/cldr/constants.js

@@ -0,0 +1,4 @@
+
+export const DAYS_OF_WEEK = [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ];
+
+export const DEFAULT_TERRITORY = '001';

src/cldr/first-day.js

@@ -1,13 +1,11 @@
 import { cldr, getLocaleInfo } from './info';
 import localeTerritory from './territory';
 
+import { DAYS_OF_WEEK, DEFAULT_TERRITORY } from './constants';
 import { errors } from '../errors';
 
 const { NoWeekData, NoFirstDay } = errors;
 
-const DAYS = [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ];
-const DEFAULT = '001';
-
 export default function firstDay(locale) {
     const info = getLocaleInfo(locale);
 
@@ -20,13 +18,13 @@ export default function firstDay(locale) {
         throw NoWeekData.error();
     }
 
-    const firstDay = weekData.firstDay[localeTerritory(info)] || weekData.firstDay[DEFAULT];
+    const firstDay = weekData.firstDay[localeTerritory(info)] || weekData.firstDay[DEFAULT_TERRITORY];
 
     if (!firstDay) {
         throw NoFirstDay.error();
     }
 
-    info.firstDay = DAYS.indexOf(firstDay);
+    info.firstDay = DAYS_OF_WEEK.indexOf(firstDay);
 
     return info.firstDay;
 }

src/cldr/load.js

@@ -30,11 +30,13 @@ export default function load() {
         } else if (entry.supplemental) {
             if (entry.supplemental.weekData) {
                 cldr.supplemental.weekData = {
-                    firstDay: entry.supplemental.weekData.firstDay
+                    firstDay: entry.supplemental.weekData.firstDay,
+                    weekendStart: entry.supplemental.weekData.weekendStart,
+                    weekendEnd: entry.supplemental.weekData.weekendEnd
                 };
             } else {
                 Object.assign(cldr.supplemental, entry.supplemental);
             }
         }
     }
-}
+}

src/cldr/weekend-range.js

@@ -0,0 +1,31 @@
+import { cldr, getLocaleInfo } from './info';
+import localeTerritory from './territory';
+
+import { DAYS_OF_WEEK, DEFAULT_TERRITORY } from './constants';
+import { errors } from '../errors';
+
+const { NoWeekData } = errors;
+
+export default function weekendRange(locale) {
+    const info = getLocaleInfo(locale);
+
+    if (info.weekendRange) {
+        return info.weekendRange;
+    }
+
+    const weekData = cldr.supplemental.weekData;
+    if (!weekData) {
+        throw NoWeekData.error();
+    }
+
+    const territory = localeTerritory(info);
+    const start = weekData.weekendStart[territory] || weekData.weekendStart[DEFAULT_TERRITORY];
+    const end = weekData.weekendEnd[territory] || weekData.weekendEnd[DEFAULT_TERRITORY];
+
+    info.weekendRange = {
+        start: DAYS_OF_WEEK.indexOf(start),
+        end: DAYS_OF_WEEK.indexOf(end)
+    };
+
+    return info.weekendRange;
+}