@dereekb/date 9.25.14 → 9.25.16

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [9.25.16](https://github.com/dereekb/dbx-components/compare/v9.25.15-dev...v9.25.16) (2023-12-01)
+
+
+
+## [9.25.15](https://github.com/dereekb/dbx-components/compare/v9.25.14-dev...v9.25.15) (2023-11-27)
+
+
+
 ## [9.25.14](https://github.com/dereekb/dbx-components/compare/v9.25.13-dev...v9.25.14) (2023-11-23)
 
 

package/package.json

@@ -1,21 +1,23 @@
 {
   "name": "@dereekb/date",
-  "version": "9.25.14",
+  "version": "9.25.16",
   "type": "commonjs",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",
   "dependencies": {},
   "peerDependencies": {
     "date-fns": "^2.29.0",
-    "@dereekb/util": "9.25.14",
+    "@dereekb/util": "9.25.16",
     "lodash.isequal": "^4.5.0",
     "make-error": "^1.3.0",
     "class-validator": "^0.13.2",
     "ts-essentials": "^9.1.2",
     "extra-set": "^2.2.11",
     "class-transformer": "^0.5.1",
-    "date-fns-tz": "^1.3.0",
+    "@dereekb/rxjs": "9.25.16",
     "rxjs": "^7.5.0",
+    "ms": "^3.0.0-canary.1",
+    "date-fns-tz": "^1.3.0",
     "rrule": "git+https://git@github.com/dereekb/rrule#2b13b1ea881059ba2ecfec380e12ef244ef54570",
     "@vvo/tzdb": "^6.0.0",
     "tslib": "^2.0.0"

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

@@ -1,4 +1,4 @@
-import { DateNow, Maybe } from '@dereekb/util';
+import { DateNow, Maybe, FactoryWithInput } from '@dereekb/util';
 export declare const DATE_TODAY_START_VALUE = "today_start";
 export declare type DateTodayStart = typeof DATE_TODAY_START_VALUE;
 export declare const DATE_TODAY_END_VALUE = "today_end";
@@ -12,6 +12,7 @@ export declare type LogicalDateStringCode = DateNow | DateTodayStart | DateToday
  * A date that is characterized by either a known string value, or a Date.
  */
 export declare type LogicalDate = Date | LogicalDateStringCode;
+export declare function logicalDateStringCodeDateFactory(logicalDateStringCode: LogicalDateStringCode): FactoryWithInput<Date, Date>;
 /**
  * Returns a Date value from the input LogicalDate.
  *

package/src/lib/date/date.logical.js

@@ -1,34 +1,40 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isLogicalDateStringCode = exports.dateFromLogicalDate = exports.DATE_WEEK_END_VALUE = exports.DATE_WEEK_START_VALUE = exports.DATE_TODAY_END_VALUE = exports.DATE_TODAY_START_VALUE = void 0;
+exports.isLogicalDateStringCode = exports.dateFromLogicalDate = exports.logicalDateStringCodeDateFactory = exports.DATE_WEEK_END_VALUE = exports.DATE_WEEK_START_VALUE = exports.DATE_TODAY_END_VALUE = exports.DATE_TODAY_START_VALUE = void 0;
 const util_1 = require("@dereekb/util");
 const date_fns_1 = require("date-fns");
 exports.DATE_TODAY_START_VALUE = 'today_start';
 exports.DATE_TODAY_END_VALUE = 'today_end';
 exports.DATE_WEEK_START_VALUE = 'this_week_start';
 exports.DATE_WEEK_END_VALUE = 'this_week_end';
+function logicalDateStringCodeDateFactory(logicalDateStringCode) {
+    let mapFn;
+    switch (logicalDateStringCode.toLocaleLowerCase()) {
+        case util_1.DATE_NOW_VALUE:
+            mapFn = (0, util_1.mapIdentityFunction)();
+            break;
+        case exports.DATE_TODAY_START_VALUE:
+            mapFn = date_fns_1.startOfDay;
+            break;
+        case exports.DATE_TODAY_END_VALUE:
+            mapFn = date_fns_1.endOfDay;
+            break;
+        case exports.DATE_WEEK_START_VALUE:
+            mapFn = date_fns_1.startOfWeek;
+            break;
+        case exports.DATE_WEEK_END_VALUE:
+            mapFn = date_fns_1.endOfWeek;
+            break;
+        default:
+            throw new Error(`Unknown logical date string "${logicalDateStringCode}"`);
+    }
+    return (now = new Date()) => mapFn(now);
+}
+exports.logicalDateStringCodeDateFactory = logicalDateStringCodeDateFactory;
 function dateFromLogicalDate(logicalDate, now = new Date()) {
     let result;
     if (typeof logicalDate === 'string') {
-        switch (logicalDate.toLocaleLowerCase()) {
-            case util_1.DATE_NOW_VALUE:
-                result = now;
-                break;
-            case exports.DATE_TODAY_START_VALUE:
-                result = (0, date_fns_1.startOfDay)(now);
-                break;
-            case exports.DATE_TODAY_END_VALUE:
-                result = (0, date_fns_1.endOfDay)(now);
-                break;
-            case exports.DATE_WEEK_START_VALUE:
-                result = (0, date_fns_1.startOfWeek)(now);
-                break;
-            case exports.DATE_WEEK_END_VALUE:
-                result = (0, date_fns_1.endOfWeek)(now);
-                break;
-            default:
-                throw new Error(`Unknown logical date string "${logicalDate}"`);
-        }
+        result = logicalDateStringCodeDateFactory(logicalDate)(now);
     }
     else {
         result = logicalDate;

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

@@ -1 +1 @@
-{"version":3,"file":"date.logical.js","sourceRoot":"","sources":["../../../../../../packages/date/src/lib/date/date.logical.ts"],"names":[],"mappings":";;;AAAA,wCAA+D;AAC/D,uCAAwE;AAE3D,QAAA,sBAAsB,GAAG,aAAa,CAAC;AAGvC,QAAA,oBAAoB,GAAG,WAAW,CAAC;AAGnC,QAAA,qBAAqB,GAAG,iBAAiB,CAAC;AAG1C,QAAA,mBAAmB,GAAG,eAAe,CAAC;AAiBnD,SAAgB,mBAAmB,CAAC,WAA+B,EAAE,MAAY,IAAI,IAAI,EAAE;IACzF,IAAI,MAAM,CAAC;IAEX,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;QACnC,QAAQ,WAAW,CAAC,iBAAiB,EAAE,EAAE;YACvC,KAAK,qBAAc;gBACjB,MAAM,GAAG,GAAG,CAAC;gBACb,MAAM;YACR,KAAK,8BAAsB;gBACzB,MAAM,GAAG,IAAA,qBAAU,EAAC,GAAG,CAAC,CAAC;gBACzB,MAAM;YACR,KAAK,4BAAoB;gBACvB,MAAM,GAAG,IAAA,mBAAQ,EAAC,GAAG,CAAC,CAAC;gBACvB,MAAM;YACR,KAAK,6BAAqB;gBACxB,MAAM,GAAG,IAAA,sBAAW,EAAC,GAAG,CAAC,CAAC;gBAC1B,MAAM;YACR,KAAK,2BAAmB;gBACtB,MAAM,GAAG,IAAA,oBAAS,EAAC,GAAG,CAAC,CAAC;gBACxB,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,gCAAgC,WAAW,GAAG,CAAC,CAAC;SACnE;KACF;SAAM;QACL,MAAM,GAAG,WAAW,CAAC;KACtB;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AA5BD,kDA4BC;AAED,SAAgB,uBAAuB,CAAC,WAAwC;IAC9E,IAAI,uBAAuB,GAAG,KAAK,CAAC;IAEpC,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;QACnC,QAAQ,WAAW,CAAC,iBAAiB,EAAE,EAAE;YACvC,KAAK,qBAAc,CAAC;YACpB,KAAK,8BAAsB,CAAC;YAC5B,KAAK,4BAAoB,CAAC;YAC1B,KAAK,6BAAqB,CAAC;YAC3B,KAAK,2BAAmB;gBACtB,uBAAuB,GAAG,IAAI,CAAC;gBAC/B,MAAM;SACT;KACF;IAED,OAAO,uBAAuB,CAAC;AACjC,CAAC;AAhBD,0DAgBC"}
+{"version":3,"file":"date.logical.js","sourceRoot":"","sources":["../../../../../../packages/date/src/lib/date/date.logical.ts"],"names":[],"mappings":";;;AAAA,wCAAmH;AACnH,uCAAwE;AAE3D,QAAA,sBAAsB,GAAG,aAAa,CAAC;AAGvC,QAAA,oBAAoB,GAAG,WAAW,CAAC;AAGnC,QAAA,qBAAqB,GAAG,iBAAiB,CAAC;AAG1C,QAAA,mBAAmB,GAAG,eAAe,CAAC;AAUnD,SAAgB,gCAAgC,CAAC,qBAA4C;IAC3F,IAAI,KAA8B,CAAC;IAEnC,QAAQ,qBAAqB,CAAC,iBAAiB,EAAE,EAAE;QACjD,KAAK,qBAAc;YACjB,KAAK,GAAG,IAAA,0BAAmB,GAAE,CAAC;YAC9B,MAAM;QACR,KAAK,8BAAsB;YACzB,KAAK,GAAG,qBAAU,CAAC;YACnB,MAAM;QACR,KAAK,4BAAoB;YACvB,KAAK,GAAG,mBAAQ,CAAC;YACjB,MAAM;QACR,KAAK,6BAAqB;YACxB,KAAK,GAAG,sBAAW,CAAC;YACpB,MAAM;QACR,KAAK,2BAAmB;YACtB,KAAK,GAAG,oBAAS,CAAC;YAClB,MAAM;QACR;YACE,MAAM,IAAI,KAAK,CAAC,gCAAgC,qBAAqB,GAAG,CAAC,CAAC;KAC7E;IAED,OAAO,CAAC,MAAY,IAAI,IAAI,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAChD,CAAC;AAxBD,4EAwBC;AASD,SAAgB,mBAAmB,CAAC,WAA+B,EAAE,MAAY,IAAI,IAAI,EAAE;IACzF,IAAI,MAAM,CAAC;IAEX,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;QACnC,MAAM,GAAG,gCAAgC,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC;KAC7D;SAAM;QACL,MAAM,GAAG,WAAW,CAAC;KACtB;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAVD,kDAUC;AAED,SAAgB,uBAAuB,CAAC,WAAwC;IAC9E,IAAI,uBAAuB,GAAG,KAAK,CAAC;IAEpC,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;QACnC,QAAQ,WAAW,CAAC,iBAAiB,EAAE,EAAE;YACvC,KAAK,qBAAc,CAAC;YACpB,KAAK,8BAAsB,CAAC;YAC5B,KAAK,4BAAoB,CAAC;YAC1B,KAAK,6BAAqB,CAAC;YAC3B,KAAK,2BAAmB;gBACtB,uBAAuB,GAAG,IAAI,CAAC;gBAC/B,MAAM;SACT;KACF;IAED,OAAO,uBAAuB,CAAC;AACjC,CAAC;AAhBD,0DAgBC"}

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

@@ -0,0 +1,38 @@
+import { FactoryWithRequiredInput, IndexNumber, Maybe, Milliseconds } from '@dereekb/util';
+import { Observable, SchedulerLike } from 'rxjs';
+import { LogicalDateStringCode } from './date.logical';
+export interface DateIntervalConfig {
+    /**
+     * How often to emit the date.
+     *
+     * Defaults to every second.
+     */
+    readonly period?: Maybe<Milliseconds>;
+    /**
+     * Emits the given logical each interval.
+     */
+    readonly logicalDate?: Maybe<LogicalDateStringCode>;
+    /**
+     * Factory to use for the date.
+     */
+    readonly factory?: FactoryWithRequiredInput<Date, IndexNumber>;
+    /**
+     * Whether or not to only emit each value and not only when the date has changed. False by default.
+     */
+    readonly emitAll?: boolean;
+    /**
+     * Scheduler for the rxjs interval.
+     */
+    readonly scheduler?: SchedulerLike | undefined;
+}
+/**
+ * Creates an Observable that emits a date given the configuration.
+ */
+export declare function dateInterval(config: DateIntervalConfig): Observable<Date>;
+/**
+ * Convenience function for dateInterval that returns the "now" logicalDate with an optional custom period.
+ *
+ * @param period
+ * @returns
+ */
+export declare function nowInterval(period?: Maybe<Milliseconds>): Observable<Date>;

package/src/lib/date/date.rxjs.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nowInterval = exports.dateInterval = void 0;
+const util_1 = require("@dereekb/util");
+const rxjs_1 = require("rxjs");
+const date_1 = require("./date");
+const date_logical_1 = require("./date.logical");
+/**
+ * Creates an Observable that emits a date given the configuration.
+ */
+function dateInterval(config) {
+    const { period, logicalDate: inputLogicalDate, factory: inputFactory, emitAll, scheduler } = config;
+    let logicalDate = inputLogicalDate;
+    if (!logicalDate && !inputFactory) {
+        logicalDate = 'now';
+    }
+    const intervalPeriod = period !== null && period !== void 0 ? period : util_1.MS_IN_SECOND;
+    const factory = inputFactory ? inputFactory : (0, util_1.protectedFactory)((0, date_logical_1.logicalDateStringCodeDateFactory)(logicalDate));
+    let obs = (0, rxjs_1.interval)(intervalPeriod, scheduler).pipe((0, rxjs_1.startWith)(-1), (0, rxjs_1.map)(factory));
+    if (emitAll !== true) {
+        obs = obs.pipe((0, rxjs_1.distinctUntilChanged)(date_1.isSameDate));
+    }
+    return obs;
+}
+exports.dateInterval = dateInterval;
+/**
+ * Convenience function for dateInterval that returns the "now" logicalDate with an optional custom period.
+ *
+ * @param period
+ * @returns
+ */
+function nowInterval(period) {
+    return dateInterval({
+        period,
+        logicalDate: 'now',
+        emitAll: true // no need to filter on emitting since now will be different each time
+    });
+}
+exports.nowInterval = nowInterval;
+//# sourceMappingURL=date.rxjs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"date.rxjs.js","sourceRoot":"","sources":["../../../../../../packages/date/src/lib/date/date.rxjs.ts"],"names":[],"mappings":";;;AAAA,wCAA2H;AAC3H,+BAAiG;AACjG,iCAAoC;AACpC,iDAAyF;AA2BzF;;GAEG;AACH,SAAgB,YAAY,CAAC,MAA0B;IACrD,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;IACpG,IAAI,WAAW,GAAiC,gBAAgB,CAAC;IAEjE,IAAI,CAAC,WAAW,IAAI,CAAC,YAAY,EAAE;QACjC,WAAW,GAAG,KAAK,CAAC;KACrB;IAED,MAAM,cAAc,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,mBAAY,CAAC;IAC9C,MAAM,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAA,uBAAgB,EAAC,IAAA,+CAAgC,EAAC,WAAoC,CAAC,CAAC,CAAC;IACvI,IAAI,GAAG,GAAG,IAAA,eAAQ,EAAC,cAAc,EAAE,SAAS,CAAC,CAAC,IAAI,CAAC,IAAA,gBAAS,EAAC,CAAC,CAAC,CAAC,EAAE,IAAA,UAAG,EAAC,OAAO,CAAC,CAAC,CAAC;IAEhF,IAAI,OAAO,KAAK,IAAI,EAAE;QACpB,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,IAAA,2BAAoB,EAAO,iBAAU,CAAC,CAAC,CAAC;KACxD;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAjBD,oCAiBC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,MAA4B;IACtD,OAAO,YAAY,CAAC;QAClB,MAAM;QACN,WAAW,EAAE,KAAK;QAClB,OAAO,EAAE,IAAI,CAAC,sEAAsE;KACrF,CAAC,CAAC;AACL,CAAC;AAND,kCAMC"}

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

@@ -19,6 +19,7 @@ export * from './date.range';
 export * from './date.range.string';
 export * from './date.range.timezone';
 export * from './date.round';
+export * from './date.rxjs';
 export * from './date.schedule';
 export * from './date.sort';
 export * from './date.time.limit';

package/src/lib/date/index.js

@@ -22,6 +22,7 @@ tslib_1.__exportStar(require("./date.range"), exports);
 tslib_1.__exportStar(require("./date.range.string"), exports);
 tslib_1.__exportStar(require("./date.range.timezone"), exports);
 tslib_1.__exportStar(require("./date.round"), exports);
+tslib_1.__exportStar(require("./date.rxjs"), exports);
 tslib_1.__exportStar(require("./date.schedule"), exports);
 tslib_1.__exportStar(require("./date.sort"), exports);
 tslib_1.__exportStar(require("./date.time.limit"), exports);

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,2DAAiC;AACjC,4DAAkC;AAClC,8DAAoC;AACpC,6DAAmC;AACnC,4DAAkC;AAClC,+DAAqC;AACrC,mEAAyC;AACzC,sDAA4B;AAC5B,gEAAsC;AACtC,2DAAiC;AACjC,0DAAgC;AAChC,0DAAgC;AAChC,wDAA8B;AAC9B,wDAA8B;AAC9B,yDAA+B;AAC/B,yDAA+B;AAC/B,uDAA6B;AAC7B,8DAAoC;AACpC,gEAAsC;AACtC,uDAA6B;AAC7B,0DAAgC;AAChC,sDAA4B;AAC5B,4DAAkC;AAClC,6DAAmC;AACnC,sDAA4B;AAC5B,0DAAgC;AAChC,iDAAuB;AACvB,sDAA4B;AAC5B,sDAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/date/src/lib/date/index.ts"],"names":[],"mappings":";;;AAAA,uDAA6B;AAC7B,2DAAiC;AACjC,4DAAkC;AAClC,8DAAoC;AACpC,6DAAmC;AACnC,4DAAkC;AAClC,+DAAqC;AACrC,mEAAyC;AACzC,sDAA4B;AAC5B,gEAAsC;AACtC,2DAAiC;AACjC,0DAAgC;AAChC,0DAAgC;AAChC,wDAA8B;AAC9B,wDAA8B;AAC9B,yDAA+B;AAC/B,yDAA+B;AAC/B,uDAA6B;AAC7B,8DAAoC;AACpC,gEAAsC;AACtC,uDAA6B;AAC7B,sDAA4B;AAC5B,0DAAgC;AAChC,sDAA4B;AAC5B,4DAAkC;AAClC,6DAAmC;AACnC,sDAA4B;AAC5B,0DAAgC;AAChC,iDAAuB;AACvB,sDAA4B;AAC5B,sDAA4B"}