Fixed: a very rare deadlock when starting sync immediately after creating the Ditto instance.

Changed: reduced total memory overhead during sync.

Fixed: private class inside the Ditto SDK was named CBOR and conflicted with a private Apple class named exactly the same, which produced a warning at launch time.

Changed: reduced CRDT memory overhead.

Changed: HTTP/WebSocket service now allows any origin for CORS, so it may be used from a webapp on localhost.

Fixed: a peer using an online identity would fail to sync peer-to-peer after app restarts.

Fixed: DittoDelegate method dittoIdentityProviderAuthenticationRequest(ditto:request:) would receive a DittoAuthenticationRequest with some properties being incorrectly set to nil.

Fixed: DittoDelegate method dittoIdentityProviderAuthenticationRequest(ditto:request:) would receive a DittoAuthenticationRequest with some properties being incorrectly set to nil.

Synchronized version bump release

Fixed: Ditto with onlinePlaygroundV2 identity would fail to sync with the Big Peer if internet access isn't available at the time when Ditto is instantiated.

Fixed: DittoSwift contained an invalid development signature.

Synchronized version bump release.

Fixed: a correctness issue in replication when peer permissions changed in the middle of a replication exchange.

Fixed: error when querying a collection and there was a type mismatch for a field being used in a comparison in the query.

Fixed: restarting an app too quickly could lead to multiple connection attempts to rejoin peers in the mesh.

Fixed: apps using OnlinePlaygroundV2 identities could experience a one minute delay before peer-to-peer sync occurs.

Fixed: cloud sync would stop working when setting a newly created transport config.

Changed: Improvements to Ditto mesh performance via fastest-available-transport prioritization.

Synchronized version bump release

Changed: improved replication performance in some scenarios.

Added: onlinePlaygroundV2 case to DittoIdentity allowing for basic authentication for playgrounds

Deprecated: onlinePlayground case of DittoIdentity, use newly added onlinePlaygroundV2 instead

Fixed: sync issues due to inconsistent handling of app IDs across SDKs

Fixed: document IDs are now validated when synced and removed if invalid (some of our early versions of the SDK stored malformed IDs under certain circumstances)

Added: property isReady to experimental DittoBusStream to check if a message may be enqueued.

Added: method setOfflineOnlyLicenseToken() to class Ditto as replacement for now deprecated setLicenseToken().

Changed: made DittoBusStream, DittoRemotePeerV2, and DittoAddress adopt Equatable and Hashable protocols.

Changed: made DittoRemotePeerV2 adopt the Identifiable.protocol.

Deprecated: method setLicenseToken() of class Ditto, use newly added setOfflineOnlyLicenseToken() instead.

Changed: Optimized the performance of accessing the value of a Document.

Added: Combine publisher APIs obviating the CombineDitto extension library

Added: remotePeersPublisher() method to Ditto class

Added: fetchAttachmentPublisher(attachmentToken:) method to DittoCollection class

Added: liveQueryPublisher() method to DittoPendingCursorOperation class

Added: singleDocumentLiveQueryPublisher() method to DittoPendingIDSpecificOperation class

Added: Experimental Bus API

Added: dittoBus(_, didReceiveSingleMessage:) method to DittoBusDelegate protocol

Added: dittoBus(_, didReceiveIncomingStream:, fromPeer:) method to DittoBusDelegate protocol

Removed: dittoBus(_, didReceive:) method from `DittoBusDelegate protocol

Added: Experimental mesh roles API

Added: setMeshRole(meshRole:, ditto:) method to DittoExperimental class

Added: setPriorityForMeshRole(_, forMeshRole:, ditto:) to DittoExperimental class

Fixed: Improved AWDL reliability on iOS 12

Changed: improved peer-to-peer algorithms to create meshes that are more efficient and diverse.

Changed: improved routing algorithms for more efficiency.

Changed: improved performance of query parsing.

Added: property isSyncActive to class Ditto.

Added: method logout() to class DittoAuthenticator.

Added: set of APIs to observe authentication status (see API reference for DittoAuthenticator and DittoAuthenticationDelegate).

Added: method upsert() to classes DittoCollection and DittoScopedWriteTransaction (as a replacement for insert() & friends) which by default merges the newly inserted document if one with the same ID already exists.

Deprecated: properties isAuthenticated and userID of class DittoAuthenticator in favor of newly introduced property status.

Deprecated: methods insert() & frinds of classes DittoCollection and DittoScopedWriteTransaction in favor of newly introduced upsert().

Fixed: collections were not appearing in the data browser under certain permission configurations.

Fixed: race condition when subscriptions were configured from multiple threads in parallel (sometimes leading to a crash).

Fixed a number of Codable-related bugs. One of the more notable fixes involves Codable-conforming types from Foundation now working as you'd expect.

Fixed some small memory leaks.

Reduced the opportunity for rapid memory growth in some scenarios.

Improve attachment sync performance.

Fix an issue where memory usage could grow very quickly when using a live query and performing lots of operations that led to a live query update.

Fixed an issue where document IDs that were specified inside the document's value as opposed to being specified explicitly (as a separate argument to insert) weren't being processed correctly, potentially leading to bugs with merge and overwrite behaviors.

macOS (including Apple Silicon) and iOS simulator (on an Apple Silicon device) support has been added.

Fix an issue with write strategies not working correctly. Unexpected results could occur when performing sequences of operations on documents.

Fix a bug with Codable-conforming enums that was causing a runtime error.

Fix an issue with live queries that involved a limit, no offset, at least one document being deleted, and some other conditions being met. Live queries that met these conditions could report incorrect sets of matching documents.

Fix an issue that could potentially lead to an infinite loop in the replication system, meaning no sync progress would be made.

Ensure that when performing a sort that if a document that matches the filter specified via the accompanying find call doesn't have the key specified in the sort expression then it won't lead to an error. Now, if you're sorting in a descending order then the documents without the key specified in the sort will appear at the end of the set of results, after all of the documents that do have the key present. If you're sorting in an ascending order then the documents without the sort key will appear first in the set of documents, before all of the documents that do contain the sort key.

Fixed handling of large integers in documents. Integers larger than Int.max were still trying to be handled as Ints, leading to crashes. We now correctly handle them as UInts when appropriate.

Add the ability to directly set values inside the closure passed to an update call with assignments done via = sets, e.g. collection.findByID("123").update { $0!["color"] = "white" }

Fix a bug where some transports related calls were not being run on the correct thread and so could lead to a crash.

Fix a bug where large integers (greater than Int.max) would mistakenly try to get internally represented by an Int. They are now correctly represented using a UInt instead.

Add support for array projections to DittoQL.

Deprecate the online identity in favor of the new onlineWithAuthentication identity.

Deprecate the development identity in favor of the new offlinePlayground identity.

Add an auth property to Ditto that provides access to a DittoAuthenticator when using an appropriate identity with your Ditto instance.

Add support for using a document ID that is an object that conforms to Codable.

Synchronized version bump release

Added global section to TransportConfig allowing P2P sync to be contained within certain groups of devices by putting them in the same "sync group".

Fixed Xcode warning regarding .swiftsourceinfo files being present.

Added DittoWriteStrategy enum.

Added method insertWithStrategy() to DittoCollection, allowing to specify the behavior when inserting a document with an ID that matches the ID of a document already in the store.

Fixed AWDL peers never re-connecting after transport is toggled.

Fixed mDNS transport crash.

Fixed sporadic hangs and crashes when using Online identity.

Added isAuthenticated() method and userID property to DittoAuthenticator.

Fixed Codable support for non-string IDs and Float and Double types.

Fix to stop a change in site ID from leading to an unnecessary error.

Improve handling of persisted authentication data. Note that this might lead to a one-off change to a peer's site ID if you weren't and continue to not be specifying an explicit site ID when creating your identity.

Added support for getting information about all of the collections that the device is aware of. This is achieved by accessing collections() through the store object and then using the same sort of API used when getting documents in collections, i.e. exec/observe/etc.

Added multicast as a transport option to the LAN config part of TransportConfig.

Added new identity types: Online and OnlinePlayground. An Online identity should be used when running Ditto in secure production mode, logging on to Ditto Cloud, or using an on-premises authentication server. User permissions are centrally managed. Sync will not work until a successful login has occurred. An OnlinePlayground identity should be used when you want to test a Ditto Cloud app without authentication ("Playground mode"). This mode offers no security and must only be used for development.

The Production identity has been renamed to Manual.

Added a DittoAuthenticator type, accessible via the Ditto object, which allows you to perform login operations when you're using an Online identity.

Similarly, added an DittoAuthenticationDelegate type that needs to be used when using an Online identity.

Report an error if more than one Ditto instance is started using the same working directory.

Improved debug logging.

Fix bug where sync may fail if an unusually long deviceName is configured

Fix intermittent crash when Bluetooth L2CAP connections fail

Fix intermittent crash when using the presence viewer component and the app is backgrounded

Add value accessor on DittoDocumentPath, DittoMutableDocumentPath, and DittoDocumentIDPath types to allow accessing a nested value in a document/ID as an Any?.

Added a new find function that accepts a query containing placeholders in the form of $args.my_arg along with a map of query arguments in the form of { "my_arg": "some value" }. The placeholders in the query will be replaced by a query-appropriate representation of the relevant value from the map of query arguments. For example, a query of color == $args.color with a query arguments map of { "color": "red" } would internally be treated as a query of: color == "red".

Added the ability to get a hash and/or a mnemonic (string) representation of the matching documents from a live query event. This means you can do something like this: let liveQuery = collection.findAll().observe() { docs, event in event.hash(docs); // e.g. `1950015808188223905` event.hashMnemonic(docs); // e.g. `locate-quality-tina--helena-remote-cat` // ... }

Fix for using floats in queries.

Accessing the store property of a Ditto instance will no longer throw an error if you have not yet activated your Ditto instance with a valid license token.

Deprecated setAccessLicense and added a new function, setLicenseToken, which will throw an appropriate error if your provided license token is expired or invalid somehow.

Deprecated startSync and added a new function, tryStartSync, which will throw an error if your Ditto instance hasn't yet been activated via a successful call to setLicenseToken.

Fix issue with AWDL transport where it could end up in a stuck state.

Deprecate the find(query:) function on DittoScopedWriteTransaction and add a new version of find(:) that doesn't require the query argument label. This makes this consistent with the find(:) function on DittoCollection.

Bluetooth sync performance improvements with L2CAP support added.

Add support for subscripting DittoDocumentIDs in order to get nested values when a document ID is based on an array or a dictionary.

Deprecated .toNative() on DittoDocumentID. You should use .value instead.

If you provide an invalid query then you will now get a better error message.

This release is not compatible with any previous SDK releases. There are a number of breaking changes both in terms of the SDK API and in terms of the internal systems used by the SDK to perform operations such as synchronization. If you have previously made use of the Ditto SDK and wish to update to this version then note that you will need to delete all existing Ditto data otherwise you will run into errors. If you have existing data that you need to keep then please contact us and we can advise you as to how you can migrate your data.

The most notable API breaking changes are: Document IDs are no longer restricted to just strings. You can now create a document ID that is a string, integer, boolean, array, map, or null. This means that when making findByID or insert calls you now need to provide a DittoDocumentID object rather than a string. Similarly, when you access a document's ID it will now return a DittoDocumentID object instead of a string. The start() and stop() functions on the Ditto object have been renamed to startSync() and stopSync() respectively. They now also don't accept any arguments. If you wish to specify which transports you would like the Ditto SDK to make use of (along with any configuration that they might require) you now need to use the setTransportConfig function on the Ditto object, and pass to that a transport config object. The default transports that will be enabled are still the same as they were in previous releases of the SDK though, so if you have no custom requirements then you can simply change your start() call to startSync().

Lots of performance improvements and bug fixes.

Fixed a bug where mDNS advertising may continue after Ditto is stopped.

Fixed a hang that could occur creating an attachment fetcher while requesting many attachments at once.

Fixed sync failure when there are multiple overlapping subscriptions or live queries with the same query string for the same collection.

Fixed a potential crash and other sync failures that could occur under certain conditions.