@sesamy/sesamy-js 1.18.0 → 1.18.2

package/README.md

@@ -11,6 +11,8 @@ The analytics module is used to track events and page views. It is using the [Ge
 The following events are tracked:
 
 - Page views, with events triggered on router updates
+- Scroll events, with events triggered on scroll at 25%, 50%, 75%, and 100%
+- Active and idle duration
 
 ## API
 
@@ -74,7 +76,9 @@ The following events are emitted by the sesamy-js library:
 - `sesamyJsLogout` - Emitted when the user logs out
 - `sesamyJsPurchase` - Emitted after a purchase is completed and passes an itemSrc property with the source of the purchase
 
-# Query parameters
+# Url triggers
+
+## Query parameters
 
 The library can trigger actions based on query parameters. The following query parameters are supported:
 
@@ -83,6 +87,10 @@ The library can trigger actions based on query parameters. The following query p
 - `sesamy-login`. If present, the library will validate that the user is authenticated. If not, the user will be logged out and a new login with be initiated.
 - `sesamy-purchase`. Triggers a sesamyJsPurchase event.
 
+# Hash triggers
+
+The library can read the access token from the hash. It is not the preferred way of logging in a user but can be used when redirecting the user across domains where a cookie-based solution is not possible. The hash is not sent to the server so the is no risk of leaking the token. The token hash is passed like this: `#access_token=<token>`
+
 ## Usage
 
 The script can either be initiated with a JSON object in a script tag or by calling the init method.
@@ -262,7 +270,7 @@ setToken(accessToken, expiresIn)
 
 ## `generateLink(params: GenerateAccountLink | GenerateConsumeLink)`
 
-Generates a link to a Sesamy hosted service such as account or consume. If the user is authenticated, the link will be signed so that the user can access the service without logging in again.
+Generates a link to a Sesamy-hosted service such as account or consume. If the user is authenticated, the link will be signed so that the user can access the service without logging in again.
 
 ### Parameters
 
@@ -273,6 +281,7 @@ Generates a link to a Sesamy hosted service such as account or consume. If the u
   - shorten (boolean, optional): If true, the link will be shortened.
   - ttl (number, optional): The time-to-live for the shortened link in seconds.
   - redirectUrl (string, optional): The URL to redirect to after the link is accessed.
+  - language (string, optional): The language for the link. If not provided the language will be fetched from the HTML element's `lang` attribute.
 
 ### Returns
 
@@ -652,6 +661,14 @@ To use the transform module, include the configuration in your initialization sc
 
 This configuration will replace the content of the element with the ID `example`, remove elements with the class `ad-banner`, insert the content of the element with the ID `source-element` into elements with the class `insert-content`, and load content from a URL into elements with the class `load-from-url`.
 
+### Polyfils
+
+The library polyfills the following methods for compatibility with older browsers:
+
+- URL
+- URLSearchParams
+- fetch
+
 ### Notes
 
 - The `content` property is required for 'insert' and 'replace' transforms.