date-vir 4.0.2 → 4.1.1

package/dist/cjs/formatting/relative-string.js

@@ -4,6 +4,17 @@ exports.toRelativeString = void 0;
 const common_1 = require("@augment-vir/common");
 const diff_dates_1 = require("../date-operations/diff-dates");
 const duration_1 = require("../duration");
+const maxDurations = {
+    [duration_1.DurationUnit.Milliseconds]: 1000,
+    [duration_1.DurationUnit.Seconds]: 60,
+    [duration_1.DurationUnit.Minutes]: 60,
+    [duration_1.DurationUnit.Hours]: 24,
+    [duration_1.DurationUnit.Days]: 30,
+    [duration_1.DurationUnit.Weeks]: 4,
+    [duration_1.DurationUnit.Months]: 12,
+    [duration_1.DurationUnit.Quarters]: 4,
+    [duration_1.DurationUnit.Years]: Infinity,
+};
 function toRelativeString({ fullDate, relativeTo, options = {}, }) {
     const roundingDigits = options.decimalDigitCount || 0;
     const allUnitDiffs = (0, diff_dates_1.diffDatesAllUnits)({
@@ -11,8 +22,12 @@ function toRelativeString({ fullDate, relativeTo, options = {}, }) {
         end: relativeTo,
     });
     const unitsWithinBounds = (0, common_1.mapObjectValues)(allUnitDiffs, (durationUnit, duration) => {
-        const isAboveZero = Math.floor(Math.abs((0, common_1.round)({ digits: 1, number: duration }))) > 0;
-        return isAboveZero;
+        const roundedDuration = Math.floor(Math.abs((0, common_1.round)({ digits: 1, number: duration })));
+        const isAboveZero = roundedDuration > 0;
+        const isBelowMax = options.limitUnitMax
+            ? roundedDuration < maxDurations[durationUnit]
+            : true;
+        return isAboveZero && isBelowMax;
     });
     const unitToUse = duration_1.orderedDurationUnits.reduce((chosenUnit, currentUnit) => {
         const isUnitAllowed = !options.blockedRelativeUnits?.includes(currentUnit);

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

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getNowFullDate = exports.toNewTimezone = exports.createFullDate = exports.createUtcFullDate = exports.createFullDateInUserTimezone = void 0;
-const common_1 = require("@augment-vir/common");
 const luxon_1 = require("luxon");
+const run_time_assertions_1 = require("run-time-assertions");
 const timezones_1 = require("../timezone/timezones");
 const is_valid_full_date_1 = require("./is-valid-full-date");
 const luxon_date_time_conversion_1 = require("./luxon-date-time-conversion");
@@ -58,10 +58,10 @@ function convertDateLikeToLuxonDateTime(dateLike, timezone) {
     if (luxon_1.DateTime.isDateTime(dateLike)) {
         return dateLike.setZone(timezone);
     }
-    else if ((0, common_1.isRuntimeTypeOf)(dateLike, 'number')) {
+    else if ((0, run_time_assertions_1.isRunTimeType)(dateLike, 'number')) {
         return luxon_1.DateTime.fromMillis(dateLike, { zone: timezones_1.utcTimezone }).setZone(timezone);
     }
-    else if ((0, common_1.isRuntimeTypeOf)(dateLike, 'string')) {
+    else if ((0, run_time_assertions_1.isRunTimeType)(dateLike, 'string')) {
         const dateTime = luxon_1.DateTime.fromISO(dateLike, { zone: timezone });
         if (!dateTime.isValid) {
             return lastDitchConversion(dateLike);

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

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseInputElementValue = exports.parseStrangeString = void 0;
-const common_1 = require("@augment-vir/common");
 const luxon_1 = require("luxon");
+const run_time_assertions_1 = require("run-time-assertions");
 const create_full_date_1 = require("./create-full-date");
 const luxon_date_time_conversion_1 = require("./luxon-date-time-conversion");
 /**
@@ -35,7 +35,7 @@ function parseInputElementValue(elementOrValue, timezone) {
     if (!elementOrValue) {
         return undefined;
     }
-    const value = (0, common_1.isRuntimeTypeOf)(elementOrValue, 'string')
+    const value = (0, run_time_assertions_1.isRunTimeType)(elementOrValue, 'string')
         ? elementOrValue
         : elementOrValue.value;
     try {

package/dist/esm/formatting/relative-string.d.ts

@@ -17,6 +17,12 @@ export type RelativeStringOptions = {
     decimalDigitCount: number;
     /** Set this to true to block the 'just now' relative string. By default, that string is allowed. */
     blockJustNow: true;
+    /**
+     * Set to true to limit durations to their max value. Each unit's max value is its value when it
+     * turns into the subsequent unit. For example, seconds maxes out at 60, at which point it
+     * becomes a minute.
+     */
+    limitUnitMax: true;
 };
 export declare function toRelativeString({ fullDate, relativeTo, options, }: {
     fullDate: Readonly<FullDate>;

package/dist/esm/formatting/relative-string.js

@@ -1,6 +1,17 @@
 import { areJsonEqual, mapObjectValues, round } from '@augment-vir/common';
 import { diffDatesAllUnits } from '../date-operations/diff-dates';
 import { DurationUnit, orderedDurationUnits, singularDurationUnitNames } from '../duration';
+const maxDurations = {
+    [DurationUnit.Milliseconds]: 1000,
+    [DurationUnit.Seconds]: 60,
+    [DurationUnit.Minutes]: 60,
+    [DurationUnit.Hours]: 24,
+    [DurationUnit.Days]: 30,
+    [DurationUnit.Weeks]: 4,
+    [DurationUnit.Months]: 12,
+    [DurationUnit.Quarters]: 4,
+    [DurationUnit.Years]: Infinity,
+};
 export function toRelativeString({ fullDate, relativeTo, options = {}, }) {
     const roundingDigits = options.decimalDigitCount || 0;
     const allUnitDiffs = diffDatesAllUnits({
@@ -8,8 +19,12 @@ export function toRelativeString({ fullDate, relativeTo, options = {}, }) {
         end: relativeTo,
     });
     const unitsWithinBounds = mapObjectValues(allUnitDiffs, (durationUnit, duration) => {
-        const isAboveZero = Math.floor(Math.abs(round({ digits: 1, number: duration }))) > 0;
-        return isAboveZero;
+        const roundedDuration = Math.floor(Math.abs(round({ digits: 1, number: duration })));
+        const isAboveZero = roundedDuration > 0;
+        const isBelowMax = options.limitUnitMax
+            ? roundedDuration < maxDurations[durationUnit]
+            : true;
+        return isAboveZero && isBelowMax;
     });
     const unitToUse = orderedDurationUnits.reduce((chosenUnit, currentUnit) => {
         const isUnitAllowed = !options.blockedRelativeUnits?.includes(currentUnit);

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

@@ -1,5 +1,5 @@
-import { isRuntimeTypeOf } from '@augment-vir/common';
 import { DateTime } from 'luxon';
+import { isRunTimeType } from 'run-time-assertions';
 import { userTimezone, utcTimezone } from '../timezone/timezones';
 import { isValidFullDate } from './is-valid-full-date';
 import { parseLuxonDateTime, toLuxonDateTime } from './luxon-date-time-conversion';
@@ -51,10 +51,10 @@ function convertDateLikeToLuxonDateTime(dateLike, timezone) {
     if (DateTime.isDateTime(dateLike)) {
         return dateLike.setZone(timezone);
     }
-    else if (isRuntimeTypeOf(dateLike, 'number')) {
+    else if (isRunTimeType(dateLike, 'number')) {
         return DateTime.fromMillis(dateLike, { zone: utcTimezone }).setZone(timezone);
     }
-    else if (isRuntimeTypeOf(dateLike, 'string')) {
+    else if (isRunTimeType(dateLike, 'string')) {
         const dateTime = DateTime.fromISO(dateLike, { zone: timezone });
         if (!dateTime.isValid) {
             return lastDitchConversion(dateLike);

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

@@ -1,5 +1,5 @@
-import { isRuntimeTypeOf } from '@augment-vir/common';
 import { DateTime } from 'luxon';
+import { isRunTimeType } from 'run-time-assertions';
 import { createFullDate } from './create-full-date';
 import { parseLuxonDateTime } from './luxon-date-time-conversion';
 /**
@@ -31,7 +31,7 @@ export function parseInputElementValue(elementOrValue, timezone) {
     if (!elementOrValue) {
         return undefined;
     }
-    const value = isRuntimeTypeOf(elementOrValue, 'string')
+    const value = isRunTimeType(elementOrValue, 'string')
         ? elementOrValue
         : elementOrValue.value;
     try {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "date-vir",
-    "version": "4.0.2",
+    "version": "4.1.1",
     "description": "Easy and explicit dates and times",
     "keywords": [
         "date",
@@ -41,45 +41,45 @@
         "test:watch": "web-test-runner --watch --color --config configs/web-test-runner.config.mjs"
     },
     "dependencies": {
-        "@augment-vir/common": "^21.6.0",
+        "@augment-vir/common": "^22.0.0",
         "@types/luxon": "^3.3.4",
         "luxon": "^3.4.4",
-        "object-shape-tester": "^1.0.1",
-        "type-fest": "^4.7.1"
+        "object-shape-tester": "^1.0.2",
+        "type-fest": "^4.8.1"
     },
     "devDependencies": {
-        "@augment-vir/browser": "^21.6.0",
-        "@augment-vir/browser-testing": "^21.6.0",
+        "@augment-vir/browser": "^22.0.0",
+        "@augment-vir/browser-testing": "^22.0.0",
         "@open-wc/testing": "^4.0.0",
         "@types/chai": "^4.3.10",
         "@types/mocha": "^10.0.4",
-        "@web/dev-server-esbuild": "^1.0.0",
+        "@web/dev-server-esbuild": "^1.0.1",
         "@web/test-runner": "^0.18.0",
         "@web/test-runner-commands": "^0.9.0",
         "@web/test-runner-playwright": "^0.11.0",
         "@web/test-runner-visual-regression": "^0.9.0",
         "cspell": "^8.0.0",
         "dependency-cruiser": "^15.3.0",
-        "element-vir": "^16.5.2",
-        "esbuild": "^0.19.5",
-        "istanbul-smart-text-reporter": "^1.1.2",
-        "markdown-code-example-inserter": "^0.3.2",
+        "element-vir": "^17.0.0",
+        "esbuild": "^0.19.6",
+        "istanbul-smart-text-reporter": "^1.1.3",
+        "markdown-code-example-inserter": "^0.3.3",
         "npm-check-updates": "~16.12.3",
         "prettier": "^3.1.0",
-        "prettier-plugin-interpolated-html-tags": "^1.0.2",
+        "prettier-plugin-interpolated-html-tags": "^1.0.3",
         "prettier-plugin-jsdoc": "^1.1.1",
-        "prettier-plugin-multiline-arrays": "^3.0.0",
+        "prettier-plugin-multiline-arrays": "^3.0.1",
         "prettier-plugin-organize-imports": "^3.2.4",
         "prettier-plugin-packagejson": "^2.4.6",
         "prettier-plugin-sort-json": "^3.1.0",
         "prettier-plugin-toml": "^1.0.0",
-        "run-time-assertions": "^0.1.3",
+        "run-time-assertions": "^0.2.1",
         "typedoc": "^0.25.3",
         "typescript": "^5.2.2",
-        "virmator": "^11.1.0"
+        "virmator": "^11.1.2"
     },
     "overrides": {
         "@open-wc/scoped-elements": "2.2.3",
-        "@open-wc/testing-helpers": "2.3.1"
+        "@open-wc/testing-helpers": "2.3.0"
     }
 }