@regulaforensics/vp-frontend-document-components 2.0.1 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (151) hide show
  1. package/README.md +67 -18
  2. package/dist/main.js +1 -1
  3. package/esm/main.js +1 -1
  4. package/lib/components/DocumentCapture.d.ts +1 -1
  5. package/lib/components/DocumentReaderFileCapture.d.ts +3 -3
  6. package/lib/constants.d.ts +40 -1
  7. package/lib/hooks/useDocumentReaderSeries.d.ts +1 -1
  8. package/lib/hooks/useDocumentReaderSingle.d.ts +3 -3
  9. package/lib/models/DocReaderWebclient/ext/authenticity/authenticity.d.ts +32 -0
  10. package/lib/models/DocReaderWebclient/ext/authenticity/fiber.d.ts +7 -0
  11. package/lib/models/DocReaderWebclient/ext/authenticity/ident.d.ts +8 -0
  12. package/lib/models/DocReaderWebclient/ext/authenticity/image-ident.d.ts +7 -0
  13. package/lib/models/DocReaderWebclient/ext/authenticity/index.d.ts +5 -0
  14. package/lib/models/DocReaderWebclient/ext/authenticity/ocr-security-text.d.ts +7 -0
  15. package/lib/models/DocReaderWebclient/ext/authenticity/security-feature.d.ts +8 -0
  16. package/lib/models/DocReaderWebclient/ext/images.d.ts +16 -0
  17. package/lib/models/DocReaderWebclient/ext/index.d.ts +6 -0
  18. package/lib/models/DocReaderWebclient/ext/process-request-image.d.ts +5 -0
  19. package/lib/models/DocReaderWebclient/ext/process-request.d.ts +38 -0
  20. package/lib/models/DocReaderWebclient/ext/process-response.d.ts +36 -0
  21. package/lib/models/DocReaderWebclient/ext/text-field.d.ts +40 -0
  22. package/lib/models/DocReaderWebclient/ext/text.d.ts +14 -0
  23. package/lib/models/DocReaderWebclient/models/area-array.d.ts +32 -0
  24. package/lib/models/DocReaderWebclient/models/area-container.d.ts +38 -0
  25. package/lib/models/DocReaderWebclient/models/authenticity-check-list.d.ts +31 -0
  26. package/lib/models/DocReaderWebclient/models/authenticity-check-result-item.d.ts +38 -0
  27. package/lib/models/DocReaderWebclient/models/authenticity-check-result.d.ts +43 -0
  28. package/lib/models/DocReaderWebclient/models/authenticity-result-all-of.d.ts +25 -0
  29. package/lib/models/DocReaderWebclient/models/authenticity-result-type.d.ts +33 -0
  30. package/lib/models/DocReaderWebclient/models/authenticity-result.d.ts +18 -0
  31. package/lib/models/DocReaderWebclient/models/bc-pdf417-info.d.ts +54 -0
  32. package/lib/models/DocReaderWebclient/models/bc-roidetect.d.ts +42 -0
  33. package/lib/models/DocReaderWebclient/models/check-diagnose.d.ts +98 -0
  34. package/lib/models/DocReaderWebclient/models/check-result.d.ts +30 -0
  35. package/lib/models/DocReaderWebclient/models/chosen-document-type-result-all-of.d.ts +25 -0
  36. package/lib/models/DocReaderWebclient/models/chosen-document-type-result.d.ts +19 -0
  37. package/lib/models/DocReaderWebclient/models/chosen-document-type.d.ts +74 -0
  38. package/lib/models/DocReaderWebclient/models/container-list.d.ts +45 -0
  39. package/lib/models/DocReaderWebclient/models/critical.d.ts +26 -0
  40. package/lib/models/DocReaderWebclient/models/cross-source-value-comparison.d.ts +38 -0
  41. package/lib/models/DocReaderWebclient/models/data-module.d.ts +48 -0
  42. package/lib/models/DocReaderWebclient/models/details-optical.d.ts +67 -0
  43. package/lib/models/DocReaderWebclient/models/details-rfid.d.ts +61 -0
  44. package/lib/models/DocReaderWebclient/models/device-info.d.ts +54 -0
  45. package/lib/models/DocReaderWebclient/models/doc-bar-code-info-all-of.d.ts +31 -0
  46. package/lib/models/DocReaderWebclient/models/doc-bar-code-info.d.ts +19 -0
  47. package/lib/models/DocReaderWebclient/models/doc-visual-extended-field.d.ts +70 -0
  48. package/lib/models/DocReaderWebclient/models/doc-visual-extended-info.d.ts +25 -0
  49. package/lib/models/DocReaderWebclient/models/document-format.d.ts +70 -0
  50. package/lib/models/DocReaderWebclient/models/document-image-result-all-of.d.ts +25 -0
  51. package/lib/models/DocReaderWebclient/models/document-image-result.d.ts +18 -0
  52. package/lib/models/DocReaderWebclient/models/document-image.d.ts +24 -0
  53. package/lib/models/DocReaderWebclient/models/document-position-result-all-of.d.ts +25 -0
  54. package/lib/models/DocReaderWebclient/models/document-position-result.d.ts +19 -0
  55. package/lib/models/DocReaderWebclient/models/document-position.d.ts +80 -0
  56. package/lib/models/DocReaderWebclient/models/document-type-recognition-result.d.ts +30 -0
  57. package/lib/models/DocReaderWebclient/models/document-type.d.ts +246 -0
  58. package/lib/models/DocReaderWebclient/models/document-types-candidates-list.d.ts +32 -0
  59. package/lib/models/DocReaderWebclient/models/document-types-candidates-result-all-of.d.ts +25 -0
  60. package/lib/models/DocReaderWebclient/models/document-types-candidates-result.d.ts +18 -0
  61. package/lib/models/DocReaderWebclient/models/document-types-candidates.d.ts +32 -0
  62. package/lib/models/DocReaderWebclient/models/encrypted-rclresult-all-of.d.ts +24 -0
  63. package/lib/models/DocReaderWebclient/models/encrypted-rclresult.d.ts +18 -0
  64. package/lib/models/DocReaderWebclient/models/fdsidlist.d.ts +80 -0
  65. package/lib/models/DocReaderWebclient/models/fiber-result-all-of.d.ts +74 -0
  66. package/lib/models/DocReaderWebclient/models/fiber-result.d.ts +18 -0
  67. package/lib/models/DocReaderWebclient/models/graphic-field-type.d.ts +118 -0
  68. package/lib/models/DocReaderWebclient/models/graphic-field.d.ts +63 -0
  69. package/lib/models/DocReaderWebclient/models/graphic-fields-list.d.ts +25 -0
  70. package/lib/models/DocReaderWebclient/models/graphics-result-all-of.d.ts +25 -0
  71. package/lib/models/DocReaderWebclient/models/graphics-result.d.ts +19 -0
  72. package/lib/models/DocReaderWebclient/models/ident-result-all-of.d.ts +65 -0
  73. package/lib/models/DocReaderWebclient/models/ident-result.d.ts +18 -0
  74. package/lib/models/DocReaderWebclient/models/image-data.d.ts +24 -0
  75. package/lib/models/DocReaderWebclient/models/image-qa.d.ts +54 -0
  76. package/lib/models/DocReaderWebclient/models/image-quality-check-list.d.ts +32 -0
  77. package/lib/models/DocReaderWebclient/models/image-quality-check-type.d.ts +50 -0
  78. package/lib/models/DocReaderWebclient/models/image-quality-check.d.ts +64 -0
  79. package/lib/models/DocReaderWebclient/models/image-quality-result-all-of.d.ts +25 -0
  80. package/lib/models/DocReaderWebclient/models/image-quality-result.d.ts +18 -0
  81. package/lib/models/DocReaderWebclient/models/images-available-source.d.ts +31 -0
  82. package/lib/models/DocReaderWebclient/models/images-field-value.d.ts +70 -0
  83. package/lib/models/DocReaderWebclient/models/images-field.d.ts +38 -0
  84. package/lib/models/DocReaderWebclient/models/images-result-all-of.d.ts +25 -0
  85. package/lib/models/DocReaderWebclient/models/images-result.d.ts +18 -0
  86. package/lib/models/DocReaderWebclient/models/images.d.ts +32 -0
  87. package/lib/models/DocReaderWebclient/models/index.d.ts +123 -0
  88. package/lib/models/DocReaderWebclient/models/lcid.d.ts +582 -0
  89. package/lib/models/DocReaderWebclient/models/lexical-analysis-result-all-of.d.ts +25 -0
  90. package/lib/models/DocReaderWebclient/models/lexical-analysis-result.d.ts +19 -0
  91. package/lib/models/DocReaderWebclient/models/license-result-all-of.d.ts +24 -0
  92. package/lib/models/DocReaderWebclient/models/license-result.d.ts +18 -0
  93. package/lib/models/DocReaderWebclient/models/light.d.ts +34 -0
  94. package/lib/models/DocReaderWebclient/models/list-verified-fields.d.ts +25 -0
  95. package/lib/models/DocReaderWebclient/models/log-level.d.ts +23 -0
  96. package/lib/models/DocReaderWebclient/models/measure-system.d.ts +26 -0
  97. package/lib/models/DocReaderWebclient/models/mrzformat.d.ts +24 -0
  98. package/lib/models/DocReaderWebclient/models/ocrsecurity-text-result-all-of.d.ts +81 -0
  99. package/lib/models/DocReaderWebclient/models/ocrsecurity-text-result.d.ts +18 -0
  100. package/lib/models/DocReaderWebclient/models/one-candidate.d.ts +74 -0
  101. package/lib/models/DocReaderWebclient/models/original-symbol.d.ts +37 -0
  102. package/lib/models/DocReaderWebclient/models/parray-field.d.ts +81 -0
  103. package/lib/models/DocReaderWebclient/models/per-document-config.d.ts +30 -0
  104. package/lib/models/DocReaderWebclient/models/photo-ident-result-all-of.d.ts +76 -0
  105. package/lib/models/DocReaderWebclient/models/photo-ident-result.d.ts +18 -0
  106. package/lib/models/DocReaderWebclient/models/point-array.d.ts +25 -0
  107. package/lib/models/DocReaderWebclient/models/point.d.ts +30 -0
  108. package/lib/models/DocReaderWebclient/models/points-container.d.ts +31 -0
  109. package/lib/models/DocReaderWebclient/models/process-params.d.ts +254 -0
  110. package/lib/models/DocReaderWebclient/models/process-request-image.d.ts +38 -0
  111. package/lib/models/DocReaderWebclient/models/process-request.d.ts +60 -0
  112. package/lib/models/DocReaderWebclient/models/process-response.d.ts +66 -0
  113. package/lib/models/DocReaderWebclient/models/process-system-info.d.ts +30 -0
  114. package/lib/models/DocReaderWebclient/models/processing-status.d.ts +30 -0
  115. package/lib/models/DocReaderWebclient/models/raw-image-container-list.d.ts +31 -0
  116. package/lib/models/DocReaderWebclient/models/rectangle-coordinates.d.ts +42 -0
  117. package/lib/models/DocReaderWebclient/models/result-item.d.ts +48 -0
  118. package/lib/models/DocReaderWebclient/models/result.d.ts +98 -0
  119. package/lib/models/DocReaderWebclient/models/rfid-location.d.ts +30 -0
  120. package/lib/models/DocReaderWebclient/models/rfid-origin.d.ts +42 -0
  121. package/lib/models/DocReaderWebclient/models/scenario.d.ts +36 -0
  122. package/lib/models/DocReaderWebclient/models/security-feature-result-all-of.d.ts +59 -0
  123. package/lib/models/DocReaderWebclient/models/security-feature-result.d.ts +18 -0
  124. package/lib/models/DocReaderWebclient/models/security-feature-type.d.ts +49 -0
  125. package/lib/models/DocReaderWebclient/models/source-validity.d.ts +32 -0
  126. package/lib/models/DocReaderWebclient/models/source.d.ts +23 -0
  127. package/lib/models/DocReaderWebclient/models/status-result-all-of.d.ts +25 -0
  128. package/lib/models/DocReaderWebclient/models/status-result.d.ts +18 -0
  129. package/lib/models/DocReaderWebclient/models/status.d.ts +63 -0
  130. package/lib/models/DocReaderWebclient/models/string-recognition-result.d.ts +25 -0
  131. package/lib/models/DocReaderWebclient/models/symbol-candidate.d.ts +30 -0
  132. package/lib/models/DocReaderWebclient/models/symbol-recognition-result.d.ts +32 -0
  133. package/lib/models/DocReaderWebclient/models/text-available-source.d.ts +38 -0
  134. package/lib/models/DocReaderWebclient/models/text-data-result-all-of.d.ts +25 -0
  135. package/lib/models/DocReaderWebclient/models/text-data-result.d.ts +19 -0
  136. package/lib/models/DocReaderWebclient/models/text-field-type.d.ts +2386 -0
  137. package/lib/models/DocReaderWebclient/models/text-field-value.d.ts +70 -0
  138. package/lib/models/DocReaderWebclient/models/text-field.d.ts +84 -0
  139. package/lib/models/DocReaderWebclient/models/text-post-processing.d.ts +22 -0
  140. package/lib/models/DocReaderWebclient/models/text-result-all-of.d.ts +25 -0
  141. package/lib/models/DocReaderWebclient/models/text-result.d.ts +18 -0
  142. package/lib/models/DocReaderWebclient/models/text.d.ts +51 -0
  143. package/lib/models/DocReaderWebclient/models/transaction-info.d.ts +42 -0
  144. package/lib/models/DocReaderWebclient/models/verification-result.d.ts +38 -0
  145. package/lib/models/DocReaderWebclient/models/verified-field-map.d.ts +63 -0
  146. package/lib/models/DocReaderWebclient/models/visibility.d.ts +23 -0
  147. package/lib/services/DocumentReaderProcessor.d.ts +7 -15
  148. package/lib/services/DocumentReaderService.d.ts +10 -4
  149. package/lib/types.d.ts +12 -9
  150. package/lib/utils.d.ts +4 -1
  151. package/package.json +1 -3
@@ -1,6 +1,6 @@
1
1
  import * as React from 'react';
2
2
  import { DocumentCompletionStatus } from '../constants';
3
- import { Response as DocumentReaderResponseType } from '@regulaforensics/document-reader-webclient/src/ext/process-response';
3
+ import { Response as DocumentReaderResponseType } from '../models/DocReaderWebclient/ext';
4
4
  declare type DocumentCaptureProps = {
5
5
  onResponse: (res: DocumentReaderResponseType) => void;
6
6
  onStatusChange: (statusData: DocumentCompletionStatus) => void;
@@ -1,11 +1,11 @@
1
1
  /// <reference types="react" />
2
- import { DocumentCompletionStatus } from '../constants';
3
- import { Response as DocumentReaderResponseType } from '@regulaforensics/document-reader-webclient/src/ext/process-response';
2
+ import { DocumentCompletionStatus, InternalScenarios } from '../constants';
3
+ import { Response as DocumentReaderResponseType } from '../models/DocReaderWebclient/ext';
4
4
  declare type DocumentReaderFileCaptureProps = {
5
5
  onStatusChange: (completionStatus: DocumentCompletionStatus) => void;
6
6
  onResponse: (response: DocumentReaderResponseType) => void;
7
7
  images: FileList | null;
8
- scenario?: string;
8
+ scenario?: InternalScenarios;
9
9
  license?: string;
10
10
  };
11
11
  declare function DocumentReaderFileCapture({ onStatusChange, onResponse, images, scenario, license, }: DocumentReaderFileCaptureProps): JSX.Element;
@@ -312,7 +312,7 @@ export declare const DocumentReaderStatusByError: {
312
312
  WASM_LICENSE: DocumentCompletionStatus;
313
313
  INCORRECT_FILE: DocumentCompletionStatus;
314
314
  };
315
- export declare const DocumentReaderStatusByCaptureStatus: {
315
+ export declare const DocumentReaderFinishStatusByCaptureStatus: {
316
316
  "DocumentCaptureStatus.SUCCESS": DocumentCompletionStatus;
317
317
  "DocumentCaptureStatus.TIMEOUT": DocumentCompletionStatus;
318
318
  "DocumentCaptureStatus.FAILED": DocumentCompletionStatus;
@@ -566,3 +566,42 @@ export declare const DocumentScenarioFrameParams: {
566
566
  manualCrop?: undefined;
567
567
  })[];
568
568
  };
569
+ export declare const DocumentReaderRecognizerDefaultRequest: {
570
+ processParam: {
571
+ scenario: InternalScenarios;
572
+ returnUncroppedImage: boolean;
573
+ multipageProcessing: boolean;
574
+ timeoutFromFirstDetect: number;
575
+ timeoutFromFirstDocType: number;
576
+ imageQa: {
577
+ expectedPass: string[];
578
+ dpiThreshold: number;
579
+ glaresCheck: boolean;
580
+ glaresCheckParams: {
581
+ imgMarginPart: number;
582
+ maxGlaringPart: number;
583
+ };
584
+ };
585
+ };
586
+ };
587
+ export declare const DocumentReaderImageDefaultRequest: {
588
+ processParam: {
589
+ scenario: InternalScenarios;
590
+ returnUncroppedImage: boolean;
591
+ };
592
+ };
593
+ export declare const SDKDocumentReaderRecognizerDefaultRequest: {
594
+ processParam: {
595
+ scenario: InternalScenarios;
596
+ returnUncroppedImage: boolean;
597
+ timeoutFromFirstDetect: number;
598
+ timeoutFromFirstDocType: number;
599
+ };
600
+ };
601
+ export declare const SDKDocumentReaderImageDefaultRequest: {
602
+ processParam: {
603
+ scenario: InternalScenarios;
604
+ returnUncroppedImage: boolean;
605
+ };
606
+ };
607
+ export declare const AcceptedFiles: string[];
@@ -1,4 +1,4 @@
1
- import { Response } from '@regulaforensics/document-reader-webclient';
1
+ import { Response } from '../models/DocReaderWebclient/ext';
2
2
  import { DocumentCaptureStatus, DocumentEventActions, InternalScenarios, ObjectFit, StreamStatus } from '../constants';
3
3
  import { FrameParamsType, VideoParamsType } from '../types';
4
4
  import CustomError from '../models/CustomError';
@@ -1,5 +1,5 @@
1
- import { DocumentCaptureStatus } from '../constants';
2
- import { Response } from '@regulaforensics/document-reader-webclient';
1
+ import { DocumentCaptureStatus, InternalScenarios } from '../constants';
2
+ import { Response } from '../models/DocReaderWebclient/ext';
3
3
  import CustomError from '../models/CustomError';
4
4
  declare type ResponseType = {
5
5
  status: DocumentCaptureStatus;
@@ -9,7 +9,7 @@ declare type ResponseType = {
9
9
  prepared: boolean;
10
10
  };
11
11
  declare function useDocumentReaderSingle(imageDataArray: Array<ImageData>, options: {
12
- scenario?: string;
12
+ scenario?: InternalScenarios;
13
13
  license?: string;
14
14
  }): ResponseType;
15
15
  export default useDocumentReaderSingle;
@@ -0,0 +1,32 @@
1
+ import { AuthenticityCheckList as BaseAuthenticityCheckList, AuthenticityCheckResult } from '../../models';
2
+ import { FiberChecks } from './fiber';
3
+ import { IdentChecks } from './ident';
4
+ import { ImageIdentChecks } from './image-ident';
5
+ import { OCRSecurityTextChecks } from './ocr-security-text';
6
+ import { SecurityFeatureChecks } from './security-feature';
7
+ export declare class Authenticity implements BaseAuthenticityCheckList {
8
+ List: Array<AuthenticityCheckResult>;
9
+ page_idx: number;
10
+ constructor(origin: BaseAuthenticityCheckList, page_idx: number);
11
+ uvLuminescenceChecks(): SecurityFeatureChecks | undefined;
12
+ irB900Checks(): SecurityFeatureChecks | undefined;
13
+ imagePatternChecks(): IdentChecks | undefined;
14
+ axialProtectionChecks(): SecurityFeatureChecks | undefined;
15
+ uvFiberChecks(): FiberChecks | undefined;
16
+ irVisibilityChecks(): IdentChecks | undefined;
17
+ ocrSecurityTextChecks(): OCRSecurityTextChecks | undefined;
18
+ ipiChecks(): ImageIdentChecks | undefined;
19
+ embedImageChecks(): SecurityFeatureChecks | undefined;
20
+ hologramsChecks(): SecurityFeatureChecks | undefined;
21
+ imageAreaChecks(): SecurityFeatureChecks | undefined;
22
+ portraitComparisonChecks(): IdentChecks | undefined;
23
+ barcodeFormatCheckChecks(): SecurityFeatureChecks | undefined;
24
+ kinegramChecks(): IdentChecks | undefined;
25
+ letterScreenChecks(): IdentChecks | undefined;
26
+ resultByType(authenticityType: number): AuthenticityCheckResult | undefined;
27
+ private fiberOrUndefined;
28
+ private identOrUndefined;
29
+ private imageIdentOrUndefined;
30
+ private ocrSecurityTextOrUndefined;
31
+ private securityFeatureOrUndefined;
32
+ }
@@ -0,0 +1,7 @@
1
+ import { AuthenticityCheckResult, AuthenticityResultType, CheckResult, FiberResult } from '../../models';
2
+ export declare class FiberChecks implements AuthenticityCheckResult {
3
+ List: Array<FiberResult>;
4
+ Result: CheckResult;
5
+ Type: AuthenticityResultType;
6
+ constructor(origin: AuthenticityCheckResult);
7
+ }
@@ -0,0 +1,8 @@
1
+ import { AuthenticityCheckResult, AuthenticityResultType, CheckResult, IdentResult, SecurityFeatureType } from '../../models';
2
+ export declare class IdentChecks implements AuthenticityCheckResult {
3
+ List: Array<IdentResult>;
4
+ Result: CheckResult;
5
+ Type: AuthenticityResultType;
6
+ constructor(origin: AuthenticityCheckResult);
7
+ checksByElement(elementType: SecurityFeatureType): Array<IdentResult>;
8
+ }
@@ -0,0 +1,7 @@
1
+ import { AuthenticityCheckResult, AuthenticityResultType, CheckResult, PhotoIdentResult } from '../../models';
2
+ export declare class ImageIdentChecks implements AuthenticityCheckResult {
3
+ List: Array<PhotoIdentResult>;
4
+ Result: CheckResult;
5
+ Type: AuthenticityResultType;
6
+ constructor(origin: AuthenticityCheckResult);
7
+ }
@@ -0,0 +1,5 @@
1
+ export * from './authenticity';
2
+ export * from './fiber';
3
+ export * from './ident';
4
+ export * from './ocr-security-text';
5
+ export * from './security-feature';
@@ -0,0 +1,7 @@
1
+ import { AuthenticityCheckResult, AuthenticityResultType, CheckResult, OCRSecurityTextResult } from '../../models';
2
+ export declare class OCRSecurityTextChecks implements AuthenticityCheckResult {
3
+ List: Array<OCRSecurityTextResult>;
4
+ Result: CheckResult;
5
+ Type: AuthenticityResultType;
6
+ constructor(origin: AuthenticityCheckResult);
7
+ }
@@ -0,0 +1,8 @@
1
+ import { AuthenticityCheckResult, AuthenticityResultType, CheckResult, SecurityFeatureResult, SecurityFeatureType } from '../../models';
2
+ export declare class SecurityFeatureChecks implements AuthenticityCheckResult {
3
+ List: Array<SecurityFeatureResult>;
4
+ Result: CheckResult;
5
+ Type: AuthenticityResultType;
6
+ constructor(origin: AuthenticityCheckResult);
7
+ checksByElement(elementType: SecurityFeatureType): Array<SecurityFeatureResult>;
8
+ }
@@ -0,0 +1,16 @@
1
+ import { GraphicFieldType, Images as BaseImages, ImagesField as BaseImagesField, ImagesAvailableSource, ImagesFieldValue, Source } from '../models';
2
+ export declare class Images implements BaseImages {
3
+ availableSourceList: Array<ImagesAvailableSource>;
4
+ fieldList: Array<ImagesField>;
5
+ constructor(origin: BaseImages);
6
+ getField(type: GraphicFieldType): ImagesField | undefined;
7
+ getFields(type: GraphicFieldType): Array<ImagesField> | undefined;
8
+ }
9
+ export declare class ImagesField implements BaseImagesField {
10
+ fieldName: string;
11
+ fieldType: GraphicFieldType;
12
+ valueList: Array<ImagesFieldValue>;
13
+ constructor(origin: BaseImagesField);
14
+ getValue(source?: Source, original?: boolean): ArrayBuffer | undefined;
15
+ private getValueBySource;
16
+ }
@@ -0,0 +1,6 @@
1
+ export * from './process-request';
2
+ export * from './process-request-image';
3
+ export * from './process-response';
4
+ export * from './text';
5
+ export * from './images';
6
+ export * from './text-field';
@@ -0,0 +1,5 @@
1
+ import { ProcessRequestImage as ProcessRequestImageBase } from '../models';
2
+ import { Base64String } from './process-request';
3
+ export interface ProcessRequestImage extends Omit<ProcessRequestImageBase, 'ImageData'> {
4
+ ImageData: ArrayBuffer | Base64String;
5
+ }
@@ -0,0 +1,38 @@
1
+ import { ContainerList, ProcessParams, ProcessSystemInfo } from '../models';
2
+ import { ProcessRequestImage } from './process-request-image';
3
+ export declare type Base64String = string;
4
+ export interface ProcessRequest {
5
+ /**
6
+ *
7
+ * @type {ProcessParams}
8
+ * @memberof ProcessRequest
9
+ */
10
+ processParam: ProcessParams;
11
+ /**
12
+ *
13
+ * @type {Array<ProcessRequestImage>}
14
+ * @memberof ProcessRequest
15
+ */
16
+ images: Array<ProcessRequestImage | ArrayBuffer | Base64String>;
17
+ /**
18
+ * @type {ContainerList}
19
+ * @memberOf ProcessRequest
20
+ */
21
+ ContainerList: ContainerList;
22
+ /**
23
+ *
24
+ * @type {ProcessParams}
25
+ * @memberof ProcessRequest
26
+ */
27
+ systemInfo?: ProcessSystemInfo;
28
+ /**
29
+ * Free-form object to be included in response. Must be object, not list or simple value.
30
+ * Do not affect document processing. Use it freely to pass your app params. Stored in process logs.
31
+ * @type {{ [key: string]: object; }}
32
+ * @memberof ProcessRequest
33
+ */
34
+ passBackObject?: {
35
+ [key: string]: any;
36
+ };
37
+ }
38
+ export declare const instanceOfProcessRequest: (data: any) => data is ProcessRequest;
@@ -0,0 +1,36 @@
1
+ import { AuthenticityResult, ContainerList, ImageQualityCheckList, ImagesResult, ProcessingStatus, ProcessResponse, Result, ResultItem, RfidLocation, Status, StatusResult, TextResult, ChosenDocumentTypeResult, DocBarCodeInfo, TransactionInfo } from '../models';
2
+ import { Text } from './text';
3
+ import { Images } from './images';
4
+ import { Authenticity } from './authenticity';
5
+ export declare class Response {
6
+ status?: Status;
7
+ text?: Text;
8
+ images?: Images;
9
+ lowLvlResponse: LowLvlResponse;
10
+ rawResponse: ProcessResponse;
11
+ constructor(original: ProcessResponse);
12
+ authenticity(page_idx?: number): Authenticity | undefined;
13
+ authenticityPerPage(): Array<Authenticity>;
14
+ imageQualityChecks(page_idx?: number): ImageQualityCheckList | undefined;
15
+ imageQualityChecksPerPage(): Array<ImageQualityCheckList> | undefined;
16
+ }
17
+ export declare class LowLvlResponse implements ProcessResponse {
18
+ ContainerList: ContainerList;
19
+ ProcessingFinished: ProcessingStatus;
20
+ TransactionInfo: TransactionInfo;
21
+ ChipPage?: RfidLocation;
22
+ log?: string;
23
+ passBackObject?: {
24
+ [key: string]: any;
25
+ };
26
+ morePagesAvailable?: number;
27
+ constructor(original: ProcessResponse);
28
+ statusResult(): StatusResult | undefined;
29
+ textResult(): TextResult | undefined;
30
+ imagesResult(): ImagesResult | undefined;
31
+ barcodeResult(): DocBarCodeInfo | undefined;
32
+ documentTypeResults(): Array<ChosenDocumentTypeResult> | undefined;
33
+ resultByType(type: Result): ResultItem | undefined;
34
+ resultByTypeAndPage(type: Result, page_idx?: number): ResultItem | undefined;
35
+ resultsByType(type: Result): Array<ResultItem | AuthenticityResult | ImageQualityCheckList>;
36
+ }
@@ -0,0 +1,40 @@
1
+ import { CheckResult, CrossSourceValueComparison, Source, SourceValidity, TextField as BaseTextField, TextFieldType, TextFieldValue } from '../models';
2
+ export declare class TextField implements BaseTextField {
3
+ fieldType: TextFieldType;
4
+ fieldName: string;
5
+ lcid?: number;
6
+ status: CheckResult;
7
+ validityStatus: CheckResult;
8
+ comparisonStatus: CheckResult;
9
+ value: string;
10
+ valueList: Array<TextFieldValue>;
11
+ validityList: Array<SourceValidity>;
12
+ comparisonList: Array<CrossSourceValueComparison>;
13
+ constructor(origin: BaseTextField);
14
+ /**
15
+ * This method returns value of the text field. Value encoded in UTF8.
16
+ * Fields value obtained in the following order:
17
+ * - if MRZ value is present, it will be taken
18
+ * - if no MRZ, but RFID value is present, it will be taken
19
+ * - if no MRZ, no RFID, but Barcode value is present, it will be taken
20
+ * - if no MRZ, no RFID, no Barcode, but Visual OCR value is present, it will be taken
21
+ *
22
+ * @param source See {@code Source}
23
+ * @param original Each value formatted according to input params and server settings.
24
+ * To get original representation, set this flag to true. Date example:
25
+ * - original visual value - "3 January 2009"
26
+ * - formatted value - "03.01.2009"
27
+ */
28
+ getValue(source?: Source, original?: boolean): string | undefined;
29
+ /**
30
+ * Returns validity check of all values for given source.
31
+ * @param source See {@code Source}
32
+ */
33
+ sourceValidity(source: Source): CheckResult;
34
+ /**
35
+ * Returns value matching result for different sources.
36
+ */
37
+ crossSourceComparison(one: Source, other: Source): CheckResult;
38
+ getLCIDName(): string | undefined;
39
+ private getValueBySource;
40
+ }
@@ -0,0 +1,14 @@
1
+ import { TextAvailableSource as AvailableSource, CheckResult, Text as BaseText, TextFieldType } from '../models';
2
+ import { TextField } from './text-field';
3
+ export declare class Text implements BaseText {
4
+ status: CheckResult;
5
+ validityStatus: CheckResult;
6
+ comparisonStatus: CheckResult;
7
+ availableSourceList: Array<AvailableSource>;
8
+ fieldList: Array<TextField>;
9
+ constructor(origin: BaseText);
10
+ getField(type: TextFieldType, lcid?: number): TextField | undefined;
11
+ getFieldByName(name: string, lcid?: number): TextField | undefined;
12
+ getFieldValue(type: TextFieldType, lcid?: number): string | undefined;
13
+ getFieldValueByName(name: string, lcid?: number): string | undefined;
14
+ }
@@ -0,0 +1,32 @@
1
+ /**
2
+ * Regula Document Reader Web API
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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { PointArray } from './point-array';
13
+ import { RectangleCoordinates } from './rectangle-coordinates';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface AreaArray
18
+ */
19
+ export interface AreaArray {
20
+ /**
21
+ *
22
+ * @type {Array<RectangleCoordinates>}
23
+ * @memberof AreaArray
24
+ */
25
+ List?: Array<RectangleCoordinates>;
26
+ /**
27
+ *
28
+ * @type {Array<PointArray>}
29
+ * @memberof AreaArray
30
+ */
31
+ Points?: Array<PointArray>;
32
+ }
@@ -0,0 +1,38 @@
1
+ /**
2
+ * Regula Document Reader Web API
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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { PointsContainer } from './points-container';
13
+ import { RectangleCoordinates } from './rectangle-coordinates';
14
+ /**
15
+ * Checked fragment coordinates
16
+ * @export
17
+ * @interface AreaContainer
18
+ */
19
+ export interface AreaContainer {
20
+ /**
21
+ *
22
+ * @type {number}
23
+ * @memberof AreaContainer
24
+ */
25
+ Count?: number;
26
+ /**
27
+ *
28
+ * @type {Array<RectangleCoordinates>}
29
+ * @memberof AreaContainer
30
+ */
31
+ List?: Array<RectangleCoordinates>;
32
+ /**
33
+ *
34
+ * @type {Array<PointsContainer>}
35
+ * @memberof AreaContainer
36
+ */
37
+ Points?: Array<PointsContainer>;
38
+ }
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Regula Document Reader Web API
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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AuthenticityCheckResult } from './authenticity-check-result';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface AuthenticityCheckList
17
+ */
18
+ export interface AuthenticityCheckList {
19
+ /**
20
+ * Count of items in List
21
+ * @type {number}
22
+ * @memberof AuthenticityCheckList
23
+ */
24
+ Count?: number;
25
+ /**
26
+ * Authenticity Check
27
+ * @type {Array<AuthenticityCheckResult>}
28
+ * @memberof AuthenticityCheckList
29
+ */
30
+ List: Array<AuthenticityCheckResult>;
31
+ }
@@ -0,0 +1,38 @@
1
+ /**
2
+ * Regula Document Reader Web API
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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { CheckDiagnose } from './check-diagnose';
13
+ import { CheckResult } from './check-result';
14
+ /**
15
+ * Common fields for all authenticity result objects
16
+ * @export
17
+ * @interface AuthenticityCheckResultItem
18
+ */
19
+ export interface AuthenticityCheckResultItem {
20
+ /**
21
+ * Same as authenticity result type, but used for safe parsing of not-described values. See authenticity result type
22
+ * @type {number}
23
+ * @memberof AuthenticityCheckResultItem
24
+ */
25
+ Type: number;
26
+ /**
27
+ *
28
+ * @type {CheckResult}
29
+ * @memberof AuthenticityCheckResultItem
30
+ */
31
+ ElementResult?: CheckResult;
32
+ /**
33
+ *
34
+ * @type {CheckDiagnose}
35
+ * @memberof AuthenticityCheckResultItem
36
+ */
37
+ ElementDiagnose?: CheckDiagnose;
38
+ }
@@ -0,0 +1,43 @@
1
+ /**
2
+ * Regula Document Reader Web API
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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AuthenticityResultType } from './authenticity-result-type';
13
+ import { CheckResult } from './check-result';
14
+ import { FiberResult } from './fiber-result';
15
+ import { IdentResult } from './ident-result';
16
+ import { OCRSecurityTextResult } from './ocrsecurity-text-result';
17
+ import { PhotoIdentResult } from './photo-ident-result';
18
+ import { SecurityFeatureResult } from './security-feature-result';
19
+ /**
20
+ *
21
+ * @export
22
+ * @interface AuthenticityCheckResult
23
+ */
24
+ export interface AuthenticityCheckResult {
25
+ /**
26
+ *
27
+ * @type {AuthenticityResultType}
28
+ * @memberof AuthenticityCheckResult
29
+ */
30
+ Type: AuthenticityResultType;
31
+ /**
32
+ *
33
+ * @type {CheckResult}
34
+ * @memberof AuthenticityCheckResult
35
+ */
36
+ Result: CheckResult;
37
+ /**
38
+ *
39
+ * @type {Array<SecurityFeatureResult | IdentResult | FiberResult | OCRSecurityTextResult | PhotoIdentResult>}
40
+ * @memberof AuthenticityCheckResult
41
+ */
42
+ List: Array<SecurityFeatureResult | IdentResult | FiberResult | OCRSecurityTextResult | PhotoIdentResult>;
43
+ }
@@ -0,0 +1,25 @@
1
+ /**
2
+ * Regula Document Reader Web API
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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AuthenticityCheckList } from './authenticity-check-list';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface AuthenticityResultAllOf
17
+ */
18
+ export interface AuthenticityResultAllOf {
19
+ /**
20
+ *
21
+ * @type {AuthenticityCheckList}
22
+ * @memberof AuthenticityResultAllOf
23
+ */
24
+ AuthenticityCheckList: AuthenticityCheckList;
25
+ }
@@ -0,0 +1,33 @@
1
+ /**
2
+ * Regula Document Reader Web API
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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Enumeration describes available authenticity checks
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare enum AuthenticityResultType {
18
+ UV_LUMINESCENCE = 1,
19
+ IR_B900 = 2,
20
+ IMAGE_PATTERN = 4,
21
+ AXIAL_PROTECTION = 8,
22
+ UV_FIBERS = 16,
23
+ IR_VISIBILITY = 32,
24
+ OCR_SECURITY_TEXT = 64,
25
+ IPI = 128,
26
+ PHOTO_EMBED_TYPE = 512,
27
+ HOLOGRAMS = 4096,
28
+ PHOTO_AREA = 8192,
29
+ PORTRAIT_COMPARISON = 32768,
30
+ BARCODE_FORMAT_CHECK = 65536,
31
+ KINEGRAM = 131072,
32
+ LETTER_SCREEN = 262144
33
+ }
@@ -0,0 +1,18 @@
1
+ /**
2
+ * Regula Document Reader Web API
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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AuthenticityResultAllOf } from './authenticity-result-all-of';
13
+ import { ResultItem } from './result-item';
14
+ /**
15
+ * @type AuthenticityResult
16
+ * @export
17
+ */
18
+ export declare type AuthenticityResult = AuthenticityResultAllOf & ResultItem;