@regulaforensics/document-reader-webclient 6.9.2 → 6.9.3

package/src/ext/process-response.ts

@@ -1,187 +0,0 @@
-import {
-  AuthenticityResult,
-  ContainerList,
-  ImageQualityCheckList,
-  ImageQualityResult,
-  ImagesResult,
-  ProcessingStatus,
-  ProcessResponse,
-  Result,
-  ResultItem,
-  RfidLocation,
-  Status,
-  StatusResult,
-  TextResult,
-  ChosenDocumentTypeResult,
-  DocBarCodeInfo,
-  TransactionInfo, OneCandidate
-} from "../models/index.js";
-import {Text} from "./text.js";
-import {Images} from "./images.js";
-import * as converter from "base64-arraybuffer";
-import {Authenticity} from "./authenticity/authenticity.js";
-import * as pako from 'pako'
-
-export class Response {
-
-  // other future modules:
-  // - authenticity
-  // - document
-  status?: Status
-  text?: Text
-  images?: Images
-
-  lowLvlResponse: LowLvlResponse
-  rawResponse: ProcessResponse
-
-  constructor(original: ProcessResponse) {
-
-    const lowLvlResponse = new LowLvlResponse(original)
-    this.lowLvlResponse = lowLvlResponse
-    this.rawResponse = original
-
-    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)
-    }
-  }
-
-  public authenticity(page_idx = 0): Authenticity | undefined {
-    const r = <AuthenticityResult>this.lowLvlResponse.resultByTypeAndPage(Result.AUTHENTICITY, page_idx)
-    if (r) {
-      return new Authenticity(r.AuthenticityCheckList, page_idx)
-    }
-  }
-
-  public json(): string {
-    return JSON.stringify(this.lowLvlResponse);
-  }
-
-  public authenticityPerPage(): Array<Authenticity> {
-    const filteredByTypeArray = <Array<AuthenticityResult>>this.lowLvlResponse.resultsByType(Result.AUTHENTICITY)
-
-    return filteredByTypeArray
-      .map((e: AuthenticityResult) => new Authenticity(e.AuthenticityCheckList, e.page_idx || 0))
-      .sort((a, b) => a.page_idx - b.page_idx)
-  }
-
-  public imageQualityChecks(page_idx = 0): ImageQualityCheckList | undefined {
-    const result = <ImageQualityResult>this.lowLvlResponse.resultByTypeAndPage(Result.IMAGE_QUALITY, page_idx)
-    if (result) {
-      return result.ImageQualityCheckList;
-    }
-  }
-
-  public imageQualityChecksPerPage(): Array<ImageQualityCheckList> | undefined {
-    return <Array<ImageQualityCheckList>>this.lowLvlResponse.resultsByType(Result.IMAGE_QUALITY)
-  }
-
-  public documentType(page_idx = 0): OneCandidate | undefined {
-    const result = <ChosenDocumentTypeResult>this.lowLvlResponse.resultByTypeAndPage(Result.DOCUMENT_TYPE, page_idx)
-    if (result) {
-      return result.OneCandidate;
-    }
-  }
-
-  public decodedLog(): string | undefined {
-    const log = this.lowLvlResponse.log
-    if (log) {
-      const decoded = converter.decode(log)
-      const uintArray = new Uint8Array(decoded)
-
-      let dataUintArray
-      try {
-        const currentDataUintArray = pako.inflate(uintArray)
-        
-        dataUintArray =
-        currentDataUintArray.length > uintArray.length
-          ? currentDataUintArray
-          : uintArray
-
-      } catch (err) {
-        dataUintArray = uintArray
-      }
-
-      const uintArraySize = dataUintArray.length
-      const step = 10000
-      const result = []
-      const convertedUnitArray = [].slice.call(dataUintArray)
-      // To avoid maximum call stack size excess
-      for (let i = 0; i < uintArraySize; i += step) {
-        const chunk = String.fromCharCode.apply(null, convertedUnitArray.slice(i, i + step))
-        result.push(chunk)
-      }
-      return result.join('')
-    } else {
-      return undefined
-    }
-  }
-}
-
-export class LowLvlResponse implements ProcessResponse {
-
-  ContainerList: ContainerList
-  ProcessingFinished: ProcessingStatus
-  TransactionInfo: TransactionInfo
-  ChipPage?: RfidLocation
-  log?: string
-  passBackObject?: { [key: string]: any; };
-  morePagesAvailable?: number;
-
-  constructor(original: ProcessResponse) {
-    this.ContainerList = original.ContainerList
-    this.ProcessingFinished = original.ProcessingFinished
-    this.TransactionInfo = original.TransactionInfo
-    this.ChipPage = original.ChipPage
-    this.log = original.log
-    this.passBackObject = original.passBackObject
-    this.morePagesAvailable = original.morePagesAvailable
-  }
-
-  public statusResult(): StatusResult | undefined {
-    return <StatusResult>this.resultByType(Result.STATUS)
-  }
-
-  public textResult(): TextResult | undefined {
-    return <TextResult>this.resultByType(Result.TEXT)
-  }
-
-  public imagesResult(): ImagesResult | undefined {
-    return <ImagesResult>this.resultByType(Result.IMAGES)
-  }
-
-  public barcodeResult(): DocBarCodeInfo | undefined {
-    return <DocBarCodeInfo>this.resultByType(Result.BARCODES)
-  }
-
-  public documentTypeResults(): Array<ChosenDocumentTypeResult> | undefined {
-    return <Array<ChosenDocumentTypeResult>>this.resultsByType(Result.DOCUMENT_TYPE)
-  }
-
-  public resultByType(type: Result): ResultItem | undefined {
-    for (const container of this.ContainerList.List) {
-      if (container.result_type === type) {
-        return container
-      }
-    }
-    return undefined
-  }
-
-  public resultByTypeAndPage(type: Result, page_idx = 0): ResultItem | undefined {
-    for (const container of this.ContainerList.List) {
-      if (container.result_type === type && container.page_idx == page_idx) {
-        return container
-      }
-    }
-    return undefined
-  }
-
-  public resultsByType(type: Result): Array<ResultItem | AuthenticityResult | ImageQualityCheckList> {
-    return this.ContainerList.List.filter(container => container.result_type === type)
-  }
-}

package/src/ext/result-item.ts

@@ -1,19 +0,0 @@
-import {ResultItem} from "../models/index.js";
-
-
-export class BaseResultItem implements ResultItem {
-
-    buf_length?: number;
-    light?: number;
-    list_idx?: number;
-    page_idx?: number;
-    result_type: number;
-
-    constructor(item: ResultItem) {
-        this.buf_length = item.buf_length;
-        this.light = item.light;
-        this.list_idx = item.list_idx;
-        this.page_idx = item.page_idx;
-        this.result_type = item.result_type;
-    }
-}

package/src/ext/text-field.ts

@@ -1,250 +0,0 @@
-import {
-  CheckResult,
-  CrossSourceValueComparison,
-  Source,
-  SourceValidity,
-  TextField as BaseTextField,
-  TextFieldType,
-  TextFieldValue
-} from "../models/index.js";
-
-const LCID_MAP: Record<number, string> = {
-  0: 'Latin',
-  1078: 'Afrikaans',
-  1052: 'Albanian',
-  5121: 'Arabic (Algeria)',
-  15361: 'Arabic (Bahrain)',
-  3073: 'Arabic (Egypt)',
-  2049: 'Arabic (Iraq)',
-  11265: 'Arabic (Jordan)',
-  13313: 'Arabic (Kuwait)',
-  12289: 'Arabic (Lebanon)',
-  4097: 'Arabic (Libya)',
-  6145: 'Arabic (Morocco)',
-  8193: 'Arabic (Oman)',
-  16385: 'Arabic (Qatar)',
-  1025: 'Arabic (Saudi Arabia)',
-  10241: 'Arabic (Syria)',
-  7169: 'Arabic (Tunisia)',
-  14337: 'Arabic (U.A.E.)',
-  9217: 'Arabic (Yemen)',
-  1067: 'Arabic Armenian',
-  2092: 'Azeri (Cyrillic)',
-  1068: 'Azeri (Latin)',
-  1069: 'Basque',
-  1059: 'Belarusian',
-  1026: 'Bulgarian',
-  1027: 'Catalan',
-  3076: 'Chinese (HongKong S.A.R.)',
-  5124: 'Chinese (Macao S.A.R.)',
-  2052: 'Chinese',
-  4100: 'Chinese (Singapore)',
-  1028: 'Chinese (Taiwan)',
-  1050: 'Croatian',
-  1029: 'Czech',
-  1030: 'Danish',
-  1125: 'Divehi',
-  2067: 'Dutch (Belgium)',
-  1043: 'Dutch (Netherlands)',
-  3081: 'English (Australia)',
-  10249: 'English (Belize)',
-  4105: 'English (Canada)',
-  9225: 'English (Caribbean)',
-  6153: 'English (Ireland)',
-  8201: 'English (Jamaica)',
-  5129: 'English (New Zealand)',
-  13321: 'English (Philippines)',
-  7177: 'English (South Africa)',
-  11273: 'English (Trinidad)',
-  2057: 'English (United Kingdom)',
-  1033: 'English (United States)',
-  12297: 'English (Zimbabwe)',
-  1061: 'Estonian',
-  1080: 'Faroese',
-  1065: 'Farsi',
-  1035: 'Finnish',
-  2060: 'French (Belgium)',
-  3084: 'French (Canada)',
-  1036: 'French (France)',
-  5132: 'French (Luxembourg)',
-  6156: 'French (Monaco)',
-  4108: 'French (Switzerland)',
-  1071: 'FYRO Macedonian',
-  1110: 'Galician',
-  1079: 'Georgian',
-  3079: 'German (Austria)',
-  1031: 'German (Germany)',
-  5127: 'German (Liechtenstein)',
-  4103: 'German (Luxembourg)',
-  2055: 'German (Switzerland)',
-  1032: 'Greek',
-  1095: 'Gujarati',
-  1037: 'Hebrew',
-  1081: 'Hindi (India)',
-  1038: 'Hungarian',
-  1039: 'Icelandic',
-  1057: 'Indonesian',
-  1040: 'Italian (Italy)',
-  2064: 'Italian (Switzerland)',
-  1041: 'Japanese',
-  1099: 'Kannada',
-  1087: 'Kazakh',
-  1111: 'Konkani',
-  1042: 'Korean',
-  1088: 'Kyrgyz (Cyrillic)',
-  1062: 'Latvian',
-  1063: 'Lithuanian',
-  2110: 'Malay (Brunei Darussalam)',
-  1102: 'Marathi',
-  1086: 'Malay (Malaysia)',
-  1104: 'Mongolian (Cyrillic)',
-  1044: 'Norwegian (Bokmal)',
-  2068: 'Norwegian (Nynorsk)',
-  1045: 'Polish',
-  1046: 'Portuguese (Brazil)',
-  2070: 'Portuguese (Portugal)',
-  1094: 'Punjabi',
-  1047: 'Rhaeto-Romanic',
-  1048: 'Romanian',
-  1049: 'Russian',
-  1103: 'Sanskrit',
-  3098: 'Serbian (Cyrillic)',
-  2074: 'Serbian (Latin)',
-  1051: 'Slovak',
-  1060: 'Slovenian',
-  11274: 'Spanish (Argentina)',
-  16394: 'Spanish (Bolivia)',
-  13322: 'Spanish (Chile)',
-  9226: 'Spanish (Colombia)',
-  5130: 'Spanish (Costa Rica)',
-  7178: 'Spanish (Dominican Republic)',
-  12298: 'Spanish (Ecuador)',
-  17418: 'Spanish (El Salvador)',
-  4106: 'Spanish (Guatemala)',
-  18442: 'Spanish (Honduras)',
-  3082: 'Spanish (International Sort)',
-  2058: 'Spanish (Mexico)',
-  19466: 'Spanish (Nicaragua)',
-  6154: 'Spanish (Panama)',
-  15370: 'Spanish (Paraguay)',
-  10250: 'Spanish (Peru)',
-  20490: 'Spanish (Puerto Rico)',
-  1034: 'Spanish (Traditional Sort)',
-  14346: 'Spanish (Uruguay)',
-  8202: 'Spanish (Venezuela)',
-  1089: 'Swahili',
-  1053: 'Swedish',
-  2077: 'Swedish (Finland)',
-  1114: 'Syriac',
-  1097: 'Tamil',
-  1092: 'Tatar',
-  1098: 'Telugu',
-  1054: 'Thai (Thailand)',
-  1055: 'Turkish',
-  1058: 'Ukrainian',
-  1056: 'Urdu',
-  2115: 'Uzbek (Cyrillic)',
-  1091: 'Uzbek (Latin)',
-  1066: 'Vietnamese',
-  1064: 'Tajik (Cyrillic)',
-  1090: 'Turkmen',
-  50001: 'CTC Simplified',
-  50002: 'CTC Traditional',
-  9999: 'Custom',
-}
-export class TextField implements BaseTextField {
-
-  // see BaseTextField for docs
-  fieldType: TextFieldType;
-  fieldName: string;
-  lcid?: number;
-
-  status: CheckResult;
-  validityStatus: CheckResult;
-  comparisonStatus: CheckResult;
-
-  value: string
-  valueList: Array<TextFieldValue>;
-  validityList: Array<SourceValidity>;
-  comparisonList: Array<CrossSourceValueComparison>;
-
-  constructor(origin: BaseTextField) {
-    this.fieldType = origin.fieldType;
-    this.fieldName = origin.fieldName;
-    this.lcid = origin.lcid;
-    this.status = origin.status;
-    this.validityStatus = origin.validityStatus;
-    this.comparisonStatus = origin.comparisonStatus;
-    this.value = origin.value;
-    this.valueList = origin.valueList;
-    this.validityList = origin.validityList;
-    this.comparisonList = origin.comparisonList;
-  }
-
-  /**
-   * This method returns value of the text field. Value encoded in UTF8.
-   * Fields value obtained in the following order:
-   * - if MRZ value is present, it will be taken
-   * - if no MRZ, but RFID value is present, it will be taken
-   * - if no MRZ, no RFID, but Barcode value is present, it will be taken
-   * - if no MRZ, no RFID, no Barcode, but Visual OCR value is present, it will be taken
-   *
-   * @param source See {@code Source}
-   * @param original Each value formatted according to input params and server settings.
-   * To get original representation, set this flag to true. Date example:
-   *  - original visual value - "3 January 2009"
-   *  - formatted value - "03.01.2009"
-   */
-  public getValue(source?: Source, original = false): string | undefined {
-
-    if (!source) {
-      return this.value;
-    }
-
-    const value = this.getValueBySource(source)
-    if (original) {
-      return value?.originalValue;
-    }
-    return value?.value;
-  }
-
-  /**
-   * Returns validity check of all values for given source.
-   * @param source See {@code Source}
-   */
-  public sourceValidity(source: Source): CheckResult {
-    for (const validity of this.validityList) {
-      if (validity.source === source) {
-        return validity.status;
-      }
-    }
-    return CheckResult.WAS_NOT_DONE;
-  }
-
-  /**
-   * Returns value matching result for different sources.
-   */
-  public crossSourceComparison(one: Source, other: Source): CheckResult {
-    for (const c of this.comparisonList) {
-      if ((c.sourceLeft === one && c.sourceRight === other) || (c.sourceLeft === other && c.sourceRight === one)) {
-        return c.status;
-      }
-    }
-    return CheckResult.WAS_NOT_DONE;
-  }
-
-  public getLCIDName(): string | undefined {
-    if (this.lcid) {
-      return LCID_MAP[this.lcid] || String(this.lcid);
-    }
-  }
-
-  private getValueBySource(source: Source): TextFieldValue | undefined {
-    for (const value of this.valueList) {
-      if (value.source == source) {
-        return value;
-      }
-    }
-    return undefined;
-  }
-}

package/src/ext/text.ts

@@ -1,66 +0,0 @@
-import {
-  TextAvailableSource as AvailableSource,
-  CheckResult,
-  Text as BaseText,
-  TextFieldType, LCID
-} from "../models/index.js";
-import {TextField} from "./text-field.js";
-
-
-export class Text implements BaseText {
-
-  status: CheckResult;
-  validityStatus: CheckResult;
-  comparisonStatus: CheckResult;
-
-  availableSourceList: Array<AvailableSource>;
-  fieldList: Array<TextField>;
-
-  constructor(origin: BaseText) {
-    this.status = origin.status
-    this.validityStatus = origin.validityStatus
-    this.comparisonStatus = origin.comparisonStatus
-    this.availableSourceList = origin.availableSourceList
-    this.fieldList = origin.fieldList.map(field => new TextField(field))
-  }
-
-  public getField(type: TextFieldType, lcid?: number): TextField | undefined {
-    let result = undefined
-    for (const field of this.fieldList) {
-      if (field.fieldType == type) {
-        if (lcid != undefined && field.lcid == lcid) {
-          return field
-        } else if (lcid == undefined && field.lcid == LCID.LATIN) {
-          return field
-        } else if (lcid == undefined && result == undefined) {
-          result = field
-        }
-      }
-    }
-    return result
-  }
-
-  public getFieldByName(name: string, lcid?: number): TextField | undefined {
-    let result = undefined
-    for (const field of this.fieldList) {
-      if (field.fieldName == name) {
-        if (lcid != undefined && field.lcid == lcid) {
-          return field
-        } else if (lcid == undefined && field.lcid == LCID.LATIN) {
-          return field
-        } else if (lcid == undefined && result == undefined) {
-          result = field
-        }
-      }
-    }
-    return result
-  }
-
-  public getFieldValue(type: TextFieldType, lcid?: number): string | undefined {
-    return this.getField(type, lcid)?.getValue()
-  }
-
-  public getFieldValueByName(name: string, lcid?: number): string | undefined {
-    return this.getFieldByName(name, lcid)?.getValue()
-  }
-}

package/src/index.ts

@@ -1,110 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Regula Document Reader SDK Web API
- * Regula Document Reader SDK Web API
- *
- * The version of the OpenAPI document: 5.1.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-export * from "./ext/index.js";
-export * from "./configuration.js";
-
-export * from './models/area-container.js';
-export * from './models/authenticity-check-list.js';
-export * from './models/authenticity-check-result.js';
-export * from './models/authenticity-check-result-item.js';
-export * from './models/authenticity-result.js';
-export * from './models/authenticity-result-all-of.js';
-export * from './models/check-diagnose.js';
-export * from './models/check-result.js';
-export * from './models/chosen-document-type.js';
-export * from './models/chosen-document-type-result.js';
-export * from './models/chosen-document-type-result-all-of.js';
-export * from './models/container-list.js';
-export * from './models/critical.js';
-export * from './models/cross-source-value-comparison.js';
-export * from './models/details-optical.js';
-export * from './models/details-rfid.js';
-export * from './models/device-info.js';
-export * from './models/doc-visual-extended-field.js';
-export * from './models/doc-visual-extended-info.js';
-export * from './models/document-format.js';
-export * from './models/document-image.js';
-export * from './models/document-image-result.js';
-export * from './models/document-image-result-all-of.js';
-export * from './models/document-type.js';
-export * from './models/document-type-recognition-result.js';
-export * from './models/document-types-candidates.js';
-export * from './models/document-types-candidates-list.js';
-export * from './models/document-types-candidates-result.js';
-export * from './models/document-types-candidates-result-all-of.js';
-export * from './models/fdsidlist.js';
-export * from './models/fiber-result.js';
-export * from './models/fiber-result-all-of.js';
-export * from './models/graphic-field.js';
-export * from './models/graphic-field-type.js';
-export * from './models/graphic-fields-list.js';
-export * from './models/graphics-result.js';
-export * from './models/graphics-result-all-of.js';
-export * from './models/ident-result.js';
-export * from './models/ident-result-all-of.js';
-export * from './models/image-data.js';
-export * from './models/image-qa.js';
-export * from './models/images-available-source.js';
-export * from './models/images-field-value.js';
-export * from './models/images-result.js';
-export * from './models/images-result-all-of.js';
-export * from './models/lcid.js';
-export * from './models/lexical-analysis-result.js';
-export * from './models/lexical-analysis-result-all-of.js';
-export * from './models/light.js';
-export * from './models/list-verified-fields.js';
-export * from './models/ocrsecurity-text-result.js';
-export * from './models/ocrsecurity-text-result-all-of.js';
-export * from './models/one-candidate.js';
-export * from './models/original-symbol.js';
-export * from './models/photo-ident-result.js';
-export * from './models/photo-ident-result-all-of.js';
-export * from './models/point.js';
-export * from './models/points-container.js';
-export * from './models/process-params.js';
-export * from './models/process-response.js';
-export * from './models/process-system-info.js';
-export * from './models/processing-status.js';
-export * from './models/raw-image-container-list.js';
-export * from './models/rectangle-coordinates.js';
-export * from './models/result.js';
-export * from './models/result-item.js';
-export * from './models/rfid-location.js';
-export * from './models/rfid-origin.js';
-export * from './models/scenario.js';
-export * from './models/security-feature-result.js';
-export * from './models/security-feature-result-all-of.js';
-export * from './models/security-feature-type.js';
-export * from './models/source.js';
-export * from './models/source-validity.js';
-export * from './models/status.js';
-export * from './models/status-result.js';
-export * from './models/status-result-all-of.js';
-export * from './models/string-recognition-result.js';
-export * from './models/symbol-candidate.js';
-export * from './models/symbol-recognition-result.js';
-export * from './models/text-available-source.js';
-export * from './models/text-data-result.js';
-export * from './models/text-data-result-all-of.js';
-export * from './models/text-field-type.js';
-export * from './models/text-field-value.js';
-export * from './models/text-result.js';
-export * from './models/text-result-all-of.js';
-export * from './models/text-post-processing.js';
-export * from './models/transaction-info.js';
-export * from './models/verification-result.js';
-export * from './models/verified-field-map.js';
-export * from './models/visibility.js';

package/src/models/area-array.ts

@@ -1,39 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Regula Document Reader Web API
- * Documents recognition as easy as reading two bytes.  # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core 
- *
- * The version of the OpenAPI document: 6.9.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-import { PointArray } from './point-array';
-import { RectangleCoordinates } from './rectangle-coordinates';
-
-/**
- * 
- * @export
- * @interface AreaArray
- */
-export interface AreaArray {
-    /**
-     * 
-     * @type {Array<RectangleCoordinates>}
-     * @memberof AreaArray
-     */
-    List?: Array<RectangleCoordinates>;
-    /**
-     * 
-     * @type {Array<PointArray>}
-     * @memberof AreaArray
-     */
-    Points?: Array<PointArray>;
-}
-
-