@flomentumsolutions/capacitor-health-extended 0.0.1

package/CapacitorHealthExtended.podspec

@@ -0,0 +1,17 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapacitorHealthExtended'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['repository']['url']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target  = '13.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+end

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 - Martin Ley1
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/Package.swift

@@ -0,0 +1,28 @@
+// swift-tools-version: 5.9
+import PackageDescription
+
+let package = Package(
+    name: "CapacitorHealth",
+    platforms: [.iOS(.v13)],
+    products: [
+        .library(
+            name: "CapacitorHealth",
+            targets: ["HealthPluginPlugin"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", branch: "main")
+    ],
+    targets: [
+        .target(
+            name: "HealthPluginPlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm")
+            ],
+            path: "ios/Sources/HealthPluginPlugin"),
+        .testTarget(
+            name: "HealthPluginPluginTests",
+            dependencies: ["HealthPluginPlugin"],
+            path: "ios/Tests/HealthPluginPluginTests")
+    ]
+)

package/README.md

@@ -0,0 +1,343 @@
+# capacitor-health
+
+Capacitor plugin to query data from Apple Health and Google Health Connect
+
+## Thanks and attribution
+
+Some parts, concepts and ideas are borrowed from [cordova-plugin-health](https://github.com/dariosalvi78/cordova-plugin-health/). Big thanks to [@dariosalvi78](https://github.com/dariosalvi78) for the support.
+
+## Install
+
+```bash
+npm install capacitor-health-extended
+npx cap sync
+```
+
+## Setup
+
+### iOS
+
+* Make sure your app id has the 'HealthKit' entitlement when this plugin is installed (see iOS dev center).
+* Also, make sure your app and App Store description comply with the Apple review guidelines.
+* There are two keys to be added to the info.plist file: NSHealthShareUsageDescription and NSHealthUpdateUsageDescription. 
+
+### Android
+
+* Android Manifest in root tag right after opening manifest tag
+```xml
+    <!-- Make Health Connect visible to detect installation -->
+    <queries>
+        <package android:name="com.google.android.apps.healthdata" />
+    </queries>
+
+    <!-- Declare permissions you’ll request -->
+    <uses-permission android:name="android.permission.INTERNET" />
+    <uses-permission android:name="android.permission.health.READ_STEPS"/>
+    <uses-permission android:name="android.permission.health.READ_EXERCISE"/>
+    <uses-permission android:name="android.permission.health.READ_WEIGHT" />
+    <uses-permission android:name="android.permission.health.READ_DISTANCE"/>
+    <uses-permission android:name="android.permission.health.READ_ACTIVE_CALORIES_BURNED"/>
+    <uses-permission android:name="android.permission.health.READ_TOTAL_CALORIES_BURNED"/>
+    <uses-permission android:name="android.permission.health.READ_HEART_RATE"/>
+```
+
+
+* Android Manifest in application tag
+```xml
+    <!-- Handle Health Connect rationale (Android 13-) -->
+    <activity
+        android:name=".PermissionsRationaleActivity"
+        android:exported="true">
+        <intent-filter>
+            <action android:name="androidx.health.ACTION_SHOW_PERMISSIONS_RATIONALE"/>
+            <category android:name="android.intent.category.HEALTH_PERMISSIONS"/>
+        </intent-filter>
+    </activity>
+
+    <!-- Handle Android 14+ alias -->
+    <activity-alias
+        android:name="ViewPermissionUsageActivity"
+        android:exported="true"
+        android:targetActivity=".PermissionsRationaleActivity"
+        android:permission="android.permission.START_VIEW_PERMISSION_USAGE">
+        <intent-filter>
+            <action android:name="android.intent.action.VIEW_PERMISSION_USAGE"/>
+            <category android:name="android.intent.category.HEALTH_PERMISSIONS"/>
+        </intent-filter>
+    </activity-alias>
+```
+
+* Android Manifest in application tag for secure WebView content
+```xml
+    <!-- Configure secure WebView and allow HTTPS loading -->
+    <application
+        android:usesCleartextTraffic="false"
+        android:networkSecurityConfig="@xml/network_security_config">
+        ...
+    </application>
+```
+
+* Create `res/xml/network_security_config.xml` with:
+
+```xml
+<?xml version="1.0" encoding="utf-8"?>
+<network-security-config>
+  <base-config cleartextTrafficPermitted="false">
+    <trust-anchors>
+      <certificates src="system"/>
+    </trust-anchors>
+  </base-config>
+</network-security-config>
+```
+
+This setup ensures your WebView will load HTTPS content securely and complies with Android's default network security policy.
+```
+
+## API
+
+<docgen-index>
+
+* [`isHealthAvailable()`](#ishealthavailable)
+* [`checkHealthPermissions(...)`](#checkhealthpermissions)
+* [`requestHealthPermissions(...)`](#requesthealthpermissions)
+* [`openAppleHealthSettings()`](#openapplehealthsettings)
+* [`openHealthConnectSettings()`](#openhealthconnectsettings)
+* [`showHealthConnectInPlayStore()`](#showhealthconnectinplaystore)
+* [`queryAggregated(...)`](#queryaggregated)
+* [`queryWorkouts(...)`](#queryworkouts)
+* [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### isHealthAvailable()
+
+```typescript
+isHealthAvailable() => Promise<{ available: boolean; }>
+```
+
+Checks if health API is available.
+Android: If false is returned, the Google Health Connect app is probably not installed.
+See showHealthConnectInPlayStore()
+
+**Returns:** <code>Promise&lt;{ available: boolean; }&gt;</code>
+
+--------------------
+
+
+### checkHealthPermissions(...)
+
+```typescript
+checkHealthPermissions(permissions: PermissionsRequest) => Promise<PermissionResponse>
+```
+
+Android only: Returns for each given permission, if it was granted by the underlying health API
+
+| Param             | Type                                                              | Description          |
+| ----------------- | ----------------------------------------------------------------- | -------------------- |
+| **`permissions`** | <code><a href="#permissionsrequest">PermissionsRequest</a></code> | permissions to query |
+
+**Returns:** <code>Promise&lt;<a href="#permissionresponse">PermissionResponse</a>&gt;</code>
+
+--------------------
+
+
+### requestHealthPermissions(...)
+
+```typescript
+requestHealthPermissions(permissions: PermissionsRequest) => Promise<PermissionResponse>
+```
+
+Requests the permissions from the user.
+
+Android: Apps can ask only a few times for permissions, after that the user has to grant them manually in
+the Health Connect app. See openHealthConnectSettings()
+
+iOS: If the permissions are already granted or denied, this method will just return without asking the user. In iOS
+we can't really detect if a user granted or denied a permission. The return value reflects the assumption that all
+permissions were granted.
+
+| Param             | Type                                                              | Description            |
+| ----------------- | ----------------------------------------------------------------- | ---------------------- |
+| **`permissions`** | <code><a href="#permissionsrequest">PermissionsRequest</a></code> | permissions to request |
+
+**Returns:** <code>Promise&lt;<a href="#permissionresponse">PermissionResponse</a>&gt;</code>
+
+--------------------
+
+
+### openAppleHealthSettings()
+
+```typescript
+openAppleHealthSettings() => Promise<void>
+```
+
+Opens the apps settings, which is kind of wrong, because health permissions are configured under:
+Settings &gt; Apps &gt; (Apple) Health &gt; Access and Devices &gt; [app-name]
+But we can't go there directly.
+
+--------------------
+
+
+### openHealthConnectSettings()
+
+```typescript
+openHealthConnectSettings() => Promise<void>
+```
+
+Opens the Google Health Connect app
+
+--------------------
+
+
+### showHealthConnectInPlayStore()
+
+```typescript
+showHealthConnectInPlayStore() => Promise<void>
+```
+
+Opens the Google Health Connect app in PlayStore
+
+--------------------
+
+
+### queryAggregated(...)
+
+```typescript
+queryAggregated(request: QueryAggregatedRequest) => Promise<QueryAggregatedResponse>
+```
+
+Query aggregated data
+
+| Param         | Type                                                                      |
+| ------------- | ------------------------------------------------------------------------- |
+| **`request`** | <code><a href="#queryaggregatedrequest">QueryAggregatedRequest</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#queryaggregatedresponse">QueryAggregatedResponse</a>&gt;</code>
+
+--------------------
+
+
+### queryWorkouts(...)
+
+```typescript
+queryWorkouts(request: QueryWorkoutRequest) => Promise<QueryWorkoutResponse>
+```
+
+Query workouts
+
+| Param         | Type                                                                |
+| ------------- | ------------------------------------------------------------------- |
+| **`request`** | <code><a href="#queryworkoutrequest">QueryWorkoutRequest</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#queryworkoutresponse">QueryWorkoutResponse</a>&gt;</code>
+
+--------------------
+
+
+### Interfaces
+
+
+#### PermissionResponse
+
+| Prop              | Type                                       |
+| ----------------- | ------------------------------------------ |
+| **`permissions`** | <code>{ [key: string]: boolean; }[]</code> |
+
+
+#### PermissionsRequest
+
+| Prop              | Type                            |
+| ----------------- | ------------------------------- |
+| **`permissions`** | <code>HealthPermission[]</code> |
+
+
+#### QueryAggregatedResponse
+
+| Prop                 | Type                            |
+| -------------------- | ------------------------------- |
+| **`aggregatedData`** | <code>AggregatedSample[]</code> |
+
+
+#### AggregatedSample
+
+| Prop            | Type                |
+| --------------- | ------------------- |
+| **`startDate`** | <code>string</code> |
+| **`endDate`**   | <code>string</code> |
+| **`value`**     | <code>number</code> |
+
+
+#### QueryAggregatedRequest
+
+| Prop            | Type                               |
+| --------------- | ---------------------------------- |
+| **`startDate`** | <code>string</code>                |
+| **`endDate`**   | <code>string</code>                |
+| **`dataType`**  | <code>'steps' \| 'calories'</code> |
+| **`bucket`**    | <code>string</code>                |
+
+
+#### QueryWorkoutResponse
+
+| Prop           | Type                   |
+| -------------- | ---------------------- |
+| **`workouts`** | <code>Workout[]</code> |
+
+
+#### Workout
+
+| Prop                 | Type                           |
+| -------------------- | ------------------------------ |
+| **`startDate`**      | <code>string</code>            |
+| **`endDate`**        | <code>string</code>            |
+| **`workoutType`**    | <code>string</code>            |
+| **`sourceName`**     | <code>string</code>            |
+| **`id`**             | <code>string</code>            |
+| **`duration`**       | <code>number</code>            |
+| **`distance`**       | <code>number</code>            |
+| **`calories`**       | <code>number</code>            |
+| **`sourceBundleId`** | <code>string</code>            |
+| **`route`**          | <code>RouteSample[]</code>     |
+| **`heartRate`**      | <code>HeartRateSample[]</code> |
+
+
+#### RouteSample
+
+| Prop            | Type                |
+| --------------- | ------------------- |
+| **`timestamp`** | <code>string</code> |
+| **`lat`**       | <code>number</code> |
+| **`lng`**       | <code>number</code> |
+| **`alt`**       | <code>number</code> |
+
+
+#### HeartRateSample
+
+| Prop            | Type                |
+| --------------- | ------------------- |
+| **`timestamp`** | <code>string</code> |
+| **`bpm`**       | <code>number</code> |
+
+
+#### QueryWorkoutRequest
+
+| Prop                   | Type                 |
+| ---------------------- | -------------------- |
+| **`startDate`**        | <code>string</code>  |
+| **`endDate`**          | <code>string</code>  |
+| **`includeHeartRate`** | <code>boolean</code> |
+| **`includeRoute`**     | <code>boolean</code> |
+
+
+### Type Aliases
+
+
+#### HealthPermission
+
+<code>'READ_STEPS' | 'READ_WORKOUTS' | 'READ_CALORIES' | 'READ_DISTANCE' | 'READ_HEART_RATE' | 'READ_ROUTE'</code>
+
+</docgen-api>

package/android/build.gradle

@@ -0,0 +1,70 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.1'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.2.1'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.6.1'
+}
+
+buildscript {
+    ext {
+        kotlin_version = '2.0.20'
+    }
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.10.1'
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+    }
+}
+
+apply plugin: 'com.android.library'
+apply plugin: 'org.jetbrains.kotlin.android'
+
+android {
+    namespace "com.flomentum.health.capacitor"
+    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 36
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 26
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 36
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
+    }
+    kotlinOptions {
+        jvmTarget = '17'
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+
+    implementation 'androidx.health.connect:connect-client:1.1.0-rc02'
+    implementation 'androidx.core:core-ktx:1.13.1'
+
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,3 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.flomentum.health.capacitor">
+
+</manifest>