@kingstinct/react-native-healthkit 4.4.6 → 5.0.0

package/src/index.ios.tsx

@@ -1,548 +1,46 @@
-import { useCallback, useEffect, useState } from 'react'
-
-import Native, {
-  EventEmitter,
-  HKQuantityTypeIdentifier,
-  HKUnit,
-} from './native-types'
-
-import type {
-  HealthkitReadAuthorization,
-  HealthkitWriteAuthorization,
-  HKAuthorizationRequestStatus,
-  HKCategorySampleRaw,
-  HKCategoryValueForIdentifier,
-  HKCorrelationRaw,
-  HKCorrelationTypeIdentifier,
-  HKQuantitySampleRaw,
-  HKUnitSI,
-  HKUnitSIPrefix,
-  HKWorkoutRaw,
-  MetadataMapperForCategoryIdentifier,
-  ReadPermissions,
-  WritePermissions,
-  HKSampleTypeIdentifier,
-  HKCategoryTypeIdentifier,
-} from './native-types'
-import type {
-  GenericQueryOptions,
-  GetMostRecentCategorySampleFn,
-  GetMostRecentQuantitySampleFn,
-  GetMostRecentWorkoutFn,
-  GetPreferredUnitFn,
-  GetPreferredUnitsFn,
-  GetWorkoutRoutesFn,
-  HKCategorySample,
-  HKCorrelation,
-  HKQuantitySample,
-  HKWorkout,
-  QueryCategorySamplesFn,
-  QueryCorrelationSamplesFn,
-  QueryQuantitySamplesFn,
-  QueryStatisticsForQuantityFn,
-  QueryWorkoutsFn,
-  ReactNativeHealthkit,
-  SaveCorrelationSampleFn,
-  SaveQuantitySampleFn,
-  SaveWorkoutSampleFn,
-  SubscribeToChangesFn,
-} from './types'
-
-const getPreferredUnit: GetPreferredUnitFn = async (type) => {
-  const [unit] = await getPreferredUnits([type])
-  return unit
-}
-
-const ensureUnit = async <TUnit extends HKUnit>(
-  type: HKQuantityTypeIdentifier,
-  providedUnit?: TUnit,
-) => {
-  if (providedUnit) {
-    return providedUnit
-  }
-  const unit = await Native.getPreferredUnits([type])
-  return unit[type] as TUnit
-}
-
-function deserializeSample<
-  TIdentifier extends HKQuantityTypeIdentifier,
-  TUnit extends HKUnit
->(
-  sample: HKQuantitySampleRaw<TIdentifier, TUnit>,
-): HKQuantitySample<TIdentifier, TUnit> {
-  return {
-    ...sample,
-    startDate: new Date(sample.startDate),
-    endDate: new Date(sample.endDate),
-  }
-}
-
-function deserializeWorkout<TEnergy extends HKUnit, TDistance extends HKUnit>(
-  sample: HKWorkoutRaw<TEnergy, TDistance>,
-): HKWorkout<TEnergy, TDistance> {
-  return {
-    ...sample,
-    startDate: new Date(sample.startDate),
-    endDate: new Date(sample.endDate),
-  }
-}
-
-const deserializCategorySample = <T extends HKCategoryTypeIdentifier>(
-  sample: HKCategorySampleRaw<T>,
-): HKCategorySample<T> => ({
-  ...sample,
-  startDate: new Date(sample.startDate),
-  endDate: new Date(sample.endDate),
-})
-
-const serializeDate = (date?: Date | null): string => (date ? date.toISOString() : new Date(0).toISOString())
-
-const prepareOptions = (options: GenericQueryOptions) => {
-  const limit = !options.limit || options.limit === Infinity ? 0 : options.limit
-  const ascending = options.ascending ?? limit === 0
-  const from = serializeDate(options.from)
-  const to = serializeDate(options.to)
-  return {
-    limit, ascending, from, to,
-  }
-}
-
-const queryQuantitySamples: QueryQuantitySamplesFn = async (
-  identifier,
-  options,
-) => {
-  const unit = await ensureUnit(identifier, options.unit)
-  const opts = prepareOptions(options)
-
-  const quantitySamples = await Native.queryQuantitySamples(
-    identifier,
-    unit,
-    opts.from,
-    opts.to,
-    opts.limit,
-    opts.ascending,
-  )
-
-  return quantitySamples.map(deserializeSample)
-}
-
-async function getPreferredUnitsTyped<
-  TEnergy extends HKUnit,
-  TDistance extends HKUnit
->(options?: { readonly energyUnit?: TEnergy; readonly distanceUnit?: TDistance }) {
-  let energyUnit = options?.energyUnit
-  let distanceUnit = options?.distanceUnit
-  if (!energyUnit || !distanceUnit) {
-    const units = await Native.getPreferredUnits([
-      HKQuantityTypeIdentifier.distanceWalkingRunning,
-      HKQuantityTypeIdentifier.activeEnergyBurned,
-    ])
-    if (!energyUnit) {
-      energyUnit = units[HKQuantityTypeIdentifier.distanceWalkingRunning] as
-        | TEnergy
-        | undefined
-    }
-    if (!distanceUnit) {
-      distanceUnit = units[HKQuantityTypeIdentifier.activeEnergyBurned] as
-        | TDistance
-        | undefined
-    }
-  }
-  if (!energyUnit) {
-    energyUnit = HKUnit.Kilocalories as TEnergy
-  }
-  if (!distanceUnit) {
-    distanceUnit = HKUnit.Meters as TDistance
-  }
-  return { energyUnit, distanceUnit }
-}
-
-const subscribeToChanges: SubscribeToChangesFn = async (
-  identifier,
-  callback,
-) => {
-  const subscription = EventEmitter.addListener(
-    'onChange',
-    ({ typeIdentifier }) => {
-      if (typeIdentifier === identifier) {
-        callback()
-      }
-    },
-  )
-
-  const queryId = await Native.subscribeToObserverQuery(identifier).catch(
-    async (error) => {
-      subscription.remove()
-      return Promise.reject(error)
-    },
-  )
-
-  return async () => {
-    subscription.remove()
-    return Native.unsubscribeQuery(queryId)
-  }
-}
-
-const getMostRecentQuantitySample: GetMostRecentQuantitySampleFn = async (
-  identifier,
-  unit,
-) => {
-  const samples = await queryQuantitySamples(identifier, {
-    limit: 1,
-    unit,
-  })
-  return samples[0]
-}
-
-function useMostRecentWorkout<
-  TEnergy extends HKUnit,
-  TDistance extends HKUnit
->(options?: { readonly energyUnit?: TEnergy; readonly distanceUnit?: TDistance }) {
-  const [workout, setWorkout] = useState<HKWorkout<TEnergy, TDistance> | null>(
-    null,
-  )
-  useEffect(() => {
-    let cancelSubscription: (() => Promise<boolean>) | undefined
-
-    const init = async () => {
-      const { energyUnit, distanceUnit } = await getPreferredUnitsTyped(
-        options,
-      )
-
-      cancelSubscription = await subscribeToChanges(
-        'HKWorkoutTypeIdentifier',
-        async () => {
-          const w = await getMostRecentWorkout({ energyUnit, distanceUnit })
-          setWorkout(w)
-        },
-      )
-    }
-    void init()
-    return () => {
-      void cancelSubscription?.()
-    }
-  }, [options])
-  return workout
-}
-
-const getMostRecentCategorySample: GetMostRecentCategorySampleFn = async (
-  identifier,
-) => {
-  const samples = await queryCategorySamples(identifier, {
-    limit: 1,
-    ascending: false,
-  })
-
-  return samples[0]
-}
-
-function useSubscribeToChanges<TIdentifier extends HKSampleTypeIdentifier>(
-  identifier: TIdentifier,
-  onChange: () => void,
-): void {
-  useEffect(() => {
-    let cancelSubscription: (() => Promise<boolean>) | undefined
-
-    const init = async () => {
-      cancelSubscription = await subscribeToChanges(identifier, onChange)
-    }
-    void init()
-
-    return () => {
-      void cancelSubscription?.()
-    }
-  }, [identifier, onChange])
-}
-
-function useMostRecentCategorySample<
-  TCategory extends HKCategoryTypeIdentifier
->(identifier: TCategory) {
-  const [category, setCategory] = useState<HKCategorySample<TCategory> | null>(
-    null,
-  )
-  const updater = useCallback(() => {
-    void getMostRecentCategorySample(identifier).then(setCategory)
-  }, [identifier])
-
-  useSubscribeToChanges(identifier, updater)
-
-  return category
-}
-
-function useMostRecentQuantitySample<
-  TIdentifier extends HKQuantityTypeIdentifier,
-  TUnit extends HKUnit = HKUnit
->(identifier: TIdentifier, unit?: TUnit) {
-  const [lastSample, setLastSample] = useState<HKQuantitySample<
-  TIdentifier,
-  TUnit
-  > | null>(null)
-
-  useEffect(() => {
-    let cancelSubscription: (() => Promise<boolean>) | undefined
-
-    const init = async () => {
-      const actualUnit = await ensureUnit(identifier, unit)
-
-      cancelSubscription = await subscribeToChanges(identifier, async () => {
-        const value = await getMostRecentQuantitySample(identifier, actualUnit)
-        setLastSample(value)
-      })
-    }
-    void init()
-
-    return () => {
-      void cancelSubscription?.()
-    }
-  }, [identifier, unit])
-
-  return lastSample
-}
-
-const saveQuantitySample: SaveQuantitySampleFn = async (
-  identifier,
-  unit,
-  value,
-  options,
-) => {
-  const start = options?.start || options?.end || new Date()
-  const end = options?.end || options?.start || new Date()
-  const metadata = options?.metadata || {}
-
-  return Native.saveQuantitySample(
-    identifier,
-    unit,
-    value,
-    start.toISOString(),
-    end.toISOString(),
-    metadata,
-  )
-}
-
-const queryStatisticsForQuantity: QueryStatisticsForQuantityFn = async (
-  identifier,
-  options,
-  from,
-  to,
-  unit,
-) => {
-  const actualUnit = await ensureUnit(identifier, unit)
-  const toDate = to || new Date()
-  const { mostRecentQuantityDateInterval, ...rawResponse } = await Native.queryStatisticsForQuantity(
-    identifier,
-    actualUnit,
-    from.toISOString(),
-    toDate.toISOString(),
-    options,
-  )
-
-  const response = {
-    ...rawResponse,
-    ...(mostRecentQuantityDateInterval
-      ? {
-        mostRecentQuantityDateInterval: {
-          from: new Date(mostRecentQuantityDateInterval.from),
-          to: new Date(mostRecentQuantityDateInterval.to),
-        },
-      }
-      : {}),
-  }
-
-  return response
-}
-
-const requestAuthorization = async (
-  read: readonly HealthkitReadAuthorization[],
-  write: readonly HealthkitWriteAuthorization[] = [],
-): Promise<boolean> => {
-  const readPermissions = read.reduce((obj, cur) => ({ ...obj, [cur]: true }), {} as ReadPermissions)
-
-  const writePermissions = write.reduce((obj, cur) => ({ ...obj, [cur]: true }), {} as WritePermissions)
-
-  return Native.requestAuthorization(writePermissions, readPermissions)
-}
-
-const getDateOfBirth = async () => {
-  const dateOfBirth = await Native.getDateOfBirth()
-  return new Date(dateOfBirth)
-}
-
-const getRequestStatusForAuthorization = async (
-  read: readonly HealthkitReadAuthorization[],
-  write: readonly HealthkitWriteAuthorization[] = [],
-) => {
-  const readPermissions = read.reduce((obj, cur) => ({ ...obj, [cur]: true }), {} as ReadPermissions)
-
-  const writePermissions = write.reduce((obj, cur) => ({ ...obj, [cur]: true }), {} as WritePermissions)
-
-  return Native.getRequestStatusForAuthorization(
-    writePermissions,
-    readPermissions,
-  )
-}
-
-const queryCategorySamples: QueryCategorySamplesFn = async (
-  identifier,
-  options,
-) => {
-  const opts = prepareOptions(options)
-  const results = await Native.queryCategorySamples(
-    identifier,
-    opts.from,
-    opts.to,
-    opts.limit,
-    opts.ascending,
-  )
-
-  return results.map(deserializCategorySample)
-}
-
-const queryWorkouts: QueryWorkoutsFn = async (options) => {
-  const { energyUnit, distanceUnit } = await getPreferredUnitsTyped(options)
-  const opts = prepareOptions(options)
-
-  const workouts = await Native.queryWorkoutSamples(
-    energyUnit,
-    distanceUnit,
-    opts.from,
-    opts.to,
-    opts.limit,
-    opts.ascending,
-  )
-
-  return workouts.map(deserializeWorkout)
-}
-
-const getMostRecentWorkout: GetMostRecentWorkoutFn = async (options) => {
-  const workouts = await queryWorkouts({
-    limit: 1,
-    ascending: false,
-    energyUnit: options?.energyUnit,
-    distanceUnit: options?.distanceUnit,
-  })
-
-  return workouts[0]
-}
-
-async function saveCategorySample<T extends HKCategoryTypeIdentifier>(
-  identifier: T,
-  value: HKCategoryValueForIdentifier<T>,
-  options?: {
-    readonly start?: Date;
-    readonly end?: Date;
-    readonly metadata?: MetadataMapperForCategoryIdentifier<T>;
-  },
-) {
-  const start = options?.start || options?.end || new Date()
-  const end = options?.end || options?.start || new Date()
-  const metadata = options?.metadata || {}
-
-  return Native.saveCategorySample(
-    identifier,
-    value,
-    start.toISOString(),
-    end.toISOString(),
-    metadata || {},
-  )
-}
-
-const getPreferredUnits: GetPreferredUnitsFn = async (identifiers) => {
-  const units = await Native.getPreferredUnits(identifiers)
-  return identifiers.map((i) => units[i])
-}
-
-const buildUnitWithPrefix = (prefix: HKUnitSIPrefix, unit: HKUnitSI) => `${prefix}${unit}` as HKUnit
-
-function deserializeCorrelation<
-  TIdentifier extends HKCorrelationTypeIdentifier
->(s: HKCorrelationRaw<TIdentifier>): HKCorrelation<TIdentifier> {
-  return {
-    ...s,
-    objects: s.objects.map((o) => {
-      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-      // @ts-ignore
-      if (o.quantity !== undefined) {
-        return deserializeSample(o as HKQuantitySampleRaw)
-      }
-
-      return deserializCategorySample(o as HKCategorySampleRaw)
-    }),
-    endDate: new Date(s.endDate),
-    startDate: new Date(s.startDate),
-  }
-}
-
-function ensureMetadata<TMetadata>(metadata?: TMetadata) {
-  return metadata || ({} as TMetadata)
-}
-
-const queryCorrelationSamples: QueryCorrelationSamplesFn = async (
-  typeIdentifier,
-  options,
-) => {
-  const opts = prepareOptions(options)
-  const correlations = await Native.queryCorrelationSamples(
-    typeIdentifier,
-    opts.from,
-    opts.to,
-  )
-
-  return correlations.map(deserializeCorrelation)
-}
-
-const saveCorrelationSample: SaveCorrelationSampleFn = async (
-  typeIdentifier,
-  samples,
-  options,
-) => {
-  const start = (options?.start || new Date()).toISOString()
-  const end = (options?.end || new Date()).toISOString()
-
-  return Native.saveCorrelationSample(
-    typeIdentifier,
-    samples,
-    start,
-    end,
-    ensureMetadata(options?.metadata),
-  )
-}
-
-const saveWorkoutSample: SaveWorkoutSampleFn = async (
-  typeIdentifier,
-  quantities,
-  _start,
-  options,
-) => {
-  const start = _start.toISOString()
-  const end = (options?.end || new Date()).toISOString()
-
-  return Native.saveWorkoutSample(
-    typeIdentifier,
-    quantities,
-    start,
-    end,
-    ensureMetadata(options?.metadata),
-  )
-}
-
-const getWorkoutRoutes: GetWorkoutRoutesFn = async (workoutUUID: string) => Native.getWorkoutRoutes(workoutUUID)
-
-const Healthkit: ReactNativeHealthkit = {
+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 useSubscribeToChanges from './hooks/useSubscribeToChanges'
+import Native from './native-types'
+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 queryCategorySamples from './utils/queryCategorySamples'
+import queryCorrelationSamples from './utils/queryCorrelationSamples'
+import queryQuantitySamples from './utils/queryQuantitySamples'
+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 saveWorkoutSample from './utils/saveWorkoutSample'
+import subscribeToChanges from './utils/subscribeToChanges'
+
+const Healthkit = {
   authorizationStatusFor: Native.authorizationStatusFor.bind(Native),
 
   isHealthDataAvailable: Native.isHealthDataAvailable.bind(Native),
 
-  buildUnitWithPrefix,
-
-  disableAllBackgroundDelivery: Native.disableAllBackgroundDelivery,
-  disableBackgroundDelivery: Native.disableBackgroundDelivery,
-  enableBackgroundDelivery: Native.enableBackgroundDelivery,
+  disableAllBackgroundDelivery: Native.disableAllBackgroundDelivery.bind(Native),
+  disableBackgroundDelivery: Native.disableBackgroundDelivery.bind(Native),
+  enableBackgroundDelivery: Native.enableBackgroundDelivery.bind(Native),
 
   // simple convenience getters
   getBiologicalSex: Native.getBiologicalSex.bind(Native),
   getFitzpatrickSkinType: Native.getFitzpatrickSkinType.bind(Native),
-  getWheelchairUse: Native.getWheelchairUse,
+  getWheelchairUse: Native.getWheelchairUse.bind(Native),
   getBloodType: Native.getBloodType.bind(Native),
+
+  getWorkoutRoutes: Native.getWorkoutRoutes.bind(Native),
+
   getDateOfBirth,
 
   getMostRecentQuantitySample,
@@ -553,8 +51,6 @@ const Healthkit: ReactNativeHealthkit = {
   getPreferredUnits,
   getRequestStatusForAuthorization,
 
-  getWorkoutRoutes,
-
   // query methods
   queryCategorySamples,
   queryCorrelationSamples,
@@ -581,39 +77,10 @@ const Healthkit: ReactNativeHealthkit = {
 
   useSubscribeToChanges,
 
-  useIsHealthDataAvailable: () => {
-    const [isAvailable, setIsAvailable] = useState<boolean | null>(null)
-    useEffect(() => {
-      const init = async () => {
-        const res = await Native.isHealthDataAvailable()
-        setIsAvailable(res)
-      }
-      void init()
-    }, [])
-    return isAvailable
-  },
-  useHealthkitAuthorization: (read, write) => {
-    const [status, setStatus] = useState<HKAuthorizationRequestStatus | null>(null)
-    const refreshAuthStatus = useCallback(async () => {
-      const auth = await getRequestStatusForAuthorization(read, write)
-      setStatus(auth)
-      return auth
-    }, [])
-
-    const request = useCallback(async () => {
-      await requestAuthorization(read, write)
-      return refreshAuthStatus()
-    }, [])
-
-    useEffect(() => {
-      void refreshAuthStatus()
-    }, [])
-
-    return [status, request]
-  },
+  useIsHealthDataAvailable,
+  useHealthkitAuthorization,
 }
 
-export * from './native-types'
 export * from './types'
 
 export default Healthkit

package/src/index.tsx

@@ -1,10 +1,10 @@
 import { Platform } from 'react-native'
 
 import {
-  HKAuthorizationRequestStatus, HKBiologicalSex, HKBloodType, HKFitzpatrickSkinType, HKUnit, HKWheelchairUse,
+  HKAuthorizationRequestStatus, HKBiologicalSex, HKBloodType, HKFitzpatrickSkinType, HKUnits, HKWheelchairUse,
 } from './native-types'
 
-import type { ReactNativeHealthkit } from './types'
+import type ReactNativeHealthkit from './index.ios'
 
 const notAvailableError = `[@kingstinct/react-native-healthkit] Platform "${
   Platform.OS
@@ -22,9 +22,8 @@ function UnavailableFn<T = unknown>(retVal: T) {
   }
 }
 
-const Healthkit: ReactNativeHealthkit = {
+const Healthkit: typeof ReactNativeHealthkit = {
   authorizationStatusFor: UnavailableFn(Promise.resolve(false)),
-  buildUnitWithPrefix: UnavailableFn(HKUnit.Atmospheres),
   disableAllBackgroundDelivery: UnavailableFn(Promise.resolve(false)),
   disableBackgroundDelivery: UnavailableFn(Promise.resolve(false)),
   enableBackgroundDelivery: UnavailableFn(Promise.resolve(false)),
@@ -35,7 +34,7 @@ const Healthkit: ReactNativeHealthkit = {
   getMostRecentCategorySample: UnavailableFn(Promise.resolve(null)),
   getMostRecentQuantitySample: UnavailableFn(Promise.resolve(null)),
   getMostRecentWorkout: UnavailableFn(Promise.resolve(null)),
-  getPreferredUnit: UnavailableFn(Promise.resolve(HKUnit.Atmospheres)),
+  getPreferredUnit: UnavailableFn(Promise.resolve(HKUnits.Count)),
   getPreferredUnits: UnavailableFn(Promise.resolve([])),
   getRequestStatusForAuthorization: UnavailableFn(Promise.resolve(HKAuthorizationRequestStatus.unknown)),
   getWheelchairUse: UnavailableFn(Promise.resolve(HKWheelchairUse.notSet)),
@@ -64,11 +63,10 @@ const Healthkit: ReactNativeHealthkit = {
   useMostRecentQuantitySample: UnavailableFn(null),
   useMostRecentWorkout: UnavailableFn(null),
   useSubscribeToChanges: UnavailableFn([null, () => null]),
-  useHealthkitAuthorization: UnavailableFn([null, async () => Promise.resolve(null)] as const),
+  useHealthkitAuthorization: UnavailableFn([null, async () => Promise.resolve(HKAuthorizationRequestStatus.unknown)] as const),
   useIsHealthDataAvailable: () => false,
 }
 
-export * from './native-types'
 export * from './types'
 
 export default Healthkit