npm - @capgo/capacitor-health - Versions diffs - 8.2.5 → 8.2.7 - Mend

@capgo/capacitor-health 8.2.5 → 8.2.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

package/README.md +74 -27
package/android/src/main/java/app/capgo/plugin/health/HealthManager.kt +43 -13
package/android/src/main/java/app/capgo/plugin/health/HealthPlugin.kt +2 -2
package/dist/docs.json +14 -0
package/dist/esm/definitions.d.ts +11 -0
package/dist/esm/definitions.js.map +1 -1
package/ios/Sources/HealthPlugin/Health.swift +52 -9
package/ios/Sources/HealthPlugin/HealthPlugin.swift +6 -4
package/package.json +1 -1

package/README.md CHANGED Viewed

@@ -1,9 +1,19 @@
 # @capgo/capacitor-health
- <a href="https://capgo.app/"><img src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/></a>
+<a href="https://capgo.app/">
+  <img
+    src="https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png"
+    alt="Capgo - Instant updates for capacitor"
+  />
+</a>
 <div align="center">
-  <h2><a href="https://capgo.app/?ref=plugin_health"> ➡️ Get Instant updates for your App with Capgo</a></h2>
-  <h2><a href="https://capgo.app/consulting/?ref=plugin_health"> Missing a feature? We’ll build the plugin for you 💪</a></h2>
+  <h2>
+    <a href="https://capgo.app/?ref=plugin_health"> ➡️ Get Instant updates for your App with Capgo</a>
+  </h2>
+  <h2>
+    <a href="https://capgo.app/consulting/?ref=plugin_health"> Missing a feature? We’ll build the plugin for you 💪</a>
+  </h2>
 </div>
 Capacitor plugin to read and write health metrics via Apple HealthKit (iOS) and Health Connect (Android). The TypeScript API keeps the same data types and units across platforms so you can build once and deploy everywhere.
@@ -51,7 +61,7 @@ This plugin now uses [Health Connect](https://developer.android.com/health-and-f
 1. **Min SDK 26+.** Health Connect is only available on Android 8.0 (API 26) and above. The plugin's Gradle setup already targets this level.
 2. **Declare Health permissions.** The plugin manifest ships with the required `<uses-permission>` declarations (`READ_/WRITE_STEPS`, `READ_/WRITE_DISTANCE`, `READ_/WRITE_ACTIVE_CALORIES_BURNED`, `READ_/WRITE_HEART_RATE`, `READ_/WRITE_WEIGHT`). Your app does not need to duplicate them, but you must surface a user-facing rationale because the permissions are considered health sensitive.
-3. **Ensure Health Connect is installed.** Devices on Android 14+ include it by default. For earlier versions the user must install *Health Connect by Android* from the Play Store. The `Health.isAvailable()` helper exposes the current status so you can prompt accordingly.
+3. **Ensure Health Connect is installed.** Devices on Android 14+ include it by default. For earlier versions the user must install _Health Connect by Android_ from the Play Store. The `Health.isAvailable()` helper exposes the current status so you can prompt accordingly.
 4. **Request runtime access.** The plugin opens the Health Connect permission UI when you call `requestAuthorization`. You should still handle denial flows (e.g., show a message if `checkAuthorization` reports missing scopes).
 5. **Provide a Privacy Policy.** Health Connect requires apps to display a privacy policy explaining how health data is used. See the [Privacy Policy Setup](#privacy-policy-setup) section below.
@@ -68,17 +78,17 @@ Place an HTML file at `android/app/src/main/assets/public/privacypolicy.html`:
 ```html
 <!DOCTYPE html>
 <html>
-<head>
-    <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
     <title>Privacy Policy</title>
-</head>
-<body>
+  </head>
+  <body>
     <h1>Privacy Policy</h1>
     <p>Your privacy policy content here...</p>
     <h2>Health Data</h2>
     <p>Explain how you collect, use, and protect health data...</p>
-</body>
+  </body>
 </html>
 ```
@@ -141,16 +151,51 @@ await Health.saveSample({
 ### Supported data types
-| Identifier | Default unit  | Notes |
-| ---------- | ------------- | ----- |
-| `steps`    | `count`       | Step count deltas |
-| `distance` | `meter`       | Walking / running distance |
-| `calories` | `kilocalorie` | Active energy burned |
-| `heartRate`| `bpm`         | Beats per minute |
-| `weight`   | `kilogram`    | Body mass |
+| Identifier  | Default unit  | Notes                                                    |
+| ----------- | ------------- | -------------------------------------------------------- |
+| `steps`     | `count`       | Step count deltas                                        |
+| `distance`  | `meter`       | Walking / running distance                               |
+| `calories`  | `kilocalorie` | Active energy burned                                     |
+| `heartRate` | `bpm`         | Beats per minute                                         |
+| `weight`    | `kilogram`    | Body mass                                                |
+| `workouts`  | N/A           | Workout sessions (read-only, use with `queryWorkouts()`) |
 All write operations expect the default unit shown above. On Android the `metadata` option is currently ignored by Health Connect.
+**Note about workouts:** To query workout data using `queryWorkouts()`, you need to explicitly request `workouts` permission:
+```ts
+await Health.requestAuthorization({
+  read: ['steps', 'workouts'], // Include 'workouts' to access workout sessions
+});
+```
+**Pagination example:** Use the `anchor` parameter to paginate through workout results:
+```ts
+// First page: get the first 10 workouts
+let result = await Health.queryWorkouts({
+  startDate: new Date(Date.now() - 30 * 24 * 60 * 60 * 1000).toISOString(), // Last 30 days
+  endDate: new Date().toISOString(),
+  limit: 10,
+});
+console.log(`Found ${result.workouts.length} workouts`);
+// If there are more results, the anchor will be set
+while (result.anchor) {
+  // Next page: use the anchor to continue from where we left off
+  result = await Health.queryWorkouts({
+    startDate: new Date(Date.now() - 30 * 24 * 60 * 60 * 1000).toISOString(),
+    endDate: new Date().toISOString(),
+    limit: 10,
+    anchor: result.anchor, // Continue from the last result
+  });
+  console.log(`Found ${result.workouts.length} more workouts`);
+}
+```
 ## API
 <docgen-index>
@@ -391,9 +436,10 @@ Supported on iOS (HealthKit) and Android (Health Connect).
 #### QueryWorkoutsResult
-| Prop           | Type                   |
-| -------------- | ---------------------- |
-| **`workouts`** | <code>Workout[]</code> |
+| Prop           | Type                   | Description                                                                                                                                                             |
+| -------------- | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`workouts`** | <code>Workout[]</code> |                                                                                                                                                                         |
+| **`anchor`**   | <code>string</code>    | Anchor for the next page of results. Pass this value as the anchor parameter in the next query to continue pagination. If undefined or null, there are no more results. |
 #### Workout
@@ -413,13 +459,14 @@ Supported on iOS (HealthKit) and Android (Health Connect).
 #### QueryWorkoutsOptions
-| Prop              | Type                                                | Description                                                               |
-| ----------------- | --------------------------------------------------- | ------------------------------------------------------------------------- |
-| **`workoutType`** | <code><a href="#workouttype">WorkoutType</a></code> | Optional workout type filter. If omitted, all workout types are returned. |
-| **`startDate`**   | <code>string</code>                                 | Inclusive ISO 8601 start date (defaults to now - 1 day).                  |
-| **`endDate`**     | <code>string</code>                                 | Exclusive ISO 8601 end date (defaults to now).                            |
-| **`limit`**       | <code>number</code>                                 | Maximum number of workouts to return (defaults to 100).                   |
-| **`ascending`**   | <code>boolean</code>                                | Return results sorted ascending by start date (defaults to false).        |
+| Prop              | Type                                                | Description                                                                                                                                                                                                                           |
+| ----------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`workoutType`** | <code><a href="#workouttype">WorkoutType</a></code> | Optional workout type filter. If omitted, all workout types are returned.                                                                                                                                                             |
+| **`startDate`**   | <code>string</code>                                 | Inclusive ISO 8601 start date (defaults to now - 1 day).                                                                                                                                                                              |
+| **`endDate`**     | <code>string</code>                                 | Exclusive ISO 8601 end date (defaults to now).                                                                                                                                                                                        |
+| **`limit`**       | <code>number</code>                                 | Maximum number of workouts to return (defaults to 100).                                                                                                                                                                               |
+| **`ascending`**   | <code>boolean</code>                                | Return results sorted ascending by start date (defaults to false).                                                                                                                                                                    |
+| **`anchor`**      | <code>string</code>                                 | Anchor for pagination. Use the anchor returned from a previous query to continue from that point. On iOS, this uses HKQueryAnchor. On Android, this uses Health Connect's pageToken. Omit this parameter to start from the beginning. |
 ### Type Aliases

package/android/src/main/java/app/capgo/plugin/health/HealthManager.kt CHANGED Viewed

@@ -25,6 +25,7 @@ import java.time.ZoneOffset
 import java.time.format.DateTimeFormatter
 import kotlin.math.min
 import kotlin.collections.buildSet
+import kotlinx.coroutines.CancellationException
 class HealthManager {
@@ -298,11 +299,12 @@ class HealthManager {
         startTime: Instant,
         endTime: Instant,
         limit: Int,
-        ascending: Boolean
-    ): JSArray {
+        ascending: Boolean,
+        anchor: String?
+    ): JSObject {
         val workouts = mutableListOf<Pair<Instant, JSObject>>()
-        var pageToken: String? = null
+        var pageToken: String? = anchor  // Use anchor as initial pageToken (leverages Health Connect's native pagination)
         val pageSize = if (limit > 0) min(limit, MAX_PAGE_SIZE) else DEFAULT_PAGE_SIZE
         var fetched = 0
@@ -341,7 +343,15 @@ class HealthManager {
         val array = JSArray()
         limited.forEach { array.put(it.second) }
-        return array
+        // Return result with workouts and next anchor (pageToken)
+        val result = JSObject()
+        result.put("workouts", array)
+        // Only include anchor if there might be more results
+        if (pageToken != null) {
+            result.put("anchor", pageToken)
+        }
+        return result
     }
     private suspend fun aggregateWorkoutData(
@@ -352,27 +362,42 @@ class HealthManager {
         // Don't filter by dataOrigin - distance might come from different sources
         // than the workout session itself (e.g., fitness tracker vs workout app)
-        // Aggregate distance
-        val distanceAggregate = try {
+        // Aggregate distance and calories in a single request for efficiency
+        var distanceAggregate: Double? = null
+        var caloriesAggregate: Double? = null
+        try {
             val aggregateRequest = AggregateRequest(
-                metrics = setOf(DistanceRecord.DISTANCE_TOTAL),
+                metrics = setOf(
+                    DistanceRecord.DISTANCE_TOTAL,
+                    ActiveCaloriesBurnedRecord.ACTIVE_CALORIES_TOTAL
+                ),
                 timeRangeFilter = timeRange
-                // Removed dataOriginFilter to get distance from all sources during workout time
+                // Removed dataOriginFilter to get data from all sources during workout time
             )
             val result = client.aggregate(aggregateRequest)
-            result[DistanceRecord.DISTANCE_TOTAL]?.inMeters
+            distanceAggregate = result[DistanceRecord.DISTANCE_TOTAL]?.inMeters
+            caloriesAggregate = result[ActiveCaloriesBurnedRecord.ACTIVE_CALORIES_TOTAL]?.inKilocalories
+        } catch (e: CancellationException) {
+            // Rethrow cancellation to allow coroutine cancellation to propagate
+            throw e
+        } catch (e: SecurityException) {
+            // Permission not granted for one or both metrics
+            android.util.Log.d("HealthManager", "Permission denied for workout data aggregation: ${e.message}", e)
         } catch (e: Exception) {
-            android.util.Log.d("HealthManager", "Distance aggregation failed for workout: ${e.message}", e)
-            null // Permission might not be granted or no data available
+            // Other errors (e.g., no data available)
+            android.util.Log.d("HealthManager", "Workout data aggregation failed: ${e.message}", e)
         }
         return WorkoutAggregatedData(
-            totalDistance = distanceAggregate
+            totalDistance = distanceAggregate,
+            totalEnergyBurned = caloriesAggregate
         )
     }
     private data class WorkoutAggregatedData(
-        val totalDistance: Double?
+        val totalDistance: Double?,
+        val totalEnergyBurned: Double?
     )
     private fun createWorkoutPayload(session: ExerciseSessionRecord, aggregatedData: WorkoutAggregatedData): JSObject {
@@ -394,6 +419,11 @@ class HealthManager {
             payload.put("totalDistance", distance)
         }
+        // Total energy burned (aggregated from ActiveCaloriesBurnedRecord)
+        aggregatedData.totalEnergyBurned?.let { energy ->
+            payload.put("totalEnergyBurned", energy)
+        }
         // Source information
         val dataOrigin = session.metadata.dataOrigin
         payload.put("sourceId", dataOrigin.packageName)

package/android/src/main/java/app/capgo/plugin/health/HealthPlugin.kt CHANGED Viewed

@@ -353,6 +353,7 @@ class HealthPlugin : Plugin() {
         val workoutType = call.getString("workoutType")
         val limit = (call.getInt("limit") ?: DEFAULT_LIMIT).coerceAtLeast(0)
         val ascending = call.getBoolean("ascending") ?: false
+        val anchor = call.getString("anchor")
         val startInstant = try {
             manager.parseInstant(call.getString("startDate"), Instant.now().minus(DEFAULT_PAST_DURATION))
@@ -376,8 +377,7 @@ class HealthPlugin : Plugin() {
         pluginScope.launch {
             val client = getClientOrReject(call) ?: return@launch
             try {
-                val workouts = manager.queryWorkouts(client, workoutType, startInstant, endInstant, limit, ascending)
-                val result = JSObject().apply { put("workouts", workouts) }
+                val result = manager.queryWorkouts(client, workoutType, startInstant, endInstant, limit, ascending, anchor)
                 call.resolve(result)
             } catch (e: Exception) {
                 call.reject(e.message ?: "Failed to query workouts.", null, e)

package/dist/docs.json CHANGED Viewed

@@ -477,6 +477,13 @@
             "Workout"
           ],
           "type": "Workout[]"
+        },
+        {
+          "name": "anchor",
+          "tags": [],
+          "docs": "Anchor for the next page of results. Pass this value as the anchor parameter in the next query\nto continue pagination. If undefined or null, there are no more results.",
+          "complexTypes": [],
+          "type": "string | undefined"
         }
       ]
     },
@@ -599,6 +606,13 @@
           "docs": "Return results sorted ascending by start date (defaults to false).",
           "complexTypes": [],
           "type": "boolean | undefined"
+        },
+        {
+          "name": "anchor",
+          "tags": [],
+          "docs": "Anchor for pagination. Use the anchor returned from a previous query to continue from that point.\nOn iOS, this uses HKQueryAnchor. On Android, this uses Health Connect's pageToken.\nOmit this parameter to start from the beginning.",
+          "complexTypes": [],
+          "type": "string | undefined"
         }
       ]
     }

package/dist/esm/definitions.d.ts CHANGED Viewed

@@ -54,6 +54,12 @@ export interface QueryWorkoutsOptions {
     limit?: number;
     /** Return results sorted ascending by start date (defaults to false). */
     ascending?: boolean;
+    /**
+     * Anchor for pagination. Use the anchor returned from a previous query to continue from that point.
+     * On iOS, this uses HKQueryAnchor. On Android, this uses Health Connect's pageToken.
+     * Omit this parameter to start from the beginning.
+     */
+    anchor?: string;
 }
 export interface Workout {
     /** The type of workout. */
@@ -77,6 +83,11 @@ export interface Workout {
 }
 export interface QueryWorkoutsResult {
     workouts: Workout[];
+    /**
+     * Anchor for the next page of results. Pass this value as the anchor parameter in the next query
+     * to continue pagination. If undefined or null, there are no more results.
+     */
+    anchor?: string;
 }
 export interface WriteSampleOptions {
     dataType: HealthDataType;

package/dist/esm/definitions.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export type HealthDataType = 'steps' \| 'distance' \| 'calories' \| 'heartRate' \| 'weight';\n\nexport type HealthUnit = 'count' \| 'meter' \| 'kilocalorie' \| 'bpm' \| 'kilogram';\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 interface HealthSample {\n dataType: HealthDataType;\n value: number;\n unit: HealthUnit;\n startDate: string;\n endDate: string;\n sourceName?: string;\n sourceId?: string;\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\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\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 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"]}
1	+ {"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export type HealthDataType = 'steps' \| 'distance' \| 'calories' \| 'heartRate' \| 'weight';\n\nexport type HealthUnit = 'count' \| 'meter' \| 'kilocalorie' \| 'bpm' \| 'kilogram';\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 interface HealthSample {\n dataType: HealthDataType;\n value: number;\n unit: HealthUnit;\n startDate: string;\n endDate: string;\n sourceName?: string;\n sourceId?: string;\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 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"]}

package/ios/Sources/HealthPlugin/Health.swift CHANGED Viewed

@@ -236,6 +236,9 @@ struct AuthorizationStatusPayload {
 final class Health {
     private let healthStore = HKHealthStore()
     private let isoFormatter: ISO8601DateFormatter
+    /// Small time offset (in seconds) added to the last workout's end date to avoid duplicate results in pagination
+    private let paginationOffsetSeconds: TimeInterval = 0.001
     init() {
         let formatter = ISO8601DateFormatter()
@@ -266,10 +269,15 @@ final class Health {
         }
         do {
-            let readTypes = try HealthDataType.parseMany(readIdentifiers)
+            // Separate "workouts" from regular health data types
+            let (readTypes, includeWorkouts) = try parseTypesWithWorkouts(readIdentifiers)
             let writeTypes = try HealthDataType.parseMany(writeIdentifiers)
-            let readObjectTypes = try objectTypes(for: readTypes)
+            var readObjectTypes = try objectTypes(for: readTypes)
+            // Include workout type if explicitly requested
+            if includeWorkouts {
+                readObjectTypes.insert(HKObjectType.workoutType())
+            }
             let writeSampleTypes = try sampleTypes(for: writeTypes)
             healthStore.requestAuthorization(toShare: writeSampleTypes, read: readObjectTypes) { [weak self] success, error in
@@ -295,7 +303,7 @@ final class Health {
     func checkAuthorization(readIdentifiers: [String], writeIdentifiers: [String], completion: @escaping (Result<AuthorizationStatusPayload, Error>) -> Void) {
         do {
-            let readTypes = try HealthDataType.parseMany(readIdentifiers)
+            let (readTypes, _) = try parseTypesWithWorkouts(readIdentifiers)
             let writeTypes = try HealthDataType.parseMany(writeIdentifiers)
             evaluateAuthorizationStatus(readTypes: readTypes, writeTypes: writeTypes) { payload in
@@ -485,6 +493,24 @@ final class Health {
         return type
     }
+    private func parseTypesWithWorkouts(_ identifiers: [String]) throws -> ([HealthDataType], Bool) {
+        var types: [HealthDataType] = []
+        var includeWorkouts = false
+        for identifier in identifiers {
+            if identifier == "workouts" {
+                includeWorkouts = true
+            } else {
+                guard let type = HealthDataType(rawValue: identifier) else {
+                    throw HealthManagerError.invalidDataType(identifier)
+                }
+                types.append(type)
+            }
+        }
+        return (types, includeWorkouts)
+    }
     private func parseDate(_ string: String?, defaultValue: Date) throws -> Date {
         guard let value = string else {
             return defaultValue
@@ -524,8 +550,6 @@ final class Health {
             let type = try dataType.sampleType()
             set.insert(type)
         }
-        // Always include workout type for read access to enable workout queries
-        set.insert(HKObjectType.workoutType())
         return set
     }
@@ -538,7 +562,7 @@ final class Health {
         return set
     }
-    func queryWorkouts(workoutTypeString: String?, startDateString: String?, endDateString: String?, limit: Int?, ascending: Bool, completion: @escaping (Result<[[String: Any]], Error>) -> Void) {
+    func queryWorkouts(workoutTypeString: String?, startDateString: String?, endDateString: String?, limit: Int?, ascending: Bool, anchorString: String?, completion: @escaping (Result<[String: Any], Error>) -> Void) {
         let startDate = (try? parseDate(startDateString, defaultValue: Date().addingTimeInterval(-86400))) ?? Date().addingTimeInterval(-86400)
         let endDate = (try? parseDate(endDateString, defaultValue: Date())) ?? Date()
@@ -547,7 +571,16 @@ final class Health {
             return
         }
-        var predicate = HKQuery.predicateForSamples(withStart: startDate, end: endDate, options: [])
+        // If anchor is provided, use it as the continuation point for pagination.
+        // The anchor is the ISO 8601 date string of the last workout's end date from the previous query.
+        let effectiveStartDate: Date
+        if let anchorString = anchorString, let anchorDate = try? parseDate(anchorString, defaultValue: startDate) {
+            effectiveStartDate = anchorDate
+        } else {
+            effectiveStartDate = startDate
+        }
+        var predicate = HKQuery.predicateForSamples(withStart: effectiveStartDate, end: endDate, options: [])
         // Filter by workout type if specified
         if let workoutTypeString = workoutTypeString, let workoutType = WorkoutType(rawValue: workoutTypeString) {
@@ -573,7 +606,7 @@ final class Health {
             }
             guard let workouts = samples as? [HKWorkout] else {
-                completion(.success([]))
+                completion(.success(["workouts": []]))
                 return
             }
@@ -620,7 +653,17 @@ final class Health {
                 return payload
             }
-            completion(.success(results))
+            // Generate next anchor if we have results and reached the limit
+            var response: [String: Any] = ["workouts": results]
+            if !workouts.isEmpty && workouts.count >= queryLimit {
+                // Use the last workout's end date as the anchor for the next page
+                let lastWorkout = workouts.last!
+                // Add a small offset to avoid getting the same workout again
+                let nextAnchorDate = lastWorkout.endDate.addingTimeInterval(self.paginationOffsetSeconds)
+                response["anchor"] = self.isoFormatter.string(from: nextAnchorDate)
+            }
+            completion(.success(response))
         }
         healthStore.execute(query)

package/ios/Sources/HealthPlugin/HealthPlugin.swift CHANGED Viewed

@@ -3,7 +3,7 @@ import Capacitor
 @objc(HealthPlugin)
 public class HealthPlugin: CAPPlugin, CAPBridgedPlugin {
-    private let pluginVersion: String = "8.2.5"
+    private let pluginVersion: String = "8.2.7"
     public let identifier = "HealthPlugin"
     public let jsName = "Health"
     public let pluginMethods: [CAPPluginMethod] = [
@@ -153,18 +153,20 @@ public class HealthPlugin: CAPPlugin, CAPBridgedPlugin {
         let endDate = call.getString("endDate")
         let limit = call.getInt("limit")
         let ascending = call.getBool("ascending") ?? false
+        let anchor = call.getString("anchor")
         implementation.queryWorkouts(
             workoutTypeString: workoutType,
             startDateString: startDate,
             endDateString: endDate,
             limit: limit,
-            ascending: ascending
+            ascending: ascending,
+            anchorString: anchor
         ) { result in
             DispatchQueue.main.async {
                 switch result {
-                case let .success(workouts):
-                    call.resolve(["workouts": workouts])
+                case let .success(response):
+                    call.resolve(response)
                 case let .failure(error):
                     call.reject(error.localizedDescription, nil, error)
                 }

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-health",
-  "version": "8.2.5",
+  "version": "8.2.7",
   "description": "Capacitor plugin to interact with data from Apple HealthKit and Health Connect",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",