date-vir 0.9.0 → 1.1.0

package/dist/cjs/date-operations/diff-dates.js

@@ -1,13 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.diffDates = void 0;
+exports.isDateAfter = exports.diffDates = exports.DiffUnit = void 0;
 const luxon_date_time_conversion_1 = require("../full-date/luxon-date-time-conversion");
-const primitive_conversions_1 = require("../full-date/primitive-conversions");
-function diffDates(fullDateA, fullDateB, unit) {
-    const isALater = (0, primitive_conversions_1.toTimestamp)(fullDateA) > (0, primitive_conversions_1.toTimestamp)(fullDateB);
-    const luxonDateA = (0, luxon_date_time_conversion_1.toLuxonDateTime)(isALater ? fullDateA : fullDateB);
-    const luxonDateB = (0, luxon_date_time_conversion_1.toLuxonDateTime)(isALater ? fullDateB : fullDateA);
-    const diff = luxonDateA.diff(luxonDateB, unit).toObject();
+/**
+ * Exclude the higher order units of time measure for diffing because they vary significantly,
+ * causing inaccuracies and many issues. See
+ * https://moment.github.io/luxon/#/math?id=casual-vs-longterm-conversion-accuracy for more info.
+ *
+ * If you REALLY want to use these higher order units, convert the dates to luxon objects with
+ * toLuxonDateTime and then run diff calculations there.
+ */
+var DiffUnit;
+(function (DiffUnit) {
+    DiffUnit["Weeks"] = "weeks";
+    DiffUnit["Days"] = "days";
+    DiffUnit["Hours"] = "hours";
+    DiffUnit["Minutes"] = "minutes";
+    DiffUnit["Seconds"] = "seconds";
+    DiffUnit["Milliseconds"] = "milliseconds";
+})(DiffUnit || (exports.DiffUnit = DiffUnit = {}));
+function diffDates({ start, end, unit, }) {
+    const luxonDateStart = (0, luxon_date_time_conversion_1.toLuxonDateTime)(start);
+    const luxonDateEnd = (0, luxon_date_time_conversion_1.toLuxonDateTime)(end);
+    const diff = luxonDateEnd.diff(luxonDateStart, unit).toObject();
     return diff;
 }
 exports.diffDates = diffDates;
+function isDateAfter({ start, end }) {
+    return diffDates({ start, end, unit: DiffUnit.Milliseconds }).milliseconds >= 0;
+}
+exports.isDateAfter = isDateAfter;

package/dist/cjs/{full-date → extra-utils}/js-date-conversion.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toJsDate = void 0;
-const primitive_conversions_1 = require("./primitive-conversions");
+const primitive_conversions_1 = require("../full-date/primitive-conversions");
 function toJsDate(fullDate) {
     return new Date((0, primitive_conversions_1.toTimestamp)(fullDate));
 }

package/dist/cjs/extra-utils/{now-in-iso-string.js → now.js}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getNowInIsoString = void 0;
+exports.getNowInUserTimezone = exports.getNowInIsoString = void 0;
 const create_full_date_1 = require("../full-date/create-full-date");
 const primitive_conversions_1 = require("../full-date/primitive-conversions");
 const timezones_1 = require("../timezone/timezones");
@@ -12,3 +12,7 @@ function getNowInIsoString() {
     return (0, primitive_conversions_1.toIsoString)((0, create_full_date_1.getNowFullDate)(timezones_1.utcTimezone));
 }
 exports.getNowInIsoString = getNowInIsoString;
+function getNowInUserTimezone() {
+    return (0, create_full_date_1.getNowFullDate)(timezones_1.userTimezone);
+}
+exports.getNowInUserTimezone = getNowInUserTimezone;

package/dist/cjs/extra-utils/zero.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearParts = exports.clearTime = exports.zeroTime = exports.zeroDate = void 0;
+const common_1 = require("@augment-vir/common");
+const full_date_shape_1 = require("../full-date/full-date-shape");
+const date_transforms_1 = require("./date-transforms");
+exports.zeroDate = {
+    year: 0,
+    month: 1,
+    day: 1,
+    hour: 0,
+    minute: 0,
+    second: 0,
+    millisecond: 0,
+};
+exports.zeroTime = (0, common_1.pickObjectKeys)(exports.zeroDate, full_date_shape_1.timeFullDateKeys);
+function clearTime(inputFullDate) {
+    return clearParts(inputFullDate, full_date_shape_1.timeFullDateKeys);
+}
+exports.clearTime = clearTime;
+function clearParts(inputFullDate, parts) {
+    const clearParts = (0, common_1.typedObjectFromEntries)(parts.map((keyName) => {
+        return [
+            keyName,
+            exports.zeroDate[keyName],
+        ];
+    }));
+    return (0, date_transforms_1.overrideDateParts)(inputFullDate, clearParts);
+}
+exports.clearParts = clearParts;

package/dist/cjs/full-date/full-date-shape.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fullDateShape = exports.datePartShape = exports.timePartShape = exports.FullDatePartEnum = void 0;
+exports.fullDateShape = exports.datePartShape = exports.timePartShape = exports.dateFullDateKeys = exports.timeFullDateKeys = exports.FullDatePartEnum = void 0;
 const object_shape_tester_1 = require("object-shape-tester");
 const timezones_1 = require("../timezone/timezones");
 /**
@@ -13,15 +13,26 @@ var FullDatePartEnum;
     FullDatePartEnum["Time"] = "time";
     FullDatePartEnum["DateTime"] = "datetime-local";
 })(FullDatePartEnum || (exports.FullDatePartEnum = FullDatePartEnum = {}));
+exports.timeFullDateKeys = [
+    'hour',
+    'minute',
+    'second',
+    'millisecond',
+];
+exports.dateFullDateKeys = [
+    'year',
+    'month',
+    'day',
+];
 exports.timePartShape = (0, object_shape_tester_1.defineShape)({
     /** Hour of the day in 24 time: 0-23 */
     hour: 14,
     /** Minute of the hour: 0-59 */
     minute: 19,
     /** Second of the minute: 0-59 */
-    second: 0,
+    second: 7,
     /** Millisecond of the second: 0-999 */
-    millisecond: 870,
+    millisecond: 877,
     /** The timezone that this date/time is meant for / originated from. */
     timezone: timezones_1.utcTimezone,
 });

package/dist/cjs/index.js

@@ -17,14 +17,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./date-operations/calculate-relative-date"), exports);
 __exportStar(require("./date-operations/combine-dates"), exports);
 __exportStar(require("./date-operations/diff-dates"), exports);
-__exportStar(require("./extra-utils/now-in-iso-string"), exports);
+__exportStar(require("./extra-utils/date-transforms"), exports);
+__exportStar(require("./extra-utils/js-date-conversion"), exports);
+__exportStar(require("./extra-utils/now"), exports);
+__exportStar(require("./extra-utils/zero"), exports);
 __exportStar(require("./full-date/create-full-date"), exports);
 __exportStar(require("./full-date/date-like"), exports);
-__exportStar(require("./full-date/date-transforms"), exports);
 __exportStar(require("./full-date/format-presets"), exports);
 __exportStar(require("./full-date/full-date-shape"), exports);
 __exportStar(require("./full-date/is-valid-full-date"), exports);
-__exportStar(require("./full-date/js-date-conversion"), exports);
 __exportStar(require("./full-date/luxon-date-time-conversion"), exports);
 __exportStar(require("./full-date/parsing"), exports);
 __exportStar(require("./full-date/primitive-conversions"), exports);

package/dist/esm/date-operations/diff-dates.d.ts

@@ -10,7 +10,22 @@ export type MaybeTuple<T> = T | AtLeastTuple<T, 1>;
  * If you REALLY want to use these higher order units, convert the dates to luxon objects with
  * toLuxonDateTime and then run diff calculations there.
  */
-export type DiffUnit = Exclude<keyof RelativeTimeDuration, 'months' | 'years' | 'quarters'>;
+export declare enum DiffUnit {
+    Weeks = "weeks",
+    Days = "days",
+    Hours = "hours",
+    Minutes = "minutes",
+    Seconds = "seconds",
+    Milliseconds = "milliseconds"
+}
 export type DiffDuration<DurationKeys extends MaybeTuple<DiffUnit>> = MaybeTuple<DiffUnit> extends DurationKeys ? Pick<RelativeTimeDuration, DiffUnit> : Pick<RequiredAndNotNull<RelativeTimeDuration>, DurationKeys extends AtLeastTuple<infer InnerValue, 1> ? InnerValue : DurationKeys>;
 export type Duration<DurationKeys extends MaybeTuple<DiffUnit>> = DiffDuration<DurationKeys>;
-export declare function diffDates<const DurationKeys extends MaybeTuple<DiffUnit> = MaybeTuple<DiffUnit>>(fullDateA: FullDate, fullDateB: FullDate, unit: DurationKeys): DiffDuration<DurationKeys>;
+export declare function diffDates<const DurationKeys extends MaybeTuple<DiffUnit> = MaybeTuple<DiffUnit>>({ start, end, unit, }: {
+    start: FullDate;
+    end: FullDate;
+    unit: DurationKeys;
+}): DiffDuration<DurationKeys>;
+export declare function isDateAfter({ start, end }: {
+    start: FullDate;
+    end: FullDate;
+}): boolean;

package/dist/esm/date-operations/diff-dates.js

@@ -1,9 +1,27 @@
 import { toLuxonDateTime } from '../full-date/luxon-date-time-conversion';
-import { toTimestamp } from '../full-date/primitive-conversions';
-export function diffDates(fullDateA, fullDateB, unit) {
-    const isALater = toTimestamp(fullDateA) > toTimestamp(fullDateB);
-    const luxonDateA = toLuxonDateTime(isALater ? fullDateA : fullDateB);
-    const luxonDateB = toLuxonDateTime(isALater ? fullDateB : fullDateA);
-    const diff = luxonDateA.diff(luxonDateB, unit).toObject();
+/**
+ * Exclude the higher order units of time measure for diffing because they vary significantly,
+ * causing inaccuracies and many issues. See
+ * https://moment.github.io/luxon/#/math?id=casual-vs-longterm-conversion-accuracy for more info.
+ *
+ * If you REALLY want to use these higher order units, convert the dates to luxon objects with
+ * toLuxonDateTime and then run diff calculations there.
+ */
+export var DiffUnit;
+(function (DiffUnit) {
+    DiffUnit["Weeks"] = "weeks";
+    DiffUnit["Days"] = "days";
+    DiffUnit["Hours"] = "hours";
+    DiffUnit["Minutes"] = "minutes";
+    DiffUnit["Seconds"] = "seconds";
+    DiffUnit["Milliseconds"] = "milliseconds";
+})(DiffUnit || (DiffUnit = {}));
+export function diffDates({ start, end, unit, }) {
+    const luxonDateStart = toLuxonDateTime(start);
+    const luxonDateEnd = toLuxonDateTime(end);
+    const diff = luxonDateEnd.diff(luxonDateStart, unit).toObject();
     return diff;
 }
+export function isDateAfter({ start, end }) {
+    return diffDates({ start, end, unit: DiffUnit.Milliseconds }).milliseconds >= 0;
+}

package/dist/esm/{full-date → extra-utils}/date-transforms.d.ts

@@ -1,3 +1,3 @@
-import { FullDate } from './full-date-shape';
+import { FullDate } from '../full-date/full-date-shape';
 /** Override the initial provided FullDate with all subsequent FullDate parts. */
 export declare function overrideDateParts(date: FullDate, ...overrides: Partial<FullDate>[]): FullDate;

package/dist/esm/{full-date → extra-utils}/js-date-conversion.d.ts

@@ -1,2 +1,2 @@
-import { FullDate } from './full-date-shape';
+import { FullDate } from '../full-date/full-date-shape';
 export declare function toJsDate(fullDate: FullDate): Date;

package/dist/esm/{full-date → extra-utils}/js-date-conversion.js

@@ -1,4 +1,4 @@
-import { toTimestamp } from './primitive-conversions';
+import { toTimestamp } from '../full-date/primitive-conversions';
 export function toJsDate(fullDate) {
     return new Date(toTimestamp(fullDate));
 }

package/dist/esm/extra-utils/{now-in-iso-string.d.ts → now.d.ts}

@@ -1,2 +1,4 @@
+import { FullDate } from '../full-date/full-date-shape';
 import { UtcIsoString } from '../full-date/string-format-types';
 export declare function getNowInIsoString(): UtcIsoString;
+export declare function getNowInUserTimezone(): FullDate;

package/dist/esm/extra-utils/{now-in-iso-string.js → now.js}

@@ -1,6 +1,6 @@
 import { getNowFullDate } from '../full-date/create-full-date';
 import { toIsoString } from '../full-date/primitive-conversions';
-import { utcTimezone } from '../timezone/timezones';
+import { userTimezone, utcTimezone } from '../timezone/timezones';
 export function getNowInIsoString() {
     /**
      * The time zone doesn't matter here because the ISO string will be identical for a given date
@@ -8,3 +8,6 @@ export function getNowInIsoString() {
      */
     return toIsoString(getNowFullDate(utcTimezone));
 }
+export function getNowInUserTimezone() {
+    return getNowFullDate(userTimezone);
+}

package/dist/esm/extra-utils/zero.d.ts

@@ -0,0 +1,21 @@
+import { FullDate } from '../full-date/full-date-shape';
+export declare const zeroDate: {
+    readonly year: 0;
+    readonly month: 1;
+    readonly day: 1;
+    readonly hour: 0;
+    readonly minute: 0;
+    readonly second: 0;
+    readonly millisecond: 0;
+};
+export declare const zeroTime: Pick<{
+    year: 0;
+    month: 1;
+    day: 1;
+    hour: 0;
+    minute: 0;
+    second: 0;
+    millisecond: 0;
+}, "hour" | "minute" | "second" | "millisecond">;
+export declare function clearTime(inputFullDate: Readonly<FullDate>): FullDate;
+export declare function clearParts(inputFullDate: Readonly<FullDate>, parts: ReadonlyArray<Exclude<keyof FullDate, 'timezone'>>): FullDate;

package/dist/esm/extra-utils/zero.js

@@ -0,0 +1,25 @@
+import { pickObjectKeys, typedObjectFromEntries } from '@augment-vir/common';
+import { timeFullDateKeys } from '../full-date/full-date-shape';
+import { overrideDateParts } from './date-transforms';
+export const zeroDate = {
+    year: 0,
+    month: 1,
+    day: 1,
+    hour: 0,
+    minute: 0,
+    second: 0,
+    millisecond: 0,
+};
+export const zeroTime = pickObjectKeys(zeroDate, timeFullDateKeys);
+export function clearTime(inputFullDate) {
+    return clearParts(inputFullDate, timeFullDateKeys);
+}
+export function clearParts(inputFullDate, parts) {
+    const clearParts = typedObjectFromEntries(parts.map((keyName) => {
+        return [
+            keyName,
+            zeroDate[keyName],
+        ];
+    }));
+    return overrideDateParts(inputFullDate, clearParts);
+}

package/dist/esm/full-date/full-date-shape.d.ts

@@ -1,4 +1,4 @@
-import { Overwrite, RequiredBy } from '@augment-vir/common';
+import { ArrayElement, Overwrite, RequiredBy } from '@augment-vir/common';
 import { Timezone } from '../timezone/timezone-names';
 /**
  * Represents various parts of a FullDate. Each value is also a valid "type" attribute for an
@@ -9,6 +9,10 @@ export declare enum FullDatePartEnum {
     Time = "time",
     DateTime = "datetime-local"
 }
+export declare const timeFullDateKeys: readonly ["hour", "minute", "second", "millisecond"];
+export type TimeFullDateKeys = ArrayElement<typeof timeFullDateKeys>;
+export declare const dateFullDateKeys: readonly ["year", "month", "day"];
+export type DateFullDateKeys = ArrayElement<typeof dateFullDateKeys>;
 export declare const timePartShape: import("object-shape-tester").ShapeDefinition<{
     /** Hour of the day in 24 time: 0-23 */
     hour: number;

package/dist/esm/full-date/full-date-shape.js

@@ -10,15 +10,26 @@ export var FullDatePartEnum;
     FullDatePartEnum["Time"] = "time";
     FullDatePartEnum["DateTime"] = "datetime-local";
 })(FullDatePartEnum || (FullDatePartEnum = {}));
+export const timeFullDateKeys = [
+    'hour',
+    'minute',
+    'second',
+    'millisecond',
+];
+export const dateFullDateKeys = [
+    'year',
+    'month',
+    'day',
+];
 export const timePartShape = defineShape({
     /** Hour of the day in 24 time: 0-23 */
     hour: 14,
     /** Minute of the hour: 0-59 */
     minute: 19,
     /** Second of the minute: 0-59 */
-    second: 0,
+    second: 7,
     /** Millisecond of the second: 0-999 */
-    millisecond: 870,
+    millisecond: 877,
     /** The timezone that this date/time is meant for / originated from. */
     timezone: utcTimezone,
 });

package/dist/esm/index.d.ts

@@ -1,14 +1,15 @@
 export * from './date-operations/calculate-relative-date';
 export * from './date-operations/combine-dates';
 export * from './date-operations/diff-dates';
-export * from './extra-utils/now-in-iso-string';
+export * from './extra-utils/date-transforms';
+export * from './extra-utils/js-date-conversion';
+export * from './extra-utils/now';
+export * from './extra-utils/zero';
 export * from './full-date/create-full-date';
 export * from './full-date/date-like';
-export * from './full-date/date-transforms';
 export * from './full-date/format-presets';
 export * from './full-date/full-date-shape';
 export * from './full-date/is-valid-full-date';
-export * from './full-date/js-date-conversion';
 export * from './full-date/luxon-date-time-conversion';
 export * from './full-date/parsing';
 export * from './full-date/primitive-conversions';

package/dist/esm/index.js

@@ -1,14 +1,15 @@
 export * from './date-operations/calculate-relative-date';
 export * from './date-operations/combine-dates';
 export * from './date-operations/diff-dates';
-export * from './extra-utils/now-in-iso-string';
+export * from './extra-utils/date-transforms';
+export * from './extra-utils/js-date-conversion';
+export * from './extra-utils/now';
+export * from './extra-utils/zero';
 export * from './full-date/create-full-date';
 export * from './full-date/date-like';
-export * from './full-date/date-transforms';
 export * from './full-date/format-presets';
 export * from './full-date/full-date-shape';
 export * from './full-date/is-valid-full-date';
-export * from './full-date/js-date-conversion';
 export * from './full-date/luxon-date-time-conversion';
 export * from './full-date/parsing';
 export * from './full-date/primitive-conversions';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "date-vir",
-    "version": "0.9.0",
+    "version": "1.1.0",
     "description": "Easy and explicit dates and times",
     "keywords": [
         "date",
@@ -40,38 +40,39 @@
         "test:watch": "web-test-runner --watch --color --config configs/web-test-runner.config.mjs"
     },
     "dependencies": {
-        "@augment-vir/common": "^16.3.0",
-        "@types/luxon": "^3.3.1",
-        "luxon": "^3.4.0",
-        "object-shape-tester": "^0.4.2",
-        "type-fest": "^4.2.0"
+        "@augment-vir/common": "^19.0.1",
+        "@types/luxon": "^3.3.2",
+        "luxon": "^3.4.3",
+        "object-shape-tester": "^0.4.3",
+        "type-fest": "^4.3.1"
     },
     "devDependencies": {
-        "@augment-vir/browser": "^16.3.0",
-        "@augment-vir/browser-testing": "^16.3.0",
+        "@augment-vir/browser": "^19.0.1",
+        "@augment-vir/browser-testing": "^19.0.1",
         "@open-wc/testing": "^3.2.0",
-        "@types/chai": "^4.3.5",
+        "@types/chai": "^4.3.6",
         "@types/mocha": "^10.0.1",
         "@web/dev-server-esbuild": "^0.4.1",
-        "@web/test-runner": "^0.17.0",
+        "@web/test-runner": "^0.17.1",
         "@web/test-runner-commands": "^0.8.0",
         "@web/test-runner-playwright": "^0.10.1",
         "@web/test-runner-visual-regression": "^0.8.2",
-        "cspell": "^7.0.0",
-        "element-vir": "^16.3.1",
-        "esbuild": "^0.19.1",
+        "cspell": "^7.3.6",
+        "element-vir": "^16.4.0",
+        "esbuild": "^0.19.3",
         "istanbul-smart-text-reporter": "^1.1.2",
         "markdown-code-example-inserter": "^0.3.1",
-        "npm-check-updates": "^16.10.18",
+        "npm-check-updates": "~16.12.3",
         "prettier": "^2.8.8",
         "prettier-plugin-interpolated-html-tags": "^0.0.4",
         "prettier-plugin-jsdoc": "^0.4.2",
         "prettier-plugin-multiline-arrays": "^2.0.0",
         "prettier-plugin-organize-imports": "^3.2.3",
         "prettier-plugin-packagejson": "^2.4.5",
-        "prettier-plugin-sort-json": "^1.0.0",
+        "prettier-plugin-sort-json": "^2.0.0",
         "prettier-plugin-toml": "^0.3.1",
-        "typescript": "^5.1.6",
-        "virmator": "^7.3.1"
+        "run-time-assertions": "^0.0.2",
+        "typescript": "^5.2.2",
+        "virmator": "^7.4.1"
     }
 }