date-vir 0.0.0 → 0.1.0

package/dist/full-date/format-presets.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatPresets = void 0;
+const luxon_1 = require("luxon");
+/**
+ * Format preset re-exported from luxon to be used with toLocaleString. To see examples of all
+ * presets, go here: https://moment.github.io/luxon/#/formatting?id=presets
+ */
+exports.formatPresets = {
+    DateShort: luxon_1.DateTime.DATE_SHORT,
+    DateMed: luxon_1.DateTime.DATE_MED,
+    DateMedWithWeekday: luxon_1.DateTime.DATE_MED_WITH_WEEKDAY,
+    DateFull: luxon_1.DateTime.DATE_FULL,
+    DateHuge: luxon_1.DateTime.DATE_HUGE,
+    TimeSimple: luxon_1.DateTime.TIME_SIMPLE,
+    TimeWithSeconds: luxon_1.DateTime.TIME_WITH_SECONDS,
+    TimeWithShortOffset: luxon_1.DateTime.TIME_WITH_SHORT_OFFSET,
+    TimeWithLongOffset: luxon_1.DateTime.TIME_WITH_LONG_OFFSET,
+    Time24Simple: luxon_1.DateTime.TIME_24_SIMPLE,
+    Time24WithSeconds: luxon_1.DateTime.TIME_24_WITH_SECONDS,
+    Time24WithShortOffset: luxon_1.DateTime.TIME_24_WITH_SHORT_OFFSET,
+    Time24WithLongOffset: luxon_1.DateTime.TIME_24_WITH_LONG_OFFSET,
+    DatetimeShort: luxon_1.DateTime.DATETIME_SHORT,
+    DatetimeShortWithSeconds: luxon_1.DateTime.DATETIME_SHORT_WITH_SECONDS,
+    DatetimeMed: luxon_1.DateTime.DATETIME_MED,
+    DatetimeMedWithSeconds: luxon_1.DateTime.DATETIME_MED_WITH_SECONDS,
+    DatetimeMedWithWeekday: luxon_1.DateTime.DATETIME_MED_WITH_WEEKDAY,
+    DatetimeFull: luxon_1.DateTime.DATETIME_FULL,
+    DatetimeFullWithSeconds: luxon_1.DateTime.DATETIME_FULL_WITH_SECONDS,
+    DatetimeHuge: luxon_1.DateTime.DATETIME_HUGE,
+    DatetimeHugeWithSeconds: luxon_1.DateTime.DATETIME_HUGE_WITH_SECONDS,
+};

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

@@ -0,0 +1,65 @@
+import { Overwrite } from '@augment-vir/common';
+import { Timezone } from '../timezone/timezone-names';
+export type WithTimezone = {
+    timezone: Timezone;
+};
+export declare const timeOnlyShape: import("object-shape-tester").ShapeDefinition<{
+    /** Hour of the day in 24 time: 0-23 */
+    hour: number;
+    /** Minute of the hour: 0-59 */
+    minute: number;
+    /** Second of the minute: 0-59 */
+    second: number;
+    /** Millisecond of the second: 0-999 */
+    millisecond: number;
+    /** The timezone that this date/time is meant for / originated from. */
+    timezone: "UTC";
+}>;
+export type TimeOnly = Overwrite<(typeof timeOnlyShape)['runTimeType'], WithTimezone>;
+export declare const dateOnlyShape: import("object-shape-tester").ShapeDefinition<{
+    /**
+     * The full, four digit year.
+     *
+     * @example
+     *     2023;
+     */
+    year: number;
+    /** A month of the year: 1-12 */
+    month: number;
+    /** A day of the month: 1-31 depending on the month */
+    day: number;
+    /** The timezone that this date/time is meant for / originated from. */
+    timezone: "UTC";
+}>;
+export type DateOnly = Overwrite<(typeof dateOnlyShape)['runTimeType'], WithTimezone>;
+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: number;
+    /** A day of the month: 1-31 depending on the month */
+    day: number;
+    /** The timezone that this date/time is meant for / originated from. */
+    timezone: "UTC";
+}>, import("object-shape-tester").ShapeDefinition<{
+    /** Hour of the day in 24 time: 0-23 */
+    hour: number;
+    /** Minute of the hour: 0-59 */
+    minute: number;
+    /** Second of the minute: 0-59 */
+    second: number;
+    /** Millisecond of the second: 0-999 */
+    millisecond: number;
+    /** The timezone that this date/time is meant for / originated from. */
+    timezone: "UTC";
+}>]>>;
+/**
+ * A easily serializable (it fits into plain JSON) object that completely defines how a date is to
+ * be represented with minimal data.
+ */
+export type FullDate = Overwrite<(typeof fullDateShape)['runTimeType'], WithTimezone>;

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

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fullDateShape = exports.dateOnlyShape = exports.timeOnlyShape = void 0;
+const object_shape_tester_1 = require("object-shape-tester");
+const timezones_1 = require("../timezone/timezones");
+exports.timeOnlyShape = (0, object_shape_tester_1.defineShape)({
+    /** Hour of the day in 24 time: 0-23 */
+    hour: 14,
+    /** Minute of the hour: 0-59 */
+    minute: 19,
+    /** Second of the minute: 0-59 */
+    second: 0,
+    /** Millisecond of the second: 0-999 */
+    millisecond: 870,
+    /** The timezone that this date/time is meant for / originated from. */
+    timezone: timezones_1.utcTimezone,
+});
+exports.dateOnlyShape = (0, object_shape_tester_1.defineShape)({
+    /**
+     * The full, four digit year.
+     *
+     * @example
+     *     2023;
+     */
+    year: 2023,
+    /** A month of the year: 1-12 */
+    month: 6,
+    /** A day of the month: 1-31 depending on the month */
+    day: 5,
+    /** The timezone that this date/time is meant for / originated from. */
+    timezone: timezones_1.utcTimezone,
+});
+exports.fullDateShape = (0, object_shape_tester_1.defineShape)((0, object_shape_tester_1.and)(exports.dateOnlyShape, exports.timeOnlyShape));

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

@@ -0,0 +1,3 @@
+import { FullDate } from './full-date-shape';
+export declare function assertIsValidFullDate(input: unknown): asserts input is FullDate;
+export declare function isValidFullDate(input: unknown): input is FullDate;

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

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidFullDate = exports.assertIsValidFullDate = void 0;
+const object_shape_tester_1 = require("object-shape-tester");
+const timezone_checks_1 = require("../timezone/timezone-checks");
+const full_date_shape_1 = require("./full-date-shape");
+const luxon_date_time_conversion_1 = require("./luxon-date-time-conversion");
+function assertIsValidFullDate(input) {
+    (0, object_shape_tester_1.assertValidShape)(input, full_date_shape_1.fullDateShape);
+    (0, timezone_checks_1.assertValidTimezone)(input.timezone);
+    /** Check that the input can be converted to a luxon date correctly. */
+    (0, luxon_date_time_conversion_1.toLuxonDateTime)(input);
+}
+exports.assertIsValidFullDate = assertIsValidFullDate;
+function isValidFullDate(input) {
+    try {
+        assertIsValidFullDate(input);
+        return true;
+    }
+    catch (error) {
+        return false;
+    }
+}
+exports.isValidFullDate = isValidFullDate;

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

@@ -0,0 +1,14 @@
+import { DateTime } from 'luxon';
+import { FullDate } from './full-date-shape';
+/**
+ * Converts a 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 the date-vir functionality as it
+ * uses the Luxon library for conversions between timezones.
+ */
+export declare function toLuxonDateTime(fullDateInput: FullDate): DateTime;
+/**
+ * Convert a Luxon DateTime object into a DateTime object. Used internally inside of date-vir, but
+ * could be helpful if you need it. Usually you should prefer using the createFullDate function
+ * instead.
+ */
+export declare function parseLuxonDateTime(dateTimeInput: DateTime): FullDate;

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

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseLuxonDateTime = exports.toLuxonDateTime = void 0;
+const common_1 = require("@augment-vir/common");
+const luxon_1 = require("luxon");
+/**
+ * Converts a 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 the date-vir functionality as it
+ * uses the Luxon library for conversions between timezones.
+ */
+function toLuxonDateTime(fullDateInput) {
+    const dateTime = luxon_1.DateTime.fromObject((0, common_1.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;
+}
+exports.toLuxonDateTime = toLuxonDateTime;
+/**
+ * Convert a Luxon DateTime object into a DateTime object. Used internally inside of date-vir, but
+ * could be helpful if you need it. Usually you should prefer using the createFullDate function
+ * instead.
+ */
+function parseLuxonDateTime(dateTimeInput) {
+    if (!dateTimeInput.isValid) {
+        throw new Error(`Invalid input: '${dateTimeInput.toISO()}'`);
+    }
+    return {
+        day: dateTimeInput.day,
+        month: dateTimeInput.month,
+        year: dateTimeInput.year,
+        hour: dateTimeInput.hour,
+        minute: dateTimeInput.minute,
+        second: dateTimeInput.second,
+        millisecond: dateTimeInput.millisecond,
+        timezone: dateTimeInput.zoneName,
+    };
+}
+exports.parseLuxonDateTime = parseLuxonDateTime;

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

@@ -0,0 +1,27 @@
+import { Timezone } from '../timezone/timezone-names';
+import { FullDate } from './full-date-shape';
+/**
+ * Parses any strangely formatted dateString using the given formatString and timezone.
+ *
+ * This is much more flexible than createFullDate but createFullDate should be preferred in
+ * situations where it works.
+ *
+ * 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, }: {
+    /** 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: Timezone;
+}): FullDate;
+/**
+ * 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(elementOrValue: HTMLInputElement | string | null | undefined, timezone: Timezone): FullDate;

package/dist/full-date/parsing.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseInputElementValue = exports.parseStrangeString = void 0;
+const common_1 = require("@augment-vir/common");
+const luxon_1 = require("luxon");
+const create_full_date_1 = require("./create-full-date");
+const luxon_date_time_conversion_1 = require("./luxon-date-time-conversion");
+/**
+ * Parses any strangely formatted dateString using the given formatString and timezone.
+ *
+ * This is much more flexible than createFullDate but createFullDate should be preferred in
+ * situations where it works.
+ *
+ * The formatString input is passed to Luxon. All format options are listed here:
+ * https://moment.github.io/luxon/#/parsing?id=table-of-tokens
+ */
+function parseStrangeString({ dateString, formatString, timezone, }) {
+    try {
+        const dateTime = luxon_1.DateTime.fromFormat(dateString, formatString, {
+            zone: timezone,
+            setZone: true,
+        });
+        return (0, luxon_date_time_conversion_1.parseLuxonDateTime)(dateTime);
+    }
+    catch (error) {
+        throw new Error(`Failed to parse string '${dateString}' with format '${formatString}'`);
+    }
+}
+exports.parseStrangeString = parseStrangeString;
+/**
+ * Read either an HTMLInputElement's value directly, or the value string retrieved from an
+ * HTMLInputElement. Handles both type="date" and type="time" <input> elements.
+ */
+function parseInputElementValue(elementOrValue, timezone) {
+    if (!elementOrValue) {
+        throw new Error('Cannot parse an empty element.');
+    }
+    const value = (0, common_1.isRuntimeTypeOf)(elementOrValue, 'string')
+        ? elementOrValue
+        : elementOrValue.value;
+    return (0, create_full_date_1.createFullDate)(value, timezone);
+}
+exports.parseInputElementValue = parseInputElementValue;

package/dist/full-date/primitive-conversions.d.ts

@@ -0,0 +1,42 @@
+import { PartialAndUndefined } from '@augment-vir/common';
+import { FullDate } from './full-date-shape';
+import { JustDateString, JustTimeString, JustTimeWithSecondsString, UtcIsoString } from './string-format-types';
+/** Convert a FullDate into a unix timestamp with milliseconds. */
+export declare function toTimestamp(fullDate: FullDate): number;
+/** Convert a FullDate into an ISO string in UTC; always ends in Z. */
+export declare function toIsoString(fullDate: FullDate): UtcIsoString;
+/** Converts the given FullDate into a string in the user's locale, or the given localeOverride. */
+export declare function toLocaleString(fullDate: FullDate, formatOptions?: (Intl.DateTimeFormatOptions & PartialAndUndefined<{
+    locale: string;
+}>) | undefined): string;
+/**
+ * Provides arbitrary date formatting using Luxon. For full details on the options for the format
+ * string input, see https://moment.github.io/luxon/#/formatting?id=table-of-tokens
+ *
+ * You probably should **prefer toLocaleString** so your users see the format they expect. It
+ * already has many formatting options.
+ */
+export declare function toFormattedString(fullDate: FullDate, format: string, localeOverride?: string): string;
+/**
+ * The different options for the "type" attribute in an <input> element that require specific
+ * formatting relevant to dates.
+ */
+export declare enum HtmlInputElementTypeEnum {
+    Date = "date",
+    Time = "time"
+}
+/**
+ * Converts a FullDate object into a string that is understood by type="date" or type="time"
+ * HTMLInputElement instances. Can optionally include seconds as well for type="time".
+ *
+ * This does NO timezone operations, the literal stored date and time are simply concatenated into a
+ * string. If you wish to convert time zones, first call createFullDate and give it a different time
+ * zone.
+ */
+export declare function toHtmlInputString(fullDate: FullDate, inputType: HtmlInputElementTypeEnum.Date): JustDateString;
+export declare function toHtmlInputString(fullDate: FullDate, inputType: HtmlInputElementTypeEnum.Time, includeSeconds?: false | undefined): JustTimeString;
+export declare function toHtmlInputString(fullDate: FullDate, inputType: HtmlInputElementTypeEnum.Time, includeSeconds: true): JustTimeWithSecondsString;
+export declare function toHtmlInputString(fullDate: FullDate, inputType: HtmlInputElementTypeEnum.Time, includeSeconds?: boolean | undefined): JustTimeWithSecondsString | JustTimeString;
+export declare function toHtmlInputString(fullDate: FullDate, inputType: HtmlInputElementTypeEnum, includeSeconds: true): JustDateString | JustTimeWithSecondsString;
+export declare function toHtmlInputString(fullDate: FullDate, inputType: HtmlInputElementTypeEnum, includeSeconds?: false | undefined): JustDateString | JustTimeString;
+export declare function toHtmlInputString(fullDate: FullDate, inputType: HtmlInputElementTypeEnum, includeSeconds?: boolean | undefined): JustDateString | JustTimeWithSecondsString | JustTimeString;

package/dist/full-date/primitive-conversions.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toHtmlInputString = exports.HtmlInputElementTypeEnum = exports.toFormattedString = exports.toLocaleString = exports.toIsoString = exports.toTimestamp = void 0;
+const common_1 = require("@augment-vir/common");
+const locales_1 = require("../locales");
+const timezones_1 = require("../timezone/timezones");
+const luxon_date_time_conversion_1 = require("./luxon-date-time-conversion");
+/** Convert a FullDate into a unix timestamp with milliseconds. */
+function toTimestamp(fullDate) {
+    return (0, luxon_date_time_conversion_1.toLuxonDateTime)(fullDate).toMillis();
+}
+exports.toTimestamp = toTimestamp;
+/** Convert a FullDate into an ISO string in UTC; always ends in Z. */
+function toIsoString(fullDate) {
+    const isoString = (0, luxon_date_time_conversion_1.toLuxonDateTime)(fullDate).setZone(timezones_1.utcTimezone).toISO();
+    /** Ignore this edge case in the types and idk how to trigger it. */
+    /* c8 ignore next 3 */
+    if (!isoString) {
+        throw new Error(`Unable to get ISO string for '${JSON.stringify(fullDate)}'`);
+    }
+    return isoString;
+}
+exports.toIsoString = toIsoString;
+/** Converts the given FullDate into a string in the user's locale, or the given localeOverride. */
+function toLocaleString(fullDate, formatOptions) {
+    return (0, luxon_date_time_conversion_1.toLuxonDateTime)(fullDate).toLocaleString({
+        ...formatOptions,
+    }, {
+        locale: formatOptions?.locale ?? locales_1.userLocale,
+    });
+}
+exports.toLocaleString = toLocaleString;
+/**
+ * Provides arbitrary date formatting using Luxon. For full details on the options for the format
+ * string input, see https://moment.github.io/luxon/#/formatting?id=table-of-tokens
+ *
+ * You probably should **prefer toLocaleString** so your users see the format they expect. It
+ * already has many formatting options.
+ */
+function toFormattedString(fullDate, format, localeOverride = locales_1.userLocale) {
+    return (0, luxon_date_time_conversion_1.toLuxonDateTime)(fullDate).toFormat(format, { locale: localeOverride });
+}
+exports.toFormattedString = toFormattedString;
+/**
+ * The different options for the "type" attribute in an <input> element that require specific
+ * formatting relevant to dates.
+ */
+var HtmlInputElementTypeEnum;
+(function (HtmlInputElementTypeEnum) {
+    HtmlInputElementTypeEnum["Date"] = "date";
+    HtmlInputElementTypeEnum["Time"] = "time";
+})(HtmlInputElementTypeEnum = exports.HtmlInputElementTypeEnum || (exports.HtmlInputElementTypeEnum = {}));
+function toHtmlInputString(fullDate, inputType, includeSeconds) {
+    if (inputType === HtmlInputElementTypeEnum.Date) {
+        const dateParts = [
+            fullDate.year,
+            String(fullDate.month).padStart(2, '0'),
+            String(fullDate.day).padStart(2, '0'),
+        ];
+        return dateParts.join('-');
+    }
+    else if (inputType === HtmlInputElementTypeEnum.Time) {
+        const timeParts = [
+            String(fullDate.hour).padStart(2, '0'),
+            String(fullDate.minute).padStart(2, '0'),
+            includeSeconds ? String(fullDate.second).padStart(2, '0') : undefined,
+        ].filter((entry) => entry != undefined);
+        return timeParts.join(':');
+    }
+    else {
+        throw new Error(`Unexpected inputTyped: '${inputType}'. Expected usage of HtmlInputElementTypeEnum or one of ${(0, common_1.getEnumTypedValues)(HtmlInputElementTypeEnum).join(', ')}.`);
+    }
+}
+exports.toHtmlInputString = toHtmlInputString;

package/dist/full-date/string-format-types.d.ts

@@ -0,0 +1,4 @@
+export type JustDateString = `${number}-${number}-${number}`;
+export type JustTimeWithSecondsString = `${number}:${number}:${number}`;
+export type JustTimeString = `${number}:${number}`;
+export type UtcIsoString = `${JustDateString}T${JustTimeWithSecondsString}.${number}Z`;

package/dist/full-date/string-format-types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+export * from './full-date/create-full-date';
+export * from './full-date/date-like';
+export * from './full-date/format-presets';
+export * from './full-date/full-date-shape';
+export * from './full-date/is-valid-full-date';
+export * from './full-date/luxon-date-time-conversion';
+export * from './full-date/parsing';
+export * from './full-date/primitive-conversions';
+export * from './full-date/string-format-types';
+export * from './locales';
+export * from './timezone/timezone-checks';
+export * from './timezone/timezone-names';
+export * from './timezone/timezones';

package/dist/index.js

@@ -0,0 +1,29 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./full-date/create-full-date"), exports);
+__exportStar(require("./full-date/date-like"), exports);
+__exportStar(require("./full-date/format-presets"), exports);
+__exportStar(require("./full-date/full-date-shape"), exports);
+__exportStar(require("./full-date/is-valid-full-date"), exports);
+__exportStar(require("./full-date/luxon-date-time-conversion"), exports);
+__exportStar(require("./full-date/parsing"), exports);
+__exportStar(require("./full-date/primitive-conversions"), exports);
+__exportStar(require("./full-date/string-format-types"), exports);
+__exportStar(require("./locales"), exports);
+__exportStar(require("./timezone/timezone-checks"), exports);
+__exportStar(require("./timezone/timezone-names"), exports);
+__exportStar(require("./timezone/timezones"), exports);

package/dist/locales.d.ts

@@ -0,0 +1 @@
+export declare const userLocale: string;

package/dist/locales.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.userLocale = void 0;
+const luxon_1 = require("luxon");
+exports.userLocale = luxon_1.Settings.defaultLocale;

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

@@ -0,0 +1,17 @@
+import { Timezone } from './timezone-names';
+/**
+ * Asserts that the given timezoneName is a valid timezone name.
+ *
+ * Note that this may actually allow names beyond what is currently in the exact TimezoneName type,
+ * because this function uses luxon to check that it is able to generate a date with the given
+ * timezone, regardless of whether it's in our typed list or not.
+ */
+export declare function assertValidTimezone(potentialTimezoneName: string): asserts potentialTimezoneName is Timezone;
+/**
+ * Checks that the given timezoneName is a valid timezone name.
+ *
+ * Note that this may actually allow names beyond what is currently in the exact TimezoneName type,
+ * because this function uses luxon to check that it is able to generate a date with the given
+ * timezone, regardless of whether it's in our typed list or not.
+ */
+export declare function isValidTimezone(potentialTimezoneName: string): potentialTimezoneName is Timezone;

package/dist/timezone/timezone-checks.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidTimezone = exports.assertValidTimezone = void 0;
+const luxon_1 = require("luxon");
+/**
+ * Asserts that the given timezoneName is a valid timezone name.
+ *
+ * Note that this may actually allow names beyond what is currently in the exact TimezoneName type,
+ * because this function uses luxon to check that it is able to generate a date with the given
+ * timezone, regardless of whether it's in our typed list or not.
+ */
+function assertValidTimezone(potentialTimezoneName) {
+    if (!luxon_1.Info.isValidIANAZone(potentialTimezoneName)) {
+        throw new Error(`'${potentialTimezoneName}' is not a valid time zone`);
+    }
+}
+exports.assertValidTimezone = assertValidTimezone;
+/**
+ * Checks that the given timezoneName is a valid timezone name.
+ *
+ * Note that this may actually allow names beyond what is currently in the exact TimezoneName type,
+ * because this function uses luxon to check that it is able to generate a date with the given
+ * timezone, regardless of whether it's in our typed list or not.
+ */
+function isValidTimezone(potentialTimezoneName) {
+    try {
+        assertValidTimezone(potentialTimezoneName);
+        return true;
+    }
+    catch (error) {
+        return false;
+    }
+}
+exports.isValidTimezone = isValidTimezone;

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

@@ -0,0 +1,9 @@
+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:
+ *
+ * Intl.supportedValuesOf('timeZone').map(zone => `'${zone}'`).join(',')
+ */
+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>;