node-red-contrib-knx-ultimate 7.1.4 → 8.0.2

package/nodes/utils/http.js

@@ -1,291 +0,0 @@
-const simpleget = require('simple-get')
-
-const DEFAULT_TIMEOUT_MS = 30000
-
-/**
-* Parameters.
-*
-* @param config.key the credentualskey.
-* @param config.prefix the bridge's URL
-* @param config.url the resource url
- * @param config.timeoutMs optional request timeout
-*/
-module.exports.use = (config) => {
-  const http = {}
-
-  const logError = (message) => {
-    try {
-      const logger = config?.logger || config?.sysLogger
-      if (logger?.error) logger.error(message)
-      else console.error(message)
-    } catch (error) {
-      try { console.error(message) } catch (err) { /* empty */ }
-    }
-  }
-
-  /**
-     * Make a http call.
-     *
-     * @param opt  Used as options for simple get.
-     */
-  http.call = async (opt) => {
-    return new Promise((resolve, reject) => {
-      const requestOptions = { ...opt }
-      requestOptions.rejectUnauthorized = false
-      requestOptions.timeout = Number.isFinite(config?.timeoutMs) && config.timeoutMs > 0
-        ? config.timeoutMs
-        : DEFAULT_TIMEOUT_MS
-      if (config?.agent) requestOptions.agent = config.agent
-      requestOptions.headers = {
-        ...(opt.headers || {}),
-        'hue-application-key': config.key
-      }
-      if (requestOptions.body && !requestOptions.headers['Content-Type'] && !requestOptions.headers['content-type']) {
-        requestOptions.headers['Content-Type'] = 'application/json'
-      }
-      requestOptions.url = config.prefix + requestOptions.url
-      // log.trace('http ' + opt.method + ' ' + opt.url);
-      const req = simpleget.concat(requestOptions, (err, res, data) => {
-        if (err) return reject(err)
-
-        const statusCode = res?.statusCode ?? 0
-        const statusMessage = res?.statusMessage || ''
-        const responseText = Buffer.isBuffer(data) ? data.toString('utf8') : String(data ?? '')
-
-        if (statusCode >= 100 && statusCode < 400) {
-          let result
-          try {
-            result = JSON.parse(responseText)
-          } catch (error) {
-            logError(`utils.http: Invalid JSON response from ${requestOptions.url}: ${error.message}`)
-            return reject(new Error(`Invalid JSON response for ${requestOptions.url}: ${error.message}`))
-          }
-
-          if (result?.errors && Array.isArray(result.errors) && result.errors.length > 0) {
-            return reject(new Error('The response for ' + requestOptions.url + ' returned errors ' + JSON.stringify(result.errors)))
-          }
-          if (!Object.prototype.hasOwnProperty.call(result || {}, 'data')) {
-            return reject(new Error('Unexpected result with no data. ' + JSON.stringify(result)))
-          }
-          return resolve(result.data)
-        }
-
-        logError(`utils.http: Error response from ${requestOptions.url}: ${statusCode} ${statusMessage}`)
-        const bodySnippet = responseText ? ` ${responseText}` : ''
-        return reject(new Error(`Error response for ${requestOptions.url} with status ${statusCode} ${statusMessage}${bodySnippet}`))
-      })
-
-      // Ensure timeouts fire even if the underlying client ignores the option.
-      try {
-        if (requestOptions.timeout && typeof req?.setTimeout === 'function') {
-          req.setTimeout(requestOptions.timeout)
-        }
-      } catch (error) { /* empty */ }
-    })
-  }
-
-  /**
-     * Make a POST call.
-     *
-     * @param url The target url.
-     * @param data The body data.
-     */
-  http.post = async (url, data) => {
-    return await http.call({
-      method: 'POST',
-      url,
-      body: JSON.stringify(data)
-    })
-  }
-
-  /**
-     * Makes a put call.
-     *
-     * @param url The target url.
-     */
-  http.put = async (url, data) => {
-    return await http.call({
-      method: 'PUT',
-      url,
-      body: JSON.stringify(data)
-    })
-  }
-
-  /**
-     * Makes a get call.
-     *
-     * @param url The target url.
-     */
-  http.get = async (url) => {
-    return await http.call({
-      method: 'GET',
-      url
-    })
-  }
-  /**
-      * Makes a delete call.
-      *
-      * @param url The target url.
-      */
-  http.delete = async (url) => {
-    return await http.call({
-      method: 'DELETE',
-      url
-    })
-  }
-
-  return http
-}
-
-/**
-* Get Bridgedetails
-*
-* @param _ip The target ip.
-*/
-module.exports.getBridgeDetails = async (_ip) => {
-  return new Promise((resolve, reject) => {
-    const opt = {}
-    opt.method = 'GET'
-    opt.rejectUnauthorized = false
-    opt.url = 'https://' + _ip + '/api/0/config'
-    simpleget.concat(opt, (err, res, data) => {
-      if (err) return reject(new Error(err.message || 'getBridgeDetails general error'))
-
-      const statusCode = res?.statusCode ?? 0
-      const statusMessage = res?.statusMessage || ''
-      const responseText = Buffer.isBuffer(data) ? data.toString('utf8') : String(data ?? '')
-
-      if (statusCode < 200 || statusCode >= 400) {
-        return reject(new Error('Error response for ' + opt.url + ' with status ' + statusCode + ' ' + statusMessage))
-      }
-
-      try {
-        const result = JSON.parse(responseText)
-        if (result?.errors && Array.isArray(result.errors) && result.errors.length > 0) {
-          return reject(new Error('The response for ' + opt.url + ' returned errors ' + JSON.stringify(result.errors)))
-        }
-        if (!result) {
-          return reject(new Error('Unexpected result with no data. ' + JSON.stringify(result)))
-        }
-        return resolve(result)
-      } catch (error) {
-        return reject(new Error(`Invalid Hue bridge configuration response: ${error.message}`))
-      }
-    })
-  })
-}
-
-/**
-* Register a new application user on the Hue bridge.
-*
-* @param {string} ip Bridge IP address.
-* @param {string} appName Application name (used for devicetype).
-* @param {string} deviceName Device name (used for devicetype).
-* @returns {Promise<{bridge: object, user: {username: string, clientkey?: string}}>}
-*/
-module.exports.registerBridgeUser = async (ip, appName = 'KNXUltimate', deviceName = 'Node-RED') => {
-  const deviceType = `${appName}#${deviceName}`.substring(0, 40)
-  const payload = JSON.stringify({
-    devicetype: deviceType,
-    generateclientkey: true
-  })
-
-  const postOptions = {
-    method: 'POST',
-    url: `https://${ip}/api`,
-    rejectUnauthorized: false,
-    headers: {
-      'Content-Type': 'application/json'
-    },
-    body: payload
-  }
-
-  const postResponse = await new Promise((resolve, reject) => {
-    simpleget.concat(postOptions, (err, res, data) => {
-      if (err) {
-        return reject(new Error(err.message || 'Hue registration request failed'))
-      }
-      if (!res || res.statusCode < 200 || res.statusCode >= 400) {
-        return reject(new Error(`Hue registration request failed with status ${res?.statusCode ?? 'unknown'}`))
-      }
-      try {
-        const parsed = JSON.parse(data)
-        resolve(parsed)
-      } catch (parseError) {
-        reject(new Error(`Invalid Hue registration response: ${parseError.message}`))
-      }
-    })
-  })
-
-  if (!Array.isArray(postResponse) || postResponse.length === 0) {
-    throw new Error('Unexpected Hue registration response')
-  }
-  const firstEntry = postResponse[0]
-  if (firstEntry.error) {
-    throw new Error(firstEntry.error.description || 'Hue Bridge rejected the registration request. Press the link button and try again.')
-  }
-  const success = firstEntry.success || {}
-  if (!success.username) {
-    throw new Error('Hue Bridge did not return a username.')
-  }
-
-  const username = success.username
-  const clientkey = success.clientkey
-
-  const configOptions = {
-    method: 'GET',
-    url: `https://${ip}/api/${username}/config`,
-    rejectUnauthorized: false
-  }
-
-  const bridgeConfig = await new Promise((resolve, reject) => {
-    simpleget.concat(configOptions, (err, res, data) => {
-      if (err) return reject(new Error(err.message || 'Unable to read Hue bridge configuration'))
-      if (!res || res.statusCode < 200 || res.statusCode >= 400) {
-        return reject(new Error(`Hue bridge configuration request failed with status ${res?.statusCode ?? 'unknown'}`))
-      }
-      try {
-        const parsed = JSON.parse(data)
-        resolve(parsed)
-      } catch (parseError) {
-        reject(new Error(`Invalid Hue bridge configuration response: ${parseError.message}`))
-      }
-    })
-  })
-
-  return {
-    bridge: bridgeConfig,
-    user: { username, clientkey }
-  }
-}
-
-/**
-* Discover Hue bridges using the public discovery service.
-* @returns {Promise<Array<{id?: string, internalipaddress?: string}>>}
-*/
-module.exports.discoverHueBridges = async () => {
-  return await new Promise((resolve, reject) => {
-    const opt = {
-      method: 'GET',
-      url: 'https://discovery.meethue.com',
-      rejectUnauthorized: false
-    }
-    simpleget.concat(opt, (err, res, data) => {
-      if (err) {
-        return reject(new Error(err.message || 'Unable to reach discovery.meethue.com'))
-      }
-      if (!res || res.statusCode < 200 || res.statusCode >= 400) {
-        return reject(new Error(`Discovery request failed with status ${res?.statusCode ?? 'unknown'}`))
-      }
-      try {
-        const parsed = JSON.parse(data)
-        if (!Array.isArray(parsed)) {
-          return reject(new Error('Unexpected discovery response'))
-        }
-        resolve(parsed)
-      } catch (parseError) {
-        reject(new Error(`Invalid discovery response: ${parseError.message}`))
-      }
-    })
-  })
-}

package/nodes/utils/hueControllerProfileAdapter.js

@@ -1,104 +0,0 @@
-'use strict'
-
-// These are the canonical runtime implementations owned by HUE Controller.
-// They deliberately keep the familiar "module receives RED, then calls
-// registerType" shape: that lets us preserve the well-tested lifecycle of each
-// dedicated Hue implementation without registering fifteen more public nodes.
-//
-// None of these paths is listed under `node-red.nodes` in package.json. Node-RED
-// therefore never loads them as palette nodes, and deleting a legacy entry point
-// cannot remove code required by HUE Controller.
-const RUNTIME_MODULES = Object.freeze({
-  light: './hueControllerProfiles/runtime/light',
-  plug: './hueControllerProfiles/runtime/plug',
-  button: './hueControllerProfiles/runtime/button',
-  relative_rotary: './hueControllerProfiles/runtime/relative_rotary',
-  motion: './hueControllerProfiles/runtime/motion',
-  area_motion: './hueControllerProfiles/runtime/area_motion',
-  camera_motion: './hueControllerProfiles/runtime/camera_motion',
-  contact: './hueControllerProfiles/runtime/contact',
-  light_level: './hueControllerProfiles/runtime/light_level',
-  temperature: './hueControllerProfiles/runtime/temperature',
-  humidity: './hueControllerProfiles/runtime/humidity',
-  scene: './hueControllerProfiles/runtime/scene',
-  device_power: './hueControllerProfiles/runtime/device_power',
-  zigbee_connectivity: './hueControllerProfiles/runtime/zigbee_connectivity',
-  device_software_update: './hueControllerProfiles/runtime/device_software_update'
-})
-
-// A constructor closes over the RED instance used while loading its module.
-// Cache by RED first (rather than globally) so tests, embedded runtimes and future
-// hot-reload scenarios never accidentally share constructors across runtimes.
-// WeakMap also means an abandoned RED instance is not kept alive by this adapter.
-const constructors = new WeakMap()
-
-const getConstructorCache = (RED) => {
-  let cache = constructors.get(RED)
-  if (!cache) {
-    cache = new Map()
-    constructors.set(RED, cache)
-  }
-  return cache
-}
-
-const captureRuntimeConstructor = (RED, controllerType) => {
-  const modulePath = RUNTIME_MODULES[controllerType]
-  if (!modulePath) return undefined
-
-  const cache = getConstructorCache(RED)
-  if (cache.has(controllerType)) return cache.get(controllerType)
-
-  let capturedConstructor
-
-  // The private modules believe they are registering an ordinary node. The
-  // facade delegates every real RED service through the prototype chain but
-  // intercepts only registerType, turning registration into constructor capture.
-  // The real Node-RED registry is never touched here.
-  const redFacade = Object.create(RED)
-  redFacade.nodes = Object.create(RED.nodes)
-  redFacade.nodes.registerType = (_type, constructor) => {
-    capturedConstructor = constructor
-  }
-
-  // CommonJS itself caches the module source; our per-RED cache stores the
-  // constructor produced by invoking its exported registration function.
-  require(modulePath)(redFacade)
-  if (typeof capturedConstructor !== 'function') {
-    throw new Error(`Unable to load HUE Controller runtime for ${controllerType}`)
-  }
-
-  cache.set(controllerType, capturedConstructor)
-  return capturedConstructor
-}
-
-const normalizeControllerType = (config = {}) => {
-  // `hueControllerType` is the authoritative new field. The resource suffix is
-  // a compatibility safety net for imported or partially migrated flows.
-  const configuredType = String(config.hueControllerType || '').trim()
-  if (RUNTIME_MODULES[configuredType]) return configuredType
-
-  const resourceType = String(config.hueDevice || '').split('#')[1] || ''
-  if (RUNTIME_MODULES[resourceType]) return resourceType
-
-  // grouped_light intentionally falls through to light: both resource kinds
-  // use the same mature light runtime and there is no separate grouped profile.
-  return 'light'
-}
-
-const setupHueControllerRuntime = (RED, node, config) => {
-  const controllerType = normalizeControllerType(config)
-  const RuntimeConstructor = captureRuntimeConstructor(RED, controllerType)
-
-  // Execute the selected constructor *on the Controller instance*. Its own
-  // RED.nodes.createNode call installs all normal Node-RED lifecycle hooks,
-  // while the persisted public type remains knxUltimateHueController.
-  RuntimeConstructor.call(node, config)
-  node.hueControllerType = controllerType
-}
-
-module.exports = {
-  RUNTIME_MODULES,
-  captureRuntimeConstructor,
-  normalizeControllerType,
-  setupHueControllerRuntime
-}

package/nodes/utils/hueControllerProfiles/runtime/area_motion.js

@@ -1,221 +0,0 @@
-// Canonical private runtime profile for HUE Controller: area_motion.
-// This module is shipped with the Controller but is intentionally absent from
-// package.json, so Node-RED never registers it as a separate palette node.
-module.exports = function (RED) {
-  function knxUltimateHueAreaMotion (config) {
-    RED.nodes.createNode(this, config)
-    const node = this
-    node.serverKNX = RED.nodes.getNode(config.server) || undefined
-    node.serverHue = RED.nodes.getNode(config.serverHue) || undefined
-    node.topic = node.name
-    node.name = config.name === undefined ? 'Hue' : config.name
-    node.dpt = ''
-    node.notifyreadrequest = true
-    node.notifyreadrequestalsorespondtobus = 'false'
-    node.notifyreadrequestalsorespondtobusdefaultvalueifnotinitialized = ''
-    node.notifyresponse = false
-    node.notifywrite = true
-    node.initialread = true
-    node.listenallga = true
-    node.outputtype = 'write'
-    node.outputRBE = 'false'
-    node.inputRBE = 'false'
-    node.currentPayload = ''
-    node.passthrough = 'no'
-    node.formatmultiplyvalue = 1
-    node.formatnegativevalue = 'leave'
-    node.formatdecimalsvalue = 2
-    node.hueDevice = config.hueDevice
-    node.dptAreaMotion = config.dptAreaMotion
-    node.motionDPT = (config.dptAreaMotion && config.dptAreaMotion !== '') ? config.dptAreaMotion : '1.001'
-    node.initializingAtStart = (config.readStatusAtStartup === undefined || config.readStatusAtStartup === 'yes')
-    node.currentDeviceValue = false
-    node.enableNodePINS = (config.enableNodePINS === undefined || config.enableNodePINS === 'yes')
-    node.outputs = node.enableNodePINS ? 1 : 0
-
-    if (!node.serverKNX && node.enableNodePINS !== 'yes') {
-      node.enableNodePINS = 'yes'
-      node.outputs = 1
-    }
-
-    const pushStatus = (status) => {
-      if (!status) return
-      const provider = node.serverKNX
-      if (provider && typeof provider.applyStatusUpdate === 'function') {
-        provider.applyStatusUpdate(node, status)
-      } else {
-        node.status(status)
-      }
-    }
-
-    const updateStatus = (status) => {
-      if (!status) return
-      pushStatus(status)
-    }
-
-    const formatTs = (date) => {
-      const d = date instanceof Date ? date : new Date(date)
-      const provider = node.serverKNX
-      if (provider && typeof provider.formatStatusTimestamp === 'function') return provider.formatStatusTimestamp(d)
-      return `${d.getDate()}, ${d.toLocaleTimeString()}`
-    }
-
-    const safeSendToKNX = (telegram, context = 'write') => {
-      try {
-        if (!node.serverKNX || typeof node.serverKNX.sendKNXTelegramToKNXEngine !== 'function') {
-          const now = new Date()
-          updateStatus({ fill: 'red', shape: 'dot', text: `KNX server missing (${context}) (${formatTs(now)})` })
-          return
-        }
-        node.serverKNX.sendKNXTelegramToKNXEngine({ ...telegram, nodecallerid: node.id })
-      } catch (error) {
-        updateStatus({ fill: 'red', shape: 'dot', text: `KNX send error ${error.message}` })
-      }
-    }
-
-    node.setNodeStatus = ({ fill, shape, text, payload }) => {
-      try {
-        if (payload === undefined) payload = ''
-        const dDate = new Date()
-        payload = typeof payload === 'object' ? JSON.stringify(payload) : payload.toString()
-        node.sKNXNodeStatusText = `|KNX: ${text} ${payload} (${formatTs(dDate)})`
-        pushStatus({ fill, shape, text: (node.sHUENodeStatusText || '') + ' ' + (node.sKNXNodeStatusText || '') })
-      } catch (error) { }
-    }
-
-    node.setNodeStatusHue = ({ fill, shape, text, payload }) => {
-      try {
-        if (payload === undefined) payload = ''
-        const dDate = new Date()
-        payload = typeof payload === 'object' ? JSON.stringify(payload) : payload.toString()
-        node.sHUENodeStatusText = `|HUE: ${text} ${payload} (${formatTs(dDate)})`
-        pushStatus({ fill, shape, text: node.sHUENodeStatusText + ' ' + (node.sKNXNodeStatusText || '') })
-      } catch (error) { }
-    }
-
-    const mapMotionValue = (_event) => {
-      const motion = _event?.motion
-      if (!motion) return undefined
-
-      const readBoolean = (candidate) => {
-        if (typeof candidate === 'boolean') return candidate
-        if (candidate && typeof candidate.value === 'boolean') return candidate.value
-        return undefined
-      }
-
-      let value = readBoolean(motion.motion)
-      if (value === undefined && motion.motion_report) {
-        value = readBoolean(motion.motion_report.motion)
-      }
-      if (value === undefined && motion.motion_report && typeof motion.motion_report.motion === 'boolean') {
-        value = motion.motion_report.motion
-      }
-      if (value === undefined && typeof motion.motion_valid === 'boolean') {
-        value = motion.motion_valid
-      }
-      if (value === undefined) {
-        value = readBoolean(motion.motion_valid)
-      }
-      return value
-    }
-
-    node.handleSend = (msg) => {
-      if (!msg || !msg.knx) return
-      if (msg.knx.event === 'GroupValue_Read') {
-        switch (msg.knx.destination) {
-          case config.GAareaMotion:
-            node.sendResponseToKNX(node.currentDeviceValue)
-            break
-          default:
-            break
-        }
-      }
-    }
-
-    node.handleSendHUE = (_event) => {
-      try {
-        if (_event.id !== config.hueDevice) return
-        const motionValue = mapMotionValue(_event)
-        if (motionValue === undefined) return
-
-        const knxMsgPayload = {
-          topic: config.GAareaMotion,
-          dpt: node.motionDPT,
-          payload: motionValue === true || motionValue === 1 || motionValue === '1' ? true : Boolean(motionValue),
-          name: node.name,
-          event: 'motion',
-          rawEvent: _event
-        }
-
-        if (knxMsgPayload.topic) {
-          safeSendToKNX({
-            grpaddr: knxMsgPayload.topic,
-            payload: knxMsgPayload.payload,
-            dpt: knxMsgPayload.dpt,
-            outputtype: 'write'
-          }, 'write')
-        }
-        node.currentDeviceValue = knxMsgPayload.payload
-
-        updateStatus({
-          fill: 'green',
-          shape: 'dot',
-          text: `HUE->KNX ${knxMsgPayload.payload} (${formatTs(new Date())})`
-        })
-
-        if (node.enableNodePINS) {
-          node.send(knxMsgPayload)
-        }
-        node.setNodeStatusHue({
-          fill: 'blue',
-          shape: 'ring',
-          text: 'HUE->KNX',
-          payload: knxMsgPayload.payload
-        })
-      } catch (error) {
-        updateStatus({
-          fill: 'red',
-          shape: 'dot',
-          text: `HUE->KNX error ${error.message} (${formatTs(new Date())})`
-        })
-      }
-    }
-
-    node.sendResponseToKNX = (_level) => {
-      if (!node.serverKNX) return
-      const knxMsgPayload = {
-        topic: config.GAareaMotion,
-        dpt: node.motionDPT,
-        payload: !!(_level === true || _level === 1 || _level === '1')
-      }
-      if (knxMsgPayload.topic) {
-        safeSendToKNX({
-          grpaddr: knxMsgPayload.topic,
-          payload: knxMsgPayload.payload,
-          dpt: knxMsgPayload.dpt,
-          outputtype: 'response'
-        }, 'response')
-      }
-    }
-
-    if (node.serverKNX) {
-      node.serverKNX.removeClient(node)
-      node.serverKNX.addClient(node)
-    }
-    if (node.serverHue) {
-      node.serverHue.removeClient(node)
-      node.serverHue.addClient(node)
-    }
-
-    node.on('close', (done) => {
-      if (node.serverKNX) {
-        node.serverKNX.removeClient(node)
-      }
-      if (node.serverHue) {
-        node.serverHue.removeClient(node)
-      }
-      done()
-    })
-  }
-  RED.nodes.registerType('knxUltimateHueAreaMotion', knxUltimateHueAreaMotion)
-}