@dereekb/date 9.9.4 → 9.10.0

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+# [9.10.0](https://github.com/dereekb/dbx-components/compare/v9.9.5-dev...v9.10.0) (2022-10-05)
+
+
+
+## [9.9.5](https://github.com/dereekb/dbx-components/compare/v9.9.4-dev...v9.9.5) (2022-09-19)
+
+
+
 ## [9.9.4](https://github.com/dereekb/dbx-components/compare/v9.9.3-dev...v9.9.4) (2022-09-19)
 
 

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@dereekb/date",
-  "version": "9.9.4",
+  "version": "9.10.0",
   "type": "commonjs",
   "main": "./src/index.js",
   "typings": "./src/index.d.ts",
   "dependencies": {},
   "peerDependencies": {
     "date-fns": "^2.29.0",
-    "@dereekb/util": "9.9.4",
+    "@dereekb/util": "9.10.0",
     "lodash.isequal": "^4.5.0",
     "make-error": "^1.3.0",
     "class-validator": "^0.13.2",

package/src/lib/date/date.week.d.ts

@@ -0,0 +1,128 @@
+import { MapFunction, Maybe } from '@dereekb/util';
+import { DateTimezoneUtcNormalInstance, DateTimezoneUtcNormalInstanceInput } from './date.timezone';
+/**
+ * A Week/Year number combination used to refer to a specific Week on a specific Year.
+ *
+ * 202201 is January 2022
+ */
+export declare type YearWeekCode = number;
+/**
+ * Used for default YearWeekCode values
+ */
+export declare const UNKNOWN_JOB_YEAR_WEEK = 0;
+export declare type UnknownYearWeekCode = typeof UNKNOWN_JOB_YEAR_WEEK;
+/**
+ * The week in the year. Starts from 1.
+ */
+export declare type YearWeekCodeIndex = number;
+/**
+ * Returns the YearWeekCodeIndex for the YearWeekCode.
+ *
+ * @param yearWeekCode
+ * @returns
+ */
+export declare function yearWeekCodeIndex(yearWeekCode: YearWeekCode): YearWeekCodeIndex;
+/**
+ * Pair of the YearWeekCodeIndex and the year.
+ */
+export interface YearWeekCodePair {
+    week: YearWeekCodeIndex;
+    year: number;
+}
+/**
+ * Returns the YearWeekCodePair for the YearWeekCode.
+ *
+ * @param yearWeekCode
+ * @returns
+ */
+export declare function yearWeekCodePair(yearWeekCode: YearWeekCode): YearWeekCodePair;
+/**
+ * Used to convert the input to a YearWeekCode.
+ */
+export declare type YearWeekCodeFactory = ((dateOrYear: Date | number, inputWeek?: YearWeekCodeIndex) => YearWeekCode) & {
+    _normal: DateTimezoneUtcNormalInstance;
+};
+export declare type YearWeekCodeDateTimezoneInput = DateTimezoneUtcNormalInstanceInput | DateTimezoneUtcNormalInstance;
+export interface YearWeekCodeConfig {
+    /**
+     * (Optional) Input timezone configuration for a DateTimezoneUtcNormalInstance.
+     *
+     * Configured to use the system timezone by default.
+     */
+    timezone?: YearWeekCodeDateTimezoneInput;
+}
+export declare function yearWeekCodeDateTimezoneInstance(input: YearWeekCodeDateTimezoneInput): DateTimezoneUtcNormalInstance;
+/**
+ * Returns the yearWeekCode for the input Date or Year/Week combo.
+ *
+ * The date is expected to be relative to UTC.
+ *
+ * @param date
+ */
+export declare function yearWeekCode(date: Date): YearWeekCode;
+export declare function yearWeekCode(year: number, week: YearWeekCodeIndex): YearWeekCode;
+/**
+ * Creates a YearWeekCodeFactory using the optional input config.
+ *
+ * @param config
+ * @returns
+ */
+export declare function yearWeekCodeFactory(config?: YearWeekCodeConfig): YearWeekCodeFactory;
+/**
+ * Used for returning an array of YearWeekCode values for a pre-configured date range.
+ */
+export declare type YearWeekCodeForCalendarMonthFactory = (date: Date) => YearWeekCode[];
+/**
+ * Returns the yearWeekCodes for the input Date's calendar month.
+ *
+ * The date is expected to be relative to UTC.
+ *
+ * @param date
+ */
+export declare function yearWeekCodeForCalendarMonth(date: Date): YearWeekCode[];
+/**
+ * Create a YearWeekCodeForMonthFactory.
+ *
+ * @param factory
+ * @returns
+ */
+export declare function yearWeekCodeForCalendarMonthFactory(factory?: YearWeekCodeFactory): YearWeekCodeForCalendarMonthFactory;
+/**
+ * Used to convert the input to a YearWeekCode.
+ */
+export declare type YearWeekCodeDateFactory = (yearWeekCode: YearWeekCode) => Date;
+export interface YearWeekCodeDateConfig extends Pick<YearWeekCodeConfig, 'timezone'> {
+}
+/**
+ * Creates a YearWeekCodeDateFactory using the optional input config.
+ *
+ * @param config
+ * @returns
+ */
+export declare function yearWeekCodeDateFactory(config?: YearWeekCodeDateConfig): YearWeekCodeDateFactory;
+/**
+ *
+ */
+export interface YearWeekCodeGroup<B> {
+    readonly items: B[];
+    readonly week: YearWeekCode;
+}
+/**
+ * Used to group the input items into an array of YearWeekCodeGroup values.
+ */
+export declare type YearWeekCodeGroupFactory<B> = (items: B[]) => YearWeekCodeGroup<B>[];
+/**
+ * MapFunction that reads the relevant date to use for the YearWeekCode calculation from the input item.
+ */
+export declare type YearWeekCodeDateReader<B> = MapFunction<B, Maybe<Date>>;
+export interface YearWeekCodeGroupFactoryConfig<B> {
+    yearWeekCodeFactory?: YearWeekCodeFactory | YearWeekCodeConfig;
+    dateReader: YearWeekCodeDateReader<B>;
+}
+/**
+ * Crates a YearWeekCodeGroupFactory.
+ *
+ * @param config
+ * @returns
+ */
+export declare function yearWeekCodeGroupFactory<B>(config: YearWeekCodeGroupFactoryConfig<B>): YearWeekCodeGroupFactory<B>;

package/src/lib/date/date.week.js

@@ -0,0 +1,154 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.yearWeekCodeGroupFactory = exports.yearWeekCodeDateFactory = exports.yearWeekCodeForCalendarMonthFactory = exports.yearWeekCodeForCalendarMonth = exports.yearWeekCodeFactory = exports.yearWeekCode = exports.yearWeekCodeDateTimezoneInstance = exports.yearWeekCodePair = exports.yearWeekCodeIndex = exports.UNKNOWN_JOB_YEAR_WEEK = void 0;
+const util_1 = require("@dereekb/util");
+const date_fns_1 = require("date-fns");
+const date_timezone_1 = require("./date.timezone");
+/**
+ * Used for default YearWeekCode values
+ */
+exports.UNKNOWN_JOB_YEAR_WEEK = 0;
+/**
+ * Returns the YearWeekCodeIndex for the YearWeekCode.
+ *
+ * @param yearWeekCode
+ * @returns
+ */
+function yearWeekCodeIndex(yearWeekCode) {
+    return yearWeekCode % 100;
+}
+exports.yearWeekCodeIndex = yearWeekCodeIndex;
+/**
+ * Returns the YearWeekCodePair for the YearWeekCode.
+ *
+ * @param yearWeekCode
+ * @returns
+ */
+function yearWeekCodePair(yearWeekCode) {
+    return {
+        week: yearWeekCodeIndex(yearWeekCode),
+        year: Math.floor(yearWeekCode / 100)
+    };
+}
+exports.yearWeekCodePair = yearWeekCodePair;
+function yearWeekCodeDateTimezoneInstance(input) {
+    const normal = input ? (input instanceof date_timezone_1.DateTimezoneUtcNormalInstance ? input : (0, date_timezone_1.dateTimezoneUtcNormal)(input)) : date_timezone_1.SYSTEM_DATE_TIMEZONE_UTC_NORMAL_INSTANCE;
+    return normal;
+}
+exports.yearWeekCodeDateTimezoneInstance = yearWeekCodeDateTimezoneInstance;
+function yearWeekCode(dateOrYear, inputWeek) {
+    return yearWeekCodeFactory({ timezone: date_timezone_1.SYSTEM_DATE_TIMEZONE_UTC_NORMAL_INSTANCE })(dateOrYear, inputWeek);
+}
+exports.yearWeekCode = yearWeekCode;
+/**
+ * Creates a YearWeekCodeFactory using the optional input config.
+ *
+ * @param config
+ * @returns
+ */
+function yearWeekCodeFactory(config) {
+    const normal = yearWeekCodeDateTimezoneInstance(config === null || config === void 0 ? void 0 : config.timezone);
+    const result = (dateOrYear, inputWeek) => {
+        let year;
+        let week;
+        if ((0, date_fns_1.isDate)(dateOrYear)) {
+            const normalDate = normal.systemDateToTargetDate(dateOrYear);
+            week = (0, date_fns_1.getWeek)(normalDate);
+            // check if the date is not in the previous year, in which case we need to add one.
+            if (week === 1) {
+                year = (0, date_fns_1.getYear)((0, date_fns_1.endOfWeek)(normalDate)); // the last day is the important one to get the year from.
+            }
+            else {
+                year = (0, date_fns_1.getYear)(normalDate);
+            }
+        }
+        else {
+            year = dateOrYear;
+            week = inputWeek;
+        }
+        const encodedYear = year * 100;
+        return encodedYear + week;
+    };
+    result._normal = normal;
+    return result;
+}
+exports.yearWeekCodeFactory = yearWeekCodeFactory;
+/**
+ * Returns the yearWeekCodes for the input Date's calendar month.
+ *
+ * The date is expected to be relative to UTC.
+ *
+ * @param date
+ */
+function yearWeekCodeForCalendarMonth(date) {
+    return yearWeekCodeForCalendarMonthFactory(yearWeekCodeFactory({ timezone: date_timezone_1.SYSTEM_DATE_TIMEZONE_UTC_NORMAL_INSTANCE }))(date);
+}
+exports.yearWeekCodeForCalendarMonth = yearWeekCodeForCalendarMonth;
+/**
+ * Create a YearWeekCodeForMonthFactory.
+ *
+ * @param factory
+ * @returns
+ */
+function yearWeekCodeForCalendarMonthFactory(factory = yearWeekCodeFactory()) {
+    const { _normal } = factory;
+    return (date) => {
+        const normalDate = _normal.systemDateToTargetDate(date);
+        const start = (0, date_fns_1.startOfMonth)((0, date_fns_1.endOfWeek)(normalDate));
+        const end = (0, date_fns_1.endOfWeek)((0, date_fns_1.endOfMonth)(start));
+        const weeks = [];
+        let current = start;
+        while ((0, date_fns_1.isBefore)(current, end)) {
+            const week = factory(current);
+            weeks.push(week);
+            current = (0, date_fns_1.addWeeks)(current, 1);
+        }
+        return weeks;
+    };
+}
+exports.yearWeekCodeForCalendarMonthFactory = yearWeekCodeForCalendarMonthFactory;
+/**
+ * Creates a YearWeekCodeDateFactory using the optional input config.
+ *
+ * @param config
+ * @returns
+ */
+function yearWeekCodeDateFactory(config) {
+    const normal = yearWeekCodeDateTimezoneInstance(config === null || config === void 0 ? void 0 : config.timezone);
+    return (yearWeekCode) => {
+        const pair = yearWeekCodePair(yearWeekCode);
+        const date = (0, date_fns_1.startOfWeek)((0, date_fns_1.setWeek)(new Date(Date.UTC(pair.year, 0, 1, 0, 0, 0, 0)), pair.week));
+        const fixed = normal.targetDateToSystemDate(date);
+        return fixed;
+    };
+}
+exports.yearWeekCodeDateFactory = yearWeekCodeDateFactory;
+/**
+ * Crates a YearWeekCodeGroupFactory.
+ *
+ * @param config
+ * @returns
+ */
+function yearWeekCodeGroupFactory(config) {
+    const { yearWeekCodeFactory: factoryInput, dateReader } = config;
+    const readJobWeekYear = typeof factoryInput === 'function' ? factoryInput : yearWeekCodeFactory(factoryInput);
+    return (items) => {
+        const map = (0, util_1.makeValuesGroupMap)(items, (item) => {
+            let yearWeekCode;
+            const date = dateReader(item);
+            if (date != null) {
+                yearWeekCode = readJobWeekYear(date);
+            }
+            return yearWeekCode;
+        });
+        const groups = Array.from(map.entries()).map(([week, items]) => {
+            return {
+                week: week || 0,
+                items
+            };
+        });
+        return groups;
+    };
+}
+exports.yearWeekCodeGroupFactory = yearWeekCodeGroupFactory;
+//# sourceMappingURL=date.week.js.map

package/src/lib/date/date.week.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"date.week.js","sourceRoot":"","sources":["../../../../../../packages/date/src/lib/date/date.week.ts"],"names":[],"mappings":";;;AAAA,wCAAiF;AACjF,uCAAmI;AACnI,mDAAqK;AASrK;;GAEG;AACU,QAAA,qBAAqB,GAAG,CAAC,CAAC;AASvC;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,YAA0B;IAC1D,OAAO,YAAY,GAAG,GAAG,CAAC;AAC5B,CAAC;AAFD,8CAEC;AAUD;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,YAA0B;IACzD,OAAO;QACL,IAAI,EAAE,iBAAiB,CAAC,YAAY,CAAC;QACrC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,GAAG,CAAC;KACrC,CAAC;AACJ,CAAC;AALD,4CAKC;AAoBD,SAAgB,gCAAgC,CAAC,KAAoC;IACnF,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,YAAY,6CAA6B,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAA,qCAAqB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,wDAAwC,CAAC;IAC1J,OAAO,MAAM,CAAC;AAChB,CAAC;AAHD,4EAGC;AAWD,SAAgB,YAAY,CAAC,UAAyB,EAAE,SAA6B;IACnF,OAAO,mBAAmB,CAAC,EAAE,QAAQ,EAAE,wDAAwC,EAAE,CAAC,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;AAC5G,CAAC;AAFD,oCAEC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,MAA2B;IAC7D,MAAM,MAAM,GAAG,gCAAgC,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,CAAC,CAAC;IAElE,MAAM,MAAM,GAAkC,CAAC,UAAyB,EAAE,SAA6B,EAAE,EAAE;QACzG,IAAI,IAAY,CAAC;QACjB,IAAI,IAAuB,CAAC;QAE5B,IAAI,IAAA,iBAAM,EAAC,UAAU,CAAC,EAAE;YACtB,MAAM,UAAU,GAAG,MAAM,CAAC,sBAAsB,CAAC,UAAkB,CAAC,CAAC;YACrE,IAAI,GAAG,IAAA,kBAAO,EAAC,UAAU,CAAC,CAAC;YAE3B,mFAAmF;YACnF,IAAI,IAAI,KAAK,CAAC,EAAE;gBACd,IAAI,GAAG,IAAA,kBAAO,EAAC,IAAA,oBAAS,EAAC,UAAU,CAAC,CAAC,CAAC,CAAC,0DAA0D;aAClG;iBAAM;gBACL,IAAI,GAAG,IAAA,kBAAO,EAAC,UAAU,CAAC,CAAC;aAC5B;SACF;aAAM;YACL,IAAI,GAAG,UAAoB,CAAC;YAC5B,IAAI,GAAG,SAA8B,CAAC;SACvC;QAED,MAAM,WAAW,GAAG,IAAI,GAAG,GAAG,CAAC;QAC/B,OAAO,WAAW,GAAG,IAAI,CAAC;IAC5B,CAAC,CAAC;IAEF,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,OAAO,MAA6B,CAAC;AACvC,CAAC;AA5BD,kDA4BC;AAOD;;;;;;GAMG;AACH,SAAgB,4BAA4B,CAAC,IAAU;IACrD,OAAO,mCAAmC,CAAC,mBAAmB,CAAC,EAAE,QAAQ,EAAE,wDAAwC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAChI,CAAC;AAFD,oEAEC;AAED;;;;;GAKG;AACH,SAAgB,mCAAmC,CAAC,UAA+B,mBAAmB,EAAE;IACtG,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAE5B,OAAO,CAAC,IAAU,EAAE,EAAE;QACpB,MAAM,UAAU,GAAG,OAAO,CAAC,sBAAsB,CAAC,IAAY,CAAC,CAAC;QAChE,MAAM,KAAK,GAAG,IAAA,uBAAY,EAAC,IAAA,oBAAS,EAAC,UAAU,CAAC,CAAC,CAAC;QAClD,MAAM,GAAG,GAAG,IAAA,oBAAS,EAAC,IAAA,qBAAU,EAAC,KAAK,CAAC,CAAC,CAAC;QAEzC,MAAM,KAAK,GAAmB,EAAE,CAAC;QAEjC,IAAI,OAAO,GAAG,KAAK,CAAC;QAEpB,OAAO,IAAA,mBAAQ,EAAC,OAAO,EAAE,GAAG,CAAC,EAAE;YAC7B,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;YAC9B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjB,OAAO,GAAG,IAAA,mBAAQ,EAAC,OAAO,EAAE,CAAC,CAAC,CAAC;SAChC;QAED,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;AACJ,CAAC;AApBD,kFAoBC;AASD;;;;;GAKG;AACH,SAAgB,uBAAuB,CAAC,MAA+B;IACrE,MAAM,MAAM,GAAG,gCAAgC,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,CAAC,CAAC;IAClE,OAAO,CAAC,YAA0B,EAAE,EAAE;QACpC,MAAM,IAAI,GAAG,gBAAgB,CAAC,YAAY,CAAC,CAAC;QAC5C,MAAM,IAAI,GAAG,IAAA,sBAAW,EAAC,IAAA,kBAAO,EAAC,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9F,MAAM,KAAK,GAAG,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAClD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;AACJ,CAAC;AARD,0DAQC;AAyBD;;;;;GAKG;AACH,SAAgB,wBAAwB,CAAI,MAAyC;IACnF,MAAM,EAAE,mBAAmB,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;IACjE,MAAM,eAAe,GAAG,OAAO,YAAY,KAAK,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;IAE9G,OAAO,CAAC,KAAU,EAAE,EAAE;QACpB,MAAM,GAAG,GAAG,IAAA,yBAAkB,EAAC,KAAK,EAAE,CAAC,IAAO,EAAE,EAAE;YAChD,IAAI,YAAiC,CAAC;YACtC,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;YAE9B,IAAI,IAAI,IAAI,IAAI,EAAE;gBAChB,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;aACtC;YAED,OAAO,YAAY,CAAC;QACtB,CAAC,CAAC,CAAC;QAEH,MAAM,MAAM,GAA2B,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE;YACrF,OAAO;gBACL,IAAI,EAAE,IAAI,IAAI,CAAC;gBACf,KAAK;aACN,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAzBD,4DAyBC"}

package/src/lib/date/index.d.ts

@@ -12,3 +12,4 @@ export * from './date.time';
 export * from './date.timezone';
 export * from './date';
 export * from './date.unix';
+export * from './date.week';

package/src/lib/date/index.js

@@ -15,4 +15,5 @@ tslib_1.__exportStar(require("./date.time"), exports);
 tslib_1.__exportStar(require("./date.timezone"), exports);
 tslib_1.__exportStar(require("./date"), exports);
 tslib_1.__exportStar(require("./date.unix"), exports);
+tslib_1.__exportStar(require("./date.week"), exports);
 //# sourceMappingURL=index.js.map

package/src/lib/date/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/date/src/lib/date/index.ts"],"names":[],"mappings":";;;AAAA,uDAA6B;AAC7B,0DAAgC;AAChC,0DAAgC;AAChC,wDAA8B;AAC9B,yDAA+B;AAC/B,uDAA6B;AAC7B,uDAA6B;AAC7B,sDAA4B;AAC5B,4DAAkC;AAClC,6DAAmC;AACnC,sDAA4B;AAC5B,0DAAgC;AAChC,iDAAuB;AACvB,sDAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/date/src/lib/date/index.ts"],"names":[],"mappings":";;;AAAA,uDAA6B;AAC7B,0DAAgC;AAChC,0DAAgC;AAChC,wDAA8B;AAC9B,yDAA+B;AAC/B,uDAA6B;AAC7B,uDAA6B;AAC7B,sDAA4B;AAC5B,4DAAkC;AAClC,6DAAmC;AACnC,sDAA4B;AAC5B,0DAAgC;AAChC,iDAAuB;AACvB,sDAA4B;AAC5B,sDAA4B"}