@instructure/ui-i18n 8.11.2-snapshot.41 → 8.11.2-snapshot.44

package/es/DateTime.js

@@ -27,7 +27,8 @@ import moment from 'moment-timezone';
  * category: utilities/i18n
  * ---
  * @deprecated
- * ##### DEPRECATION WARNING: Will be removed in v9 since it provides no further benefit over using dayjs
+ * #### DEPRECATION WARNING: Will be removed in v9, which wil include a
+ * time library agnostic API.
  * A wrapper for [moment](https://momentjs.com/) utils.
  * @module DateTime
  */
@@ -79,6 +80,38 @@ function isValid(dateString) {
 function browserTimeZone() {
   return moment.tz.guess();
 }
+/**
+ * Returns the days of the week in the given locale,
+ * for example ["Monday", "Tuesday",..]. It always begins with Monday.
+ * @param locale A locale accepted by the browser, e.g. America/New_York
+ * @param format If set to 'short' it will be maximum 3 letters long,
+ *               if set to 'long' it will be the full word.
+ */
+
+
+function getLocalDayNamesOfTheWeek(locale, format) {
+  const ret = [];
+  const toFormat = format === 'short' ? 'dd' : 'dddd';
+  let currentDay = getFirstDayOfWeek(now(locale, browserTimeZone()));
+
+  for (let i = 0; i < 7; i++) {
+    ret.push(currentDay.format(toFormat));
+    currentDay = currentDay.add(1, 'day'); // TODO this is mutable
+  }
+
+  return ret;
+}
+/**
+ * Returns the first day of the week in the given locale.
+ * The locale decides what is the first day, e.g. Sunday in the US, Monday in
+ * the EU.
+ * @param date A Moment Datetime object
+ */
+
+
+function getFirstDayOfWeek(date) {
+  return date.clone().weekday(0);
+}
 /**
  * Return a localized date + time with timezone as a ISO 8601 string
  * @param {String} dateString
@@ -105,7 +138,9 @@ const DateTime = {
   parse,
   browserTimeZone,
   isValid,
-  toLocaleString
+  toLocaleString,
+  getFirstDayOfWeek,
+  getLocalDayNamesOfTheWeek
 };
 export default DateTime;
 export { DateTime };

package/lib/DateTime.js

@@ -38,7 +38,8 @@ var _momentTimezone = _interopRequireDefault(require("moment-timezone"));
  * category: utilities/i18n
  * ---
  * @deprecated
- * ##### DEPRECATION WARNING: Will be removed in v9 since it provides no further benefit over using dayjs
+ * #### DEPRECATION WARNING: Will be removed in v9, which wil include a
+ * time library agnostic API.
  * A wrapper for [moment](https://momentjs.com/) utils.
  * @module DateTime
  */
@@ -89,6 +90,38 @@ function isValid(dateString) {
 function browserTimeZone() {
   return _momentTimezone.default.tz.guess();
 }
+/**
+ * Returns the days of the week in the given locale,
+ * for example ["Monday", "Tuesday",..]. It always begins with Monday.
+ * @param locale A locale accepted by the browser, e.g. America/New_York
+ * @param format If set to 'short' it will be maximum 3 letters long,
+ *               if set to 'long' it will be the full word.
+ */
+
+
+function getLocalDayNamesOfTheWeek(locale, format) {
+  const ret = [];
+  const toFormat = format === 'short' ? 'dd' : 'dddd';
+  let currentDay = getFirstDayOfWeek(now(locale, browserTimeZone()));
+
+  for (let i = 0; i < 7; i++) {
+    ret.push(currentDay.format(toFormat));
+    currentDay = currentDay.add(1, 'day'); // TODO this is mutable
+  }
+
+  return ret;
+}
+/**
+ * Returns the first day of the week in the given locale.
+ * The locale decides what is the first day, e.g. Sunday in the US, Monday in
+ * the EU.
+ * @param date A Moment Datetime object
+ */
+
+
+function getFirstDayOfWeek(date) {
+  return date.clone().weekday(0);
+}
 /**
  * Return a localized date + time with timezone as a ISO 8601 string
  * @param {String} dateString
@@ -115,7 +148,9 @@ const DateTime = {
   parse,
   browserTimeZone,
   isValid,
-  toLocaleString
+  toLocaleString,
+  getFirstDayOfWeek,
+  getLocalDayNamesOfTheWeek
 };
 exports.DateTime = DateTime;
 var _default = DateTime;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-i18n",
-  "version": "8.11.2-snapshot.41+c2204d939",
+  "version": "8.11.2-snapshot.44+e7e40bd05",
   "description": "Helper components and utilities for internationalization.",
   "author": "Instructure, Inc. Engineering and Product Design",
   "type": "commonjs",
@@ -24,18 +24,18 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@instructure/ui-babel-preset": "8.11.2-snapshot.41+c2204d939",
-    "@instructure/ui-test-utils": "8.11.2-snapshot.41+c2204d939",
+    "@instructure/ui-babel-preset": "8.11.2-snapshot.44+e7e40bd05",
+    "@instructure/ui-test-utils": "8.11.2-snapshot.44+e7e40bd05",
     "@types/hoist-non-react-statics": "^3.3.1"
   },
   "dependencies": {
     "@babel/runtime": "^7.13.10",
-    "@instructure/shared-types": "8.11.2-snapshot.41+c2204d939",
-    "@instructure/ui-decorator": "8.11.2-snapshot.41+c2204d939",
-    "@instructure/ui-dom-utils": "8.11.2-snapshot.41+c2204d939",
-    "@instructure/ui-prop-types": "8.11.2-snapshot.41+c2204d939",
-    "@instructure/ui-react-utils": "8.11.2-snapshot.41+c2204d939",
-    "@instructure/ui-utils": "8.11.2-snapshot.41+c2204d939",
+    "@instructure/shared-types": "8.11.2-snapshot.44+e7e40bd05",
+    "@instructure/ui-decorator": "8.11.2-snapshot.44+e7e40bd05",
+    "@instructure/ui-dom-utils": "8.11.2-snapshot.44+e7e40bd05",
+    "@instructure/ui-prop-types": "8.11.2-snapshot.44+e7e40bd05",
+    "@instructure/ui-react-utils": "8.11.2-snapshot.44+e7e40bd05",
+    "@instructure/ui-utils": "8.11.2-snapshot.44+e7e40bd05",
     "hoist-non-react-statics": "^3.3.2",
     "moment-timezone": "^0.5",
     "prop-types": "^15"
@@ -47,5 +47,5 @@
     "access": "public"
   },
   "sideEffects": false,
-  "gitHead": "c2204d939d018592429a7055755fbdb036d2ceb0"
+  "gitHead": "e7e40bd053ec965afb10ef5a85379aec0452ce37"
 }

package/src/DateTime.ts

@@ -22,14 +22,15 @@
  * SOFTWARE.
  */
 
-import moment from 'moment-timezone'
+import moment, { Moment } from 'moment-timezone'
 
 /**
  * ---
  * category: utilities/i18n
  * ---
  * @deprecated
- * ##### DEPRECATION WARNING: Will be removed in v9 since it provides no further benefit over using dayjs
+ * #### DEPRECATION WARNING: Will be removed in v9, which wil include a
+ * time library agnostic API.
  * A wrapper for [moment](https://momentjs.com/) utils.
  * @module DateTime
  */
@@ -81,6 +82,34 @@ function browserTimeZone() {
   return moment.tz.guess()
 }
 
+/**
+ * Returns the days of the week in the given locale,
+ * for example ["Monday", "Tuesday",..]. It always begins with Monday.
+ * @param locale A locale accepted by the browser, e.g. America/New_York
+ * @param format If set to 'short' it will be maximum 3 letters long,
+ *               if set to 'long' it will be the full word.
+ */
+function getLocalDayNamesOfTheWeek(locale: string, format: 'short' | 'long') {
+  const ret: string[] = []
+  const toFormat = format === 'short' ? 'dd' : 'dddd'
+  let currentDay = getFirstDayOfWeek(now(locale, browserTimeZone()))
+  for (let i = 0; i < 7; i++) {
+    ret.push(currentDay.format(toFormat))
+    currentDay = currentDay.add(1, 'day') // TODO this is mutable
+  }
+  return ret
+}
+
+/**
+ * Returns the first day of the week in the given locale.
+ * The locale decides what is the first day, e.g. Sunday in the US, Monday in
+ * the EU.
+ * @param date A Moment Datetime object
+ */
+function getFirstDayOfWeek(date: Moment) {
+  return date.clone().weekday(0)
+}
+
 /**
  * Return a localized date + time with timezone as a ISO 8601 string
  * @param {String} dateString
@@ -110,8 +139,11 @@ const DateTime = {
   parse,
   browserTimeZone,
   isValid,
-  toLocaleString
+  toLocaleString,
+  getFirstDayOfWeek,
+  getLocalDayNamesOfTheWeek
 }
 
 export default DateTime
 export { DateTime }
+export type { Moment }

package/src/index.ts

@@ -36,6 +36,7 @@ export {
   ApplyTextDirection
 } from './ApplyTextDirection'
 
+export type { Moment } from './DateTime'
 export type { BidirectionalProps } from './bidirectional'
 export type { ApplyLocaleProps } from './ApplyLocale/props'
 export type { ApplyTextDirectionProps } from './ApplyTextDirection/props'

package/types/DateTime.d.ts

@@ -1,10 +1,11 @@
-import moment from 'moment-timezone';
+import moment, { Moment } from 'moment-timezone';
 /**
  * ---
  * category: utilities/i18n
  * ---
  * @deprecated
- * ##### DEPRECATION WARNING: Will be removed in v9 since it provides no further benefit over using dayjs
+ * #### DEPRECATION WARNING: Will be removed in v9, which wil include a
+ * time library agnostic API.
  * A wrapper for [moment](https://momentjs.com/) utils.
  * @module DateTime
  */
@@ -35,6 +36,21 @@ declare function isValid(dateString: string): boolean;
  * @returns {String} a time zone identifier (see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
  */
 declare function browserTimeZone(): string;
+/**
+ * Returns the days of the week in the given locale,
+ * for example ["Monday", "Tuesday",..]. It always begins with Monday.
+ * @param locale A locale accepted by the browser, e.g. America/New_York
+ * @param format If set to 'short' it will be maximum 3 letters long,
+ *               if set to 'long' it will be the full word.
+ */
+declare function getLocalDayNamesOfTheWeek(locale: string, format: 'short' | 'long'): string[];
+/**
+ * Returns the first day of the week in the given locale.
+ * The locale decides what is the first day, e.g. Sunday in the US, Monday in
+ * the EU.
+ * @param date A Moment Datetime object
+ */
+declare function getFirstDayOfWeek(date: Moment): moment.Moment;
 /**
  * Return a localized date + time with timezone as a ISO 8601 string
  * @param {String} dateString
@@ -50,7 +66,10 @@ declare const DateTime: {
     browserTimeZone: typeof browserTimeZone;
     isValid: typeof isValid;
     toLocaleString: typeof toLocaleString;
+    getFirstDayOfWeek: typeof getFirstDayOfWeek;
+    getLocalDayNamesOfTheWeek: typeof getLocalDayNamesOfTheWeek;
 };
 export default DateTime;
 export { DateTime };
+export type { Moment };
 //# sourceMappingURL=DateTime.d.ts.map

package/types/DateTime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DateTime.d.ts","sourceRoot":"","sources":["../src/DateTime.ts"],"names":[],"mappings":"AAwBA,OAAO,MAAM,MAAM,iBAAiB,CAAA;AAEpC;;;;;;;;GAQG;AAEH;;;;;GAKG;AACH,iBAAS,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,iBAG5C;AAED;;;;;;GAMG;AACH,iBAAS,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,iBASlE;AAED;;;;GAIG;AACH,iBAAS,OAAO,CAAC,UAAU,EAAE,MAAM,WAElC;AAED;;;;GAIG;AACH,iBAAS,eAAe,WAEvB;AAED;;;;;;;GAOG;AACH,iBAAS,cAAc,CACrB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,MAAM,UAKhB;AAOD,QAAA,MAAM,QAAQ;;;;;;CAMb,CAAA;AAED,eAAe,QAAQ,CAAA;AACvB,OAAO,EAAE,QAAQ,EAAE,CAAA"}
+{"version":3,"file":"DateTime.d.ts","sourceRoot":"","sources":["../src/DateTime.ts"],"names":[],"mappings":"AAwBA,OAAO,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAEhD;;;;;;;;;GASG;AAEH;;;;;GAKG;AACH,iBAAS,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,iBAG5C;AAED;;;;;;GAMG;AACH,iBAAS,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,iBASlE;AAED;;;;GAIG;AACH,iBAAS,OAAO,CAAC,UAAU,EAAE,MAAM,WAElC;AAED;;;;GAIG;AACH,iBAAS,eAAe,WAEvB;AAED;;;;;;GAMG;AACH,iBAAS,yBAAyB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM,YAS1E;AAED;;;;;GAKG;AACH,iBAAS,iBAAiB,CAAC,IAAI,EAAE,MAAM,iBAEtC;AAED;;;;;;;GAOG;AACH,iBAAS,cAAc,CACrB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,MAAM,UAKhB;AAOD,QAAA,MAAM,QAAQ;;;;;;;;CAQb,CAAA;AAED,eAAe,QAAQ,CAAA;AACvB,OAAO,EAAE,QAAQ,EAAE,CAAA;AACnB,YAAY,EAAE,MAAM,EAAE,CAAA"}

package/types/index.d.ts

@@ -7,6 +7,7 @@ export { I18nPropTypes } from './I18nPropTypes';
 export { Locale } from './Locale';
 export { DIRECTION, TextDirectionContext } from './TextDirectionContext';
 export { useTextDirectionContext, ApplyTextDirection } from './ApplyTextDirection';
+export type { Moment } from './DateTime';
 export type { BidirectionalProps } from './bidirectional';
 export type { ApplyLocaleProps } from './ApplyLocale/props';
 export type { ApplyTextDirectionProps } from './ApplyTextDirection/props';

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAA;AAErE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AACrC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACjC,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AACxE,OAAO,EACL,uBAAuB,EACvB,kBAAkB,EACnB,MAAM,sBAAsB,CAAA;AAE7B,YAAY,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AACzD,YAAY,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AAC3D,YAAY,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAA;AAErE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AACrC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACjC,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AACxE,OAAO,EACL,uBAAuB,EACvB,kBAAkB,EACnB,MAAM,sBAAsB,CAAA;AAE7B,YAAY,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AACxC,YAAY,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AACzD,YAAY,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AAC3D,YAAY,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAA"}