refactor: date comparition utils

Author: bart-krakowski

Methods.md

@@ -1,22 +1,39 @@
 # What API methods do we need?
 
-[x] startOf(ZonedDateTime, unit): ZonedDateTime ✅
-[x] endOf(ZonedDateTime, unit): ZonedDateTime ✅
-[x] add(ZonedDateTime, duration): ZonedDateTime ✅
-[x] subtract(ZonedDateTime, duration): ZonedDateTime ✅
-[x] until(ZonedDateTime, ZonedDateTime): Duration ✅
-[x] since(ZonedDateTime, ZonedDateTime): Duration ✅
-[x] equals(ZonedDateTime, ZonedDateTime, unit): boolean ✅
-[x] isBefore(ZonedDateTime, ZonedDateTime): boolean ✅
-[x] isAfter(ZonedDateTime, ZonedDateTime): boolean ✅
-[x] round(unit): ZonedDateTime ✅
-[x] isSameOrBefore(ZonedDateTime, ZonedDateTime, unit): boolean ✅
-[x] isSameOrAfter(ZonedDateTime, ZonedDateTime, unit): boolean ✅
-[x] isBetween(ZonedDateTime, Range): boolean ✅
-[x] intersects(ZonedDateTime, Range): boolean ✅
-[ ] time(PlainTime): ZonedDateTime (use getter/setter?)
-[x] timeZone(IANATimeZoneId): ZonedDateTime (use getter/setter?) ✅
-[x] calendar(Calendar): ZonedDateTime (use getter/setter?) ✅
-[x] asEpoch ✅
-[x] asString ✅
-[x] asZonedDateTime ✅
+## Date Operations
+
+- [x] `startOf(input: DateInput, options: StartOfOptions): DateOperationResult` ✅
+- [x] `endOf(input: DateInput, options: EndOfOptions): DateOperationResult` ✅
+- [x] `add(input: DateInput, options: AddOptions): DateOperationResult` ✅
+- [x] `subtract(input: DateInput, options: SubtractOptions): DateOperationResult` ✅
+- [x] `round(input: DateInput, options: RoundOptions): DateOperationResult` ✅
+
+## Duration Calculations
+
+- [x] `until(start: DateInput, end: DateInput, options: UntilOptions): number` ✅
+- [x] `since(start: DateInput, end: DateInput, options: SinceOptions): number` ✅
+
+## Comparisons
+
+- [x] `equals(date1: DateInput, date2: DateInput, options: EqualsOptions): boolean` ✅
+- [x] `isBefore(date1: DateInput, date2: DateInput, options?: IsBeforeOptions): boolean` ✅
+- [x] `isAfter(date1: DateInput, date2: DateInput, options?: IsAfterOptions): boolean` ✅
+- [x] `isSameOrBefore(date1: DateInput, date2: DateInput, options: IsSameOrBeforeOptions): boolean` ✅
+- [x] `isSameOrAfter(date1: DateInput, date2: DateInput, options: IsSameOrAfterOptions): boolean` ✅
+
+## Range Operations
+
+- [x] `isBetween(date: DateInput, options: IsBetweenOptions): boolean` ✅
+- [x] `intersects(date: DateInput, options: IntersectsOptions): boolean` ✅
+
+## Type Definitions
+
+- `DateInput = string | number | Date | Temporal.ZonedDateTime`
+- `DateOperationResult` - Object with `value`, `asDate()`, `asEpoch()`, `asString()`, `asZonedDateTime()`, etc.
+- `Range = { start: DateInput, end: DateInput }`
+
+## Future Considerations
+
+- [ ] `time(PlainTime): ZonedDateTime` (use getter/setter?)
+- [x] `timeZone(IANATimeZoneId): ZonedDateTime` (use getter/setter?) ✅
+- [x] `calendar(Calendar): ZonedDateTime` (use getter/setter?) ✅

packages/time/src/date/isSameOrBefore/isSameOrBefore.ts

@@ -38,8 +38,8 @@ export function isSameOrBefore(
   if (options.unit === 'week') {
     const normalized1 = normalizeWeek(zdt1)
     const normalized2 = normalizeWeek(zdt2)
-    return Temporal.ZonedDateTime.compare(normalized1, normalized2) >= 0
+    return Temporal.ZonedDateTime.compare(normalized1, normalized2) <= 0
   }
 
-  return Temporal.ZonedDateTime.compare(zdt1, zdt2) >= 0
+  return Temporal.ZonedDateTime.compare(zdt1, zdt2) <= 0
 }

packages/time/src/date/round/round.ts

@@ -1,8 +1,8 @@
 import { Temporal } from '@js-temporal/polyfill'
+import { startOf } from '../startOf/startOf'
 import { withDateOperation } from '../withDateOperation'
-import type { DateOperationOptions } from '../withDateOperation'
 import type { DateInput } from '../types'
-import { startOf } from '../startOf/startOf'
+import type { DateOperationOptions } from '../withDateOperation'
 
 export type RoundUnit =
   | 'year'

packages/time/src/date/withDateOperation/withDateOperation.test.ts

@@ -74,29 +74,6 @@ describe('withDateOperation', () => {
       expect(new Date(epoch).toISOString()).toContain('2024-03-15')
     })
 
-    test('should have asString method', () => {
-      const result = mockOperation('2024-03-15T14:42:12.789Z', {
-        unit: 'test',
-        timeZone: 'UTC',
-      })
-      const str = result.asString()
-      expect(typeof str).toBe('string')
-      expect(str).toContain('2024-03-15')
-    })
-
-    test('should have asLong method', () => {
-      const result = mockOperation('2024-03-15T14:42:12.789Z', {
-        unit: 'test',
-        timeZone: 'America/New_York',
-        calendar: 'gregory',
-      })
-      const long = result.asLong()
-      expect(typeof long).toBe('string')
-      expect(long).toContain('2024-03-15')
-      expect(long).toContain('[America/New_York]')
-      expect(long).toContain('[u-ca=gregory]')
-    })
-
     test('should have asZonedDateTime method', () => {
       const result = mockOperation('2024-03-15T14:42:12.789Z', {
         unit: 'test',

packages/time/src/date/withDateOperation/withDateOperation.ts

@@ -11,9 +11,9 @@ export interface DateOperationOptions extends DateOptions {
 
 function createDateOperationResult(
   zdt: Temporal.ZonedDateTime,
-  options: Required<DateOptions>,
-  returnFormat: ReturnFormat = 'standard',
+  options: DateOperationOptions,
 ) {
+  const { returnFormat } = options
   const getValue = (): string => {
     switch (returnFormat) {
       case 'standard':
@@ -35,12 +35,6 @@ function createDateOperationResult(
     asEpoch: () => {
       return Number(zdt.epochNanoseconds / 1_000_000n)
     },
-    asString: () => {
-      return zdt.toInstant().toString()
-    },
-    asLong: () => {
-      return `${zdt.toInstant().toString()}[${zdt.timeZoneId}][u-ca=${zdt.calendarId}]`
-    },
     asZonedDateTime: () => {
       return zdt
     },
@@ -67,13 +61,10 @@ export function withDateOperation<TArgs>(
     const inputZdt = toZonedDateTime(input, timeZone, calendar)
     const resultZdt = fn(inputZdt, options)
 
-    return createDateOperationResult(
-      resultZdt,
-      {
-        timeZone,
-        calendar,
-      },
+    return createDateOperationResult(resultZdt, {
+      timeZone,
+      calendar,
       returnFormat,
-    )
+    })
   }
 }