Changelog: Twilio Sync JavaScript SDK

During development, we recommend that you consume the libraries linked below in this section. These will automatically receive API-compatible improvements and bug fixes as we release them.

This release provides all the latest features of Twilio Sync in a single package. It is available on our CDN in full source and minified variants. The latest documentation is available too.

Sync is also published via NPM, for use from within a browserified/web-packed code base. Use npm install --save twilio-sync to install the latest version.

You will find links to specific patch versions below. We recommend using these links for production deployments together with resource integrity checks to avoid accidental security issues.

• Improve caching of Map and List items.

• Non-minified Sync SDK bundled for browsers, hosted on Twilio CDN.
  • SHA-256 for non-minified version 3.3.3: sha256-oObltVynqz080xP0RageLJL+ER8YxuxbM2vNxiIXZB8=
• Minified Sync SDK bundled for browsers, hosted on Twilio CDN.
  • SHA-256 for minified version 3.3.3: sha256-dz7+xOkKoNfCt26B8gNpaJEINEj/uS9875D5CGT0GMY=
• npm Sync node.js SDK package. Built with LTS (14.17.3) version of node.js.
• Documentation

Secure browser script link (recommended for production deployments)

1
<script src="https://media.twiliocdn.com/sdk/js/sync/releases/3.3.3/twilio-sync.min.js"
2
  integrity="sha256-dz7+xOkKoNfCt26B8gNpaJEINEj/uS9875D5CGT0GMY="
3
  crossorigin="anonymous"></script>

Non-secure browser script link (recommended only for development)

<script src="https://media.twiliocdn.com/sdk/js/sync/v3.3/twilio-sync.min.js"></script>

Internal release only for Conversations. No changes.

Internal release only for Conversations. No changes.

Internal release only for Conversations. No changes.

• Internal dependencies update.

• Non-minified Sync SDK bundled for browsers, hosted on Twilio CDN.
  • SHA-256 for non-minified version 3.2.2: sha256-JOuqOoGoPQg23LqcaaeU2HndvzZLnd8zb7euvc/Y+ks=
• Minified Sync SDK bundled for browsers, hosted on Twilio CDN.
  • SHA-256 for minified version 3.2.2: sha256-2C+eHlUZrxhV/UR+DOrKT89SvvRKWgvHn5hJPrUXcOg=
• npm Sync node.js SDK package. Built with LTS (14.17.3) version of node.js.
• Documentation

Secure browser script link (recommended for production deployments)

1
<script src="https://media.twiliocdn.com/sdk/js/sync/releases/3.2.2/twilio-sync.min.js"
2
  integrity="sha256-2C+eHlUZrxhV/UR+DOrKT89SvvRKWgvHn5hJPrUXcOg="
3
  crossorigin="anonymous"></script>

Non-secure browser script link (recommended only for development)

<script src="https://media.twiliocdn.com/sdk/js/sync/v3.2/twilio-sync.min.js"></script>

• Improve initialization time for instances with many sync entities.

• Non-minified Sync SDK bundled for browsers, hosted on Twilio CDN.
  • SHA-256 for non-minified version 3.1.0: sha256-JICkcwEiYrwB5mvDJPUaIEdXVIbSPQdyrXdEXg52/KM=
• Minified Sync SDK bundled for browsers, hosted on Twilio CDN.
  • SHA-256 for minified version 3.1.0: sha256-DDFF+/Gwdi6qvGG/UJUtYa11+zt6sHDM84Ieg7t2/O0=
• npm Sync node.js SDK package. Built with LTS (14.17.3) version of node.js.
• Documentation

Secure browser script link (recommended for production deployments)

1
<script src="https://media.twiliocdn.com/sdk/js/sync/releases/3.1.0/twilio-sync.min.js"
2
  integrity="sha256-DDFF+/Gwdi6qvGG/UJUtYa11+zt6sHDM84Ieg7t2/O0="
3
  crossorigin="anonymous"></script>

Non-secure browser script link (recommended only for development)

<script src="https://media.twiliocdn.com/sdk/js/sync/v3.1/twilio-sync.min.js"></script>

• Remove the post-install script, which was known to cause installation problems.
• Fix argument typing for Sync maps.
• Bump Node required version to current LTS (14).

• Non-minified Sync SDK bundled for browsers, hosted on Twilio CDN.
  • SHA-256 for non-minified version 3.0.6: sha256-yR8MMXeSjlx8ZNVa6MSkgfVGhuDpsHL8b1bYj1PhDRQ=
• Minified Sync SDK bundled for browsers, hosted on Twilio CDN.
  • SHA-256 for minified version 3.0.6: sha256-EAQOpK8jvEQFOKfEVoTwyZD+Zg84X4ubsa0G6Q2QrvI=
• npm Sync node.js SDK package. Built with LTS (14.17.3) version of node.js.
• Documentation

Secure browser script link (recommended for production deployments)

1
<script src="https://media.twiliocdn.com/sdk/js/sync/releases/3.0.6/twilio-sync.min.js"
2
  integrity="sha256-EAQOpK8jvEQFOKfEVoTwyZD+Zg84X4ubsa0G6Q2QrvI="
3
  crossorigin="anonymous"></script>

Non-secure browser script link (recommended only for development)

<script src="https://media.twiliocdn.com/sdk/js/sync/v3.0/twilio-sync.min.js"></script>

• Non-minified Sync SDK bundled for browsers, hosted on Twilio CDN.
  • SHA-256 for non-minified version 3.0.5: sha256-3MjDCDOWsJnwzmcFQgbc/GnxhH2sl7r8hWo4lPGVmqY=
• Minified Sync SDK bundled for browsers, hosted on Twilio CDN.
  • SHA-256 for minified version 3.0.5: sha256-M715lCHKKLJrBCtSpsjvP4hInafwt8ZXbJfXR7RlwdQ=
• npm Sync node.js SDK package. Built with LTS (14.17.3) version of node.js.
• Documentation

Secure browser script link (recommended for production deployments)

1
<script src="https://media.twiliocdn.com/sdk/js/sync/releases/3.0.5/twilio-sync.min.js"
2
  integrity="sha256-M715lCHKKLJrBCtSpsjvP4hInafwt8ZXbJfXR7RlwdQ="
3
  crossorigin="anonymous"></script>

Non-secure browser script link (recommended only for development)

<script src="https://media.twiliocdn.com/sdk/js/sync/v3.0/twilio-sync.min.js"></script>

• Default exports removed — they didn't work in the previous versions either.
• Fixed polyfilling issues for IE11.
• Fixed type resolution issues on Angular.
• Fixed initialization problems on React Native.

• Non-minified Sync SDK bundled for browsers, hosted on Twilio CDN.
  • SHA-256 for non-minified version 3.0.1: sha256-89ZueJ3POPtrp17bnpX0nQEEzB5Enu/16ais0WLP4g4=
• Minified Sync SDK bundled for browsers, hosted on Twilio CDN.
  • SHA-256 for minified version 3.0.1: sha256-V+3gBmUUB90uAwluzE5PEUip/165AsEUxPLXPK8qWxw=
• npm Sync node.js SDK package. Built with LTS (14.17.3) version of node.js.
• Documentation

Secure browser script link (recommended for production deployments)

1
<script src="https://media.twiliocdn.com/sdk/js/sync/releases/3.0.1/twilio-sync.min.js"
2
  integrity="sha256-V+3gBmUUB90uAwluzE5PEUip/165AsEUxPLXPK8qWxw="
3
  crossorigin="anonymous"></script>

Non-secure browser script link (recommended only for development)

<script src="https://media.twiliocdn.com/sdk/js/sync/v3.0/twilio-sync.min.js"></script>

• Fixes for exports that broke when adding the new build pipeline.

Note These changes are minimal and require only some textual replacement. The new build pipeline might have caused some side-effects, though, especially for customers migrating from 2.x. Please evaluate this new version before deploying to production, and open support tickets if you detect any inconsistencies.

• Non-minified Sync SDK bundled for browsers, hosted on Twilio CDN.
  • SHA-256 for non-minified version 3.0.0: sha256-CRHpV7OuDzfqdL91MXlEKkBLlpsWFHozBoyvWNG6mQM=
• Minified Sync SDK bundled for browsers, hosted on Twilio CDN.
  • SHA-256 for minified version 3.0.0: sha256-I0M5Rlc2nP5g3hG8HoJ/Mfz9qKdlrG5Y6lFjOc8y94Q=
• npm Sync node.js SDK package. Built with LTS (14.17.3) version of node.js.
• Documentation

Secure browser script link (recommended for production deployments)

1
<script src="https://media.twiliocdn.com/sdk/js/sync/releases/3.0.0/twilio-sync.min.js"
2
  integrity="sha256-I0M5Rlc2nP5g3hG8HoJ/Mfz9qKdlrG5Y6lFjOc8y94Q="
3
  crossorigin="anonymous"></script>

Non-secure browser script link (recommended only for development)

<script src="https://media.twiliocdn.com/sdk/js/sync/v3.0/twilio-sync.min.js"></script>

• New Rollup-based build, removing dependency on Gulp, which produces a more optimized package and resolves some build pipeline vulnerabilities.
• New documentation based on TypeDoc.
• Stronger type checks in the sources.
• New import paths for types (import from the bundle directly, not from lib).
• New names for imported types. See the documentation for details of the renames.

Note These changes are minimal and require only some textual replacement. The new build pipeline might have caused some side-effects, though, especially for customers migrating from 2.x. Please evaluate this new version before deploying to production, and open support tickets if you detect any inconsistencies.

• Full Source
• Minified
• Documentation

• Reverted the change that required the argument of InstantQuery.search to be a non-empty string. It now accepts any string.

• Full Source
• Minified
• Documentation

• Breaking Stream's value field was renamed data.
• Added startup registrations to allow subscribing to events during Twilsock connection, without using twilio-notifications.js dependency.
• Reduces Sync dependencies, improves startup time.
• Added runtime validation for InstantQuery.search, now the parameter is validated to be a non-empty string before making a call to the back-end.
• Connection will not automatically start if you pass your own instance of Twilsock via options. Nothing changes if you simply create SyncClient with default options - it will work as usual.

• Full Source
• Minified
• Documentation

• The getter for the data of Document was renamed from Document.value to Document.data.
• The getters for the data of ListItem and MapItem were renamed from ListItem.value/MapItem.value to ListItem.data/MapItem.data.
• The itemUpdated events for Map and List now expose the value previousItemData, which is a snapshot of the previous data of the item.
• The itemRemoved events for Map and List had their value property renamed previousItemData.
• The previousItemData value for itemRemoved events (for Map and List) is now also available to local users upon removal.
• The updated and removed events for Document now expose the value previousData, which is a snapshot of the previous data of the document.
• Documentation improvements.

• Full Source
• Minified
• Documentation

• Internal changes and bug fixes.

• Full Source
• Minified
• Documentation

• Dependency bumps.

• Full Source
• Minified
• Documentation

• Dependency bumps.

• Full Source
• Minified
• Documentation

• Connection errors are reported with more details about what actually happened.
• SDK type is now filled as "sync" to be compatible with mobile SDKs.

• Full Source
• Minified
• Documentation

• Logger name is now set to "twilio-sync".
• Client metadata now gets filled if not provided by the user application to the Sync SDK.
• Added validation to the id attribute in OpenOptions to be a string.
• Added validation to ttl attribute in OpenOptions to be a number.

• Full Source
• Minified
• Documentation

• LiveQuery can now automatically restore current state of the record set after being offline for a short period of time. It's an internal functional change which requires no special adoption (no API compatibility issue whatsoever), but it might affect network traffic due to LiveQuery now fetching updates which could have happened while SDK was offline.

• Full Source
• Minified
• Documentation

• Deleted legacy code to make event handling more clean and consistent with iOS and Android SDKs, a non-functional change.

• Full Source
• Minified
• Documentation

• Fixed issues appearing in restrictive browser environments, enabling SDK operation without session storage.

• Full Source
• Minified
• Documentation

• Introduced connectionError event.
• Fixed a bug, where recovery after partial network degradations did not result in the websocket reconnect.

• Full Source
• Minified
• Documentation

• Removed a redundant external dependency (backoff package) and replaced it with operation-retrier package, reducing the SDK footprint.
• Fixed a bug, where the timed out requests were retried excessively, generating additional network traffic.

• Full Source
• Minified
• Documentation

• New close method has been introduced on every Sync primitive (Document, List, Map, Stream, LiveQuery). It can be called at any time to denote that the work on the Sync entity is concluded. Copies of the same Sync entity are reference counted and can be "closed" independently of one another. "Closed" Sync object accepts neither mutation operations nor service events. Once the last copy is closed, SDK unsubscribes from further service events pertaining to this Sync entity, which eventually stops the physical inflow of updates over the network.

• Full Source
• Minified
• Documentation

• This release mostly contains cosmetic changes (internal non-functional modifications) and cleanup activities:
  • Removed two external dependencies: karibu and rfc6902.
  • Deleted legacy code, also reshuffled build scripts and code structure, a non-functional change.
  • Cleaned up documentation — no more references to private constructors.
  • Moved LiveQuery language documentation to a web page, hence a new link in Sync Client documentation that now points to it.

• Full Source
• Minified
• Documentation

• This release includes numerous bugfixes for the LiveQuery/InstantQuery objects that drive Flex:
  • Improved error reporting in case of incorrect query expression syntax.
  • Improved query parsing logic.
  • Reduced SDK size by moving some key functionality to the backend.
  • Integrated an updated version of websocket (Twilsock) library containing a fix for dropping timed out requests.

• Full Source
• Minified
• Documentation

• This release includes numerous bugfixes for the LiveQuery / InstantQuery objects that drive Flex:
• Improved error reporting and handling in case of incorrect query expression syntax.
• Added validation of indexName parameter passed to constructors.
• Improved query parsing logic to detect invalid syntax better.
• Minor updates to documentation.

• Full Source
• Minified
• Documentation

• Added Client.liveQuery() method to fetch a record set and subscribe to it using an SQL-like syntax, receiving updates matching this query in the future.
• Added Client.instantQuery() method to fetch a record set without subscribing to it.

Note These functions are only accessible to Flex developers, cannot be used on a regular Sync service instances.

• Full Source
• Minified
• Documentation

• Fixed a connectivity bug that caused unhandled promise rejections.

• Full Source
• Minified
• Documentation

• Integrating an updated version of websocket (Twilsock) library containing several fixes for reconnect issues on iOS.

• Full Source
• Minified
• Documentation

• Fixed a syntax error which was causing applications with JS Sync SDK to crash in mobile browsers.

• Full Source
• Minified
• Documentation

• Improve diagnostics, start adding timestamps to log lines.
• Fix a transport bug where some of early requests could fail when sent before SDK initialization completes.

• Full Source
• Minified
• Documentation

• Dramatically improved bandwidth use compared with previous versions ("Pre-authenticated Twilsock").
• Knock-on performance improvements from more efficient bandwidth usage.
• Removed HTTP fallback; all traffic is now directed over the websocket.
• Introduced simplified terminal URL configuration. For traffic shaping, you can now control websocket termination with a stanza like the below:

1
let sync = new SyncClient(token, {
2
    twilsock: { uri: 'wss://mycustomproxy.org/v3/wsconnect' }
3
});

• Default logging level has been reduced to "silent". Override by supplying the logLevel option, e.g.

let sync = new SyncClient(token, { logLevel: 'debug' });

• Full Source
• Minified
• Documentation

• Exposed dateUpdated attribute in Documents, Lists, Maps, and update it in browser session cache timely.

• Full Source
• Minified
• Documentation

• Fixed Map itemRemoved event payload for local events.
• Improved SyncError exception description and logging.

• Full Source
• Minified
• Documentation

• This release included only minor internal improvements and documentation clarifications.

• Full Source
• Minified
• Documentation

This release introduces some backwards incompatible changes. Please refer to more detailed release notes to help with migrating.

• Provided more control over how SDK handles object opening and creation, via OpenOptions parameter.
• Enabled configuring automatic garbage collection via TTL parameters for objects and collection items.
• Removed document.get() method, use document.value instead.
• Simplified emitted events, by combining local and remote events under the same name, differentiated by isLocal flag.
• Renamed collectionRemoved event to removed.
• Started automatically merging multiple state update events into single one, if they occur rapidly.
• Fixed requested page size validation on the client side.
• Made object subscription cancellation handling more robust.
• Enabled returning null from mutator functions, gracefully abandoning data change operations.

• Full Source
• Minified
• Documentation

This release adds support for Message Streams with the Stream class.

• Full Source
• Minified
• Documentation

• This release extends and improves on the API documentation of Sync Objects and the events they fire.

• Full Source
• Minified
• Documentation

• itemRemovedRemotely events now include the body of the removed item.
• Internal improvements for resiliency.

• Full Source
• Minified
• Documentation

• An item-caching bug was fixed, in which the Sync SDK would diverge on very volatile objects
• Internal retry handling was tweaked

• Full Source
• Minified
• Documentation

• This release corrects a variety of issues in the .mutate() If-Match concurrency update functions. If you're using this feature on any Sync object this release is critical.

• Full Source
• Minified
• Documentation

• This release corrects handling of non-alphanumeric map UniqueNames and map keys.

• Full Source
• Minified
• Documentation

• This release includes improvements to connection recovery.

• Full Source
• Minified
• Documentation

• This release includes improvements to performance over weak connections.

• Full Source
• Minified
• Documentation

• You can now disable the Sync SDK's use of the session cache it with the below incantation. This may be useful if you need to conserve space.

new Twilio.Sync.Client(/* token */, { Sync: { enableSessionStorage: false } })

• Documents reverted to an old state if a browser tab was refreshed or clicked-through.
• An object deleted on one SDK could somehow still be reconstituted on another client.
• Map and List items were sometimes not properly deleted among collaborating Sync clients.

• Full Source
• Minified
• Documentation

• This patch release fixes a bug in which the automated session cache became unreasonably stale, yielding extraneous update events on new page-loads. The cache should now be neatly updated on each page-load.

• Full Source
• Minified
• Documentation

• Automatic Session Cache This change brings dramatic speed increases for Sync re-initialization across page loads (e.g. if your user clicks through a link), particularly with many objects in play. No API change required.
• Connection Recovery Efficiency If the Twilsock connection should rupture, recovery of state upon reconnect is now dramatically more efficient. To a lesser extent, the same benefit should apply to cold starts (those not benefiting from the session cache), especially with many objects in play.
• Token endpoint_id no longer required It is no longer necessary to provide an endpoint_id field when minting your access tokens; Sync will automatically fingerprint a new endpoint in each browser tab. This change is backwards compatible: if you don't revise your backend code, the endpoint ID will simply be ignored.
• Token Refresh Improved Updating the token in your running Sync SDK will no longer cause a reconnect; the same connection will persist. Reachability webhooks, accordingly, will not fire on token refreshes.

• A vexing bug rarely observed in Edge and Internet Explorer in which sync initialization failed silently has been squashed.
• Handling of retries in the face of rate-limiting (HTTP 429) or overloads (HTTP 503) has been significantly improved.

• js
• min
• docs

Breaking Change: Sync client constructor now expects the token directly, not an AccessManager. Example:

syncClient = new Twilio.Sync.Client(tokenResponse.token);

• Removes: AccessManager requirement. AccessManager is now only required for token lifecycle management, not for Sync client initialization.

• Fixed bug where local connection state not always firing on connection state changes

• js
• min
• docs

• Adds update method to documents, lists and maps. Method allows for convenient updating of specific keys in the JSON data stored in Sync.