@kingstinct/react-native-healthkit 7.3.0 → 7.3.2

package/lib/typescript/src/utils/saveCategorySample.d.ts

@@ -1,4 +1,8 @@
 import type { HKCategoryTypeIdentifier, HKCategoryValueForIdentifier, MetadataMapperForCategoryIdentifier } from '../native-types';
+/**
+   * @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)}
+   */
 declare function saveCategorySample<T extends HKCategoryTypeIdentifier>(identifier: T, value: HKCategoryValueForIdentifier<T>, options?: {
     readonly start?: Date;
     readonly end?: Date;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kingstinct/react-native-healthkit",
-  "version": "7.3.0",
+  "version": "7.3.2",
   "description": "React Native bindings for HealthKit",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

package/src/hooks/useHealthkitAuthorization.ts

@@ -7,6 +7,11 @@ import requestAuthorization from '../utils/requestAuthorization'
 
 import type { HealthkitReadAuthorization, HealthkitWriteAuthorization, HKAuthorizationRequestStatus } from '../native-types'
 
+/**
+   * @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}
+   */
 const useHealthkitAuthorization = (read: readonly HealthkitReadAuthorization[], write?: readonly HealthkitWriteAuthorization[]) => {
   const [status, setStatus] = useState<HKAuthorizationRequestStatus | null>(null)
 

package/src/hooks/useMostRecentCategorySample.ts

@@ -6,6 +6,9 @@ import getMostRecentCategorySample from '../utils/getMostRecentCategorySample'
 import type { HKCategoryTypeIdentifier } from '../native-types'
 import type { HKCategorySample } from '../types'
 
+/**
+   * @returns the most recent sample for the given category type.
+   */
 function useMostRecentCategorySample<
   TCategory extends HKCategoryTypeIdentifier
 >(identifier: TCategory) {

package/src/hooks/useMostRecentQuantitySample.ts

@@ -7,6 +7,9 @@ import subscribeToChanges from '../utils/subscribeToChanges'
 import type { HKQuantityTypeIdentifier, UnitForIdentifier } from '../native-types'
 import type { HKQuantitySample } from '../types'
 
+/**
+   * @returns the most recent sample for the given quantity type.
+   */
 function useMostRecentQuantitySample<
   TIdentifier extends HKQuantityTypeIdentifier,
   TUnit extends UnitForIdentifier<TIdentifier>

package/src/hooks/useMostRecentWorkout.ts

@@ -9,6 +9,9 @@ import subscribeToChanges from '../utils/subscribeToChanges'
 import type { EnergyUnit, LengthUnit } from '../native-types'
 import type { HKWorkout } from '../types'
 
+/**
+   * @returns the most recent workout sample.
+   */
 function useMostRecentWorkout<
   TEnergy extends EnergyUnit,
   TDistance extends LengthUnit

package/src/index.ios.tsx

@@ -5,6 +5,8 @@ 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'
@@ -214,6 +216,61 @@ export default {
    * @see {@link https://developer.apple.com/documentation/healthkit/authorizing_access_to_health_data Apple Docs - Authorizing access to health data}
    */
   useHealthkitAuthorization,
+  useSources,
+  useStatisticsForQuantity,
+}
+
+const isProtectedDataAvailable = canAccessProtectedData
+
+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,
+  canAccessProtectedData,
+  isProtectedDataAvailable,
 }
 
 export * from './types'

package/src/index.native.tsx

@@ -0,0 +1,201 @@
+import { Platform } from 'react-native'
+
+import {
+  HKAuthorizationRequestStatus, HKAuthorizationStatus, HKBiologicalSex, HKBloodType, HKFitzpatrickSkinType, HKUnits, HKWheelchairUse,
+} from './native-types'
+
+import type ReactNativeHealthkit from './index.ios'
+import type { QueryCategorySamplesFn } from './utils/queryCategorySamples'
+import type { QueryQuantitySamplesFn } from './utils/queryQuantitySamples'
+
+const notAvailableError = `[@kingstinct/react-native-healthkit] Platform "${
+  Platform.OS
+}" not supported`
+
+let hasWarned = false
+
+function UnavailableFn<T = unknown>(retVal: T) {
+  return () => {
+    if (!hasWarned) {
+      // eslint-disable-next-line no-console
+      console.warn(notAvailableError)
+      hasWarned = true
+    }
+    return retVal
+  }
+}
+
+const authorizationStatusFor = UnavailableFn(Promise.resolve(HKAuthorizationStatus.notDetermined)),
+      availableQuantityTypes = UnavailableFn([]),
+      disableAllBackgroundDelivery = UnavailableFn(Promise.resolve(false)),
+      disableBackgroundDelivery = UnavailableFn(Promise.resolve(false)),
+      enableBackgroundDelivery = UnavailableFn(Promise.resolve(false)),
+      getBiologicalSex = UnavailableFn(Promise.resolve(HKBiologicalSex.notSet)),
+      getBloodType = UnavailableFn(Promise.resolve(HKBloodType.notSet)),
+      getDateOfBirth = UnavailableFn(Promise.resolve(new Date(0))),
+      getFitzpatrickSkinType = UnavailableFn(Promise.resolve(HKFitzpatrickSkinType.notSet)),
+      getMostRecentCategorySample = UnavailableFn(Promise.resolve(null)),
+      getMostRecentQuantitySample = UnavailableFn(Promise.resolve(null)),
+      getMostRecentWorkout = UnavailableFn(Promise.resolve(null)),
+      getPreferredUnit = UnavailableFn(Promise.resolve(HKUnits.Count)),
+      getPreferredUnits = UnavailableFn(Promise.resolve([])),
+      getRequestStatusForAuthorization = UnavailableFn(Promise.resolve(HKAuthorizationRequestStatus.unknown)),
+      getWheelchairUse = UnavailableFn(Promise.resolve(HKWheelchairUse.notSet)),
+      getWorkoutRoutes = UnavailableFn(Promise.resolve([])),
+      isHealthDataAvailable = async () => Promise.resolve(false),
+      useSources = UnavailableFn(null),
+      useStatisticsForQuantity = UnavailableFn(null),
+      queryCategorySamples = UnavailableFn(Promise.resolve([])) as unknown as QueryCategorySamplesFn,
+      queryCategorySamplesWithAnchor = UnavailableFn(Promise.resolve({
+        samples: [],
+        deletedSamples: [],
+        newAnchor: '',
+      })),
+      queryCorrelationSamples = UnavailableFn(Promise.resolve([])),
+      queryHeartbeatSeriesSamples = UnavailableFn(Promise.resolve([])),
+      queryHeartbeatSeriesSamplesWithAnchor = UnavailableFn(Promise.resolve({
+        samples: [],
+        deletedSamples: [],
+        newAnchor: '',
+      })),
+      queryQuantitySamples = UnavailableFn(Promise.resolve([])) as unknown as QueryQuantitySamplesFn,
+      queryQuantitySamplesWithAnchor = UnavailableFn(Promise.resolve({
+        samples: [],
+        deletedSamples: [],
+        newAnchor: '',
+      })),
+      queryStatisticsForQuantity = UnavailableFn(Promise.resolve({
+        averageQuantity: undefined,
+        maximumQuantity: undefined,
+        minimumQuantity: undefined,
+        sumQuantity: undefined,
+        mostRecentQuantity: undefined,
+        mostRecentQuantityDateInterval: undefined,
+        duration: undefined,
+      })),
+      queryWorkouts = UnavailableFn(Promise.resolve([])),
+      querySources = UnavailableFn(Promise.resolve([])),
+      requestAuthorization = UnavailableFn(Promise.resolve(false)),
+      deleteQuantitySample = UnavailableFn(Promise.resolve(false)),
+      deleteSamples = UnavailableFn(Promise.resolve(false)),
+      getWorkoutPlanById = UnavailableFn(Promise.resolve(null)),
+      saveCategorySample = UnavailableFn(Promise.resolve(false)),
+      saveCorrelationSample = UnavailableFn(Promise.resolve(false)),
+      saveQuantitySample = UnavailableFn(Promise.resolve(false)),
+      saveWorkoutSample = UnavailableFn(Promise.resolve(null)),
+      saveWorkoutRoute = UnavailableFn(Promise.resolve(false)),
+      subscribeToChanges = UnavailableFn(Promise.resolve(async () => Promise.resolve(false))),
+      useMostRecentCategorySample = UnavailableFn(null),
+      useMostRecentQuantitySample = UnavailableFn(null),
+      useMostRecentWorkout = UnavailableFn(null),
+      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 = {
+  authorizationStatusFor,
+  availableQuantityTypes,
+  useSources,
+  useStatisticsForQuantity,
+  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,
+  canAccessProtectedData,
+  isProtectedDataAvailable,
+}
+
+export {
+  authorizationStatusFor,
+  availableQuantityTypes,
+  disableAllBackgroundDelivery,
+  disableBackgroundDelivery,
+  enableBackgroundDelivery,
+  useSources,
+  useStatisticsForQuantity,
+  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,
+  canAccessProtectedData,
+  isProtectedDataAvailable,
+}
+
+export * from './types'
+
+export default Healthkit

package/src/index.tsx

@@ -1,99 +1,5 @@
-import { Platform } from 'react-native'
+import Healthkit from './index.ios'
 
-import {
-  HKAuthorizationRequestStatus, HKAuthorizationStatus, HKBiologicalSex, HKBloodType, HKFitzpatrickSkinType, HKUnits, HKWheelchairUse,
-} from './native-types'
+export * from './index.ios'
 
-import type ReactNativeHealthkit from './index.ios'
-import type { QueryCategorySamplesFn } from './utils/queryCategorySamples'
-import type { QueryQuantitySamplesFn } from './utils/queryQuantitySamples'
-
-const notAvailableError = `[@kingstinct/react-native-healthkit] Platform "${
-  Platform.OS
-}" not supported`
-
-let hasWarned = false
-
-function UnavailableFn<T = unknown>(retVal: T) {
-  return () => {
-    if (!hasWarned) {
-      // eslint-disable-next-line no-console
-      console.warn(notAvailableError)
-      hasWarned = true
-    }
-    return retVal
-  }
-}
-
-const Healthkit = {
-  authorizationStatusFor: UnavailableFn(Promise.resolve(HKAuthorizationStatus.notDetermined)),
-  availableQuantityTypes: UnavailableFn([]),
-  disableAllBackgroundDelivery: UnavailableFn(Promise.resolve(false)),
-  disableBackgroundDelivery: UnavailableFn(Promise.resolve(false)),
-  enableBackgroundDelivery: UnavailableFn(Promise.resolve(false)),
-  getBiologicalSex: UnavailableFn(Promise.resolve(HKBiologicalSex.notSet)),
-  getBloodType: UnavailableFn(Promise.resolve(HKBloodType.notSet)),
-  getDateOfBirth: UnavailableFn(Promise.resolve(new Date(0))),
-  getFitzpatrickSkinType: UnavailableFn(Promise.resolve(HKFitzpatrickSkinType.notSet)),
-  getMostRecentCategorySample: UnavailableFn(Promise.resolve(null)),
-  getMostRecentQuantitySample: UnavailableFn(Promise.resolve(null)),
-  getMostRecentWorkout: UnavailableFn(Promise.resolve(null)),
-  getPreferredUnit: UnavailableFn(Promise.resolve(HKUnits.Count)),
-  getPreferredUnits: UnavailableFn(Promise.resolve([])),
-  getRequestStatusForAuthorization: UnavailableFn(Promise.resolve(HKAuthorizationRequestStatus.unknown)),
-  getWheelchairUse: UnavailableFn(Promise.resolve(HKWheelchairUse.notSet)),
-  getWorkoutRoutes: UnavailableFn(Promise.resolve([])),
-  isHealthDataAvailable: async () => Promise.resolve(false),
-  queryCategorySamples: UnavailableFn(Promise.resolve([])) as unknown as QueryCategorySamplesFn,
-  queryCategorySamplesWithAnchor: UnavailableFn(Promise.resolve({
-    samples: [],
-    deletedSamples: [],
-    newAnchor: '',
-  })),
-  queryCorrelationSamples: UnavailableFn(Promise.resolve([])),
-  queryHeartbeatSeriesSamples: UnavailableFn(Promise.resolve([])),
-  queryHeartbeatSeriesSamplesWithAnchor: UnavailableFn(Promise.resolve({
-    samples: [],
-    deletedSamples: [],
-    newAnchor: '',
-  })),
-  queryQuantitySamples: UnavailableFn(Promise.resolve([])) as unknown as QueryQuantitySamplesFn,
-  queryQuantitySamplesWithAnchor: UnavailableFn(Promise.resolve({
-    samples: [],
-    deletedSamples: [],
-    newAnchor: '',
-  })),
-  queryStatisticsForQuantity: UnavailableFn(Promise.resolve({
-    averageQuantity: undefined,
-    maximumQuantity: undefined,
-    minimumQuantity: undefined,
-    sumQuantity: undefined,
-    mostRecentQuantity: undefined,
-    mostRecentQuantityDateInterval: undefined,
-    duration: undefined,
-  })),
-  queryWorkouts: UnavailableFn(Promise.resolve([])),
-  querySources: UnavailableFn(Promise.resolve([])),
-  requestAuthorization: UnavailableFn(Promise.resolve(false)),
-  deleteQuantitySample: UnavailableFn(Promise.resolve(false)),
-  deleteSamples: UnavailableFn(Promise.resolve(false)),
-  getWorkoutPlanById: UnavailableFn(Promise.resolve(null)),
-  saveCategorySample: UnavailableFn(Promise.resolve(false)),
-  saveCorrelationSample: UnavailableFn(Promise.resolve(false)),
-  saveQuantitySample: UnavailableFn(Promise.resolve(false)),
-  saveWorkoutSample: UnavailableFn(Promise.resolve(null)),
-  saveWorkoutRoute: UnavailableFn(Promise.resolve(false)),
-  subscribeToChanges: UnavailableFn(Promise.resolve(async () => Promise.resolve(false))),
-  useMostRecentCategorySample: UnavailableFn(null),
-  useMostRecentQuantitySample: UnavailableFn(null),
-  useMostRecentWorkout: UnavailableFn(null),
-  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),
-} as typeof ReactNativeHealthkit
-
-export * from './types'
-
-export default Healthkit as typeof ReactNativeHealthkit
+export default Healthkit

package/src/index.web.tsx

@@ -0,0 +1,5 @@
+import Healthkit from './index.native'
+
+export * from './index.native'
+
+export default Healthkit

package/src/utils/saveCategorySample.ts

@@ -2,6 +2,10 @@ import Native from '../native-types'
 
 import type { HKCategoryTypeIdentifier, HKCategoryValueForIdentifier, MetadataMapperForCategoryIdentifier } from '../native-types'
 
+/**
+   * @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)}
+   */
 async function saveCategorySample<T extends HKCategoryTypeIdentifier>(
   identifier: T,
   value: HKCategoryValueForIdentifier<T>,