Webcom iOS SDK Change Log

All notable changes to this SDK are documented in this file.
This project adheres to Semantic Versioning.
Publication dates comply with the ISO 8601 Standard.

3.0.0

Breaking

• This release requires iOS 13 or more recent.
• API deprecated in version 2.2.0 have been removed.
• The WebcomCombine module has been merged into WebcomCore base module.

Enhancements

• The SDK does not use the Starscream library anymore.

2.3.1

Bug Fixes

• The log message when an invalid state occurs while authenticating using AuthenticationMethodInternal was not formatted correctly.

2.3.0

Enhancements

• WebcomKey conforms to CustomStringConvertible.
• Increase the default web socket timeout to save battery (170 seconds instead of 45 seconds). [#1217]
• Make subscription callbacks wait for web socket establishment to complete before being called. [#1152]

Bug Fixes

• A WebcomWrapper instance has the same description as its wrapped instance.
• Webcom.defaultConfigurations and Webcom.configurations(from:withKey:) did not throw the expected exception in some circumstances.
• The decoding of a WebcomConfiguration.WebSocketConfiguration value was ignoring the default value of the protocol property.
• Canceling a subscription that uses a constraint could delete data from the cache. [#1227]

2.2.0

Enhancements

• Add WebcomKey.date property.
• DataService.node(for:) method processes . and .. segments, so that the paths are normalized.
• Add DataNode.key property and corresponding property in WebcomWrapper.
• Add DataNode.parent, DataNode.PromiseWrapper.parent and DataNode.CombineWrapper.parent properties.
• Add DataNode.relativeNode(for:), DataNode.PromiseWrapper.relativeNode(for:) and DataNode.CombineWrapper.relativeNode(for:) methods, as well as the corresponding / operators.

Changes

• Rename WebcomValuable.keys() to WebcomValuable.childrenKeys().
  The old method is still available but it is deprecated.
• Rename DataNode.keys(session:queue:then:) to DataNode.childrenKeys(session:queue:then:).
  The old method is still available but it is deprecated.
• Rename DataNode.PromiseWrapper.keys(session:) to DataNode.PromiseWrapper.childrenKeys(session:).
  The old method is still available but it is deprecated.
• Rename DataNode.CombineWrapper.keys(session:) to DataNode.PromiseWrapper.childrenKeys(session:).
  The old method is still available but it is deprecated.

Bug Fixes

• In some circumstances, the value property of DatasyncEvent instances contained child nodes with null values. These child nodes no longer appear. [#1190]

2.1.2

Bug Fixes

• The AuthenticationDetails.downloadAvatar(session:queue:then:) method did not call the completionCallback when no avatar URL was available. Added the noAvatarURL case in WebcomError.SDKCode enumeration to handle this case.

2.1.1

Bug Fixes

• When using DatasyncNode.runTransaction(...), the DatasyncTransaction.Operation returned by a call to function was not stored in the cache until acknowledgment or reject by the back-end. [#712]

2.1.0

Enhancements

• PromiseWrapper and CombineWrapper subtypes become Equatable, Hashable and/or CustomDebugStringConvertible when their wrapped types are:
  • AuthenticationDetails.PromiseWrapper and AuthenticationDetails.CombineWrapper become Equatable.
  • AuthenticationMethodInternal.PromiseWrapper and AuthenticationMethodInternal.CombineWrapper become CustomDebugStringConvertible.
  • AuthenticationService.PromiseWrapper and AuthenticationService.CombineWrapper become Equatable.
  • DataNode.PromiseWrapper and DataNode.CombineWrapper become Hashable (and therefore Equatable).
  • DataService.PromiseWrapper and DataService.CombineWrapper become Equatable.
  • DatasyncNode.PromiseWrapper and DatasyncNode.CombineWrapper become Hashable (and therefore Equatable).
  • DatasyncService.PromiseWrapper and DatasyncService.CombineWrapper become Equatable.
  • WebcomApplication.PromiseWrapper and WebcomApplication.CombineWrapper become Hashable (and therefore Equatable).
• DataNode paths are normalized to remove consecutive slashes and trailing slashes.

Bug Fixes

• Make WebcomDate.backEndCurrentDate work as expected when used: [#1122]
  • in the associated value of DatasyncTransaction.Operation.set(_:),
  • in the value of DatasyncNode.set(_:at:queue:then:) or DatasyncNode.merge(with:at:queue:then:) method when time is DatasyncTime.nextDisconnection.
• Make the DatasyncNode.runTransaction(_:queue:then:) method: [#1124]
  • notify subscriptions when the resulting value is acknowledged by the back-end,
  • store this value in the cache and report it to the completionCallback.

2.0.1

Bug Fixes

• Fix a compilation error when using Xcode 13.
• In the completionCallback of the DatasyncNode.decodedValue(...) method or the DataNode.decodedValue(...) method, the cause of the WebcomError was incorrect in case of decoding error.

2.0.0

Breaking

• This release implements a completely new API, which makes full use of the Swift language.