@capturebridge/sdk 0.10.1 → 0.11.0

package/CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.11.0] - 2024-06-21
+
+### Added
+
+- Added `DeviceForms` and `ControlProperty` classes for configuring forms for
+  `Verifone`.
+- Added `Verifone.renderForm()`
+
 ## [0.10.0] - 2024-06-17
 
 ### Changed

package/README.md

@@ -1,3 +1,3 @@
-# Capture Bridge JavaScript SDK for web applications
+# Capture Bridge JavaScript SDK
 
-See the [Changelog](CHANGELOG.md) for new features and breaking changes.
+See `CHANGELOG.md` for new features and breaking changes.

package/Verifone.js

@@ -1,13 +1,94 @@
 import SignatureTablet from './SignatureTablet.js'
-import { BASE_URL } from './Common.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 on Verifone device.
+ * @classdesc Captures a signature and renders forms on Verifone devices.
  * @extends SignatureTablet
  * @see {@link SignatureTablet}
  */
-class Verifone extends SignatureTablet {
+export class Verifone extends SignatureTablet {
   /**
    * Instantiate a Verifone Class
    * @constructor
@@ -54,15 +135,58 @@ class Verifone extends SignatureTablet {
   }
 
   /**
-   * Not currently supported for this 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

package/Version.js

@@ -4,5 +4,5 @@
  * @constant
  * @type {string}
  */
-const VERSION = '0.10.1'
+const VERSION = '0.11.0'
 export default VERSION

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capturebridge/sdk",
-  "version": "0.10.1",
+  "version": "0.11.0",
   "description": "Capture Bridge JavaScript SDK for web applications",
   "type": "module",
   "license": "Apache-2.0"