homebridge-lib 6.3.6 → 6.3.8

package/lib/HttpClient.js

@@ -1,478 +0,0 @@
-// homebridge-lib/lib/HttpClient.js
-//
-// Library for Homebridge plugins.
-// Copyright © 2018-2023 Erik Baauw. All rights reserved.
-
-'use strict'
-
-const homebridgeLib = require('../index')
-
-const events = require('events')
-const http = require('http')
-const https = require('https')
-
-/** HTTP error.
-  * @hideconstructor
-  * @extends Error
-  * @memberof HttpClient
-  */
-class HttpError extends Error {
-  constructor (message, request, statusCode, statusMessage) {
-    super(message)
-    /** @member {HttpClient.HttpRequest} - The request that caused the error.
-      */
-    this.request = request
-
-    /** @member {?integer} - The HTTP status code.
-      */
-    this.statusCode = statusCode
-
-    /** @member {?string} - The HTTP status message.
-      */
-    this.statusMessage = statusMessage
-  }
-}
-
-/** HTTP request.
-  * @hideconstructor
-  * @memberof HttpClient
-  */
-class HttpRequest {
-  constuctor (name, id, method, resource, headers, body, url) {
-    /** @member {string} - The server name.
-      */
-    this.name = name
-
-    /** @member {integer} - The request ID.
-      */
-    this.id = id
-
-    /** @member {string} - The request method.
-      */
-    this.method = method
-
-    /** @member {string} - The requested resource.
-      */
-    this.resource = resource
-
-    /** @member {object} - The request headers.
-      */
-    this.headers = headers
-
-    /** @member {?string} - The request body.
-      */
-    this.body = body
-
-    /** @member {string} - The full request URL.
-      */
-    this.url = url
-  }
-}
-
-/** HTTP response.
-  * @hideconstructor
-  * @memberof HttpClient
-  */
-class HttpResponse {
-  constructor (request, statusCode, statusMessage, headers, body, parsedBody) {
-    /** @member {HttpClient.HttpRequest} - The request that generated the response.
-      */
-    this.request = request
-
-    /** @member {integer} - The HTTP status code.
-      */
-    this.statusCode = statusCode
-
-    /** @member {string} - The HTTP status message.
-      */
-    this.statusMessage = statusMessage
-
-    /** @member {object} - The response headers.
-      */
-    this.headers = headers
-
-    /** @member {?*} - The response body.
-      */
-    this.body = body
-
-    /** @member {?*} - The parsed response body
-      * (in case of an XML response body).
-      */
-    this.parsedBody = parsedBody
-  }
-}
-
-/** HTTP client.
-  * @extends EventEmitter
-  */
-class HttpClient extends events.EventEmitter {
-  static get HttpError () { return HttpError }
-  static get HttpRequest () { return HttpRequest }
-  static get HttpResponse () { return HttpResponse }
-
-  /** Create a new instance of a client to an HTTP server.
-    *
-    * @param {object} params - Parameters.
-    * @param {object} [params.headers={}] - Default HTTP headers for each request.
-    * @param {string} [params.host='localhost:80'] - Server hostname and port.
-    * @param {boolean} [params.https=false] - Use HTTPS (instead of HTTP).
-    * @param {boolean} [params.ipv6=false] - Use IPv6 (instead of IPv4).
-    * @param {boolean} [params.json=false] - Use JSON, i.e. request and response
-    * bodies are JSON strings.
-    * @param {boolean} [params.keepAlive=false] - Keep server connection(s) open.
-    * @param {integer} [params.maxSockets=Infinity] - Throttle requests to
-    * maximum number of parallel connections.
-    * @param {?string} params.name - The name of the server.  Defaults to hostname.
-    * @param {string} [params.path=''] - Server base path.
-    * @param {boolean} [params.selfSignedCertificate=false] - Server uses a
-    * self-signed SSL certificate.
-    * @param {string} [params.suffix=''] - Base suffix to append after resource
-    * e.g. for authentication of the request.
-    * @param {boolean} [params.text=false] - Convert response body to text.
-    * @param {integer} [params.timeout=5] - Request timeout (in seconds).
-    * @param {integer[]} [params.validStatusCodes=[200]] - List of valid HTTP status codes.
-    * @param {?function} params.xmlParser - Parser for XML response body.
-    */
-  constructor (params) {
-    super()
-    this.__params = {
-      headers: {},
-      hostname: 'localhost',
-      keepAlive: false,
-      maxSockets: Infinity,
-      path: '',
-      suffix: '',
-      timeout: 5,
-      validStatusCodes: [200]
-    }
-    const optionParser = new homebridgeLib.OptionParser(this.__params)
-    optionParser
-      .hostKey()
-      .boolKey('https')
-      .boolKey('ipv6')
-      .objectKey('headers')
-      .boolKey('json')
-      .boolKey('keepAlive')
-      .intKey('maxSockets', 1)
-      .stringKey('name', true)
-      .stringKey('path')
-      .boolKey('selfSignedCertificate')
-      .stringKey('suffix')
-      .boolKey('text', true)
-      .intKey('timeout', 1, 60)
-      .arrayKey('validStatusCodes')
-      .asyncFunctionKey('xmlParser')
-      .parse(params)
-    if (this.__params.selfSignedCertificate) {
-      this.__params.https = true
-    }
-    this._http = this.__params.https ? https : http
-    this.__options = {
-      agent: new this._http.Agent({
-        keepAlive: this.__params.keepAlive,
-        maxSockets: this.__params.maxSockets
-      }),
-      family: this.__params.ipv6 ? 6 : 4,
-      headers: Object.assign({}, this.__params.headers),
-      timeout: 1000 * this.__params.timeout
-    }
-    if (this.__params.selfSignedCertificate) {
-      this.__options.rejectUnauthorized = false
-    }
-    if (this.__params.json) {
-      const json = 'application/json;charset=utf-8'
-      if (this.__options.headers == null) {
-        this.__options.headers = {}
-      }
-      this.__options.headers['Content-Type'] = json
-      if (this.__options.headers.Accept == null) {
-        this.__options.headers.Accept = json
-      } else {
-        this.__options.headers.Accept += ',' + json
-      }
-    }
-    this._setUrl()
-    this.__requestId = 0
-  }
-
-  _setUrl () {
-    this.__params.url = this.__params.https ? 'https://' : 'http://'
-    this.__params.url += this.__params.hostname
-    if (this.__params.port != null) {
-      this.__params.url += ':' + this.__params.port
-    }
-    this.__params.url += this.__params.path
-  }
-
-  /** Server IP address.
-    * @type {string}
-    * @readonly
-    */
-  get address () { return this.__params.address }
-
-  /** Server hostname and port.
-    * @type {string}
-    */
-  get host () {
-    let host = this.__params.hostname
-    if (this.__params.port != null) {
-      host += ':' + this.__params.port
-    }
-    return host
-  }
-
-  set host (value) {
-    const obj = homebridgeLib.OptionParser.toHost('host', value)
-    this.__params.hostname = obj.hostname
-    this.__params.port = obj.port
-    this._setUrl()
-  }
-
-  /** Local IP address used for the connection.
-    * @type {string}
-    * @readonly
-    */
-  get localAddress () { return this.__params.localAddress }
-
-  /** Server frienly name.
-    * Defaults to the hostname.
-    * @type {string}
-    */
-  get name () {
-    return this.__params.name == null
-      ? this.__params.hostname
-      : this.__params.name
-  }
-
-  set name (name) {
-    this.__params.name = name
-  }
-
-  /** Server (base) path.
-    * @type {string}
-    */
-  get path () { return this.__params.path }
-  set path (value) {
-    this.__params.path = value == null
-      ? ''
-      : homebridgeLib.OptionParser.toPath('path', value)
-    this._setUrl()
-  }
-
-  /** Server (base) url.
-    * @type {string}
-    * @readonly
-    */
-  get url () { return this.__params.url }
-
-  /** GET request.
-    * @param {string} [resource='/'] - The resource.
-    * @param {?object} headers - Additional headers for the request.
-    * @param {?string} suffix - Additional suffix to append after resource
-    * e.g. for authentication of the request.
-    * @return {HttpResponse} response - The response.
-    * @throws {HttpError} In case of error.
-    */
-  async get (resource = '/', headers, suffix) {
-    return this.request('GET', resource, undefined, headers, suffix)
-  }
-
-  /** PUT request.
-    * @param {!string} resource - The resource.
-    * @param {?*} body - The body for the request.
-    * @param {?object} headers - Additional headers for the request.
-    * @param {?string} suffix - Additional suffix to append after resource
-    * e.g. for authentication of the request.
-    * @return {HttpResponse} response - The response.
-    * @throws {HttpError} In case of error.
-    */
-  async put (resource, body, headers, suffix) {
-    return this.request('PUT', resource, body, headers, suffix)
-  }
-
-  /** POST request.
-    * @param {!string} resource - The resource.
-    * @param {?*} body - The body for the request.
-    * @param {?object} headers - Additional headers for the request.
-    * @param {?string} suffix - Additional suffix to append after resource
-    * e.g. for authentication of the request.
-    * @return {HttpResponse} response - The response.
-    * @throws {HttpError} In case of error.
-    */
-  async post (resource, body, headers, suffix) {
-    return this.request('POST', resource, body, headers, suffix)
-  }
-
-  /** DELETE request.
-    * @param {!string} resource - The resource.
-    * @param {?*} body - The body for the request.
-    * @param {?object} headers - Additional headers for the request.
-    * @param {?string} suffix - Additional suffix to append after resource
-    * e.g. for authentication of the request.
-    * @return {object} response - The response.
-    * @throws {HttpError} In case of error.
-    */
-  async delete (resource, body, headers, suffix) {
-    return this.request('DELETE', resource, body, headers, suffix)
-  }
-
-  /** Check self-signed SSL certificate.
-    * @abstract
-    * @throws {Error} For invalid SSL certificate.
-    */
-  checkCertificate (cert) {}
-
-  /** Issue an HTTP request.
-    * @param {string} method - The method for the request.
-    * @param {!string} resource - The resource for the request.
-    * @param {?*} body - The body for the request.
-    * @param {?object} headers - Additional headers for the request.
-    * @param {?string} suffix - Additional suffix to append after resource
-    * e.g. for authentication of the request.
-    * @param {?object} info - Additional key/value pairs to include in the
-    * for the `HttpRequest` of the `request`, `response`, and `error` events.
-    * @return {HttpResponse} response - The response.
-    * @throws {HttpError} In case of error.
-    */
-  async request (method, resource, body, headers = {}, suffix = '', info = {}) {
-    return new Promise((resolve, reject) => {
-      method = homebridgeLib.OptionParser.toString('method', method, true)
-      if (!http.METHODS.includes(method)) {
-        throw new TypeError(`${method}: invalid method`)
-      }
-      resource = homebridgeLib.OptionParser.toString('resource', resource, true)
-      if (body != null && !Buffer.isBuffer(body)) {
-        body = this.__params.json
-          ? JSON.stringify(body)
-          : homebridgeLib.OptionParser.toString('body', body)
-      }
-      const requestId = ++this.__requestId
-      const url = this.__params.url + (resource === '/' ? '' : resource) +
-                  this.__params.suffix + suffix
-      const options = Object.assign({ method }, this.__options)
-      const requestInfo = Object.assign({
-        name: this.name,
-        id: requestId,
-        method,
-        resource,
-        body,
-        url
-      }, info)
-      const request = this._http.request(url, options)
-      request
-        .on('error', (error) => {
-          if (!(error instanceof HttpError)) {
-            error = new HttpError(error.message, requestInfo)
-          }
-          /** Emitted in case of error.
-            * @event HttpClient#error
-            * @param {HttpClient.HttpError} error - The error.
-            */
-          this.emit('error', error)
-          reject(error)
-        })
-        .on('timeout', () => {
-          const error = new HttpError(
-            `timeout after ${this.__params.timeout} seconds`,
-            requestInfo, 408, 'Request Timeout'
-          )
-          request.destroy(error)
-        })
-        .on('socket', (socket) => {
-          if (
-            this.__params.address == null || this.__params.localAddress == null
-          ) {
-            socket.once('connect', () => {
-              this.__params.address = socket.remoteAddress
-              this.__params.localAddress = socket.localAddress
-            })
-          }
-          /** Emitted when a request has been sent to the HTTP server.
-            * @event HttpClient#request
-            * @param {HttpClient.HttpRequest} request - The request.
-            */
-          this.emit('request', requestInfo)
-        })
-        .on('response', (response) => {
-          if (this.__params.selfSignedCertificate) {
-            try {
-              this.checkCertificate(response.socket.getPeerCertificate())
-            } catch (error) {
-              request.destroy(error)
-              return
-            }
-          }
-          const a = []
-          response
-            .on('data', (chunk) => { a.push(chunk) })
-            .on('end', async () => {
-              const buffer = Buffer.concat(a)
-
-              if (!this.__params.validStatusCodes.includes(response.statusCode)) {
-                request.emit('error',
-                  new HttpError(
-                    `http status ${response.statusCode} ${response.statusMessage}`,
-                    requestInfo, response.statusCode, response.statusMessage
-                  )
-                )
-                return
-              }
-              const responseInfo = {
-                request: requestInfo,
-                headers: response.headers,
-                statusCode: response.statusCode,
-                statusMessage: response.statusMessage,
-                body: null
-              }
-              if (buffer != null && buffer.length > 0) {
-                responseInfo.body = buffer
-                if (response.headers['content-type'] != null) {
-                  if (
-                    response.headers['content-type'].startsWith('application/json')
-                  ) {
-                    try {
-                      responseInfo.body = JSON.parse(buffer.toString('utf-8'))
-                    } catch (error) {
-                      request.emit('error', error)
-                      return
-                    }
-                  } else if (response.headers['content-type'].startsWith('text')) {
-                    responseInfo.body = buffer.toString('utf-8')
-                    if (
-                      response.headers['content-type'].startsWith('text/xml') &&
-                      this.__params.xmlParser != null
-                    ) {
-                      try {
-                        responseInfo.parsedBody = await this.__params.xmlParser(
-                          responseInfo.body
-                        )
-                      } catch (error) {
-                        request.emit('error', error)
-                        return
-                      }
-                    }
-                  }
-                }
-              }
-              /** Emitted when a valid response has been received from the HTTP server.
-                * @event HttpClient#response
-                * @param {HttpClient.HttpResponse} response - The response.
-                */
-              this.emit('response', responseInfo)
-              resolve(responseInfo)
-            })
-        })
-
-      if (headers != null) {
-        headers = homebridgeLib.OptionParser.toObject('headers', headers)
-        for (const header in headers) {
-          request.setHeader(header, headers[header])
-        }
-      }
-      requestInfo.headers = request.getHeaders()
-      request.end(body)
-    })
-  }
-}
-
-module.exports = HttpClient

package/lib/JsonFormatter.js

@@ -1,200 +0,0 @@
-// homebridge-lib/lib/JsonFormatter.js
-//
-// Library for Homebridge plugins.
-// Copyright © 2018-2023 Erik Baauw. All rights reserved.
-
-'use strict'
-
-const homebridgeLib = require('../index')
-
-/** JSON formatter.
-  *
-  * Class to format (pretty-print) JavaScript types to formatted JSON strings.
-  * This class is the engine under the `json` command-line tool.
-  */
-class JsonFormatter {
-  /** Create a new instance of a JSON formatter.
-    *
-    * The parameters configure how the JSON should be formatted.
-    * @param {object} params - Parameters.
-    * @param {boolean} [params.ascii=false] - Output path:value in plain text
-    * instead of JSON.
-    * <br>Command-line equivalent: `json -a`
-    * @param {string} params.fromPath - Limit output to key/values under path.
-    * <br>Set top level below path.
-    * <br>Command-line equivalent: `json -p `_path_
-    * @param {boolean} [params.jsonArray=false] - Output JSON array of objects
-    * for each key/value pair.<br>
-    * Each object contains two key/value pairs: key `keys` with an array
-    * of keys as value and key `value` with the value as value.
-    * <br>Command-line equivalent: `json -j`
-    * @param {boolean} [params.joinKeys=false] - Output JSON array of objects
-    * for each key/value pair.<br>
-    * Each object contains one key/value pair: the path (concatenated
-    * keys separated by '/') as key and the value as value.
-    * <br>Command-line equivalent: `json -u`
-    * @param {boolean} [params.keysOnly=false] -  Limit output to keys.
-    * <br>With `joinKeys` output JSON array of paths.
-    * <br>Command-line equivalent: `json -k`
-    * @param {boolean} [params.leavesOnly=false] -  Limit output to leaf
-    * (non-array, non-object) key/values.
-    * <br>Command-line equivalent: `json -l`
-    * @param {?integer} params.maxDepth - Limit output to levels above depth.
-    * <br>Command-line equivalent: `json -d `_depth_
-    * @param {boolean} [params.noWhiteSpace=false] - Do not include spaces nor
-    * newlines in the output.
-    * <br>Command-line equivalent: `json -n`
-    * @param {boolean} [params.sortKeys=false] - Sort object key/value pairs
-    * alphabetically on key.
-    * <br>Command-line equivalent: `json -s`
-    * @param {boolean} [params.topOnly=false] - Limit output to top-level key/values.
-    * <br>Command-line equivalent: `json -t`
-    * @param {boolean} [params.valuesOnly=false] -  Limit output to values.
-    * <br>With `joinKeys` output JSON array of values.
-    * <br>Command-line equivalent: `json -v`
-    */
-  constructor (params = {}) {
-    this.options = {}
-    const optionParser = new homebridgeLib.OptionParser(this.options)
-    optionParser.boolKey('sortKeys')
-    optionParser.boolKey('noWhiteSpace')
-    optionParser.boolKey('jsonArray')
-    optionParser.boolKey('joinKeys')
-    optionParser.boolKey('ascii')
-    optionParser.boolKey('topOnly')
-    optionParser.intKey('maxDepth', 0)
-    optionParser.pathKey('fromPath')
-    optionParser.boolKey('leavesOnly')
-    optionParser.boolKey('keysOnly')
-    optionParser.boolKey('valuesOnly')
-    optionParser.parse(params)
-    if (this.options.ascii) {
-      this.options.noWhiteSpace = true
-      this.options.joinKeys = true
-    }
-    if (
-      this.options.joinKeys || this.options.topOnly || this.options.leavesOnly ||
-      this.options.keysOnly || this.options.valuesOnly
-    ) {
-      this.options.jsonArray = true
-    }
-  }
-
-  _forEach (value, callback) {
-    function forEach (keys, value, depth) {
-      const isCollection = (typeof (value) === 'object' && value != null)
-
-      if (value === undefined) {
-        return
-      }
-      if (
-        !isCollection ||
-        (!this.options.leavesOnly && (!this.options.topOnly || depth === 1))
-      ) {
-        callback(keys, value)
-      }
-      if (
-        isCollection && (!this.options.topOnly || depth === 0) &&
-        depth !== this.options.maxDepth
-      ) {
-        const list = Object.keys(value)
-        if (this.options.sortKeys && !Array.isArray(value)) {
-          list.sort()
-        }
-        for (const key of list) {
-          forEach.call(this, keys.concat([key]), value[key], depth + 1)
-        }
-      }
-    }
-
-    forEach.call(this, [], value, 0)
-  }
-
-  _map (value, callback) {
-    const array = []
-    this._forEach(value, (keys, value) => {
-      array.push(callback(keys, value))
-    })
-    return array
-  }
-
-  _format (value, maxDepth = this.options.maxDepth, withIndent = '  ') {
-    function format (value, depth, indent) {
-      const noNewline = this.options.noWhiteSpace || depth >= maxDepth
-      const nl = this.options.noWhiteSpace ? '' : noNewline ? ' ' : '\n'
-      const sp = this.options.noWhiteSpace ? '' : ' '
-      const nlsp = noNewline ? '' : '\n'
-      const wi = noNewline ? '' : withIndent
-      const id = noNewline ? '' : indent
-
-      if (value === undefined) {
-        return ''
-      }
-      if (typeof (value) !== 'object' || value == null) {
-        return JSON.stringify(value)
-      }
-      const array = []
-      const list = Object.keys(value)
-      if (this.options.sortKeys && !Array.isArray(value)) {
-        list.sort()
-      }
-      for (const key of list) {
-        if (value[key] !== undefined) {
-          const k = Array.isArray(value) ? '' : `"${key}":${sp}`
-          const v = format.call(this, value[key], depth + 1, `${wi}${id}`)
-          array.push(k + v)
-        }
-      }
-      let s = array.join(`,${nl}${wi}${id}`)
-      if (s !== '') {
-        s = `${nlsp}${wi}${id}${s}${nlsp}${id}`
-      }
-      return Array.isArray(value) ? `[${s}]` : `{${s}}`
-    }
-    return format.call(this, value, 0, '')
-  }
-
-  /** Transform javascript value into a formatted JSON string.
-    *
-    * @param {*} value - The JavaScript value.
-    * @return {string} json - The formatted JSON string.
-    */
-  stringify (value) {
-    if (this.options.fromPath != null) {
-      const a = this.options.fromPath.slice(1).split('/')
-      for (const key of a) {
-        if (typeof (value) === 'object' && value != null) {
-          value = value[key]
-        } else {
-          value = undefined
-        }
-      }
-    }
-    if (!this.options.jsonArray) {
-      return this._format(value)
-    }
-    const array = this._map(value, (keys, value) => {
-      if (this.options.ascii) {
-        if (this.options.keysOnly) { return `/${keys.join('/')}` }
-        if (this.options.valuesOnly) { return this._format(value) }
-        return `/${keys.join('/')}:${this._format(value)}`
-      } else if (this.options.joinKeys) {
-        if (this.options.keysOnly) { return `/${keys.join('/')}` }
-        if (this.options.valuesOnly) { return value }
-        const obj = {}
-        obj[`/${keys.join('/')}`] = value
-        return obj
-      } else {
-        if (this.options.keysOnly) { return { keys } }
-        if (this.options.valuesOnly) { return { value } }
-        return { keys, value }
-      }
-    })
-    if (this.options.ascii) {
-      return array.join('\n')
-    }
-    return this._format(array, 1)
-  }
-}
-
-module.exports = JsonFormatter