@regulaforensics/vp-frontend-face-components 1.3.0 → 2.0.0

package/lib/models/DocReaderWebclient/models/image-qa.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 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 ImageQA
+ */
+export interface ImageQA {
+    /**
+     * This parameter sets threshold for Image QA check of the presented document physical dpi. If actual document dpi is below this threshold, check will fail.
+     * @type {number}
+     * @memberof ImageQA
+     */
+    dpiThreshold?: number;
+    /**
+     * This parameter sets threshold for Image QA check of the presented document perspective angle in degrees. If actual document perspective angle is above this threshold, check will fail.
+     * @type {number}
+     * @memberof ImageQA
+     */
+    angleThreshold?: number;
+    /**
+     * This option enables focus check while performing image quality validation.
+     * @type {boolean}
+     * @memberof ImageQA
+     */
+    focusCheck?: boolean;
+    /**
+     * This option enables glares check while performing image quality validation.
+     * @type {boolean}
+     * @memberof ImageQA
+     */
+    glaresCheck?: boolean;
+    /**
+     * This option enables colorness check while performing image quality validation.
+     * @type {boolean}
+     * @memberof ImageQA
+     */
+    colornessCheck?: boolean;
+    /**
+     * This option enables screen capture (moire patterns) check while performing image quality validation.
+     * @type {boolean}
+     * @memberof ImageQA
+     */
+    moireCheck?: boolean;
+}

package/lib/models/DocReaderWebclient/models/image-quality-check-list.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+import { CheckResult } from './check-result';
+import { ImageQualityCheck } from './image-quality-check';
+/**
+ *
+ * @export
+ * @interface ImageQualityCheckList
+ */
+export interface ImageQualityCheckList {
+    /**
+     *
+     * @type {CheckResult}
+     * @memberof ImageQualityCheckList
+     */
+    result: CheckResult;
+    /**
+     *
+     * @type {Array<ImageQualityCheck>}
+     * @memberof ImageQualityCheckList
+     */
+    List: Array<ImageQualityCheck>;
+}

package/lib/models/DocReaderWebclient/models/image-quality-check-type.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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.
+ */
+/**
+ * Image quality check type
+ * @export
+ * @enum {string}
+ */
+export declare enum ImageQualityCheckType {
+    /**
+    * Signals glare presence on the image
+    */
+    ImageGlares = 0,
+    /**
+    * Signals whether image is in focus
+    */
+    ImageFocus = 1,
+    /**
+    * Signals if image resolution is below threshold
+    */
+    ImageResolution = 2,
+    /**
+    * Signals if image is colorless
+    */
+    ImageColorness = 3,
+    /**
+    * Signals if document in the image has prespective distortion above threshold
+    */
+    Perspective = 4,
+    /**
+    * Signals if document is not fully present in the image
+    */
+    Bounds = 5,
+    /**
+    * Signals if an image is captured from screen
+    */
+    ScreenCapture = 6,
+    /**
+    * Signals if the portrait is present
+    */
+    Portrait = 7
+}

package/lib/models/DocReaderWebclient/models/image-quality-check.d.ts

@@ -0,0 +1,64 @@
+/**
+ * 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.
+ */
+import { AreaArray } from './area-array';
+import { CheckResult } from './check-result';
+import { ImageQualityCheckType } from './image-quality-check-type';
+import { SecurityFeatureType } from './security-feature-type';
+/**
+ *
+ * @export
+ * @interface ImageQualityCheck
+ */
+export interface ImageQualityCheck {
+    /**
+     *
+     * @type {ImageQualityCheckType}
+     * @memberof ImageQualityCheck
+     */
+    type?: ImageQualityCheckType;
+    /**
+     *
+     * @type {CheckResult}
+     * @memberof ImageQualityCheck
+     */
+    result?: CheckResult;
+    /**
+     *
+     * @type {SecurityFeatureType}
+     * @memberof ImageQualityCheck
+     */
+    featureType?: SecurityFeatureType;
+    /**
+     *
+     * @type {AreaArray}
+     * @memberof ImageQualityCheck
+     */
+    areas?: AreaArray;
+    /**
+     *
+     * @type {number}
+     * @memberof ImageQualityCheck
+     */
+    mean?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ImageQualityCheck
+     */
+    std_dev?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ImageQualityCheck
+     */
+    probability?: number;
+}

package/lib/models/DocReaderWebclient/models/image-quality-result-all-of.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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.
+ */
+import { ImageQualityCheckList } from './image-quality-check-list';
+/**
+ *
+ * @export
+ * @interface ImageQualityResultAllOf
+ */
+export interface ImageQualityResultAllOf {
+    /**
+     *
+     * @type {ImageQualityCheckList}
+     * @memberof ImageQualityResultAllOf
+     */
+    ImageQualityCheckList: ImageQualityCheckList;
+}

package/lib/models/DocReaderWebclient/models/image-quality-result.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+import { ImageQualityResultAllOf } from './image-quality-result-all-of';
+import { ResultItem } from './result-item';
+/**
+ * @type ImageQualityResult
+ * @export
+ */
+export declare type ImageQualityResult = ImageQualityResultAllOf & ResultItem;

package/lib/models/DocReaderWebclient/models/images-available-source.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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.
+ */
+import { Source } from './source';
+/**
+ *
+ * @export
+ * @interface ImagesAvailableSource
+ */
+export interface ImagesAvailableSource {
+    /**
+     * Same as Result type, but used for safe parsing of not-described values. See Result type.
+     * @type {number}
+     * @memberof ImagesAvailableSource
+     */
+    containerType?: number;
+    /**
+     *
+     * @type {Source}
+     * @memberof ImagesAvailableSource
+     */
+    source: Source;
+}

package/lib/models/DocReaderWebclient/models/images-field-value.d.ts

@@ -0,0 +1,70 @@
+/**
+ * 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.
+ */
+import { Light } from './light';
+import { RectangleCoordinates } from './rectangle-coordinates';
+import { RfidOrigin } from './rfid-origin';
+import { Source } from './source';
+/**
+ *
+ * @export
+ * @interface ImagesFieldValue
+ */
+export interface ImagesFieldValue {
+    /**
+     *
+     * @type {Source}
+     * @memberof ImagesFieldValue
+     */
+    source: Source;
+    /**
+     * Base64 encoded image
+     * @type {string}
+     * @memberof ImagesFieldValue
+     */
+    value: string;
+    /**
+     * Base64 encoded image
+     * @type {string}
+     * @memberof ImagesFieldValue
+     */
+    originalValue?: string;
+    /**
+     * Page index of the image from input list
+     * @type {number}
+     * @memberof ImagesFieldValue
+     */
+    pageIndex: number;
+    /**
+     *
+     * @type {Light}
+     * @memberof ImagesFieldValue
+     */
+    lightIndex: Light;
+    /**
+     * Same as Result type, but used for safe parsing of not-described values. See Result type.
+     * @type {number}
+     * @memberof ImagesFieldValue
+     */
+    containerType: number;
+    /**
+     *
+     * @type {RectangleCoordinates}
+     * @memberof ImagesFieldValue
+     */
+    fieldRect?: RectangleCoordinates;
+    /**
+     *
+     * @type {RfidOrigin}
+     * @memberof ImagesFieldValue
+     */
+    rfidOrigin?: RfidOrigin;
+}

package/lib/models/DocReaderWebclient/models/images-field.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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.
+ */
+import { GraphicFieldType } from './graphic-field-type';
+import { ImagesFieldValue } from './images-field-value';
+/**
+ *
+ * @export
+ * @interface ImagesField
+ */
+export interface ImagesField {
+    /**
+     * Human readable field name. Do not bind to this name - use GraphicFieldType instead.
+     * @type {string}
+     * @memberof ImagesField
+     */
+    fieldName: string;
+    /**
+     *
+     * @type {GraphicFieldType}
+     * @memberof ImagesField
+     */
+    fieldType: GraphicFieldType;
+    /**
+     *
+     * @type {Array<ImagesFieldValue>}
+     * @memberof ImagesField
+     */
+    valueList: Array<ImagesFieldValue>;
+}

package/lib/models/DocReaderWebclient/models/images-result-all-of.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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.
+ */
+import { Images } from './images';
+/**
+ *
+ * @export
+ * @interface ImagesResultAllOf
+ */
+export interface ImagesResultAllOf {
+    /**
+     *
+     * @type {Images}
+     * @memberof ImagesResultAllOf
+     */
+    Images: Images;
+}

package/lib/models/DocReaderWebclient/models/images-result.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+import { ImagesResultAllOf } from './images-result-all-of';
+import { ResultItem } from './result-item';
+/**
+ * @type ImagesResult
+ * @export
+ */
+export declare type ImagesResult = ImagesResultAllOf & ResultItem;

package/lib/models/DocReaderWebclient/models/images.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+import { ImagesAvailableSource } from './images-available-source';
+import { ImagesField } from './images-field';
+/**
+ *
+ * @export
+ * @interface Images
+ */
+export interface Images {
+    /**
+     *
+     * @type {Array<ImagesAvailableSource>}
+     * @memberof Images
+     */
+    availableSourceList: Array<ImagesAvailableSource>;
+    /**
+     *
+     * @type {Array<ImagesField>}
+     * @memberof Images
+     */
+    fieldList: Array<ImagesField>;
+}

package/lib/models/DocReaderWebclient/models/index.d.ts

@@ -0,0 +1,123 @@
+export * from './area-array';
+export * from './area-container';
+export * from './authenticity-check-list';
+export * from './authenticity-check-result';
+export * from './authenticity-check-result-item';
+export * from './authenticity-result';
+export * from './authenticity-result-all-of';
+export * from './authenticity-result-type';
+export * from './bc-pdf417-info';
+export * from './bc-roidetect';
+export * from './check-diagnose';
+export * from './check-result';
+export * from './chosen-document-type';
+export * from './chosen-document-type-result';
+export * from './chosen-document-type-result-all-of';
+export * from './container-list';
+export * from './critical';
+export * from './cross-source-value-comparison';
+export * from './data-module';
+export * from './details-optical';
+export * from './details-rfid';
+export * from './device-info';
+export * from './doc-bar-code-info';
+export * from './doc-bar-code-info-all-of';
+export * from './doc-visual-extended-field';
+export * from './doc-visual-extended-info';
+export * from './document-format';
+export * from './document-image';
+export * from './document-image-result';
+export * from './document-image-result-all-of';
+export * from './document-position';
+export * from './document-position-result';
+export * from './document-position-result-all-of';
+export * from './document-type';
+export * from './document-type-recognition-result';
+export * from './document-types-candidates';
+export * from './document-types-candidates-list';
+export * from './document-types-candidates-result';
+export * from './document-types-candidates-result-all-of';
+export * from './encrypted-rclresult';
+export * from './encrypted-rclresult-all-of';
+export * from './fdsidlist';
+export * from './fiber-result';
+export * from './fiber-result-all-of';
+export * from './graphic-field';
+export * from './graphic-field-type';
+export * from './graphic-fields-list';
+export * from './graphics-result';
+export * from './graphics-result-all-of';
+export * from './ident-result';
+export * from './ident-result-all-of';
+export * from './image-data';
+export * from './image-qa';
+export * from './image-quality-check';
+export * from './image-quality-check-list';
+export * from './image-quality-check-type';
+export * from './image-quality-result';
+export * from './image-quality-result-all-of';
+export * from './images';
+export * from './images-available-source';
+export * from './images-field';
+export * from './images-field-value';
+export * from './images-result';
+export * from './images-result-all-of';
+export * from './lcid';
+export * from './lexical-analysis-result';
+export * from './lexical-analysis-result-all-of';
+export * from './license-result';
+export * from './license-result-all-of';
+export * from './light';
+export * from './list-verified-fields';
+export * from './log-level';
+export * from './mrzformat';
+export * from './measure-system';
+export * from './ocrsecurity-text-result';
+export * from './ocrsecurity-text-result-all-of';
+export * from './one-candidate';
+export * from './original-symbol';
+export * from './parray-field';
+export * from './per-document-config';
+export * from './photo-ident-result';
+export * from './photo-ident-result-all-of';
+export * from './point';
+export * from './point-array';
+export * from './points-container';
+export * from './process-params';
+export * from './process-request';
+export * from './process-request-image';
+export * from './process-response';
+export * from './process-system-info';
+export * from './processing-status';
+export * from './raw-image-container-list';
+export * from './rectangle-coordinates';
+export * from './result';
+export * from './result-item';
+export * from './rfid-location';
+export * from './rfid-origin';
+export * from './scenario';
+export * from './security-feature-result';
+export * from './security-feature-result-all-of';
+export * from './security-feature-type';
+export * from './source';
+export * from './source-validity';
+export * from './status';
+export * from './status-result';
+export * from './status-result-all-of';
+export * from './string-recognition-result';
+export * from './symbol-candidate';
+export * from './symbol-recognition-result';
+export * from './text';
+export * from './text-available-source';
+export * from './text-data-result';
+export * from './text-data-result-all-of';
+export * from './text-field';
+export * from './text-field-type';
+export * from './text-field-value';
+export * from './text-post-processing';
+export * from './text-result';
+export * from './text-result-all-of';
+export * from './transaction-info';
+export * from './verification-result';
+export * from './verified-field-map';
+export * from './visibility';