date-vir 6.0.1 → 7.0.0

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

@@ -0,0 +1,149 @@
+import { DateUnit } from '@date-vir/duration';
+import { type FullDate } from '../full-date/full-date-shape.js';
+import { Timezone } from '../timezone/timezones.js';
+/**
+ * Get the {@link DateUnit} value of a {@link FullDate}.
+ *
+ * @category Calculation
+ * @example
+ *
+ * ```ts
+ * import {getDateUnit, DateUnit, utcTimezone} from 'date-vir';
+ *
+ * getDateUnit(
+ *     {
+ *         year: 2024,
+ *         month: 11,
+ *         day: 7,
+ *
+ *         hour: 12,
+ *         minute: 12,
+ *         second: 12,
+ *         millisecond: 12,
+ *
+ *         timezone: utcTimezone,
+ *     },
+ *     DateUnit.Week,
+ * ); // outputs `45`
+ * ```
+ */
+export declare function getDateUnit(date: Readonly<FullDate>, unit: DateUnit): number;
+/**
+ * Get the start date of a specific {@link DateUnit} based on a given {@link FullDate}.
+ *
+ * @category Calculation
+ * @example
+ *
+ * ```ts
+ * import {getStartDate, DateUnit, utcTimezone} from 'date-vir';
+ *
+ * getStartDate(
+ *     {
+ *         year: 2024,
+ *         month: 11,
+ *         day: 7,
+ *
+ *         hour: 12,
+ *         minute: 12,
+ *         second: 12,
+ *         millisecond: 12,
+ *
+ *         timezone: utcTimezone,
+ *     },
+ *     DateUnit.Month,
+ * ); // outputs {year: 2024, month: 11, day: 1, hour: 0, minute: 0, second: 0, millisecond: 0, timezone: utcTimezone}
+ * ```
+ */
+export declare function getStartDate<const SpecificTimezone extends Timezone>(date: Readonly<FullDate<SpecificTimezone>>, unit: DateUnit): FullDate<SpecificTimezone>;
+/**
+ * Get the end date of a specific {@link DateUnit} based on a given {@link FullDate}.
+ *
+ * @category Calculation
+ * @example
+ *
+ * ```ts
+ * import {getEndDate, DateUnit, utcTimezone} from 'date-vir';
+ *
+ * getEndDate(
+ *     {
+ *         year: 2024,
+ *         month: 11,
+ *         day: 7,
+ *
+ *         hour: 12,
+ *         minute: 12,
+ *         second: 12,
+ *         millisecond: 12,
+ *
+ *         timezone: utcTimezone,
+ *     },
+ *     DateUnit.Month,
+ * ); // outputs {year: 2024, month: 11, day: 30, hour: 23, minute: 59, second: 59, millisecond: 999, timezone: utcTimezone}
+ * ```
+ */
+export declare function getEndDate<const SpecificTimezone extends Timezone>(date: Readonly<FullDate<SpecificTimezone>>, unit: DateUnit): FullDate<SpecificTimezone>;
+/**
+ * Shape definition for all valid date position calculations. Used for {@link calculateDatePosition}.
+ *
+ * @category Internal
+ */
+export declare const datePositionCalculationShape: import("object-shape-tester").ShapeDefinition<import("object-shape-tester").ShapeOr<[{
+    get: import("object-shape-tester").ShapeExact<readonly [DateUnit.Month]>;
+    in: import("object-shape-tester").ShapeOr<[import("object-shape-tester").ShapeExact<readonly [DateUnit.Year]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Quarter]>]>;
+}, {
+    get: import("object-shape-tester").ShapeExact<readonly [DateUnit.Week]>;
+    in: import("object-shape-tester").ShapeOr<[import("object-shape-tester").ShapeExact<readonly [DateUnit.Year]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Quarter]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Month]>]>;
+}, {
+    get: import("object-shape-tester").ShapeExact<readonly [DateUnit.Day]>;
+    in: import("object-shape-tester").ShapeOr<[import("object-shape-tester").ShapeExact<readonly [DateUnit.Year]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Quarter]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Month]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Week]>]>;
+}, {
+    get: import("object-shape-tester").ShapeExact<readonly [DateUnit.Hour]>;
+    in: import("object-shape-tester").ShapeOr<[import("object-shape-tester").ShapeExact<readonly [DateUnit.Year]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Quarter]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Month]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Week]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Day]>]>;
+}, {
+    get: import("object-shape-tester").ShapeExact<readonly [DateUnit.Minute]>;
+    in: import("object-shape-tester").ShapeOr<[import("object-shape-tester").ShapeExact<readonly [DateUnit.Year]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Quarter]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Month]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Week]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Day]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Hour]>]>;
+}, {
+    get: import("object-shape-tester").ShapeExact<readonly [DateUnit.Second]>;
+    in: import("object-shape-tester").ShapeOr<[import("object-shape-tester").ShapeExact<readonly [DateUnit.Year]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Quarter]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Month]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Week]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Day]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Hour]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Minute]>]>;
+}, {
+    get: import("object-shape-tester").ShapeExact<readonly [DateUnit.Millisecond]>;
+    in: import("object-shape-tester").ShapeOr<[import("object-shape-tester").ShapeExact<readonly [DateUnit.Year]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Quarter]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Month]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Week]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Day]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Hour]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Minute]>, import("object-shape-tester").ShapeExact<readonly [DateUnit.Second]>]>;
+}]>, false>;
+/**
+ * All valid date position calculations. Used for {@link calculateDatePosition}.
+ *
+ * @category Internal
+ */
+export type DatePositionCalculation = typeof datePositionCalculationShape.runtimeType;
+/**
+ * Calculate the position of the given date's day within the given date unit. Only date units larger
+ * than a day are allowed.
+ *
+ * @category Calculation
+ * @example
+ *
+ * ```ts
+ * import {calculateDatePosition, DateUnit} from 'date-vir';
+ *
+ * calculateDatePosition(
+ *     {
+ *         day: 5,
+ *         month: 4,
+ *         year: 2020,
+ *     },
+ *     DateUnit.Month,
+ * );
+ * // result is 5
+ *
+ * calculateDatePosition(
+ *     {
+ *         day: 5,
+ *         month: 4,
+ *         year: 2020,
+ *     },
+ *     DateUnit.Week,
+ * );
+ * // result is
+ * ```
+ */
+export declare function calculateDatePosition(date: Readonly<FullDate>, calculation: Readonly<DatePositionCalculation>): number;

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

@@ -0,0 +1,175 @@
+import { check } from '@augment-vir/assert';
+import { stringify } from '@augment-vir/common';
+import { DateUnit, oneIndexedDateUnits } from '@date-vir/duration';
+import { defineShape, exact, isValidShape, or } from 'object-shape-tester';
+import { createFullDate } from '../full-date/create-full-date.js';
+import { toLuxonDateTime } from '../full-date/luxon-date-time-conversion.js';
+import { diffDates } from './diff-dates.js';
+/**
+ * Get the {@link DateUnit} value of a {@link FullDate}.
+ *
+ * @category Calculation
+ * @example
+ *
+ * ```ts
+ * import {getDateUnit, DateUnit, utcTimezone} from 'date-vir';
+ *
+ * getDateUnit(
+ *     {
+ *         year: 2024,
+ *         month: 11,
+ *         day: 7,
+ *
+ *         hour: 12,
+ *         minute: 12,
+ *         second: 12,
+ *         millisecond: 12,
+ *
+ *         timezone: utcTimezone,
+ *     },
+ *     DateUnit.Week,
+ * ); // outputs `45`
+ * ```
+ */
+export function getDateUnit(date, unit) {
+    const luxonInstance = toLuxonDateTime(date);
+    if (unit === DateUnit.Week) {
+        return luxonInstance.weekNumber;
+    }
+    else {
+        return luxonInstance[unit];
+    }
+}
+/**
+ * Get the start date of a specific {@link DateUnit} based on a given {@link FullDate}.
+ *
+ * @category Calculation
+ * @example
+ *
+ * ```ts
+ * import {getStartDate, DateUnit, utcTimezone} from 'date-vir';
+ *
+ * getStartDate(
+ *     {
+ *         year: 2024,
+ *         month: 11,
+ *         day: 7,
+ *
+ *         hour: 12,
+ *         minute: 12,
+ *         second: 12,
+ *         millisecond: 12,
+ *
+ *         timezone: utcTimezone,
+ *     },
+ *     DateUnit.Month,
+ * ); // outputs {year: 2024, month: 11, day: 1, hour: 0, minute: 0, second: 0, millisecond: 0, timezone: utcTimezone}
+ * ```
+ */
+export function getStartDate(date, unit) {
+    const luxonInstance = toLuxonDateTime(date);
+    return createFullDate(luxonInstance.startOf(unit), date.timezone);
+}
+/**
+ * Get the end date of a specific {@link DateUnit} based on a given {@link FullDate}.
+ *
+ * @category Calculation
+ * @example
+ *
+ * ```ts
+ * import {getEndDate, DateUnit, utcTimezone} from 'date-vir';
+ *
+ * getEndDate(
+ *     {
+ *         year: 2024,
+ *         month: 11,
+ *         day: 7,
+ *
+ *         hour: 12,
+ *         minute: 12,
+ *         second: 12,
+ *         millisecond: 12,
+ *
+ *         timezone: utcTimezone,
+ *     },
+ *     DateUnit.Month,
+ * ); // outputs {year: 2024, month: 11, day: 30, hour: 23, minute: 59, second: 59, millisecond: 999, timezone: utcTimezone}
+ * ```
+ */
+export function getEndDate(date, unit) {
+    const luxonInstance = toLuxonDateTime(date);
+    return createFullDate(luxonInstance.endOf(unit), date.timezone);
+}
+/**
+ * Shape definition for all valid date position calculations. Used for {@link calculateDatePosition}.
+ *
+ * @category Internal
+ */
+export const datePositionCalculationShape = defineShape(or({
+    get: exact(DateUnit.Month),
+    in: or(exact(DateUnit.Year), exact(DateUnit.Quarter)),
+}, {
+    get: exact(DateUnit.Week),
+    in: or(exact(DateUnit.Year), exact(DateUnit.Quarter), exact(DateUnit.Month)),
+}, {
+    get: exact(DateUnit.Day),
+    in: or(exact(DateUnit.Year), exact(DateUnit.Quarter), exact(DateUnit.Month), exact(DateUnit.Week)),
+}, {
+    get: exact(DateUnit.Hour),
+    in: or(exact(DateUnit.Year), exact(DateUnit.Quarter), exact(DateUnit.Month), exact(DateUnit.Week), exact(DateUnit.Day)),
+}, {
+    get: exact(DateUnit.Minute),
+    in: or(exact(DateUnit.Year), exact(DateUnit.Quarter), exact(DateUnit.Month), exact(DateUnit.Week), exact(DateUnit.Day), exact(DateUnit.Hour)),
+}, {
+    get: exact(DateUnit.Second),
+    in: or(exact(DateUnit.Year), exact(DateUnit.Quarter), exact(DateUnit.Month), exact(DateUnit.Week), exact(DateUnit.Day), exact(DateUnit.Hour), exact(DateUnit.Minute)),
+}, {
+    get: exact(DateUnit.Millisecond),
+    in: or(exact(DateUnit.Year), exact(DateUnit.Quarter), exact(DateUnit.Month), exact(DateUnit.Week), exact(DateUnit.Day), exact(DateUnit.Hour), exact(DateUnit.Minute), exact(DateUnit.Second)),
+}));
+/**
+ * Calculate the position of the given date's day within the given date unit. Only date units larger
+ * than a day are allowed.
+ *
+ * @category Calculation
+ * @example
+ *
+ * ```ts
+ * import {calculateDatePosition, DateUnit} from 'date-vir';
+ *
+ * calculateDatePosition(
+ *     {
+ *         day: 5,
+ *         month: 4,
+ *         year: 2020,
+ *     },
+ *     DateUnit.Month,
+ * );
+ * // result is 5
+ *
+ * calculateDatePosition(
+ *     {
+ *         day: 5,
+ *         month: 4,
+ *         year: 2020,
+ *     },
+ *     DateUnit.Week,
+ * );
+ * // result is
+ * ```
+ */
+export function calculateDatePosition(date, calculation) {
+    if (!isValidShape(calculation, datePositionCalculationShape)) {
+        throw new Error(`Invalid date position calculation for '${stringify(date)}': cannot get ${calculation.get} in ${calculation.in}.`);
+    }
+    const start = getStartDate(date, calculation.in);
+    const diffUnit = `${calculation.get}s`;
+    const diff = diffDates({ start, end: date }, { [diffUnit]: true });
+    const value = diff[diffUnit];
+    if (check.isIn(calculation.get, oneIndexedDateUnits)) {
+        return value + 1;
+    }
+    else {
+        return value;
+    }
+}

package/dist/extra-utils/end.d.ts

@@ -0,0 +1,11 @@
+/**
+ * A partial {@link FullDate} instance that has the highest value for each time property.
+ *
+ * @category Constants
+ */
+export declare const endTime: {
+    readonly hour: 23;
+    readonly minute: 59;
+    readonly second: 59;
+    readonly millisecond: 999;
+};

package/dist/extra-utils/end.js

@@ -0,0 +1,11 @@
+/**
+ * A partial {@link FullDate} instance that has the highest value for each time property.
+ *
+ * @category Constants
+ */
+export const endTime = {
+    hour: 23,
+    minute: 59,
+    second: 59,
+    millisecond: 999,
+};

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

@@ -1,9 +1,10 @@
+import { TimeKey } from '../full-date/full-date-parts.js';
 import { FullDate } from '../full-date/full-date-shape.js';
 import { Timezone } from '../timezone/timezones.js';
 /**
  * A {@link FullDate} instance that has the lowest, valid, non-negative, value for each property.
  *
- * @category Zero
+ * @category Constants
  */
 export declare const zeroDate: {
     readonly year: 0;
@@ -18,7 +19,7 @@ export declare const zeroDate: {
  * A {@link FullDate} instance that has the lowest, valid, non-negative, value for each property.
  * Alias for {@link zeroDate}.
  *
- * @category Zero
+ * @category Constants
  */
 export declare const emptyDate: {
     readonly year: 0;
@@ -32,7 +33,7 @@ export declare const emptyDate: {
 /**
  * An object that contains the time parts of {@link FullDate} all set to `0`.
  *
- * @category Zero
+ * @category Constants
  */
 export declare const zeroTime: Pick<{
     year: 0;
@@ -42,11 +43,11 @@ export declare const zeroTime: Pick<{
     minute: 0;
     second: 0;
     millisecond: 0;
-}, "hour" | "minute" | "second" | "millisecond">;
+}, TimeKey>;
 /**
  * Clear the time parts of a {@link FullDate}, setting them all to `0`.
  *
- * @category Zero
+ * @category Clear
  * @example
  *
  * ```ts
@@ -72,7 +73,7 @@ export declare function clearTime<const SpecificTimezone extends Timezone>(input
  * Clear all the selected parts of {@link FullDate} by setting them each to their lowest, valid
  * value. See {@link zeroDate} for the lowest valid values for each property.
  *
- * @category Zero
+ * @category Clear
  * @example
  *
  * ```ts
@@ -96,4 +97,13 @@ export declare function clearTime<const SpecificTimezone extends Timezone>(input
  * // `{year: 0, month: 1, day: 1, hour: 1, minute: 1, second: 1, millisecond: 1, timezone: 'UTC'}`
  * ```
  */
-export declare function clearParts<const SpecificTimezone extends Timezone>(inputFullDate: Readonly<FullDate<SpecificTimezone>>, parts: ReadonlyArray<Exclude<keyof FullDate, 'timezone'>>): FullDate<SpecificTimezone>;
+export declare function clearParts<const SpecificTimezone extends Timezone>(inputFullDate: Readonly<FullDate<SpecificTimezone>>, parts: ReadonlyArray<Exclude<keyof FullDate, 'timezone'>>): {
+    hour: import("@date-vir/duration").Hour;
+    minute: import("@date-vir/duration").Minute;
+    second: import("@date-vir/duration").Minute;
+    millisecond: number;
+    year: number;
+    month: import("@date-vir/duration").MonthNumber;
+    day: import("@date-vir/duration").DayOfMonth;
+    timezone: SpecificTimezone;
+};

package/dist/extra-utils/zero.js

@@ -1,10 +1,10 @@
-import { pickObjectKeys, typedObjectFromEntries } from '@augment-vir/common';
-import { timeFullDateKeys } from '../full-date/full-date-parts.js';
+import { getEnumValues, pickObjectKeys, typedObjectFromEntries } from '@augment-vir/common';
+import { TimeKey } from '../full-date/full-date-parts.js';
 import { overrideDateParts } from './override-date.js';
 /**
  * A {@link FullDate} instance that has the lowest, valid, non-negative, value for each property.
  *
- * @category Zero
+ * @category Constants
  */
 export const zeroDate = {
     year: 0,
@@ -19,19 +19,19 @@ export const zeroDate = {
  * A {@link FullDate} instance that has the lowest, valid, non-negative, value for each property.
  * Alias for {@link zeroDate}.
  *
- * @category Zero
+ * @category Constants
  */
 export const emptyDate = zeroDate;
 /**
  * An object that contains the time parts of {@link FullDate} all set to `0`.
  *
- * @category Zero
+ * @category Constants
  */
-export const zeroTime = pickObjectKeys(zeroDate, timeFullDateKeys);
+export const zeroTime = pickObjectKeys(zeroDate, getEnumValues(TimeKey));
 /**
  * Clear the time parts of a {@link FullDate}, setting them all to `0`.
  *
- * @category Zero
+ * @category Clear
  * @example
  *
  * ```ts
@@ -53,13 +53,13 @@ export const zeroTime = pickObjectKeys(zeroDate, timeFullDateKeys);
  * ```
  */
 export function clearTime(inputFullDate) {
-    return clearParts(inputFullDate, timeFullDateKeys);
+    return clearParts(inputFullDate, getEnumValues(TimeKey));
 }
 /**
  * Clear all the selected parts of {@link FullDate} by setting them each to their lowest, valid
  * value. See {@link zeroDate} for the lowest valid values for each property.
  *
- * @category Zero
+ * @category Clear
  * @example
  *
  * ```ts

package/dist/full-date/full-date-parts.d.ts

@@ -1,4 +1,3 @@
-import type { ArrayElement } from '@augment-vir/common';
 /**
  * Represents various parts of a {@link FullDate}. Each value is also a valid "type" attribute for an
  * `<input>` HTML element.
@@ -27,22 +26,19 @@ export declare enum FullDatePart {
  *
  * @category Internal
  */
-export declare const timeFullDateKeys: readonly ["hour", "minute", "second", "millisecond"];
-/**
- * {@link FullDate} keys used for telling time only.
- *
- * @category Internal
- */
-export type TimeFullDateKeys = ArrayElement<typeof timeFullDateKeys>;
-/**
- * {@link FullDate} keys used for telling the date only.
- *
- * @category Internal
- */
-export declare const dateFullDateKeys: readonly ["year", "month", "day"];
+export declare enum TimeKey {
+    Hour = "hour",
+    Minute = "minute",
+    Second = "second",
+    Millisecond = "millisecond"
+}
 /**
  * {@link FullDate} keys used for telling the date only.
  *
  * @category Internal
  */
-export type DateFullDateKeys = ArrayElement<typeof dateFullDateKeys>;
+export declare enum DateKey {
+    Year = "year",
+    Month = "month",
+    Day = "day"
+}

package/dist/full-date/full-date-parts.js

@@ -27,19 +27,21 @@ export var FullDatePart;
  *
  * @category Internal
  */
-export const timeFullDateKeys = [
-    'hour',
-    'minute',
-    'second',
-    'millisecond',
-];
+export var TimeKey;
+(function (TimeKey) {
+    TimeKey["Hour"] = "hour";
+    TimeKey["Minute"] = "minute";
+    TimeKey["Second"] = "second";
+    TimeKey["Millisecond"] = "millisecond";
+})(TimeKey || (TimeKey = {}));
 /**
  * {@link FullDate} keys used for telling the date only.
  *
  * @category Internal
  */
-export const dateFullDateKeys = [
-    'year',
-    'month',
-    'day',
-];
+export var DateKey;
+(function (DateKey) {
+    DateKey["Year"] = "year";
+    DateKey["Month"] = "month";
+    DateKey["Day"] = "day";
+})(DateKey || (DateKey = {}));

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

@@ -1,4 +1,6 @@
 import { Overwrite, type SetRequired } from '@augment-vir/common';
+import { type DayOfMonth, type Hour, type Minute, type MonthNumber } from '@date-vir/duration';
+import type { Simplify } from 'type-fest';
 import { type Timezone } from '../timezone/timezones.js';
 /**
  * Time part of {@link FullDate} represented in a shape definition.
@@ -7,13 +9,13 @@ import { type Timezone } from '../timezone/timezones.js';
  */
 export declare const timePartShape: import("object-shape-tester").ShapeDefinition<{
     /** Hour of the day in 24 time: 0-23 */
-    hour: number;
+    hour: import("object-shape-tester").ShapeNumericRange<Hour>;
     /** Minute of the hour: 0-59 */
-    minute: number;
+    minute: import("object-shape-tester").ShapeNumericRange<Minute>;
     /** Second of the minute: 0-59 */
-    second: number;
+    second: import("object-shape-tester").ShapeNumericRange<Minute>;
     /** Millisecond of the second: 0-999 */
-    millisecond: number;
+    millisecond: import("object-shape-tester").ShapeNumericRange<number>;
     /** The timezone that this date/time is meant for / originated from. */
     timezone: Timezone;
 }, false>;
@@ -36,9 +38,9 @@ export declare const datePartShape: import("object-shape-tester").ShapeDefinitio
      */
     year: number;
     /** A month of the year: 1-12 */
-    month: number;
+    month: import("object-shape-tester").ShapeNumericRange<MonthNumber>;
     /** A day of the month: 1-31 depending on the month */
-    day: number;
+    day: import("object-shape-tester").ShapeNumericRange<DayOfMonth>;
     /** The timezone that this date/time is meant for / originated from. */
     timezone: Timezone;
 }, false>;
@@ -61,20 +63,20 @@ export declare const fullDateShape: import("object-shape-tester").ShapeDefinitio
      */
     year: number;
     /** A month of the year: 1-12 */
-    month: number;
+    month: import("object-shape-tester").ShapeNumericRange<MonthNumber>;
     /** A day of the month: 1-31 depending on the month */
-    day: number;
+    day: import("object-shape-tester").ShapeNumericRange<DayOfMonth>;
     /** The timezone that this date/time is meant for / originated from. */
     timezone: Timezone;
 }, false>, import("object-shape-tester").ShapeDefinition<{
     /** Hour of the day in 24 time: 0-23 */
-    hour: number;
+    hour: import("object-shape-tester").ShapeNumericRange<Hour>;
     /** Minute of the hour: 0-59 */
-    minute: number;
+    minute: import("object-shape-tester").ShapeNumericRange<Minute>;
     /** Second of the minute: 0-59 */
-    second: number;
+    second: import("object-shape-tester").ShapeNumericRange<Minute>;
     /** Millisecond of the second: 0-999 */
-    millisecond: number;
+    millisecond: import("object-shape-tester").ShapeNumericRange<number>;
     /** The timezone that this date/time is meant for / originated from. */
     timezone: Timezone;
 }, false>]>, false>;
@@ -101,6 +103,6 @@ export declare const fullDateShape: import("object-shape-tester").ShapeDefinitio
  * };
  * ```
  */
-export type FullDate<SpecificTimezone extends Timezone = Timezone> = Overwrite<(typeof fullDateShape)['runtimeType'], {
+export type FullDate<SpecificTimezone extends Timezone = Timezone> = Simplify<Overwrite<(typeof fullDateShape)['runtimeType'], {
     timezone: SpecificTimezone;
-}>;
+}>>;

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

@@ -1,4 +1,5 @@
-import { and, defineShape } from 'object-shape-tester';
+import { dayOfMonthBounds, hourBounds, millisecondsBounds, minuteBounds, monthNumberBounds, secondBounds, } from '@date-vir/duration';
+import { and, defineShape, numericRange } from 'object-shape-tester';
 import { utcTimezone } from '../timezone/timezones.js';
 /**
  * Time part of {@link FullDate} represented in a shape definition.
@@ -7,13 +8,13 @@ import { utcTimezone } from '../timezone/timezones.js';
  */
 export const timePartShape = defineShape({
     /** Hour of the day in 24 time: 0-23 */
-    hour: 14,
+    hour: numericRange(hourBounds.min, hourBounds.max),
     /** Minute of the hour: 0-59 */
-    minute: 19,
+    minute: numericRange(minuteBounds.min, minuteBounds.max),
     /** Second of the minute: 0-59 */
-    second: 7,
+    second: numericRange(secondBounds.min, secondBounds.max),
     /** Millisecond of the second: 0-999 */
-    millisecond: 877,
+    millisecond: numericRange(millisecondsBounds.min, millisecondsBounds.max),
     /** The timezone that this date/time is meant for / originated from. */
     timezone: utcTimezone,
 });
@@ -30,9 +31,9 @@ export const datePartShape = defineShape({
      */
     year: 2023,
     /** A month of the year: 1-12 */
-    month: 6,
+    month: numericRange(monthNumberBounds.min, monthNumberBounds.max),
     /** A day of the month: 1-31 depending on the month */
-    day: 5,
+    day: numericRange(dayOfMonthBounds.min, dayOfMonthBounds.max),
     /** The timezone that this date/time is meant for / originated from. */
     timezone: utcTimezone,
 });

package/dist/full-date/luxon-date-time-conversion.js

@@ -1,4 +1,5 @@
 import { omitObjectKeys } from '@augment-vir/common';
+import { assertWrapDayOfMonth, assertWrapHour, assertWrapMillisecond, assertWrapMinute, assertWrapMonthNumber, assertWrapSecond, } from '@date-vir/duration';
 import { DateTime } from 'luxon';
 /**
  * Converts a {@link FullDate} object into a Luxon DateTime library. This is only needed if you need
@@ -30,13 +31,13 @@ export function parseLuxonDateTime(dateTimeInput, forcedTimezone) {
         throw new Error(`Invalid input: '${dateTimeInput.toISO()}'`);
     }
     return {
-        day: dateTimeInput.day,
-        month: dateTimeInput.month,
+        day: assertWrapDayOfMonth(dateTimeInput.day),
+        month: assertWrapMonthNumber(dateTimeInput.month),
         year: dateTimeInput.year,
-        hour: dateTimeInput.hour,
-        minute: dateTimeInput.minute,
-        second: dateTimeInput.second,
-        millisecond: dateTimeInput.millisecond,
+        hour: assertWrapHour(dateTimeInput.hour),
+        minute: assertWrapMinute(dateTimeInput.minute),
+        second: assertWrapSecond(dateTimeInput.second),
+        millisecond: assertWrapMillisecond(dateTimeInput.millisecond),
         timezone: forcedTimezone ?? dateTimeInput.zoneName,
     };
 }

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 export * from './date-operations/calculate-relative-date.js';
 export * from './date-operations/combine-dates.js';
+export * from './date-operations/date-position.js';
 export * from './date-operations/diff-dates.js';
+export * from './extra-utils/end.js';
 export * from './extra-utils/has-date-props.js';
 export * from './extra-utils/js-date-conversion.js';
 export * from './extra-utils/now.js';

package/dist/index.js

@@ -1,6 +1,8 @@
 export * from './date-operations/calculate-relative-date.js';
 export * from './date-operations/combine-dates.js';
+export * from './date-operations/date-position.js';
 export * from './date-operations/diff-dates.js';
+export * from './extra-utils/end.js';
 export * from './extra-utils/has-date-props.js';
 export * from './extra-utils/js-date-conversion.js';
 export * from './extra-utils/now.js';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "date-vir",
-    "version": "6.0.1",
+    "version": "7.0.0",
     "description": "Easy and explicit dates and times.",
     "keywords": [
         "date",
@@ -34,25 +34,25 @@
         "test:docs": "virmator docs check"
     },
     "dependencies": {
-        "@augment-vir/assert": "^30.1.0",
-        "@augment-vir/common": "^30.1.0",
-        "@date-vir/duration": "^6.0.0",
+        "@augment-vir/assert": "^30.6.2",
+        "@augment-vir/common": "^30.6.2",
+        "@date-vir/duration": "^7.0.0",
         "@types/luxon": "^3.4.2",
         "luxon": "^3.5.0",
-        "object-shape-tester": "^3.0.0",
+        "object-shape-tester": "^3.1.0",
         "type-fest": "^4.26.1"
     },
     "devDependencies": {
-        "@augment-vir/test": "^30.1.0",
-        "@web/dev-server-esbuild": "^1.0.2",
+        "@augment-vir/test": "^30.6.2",
+        "@web/dev-server-esbuild": "^1.0.3",
         "@web/test-runner": "^0.19.0",
         "@web/test-runner-commands": "^0.9.0",
         "@web/test-runner-playwright": "^0.11.0",
         "@web/test-runner-visual-regression": "^0.10.0",
-        "element-vir": "^22.2.2",
-        "istanbul-smart-text-reporter": "^1.1.4",
+        "element-vir": "^23.0.0",
+        "istanbul-smart-text-reporter": "^1.1.5",
         "markdown-code-example-inserter": "^3.0.0",
-        "typedoc": "^0.26.7"
+        "typedoc": "^0.26.11"
     },
     "engines": {
         "node": ">=22"