Skip to main content
Version: 0.3.0

Release notes

What changed in each release of the iOS SDK, newest first.

0.3.0​

Released 2026-09-28

Added​

  • Panoramas can be stitched on the device. SettingsProviderType.panoramaProcessing() chooses, per capture session, where a panorama is stitched, with PanoramaProcessing as its value. .server, the default, records the sweep as a movie and uploads it for the server to stitch. .onDevice stitches it on the phone, in the background, while the user captures the next one, and uploads the finished panorama. Stitching runs only while the app is in the foreground and carries on where it stopped when the app comes back. In .v0, the Room screen shows a thumbnail and the status of each panorama, opens it in a full-screen viewer on tap, and offers "Retry stitch" on one that failed.
  • The SDK's UI comes in two versions. SettingsProviderType.uiVersion() chooses which one is presented, with UIVersion as its value. .v0, the default, lists a property's floors and opens floors and rooms on screens of their own. .v1 is a redesign in which the property screen is one project tree: every floor, its rooms, each room's floor plan and panoramas, and their sync state on a single scrolling screen, in light or dark following the system appearance. Floors and rooms are added and edited in sheets, rooms can be added to a floor before its floor plan is captured, and creating a property asks only for its name.
  • Both settings have a default, so a settings provider written for 0.2.0 keeps compiling.

Changed​

  • The SDK navigates inside its flows; the host only places the entry screen. Put the screen from makePropertyListViewController(subtitle:onEvent:) or makePropertyViewController(property:onEvent:) in your UINavigationController, and the SDK pushes and pops everything below it on that same controller: the property opened from the list, floors and rooms, and both capture flows. Both entry points report one enum, PropertyFlowEvent, whose cases say what happened — openedProperty, structureCaptureFinished, panoramaCaptureFinished, failed — and never ask you to navigate. A screen the flow cannot open, such as capture on a device without LiDAR, arrives as failed and the user stays where they were. The entry screen must be inside a navigation controller. A host coordinator reduces to its failure handler:

    let list = try await tours.properties.makePropertyListViewController { event in
        if case .failed(let error) = event { present(error) }
    }
    navigationController.setViewControllers([list], animated: false)

  • FloorPlanStylePreview is replaced by FloorPlanStyle.previewImage(size:), which returns a UIImage of a sample plan drawn in that style, for you to frame and lay out yourself. It returns nil for an empty size or if the sample is unavailable.

  • AuthError.serverError is now serverError(statusCode:message:). message carries the backend's explanation, and the error's description includes it — for example Auth server error 401: Device not registered.

  • No two floors of a property can share a level.

  • The SDK bundles the Geist and JetBrains Mono typefaces its .v1 screens use, and registers them itself; the host app adds nothing.

  • The binary now includes libwebp, with its symbols hidden as GRDB's and Zip's are, so an app that links its own copy is unaffected. Its licence is in NOTICES.

Removed​

  • Every screen a host built and pushed below the entry points; the SDK opens them itself: PropertyManagement.makeFloorViewController(floor:onEvent:), PropertyManagement.makeRoomViewController(room:onEvent:), NoughtyTours.structureCapture (StructureCapture, StructureCaptureMode, StructureCaptureEvent) and NoughtyTours.panoramaCapture (PanoramaCapture, PanoramaCaptureEvent).
  • PropertyListEvent, PropertyEvent, FloorEvent and RoomEvent, replaced by PropertyFlowEvent.
  • The Room handle. Nothing public takes or returns one any more.

Fixed​

  • Capture, sync and upload failures are shown in the user's language (en, de, ro, ru) and worded for the person holding the phone. They were English sentences whatever the device language. Failures the SDK does not classify — database, network, the backend's own message — still carry the system's wording.
  • Device auth recovers on its own when the backend no longer recognises a device it attested before, and after the app is reinstalled on a device that was never attested. Both failed every session until the app's data was cleared.
  • Uploads no longer use up their automatic retries while the device is offline or device auth is failing. The queue pauses and resumes on the next launch or background run.
  • A request rejected because the device session expired is always refreshed and retried. A sync or upload could fail with a 401 until it was retried by hand.

0.2.0​

Released 2026-09-14

Changed​

  • NoughtyToursSDK.xcframework.zip is 10.6 MB, down from 13.0 MB. The binary no longer carries the linker's debug map, which only named files on our build machine. SDK frames in your crash reports still symbolicate to function names, and your linked app is the same size.
  • The documentation is now at docs.noughtyreality.com, with a version for each release.

0.1.0​

Initial binary release.

Added​

  • Closed-source Swift Package Manager distribution of the NoughtyTours SDK as a prebuilt, cross-Xcode static xcframework, exposed through a single NoughtyToursSDK product and a single import (import NoughtyToursSDK).
  • NoughtyTours — one instance per process, built from a Configuration (environment, publishable key, organisation provider, settings provider). init cannot fail; start() prepares local storage and reconnects to in-flight uploads, and is idempotent.
  • Device-level auth. The SDK authenticates itself: every capture/data request carries a bearer minted from an Apple App Attest assertion, scoped to the organisation the host supplies. prepareDeviceAuth() establishes it up front; revokeDeviceSession() tears it down. There is no user login in the SDK — the host owns that and supplies only the selected organisation via OrganizationProviderType.
  • Screens vended from the core in three namespaces — core.properties, core.structureCapture, core.panoramaCapture — each reporting through one typed onEvent closure whose events carry the handle for the next screen. PanoramaCaptureEvent matches its structure-capture neighbour: a .cancelled case, and a .finished that carries the floor and how many panoramas the visit added.
  • iPhone and iPad. The capture screens and the modal cards lay out correctly on iPad, where the cards stay dialog-sized rather than stretching to the full width.
  • Property/floor/room handles without the list screen: createProperty(name:floorCount:metadata:) and property(id:), for hosts that already know what they are capturing. Both are async: they start the core themselves, so a host that builds a screen before awaiting start() gets an error rather than a trap.
  • Host metadata on a tour. createProperty takes an optional metadata — any Encodable that encodes to a JSON object — serialized once at the boundary and sent when the tour is created, so a work order or job id travels to the backend with the capture. Set once, at creation: the update request carries no such field, and a property created without it never gets any. The only check is that the value is a JSON object; anything else is NoughtyToursError.invalidMetadata, which is not retryable.
  • Reading what a capture produced. status(of:) for a point-in-time read and statusUpdates(for:) for an AsyncStream driven by the database's own change notifications; both run the same query, so a poll and a stream cannot disagree. PropertyStatus carries the backend tour id (nil until the first sync), the sync state, and floor/room/panorama counts including uploaded and failed.
  • Typed errors — NoughtyToursError and AuthError, both LocalizedError with an isRetryable flag and a stable code (lowercase dot-separated slugs, one per case, tabulated on each property). Unlike description and the reason payloads, which are diagnostics whose wording may change, a code is API: safe to log, to forward, and to branch on.
  • Offline-first storage and sync: capture never blocks on connectivity, and uploads continue in the background, reconnecting to transfers still in flight across launches.
  • The SDK logs for itself (Log). Its lines are printed to the console prefixed [NoughtyToursSDK], filtered by Log.level. Every line, down to debug, is written to the SDK's on-device log file (Documents/Logs/capture-runtime.log) whatever the level says, so a bug report stays complete at any verbosity.
  • NoughtyTours.isDeviceSupported for gating the capture flow on LiDAR availability.
  • Bundled assets and localized strings resolved automatically at runtime. A missing resource bundle degrades to raw keys on screen rather than taking the host app down.
  • Every property has a name. createProperty(name:) takes a non-optional String, trimmed before it reaches the API; a blank one is rejected with NoughtyToursError.invalidName rather than silently becoming an English placeholder. Floor and room names stay optional — the backend models an unnamed floor or room, and a floor titles itself from its number.
  • Third-party NOTICES and LICENSE.

Notes​

  • Requires iOS 17.0+ and Xcode 16+.
  • arm64 only (device + Apple-silicon simulator); Intel-Mac simulator unsupported.
  • A real device with a LiDAR scanner is required for anything that captures or syncs; App Attest is additionally unavailable in the simulator.
  • Requires the App Attest capability on your own App ID and a pk_ios_* publishable key issued by The Noughty Fox for the matching environment.
  • The package resolves no dependencies of its own — everything the SDK needs is inside the binary.
  • Localized in en, de, ro and ru. The SDK's screens localize themselves; there is no string-override hook.