@capturebridge/sdk 0.12.1 → 0.14.2

package/Scanner.js

@@ -1,55 +1,55 @@
-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
+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,108 +1,86 @@
-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
+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 {
+  constructor (plugin, baseUrl = BASE_URL) {
+    super(plugin, baseUrl)
+  }
+
+  /**
+   * @description Clear a signature tablet's display.
+   *
+   * @param {boolean} [backlight=false] If `true`, the device's backlight will be
+   * enabled. If `false`, it will be disabled. If unspecified no action will be
+   * taken on the backlight.
+   *
+   * @param {string|Device} [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}
+   */
+  async clear (backlight, deviceOpt) {
+    const device = await this.setupDevice(deviceOpt)
+    return device.clear(backlight)
+  }
+
+  /**
+   * Render an Array of Objects on the display and wait for user input.
+   *
+   * @description If any Objects are Buttons, the method will wait for one
+   * to be clicked and will then return results. The format of the Array of
+   * Objects, the response structure, and the scene options are plugin specific.
+   *
+   * @param {Object[]} objects An array of drawable objects to display.
+   * @param {Object} [sceneOpt] Options for configuring the scene.
+   *
+   * @async
+   * @method
+   * @returns {object?}
+   */
+  async displayObjects (objects, sceneOpt = {}, deviceOpt) {
+    const device = await this.setupDevice(deviceOpt)
+    return device.displayObjects(objects, sceneOpt)
+  }
+
+  /**
+   * 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

package/SignatureTabletWidgets.js

@@ -1,164 +1,164 @@
-/**
-* @module SignatureTabletWidgets
-*/
-
-import { blobToBase64 } from './Common.js'
-
-/**
- * DisplayWidget
- * @classdesc Represents a widget that can be displayed at some x and y coordinates
- * @see {@link TextButton}
- * @see {@link Text}
- * @see {@link Image}
- */
-export class DisplayWidget {
-  x
-  y
-  constructor (x, y) {
-    this.x = x
-    this.y = y
-  }
-}
-
-/**
- * TextButton
- * @classdesc A button for displaying clickable text on a tablet
- * @extends DisplayWidget
- * @see {@link SignatureTablet}
- */
-export class TextButton extends DisplayWidget {
-  text
-  fontFace
-  fontSize
-  id
-  /**
-   * Instantiate a Tablet Text Button
-   * @constructor
-   * @param {string} text - Text to display on the button
-   * @param {number} x - X position to draw the button
-   * @param {number} y - Y position to draw the button
-   * @param {text} [id] - ID of the button that will be returned when it is
-   * clicked. If not set one will attempt to be constructed from the button
-   * text but there is no guarantee it will be unique.
-   * @param {string} [fontFace] - Font face for the text on the button.
-   * Defaults to 'Arial'
-   * @param {number} [fontSize] - Size of the font for the text on the button.
-   * Defaults to 40.
-   * @example
-   * const new TextButton("OK", 20, 200)
-   */
-  constructor (text, x, y, id, fontFace = 'Arial', fontSize = 40) {
-    super(x, y)
-    this.text = text
-    this.fontFace = fontFace
-    this.fontSize = fontSize
-    if (id) {
-      this.id = id
-    } else {
-      this.id = text.length > 16 ? text.slice(0, 16) : text
-    }
-  }
-
-  toJSON () {
-    return {
-      type: 'button',
-      text: this.text,
-      font_face: this.fontFace,
-      font_size: this.fontSize,
-      x: this.x,
-      y: this.y,
-      id: this.id
-    }
-  }
-}
-
-/**
- * Text
- * @classdesc Text to be displayed on a tablet
- * @extends DisplayWidget
- * @see {@link SignatureTablet}
- */
-export class Text extends DisplayWidget {
-  text
-  fontFace
-  fontSize
-  /**
-   * Instantiate a Text object
-   * @constructor
-   * @param {string} text - Text to display on the button
-   * @param {number} x - X position to draw the button
-   * @param {number} y - Y position to draw the button
-   * @param {string} [fontFace] - Font face for the text on the button.
-   * Defaults to 'Arial'
-   * @param {number} [fontSize] - Size of the font for the text on the button.
-   * Defaults to 40.
-   * @example
-   * const new Text("Do you agree?", 20, 200)
-   */
-  constructor (text, x, y, fontFace = 'Arial', fontSize = 40) {
-    super(x, y)
-    this.text = text
-    this.fontFace = fontFace
-    this.fontSize = fontSize
-  }
-
-  toJSON () {
-    return {
-      type: 'text',
-      text: this.text,
-      font_face: this.fontFace,
-      font_size: this.fontSize,
-      x: this.x,
-      y: this.y
-    }
-  }
-}
-
-/**
- * Image
- * @classdesc Image to be displayed on a tablet
- * @extends DisplayWidget
- * @see {@link SignatureTablet}
- */
-export class Image extends DisplayWidget {
-  url
-  imageData
-  delay
-  /**
-   * Instantiate an Image object
-   * @constructor
-   * @param {string} url - URL of the image.
-   * @param {number} [x] - X position to draw the button
-   * @param {number} [y] - Y position to draw the button
-   * @param {number} [delay] - Milliseconds to sleep after displaying the image
-   * @example
-   * const new Image("/img/logo.tif", 20, 200)
-   */
-  constructor (url, x = 0, y = 0, delay = 0) {
-    super(x, y)
-    this.url = url
-    this.delay = delay
-  }
-
-  /**
-   * Fetch the image data and base64 encode it
-   * @async
-   * @example
-   * const new Image("/img/logo.tif", 20, 200)
-   */
-  async data () {
-    const response = await fetch(this.url)
-    const blob = await response.blob()
-    this.imageData = await blobToBase64(blob)
-  }
-
-  toJSON () {
-    return {
-      type: 'image',
-      data: this.imageData,
-      delay: this.delay,
-      x: this.x,
-      y: this.y
-    }
-  }
-}
+/**
+* @module SignatureTabletWidgets
+*/
+
+import { blobToBase64 } from './Common.js'
+
+/**
+ * DisplayWidget
+ * @classdesc Represents a widget that can be displayed at some x and y coordinates
+ * @see {@link TextButton}
+ * @see {@link Text}
+ * @see {@link Image}
+ */
+export class DisplayWidget {
+  x
+  y
+  constructor (x, y) {
+    this.x = x
+    this.y = y
+  }
+}
+
+/**
+ * TextButton
+ * @classdesc A button for displaying clickable text on a tablet
+ * @extends DisplayWidget
+ * @see {@link SignatureTablet}
+ */
+export class TextButton extends DisplayWidget {
+  text
+  fontFace
+  fontSize
+  id
+  /**
+   * Instantiate a Tablet Text Button
+   * @constructor
+   * @param {string} text - Text to display on the button
+   * @param {number} x - X position to draw the button
+   * @param {number} y - Y position to draw the button
+   * @param {text} [id] - ID of the button that will be returned when it is
+   * clicked. If not set one will attempt to be constructed from the button
+   * text but there is no guarantee it will be unique.
+   * @param {string} [fontFace] - Font face for the text on the button.
+   * Defaults to 'Arial'
+   * @param {number} [fontSize] - Size of the font for the text on the button.
+   * Defaults to 40.
+   * @example
+   * const new TextButton("OK", 20, 200)
+   */
+  constructor (text, x, y, id, fontFace = 'Arial', fontSize = 40) {
+    super(x, y)
+    this.text = text
+    this.fontFace = fontFace
+    this.fontSize = fontSize
+    if (id) {
+      this.id = id
+    } else {
+      this.id = text.length > 16 ? text.slice(0, 16) : text
+    }
+  }
+
+  toJSON () {
+    return {
+      type: 'button',
+      text: this.text,
+      font_face: this.fontFace,
+      font_size: this.fontSize,
+      x: this.x,
+      y: this.y,
+      id: this.id
+    }
+  }
+}
+
+/**
+ * Text
+ * @classdesc Text to be displayed on a tablet
+ * @extends DisplayWidget
+ * @see {@link SignatureTablet}
+ */
+export class Text extends DisplayWidget {
+  text
+  fontFace
+  fontSize
+  /**
+   * Instantiate a Text object
+   * @constructor
+   * @param {string} text - Text to display on the button
+   * @param {number} x - X position to draw the button
+   * @param {number} y - Y position to draw the button
+   * @param {string} [fontFace] - Font face for the text on the button.
+   * Defaults to 'Arial'
+   * @param {number} [fontSize] - Size of the font for the text on the button.
+   * Defaults to 40.
+   * @example
+   * const new Text("Do you agree?", 20, 200)
+   */
+  constructor (text, x, y, fontFace = 'Arial', fontSize = 40) {
+    super(x, y)
+    this.text = text
+    this.fontFace = fontFace
+    this.fontSize = fontSize
+  }
+
+  toJSON () {
+    return {
+      type: 'text',
+      text: this.text,
+      font_face: this.fontFace,
+      font_size: this.fontSize,
+      x: this.x,
+      y: this.y
+    }
+  }
+}
+
+/**
+ * Image
+ * @classdesc Image to be displayed on a tablet
+ * @extends DisplayWidget
+ * @see {@link SignatureTablet}
+ */
+export class Image extends DisplayWidget {
+  url
+  imageData
+  delay
+  /**
+   * Instantiate an Image object
+   * @constructor
+   * @param {string} url - URL of the image.
+   * @param {number} [x] - X position to draw the button
+   * @param {number} [y] - Y position to draw the button
+   * @param {number} [delay] - Milliseconds to sleep after displaying the image
+   * @example
+   * const new Image("/img/logo.tif", 20, 200)
+   */
+  constructor (url, x = 0, y = 0, delay = 0) {
+    super(x, y)
+    this.url = url
+    this.delay = delay
+  }
+
+  /**
+   * Fetch the image data and base64 encode it
+   * @async
+   * @example
+   * const new Image("/img/logo.tif", 20, 200)
+   */
+  async data () {
+    const response = await fetch(this.url)
+    const blob = await response.blob()
+    this.imageData = await blobToBase64(blob)
+  }
+
+  toJSON () {
+    return {
+      type: 'image',
+      data: this.imageData,
+      delay: this.delay,
+      x: this.x,
+      y: this.y
+    }
+  }
+}