[items] ItemPersistence: Add lastChange and nextChange methods (#350)

Adds support for openhab/openhab-core#4259. Also-by: Florian Hotze <[email protected]> Signed-off-by: Mark Herwege <[email protected]>
openhab · Jun 25, 2024 · a94e9fe · a94e9fe
1 parent 7c4f5d0
commit a94e9fe
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -519,7 +519,9 @@ Calling `Item.persistence` returns an `ItemPersistence` object with the followin
   - .getAllStatesUntil(timestamp, serviceId)  ⇒ `Array[PersistedItem]`
   - .getAllStatesBetween(begin, end, serviceId)  ⇒ `Array[PersistedItem]`
   - .lastUpdate(serviceId) ⇒ `ZonedDateTime | null`
-  - .nextUpdate(serviceId)  ⇒ `ZonedDateTime | null`
+  - .nextUpdate(serviceId) ⇒ `ZonedDateTime | null`
+  - .lastChange(serviceId) ⇒ `ZonedDateTime | null`
+  - .nextChange(serviceId) ⇒ `ZonedDateTime | null`
   - .maximumSince(timestamp, serviceId) ⇒ `PersistedItem | null`
   - .maximumUntil(timestamp, serviceId) ⇒ `PersistedItem | null`
   - .maximumBetween(begin, end, serviceId) ⇒ `PersistedItem | null`

diff --git a/src/items/item-persistence.js b/src/items/item-persistence.js
@@ -275,8 +275,9 @@ class ItemPersistence {
    * Query the last update time of a given Item.
    *
    * @param {string} [serviceId] optional persistence service ID, if omitted, the default persistence service will be used
-   * @returns {(time.ZonedDateTime | null)} point in time of the last historic update to Item, or <code>null</code> if there are no historic persisted updates
-   */
+   * @returns {(time.ZonedDateTime | null)} point in time of the last historic update to Item, or <code>null</code>
+                                            if the current state is different from the last persisted state or there are no historic persisted updates
+  */
   lastUpdate (serviceId) {
     return _ZDTOrNull(PersistenceExtensions.lastUpdate(this.rawItem, ...arguments));
   }
@@ -291,6 +292,27 @@ class ItemPersistence {
     return _ZDTOrNull(PersistenceExtensions.nextUpdate(this.rawItem, ...arguments));
   }
 
+  /**
+   * Query the last change time of a given Item.
+   *
+   * @param {string} [serviceId] optional persistence service ID, if omitted, the default persistence service will be used
+   * @returns {(time.ZonedDateTime | null)} point in time of the last historic change to Item, or <code>null</code>
+                                            if the current state is different from the last persisted state or there are no historic persisted states
+   */
+  lastChange (serviceId) {
+    return _ZDTOrNull(PersistenceExtensions.lastChange(this.rawItem, ...arguments));
+  }
+
+  /**
+   * Query the next change time of a given Item.
+   *
+   * @param {string} [serviceId] optional persistence service ID, if omitted, the default persistence service will be used
+   * @returns {(time.ZonedDateTime | null)} point in time of the first future change to Item, or <code>null</code> if there are no future persisted states
+   */
+  nextChange (serviceId) {
+    return _ZDTOrNull(PersistenceExtensions.nextChange(this.rawItem, ...arguments));
+  }
+
   /**
    * Returns the previous state of a given Item.
    *

diff --git a/types/items/item-persistence.d.ts b/types/items/item-persistence.d.ts
@@ -59,8 +59,9 @@ declare class ItemPersistence {
      * Query the last update time of a given Item.
      *
      * @param {string} [serviceId] optional persistence service ID, if omitted, the default persistence service will be used
-     * @returns {(time.ZonedDateTime | null)} point in time of the last historic update to Item, or <code>null</code> if there are no historic persisted updates
-     */
+     * @returns {(time.ZonedDateTime | null)} point in time of the last historic update to Item, or <code>null</code>
+                                              if the current state is different from the last persisted state or there are no historic persisted updates
+    */
     lastUpdate(serviceId?: string, ...args: any[]): (time.ZonedDateTime | null);
     /**
      * Query the next update time of a given Item.
@@ -69,6 +70,21 @@ declare class ItemPersistence {
      * @returns {(time.ZonedDateTime | null)} point in time of the first future update to Item, or <code>null</code> if there are no future persisted updates
      */
     nextUpdate(serviceId?: string, ...args: any[]): (time.ZonedDateTime | null);
+    /**
+     * Query the last change time of a given Item.
+     *
+     * @param {string} [serviceId] optional persistence service ID, if omitted, the default persistence service will be used
+     * @returns {(time.ZonedDateTime | null)} point in time of the last historic change to Item, or <code>null</code>
+                                              if the current state is different from the last persisted state or there are no historic persisted states
+     */
+    lastChange(serviceId?: string, ...args: any[]): (time.ZonedDateTime | null);
+    /**
+     * Query the next change time of a given Item.
+     *
+     * @param {string} [serviceId] optional persistence service ID, if omitted, the default persistence service will be used
+     * @returns {(time.ZonedDateTime | null)} point in time of the first future change to Item, or <code>null</code> if there are no future persisted states
+     */
+    nextChange(serviceId?: string, ...args: any[]): (time.ZonedDateTime | null);
     /**
      * Returns the previous state of a given Item.
      *

diff --git a/types/items/item-persistence.d.ts.map b/types/items/item-persistence.d.ts.map