date-vir 5.3.2 → 7.0.0

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

@@ -0,0 +1,108 @@
+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.
+ *
+ * @category Shape
+ */
+export declare const timePartShape: import("object-shape-tester").ShapeDefinition<{
+    /** Hour of the day in 24 time: 0-23 */
+    hour: import("object-shape-tester").ShapeNumericRange<Hour>;
+    /** Minute of the hour: 0-59 */
+    minute: import("object-shape-tester").ShapeNumericRange<Minute>;
+    /** Second of the minute: 0-59 */
+    second: import("object-shape-tester").ShapeNumericRange<Minute>;
+    /** Millisecond of the second: 0-999 */
+    millisecond: import("object-shape-tester").ShapeNumericRange<number>;
+    /** The timezone that this date/time is meant for / originated from. */
+    timezone: Timezone;
+}, false>;
+/**
+ * Time part of a {@link FullDate}.
+ *
+ * @category Internal
+ */
+export type TimePart<SpecificTimezone extends Timezone = Timezone> = SetRequired<Partial<FullDate<SpecificTimezone>>, keyof (typeof timePartShape)['runtimeType']>;
+/**
+ * Date part of {@link FullDate} represented in a shape definition.
+ *
+ * @category Shape
+ */
+export declare const datePartShape: import("object-shape-tester").ShapeDefinition<{
+    /**
+     * The full, four digit year.
+     *
+     * @example 2023;
+     */
+    year: number;
+    /** A month of the year: 1-12 */
+    month: import("object-shape-tester").ShapeNumericRange<MonthNumber>;
+    /** A day of the month: 1-31 depending on the month */
+    day: import("object-shape-tester").ShapeNumericRange<DayOfMonth>;
+    /** The timezone that this date/time is meant for / originated from. */
+    timezone: Timezone;
+}, false>;
+/**
+ * Date part of {@link FullDate}.
+ *
+ * @category Internal
+ */
+export type DatePart<SpecificTimezone extends Timezone = Timezone> = SetRequired<Partial<FullDate<SpecificTimezone>>, keyof (typeof datePartShape)['runtimeType']>;
+/**
+ * The complete {@link FullDate} represented in a shape definition.
+ *
+ * @category Shape
+ */
+export declare const fullDateShape: import("object-shape-tester").ShapeDefinition<import("object-shape-tester").ShapeAnd<[import("object-shape-tester").ShapeDefinition<{
+    /**
+     * The full, four digit year.
+     *
+     * @example 2023;
+     */
+    year: number;
+    /** A month of the year: 1-12 */
+    month: import("object-shape-tester").ShapeNumericRange<MonthNumber>;
+    /** A day of the month: 1-31 depending on the month */
+    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: import("object-shape-tester").ShapeNumericRange<Hour>;
+    /** Minute of the hour: 0-59 */
+    minute: import("object-shape-tester").ShapeNumericRange<Minute>;
+    /** Second of the minute: 0-59 */
+    second: import("object-shape-tester").ShapeNumericRange<Minute>;
+    /** Millisecond of the second: 0-999 */
+    millisecond: import("object-shape-tester").ShapeNumericRange<number>;
+    /** The timezone that this date/time is meant for / originated from. */
+    timezone: Timezone;
+}, false>]>, false>;
+/**
+ * A serializable object that completely specifies how any given date should be represented,
+ * including its timezone, to millisecond accuracy. This is the core type of the `date-vir` package,
+ * with most operations either requiring or returning this type.
+ *
+ * @category FullDate
+ * @example
+ *
+ * ```ts
+ * import {FullDate, timezones} from 'date-vir';
+ *
+ * const myDate: FullDate = {
+ *     year: 2024,
+ *     month: 6,
+ *     day: 2,
+ *     hour: 13,
+ *     minute: 32,
+ *     second: 12,
+ *     milliseconds: 94,
+ *     timezone: timezones['Australia/Brisbane'],
+ * };
+ * ```
+ */
+export type FullDate<SpecificTimezone extends Timezone = Timezone> = Simplify<Overwrite<(typeof fullDateShape)['runtimeType'], {
+    timezone: SpecificTimezone;
+}>>;

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

@@ -0,0 +1,45 @@
+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.
+ *
+ * @category Shape
+ */
+export const timePartShape = defineShape({
+    /** Hour of the day in 24 time: 0-23 */
+    hour: numericRange(hourBounds.min, hourBounds.max),
+    /** Minute of the hour: 0-59 */
+    minute: numericRange(minuteBounds.min, minuteBounds.max),
+    /** Second of the minute: 0-59 */
+    second: numericRange(secondBounds.min, secondBounds.max),
+    /** Millisecond of the second: 0-999 */
+    millisecond: numericRange(millisecondsBounds.min, millisecondsBounds.max),
+    /** The timezone that this date/time is meant for / originated from. */
+    timezone: utcTimezone,
+});
+/**
+ * Date part of {@link FullDate} represented in a shape definition.
+ *
+ * @category Shape
+ */
+export const datePartShape = defineShape({
+    /**
+     * The full, four digit year.
+     *
+     * @example 2023;
+     */
+    year: 2023,
+    /** A month of the year: 1-12 */
+    month: numericRange(monthNumberBounds.min, monthNumberBounds.max),
+    /** A day of the month: 1-31 depending on the month */
+    day: numericRange(dayOfMonthBounds.min, dayOfMonthBounds.max),
+    /** The timezone that this date/time is meant for / originated from. */
+    timezone: utcTimezone,
+});
+/**
+ * The complete {@link FullDate} represented in a shape definition.
+ *
+ * @category Shape
+ */
+export const fullDateShape = defineShape(and(datePartShape, timePartShape));

package/dist/full-date/is-valid-full-date.d.ts

@@ -0,0 +1,21 @@
+import { Timezone } from '../timezone/timezones.js';
+import { FullDate } from './full-date-shape.js';
+/**
+ * Asserts that the input is a valid {@link FullDate}.
+ *
+ * @category Assertion
+ * @throws An Error if the input is not a valid {@link FullDate}.
+ */
+export declare function assertValidFullDate(input: unknown): asserts input is FullDate;
+/**
+ * Checks and type guards that the input is a valid {@link FullDate}.
+ *
+ * @category Assertion
+ */
+export declare function isValidFullDate(input: unknown): input is FullDate;
+/**
+ * Checks and type guards that the given {@link FullDate} instance has the given timezone.
+ *
+ * @category Assertion
+ */
+export declare function hasTimezone<const SpecificTimezone extends Timezone>(input: FullDate, timezone: SpecificTimezone): input is FullDate<SpecificTimezone>;

package/dist/full-date/is-valid-full-date.js

@@ -0,0 +1,38 @@
+import { assertValidShape } from 'object-shape-tester';
+import { assertValidTimezone } from '../timezone/timezone-checks.js';
+import { fullDateShape } from './full-date-shape.js';
+import { toLuxonDateTime } from './luxon-date-time-conversion.js';
+/**
+ * Asserts that the input is a valid {@link FullDate}.
+ *
+ * @category Assertion
+ * @throws An Error if the input is not a valid {@link FullDate}.
+ */
+export function assertValidFullDate(input) {
+    assertValidShape(input, fullDateShape);
+    assertValidTimezone(input.timezone);
+    /** Check that the input can be converted to a luxon date correctly. */
+    toLuxonDateTime(input);
+}
+/**
+ * Checks and type guards that the input is a valid {@link FullDate}.
+ *
+ * @category Assertion
+ */
+export function isValidFullDate(input) {
+    try {
+        assertValidFullDate(input);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Checks and type guards that the given {@link FullDate} instance has the given timezone.
+ *
+ * @category Assertion
+ */
+export function hasTimezone(input, timezone) {
+    return input.timezone === timezone;
+}

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

@@ -0,0 +1,19 @@
+import { DateTime } from 'luxon';
+import { Timezone } from '../timezone/timezones.js';
+import { FullDate } from './full-date-shape.js';
+/**
+ * Converts a {@link FullDate} object into a Luxon DateTime library. This is only needed if you need
+ * complex operations on dates. It does, however, internally power a lot of date-vir functionality
+ * as it uses the Luxon library for conversions between timezones.
+ *
+ * @category Internal
+ */
+export declare function toLuxonDateTime(fullDateInput: Readonly<FullDate>): DateTime;
+/**
+ * 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
+ * `createFullDate` function instead.
+ *
+ * @category Internal
+ */
+export declare function parseLuxonDateTime<const SpecificTimezone extends Timezone>(dateTimeInput: Readonly<DateTime>, forcedTimezone?: SpecificTimezone): FullDate<SpecificTimezone>;

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

@@ -0,0 +1,43 @@
+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
+ * complex operations on dates. It does, however, internally power a lot of date-vir functionality
+ * as it uses the Luxon library for conversions between timezones.
+ *
+ * @category Internal
+ */
+export function toLuxonDateTime(fullDateInput) {
+    const dateTime = DateTime.fromObject(omitObjectKeys(fullDateInput, ['timezone']), {
+        zone: fullDateInput.timezone,
+    });
+    /** Ignore this edge case in coverage cause idk how to trigger it. */
+    /* c8 ignore next 3 */
+    if (!dateTime.isValid) {
+        throw new Error(dateTime.invalidExplanation ?? undefined);
+    }
+    return dateTime;
+}
+/**
+ * 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
+ * `createFullDate` function instead.
+ *
+ * @category Internal
+ */
+export function parseLuxonDateTime(dateTimeInput, forcedTimezone) {
+    if (!dateTimeInput.isValid) {
+        throw new Error(`Invalid input: '${dateTimeInput.toISO()}'`);
+    }
+    return {
+        day: assertWrapDayOfMonth(dateTimeInput.day),
+        month: assertWrapMonthNumber(dateTimeInput.month),
+        year: dateTimeInput.year,
+        hour: assertWrapHour(dateTimeInput.hour),
+        minute: assertWrapMinute(dateTimeInput.minute),
+        second: assertWrapSecond(dateTimeInput.second),
+        millisecond: assertWrapMillisecond(dateTimeInput.millisecond),
+        timezone: forcedTimezone ?? dateTimeInput.zoneName,
+    };
+}

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

@@ -0,0 +1,33 @@
+import { Timezone } from '../timezone/timezones.js';
+import { FullDate } from './full-date-shape.js';
+/**
+ * Parses any date string into a {@link FullDate} using the specified pattern and timezone. Prefer
+ * using {@link createFullDate} if possible.
+ *
+ * Since this supports any arbitrary date string pattern, it is more flexible than
+ * {@link createFullDate} but you must know the date pattern ahead of time.
+ *
+ * The `formatString` input is passed to Luxon. All format pattern options are listed here:
+ * https://moment.github.io/luxon/#/parsing?id=table-of-tokens
+ *
+ * @category FullDate
+ */
+export declare function parseDateStringWithPattern<const SpecificTimezone extends Timezone>({ dateString, formatString, timezone, }: {
+    /** The date string to be parsed. */
+    dateString: string;
+    /**
+     * The format string that should match Luxon's expectations here:
+     * https://moment.github.io/luxon/#/parsing?id=table-of-tokens
+     */
+    formatString: string;
+    /** The timezone that this date/time is meant for / originated from. */
+    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.
+ *
+ * @category FullDate
+ * @category HTML
+ */
+export declare function parseInputElementValue<const SpecificTimezone extends Timezone>(elementOrValue: Readonly<Pick<HTMLInputElement, 'value'>> | string | null | undefined, timezone: SpecificTimezone): FullDate<SpecificTimezone> | undefined;

package/dist/full-date/parsing.js

@@ -0,0 +1,47 @@
+import { check } from '@augment-vir/assert';
+import { DateTime } from 'luxon';
+import { createFullDate } from './create-full-date.js';
+import { parseLuxonDateTime } from './luxon-date-time-conversion.js';
+/**
+ * Parses any date string into a {@link FullDate} using the specified pattern and timezone. Prefer
+ * using {@link createFullDate} if possible.
+ *
+ * Since this supports any arbitrary date string pattern, it is more flexible than
+ * {@link createFullDate} but you must know the date pattern ahead of time.
+ *
+ * The `formatString` input is passed to Luxon. All format pattern options are listed here:
+ * https://moment.github.io/luxon/#/parsing?id=table-of-tokens
+ *
+ * @category FullDate
+ */
+export function parseDateStringWithPattern({ dateString, formatString, timezone, }) {
+    try {
+        const dateTime = DateTime.fromFormat(dateString, formatString, {
+            zone: timezone,
+            setZone: true,
+        });
+        return parseLuxonDateTime(dateTime);
+    }
+    catch {
+        throw new Error(`Failed to parse string '${dateString}' with format '${formatString}'`);
+    }
+}
+/**
+ * Read either an `HTMLInputElement`'s value directly, or the value string retrieved from an
+ * `HTMLInputElement`. Handles both `type="date"` and `type="time"` <input> elements.
+ *
+ * @category FullDate
+ * @category HTML
+ */
+export function parseInputElementValue(elementOrValue, timezone) {
+    if (!elementOrValue) {
+        return undefined;
+    }
+    const value = check.isString(elementOrValue) ? elementOrValue : elementOrValue.value;
+    try {
+        return createFullDate(value, timezone);
+    }
+    catch {
+        return undefined;
+    }
+}

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

@@ -0,0 +1,9 @@
+import { DateTime } from 'luxon';
+import { Timezone } from '../timezone/timezones.js';
+/**
+ * Tries extra known formats for parsing date strings, even those that browsers do not natively
+ * support.
+ *
+ * @category Internal
+ */
+export declare function parseDateString(dateString: string, timezone: Timezone): DateTime | undefined;

package/dist/{esm/full-date → full-date}/string-parsing.js

@@ -11,6 +11,12 @@ const knownStringFormats = [
     // january-2021
     'LLLL-y',
 ];
+/**
+ * Tries extra known formats for parsing date strings, even those that browsers do not natively
+ * support.
+ *
+ * @category Internal
+ */
 export function parseDateString(dateString, timezone) {
     const isoAttempt = DateTime.fromISO(dateString, { zone: timezone });
     if (isoAttempt.isValid) {

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+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';
+export * from './extra-utils/override-date.js';
+export * from './extra-utils/zero.js';
+export * from './formatting/formatted-string.js';
+export * from './formatting/html-input.js';
+export * from './formatting/relative-string.js';
+export * from './formatting/simple-strings.js';
+export * from './formatting/string-format-types.js';
+export * from './formatting/timestamp.js';
+export * from './full-date/create-full-date.js';
+export * from './full-date/date-like.js';
+export * from './full-date/format-presets.js';
+export * from './full-date/full-date-parts.js';
+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';
+export * from '@date-vir/duration';

package/dist/index.js

@@ -0,0 +1,29 @@
+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';
+export * from './extra-utils/override-date.js';
+export * from './extra-utils/zero.js';
+export * from './formatting/formatted-string.js';
+export * from './formatting/html-input.js';
+export * from './formatting/relative-string.js';
+export * from './formatting/simple-strings.js';
+export * from './formatting/string-format-types.js';
+export * from './formatting/timestamp.js';
+export * from './full-date/create-full-date.js';
+export * from './full-date/date-like.js';
+export * from './full-date/format-presets.js';
+export * from './full-date/full-date-parts.js';
+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';
+export * from '@date-vir/duration';

package/dist/locales.d.ts

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

package/dist/locales.js

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

package/dist/timezone/timezone-checks.d.ts

@@ -0,0 +1,21 @@
+import { Timezone } from './timezones.js';
+/**
+ * Asserts that the given input is a valid timezone name.
+ *
+ * Note that this may actually allow names beyond what is currently in the exact {@link Timezone}
+ * type, because this function checks to see if the given timezone can be used to construct a date,
+ * regardless of whether it's in our typed list or not.
+ *
+ * @category Assertion
+ */
+export declare function assertValidTimezone(potentialTimezone: string, userMessage?: string | undefined): asserts potentialTimezone is Timezone;
+/**
+ * Checks that the given timezone is valid.
+ *
+ * Note that this may actually allow names beyond what is currently in the exact {@link Timezone}
+ * type, because this function checks to see if the given timezone can be used to construct a date,
+ * regardless of whether it's in our typed list or not.
+ *
+ * @category Assertion
+ */
+export declare function isValidTimezone(potentialTimezone: string): potentialTimezone is Timezone;

package/dist/timezone/timezone-checks.js

@@ -0,0 +1,34 @@
+import { AssertionError } from '@augment-vir/assert';
+import { Info } from 'luxon';
+/**
+ * Asserts that the given input is a valid timezone name.
+ *
+ * Note that this may actually allow names beyond what is currently in the exact {@link Timezone}
+ * type, because this function checks to see if the given timezone can be used to construct a date,
+ * regardless of whether it's in our typed list or not.
+ *
+ * @category Assertion
+ */
+export function assertValidTimezone(potentialTimezone, userMessage) {
+    if (!Info.isValidIANAZone(potentialTimezone)) {
+        throw new AssertionError(`'${potentialTimezone}' is not a valid time zone`, userMessage);
+    }
+}
+/**
+ * Checks that the given timezone is valid.
+ *
+ * Note that this may actually allow names beyond what is currently in the exact {@link Timezone}
+ * type, because this function checks to see if the given timezone can be used to construct a date,
+ * regardless of whether it's in our typed list or not.
+ *
+ * @category Assertion
+ */
+export function isValidTimezone(potentialTimezone) {
+    try {
+        assertValidTimezone(potentialTimezone);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}

package/dist/{esm/timezone → timezone}/timezone-names.d.ts

@@ -1,9 +1,15 @@
-import { ArrayElement } from '@augment-vir/common';
 /**
- * This list was generated from Firefox 106.0.2 (which gave me the longest list out of all the
- * browsers I had immediately available to me at the time) with the following code:
+ * All valid timezone names.
  *
- * Intl.supportedValuesOf('timeZone').map(zone => `'${zone}'`).join(',')
+ * The list of timezone names was generated from Firefox 106.0.2 (which gave me the longest list out
+ * of all the browsers I had available to me) with the following code:
+ *
+ * ```ts
+ * Intl.supportedValuesOf('timeZone')
+ *     .map((zone) => `'${zone}'`)
+ *     .join(',');
+ * ```
+ *
+ * @category Timezone
  */
 export declare const allTimezoneNames: readonly ["Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Coral_Harbour", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fortaleza", "America/Glace_Bay", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Maceio", "America/Managua", "America/Manaus", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Sitka", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Colombo", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Riyadh", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ulaanbaatar", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/Perth", "Australia/Sydney", "CET", "CST6CDT", "EET", "EST", "EST5EDT", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kirov", "Europe/Kyiv", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Oslo", "Europe/Paris", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "Factory", "HST", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "MET", "MST", "MST7MDT", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Wake", "Pacific/Wallis", "UTC", "WET"];
-export type Timezone = ArrayElement<typeof allTimezoneNames>;

package/dist/{esm/timezone → timezone}/timezone-names.js

@@ -1,8 +1,16 @@
 /**
- * This list was generated from Firefox 106.0.2 (which gave me the longest list out of all the
- * browsers I had immediately available to me at the time) with the following code:
+ * All valid timezone names.
  *
- * Intl.supportedValuesOf('timeZone').map(zone => `'${zone}'`).join(',')
+ * The list of timezone names was generated from Firefox 106.0.2 (which gave me the longest list out
+ * of all the browsers I had available to me) with the following code:
+ *
+ * ```ts
+ * Intl.supportedValuesOf('timeZone')
+ *     .map((zone) => `'${zone}'`)
+ *     .join(',');
+ * ```
+ *
+ * @category Timezone
  */
 export const allTimezoneNames = [
     'Africa/Abidjan',

package/dist/timezone/timezones.d.ts

@@ -0,0 +1,42 @@
+import type { ArrayElement } from '@augment-vir/common';
+import { allTimezoneNames } from './timezone-names.js';
+/**
+ * All possible timezone names.
+ *
+ * @category Timezone
+ * @see {@link allTimezoneNames}
+ */
+export type Timezone = ArrayElement<typeof allTimezoneNames>;
+/**
+ * An enum of all possible timezone names.
+ *
+ * @category Timezone
+ * @example
+ *
+ * ```ts
+ * import {Timezone} from 'date-vir';
+ *
+ * Timezone['Africa/Bamako'];
+ * ```
+ */
+export declare const Timezone: Readonly<{
+    [SpecificTimezoneName in Timezone]: SpecificTimezoneName;
+}>;
+/**
+ * The timezone of the current user's environment.
+ *
+ * @category Timezone
+ */
+export declare const userTimezone: Timezone;
+/**
+ * The UTC timezone.
+ *
+ * @category Timezone
+ */
+export declare const utcTimezone: "UTC";
+/**
+ * The UTC timezone as a type.
+ *
+ * @category Timezone
+ */
+export type UtcTimezone = typeof utcTimezone;