SwiftSDK

What's Changed

• Fixes missing session start upon app start on non-iOS platforms (macOS, tvOS, visionOS, watchOS) by @Jeehut in https://github.com/TelemetryDeck/SwiftSDK/pull/178
• Avoids a new session start when a user returns within 5 minutes of leaving the app by @Jeehut in https://github.com/TelemetryDeck/SwiftSDK/pull/178

Full Changelog: https://github.com/TelemetryDeck/SwiftSDK/compare/2.2.4...2.3.0

What's Changed

• Added missing calls like terminate() to the new TelemetryDeck domain. Fixes https://github.com/TelemetryDeck/SwiftSDK/issues/171 by @Jeehut.

Full Changelog: https://github.com/TelemetryDeck/SwiftSDK/compare/2.2.3...2.2.4

What's Changed

• Fixed CocoaPods support for version 2.x to allow FlutterSDK to rely on the latest version by @Jeehut on https://github.com/TelemetryDeck/SwiftSDK/issues/155

Full Changelog: https://github.com/TelemetryDeck/SwiftSDK/compare/2.2.2...2.2.3

What's Changed

• Add support for accessing the Storefront country code on visionOS by @Jeehut in https://github.com/TelemetryDeck/SwiftSDK/pull/168
• Fix a compilation error in Xcode 15.0 by @Jeehut in https://github.com/TelemetryDeck/SwiftSDK/pull/170

Full Changelog: https://github.com/TelemetryDeck/SwiftSDK/compare/2.2.1...2.2.2

What's Changed

• Define public init for LogHandler by @Sherlouk in https://github.com/TelemetryDeck/SwiftSDK/pull/128
• Use the modern currency API on Transaction on newer OS versions by @Jeehut in https://github.com/TelemetryDeck/SwiftSDK/pull/163
• Extract navigation code to separate files + rename for consistency by @Jeehut in https://github.com/TelemetryDeck/SwiftSDK/pull/164

Full Changelog: https://github.com/TelemetryDeck/SwiftSDK/compare/2.2.0...2.2.1

This release adds support for sending Navigation signals. Navigation signals will allow you to better understand how users are navigating through your app in the future. We're releasing this part of the feature early so that you can get a head start at collecting this data.

What's Changed

• Add Navigation events by @winsmith in https://github.com/TelemetryDeck/SwiftSDK/pull/161

Full Changelog: https://github.com/TelemetryDeck/SwiftSDK/compare/2.1.1...2.2.0

What's Changed

• Fixed #157 to fix build issue on visionOS

Full Changelog: https://github.com/TelemetryDeck/SwiftSDK/compare/2.1.0...2.1.1

This release adds the convenience methods mentioned in the new Purchases Preset and Errors Preset doc articles.

What's Changed

• Add convenience methods & types for sending error & purchase preset signals by @Jeehut in https://github.com/TelemetryDeck/SwiftSDK/pull/154

Full Changelog: https://github.com/TelemetryDeck/SwiftSDK/compare/2.0.0...2.1.0

While there are no source-breaking changes in this 2.0 release, we deprecated a couple of APIs as we decided to streamline the naming conventions within our first SDK for a more consistent and clear future. You should be able to upgrade to 2.0 without any build errors, and the deprecation warnings & fix-its should guide you to be prepared for the future of TelemetryDeck!

To upgrade, you need to explicitly change the version specifier to 2.0.0 < 3.0.0 in your projects "Package Dependencies" settings.

This release represents the "Grand Rename" of this SDK, which doesn't end with the API calls, but the very GitHub repository itself was renamed from "SwiftClient" to "SwiftSDK" to be consistent with all our other SDKs. Thanks to GitHub redirections, your projects should not be affected by this change.

Most notably, the following APIs were renamed:

1. TelemetryManager.send("A", with: ["a": "b"]) is now TelemetryDeck.signal("A", parameters: ["a": "b"])
2. The optional for parameter to override the user ID was renamed to customUserID to be more clear
3. TelemetryManager.initialize(with:) is now TelemetryDeck.initialize(config:) (fix-it available)
4. TelemetryManagerConfiguration was renamed to TelemetryDeck.Config (without warnings)
5. import TelemetryClient was renamed import TelemetryDeck, but you need to link TelemetryDeck to your project to switch

The Swift Setup Guide was updated accordingly.

We also renamed our existing parameters, but with a thoughtful approach that won't break any existing insights (we are still sending the old names). Most notably, all new parameters are now namespaced with TelemetryDeck. so there can be no name clash with your custom parameters. New useful parameters were introduced as well, such as TelemetryDeck.UserPreference.language which gives you the language the user has set as their preference on their device, so you can learn which new languages you might want to support.

See our Grand Rename article for a full list of new parameters and a table of old & new names.

What's Changed

• New force-sync method (load-capped) to track bad experiences that might lead users to leave/delete app (improved churn tracking) by @Jeehut in https://github.com/TelemetryDeck/SwiftSDK/pull/136
• [TelemetryManager] Replace fatalError With assertionFailure by @nickkohrn in https://github.com/TelemetryDeck/SwiftSDK/pull/146
• Make it easier to check for appLanguage, preferredLanguage, and region + grand rename by @Jeehut in https://github.com/TelemetryDeck/SwiftSDK/pull/153

Full Changelog: https://github.com/TelemetryDeck/SwiftSDK/compare/1.5.1...2.0.0

What's Changed

• Give DefaultSignalPayload Public Access by @nevillco in https://github.com/TelemetryDeck/SwiftClient/pull/126
• CocoaPods Support by @winsmith in https://github.com/TelemetryDeck/SwiftClient/pull/135

New Contributors

• @nevillco made their first contribution in https://github.com/TelemetryDeck/SwiftClient/pull/126

Full Changelog: https://github.com/TelemetryDeck/SwiftClient/compare/1.5.0...1.5.1

This release prepares us for iOS 17, improves privacy, and improves VisionOS compatibility. Thanks a lot to our wonderful contributors <3

What's Changed

• Add privacy labels by @winsmith in https://github.com/TelemetryDeck/SwiftClient/pull/117
• Remove waitsForConnectivity by @Finnvoor in https://github.com/TelemetryDeck/SwiftClient/pull/114
• Update checkout action by @winsmith in https://github.com/TelemetryDeck/SwiftClient/pull/120
• Improve Code Quality by @winsmith in https://github.com/TelemetryDeck/SwiftClient/pull/121
• Allow visionOS to use identifierForVendor by @winsmith in https://github.com/TelemetryDeck/SwiftClient/pull/119

New Contributors

• @Finnvoor made their first contribution in https://github.com/TelemetryDeck/SwiftClient/pull/114

Full Changelog: https://github.com/TelemetryDeck/SwiftClient/compare/1.4.4...1.5.0

This version adds a lot of small improvements by our amazing customers and supporters. It also correctly detect's Apple's visionOS running on the Vision Pro Simulator (we can't test it on actual hardware yet).

What's Changed

• Support customisable LogHandler by @Sherlouk in https://github.com/TelemetryDeck/SwiftClient/pull/92
• send extension identifier, if provided by @Sherlouk in https://github.com/TelemetryDeck/SwiftClient/pull/93
• Add support for metadata enrichers by @Sherlouk in https://github.com/TelemetryDeck/SwiftClient/pull/94
• Fix README.md Typos by @nickkohrn in https://github.com/TelemetryDeck/SwiftClient/pull/95
• Fix warning in Signal.isAppStore by using #elseif by @mrackwitz in https://github.com/TelemetryDeck/SwiftClient/pull/103
• Update README.md by @shaundon in https://github.com/TelemetryDeck/SwiftClient/pull/107
• Add support for visionOS by @winsmith in https://github.com/TelemetryDeck/SwiftClient/pull/109

New Contributors

• @Sherlouk made their first contribution in https://github.com/TelemetryDeck/SwiftClient/pull/92
• @nickkohrn made their first contribution in https://github.com/TelemetryDeck/SwiftClient/pull/95
• @mrackwitz made their first contribution in https://github.com/TelemetryDeck/SwiftClient/pull/103
• @shaundon made their first contribution in https://github.com/TelemetryDeck/SwiftClient/pull/107

Full Changelog: https://github.com/TelemetryDeck/SwiftClient/compare/1.4.3...1.4.4

This version adds support for integrating TelemetryDeck via CocoaPods, for projects who prefer CocoaPods over Swift Package Manager.

Thanks a lot to @chrisvasselli for the contribution!

What's Changed

• Add a podspec for integration using Cocoapods. by @chrisvasselli in https://github.com/TelemetryDeck/SwiftClient/pull/91

New Contributors

• @chrisvasselli made their first contribution in https://github.com/TelemetryDeck/SwiftClient/pull/91

Full Changelog: https://github.com/TelemetryDeck/SwiftClient/compare/1.4.2...1.5.0

This version fixes a bug #88 that made it so the isAppStore property would always be reported as false.

If you're filtering for isAppStore, a way around that is to add an "and" filter containing a "not isSimulator = true" and a "not isTestFlight = true".

This bugfix update fixes a crash due to objects being released too early. Thanks a lot to @andreyz for the contribution!

What's Changed

• Update Xcode version in CI by @winsmith in https://github.com/TelemetryDeck/SwiftClient/pull/86
• Avoid runtime exception due to deallocated unowned self by @andreyz in https://github.com/TelemetryDeck/SwiftClient/pull/84

New Contributors

• @andreyz made their first contribution in https://github.com/TelemetryDeck/SwiftClient/pull/84

Full Changelog: https://github.com/TelemetryDeck/SwiftClient/compare/1.4.0...1.4.1

This version adds support for sending numerical values in Signals via the new floatValue property. Any signal you send can have one floatValue (which, annoyingly, maps to a Double type in Swift). On the server, you'll be able to aggregate, min, max and average these values.

What's Changed

• Add support for numerical values by @winsmith in https://github.com/TelemetryDeck/SwiftClient/pull/82

What's Changed

• Use a self-generated UUID as default ID on macOS + add tvOS support by @Jeehut in https://github.com/TelemetryDeck/SwiftClient/pull/71
• Ensure not to make SwiftUI previews crash due to missing init call by @Jeehut in https://github.com/TelemetryDeck/SwiftClient/pull/74
• Implement analyticsDisabled to allow an opt out of analytics by @kimar in https://github.com/TelemetryDeck/SwiftClient/pull/76
• Add Objective-C support by @winsmith in https://github.com/TelemetryDeck/SwiftClient/pull/79

New Contributors

• @MortenGregersen made their first contribution in https://github.com/TelemetryDeck/SwiftClient/pull/77
• @kimar made their first contribution in https://github.com/TelemetryDeck/SwiftClient/pull/76

Full Changelog: https://github.com/TelemetryDeck/SwiftClient/compare/1.2.0...1.3.0

Oh wow, big release! We've fixed various bugs, especially ones that would report inconsistent values on macOS, such as for isAppStore.

We're also giving you the option to specify a salt before hashing user identifiers, slightly improving cryptographic security.

What's Changed

• Fix unit test by @xr1337 in https://github.com/TelemetryDeck/SwiftClient/pull/50
• Wait for connectivity by @ca13ra1 in https://github.com/TelemetryDeck/SwiftClient/pull/54
• Fixes typo in URLSession by @ca13ra1 in https://github.com/TelemetryDeck/SwiftClient/pull/55
• Use Apples CryptoKit when available & fall back to CommonCrypto by @Jeehut in https://github.com/TelemetryDeck/SwiftClient/pull/58
• Return correct modelName on macOS by @winsmith in https://github.com/TelemetryDeck/SwiftClient/pull/61
• Improve checking for isAppStore by @winsmith in https://github.com/TelemetryDeck/SwiftClient/pull/62
• Allow users to optionally specify a salt before hashing user identifiers by @winsmith in https://github.com/TelemetryDeck/SwiftClient/pull/66
• Allow iOS 12 and watchOS 5 by @winsmith in https://github.com/TelemetryDeck/SwiftClient/pull/67

New Contributors

• @xr1337 made their first contribution in https://github.com/TelemetryDeck/SwiftClient/pull/50
• @ca13ra1 made their first contribution in https://github.com/TelemetryDeck/SwiftClient/pull/54
• @Jeehut made their first contribution in https://github.com/TelemetryDeck/SwiftClient/pull/58
• @winsmith made their first contribution in https://github.com/TelemetryDeck/SwiftClient/pull/61

Full Changelog: https://github.com/TelemetryDeck/SwiftClient/compare/1.1.6...1.2.0

This version adds a terminate method as well as the isInitialized property. Thanks to @StarLard for your contribution!

Full Changelog: https://github.com/TelemetryDeck/SwiftClient/compare/1.1.5...1.1.6

This release brings you Testing Mode, and better OS Version reporting.

Testing Mode

Previously, when you ran your app locally with the Build Configuration set to DEBUG, TelemetryManager would not send any signals at all. This is because otherwise these testing signals would pollute your actual data, which is not something we desire. However, that made it hard to test wether your configuration actually works, and to prepare reasonable Insights before your launch.

This is why we're introducing Testing Mode. When you run your app in the DEBUG Build Configuration, i.e. directly from Xcode, TelemetryManager will now send all signals, but tag them as Testing Mode signals. In an upcoming version of the app, you will be able to see those signals separately, so you can immediately confirm that your code is working correctly without polluting the actual data.

Better OS Version Reporting

Previously signals sent by TelemetryManager would include the full system version string, e.g. iOS 15.0.1. However, this makes it hard to create an Insight to answer the question: How many of my users are already on iOS 15? To help with that, we added two more default payload keys:

• majorSystemVersion, which reports just the major system version, i.e. iOS 15
• majorMinorSystemVersion, which reports major and minor version, but not the point release, e.g. iOS 15.0

We left the existing systemVersion payload key untouched. You can continue to use it as is.

And an internal change: We updated the code to determine the system version to always use processInfo.operatingSystemVersion on all platforms. This should not change anything, but it makes the code smaller and easier.

Enjoy, and have a wonderful time with TelemetryDeck. Thanks to @conath for contributing code to this release. We love getting your pull request!

Best

Lisa & Daniel, who make TelemetryDeck