launchdarkly · keelerm84 · May 4, 2022 · Apr 24, 2020 · May 27, 2020 · Jun 4, 2020
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -110,7 +110,7 @@ jobs:
           - run:
               name: CocoaPods spec lint
               command: |
-                if [ "$CIRCLE_BRANCH" = 'master' ]; then
+                if [ "$CIRCLE_BRANCH" = 'main' ]; then
                   pod spec lint
                 else
                   pod lib lint

diff --git a/.circleci/run-build-locally.sh b/.circleci/run-build-locally.sh
@@ -10,4 +10,4 @@ curl --user ${CIRCLE_TOKEN}: \
      --request POST \
      --form config=@.circleci/config.yml \
      --form notify=false \
-        https://circleci.com/api/v1.1/project/github/launchdarkly/ios-swift-client-sdk-private/tree/master
+        https://circleci.com/api/v1.1/project/github/launchdarkly/ios-swift-client-sdk-private/tree/main
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,7 +1,7 @@
 **Requirements**
 
 - [ ] I have added test coverage for new or changed functionality
-- [ ] I have followed the repository's [pull request submission guidelines](../blob/master/CONTRIBUTING.md#submitting-pull-requests)
+- [ ] I have followed the repository's [pull request submission guidelines](../blob/v6/CONTRIBUTING.md#submitting-pull-requests)
 - [ ] I have validated my changes against all supported platform versions
 
 **Related issues**

diff --git a/.jazzy.yaml b/.jazzy.yaml
@@ -19,6 +19,7 @@ custom_categories:
     - LDConfig
     - LDUser
     - LDEvaluationDetail
+    - LDValue
 
   - name: Flag Change Observers
     children:
@@ -35,33 +36,25 @@ custom_categories:
 
   - name: Other Types
     children:
+    - UserAttribute
     - LDStreamingMode
-    - LDFlagValueConvertible
     - LDFlagKey
     - LDInvalidArgumentError
-    - LDErrorHandler
+    - RequestHeaderTransform
 
   - name: Objective-C Core Interfaces
     children:
     - ObjcLDClient
     - ObjcLDConfig
     - ObjcLDUser
     - ObjcLDChangedFlag
+    - ObjcLDValue
+    - ObjcLDValueType
 
   - name: Objective-C EvaluationDetail Wrappers
     children:
     - ObjcLDBoolEvaluationDetail
     - ObjcLDIntegerEvaluationDetail
     - ObjcLDDoubleEvaluationDetail
     - ObjcLDStringEvaluationDetail
-    - ObjcLDArrayEvaluationDetail
-    - ObjcLDDictionaryEvaluationDetail
-
-  - name: Objective-C ChangedFlag Wrappers
-    children:
-    - ObjcLDBoolChangedFlag
-    - ObjcLDIntegerChangedFlag
-    - ObjcLDDoubleChangedFlag
-    - ObjcLDStringChangedFlag
-    - ObjcLDArrayChangedFlag
-    - ObjcLDDictionaryChangedFlag
+    - ObjcLDJSONEvaluationDetail
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,58 @@
 
 All notable changes to the LaunchDarkly iOS SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [6.0.0] - 2022-05-04
+
+Note that Objective-C bridging types are prefixed by `Objc`, but that prefix is not exposed to code written in Objective-C. For example, changes listed to `ObjcLDClient` are changes to the class referred to as `LDClient` from within Objective-C.
+
+### Added
+- Added the `LDValue` class to represent any data type that is allowed in JSON. This new type is used to provide more type safety when representing complex or non-statically determined data types. The SDK also provides the bridge types `ObjcLDValue` and `ObjcLDValueType` for Objective-C interoperability.
+- Added the `UserAttribute` class which provides a less error-prone way to refer to user attribute names in configuration.
+- Added the type specific variation functions, `boolVariation`, `intVariation`, `doubleVariation`, `stringVariation`, and `jsonVariation`, to `LDClient`.
+- Added the type specific detailed variation functions, `boolVariationDetail`, `intVariationDetail`, `doubleVariationDetail`, `stringVariationDetail`, and `jsonVariationDetail`, to `LDClient`.
+- Added `jsonVariation` and `jsonVariationDetail` to `ObjcLDClient`. These functions allow evaluating feature flags where the provided `defaultValue` and the resulting variation can be any valid JSON data type.
+- Added `ObjcLDJSONEvaluationDetail` for retrieving the detailed evaluation information of arbitrary type flag variations.
+- Added `ObjcLDChangedFlagHandler` type alias for new non-type specific Objective-C flag observers.
+
+### Changed (API)
+- `LDClient.track(key: data: metricValue:)` no longer `throws`.
+- The type of the `data` parameter of `LDClient.track(key: data: metricValue:)` has changed from `Any?` to `LDValue?`.
+- `ObjcLDClient.track(key: data:)` and `ObjcLDClient.track(key: data: metricValue:)` no longer `throws`. In Objective-C this change means that the `track` functions no longer accept a `error:` parameter.
+- The type of the `data` parameter of `ObjcLDClient.track(key: data:)` and `ObjcLDClient.track(key: data: metricValue)` has changed from `Any?` to `ObjLDValue?`. In Objective-C this would be a change from `id _Nullable` to `LDValue * _Nullable`.
+- `LDClient.allFlags` now has the type `[LDFlagKey: LDValue]?` rather than `[LDFlagKey: Any]?`.
+- `ObjcLDClient.allFlags` now has the type `[String: ObjcLDValue]?` rather than `[String: Any]?`. In Objective-C this would be a change from `NSDictionary<NSString*, id> * _Nullable` to `NSDictionary<NSString*, LDValue*> * _Nullable`.
+- The type of the `LDUser.custom` dictionary, and the corresponding `LDUser.init` parameter has been changed from `[String: Any]?` to `[String: LDValue]`.
+- The type of the `ObjcLDUser.custom` property has been changed from `[String: Any]?` to `[String: ObjcLDValue]`. In Objective-C this would be a change from `NSDictionary<NSString*, id> * _Nullable` to `NSDictionary<NSString*, LDValue*> * _Nonnull`.
+- The type of the `LDUser.privateAttributes` property, and the corresponding `LDUser.init` parameter, have been changed from `[String]?` to `[UserAttribute]`.
+- The type of the `ObjcLDUser.privateAttributes` property has been changed from `[String]?` to `[String]`. In Objective-C this would be a change from `NSArray<NSString*> * _Nullable` to `NSArray<NSString*> * _Nonnull`.
+- The types of the properties `LDChangedFlag.oldValue` and `LDChangedFlag.newValue` have been changed from `Any?` to `LDValue`.
+- The type of the `LDConfig.privateUserAttributes` property has been changed from `[String]?` to `[UserAttribute]`.
+- `ObjcLDConfig.privateUserAttributes` now has the non-optional type `[String]` rather than `[String]?`. In Objective-C this would be a change from `NSArray<NSString*> * _Nullable` to `NSArray<NSString*> * _Nonnull`.
+- The type of the `LDEvaluationDetail.reason` property has been changed from `[String: Any]` to `[String: LDValue]`.
+- The type of the `reason` property of `ObjcLDBoolEvaluationDetail`, `ObjcLDIntegerEvaluationDetail`, `ObjcLDDoubleEvaluationDetail`, and `ObjcLDStringEvaluationDetail` has been changed from `[String: Any]?` to `[String: ObjcLDValue]?`. In Objective-C this would be a change from `NSDictionary<NSString*, id> * _Nullable` to `NSDictionary<NSString*, LDValue*> * _Nullable`.
+
+### Changed (behavioral)
+- The `Equatable` instance for `LDUser` has been changed to compare all user properties, rather than just the `key` property.
+- Using `"custom"` as a private attribute name in `LDConfig.privateUserAttributes` or `LDUser.privateAttributes` will no longer set all `LDUser` custom attributes private.
+- The automatically set `device` and `operatingSystem` custom attributes can now be set private.
+- SDK versions from 4.0.0 and less than 6.0.0 supported migration of cached flag data from any SDK version of at least 2.3.3. The 6.0.0 release only supports migration of cached flag data from SDK versions of at least 4.0.0.
+
+### Removed
+- Removed `LDClient.variation(forKey: defaultValue:)` and `LDClient.variationDetail(forKey: defaultValue:)` functions. Please use the new type-specific variation functions instead (e.g. `LDClient.boolVariation(forKey: defaultValue:)`).
+- Removed the `LDFlagValueConvertible` protocol which was previously used to constrain the parameters and return types of the variation functions.
+- `LDErrorHandler` and `LDClient.observeError(owner: handler:)` have been removed. Please use `ConnectionInformation` instead.
+- Removed the `LDUser.init(userDictionary: )` and `ObjcLDUser.init(userDictionary: )` initializers, please use the explicit initializers instead.
+- Removed `LDUser.CodingKeys`. To refer to user attributes, please use `UserAttribute` instead.
+- Removed `LDUser.privatizableAttributes` and `ObjcLDUser.privatizableAttributes`.
+- Removed `ObjcLDUser.attributeCustom`.
+- The `LDUser.device` and `LDUser.operatingSystem` properties, and the corresponding `LDUser.init` parameters have been removed. These fields will be included in the `LDUser.custom` dictionary.
+- The `ObjcLDUser.device` and `ObjcLDUser.operatingSystem` properties have been removed. These fields will be included in the `ObjcLDUser.custom` dictionary.
+- The `ObjcLDClient` functions, `arrayVariation`, `arrayVariationDetail`, `dictionaryVariation`, and `dictionaryVariationDetail`, have been removed. Please use `ObjcLDClient.jsonVariation` and `ObjcLDClient.jsonVariationDetail` instead.
+- The per-type instances of `ObjcLDChangedFlag` have been removed. Please use the base class `ObjcLDChangedFlag`, which now provides `oldValue` and `newValue` `ObjcLDValue` properties. The removed classes are `ObjcLDBoolChangedFlag`, `ObjcLDIntegerChangedFlag`, `ObjcLDDoubleChangedFlag`, `ObjcLDStringChangedFlag`, `ObjcLDArrayChangedFlag`, and `ObjcLDDictionaryChangedFlag`.
+- The classes `ObjcLDArrayEvaluationDetail` and `ObjcLDDictionaryEvaluationDetail` have been removed. Please use `ObjcLDJSONEvaluationDetail` instead.
+- The type aliases, `ObjcLDBoolChangedFlagHandler`, `ObjcLDIntegerChangedFlagHandler`, `ObjcLDDoubleChangedFlagHandler`, `ObjcLDStringChangedFlagHandler`, `ObjcLDArrayChangedFlagHandler`, and `ObjcLDDictionaryChangedFlagHandler`, have been removed. Please use `ObjcLDChangedFlagHandler` instead.
+- The `ObjcLDClient` functions, `observeBool`, `observeInteger`, `observeDouble`, `observeString`, `observeArray`, and `observeDictionary`, have been removed. Please use the non-type specific `ObjcLDClient.observe(key: owner: handler:)` instead.
+
 ## [5.4.5] - 2022-03-11
 ### Fixed
 - Fixed race condition in `LDSwiftEventSource` that could cause a crash if the stream is explicitly stopped (such as when `identify` is called) while the stream is waiting to reconnect.

diff --git a/LaunchDarkly.podspec b/LaunchDarkly.podspec
@@ -2,7 +2,7 @@
 Pod::Spec.new do |ld|
 
   ld.name         = "LaunchDarkly"
-  ld.version      = "5.4.5"
+  ld.version      = "6.0.0"
   ld.summary      = "iOS SDK for LaunchDarkly"
 
   ld.description  = <<-DESC