@sesamy/sesamy-js 1.19.8 → 1.19.10

package/README.md

@@ -714,11 +714,89 @@ In this example, the details of a specific checkout session are retrieved using
 
 By using the `getCheckout` function, you can easily fetch the details of a specific checkout session from the Sesamy API to view or process the transaction information.
 
-## Transform
+# Browser API
+
+## `detectAdblock()`
+
+Detects the presence of an ad blocker in the browser by dynamically creating and checking the visibility of several ad-related HTML elements.
+
+### Parameters
+
+None
+
+### Returns
+
+Promise: A promise that resolves to a boolean value indicating whether an ad blocker is enabled (`true`) or not (`false`).
+
+### Example
+
+The following example demonstrates how to use the `detectAdblock` function to detect if an ad blocker is enabled:
+
+```javascript
+import { detectAdblock } from '@sesamy/sesamy-js';
+
+// Detect if an ad blocker is enabled
+detectAdblock()
+  .then(isAdblockEnabled => {
+    if (isAdblockEnabled) {
+      console.log('Adblocker is enabled');
+    } else {
+      console.log('Adblocker is not enabled');
+    }
+  })
+  .catch(error => {
+    console.error('Error detecting adblock:', error);
+  });
+```
+
+### Details
+
+- The function creates a set of HTML `<div>` elements with IDs typically used by ad containers (e.g., 'AdHeader', 'AdContainer', etc.).
+- These elements are appended to the body of the document and their visibility is checked after a short delay (100 milliseconds).
+
+## `isInAppBrowser()`
+
+Detects if the current browsing context is an in-app browser and identifies the browser name if applicable.
+
+### Parameters
+
+None
+
+### Returns
+
+Object: An object containing two properties:
+
+- `isInAppBrowser` (boolean): Indicates whether the current browsing context is an in-app browser (`true`) or not (`false`).
+- `browserName` (string | null): The name of the in-app browser if detected, or `null` if not detected.
+
+### Example
+
+The following example demonstrates how to use the `isInAppBrowser` function to check if the current context is an in-app browser and log the browser name if applicable:
+
+```javascript
+import { isInAppBrowser } from '@sesamy/sesamy-js';
+
+// Detect if the current context is an in-app browser
+const result = isInAppBrowser();
+
+if (result.isInAppBrowser) {
+  console.log(`Running inside an in-app browser: ${result.browserName}`);
+} else {
+  console.log('Not running inside an in-app browser');
+}
+```
+
+### Details
+
+- A predefined list of common in-app browsers (e.g., Facebook, Instagram, LinkedIn, etc.) is checked against the user agent.
+- If a match is found, the function returns `isInAppBrowser: true` and the corresponding `browserName`.
+- If no known in-app browser signatures are detected, the function returns `isInAppBrowser: false` and `browserName: null`.
+
+# Transforms
 
 The transform module allows for dynamic content manipulation based on specified rules. This can include inserting, replacing, or removing elements on a webpage.
 
-### Configuration
+## Configuration
 
 The transform configuration is defined within the `Config` interface. The following properties are available: