react-native-scanbot-barcode-scanner-sdk 7.1.2-rc.2 → 8.0.0-rc.1

package/src/{documents → types/core/generic_document}/CommonFieldType.ts

@@ -34,8 +34,8 @@ Common field types.
    Pseudonym field.
 - `MRZ`:
    MRZ field.
-- `COUNTRY_CODE`:
-   Country code (ISO-3166 Alpha-3) field.
+- `ISSUING_COUNTRY`:
+   Issuing country field.
 - `GENDER`:
    Gender field.
 - `SIGNATURE`:
@@ -58,37 +58,125 @@ Common field types.
    Full name field.
 - `CARD_ACCESS_NUMBER`:
    Card access number field.
+- `PERSONAL_ID`:
+   ID of the holder of the document.
 */
 export type CommonFieldType =
+  /**
+    Document ID.
+    */
   | 'ID'
+  /**
+    Person surname field.
+    */
   | 'SURNAME'
+  /**
+    Person maiden name field.
+    */
   | 'MAIDEN_NAME'
+  /**
+    Person given names field.
+    */
   | 'GIVEN_NAMES'
+  /**
+    Person birth date field.
+    */
   | 'BIRTH_DATE'
+  /**
+    Person nationality field.
+    */
   | 'NATIONALITY'
+  /**
+    Person birthplace field.
+    */
   | 'BIRTHPLACE'
+  /**
+    Document expiry date field.
+    */
   | 'EXPIRY_DATE'
+  /**
+    Person eye color field.
+    */
   | 'EYE_COLOR'
+  /**
+    Person height field.
+    */
   | 'HEIGHT'
+  /**
+    Document issue date field.
+    */
   | 'ISSUE_DATE'
+  /**
+    Document issuing authority field.
+    */
   | 'ISSUING_AUTHORITY'
+  /**
+    Address field.
+    */
   | 'ADDRESS'
+  /**
+    Pseudonym field.
+    */
   | 'PSEUDONYM'
+  /**
+    MRZ field.
+    */
   | 'MRZ'
-  | 'COUNTRY_CODE'
+  /**
+    Issuing country field.
+    */
+  | 'ISSUING_COUNTRY'
+  /**
+    Gender field.
+    */
   | 'GENDER'
+  /**
+    Signature field.
+    */
   | 'SIGNATURE'
+  /**
+    Photo field.
+    */
   | 'PHOTO'
+  /**
+    Date of start of validity field.
+    */
   | 'VALID_FROM_DATE'
+  /**
+    Check routing number.
+    */
   | 'ROUTING_NUMBER'
+  /**
+    Check account number.
+    */
   | 'ACCOUNT_NUMBER'
+  /**
+    Place of issue for the identity card.
+    */
   | 'PLACE_OF_ISSUE'
+  /**
+    Type of the title field in the identity document.
+    */
   | 'TITLE_TYPE'
+  /**
+    Remarks field in the identity document.
+    */
   | 'REMARKS'
+  /**
+    Full name field.
+    */
   | 'NAME'
-  | 'CARD_ACCESS_NUMBER';
+  /**
+    Card access number field.
+    */
+  | 'CARD_ACCESS_NUMBER'
+  /**
+    ID of the holder of the document.
+    */
+  | 'PERSONAL_ID';
 
-export const CommonFieldTypeValues: CommonFieldType[] = [
+/** @hidden */
+export const CommonFieldTypeValues: ReadonlyArray<CommonFieldType> = [
   'ID',
   'SURNAME',
   'MAIDEN_NAME',
@@ -104,7 +192,7 @@ export const CommonFieldTypeValues: CommonFieldType[] = [
   'ADDRESS',
   'PSEUDONYM',
   'MRZ',
-  'COUNTRY_CODE',
+  'ISSUING_COUNTRY',
   'GENDER',
   'SIGNATURE',
   'PHOTO',
@@ -116,4 +204,5 @@ export const CommonFieldTypeValues: CommonFieldType[] = [
   'REMARKS',
   'NAME',
   'CARD_ACCESS_NUMBER',
-];
+  'PERSONAL_ID',
+] as const;

package/src/{documents → types/core/generic_document}/GenericDocument.ts

@@ -1,15 +1,16 @@
 /// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
 /// Generated from core/schemas/GenericDocument.yaml
 
-import { CommonFieldType, CommonFieldTypeValues } from '../documents/CommonFieldType';
-import { ImageRef } from '../imageRef/image';
-import { ToJsonConfiguration } from '../utils/json/JsonSerializationTypes';
-import { DeepPartial, PartiallyConstructible, Point } from '../utils/utils';
+import { ToJsonConfiguration } from '../common/JsonSerializationTypes';
+import { ImageRef } from '../image/image';
+import type { Point } from '../utils/utils';
+import { DeepPartial } from '../utils/utils';
+import { CommonFieldType, CommonFieldTypeValues } from './CommonFieldType';
 
 /**
 Result of OCR text recognition.
 */
-export class OcrResult extends PartiallyConstructible {
+export class OcrResult {
   /**
     Maximum number of accumulated frames to inspect before actual result is returned.
     */
@@ -21,7 +22,6 @@ export class OcrResult extends PartiallyConstructible {
 
   /** @param source {@displayType `DeepPartial<OcrResult>`} */
   public constructor(source: DeepPartial<OcrResult> = {}) {
-    super();
     if (source.text !== undefined) {
       this.text = source.text;
     } else {
@@ -96,15 +96,50 @@ from systemic OCR errors, but in practice it still provides good results for mos
    The value of this field is always empty, although the field may be non-empty in the document.
 */
 export type FieldValidationStatus =
+  /**
+    Field value failed validation. This status is used for fields that have validation rules, like
+    IBAN, date fields, etc. that have check digits or a known format that can be validated.
+    */
   | 'INVALID'
+  /**
+    Field value was not recognized because it was obstructed by e.g. a light reflection or a shadow.
+    */
   | 'OBSTRUCTED'
+  /**
+    Field value was not validated, typically because the field does not support validation and the value
+    has not been seen enough times to confirm it.
+    If the same value is seen in multiple frames, the validation status will transition to CONFIRMED,
+    but only if that particular recognizer supports multiple frame accumulation.
+    */
   | 'NONE'
+  /**
+    The same field value was recognized in multiple frames, thereby confirming the value.
+    Occurs only for fields that have no validation rules otherwise.
+    A CONFIRMED value gives a strong guarantee that the field value has been read out without errors,
+    but not as strong as VALID. The value may still be incorrect, due to systemic OCR errors.
+    In case of OCR errors, increase the number of frames needed to confirm the value in the
+    recognizer configuration.
+    */
   | 'CONFIRMED'
+  /**
+    Field value was inferred from other fields or from domain knowledge.
+    The field value may differ from what is actually written in the document in unexpected situations.
+    */
   | 'INFERRED'
+  /**
+    Field value passed validation. This status is used for fields that have validation rules, like
+    IBAN, date fields, etc. that have check digits or a known format that can be validated.
+    The VALID status gives the strongest guarantee that the field value has been read out without errors.
+    */
   | 'VALID'
+  /**
+    The document contains a field of this type, but recognition for this field is disabled.
+    The value of this field is always empty, although the field may be non-empty in the document.
+    */
   | 'IGNORED';
 
-export const FieldValidationStatusValues: FieldValidationStatus[] = [
+/** @hidden */
+export const FieldValidationStatusValues: ReadonlyArray<FieldValidationStatus> = [
   'INVALID',
   'OBSTRUCTED',
   'NONE',
@@ -112,7 +147,7 @@ export const FieldValidationStatusValues: FieldValidationStatus[] = [
   'INFERRED',
   'VALID',
   'IGNORED',
-];
+] as const;
 
 /**
 Type of parsing applied to field.
@@ -131,26 +166,45 @@ Type of parsing applied to field.
    Field value is parsed as "Male", "Female".
 */
 export type FieldDataFormat =
+  /**
+    Field value is parsed as ISO 8601 date in format YYYY-MM-DD.
+    */
   | 'ISO_DATE'
+  /**
+    Field value is parsed as ISO 3166-1 alpha-2 country code. E.g. "DE" for Germany.
+    */
   | 'ISO_COUNTRY_ALPHA_2'
+  /**
+    Field value is parsed as ISO 3166-1 alpha-3 country code. E.g. "DEU" for Germany.
+    */
   | 'ISO_COUNTRY_ALPHA_3'
+  /**
+    Field value is parsed as ISO 3166-1 numeric country code. E.g. "276" for Germany.
+    */
   | 'ISO_COUNTRY_NUMERIC'
+  /**
+    Field value is parsed as ISO 3166-1 country name. E.g. "Germany".
+    */
   | 'ISO_COUNTRY_NAME'
+  /**
+    Field value is parsed as "Male", "Female".
+    */
   | 'GENDER';
 
-export const FieldDataFormatValues: FieldDataFormat[] = [
+/** @hidden */
+export const FieldDataFormatValues: ReadonlyArray<FieldDataFormat> = [
   'ISO_DATE',
   'ISO_COUNTRY_ALPHA_2',
   'ISO_COUNTRY_ALPHA_3',
   'ISO_COUNTRY_NUMERIC',
   'ISO_COUNTRY_NAME',
   'GENDER',
-];
+] as const;
 
 /**
 Parsed data.
 */
-export class FieldParsedData extends PartiallyConstructible {
+export class FieldParsedData {
   /**
     Parsing type.
     */
@@ -162,7 +216,6 @@ export class FieldParsedData extends PartiallyConstructible {
 
   /** @param source {@displayType `DeepPartial<FieldParsedData>`} */
   public constructor(source: DeepPartial<FieldParsedData> = {}) {
-    super();
     if (source.type !== undefined) {
       this.type = source.type;
     } else {
@@ -188,7 +241,7 @@ export class FieldParsedData extends PartiallyConstructible {
 /**
 Generic Document Type.
 */
-export class FieldType extends PartiallyConstructible {
+export class FieldType {
   /**
     Local field type name scoped to the containing document type.
     */
@@ -212,7 +265,6 @@ export class FieldType extends PartiallyConstructible {
 
   /** @param source {@displayType `DeepPartial<FieldType>`} */
   public constructor(source: DeepPartial<FieldType> = {}) {
-    super();
     if (source.name !== undefined) {
       this.name = source.name;
     } else {
@@ -259,7 +311,7 @@ export class FieldType extends PartiallyConstructible {
 /**
 Generic document field.
 */
-export class Field extends PartiallyConstructible {
+export class Field {
   /**
     The type of the field.
     */
@@ -295,7 +347,6 @@ export class Field extends PartiallyConstructible {
 
   /** @param source {@displayType `DeepPartial<Field>`} */
   public constructor(source: DeepPartial<Field> = {}) {
-    super();
     if (source.type !== undefined) {
       this.type = new FieldType(source.type);
     } else {
@@ -310,10 +361,10 @@ export class Field extends PartiallyConstructible {
       this.confidenceWeight = source.confidenceWeight;
     }
     if (source.image !== undefined) {
-      this.image = source.image != null ? ImageRef.From(source.image) : null;
+      this.image = source.image != null ? ImageRef.from(source.image) : null;
     }
     if (source.polygonInRoot !== undefined) {
-      this.polygonInRoot = source.polygonInRoot.map((it: any) => {
+      this.polygonInRoot = source.polygonInRoot.map((it: DeepPartial<Point>) => {
         return { x: it.x, y: it.y };
       });
     } else {
@@ -323,7 +374,7 @@ export class Field extends PartiallyConstructible {
       this.validationStatus = source.validationStatus;
     }
     if (source.parsedData !== undefined) {
-      this.parsedData = source.parsedData.map((it: any) => {
+      this.parsedData = source.parsedData.map((it: DeepPartial<FieldParsedData>) => {
         return new FieldParsedData(it);
       });
     }
@@ -375,7 +426,7 @@ export class Field extends PartiallyConstructible {
 /**
 Generic Document Type.
 */
-export class GenericDocumentType extends PartiallyConstructible {
+export class GenericDocumentType {
   /**
     Local document type name.
     */
@@ -395,7 +446,6 @@ export class GenericDocumentType extends PartiallyConstructible {
 
   /** @param source {@displayType `DeepPartial<GenericDocumentType>`} */
   public constructor(source: DeepPartial<GenericDocumentType> = {}) {
-    super();
     if (source.name !== undefined) {
       this.name = source.name;
     } else {
@@ -431,7 +481,7 @@ export class GenericDocumentType extends PartiallyConstructible {
 /**
 Generic document.
 */
-export class GenericDocument extends PartiallyConstructible {
+export class GenericDocument {
   /**
     Document type.
     */
@@ -471,42 +521,41 @@ export class GenericDocument extends PartiallyConstructible {
 
   /** @param source {@displayType `DeepPartial<GenericDocument>`} */
   public constructor(source: DeepPartial<GenericDocument> = {}) {
-    super();
     if (source.type !== undefined) {
       this.type = new GenericDocumentType(source.type);
     } else {
       throw new Error('type must be present in constructor argument');
     }
     if (source.fields !== undefined) {
-      this.fields = source.fields.map((it: any) => {
+      this.fields = source.fields.map((it: DeepPartial<Field>) => {
         return new Field(it);
       });
     } else {
       throw new Error('fields must be present in constructor argument');
     }
     if (source.children !== undefined) {
-      this.children = source.children.map((it: any) => {
+      this.children = source.children.map((it: DeepPartial<GenericDocument>) => {
         return new GenericDocument(it);
       });
     } else {
       throw new Error('children must be present in constructor argument');
     }
     if (source.quad !== undefined) {
-      this.quad = source.quad.map((it: any) => {
+      this.quad = source.quad.map((it: DeepPartial<Point>) => {
         return { x: it.x, y: it.y };
       });
     } else {
       throw new Error('quad must be present in constructor argument');
     }
     if (source.quadInRoot !== undefined) {
-      this.quadInRoot = source.quadInRoot.map((it: any) => {
+      this.quadInRoot = source.quadInRoot.map((it: DeepPartial<Point>) => {
         return { x: it.x, y: it.y };
       });
     } else {
       throw new Error('quadInRoot must be present in constructor argument');
     }
     if (source.crop !== undefined) {
-      this.crop = source.crop != null ? ImageRef.From(source.crop) : null;
+      this.crop = source.crop != null ? ImageRef.from(source.crop) : null;
     }
     if (source.confidence !== undefined) {
       this.confidence = source.confidence;

package/src/{utils → types/core}/geometry/Geometry.ts

@@ -1,13 +1,14 @@
 /// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
 /// Generated from core/schemas/Geometry.yaml
 
-import { ToJsonConfiguration } from '../../utils/json/JsonSerializationTypes';
-import { DeepPartial, PartiallyConstructible, Point } from '../../utils/utils';
+import { ToJsonConfiguration } from '../common/JsonSerializationTypes';
+import type { Point } from '../utils/utils';
+import { DeepPartial } from '../utils/utils';
 
 /**
 Represents a line segment in 2D space.
 */
-export class LineSegmentInt extends PartiallyConstructible {
+export class LineSegmentInt {
   /**
     Start point of the segment.
     */
@@ -19,7 +20,6 @@ export class LineSegmentInt extends PartiallyConstructible {
 
   /** @param source {@displayType `DeepPartial<LineSegmentInt>`} */
   public constructor(source: DeepPartial<LineSegmentInt> = {}) {
-    super();
     if (source.start !== undefined) {
       this.start = { x: source.start.x, y: source.start.y };
     } else {
@@ -45,7 +45,7 @@ export class LineSegmentInt extends PartiallyConstructible {
 /**
 Represents a line segment in 2D space.
 */
-export class LineSegmentFloat extends PartiallyConstructible {
+export class LineSegmentFloat {
   /**
     Start point of the segment.
     */
@@ -57,7 +57,6 @@ export class LineSegmentFloat extends PartiallyConstructible {
 
   /** @param source {@displayType `DeepPartial<LineSegmentFloat>`} */
   public constructor(source: DeepPartial<LineSegmentFloat> = {}) {
-    super();
     if (source.start !== undefined) {
       this.start = { x: source.start.x, y: source.start.y };
     } else {
@@ -83,7 +82,7 @@ export class LineSegmentFloat extends PartiallyConstructible {
 /**
 Aspect ratio is the ratio of the width to the height of an image or screen.
 */
-export class AspectRatio extends PartiallyConstructible {
+export class AspectRatio {
   /**
     Width component of the aspect ratio.
     
@@ -99,7 +98,6 @@ export class AspectRatio extends PartiallyConstructible {
 
   /** @param source {@displayType `DeepPartial<AspectRatio>`} */
   public constructor(source: DeepPartial<AspectRatio> = {}) {
-    super();
     if (source.width !== undefined) {
       this.width = source.width;
     }

package/src/types/core/geometry/index.ts

@@ -0,0 +1 @@
+export * from './Geometry';