[utils] Remove time conversions as moved to the time namespace

Follow-up for openhab#383. Access to utils.javaInstantToJsInstant, utils.javaZDTToJsZDT and utils.javaZDTToJsZDTWithDefaultZoneSystem is kept for backward compatibility, but considered deprecated. Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
florian-h05 · Sep 16, 2024 · 540b687 · 540b687
1 parent 06717c0
commit 540b687
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 92 deletions.
diff --git a/README.md b/README.md
@@ -941,6 +941,14 @@ var Locale = require('@js-joda/locale_de-de').Locale.GERMAN;
 var formatter = time.DateTimeFormatter.ofPattern('dd.MM.yyyy HH:mm').withLocale(Locale);
 ```
 
+#### `time.javaInstantToJsInstant()`
+
+Converts a [`java.time.Instant`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Instant.html) to a JS-Joda [`Instant`](https://js-joda.github.io/js-joda/manual/Instant.html).
+
+#### `time.javaZDTToJsZDT()`
+
+Converts a [`java.time.ZonedDateTime`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/ZonedDateTime.html) to a JS-Joda [`ZonedDateTime`](https://js-joda.github.io/js-joda/manual/ZonedDateTime.html).
+
 #### `time.toZDT()`
 
 There will be times when this automatic conversion is not available (for example when working with date times within a rule).

diff --git a/src/index.js b/src/index.js
@@ -6,7 +6,18 @@ module.exports = {
   get things () { return require('./things'); },
   get triggers () { return require('./triggers'); },
   get actions () { return require('./actions'); },
-  get utils () { return require('./utils'); },
+  utils: new Proxy({}, {
+    get: (target, name) => {
+      if (name.startsWith('javaZDTToJsZDT')) {
+        console.warn(`utils.${name} is deprecated, use time.javaZDTToJsZDT instead.`);
+        return require('./time').javaZDTToJsZDT;
+      } else if (name === 'javaInstantToJsInstant') {
+        console.warn('utils.javaInstantToJsInstant is deprecated, use time.javaInstantToJsInstant instead.');
+        return require('./time').javaInstantToJsInstant;
+      }
+      return require('./utils')[name];
+    }
+  }),
   get osgi () { return require('./osgi'); },
   get cache () { return require('./cache'); },
   get time () { return require('./time'); },

diff --git a/src/items/item-persistence.js b/src/items/item-persistence.js
@@ -1,6 +1,5 @@
 const log = require('../log')('items.ItemPersistence');
 const time = require('../time');
-const utils = require('../utils');
 const { getQuantity, QuantityError } = require('../quantity');
 const { _toOpenhabPrimitiveType, _isTimeSeries } = require('../helpers');
 
@@ -99,7 +98,7 @@ class PersistedItem extends PersistedState {
    * @type {time.ZonedDateTime}
    */
   get timestamp () {
-    return utils.javaZDTToJsZDT(this.#rawHistoricItem.getTimestamp());
+    return time.javaZDTToJsZDT(this.#rawHistoricItem.getTimestamp());
   }
 
   toString () {

diff --git a/src/utils.js b/src/utils.js
@@ -1,5 +1,3 @@
-const time = require('@js-joda/core');
-
 /**
  * openHAB JavaScript library version
  *
@@ -194,46 +192,6 @@ function dumpObject (obj, dumpProps = false) {
   }
 }
 
-/**
- * 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}
- */
-function javaInstantToJsInstant (instant) {
-  return time.Instant.ofEpochMilli(instant.toEpochMilli());
-}
-
-/**
- * Convert Java ZonedDateTime to JS-Joda ZonedDateTime.
- *
- * @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}
- */
-function javaZDTToJsZDT (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);
-}
-
-/**
- * Convert Java ZonedDateTime to JS-Joda ZonedDateTime and default to SYSTEM timezone if not explicitly set.
- *
- * @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}
- */
-function javaZDTToJsZDTWithDefaultZoneSystem (zdt) {
-  const jsZDT = javaZDTToJsZDT(zdt);
-  if (/^[+-]/.test(jsZDT.zone().toString())) {
-    return jsZDT.withZoneSameLocal(time.ZoneId.SYSTEM);
-  }
-  return jsZDT;
-}
-
 module.exports = {
   jsSetToJavaSet,
   jsArrayToJavaSet,
@@ -245,8 +203,5 @@ module.exports = {
   javaMapToJsObj,
   randomUUID,
   dumpObject,
-  javaInstantToJsInstant,
-  javaZDTToJsZDT,
-  javaZDTToJsZDTWithDefaultZoneSystem,
   OPENHAB_JS_VERSION: VERSION
 };
diff --git a/test/utils.spec.js b/test/utils.spec.js
@@ -1,16 +1,13 @@
-const { UUID, HashSet, ArrayList, Instant, ZonedDateTime } = require('./java.mock');
+const { UUID, HashSet, ArrayList } = require('./java.mock');
 const {
   randomUUID,
   jsSetToJavaSet,
   jsArrayToJavaSet,
   jsArrayToJavaList,
   javaListToJsArray,
   javaSetToJsArray,
-  javaSetToJsSet,
-  javaInstantToJsInstant,
-  javaZDTToJsZDT
+  javaSetToJsSet
 } = require('../src/utils');
-const time = require('@js-joda/core');
 
 describe('utils.js', () => {
   describe('randomUUID', () => {
@@ -87,16 +84,4 @@ describe('utils.js', () => {
       expect(javaSetToJsSet(new HashSet())).toBeInstanceOf(Set);
     });
   });
-
-  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);
-    });
-  });
 });
diff --git a/types/items/item-persistence.d.ts.map b/types/items/item-persistence.d.ts.map
diff --git a/types/utils.d.ts b/types/utils.d.ts
@@ -77,30 +77,6 @@ export function randomUUID(): string;
  * @param {boolean} [dumpProps=false] whether properties also should be dumped
  */
 export function dumpObject(obj: any, dumpProps?: boolean): void;
-/**
- * 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 ZonedDateTime.
- *
- * @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;
-/**
- * Convert Java ZonedDateTime to JS-Joda ZonedDateTime and default to SYSTEM timezone if not explicitly set.
- *
- * @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 javaZDTToJsZDTWithDefaultZoneSystem(zdt: JavaZonedDateTime): time.ZonedDateTime;
 /**
  * openHAB JavaScript library version
  *
@@ -109,6 +85,5 @@ export function javaZDTToJsZDTWithDefaultZoneSystem(zdt: JavaZonedDateTime): tim
  * @type {string}
  */
 declare const VERSION: string;
-import time = require("@js-joda/core");
 export { VERSION as OPENHAB_JS_VERSION };
 //# sourceMappingURL=utils.d.ts.map