@sesamy/sesamy-js 1.21.4 → 1.21.5

package/README.md

@@ -90,6 +90,7 @@ The library can trigger actions based on query parameters. The following query p
 - `sesamy-user`. If present, the library will validate that the user is authenticated with the correct email. If not, the user will be logged out and a new login with be initiated.
 - `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.
+- `sesamy-token`. If present, the library parse the token and add any content permissions that the token grants.
 
 # Hash triggers
 
@@ -270,6 +271,133 @@ setToken(accessToken, expiresIn)
   });
 ```
 
+# Entitlements API
+
+## `entitlements.get(entitlementId: string)`
+
+Fetches a specific entitlement by its ID.
+
+### Parameters
+
+- `entitlementId` (string): The ID of the entitlement to retrieve.
+
+### Returns
+
+- `Promise<Entitlement | undefined>`: The entitlement object if found, otherwise `undefined`.
+
+### Example
+
+```javascript
+// Fetch a specific entitlement by its ID
+window.sesamy.entitlements
+  .get('entitlement-id')
+  .then(entitlement => {
+    if (entitlement) {
+      console.log('Entitlement:', entitlement);
+    } else {
+      console.log('Entitlement not found');
+    }
+  })
+  .catch(error => {
+    console.error('Error fetching entitlement:', error);
+  });
+```
+
+---
+
+## `entitlements.list(params: GetEntitlementsOptions)`
+
+Fetches the list of entitlements, with optional filters and inclusion of signed links.
+
+### Parameters
+
+- `params` (GetEntitlementsOptions): Optional parameters for fetching entitlements.
+  - `includeSignedLinks` (boolean, optional): Whether to include signed links. Default is `true`.
+  - `waitForEntitlementAfter` (Date, optional): If provided, waits for an entitlement that is available after the given date.
+
+### Returns
+
+- `Promise<Entitlement[]>`: An array of entitlements.
+
+### Example
+
+```javascript
+// Fetch all entitlements, including signed links
+window.sesamy.entitlements
+  .list({ includeSignedLinks: true })
+  .then(entitlements => {
+    console.log('Entitlements:', entitlements);
+  })
+  .catch(error => {
+    console.error('Error fetching entitlements:', error);
+  });
+```
+
+---
+
+## `entitlements.access(entitlementId: string)`
+
+Fetches the access details for a specific entitlement by its ID.
+
+### Parameters
+
+- `entitlementId` (string): The ID of the entitlement to access.
+
+### Returns
+
+- `Promise<Access>`: The access details for the given entitlement.
+
+### Example
+
+```javascript
+// Fetch access details for a specific entitlement
+window.sesamy.entitlements
+  .access('entitlement-id')
+  .then(access => {
+    console.log('Access details:', access);
+  })
+  .catch(error => {
+    console.error('Error fetching entitlement access:', error);
+  });
+```
+
+---
+
+## `entitlements.signedLinks()`
+
+Fetches signed links for the current session's entitlements.
+
+### Parameters
+
+None.
+
+### Returns
+
+- `SignedLink[]`: An array of signed links for the current entitlements.
+
+### Example
+
+```javascript
+// Fetch signed links for the current entitlements
+const signedLinks = window.sesamy.entitlements.signedLinks();
+console.log('Signed links:', signedLinks);
+```
+
+---
+
+### Types
+
+- **GetEntitlementsOptions**: An object containing optional parameters for fetching entitlements.
+
+  - `includeSignedLinks` (boolean, optional): Whether to include signed links. Defaults to `true`.
+  - `waitForEntitlementAfter` (Date, optional): A date to filter entitlements that are available after the given date.
+
+- **Entitlement**: Represents an entitlement object.
+
+- **Access**: Represents the access details for an entitlement.
+
+- **SignedLink**: Represents a signed link for accessing an entitlement.
+
 # Services
 
 ## `getProfile()`