[items] Set event source for commands & updates

Refs openhab/openhab-core#5122.
Refs openhab/openhab-core#5136.

Signed-off-by: Florian Hotze <[email protected]>

Author: florian-h05

src/items/items.js

@@ -29,6 +29,9 @@ const ItemDTOMapper = Java.type('org.openhab.core.items.dto.ItemDTOMapper');
 const ItemDTO = Java.type('org.openhab.core.items.dto.ItemDTO');
 const GroupItemDTO = Java.type('org.openhab.core.items.dto.GroupItemDTO');
 const GroupFunctionDTO = Java.type('org.openhab.core.items.dto.GroupFunctionDTO');
+const AbstractEvent = Java.type('org.openhab.core.events.AbstractEvent');
+
+const BusEventImplClassName = 'org.openhab.core.automation.module.script.internal.action.BusEventImpl';
 
 // typedefs need to be global for TypeScript to fully work
 /**
@@ -70,6 +73,34 @@ const GroupFunctionDTO = Java.type('org.openhab.core.items.dto.GroupFunctionDTO'
  * @private
  */
 
+let eventSource = null;
+
+/**
+ * Builds the event source for commands and updates.
+ * Caches the computed source string.
+ * @return {string}
+ * @private
+ */
+function _buildEventSource () {
+  if (eventSource) return eventSource;
+
+  const packageName = 'org.openhab.automation.jsscripting';
+  const filename = globalThis['javax.script.filename']?.replace(/^.*[\\/]/, '');
+  const ruleUID = globalThis.ruleUID;
+  const engineIdentifier = globalThis['oh.engine-identifier'];
+  if (filename) {
+    eventSource = AbstractEvent.buildSource(packageName, `file:${filename}`);
+  } else if (ruleUID) {
+    eventSource = AbstractEvent.buildSource(packageName, `rule:${ruleUID}`);
+  } else if (engineIdentifier.startsWith('openhab-transformation-script-')) {
+    eventSource = AbstractEvent.buildSource(packageName,
+      `transformation:${engineIdentifier.replaceAll('openhab-transformation-script-', '')}`);
+  } else {
+    eventSource = AbstractEvent.buildSource(packageName, `engine:${engineIdentifier}`);
+  }
+  return eventSource;
+}
+
 /**
  * Class representing an openHAB Item
  *
@@ -354,7 +385,14 @@ class Item {
       }, expire.toMillis(), this, onExpire, value);
       cache.private.put(CACHE_KEY, timeoutId);
     }
-    events.sendCommand(this.rawItem, _toOpenhabPrimitiveType(value));
+
+    if (Java.typeName(events.getClass()) === BusEventImplClassName) {
+      // BusEventImpl supports providing command source
+      events.sendCommand(this.rawItem, _toOpenhabPrimitiveType(value), _buildEventSource());
+    } else {
+      // old ScriptBusEventImpl doesn't support providing command source
+      events.sendCommand(this.rawItem, _toOpenhabPrimitiveType(value));
+    }
   }
 
   /**
@@ -511,7 +549,13 @@ class Item {
    * @see sendCommand
    */
   postUpdate (value) {
-    events.postUpdate(this.rawItem, _toOpenhabPrimitiveType(value));
+    if (Java.typeName(events.getClass()) === BusEventImplClassName) {
+      // BusEventImpl supports providing update source
+      events.postUpdate(this.rawItem, _toOpenhabPrimitiveType(value), _buildEventSource());
+    } else {
+      // old ScriptBusEventImpl doesn't support providing update source
+      events.postUpdate(this.rawItem, _toOpenhabPrimitiveType(value));
+    }
   }
 
   /**

types/items/items.d.ts

@@ -143,44 +143,6 @@ export function replaceItem(itemConfig: ItemConfig): Item | null;
  * @returns {Item|null} the Item that has been removed or `null` if no Item has been found, or it cannot be removed
  */
 export function removeItem(itemOrItemName: string | Item): Item | null;
-/**
- * @typedef {object} ItemConfig configuration describing an Item
- * @property {string} type the type of the Item
- * @property {string} name Item name for the Item to create
- * @property {string} [label] the label for the Item
- * @property {string} [category] the category (icon) for the Item
- * @property {string[]} [groups] an array of groups the Item is a member of
- * @property {string[]} [tags] an array of tags for the Item
- * @property {object} [group] group configuration, only applicable if type is `Group`
- * @property {string} group.type the type of the Group, such as `Switch` or `Number`
- * @property {string} [group.function] the group function, such as 'EQUALITY' or `AND`
- * @property {string[]} [group.parameters] optional parameters for the group function, e.g. `ON` and `OFF` for the `AND` function
- * @property {string|object} [channels] for single channel link a string or for multiple an object { channeluid: configuration }; configuration is an object
- * @property {*} [metadata] either object `{ namespace: value }` or `{ namespace: `{@link ItemMetadata}` }`
- * @property {string} [format] short form for the stateDescription metadata's pattern configuration
- * @property {string} [unit] short form for the unit metadata's value
- * @property {boolean} [autoupdate] short form for the autoupdate metadata's value
- */
-/**
- * @typedef {import('./metadata').ItemMetadata} ItemMetadata
- * @private
- */
-/**
- * @typedef {import('@js-joda/core').ZonedDateTime} ZonedDateTime
- * @private
- */
-/**
- * @typedef {import('@js-joda/core').Instant} Instant
- * @private
- */
-/**
- * @typedef {import('@js-joda/core').Duration} Duration
- * @private
- */
-/**
- * @typedef {import('../quantity').Quantity} Quantity
- * @private
- */
 /**
  * Class representing an openHAB Item
  *

types/items/items.d.ts.map

@@ -9,7 +9,13 @@ export type Item = {
     readonly state: string;
     readonly numericState: number;
     readonly quantityState: Quantity;
-    readonly boolState: boolean;
+    readonly boolState: boolean; /**
+     * Convert this Quantity to the given unit.
+     *
+     * @param {string} unit
+     * @returns {Quantity|null} a new Quantity with the given unit or `null` if conversion to this unit is not possible
+     * @throws {QuantityError} when unit cannot be parsed because it is invalid
+     */
     readonly rawState: HostState;
     readonly previousState: string;
     readonly previousNumericState: number;