Add Images

Author: hleb-albau

.eslintrc

@@ -11,6 +11,7 @@
     "plugin:@typescript-eslint/recommended"
   ],
   "rules": {
-    "unused-imports/no-unused-imports": "error"
+    "unused-imports/no-unused-imports": "error",
+    "@typescript-eslint/ban-ts-comment": "off"
   }
 }

.gitignore

@@ -2,4 +2,6 @@ wwwroot/*.js
 node_modules
 typings
 dist
-.idea
+.idea
+/example/portraitFromVisual.jpg
+/example/normalizedInputImage.jpg

example/index.js

@@ -1,6 +1,15 @@
 import * as fs from 'fs';
 
-import {DocumentReaderApi, Scenario, Result, TextFieldType, Source} from '@regulaforensics/document-reader-client/esm';
+import {
+  DocumentReaderApi,
+  Result,
+  Scenario,
+  Source,
+  TextFieldType,
+  GraphicFieldType
+} from '@regulaforensics/document-reader-client/esm';
+
+const {PORTRAIT} = GraphicFieldType;
 const {DOCUMENT_NUMBER} = TextFieldType;
 
 
@@ -17,20 +26,28 @@ const {DOCUMENT_NUMBER} = TextFieldType;
     images: [raw_image],
     processParam: {
       scenario: Scenario.FULL_PROCESS,
-      resultTypeOutput: [Result.STATUS, Result.TEXT, Result.LEXICAL_ANALYSIS]
+      resultTypeOutput: [Result.RAW_IMAGE, Result.STATUS, Result.TEXT, Result.IMAGES]
     }
   })
 
   const docOverallStatus = response.status.complete;
   const docOpticalTextStatus = response.status.detailsOptical.text;
 
+  // text fields example
   const docNumberField = response.text.getField(DOCUMENT_NUMBER);
   const docNumberVisual = docNumberField.getValue(Source.VISUAL)
   const docNumberMrz = docNumberField.getValue(Source.MRZ)
   const docNumberVisualValidity = docNumberField.sourceValidity(Source.VISUAL)
   const docNumberMrzValidity = docNumberField.sourceValidity(Source.MRZ)
   const docNumberMrzVisualMatching = docNumberField.crossSourceComparison(Source.MRZ, Source.VISUAL)
 
+  // images example
+  const normalizedInputImage = response.images.getNormalizedInputImage()
+  const portraitField = response.images.getField(PORTRAIT)
+  const portraitFromVisual = portraitField.getValue(Source.VISUAL)
+  fs.appendFileSync('portraitFromVisual.jpg', Buffer.from(portraitFromVisual));
+  fs.appendFileSync('normalizedInputImage.jpg', Buffer.from(normalizedInputImage));
+
   console.log("-----------------------------------------------------------------")
   console.log(`           Document Overall Status: ${docOverallStatus}`)
   console.log(`            Document Number Visual: ${docNumberVisual}`)

src/ext/document-reader.ts

@@ -8,6 +8,7 @@ import {ProcessRequestImage as ProcessRequestImageBase} from "../models/index.js
 import {ProcessRequest} from "./process-request.js";
 import {ProcessRequestImage} from "./process-request-image.js";
 
+// @ts-ignore
 import converter from "base64-arraybuffer";
 
 

src/ext/images.ts

@@ -0,0 +1,72 @@
+import {
+  GraphicFieldType,
+  Images as BaseImages,
+  ImagesField as BaseImagesField,
+  ImagesAvailableSource, ImagesFieldValue, Source, RawImageResult,
+} from "../models/index.js";
+
+// @ts-ignore
+import converter from "base64-arraybuffer";
+
+export class Images implements BaseImages {
+
+  availableSourceList: Array<ImagesAvailableSource>;
+  fieldList: Array<ImagesField>;
+  normalizedInputImages: Array<RawImageResult>;
+
+  constructor(origin: BaseImages, normalizedInputImages: Array<RawImageResult>) {
+    this.normalizedInputImages = normalizedInputImages;
+    this.availableSourceList = origin.availableSourceList
+    this.fieldList = origin.fieldList.map(field => new ImagesField(field))
+  }
+
+  public getField(type: GraphicFieldType): ImagesField | undefined {
+    return this.fieldList.find(field => field.fieldType == type)
+  }
+
+  public getNormalizedInputImage(page = 0): ArrayBuffer | undefined {
+    const imageAsBase64 = this.normalizedInputImages.find(i=>i.page_idx==page)?.RawImageContainer?.image
+    if(imageAsBase64) {
+      return base64ToBuffer(imageAsBase64)
+    }
+    return undefined
+  }
+}
+
+export class ImagesField implements BaseImagesField {
+
+  fieldName: string;
+  fieldType: GraphicFieldType;
+  valueList: Array<ImagesFieldValue>;
+
+  constructor(origin: BaseImagesField) {
+    this.fieldType = origin.fieldType
+    this.fieldType = origin.fieldType
+    this.valueList = origin.valueList
+  }
+
+  public getValue(source?: Source, original = false): ArrayBuffer | undefined {
+    let fieldValue
+    if (!source) {
+      // rfid -> visual -> barcode
+      fieldValue = this.valueList.find(v => v.source == Source.RFID)
+        || this.valueList.find(v => v.source == Source.VISUAL)
+        || this.valueList.find(v => v.source == Source.BARCODE)
+    } else {
+      fieldValue = this.valueList.find(v => v.source == source)
+    }
+
+    if (!fieldValue) {
+      return undefined
+    }
+
+    if (original) {
+      return base64ToBuffer(fieldValue.originalValue)
+    }
+    return base64ToBuffer(fieldValue.value)
+  }
+}
+
+function base64ToBuffer(str: string): ArrayBuffer {
+  return converter.decode(str);
+}

src/ext/index.ts

@@ -4,4 +4,5 @@ export * from './process-request-image.js';
 export * from './process-response.js';
 export * from './result-item.js';
 export * from './text.js';
+export * from './images.js';
 export * from './text-field.js';

src/ext/process-response.ts

@@ -1,64 +1,81 @@
 import {
-    ContainerList,
-    ProcessingStatus,
-    ProcessResponse,
-    Result,
-    ResultItem,
-    RfidLocation, Status, StatusResult,
-    TextResult,
-    TransactionInfo
+  ContainerList, ImagesResult,
+  ProcessingStatus,
+  ProcessResponse, RawImageResult,
+  Result,
+  ResultItem,
+  RfidLocation, Status, StatusResult,
+  TextResult,
+  TransactionInfo
 } from "../models/index.js";
 import {Text} from "./text.js";
+import {Images} from "./images.js";
 
 
 export class Response {
 
-    // other modules:
-    // - images
-    // - status
-    // - authenticity
-    // - document
-    status?: Status
-    text?: Text
+  // other future modules:
+  // - authenticity
+  // - document
+  status?: Status
+  text?: Text
+  images?: Images
 
-    lowLvlResponse: LowLvlResponse
+  lowLvlResponse: LowLvlResponse
 
-    constructor(original: ProcessResponse) {
+  constructor(original: ProcessResponse) {
 
-        const lowLvlResponse = new LowLvlResponse(original)
-        this.lowLvlResponse = lowLvlResponse
+    const lowLvlResponse = new LowLvlResponse(original)
+    this.lowLvlResponse = lowLvlResponse
 
-        const textResult = lowLvlResponse.textResult()
-        if (textResult) {
-            this.text = new Text(textResult.Text)
-        }
-        this.status = lowLvlResponse.statusResult()?.Status
+    this.status = lowLvlResponse.statusResult()?.Status
+    const textResult = lowLvlResponse.textResult()
+    if (textResult) {
+      this.text = new Text(textResult.Text)
     }
+    const imagesResult = lowLvlResponse.imagesResult()
+    if (imagesResult) {
+      this.images = new Images(imagesResult.Images, lowLvlResponse.normalizedInputImages())
+    }
+  }
 }
 
 export class LowLvlResponse implements ProcessResponse {
 
-    ContainerList: ContainerList
-    ProcessingFinished: ProcessingStatus
-    TransactionInfo: TransactionInfo
-    ChipPage: RfidLocation
+  ContainerList: ContainerList
+  ProcessingFinished: ProcessingStatus
+  TransactionInfo: TransactionInfo
+  ChipPage: RfidLocation
 
-    constructor(original: ProcessResponse) {
-        this.ContainerList = original.ContainerList
-        this.ProcessingFinished = original.ProcessingFinished
-        this.TransactionInfo = original.TransactionInfo
-        this.ChipPage = original.ChipPage
-    }
+  constructor(original: ProcessResponse) {
+    this.ContainerList = original.ContainerList
+    this.ProcessingFinished = original.ProcessingFinished
+    this.TransactionInfo = original.TransactionInfo
+    this.ChipPage = original.ChipPage
+  }
 
-    public textResult(): TextResult | undefined {
-        return <TextResult>this.resultByType(Result.TEXT)
-    }
+  public normalizedInputImages(): Array<RawImageResult> | undefined {
+    // @ts-ignore
+    return this.resultsByType(Result.RAW_IMAGE)
+  }
 
-    public statusResult(): StatusResult | undefined {
-        return <StatusResult>this.resultByType(Result.STATUS)
-    }
+  public statusResult(): StatusResult | undefined {
+    return <StatusResult>this.resultByType(Result.STATUS)
+  }
 
-    public resultByType(type: Result): ResultItem | undefined {
-        return this.ContainerList.List.find(container => container.result_type === type)
-    }
+  public textResult(): TextResult | undefined {
+    return <TextResult>this.resultByType(Result.TEXT)
+  }
+
+  public imagesResult(): ImagesResult | undefined {
+    return <ImagesResult>this.resultByType(Result.IMAGES)
+  }
+
+  public resultByType(type: Result): ResultItem | undefined {
+    return this.ContainerList.List.find(container => container.result_type === type)
+  }
+
+  public resultsByType(type: Result): Array<ResultItem> | undefined {
+    return this.ContainerList.List.filter(container => container.result_type === type)
+  }
 }