@capturebridge/sdk 0.7.1 → 0.9.0

package/StreamingCapturePlugin.js

@@ -1,6 +1,17 @@
 import CapturePlugin from './CapturePlugin.js'
-import { BASE_URL, DATAURL_JPEG, blobToBuffer } from './Common.js'
+import {
+  BASE_URL,
+  DATAURL_JPEG,
+  blobToBuffer,
+  DEFAULT_CAPTURE_OPT,
+  DEPRECATION_01
+} from './Common.js'
 
+/**
+ * StreamingCapturePlugin
+ * @extends CapturePlugin
+ * @classdesc Class for invoking streaming-related methods
+ */
 class StreamingCapturePlugin extends CapturePlugin {
   constructor (plugin, baseUrl = BASE_URL) {
     super(plugin, baseUrl)
@@ -28,9 +39,9 @@ class StreamingCapturePlugin extends CapturePlugin {
    * img.src = await camera.streamUrl()
    * document.body.appendChild(img)
    */
-  async streamUrl (deviceOpt) {
+  async streamUrl (streamOpt = {}, deviceOpt) {
     const device = await this.setupDevice(deviceOpt)
-    return device.streamUrl()
+    return device.streamUrl(streamOpt)
   }
 
   /**
@@ -47,26 +58,8 @@ class StreamingCapturePlugin extends CapturePlugin {
    * @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 {CaptureOptions} [captureOpt] - Additional options for capturing a
+   * photo.
    *
    * @param {string|object} [deviceOpt] - Return the frame from either a
    * specific Device ID or a Device Object. The default, if not supplied, is the
@@ -84,24 +77,39 @@ class StreamingCapturePlugin extends CapturePlugin {
    * // Stop the live feed when done getting frames
    * await camera.stopFeed()
    */
-  async getMostRecentFrame (kind = 'buffer', deviceOpt) {
-    const device = await this.setupDevice(deviceOpt)
-    switch (kind) {
+  async getMostRecentFrame (captureOpt = {}, deviceOpt) {
+    if (typeof captureOpt === 'string' && DEPRECATION_01) {
+      captureOpt = { kind: captureOpt }
+      console.warn('CaptureBridge SDK Deprecation Warning: ' +
+        '`StreamingCapturePlugin.getMostRecentFrame()` 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)
+    const device = await this.setupDevice(mergedOpt)
+    switch (mergedOpt.kind) {
+      case 'objecturl':
+        return URL.createObjectURL(await device.frameAsBlob(mergedOpt))
       case 'blob':
-        return await device.frameAsBlob()
+        return await device.frameAsBlob(mergedOpt)
       case 'buffer':
-        return await blobToBuffer(await device.frameAsBlob())
+        return await blobToBuffer(await device.frameAsBlob(mergedOpt))
       case 'base64':
-        return await device.frameAsBase64()
+        return await device.frameAsBase64(mergedOpt)
       case 'dataurl':
-        return DATAURL_JPEG + (await device.frameAsBase64())
+        return DATAURL_JPEG + (await device.frameAsBase64(mergedOpt))
     }
-    throw new Error(`Unknown image response type: ${kind}`)
+    throw new Error(`Unknown image response kind: ${mergedOpt.kind}`)
   }
 
   /**
    * Stop the camera's live feed if it is running.
    *
+   * @param {string|object} [deviceOpt] - Stop the feed for a specific Device ID
+   * or a Device Object. The default, if not supplied, is the first available
+   * device.
+   *
    * @method
    * @async
    * @returns {object} Status of the stop operation

package/TopazSigGem.js

@@ -5,7 +5,7 @@ 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.
- *
+ * @extends SignatureTablet
  * @see {@link SignatureTablet}
  */
 class TopazSigGem extends SignatureTablet {

package/Verifone.js

@@ -0,0 +1,68 @@
+import SignatureTablet from './SignatureTablet.js'
+import { BASE_URL } from './Common.js'
+
+/**
+ * Verifone
+ * @classdesc Captures a signature on Verifone device.
+ * @extends SignatureTablet
+ * @see {@link SignatureTablet}
+ */
+class Verifone extends SignatureTablet {
+  /**
+   * Instantiate a Verifone Class
+   * @constructor
+   * @param {string} [baseURL] - Protocol, domain, and port for the service.
+   * @example
+   * const tablet = new Verifone()
+   *
+   */
+  constructor (baseUrl = BASE_URL) {
+    super('capture_signature_verifone', baseUrl)
+  }
+
+  /**
+   * Not currently supported for this plugin.
+   * @throws Not implemented error
+   * @example
+   * // Not currently supported for this plugin
+   * @override
+   */
+  async streamUrl () {
+    throw new Error('streamUrl() is not implemented for the Verifone Plugin')
+  }
+
+  /**
+   * Not currently supported for this plugin.
+   * @throws Not implemented error
+   * @example
+   * // Not currently supported for this plugin
+   * @override
+   */
+  async getMostRecentFrame () {
+    throw new Error('getMostRecentFrame() is not implemented for the Verifone Plugin')
+  }
+
+  /**
+   * Not currently supported for this plugin.
+   * @throws Not implemented error
+   * @example
+   * // Not currently supported for this plugin
+   * @override
+   */
+  async stopFeed () {
+    throw new Error('stopFeed() is not implemented for the Verifone Plugin')
+  }
+
+  /**
+   * Not currently supported for this plugin.
+   * @throws Not implemented error
+   * @example
+   * // Not currently supported for this plugin
+   * @override
+   */
+  async displayObjects () {
+    throw new Error('displayObjects() is not implemented for the Verifone Plugin')
+  }
+}
+
+export default Verifone

package/Version.js

@@ -0,0 +1,8 @@
+/**
+ * @summary SDK Version as published on
+ * {@link https://www.npmjs.com/package/@capturebridge/sdk|NPM}
+ * @constant
+ * @type {string}
+ */
+const VERSION = '0.9.0'
+export default VERSION

package/WindowsScanner.js

@@ -0,0 +1,25 @@
+import Scanner from './Scanner.js'
+import { BASE_URL } from './Common.js'
+
+/**
+ * WindowsScanner
+ * @classdesc Convenience class for instantiating a WIA compatible Scanner.
+ * Inherits all methods on the {@link Scanner} class.
+ * @extends Scanner
+ * @see {@link Scanner}
+ */
+class WindowsScanner extends Scanner {
+  /**
+   * Instantiate a WIA compatible scanner
+   * @constructor
+   * @param {string} [baseURL] - Protocol, domain, and port for the service.
+   * @example
+   * const scanner = new WindowsScanner()
+   * const doc = await camera.scan()
+   */
+  constructor (baseUrl = BASE_URL) {
+    super('capture_scanner_windows', baseUrl)
+  }
+}
+
+export default WindowsScanner

package/examples/canon.html

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+<head><title>Canon Camera Example</title></head>
+<body>
+<img id="img"/>
+<div>
+  <div>
+    <label>Rotate</label>
+    <input type="number" value="0" id="rotate" min="-360" max="360" step="90"/>
+  </div>
+  <button type="button" id="capture" title="Capture Image">
+    Capture
+  </button>
+  <button type="button" id="stream" title="Stream Live Feed">
+    Stream
+  </button>
+</div>
+<script type="module">
+import CanonCamera from '/sdk/js/CanonCamera.js'
+(async () => {
+  const defaultSrc = '/demo/img/empty.jpg'
+  const defaultWidth = 400
+  const img = document.getElementById('img')
+  const capture = document.getElementById('capture')
+  const stream = document.getElementById('stream')
+  const rotation = document.getElementById('rotate')
+
+  img.src = defaultSrc
+  img.width = defaultWidth
+
+  try {
+    const camera = new CanonCamera()
+    const devices = await camera.devices();
+
+    if (!devices.length) {
+      return alert('No Canon Camera devices found')
+    }
+
+    // Start the first device's live feed and stream it to the img tag
+    stream.addEventListener('click', async () => {
+      const rotate = parseInt(rotation.value)
+      rotation.disabled = true
+      stream.disabled = true
+      img.src = await camera.streamUrl({rotate})
+    })
+
+    // Take a full capture and add the image to the page
+    capture.addEventListener('click', async () => {
+      const rotate = parseInt(rotation.value)
+      const capture = document.createElement('img')
+      img.src = defaultSrc
+      capture.src = await camera.takePhoto({rotate})
+      capture.width = defaultWidth
+      document.body.appendChild(capture)
+      rotation.disabled = false
+      stream.disabled = false
+    })
+
+  } catch (e) {
+    console.error(e)
+    alert(`Error: ${e.message}`)
+  }
+})()
+</script>
+</body>
+</html>

package/examples/canon_getframe.html

@@ -0,0 +1,68 @@
+<!DOCTYPE html>
+<html>
+<head><title>Canon Camera Frame Example</title></head>
+<body>
+<div>
+  <img id="img"/>
+  <div>
+    <label>Rotate</label>
+    <input type="number" value="0" id="rotate" min="-360" max="360" step="90"/>
+  </div>
+  <button type="button" id="frame" title="Grab Frame from live feed">
+    Get Frame
+  </button>
+  <button type="button" id="stop" title="Stop live feed">
+    Stop Feed
+  </button>
+</div>
+<script type="module">
+import CanonCamera from '/sdk/js/CanonCamera.js'
+(async () => {
+  const defaultSrc = '/demo/img/empty.jpg'
+  const img = document.getElementById('img')
+  const rotation = document.getElementById('rotate')
+  const frame = document.getElementById('frame')
+  const stop = document.getElementById('stop')
+
+  img.src = defaultSrc
+  img.width = 400
+
+  try {
+    const camera = new CanonCamera()
+    const devices = await camera.devices()
+
+    if (!devices.length) {
+      return alert('No Canon Camera devices found')
+    }
+
+    // Acquiring the first frame will take a few seconds while the camera
+    // starts up and begins streaming, subsequent frames will be returned
+    // instantaneously
+    let lastFrame;
+    frame.addEventListener('click', async () => {
+      stop.disabled = true
+      rotation.disabled = true
+      const rotate = parseInt(rotation.value)
+      // Cleanup the last frame captured, if any
+      if (lastFrame) {
+        URL.revokeObjectURL(lastFrame)
+      }
+      img.src = lastFrame = await camera.getMostRecentFrame({rotate})
+      rotation.disabled = false
+      stop.disabled = false
+    })
+
+    // Stop live feed
+    stop.addEventListener('click', async () => {
+      const result = await camera.stopFeed()
+      alert(result.message || result.status)
+    })
+
+  } catch (e) {
+    console.error(e)
+    alert(`Error: ${e.message}`)
+  }
+})()
+</script>
+</body>
+</html>

package/examples/canon_lan.html

@@ -0,0 +1,68 @@
+<!DOCTYPE html>
+<html>
+<head><title>Canon Camera LAN Example</title></head>
+<body>
+<img id="img"/>
+<div>
+  <div>
+    <label>Rotate</label>
+    <input type="number" value="0" id="rotate" min="-360" max="360" step="90"/>
+  </div>
+  <button type="button" id="capture" title="Capture Image">
+    Capture
+  </button>
+  <button type="button" id="stream" title="Stream Live Feed">
+    Stream
+  </button>
+</div>
+<script type="module">
+import CanonCamera from '/sdk/js/CanonCamera.js'
+(async () => {
+  const defaultSrc = '/demo/img/empty.jpg'
+  const defaultWidth = 400
+  const img = document.getElementById('img')
+  const capture = document.getElementById('capture')
+  const stream = document.getElementById('stream')
+  const rotation = document.getElementById('rotate')
+
+  img.src = defaultSrc
+  img.width = defaultWidth
+
+  try {
+    const defaultURL = 'https://windev2-local.capturebridge.net:9001'
+    const url = prompt('Enter remote Base URL', defaultURL)
+    const camera = new CanonCamera(url)
+    const devices = await camera.devices();
+
+    if (!devices.length) {
+      return alert('No Canon Camera devices found')
+    }
+
+    // Start the first device's live feed and stream it to the img tag
+    stream.addEventListener('click', async () => {
+      const rotate = parseInt(rotation.value)
+      rotation.disabled = true
+      stream.disabled = true
+      img.src = await camera.streamUrl({rotate})
+    })
+
+    // Take a full capture and add the image to the page
+    capture.addEventListener('click', async () => {
+      const rotate = parseInt(rotation.value)
+      const capture = document.createElement('img')
+      img.src = defaultSrc
+      capture.src = await camera.takePhoto({rotate})
+      capture.width = defaultWidth
+      document.body.appendChild(capture)
+      rotation.disabled = false
+      stream.disabled = false
+    })
+
+  } catch (e) {
+    console.error(e)
+    alert(`Error: ${e.message}`)
+  }
+})()
+</script>
+</body>
+</html>

package/examples/canon_minimal.html

@@ -0,0 +1,37 @@
+<!DOCTYPE html>
+<html>
+<head><title>Canon Camera Minimal Example</title></head>
+<body>
+<script type="module">
+import CanonCamera from '/sdk/js/CanonCamera.js'
+(async () => {
+  try {
+
+    // Instantiate a Canon Camera
+    const camera = new CanonCamera()
+
+    const devices = await camera.devices();
+
+    if (!devices.length) {
+      return alert('No Canon Camera devices found')
+    }
+
+    // Start the device's live feed and stream it to an img tag
+    const img = document.createElement('img')
+    img.src = await camera.streamUrl()
+    img.height = 400
+    document.body.appendChild(img)
+
+    // Demo live feed for a few seconds, take a picture, and update the img tag
+    setTimeout(async () => {
+      img.src = await camera.takePhoto()
+    }, 9000)
+
+  } catch (e) {
+    console.error(e)
+    alert(`Error: ${e.message}`)
+  }
+})()
+</script>
+</body>
+</html>

package/examples/mockcamera.html

@@ -0,0 +1,61 @@
+<!DOCTYPE html>
+<html>
+<head><title>Mock Camera Example</title></head>
+<body>
+<img id="img" src="/demo/img/empty.jpg"/>
+<div>
+  <div>
+    <label>Rotate</label>
+    <input type="number" value="0" id="rotate" min="-360" max="360" step="90"/>
+  </div>
+  <button type="button" id="capture" title="Capture Image">
+    Capture
+  </button>
+  <button type="button" id="stream" title="Stream Live Feed">
+    Stream
+  </button>
+</div>
+<script type="module">
+import MockCamera from '/sdk/js/MockCamera.js'
+(async () => {
+  const defaultSrc = '/demo/img/empty.jpg'
+  const defaultWidth = 400
+  const img = document.getElementById('img')
+  const capture = document.getElementById('capture')
+  const stream = document.getElementById('stream')
+  const rotation = document.getElementById('rotate')
+
+  img.src = defaultSrc
+  img.width = defaultWidth
+
+  try {
+    const camera = new MockCamera()
+
+    // Start the first device's live feed and stream it to the img tag
+    stream.addEventListener('click', async () => {
+      const rotate = parseInt(rotation.value)
+      rotation.disabled = true
+      stream.disabled = true
+      img.src = await camera.streamUrl({rotate})
+    })
+
+    // Take a full capture and add the image to the page
+    capture.addEventListener('click', async () => {
+      const rotate = parseInt(rotation.value)
+      const capture = document.createElement('img')
+      img.src = defaultSrc
+      capture.src = await camera.takePhoto({rotate})
+      capture.width = defaultWidth
+      document.body.appendChild(capture)
+      rotation.disabled = false
+      stream.disabled = false
+    })
+
+  } catch (e) {
+    console.error(e)
+    alert(`Error: ${e.message}`)
+  }
+})()
+</script>
+</body>
+</html>

package/examples/mockcamera_getframe.html

@@ -0,0 +1,63 @@
+<!DOCTYPE html>
+<html>
+<head><title>Mock Camera Frame Example</title></head>
+<body>
+<div>
+  <img id="img"/>
+  <div>
+    <label>Rotate</label>
+    <input type="number" value="0" id="rotate" min="-360" max="360" step="90"/>
+  </div>
+  <button type="button" id="frame" title="Grab Frame from live feed">
+    Get Frame
+  </button>
+  <button type="button" id="stop" title="Stop live feed">
+    Stop Feed
+  </button>
+</div>
+<script type="module">
+import MockCamera from '/sdk/js/MockCamera.js'
+(async () => {
+  const defaultSrc = '/demo/img/empty.jpg'
+  const img = document.getElementById('img')
+  const rotation = document.getElementById('rotate')
+  const frame = document.getElementById('frame')
+  const stop = document.getElementById('stop')
+
+  img.src = defaultSrc
+  img.width = 400
+
+  try {
+    const camera = new MockCamera()
+    const devices = await camera.devices()
+
+    // Grab a frame from the live feed
+    let lastFrame;
+    frame.addEventListener('click', async () => {
+      stop.disabled = true
+      rotation.disabled = true
+      const rotate = parseInt(rotation.value)
+      // Cleanup the last frame captured, if any
+      if (lastFrame) {
+        URL.revokeObjectURL(lastFrame)
+      }
+      img.src = lastFrame = await camera.getMostRecentFrame({rotate})
+      document.body.appendChild(frame)
+      rotation.disabled = false
+      stop.disabled = false
+    })
+
+    // Stop live feed
+    stop.addEventListener('click', async () => {
+      const result = await camera.stopFeed()
+      alert(result.message || result.status)
+    })
+
+  } catch (e) {
+    console.error(e)
+    alert(`Error: ${e.message}`)
+  }
+})()
+</script>
+</body>
+</html>

package/examples/mockcamera_minimal.html

@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html>
+<head><title>Mock Camera Minimal Example</title></head>
+<body>
+<script type="module">
+import MockCamera from '/sdk/js/MockCamera.js'
+(async () => {
+  try {
+
+    // Instantiate a Mock Camera
+    const camera = new MockCamera()
+
+    // Start the device's live feed and stream it to an img tag
+    const img = document.createElement('img')
+    img.src = await camera.streamUrl()
+    img.height = 400
+    document.body.appendChild(img)
+
+    // Demo live feed for a few seconds, take a picture, and update the img tag
+    setTimeout(async () => {
+      img.src = await camera.takePhoto()
+    }, 9000)
+
+  } catch (e) {
+    console.error(e)
+    alert(`Error: ${e.message}`)
+  }
+})()
+</script>
+</body>
+</html>

package/examples/verifone_minimal.html

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html>
+<head><title>Verifone Minimal Example</title></head>
+<body>
+<script type="module">
+import Verifone from '/sdk/js/Verifone.js'
+(async () => {
+  try {
+    const tablet = new Verifone()
+
+    const img = document.createElement('img')
+    img.src = await tablet.signature({format: 'jpg'})
+    await tablet.clear()
+    document.body.appendChild(img)
+
+  } catch (e) {
+    console.error(e)
+    alert(`Error: ${e.message}`)
+  }
+})()
+</script>
+</body>
+</html>

package/examples/windows_scanner_minimal.html

@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<html>
+<head><title>Windows Scanner Example</title></head>
+<body>
+<img id="img"/>
+<script type="module">
+import WindowsScanner from '/sdk/js/WindowsScanner.js'
+(async () => {
+  try {
+
+    const scanner = new WindowsScanner()
+
+    const devices = await scanner.devices();
+
+    if (!devices.length) {
+      return alert('No Scanner devices found')
+    }
+
+    let scan = await scanner.scan()
+
+    document.createElement('img')
+    img.src = await scanner.scan()
+    document.body.appendChild(img)
+
+  } catch (e) {
+    console.error(e)
+    alert(`Error: ${e.message}`)
+  }
+})()
+</script>
+</body>
+</html>

package/package.json

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