@shenai/capacitor-sdk 3.1.1

package/dist/esm/definitions.d.ts

@@ -0,0 +1,612 @@
+export declare enum InitializationResult {
+    OK = 0,
+    INVALID_API_KEY = 1,
+    CONNECTION_ERROR = 2,
+    INTERNAL_ERROR = 3
+}
+export declare enum OperatingMode {
+    POSITIONING = 0,
+    MEASURE = 1,
+    SYSTEM_OVERLOADED = 2
+}
+export declare enum CalibrationState {
+    CALIBRATED = 0,
+    NOT_CALIBRATED = 1,
+    OUTDATED = 2
+}
+export declare enum PrecisionMode {
+    STRICT = 0,
+    RELAXED = 1
+}
+export declare enum MeasurementEnvironmentCondition {
+    FACE_POSITION = 0,
+    FOREHEAD_VISIBLE = 1,
+    GLASSES_NOT_DETECTED = 2,
+    SUFFICIENT_LIGHT_LEVEL = 3,
+    EVEN_LIGHTING = 4,
+    NO_BACKLIGHT = 5,
+    FACE_STABLE = 6,
+    DEVICE_STABLE = 7
+}
+export declare enum Screen {
+    INITIALIZATION = 0,
+    ONBOARDING = 1,
+    MEASUREMENT = 2,
+    INSTRUCTIONS = 3,
+    RESULTS = 4,
+    HEALTH_RISKS = 5,
+    HEALTH_RISKS_EDIT = 6,
+    CALIBRATION_ONBOARDING = 7,
+    CALIBRATION_FINISH = 8,
+    CALIBRATION_DATA_ENTRY = 9,
+    DISCLAIMER = 10,
+    DASHBOARD = 11
+}
+export declare enum Metric {
+    HEART_RATE = 0,
+    HRV_SDNN = 1,
+    BREATHING_RATE = 2,
+    SYSTOLIC_BP = 3,
+    DIASTOLIC_BP = 4,
+    CARDIAC_STRESS = 5,
+    PNS_ACTIVITY = 6,
+    CARDIAC_WORKLOAD = 7,
+    AGE = 8,
+    BMI = 9,
+    BLOOD_PRESSURE = 10,
+    BLOOD_PRESSURE_SCALE = 11
+}
+export declare enum BmiCategory {
+    UNDERWEIGHT_SEVERE = 0,
+    UNDERWEIGHT_MODERATE = 1,
+    UNDERWEIGHT_MILD = 2,
+    NORMAL = 3,
+    OVERWEIGHT = 4,
+    OBESE_CLASS_I = 5,
+    OBESE_CLASS_II = 6,
+    OBESE_CLASS_III = 7
+}
+export declare enum HealthIndex {
+    WELLNESS_SCORE = 0,
+    VASCULAR_AGE = 1,
+    CARDIOVASCULAR_DISEASE_RISK = 2,
+    HARD_AND_FATAL_EVENTS_RISKS = 3,
+    CARDIO_VASCULAR_RISK_SCORE = 4,
+    WAIST_TO_HEIGHT_RATIO = 5,
+    BODY_FAT_PERCENTAGE = 6,
+    BODY_ROUNDNESS_INDEX = 7,
+    A_BODY_SHAPE_INDEX = 8,
+    CONICITY_INDEX = 9,
+    BASAL_METABOLIC_RATE = 10,
+    TOTAL_DAILY_ENERGY_EXPENDITURE = 11,
+    HYPERTENSION_RISK = 12,
+    DIABETES_RISK = 13,
+    NON_ALCOHOLIC_FATYY_LIVER_DISEASE_RISK = 14
+}
+export declare enum MeasurementPreset {
+    ONE_MINUTE_HR_HRV_BR = 0,
+    ONE_MINUTE_BETA_METRICS = 1,
+    INFINITE_HR = 2,
+    INFINITE_METRICS = 3,
+    FOURTY_FIVE_SECONDS_UNVALIDATED = 4,
+    THIRTY_SECONDS_UNVALIDATED = 5,
+    CUSTOM = 6,
+    ONE_MINUTE_ALL_METRICS = 7,
+    FOURTY_FIVE_SECONDS_ALL_METRICS = 8,
+    THIRTY_SECONDS_ALL_METRICS = 9,
+    QUICK_HR_MODE = 10
+}
+export declare enum CameraMode {
+    OFF = 0,
+    FACING_USER = 1,
+    FACING_ENVIRONMENT = 2,
+    CUSTOM_FRAMES = 3
+}
+export declare enum CameraError {
+    UNKNOWN = 0,
+    UNSUPPORTED_MODE = 1,
+    NO_CAMERA_DEVICE = 2,
+    PERMISSION_NOT_GRANTED = 3,
+    INVALID_DEVICE_ID = 4,
+    DEVICE_UNAVAILABLE = 5
+}
+export declare enum OnboardingMode {
+    HIDDEN = 0,
+    SHOW_ONCE = 1,
+    SHOW_ALWAYS = 2
+}
+export declare enum UiVersion {
+    V1 = 0,
+    V2 = 1,
+    V3 = 2
+}
+export declare enum InitializationMode {
+    MEASUREMENT = 0,
+    CALIBRATION = 1,
+    CALIBRATED_MEASUREMENT = 2,
+    FAST_CALIBRATION = 3
+}
+export declare const enum Event {
+    START_BUTTON_CLICKED = 0,
+    STOP_BUTTON_CLICKED = 1,
+    MEASUREMENT_FINISHED = 2,
+    USER_FLOW_FINISHED = 3,
+    SCREEN_CHANGED = 4
+}
+export interface InitializationSettings {
+    precisionMode?: PrecisionMode;
+    operatingMode?: OperatingMode;
+    measurementPreset?: MeasurementPreset;
+    cameraMode?: CameraMode;
+    onboardingMode?: OnboardingMode;
+    initializationMode?: InitializationMode;
+    offlineProcessing?: boolean;
+    showUserInterface?: boolean;
+    showFacePositioningOverlay?: boolean;
+    showVisualWarnings?: boolean;
+    enableCameraSwap?: boolean;
+    showFaceMask?: boolean;
+    showBloodFlow?: boolean;
+    hideShenaiLogo?: boolean;
+    includeTimestampInPdf?: boolean;
+    pdfEmailSubject?: string;
+    pdfEmailBody?: string;
+    enableStartAfterSuccess?: boolean;
+    enableSummaryScreen?: boolean;
+    showResultsFinishButton?: boolean;
+    enableHealthRisks?: boolean;
+    showHealthIndicesFinishButton?: boolean;
+    saveHealthRisksFactors?: boolean;
+    showOutOfRangeResultIndicators?: boolean;
+    showTrialMetricLabels?: boolean;
+    showSignalQualityIndicator?: boolean;
+    showSignalTile?: boolean;
+    showStartStopButton?: boolean;
+    showInfoButton?: boolean;
+    showDisclaimer?: boolean;
+    enableMeasurementsDashboard?: boolean;
+    uiVersion?: UiVersion;
+    uiFlowScreens?: Screen[];
+    frameWidth?: number;
+    frameHeight?: number;
+    rotation?: number;
+    risksFactors?: RisksFactors;
+}
+export interface CustomMeasurementConfig {
+    durationSeconds?: number;
+    infiniteMeasurement?: boolean;
+    instantMetrics?: Metric[];
+    summaryMetrics?: Metric[];
+    healthIndices?: HealthIndex[];
+    realtimeHrPeriodSeconds?: number;
+    realtimeHrvPeriodSeconds?: number;
+    realtimeCardiacStressPeriodSeconds?: number;
+}
+export interface CustomColorTheme {
+    themeColor: string;
+    textColor: string;
+    backgroundColor: string;
+    tileColor: string;
+    buttonMainColor?: string;
+    buttonSecondaryColor?: string;
+}
+export declare enum FaceState {
+    OK = 0,
+    TOO_FAR = 1,
+    TOO_CLOSE = 2,
+    NOT_CENTERED = 3,
+    NOT_VISIBLE = 4,
+    UNKNOWN = 5
+}
+export interface NormalizedFaceBbox {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export declare enum MeasurementState {
+    NOT_STARTED = 0,
+    WAITING_FOR_FACE = 1,
+    RUNNING_SIGNAL_SHORT = 2,
+    RUNNING_SIGNAL_GOOD = 3,
+    RUNNING_SIGNAL_BAD = 4,
+    RUNNING_SIGNAL_BAD_DEVICE_UNSTABLE = 5,
+    FINALIZING = 6,
+    FINISHED = 7,
+    FAILED = 8
+}
+export interface Heartbeat {
+    startLocationSec: number;
+    endLocationSec: number;
+    durationMs: number;
+}
+export interface MeasurementQualityMetrics {
+    ppgQualityIndex: number | null;
+    bcgQualityIndex: number | null;
+    breathingQualityIndex: number | null;
+    bloodPressureQualityIndex: number | null;
+    expectedSbpMedianAbsErrorMmhg: number | null;
+    expectedSbpP80AbsErrorMmhg: number | null;
+    expectedSbpMeanAbsErrorMmhg: number | null;
+    expectedSbpBalancedMaeMmhg: number | null;
+    expectedDbpMedianAbsErrorMmhg: number | null;
+    expectedDbpP80AbsErrorMmhg: number | null;
+    expectedDbpMeanAbsErrorMmhg: number | null;
+    expectedDbpBalancedMaeMmhg: number | null;
+}
+export interface MeasurementResults {
+    heartRateBpm: number;
+    hrvSdnnMs: number | null;
+    hrvLnrmssdMs: number | null;
+    stressIndex: number | null;
+    parasympatheticActivity: number | null;
+    breathingRateBpm: number | null;
+    systolicBloodPressureMmhg: number | null;
+    diastolicBloodPressureMmhg: number | null;
+    cardiacWorkloadMmhgPerSec: number | null;
+    ageYears: number | null;
+    bmiKgPerM2: number | null;
+    bmiCategory?: BmiCategory | null;
+    weightKg: number | null;
+    heightCm: number | null;
+    qualityMetrics: MeasurementQualityMetrics | null;
+    heartbeats: Heartbeat[];
+    averageSignalQuality: number;
+}
+export interface MeasurementResultsWithMetadata {
+    measurementResults: MeasurementResults;
+    epochTimestamp: number;
+    isCalibration: boolean;
+}
+export interface MeasurementResultsHistory {
+    history: MeasurementResultsWithMetadata[];
+}
+export interface MomentaryHrValue {
+    timestamp: number;
+    value: number;
+}
+export declare enum Gender {
+    MALE = 0,
+    FEMALE = 1,
+    OTHER = 2
+}
+export declare enum PhysicalActivity {
+    SEDENTARY = 0,
+    LIGHTLY_ACTIVE = 1,
+    MODERATELY = 2,
+    VERY_ACTIVE = 3,
+    EXTRA_ACTIVE = 4
+}
+export declare enum Race {
+    WHITE = 0,
+    AFRICAN_AMERICAN = 1,
+    OTHER = 2
+}
+export declare enum HypertensionTreatment {
+    NOT_NEEDED = 0,
+    NO = 1,
+    YES = 2
+}
+export declare enum ParentalHistory {
+    NONE = 0,
+    ONE = 1,
+    BOTH = 2
+}
+export declare enum FamilyHistory {
+    NONE = 0,
+    NONE_FIRST_DEGREE = 1,
+    FIRST_DEGREE = 2
+}
+export declare enum NAFLDRisk {
+    LOW = 0,
+    MODERATE = 1,
+    HIGH = 2
+}
+export interface HardAndFatalEventsRisks {
+    coronaryDeathEventRisk: number | null;
+    fatalStrokeEventRisk: number | null;
+    totalCVMortalityRisk: number | null;
+    hardCVEventRisk: number | null;
+}
+export interface CVDiseasesRisks {
+    overallRisk: number | null;
+    coronaryHeartDiseaseRisk: number | null;
+    strokeRisk: number | null;
+    heartFailureRisk: number | null;
+    peripheralVascularDiseaseRisk: number | null;
+}
+export interface RisksFactorsScores {
+    ageScore: number | null;
+    sbpScore: number | null;
+    smokingScore: number | null;
+    diabetesScore: number | null;
+    bmiScore: number | null;
+    cholesterolScore: number | null;
+    cholesterolHdlScore: number | null;
+    totalScore: number | null;
+}
+export interface HealthRisks {
+    wellnessScore: number | null;
+    hardAndFatalEvents: HardAndFatalEventsRisks;
+    cvDiseases: CVDiseasesRisks;
+    vascularAge: number | null;
+    waistToHeightRatio: number | null;
+    bodyFatPercentage: number | null;
+    basalMetabolicRate: number | null;
+    bodyRoundnessIndex: number | null;
+    conicityIndex: number | null;
+    aBodyShapeIndex: number | null;
+    totalDailyEnergyExpenditure: number | null;
+    scores: RisksFactorsScores;
+    hypertensionRisk?: number | null;
+    diabetesRisk?: number | null;
+    nonAlcoholicFattyLiverDiseaseRisk?: NAFLDRisk | null;
+}
+export interface RisksFactors {
+    age?: number;
+    cholesterol?: number;
+    cholesterolHdl?: number;
+    sbp?: number;
+    dbp?: number;
+    isSmoker?: boolean;
+    hypertensionTreatment?: HypertensionTreatment;
+    hasDiabetes?: boolean;
+    bodyHeight?: number;
+    bodyWeight?: number;
+    waistCircumference?: number;
+    neckCircumference?: number;
+    hipCircumference?: number;
+    gender?: Gender;
+    physicalActivity?: PhysicalActivity;
+    country?: string;
+    race?: Race;
+    vegetableFruitDiet?: boolean;
+    historyOfHypertension?: boolean;
+    historyOfHighGlucose?: boolean;
+    fastingGlucose?: number;
+    triglyceride?: number;
+    parentalHypertension?: ParentalHistory;
+    familyDiabetes?: FamilyHistory;
+}
+export interface ViewRect {
+    x?: number;
+    y?: number;
+    width?: number;
+    height?: number;
+}
+export interface ShenaiSdkCapacitorPlugin {
+    echo(options: {
+        value: string;
+    }): Promise<{
+        value: string;
+    }>;
+    initialize(options: {
+        apiKey: string;
+        userId?: string;
+        settings?: InitializationSettings;
+    }): Promise<{
+        value: InitializationResult;
+    }>;
+    isInitialized(): Promise<{
+        value: boolean;
+    }>;
+    deinitialize(): Promise<void>;
+    setViewRect(options: ViewRect): Promise<void>;
+    setOverlaysWebview(options: {
+        overlay: boolean;
+    }): Promise<void>;
+    setOperatingMode(options: {
+        operatingMode: OperatingMode;
+    }): Promise<void>;
+    startMeasurement(): Promise<void>;
+    stopMeasurement(): Promise<void>;
+    resetMeasurementSession(): Promise<void>;
+    setPrecisionMode(options: {
+        precisionMode: PrecisionMode;
+    }): Promise<void>;
+    setMeasurementPreset(options: {
+        preset: MeasurementPreset;
+    }): Promise<void>;
+    setCustomMeasurementConfig(options: {
+        config: CustomMeasurementConfig;
+    }): Promise<void>;
+    setCustomColorTheme(options: {
+        theme: CustomColorTheme;
+    }): Promise<void>;
+    setCameraMode(options: {
+        cameraMode: CameraMode;
+    }): Promise<void>;
+    setScreen(options: {
+        screen: Screen;
+    }): Promise<void>;
+    setShowUserInterface(options: {
+        value: boolean;
+    }): Promise<void>;
+    setShowFacePositioningOverlay(options: {
+        value: boolean;
+    }): Promise<void>;
+    setShowVisualWarnings(options: {
+        value: boolean;
+    }): Promise<void>;
+    setEnableCameraSwap(options: {
+        value: boolean;
+    }): Promise<void>;
+    setShowFaceMask(options: {
+        value: boolean;
+    }): Promise<void>;
+    setShowBloodFlow(options: {
+        value: boolean;
+    }): Promise<void>;
+    setIncludeTimestampInPdf(options: {
+        value: boolean;
+    }): Promise<void>;
+    setPdfEmailSubject(options: {
+        subject: string;
+    }): Promise<void>;
+    setPdfEmailBody(options: {
+        body: string;
+    }): Promise<void>;
+    setEnableStartAfterSuccess(options: {
+        value: boolean;
+    }): Promise<void>;
+    setEnableMeasurementsDashboard(options: {
+        value: boolean;
+    }): Promise<void>;
+    setLanguage(options: {
+        language: string;
+    }): Promise<void>;
+    getOperatingMode(): Promise<{
+        value: OperatingMode;
+    }>;
+    getCalibrationState(): Promise<{
+        value: CalibrationState;
+    }>;
+    getPrecisionMode(): Promise<{
+        value: PrecisionMode;
+    }>;
+    getMeasurementPreset(): Promise<{
+        value: MeasurementPreset;
+    }>;
+    getCameraMode(): Promise<{
+        value: CameraMode;
+    }>;
+    getLastCameraError(): Promise<{
+        value: CameraError | null;
+    }>;
+    getScreen(): Promise<{
+        value: Screen;
+    }>;
+    getShowUserInterface(): Promise<{
+        value: boolean;
+    }>;
+    getShowFacePositioningOverlay(): Promise<{
+        value: boolean;
+    }>;
+    getShowVisualWarnings(): Promise<{
+        value: boolean;
+    }>;
+    getEnableCameraSwap(): Promise<{
+        value: boolean;
+    }>;
+    getShowFaceMask(): Promise<{
+        value: boolean;
+    }>;
+    getShowBloodFlow(): Promise<{
+        value: boolean;
+    }>;
+    getIncludeTimestampInPdf(): Promise<{
+        value: boolean;
+    }>;
+    setShowStartStopButton(options: {
+        value: boolean;
+    }): Promise<void>;
+    getShowStartStopButton(): Promise<{
+        value: boolean;
+    }>;
+    setEnableMeasurementsDashboard(options: {
+        value: boolean;
+    }): Promise<void>;
+    getEnableMeasurementsDashboard(): Promise<{
+        value: boolean;
+    }>;
+    setShowInfoButton(options: {
+        value: boolean;
+    }): Promise<void>;
+    getShowInfoButton(): Promise<{
+        value: boolean;
+    }>;
+    getShowDisclaimer(): Promise<{
+        value: boolean;
+    }>;
+    getEnableStartAfterSuccess(): Promise<{
+        value: boolean;
+    }>;
+    getFaceState(): Promise<{
+        value: FaceState;
+    }>;
+    getNormalizedFaceBbox(): Promise<NormalizedFaceBbox | null>;
+    getMeasurementState(): Promise<{
+        value: MeasurementState;
+    }>;
+    getCurrentViolatedMeasurementEnvironmentCondition(): Promise<{
+        value: MeasurementEnvironmentCondition | null;
+    }>;
+    isReadyToStartMeasurement(): Promise<{
+        value: boolean;
+    }>;
+    areRequiredModelsDownloaded(): Promise<{
+        value: boolean;
+    }>;
+    getMeasurementProgressPercentage(): Promise<{
+        value: number;
+    }>;
+    getHeartRate10s(): Promise<{
+        value: number | null;
+    }>;
+    getHeartRate4s(): Promise<{
+        value: number | null;
+    }>;
+    getRealtimeMetrics(options: {
+        periodSec: number;
+    }): Promise<MeasurementResults | null>;
+    getMeasurementResults(): Promise<MeasurementResults | null>;
+    getMeasurementResultsHistory(): Promise<MeasurementResultsHistory | null>;
+    getRealtimeHeartbeats(options?: {
+        periodSec?: number;
+    }): Promise<Heartbeat[]>;
+    getFullPpgSignal(): Promise<{
+        value: number[];
+    }>;
+    setRecordingEnabled(options: {
+        enabled: boolean;
+    }): Promise<void>;
+    getRecordingEnabled(): Promise<{
+        value: boolean;
+    }>;
+    getTotalBadSignalSeconds(): Promise<{
+        value: number;
+    }>;
+    getCurrentSignalQualityMetric(): Promise<{
+        value: number;
+    }>;
+    getSignalQualityMapPng(): Promise<{
+        value: number[];
+    }>;
+    getFaceTexturePng(): Promise<{
+        value: number[];
+    }>;
+    getHealthRisksFactors(): Promise<RisksFactors>;
+    getHealthRisks(): Promise<HealthRisks>;
+    computeHealthRisks(options: {
+        risksFactors: RisksFactors;
+    }): Promise<HealthRisks>;
+    getMaximalRisks(options: {
+        risksFactors: RisksFactors;
+    }): Promise<HealthRisks>;
+    getMinimalRisks(options: {
+        risksFactors: RisksFactors;
+    }): Promise<HealthRisks>;
+    getReferenceRisks(options: {
+        risksFactors: RisksFactors;
+    }): Promise<HealthRisks>;
+    openMeasurementResultsPdfInBrowser(): Promise<void>;
+    sendMeasurementResultsPdfToEmail(options: {
+        email: string;
+    }): Promise<void>;
+    requestMeasurementResultsPdfUrl(): Promise<void>;
+    getMeasurementResultsPdfUrl(): Promise<{
+        value: string | null;
+    }>;
+    requestMeasurementResultsPdfBytes(): Promise<void>;
+    getMeasurementResultsPdfBytes(): Promise<{
+        value: number[] | null;
+    }>;
+    getResultAsFhirObservation(): Promise<{
+        value: string | null;
+    }>;
+    sendResultFhirObservation(options: {
+        url: string;
+    }): Promise<{
+        value: string | null;
+    }>;
+}