scandit-datacapture-frameworks-id 8.1.0 → 8.2.0-beta.1
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.
- package/dist/dts/defaults/IdDefaults.d.ts +1 -0
- package/dist/dts/defaults/loadDefaults.d.ts +3 -0
- package/dist/dts/generated/IdProxy.d.ts +30 -0
- package/dist/dts/generated/IdProxyAdapter.d.ts +92 -0
- package/dist/dts/generated/index.d.ts +6 -0
- package/dist/dts/idcapture/IdCaptureSettings.d.ts +1 -0
- package/dist/dts/idcapture/controller/IdCaptureController.d.ts +4 -23
- package/dist/dts/idcapture/controller/IdCaptureListenerController.d.ts +4 -22
- package/dist/dts/idcapture/controller/IdCaptureOverlayController.d.ts +4 -7
- package/dist/dts/iddocumenttype/DriverLicense.d.ts +2 -0
- package/dist/dts/iddocumenttype/HealthInsuranceCard.d.ts +2 -0
- package/dist/dts/iddocumenttype/IdCaptureDocument.d.ts +3 -1
- package/dist/dts/iddocumenttype/IdCard.d.ts +2 -0
- package/dist/dts/iddocumenttype/Passport.d.ts +2 -0
- package/dist/dts/iddocumenttype/RegionSpecific.d.ts +2 -0
- package/dist/dts/iddocumenttype/ResidencePermit.d.ts +2 -0
- package/dist/dts/iddocumenttype/VisaIcao.d.ts +2 -0
- package/dist/dts/proxy-types.d.ts +1 -1
- package/dist/index.js +245 -23
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
|
@@ -33,6 +33,7 @@ export interface IdDefaults {
|
|
|
33
33
|
RecommendedCameraSettings: CameraSettings;
|
|
34
34
|
IdCaptureSettings: {
|
|
35
35
|
anonymizationMode: IdAnonymizationMode;
|
|
36
|
+
anonymizeDefaultFields: boolean;
|
|
36
37
|
rejectVoidedIds: boolean;
|
|
37
38
|
decodeBackOfEuropeanDrivingLicense: boolean;
|
|
38
39
|
rejectExpiredIds: boolean;
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { BaseProxy } from 'scandit-datacapture-frameworks-core';
|
|
2
|
+
/**
|
|
3
|
+
* ID module - identity document scanning and verification
|
|
4
|
+
* Generated from schema definition.
|
|
5
|
+
*
|
|
6
|
+
* Single entry point interface - all operations go through $executeId.
|
|
7
|
+
* The IdController handles method-specific logic and calls this proxy.
|
|
8
|
+
* The NativeProxy automatically handles the `$` prefix for native method calls.
|
|
9
|
+
*/
|
|
10
|
+
export interface IdProxy extends BaseProxy {
|
|
11
|
+
/**
|
|
12
|
+
* Single entry point for all Id operations.
|
|
13
|
+
* Routes to appropriate native command based on moduleName and methodName.
|
|
14
|
+
*
|
|
15
|
+
* @param params Object containing:
|
|
16
|
+
* - moduleName: The name of the module to execute against
|
|
17
|
+
* - methodName: The name of the method to execute
|
|
18
|
+
* - ...other parameters specific to the method
|
|
19
|
+
*
|
|
20
|
+
* @returns Promise resolving to the result (type depends on methodName)
|
|
21
|
+
*
|
|
22
|
+
* Note: This method is called with the `$` prefix ($executeId) which is
|
|
23
|
+
* automatically handled by NativeProxy to route to native implementation.
|
|
24
|
+
*/
|
|
25
|
+
$executeId(params: {
|
|
26
|
+
moduleName: string;
|
|
27
|
+
methodName: string;
|
|
28
|
+
[key: string]: any;
|
|
29
|
+
}): Promise<any>;
|
|
30
|
+
}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import { IdProxy } from './IdProxy';
|
|
2
|
+
/**
|
|
3
|
+
* Adapter class for Id operations.
|
|
4
|
+
* Provides typed methods that internally call $executeId.
|
|
5
|
+
* Generated from schema definition to ensure parameter and method name consistency.
|
|
6
|
+
*/
|
|
7
|
+
export declare class IdProxyAdapter {
|
|
8
|
+
private proxy;
|
|
9
|
+
constructor(proxy: IdProxy);
|
|
10
|
+
/**
|
|
11
|
+
* Resets the ID capture mode
|
|
12
|
+
* @param modeId Unique identifier of the ID capture mode
|
|
13
|
+
*/
|
|
14
|
+
resetIdCaptureMode({ modeId }: {
|
|
15
|
+
modeId: number;
|
|
16
|
+
}): Promise<void>;
|
|
17
|
+
/**
|
|
18
|
+
* Sets the enabled state of the ID capture mode
|
|
19
|
+
* @param modeId Unique identifier of the ID capture mode
|
|
20
|
+
* @param enabled Whether the mode should be enabled
|
|
21
|
+
*/
|
|
22
|
+
setModeEnabledState({ modeId, enabled }: {
|
|
23
|
+
modeId: number;
|
|
24
|
+
enabled: boolean;
|
|
25
|
+
}): Promise<void>;
|
|
26
|
+
/**
|
|
27
|
+
* Updates the ID capture mode configuration
|
|
28
|
+
* @param modeJson ID capture mode configuration as JSON string
|
|
29
|
+
* @param modeId Unique identifier of the ID capture mode
|
|
30
|
+
*/
|
|
31
|
+
updateIdCaptureMode({ modeJson, modeId }: {
|
|
32
|
+
modeJson: string;
|
|
33
|
+
modeId: number;
|
|
34
|
+
}): Promise<void>;
|
|
35
|
+
/**
|
|
36
|
+
* Applies new settings to the ID capture mode
|
|
37
|
+
* @param settingsJson ID capture mode settings as JSON string
|
|
38
|
+
* @param modeId Unique identifier of the ID capture mode
|
|
39
|
+
*/
|
|
40
|
+
applyIdCaptureModeSettings({ settingsJson, modeId, }: {
|
|
41
|
+
settingsJson: string;
|
|
42
|
+
modeId: number;
|
|
43
|
+
}): Promise<void>;
|
|
44
|
+
/**
|
|
45
|
+
* Updates the ID capture feedback configuration
|
|
46
|
+
* @param feedbackJson Feedback configuration as JSON string
|
|
47
|
+
* @param modeId Unique identifier of the ID capture mode
|
|
48
|
+
*/
|
|
49
|
+
updateFeedback({ feedbackJson, modeId }: {
|
|
50
|
+
feedbackJson: string;
|
|
51
|
+
modeId: number;
|
|
52
|
+
}): Promise<void>;
|
|
53
|
+
/**
|
|
54
|
+
* Updates the ID capture overlay configuration
|
|
55
|
+
* @param overlayJson ID capture overlay configuration as JSON string
|
|
56
|
+
*/
|
|
57
|
+
updateIdCaptureOverlay({ overlayJson }: {
|
|
58
|
+
overlayJson: string;
|
|
59
|
+
}): Promise<void>;
|
|
60
|
+
/**
|
|
61
|
+
* Finish callback for ID capture did capture event
|
|
62
|
+
* @param modeId Unique identifier of the ID capture mode
|
|
63
|
+
* @param enabled Whether the mode is enabled
|
|
64
|
+
*/
|
|
65
|
+
finishDidCaptureCallback({ modeId, enabled }: {
|
|
66
|
+
modeId: number;
|
|
67
|
+
enabled: boolean;
|
|
68
|
+
}): Promise<void>;
|
|
69
|
+
/**
|
|
70
|
+
* Finish callback for ID capture did reject event
|
|
71
|
+
* @param modeId Unique identifier of the ID capture mode
|
|
72
|
+
* @param enabled Whether the mode is enabled
|
|
73
|
+
*/
|
|
74
|
+
finishDidRejectCallback({ modeId, enabled }: {
|
|
75
|
+
modeId: number;
|
|
76
|
+
enabled: boolean;
|
|
77
|
+
}): Promise<void>;
|
|
78
|
+
/**
|
|
79
|
+
* Register persistent event listener for ID capture events
|
|
80
|
+
* @param modeId Unique identifier of the ID capture mode
|
|
81
|
+
*/
|
|
82
|
+
addIdCaptureListener({ modeId }: {
|
|
83
|
+
modeId: number;
|
|
84
|
+
}): Promise<void>;
|
|
85
|
+
/**
|
|
86
|
+
* Unregister event listener for ID capture events
|
|
87
|
+
* @param modeId Unique identifier of the ID capture mode
|
|
88
|
+
*/
|
|
89
|
+
removeIdCaptureListener({ modeId }: {
|
|
90
|
+
modeId: number;
|
|
91
|
+
}): Promise<void>;
|
|
92
|
+
}
|
|
@@ -6,6 +6,7 @@ import { Duration } from '../common/Duration';
|
|
|
6
6
|
import { IdFieldType } from '../id/IdFieldType';
|
|
7
7
|
export declare class IdCaptureSettings extends DefaultSerializeable {
|
|
8
8
|
anonymizationMode: IdAnonymizationMode;
|
|
9
|
+
anonymizeDefaultFields: boolean;
|
|
9
10
|
rejectVoidedIds: boolean;
|
|
10
11
|
decodeBackOfEuropeanDrivingLicense: boolean;
|
|
11
12
|
acceptedDocuments: IdCaptureDocument[];
|
|
@@ -1,30 +1,11 @@
|
|
|
1
|
-
import { BaseController
|
|
1
|
+
import { BaseController } from 'scandit-datacapture-frameworks-core';
|
|
2
2
|
import { IdCapture } from '../IdCapture';
|
|
3
3
|
import { IdCaptureSettings } from '../IdCaptureSettings';
|
|
4
4
|
import { IdCaptureFeedback } from '../IdCaptureFeedback';
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
modeId: number;
|
|
8
|
-
}): Promise<void>;
|
|
9
|
-
$setModeEnabledState({ modeId, enabled }: {
|
|
10
|
-
modeId: number;
|
|
11
|
-
enabled: boolean;
|
|
12
|
-
}): Promise<void>;
|
|
13
|
-
$updateIdCaptureMode({ modeJson, modeId }: {
|
|
14
|
-
modeJson: string;
|
|
15
|
-
modeId: number;
|
|
16
|
-
}): Promise<void>;
|
|
17
|
-
$applyIdCaptureModeSettings({ settingsJson, modeId }: {
|
|
18
|
-
settingsJson: string;
|
|
19
|
-
modeId: number;
|
|
20
|
-
}): Promise<void>;
|
|
21
|
-
$updateFeedback({ feedbackJson, modeId }: {
|
|
22
|
-
feedbackJson: string;
|
|
23
|
-
modeId: number;
|
|
24
|
-
}): Promise<void>;
|
|
25
|
-
}
|
|
26
|
-
export declare class IdCaptureController extends BaseController<IdCaptureProxy> {
|
|
5
|
+
import { IdProxy } from '../../generated';
|
|
6
|
+
export declare class IdCaptureController extends BaseController<IdProxy> {
|
|
27
7
|
private idCapture;
|
|
8
|
+
private adapter;
|
|
28
9
|
constructor(idCapture?: IdCapture | null);
|
|
29
10
|
reset(): Promise<void>;
|
|
30
11
|
setModeEnabledState(enabled: boolean): Promise<void>;
|
|
@@ -1,31 +1,13 @@
|
|
|
1
|
-
import { BaseController
|
|
1
|
+
import { BaseController } from 'scandit-datacapture-frameworks-core';
|
|
2
2
|
import { IdCapture } from '../IdCapture';
|
|
3
|
-
|
|
4
|
-
$finishDidCaptureCallback({ modeId, enabled }: {
|
|
5
|
-
modeId: number;
|
|
6
|
-
enabled: boolean;
|
|
7
|
-
}): Promise<void>;
|
|
8
|
-
$finishDidRejectCallback({ modeId, enabled }: {
|
|
9
|
-
modeId: number;
|
|
10
|
-
enabled: boolean;
|
|
11
|
-
}): Promise<void>;
|
|
12
|
-
/**
|
|
13
|
-
* Add persistent event listener for ID capture events.
|
|
14
|
-
* Uses `$$` prefix for automatic Cordova event registration detection.
|
|
15
|
-
*/
|
|
16
|
-
$$addIdCaptureListener({ modeId }: {
|
|
17
|
-
modeId: number;
|
|
18
|
-
}): Promise<void>;
|
|
19
|
-
$removeIdCaptureListener({ modeId }: {
|
|
20
|
-
modeId: number;
|
|
21
|
-
}): Promise<void>;
|
|
22
|
-
}
|
|
3
|
+
import { IdProxy } from '../../generated';
|
|
23
4
|
export declare enum IdCaptureListenerEvents {
|
|
24
5
|
didCapture = "IdCaptureListener.didCaptureId",
|
|
25
6
|
didReject = "IdCaptureListener.didRejectId"
|
|
26
7
|
}
|
|
27
|
-
export declare class IdCaptureListenerController extends BaseController<
|
|
8
|
+
export declare class IdCaptureListenerController extends BaseController<IdProxy> {
|
|
28
9
|
private idCapture;
|
|
10
|
+
private adapter;
|
|
29
11
|
private hasListeners;
|
|
30
12
|
constructor(idCapture: IdCapture);
|
|
31
13
|
subscribeListener(): Promise<void>;
|
|
@@ -1,12 +1,9 @@
|
|
|
1
|
-
import { BaseController
|
|
1
|
+
import { BaseController } from 'scandit-datacapture-frameworks-core';
|
|
2
2
|
import { IdCaptureOverlay } from '../IdCaptureOverlay';
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
overlayJson: string;
|
|
6
|
-
}): Promise<void>;
|
|
7
|
-
}
|
|
8
|
-
export declare class IdCaptureOverlayController extends BaseController<IdCaptureOverlayProxy> {
|
|
3
|
+
import { IdProxy } from '../../generated';
|
|
4
|
+
export declare class IdCaptureOverlayController extends BaseController<IdProxy> {
|
|
9
5
|
private overlay;
|
|
6
|
+
private adapter;
|
|
10
7
|
constructor(overlay: IdCaptureOverlay);
|
|
11
8
|
updateIdCaptureOverlay(overlay: IdCaptureOverlay): Promise<void>;
|
|
12
9
|
dispose(): void;
|
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import { IdCaptureDocument } from "./IdCaptureDocument";
|
|
2
|
+
import { IdCaptureDocumentType } from "./IdCaptureDocumentType";
|
|
2
3
|
import { IdCaptureRegion } from "../common/IdCaptureRegion";
|
|
3
4
|
import { DefaultSerializeable } from "scandit-datacapture-frameworks-core";
|
|
4
5
|
export declare class DriverLicense extends DefaultSerializeable implements IdCaptureDocument {
|
|
5
6
|
private readonly _region;
|
|
6
7
|
private readonly _documentType;
|
|
7
8
|
constructor(region: IdCaptureRegion);
|
|
9
|
+
get documentType(): IdCaptureDocumentType;
|
|
8
10
|
get region(): IdCaptureRegion;
|
|
9
11
|
get isIdCard(): boolean;
|
|
10
12
|
get isDriverLicense(): boolean;
|
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import { IdCaptureDocument } from "./IdCaptureDocument";
|
|
2
|
+
import { IdCaptureDocumentType } from "./IdCaptureDocumentType";
|
|
2
3
|
import { IdCaptureRegion } from "../common/IdCaptureRegion";
|
|
3
4
|
import { DefaultSerializeable } from "scandit-datacapture-frameworks-core";
|
|
4
5
|
export declare class HealthInsuranceCard extends DefaultSerializeable implements IdCaptureDocument {
|
|
5
6
|
private readonly _region;
|
|
6
7
|
private readonly _documentType;
|
|
7
8
|
constructor(region: IdCaptureRegion);
|
|
9
|
+
get documentType(): IdCaptureDocumentType;
|
|
8
10
|
get region(): IdCaptureRegion;
|
|
9
11
|
get isIdCard(): boolean;
|
|
10
12
|
get isDriverLicense(): boolean;
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { IdCaptureRegion } from "../common/IdCaptureRegion";
|
|
2
|
+
import { IdCaptureDocumentType } from "./IdCaptureDocumentType";
|
|
2
3
|
export interface IdCaptureDocument {
|
|
3
|
-
region: IdCaptureRegion;
|
|
4
|
+
readonly region: IdCaptureRegion;
|
|
5
|
+
readonly documentType: IdCaptureDocumentType;
|
|
4
6
|
isIdCard: boolean;
|
|
5
7
|
isDriverLicense: boolean;
|
|
6
8
|
isPassport: boolean;
|
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import { IdCaptureDocument } from "./IdCaptureDocument";
|
|
2
|
+
import { IdCaptureDocumentType } from "./IdCaptureDocumentType";
|
|
2
3
|
import { IdCaptureRegion } from "../common/IdCaptureRegion";
|
|
3
4
|
import { DefaultSerializeable } from "scandit-datacapture-frameworks-core";
|
|
4
5
|
export declare class IdCard extends DefaultSerializeable implements IdCaptureDocument {
|
|
5
6
|
private readonly _region;
|
|
6
7
|
private readonly _documentType;
|
|
7
8
|
constructor(region: IdCaptureRegion);
|
|
9
|
+
get documentType(): IdCaptureDocumentType;
|
|
8
10
|
get region(): IdCaptureRegion;
|
|
9
11
|
get isIdCard(): boolean;
|
|
10
12
|
get isDriverLicense(): boolean;
|
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import { IdCaptureDocument } from "./IdCaptureDocument";
|
|
2
|
+
import { IdCaptureDocumentType } from "./IdCaptureDocumentType";
|
|
2
3
|
import { IdCaptureRegion } from "../common/IdCaptureRegion";
|
|
3
4
|
import { DefaultSerializeable } from "scandit-datacapture-frameworks-core";
|
|
4
5
|
export declare class Passport extends DefaultSerializeable implements IdCaptureDocument {
|
|
5
6
|
private readonly _region;
|
|
6
7
|
private readonly _documentType;
|
|
7
8
|
constructor(region: IdCaptureRegion);
|
|
9
|
+
get documentType(): IdCaptureDocumentType;
|
|
8
10
|
get region(): IdCaptureRegion;
|
|
9
11
|
get isIdCard(): boolean;
|
|
10
12
|
get isDriverLicense(): boolean;
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { IdCaptureDocument } from "./IdCaptureDocument";
|
|
2
|
+
import { IdCaptureDocumentType } from "./IdCaptureDocumentType";
|
|
2
3
|
import { IdCaptureRegion } from "../common/IdCaptureRegion";
|
|
3
4
|
import { DefaultSerializeable } from "scandit-datacapture-frameworks-core";
|
|
4
5
|
import { RegionSpecificSubtype } from "../common";
|
|
@@ -7,6 +8,7 @@ export declare class RegionSpecific extends DefaultSerializeable implements IdCa
|
|
|
7
8
|
private readonly _documentSubtype;
|
|
8
9
|
private readonly _documentType;
|
|
9
10
|
constructor(subtype: RegionSpecificSubtype);
|
|
11
|
+
get documentType(): IdCaptureDocumentType;
|
|
10
12
|
get region(): IdCaptureRegion;
|
|
11
13
|
get subtype(): RegionSpecificSubtype;
|
|
12
14
|
get isIdCard(): boolean;
|
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import { IdCaptureDocument } from "./IdCaptureDocument";
|
|
2
|
+
import { IdCaptureDocumentType } from "./IdCaptureDocumentType";
|
|
2
3
|
import { IdCaptureRegion } from "../common/IdCaptureRegion";
|
|
3
4
|
import { DefaultSerializeable } from "scandit-datacapture-frameworks-core";
|
|
4
5
|
export declare class ResidencePermit extends DefaultSerializeable implements IdCaptureDocument {
|
|
5
6
|
private readonly _region;
|
|
6
7
|
private readonly _documentType;
|
|
7
8
|
constructor(region: IdCaptureRegion);
|
|
9
|
+
get documentType(): IdCaptureDocumentType;
|
|
8
10
|
get region(): IdCaptureRegion;
|
|
9
11
|
get isIdCard(): boolean;
|
|
10
12
|
get isDriverLicense(): boolean;
|
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import { IdCaptureDocument } from "./IdCaptureDocument";
|
|
2
|
+
import { IdCaptureDocumentType } from "./IdCaptureDocumentType";
|
|
2
3
|
import { IdCaptureRegion } from "../common/IdCaptureRegion";
|
|
3
4
|
import { DefaultSerializeable } from "scandit-datacapture-frameworks-core";
|
|
4
5
|
export declare class VisaIcao extends DefaultSerializeable implements IdCaptureDocument {
|
|
5
6
|
private readonly _region;
|
|
6
7
|
private readonly _documentType;
|
|
7
8
|
constructor(region: IdCaptureRegion);
|
|
9
|
+
get documentType(): IdCaptureDocumentType;
|
|
8
10
|
get region(): IdCaptureRegion;
|
|
9
11
|
get isIdCard(): boolean;
|
|
10
12
|
get isDriverLicense(): boolean;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { NativeCallerProvider } from 'scandit-datacapture-frameworks-core';
|
|
2
|
-
export declare const ID_PROXY_TYPE_NAMES: readonly ["
|
|
2
|
+
export declare const ID_PROXY_TYPE_NAMES: readonly ["IdProxy"];
|
|
3
3
|
export type IdProxyType = typeof ID_PROXY_TYPE_NAMES[number];
|
|
4
4
|
export interface IdNativeCallerProvider extends NativeCallerProvider<IdProxyType> {
|
|
5
5
|
}
|