[items] Fix NULL Item state not recognized as null (#448)

Fixes #446.

Signed-off-by: Florian Hotze <dev@florianhotze.com>

Author: florian-h05

CHANGELOG.md

@@ -2,10 +2,11 @@
 
 ## Unreleased
 
-| Type        | Namespace     | Description                                                                       |   | Reference                                              | Breaking |
-|-------------|---------------|-----------------------------------------------------------------------------------|:--|--------------------------------------------------------|----------|
-| Enhancement | `environment` | Add `isFileBasedScript()` function to determine whether script is file-based      |   | [#441](https://github.com/openhab/openhab-js/pull/441) | no       |
-| Enhancement | `items`       | Add support for providing Items, metadata & channel links from file-based scripts |   | [#441](https://github.com/openhab/openhab-js/pull/441) | no       |
+| Type        | Namespace     | Description                                                                       | Reference                                              | Breaking |
+|-------------|---------------|-----------------------------------------------------------------------------------|--------------------------------------------------------|----------|
+| Enhancement | `environment` | Add `isFileBasedScript()` function to determine whether script is file-based      | [#441](https://github.com/openhab/openhab-js/pull/441) | no       |
+| Enhancement | `items`       | Add support for providing Items, metadata & channel links from file-based scripts | [#441](https://github.com/openhab/openhab-js/pull/441) | no       |
+| Bugfix      | `items`       | Fix `NULL` Item state (UnDefType) not recognized as `null`                        | [#448](https://github.com/openhab/openhab-js/pull/448) | no       |
 
 ## 5.11.1 (5.11.0)
 

src/items/helpers.js

@@ -1,9 +1,20 @@
 // Helper functions used internally across the items namespace
 
-const { PercentType } = require('@runtime');
+const { UnDefType, PercentType } = require('@runtime');
 
 const { getQuantity, QuantityError } = require('../quantity');
 
+/**
+ * Check if a value is `null`, `undefined` or an instance of {@link https://www.openhab.org/javadoc/latest/org/openhab/core/types/undeftype `UnDefType`}.
+ *
+ * @private
+ * @param {*} value
+ * @returns {boolean}
+ */
+function _isNullOrUndefined (value) {
+  return value === null || value === undefined || value instanceof UnDefType;
+}
+
 /**
  * Return a string representation of a state.
  *
@@ -12,7 +23,7 @@ const { getQuantity, QuantityError } = require('../quantity');
  * @returns {string|null} string representation or `null` if `rawState` was `null`
  */
 function _stateOrNull (rawState) {
-  if (rawState === null) return null;
+  if (_isNullOrUndefined(rawState)) return null;
   return rawState.toString();
 }
 
@@ -25,7 +36,7 @@ function _stateOrNull (rawState) {
  * @returns {number|null} numeric representation or `null` if `rawState` was `null`
  */
 function _numericStateOrNull (rawState, type) {
-  if (rawState === null) return null;
+  if (_isNullOrUndefined(rawState)) return null;
   let state = rawState.toString();
   if (type === 'Color') state = rawState.as(PercentType).toString();
   const numericState = parseFloat(state);
@@ -41,7 +52,7 @@ function _numericStateOrNull (rawState, type) {
  * @throws failed to create quantityState
  */
 function _quantityStateOrNull (rawState) {
-  if (rawState === null) return null;
+  if (_isNullOrUndefined(rawState)) return null;
   try {
     const qty = getQuantity(rawState);
     return (qty !== null && qty.symbol !== null) ? qty : null;
@@ -55,6 +66,7 @@ function _quantityStateOrNull (rawState) {
 }
 
 module.exports = {
+  _isNullOrUndefined,
   _stateOrNull,
   _numericStateOrNull,
   _quantityStateOrNull

src/items/items.js

@@ -12,12 +12,12 @@ const cache = require('../cache');
 const time = require('../time');
 const environment = require('../environment');
 
-const { OnOffType, UnDefType, events } = require('@runtime');
+const { OnOffType, events } = require('@runtime');
 const itemRegistry = environment.useProviderRegistries()
   ? require('@runtime/provider').itemRegistry
   : require('@runtime').itemRegistry;
 
-const { _stateOrNull, _numericStateOrNull, _quantityStateOrNull } = require('./helpers');
+const { _stateOrNull, _numericStateOrNull, _quantityStateOrNull, _isNullOrUndefined } = require('./helpers');
 const metadata = require('./metadata');
 const itemChannelLink = require('./itemchannellink');
 const ItemPersistence = require('./item-persistence');
@@ -251,10 +251,7 @@ class Item {
    * @type {boolean}
    */
   get isUninitialized () {
-    return (this.rawItem.getState() instanceof UnDefType ||
-        this.rawItem.getState().toString() === 'Undefined' ||
-        this.rawItem.getState().toString() === 'Uninitialized'
-    );
+    return _isNullOrUndefined(this.rawState);
   }
 
   /**

src/things.js

@@ -145,10 +145,6 @@ class Thing {
   }
 }
 
-function addThing () {
-
-}
-
 /**
  * Gets an openHAB Thing.
  * Returns `null` if no Thing with the given UID exists.
@@ -175,7 +171,6 @@ function getThings () {
 
 module.exports = {
   Thing,
-  addThing,
   getThing,
   getThings
 };

types/items/items.d.ts.map

@@ -2,8 +2,15 @@ export type Item = {
     rawItem: HostItem;
     persistence: import("./items/item-persistence");
     semantics: import("./items/item-semantics");
-    readonly type: string;
+    readonly type: string; /**
+     * @type {QuantityType}
+     * @private
+     */
     readonly name: string;
+    /**
+     * @type {QuantityType}
+     * @private
+     */
     readonly label: string;
     readonly state: string;
     readonly numericState: number;