@regulaforensics/document-reader-webclient 6.5.2 → 6.6.1-beta.0

package/src/configuration.ts

@@ -1,101 +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.5.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 interface ConfigurationParameters {
-    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
-    username?: string;
-    password?: string;
-    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
-    basePath?: string;
-    baseOptions?: any;
-    formDataCtor?: new () => any;
-}
-
-export class Configuration {
-    /**
-     * parameter for apiKey security
-     * @param name security name
-     * @memberof Configuration
-     */
-    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
-    /**
-     * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    username?: string;
-    /**
-     * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    password?: string;
-    /**
-     * parameter for oauth2 security
-     * @param name security name
-     * @param scopes oauth2 scope
-     * @memberof Configuration
-     */
-    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
-    /**
-     * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    basePath?: string;
-    /**
-     * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
-     */
-    baseOptions?: any;
-    /**
-     * The FormData constructor that will be used to create multipart form data
-     * requests. You can inject this here so that execution environments that
-     * do not support the FormData class can still run the generated client.
-     *
-     * @type {new () => FormData}
-     */
-    formDataCtor?: new () => any;
-
-    constructor(param: ConfigurationParameters = {}) {
-        this.apiKey = param.apiKey;
-        this.username = param.username;
-        this.password = param.password;
-        this.accessToken = param.accessToken;
-        this.basePath = param.basePath;
-        this.baseOptions = param.baseOptions;
-        this.formDataCtor = param.formDataCtor;
-    }
-
-    /**
-     * Check if the given MIME is a JSON MIME.
-     * JSON MIME examples:
-     *   application/json
-     *   application/json; charset=UTF8
-     *   APPLICATION/JSON
-     *   application/vnd.company+json
-     * @param mime - MIME (Multipurpose Internet Mail Extensions)
-     * @return True if the given MIME is JSON, false otherwise.
-     */
-    public isJsonMime(mime: string): boolean {
-        const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
-        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
-    }
-}

package/src/ext/authenticity/authenticity.ts

@@ -1,128 +0,0 @@
-import {
-  AuthenticityCheckList as BaseAuthenticityCheckList, AuthenticityCheckResult, AuthenticityResultType
-} from "../../models/index.js";
-import {FiberChecks} from "./fiber.js";
-import {IdentChecks} from "./ident.js";
-import {ImageIdentChecks} from "./image-ident.js";
-import {OCRSecurityTextChecks} from "./ocr-security-text.js";
-import {SecurityFeatureChecks} from "./security-feature.js";
-
-export class Authenticity implements BaseAuthenticityCheckList {
-  List: Array<AuthenticityCheckResult>;
-  page_idx: number;
-
-  constructor(origin: BaseAuthenticityCheckList, page_idx: number) {
-    this.List = origin.List
-    this.page_idx = page_idx
-  }
-
-  public uvLuminescenceChecks(): SecurityFeatureChecks | undefined {
-    return this.securityFeatureOrUndefined(AuthenticityResultType.UV_LUMINESCENCE)
-  }
-
-  public irB900Checks(): SecurityFeatureChecks | undefined {
-    return this.securityFeatureOrUndefined(AuthenticityResultType.IR_B900)
-  }
-
-  public imagePatternChecks(): IdentChecks | undefined {
-    return this.identOrUndefined(AuthenticityResultType.IMAGE_PATTERN);
-  }
-
-  public axialProtectionChecks(): SecurityFeatureChecks | undefined {
-    return this.securityFeatureOrUndefined(AuthenticityResultType.AXIAL_PROTECTION);
-  }
-
-  public uvFiberChecks(): FiberChecks | undefined {
-    return this.fiberOrUndefined(AuthenticityResultType.UV_FIBERS);
-  }
-
-  public irVisibilityChecks(): IdentChecks | undefined {
-    return this.identOrUndefined(AuthenticityResultType.IR_VISIBILITY);
-  }
-
-  public ocrSecurityTextChecks(): OCRSecurityTextChecks | undefined {
-    return this.ocrSecurityTextOrUndefined(AuthenticityResultType.OCR_SECURITY_TEXT);
-  }
-
-  public ipiChecks(): ImageIdentChecks | undefined {
-    return this.imageIdentOrUndefined(AuthenticityResultType.IPI);
-  }
-
-
-  public embedImageChecks(): SecurityFeatureChecks | undefined {
-    return this.securityFeatureOrUndefined(AuthenticityResultType.PHOTO_EMBED_TYPE);
-  }
-
-  public hologramsChecks(): SecurityFeatureChecks | undefined {
-    return this.securityFeatureOrUndefined(AuthenticityResultType.HOLOGRAMS);
-  }
-
-  public imageAreaChecks(): SecurityFeatureChecks | undefined {
-    return this.securityFeatureOrUndefined(AuthenticityResultType.PHOTO_AREA);
-  }
-
-  public portraitComparisonChecks(): IdentChecks | undefined {
-    return this.identOrUndefined(AuthenticityResultType.PORTRAIT_COMPARISON);
-  }
-
-  public barcodeFormatCheckChecks(): SecurityFeatureChecks | undefined {
-    return this.securityFeatureOrUndefined(AuthenticityResultType.BARCODE_FORMAT_CHECK);
-  }
-
-  public kinegramChecks(): IdentChecks | undefined {
-    return this.identOrUndefined(AuthenticityResultType.KINEGRAM);
-  }
-
-  public letterScreenChecks(): IdentChecks | undefined {
-    return this.identOrUndefined(AuthenticityResultType.LETTER_SCREEN);
-  }
-
-  public resultByType(authenticityType: number): AuthenticityCheckResult | undefined {
-    for (const result of this.List) {
-      if (result.Type == authenticityType) {
-        return result
-      }
-    }
-    return undefined
-  }
-
-  private fiberOrUndefined(authenticityType: number): FiberChecks | undefined {
-    const result = this.resultByType(authenticityType)
-    if (result) {
-      return new FiberChecks(result)
-    }
-    return undefined
-  }
-
-  private identOrUndefined(authenticityType: number): IdentChecks | undefined {
-    const result = this.resultByType(authenticityType)
-    if (result) {
-      return new IdentChecks(result)
-    }
-    return undefined
-  }
-
-  private imageIdentOrUndefined(authenticityType: number): ImageIdentChecks | undefined {
-    const result = this.resultByType(authenticityType)
-    if (result) {
-      return new ImageIdentChecks(result)
-    }
-    return undefined
-  }
-
-  private ocrSecurityTextOrUndefined(authenticityType: number): OCRSecurityTextChecks | undefined {
-    const result = this.resultByType(authenticityType)
-    if (result) {
-      return new OCRSecurityTextChecks(result)
-    }
-    return undefined
-  }
-
-  private securityFeatureOrUndefined(authenticityType: number): SecurityFeatureChecks | undefined {
-    const result = this.resultByType(authenticityType)
-    if (result) {
-      return new SecurityFeatureChecks(result)
-    }
-    return undefined
-  }
-}

package/src/ext/authenticity/fiber.ts

@@ -1,19 +0,0 @@
-import {
-  AuthenticityCheckResult,
-  AuthenticityResultType,
-  CheckResult,
-  FiberResult
-} from "../../models";
-
-
-export class FiberChecks implements AuthenticityCheckResult {
-  List: Array<FiberResult>;
-  Result: CheckResult;
-  Type: AuthenticityResultType;
-
-  constructor(origin: AuthenticityCheckResult) {
-    this.List = <Array<FiberResult>>origin.List
-    this.Result = origin.Result
-    this.Type = origin.Type
-  }
-}

package/src/ext/authenticity/ident.ts

@@ -1,29 +0,0 @@
-import {
-  AuthenticityCheckResult,
-  AuthenticityResultType,
-  CheckResult,
-  IdentResult,
-  SecurityFeatureType
-} from "../../models";
-
-export class IdentChecks implements AuthenticityCheckResult {
-  List: Array<IdentResult>;
-  Result: CheckResult;
-  Type: AuthenticityResultType;
-
-  constructor(origin: AuthenticityCheckResult) {
-    this.List = <Array<IdentResult>>origin.List
-    this.Result = origin.Result
-    this.Type = origin.Type
-  }
-
-  public checksByElement(elementType: SecurityFeatureType): Array<IdentResult> {
-    const results = []
-    for (const result of this.List) {
-      if (result.ElementType === elementType) {
-        results.push(result)
-      }
-    }
-    return results
-  }
-}

package/src/ext/authenticity/image-ident.ts

@@ -1,18 +0,0 @@
-import {
-  AuthenticityCheckResult,
-  AuthenticityResultType,
-  CheckResult,
-  PhotoIdentResult
-} from "../../models";
-
-export class ImageIdentChecks implements AuthenticityCheckResult {
-  List: Array<PhotoIdentResult>;
-  Result: CheckResult;
-  Type: AuthenticityResultType;
-
-  constructor(origin: AuthenticityCheckResult) {
-    this.List = <Array<PhotoIdentResult>>origin.List
-    this.Result = origin.Result
-    this.Type = origin.Type
-  }
-}

package/src/ext/authenticity/index.ts

@@ -1,5 +0,0 @@
-export * from './authenticity.js';
-export * from './fiber.js'
-export * from './ident.js'
-export * from './ocr-security-text.js'
-export * from './security-feature.js'

package/src/ext/authenticity/ocr-security-text.ts

@@ -1,18 +0,0 @@
-import {
-  AuthenticityCheckResult,
-  AuthenticityResultType,
-  CheckResult,
-  OCRSecurityTextResult
-} from "../../models";
-
-export class OCRSecurityTextChecks implements AuthenticityCheckResult {
-  List: Array<OCRSecurityTextResult>;
-  Result: CheckResult;
-  Type: AuthenticityResultType;
-
-  constructor(origin: AuthenticityCheckResult) {
-    this.List = <Array<OCRSecurityTextChecks>>origin.List
-    this.Result = origin.Result
-    this.Type = origin.Type
-  }
-}

package/src/ext/authenticity/security-feature.ts

@@ -1,29 +0,0 @@
-import {
-  AuthenticityCheckResult,
-  AuthenticityResultType,
-  CheckResult,
-  SecurityFeatureResult,
-  SecurityFeatureType
-} from "../../models";
-
-export class SecurityFeatureChecks implements AuthenticityCheckResult {
-  List: Array<SecurityFeatureResult>;
-  Result: CheckResult;
-  Type: AuthenticityResultType;
-
-  constructor(origin: AuthenticityCheckResult) {
-    this.List = <Array<SecurityFeatureResult>>origin.List
-    this.Result = origin.Result
-    this.Type = origin.Type
-  }
-
-  public checksByElement(elementType: SecurityFeatureType): Array<SecurityFeatureResult> {
-    const results = []
-    for (const result of this.List) {
-      if (result.ElementType === elementType) {
-        results.push(result)
-      }
-    }
-    return results
-  }
-}

package/src/ext/document-reader.ts

@@ -1,121 +0,0 @@
-import {DefaultApi} from "../api/default-api.js";
-import {ProcessApi} from "../api/process-api.js";
-import {
-  Light,
-  ProcessRequest as ProcessRequestBase,
-  Scenario,
-  Result,
-  
-  DeviceInfo
-} from "../models/index.js";
-import {Response} from "./process-response.js";
-import {Configuration} from "../configuration.js";
-import globalAxios, {AxiosInstance} from "axios";
-import {BASE_PATH} from "../base.js";
-import {ProcessRequestImage as ProcessRequestImageBase} from "../models/index.js";
-import {Base64String, instanceOfProcessRequest, ProcessRequest} from "./process-request.js";
-import {ProcessRequestImage} from "./process-request-image.js";
-import * as converter from "base64-arraybuffer";
-
-
-export class DocumentReaderApi {
-
-  private readonly defaultApi: DefaultApi
-  private readonly processApi: ProcessApi
-
-  private license: string | undefined
-
-  constructor(configuration?: Configuration, basePath: string = BASE_PATH, axios: AxiosInstance = globalAxios) {
-    this.defaultApi = new DefaultApi(configuration, basePath, axios)
-    this.processApi = new ProcessApi(configuration, basePath, axios)
-  }
-
-  ping(xRequestID?: string): Promise<DeviceInfo> {
-    return this.defaultApi.ping(xRequestID)
-      .then((axiosResult) => axiosResult.data);
-  }
-
-  /**
-   *
-   * @summary Process list of documents images and return extracted data
-   * @param {ProcessRequest} [request] Request options such as image, results types and etc.
-   * @param {*} [options] Override http request option.
-   * @throws {RequiredError} If some request params are missed
-   * */
-  process(request: ProcessRequest | ProcessRequestBase, xRequestID?: string, options?: any): Promise<Response> {
-    let baseRequest;
-
-    if (instanceOfProcessRequest(request)) {
-      if (!request.processParam) {
-        request.processParam = {
-          scenario: Scenario.FULL_PROCESS,
-          resultTypeOutput: [Result.TEXT]
-        }
-      }
-      if (!request.systemInfo) {
-        request.systemInfo = {}
-      }
-
-      if (!request.systemInfo.license && this.license) {
-        request.systemInfo.license = this.license
-      }
-
-      baseRequest = requestToBaseRequest(request)
-    } else {
-      baseRequest = request
-    }
-
-    return this.processApi.apiProcess(baseRequest, xRequestID, options)
-      .then((axiosResult) => new Response(axiosResult.data));
-  }
-
-  public setLicense(license: ArrayBuffer | Base64String): void {
-    if (typeof license === "string") {
-      this.license = license
-    } else {
-      this.license = bufferToBase64String(license);
-    }
-  }
-}
-
-
-export function requestToBaseRequest(request: ProcessRequest): ProcessRequestBase {
-
-  const imageList: Array<ProcessRequestImageBase> = []
-
-  request.images.forEach((image, index) => {
-    if (typeof image === "string") {
-      imageList.push({ImageData: {'image': image}, light: Light.WHITE, page_idx: index});
-    } else if (image instanceof ArrayBuffer) {
-      const data = bufferToBase64String(image);
-      imageList.push({ImageData: {'image': data}, light: Light.WHITE, page_idx: index});
-    } else {
-      imageList.push(imageDataToBaseImageData(image, index))
-    }
-  });
-
-  return {
-    processParam: request.processParam,
-    List: imageList,
-    systemInfo: request.systemInfo,
-    passBackObject: request.passBackObject
-  }
-}
-
-function imageDataToBaseImageData(image: ProcessRequestImage, arrayIndex: number): ProcessRequestImageBase {
-  let data: string
-  if (typeof image.ImageData === "string") {
-    data = image.ImageData
-  } else {
-    data = bufferToBase64String(image.ImageData)
-  }
-  return {
-    ImageData: {'image': data},
-    light: image.light,
-    page_idx: (typeof image.page_idx === 'undefined') ? arrayIndex : image.page_idx
-  }
-}
-
-function bufferToBase64String(buffer: ArrayBuffer): string {
-  return converter.encode(buffer);
-}

package/src/ext/images.ts

@@ -1,77 +0,0 @@
-import {
-  GraphicFieldType,
-  Images as BaseImages,
-  ImagesField as BaseImagesField,
-  ImagesAvailableSource, ImagesFieldValue, Source
-} from "../models/index.js";
-import * as converter from "base64-arraybuffer";
-
-export class Images implements BaseImages {
-
-  availableSourceList: Array<ImagesAvailableSource>;
-  fieldList: Array<ImagesField>;
-
-  constructor(origin: BaseImages) {
-    this.availableSourceList = origin.availableSourceList
-    this.fieldList = origin.fieldList.map(field => new ImagesField(field))
-  }
-
-  public getField(type: GraphicFieldType): ImagesField | undefined {
-    for (const field of this.fieldList) {
-      if (field.fieldType == type) {
-        return field
-      }
-    }
-    return undefined
-  }
-
-  public getFields(type: GraphicFieldType): Array<ImagesField> | undefined {
-    return this.fieldList.filter(field => field.fieldType == type)
-  }
-}
-
-export class ImagesField implements BaseImagesField {
-
-  fieldName: string;
-  fieldType: GraphicFieldType;
-  valueList: Array<ImagesFieldValue>;
-
-  constructor(origin: BaseImagesField) {
-    this.fieldName = origin.fieldName
-    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.getValueBySource(Source.RFID) || this.getValueBySource(Source.VISUAL)
-        || this.getValueBySource(Source.BARCODE)
-    } else {
-      fieldValue = this.getValueBySource(source)
-    }
-
-    if (!fieldValue) {
-      return undefined
-    }
-
-    if (original && fieldValue.originalValue) {
-      return base64ToBuffer(fieldValue.originalValue)
-    }
-    return base64ToBuffer(fieldValue.value)
-  }
-
-  private getValueBySource(source: Source): ImagesFieldValue | undefined {
-    for (const value of this.valueList) {
-      if (value.source == source) {
-        return value
-      }
-    }
-    return undefined
-  }
-}
-
-function base64ToBuffer(str: string): ArrayBuffer {
-  return converter.decode(str);
-}

package/src/ext/index.ts

@@ -1,8 +0,0 @@
-export * from './document-reader.js';
-export * from './process-request.js';
-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';

package/src/ext/process-request-image.ts

@@ -1,6 +0,0 @@
-import {ProcessRequestImage as ProcessRequestImageBase} from "../models/index.js";
-import {Base64String} from "./process-request.js";
-
-export interface ProcessRequestImage extends Omit<ProcessRequestImageBase, 'ImageData'> {
-    ImageData: ArrayBuffer | Base64String
-}

package/src/ext/process-request.ts

@@ -1,46 +0,0 @@
-import {ContainerList, ProcessParams, ProcessSystemInfo} from "../models/index.js";
-import {ProcessRequestImage} from "./process-request-image.js";
-
-export type Base64String = string;
-
-export interface ProcessRequest {
-
-    /**
-     *
-     * @type {ProcessParams}
-     * @memberof ProcessRequest
-     */
-    processParam: ProcessParams;
-
-    /**
-     *
-     * @type {Array<ProcessRequestImage>}
-     * @memberof ProcessRequest
-     */
-    images: Array<ProcessRequestImage | ArrayBuffer | Base64String>;
-
-    /**
-     * @type {ContainerList}
-     * @memberOf ProcessRequest
-     */
-    ContainerList: ContainerList
-
-    /**
-     *
-     * @type {ProcessParams}
-     * @memberof ProcessRequest
-     */
-    systemInfo?: ProcessSystemInfo;
-
-    /**
-     * Free-form object to be included in response. Must be object, not list or simple value.
-     * Do not affect document processing. Use it freely to pass your app params. Stored in process logs.
-     * @type {{ [key: string]: object; }}
-     * @memberof ProcessRequest
-     */
-    passBackObject?: { [key: string]: any; };
-}
-
-export const instanceOfProcessRequest = (data: any): data is ProcessRequest => {
-    return 'images' in data
-}