verant_id_cloud_scan 1.4.2 → 1.4.4-beta.0

package/.claude/settings.local.json

@@ -0,0 +1,9 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(git add:*)"
+    ],
+    "deny": [],
+    "ask": []
+  }
+}

package/.github/workflows/publish_library.yml

@@ -0,0 +1,27 @@
+# .github/workflows/publish.yml
+name: Publish to npm
+on:
+  push:
+    tags:
+      - "v*.*.*"
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write 
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+      
+      - name: Use Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          registry-url: "https://registry.npmjs.org"
+
+      - name: Update npm
+        run: npm install -g npm@latest
+        
+      - name: Publish to npm
+        run: npm publish

package/Api.js

@@ -1,5 +1,3 @@
-import { compressAndCompareImages } from "./FaceComparison.js";
-
 //prod
 const licenseServerAddress = "https://lic.verantid.com/api/v1";
 const dmvServerAddress = "https://dmv.verantid.com/api/v1/dmv_check";
@@ -7,7 +5,7 @@ const dmvServerAddress = "https://dmv.verantid.com/api/v1/dmv_check";
 // const licenseServerAddress =
 //   "https://verant-license-server-staging-52b03b060a98.herokuapp.com/api/v1";
 // const dmvServerAddress =
-//   "https://dmv-check-server-staging-fcaab48bec21.herokuapp.com/api/v1/dmv_check"; // Replace with staging or production URL
+//   "https://dmv-check-server-staging-fcaab48bec21.herokuapp.com/api/v1/dmv_check";
 
 // Helper function that checks multiple possible keys and returns a non-empty value
 const getLicenseFieldValue = (data, possibleKeys) => {
@@ -286,7 +284,13 @@ const postToScannerApi = async (
   commandObj,
   timeout = 10000
 ) => {
-  let apiAddress =`${scannerAddress}/securelink`;
+  // Ensure the scanner address has a protocol (http:// or https://)
+  let formattedAddress = scannerAddress;
+  if (!scannerAddress.startsWith('http://') && !scannerAddress.startsWith('https://')) {
+    formattedAddress = `http://${scannerAddress}`;
+  }
+
+  let apiAddress = `${formattedAddress}/securelink`;
 
   const controller = new AbortController();
   const signal = controller.signal;
@@ -337,4 +341,42 @@ export const stopScanning = (scannerAddress, commandObj) =>
   postToScannerApi(scannerAddress, commandObj);
 
 export const closeConnection = (scannerAddress, commandObj) =>
-  postToScannerApi(scannerAddress, commandObj);
+  postToScannerApi(scannerAddress, commandObj);
+
+// Check if scanner is present by attempting to connect and disconnect
+export const checkScannerPresent = async (scannerAddress) => {
+  try {
+    // Generate a unique message ID for this check
+    const messageId = new Date().toISOString();
+
+    // Attempt to establish connection
+    const connectCommand = {
+      Command: "Connect",
+      MessageId: messageId,
+      Exclusive: "false", // Use non-exclusive mode for just checking
+      IdleTimeout: "5",
+    };
+
+    const connectResponse = await postToScannerApi(scannerAddress, connectCommand, 5000);
+
+    // If connection failed or no session ID, scanner not present
+    if (!connectResponse || !connectResponse.SessionId) {
+      return false;
+    }
+
+    // Got a session ID, now disconnect
+    const disconnectCommand = {
+      Command: "Disconnect",
+      MessageId: new Date().toISOString(),
+      SessionId: connectResponse.SessionId,
+    };
+
+    await postToScannerApi(scannerAddress, disconnectCommand, 5000);
+
+    // Successfully connected and disconnected
+    return true;
+  } catch (error) {
+    // Any error means scanner is not reachable
+    return false;
+  }
+};

package/CloudScan.js

@@ -4,7 +4,7 @@ import {
   readBarcode,
 } from "./BarcodeScanner.js";
 import { driverLicenseFields } from "./DriverLicenseFields.js";
-import { localScannerChain, scanBack } from "./LocalScannerApi.js";
+import { localScannerChain, scanBack, scanFrontOnly } from "./LocalScannerApi.js";
 import { compressAndCompareImages, compressImage } from "./FaceComparison.js";
 import {
   checkDmvFeatureLicense,
@@ -12,6 +12,7 @@ import {
   dmvCheck,
   getBarcodeLicenseKey,
   scannerChain,
+  scannerPresent,
 } from "./ScannerApi.js";
 
 let cachedLicenseFrontBase64 = "";
@@ -32,6 +33,8 @@ export const checkFaceCompareFeature = async (clientId) => {
   return await checkFaceComparisonFeatureLicense(clientId);
 }
 
+export { scannerPresent };
+
 export async function readImageBarcode(imageFile) {
   let returnObj = {
     barcodeResultsObject: {},
@@ -204,7 +207,7 @@ export const localScanId = async (scannerAddress, clientId) => {
   return true;
 };
 
-export const localContinueScanId = async (scannerAddress, includeData) => {
+export const localContinueScanId = async (scannerAddress, includeData, skipBackScan = false) => {
   let barcodeResultsObject = {};
   let returnObj = {
     barcodeResultsObject,
@@ -217,9 +220,16 @@ export const localContinueScanId = async (scannerAddress, includeData) => {
     scannerAddress = "https://localhost:53051";
   }
 
-  let scannerResponseObj = await scanBack(scannerAddress, includeData);
+  let scannerResponseObj;
 
-  //console.log(scannerResponseObj);
+  if (skipBackScan) {
+    // For facial verification only, skip back scan
+    scannerResponseObj = await scanFrontOnly();
+  }
+  else {
+      scannerResponseObj = await scanBack(scannerAddress, includeData);
+  }
+  
   if (scannerResponseObj.errorMessages.length > 0) {
     returnObj.errorMessages = scannerResponseObj.errorMessages;
     return returnObj;

package/FaceComparison.js

@@ -1,3 +1,9 @@
+//prod
+// const faceComparisonAddress = "https://faceid.verantid.com/compare_id_and_face";
+//staging
+const faceComparisonAddress = "https://staging.face.verantid.bluerocket.us/compare_id_and_face";
+
+
 export async function compressImage(source, maxSize = 2 * 1024 * 1024) {
   async function _shrink(canvas) {
     let quality = 0.95;
@@ -36,7 +42,7 @@ export async function compressImage(source, maxSize = 2 * 1024 * 1024) {
 }
 
 const startComparison = async (commandObj) => {
-  return fetch("https://staging.face.verantid.bluerocket.us/compare_id_and_face", {
+  return fetch(faceComparisonAddress, {
     method: "POST",
     headers: { "Content-Type": "application/json" },
     body: JSON.stringify(commandObj)
@@ -69,14 +75,29 @@ export async function compressAndCompareImages(
 
   const res = await startComparison(imagesObject);
   const data = await res.json();
+
   const confidence = data?.SourceImageFace?.Confidence?.toFixed(2);
   const similarity = data?.FaceMatches?.[0]?.Similarity?.toFixed(2) || 0;
 
-  let range = "Not the same";
+  let range = "No match";
   if (similarity >= 80) range = "Likely match";
   else if (similarity >= 60) range = "Likely not the same";
 
-  return { similarity, confidence, range };
+  const result = {
+    similarity,
+    confidence,
+    range,
+  };
+
+  // Only include error if present
+  if (data?.error || data?.details) {
+    result.error = {
+      error: data?.error,
+      details: data?.details,
+    };
+  }
+
+  return result;
 }
 
 async function base64ToCanvas(src) {

package/LocalScannerApi.js

@@ -189,6 +189,18 @@ export async function localScannerChain(ambirApiAddress, clientId) {
   };
 }
 
+export async function scanFrontOnly() {
+  // Skip the back scan entirely, close the connection
+  await closeScannerConnection();
+  return {
+    success: true,
+    scanDataResults,
+    licenseFrontBase64: licenseFrontBase64,
+    licenseBackBase64: "",
+    errorMessages,
+  };
+}
+
 export async function scanBack() {
   //6a set the back params for this session
   const setParamsSuccess = await setScanParameters(false);

package/ScannerApi.js

@@ -41,6 +41,10 @@ export async function dmvCheck(clientId, scannerType, licenseData) {
   return await API.dmvCheck(clientId, scannerType, licenseData);
 }
 
+export async function scannerPresent(scannerAddress) {
+  return await API.checkScannerPresent(scannerAddress);
+}
+
 //This is the top level function that calls the other functions in order
 export async function scannerChain(
   scannerAddress,

package/index.d.ts

@@ -45,7 +45,8 @@ declare module "verant_id_cloud_scan" {
 
   export function localContinueScanId(
     scannerAddress: string,
-    includeData: boolean
+    includeData: boolean,
+    skipBackScan?: boolean
   ): Promise<{
     barcodeResultsObject: any;
     licenseFrontBase64: string;
@@ -53,3 +54,5 @@ declare module "verant_id_cloud_scan" {
     errorMessages: string;
   }>;
 }
+
+export function scannerPresent(scannerAddress: string): Promise<boolean>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "verant_id_cloud_scan",
-  "version": "1.4.2",
+  "version": "1.4.4-beta.0",
   "description": "Verant ID Cloud Scan NPM Library",
   "main": "CloudScan.js",
   "types": "index.d.ts",