@capturebridge/sdk 0.7.0

package/Scanner.js

@@ -0,0 +1,64 @@
+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

package/SignatureTablet.js

@@ -0,0 +1,109 @@
+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

package/SignatureTabletWidgets.js

@@ -0,0 +1,153 @@
+import { blobToBase64 } from './Common.js'
+
+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
+ *
+ * @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
+ *
+ * @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
+ *
+ * @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
+    }
+  }
+}

package/StreamingCapturePlugin.js

@@ -0,0 +1,121 @@
+import CapturePlugin from './CapturePlugin.js'
+import { BASE_URL, DATAURL_JPEG, blobToBuffer } from './Common.js'
+
+class StreamingCapturePlugin extends CapturePlugin {
+  constructor (plugin, baseUrl = BASE_URL) {
+    super(plugin, baseUrl)
+  }
+
+  /**
+   * Get the CapturePlugin's stream endpoint URL.
+   *
+   * @description The URL returned from this endpoint can be attached to an
+   * img tag's src attribute. The camera's live stream will be started and
+   * begin streaming to the img tag as a
+   * {@link https://en.wikipedia.org/wiki/Motion_JPEG|Motion JPEG} stream.
+   * If the src is changed, the img removed from the DOM, or client disconnected
+   * for any reason, the live feed will automatically be stopped.
+   *
+   * @param {string|object} [deviceOpt] - Get the stream URL from either a
+   * specific Device ID or a Device Object. The default is the first available
+   * device.
+   *
+   * @async
+   * @method
+   * @returns {string} stream endpoint URL
+   * @example
+   * const img = document.createElement('img')
+   * img.src = await camera.streamUrl()
+   * document.body.appendChild(img)
+   */
+  async streamUrl (deviceOpt) {
+    const device = await this.setupDevice(deviceOpt)
+    return device.streamUrl()
+  }
+
+  /**
+   * Get the most recent frame from a device's live feed.
+   *
+   * @description This method will startup the device's 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.
+   *
+   * If implementing a real-time preview, it is highly recommended to use the
+   * stream endpoint which will stream a Motion JPEG.
+   *
+   * @see {@link CapturePlugin#streamUrl}
+   * @see {@link CapturePlugin#stopFeed}
+   *
+   * @param {string} [kind=buffer] - Specify how to return the captured image. 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] - Return the frame from either a
+   * specific Device ID or a Device Object. The default, if not supplied, is the
+   * first available device.
+   *
+   * @async
+   * @method
+   * @example
+   * // Get the most recent frame from the camera's live feed as an ArrayBuffer
+   * // and add it to an img tag appended to the document's body.
+   * const img = document.createElement('img')
+   * img.src = await camera.getMostRecentFrame()
+   * document.body.appendChild(img)
+   *
+   * // Stop the live feed when done getting frames
+   * await camera.stopFeed()
+   */
+  async getMostRecentFrame (kind = 'buffer', deviceOpt) {
+    const device = await this.setupDevice(deviceOpt)
+    switch (kind) {
+      case 'blob':
+        return await device.frameAsBlob()
+      case 'buffer':
+        return await blobToBuffer(await device.frameAsBlob())
+      case 'base64':
+        return await device.frameAsBase64()
+      case 'dataurl':
+        return DATAURL_JPEG + (await device.frameAsBase64())
+    }
+    throw new Error(`Unknown image response type: ${kind}`)
+  }
+
+  /**
+   * Stop the camera's live feed if it is running.
+   *
+   * @method
+   * @async
+   * @returns {object} Status of the stop operation
+   * @example
+   * // CapturePlugin is now running it's live feed in a background thread
+   * const frame = await camera.getMostRecentFrame()
+   * // Do some stuff with frame...
+   * // Stop the live feed
+   * console.log(await camera.stopFeed())
+   */
+  async stopFeed (deviceOpt) {
+    const device = await this.setupDevice(deviceOpt)
+    return await device.stopFeed()
+  }
+}
+
+export default StreamingCapturePlugin

package/TopazSigGem.js

@@ -0,0 +1,25 @@
+import SignatureTablet from './SignatureTablet.js'
+import { BASE_URL } from './Common.js'
+
+/**
+ * TopazSigGem
+ * @classdesc Convience class for instantiating a Topaz SigGem Signature Tablet
+ * Inherits all methods on the {@link SignatureTablet} class.
+ *
+ * @see {@link SignatureTablet}
+ */
+class TopazSigGem extends SignatureTablet {
+  /**
+   * Instantiate a Topaz SigGem Signature Tablet
+   * @constructor
+   * @param {string} [baseURL] - Protocol, domain, and port for the service.
+   * @example
+   * const camera = new TopazSigGem()
+   *
+   */
+  constructor (baseUrl = BASE_URL) {
+    super('capture_signature_topaz', baseUrl)
+  }
+}
+
+export default TopazSigGem

package/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "@capturebridge/sdk",
+  "description": "Capture Bridge JavaScript SDK for web applications",
+  "type": "module",
+  "license": "Apache-2.0",
+  "version": "0.7.0"
+}