Enable DateTime to be initialized with Offset and ZoneId

Author: bigmontz

packages/core/src/temporal-types.ts

@@ -670,7 +670,13 @@ export class DateTime<T extends NumberOrInteger = Integer> {
     if (this.timeZoneOffsetSeconds === undefined) {
       throw new Error('Requires DateTime created with time zone offset')
     }
-    return util.isoStringToStandardDate(this.toString())
+    return util.isoStringToStandardDate(
+      // the timezone name should be removed from the
+      // string, otherwise the javascript parse doesn't
+      // read the datetime correctly
+      this.toString().replace(
+        this.timeZoneId != null ? `[${this.timeZoneId}]` : '', '')
+    )
   }
 
   /**
@@ -686,10 +692,16 @@ export class DateTime<T extends NumberOrInteger = Integer> {
       this.second,
       this.nanosecond
     )
+
+    const timeOffset = this.timeZoneOffsetSeconds != null
+      ? util.timeZoneOffsetToIsoString(this.timeZoneOffsetSeconds ?? 0)
+      : ''
+
     const timeZoneStr = this.timeZoneId != null
       ? `[${this.timeZoneId}]`
-      : util.timeZoneOffsetToIsoString(this.timeZoneOffsetSeconds ?? 0)
-    return localDateTimeStr + timeZoneStr
+      : ''
+
+    return localDateTimeStr + timeOffset + timeZoneStr
   }
 }
 
@@ -741,23 +753,25 @@ function verifyTimeZoneArguments (
   const offsetDefined = timeZoneOffsetSeconds !== null && timeZoneOffsetSeconds !== undefined
   const idDefined = timeZoneId !== null && timeZoneId !== undefined && timeZoneId !== ''
 
-  if (offsetDefined && !idDefined) {
-    assertNumberOrInteger(timeZoneOffsetSeconds, 'Time zone offset in seconds')
-    return [timeZoneOffsetSeconds, undefined]
-  } else if (!offsetDefined && idDefined) {
-    assertString(timeZoneId, 'Time zone ID')
-    return [undefined, timeZoneId]
-  } else if (offsetDefined && idDefined) {
-    throw newError(
-      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-      `Unable to create DateTime with both time zone offset and id. Please specify either of them. Given offset: ${timeZoneOffsetSeconds} and id: ${timeZoneId}`
-    )
-  } else {
+  if (!offsetDefined && !idDefined) {
     throw newError(
       // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
       `Unable to create DateTime without either time zone offset or id. Please specify either of them. Given offset: ${timeZoneOffsetSeconds} and id: ${timeZoneId}`
     )
   }
+
+  const result: [NumberOrInteger | undefined | null, string | undefined | null] = [undefined, undefined]
+  if (offsetDefined) {
+    assertNumberOrInteger(timeZoneOffsetSeconds, 'Time zone offset in seconds')
+    result[0] = timeZoneOffsetSeconds
+  }
+
+  if (idDefined) {
+    assertString(timeZoneId, 'Time zone ID')
+    result[1] = timeZoneId
+  }
+
+  return result
 }
 
 /**

packages/core/test/temporal-types.test.ts

@@ -74,7 +74,41 @@ describe('LocalDateTime', () => {
 })
 
 describe('DateTime', () => {
+  describe('constructor', () => {
+    it('should be able to create a date with zone id and offset', () => {
+      const datetime = new DateTime(2022, 6, 16, 11, 19, 25, 400004, 2 * 60 * 60, 'Europe/Stockholm')
+
+      expect(datetime.year).toEqual(2022)
+      expect(datetime.month).toEqual(6)
+      expect(datetime.day).toEqual(16)
+      expect(datetime.hour).toEqual(11)
+      expect(datetime.minute).toEqual(19)
+      expect(datetime.second).toEqual(25)
+      expect(datetime.nanosecond).toEqual(400004)
+      expect(datetime.timeZoneOffsetSeconds).toEqual(2 * 60 * 60)
+      expect(datetime.timeZoneId).toEqual('Europe/Stockholm')
+    })
+  })
+
   describe('.toStandardDate()', () => {
+    it('should convert to a standard date (offset + zone id)', () => {
+      const datetime = new DateTime(2022, 6, 16, 11, 19, 25, 4000004, 2 * 60 * 60, 'Europe/Stockholm')
+
+      const standardDate = datetime.toStandardDate()
+
+      expect(standardDate.getFullYear()).toEqual(datetime.year)
+      expect(standardDate.getMonth()).toEqual(datetime.month - 1)
+      expect(standardDate.getDate()).toEqual(datetime.day)
+      const offsetInMinutes = offset(standardDate)
+      const offsetAdjust = offsetInMinutes - (datetime.timeZoneOffsetSeconds ?? 0) / 60
+      const hourDiff = Math.abs(offsetAdjust / 60)
+      const minuteDiff = Math.abs(offsetAdjust % 60)
+      expect(standardDate.getHours()).toBe(datetime.hour - hourDiff)
+      expect(standardDate.getMinutes()).toBe(datetime.minute - minuteDiff)
+      expect(standardDate.getSeconds()).toBe(datetime.second)
+      expect(standardDate.getMilliseconds()).toBe(Math.round(datetime.nanosecond / 1000000))
+    })
+
     it('should convert to a standard date (offset)', () => {
       const datetime = new DateTime(2020, 12, 15, 12, 2, 3, 4000000, 120 * 60)
 
@@ -90,7 +124,7 @@ describe('DateTime', () => {
       expect(standardDate.getHours()).toBe(datetime.hour - hourDiff)
       expect(standardDate.getMinutes()).toBe(datetime.minute - minuteDiff)
       expect(standardDate.getSeconds()).toBe(datetime.second)
-      expect(standardDate.getMilliseconds()).toBe(datetime.nanosecond / 1000000)
+      expect(standardDate.getMilliseconds()).toBe(Math.round(datetime.nanosecond / 1000000))
     })
 
     it('should not convert to a standard date (zoneid)', () => {

packages/testkit-backend/src/cypher-native-binders.js

@@ -150,7 +150,7 @@ export function cypherToNative (c) {
         data.minute,
         data.second,
         data.nanosecond,
-        data.timezone_id == null ? data.utc_offset_s : null,
+        data.utc_offset_s,
         data.timezone_id
       )
     case 'CypherMap':