@microblink/blinkid-core 7.4.3 → 7.6.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 (30) hide show
  1. package/dist/blinkid-core.js +18 -18
  2. package/dist/resources/blinkid-worker.js +445 -399
  3. package/dist/resources/full/advanced/BlinkIdModule.data +0 -0
  4. package/dist/resources/full/advanced/BlinkIdModule.js +124 -138
  5. package/dist/resources/full/advanced/BlinkIdModule.wasm +0 -0
  6. package/dist/resources/full/advanced-threads/BlinkIdModule.data +0 -0
  7. package/dist/resources/full/advanced-threads/BlinkIdModule.js +145 -162
  8. package/dist/resources/full/advanced-threads/BlinkIdModule.wasm +0 -0
  9. package/dist/resources/full/basic/BlinkIdModule.data +0 -0
  10. package/dist/resources/full/basic/BlinkIdModule.js +120 -134
  11. package/dist/resources/full/basic/BlinkIdModule.wasm +0 -0
  12. package/dist/resources/lightweight/advanced/BlinkIdModule.data +0 -0
  13. package/dist/resources/lightweight/advanced/BlinkIdModule.js +124 -137
  14. package/dist/resources/lightweight/advanced/BlinkIdModule.wasm +0 -0
  15. package/dist/resources/lightweight/advanced-threads/BlinkIdModule.data +0 -0
  16. package/dist/resources/lightweight/advanced-threads/BlinkIdModule.js +145 -162
  17. package/dist/resources/lightweight/advanced-threads/BlinkIdModule.wasm +0 -0
  18. package/dist/resources/lightweight/basic/BlinkIdModule.data +0 -0
  19. package/dist/resources/lightweight/basic/BlinkIdModule.js +120 -133
  20. package/dist/resources/lightweight/basic/BlinkIdModule.wasm +0 -0
  21. package/dist/resources/size-manifest.json +12 -12
  22. package/package.json +1 -1
  23. package/types/deviceInfo/createDerivedDeviceInfo.d.ts +1 -1
  24. package/types/deviceInfo/createDerivedDeviceInfo.d.ts.map +1 -1
  25. package/types/deviceInfo/deviceInfo.d.ts +1 -1
  26. package/types/deviceInfo/deviceInfo.d.ts.map +1 -1
  27. package/types/deviceInfo/getBrowserFromUserAgent.d.ts.map +1 -1
  28. package/types/index.d.ts +1 -1
  29. package/types/index.d.ts.map +1 -1
  30. package/types/index.rollup.d.ts +180 -25
@@ -1,30 +1,30 @@
1
1
  {
2
2
  "wasm": {
3
3
  "basic": {
4
- "full": 3065196,
5
- "lightweight": 3123869
4
+ "full": 3242579,
5
+ "lightweight": 3280109
6
6
  },
7
7
  "advanced": {
8
- "full": 3081572,
9
- "lightweight": 3138602
8
+ "full": 3261412,
9
+ "lightweight": 3297593
10
10
  },
11
11
  "advanced-threads": {
12
- "full": 3133721,
13
- "lightweight": 3189140
12
+ "full": 3308419,
13
+ "lightweight": 3343699
14
14
  }
15
15
  },
16
16
  "data": {
17
17
  "basic": {
18
- "full": 9141750,
19
- "lightweight": 7509065
18
+ "full": 13393962,
19
+ "lightweight": 11761277
20
20
  },
21
21
  "advanced": {
22
- "full": 9141750,
23
- "lightweight": 7509065
22
+ "full": 13393962,
23
+ "lightweight": 11761277
24
24
  },
25
25
  "advanced-threads": {
26
- "full": 9141750,
27
- "lightweight": 7509065
26
+ "full": 13393962,
27
+ "lightweight": 11761277
28
28
  }
29
29
  }
30
30
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@microblink/blinkid-core",
3
- "version": "7.4.3",
3
+ "version": "7.6.0",
4
4
  "author": "Microblink",
5
5
  "type": "module",
6
6
  "main": "./dist/blinkid-core.js",
@@ -3,5 +3,5 @@
3
3
  */
4
4
  import { DerivedDeviceInfo } from "./deviceInfo";
5
5
  import type { UADataValues } from "./navigator-types";
6
- export declare function createDerivedDeviceInfo(userAgentData: UADataValues | undefined, userAgent: string): DerivedDeviceInfo;
6
+ export declare function createDerivedDeviceInfo(userAgent: string, userAgentData?: UADataValues): DerivedDeviceInfo;
7
7
  //# sourceMappingURL=createDerivedDeviceInfo.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"createDerivedDeviceInfo.d.ts","sourceRoot":"","sources":["../../src/deviceInfo/createDerivedDeviceInfo.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAIjD,OAAO,KAAK,EAAc,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAElE,wBAAgB,uBAAuB,CACrC,aAAa,EAAE,YAAY,GAAG,SAAS,EACvC,SAAS,EAAE,MAAM,GAChB,iBAAiB,CA+EnB"}
1
+ {"version":3,"file":"createDerivedDeviceInfo.d.ts","sourceRoot":"","sources":["../../src/deviceInfo/createDerivedDeviceInfo.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAIjD,OAAO,KAAK,EAAc,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAElE,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,MAAM,EACjB,aAAa,CAAC,EAAE,YAAY,GAC3B,iBAAiB,CA+EnB"}
@@ -38,7 +38,7 @@ export type DeviceInfo = {
38
38
  };
39
39
  export type DerivedDeviceInfo = {
40
40
  model: string;
41
- formFactor: FormFactor[];
41
+ formFactors: FormFactor[];
42
42
  platform: OperatingSystem | "";
43
43
  browser: {
44
44
  brand: string;
@@ -1 +1 @@
1
- {"version":3,"file":"deviceInfo.d.ts","sourceRoot":"","sources":["../../src/deviceInfo/deviceInfo.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAElE,mBAAmB,mBAAmB,CAAC;AAEvC;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,aAAa,EAAE,OAAO,CAAC;IACvB,mBAAmB,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IACzB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,aAAa,CAAC,EAAE,YAAY,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,gBAAgB,CAAC;IACzB,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,iBAAiB,EAAE,iBAAiB,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,UAAU,EAAE,CAAC;IACzB,QAAQ,EAAE,eAAe,GAAG,EAAE,CAAC;IAC/B,OAAO,EAAE;QACP,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH,CAAC;AAqCF;;;GAGG;AACH,wBAAsB,gBAAgB,sCAqBrC;AAED,wBAAsB,aAAa,wBA4BlC"}
1
+ {"version":3,"file":"deviceInfo.d.ts","sourceRoot":"","sources":["../../src/deviceInfo/deviceInfo.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAElE,mBAAmB,mBAAmB,CAAC;AAEvC;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,aAAa,EAAE,OAAO,CAAC;IACvB,mBAAmB,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IACzB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,aAAa,CAAC,EAAE,YAAY,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,gBAAgB,CAAC;IACzB,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,iBAAiB,EAAE,iBAAiB,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,UAAU,EAAE,CAAC;IAC1B,QAAQ,EAAE,eAAe,GAAG,EAAE,CAAC;IAC/B,OAAO,EAAE;QACP,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH,CAAC;AAqCF;;;GAGG;AACH,wBAAsB,gBAAgB,sCAqBrC;AAED,wBAAsB,aAAa,wBA4BlC"}
@@ -1 +1 @@
1
- {"version":3,"file":"getBrowserFromUserAgent.d.ts","sourceRoot":"","sources":["../../src/deviceInfo/getBrowserFromUserAgent.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,MAAM,WAAW,GAEnB,iBAAiB,GACjB,kBAAkB,GAClB,eAAe,GAEf,MAAM,GACN,YAAY,GACZ,SAAS,GACT,OAAO,GACP,OAAO,GACP,iBAAiB,GAEjB,iBAAiB,GACjB,aAAa,GAEb,QAAQ,GACR,SAAS,GACT,QAAQ,GAER,SAAS,CAAC;AAEd,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB;AA0FD;;;;;;;GAOG;AACH,wBAAgB,aAAa,IAAI,WAAW,CA0B3C"}
1
+ {"version":3,"file":"getBrowserFromUserAgent.d.ts","sourceRoot":"","sources":["../../src/deviceInfo/getBrowserFromUserAgent.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,MAAM,WAAW,GAEnB,iBAAiB,GACjB,kBAAkB,GAClB,eAAe,GAEf,MAAM,GACN,YAAY,GACZ,SAAS,GACT,OAAO,GACP,OAAO,GACP,iBAAiB,GAEjB,iBAAiB,GACjB,aAAa,GAEb,QAAQ,GACR,SAAS,GACT,QAAQ,GAER,SAAS,CAAC;AAEd,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB;AA0FD;;;;;;;GAOG;AACH,wBAAgB,aAAa,IAAI,WAAW,CAyB3C"}
package/types/index.d.ts CHANGED
@@ -7,7 +7,7 @@
7
7
  * This package serves as the foundation for document scanning, handling WASM initialization, worker communication,
8
8
  * and core scanning operations.
9
9
  */
10
- import { WorkerScanningSession } from "@microblink/blinkid-worker";
10
+ import type { WorkerScanningSession } from "@microblink/blinkid-worker";
11
11
  import { Remote } from "comlink";
12
12
  export * from "./BlinkIdCore";
13
13
  export * from "./createCustomImageData";
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,cAAc,eAAe,CAAC;AAC9B,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AAGxB,cAAc,yBAAyB,CAAC;AAExC,mBAAmB,0BAA0B,CAAC;AAC9C,mBAAmB,4BAA4B,CAAC;AAEhD,4CAA4C;AAC5C,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAIlE,QAAA,MAAM,UAAU,eAAW,CAAC;AAE5B,OAAO,CAAC,MAAM,CAAC;IAEb,IAAI,gBAAgB,EAAE,OAAO,UAAU,CAAC;CACzC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,cAAc,eAAe,CAAC;AAC9B,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AAGxB,cAAc,yBAAyB,CAAC;AAExC,mBAAmB,0BAA0B,CAAC;AAC9C,mBAAmB,4BAA4B,CAAC;AAEhD,4CAA4C;AAC5C,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAIlE,QAAA,MAAM,UAAU,eAAW,CAAC;AAE5B,OAAO,CAAC,MAAM,CAAC;IAEb,IAAI,gBAAgB,EAAE,OAAO,UAAU,CAAC;CACzC"}
@@ -874,6 +874,8 @@ export declare type BarcodeElementKey =
874
874
  export declare type BarcodeResult = {
875
875
  /** The raw, unparsed barcode data. */
876
876
  barcodeData: BarcodeData;
877
+ /** Whether the raw barcode data was successfully parsed into structured information. */
878
+ parsed: boolean;
877
879
  /** The first name of the document owner. */
878
880
  firstName: string;
879
881
  /** The middle name of the document owner. */
@@ -960,11 +962,17 @@ export declare type BarcodeType =
960
962
  * @ignore
961
963
  */
962
964
  export declare interface BlinkIdBindings {
963
- createBlinkIdScanningSession: (sessionSettings: BlinkIdSessionSettings) => BlinkIdScanningSession;
965
+ createBlinkIdScanningSession: (sessionSettings: BlinkIdSessionSettings, userId: string) => BlinkIdScanningSession;
964
966
  initializeWithLicenseKey: (licenceKey: string, userId: string, allowHelloMessage: boolean) => LicenseUnlockResult;
965
- submitServerPermission: (serverPermission: unknown) => ServerPermissionSubmitResult;
967
+ submitServerPermission: (serverPermission: string) => ServerPermissionSubmitError | undefined;
966
968
  getActiveLicenseTokenInfo: () => LicenseUnlockResult;
967
969
  setPingProxyUrl: (url: string) => void;
970
+ initializeSdk: (userId: string) => void;
971
+ terminateSdk: () => void;
972
+ sendPinglets: () => void;
973
+ arePingRequestsInProgress: () => boolean;
974
+ queuePinglet: (data: string, schemaName: string, schemaVersion: string, sessionNumber: number) => void;
975
+ isPingEnabled: () => boolean;
968
976
  }
969
977
 
970
978
  /**
@@ -1083,12 +1091,32 @@ export declare type BlinkIdScanningResult = {
1083
1091
  countryCode?: StringResult;
1084
1092
  /** The national insurance number of the document owner */
1085
1093
  nationalInsuranceNumber?: StringResult;
1094
+ /** The locality code of the document owner */
1095
+ localityCode?: StringResult;
1096
+ /** The maiden name of the document owner */
1097
+ maidenName?: StringResult;
1098
+ /** The municipality code of the document owner */
1099
+ municipalityCode?: StringResult;
1100
+ /** The municipality of registration of the document owner */
1101
+ municipalityOfRegistration?: StringResult;
1102
+ /** The polling station code of the document owner */
1103
+ pollingStationCode?: StringResult;
1104
+ /** The registration center code of the document owner */
1105
+ registrationCenterCode?: StringResult;
1106
+ /** The section code of the document owner */
1107
+ sectionCode?: StringResult;
1108
+ /** The state code of the document owner */
1109
+ stateCode?: StringResult;
1110
+ /** The state of the document owner */
1111
+ stateName?: StringResult;
1086
1112
  /** The date of birth of the document owner */
1087
1113
  dateOfBirth?: DateResult<StringResult>;
1088
1114
  /** The date of issue of the document */
1089
1115
  dateOfIssue?: DateResult<StringResult>;
1090
1116
  /** The date of expiry of the document */
1091
1117
  dateOfExpiry?: DateResult<StringResult>;
1118
+ /** The date of entry of the document owner */
1119
+ dateOfEntry?: DateResult<StringResult>;
1092
1120
  /** Determines if date of expiry is permanent */
1093
1121
  dateOfExpiryPermanent?: boolean;
1094
1122
  /** The driver license detailed info */
@@ -1214,6 +1242,8 @@ declare class BlinkIdWorker {
1214
1242
  * The progress status callback.
1215
1243
  */
1216
1244
  progressStatusCallback?: ProgressStatusCallback;
1245
+ reportPinglet(pinglet: Ping): void;
1246
+ sendPinglets(): void;
1217
1247
  /**
1218
1248
  * This method initializes everything.
1219
1249
  */
@@ -1251,6 +1281,8 @@ declare class BlinkIdWorker {
1251
1281
  * @returns Whether the production overlay is shown.
1252
1282
  */
1253
1283
  showProductionOverlay: () => boolean;
1284
+ ping: BlinkIdWorker["reportPinglet"];
1285
+ sendPinglets: BlinkIdWorker["sendPinglets"];
1254
1286
  } & ProxyMarked;
1255
1287
  /**
1256
1288
  * This method creates a proxy session.
@@ -1267,13 +1299,7 @@ declare class BlinkIdWorker {
1267
1299
  /**
1268
1300
  * Terminates the workers and the Wasm runtime.
1269
1301
  */
1270
- terminate(): void;
1271
- /**
1272
- * If the ping is enabled, this method will return 1.
1273
- *
1274
- * @returns 1 if the ping is enabled, 0 otherwise.
1275
- */
1276
- ping(): number;
1302
+ terminate(): Promise<void>;
1277
1303
  }
1278
1304
 
1279
1305
  /**
@@ -1488,7 +1514,7 @@ export declare type DependentInfo = {
1488
1514
 
1489
1515
  export declare type DerivedDeviceInfo = {
1490
1516
  model: string;
1491
- formFactor: FormFactor[];
1517
+ formFactors: FormFactor[];
1492
1518
  platform: OperatingSystem | "";
1493
1519
  browser: {
1494
1520
  brand: string;
@@ -1691,7 +1717,7 @@ export declare type DocumentRules = {
1691
1717
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
1692
1718
  */
1693
1719
  /** Represents document class types */
1694
- declare type DocumentType_2 = "consular-id" | "dl" | "dl-public-services-card" | "employment-pass" | "fin-card" | "id" | "multipurpose-id" | "mykad" | "mykid" | "mypr" | "mytentera" | "pan-card" | "professional-id" | "public-services-card" | "residence-permit" | "resident-id" | "temporary-residence-permit" | "voter-id" | "work-permit" | "ikad" | "military-id" | "mykas" | "social-security-card" | "health-insurance-card" | "passport" | "s-pass" | "address-card" | "alien-id" | "alien-passport" | "green-card" | "minors-id" | "postal-id" | "professional-dl" | "tax-id" | "weapon-permit" | "visa" | "border-crossing-card" | "driver-card" | "global-entry-card" | "mypolis" | "nexus-card" | "passport-card" | "proof-of-age-card" | "refugee-id" | "tribal-id" | "veteran-id" | "citizenship-certificate" | "my-number-card" | "consular-passport" | "minors-passport" | "minors-public-services-card" | "driving-privilege-card" | "asylum-request" | "driver-qualification-card" | "provisional-dl" | "refugee-passport" | "special-id" | "uniformed-services-id" | "immigrant-visa" | "consular-voter-id" | "twic-card" | "exit-entry-permit" | "mainland-travel-permit-taiwan" | "nbi-clearance" | "proof-of-registration" | "temporary-protection-permit" | "afghan-citizen-card" | "eid" | "pass" | "sis-id" | "asic-card" | "bidoon-card" | "interim-health-insurance-card" | "non-voter-id" | "reciprocal-health-insurance-card" | "vehicle-registration" | "esaad-card" | "registration-certificate" | "medical-marijuana-id" | "non-card-tribal-id" | "diplomatic-id";
1720
+ declare type DocumentType_2 = "consular-id" | "dl" | "dl-public-services-card" | "employment-pass" | "fin-card" | "id" | "multipurpose-id" | "mykad" | "mykid" | "mypr" | "mytentera" | "pan-card" | "professional-id" | "public-services-card" | "residence-permit" | "resident-id" | "temporary-residence-permit" | "voter-id" | "work-permit" | "ikad" | "military-id" | "mykas" | "social-security-card" | "health-insurance-card" | "passport" | "s-pass" | "address-card" | "alien-id" | "alien-passport" | "green-card" | "minors-id" | "postal-id" | "professional-dl" | "tax-id" | "weapon-permit" | "visa" | "border-crossing-card" | "driver-card" | "global-entry-card" | "mypolis" | "nexus-card" | "passport-card" | "proof-of-age-card" | "refugee-id" | "tribal-id" | "veteran-id" | "citizenship-certificate" | "my-number-card" | "consular-passport" | "minors-passport" | "minors-public-services-card" | "driving-privilege-card" | "asylum-request" | "driver-qualification-card" | "provisional-dl" | "refugee-passport" | "special-id" | "uniformed-services-id" | "immigrant-visa" | "consular-voter-id" | "twic-card" | "exit-entry-permit" | "mainland-travel-permit-taiwan" | "nbi-clearance" | "proof-of-registration" | "temporary-protection-permit" | "afghan-citizen-card" | "eid" | "pass" | "sis-id" | "asic-card" | "bidoon-card" | "interim-health-insurance-card" | "non-voter-id" | "reciprocal-health-insurance-card" | "vehicle-registration" | "esaad-card" | "registration-certificate" | "medical-marijuana-id" | "non-card-tribal-id" | "diplomatic-id" | "emergency-passport" | "temporary-passport" | "metis-federation-card" | "adr-certificate";
1695
1721
  export { DocumentType_2 as DocumentType }
1696
1722
 
1697
1723
  /**
@@ -1838,6 +1864,13 @@ export declare type EmscriptenModuleFactory<T extends EmscriptenModule = Emscrip
1838
1864
  */
1839
1865
  export declare type EnvironmentType = "WEB" | "NODE" | "SHELL" | "WORKER";
1840
1866
 
1867
+ /** Represents the data for the `ping.error` event. */
1868
+ export declare type ErrorData = {
1869
+ errorType: "NonFatal" | "Crash";
1870
+ errorMessage: string;
1871
+ stackTrace?: string;
1872
+ };
1873
+
1841
1874
  /**
1842
1875
  * Extracts the barcode input image from the scanning result.
1843
1876
  *
@@ -1929,6 +1962,18 @@ export declare type GpuInfo = {
1929
1962
  version: string;
1930
1963
  };
1931
1964
 
1965
+ /** Represents the data for the `ping.hardware.camera.info` event. */
1966
+ export declare type HardwareCameraInfoData = {
1967
+ availableCameras: {
1968
+ cameraFacing: "Front" | "Back" | "Unknown";
1969
+ focus?: "Auto" | "Fixed";
1970
+ availableResolutions?: {
1971
+ width: number;
1972
+ height: number;
1973
+ }[];
1974
+ }[];
1975
+ };
1976
+
1932
1977
  /**
1933
1978
  * Allows for type-safe parameter passing while still conforming to spec.
1934
1979
  */
@@ -2062,9 +2107,6 @@ export declare type LicenseRequest = Readonly<{
2062
2107
  sdkVersion: string;
2063
2108
  }>;
2064
2109
 
2065
- /** The license status response. */
2066
- export declare type LicenseStatusResponse = Record<string, string>;
2067
-
2068
2110
  /** The license token state. */
2069
2111
  export declare type LicenseTokenState = "invalid" | "requires-server-permission" | "valid";
2070
2112
 
@@ -2123,6 +2165,12 @@ export declare type LoadWasmParams = {
2123
2165
  initialMemory?: number;
2124
2166
  };
2125
2167
 
2168
+ /** Represents the data for the `ping.log` event. */
2169
+ export declare type LogData = {
2170
+ logLevel: "Info" | "Warning";
2171
+ logMessage: string;
2172
+ };
2173
+
2126
2174
  /** Types of documents that can contain MRZ */
2127
2175
  export declare type MrzDocumentType = "unknown" | "identity-card" | "passport" | "visa" | "green-card" | "mys-pass-imm13p" | "driver-license" | "internal-travel-document" | "border-crossing-card";
2128
2176
 
@@ -2227,6 +2275,50 @@ declare type PartialScanningSettings = Partial<OverrideProperties<ScanningSettin
2227
2275
  customDocumentRules: Partial<DocumentRules>[];
2228
2276
  }>>;
2229
2277
 
2278
+ export declare type Ping = PingBrowserDeviceInfo | PingError | PingHardwareCameraInfo | PingLog | PingSdkCameraInputInfo | PingSdkCameraPermission | PingSdkInitStart | PingSdkScanConditions | PingSdkUxEvent | PingSdkWrapperProduct;
2279
+
2280
+ /** Represents the base structure for a ping event. */
2281
+ export declare interface PingBase<TData, TSchemaName extends SchemaName, TSchemaVersion extends Semver, TSessionNumber extends number = number> {
2282
+ /** The data payload of the event. */
2283
+ data: TData;
2284
+ /** The name of the schema. */
2285
+ schemaName: TSchemaName;
2286
+ /** The version of the schema. */
2287
+ schemaVersion: TSchemaVersion;
2288
+ /** The session number associated with the event. */
2289
+ sessionNumber?: TSessionNumber;
2290
+ }
2291
+
2292
+ /** Represents the `ping.browser.device.info` event. */
2293
+ export declare type PingBrowserDeviceInfo = PingBase<unknown, "ping.browser.device.info", "1.0.0">;
2294
+
2295
+ /** Represents the `ping.error` event. */
2296
+ export declare type PingError = PingBase<ErrorData, "ping.error", "1.0.0">;
2297
+
2298
+ /** Represents the `ping.hardware.camera.info` event. */
2299
+ export declare type PingHardwareCameraInfo = PingBase<HardwareCameraInfoData, "ping.hardware.camera.info", "1.0.1", 0>;
2300
+
2301
+ /** Represents the `ping.log` event. */
2302
+ export declare type PingLog = PingBase<LogData, "ping.log", "1.0.0">;
2303
+
2304
+ /** Represents the `ping.sdk.camera.input.info` event. */
2305
+ export declare type PingSdkCameraInputInfo = PingBase<SdkCameraInputInfoData, "ping.sdk.camera.input.info", "1.0.1">;
2306
+
2307
+ /** Represents the `ping.sdk.camera.permission` event. */
2308
+ export declare type PingSdkCameraPermission = PingBase<SdkCameraPermissionData, "ping.sdk.camera.permission", "1.0.0">;
2309
+
2310
+ /** Represents the `ping.sdk.init.start` event. */
2311
+ export declare type PingSdkInitStart = PingBase<SdkInitStartData, "ping.sdk.init.start", "1.0.0">;
2312
+
2313
+ /** Represents the `ping.sdk.scan.conditions` event. */
2314
+ export declare type PingSdkScanConditions = PingBase<SdkScanConditionsData, "ping.sdk.scan.conditions", "1.0.0">;
2315
+
2316
+ /** Represents the `ping.sdk.ux.event` event. */
2317
+ export declare type PingSdkUxEvent = PingBase<SdkUxEventData, "ping.sdk.ux.event", "1.0.0">;
2318
+
2319
+ /** Represents the `ping.sdk.wrapper.product` event. */
2320
+ export declare type PingSdkWrapperProduct = PingBase<SdkWrapperProductData, "ping.sdk.wrapper.product", "1.0.0">;
2321
+
2230
2322
  /**
2231
2323
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
2232
2324
  */
@@ -2323,14 +2415,6 @@ export declare type ProcessResultWithBuffer = BlinkIdProcessResult & {
2323
2415
  */
2324
2416
  export declare type ProgressStatusCallback = (progress: DownloadProgress) => void;
2325
2417
 
2326
- /**
2327
- * Error thrown when proxy URL validation fails
2328
- */
2329
- export declare class ProxyUrlValidationError extends Error {
2330
- readonly url: string;
2331
- constructor(message: string, url: string);
2332
- }
2333
-
2334
2418
  /** Represents a quadrilateral shape with signed integer coordinates. */
2335
2419
  export declare type Quadrilateral = {
2336
2420
  /** Upper left point of the quadrilateral. */
@@ -2401,7 +2485,7 @@ export declare type Rectangle = {
2401
2485
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
2402
2486
  */
2403
2487
  /** Represents regions */
2404
- export declare type Region = "alabama" | "alaska" | "alberta" | "arizona" | "arkansas" | "australian-capital-territory" | "british-columbia" | "california" | "colorado" | "connecticut" | "delaware" | "district-of-columbia" | "florida" | "georgia" | "hawaii" | "idaho" | "illinois" | "indiana" | "iowa" | "kansas" | "kentucky" | "louisiana" | "maine" | "manitoba" | "maryland" | "massachusetts" | "michigan" | "minnesota" | "mississippi" | "missouri" | "montana" | "nebraska" | "nevada" | "new-brunswick" | "new-hampshire" | "new-jersey" | "new-mexico" | "new-south-wales" | "new-york" | "northern-territory" | "north-carolina" | "north-dakota" | "nova-scotia" | "ohio" | "oklahoma" | "ontario" | "oregon" | "pennsylvania" | "quebec" | "queensland" | "rhode-island" | "saskatchewan" | "south-australia" | "south-carolina" | "south-dakota" | "tasmania" | "tennessee" | "texas" | "utah" | "vermont" | "victoria" | "virginia" | "washington" | "western-australia" | "west-virginia" | "wisconsin" | "wyoming" | "yukon" | "ciudad-de-mexico" | "jalisco" | "newfoundland-and-labrador" | "nuevo-leon" | "baja-california" | "chihuahua" | "guanajuato" | "guerrero" | "mexico" | "michoacan" | "new-york-city" | "tamaulipas" | "veracruz" | "chiapas" | "coahuila" | "durango" | "guerrero-cocula" | "guerrero-juchitan" | "guerrero-tepecoacuilco" | "guerrero-tlacoapa" | "gujarat" | "hidalgo" | "karnataka" | "kerala" | "khyber-pakhtunkhwa" | "madhya-pradesh" | "maharashtra" | "morelos" | "nayarit" | "oaxaca" | "puebla" | "punjab" | "queretaro" | "san-luis-potosi" | "sinaloa" | "sonora" | "tabasco" | "tamil-nadu" | "yucatan" | "zacatecas" | "aguascalientes" | "baja-california-sur" | "campeche" | "colima" | "quintana-roo-benito-juarez" | "quintana-roo" | "quintana-roo-solidaridad" | "tlaxcala" | "quintana-roo-cozumel" | "sao-paolo" | "rio-de-janeiro" | "rio-grande-do-sul" | "northwest-territories" | "nunavut" | "prince-edward-island" | "distrito-federal" | "maranhao" | "mato-grosso" | "minas-gerais" | "para" | "parana" | "pernambuco" | "santa-catarina" | "andhra-pradesh" | "ceara" | "goias" | "guerrero-acapulco-de-juarez" | "haryana" | "sergipe" | "alagoas" | "bangsamoro";
2488
+ export declare type Region = "alabama" | "alaska" | "alberta" | "arizona" | "arkansas" | "australian-capital-territory" | "british-columbia" | "california" | "colorado" | "connecticut" | "delaware" | "district-of-columbia" | "florida" | "georgia" | "hawaii" | "idaho" | "illinois" | "indiana" | "iowa" | "kansas" | "kentucky" | "louisiana" | "maine" | "manitoba" | "maryland" | "massachusetts" | "michigan" | "minnesota" | "mississippi" | "missouri" | "montana" | "nebraska" | "nevada" | "new-brunswick" | "new-hampshire" | "new-jersey" | "new-mexico" | "new-south-wales" | "new-york" | "northern-territory" | "north-carolina" | "north-dakota" | "nova-scotia" | "ohio" | "oklahoma" | "ontario" | "oregon" | "pennsylvania" | "quebec" | "queensland" | "rhode-island" | "saskatchewan" | "south-australia" | "south-carolina" | "south-dakota" | "tasmania" | "tennessee" | "texas" | "utah" | "vermont" | "victoria" | "virginia" | "washington" | "western-australia" | "west-virginia" | "wisconsin" | "wyoming" | "yukon" | "ciudad-de-mexico" | "jalisco" | "newfoundland-and-labrador" | "nuevo-leon" | "baja-california" | "chihuahua" | "guanajuato" | "guerrero" | "mexico" | "michoacan" | "new-york-city" | "tamaulipas" | "veracruz" | "chiapas" | "coahuila" | "durango" | "guerrero-cocula" | "guerrero-juchitan" | "guerrero-tepecoacuilco" | "guerrero-tlacoapa" | "gujarat" | "hidalgo" | "karnataka" | "kerala" | "khyber-pakhtunkhwa" | "madhya-pradesh" | "maharashtra" | "morelos" | "nayarit" | "oaxaca" | "puebla" | "punjab" | "queretaro" | "san-luis-potosi" | "sinaloa" | "sonora" | "tabasco" | "tamil-nadu" | "yucatan" | "zacatecas" | "aguascalientes" | "baja-california-sur" | "campeche" | "colima" | "quintana-roo-benito-juarez" | "quintana-roo" | "quintana-roo-solidaridad" | "tlaxcala" | "quintana-roo-cozumel" | "sao-paolo" | "rio-de-janeiro" | "rio-grande-do-sul" | "northwest-territories" | "nunavut" | "prince-edward-island" | "distrito-federal" | "maranhao" | "mato-grosso" | "minas-gerais" | "para" | "parana" | "pernambuco" | "santa-catarina" | "andhra-pradesh" | "ceara" | "goias" | "guerrero-acapulco-de-juarez" | "haryana" | "sergipe" | "alagoas" | "bangsamoro" | "telangana";
2405
2489
 
2406
2490
  /** Represents a remote scanning session. */
2407
2491
  export declare type RemoteScanningSession = Remote<WorkerScanningSession>;
@@ -2767,11 +2851,60 @@ export declare type ScanningSide = "first" | "second";
2767
2851
  */
2768
2852
  export declare type ScanningStatus = "scanning-side-in-progress" | "scanning-barcode-in-progress" | "side-scanned" | "document-scanned" | "cancelled";
2769
2853
 
2854
+ export declare type SchemaName = Ping["schemaName"];
2855
+
2856
+ /** Represents the data for the `ping.sdk.camera.input.info` event. */
2857
+ export declare type SdkCameraInputInfoData = {
2858
+ cameraFacing: "Front" | "Back" | "Unknown";
2859
+ cameraFrameWidth: number;
2860
+ cameraFrameHeight: number;
2861
+ roiWidth: number;
2862
+ roiHeight: number;
2863
+ viewPortAspectRatio: number;
2864
+ };
2865
+
2866
+ /** Represents the data for the `ping.sdk.camera.permission` event. */
2867
+ export declare type SdkCameraPermissionData = {
2868
+ eventType: "CameraPermissionCheck" | "CameraPermissionRequest" | "CameraPermissionUserResponse";
2869
+ cameraPermissionGranted?: boolean;
2870
+ };
2871
+
2872
+ /** Represents the data for the `ping.sdk.init.start` event. */
2873
+ export declare type SdkInitStartData = {
2874
+ product: "BlinkID";
2875
+ platform: "Emscripten";
2876
+ packageName: string;
2877
+ userId: string;
2878
+ };
2879
+
2880
+ /** Represents the data for the `ping.sdk.scan.conditions` event. */
2881
+ export declare type SdkScanConditionsData = {
2882
+ updateType: "DeviceOrientation" | "FlashlightState";
2883
+ deviceOrientation?: "Portrait" | "LandscapeRight" | "LandscapeLeft" | "PortraitUpside";
2884
+ flashlightOn?: boolean;
2885
+ };
2886
+
2887
+ /** Represents the data for the `ping.sdk.ux.event` event. */
2888
+ export declare type SdkUxEventData = {
2889
+ eventType: "CameraStarted" | "CameraClosed" | "OnboardingInfoDisplayed" | "CloseButtonClicked" | "HelpTooltipDisplayed" | "HelpOpened" | "HelpClosed" | "AlertDisplayed" | "ErrorMessage" | "StepTimeout" | "AppMovedToBackground";
2890
+ errorMessageType?: "MoveCloser" | "MoveFarther" | "KeepVisible" | "FlipSide" | "AlignDocument" | "MoveFromEdge" | "IncreaseLighting" | "DecreaseLighting" | "EliminateBlur" | "EliminateGlare";
2891
+ alertType?: "InvalidLicenseKey" | "NetworkError" | "DocumentClassNotAllowed" | "StepTimeout";
2892
+ helpCloseType?: "ContentSkipped" | "ContentFullyViewed";
2893
+ };
2894
+
2895
+ /** Represents the data for the `ping.sdk.wrapper.product` event. */
2896
+ export declare type SdkWrapperProductData = {
2897
+ wrapperProduct: "CrossplatformFlutter" | "CrossplatformReactNative" | "IdentityVerification";
2898
+ correlationId?: string;
2899
+ };
2900
+
2901
+ declare type Semver = `${number}.${number}.${number}` | `${number}.${number}.${number}-${string}`;
2902
+
2770
2903
  /** The server permission error. */
2771
2904
  export declare type ServerPermissionError = "network-error" | "remote-lock" | "permission-expired" | "payload-corrupted" | "payload-signature-verification-failed" | "incorrect-token-state" | "detected-skewed-clock";
2772
2905
 
2773
- /** The server permission submit result. */
2774
- export declare type ServerPermissionSubmitResult = Readonly<{
2906
+ /** The server permission submit error. */
2907
+ export declare type ServerPermissionSubmitError = Readonly<{
2775
2908
  /** The error. */
2776
2909
  error: ServerPermissionError;
2777
2910
  /** The lease. */
@@ -2903,6 +3036,8 @@ export declare type VizResult = {
2903
3036
  dateOfIssue?: DateResult<StringResult>;
2904
3037
  /** The date of expiry of the document */
2905
3038
  dateOfExpiry?: DateResult<StringResult>;
3039
+ /** The date of entry of the document owner */
3040
+ dateOfEntry?: DateResult<StringResult>;
2906
3041
  /** Determines if date of expiry is permanent */
2907
3042
  dateOfExpiryPermanent?: boolean;
2908
3043
  /** The document number */
@@ -2945,6 +3080,24 @@ export declare type VizResult = {
2945
3080
  countryCode?: StringResult;
2946
3081
  /** The national insurance number of the document owner */
2947
3082
  nationalInsuranceNumber?: StringResult;
3083
+ /** The locality code of the document owner */
3084
+ localityCode?: StringResult;
3085
+ /** The maiden name of the document owner */
3086
+ maidenName?: StringResult;
3087
+ /** The municipality code of the document owner */
3088
+ municipalityCode?: StringResult;
3089
+ /** The municipality of registration of the document owner */
3090
+ municipalityOfRegistration?: StringResult;
3091
+ /** The polling station code of the document owner */
3092
+ pollingStationCode?: StringResult;
3093
+ /** The registration center code of the document owner */
3094
+ registrationCenterCode?: StringResult;
3095
+ /** The section code of the document owner */
3096
+ sectionCode?: StringResult;
3097
+ /** The state code of the document owner */
3098
+ stateCode?: StringResult;
3099
+ /** The state of the document owner */
3100
+ stateName?: StringResult;
2948
3101
  };
2949
3102
 
2950
3103
  export declare type WasmBuildType = (typeof wasmBuildTypes)[number];
@@ -2990,6 +3143,8 @@ export declare type WorkerScanningSession = OverrideProperties<BlinkIdScanningSe
2990
3143
  * @returns Whether the production overlay is shown.
2991
3144
  */
2992
3145
  showProductionOverlay: () => boolean;
3146
+ ping: BlinkIdWorker["reportPinglet"];
3147
+ sendPinglets: BlinkIdWorker["sendPinglets"];
2993
3148
  };
2994
3149
 
2995
3150
  export { }