npm - @capgo/capacitor-health - Versions diffs - 8.6.7 → 8.7.0 - Mend

@capgo/capacitor-health 8.6.7 → 8.7.0

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 (8) hide show

package/README.md +78 -20
package/android/src/main/java/app/capgo/plugin/health/HealthManager.kt +57 -4
package/android/src/main/java/app/capgo/plugin/health/HealthPlugin.kt +21 -6
package/dist/docs.json +29 -1
package/dist/esm/definitions.d.ts +44 -1
package/dist/esm/definitions.js.map +1 -1
package/ios/Sources/HealthPlugin/HealthPlugin.swift +5 -1
package/package.json +1 -1

package/README.md CHANGED Viewed

@@ -231,6 +231,55 @@ await Health.requestAuthorization({
 });
 ```
+### Reading data older than 30 days (Android)
+On Android, Health Connect caps reads to roughly the **last 30 days** unless your app holds the
+`android.permission.health.READ_HEALTH_DATA_HISTORY` permission. To read older history, set
+`requestHistoryAccess: true` on your normal `requestAuthorization()` call. The permission then
+appears in the first-time Health Connect permission sheet alongside your data-type permissions,
+instead of forcing users to grant it manually in Health Connect settings.
+```ts
+const status = await Health.requestAuthorization({
+  read: ['steps', 'heartRate'],
+  write: [],
+  requestHistoryAccess: true,
+});
+// On Android, whether the history permission was granted:
+console.log(status.historyAccessAuthorized); // true | false
+// And whether the provider supports it at all:
+console.log(status.historyAccessAvailable); // true | false
+```
+The result is reported back as the top-level `historyAccessAuthorized` boolean (present only when
+`requestHistoryAccess` was set). The same option works with `checkAuthorization()`.
+The `READ_HEALTH_DATA_HISTORY` permission only exists on sufficiently new Health Connect providers
+(Android 14 extension 13+ or Health Connect APK 171302+). On an older but otherwise supported
+provider the permission can never be granted, so the plugin checks
+[feature availability](https://developer.android.com/health-and-fitness/health-connect/features/availability)
+and **silently skips** the history permission when it is unavailable — your normal read/write scopes
+are still requested as usual. In that case the status reports `historyAccessAvailable: false` (and
+`historyAccessAuthorized: false`), which lets you distinguish "the device can't do this" from "the
+user denied it" and avoid re-prompting. `historyAccessAvailable` is omitted unless
+`requestHistoryAccess` was set, and always omitted on iOS.
+You must **also** declare the permission in your app's `AndroidManifest.xml`:
+```xml
+<uses-permission android:name="android.permission.health.READ_HEALTH_DATA_HISTORY" />
+```
+Health Connect only shows permissions that are both declared in the manifest and passed to the
+permission request, so this declaration is required for `requestHistoryAccess` to take effect. On
+iOS, HealthKit has no equivalent permission and no 30-day read cap, so `requestHistoryAccess` is
+ignored and `historyAccessAuthorized` is omitted from the returned status.
+See Google's documentation on
+[reading historical Health Connect data](https://developer.android.com/health-and-fitness/guides/health-connect/develop/read-data#read-restriction)
+for more details.
 **Pagination example:** Use the `anchor` parameter to paginate through workout results:
 ```ts
@@ -373,6 +422,11 @@ requestAuthorization(options: AuthorizationOptions) => Promise<AuthorizationStat
 Requests read/write access to the provided data types.
+Set `requestHistoryAccess: true` to additionally request Android's
+`READ_HEALTH_DATA_HISTORY` permission in the same Health Connect permission sheet
+(see {@link <a href="#authorizationoptions">AuthorizationOptions.requestHistoryAccess</a>}). The granted/denied status is
+reported back as `historyAccessAuthorized` on the result.
 | Param         | Type                                                                  |
 | ------------- | --------------------------------------------------------------------- |
 | **`options`** | <code><a href="#authorizationoptions">AuthorizationOptions</a></code> |
@@ -531,20 +585,23 @@ Supported on iOS (HealthKit) and Android (Health Connect).
 #### AuthorizationStatus
-| Prop                  | Type                          |
-| --------------------- | ----------------------------- |
-| **`readAuthorized`**  | <code>HealthDataType[]</code> |
-| **`readDenied`**      | <code>HealthDataType[]</code> |
-| **`writeAuthorized`** | <code>HealthDataType[]</code> |
-| **`writeDenied`**     | <code>HealthDataType[]</code> |
+| Prop                          | Type                          | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| ----------------------------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`readAuthorized`**          | <code>HealthDataType[]</code> |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+| **`readDenied`**              | <code>HealthDataType[]</code> |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+| **`writeAuthorized`**         | <code>HealthDataType[]</code> |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+| **`writeDenied`**             | <code>HealthDataType[]</code> |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+| **`historyAccessAuthorized`** | <code>boolean</code>          | Android only: whether the `READ_HEALTH_DATA_HISTORY` permission is granted. Only present when `requestHistoryAccess` was set on the request; omitted otherwise and always omitted on iOS. Always `false` when `historyAccessAvailable` is `false`, since an unsupported provider can never grant the permission.                                                                                                                                                                                                       |
+| **`historyAccessAvailable`**  | <code>boolean</code>          | Android only: whether the connected Health Connect provider supports the `READ_HEALTH_DATA_HISTORY` permission at all. Only present when `requestHistoryAccess` was set on the request; omitted otherwise and always omitted on iOS. `false` means the provider is too old (pre Android 14 extension 13 / Health Connect APK 171302) to ever grant history access — distinct from the user simply denying it. Use it to avoid re-prompting and to message the user that history access is unavailable on their device. |
 #### AuthorizationOptions
-| Prop        | Type                          | Description                                             |
-| ----------- | ----------------------------- | ------------------------------------------------------- |
-| **`read`**  | <code>HealthDataType[]</code> | Data types that should be readable after authorization. |
-| **`write`** | <code>HealthDataType[]</code> | Data types that should be writable after authorization. |
+| Prop                       | Type                          | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| -------------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`read`**                 | <code>HealthDataType[]</code> | Data types that should be readable after authorization.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| **`write`**                | <code>HealthDataType[]</code> | Data types that should be writable after authorization.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| **`requestHistoryAccess`** | <code>boolean</code>          | Android only: also request the `READ_HEALTH_DATA_HISTORY` permission in the same Health Connect permission sheet. Without it, Health Connect caps reads to roughly the last 30 days; granting it lets you read older data. The consuming app must also declare the permission in its `AndroidManifest.xml`: `&lt;uses-permission android:name="android.permission.health.READ_HEALTH_DATA_HISTORY" /&gt;` The permission only exists on sufficiently new Health Connect providers (Android 14 extension 13+ or Health Connect APK 171302+). On older but otherwise supported providers it is silently skipped — the normal read/write scopes are still requested — and the returned status reports `historyAccessAvailable: false`. Ignored on iOS (HealthKit has no equivalent permission and no 30-day read cap). |
 #### ReadSamplesResult
@@ -599,16 +656,17 @@ Stage-level sleep segment emitted for sleep samples when platform data is availa
 #### WriteSampleOptions
-| Prop            | Type                                                            | Description                                                                                                                                                                                       |
-| --------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`dataType`**  | <code><a href="#healthdatatype">HealthDataType</a></code>       |                                                                                                                                                                                                   |
-| **`value`**     | <code>number</code>                                             |                                                                                                                                                                                                   |
-| **`unit`**      | <code><a href="#healthunit">HealthUnit</a></code>               | Optional unit override. If omitted, the default unit for the data type is used (count for `steps`, meter for `distance`, kilocalorie for `calories`, bpm for `heartRate`, kilogram for `weight`). |
-| **`startDate`** | <code>string</code>                                             | ISO 8601 start date for the sample. Defaults to now.                                                                                                                                              |
-| **`endDate`**   | <code>string</code>                                             | ISO 8601 end date for the sample. Defaults to startDate.                                                                                                                                          |
-| **`metadata`**  | <code><a href="#record">Record</a>&lt;string, string&gt;</code> | Metadata key-value pairs forwarded to the native APIs where supported.                                                                                                                            |
-| **`systolic`**  | <code>number</code>                                             | For blood pressure data, the systolic value in mmHg. Required when dataType is 'bloodPressure'.                                                                                                   |
-| **`diastolic`** | <code>number</code>                                             | For blood pressure data, the diastolic value in mmHg. Required when dataType is 'bloodPressure'.                                                                                                  |
+| Prop                         | Type                                                                                         | Description                                                                                                                                                                                       |
+| ---------------------------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`dataType`**               | <code><a href="#healthdatatype">HealthDataType</a></code>                                    |                                                                                                                                                                                                   |
+| **`value`**                  | <code>number</code>                                                                          |                                                                                                                                                                                                   |
+| **`unit`**                   | <code><a href="#healthunit">HealthUnit</a></code>                                            | Optional unit override. If omitted, the default unit for the data type is used (count for `steps`, meter for `distance`, kilocalorie for `calories`, bpm for `heartRate`, kilogram for `weight`). |
+| **`startDate`**              | <code>string</code>                                                                          | ISO 8601 start date for the sample. Defaults to now.                                                                                                                                              |
+| **`endDate`**                | <code>string</code>                                                                          | ISO 8601 end date for the sample. Defaults to startDate.                                                                                                                                          |
+| **`metadata`**               | <code><a href="#record">Record</a>&lt;string, string&gt;</code>                              | Metadata key-value pairs forwarded to the native APIs where supported.                                                                                                                            |
+| **`mindfulnessSessionType`** | <code>'meditation' \| 'unknown' \| 'breathing' \| 'music' \| 'movement' \| 'unguided'</code> | Android mindfulness session type. Defaults to 'meditation' when dataType is 'mindfulness'.                                                                                                        |
+| **`systolic`**               | <code>number</code>                                                                          | For blood pressure data, the systolic value in mmHg. Required when dataType is 'bloodPressure'.                                                                                                   |
+| **`diastolic`**              | <code>number</code>                                                                          | For blood pressure data, the diastolic value in mmHg. Required when dataType is 'bloodPressure'.                                                                                                  |
 #### QueryWorkoutsResult

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

@@ -1,6 +1,7 @@
 package app.capgo.plugin.health
 import androidx.health.connect.client.HealthConnectClient
+import androidx.health.connect.client.HealthConnectFeatures
 import androidx.health.connect.client.aggregate.AggregationResult
 import androidx.health.connect.client.feature.ExperimentalMindfulnessSessionApi
 import androidx.health.connect.client.permission.HealthPermission
@@ -56,20 +57,49 @@ class HealthManager {
     private val formatter: DateTimeFormatter = DateTimeFormatter.ISO_INSTANT
-    fun permissionsFor(readTypes: Collection<HealthDataType>, writeTypes: Collection<HealthDataType>, includeWorkouts: Boolean = false): Set<String> = buildSet {
+    /**
+     * Whether the connected Health Connect provider supports the
+     * READ_HEALTH_DATA_HISTORY permission. The permission only exists on sufficiently
+     * new providers (Android 14 extension 13+ or Health Connect APK 171302+); on older
+     * but otherwise supported providers it can never be granted, so it must not be added
+     * to a permission request (it would never appear in getGrantedPermissions() and would
+     * leave the request flow permanently unsatisfiable).
+     *
+     * See https://developer.android.com/health-and-fitness/health-connect/features/availability
+     */
+    fun isHistoryAccessAvailable(client: HealthConnectClient): Boolean =
+        client.features.getFeatureStatus(
+            HealthConnectFeatures.FEATURE_READ_HEALTH_DATA_HISTORY
+        ) == HealthConnectFeatures.FEATURE_STATUS_AVAILABLE
+    fun permissionsFor(
+        readTypes: Collection<HealthDataType>,
+        writeTypes: Collection<HealthDataType>,
+        includeWorkouts: Boolean = false,
+        includeHistoryAccess: Boolean = false
+    ): Set<String> = buildSet {
         readTypes.forEach { add(it.readPermission) }
         writeTypes.forEach { add(it.writePermission) }
         // Include workout read permission if explicitly requested
         if (includeWorkouts) {
             add(HealthPermission.getReadPermission(ExerciseSessionRecord::class))
         }
+        // Include history-access permission if explicitly requested so reads can
+        // exceed Health Connect's default 30-day window. Requires the consumer to
+        // declare READ_HEALTH_DATA_HISTORY in their AndroidManifest. Callers must
+        // gate this on isHistoryAccessAvailable(): adding the permission on a provider
+        // that does not support it makes the request flow permanently unsatisfiable.
+        if (includeHistoryAccess) {
+            add(READ_HEALTH_DATA_HISTORY_PERMISSION)
+        }
     }
     suspend fun authorizationStatus(
         client: HealthConnectClient,
         readTypes: Collection<HealthDataType>,
         writeTypes: Collection<HealthDataType>,
-        includeWorkouts: Boolean = false
+        includeWorkouts: Boolean = false,
+        includeHistoryAccess: Boolean = false
     ): JSObject {
         val granted = client.permissionController.getGrantedPermissions()
@@ -108,6 +138,18 @@ class HealthManager {
             put("readDenied", readDenied)
             put("writeAuthorized", writeAuthorized)
             put("writeDenied", writeDenied)
+            // Report history-access status as top-level flags, only when it was requested.
+            // historyAccessAvailable distinguishes "the provider is too old to ever grant
+            // this" from "the user denied it"; historyAccessAuthorized is necessarily false
+            // when the feature is unavailable.
+            if (includeHistoryAccess) {
+                val historyAccessAvailable = isHistoryAccessAvailable(client)
+                put("historyAccessAvailable", historyAccessAvailable)
+                put(
+                    "historyAccessAuthorized",
+                    historyAccessAvailable && granted.contains(READ_HEALTH_DATA_HISTORY_PERMISSION)
+                )
+            }
         }
     }
@@ -414,7 +456,8 @@ class HealthManager {
         endTime: Instant,
         metadata: Map<String, String>?,
         systolic: Double?,
-        diastolic: Double?
+        diastolic: Double?,
+        mindfulnessSessionType: String?
     ) {
         val recordMetadata = Metadata.manualEntry()
@@ -635,7 +678,7 @@ class HealthManager {
                     endTime = endTime,
                     endZoneOffset = zoneOffset(endTime),
                     metadata = recordMetadata,
-                    mindfulnessSessionType = MindfulnessSessionRecord.MINDFULNESS_SESSION_TYPE_UNKNOWN
+                    mindfulnessSessionType = mindfulnessSessionType.toMindfulnessSessionType()
                 )
                 client.insertRecords(listOf(record))
             }
@@ -648,6 +691,14 @@ class HealthManager {
         }
         return Instant.parse(value)
     }
+private fun String?.toMindfulnessSessionType(): Int {
+        val normalized = this?.trim()
+        if (normalized.isNullOrEmpty()) {
+            return MindfulnessSessionRecord.MINDFULNESS_SESSION_TYPE_MEDITATION
+        }
+        return MindfulnessSessionRecord.MINDFULNESS_SESSION_TYPE_STRING_TO_INT_MAP[normalized]
+            ?: throw IllegalArgumentException("Unsupported mindfulnessSessionType: $normalized")
+    }
 private fun mapSleepStageToString(stage: Int): String? {
         return when (stage) {
             SleepSessionRecord.STAGE_TYPE_AWAKE -> "awake"
@@ -1035,5 +1086,7 @@ private fun createSamplePayload(
         private const val DEFAULT_PAGE_SIZE = 100
         private const val MAX_PAGE_SIZE = 500
         private const val MAX_AGGREGATE_GROUP_BUCKETS = 5000
+        // Permission that lifts Health Connect's default 30-day read window.
+        private const val READ_HEALTH_DATA_HISTORY_PERMISSION = "android.permission.health.READ_HEALTH_DATA_HISTORY"
     }
 }

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

@@ -35,6 +35,7 @@ class HealthPlugin : Plugin() {
     private var pendingReadTypes: List<HealthDataType> = emptyList()
     private var pendingWriteTypes: List<HealthDataType> = emptyList()
     private var pendingIncludeWorkouts: Boolean = false
+    private var pendingIncludeHistoryAccess: Boolean = false
     override fun handleOnDestroy() {
         super.handleOnDestroy()
@@ -63,19 +64,27 @@ class HealthPlugin : Plugin() {
             return
         }
+        val includeHistoryAccess = call.getBoolean("requestHistoryAccess") ?: false
         pluginScope.launch {
             val client = getClientOrReject(call) ?: return@launch
-            val permissions = manager.permissionsFor(readTypes, writeTypes, includeWorkouts)
+            // Only request the history permission when the provider actually supports it.
+            // On an older-but-supported provider it can never be granted, which would leave
+            // granted.containsAll(permissions) permanently false and reopen the permission
+            // sheet on every call. The normal data scopes are still requested either way;
+            // authorizationStatus reports historyAccessAvailable so callers can react.
+            val requestHistoryAccess = includeHistoryAccess && manager.isHistoryAccessAvailable(client)
+            val permissions = manager.permissionsFor(readTypes, writeTypes, includeWorkouts, requestHistoryAccess)
             if (permissions.isEmpty()) {
-                val status = manager.authorizationStatus(client, readTypes, writeTypes, includeWorkouts)
+                val status = manager.authorizationStatus(client, readTypes, writeTypes, includeWorkouts, includeHistoryAccess)
                 call.resolve(status)
                 return@launch
             }
             val granted = client.permissionController.getGrantedPermissions()
             if (granted.containsAll(permissions)) {
-                val status = manager.authorizationStatus(client, readTypes, writeTypes, includeWorkouts)
+                val status = manager.authorizationStatus(client, readTypes, writeTypes, includeWorkouts, includeHistoryAccess)
                 call.resolve(status)
                 return@launch
             }
@@ -84,6 +93,7 @@ class HealthPlugin : Plugin() {
             pendingReadTypes = readTypes
             pendingWriteTypes = writeTypes
             pendingIncludeWorkouts = includeWorkouts
+            pendingIncludeHistoryAccess = includeHistoryAccess
             // Create intent using the Health Connect permission contract
             val intent = permissionContract.createIntent(context, permissions)
@@ -107,13 +117,15 @@ class HealthPlugin : Plugin() {
         val readTypes = pendingReadTypes
         val writeTypes = pendingWriteTypes
         val includeWorkouts = pendingIncludeWorkouts
+        val includeHistoryAccess = pendingIncludeHistoryAccess
         pendingReadTypes = emptyList()
         pendingWriteTypes = emptyList()
         pendingIncludeWorkouts = false
+        pendingIncludeHistoryAccess = false
         pluginScope.launch {
             val client = getClientOrReject(call) ?: return@launch
-            val status = manager.authorizationStatus(client, readTypes, writeTypes, includeWorkouts)
+            val status = manager.authorizationStatus(client, readTypes, writeTypes, includeWorkouts, includeHistoryAccess)
             call.resolve(status)
         }
     }
@@ -134,9 +146,11 @@ class HealthPlugin : Plugin() {
             return
         }
+        val includeHistoryAccess = call.getBoolean("requestHistoryAccess") ?: false
         pluginScope.launch {
             val client = getClientOrReject(call) ?: return@launch
-            val status = manager.authorizationStatus(client, readTypes, writeTypes, includeWorkouts)
+            val status = manager.authorizationStatus(client, readTypes, writeTypes, includeWorkouts, includeHistoryAccess)
             call.resolve(status)
         }
     }
@@ -250,11 +264,12 @@ class HealthPlugin : Plugin() {
         val systolic = call.getDouble("systolic")
         val diastolic = call.getDouble("diastolic")
+        val mindfulnessSessionType = call.getString("mindfulnessSessionType")
         pluginScope.launch {
             val client = getClientOrReject(call) ?: return@launch
             try {
-                manager.saveSample(client, dataType, value, startInstant, endInstant, metadata, systolic, diastolic)
+                manager.saveSample(client, dataType, value, startInstant, endInstant, metadata, systolic, diastolic, mindfulnessSessionType)
                 call.resolve()
             } catch (e: Exception) {
                 call.reject(e.message ?: "Failed to save sample.", null, e)

package/dist/docs.json CHANGED Viewed

@@ -29,7 +29,7 @@
         ],
         "returns": "Promise<AuthorizationStatus>",
         "tags": [],
-        "docs": "Requests read/write access to the provided data types.",
+        "docs": "Requests read/write access to the provided data types.\n\nSet `requestHistoryAccess: true` to additionally request Android's\n`READ_HEALTH_DATA_HISTORY` permission in the same Health Connect permission sheet\n(see {@link AuthorizationOptions.requestHistoryAccess}). The granted/denied status is\nreported back as `historyAccessAuthorized` on the result.",
         "complexTypes": [
           "AuthorizationStatus",
           "AuthorizationOptions"
@@ -281,6 +281,20 @@
             "HealthDataType"
           ],
           "type": "HealthDataType[]"
+        },
+        {
+          "name": "historyAccessAuthorized",
+          "tags": [],
+          "docs": "Android only: whether the `READ_HEALTH_DATA_HISTORY` permission is granted. Only\npresent when `requestHistoryAccess` was set on the request; omitted otherwise and\nalways omitted on iOS. Always `false` when `historyAccessAvailable` is `false`,\nsince an unsupported provider can never grant the permission.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "historyAccessAvailable",
+          "tags": [],
+          "docs": "Android only: whether the connected Health Connect provider supports the\n`READ_HEALTH_DATA_HISTORY` permission at all. Only present when `requestHistoryAccess`\nwas set on the request; omitted otherwise and always omitted on iOS.\n\n`false` means the provider is too old (pre Android 14 extension 13 / Health Connect APK\n171302) to ever grant history access — distinct from the user simply denying it. Use it\nto avoid re-prompting and to message the user that history access is unavailable on their\ndevice.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
         }
       ]
     },
@@ -308,6 +322,13 @@
             "HealthDataType"
           ],
           "type": "HealthDataType[] | undefined"
+        },
+        {
+          "name": "requestHistoryAccess",
+          "tags": [],
+          "docs": "Android only: also request the `READ_HEALTH_DATA_HISTORY` permission in the same\nHealth Connect permission sheet. Without it, Health Connect caps reads to roughly\nthe last 30 days; granting it lets you read older data.\n\nThe consuming app must also declare the permission in its `AndroidManifest.xml`:\n`<uses-permission android:name=\"android.permission.health.READ_HEALTH_DATA_HISTORY\" />`\n\nThe permission only exists on sufficiently new Health Connect providers (Android 14\nextension 13+ or Health Connect APK 171302+). On older but otherwise supported\nproviders it is silently skipped — the normal read/write scopes are still requested —\nand the returned status reports `historyAccessAvailable: false`.\n\nIgnored on iOS (HealthKit has no equivalent permission and no 30-day read cap).",
+          "complexTypes": [],
+          "type": "boolean | undefined"
         }
       ]
     },
@@ -584,6 +605,13 @@
           ],
           "type": "Record<string, string>"
         },
+        {
+          "name": "mindfulnessSessionType",
+          "tags": [],
+          "docs": "Android mindfulness session type. Defaults to 'meditation' when dataType is 'mindfulness'.",
+          "complexTypes": [],
+          "type": "'meditation' | 'unknown' | 'breathing' | 'music' | 'movement' | 'unguided' | undefined"
+        },
         {
           "name": "systolic",
           "tags": [],

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

@@ -5,12 +5,46 @@ export interface AuthorizationOptions {
     read?: HealthDataType[];
     /** Data types that should be writable after authorization. */
     write?: HealthDataType[];
+    /**
+     * Android only: also request the `READ_HEALTH_DATA_HISTORY` permission in the same
+     * Health Connect permission sheet. Without it, Health Connect caps reads to roughly
+     * the last 30 days; granting it lets you read older data.
+     *
+     * The consuming app must also declare the permission in its `AndroidManifest.xml`:
+     * `<uses-permission android:name="android.permission.health.READ_HEALTH_DATA_HISTORY" />`
+     *
+     * The permission only exists on sufficiently new Health Connect providers (Android 14
+     * extension 13+ or Health Connect APK 171302+). On older but otherwise supported
+     * providers it is silently skipped — the normal read/write scopes are still requested —
+     * and the returned status reports `historyAccessAvailable: false`.
+     *
+     * Ignored on iOS (HealthKit has no equivalent permission and no 30-day read cap).
+     */
+    requestHistoryAccess?: boolean;
 }
 export interface AuthorizationStatus {
     readAuthorized: HealthDataType[];
     readDenied: HealthDataType[];
     writeAuthorized: HealthDataType[];
     writeDenied: HealthDataType[];
+    /**
+     * Android only: whether the `READ_HEALTH_DATA_HISTORY` permission is granted. Only
+     * present when `requestHistoryAccess` was set on the request; omitted otherwise and
+     * always omitted on iOS. Always `false` when `historyAccessAvailable` is `false`,
+     * since an unsupported provider can never grant the permission.
+     */
+    historyAccessAuthorized?: boolean;
+    /**
+     * Android only: whether the connected Health Connect provider supports the
+     * `READ_HEALTH_DATA_HISTORY` permission at all. Only present when `requestHistoryAccess`
+     * was set on the request; omitted otherwise and always omitted on iOS.
+     *
+     * `false` means the provider is too old (pre Android 14 extension 13 / Health Connect APK
+     * 171302) to ever grant history access — distinct from the user simply denying it. Use it
+     * to avoid re-prompting and to message the user that history access is unavailable on their
+     * device.
+     */
+    historyAccessAvailable?: boolean;
 }
 export interface AvailabilityResult {
     available: boolean;
@@ -132,6 +166,8 @@ export interface WriteSampleOptions {
     endDate?: string;
     /** Metadata key-value pairs forwarded to the native APIs where supported. */
     metadata?: Record<string, string>;
+    /** Android mindfulness session type. Defaults to 'meditation' when dataType is 'mindfulness'. */
+    mindfulnessSessionType?: 'unknown' | 'meditation' | 'breathing' | 'music' | 'movement' | 'unguided';
     /** 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'. */
@@ -167,7 +203,14 @@ export interface QueryAggregatedResult {
 export interface HealthPlugin {
     /** Returns whether the current platform supports the native health SDK. */
     isAvailable(): Promise<AvailabilityResult>;
-    /** Requests read/write access to the provided data types. */
+    /**
+     * Requests read/write access to the provided data types.
+     *
+     * Set `requestHistoryAccess: true` to additionally request Android's
+     * `READ_HEALTH_DATA_HISTORY` permission in the same Health Connect permission sheet
+     * (see {@link AuthorizationOptions.requestHistoryAccess}). The granted/denied status is
+     * reported back as `historyAccessAuthorized` on the result.
+     */
     requestAuthorization(options: AuthorizationOptions): Promise<AuthorizationStatus>;
     /** Checks authorization status for the provided data types without prompting the user. */
     checkAuthorization(options: AuthorizationOptions): Promise<AuthorizationStatus>;

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 =\n \| 'steps'\n \| 'distance'\n \| 'calories'\n \| 'heartRate'\n \| 'weight'\n \| 'sleep'\n \| 'respiratoryRate'\n \| 'oxygenSaturation'\n \| 'restingHeartRate'\n \| 'heartRateVariability'\n \| 'vo2Max'\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 \| 'workouts';\n\nexport type HealthUnit =\n \| 'count'\n \| 'meter'\n \| 'kilocalorie'\n \| 'bpm'\n \| 'kilogram'\n \| 'minute'\n \| 'percent'\n \| 'millisecond'\n \| 'mL/min/kg'\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\n/* Stage-level sleep segment emitted for sleep samples when platform data is available. /\nexport interface SleepStage {\n /* Stage segment start date in ISO 8601 format. /\n startDate: string;\n /* Stage segment end date in ISO 8601 format. /\n endDate: string;\n /* Sleep stage label for this segment. /\n stage: SleepState;\n /* Duration of this stage segment in minutes. /\n durationMinutes: number;\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 /* Platform-specific unique identifier (HealthKit UUID on iOS, Health Connect metadata ID on Android). /\n platformId?: string;\n /* For sleep data, indicates the sleep state (e.g., 'asleep', 'awake', 'rem', 'deep', 'light'). /\n sleepState?: SleepState;\n /* For sleep data, individual sleep stages when the platform exposes stage-level data. /\n stages?: SleepStage[];\n /* For sleep data, indicates whether stage-level data was emitted. /\n hasStageData?: boolean;\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 /* For VO2 max data on Android, Health Connect's measurement method enum value. /\n measurementMethod?: number;\n}\n\nexport interface ReadSamplesResult {\n samples: HealthSample[];\n}\n\nexport type WorkoutType =\n // Common types (supported on both platforms)\n \| 'americanFootball'\n \| 'australianFootball'\n \| 'badminton'\n \| 'baseball'\n \| 'basketball'\n \| 'bowling'\n \| 'boxing'\n \| 'climbing'\n \| 'cricket'\n \| 'crossTraining'\n \| 'curling'\n \| 'cycling'\n \| 'dance'\n \| 'elliptical'\n \| 'fencing'\n \| 'functionalStrengthTraining'\n \| 'golf'\n \| 'gymnastics'\n \| 'handball'\n \| 'hiking'\n \| 'hockey'\n \| 'jumpRope'\n \| 'kickboxing'\n \| 'lacrosse'\n \| 'martialArts'\n \| 'pilates'\n \| 'racquetball'\n \| 'rowing'\n \| 'rugby'\n \| 'running'\n \| 'sailing'\n \| 'skatingSports'\n \| 'skiing'\n \| 'snowboarding'\n \| 'soccer'\n \| 'softball'\n \| 'squash'\n \| 'stairClimbing'\n \| 'strengthTraining'\n \| 'surfing'\n \| 'swimming'\n \| 'swimmingPool'\n \| 'swimmingOpenWater'\n \| 'tableTennis'\n \| 'tennis'\n \| 'trackAndField'\n \| 'traditionalStrengthTraining'\n \| 'volleyball'\n \| 'walking'\n \| 'waterFitness'\n \| 'waterPolo'\n \| 'waterSports'\n \| 'weightlifting'\n \| 'wheelchair'\n \| 'yoga'\n // iOS specific types\n \| 'archery'\n \| 'barre'\n \| 'cooldown'\n \| 'coreTraining'\n \| 'crossCountrySkiing'\n \| 'discSports'\n \| 'downhillSkiing'\n \| 'equestrianSports'\n \| 'fishing'\n \| 'fitnessGaming'\n \| 'flexibility'\n \| 'handCycling'\n \| 'highIntensityIntervalTraining'\n \| 'hunting'\n \| 'mindAndBody'\n \| 'mixedCardio'\n \| 'paddleSports'\n \| 'pickleball'\n \| 'play'\n \| 'preparationAndRecovery'\n \| 'snowSports'\n \| 'stairs'\n \| 'stepTraining'\n \| 'surfingSports'\n \| 'taiChi'\n \| 'transition'\n \| 'underwaterDiving'\n \| 'wheelchairRunPace'\n \| 'wheelchairWalkPace'\n \| 'wrestling'\n \| 'cardioDance'\n \| 'socialDance'\n // Android specific types\n \| 'backExtension'\n \| 'barbellShoulderPress'\n \| 'benchPress'\n \| 'benchSitUp'\n \| 'bikingStationary'\n \| 'bootCamp'\n \| 'burpee'\n \| 'calisthenics'\n \| 'crunch'\n \| 'dancing'\n \| 'deadlift'\n \| 'dumbbellCurlLeftArm'\n \| 'dumbbellCurlRightArm'\n \| 'dumbbellFrontRaise'\n \| 'dumbbellLateralRaise'\n \| 'dumbbellTricepsExtensionLeftArm'\n \| 'dumbbellTricepsExtensionRightArm'\n \| 'dumbbellTricepsExtensionTwoArm'\n \| 'exerciseClass'\n \| 'forwardTwist'\n \| 'frisbeedisc'\n \| 'guidedBreathing'\n \| 'iceHockey'\n \| 'iceSkating'\n \| 'jumpingJack'\n \| 'latPullDown'\n \| 'lunge'\n \| 'meditation'\n \| 'paddling'\n \| 'paraGliding'\n \| 'plank'\n \| 'rockClimbing'\n \| 'rollerHockey'\n \| 'rowingMachine'\n \| 'runningTreadmill'\n \| 'scubaDiving'\n \| 'skating'\n \| 'snowshoeing'\n \| 'stairClimbingMachine'\n \| 'stretching'\n \| 'upperTwist'\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 is the ISO 8601 cursor returned by the previous query. On Android, this uses\n * 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 /* Platform-specific unique identifier (HealthKit UUID on iOS, Health Connect metadata ID on Android). /\n platformId?: 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"]}
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 \| 'vo2Max'\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 \| 'workouts';\n\nexport type HealthUnit =\n \| 'count'\n \| 'meter'\n \| 'kilocalorie'\n \| 'bpm'\n \| 'kilogram'\n \| 'minute'\n \| 'percent'\n \| 'millisecond'\n \| 'mL/min/kg'\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 Android only: also request the `READ_HEALTH_DATA_HISTORY` permission in the same\n * Health Connect permission sheet. Without it, Health Connect caps reads to roughly\n * the last 30 days; granting it lets you read older data.\n \n The consuming app must also declare the permission in its `AndroidManifest.xml`:\n * `<uses-permission android:name=\"android.permission.health.READ_HEALTH_DATA_HISTORY\" />`\n \n The permission only exists on sufficiently new Health Connect providers (Android 14\n * extension 13+ or Health Connect APK 171302+). On older but otherwise supported\n * providers it is silently skipped — the normal read/write scopes are still requested —\n * and the returned status reports `historyAccessAvailable: false`.\n \n Ignored on iOS (HealthKit has no equivalent permission and no 30-day read cap).\n /\n requestHistoryAccess?: boolean;\n}\n\nexport interface AuthorizationStatus {\n readAuthorized: HealthDataType[];\n readDenied: HealthDataType[];\n writeAuthorized: HealthDataType[];\n writeDenied: HealthDataType[];\n /\n Android only: whether the `READ_HEALTH_DATA_HISTORY` permission is granted. Only\n * present when `requestHistoryAccess` was set on the request; omitted otherwise and\n * always omitted on iOS. Always `false` when `historyAccessAvailable` is `false`,\n * since an unsupported provider can never grant the permission.\n /\n historyAccessAuthorized?: boolean;\n /\n Android only: whether the connected Health Connect provider supports the\n * `READ_HEALTH_DATA_HISTORY` permission at all. Only present when `requestHistoryAccess`\n * was set on the request; omitted otherwise and always omitted on iOS.\n \n `false` means the provider is too old (pre Android 14 extension 13 / Health Connect APK\n * 171302) to ever grant history access — distinct from the user simply denying it. Use it\n * to avoid re-prompting and to message the user that history access is unavailable on their\n * device.\n /\n historyAccessAvailable?: boolean;\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\n/* Stage-level sleep segment emitted for sleep samples when platform data is available. /\nexport interface SleepStage {\n /* Stage segment start date in ISO 8601 format. /\n startDate: string;\n /* Stage segment end date in ISO 8601 format. /\n endDate: string;\n /* Sleep stage label for this segment. /\n stage: SleepState;\n /* Duration of this stage segment in minutes. /\n durationMinutes: number;\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 /* Platform-specific unique identifier (HealthKit UUID on iOS, Health Connect metadata ID on Android). /\n platformId?: string;\n /* For sleep data, indicates the sleep state (e.g., 'asleep', 'awake', 'rem', 'deep', 'light'). /\n sleepState?: SleepState;\n /* For sleep data, individual sleep stages when the platform exposes stage-level data. /\n stages?: SleepStage[];\n /* For sleep data, indicates whether stage-level data was emitted. /\n hasStageData?: boolean;\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 /* For VO2 max data on Android, Health Connect's measurement method enum value. /\n measurementMethod?: number;\n}\n\nexport interface ReadSamplesResult {\n samples: HealthSample[];\n}\n\nexport type WorkoutType =\n // Common types (supported on both platforms)\n \| 'americanFootball'\n \| 'australianFootball'\n \| 'badminton'\n \| 'baseball'\n \| 'basketball'\n \| 'bowling'\n \| 'boxing'\n \| 'climbing'\n \| 'cricket'\n \| 'crossTraining'\n \| 'curling'\n \| 'cycling'\n \| 'dance'\n \| 'elliptical'\n \| 'fencing'\n \| 'functionalStrengthTraining'\n \| 'golf'\n \| 'gymnastics'\n \| 'handball'\n \| 'hiking'\n \| 'hockey'\n \| 'jumpRope'\n \| 'kickboxing'\n \| 'lacrosse'\n \| 'martialArts'\n \| 'pilates'\n \| 'racquetball'\n \| 'rowing'\n \| 'rugby'\n \| 'running'\n \| 'sailing'\n \| 'skatingSports'\n \| 'skiing'\n \| 'snowboarding'\n \| 'soccer'\n \| 'softball'\n \| 'squash'\n \| 'stairClimbing'\n \| 'strengthTraining'\n \| 'surfing'\n \| 'swimming'\n \| 'swimmingPool'\n \| 'swimmingOpenWater'\n \| 'tableTennis'\n \| 'tennis'\n \| 'trackAndField'\n \| 'traditionalStrengthTraining'\n \| 'volleyball'\n \| 'walking'\n \| 'waterFitness'\n \| 'waterPolo'\n \| 'waterSports'\n \| 'weightlifting'\n \| 'wheelchair'\n \| 'yoga'\n // iOS specific types\n \| 'archery'\n \| 'barre'\n \| 'cooldown'\n \| 'coreTraining'\n \| 'crossCountrySkiing'\n \| 'discSports'\n \| 'downhillSkiing'\n \| 'equestrianSports'\n \| 'fishing'\n \| 'fitnessGaming'\n \| 'flexibility'\n \| 'handCycling'\n \| 'highIntensityIntervalTraining'\n \| 'hunting'\n \| 'mindAndBody'\n \| 'mixedCardio'\n \| 'paddleSports'\n \| 'pickleball'\n \| 'play'\n \| 'preparationAndRecovery'\n \| 'snowSports'\n \| 'stairs'\n \| 'stepTraining'\n \| 'surfingSports'\n \| 'taiChi'\n \| 'transition'\n \| 'underwaterDiving'\n \| 'wheelchairRunPace'\n \| 'wheelchairWalkPace'\n \| 'wrestling'\n \| 'cardioDance'\n \| 'socialDance'\n // Android specific types\n \| 'backExtension'\n \| 'barbellShoulderPress'\n \| 'benchPress'\n \| 'benchSitUp'\n \| 'bikingStationary'\n \| 'bootCamp'\n \| 'burpee'\n \| 'calisthenics'\n \| 'crunch'\n \| 'dancing'\n \| 'deadlift'\n \| 'dumbbellCurlLeftArm'\n \| 'dumbbellCurlRightArm'\n \| 'dumbbellFrontRaise'\n \| 'dumbbellLateralRaise'\n \| 'dumbbellTricepsExtensionLeftArm'\n \| 'dumbbellTricepsExtensionRightArm'\n \| 'dumbbellTricepsExtensionTwoArm'\n \| 'exerciseClass'\n \| 'forwardTwist'\n \| 'frisbeedisc'\n \| 'guidedBreathing'\n \| 'iceHockey'\n \| 'iceSkating'\n \| 'jumpingJack'\n \| 'latPullDown'\n \| 'lunge'\n \| 'meditation'\n \| 'paddling'\n \| 'paraGliding'\n \| 'plank'\n \| 'rockClimbing'\n \| 'rollerHockey'\n \| 'rowingMachine'\n \| 'runningTreadmill'\n \| 'scubaDiving'\n \| 'skating'\n \| 'snowshoeing'\n \| 'stairClimbingMachine'\n \| 'stretching'\n \| 'upperTwist'\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 is the ISO 8601 cursor returned by the previous query. On Android, this uses\n * 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 /* Platform-specific unique identifier (HealthKit UUID on iOS, Health Connect metadata ID on Android). /\n platformId?: 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 /* Android mindfulness session type. Defaults to 'meditation' when dataType is 'mindfulness'. /\n mindfulnessSessionType?: 'unknown' \| 'meditation' \| 'breathing' \| 'music' \| 'movement' \| 'unguided';\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 /\n Requests read/write access to the provided data types.\n \n Set `requestHistoryAccess: true` to additionally request Android's\n * `READ_HEALTH_DATA_HISTORY` permission in the same Health Connect permission sheet\n * (see {@link AuthorizationOptions.requestHistoryAccess}). The granted/denied status is\n * reported back as `historyAccessAuthorized` on the result.\n /\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"]}

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.6.7"
+    private let pluginVersion: String = "8.7.0"
     public let identifier = "HealthPlugin"
     public let jsName = "Health"
     public let pluginMethods: [CAPPluginMethod] = [
@@ -28,6 +28,9 @@ public class HealthPlugin: CAPPlugin, CAPBridgedPlugin {
     @objc func requestAuthorization(_ call: CAPPluginCall) {
         let read = (call.getArray("read") as? [String]) ?? []
         let write = (call.getArray("write") as? [String]) ?? []
+        // `requestHistoryAccess` is Android-only (READ_HEALTH_DATA_HISTORY). HealthKit has no
+        // equivalent permission and no 30-day read cap, so we intentionally ignore it here and
+        // leave `historyAccessAuthorized` out of the returned status.
         implementation.requestAuthorization(readIdentifiers: read, writeIdentifiers: write) { result in
             DispatchQueue.main.async {
@@ -44,6 +47,7 @@ public class HealthPlugin: CAPPlugin, CAPBridgedPlugin {
     @objc func checkAuthorization(_ call: CAPPluginCall) {
         let read = (call.getArray("read") as? [String]) ?? []
         let write = (call.getArray("write") as? [String]) ?? []
+        // `requestHistoryAccess` is Android-only; intentionally ignored on iOS (see requestAuthorization).
         implementation.checkAuthorization(readIdentifiers: read, writeIdentifiers: write) { result in
             DispatchQueue.main.async {

package/package.json CHANGED Viewed

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