shopar-plugin 1.2.1-alpha.0 → 1.2.2-alpha.0

package/README.md

@@ -292,6 +292,16 @@ Options used for the plugin setup:
   - 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.
+- `trueScaleEnabled` (optional)
+  - Type: `boolean`
+  - 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: `false`
+- `customTrueScaleFaceWidth` (optional)
+  - Type: `number`
+  - 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.
      */