Skip to main content
Version: Next

Migrate from 2.2 to 3.0

This guide is provided to ease the transition of existing applications using SkyPath v2.2 to v3.0 APIs.

If you are upgrading from 2.1 or earlier it could be easier to upgrade gradually to 2.2 first and address any deprecation warnings.

Due to breaking changes, your application may no longer compile. Follow the fix-it suggestions for simple syntax updates, and review the specific modifications described below.

Breaking Changes​

  • New development environment requirements:

    • Xcode version 16.2 or higher.
    • iOS version 16.0 or higher.

  • The CocoaPods support has been removed. See Install for the supported options.

  • The Turbulence Polygons feature has been removed. Use Viewport instead. The following are not available anymore:

    • DataTypeOptions.turbulencePolygons in DataQuery.types
    • DataQuery.globalEnabled
    • DataQuery.globalTurbulencePolygonsUpToEnabled
    • TurbulencePolygonsQuery
    • SkyPathDelegate.didReceiveNewTurbulencePolygons
    • DataAreaType.global

  • DataQuery.sevs has been replaced by DataQuery.minSev.

  • Flight.dep and Flight.dest are now required.

  • TurbulenceResult is replaced with QueryResult in SkyPath.turbulence(with:). TurbulenceQuery.resultOptions is now QueryResultOptions instead of TurbulenceResultOptions.

  • DataHistoryTime.sixHours has been removed.

  • SkyPathDelegate updates:

    • didReceiveNewNowcast() changed to didReceiveNewNowcast(areaType:)
    • didFailToFetchNewData(error:) changed to didFailToFetchNewData(error:type:)

  • DataUpdateFrequency has been removed. Use SkyPath.dataUpdateEnabled instead of SkyPath.dataUpdateFrequency to stop data fetching temporarily.

  • Nowcasting is now part of OneLayer only and isn't available as a separate layer data. The following are not available anymore:

    • DataTypeOptions.nowcast
    • SkyPath.nowcast(with:)
    • NowcastQuery
    • NowcastHours
    • NowcastSeverity
    • SkyPathDelegate.didReceiveNowcast()

  • Turbulence Notifications types and functions have been renamed:

    • SkyPathDelegate.didReceiveAlert(_:) -> SkyPathDelegate.didReceiveNotification(_:)
    • AlertQuery -> NotificationQuery
    • AlertResult -> NotificationResult
    • AlertError -> QueryError

New Features​

  • SkyPath OneLayer (see docs). The following types and functions have been introduced:

    • SkyPath.oneLayer(with:)
    • SkyPathDelegate.didReceiveNewOneLayer(areaType:)
    • DataTypeOptions.oneLayer
    • NotificationResult.oneLayer
    • OneLayerItem
    • OneLayerQuery
    • DataSourceType

  • SkyPath Nowcasting is now extended to 12-hour prediction.

Improvements​

  • Query configs such as TurbulenceQuery have been updated to use general QueryResult and QueryResultOptions types instead of their types such as TurbulenceResult and TurbulenceResultOptions.

  • Query result items such as TurbulenceItem now conform to common Itemable and TurbulenceItemable protocols where applicable for consistency.

  • SkyPath.updateDate(of:) allows you to get an update date of a specific type of data.

  • DataTypeOptions.set(type:enabled:) is a quick way to enable or disable specific data types.