@nuralogix.ai/web-measurement-embedded-app 0.1.0-beta.1 → 0.1.0-beta.3

package/README.md

@@ -9,6 +9,15 @@ Need deeper integration details? Check the full docs at [docs.deepaffex.ai/wmea]
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Measurement Embedded App Demo</title>
+    <style>
+      #measurement-embedded-app-container {
+        position: fixed;
+        top: 100px;
+        left: 0;
+        width: 100vw;
+        height: calc(100vh - 100px);
+      }
+    </style>
     <script type="importmap">
       {
         "imports": {
@@ -62,8 +71,7 @@ Need deeper integration details? Check the full docs at [docs.deepaffex.ai/wmea]
                 measurementAutoStart: false,
                 cancelWhenLowSNR: true,
               }
-              // Optional top/language/api overrides
-              // top: '100px'
+              // Optional language/api overrides
               // language: 'fr'
               apiUrl: 'api.na-east.deepaffex.ai', // optional for region specific data processing
               loadError: function(error) {
@@ -93,7 +101,7 @@ Need deeper integration details? Check the full docs at [docs.deepaffex.ai/wmea]
 
 - Set `appPath` to `'.'` when you bundle the assets yourself.
 - Profile handling: when `bypassProfile` remains `true` (default) we skip demographic submission and emit an `ERROR` event with `PROFILE_INFO_NOT_SET`; set it to `false` once you supply real profile data.
-- Optional `top` offset lets you push the UI below your own header (default `'0'`).
+- Style the container you pass to `init` (e.g., position, top, width).
 - Optional `apiUrl` enables region-specific processing; omitted values follow the backend token's region automatically. When set explicitly, frontend calls your URL (processing where that endpoint runs) while results continue to store in the token's region—verify the combination suits your deployment.
 - Config options:
   - `checkConstraints` (default: `true`) – enables constraint validation pre-measurement
@@ -101,8 +109,8 @@ Need deeper integration details? Check the full docs at [docs.deepaffex.ai/wmea]
   - `cameraAutoStart` (default: `false`) – automatically starts the camera once permission is granted.
   - `measurementAutoStart` (default: `false`) – automatically starts the measurement once constraints are satisfied.
   - `cancelWhenLowSNR` (default: `true`) – cancels the measurement if signal-to-noise ratio falls below threshold.
-- Language support: `en`, `ja`, `cn`, `es`, `pt`, `it`, `fr`, `de`, `br`.
-  - Browser locales `zh` and `zh-Hans` automatically fall back to `cn`.
+- Language support: `en`, `ja`, `zh`, `es`, `pt`, `pt-BR`, `it`, `fr`, `de`.
+  - Unsupported browser locales fall back to base language (e.g., `zh-TW` → `zh`), then to English.
 - `loadError` is called if assets fail to download or the app cannot initialize.
 
 **Methods:**
@@ -141,6 +149,8 @@ event: ((appEvent: AppEvent) => void) | null;
 **App events dispatched through `measurementApp.on.event`:**
 
 - `APP_LOADED` – the embedded app finished its startup sequence.
+- `MEASUREMENT_PREPARED` - Measurement has been prepared
+- `ASSETS_DOWNLOADED` - Assets have been downloaded
 - `CAMERA_PERMISSION_GRANTED` – the user granted camera access.
 - `CAMERA_STARTED` – a camera stream opened successfully.
 - `MEASUREMENT_STARTED` – a measurement run begins.
@@ -163,14 +173,16 @@ measurementApp.setLanguage('es');
 
 **Error codes emitted through `measurementApp.on.error`:**
 
-| Code                       | Meaning                                                           |
-| -------------------------- | ----------------------------------------------------------------- |
-| `CAMERA_PERMISSION_DENIED` | Camera access prompt was rejected.                                |
-| `CAMERA_START_FAILED`      | Camera hardware failed to start after permission.                 |
-| `NO_DEVICES_FOUND`         | No video input devices detected during enumeration.               |
-| `PAGE_NOT_VISIBLE`         | Measurement was running while the tab or window became hidden.    |
-| `MEASUREMENT_LOW_SNR`      | Signal-to-noise ratio dropped below the acceptable threshold.     |
-| `WORKER_ERROR`             | SDK worker encountered a fatal processing error.                  |
-| `PROFILE_INFO_NOT_SET`     | Profile bypass stayed enabled, so demographics were not provided. |
-| `COLLECTOR`                | Frame collection reported an error                                |
-| `WEBSOCKET_DISCONNECTED`   | Realtime WebSocket connection closed or dropped.                  |
+| Code                         | Meaning                                                           |
+| ---------------------------- | ----------------------------------------------------------------- |
+| `CAMERA_PERMISSION_DENIED`   | Camera access prompt was rejected.                                |
+| `CAMERA_START_FAILED`        | Camera hardware failed to start after permission.                 |
+| `NO_DEVICES_FOUND`           | No video input devices detected during enumeration.               |
+| `PAGE_NOT_VISIBLE`           | Measurement was running while the tab or window became hidden.    |
+| `MEASUREMENT_LOW_SNR`        | Signal-to-noise ratio dropped below the acceptable threshold.     |
+| `WORKER_ERROR`               | SDK worker encountered a fatal processing error.                  |
+| `PROFILE_INFO_NOT_SET`       | Profile bypass stayed enabled, so demographics were not provided. |
+| `COLLECTOR`                  | Frame collection reported an error                                |
+| `WEBSOCKET_DISCONNECTED`     | Realtime WebSocket connection closed or dropped.                  |
+| `MEASUREMENT_PREPARE_FAILED` | Measurement preparation failed - invalid or missing credentials   |
+