date-vir 0.2.6 → 0.3.0

package/dist/cjs/{full-date → date-operations}/calculate-relative-date.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.calculateRelativeDate = void 0;
-const luxon_date_time_conversion_1 = require("./luxon-date-time-conversion");
+const luxon_date_time_conversion_1 = require("../full-date/luxon-date-time-conversion");
 function calculateRelativeDate(fullDate, relativeCalculation) {
     return (0, luxon_date_time_conversion_1.parseLuxonDateTime)((0, luxon_date_time_conversion_1.toLuxonDateTime)(fullDate).plus(relativeCalculation));
 }

package/dist/cjs/{full-date → date-operations}/combine-dates.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.combineDateParts = void 0;
 const object_shape_tester_1 = require("object-shape-tester");
-const full_date_shape_1 = require("./full-date-shape");
+const full_date_shape_1 = require("../full-date/full-date-shape");
 function combineDateParts(maybeDateParts) {
     const timePart = (0, object_shape_tester_1.isValidShape)(maybeDateParts.time, full_date_shape_1.timePartShape, {
         allowExtraKeys: true,

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

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.diffDates = 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();
+    return diff;
+}
+exports.diffDates = diffDates;

package/dist/cjs/index.js

@@ -14,8 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./full-date/calculate-relative-date"), exports);
-__exportStar(require("./full-date/combine-dates"), exports);
+__exportStar(require("./date-operations/calculate-relative-date"), exports);
+__exportStar(require("./date-operations/combine-dates"), exports);
 __exportStar(require("./full-date/create-full-date"), exports);
 __exportStar(require("./full-date/date-like"), exports);
 __exportStar(require("./full-date/format-presets"), exports);

package/dist/cjs/relative-time-duration.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/esm/date-operations/calculate-relative-date.d.ts

@@ -0,0 +1,3 @@
+import { FullDate } from '../full-date/full-date-shape';
+import { RelativeTimeDuration } from '../relative-time-duration';
+export declare function calculateRelativeDate(fullDate: FullDate, relativeCalculation: RelativeTimeDuration): FullDate;

package/dist/esm/{full-date → date-operations}/calculate-relative-date.js

@@ -1,4 +1,4 @@
-import { parseLuxonDateTime, toLuxonDateTime } from './luxon-date-time-conversion';
+import { parseLuxonDateTime, toLuxonDateTime } from '../full-date/luxon-date-time-conversion';
 export function calculateRelativeDate(fullDate, relativeCalculation) {
     return parseLuxonDateTime(toLuxonDateTime(fullDate).plus(relativeCalculation));
 }

package/dist/esm/{full-date → date-operations}/combine-dates.d.ts

@@ -1,4 +1,4 @@
-import { DatePart, FullDate, FullDatePartEnum, TimePart } from './full-date-shape';
+import { DatePart, FullDate, FullDatePartEnum, TimePart } from '../full-date/full-date-shape';
 type MaybeDateParts = Partial<{
     [FullDatePartEnum.Date]: DatePart | undefined | Partial<FullDate>;
     [FullDatePartEnum.Time]: TimePart | undefined | Partial<FullDate>;

package/dist/esm/{full-date → date-operations}/combine-dates.js

@@ -1,5 +1,5 @@
 import { isValidShape } from 'object-shape-tester';
-import { FullDatePartEnum, datePartShape, timePartShape, } from './full-date-shape';
+import { FullDatePartEnum, datePartShape, timePartShape, } from '../full-date/full-date-shape';
 export function combineDateParts(maybeDateParts) {
     const timePart = isValidShape(maybeDateParts.time, timePartShape, {
         allowExtraKeys: true,

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

@@ -0,0 +1,15 @@
+import { AtLeastTuple, RequiredAndNotNull } from '@augment-vir/common';
+import { FullDate } from '../full-date/full-date-shape';
+import { RelativeTimeDuration } from '../relative-time-duration';
+export type MaybeTuple<T> = T | AtLeastTuple<T, 1>;
+/**
+ * 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 type DiffUnit = Exclude<keyof RelativeTimeDuration, 'months' | 'years' | 'quarters'>;
+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 declare function diffDates<const DurationKeys extends MaybeTuple<DiffUnit> = MaybeTuple<DiffUnit>>(fullDateA: FullDate, fullDateB: FullDate, unit: DurationKeys): DiffDuration<DurationKeys>;

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

@@ -0,0 +1,9 @@
+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();
+    return diff;
+}

package/dist/esm/index.d.ts

@@ -1,5 +1,5 @@
-export * from './full-date/calculate-relative-date';
-export * from './full-date/combine-dates';
+export * from './date-operations/calculate-relative-date';
+export * from './date-operations/combine-dates';
 export * from './full-date/create-full-date';
 export * from './full-date/date-like';
 export * from './full-date/format-presets';

package/dist/esm/index.js

@@ -1,5 +1,5 @@
-export * from './full-date/calculate-relative-date';
-export * from './full-date/combine-dates';
+export * from './date-operations/calculate-relative-date';
+export * from './date-operations/combine-dates';
 export * from './full-date/create-full-date';
 export * from './full-date/date-like';
 export * from './full-date/format-presets';

package/dist/esm/relative-time-duration.d.ts

@@ -0,0 +1,2 @@
+import { DurationObjectUnits } from 'luxon';
+export type RelativeTimeDuration = DurationObjectUnits;

package/dist/esm/relative-time-duration.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "date-vir",
-    "version": "0.2.6",
+    "version": "0.3.0",
     "description": "Easy and explicit dates and times",
     "keywords": [
         "date",
@@ -40,25 +40,26 @@
         "test:watch": "web-test-runner --watch --color --config configs/web-test-runner.config.mjs"
     },
     "dependencies": {
-        "@augment-vir/common": "^14.2.2",
+        "@augment-vir/common": "^15.0.0",
         "@types/luxon": "^3.3.0",
         "luxon": "^3.3.0",
         "object-shape-tester": "^0.3.0",
-        "type-fest": "^3.11.1"
+        "type-fest": "^3.12.0"
     },
     "devDependencies": {
-        "@augment-vir/browser-testing": "^14.2.2",
-        "@open-wc/testing": "^3.1.8",
+        "@augment-vir/browser": "^15.0.0",
+        "@augment-vir/browser-testing": "^15.0.0",
+        "@open-wc/testing": "^3.2.0",
         "@types/chai": "^4.3.5",
         "@types/mocha": "^10.0.1",
         "@web/dev-server-esbuild": "^0.4.1",
         "@web/test-runner": "^0.16.1",
         "@web/test-runner-commands": "^0.7.0",
-        "@web/test-runner-playwright": "^0.10.0",
+        "@web/test-runner-playwright": "^0.10.1",
         "@web/test-runner-visual-regression": "^0.8.0",
         "cspell": "^6.31.1",
         "element-vir": "^13.0.4",
-        "esbuild": "^0.17.19",
+        "esbuild": "^0.18.3",
         "istanbul-smart-text-reporter": "^1.1.2",
         "markdown-code-example-inserter": "^0.3.1",
         "npm-check-updates": "^16.10.12",
@@ -71,6 +72,6 @@
         "prettier-plugin-sort-json": "^1.0.0",
         "prettier-plugin-toml": "^0.3.1",
         "typescript": "~5.0.4",
-        "virmator": "^6.6.2"
+        "virmator": "^6.6.4"
     }
 }

package/dist/esm/full-date/calculate-relative-date.d.ts

@@ -1,4 +0,0 @@
-import { DurationLikeObject } from 'luxon';
-import { FullDate } from './full-date-shape';
-export type RelativeDuration = DurationLikeObject;
-export declare function calculateRelativeDate(fullDate: FullDate, relativeCalculation: RelativeDuration): FullDate;