npm - @capturebridge/sdk - Versions diffs - 0.25.3 → 0.26.0 - Mend

@capturebridge/sdk 0.25.3 → 0.26.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/README.md CHANGED Viewed

@@ -1,7 +1,7 @@
-# Capture Bridge JavaScript SDK
+# Capture Bridge JavaScript Client SDK
 <!--
-  Not until: INF-3147
-[SDK Documentation for v0.25.3](https://docs.capturebridge.net/client/sdk/javascript/0.25.3)
-[CHANGELOG](https://docs.capturebridge.net/client/sdk/javascript/0.25.3/CHANGELOG.html)
+Not until: CPTR-38 is complete:
+[SDK Documentation for v0.26.0](https://docs.capturebridge.net/client/sdk/javascript/0.26.0/index.html)
+[SDK CHANGELOG](https://docs.capturebridge.net/client/sdk/javascript/0.26.0/CHANGELOG.html)
 -->

package/README.md.in CHANGED Viewed

@@ -1,7 +1,7 @@
-# Capture Bridge JavaScript SDK
+# Capture Bridge JavaScript Client SDK
 <!--
-  Not until: INF-3147
-[SDK Documentation for v0.0.0](https://docs.capturebridge.net/client/sdk/javascript/0.0.0)
-[CHANGELOG](https://docs.capturebridge.net/client/sdk/javascript/0.0.0/CHANGELOG.html)
+Not until: CPTR-38 is complete:
+[SDK Documentation for v0.0.0](https://docs.capturebridge.net/client/sdk/javascript/0.0.0/index.html)
+[SDK CHANGELOG](https://docs.capturebridge.net/client/sdk/javascript/0.0.0/CHANGELOG.html)
 -->

package/TopazSigGem.js CHANGED Viewed

@@ -63,6 +63,22 @@ class TopazSigGem extends SignatureTablet {
     const { clicked } = await device.displayObjects(objects, sceneOpt)
     return clicked
   }
+  /**
+   * Get detailed information about a specific tablet
+   *
+   * @description Returns detailed information about a tablet.
+   *
+   * @async
+   * @method
+   * @returns {object} Device info
+   * @example
+   * const info = await device.info()
+   */
+  async info (deviceOpt) {
+    const device = await this.setupDevice(deviceOpt)
+    return device.info()
+  }
 }
 export default TopazSigGem

package/Version.js CHANGED Viewed

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

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@capturebridge/sdk",
-  "version": "0.25.3",
+  "version": "0.26.0",
   "description": "Capture Bridge JavaScript client SDK",
   "type": "module",
   "types": "types.d.ts",

package/CHANGELOG.html DELETED Viewed

@@ -1,231 +0,0 @@
-<html>
-  <head>
-    <title>CaptureBridge JavaScript SDK v0.25.3 Changelog</title>
-    <style>
-    body {
-      font-family: sans-serif;
-      background: #fff;
-      color: #111;
-      padding: 1em;
-      margin:auto;
-      max-width:720px;
-    }
-    pre {
-      border: 1px solid #fff;
-      padding: 1em;
-      background:#333;
-      color:#fff;
-    }
-    code {
-      font-family: "Courier New", monospace;
-    }
-    @media (prefers-color-scheme: dark) {
-      body {
-        background: #111;
-        color: #eee;
-      }
-      a {
-        color: #5959F4;
-      }
-      a:visited {
-        color: #916AB4;
-      }
-      a:active {
-        color: #FF5959;
-      }
-    }
-    </style>
-  </head>
-  <body>
-    <h1>Changelog</h1>
-<p>All notable changes to this project will be documented in this file.</p>
-<p>The format is based on <a href="https://keepachangelog.com/en/1.1.0/">Keep a Changelog</a>,
-and this project adheres to <a href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p>
-<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.25.0">0.25.0</a> - 2025-04-30</h2>
-<h3>Changed</h3>
-<ul>
-<li>The SDK no longer sends a <code>rotate=0</code> parameter to capture and stream endpoints
-by default. Therefore you should no longer set a <code>rotate</code> parameter for
-capture and stream related methods unless the user has explicitly requested
-rotation (ensuring their site-specific configuration, if any, is honored.)</li>
-<li>You can inspect an instance&#39;s site-specific configuration at runtime via the
-<code>CaptureBridge.config()</code> method. The <code>defaultPluginRotation</code> config entry will
-list any rotation configurations.</li>
-</ul>
-<h3>Added</h3>
-<ul>
-<li>Added <code>info</code> method to the <code>CanonCamera</code> class.</li>
-<li>Added <code>config</code> method to the <code>CaptureBridge</code> class.</li>
-</ul>
-<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.22.7">0.22.7</a> - 2025-03-13</h2>
-<h3>Added</h3>
-<ul>
-<li>Updated documentation for the <code>CaptureResponseFormat</code> type to note support for
- <code>png</code> file types.</li>
-</ul>
-<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.21.1">0.21.1</a> - 2025-01-06</h2>
-<h3>Added</h3>
-<ul>
-<li>Added <code>escape</code> and <code>style</code> properties to Verifone <code>Text</code> objects and a text
-formatting example.</li>
-</ul>
-<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.20.0">0.20.0</a> - 2024-11-20</h2>
-<h3>Fixed</h3>
-<ul>
-<li>Tracks returned from <code>Verifone.readMagstripe()</code> are now in the correct order.</li>
-</ul>
-<h3>Changed</h3>
-<ul>
-<li><code>Verifone.readMagstripe()</code> was previously returning a base64 encoded <code>NULL</code>
-byte (e.g. the string <code>&quot;AA==&quot;</code>) for empty tracks, it is now returning <code>null</code>
-for empty tracks.</li>
-</ul>
-<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.19.2">0.19.2</a> - 2024-11-18</h2>
-<h3>Changed</h3>
-<ul>
-<li><code>ICAO.check()</code>, <code>IFace.icao()</code>, and <code>IFace.match()</code> will now throw an
-exception if the response from the server is an error (e.g. if an IFace
-license is not present.)</li>
-</ul>
-<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.19.0">0.19.0</a> - 2024-11-13</h2>
-<h3>Added</h3>
-<ul>
-<li>Added <code>Verifone.info()</code> method and device info SDK examples.</li>
-</ul>
-<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.18.3">0.18.3</a> - 2024-10-25</h2>
-<h3>Fixed</h3>
-<ul>
-<li>Fixed some bugs in error handling for the Verifone SDK examples.</li>
-<li>Now checking for a valid API response when invoking <code>Device.clear()</code></li>
-</ul>
-<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.18.2">0.18.2</a> - 2024-10-23</h2>
-<h3>Added</h3>
-<ul>
-<li>Added installation and Base URL information to SDK docs.</li>
-</ul>
-<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.18.1">0.18.1</a> - 2024-10-22</h2>
-<h3>Added</h3>
-<ul>
-<li>Added Topaz and IFace SDK examples</li>
-</ul>
-<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.18.0">0.18.0</a> - 2024-10-18</h2>
-<h3>Added</h3>
-<ul>
-<li>When running in a web browser, the value for <code>BASE_URL</code> will first be checked
-in a <code>capturebridge:url</code> meta tag, followed by <code>window.CAPTURE_BRIDGE_URL</code>,
-and finally <code>window.location.origin</code>. When running the SDK in Node.js a
-<code>CAPTURE_BRIDGE_URL</code> environment variable will be checked.</li>
-<li>Added the <code>Verifone.cancel()</code> method to gracefully cancel long-running
-operations such as the <code>Verifone.displayObjects()</code> and
-<code>Verifone.readMagstripe()</code> requests.</li>
-<li>Added the <code>Verifone.reset()</code> method to reset a device&#39;s state.</li>
-<li>Several Verifone SDK examples now contain a &quot;Cancel Request&quot; button.</li>
-<li>Added a Reset demo to the Verifone SDK examples allowing the SDK to reset the
-device state, forms processor app, and reboot the device.</li>
-<li>Added a Live ICAO demo containing face detection auto capture to the ICAO
-examples.</li>
-</ul>
-<h3>Changed</h3>
-<ul>
-<li><code>Verifone.displayObjects()</code> and <code>Verifone.readMagstripe()</code> now accept an
-additional <code>requestOpt</code> argument containing an optional
-<a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a> and
-<code>readyTimeout</code> parameter. <code>Verifone.cancel()</code> should be typically be used
-instead of the <code>AbortSignal</code> as it will block until the device is freed and
-available for another request.</li>
-</ul>
-<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.16.0">0.16.0</a> - 2024-10-03</h2>
-<h3>Changed</h3>
-<ul>
-<li><code>Plugin.shutdown()</code> now accepts a <code>timeout</code> argument.</li>
-</ul>
-<h3>Removed</h3>
-<ul>
-<li>Removed all callback style methods in favor of async/await methods.</li>
-</ul>
-<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.15.0">0.15.0</a> - 2024-09-25</h2>
-<h3>Added</h3>
-<ul>
-<li>Add <code>Plugin.hasMethod()</code> method for checking if a plugin has a specific RPC
-method.</li>
-<li>Add suppport for transcoding captured images to gif.</li>
-</ul>
-<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.14.0">0.14.0</a> - 2024-09-17</h2>
-<h3>Added</h3>
-<ul>
-<li>Add <code>Verifone.readMagstripe()</code> method for reading magstripe from Verifone.</li>
-</ul>
-<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.13.0">0.13.0</a> - 2024-09-10</h2>
-<h3>Added</h3>
-<ul>
-<li>Add Verifone dynamic form support and examples.</li>
-</ul>
-<h3>Changed</h3>
-<ul>
-<li><code>TopazSigGem.displayObjects()</code> previously accepted a boolean parameter for
-it&#39;s second argument, which if <code>true</code>, would clear the screen before displaying
-the objects. This method now accepts a <code>sceneOpt</code> object which contains
-<code>clear</code> and <code>backlight</code> boolean. A deprecation flag has been added to preserve
-the original function signature such that, if a boolean is provided, the method
-will fallback to the previous behavior of clearing the screen and emit a console
-warning. If an object is provided it will utilize any <code>clear</code> or <code>backlight</code>
-boolean properties.</li>
-</ul>
-<pre><code class="language-js">// Previous behavior, still works but will emit deprecation warning
-await tablet.displayObjects([
-  new Text(&#39;My hovercraft is full of eels.&#39;, 100, 400),
-], false)
-// New behavior
-const result = await tablet.displayObjects([
-  new Text(&#39;My hovercraft is full of eels.&#39;, 100, 400),
-], {clear: false, backlight: true})
-</code></pre>
-<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.12.0">0.12.0</a> - 2024-08-08</h2>
-<h3>Changed</h3>
-<ul>
-<li><code>BASE_URL</code> will default to <code>window.location.origin</code> if available, else
-<a href="https://local.capturebridge.net:9001">https://local.capturebridge.net:9001</a>) will be used.</li>
-</ul>
-<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.11.4">0.11.4</a> - 2024-07-29</h2>
-<h3>Added</h3>
-<ul>
-<li>Added <code>background</code> parameter to <code>ICAO.check()</code> and <code>IFace.icao()</code> that will
-fill in any part of the cropped image that falls outside the source image.</li>
-</ul>
-<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.11.0">0.11.0</a> - 2024-06-21</h2>
-<h3>Added</h3>
-<ul>
-<li>Added <code>DeviceForms</code> and <code>ControlProperty</code> classes for configuring forms for
-<code>Verifone</code>.</li>
-<li>Added <code>Verifone.renderForm()</code></li>
-</ul>
-<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.10.0">0.10.0</a> - 2024-06-17</h2>
-<h3>Changed</h3>
-<ul>
-<li>Introduced breaking changes to the structure of the object returned from
-<code>ICAO.check()</code></li>
-<li><code>ICAO</code> class will default to use the <code>capture_verify_iface</code> plugin if no
-plugin is provided to the constructor.</li>
-</ul>
-<h3>Added</h3>
-<ul>
-<li>Coordinates of the cropped photo are now returned from <code>ICAO.check()</code> if a face
-was found.</li>
-</ul>
-<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.9.0">0.9.0</a> - 2024-06-06</h2>
-<h3>Added</h3>
-<ul>
-<li>Introduced Changelog.</li>
-<li>Add Verifone class and examples (features signature capture support for the M450)</li>
-<li>Add <code>format</code> parameter to <code>DEFAULT_CAPTURE_OPT</code> (defaults to <code>null</code> which will
-use the plugin&#39;s default image format.)</li>
-<li>Add <code>CaptureResponseFormat</code> type definition to documentation.</li>
-</ul>
-<h3>Fixed</h3>
-<ul>
-<li>Fix bug where <code>null</code> would be sent for some URL parameters.</li>
-</ul>
-  </body>
-</html>