@capgo/capacitor-health 8.2.17 → 8.3.0

package/android/src/main/java/app/capgo/plugin/health/WorkoutType.kt

@@ -2,6 +2,28 @@ package app.capgo.plugin.health
 
 import androidx.health.connect.client.records.ExerciseSessionRecord
 
+/**
+ * WorkoutType mapper between TypeScript workout types and Android Health Connect exercise types.
+ * 
+ * Note: Due to platform limitations, some TypeScript workout types map to the same Android
+ * exercise type. When reading workouts from Android, these will return the primary/legacy 
+ * workout type to maintain backward compatibility:
+ * 
+ * - highIntensityIntervalTraining, mixedCardio, crossTraining → reads as "crossTraining"
+ * - kickboxing, martialArts, wrestling → reads as "wrestling"
+ * - wheelchairRunPace, wheelchairWalkPace → reads as "wheelchairWalkPace"
+ * - stairs, stairClimbing → reads as "stairClimbing"
+ * - barre, pilates → reads as "pilates"
+ * - cooldown, flexibility, preparationAndRecovery → reads as "flexibility"
+ * - coreTraining, functionalStrengthTraining, strengthTraining, traditionalStrengthTraining → reads as "strengthTraining"
+ * - mindAndBody, taiChi, yoga → reads as "yoga"
+ * - trackAndField, running → reads as "running"
+ * - cardioDance, socialDance, dance → reads as "dance"
+ * - crossCountrySkiing, downhillSkiing → reads as "downhillSkiing"
+ * 
+ * This asymmetric mapping is intentional to support the full iOS workout type set while
+ * maintaining compatibility with Android's more limited exercise type taxonomy.
+ */
 object WorkoutType {
     fun fromString(type: String?): Int? {
         if (type.isNullOrBlank()) return null
@@ -28,6 +50,67 @@ object WorkoutType {
             "waterPolo" -> ExerciseSessionRecord.EXERCISE_TYPE_WATER_POLO
             "waterSports" -> ExerciseSessionRecord.EXERCISE_TYPE_SWIMMING_OPEN_WATER
             "wrestling" -> ExerciseSessionRecord.EXERCISE_TYPE_MARTIAL_ARTS
+            // New comprehensive workout type mappings
+            "archery" -> ExerciseSessionRecord.EXERCISE_TYPE_OTHER_WORKOUT
+            "australianFootball" -> ExerciseSessionRecord.EXERCISE_TYPE_FOOTBALL_AUSTRALIAN
+            "badminton" -> ExerciseSessionRecord.EXERCISE_TYPE_BADMINTON
+            "barre" -> ExerciseSessionRecord.EXERCISE_TYPE_PILATES
+            "bowling" -> ExerciseSessionRecord.EXERCISE_TYPE_OTHER_WORKOUT
+            "boxing" -> ExerciseSessionRecord.EXERCISE_TYPE_BOXING
+            "climbing" -> ExerciseSessionRecord.EXERCISE_TYPE_ROCK_CLIMBING
+            "cooldown" -> ExerciseSessionRecord.EXERCISE_TYPE_STRETCHING
+            "coreTraining" -> ExerciseSessionRecord.EXERCISE_TYPE_STRENGTH_TRAINING
+            "cricket" -> ExerciseSessionRecord.EXERCISE_TYPE_CRICKET
+            "crossCountrySkiing" -> ExerciseSessionRecord.EXERCISE_TYPE_SKIING
+            "curling" -> ExerciseSessionRecord.EXERCISE_TYPE_OTHER_WORKOUT
+            "dance" -> ExerciseSessionRecord.EXERCISE_TYPE_DANCING
+            "discSports" -> ExerciseSessionRecord.EXERCISE_TYPE_FRISBEE_DISC
+            "downhillSkiing" -> ExerciseSessionRecord.EXERCISE_TYPE_SKIING
+            "equestrianSports" -> ExerciseSessionRecord.EXERCISE_TYPE_OTHER_WORKOUT
+            "fencing" -> ExerciseSessionRecord.EXERCISE_TYPE_FENCING
+            "fishing" -> ExerciseSessionRecord.EXERCISE_TYPE_OTHER_WORKOUT
+            "fitnessGaming" -> ExerciseSessionRecord.EXERCISE_TYPE_OTHER_WORKOUT
+            "flexibility" -> ExerciseSessionRecord.EXERCISE_TYPE_STRETCHING
+            "functionalStrengthTraining" -> ExerciseSessionRecord.EXERCISE_TYPE_STRENGTH_TRAINING
+            "golf" -> ExerciseSessionRecord.EXERCISE_TYPE_GOLF
+            "gymnastics" -> ExerciseSessionRecord.EXERCISE_TYPE_GYMNASTICS
+            "handball" -> ExerciseSessionRecord.EXERCISE_TYPE_HANDBALL
+            "handCycling" -> ExerciseSessionRecord.EXERCISE_TYPE_WHEELCHAIR
+            "highIntensityIntervalTraining" -> ExerciseSessionRecord.EXERCISE_TYPE_HIGH_INTENSITY_INTERVAL_TRAINING
+            "hockey" -> ExerciseSessionRecord.EXERCISE_TYPE_ICE_HOCKEY
+            "hunting" -> ExerciseSessionRecord.EXERCISE_TYPE_OTHER_WORKOUT
+            "jumpRope" -> ExerciseSessionRecord.EXERCISE_TYPE_OTHER_WORKOUT
+            "kickboxing" -> ExerciseSessionRecord.EXERCISE_TYPE_MARTIAL_ARTS
+            "lacrosse" -> ExerciseSessionRecord.EXERCISE_TYPE_OTHER_WORKOUT
+            "martialArts" -> ExerciseSessionRecord.EXERCISE_TYPE_MARTIAL_ARTS
+            "mindAndBody" -> ExerciseSessionRecord.EXERCISE_TYPE_YOGA
+            "mixedCardio" -> ExerciseSessionRecord.EXERCISE_TYPE_HIGH_INTENSITY_INTERVAL_TRAINING
+            "paddleSports" -> ExerciseSessionRecord.EXERCISE_TYPE_PADDLING
+            "pickleball" -> ExerciseSessionRecord.EXERCISE_TYPE_OTHER_WORKOUT
+            "pilates" -> ExerciseSessionRecord.EXERCISE_TYPE_PILATES
+            "play" -> ExerciseSessionRecord.EXERCISE_TYPE_OTHER_WORKOUT
+            "preparationAndRecovery" -> ExerciseSessionRecord.EXERCISE_TYPE_STRETCHING
+            "racquetball" -> ExerciseSessionRecord.EXERCISE_TYPE_RACQUETBALL
+            "rugby" -> ExerciseSessionRecord.EXERCISE_TYPE_RUGBY
+            "sailing" -> ExerciseSessionRecord.EXERCISE_TYPE_SAILING
+            "skatingSports" -> ExerciseSessionRecord.EXERCISE_TYPE_SKATING
+            "snowboarding" -> ExerciseSessionRecord.EXERCISE_TYPE_SNOWBOARDING
+            "snowSports" -> ExerciseSessionRecord.EXERCISE_TYPE_SNOWSHOEING
+            "softball" -> ExerciseSessionRecord.EXERCISE_TYPE_SOFTBALL
+            "squash" -> ExerciseSessionRecord.EXERCISE_TYPE_SQUASH
+            "stairs" -> ExerciseSessionRecord.EXERCISE_TYPE_STAIR_CLIMBING
+            "stepTraining" -> ExerciseSessionRecord.EXERCISE_TYPE_STAIR_CLIMBING_MACHINE
+            "surfingSports" -> ExerciseSessionRecord.EXERCISE_TYPE_SURFING
+            "tableTennis" -> ExerciseSessionRecord.EXERCISE_TYPE_TABLE_TENNIS
+            "taiChi" -> ExerciseSessionRecord.EXERCISE_TYPE_YOGA
+            "trackAndField" -> ExerciseSessionRecord.EXERCISE_TYPE_RUNNING
+            "transition" -> ExerciseSessionRecord.EXERCISE_TYPE_OTHER_WORKOUT
+            "underwaterDiving" -> ExerciseSessionRecord.EXERCISE_TYPE_SCUBA_DIVING
+            "volleyball" -> ExerciseSessionRecord.EXERCISE_TYPE_VOLLEYBALL
+            "wheelchairRunPace" -> ExerciseSessionRecord.EXERCISE_TYPE_WHEELCHAIR
+            "wheelchairWalkPace" -> ExerciseSessionRecord.EXERCISE_TYPE_WHEELCHAIR
+            "cardioDance" -> ExerciseSessionRecord.EXERCISE_TYPE_DANCING
+            "socialDance" -> ExerciseSessionRecord.EXERCISE_TYPE_DANCING
             "other" -> ExerciseSessionRecord.EXERCISE_TYPE_OTHER_WORKOUT
             else -> null
         }
@@ -49,14 +132,47 @@ object WorkoutType {
             ExerciseSessionRecord.EXERCISE_TYPE_SOCCER -> "soccer"
             ExerciseSessionRecord.EXERCISE_TYPE_FOOTBALL_AMERICAN -> "americanFootball"
             ExerciseSessionRecord.EXERCISE_TYPE_BASEBALL -> "baseball"
+            // Keep backward compatible mapping for existing types
             ExerciseSessionRecord.EXERCISE_TYPE_HIGH_INTENSITY_INTERVAL_TRAINING -> "crossTraining"
             ExerciseSessionRecord.EXERCISE_TYPE_ELLIPTICAL -> "elliptical"
             ExerciseSessionRecord.EXERCISE_TYPE_ROWING -> "rowing"
             ExerciseSessionRecord.EXERCISE_TYPE_ROWING_MACHINE -> "rowing"
+            // Keep stairClimbing as primary mapping for backward compatibility
             ExerciseSessionRecord.EXERCISE_TYPE_STAIR_CLIMBING -> "stairClimbing"
-            ExerciseSessionRecord.EXERCISE_TYPE_STAIR_CLIMBING_MACHINE -> "stairClimbing"
+            ExerciseSessionRecord.EXERCISE_TYPE_STAIR_CLIMBING_MACHINE -> "stepTraining"
             ExerciseSessionRecord.EXERCISE_TYPE_WATER_POLO -> "waterPolo"
+            // Keep wrestling as primary mapping for backward compatibility
             ExerciseSessionRecord.EXERCISE_TYPE_MARTIAL_ARTS -> "wrestling"
+            // Comprehensive Android to TypeScript workout type mappings
+            ExerciseSessionRecord.EXERCISE_TYPE_FOOTBALL_AUSTRALIAN -> "australianFootball"
+            ExerciseSessionRecord.EXERCISE_TYPE_BADMINTON -> "badminton"
+            ExerciseSessionRecord.EXERCISE_TYPE_PILATES -> "pilates"
+            ExerciseSessionRecord.EXERCISE_TYPE_BOXING -> "boxing"
+            ExerciseSessionRecord.EXERCISE_TYPE_ROCK_CLIMBING -> "climbing"
+            ExerciseSessionRecord.EXERCISE_TYPE_STRETCHING -> "flexibility"
+            ExerciseSessionRecord.EXERCISE_TYPE_CRICKET -> "cricket"
+            ExerciseSessionRecord.EXERCISE_TYPE_SKIING -> "downhillSkiing"
+            ExerciseSessionRecord.EXERCISE_TYPE_DANCING -> "dance"
+            ExerciseSessionRecord.EXERCISE_TYPE_FRISBEE_DISC -> "discSports"
+            ExerciseSessionRecord.EXERCISE_TYPE_FENCING -> "fencing"
+            ExerciseSessionRecord.EXERCISE_TYPE_GOLF -> "golf"
+            ExerciseSessionRecord.EXERCISE_TYPE_GYMNASTICS -> "gymnastics"
+            ExerciseSessionRecord.EXERCISE_TYPE_HANDBALL -> "handball"
+            ExerciseSessionRecord.EXERCISE_TYPE_WHEELCHAIR -> "wheelchairWalkPace"
+            ExerciseSessionRecord.EXERCISE_TYPE_ICE_HOCKEY -> "hockey"
+            ExerciseSessionRecord.EXERCISE_TYPE_PADDLING -> "paddleSports"
+            ExerciseSessionRecord.EXERCISE_TYPE_RACQUETBALL -> "racquetball"
+            ExerciseSessionRecord.EXERCISE_TYPE_RUGBY -> "rugby"
+            ExerciseSessionRecord.EXERCISE_TYPE_SAILING -> "sailing"
+            ExerciseSessionRecord.EXERCISE_TYPE_SKATING -> "skatingSports"
+            ExerciseSessionRecord.EXERCISE_TYPE_SNOWBOARDING -> "snowboarding"
+            ExerciseSessionRecord.EXERCISE_TYPE_SNOWSHOEING -> "snowSports"
+            ExerciseSessionRecord.EXERCISE_TYPE_SOFTBALL -> "softball"
+            ExerciseSessionRecord.EXERCISE_TYPE_SQUASH -> "squash"
+            ExerciseSessionRecord.EXERCISE_TYPE_SURFING -> "surfingSports"
+            ExerciseSessionRecord.EXERCISE_TYPE_TABLE_TENNIS -> "tableTennis"
+            ExerciseSessionRecord.EXERCISE_TYPE_SCUBA_DIVING -> "underwaterDiving"
+            ExerciseSessionRecord.EXERCISE_TYPE_VOLLEYBALL -> "volleyball"
             ExerciseSessionRecord.EXERCISE_TYPE_OTHER_WORKOUT -> "other"
             else -> "other"
         }

package/dist/docs.json

@@ -397,6 +397,20 @@
             "SleepState"
           ],
           "type": "SleepState"
+        },
+        {
+          "name": "systolic",
+          "tags": [],
+          "docs": "For blood pressure data, the systolic value in mmHg.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "diastolic",
+          "tags": [],
+          "docs": "For blood pressure data, the diastolic value in mmHg.",
+          "complexTypes": [],
+          "type": "number | undefined"
         }
       ]
     },
@@ -500,6 +514,20 @@
             "Record"
           ],
           "type": "Record<string, string>"
+        },
+        {
+          "name": "systolic",
+          "tags": [],
+          "docs": "For blood pressure data, the systolic value in mmHg. Required when dataType is 'bloodPressure'.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "diastolic",
+          "tags": [],
+          "docs": "For blood pressure data, the diastolic value in mmHg. Required when dataType is 'bloodPressure'.",
+          "complexTypes": [],
+          "type": "number | undefined"
         }
       ]
     },
@@ -811,6 +839,54 @@
         {
           "text": "'heartRateVariability'",
           "complexTypes": []
+        },
+        {
+          "text": "'bloodPressure'",
+          "complexTypes": []
+        },
+        {
+          "text": "'bloodGlucose'",
+          "complexTypes": []
+        },
+        {
+          "text": "'bodyTemperature'",
+          "complexTypes": []
+        },
+        {
+          "text": "'height'",
+          "complexTypes": []
+        },
+        {
+          "text": "'flightsClimbed'",
+          "complexTypes": []
+        },
+        {
+          "text": "'exerciseTime'",
+          "complexTypes": []
+        },
+        {
+          "text": "'distanceCycling'",
+          "complexTypes": []
+        },
+        {
+          "text": "'bodyFat'",
+          "complexTypes": []
+        },
+        {
+          "text": "'basalBodyTemperature'",
+          "complexTypes": []
+        },
+        {
+          "text": "'basalCalories'",
+          "complexTypes": []
+        },
+        {
+          "text": "'totalCalories'",
+          "complexTypes": []
+        },
+        {
+          "text": "'mindfulness'",
+          "complexTypes": []
         }
       ]
     },
@@ -850,6 +926,26 @@
         {
           "text": "'millisecond'",
           "complexTypes": []
+        },
+        {
+          "text": "'mmHg'",
+          "complexTypes": []
+        },
+        {
+          "text": "'mg/dL'",
+          "complexTypes": []
+        },
+        {
+          "text": "'celsius'",
+          "complexTypes": []
+        },
+        {
+          "text": "'fahrenheit'",
+          "complexTypes": []
+        },
+        {
+          "text": "'centimeter'",
+          "complexTypes": []
         }
       ]
     },
@@ -987,6 +1083,246 @@
           "text": "'wrestling'",
           "complexTypes": []
         },
+        {
+          "text": "'archery'",
+          "complexTypes": []
+        },
+        {
+          "text": "'australianFootball'",
+          "complexTypes": []
+        },
+        {
+          "text": "'badminton'",
+          "complexTypes": []
+        },
+        {
+          "text": "'barre'",
+          "complexTypes": []
+        },
+        {
+          "text": "'bowling'",
+          "complexTypes": []
+        },
+        {
+          "text": "'boxing'",
+          "complexTypes": []
+        },
+        {
+          "text": "'climbing'",
+          "complexTypes": []
+        },
+        {
+          "text": "'cooldown'",
+          "complexTypes": []
+        },
+        {
+          "text": "'coreTraining'",
+          "complexTypes": []
+        },
+        {
+          "text": "'cricket'",
+          "complexTypes": []
+        },
+        {
+          "text": "'crossCountrySkiing'",
+          "complexTypes": []
+        },
+        {
+          "text": "'curling'",
+          "complexTypes": []
+        },
+        {
+          "text": "'dance'",
+          "complexTypes": []
+        },
+        {
+          "text": "'discSports'",
+          "complexTypes": []
+        },
+        {
+          "text": "'downhillSkiing'",
+          "complexTypes": []
+        },
+        {
+          "text": "'equestrianSports'",
+          "complexTypes": []
+        },
+        {
+          "text": "'fencing'",
+          "complexTypes": []
+        },
+        {
+          "text": "'fishing'",
+          "complexTypes": []
+        },
+        {
+          "text": "'fitnessGaming'",
+          "complexTypes": []
+        },
+        {
+          "text": "'flexibility'",
+          "complexTypes": []
+        },
+        {
+          "text": "'functionalStrengthTraining'",
+          "complexTypes": []
+        },
+        {
+          "text": "'golf'",
+          "complexTypes": []
+        },
+        {
+          "text": "'gymnastics'",
+          "complexTypes": []
+        },
+        {
+          "text": "'handball'",
+          "complexTypes": []
+        },
+        {
+          "text": "'handCycling'",
+          "complexTypes": []
+        },
+        {
+          "text": "'highIntensityIntervalTraining'",
+          "complexTypes": []
+        },
+        {
+          "text": "'hockey'",
+          "complexTypes": []
+        },
+        {
+          "text": "'hunting'",
+          "complexTypes": []
+        },
+        {
+          "text": "'jumpRope'",
+          "complexTypes": []
+        },
+        {
+          "text": "'kickboxing'",
+          "complexTypes": []
+        },
+        {
+          "text": "'lacrosse'",
+          "complexTypes": []
+        },
+        {
+          "text": "'martialArts'",
+          "complexTypes": []
+        },
+        {
+          "text": "'mindAndBody'",
+          "complexTypes": []
+        },
+        {
+          "text": "'mixedCardio'",
+          "complexTypes": []
+        },
+        {
+          "text": "'paddleSports'",
+          "complexTypes": []
+        },
+        {
+          "text": "'pickleball'",
+          "complexTypes": []
+        },
+        {
+          "text": "'pilates'",
+          "complexTypes": []
+        },
+        {
+          "text": "'play'",
+          "complexTypes": []
+        },
+        {
+          "text": "'preparationAndRecovery'",
+          "complexTypes": []
+        },
+        {
+          "text": "'racquetball'",
+          "complexTypes": []
+        },
+        {
+          "text": "'rugby'",
+          "complexTypes": []
+        },
+        {
+          "text": "'sailing'",
+          "complexTypes": []
+        },
+        {
+          "text": "'skatingSports'",
+          "complexTypes": []
+        },
+        {
+          "text": "'snowboarding'",
+          "complexTypes": []
+        },
+        {
+          "text": "'snowSports'",
+          "complexTypes": []
+        },
+        {
+          "text": "'softball'",
+          "complexTypes": []
+        },
+        {
+          "text": "'squash'",
+          "complexTypes": []
+        },
+        {
+          "text": "'stairs'",
+          "complexTypes": []
+        },
+        {
+          "text": "'stepTraining'",
+          "complexTypes": []
+        },
+        {
+          "text": "'surfingSports'",
+          "complexTypes": []
+        },
+        {
+          "text": "'tableTennis'",
+          "complexTypes": []
+        },
+        {
+          "text": "'taiChi'",
+          "complexTypes": []
+        },
+        {
+          "text": "'trackAndField'",
+          "complexTypes": []
+        },
+        {
+          "text": "'transition'",
+          "complexTypes": []
+        },
+        {
+          "text": "'underwaterDiving'",
+          "complexTypes": []
+        },
+        {
+          "text": "'volleyball'",
+          "complexTypes": []
+        },
+        {
+          "text": "'wheelchairRunPace'",
+          "complexTypes": []
+        },
+        {
+          "text": "'wheelchairWalkPace'",
+          "complexTypes": []
+        },
+        {
+          "text": "'cardioDance'",
+          "complexTypes": []
+        },
+        {
+          "text": "'socialDance'",
+          "complexTypes": []
+        },
         {
           "text": "'other'",
           "complexTypes": []

package/dist/esm/definitions.d.ts

@@ -1,5 +1,5 @@
-export type HealthDataType = 'steps' | 'distance' | 'calories' | 'heartRate' | 'weight' | 'sleep' | 'respiratoryRate' | 'oxygenSaturation' | 'restingHeartRate' | 'heartRateVariability';
-export type HealthUnit = 'count' | 'meter' | 'kilocalorie' | 'bpm' | 'kilogram' | 'minute' | 'percent' | 'millisecond';
+export type HealthDataType = 'steps' | 'distance' | 'calories' | 'heartRate' | 'weight' | 'sleep' | 'respiratoryRate' | 'oxygenSaturation' | 'restingHeartRate' | 'heartRateVariability' | 'bloodPressure' | 'bloodGlucose' | 'bodyTemperature' | 'height' | 'flightsClimbed' | 'exerciseTime' | 'distanceCycling' | 'bodyFat' | 'basalBodyTemperature' | 'basalCalories' | 'totalCalories' | 'mindfulness';
+export type HealthUnit = 'count' | 'meter' | 'kilocalorie' | 'bpm' | 'kilogram' | 'minute' | 'percent' | 'millisecond' | 'mmHg' | 'mg/dL' | 'celsius' | 'fahrenheit' | 'centimeter';
 export interface AuthorizationOptions {
     /** Data types that should be readable after authorization. */
     read?: HealthDataType[];
@@ -41,11 +41,15 @@ export interface HealthSample {
     sourceId?: string;
     /** For sleep data, indicates the sleep state (e.g., 'asleep', 'awake', 'rem', 'deep', 'light'). */
     sleepState?: SleepState;
+    /** For blood pressure data, the systolic value in mmHg. */
+    systolic?: number;
+    /** For blood pressure data, the diastolic value in mmHg. */
+    diastolic?: number;
 }
 export interface ReadSamplesResult {
     samples: HealthSample[];
 }
-export type WorkoutType = 'running' | 'cycling' | 'walking' | 'swimming' | 'yoga' | 'strengthTraining' | 'hiking' | 'tennis' | 'basketball' | 'soccer' | 'americanFootball' | 'baseball' | 'crossTraining' | 'elliptical' | 'rowing' | 'stairClimbing' | 'traditionalStrengthTraining' | 'waterFitness' | 'waterPolo' | 'waterSports' | 'wrestling' | 'other';
+export type WorkoutType = 'running' | 'cycling' | 'walking' | 'swimming' | 'yoga' | 'strengthTraining' | 'hiking' | 'tennis' | 'basketball' | 'soccer' | 'americanFootball' | 'baseball' | 'crossTraining' | 'elliptical' | 'rowing' | 'stairClimbing' | 'traditionalStrengthTraining' | 'waterFitness' | 'waterPolo' | 'waterSports' | 'wrestling' | 'archery' | 'australianFootball' | 'badminton' | 'barre' | 'bowling' | 'boxing' | 'climbing' | 'cooldown' | 'coreTraining' | 'cricket' | 'crossCountrySkiing' | 'curling' | 'dance' | 'discSports' | 'downhillSkiing' | 'equestrianSports' | 'fencing' | 'fishing' | 'fitnessGaming' | 'flexibility' | 'functionalStrengthTraining' | 'golf' | 'gymnastics' | 'handball' | 'handCycling' | 'highIntensityIntervalTraining' | 'hockey' | 'hunting' | 'jumpRope' | 'kickboxing' | 'lacrosse' | 'martialArts' | 'mindAndBody' | 'mixedCardio' | 'paddleSports' | 'pickleball' | 'pilates' | 'play' | 'preparationAndRecovery' | 'racquetball' | 'rugby' | 'sailing' | 'skatingSports' | 'snowboarding' | 'snowSports' | 'softball' | 'squash' | 'stairs' | 'stepTraining' | 'surfingSports' | 'tableTennis' | 'taiChi' | 'trackAndField' | 'transition' | 'underwaterDiving' | 'volleyball' | 'wheelchairRunPace' | 'wheelchairWalkPace' | 'cardioDance' | 'socialDance' | 'other';
 export interface QueryWorkoutsOptions {
     /** Optional workout type filter. If omitted, all workout types are returned. */
     workoutType?: WorkoutType;
@@ -106,6 +110,10 @@ export interface WriteSampleOptions {
     endDate?: string;
     /** Metadata key-value pairs forwarded to the native APIs where supported. */
     metadata?: Record<string, string>;
+    /** For blood pressure data, the systolic value in mmHg. Required when dataType is 'bloodPressure'. */
+    systolic?: number;
+    /** For blood pressure data, the diastolic value in mmHg. Required when dataType is 'bloodPressure'. */
+    diastolic?: number;
 }
 export type BucketType = 'hour' | 'day' | 'week' | 'month';
 export type AggregationType = 'sum' | 'average' | 'min' | 'max';

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export type HealthDataType =\n  | 'steps'\n  | 'distance'\n  | 'calories'\n  | 'heartRate'\n  | 'weight'\n  | 'sleep'\n  | 'respiratoryRate'\n  | 'oxygenSaturation'\n  | 'restingHeartRate'\n  | 'heartRateVariability';\n\nexport type HealthUnit = 'count' | 'meter' | 'kilocalorie' | 'bpm' | 'kilogram' | 'minute' | 'percent' | 'millisecond';\n\nexport interface AuthorizationOptions {\n  /** Data types that should be readable after authorization. */\n  read?: HealthDataType[];\n  /** Data types that should be writable after authorization. */\n  write?: HealthDataType[];\n}\n\nexport interface AuthorizationStatus {\n  readAuthorized: HealthDataType[];\n  readDenied: HealthDataType[];\n  writeAuthorized: HealthDataType[];\n  writeDenied: HealthDataType[];\n}\n\nexport interface AvailabilityResult {\n  available: boolean;\n  /** Platform specific details (for debugging/diagnostics). */\n  platform?: 'ios' | 'android' | 'web';\n  reason?: string;\n}\n\nexport interface QueryOptions {\n  /** The type of data to retrieve from the health store. */\n  dataType: HealthDataType;\n  /** Inclusive ISO 8601 start date (defaults to now - 1 day). */\n  startDate?: string;\n  /** Exclusive ISO 8601 end date (defaults to now). */\n  endDate?: string;\n  /** Maximum number of samples to return (defaults to 100). */\n  limit?: number;\n  /** Return results sorted ascending by start date (defaults to false). */\n  ascending?: boolean;\n}\n\nexport type SleepState = 'inBed' | 'asleep' | 'awake' | 'rem' | 'deep' | 'light';\n\nexport interface HealthSample {\n  dataType: HealthDataType;\n  value: number;\n  unit: HealthUnit;\n  startDate: string;\n  endDate: string;\n  sourceName?: string;\n  sourceId?: string;\n  /** For sleep data, indicates the sleep state (e.g., 'asleep', 'awake', 'rem', 'deep', 'light'). */\n  sleepState?: SleepState;\n}\n\nexport interface ReadSamplesResult {\n  samples: HealthSample[];\n}\n\nexport type WorkoutType =\n  | 'running'\n  | 'cycling'\n  | 'walking'\n  | 'swimming'\n  | 'yoga'\n  | 'strengthTraining'\n  | 'hiking'\n  | 'tennis'\n  | 'basketball'\n  | 'soccer'\n  | 'americanFootball'\n  | 'baseball'\n  | 'crossTraining'\n  | 'elliptical'\n  | 'rowing'\n  | 'stairClimbing'\n  | 'traditionalStrengthTraining'\n  | 'waterFitness'\n  | 'waterPolo'\n  | 'waterSports'\n  | 'wrestling'\n  | 'other';\n\nexport interface QueryWorkoutsOptions {\n  /** Optional workout type filter. If omitted, all workout types are returned. */\n  workoutType?: WorkoutType;\n  /** Inclusive ISO 8601 start date (defaults to now - 1 day). */\n  startDate?: string;\n  /** Exclusive ISO 8601 end date (defaults to now). */\n  endDate?: string;\n  /** Maximum number of workouts to return (defaults to 100). */\n  limit?: number;\n  /** Return results sorted ascending by start date (defaults to false). */\n  ascending?: boolean;\n  /**\n   * Anchor for pagination. Use the anchor returned from a previous query to continue from that point.\n   * On iOS, this uses HKQueryAnchor. On Android, this uses Health Connect's pageToken.\n   * Omit this parameter to start from the beginning.\n   */\n  anchor?: string;\n}\n\nexport interface Workout {\n  /** The type of workout. */\n  workoutType: WorkoutType;\n  /** Duration of the workout in seconds. */\n  duration: number;\n  /** Total energy burned in kilocalories (if available). */\n  totalEnergyBurned?: number;\n  /** Total distance in meters (if available). */\n  totalDistance?: number;\n  /** ISO 8601 start date of the workout. */\n  startDate: string;\n  /** ISO 8601 end date of the workout. */\n  endDate: string;\n  /** Source name that recorded the workout. */\n  sourceName?: string;\n  /** Source bundle identifier. */\n  sourceId?: string;\n  /** Additional metadata (if available). */\n  metadata?: Record<string, string>;\n}\n\nexport interface QueryWorkoutsResult {\n  workouts: Workout[];\n  /**\n   * Anchor for the next page of results. Pass this value as the anchor parameter in the next query\n   * to continue pagination. If undefined or null, there are no more results.\n   */\n  anchor?: string;\n}\n\nexport interface WriteSampleOptions {\n  dataType: HealthDataType;\n  value: number;\n  /**\n   * Optional unit override. If omitted, the default unit for the data type is used\n   * (count for `steps`, meter for `distance`, kilocalorie for `calories`, bpm for `heartRate`, kilogram for `weight`).\n   */\n  unit?: HealthUnit;\n  /** ISO 8601 start date for the sample. Defaults to now. */\n  startDate?: string;\n  /** ISO 8601 end date for the sample. Defaults to startDate. */\n  endDate?: string;\n  /** Metadata key-value pairs forwarded to the native APIs where supported. */\n  metadata?: Record<string, string>;\n}\n\nexport type BucketType = 'hour' | 'day' | 'week' | 'month';\n\nexport type AggregationType = 'sum' | 'average' | 'min' | 'max';\n\nexport interface QueryAggregatedOptions {\n  /** The type of data to aggregate from the health store. */\n  dataType: HealthDataType;\n  /** Inclusive ISO 8601 start date (defaults to now - 1 day). */\n  startDate?: string;\n  /** Exclusive ISO 8601 end date (defaults to now). */\n  endDate?: string;\n  /** Time bucket for aggregation (defaults to 'day'). */\n  bucket?: BucketType;\n  /** Aggregation operation to perform (defaults to 'sum'). */\n  aggregation?: AggregationType;\n}\n\nexport interface AggregatedSample {\n  /** ISO 8601 start date of the bucket. */\n  startDate: string;\n  /** ISO 8601 end date of the bucket. */\n  endDate: string;\n  /** Aggregated value for the bucket. */\n  value: number;\n  /** Unit of the aggregated value. */\n  unit: HealthUnit;\n}\n\nexport interface QueryAggregatedResult {\n  samples: AggregatedSample[];\n}\n\nexport interface HealthPlugin {\n  /** Returns whether the current platform supports the native health SDK. */\n  isAvailable(): Promise<AvailabilityResult>;\n  /** Requests read/write access to the provided data types. */\n  requestAuthorization(options: AuthorizationOptions): Promise<AuthorizationStatus>;\n  /** Checks authorization status for the provided data types without prompting the user. */\n  checkAuthorization(options: AuthorizationOptions): Promise<AuthorizationStatus>;\n  /** Reads samples for the given data type within the specified time frame. */\n  readSamples(options: QueryOptions): Promise<ReadSamplesResult>;\n  /** Writes a single sample to the native health store. */\n  saveSample(options: WriteSampleOptions): Promise<void>;\n\n  /**\n   * Get the native Capacitor plugin version\n   *\n   * @returns {Promise<{ version: string }>} a Promise with version for this device\n   * @throws An error if something went wrong\n   */\n  getPluginVersion(): Promise<{ version: string }>;\n\n  /**\n   * Opens the Health Connect settings screen (Android only).\n   * On iOS, this method does nothing.\n   *\n   * Use this to direct users to manage their Health Connect permissions\n   * or to install Health Connect if not available.\n   *\n   * @throws An error if Health Connect settings cannot be opened\n   */\n  openHealthConnectSettings(): Promise<void>;\n\n  /**\n   * Shows the app's privacy policy for Health Connect (Android only).\n   * On iOS, this method does nothing.\n   *\n   * This displays the same privacy policy screen that Health Connect shows\n   * when the user taps \"Privacy policy\" in the permissions dialog.\n   *\n   * The privacy policy URL can be configured by adding a string resource\n   * named \"health_connect_privacy_policy_url\" in your app's strings.xml,\n   * or by placing an HTML file at www/privacypolicy.html in your assets.\n   *\n   * @throws An error if the privacy policy cannot be displayed\n   */\n  showPrivacyPolicy(): Promise<void>;\n\n  /**\n   * Queries workout sessions from the native health store.\n   * Supported on iOS (HealthKit) and Android (Health Connect).\n   *\n   * @param options Query options including optional workout type filter, date range, limit, and sort order\n   * @returns A promise that resolves with the workout sessions\n   * @throws An error if something went wrong\n   */\n  queryWorkouts(options: QueryWorkoutsOptions): Promise<QueryWorkoutsResult>;\n\n  /**\n   * Queries aggregated health data from the native health store.\n   * Aggregates data into time buckets (hour, day, week, month) with operations like sum, average, min, or max.\n   * This is more efficient than fetching individual samples for large date ranges.\n   *\n   * Supported on iOS (HealthKit) and Android (Health Connect).\n   *\n   * @param options Query options including data type, date range, bucket size, and aggregation type\n   * @returns A promise that resolves with the aggregated samples\n   * @throws An error if something went wrong\n   */\n  queryAggregated(options: QueryAggregatedOptions): Promise<QueryAggregatedResult>;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export type HealthDataType =\n  | 'steps'\n  | 'distance'\n  | 'calories'\n  | 'heartRate'\n  | 'weight'\n  | 'sleep'\n  | 'respiratoryRate'\n  | 'oxygenSaturation'\n  | 'restingHeartRate'\n  | 'heartRateVariability'\n  | 'bloodPressure'\n  | 'bloodGlucose'\n  | 'bodyTemperature'\n  | 'height'\n  | 'flightsClimbed'\n  | 'exerciseTime'\n  | 'distanceCycling'\n  | 'bodyFat'\n  | 'basalBodyTemperature'\n  | 'basalCalories'\n  | 'totalCalories'\n  | 'mindfulness';\n\nexport type HealthUnit =\n  | 'count'\n  | 'meter'\n  | 'kilocalorie'\n  | 'bpm'\n  | 'kilogram'\n  | 'minute'\n  | 'percent'\n  | 'millisecond'\n  | 'mmHg'\n  | 'mg/dL'\n  | 'celsius'\n  | 'fahrenheit'\n  | 'centimeter';\n\nexport interface AuthorizationOptions {\n  /** Data types that should be readable after authorization. */\n  read?: HealthDataType[];\n  /** Data types that should be writable after authorization. */\n  write?: HealthDataType[];\n}\n\nexport interface AuthorizationStatus {\n  readAuthorized: HealthDataType[];\n  readDenied: HealthDataType[];\n  writeAuthorized: HealthDataType[];\n  writeDenied: HealthDataType[];\n}\n\nexport interface AvailabilityResult {\n  available: boolean;\n  /** Platform specific details (for debugging/diagnostics). */\n  platform?: 'ios' | 'android' | 'web';\n  reason?: string;\n}\n\nexport interface QueryOptions {\n  /** The type of data to retrieve from the health store. */\n  dataType: HealthDataType;\n  /** Inclusive ISO 8601 start date (defaults to now - 1 day). */\n  startDate?: string;\n  /** Exclusive ISO 8601 end date (defaults to now). */\n  endDate?: string;\n  /** Maximum number of samples to return (defaults to 100). */\n  limit?: number;\n  /** Return results sorted ascending by start date (defaults to false). */\n  ascending?: boolean;\n}\n\nexport type SleepState = 'inBed' | 'asleep' | 'awake' | 'rem' | 'deep' | 'light';\n\nexport interface HealthSample {\n  dataType: HealthDataType;\n  value: number;\n  unit: HealthUnit;\n  startDate: string;\n  endDate: string;\n  sourceName?: string;\n  sourceId?: string;\n  /** For sleep data, indicates the sleep state (e.g., 'asleep', 'awake', 'rem', 'deep', 'light'). */\n  sleepState?: SleepState;\n  /** For blood pressure data, the systolic value in mmHg. */\n  systolic?: number;\n  /** For blood pressure data, the diastolic value in mmHg. */\n  diastolic?: number;\n}\n\nexport interface ReadSamplesResult {\n  samples: HealthSample[];\n}\n\nexport type WorkoutType =\n  | 'running'\n  | 'cycling'\n  | 'walking'\n  | 'swimming'\n  | 'yoga'\n  | 'strengthTraining'\n  | 'hiking'\n  | 'tennis'\n  | 'basketball'\n  | 'soccer'\n  | 'americanFootball'\n  | 'baseball'\n  | 'crossTraining'\n  | 'elliptical'\n  | 'rowing'\n  | 'stairClimbing'\n  | 'traditionalStrengthTraining'\n  | 'waterFitness'\n  | 'waterPolo'\n  | 'waterSports'\n  | 'wrestling'\n  | 'archery'\n  | 'australianFootball'\n  | 'badminton'\n  | 'barre'\n  | 'bowling'\n  | 'boxing'\n  | 'climbing'\n  | 'cooldown'\n  | 'coreTraining'\n  | 'cricket'\n  | 'crossCountrySkiing'\n  | 'curling'\n  | 'dance'\n  | 'discSports'\n  | 'downhillSkiing'\n  | 'equestrianSports'\n  | 'fencing'\n  | 'fishing'\n  | 'fitnessGaming'\n  | 'flexibility'\n  | 'functionalStrengthTraining'\n  | 'golf'\n  | 'gymnastics'\n  | 'handball'\n  | 'handCycling'\n  | 'highIntensityIntervalTraining'\n  | 'hockey'\n  | 'hunting'\n  | 'jumpRope'\n  | 'kickboxing'\n  | 'lacrosse'\n  | 'martialArts'\n  | 'mindAndBody'\n  | 'mixedCardio'\n  | 'paddleSports'\n  | 'pickleball'\n  | 'pilates'\n  | 'play'\n  | 'preparationAndRecovery'\n  | 'racquetball'\n  | 'rugby'\n  | 'sailing'\n  | 'skatingSports'\n  | 'snowboarding'\n  | 'snowSports'\n  | 'softball'\n  | 'squash'\n  | 'stairs'\n  | 'stepTraining'\n  | 'surfingSports'\n  | 'tableTennis'\n  | 'taiChi'\n  | 'trackAndField'\n  | 'transition'\n  | 'underwaterDiving'\n  | 'volleyball'\n  | 'wheelchairRunPace'\n  | 'wheelchairWalkPace'\n  | 'cardioDance'\n  | 'socialDance'\n  | 'other';\n\nexport interface QueryWorkoutsOptions {\n  /** Optional workout type filter. If omitted, all workout types are returned. */\n  workoutType?: WorkoutType;\n  /** Inclusive ISO 8601 start date (defaults to now - 1 day). */\n  startDate?: string;\n  /** Exclusive ISO 8601 end date (defaults to now). */\n  endDate?: string;\n  /** Maximum number of workouts to return (defaults to 100). */\n  limit?: number;\n  /** Return results sorted ascending by start date (defaults to false). */\n  ascending?: boolean;\n  /**\n   * Anchor for pagination. Use the anchor returned from a previous query to continue from that point.\n   * On iOS, this uses HKQueryAnchor. On Android, this uses Health Connect's pageToken.\n   * Omit this parameter to start from the beginning.\n   */\n  anchor?: string;\n}\n\nexport interface Workout {\n  /** The type of workout. */\n  workoutType: WorkoutType;\n  /** Duration of the workout in seconds. */\n  duration: number;\n  /** Total energy burned in kilocalories (if available). */\n  totalEnergyBurned?: number;\n  /** Total distance in meters (if available). */\n  totalDistance?: number;\n  /** ISO 8601 start date of the workout. */\n  startDate: string;\n  /** ISO 8601 end date of the workout. */\n  endDate: string;\n  /** Source name that recorded the workout. */\n  sourceName?: string;\n  /** Source bundle identifier. */\n  sourceId?: string;\n  /** Additional metadata (if available). */\n  metadata?: Record<string, string>;\n}\n\nexport interface QueryWorkoutsResult {\n  workouts: Workout[];\n  /**\n   * Anchor for the next page of results. Pass this value as the anchor parameter in the next query\n   * to continue pagination. If undefined or null, there are no more results.\n   */\n  anchor?: string;\n}\n\nexport interface WriteSampleOptions {\n  dataType: HealthDataType;\n  value: number;\n  /**\n   * Optional unit override. If omitted, the default unit for the data type is used\n   * (count for `steps`, meter for `distance`, kilocalorie for `calories`, bpm for `heartRate`, kilogram for `weight`).\n   */\n  unit?: HealthUnit;\n  /** ISO 8601 start date for the sample. Defaults to now. */\n  startDate?: string;\n  /** ISO 8601 end date for the sample. Defaults to startDate. */\n  endDate?: string;\n  /** Metadata key-value pairs forwarded to the native APIs where supported. */\n  metadata?: Record<string, string>;\n  /** For blood pressure data, the systolic value in mmHg. Required when dataType is 'bloodPressure'. */\n  systolic?: number;\n  /** For blood pressure data, the diastolic value in mmHg. Required when dataType is 'bloodPressure'. */\n  diastolic?: number;\n}\n\nexport type BucketType = 'hour' | 'day' | 'week' | 'month';\n\nexport type AggregationType = 'sum' | 'average' | 'min' | 'max';\n\nexport interface QueryAggregatedOptions {\n  /** The type of data to aggregate from the health store. */\n  dataType: HealthDataType;\n  /** Inclusive ISO 8601 start date (defaults to now - 1 day). */\n  startDate?: string;\n  /** Exclusive ISO 8601 end date (defaults to now). */\n  endDate?: string;\n  /** Time bucket for aggregation (defaults to 'day'). */\n  bucket?: BucketType;\n  /** Aggregation operation to perform (defaults to 'sum'). */\n  aggregation?: AggregationType;\n}\n\nexport interface AggregatedSample {\n  /** ISO 8601 start date of the bucket. */\n  startDate: string;\n  /** ISO 8601 end date of the bucket. */\n  endDate: string;\n  /** Aggregated value for the bucket. */\n  value: number;\n  /** Unit of the aggregated value. */\n  unit: HealthUnit;\n}\n\nexport interface QueryAggregatedResult {\n  samples: AggregatedSample[];\n}\n\nexport interface HealthPlugin {\n  /** Returns whether the current platform supports the native health SDK. */\n  isAvailable(): Promise<AvailabilityResult>;\n  /** Requests read/write access to the provided data types. */\n  requestAuthorization(options: AuthorizationOptions): Promise<AuthorizationStatus>;\n  /** Checks authorization status for the provided data types without prompting the user. */\n  checkAuthorization(options: AuthorizationOptions): Promise<AuthorizationStatus>;\n  /** Reads samples for the given data type within the specified time frame. */\n  readSamples(options: QueryOptions): Promise<ReadSamplesResult>;\n  /** Writes a single sample to the native health store. */\n  saveSample(options: WriteSampleOptions): Promise<void>;\n\n  /**\n   * Get the native Capacitor plugin version\n   *\n   * @returns {Promise<{ version: string }>} a Promise with version for this device\n   * @throws An error if something went wrong\n   */\n  getPluginVersion(): Promise<{ version: string }>;\n\n  /**\n   * Opens the Health Connect settings screen (Android only).\n   * On iOS, this method does nothing.\n   *\n   * Use this to direct users to manage their Health Connect permissions\n   * or to install Health Connect if not available.\n   *\n   * @throws An error if Health Connect settings cannot be opened\n   */\n  openHealthConnectSettings(): Promise<void>;\n\n  /**\n   * Shows the app's privacy policy for Health Connect (Android only).\n   * On iOS, this method does nothing.\n   *\n   * This displays the same privacy policy screen that Health Connect shows\n   * when the user taps \"Privacy policy\" in the permissions dialog.\n   *\n   * The privacy policy URL can be configured by adding a string resource\n   * named \"health_connect_privacy_policy_url\" in your app's strings.xml,\n   * or by placing an HTML file at www/privacypolicy.html in your assets.\n   *\n   * @throws An error if the privacy policy cannot be displayed\n   */\n  showPrivacyPolicy(): Promise<void>;\n\n  /**\n   * Queries workout sessions from the native health store.\n   * Supported on iOS (HealthKit) and Android (Health Connect).\n   *\n   * @param options Query options including optional workout type filter, date range, limit, and sort order\n   * @returns A promise that resolves with the workout sessions\n   * @throws An error if something went wrong\n   */\n  queryWorkouts(options: QueryWorkoutsOptions): Promise<QueryWorkoutsResult>;\n\n  /**\n   * Queries aggregated health data from the native health store.\n   * Aggregates data into time buckets (hour, day, week, month) with operations like sum, average, min, or max.\n   * This is more efficient than fetching individual samples for large date ranges.\n   *\n   * Supported on iOS (HealthKit) and Android (Health Connect).\n   *\n   * @param options Query options including data type, date range, bucket size, and aggregation type\n   * @returns A promise that resolves with the aggregated samples\n   * @throws An error if something went wrong\n   */\n  queryAggregated(options: QueryAggregatedOptions): Promise<QueryAggregatedResult>;\n}\n"]}