regula

hleb.albau

ikliashchou

ivan.hil

@regulaforensics/document-reader-webclient

  "name": "@regulaforensics/document-reader-webclient",

  "description": "Regula Document Reader js client for the browser and node.js based on axios",

    "url": "git@github.com/regulaforensics/DocumentReader-api-js-client"

    "build-cjs": "tsc --project tsconfig.commonjs.json",

    "build-esm": "tsc --project tsconfig.esm.json",

    "format": "eslint --fix ./src --ext .ts",

    "build": "npm run clean && npm run format && npm run build-cjs && npm run build-esm && echo '{\"type\": \"commonjs\"}' > ./dist/cjs-es5/package.json"

    "@typescript-eslint/eslint-plugin": "^3.5.0",

    "@typescript-eslint/parser": "^3.5.0",

    "eslint-plugin-unused-imports": "^0.1.3",

 * 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: 5.7.0

 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

import { DocumentFormat } from './document-format';

import { MeasureSystem } from './measure-system';

import { PerDocumentConfig } from './per-document-config';

import { TextFieldType } from './text-field-type';

import { TextPostProcessing } from './text-post-processing';

     * Types of results to return in response. See \'Result\' enum for available options

     * This option can be set to true if the image you provide contains double page spread of the passport and you want to process both pages in one go. It makes sense to use it for documents that have meaningful information on both pages, like Russian domestic passport, or some others. By default is set to false.

     * When enabled together with \"doublePageSpread\" and there is a passport with two pages spread in the image, pages will be cropped, straightened and aligned together, as if the document was captured on a flatbed scanner.

    generateDoublePageSpreadImage?: boolean;

     * List of text field types to extract. If empty, all text fields from template will be extracted. Narrowing the list can shorten processing time. By default is empty.

    fieldTypesFilter?: Array<TextFieldType>;

     * This option allows you to set dates format so that solution will return dates in this format. For example, if you supply \'MM/dd/yyyy\', and document have printed date \'09 JUL 2020\' for the date os issue, you will get \'07/09/2020\' as a result. By default it is set to system locale default (where the service is running).

     * This option controls maximum resolution in dpi of output images. Resolution will remain original in case 0 is supplied. By default is set to return images in response with resolution not greater than 300 dpi.

     * This option can be set to true if you know for sure that the image you provide contains already cropped document by its edges. This was designed to process on the server side images captured and cropped on mobile. By default is set to false.

     * This option allows to pass custom processing parameters that can be implemented in future without changing API.

     * @type {{ [key: string]: object; }}

    customParams?: { [key: string]: object; };

     * This option allows to set additional custom configuration per document type. If recognized document has id specified in config, processing adjusts according to designated configuration.

     * This option can be set to true if you need to get base64 string of transaction processing log.

     * When enabled no graphic fields will be cropped from document image.

     * Specifies minimal area of the image that document should cover to be treated as candidate when locating. Value should be in range from 0 to 1, where 1 is when document should fully cover the image.

     * When enabled all personal data will be forcibly removed from the logs.

     * This option allows locating and cropping multiple documents from one image if enabled.

     * This option allows shifting the date of expiry into the future or past for number of months specified. This is useful, for example, in some cases when document might be still valid for some period after original expiration date to prevent negative validity status for such documents. Or by shifting the date to the past will set negative validity for the documents that is about to expire in a specified number of months.

     * This options allows specifying the minimal age in years of the document holder for the document to be considered valid.

     * This option allows returning input images in output if enabled.

     * This option allows limiting MRZ formats to be recognized by specifying them in array.

     * This option can be set to true to make sure that in series processing MRZ is located fully inside the result document image, if present on the document. Enabling this option may add extra processing time, by disabling optimizations, but allows more stability in output image quality.

     * This option can be set to false to stop parsing after barcode is read.

		{
		"name": "@regulaforensics/document-reader-webclient",
		"version": "5.8.3",
		"version": "5.8.4",
		"description": "Regula Document Reader js client for the browser and node.js based on axios",
		@@ -5,0 +5,0 @@ "author": "Regula Forensics, Inc.",

		@@ -152,3 +152,3 @@ /* tslint:disable */
		*/
		imageQA?: ImageQA;
		imageQa?: ImageQA;
		/**
		@@ -155,0 +155,0 @@ *