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

package/lib/index.d.ts

@@ -917,7 +917,9 @@ interface Results {
 declare const measurementEmbeddedAppEvents: {
     readonly RESULTS: "results";
     readonly ERROR: "error";
-    readonly WEBHOOK: "webhook";
+    readonly APPEVENT: "appEvent";
+    readonly CANCELLED: "cancelled";
+    readonly LOGS: "logs";
 };
 interface AppSettings {
     token: string;
@@ -930,6 +932,7 @@ interface Config {
     cameraFacingMode?: 'user' | 'environment';
     cameraAutoStart?: boolean;
     measurementAutoStart?: boolean;
+    cancelWhenLowSNR?: boolean;
 }
 interface Profile extends Demographics {
     bypassProfile: boolean;
@@ -945,10 +948,28 @@ interface MeasurementEmbeddedAppOptions {
     apiUrl?: string;
     loadError?: (error: string) => void;
 }
+declare enum logCategory {
+    measurement = "Measurement",
+    collector = "Collector",
+    camera = "Camera",
+    app = "App"
+}
+interface Log {
+    timestamp: string;
+    category: logCategory;
+    message: string;
+    meta?: any;
+}
 interface MeasurementEmbedded {
     init(options: MeasurementEmbeddedAppOptions): void;
     destroy(): void;
-    cancel(): void;
+    /**
+     * Cancel the measurement
+     * @param {boolean} reset - whether to reset the Web SDK or just close the camera and hide the mask
+     * @returns {Promise<boolean>} - whether the cancellation was successful
+     */
+    cancel(reset: boolean): Promise<boolean>;
+    getLogs: () => Promise<Log[]>;
     setTheme(theme: 'light' | 'dark'): void;
     setLanguage(language: SupportedLanguage): void;
     on: {
@@ -963,37 +984,35 @@ interface MeasurementEmbedded {
          */
         error: ((error: MeasurementEmbeddedAppError) => void) | null;
         /**
-         * when webhook event is received
-         * @param {webhook} WebhookEvent - webhook event
+         * when an AppEvent is received
+         * @param {appEvent} AppEvent -  app event
          */
-        webhook: ((webhook: WebhookEvent) => void) | null;
+        event: ((appEvent: AppEvent) => void) | null;
     };
 }
 interface MeasurementEmbeddedAppError {
     code: ErrorCodes;
     message: string;
 }
-declare const webhookEventSeverity: {
+declare const appEventSeverity: {
     readonly INFO: "INFO";
     readonly WARN: "WARN";
     readonly ERROR: "ERROR";
 };
-declare const webhookEvent: {
+declare const appEvent: {
     readonly CAMERA_STARTED: "CAMERA_STARTED";
     readonly APP_LOADED: "APP_LOADED";
     readonly MEASUREMENT_STARTED: "MEASUREMENT_STARTED";
     readonly MEASUREMENT_COMPLETED: "MEASUREMENT_COMPLETED";
-    readonly CAMERA_PERMISSION_DENIED: "CAMERA_PERMISSION_DENIED";
     readonly CAMERA_PERMISSION_GRANTED: "CAMERA_PERMISSION_GRANTED";
     readonly INTERMEDIATE_RESULTS: "INTERMEDIATE_RESULTS";
     readonly RESULTS_RECEIVED: "RESULTS_RECEIVED";
     readonly MEASUREMENT_CANCELED: "MEASUREMENT_CANCELED";
     readonly CONSTRAINT_VIOLATION: "CONSTRAINT_VIOLATION";
     readonly PAGE_UNLOADED: "PAGE_UNLOADED";
-    readonly WEBSOCKET_DISCONNECTED: "WEBSOCKET_DISCONNECTED";
     readonly PAGE_VISIBILITY_CHANGE: "PAGE_VISIBILITY_CHANGE";
 };
-declare const webhookEvents: {
+declare const appEvents: {
     readonly CAMERA_STARTED: {
         readonly event: "CAMERA_STARTED";
         readonly level: "INFO";
@@ -1010,10 +1029,6 @@ declare const webhookEvents: {
         readonly event: "MEASUREMENT_COMPLETED";
         readonly level: "INFO";
     };
-    readonly CAMERA_PERMISSION_DENIED: {
-        readonly event: "CAMERA_PERMISSION_DENIED";
-        readonly level: "ERROR";
-    };
     readonly CAMERA_PERMISSION_GRANTED: {
         readonly event: "CAMERA_PERMISSION_GRANTED";
         readonly level: "INFO";
@@ -1038,18 +1053,14 @@ declare const webhookEvents: {
         readonly event: "PAGE_UNLOADED";
         readonly level: "INFO";
     };
-    readonly WEBSOCKET_DISCONNECTED: {
-        readonly event: "WEBSOCKET_DISCONNECTED";
-        readonly level: "WARN";
-    };
     readonly PAGE_VISIBILITY_CHANGE: {
         readonly event: "PAGE_VISIBILITY_CHANGE";
         readonly level: "INFO";
     };
 };
-interface WebhookEvent {
-    event: keyof typeof webhookEvent;
-    level: keyof typeof webhookEventSeverity;
+interface AppEvent {
+    event: keyof typeof appEvent;
+    level: keyof typeof appEventSeverity;
 }
 declare enum ErrorCodes {
     CAMERA_PERMISSION_DENIED = "CAMERA_PERMISSION_DENIED",
@@ -1058,7 +1069,9 @@ declare enum ErrorCodes {
     NO_DEVICES_FOUND = "NO_DEVICES_FOUND",
     PAGE_NOT_VISIBLE = "PAGE_NOT_VISIBLE",
     CAMERA_START_FAILED = "CAMERA_START_FAILED",
-    MEASUREMENT_LOW_SNR = "MEASUREMENT_LOW_SNR"
+    MEASUREMENT_LOW_SNR = "MEASUREMENT_LOW_SNR",
+    COLLECTOR = "COLLECTOR",
+    WEBSOCKET_DISCONNECTED = "WEBSOCKET_DISCONNECTED"
 }
 type MeasurementErrorCodes = ErrorCodes.WORKER_ERROR | ErrorCodes.PROFILE_INFO_NOT_SET;
 
@@ -1071,23 +1084,24 @@ declare class MeasurementEmbeddedApp implements MeasurementEmbedded {
          */
         results: ((results: Results) => void) | null;
         /**
-         * when measurement results are received
-         * @param {results} Results - measurement results
+         * when there is an error in the measurement embedded app
+         * @param {error} MeasurementEmbeddedAppError - measurement embedded app error
          */
         error: ((error: MeasurementEmbeddedAppError) => void) | null;
         /**
-         * when webhook event is received
-         * @param {webhook} WebhookEvent - webhook event
+         * when an appEvent is received
+         * @param {appEvent} AppEvent - appEvent
          */
-        webhook: ((webhook: WebhookEvent) => void) | null;
+        event: ((appEvent: AppEvent) => void) | null;
     };
     constructor();
     init(options: MeasurementEmbeddedAppOptions): void;
     destroy(): void;
     setTheme(theme: 'light' | 'dark'): void;
     setLanguage(language: SupportedLanguage): void;
-    cancel(): void;
+    cancel(reset: boolean): Promise<boolean>;
+    getLogs(): Promise<Log[]>;
 }
 
-export { ErrorCodes, MeasurementEmbeddedApp as default, faceAttributeValue, measurementEmbeddedAppEvents, webhookEvents };
-export type { AppSettings, DfxPointId, MeasurementEmbeddedAppError, MeasurementEmbeddedAppOptions, MeasurementErrorCodes, Point, Profile, Results };
+export { ErrorCodes, appEvents, MeasurementEmbeddedApp as default, faceAttributeValue, measurementEmbeddedAppEvents };
+export type { AppSettings, DfxPointId, DialSection, IMeta, MeasurementEmbeddedAppError, MeasurementEmbeddedAppOptions, MeasurementErrorCodes, Point, PointGroupType, Profile, Results };