@capturebridge/sdk 0.12.0 → 0.14.1

package/CHANGELOG.md

@@ -1,58 +1,93 @@
-# Changelog
-
-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.12.0] - 2024-08-08
-
-### Changed
-
-- `BASE_URL` will default to `window.location.origin` if available, else
-  https://local.capturebridge.net:9001) will be used.
-
-## [0.11.4] - 2024-07-29
-
-### Added
-
-- Added `background` parameter to `ICAO.check()` and `IFace.icao()` that will
-  fill in any part of the cropped image that falls outside the source image.
-
-## [0.11.0] - 2024-06-21
-
-### Added
-
-- Added `DeviceForms` and `ControlProperty` classes for configuring forms for
-  `Verifone`.
-- Added `Verifone.renderForm()`
-
-## [0.10.0] - 2024-06-17
-
-### Changed
-
-- Introduced breaking changes to the structure of the object returned from
-  `ICAO.check()`
-- `ICAO` class will default to use the `capture_verify_iface` plugin if no
-  plugin is provided to the constructor.
-
-### Added
-
-- Coordinates of the cropped photo are now returned from `ICAO.check()` if a face
-was found.
-
-## [0.9.0] - 2024-06-06
-
-### Added
-
-- Introduced Changelog.
-- Add Verifone class and examples (features signature capture support for the M450)
-- Add `format` parameter to `DEFAULT_CAPTURE_OPT` (defaults to `null` which will
-  use the plugin's default image format.)
-- Add `CaptureResponseFormat` type definition to documentation.
-
-### Fixed
-
-- Fix bug where `null` would be sent for some URL parameters.
-
-[0.9.0]: https://www.npmjs.com/package/@capturebridge/sdk/v/0.9.0
+# Changelog
+
+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.14.0] - 2024-09-17
+
+### Added
+
+- Add `Verifone.readMagstripe()` method for reading magstripe from Verifone.
+
+## [0.13.0] - 2024-09-10
+
+### Added
+
+- Add Verifone dynamic form support and examples.
+
+### Changed
+
+- `TopazSigGem.displayObjects()` previously accepted a boolean parameter for
+it's second argument, which if `true`, would clear the screen before displaying
+the objects. This method now accepts a `sceneOpt` object which contains
+`clear` and `backlight` boolean. A deprecation flag has been added to preserve
+the original function signature such that, if a boolean is provided, the method
+will fallback to the previous behavior of clearing the screen and emit a console
+warning. If an object is provided it will utilize any `clear` or `backlight`
+boolean properties.
+
+```js
+// Previous behavior, still works but will emit deprecation warning
+await tablet.displayObjects([
+  new Text('My hovercraft is full of eels.', 100, 400),
+], false)
+
+// New behavior
+const result = await tablet.displayObjects([
+  new Text('My hovercraft is full of eels.', 100, 400),
+], {clear: false, backlight: true})
+```
+
+## [0.12.0] - 2024-08-08
+
+### Changed
+
+- `BASE_URL` will default to `window.location.origin` if available, else
+  https://local.capturebridge.net:9001) will be used.
+
+## [0.11.4] - 2024-07-29
+
+### Added
+
+- Added `background` parameter to `ICAO.check()` and `IFace.icao()` that will
+  fill in any part of the cropped image that falls outside the source image.
+
+## [0.11.0] - 2024-06-21
+
+### Added
+
+- Added `DeviceForms` and `ControlProperty` classes for configuring forms for
+  `Verifone`.
+- Added `Verifone.renderForm()`
+
+## [0.10.0] - 2024-06-17
+
+### Changed
+
+- Introduced breaking changes to the structure of the object returned from
+  `ICAO.check()`
+- `ICAO` class will default to use the `capture_verify_iface` plugin if no
+  plugin is provided to the constructor.
+
+### Added
+
+- Coordinates of the cropped photo are now returned from `ICAO.check()` if a face
+was found.
+
+## [0.9.0] - 2024-06-06
+
+### Added
+
+- Introduced Changelog.
+- Add Verifone class and examples (features signature capture support for the M450)
+- Add `format` parameter to `DEFAULT_CAPTURE_OPT` (defaults to `null` which will
+  use the plugin's default image format.)
+- Add `CaptureResponseFormat` type definition to documentation.
+
+### Fixed
+
+- Fix bug where `null` would be sent for some URL parameters.
+
+[0.9.0]: https://www.npmjs.com/package/@capturebridge/sdk/v/0.9.0

package/Camera.js

@@ -1,63 +1,63 @@
-import StreamingCapturePlugin from './StreamingCapturePlugin.js'
-import {
-  BASE_URL,
-  DEFAULT_CAPTURE_OPT,
-  DEPRECATION_01,
-  asyncToCallback
-} from './Common.js'
-
-/**
- * Camera
- * @classdesc Class for invoking methods on a Camera
- * @extends StreamingCapturePlugin
- * @see {@link CanonCamera}
- */
-class Camera extends StreamingCapturePlugin {
-  /**
-   * Instantiate a Generic Camera
-   * @constructor
-   * @param {string} pluginId - The Id of the desired plugin to use for this
-   * camera instance. The plugin must support the `start_feed`, `stop_feed`,
-   * `devices`, and `capture` methods.
-   * @param {string} [baseURL] - Protocol, domain, and port for the service.
-   * @example
-   * const camera = new Camera('capture_camera_canon')
-   */
-  constructor (pluginId, baseUrl = BASE_URL) {
-    super(pluginId, baseUrl)
-  }
-
-  /**
-   * Capture a photo
-   * @param {CaptureOptions} [captureOpt] - Additional options for capturing a
-   * photo.
-   * @param {string|object} [deviceOpt] - Take the photo using either a specific
-   * Device ID or a Device Object. The default is the first available device.
-   *
-   * @async
-   * @example
-   * // Capture a photo as an ObjectURL, add it to an img element and append to
-   * // the document's body.
-   * const img = document.createElement('img')
-   * img.src = await camera.takePhoto()
-   * document.body.appendChild(img)
-   */
-  async takePhoto (captureOpt = {}, deviceOpt) {
-    if (typeof captureOpt === 'string' && DEPRECATION_01) {
-      captureOpt = { kind: captureOpt }
-      console.warn('CaptureBridge SDK Deprecation Warning: ' +
-        '`Camera.takePhoto()` converted the `captureOpt` argument from a ' +
-        'string (%s) to an object (%s). This conversion may not be performed ' +
-        'in future SDK versions.',
-      captureOpt.kind, JSON.stringify(captureOpt))
-    }
-    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
+import StreamingCapturePlugin from './StreamingCapturePlugin.js'
+import {
+  BASE_URL,
+  DEFAULT_CAPTURE_OPT,
+  DEPRECATION_01,
+  asyncToCallback
+} from './Common.js'
+
+/**
+ * Camera
+ * @classdesc Class for invoking methods on a Camera
+ * @extends StreamingCapturePlugin
+ * @see {@link CanonCamera}
+ */
+class Camera extends StreamingCapturePlugin {
+  /**
+   * Instantiate a Generic Camera
+   * @constructor
+   * @param {string} pluginId - The Id of the desired plugin to use for this
+   * camera instance. The plugin must support the `start_feed`, `stop_feed`,
+   * `devices`, and `capture` methods.
+   * @param {string} [baseURL] - Protocol, domain, and port for the service.
+   * @example
+   * const camera = new Camera('capture_camera_canon')
+   */
+  constructor (pluginId, baseUrl = BASE_URL) {
+    super(pluginId, baseUrl)
+  }
+
+  /**
+   * Capture a photo
+   * @param {CaptureOptions} [captureOpt] - Additional options for capturing a
+   * photo.
+   * @param {string|object} [deviceOpt] - Take the photo using either a specific
+   * Device ID or a Device Object. The default is the first available device.
+   *
+   * @async
+   * @example
+   * // Capture a photo as an ObjectURL, add it to an img element and append to
+   * // the document's body.
+   * const img = document.createElement('img')
+   * img.src = await camera.takePhoto()
+   * document.body.appendChild(img)
+   */
+  async takePhoto (captureOpt = {}, deviceOpt) {
+    if (typeof captureOpt === 'string' && DEPRECATION_01) {
+      captureOpt = { kind: captureOpt }
+      console.warn('CaptureBridge SDK Deprecation Warning: ' +
+        '`Camera.takePhoto()` converted the `captureOpt` argument from a ' +
+        'string (%s) to an object (%s). This conversion may not be performed ' +
+        'in future SDK versions.',
+      captureOpt.kind, JSON.stringify(captureOpt))
+    }
+    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/CanonCamera.js

@@ -1,25 +1,25 @@
-import Camera from './Camera.js'
-import { BASE_URL } from './Common.js'
-
-/**
- * CanonCamera
- * @classdesc Convenience class for instantiating a Canon Camera Object.
- * Inherits all methods on the {@link Camera} class.
- * @extends Camera
- * @see {@link Camera}
- */
-class CanonCamera extends Camera {
-  /**
-   * Instantiate a Canon Camera
-   * @constructor
-   * @param {string} [baseURL] - Protocol, domain, and port for the service.
-   * @example
-   * const camera = new CanonCamera()
-   * const base64 = await camera.takePhoto({kind: 'base64'})
-   */
-  constructor (baseUrl = BASE_URL) {
-    super('capture_camera_canon', baseUrl)
-  }
-}
-
-export default CanonCamera
+import Camera from './Camera.js'
+import { BASE_URL } from './Common.js'
+
+/**
+ * CanonCamera
+ * @classdesc Convenience class for instantiating a Canon Camera Object.
+ * Inherits all methods on the {@link Camera} class.
+ * @extends Camera
+ * @see {@link Camera}
+ */
+class CanonCamera extends Camera {
+  /**
+   * Instantiate a Canon Camera
+   * @constructor
+   * @param {string} [baseURL] - Protocol, domain, and port for the service.
+   * @example
+   * const camera = new CanonCamera()
+   * const base64 = await camera.takePhoto({kind: 'base64'})
+   */
+  constructor (baseUrl = BASE_URL) {
+    super('capture_camera_canon', baseUrl)
+  }
+}
+
+export default CanonCamera

package/CaptureBridge.js

@@ -1,160 +1,160 @@
-import Plugin from './Plugin.js'
-import { BASE_URL, asyncToCallback, checkResponse } from './Common.js'
-
-/**
- * Capture Bridge
- *
- * @classdesc Class for interacting with the HTTP API's base methods.
- */
-class CaptureBridge {
-  baseUrl
-  /**
-   * Instantiate a client for interacting with the Capture Bridge service.
-   * @constructor
-   * @param {string} [baseURL] - Protocol, domain, and port for the service.
-   * @example
-   * const captureBridge = new CaptureBridge()
-   */
-  constructor (baseUrl = BASE_URL) {
-    this.baseUrl = baseUrl
-  }
-
-  /**
-   * Get service version info
-   * @method
-   * @async
-   * @returns {object} Service version info.
-   * @see {@link https://local.capturebridge.net:9001/doc/#api-Service-GetVersion|API Endpoint (/version)}
-   * @example
-   * const captureBridge = new CaptureBridge()
-   * const {version} = await captureBridge.version()
-   * console.log(version)
-   */
-  async version () {
-    const response = await fetch(`${this.baseUrl}/version`)
-    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
-   * @async
-   * @see {@link https://local.capturebridge.net:9001/doc/#api-Service-GetStatus|API Endpoint (/status)}
-   * @returns {object} Service status information.
-   * @example
-   * const captureBridge = new CaptureBridge()
-   * const statusInfo = await captureBridge.status()
-   * console.log(statusInfo)
-   */
-  async status () {
-    const response = await fetch(`${this.baseUrl}/status`)
-    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
-   * @async
-   * @see {@link https://local.capturebridge.net:9001/doc/#api-Plugin-GetPlugins|API Endpoint (/plugin)}
-   * @see {@link Plugin}
-   * @returns {object[]} Array of {@link Plugin} objects.
-   * @example
-   * const plugins = await captureBridge.plugins()
-   */
-  async plugins () {
-    const response = await fetch(`${this.baseUrl}/plugin`)
-    const plugins = await response.json()
-    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
-   * @async
-   * @see {@link https://local.capturebridge.net:9001/doc/#api-Plugin-GetPlugins|API Endpoint (/plugin)}
-   * @see {@link Plugin}
-   * @param {string} id - Plugin ID
-   * @returns {object?} {@link Plugin} object or null
-   * @example
-   * const plugin = await captureBridge.plugin('capture_camera_canon')
-   */
-  async plugin (id) {
-    const response = await fetch(`${this.baseUrl}/plugin/${id}`)
-    await checkResponse(response)
-    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
+import Plugin from './Plugin.js'
+import { BASE_URL, asyncToCallback, checkResponse } from './Common.js'
+
+/**
+ * Capture Bridge
+ *
+ * @classdesc Class for interacting with the HTTP API's base methods.
+ */
+class CaptureBridge {
+  baseUrl
+  /**
+   * Instantiate a client for interacting with the Capture Bridge service.
+   * @constructor
+   * @param {string} [baseURL] - Protocol, domain, and port for the service.
+   * @example
+   * const captureBridge = new CaptureBridge()
+   */
+  constructor (baseUrl = BASE_URL) {
+    this.baseUrl = baseUrl
+  }
+
+  /**
+   * Get service version info
+   * @method
+   * @async
+   * @returns {object} Service version info.
+   * @see {@link https://local.capturebridge.net:9001/doc/#api-Service-GetVersion|API Endpoint (/version)}
+   * @example
+   * const captureBridge = new CaptureBridge()
+   * const {version} = await captureBridge.version()
+   * console.log(version)
+   */
+  async version () {
+    const response = await fetch(`${this.baseUrl}/version`)
+    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
+   * @async
+   * @see {@link https://local.capturebridge.net:9001/doc/#api-Service-GetStatus|API Endpoint (/status)}
+   * @returns {object} Service status information.
+   * @example
+   * const captureBridge = new CaptureBridge()
+   * const statusInfo = await captureBridge.status()
+   * console.log(statusInfo)
+   */
+  async status () {
+    const response = await fetch(`${this.baseUrl}/status`)
+    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
+   * @async
+   * @see {@link https://local.capturebridge.net:9001/doc/#api-Plugin-GetPlugins|API Endpoint (/plugin)}
+   * @see {@link Plugin}
+   * @returns {object[]} Array of {@link Plugin} objects.
+   * @example
+   * const plugins = await captureBridge.plugins()
+   */
+  async plugins () {
+    const response = await fetch(`${this.baseUrl}/plugin`)
+    const plugins = await response.json()
+    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
+   * @async
+   * @see {@link https://local.capturebridge.net:9001/doc/#api-Plugin-GetPlugins|API Endpoint (/plugin)}
+   * @see {@link Plugin}
+   * @param {string} id - Plugin ID
+   * @returns {object?} {@link Plugin} object or null
+   * @example
+   * const plugin = await captureBridge.plugin('capture_camera_canon')
+   */
+  async plugin (id) {
+    const response = await fetch(`${this.baseUrl}/plugin/${id}`)
+    await checkResponse(response)
+    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