[utils] Add Java to JS conversion for Instant & ZonedDateTime

CHANGELOG.md

@@ -2,8 +2,9 @@
 
 ## to be released
 
-| Type        | Namespace  | Description                                                                          | Reference                                                                                                                                                                                           | Breaking |
-|-------------|------------|--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
+| Type        | Namespace  | Description                                               | Reference                                              | Breaking |
+|-------------|------------|-----------------------------------------------------------|--------------------------------------------------------|----------|
+| Enhancement | `utils`    | Add Java to JS conversion for `Instant` & `ZonedDateTime` | [#267](https://github.com/openhab/openhab-js/pull/267) | No       |
 
 Also see the [Release Milestone](https://github.com/openhab/openhab-js/milestone/16).
 

actions.js

@@ -13,7 +13,10 @@
  * const { actions } = require('openhab');
  * actions.NotificationAction.sendBroadcastNotification("Hello World!")
  */
-/** @typedef {import('@js-joda/core').ZonedDateTime} time.ZonedDateTime */
+/**
+ * @typedef {import('@js-joda/core').ZonedDateTime} time.ZonedDateTime
+ * @private
+ */
 
 const osgi = require('./osgi');
 // See https://github.com/openhab/openhab-core/blob/main/bundles/org.openhab.core.automation.module.script/src/main/java/org/openhab/core/automation/module/script/internal/defaultscope/ScriptThingActionsImpl.java

items/item-history.js

@@ -3,6 +3,7 @@
  * @private
  */
 const time = require('../time');
+const utils = require('../utils');
 /**
  * @typedef {import('../quantity').Quantity} Quantity
  * @private
@@ -54,7 +55,7 @@ class HistoricItem {
      * timestamp of persisted Item
      * @type {time.ZonedDateTime}
      */
-    this.timestamp = time.ZonedDateTime.parse(rawHistoricItem.getTimestamp().toString());
+    this.timestamp = utils.javaZDTToJsZDT(rawHistoricItem.getTimestamp());
   }
 }
 

test/java.mock.js

@@ -4,6 +4,28 @@ const { ModuleBuilder, Configuration, JavaScriptExecution, JavaTransformation, Q
 class BigDecimal {}
 BigDecimal.valueOf = jest.fn(() => new BigDecimal());
 
+class Instant {
+  toEpochMilli () {
+    return 0;
+  }
+}
+
+class ZonedDateTime {
+  toInstant () {
+    return new Instant();
+  }
+
+  getZone () {
+    return new ZoneId();
+  }
+}
+
+class ZoneId {
+  toString () {
+    return 'UTC';
+  }
+}
+
 class HashSet {
   add () {}
 }
@@ -65,6 +87,8 @@ Java = {
 module.exports = {
   ArrayList,
   BigDecimal,
+  Instant,
+  ZonedDateTime,
   FrameworkUtil,
   HashSet,
   Hashtable,

test/utils.spec.js

@@ -1,4 +1,4 @@
-const { UUID, HashSet, ArrayList } = require('./java.mock');
+const { UUID, HashSet, ArrayList, Instant, ZonedDateTime } = require('./java.mock');
 const {
   randomUUID,
   jsSetToJavaSet,
@@ -7,8 +7,11 @@ const {
   javaListToJsArray,
   javaSetToJsArray,
   javaSetToJsSet,
-  isJsInstanceOfJava
+  isJsInstanceOfJava,
+  javaInstantToJsInstant,
+  javaZDTToJsZDT
 } = require('../utils');
+const time = require('@js-joda/core');
 
 describe('utils.js', () => {
   describe('randomUUID', () => {
@@ -122,4 +125,16 @@ describe('utils.js', () => {
       );
     });
   });
+
+  describe('javaInstantToJsInstant', () => {
+    it('returns JS-Joda Instant', () => {
+      expect(javaInstantToJsInstant(new Instant())).toBeInstanceOf(time.Instant);
+    });
+  });
+
+  describe('javaZDTToJsZDT', () => {
+    it('returns JS-Joda ZonedDateTime', () => {
+      expect(javaZDTToJsZDT(new ZonedDateTime())).toBeInstanceOf(time.ZonedDateTime);
+    });
+  });
 });

time.js

@@ -8,6 +8,7 @@
 require('@js-joda/timezone');
 const time = require('@js-joda/core');
 const items = require('./items');
+const utils = require('./utils');
 
 const javaZDT = Java.type('java.time.ZonedDateTime');
 const javaDuration = Java.type('java.time.Duration');
@@ -17,19 +18,6 @@ const { DateTimeType, DecimalType, StringType, QuantityType } = require('@runtim
 const { Quantity } = require('./quantity');
 const ohItem = Java.type('org.openhab.core.items.Item');
 
-/**
- * Converts the Java ZonedDateTime to a time.ZonedDateTime.
- * @private
- * @param {JavaZonedDateTime} zdt date time to convert to a time.ZonedDateTime
- * @returns {time.ZonedDateTime}
- */
-function _javaZDTtoZDT (zdt) {
-  const epoch = zdt.toInstant().toEpochMilli();
-  const instant = time.Instant.ofEpochMilli(epoch);
-  const zone = time.ZoneId.of(zdt.getZone().toString());
-  return time.ZonedDateTime.ofInstant(instant, zone);
-}
-
 /**
  * Adds millis to the passed in ZDT as milliseconds. The millis is rounded first.
  * If millis is negative they will be subtracted.
@@ -176,7 +164,7 @@ function _convertItem (item) {
   } else if (item.rawState instanceof StringType) { // String type Items
     return _parseString(item.state);
   } else if (item.rawState instanceof DateTimeType) { // DateTime Items
-    return _javaZDTtoZDT(item.rawState.getZonedDateTime());
+    return utils.javaZDTToJsZDT(item.rawState.getZonedDateTime());
   } else if (item.rawState instanceof QuantityType) { // Number:Time type Items
     return _addQuantityType(item.rawState);
   } else {
@@ -241,12 +229,12 @@ function toZDT (when) {
 
   // Java ZDT
   if (when instanceof javaZDT) {
-    return _javaZDTtoZDT(when);
+    return utils.javaZDTToJsZDT(when);
   }
 
   // DateTimeType, extract the javaZDT and convert to time.ZDT
   if (when instanceof DateTimeType) {
-    return _javaZDTtoZDT(when.getZonedDateTime());
+    return utils.javaZDTToJsZDT(when.getZonedDateTime());
   }
 
   // Quantity

types/openhab-js.d.ts

@@ -17,7 +17,11 @@ declare global {
    */
   type JavaMap = object;
   /**
-   * Native Java ZonedDateTime Object (instance of {@link https://docs.oracle.com/en/java/javase/17/docs/api//java.base/java/time/ZonedDateTime.html java.time.ZonedDateTime})
+   * Native Java Instant Object (instance of {@link https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Instant.html java.time.Instant})
+   */
+  type JavaInstant = object;
+  /**
+   * Native Java ZonedDateTime Object (instance of {@link https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/ZonedDateTime.html java.time.ZonedDateTime})
    */
   type JavaZonedDateTime = object;
   /**

types/utils.d.ts

@@ -87,6 +87,22 @@ export function dumpObject(obj: any, dumpProps?: boolean): void;
  * @throws error if type is not a java class
  */
 export function isJsInstanceOfJava(instance: any, type: JavaClass): boolean;
+/**
+ * Convert Java Instant to JS-Joda Instant.
+ *
+ * @memberOf utils
+ * @param {JavaInstant} instant {@link https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Instant.html java.time.Instant}
+ * @returns {time.Instant} {@link https://js-joda.github.io/js-joda/class/packages/core/src/Instant.js~Instant.html JS-Joda Instant}
+ */
+export function javaInstantToJsInstant(instant: JavaInstant): time.Instant;
+/**
+ * Convert Java ZonedDateTime to JS-Joda.
+ *
+ * @memberOf utils
+ * @param {JavaZonedDateTime} zdt {@link https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/ZonedDateTime.html java.time.ZonedDateTime}
+ * @returns {time.ZonedDateTime} {@link https://js-joda.github.io/js-joda/class/packages/core/src/ZonedDateTime.js~ZonedDateTime.html JS-Joda ZonedDateTime}
+ */
+export function javaZDTToJsZDT(zdt: JavaZonedDateTime): time.ZonedDateTime;
 /**
  * openHAB JavaScript library version
  *
@@ -95,5 +111,6 @@ export function isJsInstanceOfJava(instance: any, type: JavaClass): boolean;
  * @type {string}
  */
 declare const VERSION: string;
+import time = require("@js-joda/core");
 export { VERSION as OPENHAB_JS_VERSION };
 //# sourceMappingURL=utils.d.ts.map