@dereekb/date 10.1.2 → 10.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/date",
-  "version": "10.1.2",
+  "version": "10.1.3",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",

package/src/lib/date/date.cell.d.ts

@@ -125,7 +125,7 @@ export type DateCellDurationSpan<B extends DateCell = DateCell> = DateDurationSp
 /**
  * The DateRange input for dateCellTiming()
  */
-export type DateCellTimingRangeInput = Pick<DateRangeDayDistanceInput, 'distance'> | DateRange | number;
+export type DateCellTimingRangeInput = DateRangeDayDistanceInput | DateRange | number;
 /**
  * Can use any timezone instance that has a timezone configured, or is using the
  */
@@ -187,7 +187,7 @@ export declare function isValidDateCellTimingStartDate(date: Date): boolean;
  *
  * The start date from the inputDate is considered to to have the offset noted in DateCell, and will be retained.
  */
-export declare function dateCellTiming(durationInput: DateDurationSpan, inputRange: DateCellTimingRangeInput, timezoneInput?: DateCellTimingTimezoneInput): FullDateCellTiming;
+export declare function dateCellTiming(durationInput: DateDurationSpan, rangeInput: DateCellTimingRangeInput, timezoneInput?: DateCellTimingTimezoneInput): FullDateCellTiming;
 export interface DateCellTimingStartPair {
     readonly start: Date;
     readonly normalInstance: DateTimezoneUtcNormalInstance;

package/src/lib/date/date.d.ts

@@ -117,6 +117,10 @@ export declare function copyHoursAndMinutesFromNow(target: Date, roundDownToMinu
  * Creates a new date and copies the hours/minutes from the input date to the target date.
  */
 export declare function copyHoursAndMinutesFromDate(target: Date, fromDate: Date, roundDownToMinute?: boolean): Date;
+/**
+ * Creates a new date using UTC and copies the hours/minutes from the input date using the UTC values to the target date.
+ */
+export declare function copyHoursAndMinutesFromUTCDate(target: Date, fromDate: Date, roundDownToMinute?: boolean): Date;
 /**
  * Creates a new date and copies the hours/minutes from the input onto the target date, if provided. Defaults to now/today otherwise.
  *
@@ -164,3 +168,10 @@ export declare function readDaysOfWeekNames<T>(values: T[], readDate: ReadDateFu
  * @returns
  */
 export declare function isStartOfDayInUTC(date: Date): boolean;
+/**
+ * Returns true if the input date is at midnight for the system.
+ *
+ * @param date
+ * @returns
+ */
+export declare function isStartOfDayForSystem(date: Date): boolean;

package/src/lib/date/date.format.d.ts

@@ -115,13 +115,23 @@ export declare function formatToDayRangeString(start: Date, end?: Maybe<Date>, f
 export declare function safeFormatToISO8601DateString(input: Maybe<DateOrDateString | UTCDateString>): ISO8601DateString | undefined;
 export declare function formatToISO8601DateString(date?: Date): ISO8601DayString;
 /**
- * Converts the input Date or ISO8601DayString to an ISO8601DayString.
+ * Converts the input Date or ISO8601DayString to an ISO8601DayString using the system's date (not UTC date).
+ *
+ * Use formatToISO8601DayStringForUTC() for using the UTC date.
+ *
+ * @param dateOrString
+ * @returns
+ */
+export declare function toISO8601DayStringForSystem(dateOrString: DateOrDayString): ISO8601DayString;
+export declare function formatToISO8601DayStringForSystem(date?: Date): ISO8601DayString;
+/**
+ * Converts the input Date or ISO8601DayString to an ISO8601DayString using the UTC date.
  *
  * @param dateOrString
  * @returns
  */
-export declare function toISO8601DayString(dateOrString: DateOrDayString): ISO8601DayString;
-export declare function formatToISO8601DayString(date?: Date): ISO8601DayString;
+export declare function toISO8601DayStringForUTC(dateOrString: DateOrDayString): ISO8601DayString;
+export declare function formatToISO8601DayStringForUTC(date?: Date): ISO8601DayString;
 export declare const dateShortDateStringFormat = "MM/dd/yyyy";
 export declare function formatToShortDateString(date?: Date): ISO8601DayString;
 export declare const dateMonthDayStringFormat = "MM/dd";
@@ -141,3 +151,11 @@ export declare function formatStartedEndedDistanceString({ start, end }: DateRan
  */
 export declare function toJsDayDate(input: DateOrDayString): Date;
 export declare function parseISO8601DayStringToDate(dayString: ISO8601DayString | ISO8601DateString): Date;
+/**
+ * @deprecated use toISO8601DayStringForSystem instead for clarity. Will be removed in the future.
+ */
+export declare const toISO8601DayString: typeof toISO8601DayStringForSystem;
+/**
+ * @deprecated use formatToISO8601DayStringForSystem instead for clarity. Will be removed in the future.
+ */
+export declare const formatToISO8601DayString: typeof formatToISO8601DayStringForSystem;

package/src/lib/date/date.timezone.d.ts

@@ -1,4 +1,4 @@
-import { type MapFunction, type Maybe, type Milliseconds, type TimezoneString, type ISO8601DayString, type YearNumber, type MapSameFunction } from '@dereekb/util';
+import { type MapFunction, type Maybe, type Milliseconds, type TimezoneString, type ISO8601DayString, type YearNumber, type MapSameFunction, type Hours } from '@dereekb/util';
 import { type DateRange, type TransformDateRangeDatesFunction } from './date.range';
 /**
  * Inherited from the RRule library where RRule only deals with UTC date/times, dates going into it must always be in UTC.
@@ -87,6 +87,16 @@ export declare function getCurrentSystemOffsetInHours(date: Date): number;
  * @returns
  */
 export declare function getCurrentSystemOffsetInMinutes(date: Date): number;
+/**
+ * Returns the timezone offset in milliseconds.
+ *
+ * I.E. GMT-5 = -5 hours (in milliseconds)
+ *
+ * @param timezone
+ * @param date
+ * @returns
+ */
+export declare function calculateTimezoneOffset(timezone: TimezoneString, date: Date): number;
 export type DateTimezoneConversionTarget = 'target' | 'base' | 'system';
 export type DateTimezoneOffsetFunction = (date: Date, from: DateTimezoneConversionTarget, to: DateTimezoneConversionTarget) => Milliseconds;
 export interface DateTimezoneBaseDateConverter {
@@ -158,6 +168,7 @@ export declare class DateTimezoneUtcNormalInstance implements DateTimezoneBaseDa
     targetDateToSystemDate(date: Date): Date;
     systemDateToTargetDate(date: Date): Date;
     getOffset(date: Date, transform: DateTimezoneUtcNormalInstanceTransformType): Milliseconds;
+    getOffsetInHours(date: Date, transform: DateTimezoneUtcNormalInstanceTransformType): Hours;
     offsetFunction(transform: DateTimezoneUtcNormalInstanceTransformType): MapFunction<Date, Milliseconds>;
     targetDateToBaseDateOffset(date: Date): Milliseconds;
     baseDateToTargetDateOffset(date: Date): Milliseconds;