date-vir 0.1.1 → 0.2.0

package/README.md

@@ -75,7 +75,7 @@ parseStrangeString({
 
 ```TypeScript
 import {
-    HtmlInputElementTypeEnum,
+    FullDatePartEnum,
     createFullDate,
     formatPresets,
     timezones,
@@ -111,7 +111,7 @@ toLocaleString(myFullDate, formatPresets.DatetimeFull); // returns 'June 5, 2023
  * Formats the given FullDate to a string so that it is ready to be assigned to the value attribute
  * of an <input type="date" /> element.
  */
-toHtmlInputString(myFullDate, HtmlInputElementTypeEnum.Date); // returns '2023-06-05'
+toHtmlInputString(myFullDate, FullDatePartEnum.Date); // returns '2023-06-05'
 ```
 
 # Timezone

package/dist/cjs/full-date/combine-dates.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.combineDateParts = void 0;
+const full_date_shape_1 = require("./full-date-shape");
+/**
+ * Combine two parts of a FullDate objects into a filled-in FullDate. Note that the timezone is
+ * taken from the time part. If two complete FullDate objects are passed in, only the respective
+ * parts of each is used.
+ */
+function combineDateParts(partialDates) {
+    return {
+        hour: partialDates[full_date_shape_1.FullDatePartEnum.Time].hour,
+        minute: partialDates[full_date_shape_1.FullDatePartEnum.Time].minute,
+        second: partialDates[full_date_shape_1.FullDatePartEnum.Time].second,
+        millisecond: partialDates[full_date_shape_1.FullDatePartEnum.Time].millisecond,
+        timezone: partialDates[full_date_shape_1.FullDatePartEnum.Time].timezone,
+        year: partialDates[full_date_shape_1.FullDatePartEnum.Date].year,
+        month: partialDates[full_date_shape_1.FullDatePartEnum.Date].month,
+        day: partialDates[full_date_shape_1.FullDatePartEnum.Date].day,
+    };
+}
+exports.combineDateParts = combineDateParts;

package/dist/cjs/full-date/create-full-date.js

@@ -35,6 +35,9 @@ exports.createFullDate = createFullDate;
  * but represented in a new timezone.
  */
 function toNewTimezone(fullDate, timezone) {
+    if (fullDate.timezone === timezone) {
+        return fullDate;
+    }
     return createFullDate(fullDate, timezone);
 }
 exports.toNewTimezone = toNewTimezone;

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

@@ -1,8 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fullDateShape = exports.dateOnlyShape = exports.timeOnlyShape = void 0;
+exports.fullDateShape = exports.dateOnlyShape = exports.timeOnlyShape = exports.FullDatePartEnum = void 0;
 const object_shape_tester_1 = require("object-shape-tester");
 const timezones_1 = require("../timezone/timezones");
+var FullDatePartEnum;
+(function (FullDatePartEnum) {
+    FullDatePartEnum["Date"] = "date";
+    FullDatePartEnum["Time"] = "time";
+})(FullDatePartEnum = exports.FullDatePartEnum || (exports.FullDatePartEnum = {}));
 exports.timeOnlyShape = (0, object_shape_tester_1.defineShape)({
     /** Hour of the day in 24 time: 0-23 */
     hour: 14,

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

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toHtmlInputString = exports.HtmlInputElementTypeEnum = exports.toFormattedString = exports.toLocaleString = exports.toIsoString = exports.toTimestamp = void 0;
+exports.toHtmlInputString = 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 full_date_shape_1 = require("./full-date-shape");
 const luxon_date_time_conversion_1 = require("./luxon-date-time-conversion");
 /** Convert a FullDate into a unix timestamp with milliseconds. */
 function toTimestamp(fullDate) {
@@ -41,17 +42,17 @@ function toFormattedString(fullDate, format, localeOverride = locales_1.userLoca
     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) {
+    if (inputType === full_date_shape_1.FullDatePartEnum.Date) {
+        if (fullDate.year == undefined) {
+            throw new Error(`Tried to create date string but no year was provided.`);
+        }
+        if (fullDate.month == undefined) {
+            throw new Error(`Tried to create date string but no month was provided.`);
+        }
+        if (fullDate.day == undefined) {
+            throw new Error(`Tried to create date string but no day was provided.`);
+        }
         const dateParts = [
             fullDate.year,
             String(fullDate.month).padStart(2, '0'),
@@ -59,7 +60,16 @@ function toHtmlInputString(fullDate, inputType, includeSeconds) {
         ];
         return dateParts.join('-');
     }
-    else if (inputType === HtmlInputElementTypeEnum.Time) {
+    else if (inputType === full_date_shape_1.FullDatePartEnum.Time) {
+        if (includeSeconds && fullDate.second == undefined) {
+            throw new Error('Tried to include seconds in the time string but no seconds were provided.');
+        }
+        if (fullDate.hour == undefined) {
+            throw new Error(`Tried to create time string but no hour was provided.`);
+        }
+        if (fullDate.minute == undefined) {
+            throw new Error(`Tried to create time string but no minutes were provided.`);
+        }
         const timeParts = [
             String(fullDate.hour).padStart(2, '0'),
             String(fullDate.minute).padStart(2, '0'),
@@ -68,7 +78,7 @@ function toHtmlInputString(fullDate, inputType, includeSeconds) {
         return timeParts.join(':');
     }
     else {
-        throw new Error(`Unexpected inputTyped: '${inputType}'. Expected usage of HtmlInputElementTypeEnum or one of ${(0, common_1.getEnumTypedValues)(HtmlInputElementTypeEnum).join(', ')}.`);
+        throw new Error(`Unexpected inputTyped: '${inputType}'. Expected usage of FullDatePartEnum or one of ${(0, common_1.getEnumTypedValues)(full_date_shape_1.FullDatePartEnum).join(', ')}.`);
     }
 }
 exports.toHtmlInputString = toHtmlInputString;

package/dist/cjs/index.js

@@ -14,6 +14,8 @@ 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/calculate-relative-date"), exports);
+__exportStar(require("./full-date/combine-dates"), exports);
 __exportStar(require("./full-date/create-full-date"), exports);
 __exportStar(require("./full-date/date-like"), exports);
 __exportStar(require("./full-date/format-presets"), exports);

package/dist/full-date/combine-dates.d.ts

@@ -0,0 +1,10 @@
+import { DatePart, FullDate, FullDatePartEnum, TimePart } from './full-date-shape';
+/**
+ * Combine two parts of a FullDate objects into a filled-in FullDate. Note that the timezone is
+ * taken from the time part. If two complete FullDate objects are passed in, only the respective
+ * parts of each is used.
+ */
+export declare function combineDateParts(partialDates: {
+    [FullDatePartEnum.Date]: DatePart;
+    [FullDatePartEnum.Time]: TimePart;
+}): FullDate;

package/dist/full-date/combine-dates.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.combineDateParts = void 0;
+const full_date_shape_1 = require("./full-date-shape");
+/**
+ * Combine two parts of a FullDate objects into a filled-in FullDate. Note that the timezone is
+ * taken from the time part. If two complete FullDate objects are passed in, only the respective
+ * parts of each is used.
+ */
+function combineDateParts(partialDates) {
+    return {
+        hour: partialDates[full_date_shape_1.FullDatePartEnum.Time].hour,
+        minute: partialDates[full_date_shape_1.FullDatePartEnum.Time].minute,
+        second: partialDates[full_date_shape_1.FullDatePartEnum.Time].second,
+        millisecond: partialDates[full_date_shape_1.FullDatePartEnum.Time].millisecond,
+        timezone: partialDates[full_date_shape_1.FullDatePartEnum.Time].timezone,
+        year: partialDates[full_date_shape_1.FullDatePartEnum.Date].year,
+        month: partialDates[full_date_shape_1.FullDatePartEnum.Date].month,
+        day: partialDates[full_date_shape_1.FullDatePartEnum.Date].day,
+    };
+}
+exports.combineDateParts = combineDateParts;

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

@@ -35,6 +35,9 @@ exports.createFullDate = createFullDate;
  * but represented in a new timezone.
  */
 function toNewTimezone(fullDate, timezone) {
+    if (fullDate.timezone === timezone) {
+        return fullDate;
+    }
     return createFullDate(fullDate, timezone);
 }
 exports.toNewTimezone = toNewTimezone;

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

@@ -1,5 +1,9 @@
-import { Overwrite } from '@augment-vir/common';
+import { Overwrite, RequiredBy } from '@augment-vir/common';
 import { Timezone } from '../timezone/timezone-names';
+export declare enum FullDatePartEnum {
+    Date = "date",
+    Time = "time"
+}
 export type WithTimezone = {
     timezone: Timezone;
 };
@@ -15,7 +19,8 @@ export declare const timeOnlyShape: import("object-shape-tester").ShapeDefinitio
     /** The timezone that this date/time is meant for / originated from. */
     timezone: "UTC";
 }>;
-export type TimeOnly = Overwrite<(typeof timeOnlyShape)['runTimeType'], WithTimezone>;
+type TimeOnlyPart = Overwrite<(typeof timeOnlyShape)['runTimeType'], WithTimezone>;
+export type TimePart = RequiredBy<Partial<FullDate>, keyof TimeOnlyPart>;
 export declare const dateOnlyShape: import("object-shape-tester").ShapeDefinition<{
     /**
      * The full, four digit year.
@@ -31,7 +36,8 @@ export declare const dateOnlyShape: import("object-shape-tester").ShapeDefinitio
     /** The timezone that this date/time is meant for / originated from. */
     timezone: "UTC";
 }>;
-export type DateOnly = Overwrite<(typeof dateOnlyShape)['runTimeType'], WithTimezone>;
+type DateOnlyPart = Overwrite<(typeof dateOnlyShape)['runTimeType'], WithTimezone>;
+export type DatePart = RequiredBy<Partial<FullDate>, keyof DateOnlyPart>;
 export declare const fullDateShape: import("object-shape-tester").ShapeDefinition<import("object-shape-tester").ShapeAnd<[import("object-shape-tester").ShapeDefinition<{
     /**
      * The full, four digit year.
@@ -63,3 +69,4 @@ export declare const fullDateShape: import("object-shape-tester").ShapeDefinitio
  * be represented with minimal data.
  */
 export type FullDate = Overwrite<(typeof fullDateShape)['runTimeType'], WithTimezone>;
+export {};

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

@@ -1,8 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fullDateShape = exports.dateOnlyShape = exports.timeOnlyShape = void 0;
+exports.fullDateShape = exports.dateOnlyShape = exports.timeOnlyShape = exports.FullDatePartEnum = void 0;
 const object_shape_tester_1 = require("object-shape-tester");
 const timezones_1 = require("../timezone/timezones");
+var FullDatePartEnum;
+(function (FullDatePartEnum) {
+    FullDatePartEnum["Date"] = "date";
+    FullDatePartEnum["Time"] = "time";
+})(FullDatePartEnum = exports.FullDatePartEnum || (exports.FullDatePartEnum = {}));
 exports.timeOnlyShape = (0, object_shape_tester_1.defineShape)({
     /** Hour of the day in 24 time: 0-23 */
     hour: 14,

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

@@ -1,5 +1,6 @@
-import { PartialAndUndefined } from '@augment-vir/common';
-import { FullDate } from './full-date-shape';
+import { PartialAndUndefined, RequiredBy } from '@augment-vir/common';
+import { SetOptional } from 'type-fest';
+import { DatePart, FullDate, FullDatePartEnum } 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;
@@ -17,26 +18,22 @@ export declare function toLocaleString(fullDate: FullDate, formatOptions?: (Intl
  * 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"
-}
+type OnlyDatePart = SetOptional<DatePart, 'timezone'>;
+type HourMinutePart = RequiredBy<Partial<FullDate>, 'hour' | 'minute'>;
+type HourMinuteSecondPart = RequiredBy<Partial<FullDate>, 'hour' | 'minute' | 'second'>;
 /**
  * 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.
+ * This function ignores the timezone, the literal stored date and time numbers are simply
+ * concatenated into a string. If you wish to convert time zones, first call toNewTimezone on your
+ * FullDate object.
  */
-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;
+export declare function toHtmlInputString(fullDate: OnlyDatePart, inputType: FullDatePartEnum.Date): JustDateString;
+export declare function toHtmlInputString(fullDate: HourMinutePart, inputType: FullDatePartEnum.Time, includeSeconds?: false | undefined): JustTimeString;
+export declare function toHtmlInputString(fullDate: HourMinuteSecondPart, inputType: FullDatePartEnum.Time, includeSeconds: true): JustTimeWithSecondsString;
+export declare function toHtmlInputString(fullDate: HourMinutePart | HourMinuteSecondPart, inputType: FullDatePartEnum.Time, includeSeconds?: boolean | undefined): JustTimeWithSecondsString | JustTimeString;
+export declare function toHtmlInputString(fullDate: HourMinuteSecondPart | OnlyDatePart, inputType: FullDatePartEnum, includeSeconds: true): JustDateString | JustTimeWithSecondsString;
+export declare function toHtmlInputString(fullDate: HourMinutePart | OnlyDatePart, inputType: FullDatePartEnum, includeSeconds?: false | undefined): JustDateString | JustTimeString;
+export declare function toHtmlInputString(fullDate: HourMinutePart | HourMinuteSecondPart | OnlyDatePart, inputType: FullDatePartEnum, includeSeconds?: boolean | undefined): JustDateString | JustTimeWithSecondsString | JustTimeString;
+export {};

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

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toHtmlInputString = exports.HtmlInputElementTypeEnum = exports.toFormattedString = exports.toLocaleString = exports.toIsoString = exports.toTimestamp = void 0;
+exports.toHtmlInputString = 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 full_date_shape_1 = require("./full-date-shape");
 const luxon_date_time_conversion_1 = require("./luxon-date-time-conversion");
 /** Convert a FullDate into a unix timestamp with milliseconds. */
 function toTimestamp(fullDate) {
@@ -41,17 +42,17 @@ function toFormattedString(fullDate, format, localeOverride = locales_1.userLoca
     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) {
+    if (inputType === full_date_shape_1.FullDatePartEnum.Date) {
+        if (fullDate.year == undefined) {
+            throw new Error(`Tried to create date string but no year was provided.`);
+        }
+        if (fullDate.month == undefined) {
+            throw new Error(`Tried to create date string but no month was provided.`);
+        }
+        if (fullDate.day == undefined) {
+            throw new Error(`Tried to create date string but no day was provided.`);
+        }
         const dateParts = [
             fullDate.year,
             String(fullDate.month).padStart(2, '0'),
@@ -59,7 +60,16 @@ function toHtmlInputString(fullDate, inputType, includeSeconds) {
         ];
         return dateParts.join('-');
     }
-    else if (inputType === HtmlInputElementTypeEnum.Time) {
+    else if (inputType === full_date_shape_1.FullDatePartEnum.Time) {
+        if (includeSeconds && fullDate.second == undefined) {
+            throw new Error('Tried to include seconds in the time string but no seconds were provided.');
+        }
+        if (fullDate.hour == undefined) {
+            throw new Error(`Tried to create time string but no hour was provided.`);
+        }
+        if (fullDate.minute == undefined) {
+            throw new Error(`Tried to create time string but no minutes were provided.`);
+        }
         const timeParts = [
             String(fullDate.hour).padStart(2, '0'),
             String(fullDate.minute).padStart(2, '0'),
@@ -68,7 +78,7 @@ function toHtmlInputString(fullDate, inputType, includeSeconds) {
         return timeParts.join(':');
     }
     else {
-        throw new Error(`Unexpected inputTyped: '${inputType}'. Expected usage of HtmlInputElementTypeEnum or one of ${(0, common_1.getEnumTypedValues)(HtmlInputElementTypeEnum).join(', ')}.`);
+        throw new Error(`Unexpected inputTyped: '${inputType}'. Expected usage of FullDatePartEnum or one of ${(0, common_1.getEnumTypedValues)(full_date_shape_1.FullDatePartEnum).join(', ')}.`);
     }
 }
 exports.toHtmlInputString = toHtmlInputString;

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+export * from './full-date/calculate-relative-date';
+export * from './full-date/combine-dates';
 export * from './full-date/create-full-date';
 export * from './full-date/date-like';
 export * from './full-date/format-presets';

package/dist/index.js

@@ -14,6 +14,8 @@ 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/calculate-relative-date"), exports);
+__exportStar(require("./full-date/combine-dates"), exports);
 __exportStar(require("./full-date/create-full-date"), exports);
 __exportStar(require("./full-date/date-like"), exports);
 __exportStar(require("./full-date/format-presets"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "date-vir",
-    "version": "0.1.1",
+    "version": "0.2.0",
     "description": "Easy and explicit dates and times",
     "keywords": [
         "date",
@@ -42,7 +42,8 @@
         "@augment-vir/common": "^14.2.2",
         "@types/luxon": "^3.3.0",
         "luxon": "^3.3.0",
-        "object-shape-tester": "^0.2.7"
+        "object-shape-tester": "^0.2.7",
+        "type-fest": "^3.11.1"
     },
     "devDependencies": {
         "@augment-vir/browser-testing": "^14.2.2",
@@ -55,7 +56,7 @@
         "@web/test-runner-playwright": "^0.10.0",
         "@web/test-runner-visual-regression": "^0.8.0",
         "cspell": "^6.31.1",
-        "element-vir": "^13.0.2",
+        "element-vir": "^13.0.3",
         "esbuild": "^0.17.19",
         "istanbul-smart-text-reporter": "^1.1.2",
         "markdown-code-example-inserter": "^0.3.1",