@kingstinct/react-native-healthkit 7.3.1 → 8.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kingstinct/react-native-healthkit",
-  "version": "7.3.1",
+  "version": "8.0.0",
   "description": "React Native bindings for HealthKit",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -20,15 +20,15 @@
     "app.plugin.js"
   ],
   "scripts": {
-    "test-only": "jest",
-    "test": "concurrently \"yarn test-only\" \"yarn typecheck\" \"yarn lint\"",
+    "test-only": "bun test --preload ./src/test-setup.ts src",
+    "test": "concurrently \"bun test-only\" \"bun typecheck\" \"bun lint\"",
     "typecheck": "tsc --noEmit",
     "lint": "eslint \"**/*.{js,ts,tsx}\" --cache",
     "prepare": "bob build && husky install",
     "release": "release-it",
-    "example": "yarn --cwd example",
     "pods": "cd example && pod-install --quiet",
-    "bootstrap": "yarn example && yarn && yarn pods"
+    "bootstrap": "cd example && bun install && bun pods",
+    "upgrade-interactive": "bunx npm-check-updates --format group -i"
   },
   "lint-staged": {
     "*.swift": "swiftlint ios --fix",
@@ -44,7 +44,15 @@
     "react-hooks"
   ],
   "repository": "https://github.com/kingstinct/react-native-healthkit",
-  "author": "Robert Herber <robert@kingstinct.com> (https://github.com/robertherber)",
+  "funding": [
+    "https://github.com/sponsors/kingstinct",
+    "https://github.com/sponsors/robertherber"
+  ],
+  "author": {
+    "name": "Robert Herber",
+    "email": "robert@kingstinct.com",
+    "url": "https://github.com/robertherber"
+  },
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/kingstinct/react-native-healthkit/issues"
@@ -58,14 +66,14 @@
     "@graphql-eslint/eslint-plugin": ">=3",
     "@release-it/conventional-changelog": "2",
     "@testing-library/react-native": "12",
-    "@types/jest": ">=26",
+    "@types/bun": "^1.1.3",
     "@types/node": "^18.7.14",
     "@types/react": "~18.0.27",
     "@typescript-eslint/eslint-plugin": ">=5",
     "@typescript-eslint/parser": ">=5",
     "commitlint": "^17.1.1",
     "concurrently": "8",
-    "eslint": ">=8",
+    "eslint": "8",
     "eslint-config-airbnb": ">=19",
     "eslint-config-airbnb-base": ">=15",
     "eslint-config-kingstinct": "^5.1.1",
@@ -85,8 +93,6 @@
     "expo": ">=45",
     "graphql": ">=16",
     "husky": "8",
-    "jest": ">=26",
-    "jest-environment-jsdom": "^29.0.2",
     "lint-staged": "^13.2.2",
     "metro-react-native-babel-preset": "^0.70.3",
     "pod-install": "^0.1.0",
@@ -97,7 +103,6 @@
     "release-it": "14",
     "solidarity": "^3.0.4",
     "solidarity-react-native": "^2.1.2",
-    "ts-node": "^10.9.1",
     "typescript": "^4.9.4"
   },
   "peerDependencies": {

package/src/hooks/useHealthkitAuthorization.test.ts

@@ -1,11 +1,18 @@
 import { renderHook, act } from '@testing-library/react-native'
 
-import useHealthkitAuthorization from './useHealthkitAuthorization'
-import Native, { HKAuthorizationRequestStatus, HKCategoryTypeIdentifier } from '../native-types'
 import waitForNextUpdate from '../test-utils'
 
 describe('useHealthkitAuthorization', () => {
+  let NativeTypes: typeof import('../native-types')
+  let useHealthkitAuthorization: typeof import('./useHealthkitAuthorization').default
+  beforeAll(async () => {
+    NativeTypes = await import('../native-types')
+    useHealthkitAuthorization = (await import('./useHealthkitAuthorization')).default
+  })
+
   test('should return shouldRequest', async () => {
+    const { HKAuthorizationRequestStatus, HKCategoryTypeIdentifier, default: Native } = NativeTypes
+
     jest.spyOn(Native, 'getRequestStatusForAuthorization').mockReturnValue(Promise.resolve(HKAuthorizationRequestStatus.shouldRequest))
 
     const { result } = renderHook(() => useHealthkitAuthorization([HKCategoryTypeIdentifier.abdominalCramps]))
@@ -16,6 +23,8 @@ describe('useHealthkitAuthorization', () => {
   })
 
   test('should request permissions', async () => {
+    const { HKAuthorizationRequestStatus, HKCategoryTypeIdentifier, default: Native } = NativeTypes
+
     const spy = jest.spyOn(Native, 'getRequestStatusForAuthorization').mockReturnValue(Promise.resolve(HKAuthorizationRequestStatus.shouldRequest))
     jest.spyOn(Native, 'requestAuthorization').mockReturnValue(Promise.resolve(true))
 
@@ -25,9 +34,10 @@ describe('useHealthkitAuthorization', () => {
 
     spy.mockReturnValue(Promise.resolve(HKAuthorizationRequestStatus.unnecessary))
 
-    let retVal: HKAuthorizationRequestStatus | undefined
+    let retVal: typeof HKAuthorizationRequestStatus | undefined
     await act(async () => {
-      retVal = await result.current[1]()
+      const r = await result.current[1]() as unknown as typeof HKAuthorizationRequestStatus
+      retVal = r
     })
 
     expect(result.current[0]).toBe(HKAuthorizationRequestStatus.unnecessary)
@@ -35,6 +45,8 @@ describe('useHealthkitAuthorization', () => {
   })
 
   test('should return unnecessary', async () => {
+    const { HKAuthorizationRequestStatus, HKCategoryTypeIdentifier, default: Native } = NativeTypes
+
     jest.spyOn(Native, 'getRequestStatusForAuthorization').mockReturnValue(Promise.resolve(HKAuthorizationRequestStatus.unnecessary))
 
     const { result } = renderHook(() => useHealthkitAuthorization([HKCategoryTypeIdentifier.abdominalCramps]))
@@ -45,6 +57,8 @@ describe('useHealthkitAuthorization', () => {
   })
 
   test('should return null before initalizing', async () => {
+    const { HKCategoryTypeIdentifier } = NativeTypes
+
     const { result } = renderHook(() => useHealthkitAuthorization([HKCategoryTypeIdentifier.abdominalCramps]))
 
     expect(result.current[0]).toBe(null)

package/src/hooks/useIsHealthDataAvailable.test.ts

@@ -1,11 +1,11 @@
 import { renderHook } from '@testing-library/react-native'
 
-import useIsHealthDataAvailable from './useIsHealthDataAvailable'
-import Native from '../native-types'
 import waitForNextUpdate from '../test-utils'
 
 describe('useIsHealthDataAvailable', () => {
   test('should return false', async () => {
+    const useIsHealthDataAvailable = (await import('./useIsHealthDataAvailable')).default
+    const { default: Native } = await import('../native-types')
     jest.spyOn(Native, 'isHealthDataAvailable').mockReturnValue(Promise.resolve(false))
 
     const { result } = renderHook(useIsHealthDataAvailable)
@@ -16,6 +16,8 @@ describe('useIsHealthDataAvailable', () => {
   })
 
   test('should return true', async () => {
+    const useIsHealthDataAvailable = (await import('./useIsHealthDataAvailable')).default
+    const { default: Native } = await import('../native-types')
     jest.spyOn(Native, 'isHealthDataAvailable').mockReturnValue(Promise.resolve(true))
 
     const { result } = renderHook(useIsHealthDataAvailable)
@@ -26,6 +28,7 @@ describe('useIsHealthDataAvailable', () => {
   })
 
   test('should return null before initalizing', async () => {
+    const useIsHealthDataAvailable = (await import('./useIsHealthDataAvailable')).default
     const { result } = renderHook(useIsHealthDataAvailable)
 
     expect(result.current).toBe(null)

package/src/hooks/useIsHealthDataAvailable.ts

@@ -7,7 +7,7 @@ import Native from '../native-types'
 * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614180-ishealthdataavailable Apple HealthKit isHealthDataAvailable}
 * @returns {boolean | null} true if HealthKit is available; otherwise, false. null while initializing.
 */
-const useIsHealthDataAvailable = () => {
+const useIsHealthDataAvailable = (): boolean | null => {
   const [isAvailable, setIsAvailable] = useState<boolean | null>(null)
 
   useEffect(() => {

package/src/hooks/useMostRecentQuantitySample.ts

@@ -24,6 +24,9 @@ function useMostRecentQuantitySample<
     const init = async () => {
       const actualUnit = await ensureUnit(identifier, unit)
 
+      const value = await getMostRecentQuantitySample(identifier, actualUnit)
+      setLastSample(value)
+
       cancelSubscription = await subscribeToChanges(identifier, async () => {
         const value = await getMostRecentQuantitySample(identifier, actualUnit)
         setLastSample(value)

package/src/index.ios.tsx

@@ -0,0 +1,263 @@
+import { Platform } from 'react-native'
+
+import useHealthkitAuthorization from './hooks/useHealthkitAuthorization'
+import useIsHealthDataAvailable from './hooks/useIsHealthDataAvailable'
+import useMostRecentCategorySample from './hooks/useMostRecentCategorySample'
+import useMostRecentQuantitySample from './hooks/useMostRecentQuantitySample'
+import useMostRecentWorkout from './hooks/useMostRecentWorkout'
+import useSources from './hooks/useSources'
+import useStatisticsForQuantity from './hooks/useStatisticsForQuantity'
+import useSubscribeToChanges from './hooks/useSubscribeToChanges'
+import Native, { HKQuantityTypeIdentifier } from './native-types'
+import deleteQuantitySample from './utils/deleteQuantitySample'
+import deleteSamples from './utils/deleteSamples'
+import getDateOfBirth from './utils/getDateOfBirth'
+import getMostRecentCategorySample from './utils/getMostRecentCategorySample'
+import getMostRecentQuantitySample from './utils/getMostRecentQuantitySample'
+import getMostRecentWorkout from './utils/getMostRecentWorkout'
+import getPreferredUnit from './utils/getPreferredUnit'
+import getPreferredUnits from './utils/getPreferredUnits'
+import getRequestStatusForAuthorization from './utils/getRequestStatusForAuthorization'
+import getWorkoutPlanById from './utils/getWorkoutPlanById'
+import queryCategorySamples from './utils/queryCategorySamples'
+import queryCategorySamplesWithAnchor from './utils/queryCategorySamplesWithAnchor'
+import queryCorrelationSamples from './utils/queryCorrelationSamples'
+import queryHeartbeatSeriesSamples from './utils/queryHeartbeatSeriesSamples'
+import queryHeartbeatSeriesSamplesWithAnchor from './utils/queryHeartbeatSeriesSamplesWithAnchor'
+import queryQuantitySamples from './utils/queryQuantitySamples'
+import queryQuantitySamplesWithAnchor from './utils/queryQuantitySamplesWithAnchor'
+import querySources from './utils/querySources'
+import queryStatisticsForQuantity from './utils/queryStatisticsForQuantity'
+import queryWorkouts from './utils/queryWorkouts'
+import requestAuthorization from './utils/requestAuthorization'
+import saveCategorySample from './utils/saveCategorySample'
+import saveCorrelationSample from './utils/saveCorrelationSample'
+import saveQuantitySample from './utils/saveQuantitySample'
+import saveWorkoutRoute from './utils/saveWorkoutRoute'
+import saveWorkoutSample from './utils/saveWorkoutSample'
+import subscribeToChanges from './utils/subscribeToChanges'
+
+const currentMajorVersionIOS = Platform.OS === 'ios' ? parseInt(Platform.Version, 10) : 0
+
+const allQuantityTypesList = [...Object.values(HKQuantityTypeIdentifier)]
+
+const availableQuantityTypes = (majorVersionIOS = currentMajorVersionIOS) => {
+  if (majorVersionIOS >= 17) {
+    return allQuantityTypesList
+  }
+
+  // remove types that are not available before iOS 17
+  return allQuantityTypesList.filter((type) => ![
+    HKQuantityTypeIdentifier.cyclingCadence,
+    HKQuantityTypeIdentifier.cyclingFunctionalThresholdPower,
+    HKQuantityTypeIdentifier.cyclingPower,
+    HKQuantityTypeIdentifier.cyclingSpeed,
+    HKQuantityTypeIdentifier.physicalEffort,
+    HKQuantityTypeIdentifier.timeInDaylight,
+  ].includes(type))
+}
+
+const authorizationStatusFor = Native.authorizationStatusFor.bind(Native)
+const isHealthDataAvailable = Native.isHealthDataAvailable.bind(Native)
+const isProtectedDataAvailable = Native.isProtectedDataAvailable.bind(Native)
+const disableBackgroundDelivery = Native.disableBackgroundDelivery.bind(Native)
+const disableAllBackgroundDelivery = Native.disableAllBackgroundDelivery.bind(Native)
+const enableBackgroundDelivery = Native.enableBackgroundDelivery.bind(Native)
+const getBiologicalSex = Native.getBiologicalSex.bind(Native)
+const getFitzpatrickSkinType = Native.getFitzpatrickSkinType.bind(Native)
+const getWheelchairUse = Native.getWheelchairUse.bind(Native)
+const getBloodType = Native.getBloodType.bind(Native)
+const getWorkoutRoutes = Native.getWorkoutRoutes.bind(Native)
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/about_the_healthkit_framework About the HealthKit Framework (Apple Docs)}
+ */
+export default {
+  /**
+  * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614154-authorizationstatus authorizationStatus(for:) (Apple Docs) }
+  * @see {@link https://developer.apple.com/documentation/healthkit/authorizing_access_to_health_data Authorizing access to health data (Apple Docs) }
+  */
+  authorizationStatusFor,
+
+  /**
+   *
+   * @returns All available quantity types for the current iOS version (currently excluding types that are not available before iOS 17)
+   */
+  availableQuantityTypes,
+
+  /**
+    * @description By default, HealthKit data is available on iOS and watchOS. HealthKit data is also available on iPadOS 17 or later. However, devices running in an enterprise environment may restrict access to HealthKit data.
+    * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614180-ishealthdataavailable isHealthDataAvailable() (Apple Docs)}
+    * @returns {boolean} true if HealthKit is available; otherwise, false.
+    */
+  isHealthDataAvailable,
+
+  /**
+   * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614181-isprotecteddataavailable isProtectedDataAvailable() (Apple Docs)}
+   * @see {@link https://developer.apple.com/documentation/healthkit/protecting_user_privacy#3705074 Protecting User Privacy - Access encrypted data (Apple Docs)}
+   * @returns {boolean} A Boolean value that indicates whether content protection is active.
+   */
+  isProtectedDataAvailable,
+
+  /**
+   * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614158-disableallbackgrounddelivery disableAllBackgroundDelivery(completion:) (Apple Docs)}
+   */
+  disableAllBackgroundDelivery,
+  /**
+   * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614177-disablebackgrounddelivery disableBackgroundDelivery(for:withCompletion:) (Apple Docs)}
+   */
+  disableBackgroundDelivery,
+  /**
+   * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614175-enablebackgrounddelivery enableBackgroundDelivery(for:frequency:withCompletion:) (Apple Docs)}
+   */
+  enableBackgroundDelivery,
+
+  // simple convenience getters
+  /**
+   * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614171-biologicalsex biologicalSex() (Apple Docs)}
+   */
+  getBiologicalSex,
+  /**
+   * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614161-fitzpatrickskintype fitzpatrickSkinType() (Apple Docs)}
+   */
+  getFitzpatrickSkinType,
+  /**
+   * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1648356-wheelchairuse wheelchairUse() (Apple Docs)}
+   */
+  getWheelchairUse,
+  /**
+   * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614164-bloodtype bloodType() (Apple Docs)}
+   */
+  getBloodType,
+  /**
+   * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1648357-dateofbirthcomponents dateOfBirthComponents() (Apple Docs)}
+   */
+  getDateOfBirth,
+
+  getMostRecentQuantitySample,
+  getMostRecentCategorySample,
+  getMostRecentWorkout,
+
+  /**
+  * @see {@link https://developer.apple.com/documentation/healthkit/workouts_and_activity_rings/reading_route_data Reading route data (Apple Docs)}
+  * @see {@link https://developer.apple.com/documentation/healthkit/hkworkoutroutequery HKWorkoutRouteQuery (Apple Docs)}
+   */
+  getWorkoutRoutes,
+  getWorkoutPlanById,
+
+  getPreferredUnit,
+  getPreferredUnits,
+  getRequestStatusForAuthorization,
+
+  // query methods
+  queryCategorySamples,
+  queryCategorySamplesWithAnchor,
+  queryCorrelationSamples,
+  queryHeartbeatSeriesSamples,
+  queryHeartbeatSeriesSamplesWithAnchor,
+  queryQuantitySamples,
+  queryQuantitySamplesWithAnchor,
+  queryStatisticsForQuantity,
+  queryWorkouts,
+  querySources,
+
+  requestAuthorization,
+
+  // delete methods
+  deleteQuantitySample,
+  deleteSamples,
+
+  // save methods
+  /**
+   * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614168-savecategorysample save(_:withCompletion:) (Apple Docs)}
+   * @see {@link https://developer.apple.com/documentation/healthkit/saving_data_to_healthkit Saving data to HealthKit (Apple Docs)}
+   */
+  saveCategorySample,
+  saveCorrelationSample,
+  saveQuantitySample,
+  saveWorkoutSample,
+  saveWorkoutRoute,
+
+  // subscriptions
+  subscribeToChanges,
+
+  /**
+   * @returns the most recent sample for the given category type.
+   */
+  useMostRecentCategorySample,
+  /**
+   * @returns the most recent sample for the given quantity type.
+   */
+  useMostRecentQuantitySample,
+  /**
+   * @returns the most recent workout sample.
+   */
+  useMostRecentWorkout,
+  useSubscribeToChanges,
+  /**
+     * @description By default, HealthKit data is available on iOS and watchOS. HealthKit data is also available on iPadOS 17 or later. However, devices running in an enterprise environment may restrict access to HealthKit data.
+    * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614180-ishealthdataavailable Apple Docs}
+    * @returns {boolean | null} true if HealthKit is available; otherwise, false. null while initializing.
+    */
+  useIsHealthDataAvailable,
+  /**
+   * @description Hook to retrieve the current authorization status for the given types, and request authorization if needed.
+   * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614152-requestauthorization Apple Docs - requestAuthorization}
+   * @see {@link https://developer.apple.com/documentation/healthkit/authorizing_access_to_health_data Apple Docs - Authorizing access to health data}
+   */
+  useHealthkitAuthorization,
+  useSources,
+  useStatisticsForQuantity,
+}
+
+export {
+  authorizationStatusFor,
+  availableQuantityTypes,
+  disableAllBackgroundDelivery,
+  disableBackgroundDelivery,
+  enableBackgroundDelivery,
+  getBiologicalSex,
+  getBloodType,
+  getDateOfBirth,
+  getFitzpatrickSkinType,
+  getMostRecentCategorySample,
+  getMostRecentQuantitySample,
+  getMostRecentWorkout,
+  getPreferredUnit,
+  getPreferredUnits,
+  getRequestStatusForAuthorization,
+  getWheelchairUse,
+  getWorkoutRoutes,
+  isHealthDataAvailable,
+  queryCategorySamples,
+  queryCategorySamplesWithAnchor,
+  queryCorrelationSamples,
+  queryHeartbeatSeriesSamples,
+  queryHeartbeatSeriesSamplesWithAnchor,
+  queryQuantitySamples,
+  queryQuantitySamplesWithAnchor,
+  queryStatisticsForQuantity,
+  queryWorkouts,
+  querySources,
+  requestAuthorization,
+  deleteQuantitySample,
+  deleteSamples,
+  getWorkoutPlanById,
+  saveCategorySample,
+  saveCorrelationSample,
+  saveQuantitySample,
+  saveWorkoutSample,
+  saveWorkoutRoute,
+  subscribeToChanges,
+  useMostRecentCategorySample,
+  useMostRecentQuantitySample,
+  useMostRecentWorkout,
+  useSubscribeToChanges,
+  useHealthkitAuthorization,
+  useIsHealthDataAvailable,
+  useSources,
+  useStatisticsForQuantity,
+  isProtectedDataAvailable,
+}
+
+export * from './types'

package/src/index.native.tsx

@@ -4,7 +4,7 @@ import {
   HKAuthorizationRequestStatus, HKAuthorizationStatus, HKBiologicalSex, HKBloodType, HKFitzpatrickSkinType, HKUnits, HKWheelchairUse,
 } from './native-types'
 
-import type ReactNativeHealthkit from '.'
+import type ReactNativeHealthkit from './index.ios'
 import type { QueryCategorySamplesFn } from './utils/queryCategorySamples'
 import type { QueryQuantitySamplesFn } from './utils/queryQuantitySamples'
 
@@ -91,7 +91,6 @@ const authorizationStatusFor = UnavailableFn(Promise.resolve(HKAuthorizationStat
       useSubscribeToChanges = UnavailableFn([null, () => null]),
       useHealthkitAuthorization = UnavailableFn([null, async () => Promise.resolve(HKAuthorizationRequestStatus.unknown)] as const),
       useIsHealthDataAvailable = () => false,
-      canAccessProtectedData = async () => Promise.resolve(false),
       isProtectedDataAvailable = async () => Promise.resolve(false)
 
 const Healthkit: typeof ReactNativeHealthkit = {
@@ -141,7 +140,6 @@ const Healthkit: typeof ReactNativeHealthkit = {
   useSubscribeToChanges,
   useHealthkitAuthorization,
   useIsHealthDataAvailable,
-  canAccessProtectedData,
   isProtectedDataAvailable,
 }
 
@@ -192,7 +190,6 @@ export {
   useSubscribeToChanges,
   useHealthkitAuthorization,
   useIsHealthDataAvailable,
-  canAccessProtectedData,
   isProtectedDataAvailable,
 }