|
Novarum DX Ltd
|
Document ID: IFU055
|
1. Overview
v4.1.1 updates the iOS Reader SDK customer integration path to Swift Package Manager. It follows v4.0.1 and updates the private SwiftPM package novarumdx.ndx-imaging-swift to version 4.1.1, distributed through AWS CodeArtifact using the customer-facing novarum.client.swift registry.
-
Release package: customers integrate the
ImagingSwift package product fromnovarumdx.ndx-imaging-swift:4.1.1. -
Shared core update: the native dependency is updated to NDX Imaging Core
1.1.1and remains resolved transitively through SwiftPM. -
Primary release purpose: provide the iOS v4.1.1 maintenance baseline, update the shared core runtime, and complete functional and non-functional verification.
-
Integration continuity: the SwiftPM,
PMFLoader, SwiftUI, UIKit, callback, and model integration patterns established in v4.0.1 remain the supported customer path.
Warning: The SDK 4.1.1 (iOS) is not compatible with reader files that do not use the current format with the {estimators: [ wrapper. Reader files must be updated to the current format before use with SDK 4.1.1 (iOS).
2. What’s Changed Since 4.0.1
-
Customer-facing SwiftPM package released at version
4.1.1. -
Documentation coverage extended:
PMFLoaderdata-based methods,ReaderViewWrapper,ReaderViewController, andFrameCapturedCallback.stripStatusesare now fully documented as the supported integration interfaces. No API changes were introduced. -
The iOS SDK is aligned with NDX Imaging Core
1.1.1.
3. Breaking vs. Non-breaking Summary
|
Change |
Type |
Developer impact |
|---|---|---|
|
Customer SwiftPM package updated to |
Integration update |
Update the package version and refresh resolved dependencies. |
|
NDX Imaging Core updated to |
Runtime dependency update |
No API change is required for normal SwiftPM integrations; rebuild and regression-test the host app. |
|
iOS XCFramework packaging corrected in Core v1.1.1 |
Bug fix |
Consumers should no longer encounter the affected binary |
4. When to Upgrade
Upgrade from iOS SDK v4.0.1 to v4.1.1 to adopt the latest iOS v4 maintenance release and the NDX Imaging Core v1.1.1 update. Apps using the existing SwiftPM integration should normally only need to update the package version, resolve dependencies, rebuild, and re-run application-level verification.
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 is NDX Imaging Core
1.1.1, resolved transitively by SwiftPM. -
Direct XCFramework integration is not documented as the customer integration path; use SwiftPM and the customer-facing CodeArtifact registry.
-
Reader files must use the current
{estimators: [wrapper format.
6. Summary of Developer Actions
|
Area |
Action Required |
|---|---|
|
Registry access |
Authenticate to AWS CodeArtifact using |
|
Dependency setup |
Update |
|
Core dependency |
Allow SwiftPM to resolve NDX Imaging Core |
|
Reader configuration |
Confirm reader JSON files use the current |
|
Configuration loading |
Continue using |
|
SwiftUI/UIKit usage |
Continue using |
|
Regression testing |
Rebuild the host app and repeat relevant functional and non-functional checks. |
|
Troubleshooting |
Use SwiftPM and CodeArtifact troubleshooting; the previous CocoaPods-only setup is not supported. |
7. Versioning Summary
|
Component |
Version |
Notes |
|---|---|---|
|
iOS Reader SDK Swift package |
4.1.1 |
Package id |
|
NDX Imaging Core |
1.1.1 |
Resolved transitively by the iOS Swift package. |
|
Previous iOS baseline |
4.0.1 |
Changes are summarised against this release. |
|
Minimum iOS version |
14.2 |
Required. |
|
Swift tools version |
5.9 |
Required. |
8. Known Issues
No additional iOS SDK defects were identified in the v4.1.1 release verification records.