verant_id_cloud_scan 1.4.5-beta.2 → 1.4.5-beta.4

package/Api.js

@@ -40,7 +40,7 @@ const licenseServerAddress = env === 'staging'
   : "https://lic.verantid.com/api/v1";
 
 const dmvServerAddress = env === 'staging'
-  ? "https://dmv-staging.verantid.com/api/v1/dmv_check"
+  ? "https://dmv-check-server-staging-fcaab48bec21.herokuapp.com/api/v1/dmv_check"
   : "https://dmv.verantid.com/api/v1/dmv_check";
 
 export const dmvCheck = async (clientId, scannerType, licenseData) => {
@@ -296,6 +296,9 @@ const postToScannerApi = async (
     formattedAddress = `http://${scannerAddress}`;
   }
 
+  // Remove trailing slash to prevent double slashes in URL
+  formattedAddress = formattedAddress.replace(/\/+$/, '');
+
   let apiAddress = `${formattedAddress}/securelink`;
 
   const controller = new AbortController();

package/CloudScan.js

@@ -175,7 +175,7 @@ export const scanId = async (
       console.log('[AUTO-DMV] Feature enabled, showing verification modal');
 
       // Determine scanner type - you can customize this based on your needs
-      const scannerType = 'DigitalCheck'; // Default scanner type
+      const scannerType = scannerResponseObj.scannerProfile || 'DigitalCheck'; // Default scanner type
 
       // Create and open the modal
       const modal = new VerificationModal(clientId, scannerType, barcodeResultsObject, {

package/LocalApi.js

@@ -1,3 +1,10 @@
+// Helper function to build consistent scanner API URLs
+const buildScannerApiUrl = (scannerAddress, endpoint) => {
+  // Remove trailing slash to prevent double slashes in URL
+  const formattedAddress = scannerAddress.replace(/\/+$/, '');
+  return `${formattedAddress}/ambirscanwebconnect/${endpoint}`;
+};
+
 // Helper function for making POST requests to the scanner API
 const callScannerApi = async (
   requestType,
@@ -5,12 +12,7 @@ const callScannerApi = async (
   endpoint,
   bodyObj
 ) => {
-  let apiAddress = "";
-  if (scannerAddress === "https://demo6425275.mockable.io") {
-    apiAddress = `${scannerAddress}/ambirscanwebconnect/${endpoint}`;
-  } else {
-    apiAddress = `${scannerAddress}/ambirscanwebconnect/${endpoint}`;
-  }
+  const apiAddress = buildScannerApiUrl(scannerAddress, endpoint);
 
   const response = await fetch(apiAddress, {
     method: requestType,
@@ -35,9 +37,7 @@ export const getScannerSerialNumber = (scannerAddress) =>
   callScannerApi("POST", scannerAddress, "getserialnumber", null);
 
 export const isFeederLoaded = async (scannerAddress) => {
-  let apiAddress = "";
-
-  apiAddress = `${scannerAddress}/ambirscanwebconnect/isfeederloaded`;
+  const apiAddress = buildScannerApiUrl(scannerAddress, "isfeederloaded");
 
   const response = await fetch(apiAddress, {
     method: "POST",
@@ -45,15 +45,13 @@ export const isFeederLoaded = async (scannerAddress) => {
     body: null,
   });
   if (!response.ok) throw new Error(response.statusText);
-  let responseText = response.text();
+  let responseText = await response.text();
 
   return responseText;
 };
 
 export const setBackScanParameters = async (scannerAddress) => {
-  let apiAddress = "";
-
-  apiAddress = `${scannerAddress}/ambirscanwebconnect/setscanparameters`;
+  const apiAddress = buildScannerApiUrl(scannerAddress, "setscanparameters");
 
   const response = await fetch(apiAddress, {
     method: "POST",
@@ -63,14 +61,12 @@ export const setBackScanParameters = async (scannerAddress) => {
     body: "settings%5BDPI%5D=400&settings%5BAutoCrop%5D=true&settings%5BAutoDeskew%5D=true&settings%5BPaperSize%5D=NONE&settings%5BAutoRotate%5D=true&settings%5BDuplex%5D=false&settings%5BColor%5D=Color",
   });
   if (!response.ok) throw new Error(response.statusText);
-  let responseText = response.text();
+  let responseText = await response.text();
 
   return responseText;
 };
 export const setFrontScanParameters = async (scannerAddress) => {
-  let apiAddress = "";
-
-  apiAddress = `${scannerAddress}/ambirscanwebconnect/setscanparameters`;
+  const apiAddress = buildScannerApiUrl(scannerAddress, "setscanparameters");
 
   const response = await fetch(apiAddress, {
     method: "POST",
@@ -80,7 +76,7 @@ export const setFrontScanParameters = async (scannerAddress) => {
     body: "settings%5BDPI%5D=400&settings%5BAutoCrop%5D=true&settings%5BAutoDeskew%5D=true&settings%5BPaperSize%5D=NONE&settings%5BAutoRotate%5D=true&settings%5BDuplex%5D=false&settings%5BColor%5D=Color",
   });
   if (!response.ok) throw new Error(response.statusText);
-  let responseText = response.text();
+  let responseText = await response.text();
 
   return responseText;
 };
@@ -91,9 +87,7 @@ export const getImageCount = (scannerAddress) =>
   callScannerApi("GET", scannerAddress, "getimagecount", null);
 
 export const getImage = async (scannerAddress, imageIndex) => {
-  let apiAddress = "";
-
-  apiAddress = `${scannerAddress}/ambirscanwebconnect/getimage/` + imageIndex;
+  const apiAddress = buildScannerApiUrl(scannerAddress, `getimage/${imageIndex}`);
 
   const response = await fetch(apiAddress, {
     method: "POST",
@@ -101,7 +95,7 @@ export const getImage = async (scannerAddress, imageIndex) => {
     body: null,
   });
   if (!response.ok) throw new Error(response.statusText);
-  let responseText = response.text();
+  let responseText = await response.text();
 
   return responseText;
 };

package/ScannerApi.js

@@ -1,4 +1,5 @@
 import * as API from "./Api.js";
+import { getProfile } from "./ScannerProfiles.js";
 
 let errorMessages = [];
 let selectedScannerAddress = "";
@@ -63,6 +64,23 @@ export async function scannerChain(
   let licenseFrontBase64 = "";
   let licenseBackBase64 = "";
 
+  // Get scanner profile
+  const profileName = optionalConnectionParams?.scannerProfile;
+  let profile;
+  try {
+    profile = getProfile(profileName);
+  } catch (e) {
+    const message =
+      e && typeof e.message === "string"
+        ? e.message
+        : `Failed to resolve scanner profile${profileName ? ` "${profileName}"` : ""}`;
+    buildError(message);
+    return {
+      success: false,
+      errorMessages,
+    };
+  }
+
   //1 open connection and set the session id
   const currentSessionId = await openConnection(optConnectionParams);
   if (!currentSessionId) {
@@ -85,40 +103,49 @@ export async function scannerChain(
     };
   }
 
-  //check the license for this scanner's mac address
-  if (!existingParams.ScannerMAC) {
-    closeScannerConnection(currentSessionId); // Even if scanning has errors, always attempt to close the connection
+  //check the license for this scanner's identifier (MAC or Serial)
+  const identifierField = profile.licenseIdentifierField;
+  const fallbackField = profile.licenseIdentifierFallback;
+  let scannerIdentifier = existingParams[identifierField];
+
+  // Fall back to alternate field if primary is missing
+  if (!scannerIdentifier && fallbackField) {
+    scannerIdentifier = existingParams[fallbackField];
+  }
+
+  if (!scannerIdentifier) {
+    buildError(
+      `Error: Missing scanner identifier. Tried ${identifierField}${fallbackField ? ` and ${fallbackField}` : ""}`
+    );
+    await closeScannerConnection(currentSessionId); // Even if scanning has errors, always attempt to close the connection
     return {
       success: false,
       errorMessages,
     };
-  } else {
-    // Check the license
-    try {
-      const isValid = await API.checkLicense(
-        clientId,
-        existingParams.ScannerMAC
-      );
-
-      if (isValid) {
-        // continue
-      } else {
-        buildError("Error: License error!");
-        closeScannerConnection(currentSessionId); // Even if scanning has errors, always attempt to close the connection
-        return {
-          success: false,
-          errorMessages,
-        };
-      }
-    } catch (error) {
-      buildError(" Error: " + error.message);
-      console.error("An error occurred:", error.message);
-      closeScannerConnection(currentSessionId); // Even if scanning has errors, always attempt to close the connection
+  }
+
+  // Check the license
+  try {
+    const isValid = await API.checkLicense(clientId, scannerIdentifier);
+
+    if (isValid) {
+      // continue
+    } else {
+      buildError("Error: License error!");
+      await closeScannerConnection(currentSessionId); // Even if scanning has errors, always attempt to close the connection
       return {
         success: false,
         errorMessages,
       };
     }
+  } catch (error) {
+    buildError("Error: " + error.message);
+    console.error("An error occurred:", error.message);
+    await closeScannerConnection(currentSessionId); // Even if scanning has errors, always attempt to close the connection
+    return {
+      success: false,
+      errorMessages,
+    };
   }
 
   //3 clear the params for this session
@@ -134,6 +161,7 @@ export async function scannerChain(
   //4 set the params for this session
   const setParamsSuccess = await setScanParameters(
     currentSessionId,
+    profile,
     optScannerParams
   );
   if (!setParamsSuccess) {
@@ -150,7 +178,7 @@ export async function scannerChain(
     scanDataResults: resultData,
     licenseFrontBase64: frontBase64,
     licenseBackBase64: backBase64,
-  } = await startScanDocument(currentSessionId, optGetDocumentParams);
+  } = await startScanDocument(currentSessionId, profile, optGetDocumentParams);
 
   scanDataResults = resultData;
   licenseFrontBase64 = frontBase64;
@@ -165,24 +193,12 @@ export async function scannerChain(
   }
 
   //6 set the params we changed back to what they were
-  let setParamsBack = {
-    FeedType: existingParams.FeedType,
-    FeedSource: existingParams.FeedSource,
-    fclrEnabled: existingParams.fclrEnabled,
-    fclrResolution: existingParams.fclrResolution,
-    rclrEnabled: existingParams.rclrEnabled,
-    rclrResolution: existingParams.rclrResolution,
-    fgsEnabled: existingParams.fgsEnabled,
-    fgsResolution: existingParams.fgsResolution,
-    rgsEnabled: existingParams.rgsEnabled,
-    rgsResolution: existingParams.rgsResolution,
-    fbwEnabled: existingParams.fbwEnabled,
-    fbwResolution: existingParams.fbwResolution,
-    rbwEnabled: existingParams.rbwEnabled,
-    rbwResolution: existingParams.rbwResolution,
-    rbwThreshold: existingParams.rbwThreshold,
-    rclrCompressionQuality: existingParams.rclrCompressionQuality,
-  };
+  let setParamsBack = {};
+  profile.restoreParamKeys.forEach((key) => {
+    if (existingParams[key] !== undefined) {
+      setParamsBack[key] = existingParams[key];
+    }
+  });
   console.log("Setting Params Back to:", setParamsBack);
 
   const setParamsBackSuccess = await setScanParametersBack(
@@ -205,6 +221,7 @@ export async function scannerChain(
     scanDataResults,
     licenseFrontBase64: licenseFrontBase64,
     licenseBackBase64: licenseBackBase64,
+    scannerProfile: profileName,
     errorMessages,
   };
 }
@@ -231,6 +248,9 @@ async function makeApiCall(endpointFunction, commandObj, scannerAddress) {
 
 // step 1 - start connection
 async function openConnection(optConnectionParams) {
+  // Strip out client-only fields that shouldn't be sent to the scanner
+  const { scannerProfile, ...connectionParams } = optConnectionParams || {};
+
   let establishConnectionObj = {
     Command: "Connect",
     MessageId: "",
@@ -241,15 +261,48 @@ async function openConnection(optConnectionParams) {
   //if passed in connection params use them on the object
   establishConnectionObj = {
     ...establishConnectionObj,
-    ...optConnectionParams,
+    ...connectionParams,
   };
   establishConnectionObj.MessageId = getMessageId();
-  const responseData = await makeApiCall(
-    API.establishConnection,
-    establishConnectionObj,
-    selectedScannerAddress
-  );
-  return responseData ? responseData.SessionId : "";
+
+  // Call the API directly to get the raw response (not filtered by makeApiCall)
+  try {
+    const res = await API.establishConnection(
+      selectedScannerAddress,
+      establishConnectionObj
+    );
+
+    // If there's an error, check if we still got a SessionId that needs cleanup
+    if (res && res.ErrorInformation !== "OK" && res.ErrorInformation) {
+      buildError("Connect Error: " + res.ErrorInformation);
+
+      // If scanner returned a SessionId even with error, disconnect it
+      if (res.SessionId) {
+        let disconnectObj = {
+          Command: "Disconnect",
+          MessageId: getMessageId(),
+          SessionId: res.SessionId,
+        };
+        try {
+          await API.closeConnection(selectedScannerAddress, disconnectObj);
+        } catch (disconnectError) {
+          // Log cleanup/Disconnect failure separately so it doesn't mask the original connect error
+          buildError(
+            "Disconnect Error during Connect cleanup: " +
+              (disconnectError.message || disconnectError)
+          );
+        }
+      }
+
+      return "";
+    }
+
+    return res ? res.SessionId : "";
+  } catch (error) {
+    const errorMessage = error?.message ?? String(error);
+    buildError("Connect Error: " + errorMessage);
+    return "";
+  }
 }
 
 // step 2 - get parameters
@@ -287,32 +340,17 @@ async function resetScanParameters(currentSessionId) {
 }
 
 // step 4 - set parameters
-async function setScanParameters(currentSessionId, optScannerParams) {
+async function setScanParameters(currentSessionId, profile, optScannerParams) {
   let newSetParamsObj = {
     Command: "SetParameters",
     MessageId: getMessageId(),
     SessionId: currentSessionId,
     Params: {
-      FeedType: "single",
-      FeedSource: "id",
-      fbwResolution: "300dpi",
-      fclrResolution: "300dpi",
-      rbwResolution: "300dpi",
-      rclrResolution: "300dpi",
-      rclrCompressionQuality: "100",
-      rbwThreshold: "95",
-      fclrEnabled: "true",
-      rgsEnabled: "false",
-      rbwEnabled: "false",
-      rclrEnabled: "true",
+      ...profile.defaultParams,
+      ...optScannerParams,
     },
   };
 
-  //use the optionally passed in scanner params if any
-  newSetParamsObj.Params = {
-    ...newSetParamsObj.Params,
-    ...optScannerParams,
-  };
   console.log("Setting Params for ID Scan to:", newSetParamsObj.Params);
   const responseData = await makeApiCall(
     API.setParameters,
@@ -323,7 +361,11 @@ async function setScanParameters(currentSessionId, optScannerParams) {
 }
 
 // step 5 - scan document
-async function startScanDocument(currentSessionId, optGetDocumentParams) {
+async function startScanDocument(
+  currentSessionId,
+  profile,
+  optGetDocumentParams
+) {
   let scanDocumentObj = {
     Command: "GetDocument",
     MessageId: getMessageId(),
@@ -351,12 +393,12 @@ async function startScanDocument(currentSessionId, optGetDocumentParams) {
 
     const images = responseData.Images || [];
 
-    // Check and set image data
+    // Check and set image data using profile-defined image types
     images.forEach((element) => {
-      if (element["ImageType"] === "fclr") {
+      if (element["ImageType"] === profile.frontImageType) {
         licenseFrontBase64 = element["data"];
       }
-      if (element["ImageType"] === "rclr") {
+      if (element["ImageType"] === profile.backImageType) {
         licenseBackBase64 = element["data"];
       }
     });

package/ScannerProfiles.js

@@ -0,0 +1,118 @@
+// Scanner profile configurations for different scanner models
+
+const PROFILES = {
+  DigitalCheck: {
+    defaultParams: {
+      FeedType: "single",
+      FeedSource: "id",
+      fbwResolution: "300dpi",
+      fclrResolution: "300dpi",
+      rbwResolution: "300dpi",
+      rclrResolution: "300dpi",
+      rclrCompressionQuality: "100",
+      rbwThreshold: "95",
+      fclrEnabled: "true",
+      rgsEnabled: "false",
+      rbwEnabled: "false",
+      rclrEnabled: "true",
+    },
+    restoreParamKeys: [
+      "FeedType",
+      "FeedSource",
+      "fclrEnabled",
+      "fclrResolution",
+      "rclrEnabled",
+      "rclrResolution",
+      "fgsEnabled",
+      "fgsResolution",
+      "rgsEnabled",
+      "rgsResolution",
+      "fbwEnabled",
+      "fbwResolution",
+      "rbwEnabled",
+      "rbwResolution",
+      "rbwThreshold",
+      "rclrCompressionQuality",
+    ],
+    frontImageType: "fclr",
+    backImageType: "rclr",
+    licenseIdentifierField: "ScannerMAC",
+    licenseIdentifierFallback: "ScannerSerial",
+  },
+
+  IDXpress: {
+    defaultParams: {
+      FeedType: "single",
+      FeedSource: "id",
+      fclrResolution: "600dpi",
+      rclrResolution: "600dpi",
+      rclrCompressionQuality: "100",
+      fclrEnabled: "true",
+      rgsEnabled: "false",
+      rclrEnabled: "true",
+    },
+    restoreParamKeys: [
+      "FeedType",
+      "FeedSource",
+      "fclrEnabled",
+      "fclrResolution",
+      "rclrEnabled",
+      "rclrResolution",
+      "fgsEnabled",
+      "fgsResolution",
+      "rgsEnabled",
+      "rgsResolution",
+      "rclrCompressionQuality",
+    ],
+    frontImageType: "fclr",
+    backImageType: "rclr",
+    licenseIdentifierField: "ScannerMAC",
+    licenseIdentifierFallback: "ScannerSerial",
+  },
+
+  IDXpressPlus: {
+    defaultParams: {
+      FeedType: "single",
+      FeedSource: "id",
+      fclrResolution: "600dpi",
+      rclrResolution: "600dpi",
+      rclrCompressionQuality: "100",
+      fclrEnabled: "true",
+      rgsEnabled: "false",
+      rclrEnabled: "true",
+    },
+    restoreParamKeys: [
+      "FeedType",
+      "FeedSource",
+      "fclrEnabled",
+      "fclrResolution",
+      "rclrEnabled",
+      "rclrResolution",
+      "fgsEnabled",
+      "fgsResolution",
+      "rgsEnabled",
+      "rgsResolution",
+      "rclrCompressionQuality",
+    ],
+    frontImageType: "fclr",
+    backImageType: "rclr",
+    licenseIdentifierField: "ScannerMAC",
+    licenseIdentifierFallback: "ScannerSerial",
+  },
+};
+
+export function getProfile(profileName) {
+  if (!profileName) {
+    return PROFILES.DigitalCheck; // Default to DigitalCheck for backward compatibility
+  }
+
+  // Use own-property check to prevent prototype pollution attacks
+  const hasOwn =
+    typeof Object.hasOwn === "function"
+      ? Object.hasOwn(PROFILES, profileName)
+      : Object.prototype.hasOwnProperty.call(PROFILES, profileName);
+  if (!hasOwn) {
+    throw new Error(`Unknown scanner profile: ${profileName}`);
+  }
+  return PROFILES[profileName];
+}

package/index.d.ts

@@ -29,11 +29,16 @@ declare module "verant_id_cloud_scan" {
     dmvVerificationResult?: any;
   }>;
 
+  export interface OptionalConnectionParams {
+    scannerProfile?: "DigitalCheck" | "IDXpress" | "IDXpressPlus";
+    [key: string]: any;
+  }
+
   export function scanId(
     scannerAddress: string,
     includeData: boolean,
     clientId: string,
-    optionalConnectionParams?: any,
+    optionalConnectionParams?: OptionalConnectionParams,
     optionalScannerParams?: any,
     optionalGetDocumentParams?: any,
   ): Promise<{
@@ -47,7 +52,15 @@ declare module "verant_id_cloud_scan" {
   export function localScanId(
     scannerAddress: string,
     clientId: string,
-  ): Promise<boolean>;
+  ): Promise<
+    | boolean
+    | {
+        barcodeResultsObject: any;
+        licenseFrontBase64: string;
+        licenseBackBase64: string;
+        errorMessages: string;
+      }
+  >;
 
   export function localContinueScanId(
     scannerAddress: string,

package/package.json

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