shopar-plugin 1.1.0 → 1.1.1-alpha.1

package/README.md

@@ -15,6 +15,7 @@ Powered and developed by DeepAR.
   - [Usage](#usage)
   - [API](#api)
     - [ShopAR.plugin.setup(options)](#shoparpluginsetupoptions)
+    - [SkuData](#skudata)
   - [License](#license)
 
 ## Getting started
@@ -32,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.1.0/dist/shopar-plugin.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/shopar-plugin@{{VERSION}}/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).
@@ -194,13 +195,17 @@ Options used for the plugin setup:
   - Type: `HTMLElement`
   - The element to inflate with ShopAR UI.
   - Its CSS position property must be either `static` or `relative`.
+- `skuData` (optional)
+  - Type: `SkuData`
+  - If provided, the API call is skipped and this data is used instead. This is useful for providing product data directly without relying on the ShopAR Dashboard API.
+  - See [SkuData](#skudata) for the full type reference.
 - `initialState` (optional)
   - Type: `'AR' | '3D'`
   - If provided, defines which preview type the plugin initializes to.
 - `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.1.0/dist`
+  - Default value: `https://cdn.jsdelivr.net/npm/shopar-plugin@{{VERSION}}/dist`
 - `defaultUI` (optional)
   - Type: `boolean`
   - If provided and set to `false`, disables the default UI (buttons and error UI).
@@ -258,6 +263,39 @@ Options used for the plugin setup:
   - 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.
 
+### SkuData
+
+The `skuData` option allows you to provide product data directly, bypassing the ShopAR Dashboard API call. All properties are optional.
+
+| Property | Type | Description |
+| --- | --- | --- |
+| `category` | `AssetCategory` | Product category. Supported values: `'Glasses'`, `'Shoes'`, `'Watches'`, `'Bracelets'`, `'Handbags'`, `'Rings'`, `'Bottles'`, `'Scarves'`, `'Hats'`, `'Necklaces'`, `'Earrings'`. |
+| `arUrl` | `string` | URL to the AR model asset. |
+| `arEnvUrl` | `string` | URL to the AR environment map. |
+| `arDiamondEnvUrl` | `string` | URL to the AR diamond environment map. |
+| `arToneMapping` | `ToneMapping` | Tone mapping mode for AR. Supported values: `'ACES'`, `'Linear'`, `'Neutral'`. |
+| `arToneMappingExposure` | `number` | Tone mapping exposure for AR. |
+| `arBloomEnabled` | `boolean` | Whether bloom is enabled in AR. |
+| `arBloomStrength` | `number` | Bloom strength in AR. |
+| `arBloomRadius` | `number` | Bloom radius in AR. |
+| `arBloomThreshold` | `number` | Bloom threshold in AR. |
+| `arKey` | `string` | License key for AR. |
+| `arPromptEnabled` | `boolean` | Whether the AR prompt overlay is shown. |
+| `arPromptText` | `string` | Custom text displayed in the AR prompt. |
+| `arPromptImage` | `string` | URL to a custom AR prompt image. If not provided, a default bundled image is used. |
+| `previewUrl` | `string` | URL to the 3D preview model asset. |
+| `previewEnvUrl` | `string` | URL to the 3D preview environment map. |
+| `previewDiamondEnvUrl` | `string` | URL to the 3D preview diamond environment map. |
+| `previewToneMapping` | `ToneMapping` | Tone mapping mode for 3D preview. Supported values: `'ACES'`, `'Linear'`, `'Neutral'`. |
+| `previewToneMappingExposure` | `number` | Tone mapping exposure for 3D preview. |
+| `previewBloomEnabled` | `boolean` | Whether bloom is enabled in 3D preview. |
+| `previewBloomStrength` | `number` | Bloom strength in 3D preview. |
+| `previewBloomRadius` | `number` | Bloom radius in 3D preview. |
+| `previewBloomThreshold` | `number` | Bloom threshold in 3D preview. |
+| `previewPosterUrl` | `string` | URL to a poster image shown before 3D loads. |
+| `cameraErrorText` | `string` | Custom text shown when camera access fails. |
+| `qrPromptText` | `string` | Custom text shown on the QR code screen. |
+
 ## License
 
 Please see: https://developer.deepar.ai/customer-agreement

package/dist/deepar/VERSION.txt

@@ -1 +1 @@
-DeepAR SDK version: v5.6.21-shopar-alpha-401
+DeepAR SDK version: v5.6.22-shopar-alpha-414

package/dist/deepar/file_sizes.json

@@ -1 +1 @@
-{"default_envmap.webp":65532,"background_blur.deepar":4912,"background_replacement.deepar":7024,"deepar.esm.js":140632,"deepar.js":140812,"xzimg.js":421260,"draco-decoder.js":5864,"selfie_segmenter.tflite":249537,"selfie_segmenter_landscape.tflite":250177,"vision_wasm_internal.js":205044,"vision_wasm_internal.wasm":8892001,"vision_wasm_nosimd_internal.js":205051,"vision_wasm_nosimd_internal.wasm":8762352,"face-det.bin":810418,"face-pdm.zip":315482,"face-track-19-v2.bin":698591,"face-track.bin":758982,"face.obj":131564,"models-68-extreme.bin":8139350,"foot-detector-96x96x6-q8.bin":308992,"foot-keyps-superfast-23JUN2024.bin":697885,"foot-right-200.obj":10205,"segmentation-160x160-opt.bin":1306177,"wrist-det-9.bin":1472871,"wrist-track-181-fast-q.bin":2382576,"wrist-track-181-q.bin":3633365,"wrist-track.obj":116157,"split_sum.webp":9562,"deepar.wasm":440229,"draco-decoder.wasm":210412,"libxzimgPoseEstimation.wasm":156543,"tfjs-backend-wasm-simd.wasm":260697,"tfjs-backend-wasm-threaded-simd.wasm":269578,"tfjs-backend-wasm.wasm":171241}
+{"default_envmap.webp":65532,"background_blur.deepar":4912,"background_replacement.deepar":7024,"deepar.esm.js":140722,"deepar.js":140902,"xzimg.js":421260,"draco-decoder.js":5864,"selfie_segmenter.tflite":249537,"selfie_segmenter_landscape.tflite":250177,"vision_wasm_internal.js":205044,"vision_wasm_internal.wasm":8892001,"vision_wasm_nosimd_internal.js":205051,"vision_wasm_nosimd_internal.wasm":8762352,"face-det.bin":810418,"face-pdm.zip":315482,"face-track-19-v2.bin":698591,"face-track.bin":758982,"face.obj":131564,"models-68-extreme.bin":8139350,"foot-detector-96x96x6-q8.bin":308992,"foot-keyps-superfast-23JUN2024.bin":697885,"foot-right-200.obj":10205,"segmentation-160x160-opt.bin":1306177,"wrist-det-9.bin":1472871,"wrist-track-181-fast-q.bin":2382576,"wrist-track-181-q.bin":3633365,"wrist-track.obj":116157,"split_sum.webp":9562,"deepar.wasm":440550,"draco-decoder.wasm":210412,"libxzimgPoseEstimation.wasm":156543,"tfjs-backend-wasm-simd.wasm":260697,"tfjs-backend-wasm-threaded-simd.wasm":269578,"tfjs-backend-wasm.wasm":171241}