@smileid/web-components 10.0.6 → 11.0.1

package/lib/components/totp-consent/src/index.js

@@ -1,4 +1,4 @@
-export {
-  // eslint-disable-next-line import/prefer-default-export
-  TotpConsent,
-} from './TotpConsent';
+export {
+  // eslint-disable-next-line import/prefer-default-export
+  TotpConsent,
+} from './TotpConsent';

package/lib/domain/camera/src/README.md

@@ -1,38 +1,38 @@
-# SmartCamera.js
-
-SmartCamera.js is a JavaScript class that provides an interface for interacting with the user's camera device. It has special handling for multi-camera Samsung devices to mitigate issues with blurry images at the edges.
-
-## Usage
-
-### Getting Media Stream
-
-To get the media stream from the user's camera, call the `getMedia` method with the desired constraints. This method returns a Promise that resolves to a MediaStream object.
-
-```javascript
-const constraints = {
-  video: true,
-  audio: false,
-};
-const stream = await SmartCamera.getMedia(constraints);
-```
-
-`StartCamera` is a singleton so the `stream` can be accessed anytime via `SmartCamera.stream`.
-
-```javascript
-let video = document.createElement('video');
-
-video.autoplay = true;
-video.playsInline = true;
-video.muted = true;
-
-if ('srcObject' in video) {
-  video.srcObject = stream;
-} else {
-  video.src = window.URL.createObjectURL(stream);
-}
-video.play();
-```
-
-### Stopping Media Stream
-
-To stop the media stream, call the stopMedia method. This will stop all tracks in the stream and set the stream to null.
+# SmartCamera.js
+
+SmartCamera.js is a JavaScript class that provides an interface for interacting with the user's camera device. It has special handling for multi-camera Samsung devices to mitigate issues with blurry images at the edges.
+
+## Usage
+
+### Getting Media Stream
+
+To get the media stream from the user's camera, call the `getMedia` method with the desired constraints. This method returns a Promise that resolves to a MediaStream object.
+
+```javascript
+const constraints = {
+  video: true,
+  audio: false,
+};
+const stream = await SmartCamera.getMedia(constraints);
+```
+
+`StartCamera` is a singleton so the `stream` can be accessed anytime via `SmartCamera.stream`.
+
+```javascript
+let video = document.createElement('video');
+
+video.autoplay = true;
+video.playsInline = true;
+video.muted = true;
+
+if ('srcObject' in video) {
+  video.srcObject = stream;
+} else {
+  video.src = window.URL.createObjectURL(stream);
+}
+video.play();
+```
+
+### Stopping Media Stream
+
+To stop the media stream, call the stopMedia method. This will stop all tracks in the stream and set the stream to null.

package/lib/domain/camera/src/SmartCamera.js

@@ -1,109 +1,109 @@
-class SmartCamera {
-  static stream = null;
-
-  static async getMedia(constraints) {
-    SmartCamera.stream = await navigator.mediaDevices.getUserMedia(constraints);
-    return SmartCamera.stream;
-  }
-
-  static environmentOptions = {
-    facingMode: 'environment',
-    height: {
-      ideal: 1080,
-      max: 1440,
-      min: 720,
-    },
-    width: {
-      ideal: 1920,
-      max: 2560,
-      min: 1280,
-    },
-    // NOTE: Special case for multi-camera Samsung devices (learnt from Acuant)
-    // "We found out that some triple camera Samsung devices (S10, S20, Note 20, etc) capture images blurry at edges.
-    // Zooming to 2X, matching the telephoto lens, doesn't solve it completely but mitigates it."
-    zoom: SmartCamera.isSamsungMultiCameraDevice() ? 2.0 : 1.0,
-  };
-
-  static stopMedia() {
-    if (SmartCamera.stream) {
-      SmartCamera.stream.getTracks().forEach((track) => track.stop());
-      SmartCamera.stream = null;
-    }
-  }
-
-  static async supportsAgentMode() {
-    try {
-      const devices = await navigator.mediaDevices.enumerateDevices();
-      const videoDevices = devices.filter(
-        (device) => device.kind === 'videoinput',
-      );
-
-      let hasBackCamera = false;
-
-      videoDevices.forEach((device) => {
-        // Check if the device label or device ID indicates a back camera
-        if (
-          device.label.toLowerCase().includes('back') ||
-          device.label.toLowerCase().includes('rear')
-        ) {
-          hasBackCamera = true;
-          return true;
-        }
-        return false;
-      });
-
-      return hasBackCamera;
-    } catch (error) {
-      console.warn('Error accessing media devices: ', error);
-      return false;
-    }
-  }
-
-  static isSamsungMultiCameraDevice() {
-    const matchedModelNumber = navigator.userAgent.match(/SM-[N|G]\d{3}/);
-    if (!matchedModelNumber) {
-      return false;
-    }
-
-    const modelNumber = parseInt(matchedModelNumber[0].match(/\d{3}/)[0], 10);
-    const smallerModelNumber = 970; // S10e
-    return !Number.isNaN(modelNumber) && modelNumber >= smallerModelNumber;
-  }
-
-  static handleCameraError(e) {
-    switch (e.name) {
-      case 'NotAllowedError':
-      case 'SecurityError':
-        return `
-              Looks like camera access was not granted, or was blocked by a browser
-              level setting / extension. Please follow the prompt from the URL bar,
-              or extensions, and enable access.
-              You may need to refresh to start all over again
-            `;
-      case 'AbortError':
-        return `
-              Oops! Something happened, and we lost access to your stream.
-              Please refresh to start all over again
-            `;
-      case 'NotReadableError':
-        return `
-              There seems to be a problem with your device's camera, or its connection.
-              Please check this, and when resolved, try again. Or try another device.
-            `;
-      case 'NotFoundError':
-        return `
-              We are unable to find a video stream.
-              You may need to refresh to start all over again
-            `;
-      case 'TypeError':
-        return `
-              This site is insecure, and as such cannot have access to your camera.
-              Try to navigate to a secure version of this page, or contact the owner.
-            `;
-      default:
-        return e.message;
-    }
-  }
-}
-
-export default SmartCamera;
+class SmartCamera {
+  static stream = null;
+
+  static async getMedia(constraints) {
+    SmartCamera.stream = await navigator.mediaDevices.getUserMedia(constraints);
+    return SmartCamera.stream;
+  }
+
+  static environmentOptions = {
+    facingMode: 'environment',
+    height: {
+      ideal: 1080,
+      max: 1440,
+      min: 720,
+    },
+    width: {
+      ideal: 1920,
+      max: 2560,
+      min: 1280,
+    },
+    // NOTE: Special case for multi-camera Samsung devices (learnt from Acuant)
+    // "We found out that some triple camera Samsung devices (S10, S20, Note 20, etc) capture images blurry at edges.
+    // Zooming to 2X, matching the telephoto lens, doesn't solve it completely but mitigates it."
+    zoom: SmartCamera.isSamsungMultiCameraDevice() ? 2.0 : 1.0,
+  };
+
+  static stopMedia() {
+    if (SmartCamera.stream) {
+      SmartCamera.stream.getTracks().forEach((track) => track.stop());
+      SmartCamera.stream = null;
+    }
+  }
+
+  static async supportsAgentMode() {
+    try {
+      const devices = await navigator.mediaDevices.enumerateDevices();
+      const videoDevices = devices.filter(
+        (device) => device.kind === 'videoinput',
+      );
+
+      let hasBackCamera = false;
+
+      videoDevices.forEach((device) => {
+        // Check if the device label or device ID indicates a back camera
+        if (
+          device.label.toLowerCase().includes('back') ||
+          device.label.toLowerCase().includes('rear')
+        ) {
+          hasBackCamera = true;
+          return true;
+        }
+        return false;
+      });
+
+      return hasBackCamera;
+    } catch (error) {
+      console.warn('Error accessing media devices: ', error);
+      return false;
+    }
+  }
+
+  static isSamsungMultiCameraDevice() {
+    const matchedModelNumber = navigator.userAgent.match(/SM-[N|G]\d{3}/);
+    if (!matchedModelNumber) {
+      return false;
+    }
+
+    const modelNumber = parseInt(matchedModelNumber[0].match(/\d{3}/)[0], 10);
+    const smallerModelNumber = 970; // S10e
+    return !Number.isNaN(modelNumber) && modelNumber >= smallerModelNumber;
+  }
+
+  static handleCameraError(e) {
+    switch (e.name) {
+      case 'NotAllowedError':
+      case 'SecurityError':
+        return `
+              Looks like camera access was not granted, or was blocked by a browser
+              level setting / extension. Please follow the prompt from the URL bar,
+              or extensions, and enable access.
+              You may need to refresh to start all over again
+            `;
+      case 'AbortError':
+        return `
+              Oops! Something happened, and we lost access to your stream.
+              Please refresh to start all over again
+            `;
+      case 'NotReadableError':
+        return `
+              There seems to be a problem with your device's camera, or its connection.
+              Please check this, and when resolved, try again. Or try another device.
+            `;
+      case 'NotFoundError':
+        return `
+              We are unable to find a video stream.
+              You may need to refresh to start all over again
+            `;
+      case 'TypeError':
+        return `
+              This site is insecure, and as such cannot have access to your camera.
+              Try to navigate to a secure version of this page, or contact the owner.
+            `;
+      default:
+        return e.message;
+    }
+  }
+}
+
+export default SmartCamera;

package/lib/domain/constants/src/Constants.js

@@ -1,27 +1,27 @@
-/**
- * The type of image submitted in the job request
- * @readonly
- * @enum {number}
- */
-export const IMAGE_TYPE = {
-  /** ID_CARD_BACK_IMAGE_BASE64 Base64 encoded back of ID card image (.jpg or .png) */
-  ID_CARD_BACK_IMAGE_BASE64: 7,
-  /** ID_CARD_BACK_IMAGE_FILE Back of ID card image in .png or .jpg file format */
-  ID_CARD_BACK_IMAGE_FILE: 5,
-  /** ID_CARD_IMAGE_BASE64 Base64 encoded ID card image (.png or .jpg) */
-  ID_CARD_IMAGE_BASE64: 3,
-  /** ID_CARD_IMAGE_FILE ID card image in .png or .jpg file format */
-  ID_CARD_IMAGE_FILE: 1,
-  /** LIVENESS_IMAGE_BASE64 Base64 encoded liveness image (.jpg or .png) */
-  LIVENESS_IMAGE_BASE64: 6,
-  /** LIVENESS_IMAGE_FILE Liveness image in .png or .jpg file format */
-  LIVENESS_IMAGE_FILE: 4,
-  /** SELFIE_IMAGE_BASE64 Base64 encoded selfie image (.png or .jpg) */
-  SELFIE_IMAGE_BASE64: 2,
-  /** SELFIE_IMAGE_FILE Selfie image in .png or .jpg file format */
-  SELFIE_IMAGE_FILE: 0,
-};
-
-export const DEFAULT_NO_OF_LIVENESS_FRAMES = 8;
-export const PORTRAIT_ID_PREVIEW_WIDTH = 396;
-export const PORTRAIT_ID_PREVIEW_HEIGHT = 527;
+/**
+ * The type of image submitted in the job request
+ * @readonly
+ * @enum {number}
+ */
+export const IMAGE_TYPE = {
+  /** ID_CARD_BACK_IMAGE_BASE64 Base64 encoded back of ID card image (.jpg or .png) */
+  ID_CARD_BACK_IMAGE_BASE64: 7,
+  /** ID_CARD_BACK_IMAGE_FILE Back of ID card image in .png or .jpg file format */
+  ID_CARD_BACK_IMAGE_FILE: 5,
+  /** ID_CARD_IMAGE_BASE64 Base64 encoded ID card image (.png or .jpg) */
+  ID_CARD_IMAGE_BASE64: 3,
+  /** ID_CARD_IMAGE_FILE ID card image in .png or .jpg file format */
+  ID_CARD_IMAGE_FILE: 1,
+  /** LIVENESS_IMAGE_BASE64 Base64 encoded liveness image (.jpg or .png) */
+  LIVENESS_IMAGE_BASE64: 6,
+  /** LIVENESS_IMAGE_FILE Liveness image in .png or .jpg file format */
+  LIVENESS_IMAGE_FILE: 4,
+  /** SELFIE_IMAGE_BASE64 Base64 encoded selfie image (.png or .jpg) */
+  SELFIE_IMAGE_BASE64: 2,
+  /** SELFIE_IMAGE_FILE Selfie image in .png or .jpg file format */
+  SELFIE_IMAGE_FILE: 0,
+};
+
+export const DEFAULT_NO_OF_LIVENESS_FRAMES = 8;
+export const PORTRAIT_ID_PREVIEW_WIDTH = 396;
+export const PORTRAIT_ID_PREVIEW_HEIGHT = 527;

package/lib/domain/file-upload/README.md

@@ -1,35 +1,35 @@
-# SmartFileUpload.js
-
-This exports a class for dealing with file-uploads in SmileID's web components
-
-## Usage
-
-Suppose you have an file input field
-
-```html
-<input
-  type="file"
-  id="upload-photo"
-  name="document"
-  accept="image/png, image/jpeg"
-/>
-```
-
-```javascript
-// get the element
-const uploadDocumentPhotoButton = document.getElementById('upload-photo');
-// add a change event listener
-uploadDocumentPhotoButton.addEventListener('change', async (event) => {
-  try {
-    const { files } = event.target;
-
-    // validate file, and convert file to data url
-    // returns the data url for the first file
-    const fileData = await SmartFileUpload.retrieve(files);
-
-    // use the data url
-  } catch (error) {
-    // handle error
-  }
-});
-```
+# SmartFileUpload.js
+
+This exports a class for dealing with file-uploads in SmileID's web components
+
+## Usage
+
+Suppose you have an file input field
+
+```html
+<input
+  type="file"
+  id="upload-photo"
+  name="document"
+  accept="image/png, image/jpeg"
+/>
+```
+
+```javascript
+// get the element
+const uploadDocumentPhotoButton = document.getElementById('upload-photo');
+// add a change event listener
+uploadDocumentPhotoButton.addEventListener('change', async (event) => {
+  try {
+    const { files } = event.target;
+
+    // validate file, and convert file to data url
+    // returns the data url for the first file
+    const fileData = await SmartFileUpload.retrieve(files);
+
+    // use the data url
+  } catch (error) {
+    // handle error
+  }
+});
+```

package/lib/domain/file-upload/src/SmartFileUpload.js

@@ -1,65 +1,65 @@
-class SmartFileUpload {
-  static memoryLimit = 10240000;
-
-  static supportedTypes = ['image/jpeg', 'image/png'];
-
-  static getHumanSize(numberOfBytes) {
-    // Approximate to the closest prefixed unit
-    const units = ['B', 'kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
-    const exponent = Math.min(
-      Math.floor(Math.log(numberOfBytes) / Math.log(1024)),
-      units.length - 1,
-    );
-    const approx = numberOfBytes / 1024 ** exponent;
-    const output =
-      exponent === 0
-        ? `${numberOfBytes} bytes`
-        : `${approx.toFixed(0)} ${units[exponent]}`;
-
-    return output;
-  }
-
-  static getData(file) {
-    return new Promise((resolve, reject) => {
-      const reader = new FileReader();
-
-      reader.onload = (e) => {
-        resolve(e.target.result);
-      };
-      reader.onerror = () => {
-        reject(
-          new Error(
-            'An error occurred reading the file. Please check the file, and try again',
-          ),
-        );
-      };
-      reader.readAsDataURL(file);
-    });
-  }
-
-  static async retrieve(files) {
-    if (files.length > 1) {
-      throw new Error('Only one file upload is permitted at a time');
-    }
-
-    const file = files[0];
-
-    if (!SmartFileUpload.supportedTypes.includes(file.type)) {
-      throw new Error(
-        'Unsupported file format. Please ensure that you are providing a JPG or PNG image',
-      );
-    }
-
-    if (file.size > SmartFileUpload.memoryLimit) {
-      throw new Error(
-        `${file.name} is too large. Please ensure that the file is less than ${SmartFileUpload.getHumanSize(SmartFileUpload.memoryLimit)}.`,
-      );
-    }
-
-    const imageAsDataUrl = await SmartFileUpload.getData(file);
-
-    return imageAsDataUrl;
-  }
-}
-
-export default SmartFileUpload;
+class SmartFileUpload {
+  static memoryLimit = 10240000;
+
+  static supportedTypes = ['image/jpeg', 'image/png'];
+
+  static getHumanSize(numberOfBytes) {
+    // Approximate to the closest prefixed unit
+    const units = ['B', 'kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
+    const exponent = Math.min(
+      Math.floor(Math.log(numberOfBytes) / Math.log(1024)),
+      units.length - 1,
+    );
+    const approx = numberOfBytes / 1024 ** exponent;
+    const output =
+      exponent === 0
+        ? `${numberOfBytes} bytes`
+        : `${approx.toFixed(0)} ${units[exponent]}`;
+
+    return output;
+  }
+
+  static getData(file) {
+    return new Promise((resolve, reject) => {
+      const reader = new FileReader();
+
+      reader.onload = (e) => {
+        resolve(e.target.result);
+      };
+      reader.onerror = () => {
+        reject(
+          new Error(
+            'An error occurred reading the file. Please check the file, and try again',
+          ),
+        );
+      };
+      reader.readAsDataURL(file);
+    });
+  }
+
+  static async retrieve(files) {
+    if (files.length > 1) {
+      throw new Error('Only one file upload is permitted at a time');
+    }
+
+    const file = files[0];
+
+    if (!SmartFileUpload.supportedTypes.includes(file.type)) {
+      throw new Error(
+        'Unsupported file format. Please ensure that you are providing a JPG or PNG image',
+      );
+    }
+
+    if (file.size > SmartFileUpload.memoryLimit) {
+      throw new Error(
+        `${file.name} is too large. Please ensure that the file is less than ${SmartFileUpload.getHumanSize(SmartFileUpload.memoryLimit)}.`,
+      );
+    }
+
+    const imageAsDataUrl = await SmartFileUpload.getData(file);
+
+    return imageAsDataUrl;
+  }
+}
+
+export default SmartFileUpload;

package/lib/styles/README.md

@@ -1,3 +1,3 @@
-# @smileid/styles
-
-This is a package that contains global styles exported as a string to be used in composing CSS in Web Components and anywhere else
+# @smileid/styles
+
+This is a package that contains global styles exported as a string to be used in composing CSS in Web Components and anywhere else