Web 1.+ migration guide

Upgrading version

Increase the dependency version in your package.json file to upgrade your Qonversion SDK to the latest

"@qonversion/web-sdk": "^1.0.0"


In this major version, we have renamed several entities and public methods to make our namings more clear. To make everything work just change all the occurrences from the left column of the table below to the new ones.

Before upgradeAfter upgrade

User properties changes

As mentioned above, we have renamed theUserProperty enum to UserPropertyKey. It was made to release the name UserProperty for a class, containing both the property key and its value. This class will be used in the new Qonversion method userProperties, which will return all the properties set for the current user.

try {
  const userProperties = await Qonversion.getSharedInstance().userProperties();
  userProperties.properties.forEach(userProperty => {
    console.log('User property - key:' + userProperty.key + ', value: ' + userProperty.value);
} catch (e) {
  // handle error here

UserProperties class returned as the successful result of userProperties contains several useful fields and methods to get all the types of properties you may want:

propertiesList of all user properties
definedPropertiesSubset of all user properties, which were set using Qonversion-defined keys
customPropertiesSubset of all user properties, which were set using custom keys
flatPropertiesMapA flattened version of all user properties as a key-value map
flatDefinedPropertiesMapA flattened version of defined user properties as a key-value map
flatCustomPropertiesMapA flattened version of custom user properties as a key-value map
getPropertykey - stringSearches for a property with the given property key in all properties list
getDefinedPropertykey - UserPropertyKeySearches for a property with the given Qonversion-defined property key in the defined properties list.

The last change here is that we've enriched UserPropertyKey enum with a Custom key to represent all the custom properties.