@smileid/usesmileid_vision_face 12.0.0-beta01 → 12.0.0

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 12.0.0
+
+First stable release of the Smile ID v12 SDK. Provides the iOS Apple Vision face detection module for `usesmileid`.
+
 ## 12.0.0-beta01
 
 First public beta release. Apple Vision face detection for the Smile ID React Native (Expo) SDK v12.

package/README.md

@@ -13,7 +13,6 @@ and a TS wrapper that bridges the four contract methods (`configure /
 analyze / reset / close`) with Zod-validated wire payloads.
 
 No ML logic is reimplemented in this package — it's a pure passthrough.
-See `react-native-expo/docs/Architecture.md`.
 
 ## Installation
 

package/ios/UseSmileIDVisionFaceModule/ResizingFrameStorage.swift

@@ -1,34 +1,30 @@
-// MIRRORED FILE — duplicated into both RN Expo iOS vision modules
-// (usesmileid_vision_face / usesmileid_vision_document). The per-module
-// CocoaPods bridge target sources cannot share files without a new pod.
-// Canonical location:
-//   usesmileid_vision_face/ios/UseSmileIDVisionFaceModule/ResizingFrameStorage.swift
-// Mirror location:
-//   usesmileid_vision_document/ios/UseSmileIDVisionDocumentModule/ResizingFrameStorage.swift
-//
-// Any edit here MUST be applied to the other location in the same commit.
+// MIRRORED FILE — duplicated in both RN Expo iOS vision modules
+// (usesmileid_vision_face / usesmileid_vision_document); the per-module pod
+// targets can't share sources. Apply any edit to BOTH copies in the same commit.
 
 import Foundation
 import UIKit
 import UseSmileIDBridge
 
-/// `FrameStorage` implementation that center-crops and scales every selfie and
-/// liveness JPEG to the configured target dimensions before writing.
-///
-/// Target dimensions are resolved at configure-time from the token
-/// `sdk_config` claim; the executor falls back to 480 × 640 when the token
-/// carries no override, so the on-disk pixel size always matches the
-/// `image_width` / `image_height` values reported in job metadata.
-///
-/// Document frames are not resized — they are written at the analyzer's
-/// native frame resolution using the specified `documentQuality`. Document
-/// dimensions are not part of the token `sdk_config` contract.
-///
-/// Encode and write run on background tasks; `persist` is fire-and-forget so
-/// the analyzer keeps running at frame rate. `flush()` awaits all in-flight
-/// writes before upload proceeds.
+/// `FrameStorage` that center-crops + scales selfie/liveness JPEGs to the
+/// token-resolved target size (falling back to 480×640, matching the
+/// `image_width`/`image_height` job metadata), and downscales document frames
+/// so their longest edge is bounded at `documentMaxDimension` (no upscaling).
+/// When a crop region is set, document frames are first cropped to the on-screen
+/// guide so the saved capture matches what the user framed (`setCropRegion(nil)`
+/// clears it; selfie/liveness are never guide-cropped). Encode + write run on
+/// background tasks; `persist` is fire-and-forget, `flush()` awaits all writes.
 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
+
   private let sessionDirectory: URL
+  private let captureType: CaptureType
   private let documentSide: DocumentSide
   private let selfieTargetWidth: Int
   private let selfieTargetHeight: Int
@@ -38,9 +34,16 @@ final class ResizingFrameStorage: FrameStorage {
   private let livenessQuality: CGFloat
   private let documentQuality: CGFloat
   private let writer: Writer
+  // The frame-processor plugin calls `setCropRegion` on the VisionCamera FP
+  // 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?
 
   init(
     sessionDirectory: URL,
+    captureType: CaptureType,
     documentSide: DocumentSide = .front,
     selfieTargetWidth: Int = 480,
     selfieTargetHeight: Int = 640,
@@ -51,6 +54,7 @@ final class ResizingFrameStorage: FrameStorage {
     documentQuality: CGFloat = 0.85
   ) {
     self.sessionDirectory = sessionDirectory
+    self.captureType = captureType
     self.documentSide = documentSide
     self.selfieTargetWidth = selfieTargetWidth
     self.selfieTargetHeight = selfieTargetHeight
@@ -62,6 +66,13 @@ final class ResizingFrameStorage: FrameStorage {
     self.writer = Writer()
   }
 
+  /// Set the on-screen document guide rectangle so document frames are cropped
+  /// to exactly what the user saw. Pass `nil` to clear the crop and save the
+  /// full upright frame. Selfie and liveness frames are unaffected.
+  func setCropRegion(_ region: ViewportCropRegion?) {
+    cropRegion = region
+  }
+
   func url(for kind: FrameKind, captureIndex: Int) -> URL {
     let name: String
     switch kind {
@@ -84,20 +95,37 @@ final class ResizingFrameStorage: FrameStorage {
   func persist(image: UIImage, to url: URL) {
     let name = url.lastPathComponent
     let resize: (Int, Int)?
+    let maxDimension: Int?
     let quality: CGFloat
+    let documentCropRegion: ViewportCropRegion?
     if name.hasPrefix("selfie") {
       resize = (selfieTargetWidth, selfieTargetHeight)
+      maxDimension = nil
       quality = selfieQuality
+      documentCropRegion = nil
     } else if name.hasPrefix("liveness") {
       resize = (livenessTargetWidth, livenessTargetHeight)
+      maxDimension = nil
       quality = livenessQuality
+      documentCropRegion = nil
     } else {
-      // Document frames: encode at the analyzer's native resolution.
+      // Document frames: optionally crop to the guide overlay, then downscale
+      // so the longest edge is bounded at documentMaxDimension; frames already
+      // within the bound are written as-is (no upscaling).
       resize = nil
+      maxDimension = Self.documentMaxDimension
       quality = documentQuality
+      documentCropRegion = cropRegion
     }
     Task {
-      await writer.enqueue(image: image, to: url, resize: resize, quality: quality)
+      await writer.enqueue(
+        image: image,
+        to: url,
+        resize: resize,
+        maxDimension: maxDimension,
+        quality: quality,
+        documentCropRegion: documentCropRegion
+      )
     }
   }
 
@@ -106,25 +134,53 @@ final class ResizingFrameStorage: FrameStorage {
   }
 
   func clear() {
+    // Selfie and document captures share one session directory; delete
+    // only this role's own frames.
     let fileManager = FileManager.default
     let contents = (try? fileManager.contentsOfDirectory(
       at: sessionDirectory,
       includingPropertiesForKeys: nil
     )) ?? []
-    for fileURL in contents {
+    for fileURL in contents where ownsForClear(fileURL) {
       try? fileManager.removeItem(at: fileURL)
     }
   }
 
+  private func ownsForClear(_ fileURL: URL) -> Bool {
+    let name = fileURL.lastPathComponent
+    switch captureType {
+    case .selfie:
+      return name.hasPrefix("selfie") || name.hasPrefix("liveness")
+    case .document:
+      return name == url(for: .document, captureIndex: 0).lastPathComponent
+    @unknown default:
+      return false
+    }
+  }
+
   /// Serialises writes through an actor so concurrent `persist` calls for
   /// the same URL don't race and `flush()` can join every outstanding task
   /// without external synchronisation.
   private actor Writer {
     private var inFlight: [Task<Void, Error>] = []
 
-    func enqueue(image: UIImage, to url: URL, resize: (Int, Int)?, quality: CGFloat) {
+    func enqueue(
+      image: UIImage,
+      to url: URL,
+      resize: (Int, Int)?,
+      maxDimension: Int?,
+      quality: CGFloat,
+      documentCropRegion: ViewportCropRegion?
+    ) {
       let task = Task<Void, Error>.detached(priority: .utility) {
-        try Self.encodeAndWrite(image: image, to: url, resize: resize, quality: quality)
+        try Self.encodeAndWrite(
+          image: image,
+          to: url,
+          resize: resize,
+          maxDimension: maxDimension,
+          quality: quality,
+          documentCropRegion: documentCropRegion
+        )
       }
       inFlight.append(task)
     }
@@ -149,7 +205,9 @@ final class ResizingFrameStorage: FrameStorage {
       image: UIImage,
       to url: URL,
       resize: (Int, Int)?,
-      quality: CGFloat
+      maxDimension: Int?,
+      quality: CGFloat,
+      documentCropRegion: ViewportCropRegion?
     ) throws {
       try FileManager.default.createDirectory(
         at: url.deletingLastPathComponent(),
@@ -162,9 +220,56 @@ final class ResizingFrameStorage: FrameStorage {
       let upright = image.normalizingOrientation()
       let data: Data?
       if let (width, height) = resize, let cgImage = upright.cgImage {
-        // Center-crop and scale to the token-resolved target size.
+        // Center-crop and scale to the token-resolved target size
+        // (selfie / liveness path).
         let cropped = cgImage.centerCroppedExact(width: width, height: height)
         data = cropped.flatMap { UIImage(cgImage: $0).jpegData(compressionQuality: quality) }
+      } else if let maxDimension, var cgImage = upright.cgImage {
+        // Document path: optionally crop to the on-screen guide overlay, then
+        // downscale so the longest pixel edge is bounded at maxDimension.
+        // Never upscale frames already within the bound.
+        //
+        // Geometric correctness of the crop depends on `upright` being
+        // pixel-upright (orientation baked above); `toFrameBoundingBox`
+        // maps viewport coordinates onto an upright frame.
+        if let region = documentCropRegion {
+          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))
+          if let cropped = cgImage.cropping(to: cropRect) {
+            cgImage = cropped
+          }
+        }
+        let pixelWidth = cgImage.width
+        let pixelHeight = cgImage.height
+        let longest = max(pixelWidth, pixelHeight)
+        if longest > maxDimension {
+          let scale = CGFloat(maxDimension) / CGFloat(longest)
+          let newSize = CGSize(
+            width: (CGFloat(pixelWidth) * scale).rounded(),
+            height: (CGFloat(pixelHeight) * scale).rounded()
+          )
+          let format = UIGraphicsImageRendererFormat()
+          format.scale = 1
+          let scaled = UIGraphicsImageRenderer(size: newSize, format: format).image { _ in
+            UIImage(cgImage: cgImage).draw(in: CGRect(origin: .zero, size: newSize))
+          }
+          data = scaled.jpegData(compressionQuality: quality)
+        } else {
+          data = UIImage(cgImage: cgImage).jpegData(compressionQuality: quality)
+        }
       } else {
         data = upright.jpegData(compressionQuality: quality)
       }

package/ios/UseSmileIDVisionFaceModule/UseSmileIDVisionFaceModule.swift

@@ -114,6 +114,7 @@ private extension Dictionary where Key == String, Value == Any? {
     let livenessQuality = ((self["livenessJpegQuality"] as? NSNumber)?.intValue).map { CGFloat($0) / 100.0 } ?? 0.80
     return ResizingFrameStorage(
       sessionDirectory: sessionDirectory,
+      captureType: .selfie,
       documentSide: .front,
       selfieTargetWidth: selfieTargetWidth,
       selfieTargetHeight: selfieTargetHeight,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@smileid/usesmileid_vision_face",
-  "version": "12.0.0-beta01",
-  "description": "UseSmileID v12 — Apple Vision face provider (iOS-only). Thin Expo Module shim around the existing Swift Package `UseSmileIDVisionFace`.",
+  "version": "12.0.0",
+  "description": "Apple Vision face detection implementation for the UseSmileID React Native (Expo) SDK.",
   "homepage": "https://usesmileid.com",
   "repository": {
     "type": "git",
@@ -48,8 +48,8 @@
     "CHANGELOG.md"
   ],
   "dependencies": {
-    "@smileid/usesmileid_bridge": "12.0.0-beta01",
-    "@smileid/usesmileid_platform_interface": "12.0.0-beta01"
+    "@smileid/usesmileid_platform_interface": "12.0.0",
+    "@smileid/usesmileid_bridge": "12.0.0"
   },
   "peerDependencies": {
     "expo": ">=56.0.0",
@@ -64,8 +64,7 @@
     "typescript": "^6.0.3"
   },
   "publishConfig": {
-    "access": "public",
-    "provenance": false
+    "access": "public"
   },
   "scripts": {
     "build": "pnpm run build:lib && pnpm run build:plugin",

package/plugin/build/index.js

@@ -51,15 +51,15 @@ const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const podfile_1 = require("./lib/podfile");
 const spm_1 = require("./lib/spm");
-// Pinned to the exact `12.0.0-beta01` release tag — `from: 12.0.0`
+// Pinned to the exact `12.0.0` release tag — `from: 12.0.0`
 // would not resolve because `ios-spm` publishes pre-release tags (e.g.
-// `12.0.0-beta01`), and SPM excludes pre-release tags from open-ended
+// `12.0.0`), and SPM excludes pre-release tags from open-ended
 // major-version requirements.
 const SMILE_ID_PACKAGE = {
     url: "https://github.com/smileidentity/ios-spm",
     requirement: {
         kind: "exactVersion",
-        version: "12.0.0-beta01",
+        version: "12.0.0",
     },
 };
 const POD_TARGET = "UseSmileIDVisionFaceExpo";

package/plugin/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,iEAAiE;AACjE,0DAA0D;AAC1D,qEAAqE;AACrE,2CAA2C;AAC3C,mEAAmE;AACnE,oEAAoE;AACpE,uEAAuE;AACvE,EAAE;AACF,oDAAoD;AACpD,oEAAoE;AACpE,sEAAsE;AACtE,oEAAoE;AACpE,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE9B,yDAI8B;AAC9B,uCAAyB;AACzB,2CAA6B;AAE7B,2CAAsD;AACtD,mCAAuD;AAEvD,mEAAmE;AACnE,uEAAuE;AACvE,sEAAsE;AACtE,8BAA8B;AAC9B,MAAM,gBAAgB,GAAe;IACnC,GAAG,EAAE,0CAA0C;IAC/C,WAAW,EAAE;QACX,IAAI,EAAE,cAAc;QACpB,OAAO,EAAE,eAAe;KACzB;CACF,CAAC;AAEF,MAAM,UAAU,GAAG,0BAA0B,CAAC;AAC9C,sEAAsE;AACtE,qEAAqE;AACrE,sEAAsE;AACtE,+DAA+D;AAC/D,uDAAuD;AACvD,yEAAyE;AACzE,qEAAqE;AACrE,kEAAkE;AAClE,MAAM,YAAY,GAAG,CAAC,sBAAsB,EAAE,kBAAkB,CAAU,CAAC;AAC3E,MAAM,cAAc,GAAG,wBAAwB,CAAC;AAEhD,MAAM,iBAAiB,GAAiB,CAAC,MAAM,EAAE,EAAE;IACjD,mEAAmE;IACnE,mEAAmE;IACnE,wBAAwB;IACxB,MAAM,GAAG,IAAA,iCAAgB,EAAC,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE;QAC3C,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC;QAChD,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CACb,0FAA0F,CAC3F,CAAC;QACJ,CAAC;QACD,IAAA,oBAAc,EAAC,MAAM,CAAC,UAAU,EAAE,gBAAgB,EAAE;YAClD,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,CAAC,GAAG,YAAY,CAAC;SAC5B,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,mEAAmE;IACnE,iEAAiE;IACjE,+DAA+D;IAC/D,oEAAoE;IACpE,MAAM,GAAG,IAAA,iCAAgB,EAAC,MAAM,EAAE;QAChC,KAAK;QACL,CAAC,MAAM,EAAE,EAAE;YACT,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAC3B,MAAM,CAAC,UAAU,CAAC,mBAAmB,EACrC,SAAS,CACV,CAAC;YACF,MAAM,QAAQ,GAAG,EAAE,CAAC,YAAY,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YACvD,MAAM,IAAI,GAAG,IAAA,+BAAqB,EAAC,QAAQ,EAAE;gBAC3C,MAAM,EAAE,cAAc;gBACtB,OAAO,EAAE,gBAAgB;gBACzB,SAAS,EAAE,UAAU;gBACrB,QAAQ,EAAE,CAAC,GAAG,YAAY,CAAC;aAC5B,CAAC,CAAC;YACH,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACtB,EAAE,CAAC,aAAa,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;YACtC,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,kBAAe,iBAAiB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,iEAAiE;AACjE,0DAA0D;AAC1D,qEAAqE;AACrE,2CAA2C;AAC3C,mEAAmE;AACnE,oEAAoE;AACpE,uEAAuE;AACvE,EAAE;AACF,oDAAoD;AACpD,oEAAoE;AACpE,sEAAsE;AACtE,oEAAoE;AACpE,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE9B,yDAI8B;AAC9B,uCAAyB;AACzB,2CAA6B;AAE7B,2CAAsD;AACtD,mCAAuD;AAEvD,4DAA4D;AAC5D,uEAAuE;AACvE,+DAA+D;AAC/D,8BAA8B;AAC9B,MAAM,gBAAgB,GAAe;IACnC,GAAG,EAAE,0CAA0C;IAC/C,WAAW,EAAE;QACX,IAAI,EAAE,cAAc;QACpB,OAAO,EAAE,QAAQ;KAClB;CACF,CAAC;AAEF,MAAM,UAAU,GAAG,0BAA0B,CAAC;AAC9C,sEAAsE;AACtE,qEAAqE;AACrE,sEAAsE;AACtE,+DAA+D;AAC/D,uDAAuD;AACvD,yEAAyE;AACzE,qEAAqE;AACrE,kEAAkE;AAClE,MAAM,YAAY,GAAG,CAAC,sBAAsB,EAAE,kBAAkB,CAAU,CAAC;AAC3E,MAAM,cAAc,GAAG,wBAAwB,CAAC;AAEhD,MAAM,iBAAiB,GAAiB,CAAC,MAAM,EAAE,EAAE;IACjD,mEAAmE;IACnE,mEAAmE;IACnE,wBAAwB;IACxB,MAAM,GAAG,IAAA,iCAAgB,EAAC,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE;QAC3C,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC;QAChD,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CACb,0FAA0F,CAC3F,CAAC;QACJ,CAAC;QACD,IAAA,oBAAc,EAAC,MAAM,CAAC,UAAU,EAAE,gBAAgB,EAAE;YAClD,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,CAAC,GAAG,YAAY,CAAC;SAC5B,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,mEAAmE;IACnE,iEAAiE;IACjE,+DAA+D;IAC/D,oEAAoE;IACpE,MAAM,GAAG,IAAA,iCAAgB,EAAC,MAAM,EAAE;QAChC,KAAK;QACL,CAAC,MAAM,EAAE,EAAE;YACT,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAC3B,MAAM,CAAC,UAAU,CAAC,mBAAmB,EACrC,SAAS,CACV,CAAC;YACF,MAAM,QAAQ,GAAG,EAAE,CAAC,YAAY,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YACvD,MAAM,IAAI,GAAG,IAAA,+BAAqB,EAAC,QAAQ,EAAE;gBAC3C,MAAM,EAAE,cAAc;gBACtB,OAAO,EAAE,gBAAgB;gBACzB,SAAS,EAAE,UAAU;gBACrB,QAAQ,EAAE,CAAC,GAAG,YAAY,CAAC;aAC5B,CAAC,CAAC;YACH,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACtB,EAAE,CAAC,aAAa,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;YACtC,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,kBAAe,iBAAiB,CAAC"}

package/plugin/src/index.ts

@@ -23,15 +23,15 @@ import * as path from "path";
 import { injectPodfileSpmBlock } from "./lib/podfile";
 import { linkSpmPackage, SpmPackage } from "./lib/spm";
 
-// Pinned to the exact `12.0.0-beta01` release tag — `from: 12.0.0`
+// Pinned to the exact `12.0.0` release tag — `from: 12.0.0`
 // would not resolve because `ios-spm` publishes pre-release tags (e.g.
-// `12.0.0-beta01`), and SPM excludes pre-release tags from open-ended
+// `12.0.0`), and SPM excludes pre-release tags from open-ended
 // major-version requirements.
 const SMILE_ID_PACKAGE: SpmPackage = {
   url: "https://github.com/smileidentity/ios-spm",
   requirement: {
     kind: "exactVersion",
-    version: "12.0.0-beta01",
+    version: "12.0.0",
   },
 };