shopar-plugin 1.2.1 → 1.2.2

package/README.md

@@ -33,7 +33,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@1.2.1/dist/shopar-plugin.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/shopar-plugin@1.2.2/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).
@@ -205,7 +205,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@1.2.1/dist`
+  - Default value: `https://cdn.jsdelivr.net/npm/shopar-plugin@1.2.2/dist`
 - `defaultUI` (optional)
   - Type: `boolean`
   - If provided and set to `false`, disables the default UI (buttons and error UI).
@@ -294,12 +294,13 @@ Options used for the plugin setup:
   - 3D engagement is measured as the time spent by the user rotating, panning or zooming the product in 3D.
 - `trueScaleEnabled` (optional)
   - Type: `boolean`
-  - If provided and set to `false`, disables ShopAR True Scale sizing for AR glasses. The glasses are then rendered at their authored size instead of being scaled to the user's measured face.
+  - If provided and set to `true`, enables ShopAR True Scale sizing for AR glasses, scaling them to the user's measured face. Otherwise the glasses are rendered at their authored size.
   - Only applies to the Glasses category.
-  - Default value: `true`
+  - Default value: `false`
 - `customTrueScaleFaceWidth` (optional)
   - Type: `number`
-  - If provided, it will be used as the True Scale face width, in millimeters, for AR glasses, instead of measuring it with ShopAR True Scale technology.
+  - If provided, AR glasses are scaled to this fixed face width, in millimeters, instead of measuring it with ShopAR True Scale technology.
+  - Sets the face width directly and works independently of `trueScaleEnabled`. When both are set, this fixed width takes precedence over the measured width.
   - Only applies to the Glasses category.
 
 ### SkuData

package/dist/shopar-plugin.d.ts

@@ -476,16 +476,20 @@ type SetupOptions = {
      */
     customArVideo?: ArVideoConfig;
     /**
-     * If provided, it will be used as the true scale face width, in millimeters, for AR glasses.
+     * If provided, AR glasses are scaled to this fixed face width, in millimeters.
      *
-     * If not provided, the value is determined by ShopAR True Scale technology.
+     * This sets the face width directly and does not use ShopAR True Scale measurement, so it
+     * works independently of `trueScaleEnabled`. When both are set, this fixed width takes
+     * precedence over the measured width.
+     *
+     * Only applies to the Glasses category.
      */
     customTrueScaleFaceWidth?: number;
     /**
      * Controls whether ShopAR True Scale is used to size AR glasses to the user's face.
      *
-     * Defaults to `true`. Set to `false` to disable True Scale, in which case glasses are
-     * rendered at their authored size instead of being scaled to the measured face width.
+     * Defaults to `false`, in which case glasses are rendered at their authored size.
+     * Set to `true` to enable True Scale, scaling the glasses to the user's measured face width.
      *
      * Only applies to the Glasses category.
      */