@microblink/blinkid-ux-manager 7.6.3 → 7.7.0

package/types/core/ui-state-utils.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Copyright (c) 2026 Microblink Ltd. All rights reserved.
+ */
+import { BlinkIdProcessResult, DocumentClassInfo } from "@microblink/blinkid-core";
+/**
+ * Extracts the document class info from the process result.
+ *
+ * @param processResult - The process result.
+ * @returns The document class info.
+ */
+export declare function extractDocumentClassInfo(processResult: BlinkIdProcessResult): DocumentClassInfo;
+/**
+ * Checks if the document class is classified.
+ *
+ * @param documentClassInfo - The document class info.
+ * @returns Whether the document class is classified.
+ */
+export declare function isDocumentClassified(documentClassInfo: DocumentClassInfo): boolean;
+export declare function getDocumentRotation(processResult: BlinkIdProcessResult): import("@microblink/blinkid-wasm").DocumentRotation;
+/**
+ * Checks if the document is a passport.
+ *
+ * @param docClass - The document class info.
+ * @returns True if the document is a passport, false otherwise.
+ */
+export declare function isPassport(docClass: DocumentClassInfo | undefined): boolean;
+/**
+ * Checks if the document is a passport and has a barcode on the last page (USA or India).
+ *
+ * @param docClass - The document class info.
+ * @returns True if the document is a passport and has a barcode on the last page (USA or India), false otherwise.
+ */
+export declare function isPassportWithBarcode(docClass: DocumentClassInfo | undefined): boolean;
+/**
+ * Checks if the document is a passport without a barcode on the last page (not USA or India).
+ *
+ * @param docClass - The document class info.
+ * @returns True if the document is a passport without a barcode on the last page (not USA or India), false otherwise.
+ */
+export declare function isPassportWithoutBarcode(docClass: DocumentClassInfo | undefined): boolean; /**
+ * Utility type for document pagination types.
+ */
+export type DocumentPagination = "passport-no-barcode" | "passport-with-barcode" | "other";
+/**
+ * Determines the document pagination type based on the document class info.
+ *
+ * @param docClass - The document class info.
+ * @returns The document pagination type.
+ */
+export declare function getDocumentPaginationType(docClass: DocumentClassInfo | undefined): DocumentPagination;
+//# sourceMappingURL=ui-state-utils.d.ts.map

package/types/core/ui-state-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui-state-utils.d.ts","sourceRoot":"","sources":["../../src/core/ui-state-utils.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EAClB,MAAM,0BAA0B,CAAC;AAElC;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,aAAa,EAAE,oBAAoB,qBAE3E;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,iBAAiB,EAAE,iBAAiB,GACnC,OAAO,CAKT;AAED,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,oBAAoB,uDAEtE;AAED;;;;;GAKG;AAEH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,iBAAiB,GAAG,SAAS,WAEjE;AACD;;;;;GAKG;AAEH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,iBAAiB,GAAG,SAAS,WAK5E;AACD;;;;;GAKG;AAEH,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,iBAAiB,GAAG,SAAS,WAOxC,CAAC;;GAEC;AAEH,MAAM,MAAM,kBAAkB,GAC1B,qBAAqB,GACrB,uBAAuB,GACvB,OAAO,CAAC;AACZ;;;;;GAKG;AAEH,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,iBAAiB,GAAG,SAAS,GACtC,kBAAkB,CAQpB"}

package/types/core/uxAnalyticsMappers.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) 2026 Microblink Ltd. All rights reserved.
+ */
+import type { PingUxEventData } from "@microblink/analytics/ping";
+import type { BlinkIdUiErrorStateKey } from "./blinkid-ui-state";
+/**
+ * Error state keys that produce a concrete analytics error message type.
+ * UNSUPPORTED_DOCUMENT is excluded because it is handled as a separate
+ * error callback rather than an analytics error message event.
+ */
+export type PingableErrorUiStateKey = Exclude<BlinkIdUiErrorStateKey, "UNSUPPORTED_DOCUMENT">;
+/**
+ * Maps a UI error state key to the analytics error message type used in
+ * the UX event ping.
+ */
+export declare function mapErrorStateKeyToAnalyticsType(errorKey: PingableErrorUiStateKey): PingUxEventData["errorMessageType"];
+//# sourceMappingURL=uxAnalyticsMappers.d.ts.map

package/types/core/uxAnalyticsMappers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uxAnalyticsMappers.d.ts","sourceRoot":"","sources":["../../src/core/uxAnalyticsMappers.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAElE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAEjE;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAC3C,sBAAsB,EACtB,sBAAsB,CACvB,CAAC;AAEF;;;GAGG;AACH,wBAAgB,+BAA+B,CAC7C,QAAQ,EAAE,uBAAuB,GAChC,eAAe,CAAC,kBAAkB,CAAC,CA4BrC"}

package/types/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2025 Microblink Ltd. All rights reserved.
+ * Copyright (c) 2026 Microblink Ltd. All rights reserved.
  */
 /**
  * @packageDocumentation
@@ -7,14 +7,15 @@
  * This package includes feedback UI, localization support, and document scanning state management to create
  * an intuitive document scanning experience.
  */
+export type * from "@microblink/feedback-stabilizer";
+export type * from "@microblink/ux-common/hapticFeedback";
 export * from "./core/blinkid-ui-state";
-export * from "./core/BlinkIdUxManager";
-export * from "./core/HapticFeedback";
+export type { BlinkIdProcessingError } from "./core/BlinkIdProcessingError";
+export type { BlinkIdUxManager } from "./core/BlinkIdUxManager";
+export * from "./core/createBlinkIdUxManager";
+export type { DocumentClassFilter } from "./core/DocumentClassFilter";
 export * from "./ui/createBlinkIdFeedbackUi";
 export type { LocaleRecord, LocalizationStrings, } from "./ui/LocalizationContext";
-export type { DocumentClassFilter } from "./core/DocumentClassFilter";
-export type * from "@microblink/feedback-stabilizer";
-export type { BlinkIdProcessingError } from "./core/BlinkIdProcessingError";
 /**
  * The global interface.
  *

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AAEH,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,8BAA8B,CAAC;AAC7C,YAAY,EACV,YAAY,EACZ,mBAAmB,GACpB,MAAM,0BAA0B,CAAC;AAClC,YAAY,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAEtE,mBAAmB,iCAAiC,CAAC;AACrD,YAAY,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAE5E;;;;GAIG;AACH,QAAA,MAAM,UAAU,eAAW,CAAC;AAE5B;;GAEG;AACH,OAAO,CAAC,MAAM,CAAC;IAEb,IAAI,sBAAsB,EAAE,OAAO,UAAU,CAAC;CAC/C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AAEH,mBAAmB,iCAAiC,CAAC;AACrD,mBAAmB,sCAAsC,CAAC;AAC1D,cAAc,yBAAyB,CAAC;AACxC,YAAY,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAC5E,YAAY,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAChE,cAAc,+BAA+B,CAAC;AAC9C,YAAY,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACtE,cAAc,8BAA8B,CAAC;AAC7C,YAAY,EACV,YAAY,EACZ,mBAAmB,GACpB,MAAM,0BAA0B,CAAC;AAElC;;;;GAIG;AACH,QAAA,MAAM,UAAU,eAAW,CAAC;AAE5B;;GAEG;AACH,OAAO,CAAC,MAAM,CAAC;IAEb,IAAI,sBAAsB,EAAE,OAAO,UAAU,CAAC;CAC/C"}