@kingstinct/react-native-healthkit 8.7.2 → 9.0.1

package/src/types/Workouts.ts

@@ -0,0 +1,282 @@
+import type { AnyMap } from 'react-native-nitro-modules'
+import type { WorkoutProxy } from '../specs/WorkoutProxy.nitro'
+import type { Device } from './Device'
+import type { Quantity } from './QuantityType'
+import type { PredicateForSamples } from './QueryOptions'
+import type { DeletedSample, GenericMetadata } from './Shared'
+import type { SourceRevision } from './Source'
+
+export enum WorkoutActivityType {
+  americanFootball = 1,
+  archery = 2,
+  australianFootball = 3,
+  badminton = 4,
+  baseball = 5,
+  basketball = 6,
+  bowling = 7,
+  boxing = 8, // See also HKWorkoutActivityTypeKickboxing.,
+  climbing = 9,
+  cricket = 10,
+  crossTraining = 11, // Any mix of cardio and/or strength training. See also HKWorkoutActivityTypeCoreTraining and HKWorkoutActivityTypeFlexibility.,
+  curling = 12,
+  cycling = 13,
+  dance = 14,
+  danceInspiredTraining = 15, // This enum remains available to access older data.,
+  elliptical = 16,
+  equestrianSports = 17, // Polo, Horse Racing, Horse Riding, etc.,
+  fencing = 18,
+  fishing = 19,
+  functionalStrengthTraining = 20, // Primarily free weights and/or body weight and/or accessories,
+  golf = 21,
+  gymnastics = 22,
+  handball = 23,
+  hiking = 24,
+  hockey = 25, // Ice Hockey, Field Hockey, etc.,
+  hunting = 26,
+  lacrosse = 27,
+  martialArts = 28,
+  mindAndBody = 29, // Qigong, meditation, etc.,
+  mixedMetabolicCardioTraining = 30, // This enum remains available to access older data.,
+  paddleSports = 31, // Canoeing, Kayaking, Outrigger, Stand Up Paddle Board, etc.,
+  play = 32, // Dodge Ball, Hopscotch, Tetherball, Jungle Gym, etc.,
+  preparationAndRecovery = 33, // Foam rolling, stretching, etc.,
+  racquetball = 34,
+  rowing = 35,
+  rugby = 36,
+  running = 37,
+  sailing = 38,
+  skatingSports = 39, // Ice Skating, Speed Skating, Inline Skating, Skateboarding, etc.,
+  snowSports = 40, // Sledding, Snowmobiling, Building a Snowman, etc. See also HKWorkoutActivityTypeCrossCountrySkiing, HKWorkoutActivityTypeSnowboarding, and HKWorkoutActivityTypeDownhillSkiing.,
+  soccer = 41,
+  softball = 42,
+  squash = 43,
+  stairClimbing = 44, // See also HKWorkoutActivityTypeStairs and HKWorkoutActivityTypeStepTraining.,
+  surfingSports = 45, // Traditional Surfing, Kite Surfing, Wind Surfing, etc.,
+  swimming = 46,
+  tableTennis = 47,
+  tennis = 48,
+  trackAndField = 49, // Shot Put, Javelin, Pole Vaulting, etc.,
+  traditionalStrengthTraining = 50, // Primarily machines and/or free weights,
+  volleyball = 51,
+  walking = 52,
+  waterFitness = 53,
+  waterPolo = 54,
+  waterSports = 55, // Water Skiing, Wake Boarding, etc.,
+  wrestling = 56,
+  yoga = 57,
+  barre = 58, // HKWorkoutActivityTypeDanceInspiredTraining,
+  coreTraining = 59,
+  crossCountrySkiing = 60,
+  downhillSkiing = 61,
+  flexibility = 62,
+  highIntensityIntervalTraining = 63,
+  jumpRope = 64,
+  kickboxing = 65,
+  pilates = 66, // HKWorkoutActivityTypeDanceInspiredTraining,
+  snowboarding = 67,
+  stairs = 68,
+  stepTraining = 69,
+  wheelchairWalkPace = 70,
+  wheelchairRunPace = 71,
+  taiChi = 72,
+  mixedCardio = 73, // HKWorkoutActivityTypeMixedMetabolicCardioTraining,
+  handCycling = 74,
+  discSports = 75,
+  fitnessGaming = 76,
+  cardioDance = 77,
+  socialDance = 78,
+  pickleball = 79,
+  cooldown = 80,
+  swimBikeRun = 82,
+  transition = 83,
+  underwaterDiving = 84,
+  other = 3000,
+}
+
+// documented at https://developer.apple.com/documentation/healthkit/hkweathercondition
+export enum WeatherCondition {
+  none = 0,
+  clear = 1,
+  fair = 2,
+  partlyCloudy = 3,
+  mostlyCloudy = 4,
+  cloudy = 5,
+  foggy = 6,
+  haze = 7,
+  windy = 8,
+  blustery = 9,
+  smoky = 10,
+  dust = 11,
+  snow = 12,
+  hail = 13,
+  sleet = 14,
+  freezingDrizzle = 15,
+  freezingRain = 16,
+  mixedRainAndHail = 17,
+  mixedRainAndSnow = 18,
+  mixedRainAndSleet = 19,
+  mixedSnowAndSleet = 20,
+  drizzle = 21,
+  scatteredShowers = 22,
+  showers = 23,
+  thunderstorms = 24,
+  tropicalStorm = 25,
+  hurricane = 26,
+  tornado = 27,
+}
+
+export interface WorkoutMetadata extends GenericMetadata {
+  readonly HKWeatherCondition?: WeatherCondition
+  readonly HKWeatherHumidity?: Quantity
+  readonly HKWeatherTemperature?: Quantity
+  readonly HKAverageMETs?: Quantity
+  readonly HKElevationAscended?: Quantity
+  readonly HKIndoorWorkout?: boolean
+}
+
+export interface WorkoutEvent {
+  readonly type: WorkoutEventType
+  readonly startDate: Date
+  readonly endDate: Date
+}
+
+export enum WorkoutEventType {
+  pause = 1,
+  resume = 2,
+  lap = 3,
+  marker = 4,
+  motionPaused = 5,
+  motionResumed = 6,
+  segment = 7,
+  pauseOrResumeRequest = 8,
+}
+
+export interface WorkoutActivity {
+  readonly startDate: Date
+  readonly endDate: Date
+  readonly uuid: string
+  readonly duration: number
+}
+
+export interface WorkoutRoute {
+  readonly locations: readonly WorkoutRouteLocation[]
+  readonly HKMetadataKeySyncIdentifier?: string
+  readonly HKMetadataKeySyncVersion?: number
+}
+
+export interface QueryWorkoutSamplesWithAnchorResponse {
+  readonly workouts: readonly WorkoutProxy[]
+  readonly deletedSamples: readonly DeletedSample[]
+  readonly newAnchor: string
+}
+
+type WorkoutActivityTypePredicate = {
+  readonly workoutActivityType: WorkoutActivityType
+}
+
+enum ComparisonPredicateOperator {
+  lessThan = 0,
+  lessThanOrEqualTo = 1,
+  greaterThan = 2,
+  greaterThanOrEqualTo = 3,
+  equalTo = 4,
+  notEqualTo = 5,
+  matches = 6,
+  like = 7,
+  beginsWith = 8,
+  endsWith = 9,
+  in = 10,
+  customSelector = 11,
+  contains = 99,
+  between = 100,
+}
+
+type WorkoutDurationPredicate = {
+  readonly predicateOperator: ComparisonPredicateOperator
+  readonly durationInSeconds: number
+}
+
+export type PredicateForWorkouts =
+  | PredicateForSamples
+  | WorkoutActivityTypePredicate
+  | WorkoutDurationPredicate
+
+export type PredicateForWorkoutsOr = {
+  readonly OR: readonly PredicateForWorkouts[]
+}
+
+export type PredicateForWorkoutsAnd = {
+  readonly AND: readonly PredicateForWorkouts[]
+}
+
+export type FilterForWorkouts =
+  | PredicateForWorkouts
+  | PredicateForWorkoutsOr
+  | PredicateForWorkoutsAnd
+
+export interface WorkoutQueryOptionsWithAnchor {
+  energyUnit?: string
+  distanceUnit?: string
+  filter?: FilterForWorkouts
+  limit?: number
+  anchor?: string
+}
+
+export interface WorkoutQueryOptions {
+  energyUnit?: string
+  distanceUnit?: string
+  filter?: FilterForWorkouts
+  limit?: number
+  ascending?: boolean
+}
+
+export interface WorkoutRouteLocation {
+  readonly altitude: number
+  readonly course: number
+  readonly date: Date
+  readonly distance: number | null
+  readonly horizontalAccuracy: number
+  readonly latitude: number
+  readonly longitude: number
+  readonly speed: number
+  readonly speedAccuracy: number
+  readonly verticalAccuracy: number
+}
+
+export interface LocationForSaving {
+  readonly altitude: number
+  readonly course: number
+  readonly date: Date // unix timestamp in milliseconds
+  readonly horizontalAccuracy: number
+  readonly latitude: number
+  readonly longitude: number
+  readonly speed: number
+  readonly verticalAccuracy: number
+}
+
+export interface WorkoutPlan {
+  readonly id: string
+  readonly activityType: WorkoutActivityType
+}
+
+export interface WorkoutTotals {
+  readonly distance?: number
+  readonly energyBurned?: number
+}
+
+export interface WorkoutSample {
+  readonly uuid: string
+  readonly device?: Device
+  readonly workoutActivityType: WorkoutActivityType
+  readonly duration: Quantity
+  readonly totalDistance?: Quantity
+  readonly totalEnergyBurned?: Quantity
+  readonly totalSwimmingStrokeCount?: Quantity
+  readonly totalFlightsClimbed?: Quantity
+  readonly startDate: Date
+  readonly endDate: Date
+  readonly metadata?: AnyMap
+  readonly sourceRevision?: SourceRevision
+  readonly events?: readonly WorkoutEvent[]
+  readonly activities?: readonly WorkoutActivity[]
+}

package/src/utils/getMostRecentCategorySample.ts

@@ -1,19 +1,15 @@
-import queryCategorySamples from './queryCategorySamples'
+import { CategoryTypes } from '../modules'
+import type { CategoryTypeIdentifier } from '../types/CategoryTypeIdentifier'
 
-import type { HKCategoryTypeIdentifier } from '../native-types'
-import type { HKCategorySample } from '../types'
-
-async function getMostRecentCategorySample<
-  T extends HKCategoryTypeIdentifier
->(
-  identifier: T,
-): Promise<HKCategorySample<T> | null> {
-  const samples = await queryCategorySamples(identifier, {
+export async function getMostRecentCategorySample<
+  T extends CategoryTypeIdentifier,
+>(identifier: T) {
+  const samples = await CategoryTypes.queryCategorySamples(identifier, {
     limit: 1,
     ascending: false,
   })
 
-  return samples[0] ?? null
+  return samples[0]
 }
 
 export default getMostRecentCategorySample

package/src/utils/getMostRecentQuantitySample.ts

@@ -1,26 +1,16 @@
-import queryQuantitySamples from './queryQuantitySamples'
+import { QuantityTypes } from '../modules'
+import type { QuantityTypeIdentifier } from '../types/QuantityTypeIdentifier'
 
-import type { HKQuantityTypeIdentifier, UnitForIdentifier } from '../native-types'
-import type { HKQuantitySample } from '../types'
-
-async function getMostRecentQuantitySample<
-  TIdentifier extends HKQuantityTypeIdentifier,
-  TUnit extends UnitForIdentifier<TIdentifier>
->(
-  identifier: TIdentifier,
-  unit: TUnit,
-): Promise<HKQuantitySample<TIdentifier, TUnit> | null> {
-  const samples = await queryQuantitySamples(identifier, {
+async function getMostRecentQuantitySample(
+  identifier: QuantityTypeIdentifier,
+  unit?: string,
+) {
+  const samples = await QuantityTypes.queryQuantitySamples(identifier, {
     limit: 1,
     unit,
   })
 
-  const lastSample = samples[0]
-
-  if (lastSample) {
-    return lastSample as HKQuantitySample<TIdentifier, TUnit>
-  }
-  return null
+  return samples[0]
 }
 
 export default getMostRecentQuantitySample

package/src/utils/getMostRecentWorkout.ts

@@ -1,27 +1,17 @@
-import queryWorkouts from './queryWorkouts'
+import { Workouts } from '../modules'
+import type { WorkoutQueryOptions } from '../types/Workouts'
 
-import type { EnergyUnit, LengthUnit } from '../native-types'
-import type { HKWorkout, QueryWorkoutsOptions } from '../types'
-
-export type GetMostRecentWorkoutFn = <
-  TEnergy extends EnergyUnit,
-  TDistance extends LengthUnit
->(
-  options?: Pick<
-  QueryWorkoutsOptions<TEnergy, TDistance>,
-  'distanceUnit' | 'energyUnit'
-  >
-) => Promise<HKWorkout<TEnergy, TDistance> | null>;
-
-const getMostRecentWorkout: GetMostRecentWorkoutFn = async (options) => {
-  const workouts = await queryWorkouts({
+const getMostRecentWorkout = async (
+  options: Pick<WorkoutQueryOptions, 'distanceUnit' | 'energyUnit'>,
+) => {
+  const workouts = await Workouts.queryWorkoutSamples({
     limit: 1,
     ascending: false,
     energyUnit: options?.energyUnit,
     distanceUnit: options?.distanceUnit,
   })
 
-  return workouts[0] || null
+  return workouts[0]
 }
 
 export default getMostRecentWorkout

package/src/utils/getPreferredUnit.ts

@@ -1,14 +1,18 @@
-import getPreferredUnits from './getPreferredUnits'
+import { Core } from '../modules'
+import type { QuantityTypeIdentifier } from '../types/QuantityTypeIdentifier'
 
-import type { HKQuantityTypeIdentifier, HKUnit } from '../native-types'
+const getPreferredUnit = async (
+  quantityType: QuantityTypeIdentifier,
+): Promise<string> => {
+  const units = await Core.getPreferredUnits([quantityType])
+  const unit = units[0]?.unit
 
-export type GetPreferredUnitFn = (
-  identifier: HKQuantityTypeIdentifier
-) => Promise<HKUnit | undefined>;
+  if (!unit) {
+    throw new Error(
+      `No preferred unit found for quantity type: ${quantityType}`,
+    )
+  }
 
-const getPreferredUnit: GetPreferredUnitFn = async (type) => {
-  const [unit] = await getPreferredUnits([type])
   return unit
 }
-
 export default getPreferredUnit

package/src/utils/subscribeToChanges.ts

@@ -1,31 +1,14 @@
-import Native, { EventEmitter } from '../native-types'
+import { Core } from '../modules'
+import type { SampleTypeIdentifier } from '../types/Shared'
+import type { OnChangeCallbackArgs } from '../types/Subscriptons'
 
-import type { HKSampleTypeIdentifier } from '..'
-
-const subscribeToChanges = async (
-  identifier: HKSampleTypeIdentifier,
-  callback: () => void,
+export const subscribeToChanges = (
+  identifier: SampleTypeIdentifier,
+  callback: (args: OnChangeCallbackArgs) => void,
 ) => {
-  const subscription = EventEmitter.addListener(
-    'onChange',
-    ({ typeIdentifier }: { readonly typeIdentifier: HKSampleTypeIdentifier }) => {
-      if (typeIdentifier === identifier) {
-        callback()
-      }
-    },
-  )
-
-  const queryId = await Native.subscribeToObserverQuery(identifier).catch(
-    async (error) => {
-      subscription.remove()
-      return Promise.reject(error)
-    },
-  )
+  const queryId = Core.subscribeToObserverQuery(identifier, callback)
 
-  return async () => {
-    subscription.remove()
-    return Native.unsubscribeQuery(queryId)
+  return {
+    remove: () => Core.unsubscribeQuery(queryId),
   }
 }
-
-export default subscribeToChanges

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020 Robert Herber
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/ios/ReactNativeHealthkit-Bridging-Header.h

@@ -1,2 +0,0 @@
-#import <React/RCTBridgeModule.h>
-#import <React/RCTEventEmitter.h>