@capturebridge/sdk 0.15.0 → 0.16.0

package/CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.16.0] - 2024-10-03
+
+### Changed
+
+- `Plugin.shutdown` now accepts a `timeout` argument.
+
+### Removed
+
+- Removed all callback style methods in favor of async/await methods.
+
 ## [0.15.0] - 2024-09-25
 
 ### Added

package/Camera.js

@@ -2,8 +2,7 @@ import StreamingCapturePlugin from './StreamingCapturePlugin.js'
 import {
   BASE_URL,
   DEFAULT_CAPTURE_OPT,
-  DEPRECATION_01,
-  asyncToCallback
+  DEPRECATION_01
 } from './Common.js'
 
 /**
@@ -54,10 +53,6 @@ class Camera extends StreamingCapturePlugin {
     const mergedOpt = Object.assign({}, DEFAULT_CAPTURE_OPT, captureOpt)
     return await this.fullCapture(mergedOpt, deviceOpt)
   }
-
-  takePhotoHandler (captureOpt = {}, deviceOpt, callback) {
-    asyncToCallback(this, this.fullCapture, callback, captureOpt, deviceOpt)
-  }
 }
 
 export default Camera

package/CaptureBridge.js

@@ -1,5 +1,5 @@
 import Plugin from './Plugin.js'
-import { BASE_URL, asyncToCallback, checkResponse } from './Common.js'
+import { BASE_URL, checkResponse } from './Common.js'
 
 /**
  * Capture Bridge
@@ -35,26 +35,6 @@ class CaptureBridge {
     return await response.json()
   }
 
-  /**
-   * Get service version info (Callback)
-   * @method
-   * @see {@link https://local.capturebridge.net:9001/doc/#api-Service-GetVersion|API Endpoint (/version)}
-   * @param {function} callback - Invoked with two arguments. The first argument
-   * is an Error object (if an error occurred) or null. The second argument is
-   * the version info.
-   * @example
-   * captureBridge.versionHandler((error, {version}) => {
-   *   if (error) {
-   *     console.error('Error fetching version:', error)
-   *   } else {
-   *     console.log(`Version: ${version}`)
-   *   }
-   * })
-   */
-  versionHandler (callback) {
-    asyncToCallback(this, this.version, callback)
-  }
-
   /**
    * Get service status information
    * @method
@@ -71,22 +51,6 @@ class CaptureBridge {
     return await response.json()
   }
 
-  /**
-   * Get service status information (Callback)
-   * @method
-   * @see {@link https://local.capturebridge.net:9001/doc/#api-Service-GetStatus|API Endpoint (/status)}
-   * @param {function} callback - Invoked with two arguments. The first argument
-   * is an Error object (if an error occurred) or null. The second argument is
-   * the status info.
-   * object.
-   * @example
-   * const captureBridge = new CaptureBridge()
-   * captureBridge.statusHandler(statusInfo => console.log(statusInfo))
-   */
-  statusHandler (callback) {
-    asyncToCallback(this, this.status, callback)
-  }
-
   /**
    * Get all installed plugins
    * @method
@@ -103,22 +67,6 @@ class CaptureBridge {
     return plugins.map(p => new Plugin(p, this.baseUrl))
   }
 
-  /**
-   * Get all installed plugins (Callback)
-   * @method
-   * @see {@link https://local.capturebridge.net:9001/doc/#api-Plugin-GetPlugins|API Endpoint (/plugin)}
-   * @see {@link Plugin}
-   * @param {function} callback - Invoked with two arguments. The first argument
-   * is an Error object (if an error occurred) or null. The second argument is
-   * an Array of {@link Plugin} objects. If no plugins are installed the second
-   * argument will be an empty Array.
-   * @example
-   * captureBridge.pluginsHandler(plugins => console.log(plugins))
-   */
-  pluginsHandler (callback) {
-    asyncToCallback(this, this.plugins, callback)
-  }
-
   /**
    * Get a single plugin by ID
    * @method
@@ -136,25 +84,6 @@ class CaptureBridge {
     const pluginJSON = await response.json()
     return new Plugin(pluginJSON)
   }
-
-  /**
-   * Get a single plugin by ID (Callback version).
-   * @method
-   * @see {@link https://local.capturebridge.net:9001/doc/#api-Plugin-GetPlugins|API Endpoint (/plugin)}
-   * @see {@link Plugin}
-   * @param {string} id - Plugin ID
-   * @param {function} callback - Invoked with two arguments. The first argument
-   * is an Error object (if an error occurred) or null. The second argument is
-   * the requested {@link Plugin} object. If no matching plugin was found the
-   * second argument will be null.
-   * @example
-   * captureBridge.pluginHandler('capture_camera_canon', (error, plugin) => {
-   *   console.log(error, plugin)
-   * })
-   */
-  pluginHandler (id, callback) {
-    asyncToCallback(this, this.plugin, callback, id)
-  }
 }
 
 export default CaptureBridge

package/Common.js

@@ -212,22 +212,6 @@ export const blobToBase64 = blob => {
   })
 }
 
-/**
- * Helper function for classes to easily add callback style support to their
- * async/await methods.
- * @private
- */
-export const asyncToCallback = (thisValue, asyncFn, callback, ...params) => {
-  (async () => {
-    try {
-      const result = await asyncFn.call(thisValue, ...(params.length ? params : []))
-      callback(null, result)
-    } catch (ex) {
-      callback(ex)
-    }
-  })()
-}
-
 /**
  * Helper function to throw if an http response was a error.
  * @private

package/Device.js

@@ -6,7 +6,6 @@ import {
   DEFAULT_CAPTURE_OPT,
   checkResponse,
   timeout,
-  asyncToCallback,
   urlParamsToString
 } from './Common.js'
 
@@ -163,32 +162,6 @@ class Device {
     return await response.blob()
   }
 
-  /**
-   * Take full capture from the specified device and return a
-   * {@link https://developer.mozilla.org/en-US/docs/Web/API/Blob|Blob} that can
-   * be used with a {@link https://developer.mozilla.org/en-US/docs/Web/API/FileReader|FileReader}
-   * (Callback version)
-   *
-   * @method
-   * @param {function} callback
-   * @param {CaptureOptions} [captureOpt] - Additional options for capturing a
-   * frame.
-   * @example
-   * // Load the blob into FileReader and append to the document's body
-   * device.captureAsBlobHandler((error, blob) => {
-   *   const reader = new FileReader()
-   *   reader.onload = event => {
-   *     const img = document.createElement('img')
-   *     img.src = event.target.result
-   *     document.body.appendChild(img)
-   *    }
-   *   reader.readAsDataURL(blob)
-   * })
-   */
-  captureAsBlobHandler (callback, captureOpt = {}) {
-    asyncToCallback(this, this.captureAsBlob, captureOpt, callback)
-  }
-
   /**
    * Take full capture from the specified device and return a
    * base64 encoded string of the image that can be used with a
@@ -224,20 +197,6 @@ class Device {
     return image
   }
 
-  /**
-   * Take full capture from the specified device and return a
-   * base64 encoded string of the image that can be used with a
-   * {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs|Data URL}
-   *  (Callback version)
-   * @method
-   * @param {function} callback
-   * @param {CaptureOptions} [captureOpt] - Additional options for capturing a
-   * frame.
-   */
-  captureAsBase64Handler (callback, captureOpt = {}) {
-    asyncToCallback(this, this.captureAsBase64, callback)
-  }
-
   /**
    * Get a base64 encoded frame from a device's live feed.
    * @method
@@ -290,42 +249,6 @@ class Device {
     }
   }
 
-  /**
-   * Get a base64 encoded frame from a device's live feed. (Callback version)
-   * @method
-   *
-   * @description This method will startup the live
-   * feed if necessary and wait for it to initialize before returning a frame.
-   * Subsequent calls will return the next available frame.
-   * You must manually stop the live feed if you are using this method.
-   *
-   * The frame returned will be a base64 encoded string of the image that can
-   * be used with a
-   * {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs|Data URL}
-   *
-   * If implementing a real-time preview, it is highly recommended to use the
-   * stream endpoint which will stream a Motion JPEG.
-   *
-   * @see {@link streamUrl}
-   * @see {@link setStopFeed}
-   *
-   * @param {function} callback
-   * @param {CaptureOptions} [captureOpt] - Additional options for capturing a
-   * frame.
-   * @param {number} [millis] - Milliseconds to wait if feed is not ready
-   * @example
-   * // Add the base64 string as a Data URL to an img tag and append to
-   * // the document's body
-   * device.frameAsBase64Handler(base64 => {
-   *   const img = document.createElement('img')
-   *   img.src = 'data:image/jpeg;base64,' + base64
-   *   document.body.appendChild(img)
-   * })
-   */
-  frameAsBase64Handler (callback, captureOpt = {}, millis = 500) {
-    asyncToCallback(this, this.frameAsBase64, callback, captureOpt, millis)
-  }
-
   /**
    * Get a binary frame from a device's live feed. (Async/await version)
    * @method
@@ -379,48 +302,6 @@ class Device {
     throw new Error(result || 'Failed to get frame')
   }
 
-  /**
-   * Get a binary frame from a device's live feed. (Callback version)
-   * @method
-   *
-   * @description This method will startup the live
-   * feed if necessary and wait for it to initialize before returning a frame.
-   * Subsequent calls will return the next available frame.
-   * You must manually stop the live feed if you are using this method.
-   *
-   * The frame returned will be a
-   * {@link https://developer.mozilla.org/en-US/docs/Web/API/Blob|Blob} that can
-   * be used with a {@link https://developer.mozilla.org/en-US/docs/Web/API/FileReader|FileReader}
-   *
-   * If implementing a real-time preview, it is highly recommended to use the
-   * stream endpoint which will stream a Motion JPEG.
-   *
-   * @see {@link streamUrl}
-   * @see {@link setStopFeed}
-   *
-   * @param {function} callback
-   *
-   * @param {CaptureOptions} [captureOpt] - Additional options for capturing a
-   * frame.
-   *
-   * @param {number} [millis] - Milliseconds to wait if feed is not ready
-   *
-   * @example
-   * // Load the blob into FileReader and append to the document's body
-   * device.frameAsBlobHandler((error, blob) => {
-   *   const reader = new FileReader()
-   *   reader.onload = event => {
-   *     const img = document.createElement('img')
-   *     img.src = event.target.result
-   *     document.body.appendChild(img)
-   *   }
-   *   reader.readAsDataURL(blob)
-   * })
-   */
-  frameAsBlobHandler (callback, captureOpt = {}, millis = 500) {
-    asyncToCallback(this, this.frameAsBlob, callback, captureOpt, millis)
-  }
-
   /**
    * Stop the live feed if it is running.
    * (Async/Await version)
@@ -441,26 +322,6 @@ class Device {
     return await response.json()
   }
 
-  /**
-   * Stop the live feed if it is running.
-   * (Callback version)
-   *
-   * @method
-   * @param {number} [millis] - Milliseconds to wait if feed is not ready
-   * @param {function} callback with the status of the stop operation
-   * @example
-   * device.stopFeedHandler((error, blob) => {
-   *   // Plugin is now running it's live feed in a background thread
-   *   device.setStopFeed(result => {
-   *     // Live feed is now stopping
-   *     console.log(result)
-   *   })
-   * })
-   */
-  stopFeedHandler (callback) {
-    asyncToCallback(this, this.frameAsBlob, callback)
-  }
-
   /**
    * Clear a device's display.
    * (Async/Await version)
@@ -484,24 +345,6 @@ class Device {
     return await response.json()
   }
 
-  /**
-   * Clear a device's display.
-   * (Callback version)
-   *
-   * @method
-   * @param {function} callback with the status of the clear operation
-   * @param {boolean} [backlight] If provided and set to true, will enable
-   * backlight. If false, it will be disabled. If unspecified no action will be
-   * taken on the backlight.
-   * @example
-   *  device.clearHandler((error, result) => {
-   *    console.log(result)
-   *  })
-   */
-  clearHandler (callback, backlight) {
-    asyncToCallback(this, this.clear, callback, backlight)
-  }
-
   /**
    * Render an Array of Objects on the display and wait for user input.
    *
@@ -548,10 +391,6 @@ class Device {
     return await response.json()
   }
 
-  async displayObjectsHandler (objects, clear = true, callback) {
-    asyncToCallback(this, this.displayObjects, callback, objects, clear)
-  }
-
   /**
    * Get detailed information about a device
    *
@@ -569,20 +408,6 @@ class Device {
     const response = await fetch(url)
     return await response.json()
   }
-
-  /**
-   * Get detailed information about a device
-   *
-   * @description Returns detailed information about a device.
-   *
-   * @method
-   * @returns {object} Device info
-   * @example
-   * const info = await device.info()
-   */
-  async infoHandler (callback) {
-    asyncToCallback(this, this.info, callback)
-  }
 }
 
 export default Device

package/IFace.js

@@ -119,10 +119,6 @@ export class IFace extends ICAO {
     return VALID_MODES
   }
 
-  matchModesHandler (callback) {
-    callback(null, VALID_MODES)
-  }
-
   /**
    * Check the ICAO compliance of an image
    * @param {string} image - A base64 encoded image.

package/Plugin.js

@@ -1,6 +1,6 @@
 import Device from './Device.js'
 
-import { BASE_URL, DELETE, checkResponse, asyncToCallback } from './Common.js'
+import { BASE_URL, DELETE, checkResponse } from './Common.js'
 
 /**
  * @classdesc CaptureBridge utilizes a plugin system for interacting with
@@ -75,24 +75,6 @@ class Plugin {
     return devices.map(d => new Device(d, this, this.baseUrl))
   }
 
-  /**
-   * Get all Devices for this plugin
-   *
-   * @method
-   * @see {@link https://local.capturebridge.net:9001/doc/#api-Plugin-GetPluginDevices|API Endpoint (/plugin/:pluginId/device)}
-   * @param {function} callback - Invoked with two arguments. The first argument
-   * is an Error object (if an error occurred) or null. The second argument is
-   * an Array of {@link Device} objects. If no devices are available the second
-   * argument will be an empty Array.
-   * @example
-   * captureBridge.pluginHandler('capture_camera_canon', (error, plugin) => {
-   *   plugin.devicesHandler((error, devices) => console.log(devices))
-   * })
-   */
-  devicesHandler (callback) {
-    asyncToCallback(this, this.devices, callback)
-  }
-
   /**
    * Get a device by ID for this plugin
    *
@@ -112,24 +94,6 @@ class Plugin {
     return device ? new Device(device, this, this.baseUrl) : null
   }
 
-  /**
-   * Get a Device by ID for this plugin
-   * @method
-   * @see {@link https://local.capturebridge.net:9001/doc/#api-Plugin-GetPluginDevices|API Endpoint (/plugin/:pluginId/device)}
-   * @param {string} id - Device ID
-   * @param {function} callback - Invoked with two arguments. The first argument
-   * is an Error object (if an error occurred) or null. The second argument is
-   * a {@link Device} object. If the requested device is not available the
-   * second argument will be null.
-   * @example
-   * captureBridge.pluginHandler('capture_camera_canon', (error, plugin) => {
-   *   plugin.deviceHandler('AWOOO56709', (error, device) => console.log(device))
-   * })
-   */
-  deviceHandler (id, callback) {
-    asyncToCallback(this, this.device, callback, id)
-  }
-
   async configSchema () {
     if (!await this.supportsConfig()) {
       throw new Error('Plugin does not support config')
@@ -138,10 +102,6 @@ class Plugin {
     return await response.json()
   }
 
-  configSchemaHandler (callback) {
-    asyncToCallback(this, this.configSchema, callback)
-  }
-
   async config () {
     if (!await this.supportsConfig()) {
       throw new Error('Plugin does not support config')
@@ -150,10 +110,6 @@ class Plugin {
     return await response.json()
   }
 
-  configHandler (callback) {
-    asyncToCallback(this, this.config, callback)
-  }
-
   async saveConfig (config) {
     if (!await this.supportsConfig()) {
       throw new Error('Plugin does not support config')
@@ -171,29 +127,29 @@ class Plugin {
     return await response.json()
   }
 
-  async saveConfigHandler (config, callback) {
-    asyncToCallback(this, this.saveConfig, callback, config)
-  }
-
   async supportsConfig () {
     await this.update()
     return this.configMethods.every(m => this.methods.includes(m))
   }
 
-  supportsConfigHandler (callback) {
-    asyncToCallback(this, this.configHandler, callback)
-  }
-
-  async shutdown () {
-    const url = `${this.baseUrl}/plugin/${this.id}`
+  /**
+   * Shutdown a plugin
+   * @method
+   * @async
+   * @see {@link https://local.capturebridge.net:9001/doc/#api-Plugin-ShutdownPlugin|API Endpoint (/plugin/:pluginId)}
+   * @param {number} [timeout=10] - Timeout in seconds. Forcefully terminate
+   * the plugin if it doesn't shutdown cleanly within the specified timeout. A
+   * value of `0` will result in immediately terminating the plugin and should
+   * be avoided unless the plugin is unresponsive.
+   * @example
+   * await plugin.shutdown()
+   */
+  async shutdown (timeout = 10) {
+    const url = `${this.baseUrl}/plugin/${this.id}?timeout=${timeout}`
     const response = await fetch(url, DELETE)
     return await response.json()
   }
 
-  shutdownHandler (callback) {
-    asyncToCallback(this, this.shutdown, callback)
-  }
-
   async startup () {
     // See: ValidRD/wa_capture_bridge/issues/48
     // We need an explicit endpoint for this instead
@@ -205,10 +161,6 @@ class Plugin {
     return { status: 'failed' }
   }
 
-  startupHandler (callback) {
-    asyncToCallback(this, this.startup, callback)
-  }
-
   /**
    * This class can be instantiated from either a plugin ID or a full plugin
    * object from an API request.
@@ -227,10 +179,6 @@ class Plugin {
     }
   }
 
-  updateHandler (force = false, callback) {
-    asyncToCallback(this, this.update, callback, force)
-  }
-
   /**
    * Check if a plugin has an RPC method
    *
@@ -259,19 +207,11 @@ class Plugin {
     return await response.json()
   }
 
-  rpcHandler (request, callback) {
-    asyncToCallback(this, this.rpc, callback, request)
-  }
-
   async ping () {
     const response = await fetch(`${this.baseUrl}/plugin/${this.id}/ping`)
     return await response.json()
   }
 
-  pingHandler (callback) {
-    asyncToCallback(this, this.ping, callback)
-  }
-
   /**
    * Classes that extend this one will add their own methods to perform
    * operations on a device. They will call this method first to get a device

package/Version.js

@@ -4,5 +4,5 @@
  * @constant
  * @type {string}
  */
-const VERSION = '0.15.0'
+const VERSION = '0.16.0'
 export default VERSION

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capturebridge/sdk",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "Capture Bridge JavaScript SDK for web applications",
   "type": "module",
   "types": "types.d.ts",