date-vir 7.4.3 → 8.1.0

package/dist/date-operations/date-position.d.ts

@@ -89,25 +89,25 @@ export declare function getEndDate<const SpecificTimezone extends Timezone>(date
  */
 export declare const datePositionCalculationShape: import("object-shape-tester").Shape<import("object-shape-tester").Shape<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TObject<{
     get: import("@sinclair/typebox").TUnsafe<DateUnit.Month>;
-    in: import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<DateUnit.Year> | import("@sinclair/typebox").TUnsafe<DateUnit.Quarter>)[]>;
+    in: import("@sinclair/typebox").TUnion<import("@sinclair/typebox").TUnsafe<DateUnit.Year>[]>;
 }> | import("@sinclair/typebox").TObject<{
     get: import("@sinclair/typebox").TUnsafe<DateUnit.Week>;
-    in: import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<DateUnit.Month> | import("@sinclair/typebox").TUnsafe<DateUnit.Year> | import("@sinclair/typebox").TUnsafe<DateUnit.Quarter>)[]>;
+    in: import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<DateUnit.Month> | import("@sinclair/typebox").TUnsafe<DateUnit.Year>)[]>;
 }> | import("@sinclair/typebox").TObject<{
     get: import("@sinclair/typebox").TUnsafe<DateUnit.Day>;
-    in: import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<DateUnit.Month> | import("@sinclair/typebox").TUnsafe<DateUnit.Year> | import("@sinclair/typebox").TUnsafe<DateUnit.Quarter> | import("@sinclair/typebox").TUnsafe<DateUnit.Week>)[]>;
+    in: import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<DateUnit.Month> | import("@sinclair/typebox").TUnsafe<DateUnit.Year> | import("@sinclair/typebox").TUnsafe<DateUnit.Week>)[]>;
 }> | import("@sinclair/typebox").TObject<{
     get: import("@sinclair/typebox").TUnsafe<DateUnit.Hour>;
-    in: import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<DateUnit.Month> | import("@sinclair/typebox").TUnsafe<DateUnit.Year> | import("@sinclair/typebox").TUnsafe<DateUnit.Quarter> | import("@sinclair/typebox").TUnsafe<DateUnit.Week> | import("@sinclair/typebox").TUnsafe<DateUnit.Day>)[]>;
+    in: import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<DateUnit.Month> | import("@sinclair/typebox").TUnsafe<DateUnit.Year> | import("@sinclair/typebox").TUnsafe<DateUnit.Week> | import("@sinclair/typebox").TUnsafe<DateUnit.Day>)[]>;
 }> | import("@sinclair/typebox").TObject<{
     get: import("@sinclair/typebox").TUnsafe<DateUnit.Minute>;
-    in: import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<DateUnit.Month> | import("@sinclair/typebox").TUnsafe<DateUnit.Year> | import("@sinclair/typebox").TUnsafe<DateUnit.Quarter> | import("@sinclair/typebox").TUnsafe<DateUnit.Week> | import("@sinclair/typebox").TUnsafe<DateUnit.Day> | import("@sinclair/typebox").TUnsafe<DateUnit.Hour>)[]>;
+    in: import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<DateUnit.Month> | import("@sinclair/typebox").TUnsafe<DateUnit.Year> | import("@sinclair/typebox").TUnsafe<DateUnit.Week> | import("@sinclair/typebox").TUnsafe<DateUnit.Day> | import("@sinclair/typebox").TUnsafe<DateUnit.Hour>)[]>;
 }> | import("@sinclair/typebox").TObject<{
     get: import("@sinclair/typebox").TUnsafe<DateUnit.Second>;
-    in: import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<DateUnit.Month> | import("@sinclair/typebox").TUnsafe<DateUnit.Year> | import("@sinclair/typebox").TUnsafe<DateUnit.Quarter> | import("@sinclair/typebox").TUnsafe<DateUnit.Week> | import("@sinclair/typebox").TUnsafe<DateUnit.Day> | import("@sinclair/typebox").TUnsafe<DateUnit.Hour> | import("@sinclair/typebox").TUnsafe<DateUnit.Minute>)[]>;
+    in: import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<DateUnit.Month> | import("@sinclair/typebox").TUnsafe<DateUnit.Year> | import("@sinclair/typebox").TUnsafe<DateUnit.Week> | import("@sinclair/typebox").TUnsafe<DateUnit.Day> | import("@sinclair/typebox").TUnsafe<DateUnit.Hour> | import("@sinclair/typebox").TUnsafe<DateUnit.Minute>)[]>;
 }> | import("@sinclair/typebox").TObject<{
     get: import("@sinclair/typebox").TUnsafe<DateUnit.Millisecond>;
-    in: import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<DateUnit.Month> | import("@sinclair/typebox").TUnsafe<DateUnit.Year> | import("@sinclair/typebox").TUnsafe<DateUnit.Quarter> | import("@sinclair/typebox").TUnsafe<DateUnit.Week> | import("@sinclair/typebox").TUnsafe<DateUnit.Day> | import("@sinclair/typebox").TUnsafe<DateUnit.Hour> | import("@sinclair/typebox").TUnsafe<DateUnit.Minute> | import("@sinclair/typebox").TUnsafe<DateUnit.Second>)[]>;
+    in: import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<DateUnit.Month> | import("@sinclair/typebox").TUnsafe<DateUnit.Year> | import("@sinclair/typebox").TUnsafe<DateUnit.Week> | import("@sinclair/typebox").TUnsafe<DateUnit.Day> | import("@sinclair/typebox").TUnsafe<DateUnit.Hour> | import("@sinclair/typebox").TUnsafe<DateUnit.Minute> | import("@sinclair/typebox").TUnsafe<DateUnit.Second>)[]>;
 }>)[]>>>;
 /**
  * All valid date position calculations. Used for {@link calculateDatePosition}.

package/dist/date-operations/date-position.js

@@ -1,4 +1,4 @@
-import { check } from '@augment-vir/assert';
+import { assertWrap, check } from '@augment-vir/assert';
 import { stringify } from '@augment-vir/common';
 import { DateUnit, oneIndexedDateUnits } from '@date-vir/duration';
 import { checkValidShape, defineShape, exactShape, unionShape } from 'object-shape-tester';
@@ -128,25 +128,25 @@ export function getEndDate(date, unit) {
  */
 export const datePositionCalculationShape = defineShape(unionShape({
     get: exactShape(DateUnit.Month),
-    in: unionShape(exactShape(DateUnit.Year), exactShape(DateUnit.Quarter)),
+    in: unionShape(exactShape(DateUnit.Year)),
 }, {
     get: exactShape(DateUnit.Week),
-    in: unionShape(exactShape(DateUnit.Year), exactShape(DateUnit.Quarter), exactShape(DateUnit.Month)),
+    in: unionShape(exactShape(DateUnit.Year), exactShape(DateUnit.Month)),
 }, {
     get: exactShape(DateUnit.Day),
-    in: unionShape(exactShape(DateUnit.Year), exactShape(DateUnit.Quarter), exactShape(DateUnit.Month), exactShape(DateUnit.Week)),
+    in: unionShape(exactShape(DateUnit.Year), exactShape(DateUnit.Month), exactShape(DateUnit.Week)),
 }, {
     get: exactShape(DateUnit.Hour),
-    in: unionShape(exactShape(DateUnit.Year), exactShape(DateUnit.Quarter), exactShape(DateUnit.Month), exactShape(DateUnit.Week), exactShape(DateUnit.Day)),
+    in: unionShape(exactShape(DateUnit.Year), exactShape(DateUnit.Month), exactShape(DateUnit.Week), exactShape(DateUnit.Day)),
 }, {
     get: exactShape(DateUnit.Minute),
-    in: unionShape(exactShape(DateUnit.Year), exactShape(DateUnit.Quarter), exactShape(DateUnit.Month), exactShape(DateUnit.Week), exactShape(DateUnit.Day), exactShape(DateUnit.Hour)),
+    in: unionShape(exactShape(DateUnit.Year), exactShape(DateUnit.Month), exactShape(DateUnit.Week), exactShape(DateUnit.Day), exactShape(DateUnit.Hour)),
 }, {
     get: exactShape(DateUnit.Second),
-    in: unionShape(exactShape(DateUnit.Year), exactShape(DateUnit.Quarter), exactShape(DateUnit.Month), exactShape(DateUnit.Week), exactShape(DateUnit.Day), exactShape(DateUnit.Hour), exactShape(DateUnit.Minute)),
+    in: unionShape(exactShape(DateUnit.Year), exactShape(DateUnit.Month), exactShape(DateUnit.Week), exactShape(DateUnit.Day), exactShape(DateUnit.Hour), exactShape(DateUnit.Minute)),
 }, {
     get: exactShape(DateUnit.Millisecond),
-    in: unionShape(exactShape(DateUnit.Year), exactShape(DateUnit.Quarter), exactShape(DateUnit.Month), exactShape(DateUnit.Week), exactShape(DateUnit.Day), exactShape(DateUnit.Hour), exactShape(DateUnit.Minute), exactShape(DateUnit.Second)),
+    in: unionShape(exactShape(DateUnit.Year), exactShape(DateUnit.Month), exactShape(DateUnit.Week), exactShape(DateUnit.Day), exactShape(DateUnit.Hour), exactShape(DateUnit.Minute), exactShape(DateUnit.Second)),
 }));
 /**
  * Calculate the position of the given date's "get" unit within the given "in" unit.
@@ -211,8 +211,10 @@ export function calculateDatePosition(date, calculation) {
         })
         : start;
     const diffUnit = `${calculation.get}s`;
-    const diff = diffDates({ start: startWithOffset, end: date }, { [diffUnit]: true });
-    const value = diff[diffUnit];
+    const diff = diffDates({ start: startWithOffset, end: date }, {
+        [diffUnit]: true,
+    });
+    const value = assertWrap.isDefined(diff[diffUnit]);
     const isDayOfWeek = calculation.get === DateUnit.Day && calculation.in === DateUnit.Week;
     if (!isDayOfWeek && check.isIn(calculation.get, oneIndexedDateUnits)) {
         return value + 1;

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

@@ -5,8 +5,8 @@ import { type FullDate } from '../full-date/full-date-shape.js';
  * provided with the `units` input property, an array is returned with the full diff duration
  * contained in each entry in the requested unit.
  *
- * Note: when years, quarters, or months are used for the unit, "long term" durations are used to
- * calculate the diff. See more details here:
+ * Note: when years or months are used for the unit, "long term" durations are used to calculate the
+ * diff. See more details here:
  * https://moment.github.io/luxon/#/math?id=casual-vs-longterm-conversion-accuracy
  *
  * @category Calculation

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

@@ -1,8 +1,7 @@
-import { DurationUnit, flattenUnitSelection, roundDuration, } from '@date-vir/duration';
+import { DurationUnit, flattenUnitsSmallestToLargest, roundDuration, } from '@date-vir/duration';
 import { toLuxonDateTime } from '../full-date/luxon-date-time-conversion.js';
 const conversionAccuracies = {
     [DurationUnit.Years]: 'longterm',
-    [DurationUnit.Quarters]: 'longterm',
     [DurationUnit.Months]: 'longterm',
     [DurationUnit.Weeks]: 'casual',
     [DurationUnit.Days]: 'casual',
@@ -24,8 +23,8 @@ function getHighestPriorityConversionAccuracy(units) {
  * provided with the `units` input property, an array is returned with the full diff duration
  * contained in each entry in the requested unit.
  *
- * Note: when years, quarters, or months are used for the unit, "long term" durations are used to
- * calculate the diff. See more details here:
+ * Note: when years or months are used for the unit, "long term" durations are used to calculate the
+ * diff. See more details here:
  * https://moment.github.io/luxon/#/math?id=casual-vs-longterm-conversion-accuracy
  *
  * @category Calculation
@@ -70,7 +69,7 @@ export function diffDates({ start, end, },
 units, options = {}) {
     const luxonDateStart = toLuxonDateTime(start);
     const luxonDateEnd = toLuxonDateTime(end);
-    const selectedUnits = flattenUnitSelection(units);
+    const selectedUnits = flattenUnitsSmallestToLargest(units);
     const conversionAccuracy = getHighestPriorityConversionAccuracy(selectedUnits);
     const additiveDiff = luxonDateEnd
         .diff(luxonDateStart, selectedUnits, {

package/dist/formatting/formatted-string.js

@@ -1,5 +1,5 @@
+import { userLocale } from '@date-vir/duration';
 import { toLuxonDateTime } from '../full-date/luxon-date-time-conversion.js';
-import { userLocale } from '../locales.js';
 /**
  * Chromium has a weird behavior where the "NARROW NO-BREAK SPACE" character (code 8239) is used
  * instead of a space (code 32) before AM/PM.

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

@@ -1,5 +1,5 @@
-import { type PartialWithUndefined } from '@augment-vir/common';
-import { type AnyDuration, type DurationUnitSelection } from '@date-vir/duration';
+import { type PartialWithUndefined, type RequiredAndNotNull } from '@augment-vir/common';
+import { type AnyDuration, type DurationUnitSelection, type LocaleOptions, type RoundOptions } from '@date-vir/duration';
 import { type FullDate } from '../full-date/full-date-shape.js';
 /**
  * Options for {@link toRelativeString}.
@@ -8,10 +8,11 @@ import { type FullDate } from '../full-date/full-date-shape.js';
  */
 export type RelativeStringOptions = PartialWithUndefined<{
     /**
-     * Set this to `true` to prevent the `'just now'` relative string from being used when the two
-     * dates are very close.
+     * Set this to `true` to block a "just now" string to be used when the two dates are very close
+     * or the duration is very small (or 0).
      *
      * @default false // (`'just now'` is used)
+     * @see `RelativeStringOptions.justNowThresholds`
      */
     blockJustNow: boolean;
     /**
@@ -22,27 +23,61 @@ export type RelativeStringOptions = PartialWithUndefined<{
      */
     useOnlyLargestUnit: boolean;
     /**
-     * The number of decimals to allow for each duration unit's value.
+     * Any values below this will trigger "just now".
      *
-     * @default 0
+     * @default `defaultJustNowThresholds`
+     * @see {@link defaultJustNowThresholds} .
      */
-    allowedDecimals: number;
+    justNowThresholds: AnyDuration;
     /**
-     * Any values below this will trigger "just now".
+     * The separator between each unit.
+     *
+     * @default ', '
+     */
+    sep: string;
+    /**
+     * By default, when `blockJustNow` is `true` and there is no duration to print (the diff is 0),
+     * this will return the smallest selected unit set to 0 and use "0 <unit> ago". Set this
+     * property to `true` to instead use "in 0 <unit>".
      *
-     * @default {
+     * @default false
+     */
+    useFutureWhenNothing: boolean;
+    /**
+     * If `true`, unit names are abbreviated.
      *
-     *         minutes: 1.5,
-     *         seconds: 5,
-     *         milliseconds: 500,
-     * }
+     * @default false
+     */
+    abbreviate: boolean;
+    /**
+     * Customize translations. If this is not provided, or any property is missing, the default
+     * english phrases will be used.
      */
-    justNowThresholds: {
-        minutes: number;
-        seconds: number;
-        milliseconds: number;
-    };
-}>;
+    i18n: Partial<{
+        /** Creates past relative strings like "5 seconds ago". */
+        timeAgo(
+        /**
+         * This will look like "5 seconds" or "1 year", translated to the configured locale (or
+         * the user's current locale.
+         */
+        unitString: string): string;
+        /** Creates future relative strings like "in 5 seconds". */
+        timeIn(
+        /**
+         * This will look like "5 seconds" or "1 year", translated to the configured locale (or
+         * the user's current locale.
+         */
+        unitString: string): string;
+        /** The string to be used when "just now" is chosen. */
+        justNow: string;
+    }>;
+}> & RequiredAndNotNull<RoundOptions> & LocaleOptions;
+/**
+ * Default value for `RelativeStringOptions.justNowThresholds`.
+ *
+ * @category Internal
+ */
+export declare const defaultJustNowThresholds: AnyDuration;
 /**
  * This function starts with a duration (either by being directly passed a duration or by diffing
  * two dates into a duration) and converts that duration into a relative string like "1 month ago"
@@ -61,8 +96,12 @@ export type RelativeStringOptions = PartialWithUndefined<{
  * toRelativeString({days: 1.6}, {days: true, hours: true}); // `'in 1 day, 14 hours'`
  * toRelativeString({seconds: 1}, selectAllDurationUnits); // `'just now'`
  * ```
+ *
+ * @throws If no units are selected
  */
 export declare function toRelativeString(datesOrDuration: Readonly<{
     start: Readonly<FullDate>;
     end: Readonly<FullDate>;
-}> | Readonly<AnyDuration>, units: Readonly<DurationUnitSelection>, options?: Readonly<RelativeStringOptions>): string;
+}> | Readonly<AnyDuration>, 
+/** The units to use in the relative string. */
+units: Readonly<DurationUnitSelection>, options: Readonly<RelativeStringOptions>): string;

package/dist/formatting/relative-string.js

@@ -1,11 +1,25 @@
 import { check } from '@augment-vir/assert';
-import { arrayToObject, filterMap } from '@augment-vir/common';
-import { convertDuration, DurationUnit, flattenUnitSelection, singularDurationUnitNames, } from '@date-vir/duration';
+import { filterMap, } from '@augment-vir/common';
+import { convertDuration, flattenUnitsSmallestToLargest, getDateUnitString, } from '@date-vir/duration';
 import { diffDates } from '../date-operations/diff-dates.js';
-const defaultJustNowThresholds = {
+const defaultRelativeStringI18n = {
+    justNow: 'just now',
+    timeAgo(unitString) {
+        return `${unitString} ago`;
+    },
+    timeIn(unitString) {
+        return `in ${unitString}`;
+    },
+};
+/**
+ * Default value for `RelativeStringOptions.justNowThresholds`.
+ *
+ * @category Internal
+ */
+export const defaultJustNowThresholds = {
     minutes: 1.5,
     seconds: 5,
-    milliseconds: 500,
+    milliseconds: 200,
 };
 /**
  * This function starts with a duration (either by being directly passed a duration or by diffing
@@ -25,85 +39,136 @@ const defaultJustNowThresholds = {
  * toRelativeString({days: 1.6}, {days: true, hours: true}); // `'in 1 day, 14 hours'`
  * toRelativeString({seconds: 1}, selectAllDurationUnits); // `'just now'`
  * ```
+ *
+ * @throws If no units are selected
  */
-export function toRelativeString(datesOrDuration, units, options = {}) {
-    const selectedUnits = flattenUnitSelection(units);
-    /** If there are no selected units, return nothing. */
-    if (!check.isLengthAtLeast(selectedUnits, 1)) {
-        return '';
+export function toRelativeString(datesOrDuration, 
+/** The units to use in the relative string. */
+units, options) {
+    /**
+     * Don't use Luxon's implementation of this (`DateTime.toRelative()`) because it's a hopeless
+     * mess.
+     */
+    const smallestToLargestSelectedUnit = flattenUnitsSmallestToLargest(units);
+    const smallestSelectedUnit = smallestToLargestSelectedUnit[0];
+    const largestToSmallestSelectedUnit = smallestToLargestSelectedUnit.toReversed();
+    if (smallestSelectedUnit == undefined) {
+        throw new Error('No units selected for relative string.');
     }
-    const diff = convertDuration('start' in datesOrDuration ? diffDates(datesOrDuration, units) : datesOrDuration, units, {
-        roundToDigits: options.allowedDecimals || 0,
+    const diff = getRelativeStringDiff({
+        datesOrDuration,
+        options,
+        units,
+        largestToSmallestSelectedUnit,
     });
+    const unitCounts = {};
     const isDiffPositive = convertDuration(diff, { milliseconds: true }).milliseconds >= 0;
-    const unitValues = filterMap(selectedUnits, (unit) => {
-        const quantity = diff[unit] || 0;
-        if (!quantity) {
-            return undefined;
+    largestToSmallestSelectedUnit.forEach((unit) => {
+        if (options.useOnlyLargestUnit && Object.keys(unitCounts).length) {
+            return;
+        }
+        const unitCount = diff[unit] || 0;
+        if (unitCount) {
+            unitCounts[unit] = unitCount;
         }
-        return {
-            quantity,
-            unit,
-        };
-    }, check.isTruthy).reverse();
-    const justNowThresholds = options.justNowThresholds || defaultJustNowThresholds;
-    const shouldUseJustNow = !options.blockJustNow &&
-        (!check.isLengthAtLeast(unitValues, 1) ||
-            (unitValues[0].unit === DurationUnit.Minutes &&
-                /* node:coverage ignore next 1 */
-                Math.abs(diff.minutes || 0) < justNowThresholds.minutes) ||
-            (unitValues[0].unit === DurationUnit.Seconds &&
-                /* node:coverage ignore next 1 */
-                Math.abs(diff.seconds || 0) < justNowThresholds.seconds) ||
-            (unitValues[0].unit === DurationUnit.Milliseconds &&
-                /* node:coverage ignore next 1 */
-                Math.abs(diff.milliseconds || 0) < justNowThresholds.milliseconds));
+    });
+    const shouldUseJustNow = determineShouldUseJustNow({ options, smallestSelectedUnit, unitCounts });
+    const i18n = {
+        ...defaultRelativeStringI18n,
+        ...options.i18n,
+    };
     if (shouldUseJustNow) {
-        return 'just now';
+        return i18n.justNow;
     }
-    else if (options.useOnlyLargestUnit) {
-        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-        if (!unitValues[0]) {
-            return '';
+    else if (Object.keys(unitCounts).length) {
+        const unitStrings = filterMap(largestToSmallestSelectedUnit, (unit) => {
+            const unitCount = unitCounts[unit];
+            if (unitCount) {
+                return getDateUnitString({
+                    count: Math.abs(unitCount),
+                    unit,
+                    locale: options.locale,
+                    abbreviate: options.abbreviate,
+                    decimalCount: options.decimalCount,
+                });
+            }
+            else {
+                return undefined;
+            }
+        }, check.isTruthy);
+        const allUnitStrings = unitStrings.join(options.sep ?? ', ');
+        if (isDiffPositive) {
+            return i18n.timeIn(allUnitStrings);
+        }
+        else {
+            return i18n.timeAgo(allUnitStrings);
         }
-        return toRelativeString(datesOrDuration, { [unitValues[0].unit]: true }, {
-            ...options,
-            useOnlyLargestUnit: false,
-        });
     }
-    else if (unitValues.length < selectedUnits.length) {
-        /**
-         * If the finalized units are less than the selected units, rerun the whole calculation to
-         * make sure we're using the right accuracy.
-         */
-        return toRelativeString(datesOrDuration, arrayToObject(unitValues, ({ unit }) => {
-            return {
-                key: unit,
-                value: true,
-            };
-        }), options);
+    else {
+        const unitString = getDateUnitString({
+            count: 0,
+            unit: smallestSelectedUnit,
+            locale: options.locale,
+            abbreviate: options.abbreviate,
+            decimalCount: options.decimalCount,
+        });
+        if (options.useFutureWhenNothing) {
+            return i18n.timeIn(unitString);
+        }
+        else {
+            return i18n.timeAgo(unitString);
+        }
     }
-    const unitsString = unitValues
-        .map(({ quantity, unit }) => {
-        const absoluteQuantity = Math.abs(quantity);
-        return [
-            absoluteQuantity,
-            ' ',
-            singularDurationUnitNames[unit],
-            absoluteQuantity > 1 ? 's' : '',
-        ].join('');
-    })
-        .join(', ');
-    if (isDiffPositive) {
-        return [
-            'in',
-            unitsString,
-        ].join(' ');
+}
+function getRelativeStringDiff({ datesOrDuration, units, options, largestToSmallestSelectedUnit, }) {
+    if (options.useOnlyLargestUnit) {
+        return findLargestDiff({ datesOrDuration, largestToSmallestSelectedUnit, options });
     }
     else {
-        return [
-            unitsString,
-            'ago',
-        ].join(' ');
+        return createDiff(datesOrDuration, { decimalCount: undefined }, units);
+    }
+}
+function createDiff(datesOrDuration, options, units) {
+    return 'start' in datesOrDuration
+        ? diffDates(datesOrDuration, units, options)
+        : convertDuration(datesOrDuration, units, options);
+}
+function findLargestDiff({ datesOrDuration, options, largestToSmallestSelectedUnit, }) {
+    for (const unit of largestToSmallestSelectedUnit) {
+        const innerDiff = createDiff(datesOrDuration, options, {
+            [unit]: true,
+        });
+        if (innerDiff[unit]) {
+            return innerDiff;
+        }
+    }
+    return {};
+}
+function determineShouldUseJustNow({ options, smallestSelectedUnit, unitCounts, }) {
+    if (options.blockJustNow) {
+        return false;
+    }
+    const thresholds = {
+        ...defaultJustNowThresholds,
+        ...options.justNowThresholds,
+    };
+    if (!(smallestSelectedUnit in thresholds) || Object.keys(unitCounts).length > 1) {
+        return false;
+    }
+    if (!Object.keys(unitCounts).length || smallestSelectedUnit in unitCounts) {
+        /* node:coverage disable: these fallbacks aren't required at runtime but are required for type safety. */
+        /**
+         * We've already verify that `smallestSelectedUnit` is in `thresholds` so the `|| 0`
+         * fallback is safe.
+         */
+        const unitThreshold = thresholds[smallestSelectedUnit] || 0;
+        /**
+         * We've already verify that `smallestSelectedUnit` is in `unitCounts` so the `|| 0`
+         * fallback is safe.
+         */
+        const unitValue = unitCounts[smallestSelectedUnit] || 0;
+        /* node:coverage enable */
+        return unitValue <= unitThreshold;
     }
+    return false;
 }

package/dist/full-date/luxon-date-time-conversion.d.ts

@@ -8,7 +8,7 @@ import { type FullDate } from './full-date-shape.js';
  *
  * @category Internal
  */
-export declare function toLuxonDateTime(fullDateInput: Readonly<FullDate>): DateTime;
+export declare function toLuxonDateTime(fullDateInput: Readonly<FullDate>): DateTime<true>;
 /**
  * Convert a Luxon DateTime object into a {@link FullDate} instance. Used internally inside of
  * date-vir, but could be helpful if you need it. Usually you should prefer using the

package/dist/index.d.ts

@@ -23,7 +23,6 @@ export * from './full-date/full-date-shape.js';
 export * from './full-date/is-valid-full-date.js';
 export * from './full-date/luxon-date-time-conversion.js';
 export * from './full-date/parsing.js';
-export * from './locales.js';
 export * from './timezone/timezone-checks.js';
 export * from './timezone/timezone-names.js';
 export * from './timezone/timezones.js';

package/dist/index.js

@@ -23,7 +23,6 @@ export * from './full-date/full-date-shape.js';
 export * from './full-date/is-valid-full-date.js';
 export * from './full-date/luxon-date-time-conversion.js';
 export * from './full-date/parsing.js';
-export * from './locales.js';
 export * from './timezone/timezone-checks.js';
 export * from './timezone/timezone-names.js';
 export * from './timezone/timezones.js';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "date-vir",
-    "version": "7.4.3",
+    "version": "8.1.0",
     "description": "Easy and explicit dates and times.",
     "keywords": [
         "date",
@@ -34,25 +34,25 @@
         "test:docs": "virmator docs check"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.40.0",
-        "@augment-vir/common": "^31.40.0",
-        "@date-vir/duration": "^7.4.3",
+        "@augment-vir/assert": "^31.54.3",
+        "@augment-vir/common": "^31.54.3",
+        "@date-vir/duration": "^8.1.0",
         "@types/luxon": "^3.7.1",
         "luxon": "^3.7.2",
-        "object-shape-tester": "^6.9.2",
-        "type-fest": "^5.0.1"
+        "object-shape-tester": "^6.10.0",
+        "type-fest": "^5.3.1"
     },
     "devDependencies": {
-        "@augment-vir/test": "^31.40.0",
+        "@augment-vir/test": "^31.54.3",
         "@web/dev-server-esbuild": "^1.0.4",
         "@web/test-runner": "^0.20.2",
         "@web/test-runner-commands": "^0.9.0",
         "@web/test-runner-playwright": "^0.11.1",
         "@web/test-runner-visual-regression": "^0.10.0",
-        "element-vir": "^26.10.0",
+        "element-vir": "^26.12.1",
         "istanbul-smart-text-reporter": "^1.1.5",
         "markdown-code-example-inserter": "^3.0.3",
-        "typedoc": "^0.28.13",
+        "typedoc": "^0.28.15",
         "typescript": "^5.9.3"
     },
     "engines": {

package/dist/locales.d.ts

@@ -1,6 +0,0 @@
-/**
- * The current user's default locale, useful for formatting purposes.
- *
- * @category Formatting
- */
-export declare const userLocale: string;

package/dist/locales.js

@@ -1,7 +0,0 @@
-import { Settings } from 'luxon';
-/**
- * The current user's default locale, useful for formatting purposes.
- *
- * @category Formatting
- */
-export const userLocale = Settings.defaultLocale;