Fix inconsistent typing of duration properties (#1265)

When creating a Duration the seconds and nanoseconds will be converted to Integers, no matter if provided with Integers, Numbers, or BigInts. This is awkward and requires special handling by users

Author: MaxAake

packages/bolt-connection/test/bolt/__snapshots__/bolt-protocol-v1.test.js.snap

@@ -33,14 +33,8 @@ exports[`#unit BoltProtocolV1 .packable() should pack types introduced afterward
 {
   "days": 1,
   "months": 1,
-  "nanoseconds": Integer {
-    "high": 0,
-    "low": 1,
-  },
-  "seconds": Integer {
-    "high": 0,
-    "low": 1,
-  },
+  "nanoseconds": 1,
+  "seconds": 1,
 }
 `;
 

packages/core/src/temporal-types.ts

@@ -23,7 +23,7 @@ import {
   assertValidDate
 } from './internal/util'
 import { newError } from './error'
-import Integer, { int, toNumber } from './integer'
+import Integer, { int, toNumber, isInt } from './integer'
 
 const IDENTIFIER_PROPERTY_ATTRIBUTES = {
   value: true,
@@ -74,11 +74,23 @@ export class Duration<T extends NumberOrInteger = Integer> {
      * @type {NumberOrInteger}
      */
     this.seconds = util.normalizeSecondsForDuration(seconds, nanoseconds) as T
+    if (typeof seconds === 'number' && isInt(this.seconds)) {
+      this.seconds = this.seconds.toNumber() as T
+    }
+    if (typeof seconds === 'bigint' && isInt(this.seconds)) {
+      this.seconds = this.seconds.toBigInt() as T
+    }
     /**
      * The number of nanoseconds.
      * @type {NumberOrInteger}
      */
     this.nanoseconds = util.normalizeNanosecondsForDuration(nanoseconds) as T
+    if (typeof nanoseconds === 'number' && isInt(this.nanoseconds)) {
+      this.nanoseconds = this.nanoseconds.toNumber() as T
+    }
+    if (typeof nanoseconds === 'bigint' && isInt(this.nanoseconds)) {
+      this.nanoseconds = this.nanoseconds.toBigInt() as T
+    }
     Object.freeze(this)
   }
 

packages/core/test/__snapshots__/json.test.ts.snap

@@ -12,11 +12,11 @@ exports[`json .stringify should handle DateTime in list 1`] = `"[{"year":2024,"m
 
 exports[`json .stringify should handle DateTime in object 1`] = `"{"key":{"year":2024,"month":6,"day":13,"hour":10,"minute":0,"second":30,"nanosecond":134,"timeZoneOffsetSeconds":-3600,"timeZoneId":"Europe/Berlin"}}"`;
 
-exports[`json .stringify should handle Duration 1`] = `"{"months":10,"days":2,"seconds":{"low":35,"high":0},"nanoseconds":{"low":100,"high":0}}"`;
+exports[`json .stringify should handle Duration 1`] = `"{"months":10,"days":2,"seconds":35,"nanoseconds":100}"`;
 
-exports[`json .stringify should handle Duration in list 1`] = `"[{"months":10,"days":2,"seconds":{"low":35,"high":0},"nanoseconds":{"low":100,"high":0}}]"`;
+exports[`json .stringify should handle Duration in list 1`] = `"[{"months":10,"days":2,"seconds":35,"nanoseconds":100}]"`;
 
-exports[`json .stringify should handle Duration in object 1`] = `"{"key":{"months":10,"days":2,"seconds":{"low":35,"high":0},"nanoseconds":{"low":100,"high":0}}}"`;
+exports[`json .stringify should handle Duration in object 1`] = `"{"key":{"months":10,"days":2,"seconds":35,"nanoseconds":100}}"`;
 
 exports[`json .stringify should handle Integer 1`] = `"{"low":5,"high":0}"`;
 

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

@@ -18,6 +18,7 @@
 import { LocalDateTime, Date, DateTime, Duration, isDuration, LocalTime, isLocalTime, Time, isTime, isDate, isLocalDateTime, isDateTime } from '../src/temporal-types'
 import { temporalUtil } from '../src/internal'
 import fc from 'fast-check'
+import { Integer } from '../src'
 
 const MIN_UTC_IN_MS = -8_640_000_000_000_000
 const MAX_UTC_IN_MS = 8_640_000_000_000_000
@@ -184,23 +185,38 @@ describe('DateTime', () => {
   })
 })
 
-describe('isDuration', () => {
+describe('Duration', () => {
+  describe('isDuration', () => {
+    it.each([
+      [new Duration(1, 2, 3, 4), true],
+      [null, false],
+      [LocalDateTime.fromStandardDate(new global.Date()), false],
+      [{ months: 1, days: 1, seconds: 2, nanoseconds: 2 }, false]
+    ])('should be a type guard [%o]', (obj: unknown, objIsDuration: boolean) => {
+      expect(isDuration(obj)).toEqual(objIsDuration)
+
+      if (isDuration(obj)) {
+        const duration: Duration = obj
+        expect(duration).toEqual(obj)
+      } else {
+        // @ts-expect-error
+        const duration: Duration = obj
+        expect(duration).toEqual(obj)
+      }
+    })
+  })
   it.each([
-    [new Duration(1, 2, 3, 4), true],
-    [null, false],
-    [LocalDateTime.fromStandardDate(new global.Date()), false],
-    [{ months: 1, days: 1, seconds: 2, nanoseconds: 2 }, false]
-  ])('should be a type guard [%o]', (obj: unknown, objIsDuration: boolean) => {
-    expect(isDuration(obj)).toEqual(objIsDuration)
-
-    if (isDuration(obj)) {
-      const duration: Duration = obj
-      expect(duration).toEqual(obj)
-    } else {
-      // @ts-expect-error
-      const duration: Duration = obj
-      expect(duration).toEqual(obj)
-    }
+    [1, 2, 3, 4],
+    [BigInt(1), BigInt(2), BigInt(3), BigInt(4)],
+    [new Integer(1), new Integer(2), new Integer(3), new Integer(4)],
+    [new Integer(1), 2, new Integer(3), BigInt(4)],
+    [1, 2, BigInt(3), 4]
+  ])('should handle differing types for parameters', (months, days, seconds, nanos) => {
+    const duration = new Duration(months, days, seconds, nanos)
+    expect(duration.months).toEqual(months)
+    expect(duration.days).toEqual(days)
+    expect(duration.seconds).toEqual(seconds)
+    expect(duration.nanoseconds).toEqual(nanos)
   })
 })
 

packages/neo4j-driver-deno/lib/core/temporal-types.ts

@@ -1101,8 +1101,8 @@ describe('#integration examples', () => {
         expect(neo4j.isDuration(durationField)).toEqual(true)
         expect(durationField.months.toInt()).toEqual(duration.months)
         expect(durationField.days.toInt()).toEqual(duration.days)
-        expect(durationField.seconds).toEqual(duration.seconds)
-        expect(durationField.nanoseconds).toEqual(duration.nanoseconds)
+        expect(durationField.seconds.toInt()).toEqual(duration.seconds)
+        expect(durationField.nanoseconds.toInt()).toEqual(duration.nanoseconds)
       } finally {
         await session.close()
       }