DSSDK logo Document Scanner SDK

Migrating 2.x to 3.x Pixelnetica™ Document Scanning SDK for Apple iOS

The 3.x release changes how the SDK is distributed and adds a ready-to-use UI layer. The core capabilities are the same; the main work is swapping the integration method.

What changed

  • Distribution is now Swift Package Manager only. The 2.x SDK was integrated by dragging DocScanningSDK.framework into the project and adding it to Embedded Binaries. That manual step — and the CocoaPods option — are gone. 3.x is consumed as binary xcframeworks through SwiftPM.
  • New ready-to-use UI. 3.x adds the DocScanningSDK-UI product: complete camera, crop-editor, OCR-editor, and language-picker screens that did not exist in 2.x.
  • Minimum iOS raised to 16.3.

Migration steps

  1. Remove the old framework. Delete the embedded DocScanningSDK.framework reference and its Embedded Binaries / Frameworks, Libraries, and Embedded Content entry.
  2. Add the package. Follow Installation & SwiftPM integration. Choose DocScanningSDK-UI if you want the new screens (it includes the core engine), or DocScanningSDK for the engine alone.
  3. Update imports. Import the module — import DocScanningSDK (and import DocScanningSDK_UI if you use the screens) — rather than the old umbrella-header #import.
  4. Re-apply your license. License application is unchanged in spirit — call PxLicense.initialize(withKey:) early; see Licensing.
  5. Rebuild and resolve. Build against the current headers and fix any references the compiler flags against the current API reference.
  6. Adopt the ready-to-use screens (optional). If you previously built your own camera/editor UI, you can now replace it with the ready-to-use screens — or keep your custom UI on the core engine.

Tips

  • Raise your deployment target to iOS 16.3 before adding the package.
  • Commit Package.resolved so your team and CI build against the same SDK version.

See also

Top