@capturebridge/sdk 0.11.3 → 0.11.5

package/CHANGELOG.md

@@ -5,6 +5,13 @@ 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.4] - 2024-07-29
+
+### Added
+
+- Added `background` parameter to `ICAO.check()` and `IFace.icao()` that will
+  fill in any part of the cropped image that falls outside the source image.
+
 ## [0.11.0] - 2024-06-21
 
 ### Added

package/ICAO.js

@@ -32,6 +32,9 @@ class ICAO extends Plugin {
    * the value will be interpreted as the preferred crop method which will vary
    * by plugin implementation.
    *
+   * @param {string} [background=#ffffff] - Hexadecimal color that will fill in
+   * any part of the cropped image that falls outside the original source image.
+   *
    * @returns {object} Results of the ICAO check, this may vary by plugin
    * implementation.
    *
@@ -48,7 +51,7 @@ class ICAO extends Plugin {
    * console.log(`found ${result.faces_found} faces in the image`)
    * document.body.appendChild(img)
    */
-  async check (image, cropMethod = false) {
+  async check (image, cropMethod = false, cropBackground) {
     let imageData
 
     // If this is an ImageSource object fetch it's image data
@@ -63,7 +66,8 @@ class ICAO extends Plugin {
     const body = {
       base64: imageData,
       crop: Boolean(cropMethod),
-      crop_method: cropMethod || undefined
+      crop_method: cropMethod || undefined,
+      crop_background: cropBackground || undefined
     }
     const options = {
       method: 'POST',

package/IFace.js

@@ -131,6 +131,9 @@ export class IFace extends ICAO {
    * the value will be interpreted as the preferred crop method which will vary
    * by plugin implementation.
    *
+   * @param {string} [background=#ffffff] - Hexadecimal color that will fill in
+   * any part of the cropped image that falls outside the original source image.
+   *
    * @returns {object} Results of the ICAO check, this may vary by plugin
    * implementation.
    *
@@ -147,8 +150,8 @@ export class IFace extends ICAO {
    * console.log(`found ${result.faces_found} faces in the image`)
    * document.body.appendChild(img)
    */
-  async icao (image, cropMethod = false) {
-    return await this.check(image, cropMethod)
+  async icao (image, cropMethod = false, cropBackground) {
+    return await this.check(image, cropMethod, cropBackground)
   }
 
   /**

package/Version.js

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

package/examples/icao.js

@@ -7,7 +7,7 @@ import ImageSource from '../../../../sdk/js/ImageSource.js'
     const imgSrc = new ImageSource('icao.jpg', 'url')
 
     // Perform an ICAO check against the provided Image and return cropped
-    const results = await icao.check(imgSrc, true)
+    const results = await icao.check(imgSrc, true, '#a5a5a5')
 
     // Our stock photo is zoomed in too close, so we pad the canvas to allow for
     // drawing a box around the cropped portion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capturebridge/sdk",
-  "version": "0.11.3",
+  "version": "0.11.5",
   "description": "Capture Bridge JavaScript SDK for web applications",
   "type": "module",
   "types": "types.d.ts",