@capturebridge/sdk 0.7.0 → 0.8.0

package/Scanner.js

@@ -1,64 +1,55 @@
-import CapturePlugin from './CapturePlugin.js'
-import { BASE_URL } from './Common.js'
-
-/**
- * Scanner
- * @classdesc Class for invoking methods on a Scanner
- *
- * @see {@link CanonScanner}
- */
-class Scanner extends CapturePlugin {
-  /**
-   * Instantiate a Generic Scanner
-   * @constructor
-   * @param {string} [baseURL] - Protocol, domain, and port for the service.
-   * @param {string} pluginId - The Id of the desired plugin to use for this
-   * scanner instance. The plugin must support the "devices", and "capture"
-   * methods.
-   * @example
-   * const scanner = new Scanner('capture_scanner_windows')
-   */
-  constructor (plugin, baseUrl = BASE_URL) {
-    super(plugin, baseUrl)
-  }
-
-  /**
-   * Scan a document
-   * @param {string} [kind] - Specify how to return the scanned document. Valid
-   * values are 'blob', 'buffer', 'base64', or 'dataurl'.
-   *
-   * The default value of 'buffer' will load the image into an
-   * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer|ArrayBuffer}
-   * that can be set directly on an img tag's src attribute.
-   *
-   * The value of 'blob' will 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}.
-   *
-   * The value of 'base64' will return the image contents as a
-   * {@link https://en.wikipedia.org/wiki/Base64|Base64} encoded string that is
-   * suitable for use with JSON serialization.
-   *
-   * The value of 'dataurl' will return a JPEG
-   * {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs|Data URL}
-   * that can be set on an img tag's src attribute or loaded as a document
-   * location.
-   *
-   * @param {string|object} [deviceOpt] - Can a document using either a specific
-   * Device ID or a Device Object. The default is the first available device.
-   *
-   * @async
-   * @example
-   * // Scan document as an ArrayBuffer and add it to an img tag appended to
-   * // the document's body.
-   * const img = document.createElement('img')
-   * img.src = await scanner.scan()
-   * document.body.appendChild(img)
-   */
-  async scan (kind = 'buffer', deviceOpt) {
-    return await this.fullCapture(kind, deviceOpt)
-  }
-}
-
-export default Scanner
+import CapturePlugin from './CapturePlugin.js'
+import { BASE_URL, DEFAULT_CAPTURE_OPT, DEPRECATION_01 } from './Common.js'
+
+/**
+ * Scanner
+ * @classdesc Class for invoking methods on a Scanner
+ *
+ * @see {@link CanonScanner}
+ */
+class Scanner extends CapturePlugin {
+  /**
+   * Instantiate a Generic Scanner
+   * @constructor
+   * @param {string} [baseURL] - Protocol, domain, and port for the service.
+   * @param {string} pluginId - The Id of the desired plugin to use for this
+   * scanner instance. The plugin must support the "devices", and "capture"
+   * methods.
+   * @example
+   * const scanner = new Scanner('capture_scanner_windows')
+   */
+  constructor (plugin, baseUrl = BASE_URL) {
+    super(plugin, baseUrl)
+  }
+
+  /**
+   * Scan a document
+   *
+   * @param {CaptureOptions} [captureOpt] - Additional options for capturing a
+   * signature.
+   *
+   * @param {string|object} [deviceOpt] - Can a document using either a specific
+   * Device ID or a Device Object. The default is the first available device.
+   *
+   * @async
+   * @example
+   * // Scan document as an ArrayBuffer and add it to an img tag appended to
+   * // the document's body.
+   * const img = document.createElement('img')
+   * img.src = await scanner.scan()
+   * document.body.appendChild(img)
+   */
+  async scan (captureOpt = {}, deviceOpt) {
+    if (typeof captureOpt === 'string' && DEPRECATION_01) {
+      captureOpt = { kind: captureOpt }
+      console.warn('CaptureBridge SDK Deprecation Warning: `Scanner.scan()` ' +
+        '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)
+  }
+}
+
+export default Scanner

package/SignatureTablet.js

@@ -1,109 +1,108 @@
-import StreamingCapturePlugin from './StreamingCapturePlugin.js'
-import { BASE_URL } from './Common.js'
-
-class SignatureTablet extends StreamingCapturePlugin {
-  #captureBridge
-  #scene = {}
-
-  constructor (plugin, baseUrl = BASE_URL) {
-    super(plugin, baseUrl)
-  }
-
-  /**
-   * Clear the tablet's display.
-   *
-   * @description This method will set the tablet's LCD screen to an empty white
-   * background. The blacklight will also be enabled if it is not already.
-   *
-   * @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.
-   *
-   * @param {string|object} [deviceOpt] - Clear the display of a either a
-   * specific Device ID or a Device Object. The default is the first available
-   * device.
-   *
-   * @async
-   * @method
-   * @returns {object}
-   * @example
-   * const img = document.createElement('img')
-   * img.src = await camera.streamUrl()
-   * document.body.appendChild(img)
-   */
-  async clear (backlight, deviceOpt) {
-    const device = await this.setupDevice(deviceOpt)
-    return device.clear(backlight)
-  }
-
-  /**
-   * Display an Array of objects on the display.
-   *
-   * @description If any objects are Button types, the method will wait for one
-   * to be clicked and will then return the ID of the clicked object.
-   *
-   * @param {object[]} objects An array of Signature Tablet Widgets to display.
-   *
-   * @param {boolean} [clear] If true (the default), the display will be cleared
-   * before adding the objects.
-   *
-   * @param {string|object} [deviceOpt] - Display the objects on either a
-   * specific Device ID or a Device Object. The default is the first available
-   * device.
-   *
-   * @async
-   * @method
-   * @returns {string?} ID of the clicked object if any
-   * @example
-   * const result = await tablet.displayObjects([
-   *  new Button("OK", 20, 200),
-   *  new Button("Cancel", 80, 200)
-   * ])
-   *
-   * console.log(`${result} was clicked`)
-   */
-  async displayObjects (objects, clear = true, deviceOpt) {
-    const device = await this.setupDevice(deviceOpt)
-    return device.displayObjects(objects, clear)
-  }
-
-  /**
-   * Capture a high resolution signature
-   * @param {string} [kind] - Specify how to return the captured photo. Valid
-   * values are 'blob', 'buffer', 'base64', or 'dataurl'.
-   *
-   * The default value of 'buffer' will load the image into an
-   * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer|ArrayBuffer}
-   * that can be set directly on an img tag's src attribute.
-   *
-   * The value of 'blob' will 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}.
-   *
-   * The value of 'base64' will return the image contents as a
-   * {@link https://en.wikipedia.org/wiki/Base64|Base64} encoded string that is
-   * suitable for use with JSON serialization.
-   *
-   * The value of 'dataurl' will return a JPEG
-   * {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs|Data URL}
-   * that can be set on an img tag's src attribute or loaded as a document
-   * location.
-   *
-   * @param {string|object} [deviceOpt] - Capture the signature using either a
-   * specific Device ID or a Device Object. The default is the first available device.
-   *
-   * @async
-   * @example
-   * // Capture signature as an ArrayBuffer and add it to an img tag appended to
-   * // the document's body.
-   * const img = document.createElement('img')
-   * img.src = await tablet.signature()
-   * document.body.appendChild(img)
-   */
-  async signature (kind = 'buffer', deviceOpt) {
-    return await this.fullCapture(kind, deviceOpt)
-  }
-}
-
-export default SignatureTablet
+import StreamingCapturePlugin from './StreamingCapturePlugin.js'
+import { BASE_URL, DEFAULT_CAPTURE_OPT, DEPRECATION_01 } from './Common.js'
+
+/**
+ * SignatureTablet
+ * @classdesc  Class for invoking methods on a Signature Capture Tablet
+ * @extends StreamingCapturePlugin
+ * @see {@link TopazSigGem}
+ */
+class SignatureTablet extends StreamingCapturePlugin {
+  #captureBridge
+  #scene = {}
+
+  constructor (plugin, baseUrl = BASE_URL) {
+    super(plugin, baseUrl)
+  }
+
+  /**
+   * Clear the tablet's display.
+   *
+   * @description This method will set the tablet's LCD screen to an empty white
+   * background. The blacklight will also be enabled if it is not already.
+   *
+   * @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.
+   *
+   * @param {string|object} [deviceOpt] - Clear the display of a either a
+   * specific Device ID or a Device Object. The default is the first available
+   * device.
+   *
+   * @async
+   * @method
+   * @returns {object}
+   * @example
+   * const img = document.createElement('img')
+   * img.src = await camera.streamUrl()
+   * document.body.appendChild(img)
+   */
+  async clear (backlight, deviceOpt) {
+    const device = await this.setupDevice(deviceOpt)
+    return device.clear(backlight)
+  }
+
+  /**
+   * Display an Array of objects on the display.
+   *
+   * @description If any objects are Button types, the method will wait for one
+   * to be clicked and will then return the ID of the clicked object.
+   *
+   * @param {object[]} objects An array of Signature Tablet Widgets to display.
+   *
+   * @param {boolean} [clear] If true (the default), the display will be cleared
+   * before adding the objects.
+   *
+   * @param {string|object} [deviceOpt] - Display the objects on either a
+   * specific Device ID or a Device Object. The default is the first available
+   * device.
+   *
+   * @async
+   * @method
+   * @returns {string?} ID of the clicked object if any
+   * @example
+   * const result = await tablet.displayObjects([
+   *  new Button("OK", 20, 200),
+   *  new Button("Cancel", 80, 200)
+   * ])
+   *
+   * console.log(`${result} was clicked`)
+   */
+  async displayObjects (objects, clear = true, deviceOpt) {
+    const device = await this.setupDevice(deviceOpt)
+    return device.displayObjects(objects, clear)
+  }
+
+  /**
+   * Capture a high resolution signature
+   *
+   * @param {CaptureOptions} [captureOpt] - Additional options for capturing a
+   * signature.
+   *
+   * @param {string|object} [deviceOpt] - Capture the signature using either a
+   * specific Device ID or a Device Object. The default is the first available
+   * device.
+   *
+   * @async
+   * @example
+   * // Capture signature as an ArrayBuffer and add it to an img tag appended to
+   * // the document's body.
+   * const img = document.createElement('img')
+   * img.src = await tablet.signature()
+   * document.body.appendChild(img)
+   */
+  async signature (captureOpt = {}, deviceOpt) {
+    if (typeof captureOpt === 'string' && DEPRECATION_01) {
+      captureOpt = { kind: captureOpt }
+      console.warn('CaptureBridge SDK Deprecation Warning: ' +
+        '`SignatureTablet.signature()` 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)
+  }
+}
+
+export default SignatureTablet