Reader SDK Documents
Reader SDK Documents
Breadcrumbs

IFU045(02) v4.0.1 (iOS)

Novarum DX Ltd
Instructions for Use / Guides

Document ID: IFU045 
Revision: 02 
Released: Jul 20, 2026 

1. Overview

v4.0.1 updates the iOS Reader SDK customer integration path to Swift Package Manager. It replaces the previous 3.0.1-era CocoaPods setup with the private SwiftPM package novarumdx.ndx-imaging-swift, distributed through AWS CodeArtifact using the customer-facing novarum.client.swift registry.

  • Integration change: customers now integrate the Imaging Swift package product via SwiftPM.

  • Dependency change: the native core dependency is resolved transitively through novarumdx.ndx-imaging-core / ndx_imaging_ios.

  • API update: configuration loading uses the current PMFLoader data-based methods.

  • Callback update: FrameCapturedCallback.stripStatuses is available for per-frame strip status reporting.

  • Scope: customer integration guidance only; promotion, signing, pipeline, and SBOM details are excluded from this guide.

Warning: The SDK 4.0.1 (iOS) is not compatible with current reader files that do not use the new format with the {estimators: [ wrapper. Reader files must be updated to the new format before use with SDK 4.0.1 (iOS).

2. What’s New

2.1. iOS SwiftPM integration

  • Added Swift Package Manager setup using package id novarumdx.ndx-imaging-swift and product Imaging.

  • Updated CodeArtifact authentication to use the customer-facing novarum.client.swift repository.

  • Set the current integration version to 4.0.1.

2.2. Configuration and public API examples

  • Updated analyser/test configuration examples to use PMFLoader.loadAnalyserConfiguration(from:), loadTestConfiguration(from:), and loadTestConfigurations(from:).

  • Removed stale json / jsonString loader examples.

  • Updated SwiftUI usage to the current ReaderViewWrapper API.

  • Added UIKit usage with ReaderViewController and ReaderViewControllerDelegate.

2.3. Callback/model documentation

  • Updated callback reference for FrameCapturedCallback, PMFResult, StripStatus, AnalysisModel, and FrameData.

  • Documented FrameCapturedCallback.stripStatuses as available in current source.

3. Breaking vs. Non-breaking Summary

Change

Type

Developer impact

CocoaPods setup removed from this customer guide

Integration-breaking for old setup instructions

Migrate customer apps to SwiftPM and CodeArtifact registry access.

SwiftPM package novarumdx.ndx-imaging-swift documented

New integration path

Add package version 4.0.1 and link product Imaging.

Native dependency resolved transitively

Non-breaking for SwiftPM users

No separate OpenCV2 pod or manual native dependency setup is required.

PMFLoader examples updated to data-based APIs

API documentation correction

Load JSON configuration into Data before decoding.

stripStatuses on frame callback

Additive

Apps may consume per-frame strip status telemetry; existing callback handling can ignore it.

4. When to Upgrade

Upgrade when integrating the iOS Reader SDK through the current customer distribution path or when migrating from the 3.0.1-era CocoaPods guide. New customer integrations should use v4.0.1 via SwiftPM.

5. Compatibility Notes

  • Minimum iOS version is 14.2.

  • Swift tools version is 5.9.

  • The Swift package product is Imaging.

  • The native core dependency novarumdx.ndx-imaging-core exact 1.0.0 is resolved transitively by SwiftPM.

  • Direct XCFramework integration is not documented as a customer path in this guide.

6. Summary of Developer Actions

Area

Action Required

Registry access

Authenticate to AWS CodeArtifact using novarum.client.swift.

Dependency setup

Add package novarumdx.ndx-imaging-swift from 4.0.1 and link product Imaging.

Configuration loading

Use PMFLoader methods that accept Data.

SwiftUI/UIKit usage

Use the current examples in sections 4 and 5.

Troubleshooting

Use SwiftPM/CodeArtifact troubleshooting; CocoaPods, private pod repo, Git LFS pod, and OpenCV pod troubleshooting are no longer applicable.

7. Versioning Summary

Component

Version

Notes

iOS Reader SDK Swift package

4.0.1

Package id novarumdx.ndx-imaging-swift; product Imaging.

Native core dependency

1.0.0

novarumdx.ndx-imaging-core / ndx_imaging_ios, resolved transitively.

8. Known Issues

The following table lists SDK iOS defect issues that are not currently in a Done status category.

Open Defects in the SDK (Total: 1)
Key
Summary
Affects versions
Risk (calculated)
Status
SDKIOS-127 ReaderViewController deconstruction is causing a leak 4.0.1-ios 🟥 High Open