shopar-plugin 0.8.10 → 0.9.0

package/README.md

@@ -32,7 +32,7 @@ There are two distinct ways of integrating the plugin: via Script tag and via NP
 Add the following script to your HTML.
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/shopar-plugin@0.8.10/dist/shopar-plugin.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/shopar-plugin@0.9.0/dist/shopar-plugin.js"></script>
 ```
 
 It is possible to use a different CDN instead of [jsDelivr](https://www.jsdelivr.com/) (e.g. [cdnjs](https://cdnjs.com/), [unpkg](https://www.unpkg.com/)), or even a relative path if the plugin is distributed as a static asset to your app. Just make sure to set the `baseUrl` parameter accordingly (see [setup options](#shoparpluginsetupoptions) for more details).
@@ -153,7 +153,7 @@ Options used for the plugin setup:
 - `baseUrl` (optional)
   - Type: `string`
   - If provided, defines where the additional ShopAR plugin files are fetched from.
-  - Default value: `https://cdn.jsdelivr.net/npm/shopar-plugin@0.8.10/dist`
+  - Default value: `https://cdn.jsdelivr.net/npm/shopar-plugin@0.9.0/dist`
 - `defaultUI` (optional)
   - Type: `boolean`
   - If provided and set to `false`, disables the default UI such as buttons, loading and error views.
@@ -193,6 +193,22 @@ Options used for the plugin setup:
   - Default values:
     - `loading.ar`: `Loading Try On...`
     - `loading.3d`: `Loading 3D...`
+- `debounceAREngagementMs` (optional)
+  - Type: `number`
+  - If provided, it will be used as the debounce duration for debounced AR engagement tracking.
+  - Default value: `2000`
+- `onDebouncedAREngagement` (optional)
+  - Type: `function`
+  - If provided, it will get called with the engagement duration on every (debounced) AR engagement.
+  - AR engagement is measured as the time spent by the user virtually trying out the product in AR.
+- `debounce3DEngagementMs` (optional)
+  - Type: `number`
+  - If provided, it will be used as the debounce duration for debounced 3D engagement tracking.
+  - Default value: `2000`
+- `onDebounced3DEngagement` (optional)
+  - Type: `function`
+  - If provided, it will be called with the engagement duration on every (debounced) 3D engagement.
+  - 3D engagement is measured as the time spent by the user rotating, panning or zooming the product in 3D.
 
 ## License
 

package/dist/shopar-plugin.d.ts

@@ -173,6 +173,42 @@ type SetupOptions = {
      * ]
      */
     initialAnimation?: KeyFrameConfig[] | string;
+    /**
+     * If provided, it will be used as the debounce duration for debounced AR engagement tracking.
+     *
+     * @default 2000
+     * @see onDebouncedAREngagement
+     */
+    debounceAREngagementMs?: number;
+    /**
+     * If provided, it will get called with the engagement duration on every (debounced) AR engagement.
+     *
+     * AR engagement is measured as the time spent by the user virtually trying out the product in AR.
+     * The callback is called after engagement stops for the specified debounce duration.
+     * Additionally, any outstanding engagement duration is flushed when AR is closed.
+     *
+     * @param durationMs Engagement duration in milliseconds.
+     * @see debounceAREngagementMs
+     */
+    onDebouncedAREngagement?: (durationMs: number) => void;
+    /**
+     * If provided, it will be used as the debounce duration for debounced 3D engagement tracking.
+     *
+     * @default 2000
+     * @see onDebounced3DEngagement
+     */
+    debounce3DEngagementMs?: number;
+    /**
+     * If provided, it will be called with the engagement duration on every (debounced) 3D engagement.
+     *
+     * 3D engagement is measured as the time spent by the user rotating, panning or zooming the product in 3D.
+     * The callback is called after engagement stops for the specified debounce duration.
+     * Additionally, any outstanding engagement duration is flushed when 3D is closed.
+     *
+     * @param durationMs Engagement duration in milliseconds.
+     * @see debounce3DEngagementMs
+     */
+    onDebounced3DEngagement?: (durationMs: number) => void;
     _internalOptions?: any;
 };
 /**