date-vir 5.2.0 → 5.3.0

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

@@ -1,7 +1,8 @@
 import { AnyDuration } from '../duration/duration';
 import { FullDate } from '../full-date/full-date-shape';
+import { Timezone } from '../timezone/timezone-names';
 /**
  * Calculates a new date starting at the given fullDate and adding the given offsets. Offsets can be
  * negative to go backwards in time.
  */
-export declare function calculateRelativeDate(fullDate: Readonly<FullDate>, offset: Readonly<AnyDuration>): FullDate;
+export declare function calculateRelativeDate<const SpecificTimezone extends Timezone>(fullDate: Readonly<FullDate<SpecificTimezone>>, offset: Readonly<AnyDuration>): FullDate<SpecificTimezone>;

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

@@ -1,34 +1,35 @@
 import { DatePart, FullDate, FullDatePartEnum, TimePart } from '../full-date/full-date-shape';
+import { Timezone } from '../timezone/timezone-names';
 /** An object containing date and/or time parts or neither. */
-type MaybeDateParts = Partial<{
-    [FullDatePartEnum.Date]: DatePart | undefined | Partial<FullDate>;
-    [FullDatePartEnum.Time]: TimePart | undefined | Partial<FullDate>;
+type MaybeDateParts<SpecificTimezone extends Timezone> = Partial<{
+    [FullDatePartEnum.Date]: DatePart<SpecificTimezone> | undefined | Partial<FullDate<SpecificTimezone>>;
+    [FullDatePartEnum.Time]: TimePart<SpecificTimezone> | undefined | Partial<FullDate<SpecificTimezone>>;
 }>;
 /** A full date, time or date parts of a date, or undefined. */
-export type MaybeDatePart = FullDate | Partial<FullDate> | DatePart | TimePart | undefined;
-export declare function combineDateParts(maybeDateParts: {
-    [FullDatePartEnum.Date]: DatePart;
-    [FullDatePartEnum.Time]: TimePart;
-}): FullDate;
-export declare function combineDateParts(maybeDateParts: {
+export type MaybeDatePart<SpecificTimezone extends Timezone> = FullDate<SpecificTimezone> | Partial<FullDate<SpecificTimezone>> | DatePart<SpecificTimezone> | TimePart<SpecificTimezone> | undefined;
+export declare function combineDateParts<const SpecificTimezone extends Timezone>(maybeDateParts: {
+    [FullDatePartEnum.Date]: DatePart<SpecificTimezone>;
+    [FullDatePartEnum.Time]: TimePart<SpecificTimezone>;
+}): FullDate<SpecificTimezone>;
+export declare function combineDateParts<const SpecificTimezone extends Timezone>(maybeDateParts: {
     [FullDatePartEnum.Date]?: undefined;
     [FullDatePartEnum.Time]?: undefined;
 }): undefined;
-export declare function combineDateParts(maybeDateParts: {
-    [FullDatePartEnum.Date]: DatePart;
+export declare function combineDateParts<const SpecificTimezone extends Timezone>(maybeDateParts: {
+    [FullDatePartEnum.Date]: DatePart<SpecificTimezone>;
     [FullDatePartEnum.Time]?: undefined;
-}): DatePart;
-export declare function combineDateParts(maybeDateParts: {
-    [FullDatePartEnum.Date]: DatePart;
-    [FullDatePartEnum.Time]?: TimePart | undefined | Partial<FullDate>;
-}): FullDate | DatePart;
-export declare function combineDateParts(maybeDateParts: {
+}): DatePart<SpecificTimezone>;
+export declare function combineDateParts<const SpecificTimezone extends Timezone>(maybeDateParts: {
+    [FullDatePartEnum.Date]: DatePart<SpecificTimezone>;
+    [FullDatePartEnum.Time]?: TimePart<SpecificTimezone> | undefined | Partial<FullDate<SpecificTimezone>>;
+}): FullDate<SpecificTimezone> | DatePart<SpecificTimezone>;
+export declare function combineDateParts<const SpecificTimezone extends Timezone>(maybeDateParts: {
     [FullDatePartEnum.Date]?: undefined;
-    [FullDatePartEnum.Time]: TimePart;
-}): TimePart;
-export declare function combineDateParts(maybeDateParts: {
-    [FullDatePartEnum.Date]?: DatePart | undefined | Partial<FullDate>;
-    [FullDatePartEnum.Time]: TimePart;
-}): FullDate | TimePart;
-export declare function combineDateParts(maybeDateParts: MaybeDateParts): MaybeDatePart;
+    [FullDatePartEnum.Time]: TimePart<SpecificTimezone>;
+}): TimePart<SpecificTimezone>;
+export declare function combineDateParts<const SpecificTimezone extends Timezone>(maybeDateParts: {
+    [FullDatePartEnum.Date]?: DatePart<SpecificTimezone> | undefined | Partial<FullDate<SpecificTimezone>>;
+    [FullDatePartEnum.Time]: TimePart<SpecificTimezone>;
+}): FullDate<SpecificTimezone> | TimePart<SpecificTimezone>;
+export declare function combineDateParts<const SpecificTimezone extends Timezone>(maybeDateParts: MaybeDateParts<SpecificTimezone>): MaybeDatePart<SpecificTimezone>;
 export {};

package/dist/esm/extra-utils/date-transforms.d.ts

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

package/dist/esm/extra-utils/has-date-props.d.ts

@@ -1,8 +1,9 @@
 import { PartialAndUndefined, RequiredAndNotNullBy } from '@augment-vir/common';
 import { FullDate } from '../full-date/full-date-shape';
-export declare function hasDateProps<PartialFullDate extends PartialAndUndefined<FullDate>, 
+import { Timezone } from '../timezone/timezone-names';
+export declare function hasDateProps<SpecificTimezone extends Timezone, PartialFullDate extends PartialAndUndefined<FullDate<SpecificTimezone>>, 
 /** A union of strings. */
-RequiredKeysUnion extends keyof FullDate>(dateInput: PartialAndUndefined<FullDate>, keys: ReadonlyArray<RequiredKeysUnion>): dateInput is RequiredAndNotNullBy<PartialFullDate, RequiredKeysUnion>;
-export declare function assertHasDateProps<PartialFullDate extends PartialAndUndefined<FullDate>, 
+RequiredKeysUnion extends keyof FullDate<SpecificTimezone>>(dateInput: PartialAndUndefined<FullDate<SpecificTimezone>>, keys: ReadonlyArray<RequiredKeysUnion>): dateInput is RequiredAndNotNullBy<PartialFullDate, RequiredKeysUnion>;
+export declare function assertHasDateProps<SpecificTimezone extends Timezone, PartialFullDate extends PartialAndUndefined<FullDate<SpecificTimezone>>, 
 /** A union of strings. */
-RequiredKeysUnion extends keyof FullDate>(dateInput: PartialAndUndefined<FullDate>, keys: ReadonlyArray<RequiredKeysUnion>): asserts dateInput is RequiredAndNotNullBy<PartialFullDate, RequiredKeysUnion>;
+RequiredKeysUnion extends keyof FullDate<SpecificTimezone>>(dateInput: PartialAndUndefined<FullDate<SpecificTimezone>>, keys: ReadonlyArray<RequiredKeysUnion>): asserts dateInput is RequiredAndNotNullBy<PartialFullDate, RequiredKeysUnion>;

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

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

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

@@ -8,7 +8,7 @@ export declare function createUtcFullDate(dateLike: Readonly<DateLike>): FullDat
  * Parses the given dateLike and then reads the fullDate properties from that parsed value as if it
  * were in the given timezone.
  */
-export declare function createFullDate<const SpecificTimezone extends Timezone = Timezone>(
+export declare function createFullDate<const SpecificTimezone extends Timezone>(
 /** The original date representation to be converted into a FullDate. */
 dateLike: Readonly<DateLike>, 
 /** The timezone that this date/time is meant for / originated from. */
@@ -17,5 +17,5 @@ timezone: SpecificTimezone): FullDate<SpecificTimezone>;
  * Creates and returns a new FullDate object with its values shifted to be the same original time
  * but represented in a new timezone.
  */
-export declare function toNewTimezone<const SpecificTimezone extends Timezone = Timezone>(fullDate: Readonly<FullDate>, timezone: SpecificTimezone): FullDate<SpecificTimezone>;
-export declare function getNowFullDate<const SpecificTimezone extends Timezone = Timezone>(timezone: SpecificTimezone): FullDate<SpecificTimezone>;
+export declare function toNewTimezone<const SpecificTimezone extends Timezone>(fullDate: Readonly<FullDate>, timezone: SpecificTimezone): FullDate<SpecificTimezone>;
+export declare function getNowFullDate<const SpecificTimezone extends Timezone>(timezone: SpecificTimezone): FullDate<SpecificTimezone>;

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

@@ -1,4 +1,5 @@
 import { DateTime } from 'luxon';
+import { Timezone } from '../timezone/timezone-names';
 import { FullDate } from './full-date-shape';
 /** Types that can be converted into dates. */
-export type DateLike = string | Date | number | DateTime | FullDate;
+export type DateLike<SpecificTimezone extends Timezone = Timezone> = string | Date | number | DateTime | FullDate<SpecificTimezone>;

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

@@ -12,4 +12,4 @@ export declare function toLuxonDateTime(fullDateInput: FullDate): DateTime;
  * could be helpful if you need it. Usually you should prefer using the createFullDate function
  * instead.
  */
-export declare function parseLuxonDateTime<const SpecificTimezone extends Timezone = Timezone>(dateTimeInput: DateTime, forcedTimezone?: SpecificTimezone): FullDate<SpecificTimezone>;
+export declare function parseLuxonDateTime<const SpecificTimezone extends Timezone>(dateTimeInput: DateTime, forcedTimezone?: SpecificTimezone): FullDate<SpecificTimezone>;

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

@@ -9,7 +9,7 @@ import { FullDate } from './full-date-shape';
  * The formatString input is passed to Luxon. All format options are listed here:
  * https://moment.github.io/luxon/#/parsing?id=table-of-tokens
  */
-export declare function parseStrangeString({ dateString, formatString, timezone, }: {
+export declare function parseStrangeString<const SpecificTimezone extends Timezone>({ dateString, formatString, timezone, }: {
     /** The date string to be parsed. */
     dateString: string;
     /**
@@ -18,10 +18,10 @@ export declare function parseStrangeString({ dateString, formatString, timezone,
      */
     formatString: string;
     /** The timezone that this date/time is meant for / originated from. */
-    timezone: Timezone;
-}): FullDate;
+    timezone: SpecificTimezone;
+}): FullDate<SpecificTimezone>;
 /**
  * Read either an HTMLInputElement's value directly, or the value string retrieved from an
  * HTMLInputElement. Handles both type="date" and type="time" <input> elements.
  */
-export declare function parseInputElementValue<const SpecificTimezone extends Timezone = Timezone>(elementOrValue: HTMLInputElement | string | null | undefined, timezone: SpecificTimezone): FullDate<SpecificTimezone> | undefined;
+export declare function parseInputElementValue<const SpecificTimezone extends Timezone>(elementOrValue: HTMLInputElement | string | null | undefined, timezone: SpecificTimezone): FullDate<SpecificTimezone> | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "date-vir",
-    "version": "5.2.0",
+    "version": "5.3.0",
     "description": "Easy and explicit dates and times",
     "keywords": [
         "date",
@@ -41,27 +41,27 @@
         "test:watch": "web-test-runner --watch --color --config configs/web-test-runner.config.mjs"
     },
     "dependencies": {
-        "@augment-vir/common": "^28.0.0",
+        "@augment-vir/common": "^28.0.2",
         "@types/luxon": "^3.4.2",
         "luxon": "^3.4.4",
         "object-shape-tester": "^2.3.2",
-        "type-fest": "^4.18.2"
+        "type-fest": "^4.18.3"
     },
     "devDependencies": {
-        "@augment-vir/browser": "^28.0.0",
-        "@augment-vir/browser-testing": "^28.0.0",
+        "@augment-vir/browser": "^28.0.2",
+        "@augment-vir/browser-testing": "^28.0.2",
         "@open-wc/testing": "^4.0.0",
         "@types/chai": "^4.3.16",
         "@types/mocha": "^10.0.6",
         "@web/dev-server-esbuild": "^1.0.2",
-        "@web/test-runner": "^0.18.1",
+        "@web/test-runner": "^0.18.2",
         "@web/test-runner-commands": "^0.9.0",
         "@web/test-runner-playwright": "^0.11.0",
         "@web/test-runner-visual-regression": "^0.9.0",
-        "cspell": "^8.8.1",
+        "cspell": "^8.8.3",
         "dependency-cruiser": "^16.3.2",
         "element-vir": "^22.2.2",
-        "esbuild": "^0.21.1",
+        "esbuild": "^0.21.4",
         "istanbul-smart-text-reporter": "^1.1.4",
         "markdown-code-example-inserter": "^1.0.0",
         "npm-check-updates": "~16.12.3",
@@ -73,7 +73,7 @@
         "prettier-plugin-packagejson": "^2.5.0",
         "prettier-plugin-sort-json": "^4.0.0",
         "prettier-plugin-toml": "^2.0.1",
-        "run-time-assertions": "^1.5.0",
+        "run-time-assertions": "^1.5.1",
         "typedoc": "^0.25.13",
         "typescript": "^5.4.5",
         "virmator": "^11.5.2"