@appeeky/expo-healthkit 0.1.0

package/package.json

@@ -0,0 +1,105 @@
+{
+  "name": "@appeeky/expo-healthkit",
+  "version": "0.1.0",
+  "description": "Apple HealthKit and Android Health Connect for Expo. One identifier-based JavaScript API on iOS and Android.",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./build/index.d.ts",
+      "default": "./build/index.js"
+    },
+    "./app.plugin": "./app.plugin.js",
+    "./app.plugin.js": "./app.plugin.js",
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "node internal/module_scripts/build.js",
+    "clean": "node internal/module_scripts/clean.js",
+    "lint": "eslint src plugin/src",
+    "typecheck": "tsc --noEmit && tsc --noEmit -p plugin",
+    "test": "node internal/module_scripts/test.js",
+    "test:coverage": "node internal/module_scripts/test.js --coverage --watchAll=false",
+    "prepare": "node internal/module_scripts/prepare.js",
+    "prepublishOnly": "node internal/module_scripts/prepare.js",
+    "open:ios": "node internal/module_scripts/open-ios.js",
+    "open:android": "node internal/module_scripts/open-android.js"
+  },
+  "keywords": [
+    "react-native",
+    "expo",
+    "expo-module",
+    "healthkit",
+    "apple-health",
+    "apple-healthkit",
+    "health-connect",
+    "google-health-connect",
+    "ios",
+    "android",
+    "health",
+    "fitness"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/appeeky/expo-healthkit.git"
+  },
+  "bugs": {
+    "url": "https://github.com/appeeky/expo-healthkit/issues"
+  },
+  "author": "Erencan Arica <erencan_arica@hotmail.com> (https://github.com/Eronred)",
+  "license": "SEE LICENSE IN LICENSE",
+  "homepage": "https://github.com/appeeky/expo-healthkit#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.26.0",
+    "@types/jest": "^29.2.1",
+    "@types/react": "~19.1.1",
+    "babel-preset-expo": "~57.0.10",
+    "eslint": "~9.39.4",
+    "eslint-config-universe": "^15.0.3",
+    "expo": "^57.0.19",
+    "jest": "^29.7.0",
+    "prettier": "^3.0.0",
+    "react-native": "0.82.1",
+    "typescript": "^5.9.2"
+  },
+  "jest": {
+    "testEnvironment": "node",
+    "roots": [
+      "<rootDir>/src"
+    ],
+    "moduleFileExtensions": [
+      "ts",
+      "tsx",
+      "js"
+    ],
+    "transform": {
+      "^.+\\.(js|ts|tsx)$": "babel-jest"
+    },
+    "collectCoverageFrom": [
+      "src/identifiers.ts",
+      "src/errors.ts",
+      "src/dates.ts"
+    ],
+    "coverageDirectory": "coverage",
+    "coverageThreshold": {
+      "global": {
+        "branches": 80,
+        "functions": 90,
+        "lines": 90,
+        "statements": 90
+      }
+    }
+  },
+  "peerDependencies": {
+    "expo": ">=53.0.0",
+    "react": "*",
+    "react-native": "*"
+  },
+  "engines": {
+    "node": ">=18.18"
+  }
+}

package/plugin/build/index.d.ts

@@ -0,0 +1,30 @@
+import { ConfigPlugin } from 'expo/config-plugins';
+export interface ExpoHealthKitPluginProps {
+    /**
+     * `NSHealthShareUsageDescription`. Pass `false` to skip writing the key.
+     */
+    healthSharePermission?: string | false;
+    /**
+     * `NSHealthUpdateUsageDescription`. Pass `false` to skip writing the key.
+     */
+    healthUpdatePermission?: string | false;
+    /**
+     * `NSHealthClinicalHealthRecordsShareUsageDescription`. Used when
+     * `isClinicalDataEnabled` is true.
+     */
+    healthClinicalRecordsPermission?: string | false;
+    /**
+     * Adds the HealthKit background-delivery entitlement and `healthkit` UIBackgroundModes.
+     */
+    isBackgroundDeliveryEnabled?: boolean;
+    /**
+     * Adds the `health-records` HealthKit access entitlement and clinical usage string.
+     */
+    isClinicalDataEnabled?: boolean;
+    /**
+     * Privacy policy URL shown from the Health Connect permission rationale screen.
+     */
+    healthConnectPrivacyPolicyUrl?: string;
+}
+declare const _default: ConfigPlugin<void | ExpoHealthKitPluginProps>;
+export default _default;

package/plugin/build/index.js

@@ -0,0 +1,138 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_plugins_1 = require("expo/config-plugins");
+const pkg = require('../../package.json');
+const DEFAULT_SHARE = 'Allow $(PRODUCT_NAME) to read your health data';
+const DEFAULT_UPDATE = 'Allow $(PRODUCT_NAME) to write health data';
+const DEFAULT_CLINICAL = 'Allow $(PRODUCT_NAME) to read your clinical health records';
+const HEALTH_CONNECT_PACKAGE = 'com.google.android.apps.healthdata';
+const PRIVACY_POLICY_META = 'expo.modules.healthkit.HEALTH_CONNECT_PRIVACY_POLICY_URL';
+const HEALTH_CONNECT_MIN_SDK = 26;
+const HEALTH_CONNECT_PERMISSIONS = [
+    'android.permission.health.READ_STEPS',
+    'android.permission.health.WRITE_STEPS',
+    'android.permission.health.READ_DISTANCE',
+    'android.permission.health.WRITE_DISTANCE',
+    'android.permission.health.READ_ACTIVE_CALORIES_BURNED',
+    'android.permission.health.WRITE_ACTIVE_CALORIES_BURNED',
+    'android.permission.health.READ_TOTAL_CALORIES_BURNED',
+    'android.permission.health.WRITE_TOTAL_CALORIES_BURNED',
+    'android.permission.health.READ_FLOORS_CLIMBED',
+    'android.permission.health.WRITE_FLOORS_CLIMBED',
+    'android.permission.health.READ_HEART_RATE',
+    'android.permission.health.WRITE_HEART_RATE',
+    'android.permission.health.READ_RESTING_HEART_RATE',
+    'android.permission.health.WRITE_RESTING_HEART_RATE',
+    'android.permission.health.READ_HEART_RATE_VARIABILITY',
+    'android.permission.health.WRITE_HEART_RATE_VARIABILITY',
+    'android.permission.health.READ_OXYGEN_SATURATION',
+    'android.permission.health.WRITE_OXYGEN_SATURATION',
+    'android.permission.health.READ_RESPIRATORY_RATE',
+    'android.permission.health.WRITE_RESPIRATORY_RATE',
+    'android.permission.health.READ_BODY_TEMPERATURE',
+    'android.permission.health.WRITE_BODY_TEMPERATURE',
+    'android.permission.health.READ_BLOOD_GLUCOSE',
+    'android.permission.health.WRITE_BLOOD_GLUCOSE',
+    'android.permission.health.READ_BLOOD_PRESSURE',
+    'android.permission.health.WRITE_BLOOD_PRESSURE',
+    'android.permission.health.READ_VO2_MAX',
+    'android.permission.health.WRITE_VO2_MAX',
+    'android.permission.health.READ_HEIGHT',
+    'android.permission.health.WRITE_HEIGHT',
+    'android.permission.health.READ_WEIGHT',
+    'android.permission.health.WRITE_WEIGHT',
+    'android.permission.health.READ_BODY_FAT',
+    'android.permission.health.WRITE_BODY_FAT',
+    'android.permission.health.READ_LEAN_BODY_MASS',
+    'android.permission.health.WRITE_LEAN_BODY_MASS',
+    'android.permission.health.READ_SLEEP',
+    'android.permission.health.WRITE_SLEEP',
+    'android.permission.health.READ_EXERCISE',
+    'android.permission.health.WRITE_EXERCISE',
+    'android.permission.health.READ_NUTRITION',
+    'android.permission.health.WRITE_NUTRITION',
+    'android.permission.health.READ_HYDRATION',
+    'android.permission.health.WRITE_HYDRATION',
+    'android.permission.health.READ_WHEELCHAIR_PUSHES',
+    'android.permission.health.WRITE_WHEELCHAIR_PUSHES',
+    'android.permission.health.READ_HEALTH_DATA_HISTORY',
+];
+const withHealthKitEntitlements = (config, props = {}) => {
+    return (0, config_plugins_1.withEntitlementsPlist)(config, (config) => {
+        config.modResults['com.apple.developer.healthkit'] = true;
+        if (props.isBackgroundDeliveryEnabled) {
+            config.modResults['com.apple.developer.healthkit.background-delivery'] = true;
+        }
+        if (props.isClinicalDataEnabled) {
+            config.modResults['com.apple.developer.healthkit.access'] = ['health-records'];
+        }
+        return config;
+    });
+};
+const withHealthKitBackgroundModes = (config, props = {}) => {
+    if (!props.isBackgroundDeliveryEnabled) {
+        return config;
+    }
+    return (0, config_plugins_1.withInfoPlist)(config, (config) => {
+        const modes = new Set(Array.isArray(config.modResults.UIBackgroundModes) ? config.modResults.UIBackgroundModes : []);
+        modes.add('healthkit');
+        config.modResults.UIBackgroundModes = [...modes];
+        return config;
+    });
+};
+const withHealthKitUsageDescriptions = (config, props = {}) => {
+    const defaults = {
+        NSHealthShareUsageDescription: DEFAULT_SHARE,
+        NSHealthUpdateUsageDescription: DEFAULT_UPDATE,
+    };
+    const values = {
+        NSHealthShareUsageDescription: props.healthSharePermission,
+        NSHealthUpdateUsageDescription: props.healthUpdatePermission,
+    };
+    if (props.isClinicalDataEnabled) {
+        defaults.NSHealthClinicalHealthRecordsShareUsageDescription = DEFAULT_CLINICAL;
+        values.NSHealthClinicalHealthRecordsShareUsageDescription =
+            props.healthClinicalRecordsPermission;
+    }
+    return config_plugins_1.IOSConfig.Permissions.createPermissionsPlugin(defaults)(config, values);
+};
+const withHealthConnectMinSdk = (config) => {
+    return (0, config_plugins_1.withGradleProperties)(config, (config) => {
+        const existing = config.modResults.find((item) => item.type === 'property' && item.key === 'android.minSdkVersion');
+        const current = existing && existing.type === 'property' ? Number.parseInt(existing.value, 10) : Number.NaN;
+        if (!Number.isFinite(current) || current < HEALTH_CONNECT_MIN_SDK) {
+            config_plugins_1.AndroidConfig.BuildProperties.updateAndroidBuildProperty(config.modResults, 'android.minSdkVersion', String(HEALTH_CONNECT_MIN_SDK));
+        }
+        return config;
+    });
+};
+const withHealthConnectManifest = (config, props = {}) => {
+    config = config_plugins_1.AndroidConfig.Permissions.withPermissions(config, HEALTH_CONNECT_PERMISSIONS);
+    return (0, config_plugins_1.withAndroidManifest)(config, (config) => {
+        var _a;
+        const manifest = config.modResults.manifest;
+        const queries = (_a = manifest.queries) !== null && _a !== void 0 ? _a : [];
+        const hasHealthConnect = queries.some((query) => { var _a; return (_a = query.package) === null || _a === void 0 ? void 0 : _a.some((item) => item.$['android:name'] === HEALTH_CONNECT_PACKAGE); });
+        if (!hasHealthConnect) {
+            queries.push({
+                package: [{ $: { 'android:name': HEALTH_CONNECT_PACKAGE } }],
+            });
+            manifest.queries = queries;
+        }
+        if (props.healthConnectPrivacyPolicyUrl) {
+            const application = config_plugins_1.AndroidConfig.Manifest.getMainApplicationOrThrow(config.modResults);
+            config_plugins_1.AndroidConfig.Manifest.addMetaDataItemToMainApplication(application, PRIVACY_POLICY_META, props.healthConnectPrivacyPolicyUrl);
+        }
+        return config;
+    });
+};
+const withExpoHealthKit = (config, props) => {
+    const pluginProps = props !== null && props !== void 0 ? props : {};
+    config = withHealthKitEntitlements(config, pluginProps);
+    config = withHealthKitBackgroundModes(config, pluginProps);
+    config = withHealthKitUsageDescriptions(config, pluginProps);
+    config = withHealthConnectMinSdk(config);
+    config = withHealthConnectManifest(config, pluginProps);
+    return config;
+};
+exports.default = (0, config_plugins_1.createRunOncePlugin)(withExpoHealthKit, pkg.name, pkg.version);

package/src/ExpoHealthKitModule.ts

@@ -0,0 +1,116 @@
+import { NativeModule, requireNativeModule } from 'expo';
+
+import { HealthKitError } from './errors';
+
+import type {
+  ExpoHealthKitModuleEvents,
+  NativeActivitySummary,
+  NativeActivitySummaryQueryOptions,
+  NativeAnchoredQueryOptions,
+  NativeAnchoredQueryResult,
+  NativeAudiogramSample,
+  NativeAuthorizationOptions,
+  NativeCategoryQueryOptions,
+  NativeCategorySample,
+  NativeCategorySampleInput,
+  NativeClinicalRecord,
+  NativeClinicalRecordQueryOptions,
+  NativeCorrelation,
+  NativeCorrelationInput,
+  NativeCorrelationQueryOptions,
+  NativeDateRangeQueryOptions,
+  NativeDeleteObjectsOptions,
+  NativeElectrocardiogramQueryOptions,
+  NativeElectrocardiogramSample,
+  NativeHeartbeatSeriesQueryOptions,
+  NativeHeartbeatSeriesSample,
+  NativeQuantityQueryOptions,
+  NativeQuantitySample,
+  NativeQuantitySampleInput,
+  NativeStatistics,
+  NativeStatisticsCollectionQueryOptions,
+  NativeStatisticsQueryOptions,
+  NativeWorkoutInput,
+  NativeWorkoutQueryOptions,
+  NativeWorkoutRoute,
+  NativeWorkoutRouteQueryOptions,
+  NativeWorkoutSample,
+} from './types';
+
+declare class ExpoHealthKitModule extends NativeModule<ExpoHealthKitModuleEvents> {
+  isHealthDataAvailable(): boolean;
+  requestAuthorization(options: NativeAuthorizationOptions): Promise<boolean>;
+  getAuthorizationStatus(identifier: string): Promise<number>;
+  getRequestStatusForAuthorization(options: NativeAuthorizationOptions): Promise<number>;
+  queryQuantitySamples(options: NativeQuantityQueryOptions): Promise<NativeQuantitySample[]>;
+  queryCategorySamples(options: NativeCategoryQueryOptions): Promise<NativeCategorySample[]>;
+  queryWorkouts(options: NativeWorkoutQueryOptions): Promise<NativeWorkoutSample[]>;
+  queryElectrocardiograms(
+    options: NativeElectrocardiogramQueryOptions
+  ): Promise<NativeElectrocardiogramSample[]>;
+  queryActivitySummaries(
+    options: NativeActivitySummaryQueryOptions
+  ): Promise<NativeActivitySummary[]>;
+  queryClinicalRecords(options: NativeClinicalRecordQueryOptions): Promise<NativeClinicalRecord[]>;
+  queryAudiograms(options: NativeDateRangeQueryOptions): Promise<NativeAudiogramSample[]>;
+  queryWorkoutRoute(options: NativeWorkoutRouteQueryOptions): Promise<NativeWorkoutRoute[]>;
+  queryCorrelations(options: NativeCorrelationQueryOptions): Promise<NativeCorrelation[]>;
+  queryHeartbeatSeries(
+    options: NativeHeartbeatSeriesQueryOptions
+  ): Promise<NativeHeartbeatSeriesSample[]>;
+  queryStatistics(options: NativeStatisticsQueryOptions): Promise<NativeStatistics>;
+  queryStatisticsCollection(
+    options: NativeStatisticsCollectionQueryOptions
+  ): Promise<NativeStatistics[]>;
+  queryAnchored(options: NativeAnchoredQueryOptions): Promise<NativeAnchoredQueryResult>;
+  saveQuantitySample(sample: NativeQuantitySampleInput): Promise<string>;
+  saveCategorySample(sample: NativeCategorySampleInput): Promise<string>;
+  saveWorkout(workout: NativeWorkoutInput): Promise<string>;
+  saveCorrelation(correlation: NativeCorrelationInput): Promise<string>;
+  deleteObjects(options: NativeDeleteObjectsOptions): Promise<number>;
+  getBiologicalSex(): Promise<number>;
+  getBloodType(): Promise<number>;
+  getDateOfBirth(): Promise<string | null>;
+  getFitzpatrickSkinType(): Promise<number>;
+  getWheelchairUse(): Promise<number>;
+  enableBackgroundDelivery(type: string, frequency: number): Promise<boolean>;
+  disableBackgroundDelivery(type: string): Promise<boolean>;
+  disableAllBackgroundDelivery(): Promise<boolean>;
+  observeTypes(types: string[]): Promise<void>;
+  clearObserverQueries(): Promise<void>;
+}
+
+const nativeModule = requireNativeModule<ExpoHealthKitModule>('ExpoHealthKit');
+
+function rethrowAsHealthKitError(error: unknown): never {
+  const message = error instanceof Error ? error.message : String(error);
+  const code =
+    error && typeof error === 'object' && 'code' in error
+      ? String((error as { code: unknown }).code)
+      : 'ERR_HEALTHKIT';
+  const wrapped = new HealthKitError(message, code);
+  if (__DEV__) {
+    console.warn(`[expo-healthkit] ${code}: ${message}`);
+  }
+  throw wrapped;
+}
+
+export default new Proxy(nativeModule, {
+  get(target, property, receiver) {
+    const value = Reflect.get(target, property, receiver) as unknown;
+    if (typeof value !== 'function') {
+      return value;
+    }
+    return (...args: unknown[]) => {
+      try {
+        const result = (value as (...inner: unknown[]) => unknown).apply(target, args);
+        if (result instanceof Promise) {
+          return result.catch(rethrowAsHealthKitError);
+        }
+        return result;
+      } catch (error) {
+        rethrowAsHealthKitError(error);
+      }
+    };
+  },
+}) as ExpoHealthKitModule;

package/src/ExpoHealthKitModule.web.ts

@@ -0,0 +1,140 @@
+import { NativeModule, registerWebModule } from 'expo';
+
+import { HealthKitUnavailableError } from './errors';
+import type { ExpoHealthKitModuleEvents } from './types';
+
+function unavailable(): never {
+  throw new HealthKitUnavailableError();
+}
+
+class ExpoHealthKitModule extends NativeModule<ExpoHealthKitModuleEvents> {
+  isHealthDataAvailable(): boolean {
+    return false;
+  }
+
+  async requestAuthorization(): Promise<boolean> {
+    return unavailable();
+  }
+
+  async getAuthorizationStatus(): Promise<number> {
+    return unavailable();
+  }
+
+  async getRequestStatusForAuthorization(): Promise<number> {
+    return unavailable();
+  }
+
+  async queryQuantitySamples(): Promise<never> {
+    return unavailable();
+  }
+
+  async queryCategorySamples(): Promise<never> {
+    return unavailable();
+  }
+
+  async queryWorkouts(): Promise<never> {
+    return unavailable();
+  }
+
+  async queryElectrocardiograms(): Promise<never> {
+    return unavailable();
+  }
+
+  async queryActivitySummaries(): Promise<never> {
+    return unavailable();
+  }
+
+  async queryClinicalRecords(): Promise<never> {
+    return unavailable();
+  }
+
+  async queryAudiograms(): Promise<never> {
+    return unavailable();
+  }
+
+  async queryWorkoutRoute(): Promise<never> {
+    return unavailable();
+  }
+
+  async queryCorrelations(): Promise<never> {
+    return unavailable();
+  }
+
+  async queryHeartbeatSeries(): Promise<never> {
+    return unavailable();
+  }
+
+  async queryStatistics(): Promise<never> {
+    return unavailable();
+  }
+
+  async queryStatisticsCollection(): Promise<never> {
+    return unavailable();
+  }
+
+  async queryAnchored(): Promise<never> {
+    return unavailable();
+  }
+
+  async saveQuantitySample(): Promise<string> {
+    return unavailable();
+  }
+
+  async saveCategorySample(): Promise<string> {
+    return unavailable();
+  }
+
+  async saveWorkout(): Promise<string> {
+    return unavailable();
+  }
+
+  async saveCorrelation(): Promise<string> {
+    return unavailable();
+  }
+
+  async deleteObjects(): Promise<number> {
+    return unavailable();
+  }
+
+  async getBiologicalSex(): Promise<number> {
+    return unavailable();
+  }
+
+  async getBloodType(): Promise<number> {
+    return unavailable();
+  }
+
+  async getDateOfBirth(): Promise<string | null> {
+    return unavailable();
+  }
+
+  async getFitzpatrickSkinType(): Promise<number> {
+    return unavailable();
+  }
+
+  async getWheelchairUse(): Promise<number> {
+    return unavailable();
+  }
+
+  async enableBackgroundDelivery(): Promise<boolean> {
+    return unavailable();
+  }
+
+  async disableBackgroundDelivery(): Promise<boolean> {
+    return unavailable();
+  }
+
+  async disableAllBackgroundDelivery(): Promise<boolean> {
+    return unavailable();
+  }
+
+  async observeTypes(): Promise<void> {
+    return unavailable();
+  }
+
+  async clearObserverQueries(): Promise<void> {
+    return unavailable();
+  }
+}
+
+export default registerWebModule(ExpoHealthKitModule, 'ExpoHealthKitModule');

package/src/dates.ts

@@ -0,0 +1,17 @@
+import type { DateInput } from './types';
+
+export function toIso(value: DateInput): string {
+  return value instanceof Date ? value.toISOString() : value;
+}
+
+export function toOptionalIso(value?: DateInput): string | undefined {
+  return value == null ? undefined : toIso(value);
+}
+
+export function fromIso(value: string): Date {
+  return new Date(value);
+}
+
+export function resolveEndDate(startDate: DateInput, endDate?: DateInput): string {
+  return toIso(endDate ?? startDate);
+}

package/src/errors.ts

@@ -0,0 +1,22 @@
+export class HealthKitUnavailableError extends Error {
+  readonly code = 'ERR_HEALTHKIT_UNAVAILABLE';
+
+  constructor(
+    message = 'Health data is not available. On iOS use a development build on a physical iPhone or the iOS Simulator. On Android install Health Connect and use a development build.'
+  ) {
+    super(message);
+    this.name = 'HealthKitUnavailableError';
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+}
+
+export class HealthKitError extends Error {
+  readonly code: string;
+
+  constructor(message: string, code = 'ERR_HEALTHKIT') {
+    super(message);
+    this.name = 'HealthKitError';
+    this.code = code;
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+}