@nuralogix.ai/web-measurement-embedded-app 0.1.0-alpha.7 → 0.1.0-alpha.9

package/README.md

@@ -21,6 +21,12 @@
   <div id="measurement-embedded-app-container"></div>
   <script type="module">
     import MeasurementEmbeddedApp, { faceAttributeValue } from '@nuralogix.ai/web-measurement-embedded-app';
+    const {
+      SEX_ASSIGNED_MALE_AT_BIRTH,
+      SMOKER_FALSE,
+      BLOOD_PRESSURE_MEDICATION_FALSE,
+      DIABETES_NONE
+    } = faceAttributeValue;
     const measurementApp = new MeasurementEmbeddedApp();
     const container = document.getElementById('measurement-embedded-app-container');
     if (container) {
@@ -32,9 +38,7 @@
         if (studyIdResponse.status === '200' && tokenResponse.status === '200') {
           measurementApp.init({
             container,
-            top: '100px',
             appPath: 'https://unpkg.com/@nuralogix.ai/web-measurement-embedded-app/dist',
-            language: 'fr', // optional
             settings: {
               token: tokenResponse.token,
               refreshToken: tokenResponse.refreshToken,
@@ -44,12 +48,21 @@
               age: 40,
               height: 180,
               weight: 60,
-              sex: faceAttributeValue.SEX_ASSIGNED_MALE_AT_BIRTH,
-              smoking: faceAttributeValue.SMOKER_FALSE,
-              bloodPressureMedication: faceAttributeValue.BLOOD_PRESSURE_MEDICATION_FALSE,
-              diabetes: faceAttributeValue.DIABETES_NONE,
-              unit: 'Metric',
+              sex: SEX_ASSIGNED_MALE_AT_BIRTH,
+              smoking: SMOKER_FALSE,
+              bloodPressureMedication: BLOOD_PRESSURE_MEDICATION_FALSE,
+              diabetes: DIABETES_NONE,
+              bypassProfile: false,
             },
+            config: {                         // optional
+              checkConstraints: true,         // optional
+              cameraFacingMode: 'user',       // optional
+              cameraAutoStart: true,          // optional
+              measurementAutoStart: false,    // optional
+            }
+            // top: '100px', // (optional)
+            // language: 'fr', // (optional)
+            // apiUrl: 'some-custom-api-url-value', // (optional)
             loadError: function(error) {
               console.error("load rror", error);
             }
@@ -64,9 +77,6 @@
           measurementApp.on.webhook = (webhook) => {
             console.log("Webhook received", webhook);
           };
-          measurementApp.on.cancel = () => {
-            console.log("Measurement cancelled");
-          };
         } else {
           console.error('Failed to get Study ID and Token pair');
         }
@@ -84,4 +94,37 @@
   - If a supported language is set, the app loads with a supported language.
   - If the language prop is not set, the app checks the browser's language and if it is among
   the list of supported languages, it loads the language pack for the browser's language.
-  Otherwise falls back to `en`.
+  Otherwise falls back to `en`.
+
+
+**Methods:**
+
+```typescript
+init(options: MeasurementEmbeddedAppOptions): void;
+destroy(): void;
+cancel(): void;
+setTheme(theme: 'light' | 'dark'): void;
+setLanguage(language: SupportedLanguage): void;
+```
+
+**Events:**
+
+```typescript
+/**
+ * when measurement results are received
+ * @param {results} Results - measurement results
+ */
+results: ((results: Results) => void) | null;
+
+/**
+ * when there is an error in the measurement embedded app
+ * @param {error} MeasurementEmbeddedAppError - measurement embedded app error
+ */
+error: ((error: MeasurementEmbeddedAppError) => void) | null;
+
+/**
+ * when an AppEvent is received
+ * @param {appEvent} AppEvent -  app event
+ */
+event: ((appEvent: AppEvent) => void) | null;
+```