Merge pull request #3 from xmartlabs/active-basal-energy

carozo · web-flow · commit 6ad0214732c8 · 2025-08-06T10:37:09.000-03:00
feat: read basal/active energy
diff --git a/README.md b/README.md
@@ -26,6 +26,9 @@ This library supports reading and writing the following health data types:
 - **Resting heart rate** - Resting heart rate measurements
 - **Blood pressure** - Systolic and diastolic blood pressure readings
 - **Oxygen saturation** - Blood oxygen saturation percentage
+- **Active Energy Burned** - The amount of energy expended during a specific activity.
+- **Basal Energy Burned** - The amount of energy expended at rest.
+
 
 ## Usage
 
diff --git a/docs/initializeHealth.md b/docs/initializeHealth.md
@@ -4,7 +4,7 @@ The `initializeHealth` function sets up health integration for the application b
 
 It accepts a `permissions` object with keys `read` and `write`. Use the `HealthLinkPermissions` enum to add permissions to the arrays.
 
-Write method does not support `BloodPressure`, `RestingHeartRate` and `OxygenSaturation`, so I'd recommend not to ask for write permissions for those data types.
+Write method does not support `BloodPressure`, `RestingHeartRate`, `ActiveEnergyBurned`, `BasalEnergyBurned` and `OxygenSaturation`, so I'd recommend not to ask for write permissions for those data types.
 
 ---
 
diff --git a/docs/read.md b/docs/read.md
@@ -27,6 +27,8 @@ RestingHeartRate
 BloodPressure
 OxygenSaturation
 Steps
+ActiveEnergyBurned
+BasalEnergyBurned
 ```
 
 ## **`ReadOptions` Interface**
@@ -77,12 +79,13 @@ The `ReadOptions` interface defines the optional parameters that can be used to
 
 The `Unit` type supports various health-related units:
 
-| **Unit Type**      | **Examples**          |
-| ------------------ | --------------------- |
-| `BloodGlucoseUnit` | `MmolPerL`, `MgPerDL` |
-| `WeightUnit`       | `Kg`, `Lbs`           |
-| `HeightUnit`       | `Cm`, `Inches`        |
-| `HeartRateUnit`    | `BeatsPerMinute`      |
+| **Unit Type**      | **Examples**                       |
+| ------------------ | ---------------------------------- |
+| `BloodGlucoseUnit` | `MmolPerL`, `MgPerDL`              |
+| `WeightUnit`       | `Kg`, `Lbs`                        |
+| `HeightUnit`       | `Cm`, `Inches`                     |
+| `HeartRateUnit`    | `BeatsPerMinute`                   |
+| `EnergyUnit`       | `Calories`, `Joules`, `Kilojoules` |
 
 ---
 
@@ -97,3 +100,23 @@ read(HealthLinkDataType.BloodGlucose, {
   unit: BloodGlucoseUnit.MmolPerL,
 });
 ```
+
+#### Retrieve Active Energy Burned Data
+
+```typescript
+read(HealthLinkDataType.ActiveEnergyBurned, {
+  startDate: '2025-01-01T00:00:00Z',
+  endDate: '2025-01-31T23:59:59Z',
+  unit: EnergyUnit.Calories,
+});
+```
+
+#### Retrieve Basal Energy Burned Data
+
+```typescript
+read(HealthLinkDataType.BasalEnergyBurned, {
+  startDate: '2025-01-01T00:00:00Z',
+  endDate: '2025-01-31T23:59:59Z',
+  unit: EnergyUnit.Calories,
+});
+```
diff --git a/example/android/app/build.gradle b/example/android/app/build.gradle
@@ -116,23 +116,4 @@ dependencies {
     } else {
         implementation jscFlavor
     }
-}
-
-def isNewArchitectureEnabled() {
-  return rootProject.hasProperty("newArchEnabled") && rootProject.getProperty("newArchEnabled") == "true"
-}
-
-if (isNewArchitectureEnabled()) {
-    // Since our library doesn't invoke codegen automatically we need to do it here.
-    tasks.register('invokeLibraryCodegen', Exec) {
-      workingDir "$rootDir/../../"
-      def isWindows = System.getProperty('os.name').toLowerCase().contains('windows')
-
-      if (isWindows) {
-        commandLine 'cmd', '/c', 'npx bob build --target codegen'
-      } else {
-        commandLine 'sh', '-c', 'npx bob build --target codegen'
-      }
-    }
-    preBuild.dependsOn invokeLibraryCodegen
 }
diff --git a/example/android/app/src/main/AndroidManifest.xml b/example/android/app/src/main/AndroidManifest.xml
@@ -17,6 +17,8 @@
     <uses-permission android:name="android.permission.health.WRITE_WEIGHT" />
     <uses-permission android:name="android.permission.health.READ_RESTING_HEART_RATE" />
     <uses-permission android:name="android.permission.health.WRITE_RESTING_HEART_RATE" />
+    <uses-permission android:name="android.permission.health.READ_ACTIVE_CALORIES_BURNED" />
+    <uses-permission android:name="android.permission.health.READ_BASAL_METABOLIC_RATE" />
 
     <application
       android:name=".MainApplication"
diff --git a/example/react-native.config.js b/example/react-native.config.js
@@ -11,10 +11,8 @@ module.exports = {
     [pkg.name]: {
       root: path.join(__dirname, '..'),
       platforms: {
-        // Codegen script incorrectly fails without this
-        // So we explicitly specify the platforms with empty object
-        ios: {},
-        android: {},
+        ios: null,
+        android: null,
       },
     },
   },
diff --git a/example/src/App.tsx b/example/src/App.tsx
@@ -3,7 +3,12 @@ import { useEffect, useState } from 'react';
 import { HealthLinkPermissions } from '../../src/types/permissions';
 import { HealthLinkDataType } from '../../src/types/dataTypes';
 import { initializeHealth, read, write } from 'react-native-health-link';
-import { BloodGlucoseUnit, HeighUnit, WeightUnit } from '../../src/types/units';
+import {
+  BloodGlucoseUnit,
+  EnergyUnit,
+  HeighUnit,
+  WeightUnit,
+} from '../../src/types/units';
 
 export default function App() {
   const [bloodGlucose, setBloodGlucose] = useState<number | undefined>();
@@ -20,6 +25,12 @@ export default function App() {
     number | undefined
   >();
   const [steps, setSteps] = useState<number | undefined>();
+  const [activeEnergyBurned, setActiveEnergyBurned] = useState<
+    number | undefined
+  >();
+  const [basalEnergyBurned, setBasalEnergyBurned] = useState<
+    number | undefined
+  >();
 
   useEffect(() => {
     initializeHealth({
@@ -32,6 +43,8 @@ export default function App() {
         HealthLinkPermissions.BloodPressure,
         HealthLinkPermissions.OxygenSaturation,
         HealthLinkPermissions.Steps,
+        HealthLinkPermissions.ActiveEnergyBurned,
+        HealthLinkPermissions.BasalEnergyBurned,
       ],
       write: [
         HealthLinkPermissions.BloodGlucose,
@@ -85,6 +98,18 @@ export default function App() {
       }).then((data) => {
         setSteps(data[0]?.value);
       });
+      read(HealthLinkDataType.ActiveEnergyBurned, {
+        startDate: new Date('2024-12-30').toISOString(),
+        unit: EnergyUnit.Calories,
+      }).then((data) => {
+        setActiveEnergyBurned(data[0]?.value);
+      });
+      read(HealthLinkDataType.BasalEnergyBurned, {
+        startDate: new Date('2024-12-30').toISOString(),
+        unit: EnergyUnit.Calories,
+      }).then((data) => {
+        setBasalEnergyBurned(data[0]?.value);
+      });
       write(HealthLinkDataType.BloodGlucose, {
         value: 4,
         unit: BloodGlucoseUnit.MmolPerL,
@@ -121,6 +146,8 @@ export default function App() {
       </Text>
       <Text>Your oxygen saturation is {oxygenSaturation}</Text>
       <Text>Your steps today are {steps}</Text>
+      <Text>Your active energy is {activeEnergyBurned}</Text>
+      <Text>Your basal energy is {basalEnergyBurned}</Text>
     </View>
   );
 }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "react-native-health-link",
-  "version": "0.1.4",
+  "version": "0.2.0",
   "description": "A common interface for react-naative-health and react-native-health-connect.",
   "source": "./src/index.tsx",
   "main": "./lib/commonjs/index.js",
diff --git a/react-native.config.js b/react-native.config.js
@@ -4,9 +4,8 @@
 module.exports = {
   dependency: {
     platforms: {
-      android: {
-        cmakeListsPath: 'generated/jni/CMakeLists.txt',
-      },
+      android: null,
+      ios: null,
     },
   },
 };
diff --git a/src/helpers/permissions.ts b/src/helpers/permissions.ts
@@ -80,6 +80,10 @@ const genericToIosMap: { [key: string]: string | string[] } = {
   [HealthLinkPermissions.OxygenSaturation]:
     AppleHealthKit.Constants.Permissions.OxygenSaturation,
   [HealthLinkPermissions.Steps]: AppleHealthKit.Constants.Permissions.Steps,
+  [HealthLinkPermissions.ActiveEnergyBurned]:
+    AppleHealthKit.Constants.Permissions.ActiveEnergyBurned,
+  [HealthLinkPermissions.BasalEnergyBurned]:
+    AppleHealthKit.Constants.Permissions.BasalEnergyBurned,
 };
 
 const genericToAndroidMap: {
@@ -93,4 +97,6 @@ const genericToAndroidMap: {
   [HealthLinkPermissions.BloodPressure]: 'BloodPressure',
   [HealthLinkPermissions.OxygenSaturation]: 'OxygenSaturation',
   [HealthLinkPermissions.Steps]: 'Steps',
+  [HealthLinkPermissions.ActiveEnergyBurned]: 'ActiveCaloriesBurned',
+  [HealthLinkPermissions.BasalEnergyBurned]: 'BasalMetabolicRate',
 };
diff --git a/src/helpers/results.ts b/src/helpers/results.ts
@@ -5,10 +5,18 @@ import {
 } from 'react-native-health-connect';
 
 import type { HealthValue } from 'react-native-health';
-import { HealthLinkDataType, type ReadOptions } from '../types/dataTypes';
+import {
+  HealthLinkDataType,
+  type AndroidRecordType,
+  type AndroidType,
+  type ReadOptions,
+  AndroidRecordTypeMap,
+} from '../types/dataTypes';
 import {
   androidHeightUnitMap,
   androidWeightUnitMap,
+  androidActiveEnergyUnitMap,
+  androidBasalEnergyUnitMap,
   BloodGlucoseUnit,
 } from '../types/units';
 import type { HealthLinkDataValue } from '../types/results';
@@ -135,6 +143,25 @@ export const dataValueDeserializer = <T extends HealthLinkDataType>(
           value: stepsDataValue.count,
         } as HealthLinkDataValue<T>;
       }
+      case HealthLinkDataType.ActiveEnergyBurned: {
+        const activeEnergyDataValue =
+          androidDataValue as RecordResult<'ActiveCaloriesBurned'>;
+        return {
+          ...result,
+          value: androidActiveEnergyUnitMap(
+            activeEnergyDataValue,
+            options.unit
+          ),
+        } as HealthLinkDataValue<T>;
+      }
+      case HealthLinkDataType.BasalEnergyBurned: {
+        const basalEnergyDataValue =
+          androidDataValue as RecordResult<'BasalMetabolicRate'>;
+        return {
+          ...result,
+          value: androidBasalEnergyUnitMap(basalEnergyDataValue, options.unit),
+        } as HealthLinkDataValue<T>;
+      }
       default:
         return result as HealthLinkDataValue<T>;
     }
@@ -145,12 +172,13 @@ export const dataValueDeserializer = <T extends HealthLinkDataType>(
 export const readDataResultDeserializer = <T extends HealthLinkDataType>(
   dataType: T,
   options: ReadOptions,
-  data: ReadRecordsResult<T> | HealthValue[]
+  data: HealthValue[] | ReadRecordsResult<AndroidType>
 ): HealthLinkDataValue<T>[] => {
-  let dataValueArray: RecordResult<T>[] | HealthValue[] =
+  const dataValueArray =
     Platform.OS === 'ios'
       ? (data as HealthValue[])
-      : (data as ReadRecordsResult<T>).records;
+      : (data as { records: RecordResult<AndroidRecordType<T>>[] }).records;
+
   return dataValueArray.reduce((acc, d) => {
     const deserializedValue = dataValueDeserializer(dataType, options, d);
     if (deserializedValue !== null) {
@@ -185,6 +213,14 @@ export const dataValueToIosReadFunction = (dataType: HealthLinkDataType) => {
     OxygenSaturation: AppleHealthKit.getOxygenSaturationSamples,
     BloodPressure: AppleHealthKit.getBloodPressureSamples,
     Steps: AppleHealthKit.getDailyStepCountSamples,
+    ActiveEnergyBurned: AppleHealthKit.getActiveEnergyBurned,
+    BasalEnergyBurned: AppleHealthKit.getBasalEnergyBurned,
   };
   return dataTypeMap[dataType] || (() => {});
 };
+
+export const healthLinkToAndroidType = (
+  dataType: HealthLinkDataType
+): AndroidType => {
+  return AndroidRecordTypeMap[dataType];
+};
diff --git a/src/index.tsx b/src/index.tsx
@@ -15,12 +15,18 @@ import {
   HealthLinkDataType,
   optionsToAndroidOptions,
   type ReadOptions,
+  type AndroidType,
 } from './types/dataTypes';
 import type { HealthValue } from 'react-native-health';
 import { type HealthLinkDataValue } from './types/results';
 import { type WriteDataType, type WriteOptions } from './types/save';
 import { serializeWriteOptions, writeIosCallback } from './helpers/save';
-import { readDataResultDeserializer, readIosCallback } from './helpers/results';
+import {
+  healthLinkToAndroidType,
+  readDataResultDeserializer,
+  readIosCallback,
+} from './helpers/results';
+
 import {
   genericToAndroidPermissions,
   genericToIosPermissions,
@@ -48,9 +54,7 @@ const AppleHealthKit = require('react-native-health');
 export const initializeHealth = async (permissions: HealthPermissions) => {
   if (Platform.OS === 'ios') {
     const iosPermissions = genericToIosPermissions(permissions);
-    AppleHealthKit.initHealthKit(iosPermissions, (error: string) => {
-      console.error(error);
-    });
+    AppleHealthKit.initHealthKit(iosPermissions);
   } else if (Platform.OS === 'android') {
     const androidPermissions = genericToAndroidPermissions(permissions);
     await initialize();
@@ -121,11 +125,14 @@ export const read = async <T extends HealthLinkDataType>(
   dataType: T,
   options: ReadOptions
 ): Promise<Array<HealthLinkDataValue<T>>> => {
-  let data: ReadRecordsResult<T> | HealthValue[] = [];
+  let data: ReadRecordsResult<AndroidType> | HealthValue[] = [];
   if (Platform.OS === 'ios') {
     data = (await readIosCallback(dataType, options)) as HealthValue[];
   } else if (Platform.OS === 'android') {
-    data = await readRecords(dataType, optionsToAndroidOptions(options));
+    data = await readRecords(
+      healthLinkToAndroidType(dataType),
+      optionsToAndroidOptions(options)
+    );
   }
   return readDataResultDeserializer(dataType, options, data);
 };
diff --git a/src/types/dataTypes.ts b/src/types/dataTypes.ts
@@ -12,6 +12,8 @@ import { type ReadRecordsOptions } from 'react-native-health-connect';
  * @property {string} BloodPressure - Represents blood pressure measurement.
  * @property {string} OxygenSaturation - Represents oxygen saturation levels.
  * @property {string} Steps - Represents the number of steps taken.
+ * @property {string} ActiveEnergyBurned - Represents active calories burned through physical activity.
+ * @property {string} BasalEnergyBurned - Represents basal/resting calories burned.
  */
 export enum HealthLinkDataType {
   BloodGlucose = 'BloodGlucose',
@@ -22,6 +24,8 @@ export enum HealthLinkDataType {
   BloodPressure = 'BloodPressure',
   OxygenSaturation = 'OxygenSaturation',
   Steps = 'Steps',
+  ActiveEnergyBurned = 'ActiveEnergyBurned',
+  BasalEnergyBurned = 'BasalEnergyBurned',
 }
 
 export type TimeOperator = 'after' | 'before' | 'between';
@@ -54,3 +58,31 @@ export const optionsToAndroidOptions = (
     pageSize: options.limit,
   };
 };
+
+export type AndroidType =
+  | 'BloodGlucose'
+  | 'Height'
+  | 'Weight'
+  | 'HeartRate'
+  | 'RestingHeartRate'
+  | 'BloodPressure'
+  | 'OxygenSaturation'
+  | 'Steps'
+  | 'ActiveCaloriesBurned'
+  | 'BasalMetabolicRate';
+
+export const AndroidRecordTypeMap: Record<HealthLinkDataType, AndroidType> = {
+  [HealthLinkDataType.BloodGlucose]: 'BloodGlucose',
+  [HealthLinkDataType.Height]: 'Height',
+  [HealthLinkDataType.Weight]: 'Weight',
+  [HealthLinkDataType.HeartRate]: 'HeartRate',
+  [HealthLinkDataType.RestingHeartRate]: 'RestingHeartRate',
+  [HealthLinkDataType.BloodPressure]: 'BloodPressure',
+  [HealthLinkDataType.OxygenSaturation]: 'OxygenSaturation',
+  [HealthLinkDataType.Steps]: 'Steps',
+  [HealthLinkDataType.ActiveEnergyBurned]: 'ActiveCaloriesBurned',
+  [HealthLinkDataType.BasalEnergyBurned]: 'BasalMetabolicRate',
+};
+
+export type AndroidRecordType<T extends HealthLinkDataType> =
+  (typeof AndroidRecordTypeMap)[T];
diff --git a/src/types/permissions.ts b/src/types/permissions.ts
diff --git a/src/types/results.ts b/src/types/results.ts
diff --git a/src/types/save.ts b/src/types/save.ts
diff --git a/src/types/units.ts b/src/types/units.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "react-native-health-link",`
`3`		`- "version": "0.1.4",`
	`3`	`+ "version": "0.2.0",`
`4`	`4`	`"description": "A common interface for react-naative-health and react-native-health-connect.",`
`5`	`5`	`"source": "./src/index.tsx",`
`6`	`6`	`"main": "./lib/commonjs/index.js",`