@capturebridge/sdk 0.12.1 → 0.14.2

package/Verifone.js

@@ -1,192 +1,239 @@
-import SignatureTablet from './SignatureTablet.js'
-import { BASE_URL, checkResponse } from './Common.js'
-
-/**
- * ControlProperty
- * @classdesc Form Control Properties
- * @see {@link Verifone#renderForm} Render a form and update control properties
- */
-export class ControlProperty {
-  id
-  name
-  value
-
-  /**
-   * Instantiate a Control Property
-   * @constructor
-   * @param {number} id - ID of the Control on the Form
-   * @param {string} name - Name of the property to update
-   * @param {number|string|boolean} value - property value
-   * @example
-   * // A property to make a control hidden
-   * const prop = new ControlProperty(1, "visible", false)
-   *
-   * // A property to change the text of a control
-   * const prop = new ControlProperty(1, "caption", "Cancel Operation")
-   *
-   * // A property to change the background color of a control
-   * const prop = new ControlProperty(1, "bg_color", "#EB9534")
-   */
-  constructor (id, name, value) {
-    this.id = id
-    this.name = name
-    this.value = value
-  }
-
-  toJSON () {
-    return {
-      id: this.id,
-      name: this.name,
-      value: this.value
-    }
-  }
-}
-
-/**
- * DeviceForm
- * @classdesc Form to be rendered on a tablet device.
- * @see {@link Verifone#renderForm} Render a form
- */
-export class DeviceForm {
-  id
-  waitForEvents
-  timeout
-
-  /**
-   * Instantiate a Form to be Rendered
-   * @constructor
-   * @param {string} id - ID of the Form
-   * @param {bool} [waitForEvents=false] - If `true` will wait for event data to
-   * be received on the form.
-   * @param {number} [timeout=15] - How long, in seconds, to wait for events from
-   * the form.
-   * @example
-   * // Form with no input data
-   * const form = new DeviceForm("FP_DISPLAY")
-   *
-   * // Form with buttons, wait 15 seconds for event data
-   * const form = new DeviceForm("FP_GEN_DISPLAY", true, 25)
-   */
-  constructor (id, waitForEvents = false, timeout = 15) {
-    this.id = id
-    this.waitForEvents = waitForEvents
-    this.timeout = timeout
-  }
-
-  toJSON () {
-    return {
-      id: this.id,
-      wait_for_events: this.waitForEvents,
-      timeout: this.timeout
-    }
-  }
-}
-
-/**
- * Verifone
- * @classdesc Captures a signature and renders forms on Verifone devices.
- * @extends SignatureTablet
- * @see {@link SignatureTablet}
- */
-export 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 supported for this plugin. Use {@link Verifone#renderForm} instead.
-   * @throws Not implemented error
-   * @example
-   * // Not currently supported for this plugin
-   * @override
-   * @see {@link Verifone#renderForm} Render a form
-   */
-  async displayObjects () {
-    throw new Error('displayObjects() is not implemented for the Verifone Plugin')
-  }
-
-  /**
-   * Render a form and get event data.
-   *
-   * @param {string|DeviceForm} form - ID of the form on the device or a DeviceForm
-   * object with addtional configuration details.
-   * @param {ControlProperty[]} [controlProps] - Array of {@link ControlProperty}
-   * objects.
-   * @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.
-   *
-   * @override
-   * @see {@link Verifone#renderForm} Render a form
-   */
-  async renderForm (form, controlProps, deviceOpt) {
-    if (typeof form === 'string') {
-      form = new DeviceForm(form)
-    }
-
-    const device = await this.setupDevice(deviceOpt)
-    device.can('render_form')
-
-    const body = JSON.stringify({
-      form: form.id,
-      wait_for_events: form.waitForEvents,
-      timeout: form.timeout,
-      control_properties: controlProps
-    })
-    const options = {
-      method: 'POST',
-      mode: 'cors',
-      headers: {
-        'Content-Type': 'application/json'
-      },
-      body
-    }
-    const url = `${this.baseUrl}/plugin/${this.id}/device/${device.id}/form/${form.id}/render`
-    const response = await fetch(url, options)
-    await checkResponse(response)
-    return await response.json()
-  }
-}
-
-export default Verifone
+import SignatureTablet from './SignatureTablet.js'
+import { BASE_URL, checkResponse } from './Common.js'
+
+/**
+ * ControlProperty
+ * @classdesc Form Control Properties
+ * @see {@link Verifone#renderForm} Render a form and update control properties
+ */
+export class ControlProperty {
+  id
+  name
+  value
+
+  /**
+   * Instantiate a Control Property
+   * @constructor
+   * @param {number} id - ID of the Control on the Form
+   * @param {string} name - Name of the property to update
+   * @param {number|string|boolean} value - property value
+   * @example
+   * // A property to make a control hidden
+   * const prop = new ControlProperty(1, "visible", false)
+   *
+   * // A property to change the text of a control
+   * const prop = new ControlProperty(1, "caption", "Cancel Operation")
+   *
+   * // A property to change the background color of a control
+   * const prop = new ControlProperty(1, "bg_color", "#EB9534")
+   */
+  constructor (id, name, value) {
+    this.id = id
+    this.name = name
+    this.value = value
+  }
+
+  toJSON () {
+    return {
+      id: this.id,
+      name: this.name,
+      value: this.value
+    }
+  }
+}
+
+/**
+ * DeviceForm
+ * @classdesc Form to be rendered on a tablet device.
+ * @see {@link Verifone#renderForm} Render a form
+ */
+export class DeviceForm {
+  id
+  waitForEvents
+  timeout
+
+  /**
+   * Instantiate a Form to be Rendered
+   * @constructor
+   * @param {string} id - ID of the Form
+   * @param {bool} [waitForEvents=false] - If `true` will wait for event data to
+   * be received on the form.
+   * @param {number} [timeout=15] - How long, in seconds, to wait for events from
+   * the form.
+   * @example
+   * // Form with no input data
+   * const form = new DeviceForm("FP_DISPLAY")
+   *
+   * // Form with buttons, wait 15 seconds for event data
+   * const form = new DeviceForm("FP_GEN_DISPLAY", true, 25)
+   */
+  constructor (id, waitForEvents = false, timeout = 15) {
+    this.id = id
+    this.waitForEvents = waitForEvents
+    this.timeout = timeout
+  }
+
+  toJSON () {
+    return {
+      id: this.id,
+      wait_for_events: this.waitForEvents,
+      timeout: this.timeout
+    }
+  }
+}
+
+/**
+ * Verifone
+ * @classdesc Captures a signature and renders forms on Verifone devices.
+ * @extends SignatureTablet
+ * @see {@link SignatureTablet}
+ */
+export 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')
+  }
+
+  /**
+   * Render an array of form controls.
+   *
+   * @description If any objects are Button types, the method will wait for one
+   * to be clicked.
+   *
+   * @param {object[]} objects An array of objects to display.
+   *
+   * @param {object} [formOpt] - Form configuration options.
+   * @param {string} [formOpt.background='#ffffff'] - Background color of form (hex or RGB.)
+   * @param {number} [formOpt.timeout=45] - Form timeout, in seconds.
+   *
+   * @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)
+   * ], { background: 'rgb(10,100,10)'})
+   *
+   * console.log(result)
+   */
+  async displayObjects (objects, formOpt = {}, deviceOpt) {
+    const device = await this.setupDevice(deviceOpt)
+    return device.displayObjects(objects, formOpt)
+  }
+
+  /**
+   * Render a form and get event data.
+   *
+   * @param {string|DeviceForm} form - ID of the form on the device or a DeviceForm
+   * object with addtional configuration details.
+   * @param {ControlProperty[]} [controlProps] - Array of {@link ControlProperty}
+   * objects.
+   * @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.
+   *
+   * @override
+   * @see {@link Verifone#renderForm} Render a form
+   */
+  async renderForm (form, controlProps, deviceOpt) {
+    if (typeof form === 'string') {
+      form = new DeviceForm(form)
+    }
+
+    const device = await this.setupDevice(deviceOpt)
+    device.can('render_form')
+
+    const body = JSON.stringify({
+      form: form.id,
+      wait_for_events: form.waitForEvents,
+      timeout: form.timeout,
+      control_properties: controlProps
+    })
+    const options = {
+      method: 'POST',
+      mode: 'cors',
+      headers: {
+        'Content-Type': 'application/json'
+      },
+      body
+    }
+    const url = `${this.baseUrl}/plugin/${this.id}/device/${device.id}/form/${form.id}/render`
+    const response = await fetch(url, options)
+    await checkResponse(response)
+    return await response.json()
+  }
+
+  /**
+   * Read magstripe from a card reader
+   *
+   * @param {object} [readOpts] - Additional options for reading magstripe.
+   * @param {number} [readOpts.timeout=30] - Magstripe read timeout, in seconds.
+   *
+   * @param {string|object} [deviceOpt] - Read magstrip using a specific Device
+   * ID or a Device Object. The default is the first available device.
+   *
+   */
+  async readMagstripe (readOpts = { timeout: 30 }, deviceOpt) {
+    const device = await this.setupDevice(deviceOpt)
+    device.can('read_magstripe')
+
+    const options = {
+      method: 'GET',
+      mode: 'cors',
+      headers: {
+        'Content-Type': 'application/json'
+      }
+    }
+    const url = `${this.baseUrl}/plugin/${this.id}/device/${device.id}/magstripe?timeout=${readOpts.timeout}`
+    const response = await fetch(url, options)
+    await checkResponse(response)
+    return await response.json()
+  }
+}
+
+export default Verifone