@mikashboks/capture-intelligence-core 0.2.4 → 0.2.5

package/dist/cjs/document-crop-arbitration.d.ts

@@ -0,0 +1,105 @@
+import type { CaptureTrustClient, CropTrustTier } from './capture-trust.js';
+export type DocumentCropShapeFamily = 'card-like' | 'passport-like' | 'document-page-like';
+export type DocumentCropReviewPolicy = 'default' | 'original_only' | 'disabled_unsafe';
+export type DocumentCropArbitrationDecision = 'default_crop' | 'original_with_overlay' | 'original_only' | 'unsafe_crop';
+export interface DocumentCropArbitrationAssessment {
+    decision: DocumentCropArbitrationDecision;
+    policy: DocumentCropReviewPolicy;
+    score: number;
+    reason: string;
+    reviewSafe: boolean;
+    defaultSafe: boolean;
+    cropVerified: boolean;
+    cropSelectable: boolean;
+}
+export interface DocumentCropPoint {
+    x: number;
+    y: number;
+}
+export interface DocumentCropRect {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+}
+export interface DocumentCropImageSize {
+    width: number;
+    height: number;
+}
+export interface DocumentCropQuadrilateral {
+    topLeft: DocumentCropPoint;
+    topRight: DocumentCropPoint;
+    bottomRight: DocumentCropPoint;
+    bottomLeft: DocumentCropPoint;
+}
+export interface DocumentCropArbitrationMetadata {
+    applied?: boolean | null;
+    confidence?: number | null;
+    reason?: string | null;
+    method?: 'perspective' | 'rectangle' | 'none' | string | null;
+    scannerEngine?: string | null;
+    cropSource?: string | null;
+    cropProvenance?: string | null;
+    rect?: DocumentCropRect | null;
+    polygon?: DocumentCropQuadrilateral | null;
+    sourceImageSize?: DocumentCropImageSize | null;
+    outputImageSize?: DocumentCropImageSize | null;
+    areaRatio?: number | null;
+    aspectRatio?: number | null;
+    clamped?: boolean | null;
+    unsafeReason?: string | null;
+    cornersOk?: boolean | null;
+    cropShapeFamily?: DocumentCropShapeFamily | null;
+    cropVerified?: boolean | null;
+    cropSelectable?: boolean | null;
+    cutOffRisk?: 'low' | 'medium' | 'high' | string | null;
+    quietZoneClampLossFraction?: number | null;
+    liveRecognitionAccepted?: boolean | null;
+    liveRecognitionReason?: string | null;
+    liveRecognitionPath?: string | null;
+    liveRecognitionStrategy?: string | null;
+    liveBoundsDetector?: 'scanic' | 'kt-jscanify' | 'sobel-fallback' | string | null;
+    liveBoundsReliable?: boolean | null;
+    liveQuadPresent?: boolean | null;
+    liveQuadInsetMin?: number | null;
+    liveMrzConfidence?: number | null;
+    liveMrzCheckDigitsValid?: boolean | null;
+    liveMrzValidated?: boolean | null;
+    captureCandidateDecision?: string | null;
+    classifierConfidence?: number | null;
+}
+interface DocumentCropSafetyThresholds {
+    minAreaRatio: number;
+    minWidthRatio: number;
+    minHeightRatio: number;
+    maxHorizontalOutsideMarginRatio: number;
+    maxVerticalOutsideMarginRatio: number;
+    aspectMin: number;
+    aspectMax: number;
+    useNormalizedAspect?: boolean;
+}
+export declare const DEFAULT_CROP_CONFIDENCE_THRESHOLD = 0.8;
+export declare const DEFAULT_RECTANGLE_CROP_CONFIDENCE_THRESHOLD = 0.88;
+export declare const DEFAULT_SUBMIT_CROP_INSET_FLOOR_ENABLED = true;
+export declare const DOCUMENT_CROP_ASPECT_MIN = 0.45;
+export declare const DOCUMENT_CROP_ASPECT_MAX = 2.15;
+export declare const CARD_LIKE_MEASURED_CROP_MIN_AREA_RATIO = 0.06;
+export declare const QUIET_ZONE_CLAMP_CUT_OFF_RISK_LOSS = 0.8;
+export declare const SAFE_LIVE_QUAD_INSET_MIN = 0.02;
+export declare const isCardLikeCropAspect: (aspectRatio: number) => boolean;
+export declare const getDocumentCropShapeFamily: (aspectRatio: number) => DocumentCropShapeFamily;
+export declare const getDocumentCropSafetyThresholds: (aspectRatio: number, shapeFamily?: DocumentCropShapeFamily | null) => DocumentCropSafetyThresholds;
+export declare const getDocumentCropSafetyAspectRatio: (aspectRatio: number, safetyThresholds: Pick<DocumentCropSafetyThresholds, "useNormalizedAspect">) => number;
+export declare const isDocumentCropAspectSafe: (aspectRatio: number, safetyThresholds: Pick<DocumentCropSafetyThresholds, "aspectMin" | "aspectMax" | "useNormalizedAspect">) => boolean;
+export declare const getMeasuredDocumentCropMinAreaRatio: (aspectRatio: number, shapeFamily?: DocumentCropShapeFamily | null) => number;
+export declare const hasExplicitDocumentCutOffReason: (reason: string | null | undefined) => boolean;
+export declare const hasExplicitUnsafeCaptureReason: (reason: string | null | undefined) => boolean;
+export declare const hasCaptureDocumentCutOffEvidence: (metadata: Pick<DocumentCropArbitrationMetadata, "reason"> | null | undefined) => boolean;
+export declare const hasMarginSafeDocumentCropEvidence: (metadata: DocumentCropArbitrationMetadata) => boolean;
+export declare const isDocumentCropVerified: (metadata: DocumentCropArbitrationMetadata) => boolean;
+export declare const getDocumentCropRejectedReason: (metadata: DocumentCropArbitrationMetadata) => string;
+export declare function assessDocumentCropCandidate(croppedBase64: string, cropMetadata: DocumentCropArbitrationMetadata | undefined): DocumentCropArbitrationAssessment;
+export declare function getDocumentCropReviewPolicy(croppedBase64: string, cropMetadata: DocumentCropArbitrationMetadata | undefined): DocumentCropReviewPolicy;
+export declare function getDocumentCropTrustTier(croppedBase64: string, cropMetadata: DocumentCropArbitrationMetadata | undefined, client?: CaptureTrustClient): CropTrustTier;
+export {};
+//# sourceMappingURL=document-crop-arbitration.d.ts.map

package/dist/cjs/document-crop-arbitration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-crop-arbitration.d.ts","sourceRoot":"","sources":["../../src/document-crop-arbitration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAG5E,MAAM,MAAM,uBAAuB,GAAG,WAAW,GAAG,eAAe,GAAG,oBAAoB,CAAC;AAE3F,MAAM,MAAM,wBAAwB,GAAG,SAAS,GAAG,eAAe,GAAG,iBAAiB,CAAC;AAEvF,MAAM,MAAM,+BAA+B,GACvC,cAAc,GACd,uBAAuB,GACvB,eAAe,GACf,aAAa,CAAC;AAElB,MAAM,WAAW,iCAAiC;IAChD,QAAQ,EAAE,+BAA+B,CAAC;IAC1C,MAAM,EAAE,wBAAwB,CAAC;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,OAAO,CAAC;IACpB,WAAW,EAAE,OAAO,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED,MAAM,WAAW,gBAAgB;IAC/B,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,iBAAiB,CAAC;IAC3B,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,WAAW,EAAE,iBAAiB,CAAC;IAC/B,UAAU,EAAE,iBAAiB,CAAC;CAC/B;AAED,MAAM,WAAW,+BAA+B;IAC9C,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,MAAM,CAAC,EAAE,aAAa,GAAG,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAC9D,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,IAAI,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAC/B,OAAO,CAAC,EAAE,yBAAyB,GAAG,IAAI,CAAC;IAC3C,eAAe,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC/C,eAAe,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC/C,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC3B,eAAe,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;IACjD,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC9B,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAChC,UAAU,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IACvD,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3C,uBAAuB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACzC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,kBAAkB,CAAC,EAAE,QAAQ,GAAG,aAAa,GAAG,gBAAgB,GAAG,MAAM,GAAG,IAAI,CAAC;IACjF,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACpC,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACjC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,uBAAuB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACzC,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAClC,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtC;AAED,UAAU,4BAA4B;IACpC,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,+BAA+B,EAAE,MAAM,CAAC;IACxC,6BAA6B,EAAE,MAAM,CAAC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,eAAO,MAAM,iCAAiC,MAAM,CAAC;AACrD,eAAO,MAAM,2CAA2C,OAAO,CAAC;AAChE,eAAO,MAAM,uCAAuC,OAAO,CAAC;AAC5D,eAAO,MAAM,wBAAwB,OAAO,CAAC;AAC7C,eAAO,MAAM,wBAAwB,OAAO,CAAC;AAC7C,eAAO,MAAM,sCAAsC,OAAO,CAAC;AAC3D,eAAO,MAAM,kCAAkC,MAAM,CAAC;AACtD,eAAO,MAAM,wBAAwB,OAAO,CAAC;AA6E7C,eAAO,MAAM,oBAAoB,GAAI,aAAa,MAAM,KAAG,OACoC,CAAC;AAEhG,eAAO,MAAM,0BAA0B,GAAI,aAAa,MAAM,KAAG,uBAOhE,CAAC;AAEF,eAAO,MAAM,+BAA+B,GAC1C,aAAa,MAAM,EACnB,cAAc,uBAAuB,GAAG,IAAI,KAC3C,4BAIF,CAAC;AAEF,eAAO,MAAM,gCAAgC,GAC3C,aAAa,MAAM,EACnB,kBAAkB,IAAI,CAAC,4BAA4B,EAAE,qBAAqB,CAAC,KAC1E,MAGc,CAAC;AAElB,eAAO,MAAM,wBAAwB,GACnC,aAAa,MAAM,EACnB,kBAAkB,IAAI,CACpB,4BAA4B,EAC5B,WAAW,GAAG,WAAW,GAAG,qBAAqB,CAClD,KACA,OAQF,CAAC;AAEF,eAAO,MAAM,mCAAmC,GAC9C,aAAa,MAAM,EACnB,cAAc,uBAAuB,GAAG,IAAI,KAC3C,MAYF,CAAC;AAEF,eAAO,MAAM,+BAA+B,GAAI,QAAQ,MAAM,GAAG,IAAI,GAAG,SAAS,KAAG,OACpB,CAAC;AAEjE,eAAO,MAAM,8BAA8B,GAAI,QAAQ,MAAM,GAAG,IAAI,GAAG,SAAS,KAAG,OACrB,CAAC;AAE/D,eAAO,MAAM,gCAAgC,GAC3C,UAAU,IAAI,CAAC,+BAA+B,EAAE,QAAQ,CAAC,GAAG,IAAI,GAAG,SAAS,KAC3E,OAOF,CAAC;AA8PF,eAAO,MAAM,iCAAiC,GAC5C,UAAU,+BAA+B,KACxC,OAUF,CAAC;AAoLF,eAAO,MAAM,sBAAsB,GAAI,UAAU,+BAA+B,KAAG,OAOD,CAAC;AAOnF,eAAO,MAAM,6BAA6B,GACxC,UAAU,+BAA+B,KACxC,MA+CF,CAAC;AAsDF,wBAAgB,2BAA2B,CACzC,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,+BAA+B,GAAG,SAAS,GACxD,iCAAiC,CAyKnC;AAED,wBAAgB,2BAA2B,CACzC,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,+BAA+B,GAAG,SAAS,GACxD,wBAAwB,CAE1B;AAED,wBAAgB,wBAAwB,CACtC,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,+BAA+B,GAAG,SAAS,EACzD,MAAM,GAAE,kBAA0B,GACjC,aAAa,CAiCf"}