@smileid/usesmileid_vision_document 12.1.1 → 12.2.0

package/CHANGELOG.md

@@ -1,15 +1,18 @@
 Full release notes: [Smile ID docs](https://docs.usesmileid.com/developer-resources/sdks/mobile/release-notes/react-native-expo).
 
+## 12.2.0
+
+See the repository CHANGELOG for the 12.2.0 release notes.
+
+
 ## 12.1.1
 
 See the repository CHANGELOG for the 12.1.1 release notes.
 
-
 ## 12.1.0
 
 See the repository CHANGELOG for the 12.1.0 release notes.
 
-
 ## 12.0.2
 
 See the repository CHANGELOG for the 12.0.2 release notes.

package/ios/UseSmileIDVisionDocumentModule/ResizingFrameStorage.swift

@@ -17,11 +17,34 @@ import UseSmileIDBridge
 final class ResizingFrameStorage: FrameStorage {
   /// Longest-edge pixel bound applied to document frames before encoding.
   private static let documentMaxDimension = 1600
-  /// Outward padding fraction applied to the guide-rect crop on each side
-  /// before cropping. Fifteen percent of the box's own width/height keeps the
-  /// document's corners and edges from being clipped when the card is framed
-  /// tight against the on-screen guide.
-  private static let documentCropPaddingFraction: CGFloat = 0.15
+  /// The hidden border kept around the guide rect: this fraction of the saved
+  /// image's short side on every edge, the rule of the native bridges'
+  /// `DocumentCropGeometry.documentBorderFraction` and the selfie's interior
+  /// crop. The border is where presentation-attack cues live; the backend reads
+  /// it, and the preview shows only the interior.
+  static let documentBorderFraction: CGFloat = 0.15
+
+  /// The uniform border, in pixels, to grow `guide` by: the b that is
+  /// `documentBorderFraction` of the grown rect's own short side,
+  /// b = f × s / (1 − 2f) for the guide's short side s. Shrinks to the most
+  /// every edge of an `imageSize` image can hold; 0 for an empty guide or one
+  /// touching an edge. Mirrors the native bridges' `DocumentCropGeometry.borderAround`.
+  static func borderAround(_ guide: CGRect, imageSize: CGSize) -> CGFloat {
+    let shortSide = min(guide.width, guide.height)
+    guard shortSide > 0 else { return 0 }
+    let wanted = documentBorderFraction * shortSide / (1 - 2 * documentBorderFraction)
+    let room = min(guide.minX, guide.minY, imageSize.width - guide.maxX, imageSize.height - guide.maxY)
+    return max(min(wanted, room), 0)
+  }
+
+  /// A `border` around a crop of `size` as a fraction of the crop's short side,
+  /// held to `documentBorderFraction` so the crop's pixel rounding never reports
+  /// more border than was kept; 0 for an empty crop.
+  static func borderFraction(_ border: CGFloat, of size: CGSize) -> CGFloat {
+    let shortSide = min(size.width, size.height)
+    guard shortSide > 0 else { return 0 }
+    return min(max(border / shortSide, 0), documentBorderFraction)
+  }
 
   private let sessionDirectory: URL
   private let captureType: CaptureType
@@ -34,12 +57,18 @@ final class ResizingFrameStorage: FrameStorage {
   private let livenessQuality: CGFloat
   private let documentQuality: CGFloat
   private let writer: Writer
+  /// The hidden border each document this storage saved kept, recorded by the
+  /// write tasks once their file is on disk and read after `flush()`.
+  private let savedBorders = SavedDocumentBorders()
   // The analysis tick calls `setCropRegion` on the module's async-function
   // thread; `persist` reads the value on that same serialised scan path before
   // handing it (by value) to the background encode task. The Swift value is a
   // `Sendable` struct captured by value into `Writer.enqueue`, so no background
   // task ever observes a torn read of this property.
-  nonisolated(unsafe) private var cropRegion: ViewportCropRegion?
+  //
+  // Read back as `FrameStorage.cropRegion`, which the document transitioner judges the detected
+  // document against, so auto-capture waits for the document inside the outline (ios-v12 #370).
+  nonisolated(unsafe) private(set) var cropRegion: ViewportCropRegion?
 
   init(
     sessionDirectory: URL,
@@ -124,7 +153,8 @@ final class ResizingFrameStorage: FrameStorage {
         resize: resize,
         maxDimension: maxDimension,
         quality: quality,
-        documentCropRegion: documentCropRegion
+        documentCropRegion: documentCropRegion,
+        savedBorders: savedBorders
       )
     }
   }
@@ -133,6 +163,16 @@ final class ResizingFrameStorage: FrameStorage {
     try await writer.flush()
   }
 
+  /// The hidden border the document at `url` was saved with, as a fraction of its
+  /// short side on every edge, once `flush()` has returned:
+  /// `documentBorderFraction` when the frame had room for all of it, less where it
+  /// did not, and 0 for a document saved without a guide crop or a file this
+  /// storage did not write. The screens that show the document hide exactly this
+  /// much.
+  func documentBorderFraction(at url: URL) -> CGFloat {
+    savedBorders.fraction(for: url)
+  }
+
   func clear() {
     // Selfie and document captures share one session directory; delete
     // only this role's own frames.
@@ -143,6 +183,7 @@ final class ResizingFrameStorage: FrameStorage {
     )) ?? []
     for fileURL in contents where ownsForClear(fileURL) {
       try? fileManager.removeItem(at: fileURL)
+      savedBorders.record(0, for: fileURL)
     }
   }
 
@@ -170,17 +211,24 @@ final class ResizingFrameStorage: FrameStorage {
       resize: (Int, Int)?,
       maxDimension: Int?,
       quality: CGFloat,
-      documentCropRegion: ViewportCropRegion?
+      documentCropRegion: ViewportCropRegion?,
+      savedBorders: SavedDocumentBorders
     ) {
       let task = Task<Void, Error>.detached(priority: .utility) {
-        try Self.encodeAndWrite(
-          image: image,
-          to: url,
-          resize: resize,
-          maxDimension: maxDimension,
-          quality: quality,
-          documentCropRegion: documentCropRegion
-        )
+        do {
+          let borderFraction = try Self.encodeAndWrite(
+            image: image,
+            to: url,
+            resize: resize,
+            maxDimension: maxDimension,
+            quality: quality,
+            documentCropRegion: documentCropRegion
+          )
+          savedBorders.record(borderFraction, for: url)
+        } catch {
+          savedBorders.record(0, for: url)
+          throw error
+        }
       }
       inFlight.append(task)
     }
@@ -208,7 +256,7 @@ final class ResizingFrameStorage: FrameStorage {
       maxDimension: Int?,
       quality: CGFloat,
       documentCropRegion: ViewportCropRegion?
-    ) throws {
+    ) throws -> CGFloat {
       try FileManager.default.createDirectory(
         at: url.deletingLastPathComponent(),
         withIntermediateDirectories: true
@@ -219,6 +267,8 @@ final class ResizingFrameStorage: FrameStorage {
       // render the file sideways.
       let upright = image.normalizingOrientation()
       let data: Data?
+      // The border the saved document kept, as a fraction of its short side.
+      var borderFraction: CGFloat = 0
       if let (width, height) = resize, let cgImage = upright.cgImage {
         // Center-crop and scale to the token-resolved target size
         // (selfie / liveness path).
@@ -236,20 +286,25 @@ final class ResizingFrameStorage: FrameStorage {
           let pixelWidth = cgImage.width
           let pixelHeight = cgImage.height
           let box = region.toFrameBoundingBox(frameWidth: pixelWidth, frameHeight: pixelHeight)
-          // Pad the guide rect outward by documentCropPaddingFraction of its
-          // own size on each side so the document's corners and edges keep
-          // breathing room and are never clipped when framed tight. Intersect
-          // with the image bounds so a padded edge never runs off-frame.
-          let padX = CGFloat(box.width) * ResizingFrameStorage.documentCropPaddingFraction
-          let padY = CGFloat(box.height) * ResizingFrameStorage.documentCropPaddingFraction
-          let cropRect = CGRect(
-            x: (CGFloat(box.left) - padX) * CGFloat(pixelWidth),
-            y: (CGFloat(box.top) - padY) * CGFloat(pixelHeight),
-            width: (CGFloat(box.width) + padX * 2) * CGFloat(pixelWidth),
-            height: (CGFloat(box.height) + padY * 2) * CGFloat(pixelHeight)
-          ).intersection(CGRect(x: 0, y: 0, width: pixelWidth, height: pixelHeight))
+          // Grow the guide rect by the hidden border (documentBorderFraction of
+          // the saved image's short side, uniform on every edge), which the
+          // preview never shows; clamp to the image bounds.
+          let imageSize = CGSize(width: pixelWidth, height: pixelHeight)
+          let guide = CGRect(
+            x: CGFloat(box.left) * imageSize.width,
+            y: CGFloat(box.top) * imageSize.height,
+            width: CGFloat(box.width) * imageSize.width,
+            height: CGFloat(box.height) * imageSize.height
+          )
+          let border = ResizingFrameStorage.borderAround(guide, imageSize: imageSize)
+          let cropRect = guide.insetBy(dx: -border, dy: -border)
+            .intersection(CGRect(origin: .zero, size: imageSize))
           if let cropped = cgImage.cropping(to: cropRect) {
             cgImage = cropped
+            borderFraction = ResizingFrameStorage.borderFraction(
+              border,
+              of: CGSize(width: cropped.width, height: cropped.height)
+            )
           }
         }
         let pixelWidth = cgImage.width
@@ -277,10 +332,27 @@ final class ResizingFrameStorage: FrameStorage {
         throw ResizingFrameStorageError.encodeFailed(url: url)
       }
       try data.write(to: url, options: .atomic)
+      return borderFraction
     }
   }
 }
 
+/// The hidden border each document a `ResizingFrameStorage` saved kept, as a
+/// fraction of its short side, by file. Shared with the detached write tasks, so it
+/// is lock-guarded.
+final class SavedDocumentBorders: @unchecked Sendable {
+  private let lock = NSLock()
+  private var fractions: [URL: CGFloat] = [:]
+
+  func record(_ fraction: CGFloat, for url: URL) {
+    lock.withLock { fractions[url.standardizedFileURL] = fraction > 0 ? fraction : nil }
+  }
+
+  func fraction(for url: URL) -> CGFloat {
+    lock.withLock { fractions[url.standardizedFileURL] ?? 0 }
+  }
+}
+
 enum ResizingFrameStorageError: Error, Sendable {
   case encodeFailed(url: URL)
 }

package/ios/UseSmileIDVisionDocumentModule/UseSmileIDVisionDocumentModule.swift

@@ -12,6 +12,9 @@ public class UseSmileIDVisionDocumentModule: Module {
 
 
   private var session: UseSmileIDDocumentSession?
+  /// The latest session's storage, kept past `close` so `documentBorderFraction` can read the
+  /// border of a document saved before the flow moved on.
+  private var storage: ResizingFrameStorage?
 
   public func definition() -> ModuleDefinition {
     Name("UseSmileIDVisionDocument")
@@ -43,6 +46,7 @@ public class UseSmileIDVisionDocumentModule: Module {
         frameStorage: storage
       )
       self.session = newSession
+      self.storage = storage
       // Publish the session through the holder's operation queue so the
       // write is serialised with any concurrent scan on the FP thread.
       UseSmileIDVisionDocumentSessionHolder.shared.setSession(newSession)
@@ -73,6 +77,14 @@ public class UseSmileIDVisionDocumentModule: Module {
       }
     }
 
+    // The hidden border the document at `url` was saved with, as a fraction of its short side,
+    // once `flush` has returned; 0 for a document saved without one.
+    AsyncFunction("documentBorderFraction") { (url: String) -> Double in
+      let fileURL = url.hasPrefix("file:") ? URL(string: url) : URL(fileURLWithPath: url)
+      guard let fileURL, let storage = self.storage else { return 0 }
+      return Double(storage.documentBorderFraction(at: fileURL))
+    }
+
     AsyncFunction("close") {
       UseSmileIDVisionDocumentSessionHolder.shared.setSession(nil)
       UseSmileIDVisionDocumentSessionHolder.shared.setStorage(nil)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smileid/usesmileid_vision_document",
-  "version": "12.1.1",
+  "version": "12.2.0",
   "description": "Apple Vision document detection implementation for the UseSmileID React Native (Expo) SDK.",
   "homepage": "https://usesmileid.com",
   "repository": {
@@ -46,8 +46,8 @@
     "CHANGELOG.md"
   ],
   "dependencies": {
-    "@smileid/usesmileid_bridge": "12.1.1",
-    "@smileid/usesmileid_platform_interface": "12.1.1"
+    "@smileid/usesmileid_bridge": "12.2.0",
+    "@smileid/usesmileid_platform_interface": "12.2.0"
   },
   "peerDependencies": {
     "expo": ">=56.0.0",
@@ -55,9 +55,9 @@
     "react-native": ">=0.83.0"
   },
   "devDependencies": {
-    "@types/node": "^26.4.1",
-    "expo": "~57.0.20",
-    "expo-modules-core": "^57.0.16",
+    "@types/node": "^26.6.2",
+    "expo": "~57.0.25",
+    "expo-modules-core": "^57.0.19",
     "react-native": "^0.86.3",
     "typescript": "^6.0.3",
     "xcode": "^3.0.1"

package/plugin/build/index.js

@@ -1 +1 @@
-"use strict";var __createBinding=this&&this.__createBinding||(Object.create?(function(i,r,t,e){e===void 0&&(e=t);var o=Object.getOwnPropertyDescriptor(r,t);(!o||("get"in o?!r.__esModule:o.writable||o.configurable))&&(o={enumerable:!0,get:function(){return r[t]}}),Object.defineProperty(i,e,o)}):(function(i,r,t,e){e===void 0&&(e=t),i[e]=r[t]})),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?(function(i,r){Object.defineProperty(i,"default",{enumerable:!0,value:r})}):function(i,r){i.default=r}),__importStar=this&&this.__importStar||(function(){var i=function(r){return i=Object.getOwnPropertyNames||function(t){var e=[];for(var o in t)Object.prototype.hasOwnProperty.call(t,o)&&(e[e.length]=o);return e},i(r)};return function(r){if(r&&r.__esModule)return r;var t={};if(r!=null)for(var e=i(r),o=0;o<e.length;o++)e[o]!=="default"&&__createBinding(t,r,e[o]);return __setModuleDefault(t,r),t}})();Object.defineProperty(exports,"__esModule",{value:!0}),exports.SPM_PRODUCTS=void 0;const config_plugins_1=require("expo/config-plugins"),fs=__importStar(require("fs")),path=__importStar(require("path")),deployment_target_1=require("./lib/deployment_target"),podfile_1=require("./lib/podfile"),signature_dedup_1=require("./lib/signature_dedup"),spm_1=require("./lib/spm"),IOS_DEPLOYMENT_TARGET="16.4",SMILE_ID_PACKAGE={url:"https://github.com/smileidentity/ios-spm",requirement:{kind:"exactVersion",version:"12.1.1"}},POD_TARGET="UseSmileIDVisionDocumentExpo";exports.SPM_PRODUCTS=["UseSmileIDVisionDocument"];const PODFILE_MARKER="usesmileid_vision_document",BRIDGE_POD_TARGET="UseSmileIDBridgeExpo",BRIDGE_SPM_PRODUCTS=["UseSmileIDBridge"],BRIDGE_PODFILE_MARKER="usesmileid_bridge",withVisionDocumentSpm=(i,r)=>(i=(0,deployment_target_1.withIosDeploymentTargetFloor)(i,IOS_DEPLOYMENT_TARGET),i=(0,config_plugins_1.withXcodeProject)(i,t=>{const e=t.modRequest.projectName;if(!e)throw new Error("[usesmileid_vision_document] Unable to resolve host app native target name from Expo config.");return(0,spm_1.linkSpmPackage)(t.modResults,SMILE_ID_PACKAGE,{targetName:e,products:[...exports.SPM_PRODUCTS]}),r?.iosSignatureAggregation==="disabled"?(0,signature_dedup_1.disableSignatureAggregation)(t.modResults,e):(0,signature_dedup_1.ensureSignatureDedupPhase)(t.modResults,e),t}),i=(0,config_plugins_1.withDangerousMod)(i,["ios",t=>{const e=path.join(t.modRequest.platformProjectRoot,"Podfile"),o=fs.readFileSync(e,"utf-8");let n=(0,podfile_1.injectPodfileSpmBlock)(o,{marker:PODFILE_MARKER,package:SMILE_ID_PACKAGE,podTarget:POD_TARGET,products:[...exports.SPM_PRODUCTS]});return n=(0,podfile_1.injectPodfileSpmBlock)(n,{marker:BRIDGE_PODFILE_MARKER,package:SMILE_ID_PACKAGE,podTarget:BRIDGE_POD_TARGET,products:[...BRIDGE_SPM_PRODUCTS],required:!0}),n=(0,podfile_1.injectPodfileKameraLinkBlock)(n),n=(0,podfile_1.injectPodfileSignatureDedupBlock)(n),n!==o&&fs.writeFileSync(e,n),t}]),i);exports.default=withVisionDocumentSpm;
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?(function(i,r,t,e){e===void 0&&(e=t);var o=Object.getOwnPropertyDescriptor(r,t);(!o||("get"in o?!r.__esModule:o.writable||o.configurable))&&(o={enumerable:!0,get:function(){return r[t]}}),Object.defineProperty(i,e,o)}):(function(i,r,t,e){e===void 0&&(e=t),i[e]=r[t]})),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?(function(i,r){Object.defineProperty(i,"default",{enumerable:!0,value:r})}):function(i,r){i.default=r}),__importStar=this&&this.__importStar||(function(){var i=function(r){return i=Object.getOwnPropertyNames||function(t){var e=[];for(var o in t)Object.prototype.hasOwnProperty.call(t,o)&&(e[e.length]=o);return e},i(r)};return function(r){if(r&&r.__esModule)return r;var t={};if(r!=null)for(var e=i(r),o=0;o<e.length;o++)e[o]!=="default"&&__createBinding(t,r,e[o]);return __setModuleDefault(t,r),t}})();Object.defineProperty(exports,"__esModule",{value:!0}),exports.SPM_PRODUCTS=void 0;const config_plugins_1=require("expo/config-plugins"),fs=__importStar(require("fs")),path=__importStar(require("path")),deployment_target_1=require("./lib/deployment_target"),podfile_1=require("./lib/podfile"),signature_dedup_1=require("./lib/signature_dedup"),spm_1=require("./lib/spm"),IOS_DEPLOYMENT_TARGET="16.4",SMILE_ID_PACKAGE={url:"https://github.com/smileidentity/ios-spm",requirement:{kind:"exactVersion",version:"12.2.0"}},POD_TARGET="UseSmileIDVisionDocumentExpo";exports.SPM_PRODUCTS=["UseSmileIDVisionDocument"];const PODFILE_MARKER="usesmileid_vision_document",BRIDGE_POD_TARGET="UseSmileIDBridgeExpo",BRIDGE_SPM_PRODUCTS=["UseSmileIDBridge"],BRIDGE_PODFILE_MARKER="usesmileid_bridge",withVisionDocumentSpm=(i,r)=>(i=(0,deployment_target_1.withIosDeploymentTargetFloor)(i,IOS_DEPLOYMENT_TARGET),i=(0,config_plugins_1.withXcodeProject)(i,t=>{const e=t.modRequest.projectName;if(!e)throw new Error("[usesmileid_vision_document] Unable to resolve host app native target name from Expo config.");return(0,spm_1.linkSpmPackage)(t.modResults,SMILE_ID_PACKAGE,{targetName:e,products:[...exports.SPM_PRODUCTS]}),r?.iosSignatureAggregation==="disabled"?(0,signature_dedup_1.disableSignatureAggregation)(t.modResults,e):(0,signature_dedup_1.ensureSignatureDedupPhase)(t.modResults,e),t}),i=(0,config_plugins_1.withDangerousMod)(i,["ios",t=>{const e=path.join(t.modRequest.platformProjectRoot,"Podfile"),o=fs.readFileSync(e,"utf-8");let n=(0,podfile_1.injectPodfileSpmBlock)(o,{marker:PODFILE_MARKER,package:SMILE_ID_PACKAGE,podTarget:POD_TARGET,products:[...exports.SPM_PRODUCTS]});return n=(0,podfile_1.injectPodfileSpmBlock)(n,{marker:BRIDGE_PODFILE_MARKER,package:SMILE_ID_PACKAGE,podTarget:BRIDGE_POD_TARGET,products:[...BRIDGE_SPM_PRODUCTS],required:!0}),n=(0,podfile_1.injectPodfileKameraLinkBlock)(n),n=(0,podfile_1.injectPodfileSignatureDedupBlock)(n),n!==o&&fs.writeFileSync(e,n),t}]),i);exports.default=withVisionDocumentSpm;

package/plugin/build/lib/podfile.js

@@ -145,7 +145,7 @@ begin
     #    @rpath/Kamera.framework/Kamera"). Xcode embeds a binary product only for an app
     #    target that depends on it, so the app target takes both products directly.
     kamera_spm_url = 'https://github.com/smileidentity/kamera-spm'
-    kamera_spm_version = JSON.parse(File.read(kamera_package_json))['version'].sub(/-SNAPSHOT.*$/, '')
+    kamera_spm_version = JSON.parse(File.read(kamera_package_json))['version'].sub(/-SNAPSHOT$/, '')
     kamera_spm_app_products = %w[Kamera KameraVision]
     # A reference an app added by hand may spell the same repository differently (.git suffix,
     # trailing slash, case); a second reference to one repository fails Xcode's resolution.