@capturebridge/sdk 0.7.0 → 0.8.0

package/ICAO.js

@@ -1,70 +1,70 @@
-import Plugin from './Plugin.js'
-import { BASE_URL } from './Common.js'
-
-/**
- * ICAO
- * @classdesc Class for invoking ICAO checks on an image
- *
- * @see {@link CanonScanner}
- */
-class ICAO extends Plugin {
-  /**
-   * Instantiate an ICAO plugin
-   * @constructor
-   * @param {string} [baseURL] - Protocol, domain, and port for the service.
-   * @param {string|object} plugin - The ID of the desired plugin to use for
-   * this instance or an existing Plugin object. The plugin must support the
-   * "icao" method.
-   *
-   * @example
-   * const icao = new ICAO('capture_verify_iface')
-   */
-  constructor (plugin, baseUrl = BASE_URL) {
-    super(plugin, baseUrl)
-  }
-
-  /**
-   * Check the ICAO compliance of an image
-   * @param {string} image - A base64 encoded image.
-   *
-   * @param {string|bool} [crop] - If falsy image will not be cropped, otherwise
-   * the value will be interpreted as the preferred crop method which will vary
-   * by plugin implementation.
-   *
-   * @returns {object} Results of the ICAO check, this may vary by plugin
-   * implementation.
-   *
-   * @async
-   * @example
-   * // Take a photo with a Canon Camera and perform ICAO checks on the
-   * // returned image
-   * const camera = new CanonCamera()
-   * const photo = await camera.takePhoto('base64')
-   * const icao = new ICAO('capture_verify_iface')
-   * const results = await icao.check(photo)
-   * const img = document.createElement('img')
-   * img.src = 'data:image/jpeg;base64,' + results.cropped
-   * console.log(`found ${result.faces_found} faces in the image`)
-   * document.body.appendChild(img)
-   */
-  async check (image, cropMethod = false) {
-    const body = {
-      base64: image,
-      crop: Boolean(cropMethod),
-      crop_method: cropMethod || undefined
-    }
-    const options = {
-      method: 'POST',
-      mode: 'cors',
-      headers: {
-        'Content-Type': 'application/json'
-      },
-      body: JSON.stringify(body)
-    }
-    const url = `${this.baseUrl}/plugin/${this.id}/icao`
-    const response = await fetch(url, options)
-    return await response.json()
-  }
-}
-
-export default ICAO
+import Plugin from './Plugin.js'
+import { BASE_URL } from './Common.js'
+
+/**
+ * ICAO
+ * @classdesc Class for invoking ICAO checks on an image
+ * @extends Plugin
+ * @see {@link CanonScanner}
+ */
+class ICAO extends Plugin {
+  /**
+   * Instantiate an ICAO plugin
+   * @constructor
+   * @param {string} [baseURL] - Protocol, domain, and port for the service.
+   * @param {string|object} plugin - The ID of the desired plugin to use for
+   * this instance or an existing Plugin object. The plugin must support the
+   * "icao" method.
+   *
+   * @example
+   * const icao = new ICAO('capture_verify_iface')
+   */
+  constructor (plugin, baseUrl = BASE_URL) {
+    super(plugin, baseUrl)
+  }
+
+  /**
+   * Check the ICAO compliance of an image
+   * @param {string} image - A base64 encoded image.
+   *
+   * @param {string|bool} [crop] - If falsy image will not be cropped, otherwise
+   * the value will be interpreted as the preferred crop method which will vary
+   * by plugin implementation.
+   *
+   * @returns {object} Results of the ICAO check, this may vary by plugin
+   * implementation.
+   *
+   * @async
+   * @example
+   * // Take a photo with a Canon Camera and perform ICAO checks on the
+   * // returned image
+   * const camera = new CanonCamera()
+   * const photo = await camera.takePhoto('base64')
+   * const icao = new ICAO('capture_verify_iface')
+   * const results = await icao.check(photo)
+   * const img = document.createElement('img')
+   * img.src = 'data:image/jpeg;base64,' + results.cropped
+   * console.log(`found ${result.faces_found} faces in the image`)
+   * document.body.appendChild(img)
+   */
+  async check (image, cropMethod = false) {
+    const body = {
+      base64: image,
+      crop: Boolean(cropMethod),
+      crop_method: cropMethod || undefined
+    }
+    const options = {
+      method: 'POST',
+      mode: 'cors',
+      headers: {
+        'Content-Type': 'application/json'
+      },
+      body: JSON.stringify(body)
+    }
+    const url = `${this.baseUrl}/plugin/${this.id}/icao`
+    const response = await fetch(url, options)
+    return await response.json()
+  }
+}
+
+export default ICAO