@capturebridge/sdk 0.20.0 → 0.20.1
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.
- package/CHANGELOG.html +161 -0
- package/README.md +5 -1
- package/README.md.in +7 -0
- package/Version.js +1 -1
- package/package.json +2 -2
- package/CHANGELOG.md +0 -180
package/CHANGELOG.html
ADDED
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
<h1>Changelog</h1>
|
|
2
|
+
<p>All notable changes to this project will be documented in this file.</p>
|
|
3
|
+
<p>The format is based on <a href="https://keepachangelog.com/en/1.1.0/">Keep a Changelog</a>,
|
|
4
|
+
and this project adheres to <a href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p>
|
|
5
|
+
<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.20.0">0.20.0</a> - 2023-11-20</h2>
|
|
6
|
+
<h3>Fixed</h3>
|
|
7
|
+
<ul>
|
|
8
|
+
<li>Tracks returned from <code>Verifone.readMagstripe()</code> are now in the correct order.</li>
|
|
9
|
+
</ul>
|
|
10
|
+
<h3>Changed</h3>
|
|
11
|
+
<ul>
|
|
12
|
+
<li><code>Verifone.readMagstripe()</code> was previously returning a base64 encoded <code>NULL</code>
|
|
13
|
+
byte (e.g. the string <code>"AA=="</code>) for empty tracks, it is now returning <code>null</code>
|
|
14
|
+
for empty tracks.</li>
|
|
15
|
+
</ul>
|
|
16
|
+
<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.19.2">0.19.2</a> - 2023-11-18</h2>
|
|
17
|
+
<h3>Changed</h3>
|
|
18
|
+
<ul>
|
|
19
|
+
<li><code>ICAO.check()</code>, <code>IFace.icao()</code>, and <code>IFace.match()</code> will now throw an
|
|
20
|
+
exception if the response from the server is an error (e.g. if an IFace
|
|
21
|
+
license is not present.)</li>
|
|
22
|
+
</ul>
|
|
23
|
+
<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.19.0">0.19.0</a> - 2023-11-13</h2>
|
|
24
|
+
<h3>Added</h3>
|
|
25
|
+
<ul>
|
|
26
|
+
<li>Added <code>Verifone.info()</code> method and device info SDK examples.</li>
|
|
27
|
+
</ul>
|
|
28
|
+
<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.18.3">0.18.3</a> - 2023-10-25</h2>
|
|
29
|
+
<h3>Fixed</h3>
|
|
30
|
+
<ul>
|
|
31
|
+
<li>Fixed some bugs in error handling for the Verifone SDK examples.</li>
|
|
32
|
+
<li>Now checking for a valid API response when invoking <code>Device.clear()</code></li>
|
|
33
|
+
</ul>
|
|
34
|
+
<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.18.2">0.18.2</a> - 2024-10-23</h2>
|
|
35
|
+
<h3>Added</h3>
|
|
36
|
+
<ul>
|
|
37
|
+
<li>Added installation and Base URL information to SDK docs.</li>
|
|
38
|
+
</ul>
|
|
39
|
+
<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.18.1">0.18.1</a> - 2024-10-22</h2>
|
|
40
|
+
<h3>Added</h3>
|
|
41
|
+
<ul>
|
|
42
|
+
<li>Added Topaz and IFace SDK examples</li>
|
|
43
|
+
</ul>
|
|
44
|
+
<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.18.0">0.18.0</a> - 2024-10-18</h2>
|
|
45
|
+
<h3>Added</h3>
|
|
46
|
+
<ul>
|
|
47
|
+
<li>When running in a web browser, the value for <code>BASE_URL</code> will first be checked
|
|
48
|
+
in a <code>capturebridge:url</code> meta tag, followed by <code>window.CAPTURE_BRIDGE_URL</code>,
|
|
49
|
+
and finally <code>window.location.origin</code>. When running the SDK in Node.js a
|
|
50
|
+
<code>CAPTURE_BRIDGE_URL</code> environment variable will be checked.</li>
|
|
51
|
+
<li>Added the <code>Verifone.cancel()</code> method to gracefully cancel long-running
|
|
52
|
+
operations such as the <code>Verifone.displayObjects()</code> and
|
|
53
|
+
<code>Verifone.readMagstripe()</code> requests.</li>
|
|
54
|
+
<li>Added the <code>Verifone.reset()</code> method to reset a device's state.</li>
|
|
55
|
+
<li>Several Verifone SDK examples now contain a "Cancel Request" button.</li>
|
|
56
|
+
<li>Added a Reset demo to the Verifone SDK examples allowing the SDK to reset the
|
|
57
|
+
device state, forms processor app, and reboot the device.</li>
|
|
58
|
+
<li>Added a Live ICAO demo containing face detection auto capture to the ICAO
|
|
59
|
+
examples.</li>
|
|
60
|
+
</ul>
|
|
61
|
+
<h3>Changed</h3>
|
|
62
|
+
<ul>
|
|
63
|
+
<li><code>Verifone.displayObjects()</code> and <code>Verifone.readMagstripe()</code> now accept an
|
|
64
|
+
additional <code>requestOpt</code> argument containing an optional
|
|
65
|
+
<a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a> and
|
|
66
|
+
<code>readyTimeout</code> parameter. <code>Verifone.cancel()</code> should be typically be used
|
|
67
|
+
instead of the <code>AbortSignal</code> as it will block until the device is freed and
|
|
68
|
+
available for another request.</li>
|
|
69
|
+
</ul>
|
|
70
|
+
<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.16.0">0.16.0</a> - 2024-10-03</h2>
|
|
71
|
+
<h3>Changed</h3>
|
|
72
|
+
<ul>
|
|
73
|
+
<li><code>Plugin.shutdown()</code> now accepts a <code>timeout</code> argument.</li>
|
|
74
|
+
</ul>
|
|
75
|
+
<h3>Removed</h3>
|
|
76
|
+
<ul>
|
|
77
|
+
<li>Removed all callback style methods in favor of async/await methods.</li>
|
|
78
|
+
</ul>
|
|
79
|
+
<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.15.0">0.15.0</a> - 2024-09-25</h2>
|
|
80
|
+
<h3>Added</h3>
|
|
81
|
+
<ul>
|
|
82
|
+
<li>Add <code>Plugin.hasMethod()</code> method for checking if a plugin has a specific RPC
|
|
83
|
+
method.</li>
|
|
84
|
+
<li>Add suppport for transcoding captured images to gif.</li>
|
|
85
|
+
</ul>
|
|
86
|
+
<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.14.0">0.14.0</a> - 2024-09-17</h2>
|
|
87
|
+
<h3>Added</h3>
|
|
88
|
+
<ul>
|
|
89
|
+
<li>Add <code>Verifone.readMagstripe()</code> method for reading magstripe from Verifone.</li>
|
|
90
|
+
</ul>
|
|
91
|
+
<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.13.0">0.13.0</a> - 2024-09-10</h2>
|
|
92
|
+
<h3>Added</h3>
|
|
93
|
+
<ul>
|
|
94
|
+
<li>Add Verifone dynamic form support and examples.</li>
|
|
95
|
+
</ul>
|
|
96
|
+
<h3>Changed</h3>
|
|
97
|
+
<ul>
|
|
98
|
+
<li><code>TopazSigGem.displayObjects()</code> previously accepted a boolean parameter for
|
|
99
|
+
it's second argument, which if <code>true</code>, would clear the screen before displaying
|
|
100
|
+
the objects. This method now accepts a <code>sceneOpt</code> object which contains
|
|
101
|
+
<code>clear</code> and <code>backlight</code> boolean. A deprecation flag has been added to preserve
|
|
102
|
+
the original function signature such that, if a boolean is provided, the method
|
|
103
|
+
will fallback to the previous behavior of clearing the screen and emit a console
|
|
104
|
+
warning. If an object is provided it will utilize any <code>clear</code> or <code>backlight</code>
|
|
105
|
+
boolean properties.</li>
|
|
106
|
+
</ul>
|
|
107
|
+
<pre><code class="language-js">// Previous behavior, still works but will emit deprecation warning
|
|
108
|
+
await tablet.displayObjects([
|
|
109
|
+
new Text('My hovercraft is full of eels.', 100, 400),
|
|
110
|
+
], false)
|
|
111
|
+
|
|
112
|
+
// New behavior
|
|
113
|
+
const result = await tablet.displayObjects([
|
|
114
|
+
new Text('My hovercraft is full of eels.', 100, 400),
|
|
115
|
+
], {clear: false, backlight: true})
|
|
116
|
+
</code></pre>
|
|
117
|
+
<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.12.0">0.12.0</a> - 2024-08-08</h2>
|
|
118
|
+
<h3>Changed</h3>
|
|
119
|
+
<ul>
|
|
120
|
+
<li><code>BASE_URL</code> will default to <code>window.location.origin</code> if available, else
|
|
121
|
+
<a href="https://local.capturebridge.net:9001">https://local.capturebridge.net:9001</a>) will be used.</li>
|
|
122
|
+
</ul>
|
|
123
|
+
<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.11.4">0.11.4</a> - 2024-07-29</h2>
|
|
124
|
+
<h3>Added</h3>
|
|
125
|
+
<ul>
|
|
126
|
+
<li>Added <code>background</code> parameter to <code>ICAO.check()</code> and <code>IFace.icao()</code> that will
|
|
127
|
+
fill in any part of the cropped image that falls outside the source image.</li>
|
|
128
|
+
</ul>
|
|
129
|
+
<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.11.0">0.11.0</a> - 2024-06-21</h2>
|
|
130
|
+
<h3>Added</h3>
|
|
131
|
+
<ul>
|
|
132
|
+
<li>Added <code>DeviceForms</code> and <code>ControlProperty</code> classes for configuring forms for
|
|
133
|
+
<code>Verifone</code>.</li>
|
|
134
|
+
<li>Added <code>Verifone.renderForm()</code></li>
|
|
135
|
+
</ul>
|
|
136
|
+
<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.10.0">0.10.0</a> - 2024-06-17</h2>
|
|
137
|
+
<h3>Changed</h3>
|
|
138
|
+
<ul>
|
|
139
|
+
<li>Introduced breaking changes to the structure of the object returned from
|
|
140
|
+
<code>ICAO.check()</code></li>
|
|
141
|
+
<li><code>ICAO</code> class will default to use the <code>capture_verify_iface</code> plugin if no
|
|
142
|
+
plugin is provided to the constructor.</li>
|
|
143
|
+
</ul>
|
|
144
|
+
<h3>Added</h3>
|
|
145
|
+
<ul>
|
|
146
|
+
<li>Coordinates of the cropped photo are now returned from <code>ICAO.check()</code> if a face
|
|
147
|
+
was found.</li>
|
|
148
|
+
</ul>
|
|
149
|
+
<h2><a href="https://www.npmjs.com/package/@capturebridge/sdk/v/0.9.0">0.9.0</a> - 2024-06-06</h2>
|
|
150
|
+
<h3>Added</h3>
|
|
151
|
+
<ul>
|
|
152
|
+
<li>Introduced Changelog.</li>
|
|
153
|
+
<li>Add Verifone class and examples (features signature capture support for the M450)</li>
|
|
154
|
+
<li>Add <code>format</code> parameter to <code>DEFAULT_CAPTURE_OPT</code> (defaults to <code>null</code> which will
|
|
155
|
+
use the plugin's default image format.)</li>
|
|
156
|
+
<li>Add <code>CaptureResponseFormat</code> type definition to documentation.</li>
|
|
157
|
+
</ul>
|
|
158
|
+
<h3>Fixed</h3>
|
|
159
|
+
<ul>
|
|
160
|
+
<li>Fix bug where <code>null</code> would be sent for some URL parameters.</li>
|
|
161
|
+
</ul>
|
package/README.md
CHANGED
|
@@ -1,3 +1,7 @@
|
|
|
1
1
|
# Capture Bridge JavaScript SDK
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<!--
|
|
4
|
+
Not until: INF-3147
|
|
5
|
+
[SDK Documentation for v0.20.1](https://docs.capturebridge.net/client/sdk/javascript/0.20.1)
|
|
6
|
+
[CHANGELOG](https://docs.capturebridge.net/client/sdk/javascript/0.20.1/CHANGELOG.html)
|
|
7
|
+
-->
|
package/README.md.in
ADDED
package/Version.js
CHANGED
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@capturebridge/sdk",
|
|
3
|
-
"version": "0.20.
|
|
4
|
-
"description": "Capture Bridge JavaScript SDK
|
|
3
|
+
"version": "0.20.1",
|
|
4
|
+
"description": "Capture Bridge JavaScript client SDK",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"types": "types.d.ts",
|
|
7
7
|
"license": "Apache-2.0"
|
package/CHANGELOG.md
DELETED
|
@@ -1,180 +0,0 @@
|
|
|
1
|
-
# Changelog
|
|
2
|
-
|
|
3
|
-
All notable changes to this project will be documented in this file.
|
|
4
|
-
|
|
5
|
-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
6
|
-
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
## [0.20.0] - 2023-11-20
|
|
10
|
-
|
|
11
|
-
### Changed
|
|
12
|
-
|
|
13
|
-
- `Verifone.readMagstripe()` was previously returning a base64 encoded `NULL`
|
|
14
|
-
byte (e.g. the string `"AA=="`) for empty tracks, it is now returning `null`
|
|
15
|
-
for empty tracks.
|
|
16
|
-
|
|
17
|
-
## [0.19.2] - 2023-11-18
|
|
18
|
-
|
|
19
|
-
### Changed
|
|
20
|
-
|
|
21
|
-
- `ICAO.check()`, `IFace.icao()`, and `IFace.match()` will now throw an
|
|
22
|
-
exception if the response from the server is an error (e.g. if an IFace
|
|
23
|
-
license is not present.)
|
|
24
|
-
|
|
25
|
-
## [0.19.0] - 2023-11-13
|
|
26
|
-
|
|
27
|
-
### Added
|
|
28
|
-
|
|
29
|
-
- Added `Verifone.info()` method and device info SDK examples.
|
|
30
|
-
|
|
31
|
-
## [0.18.3] - 2023-10-25
|
|
32
|
-
|
|
33
|
-
### Fixed
|
|
34
|
-
|
|
35
|
-
- Fixed some bugs in error handling for the Verifone SDK examples.
|
|
36
|
-
- Now checking for a valid API response when invoking `Device.clear()`
|
|
37
|
-
|
|
38
|
-
## [0.18.2] - 2024-10-23
|
|
39
|
-
|
|
40
|
-
### Added
|
|
41
|
-
|
|
42
|
-
- Added installation and Base URL information to SDK docs.
|
|
43
|
-
|
|
44
|
-
## [0.18.1] - 2024-10-22
|
|
45
|
-
|
|
46
|
-
### Added
|
|
47
|
-
|
|
48
|
-
- Added Topaz and IFace SDK examples
|
|
49
|
-
|
|
50
|
-
## [0.18.0] - 2024-10-18
|
|
51
|
-
|
|
52
|
-
### Added
|
|
53
|
-
|
|
54
|
-
- When running in a web browser, the value for `BASE_URL` will first be checked
|
|
55
|
-
in a `capturebridge:url` meta tag, followed by `window.CAPTURE_BRIDGE_URL`,
|
|
56
|
-
and finally `window.location.origin`. When running the SDK in Node.js a
|
|
57
|
-
`CAPTURE_BRIDGE_URL` environment variable will be checked.
|
|
58
|
-
- Added the `Verifone.cancel()` method to gracefully cancel long-running
|
|
59
|
-
operations such as the `Verifone.displayObjects()` and
|
|
60
|
-
`Verifone.readMagstripe()` requests.
|
|
61
|
-
- Added the `Verifone.reset()` method to reset a device's state.
|
|
62
|
-
- Several Verifone SDK examples now contain a "Cancel Request" button.
|
|
63
|
-
- Added a Reset demo to the Verifone SDK examples allowing the SDK to reset the
|
|
64
|
-
device state, forms processor app, and reboot the device.
|
|
65
|
-
- Added a Live ICAO demo containing face detection auto capture to the ICAO
|
|
66
|
-
examples.
|
|
67
|
-
|
|
68
|
-
### Changed
|
|
69
|
-
|
|
70
|
-
- `Verifone.displayObjects()` and `Verifone.readMagstripe()` now accept an
|
|
71
|
-
additional `requestOpt` argument containing an optional
|
|
72
|
-
[AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) and
|
|
73
|
-
`readyTimeout` parameter. `Verifone.cancel()` should be typically be used
|
|
74
|
-
instead of the `AbortSignal` as it will block until the device is freed and
|
|
75
|
-
available for another request.
|
|
76
|
-
|
|
77
|
-
## [0.16.0] - 2024-10-03
|
|
78
|
-
|
|
79
|
-
### Changed
|
|
80
|
-
|
|
81
|
-
- `Plugin.shutdown()` now accepts a `timeout` argument.
|
|
82
|
-
|
|
83
|
-
### Removed
|
|
84
|
-
|
|
85
|
-
- Removed all callback style methods in favor of async/await methods.
|
|
86
|
-
|
|
87
|
-
## [0.15.0] - 2024-09-25
|
|
88
|
-
|
|
89
|
-
### Added
|
|
90
|
-
|
|
91
|
-
- Add `Plugin.hasMethod()` method for checking if a plugin has a specific RPC
|
|
92
|
-
method.
|
|
93
|
-
- Add suppport for transcoding captured images to gif.
|
|
94
|
-
|
|
95
|
-
## [0.14.0] - 2024-09-17
|
|
96
|
-
|
|
97
|
-
### Added
|
|
98
|
-
|
|
99
|
-
- Add `Verifone.readMagstripe()` method for reading magstripe from Verifone.
|
|
100
|
-
|
|
101
|
-
## [0.13.0] - 2024-09-10
|
|
102
|
-
|
|
103
|
-
### Added
|
|
104
|
-
|
|
105
|
-
- Add Verifone dynamic form support and examples.
|
|
106
|
-
|
|
107
|
-
### Changed
|
|
108
|
-
|
|
109
|
-
- `TopazSigGem.displayObjects()` previously accepted a boolean parameter for
|
|
110
|
-
it's second argument, which if `true`, would clear the screen before displaying
|
|
111
|
-
the objects. This method now accepts a `sceneOpt` object which contains
|
|
112
|
-
`clear` and `backlight` boolean. A deprecation flag has been added to preserve
|
|
113
|
-
the original function signature such that, if a boolean is provided, the method
|
|
114
|
-
will fallback to the previous behavior of clearing the screen and emit a console
|
|
115
|
-
warning. If an object is provided it will utilize any `clear` or `backlight`
|
|
116
|
-
boolean properties.
|
|
117
|
-
|
|
118
|
-
```js
|
|
119
|
-
// Previous behavior, still works but will emit deprecation warning
|
|
120
|
-
await tablet.displayObjects([
|
|
121
|
-
new Text('My hovercraft is full of eels.', 100, 400),
|
|
122
|
-
], false)
|
|
123
|
-
|
|
124
|
-
// New behavior
|
|
125
|
-
const result = await tablet.displayObjects([
|
|
126
|
-
new Text('My hovercraft is full of eels.', 100, 400),
|
|
127
|
-
], {clear: false, backlight: true})
|
|
128
|
-
```
|
|
129
|
-
|
|
130
|
-
## [0.12.0] - 2024-08-08
|
|
131
|
-
|
|
132
|
-
### Changed
|
|
133
|
-
|
|
134
|
-
- `BASE_URL` will default to `window.location.origin` if available, else
|
|
135
|
-
https://local.capturebridge.net:9001) will be used.
|
|
136
|
-
|
|
137
|
-
## [0.11.4] - 2024-07-29
|
|
138
|
-
|
|
139
|
-
### Added
|
|
140
|
-
|
|
141
|
-
- Added `background` parameter to `ICAO.check()` and `IFace.icao()` that will
|
|
142
|
-
fill in any part of the cropped image that falls outside the source image.
|
|
143
|
-
|
|
144
|
-
## [0.11.0] - 2024-06-21
|
|
145
|
-
|
|
146
|
-
### Added
|
|
147
|
-
|
|
148
|
-
- Added `DeviceForms` and `ControlProperty` classes for configuring forms for
|
|
149
|
-
`Verifone`.
|
|
150
|
-
- Added `Verifone.renderForm()`
|
|
151
|
-
|
|
152
|
-
## [0.10.0] - 2024-06-17
|
|
153
|
-
|
|
154
|
-
### Changed
|
|
155
|
-
|
|
156
|
-
- Introduced breaking changes to the structure of the object returned from
|
|
157
|
-
`ICAO.check()`
|
|
158
|
-
- `ICAO` class will default to use the `capture_verify_iface` plugin if no
|
|
159
|
-
plugin is provided to the constructor.
|
|
160
|
-
|
|
161
|
-
### Added
|
|
162
|
-
|
|
163
|
-
- Coordinates of the cropped photo are now returned from `ICAO.check()` if a face
|
|
164
|
-
was found.
|
|
165
|
-
|
|
166
|
-
## [0.9.0] - 2024-06-06
|
|
167
|
-
|
|
168
|
-
### Added
|
|
169
|
-
|
|
170
|
-
- Introduced Changelog.
|
|
171
|
-
- Add Verifone class and examples (features signature capture support for the M450)
|
|
172
|
-
- Add `format` parameter to `DEFAULT_CAPTURE_OPT` (defaults to `null` which will
|
|
173
|
-
use the plugin's default image format.)
|
|
174
|
-
- Add `CaptureResponseFormat` type definition to documentation.
|
|
175
|
-
|
|
176
|
-
### Fixed
|
|
177
|
-
|
|
178
|
-
- Fix bug where `null` would be sent for some URL parameters.
|
|
179
|
-
|
|
180
|
-
[0.9.0]: https://www.npmjs.com/package/@capturebridge/sdk/v/0.9.0
|