@kingstinct/react-native-healthkit 13.3.1 → 14.0.0

package/src/types/QueryOptions.ts

@@ -102,11 +102,18 @@ export interface QueryOptionsWithSortOrder extends GenericQueryOptions {
   readonly ascending?: boolean
 }
 
-export interface QueryOptionsWithSortOrderAndUnit
+export interface QueryOptionsWithSortOrderAndUnit<TUnit extends string = string>
   extends QueryOptionsWithSortOrder {
-  readonly unit?: string
+  readonly unit?: TUnit
 }
 
-export interface QueryOptionsWithAnchorAndUnit extends QueryOptionsWithAnchor {
-  readonly unit?: string
+export interface QueryOptionsWithAnchorAndUnit<TUnit extends string = string>
+  extends QueryOptionsWithAnchor {
+  readonly unit?: TUnit
 }
+
+export interface QueryOptionsWithSortOrderAndStringUnit
+  extends QueryOptionsWithSortOrderAndUnit<string> {}
+
+export interface QueryOptionsWithAnchorAndStringUnit
+  extends QueryOptionsWithAnchorAndUnit<string> {}

package/src/types/Shared.ts

@@ -1,4 +1,8 @@
 import type { AnyMap } from 'react-native-nitro-modules'
+import type {
+  KnownObjectMetadata,
+  KnownSampleMetadata,
+} from '../generated/healthkit.generated'
 import type {
   CategoryTypeIdentifier,
   CategoryTypeIdentifierWriteable,
@@ -17,17 +21,11 @@ import type {
 } from './Constants'
 import type { CorrelationTypeIdentifier } from './CorrelationType'
 import type { Device } from './Device'
-import type {
-  HeartRateMotionContext,
-  InsulinDeliveryReason,
-  Quantity,
-} from './QuantityType'
 import type {
   QuantityTypeIdentifier,
   QuantityTypeIdentifierWriteable,
 } from './QuantityTypeIdentifier'
 import type { SourceRevision } from './Source'
-import type { WeatherCondition } from './WeatherCondition'
 
 export interface DeletedSample {
   readonly uuid: string
@@ -64,45 +62,30 @@ export type SampleTypeIdentifierWriteable =
   | typeof WorkoutRouteTypeIdentifier
   | typeof WorkoutTypeIdentifier
 
-export interface GenericMetadata {
-  readonly HKExternalUUID?: string
-  readonly HKTimeZone?: string
-  readonly HKWasUserEntered?: boolean
-  readonly HKDeviceSerialNumber?: string
-  readonly HKUDIDeviceIdentifier?: string
-  readonly HKUDIProductionIdentifier?: string
-  readonly HKDigitalSignature?: string
-  readonly HKDeviceName?: string
-  readonly HKDeviceManufacturerName?: string
-  readonly HKSyncIdentifier?: string
-  readonly HKSyncVersion?: number
-  readonly HKWasTakenInLab?: boolean
-  readonly HKReferenceRangeLowerLimit?: number
-  readonly HKReferenceRangeUpperLimit?: number
+export type MetadataWithUnknown<T extends object> = AnyMap & T
+export type GenericMetadata = AnyMap & KnownObjectMetadata
+export type WithTypedMetadata<T, TMetadata extends object> = Omit<
+  T,
+  'metadata'
+> & {
+  readonly metadata: AnyMap & TMetadata
+}
+export type WithOptionalTypedMetadata<T, TMetadata extends object> = Omit<
+  T,
+  'metadata'
+> & {
+  readonly metadata?: AnyMap & TMetadata
 }
+export type BaseObjectTyped<TMetadata extends object = KnownObjectMetadata> =
+  WithTypedMetadata<BaseObject, TMetadata>
+export type BaseSampleTyped<TMetadata extends object = KnownSampleMetadata> =
+  WithTypedMetadata<BaseSample, TMetadata>
 
 export interface BaseObject {
   readonly uuid: string
   readonly sourceRevision: SourceRevision
   readonly device?: Device
   readonly metadata: AnyMap
-
-  // metadata
-  readonly metadataExternalUUID?: string
-  readonly metadataTimeZone?: string
-  readonly metadataWasUserEntered?: boolean
-  readonly metadataDeviceSerialNumber?: string
-  readonly metadataUdiDeviceIdentifier?: string
-  readonly metadataUdiProductionIdentifier?: string
-  readonly metadataDigitalSignature?: string
-  readonly metadataDeviceName?: string
-  readonly metadataDeviceManufacturerName?: string
-  readonly metadataSyncIdentifier?: string
-  readonly metadataSyncVersion?: number
-  readonly metadataWasTakenInLab?: boolean
-  readonly metadataReferenceRangeLowerLimit?: number
-  readonly metadataReferenceRangeUpperLimit?: number
-  readonly metadataAlgorithmVersion?: number
 }
 
 export interface SampleType {
@@ -117,15 +100,5 @@ export interface BaseSample extends BaseObject {
   readonly startDate: Date
   readonly endDate: Date
   readonly hasUndeterminedDuration: boolean
-
-  // metadata
-  readonly metadataWeatherCondition?: WeatherCondition
-  readonly metadataWeatherHumidity?: Quantity
-  readonly metadataWeatherTemperature?: Quantity
-  readonly metadataInsulinDeliveryReason?: InsulinDeliveryReason
-  /**
-   * postprandial or preprandial (https://developer.apple.com/documentation/healthkit/hkbloodglucosemealtime)
-   */
-  // readonly metadataBloodGlucoseMealTime?: number
-  readonly metadataHeartRateMotionContext?: HeartRateMotionContext
+  readonly metadata: AnyMap
 }

package/src/types/StateOfMind.ts

@@ -1,4 +1,5 @@
-import type { BaseSample, DeletedSample } from './Shared'
+import type { KnownSampleMetadata } from '../generated/healthkit.generated'
+import type { BaseSample, DeletedSample, WithTypedMetadata } from './Shared'
 
 export enum StateOfMindValenceClassification {
   veryUnpleasant = 1,
@@ -23,12 +24,23 @@ export interface StateOfMindSample extends BaseSample {
   readonly labels: readonly StateOfMindLabel[]
 }
 
+export type StateOfMindSampleTyped = WithTypedMetadata<
+  StateOfMindSample,
+  KnownSampleMetadata
+>
+
 export interface StateOfMindSamplesWithAnchorResponse {
   readonly samples: readonly StateOfMindSample[]
   readonly deletedSamples: readonly DeletedSample[]
   readonly newAnchor: string
 }
 
+export interface StateOfMindSamplesWithAnchorResponseTyped {
+  readonly samples: readonly StateOfMindSampleTyped[]
+  readonly deletedSamples: readonly DeletedSample[]
+  readonly newAnchor: string
+}
+
 /**
  * @see {@link https://developer.apple.com/documentation/healthkit/hkstateofmind/label Apple Docs}
  */

package/src/types/Subscriptions.ts

@@ -1,6 +1,6 @@
 import type { CategorySampleTyped } from './CategoryType'
 import type { CategoryTypeIdentifier } from './CategoryTypeIdentifier'
-import type { QuantitySample } from './QuantitySample'
+import type { QuantitySampleTyped } from './QuantitySample'
 import type { QuantityTypeIdentifier } from './QuantityTypeIdentifier'
 import type { SampleTypeIdentifier } from './Shared'
 
@@ -13,32 +13,38 @@ export interface OnChangeCallbackArgs {
   readonly errorMessage?: string
 }
 
-export interface OnQuantitySamplesCallbackError {
-  readonly typeIdentifier: QuantityTypeIdentifier
+export interface OnQuantitySamplesCallbackError<
+  T extends QuantityTypeIdentifier = QuantityTypeIdentifier,
+> {
+  readonly typeIdentifier: T
   readonly errorMessage: string
 }
 
-export interface OnQuantitySamplesCallbackSuccess {
-  readonly typeIdentifier: QuantityTypeIdentifier
-  readonly samples: readonly QuantitySample[]
+export interface OnQuantitySamplesCallbackSuccess<
+  T extends QuantityTypeIdentifier = QuantityTypeIdentifier,
+> {
+  readonly typeIdentifier: T
+  readonly samples: readonly QuantitySampleTyped<T>[]
 }
 
-export type OnQuantitySamplesCallback =
-  | OnQuantitySamplesCallbackError
-  | OnQuantitySamplesCallbackSuccess
+export type OnQuantitySamplesCallback<
+  T extends QuantityTypeIdentifier = QuantityTypeIdentifier,
+> = OnQuantitySamplesCallbackError<T> | OnQuantitySamplesCallbackSuccess<T>
 
-export interface OnCategorySamplesCallbackError {
-  readonly typeIdentifier: CategoryTypeIdentifier
+export interface OnCategorySamplesCallbackError<
+  T extends CategoryTypeIdentifier = CategoryTypeIdentifier,
+> {
+  readonly typeIdentifier: T
   readonly errorMessage: string
 }
 
 export interface OnCategorySamplesCallbackSuccess<
   T extends CategoryTypeIdentifier,
 > {
-  readonly typeIdentifier: CategoryTypeIdentifier
+  readonly typeIdentifier: T
   readonly samples: readonly CategorySampleTyped<T>[]
 }
 
 export type OnCategorySamplesCallback<T extends CategoryTypeIdentifier> =
-  | OnCategorySamplesCallbackError
+  | OnCategorySamplesCallbackError<T>
   | OnCategorySamplesCallbackSuccess<T>

package/src/types/WeatherCondition.ts

@@ -1,31 +1 @@
-// 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 { WeatherCondition } from '../generated/healthkit.generated'

package/src/types/Workouts.ts

@@ -1,112 +1,35 @@
+import type { AnyMap } from 'react-native-nitro-modules'
+import type {
+  WorkoutEventTypedMetadata,
+  WorkoutTypedMetadata,
+} from '../generated/healthkit.generated'
+import {
+  WorkoutActivityType,
+  WorkoutEventType,
+} from '../generated/healthkit.generated'
 import type { WorkoutProxy } from '../specs/WorkoutProxy.nitro'
 import type { BaseSample, ComparisonPredicateOperator } from '../types'
 import type { Quantity } from './QuantityType'
 import type { FilterForSamplesBase } from './QueryOptions'
-import type { DeletedSample } from './Shared'
-
-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,
-}
+import type {
+  DeletedSample,
+  WithOptionalTypedMetadata,
+  WithTypedMetadata,
+} from './Shared'
+
+export { WorkoutActivityType, WorkoutEventType }
 
 export interface WorkoutEvent {
   readonly type: WorkoutEventType
   readonly startDate: Date
   readonly endDate: Date
+  readonly metadata?: AnyMap
 }
 
-export enum WorkoutEventType {
-  pause = 1,
-  resume = 2,
-  lap = 3,
-  marker = 4,
-  motionPaused = 5,
-  motionResumed = 6,
-  segment = 7,
-  pauseOrResumeRequest = 8,
-}
+export type WorkoutEventTyped = WithOptionalTypedMetadata<
+  WorkoutEvent,
+  WorkoutEventTypedMetadata
+>
 
 export interface WorkoutActivity {
   readonly startDate: Date
@@ -127,6 +50,12 @@ export interface QueryWorkoutSamplesWithAnchorResponse {
   readonly newAnchor: string
 }
 
+export interface QueryWorkoutSamplesWithAnchorResponseTyped {
+  readonly workouts: readonly WorkoutProxyTyped[]
+  readonly deletedSamples: readonly DeletedSample[]
+  readonly newAnchor: string
+}
+
 export type WorkoutDurationPredicate = {
   readonly predicateOperator: ComparisonPredicateOperator
   readonly durationInSeconds: number
@@ -178,7 +107,7 @@ export interface WorkoutRouteLocation {
 export interface LocationForSaving {
   readonly altitude: number
   readonly course: number
-  readonly date: Date // unix timestamp in milliseconds
+  readonly date: Date
   readonly horizontalAccuracy: number
   readonly latitude: number
   readonly longitude: number
@@ -196,7 +125,7 @@ export interface WorkoutTotals {
   readonly energyBurned?: number
 }
 
-export interface WorkoutSample extends BaseSample {
+export interface WorkoutSample extends Omit<BaseSample, 'metadata'> {
   readonly workoutActivityType: WorkoutActivityType
   readonly duration: Quantity
   readonly totalEnergyBurned?: Quantity
@@ -205,11 +134,20 @@ export interface WorkoutSample extends BaseSample {
   readonly totalFlightsClimbed?: Quantity
   readonly events?: readonly WorkoutEvent[]
   readonly activities?: readonly WorkoutActivity[]
-
-  readonly metadataAverageMETs?: Quantity
-  readonly metadataElevationAscended?: Quantity
-  readonly metadataElevationDescended?: Quantity
-  readonly metadataIndoorWorkout?: boolean
-  readonly metadataAverageSpeed?: Quantity
-  readonly metadataMaximumSpeed?: Quantity
-}
+  readonly metadata: AnyMap
+}
+
+export type WorkoutSampleTyped = WithTypedMetadata<
+  Omit<WorkoutSample, 'events'> & {
+    readonly events?: readonly WorkoutEventTyped[]
+  },
+  WorkoutTypedMetadata
+>
+
+export type WorkoutProxyTyped = Omit<
+  WorkoutProxy,
+  keyof WorkoutSample | 'toJSON'
+> &
+  WorkoutSampleTyped & {
+    toJSON(key?: string): WorkoutSampleTyped
+  }

package/src/types/index.ts

@@ -7,6 +7,8 @@ export * from './Constants'
 export * from './CorrelationType'
 export * from './Device'
 export * from './HeartbeatSeries'
+export * from './Medication'
+export * from './MetadataEnums'
 export * from './QuantitySample'
 export * from './QuantityType'
 export * from './QuantityTypeIdentifier'

package/src/utils/getMostRecentQuantitySample.ts

@@ -1,9 +1,10 @@
 import { QuantityTypes } from '../modules'
+import type { UnitForIdentifier } from '../types/QuantityType'
 import type { QuantityTypeIdentifier } from '../types/QuantityTypeIdentifier'
 
-async function getMostRecentQuantitySample(
-  identifier: QuantityTypeIdentifier,
-  unit?: string,
+async function getMostRecentQuantitySample<T extends QuantityTypeIdentifier>(
+  identifier: T,
+  unit?: UnitForIdentifier<T>,
 ) {
   const samples = await QuantityTypes.queryQuantitySamples(identifier, {
     limit: 1,

package/src/utils/getMostRecentWorkout.ts

@@ -1,12 +1,15 @@
 import { Workouts } from '../modules'
+import type { WorkoutProxyTyped } from '../types/Workouts'
 
-const getMostRecentWorkout = async () => {
+const getMostRecentWorkout = async (): Promise<
+  WorkoutProxyTyped | undefined
+> => {
   const workouts = await Workouts.queryWorkoutSamples({
     limit: 1,
     ascending: false,
   })
 
-  return workouts[0]
+  return workouts[0] as WorkoutProxyTyped | undefined
 }
 
 export default getMostRecentWorkout

package/src/utils/getPreferredUnit.ts

@@ -1,9 +1,10 @@
 import { Core } from '../modules'
+import type { UnitForIdentifier } from '../types/QuantityType'
 import type { QuantityTypeIdentifier } from '../types/QuantityTypeIdentifier'
 
-const getPreferredUnit = async (
-  quantityType: QuantityTypeIdentifier,
-): Promise<string> => {
+const getPreferredUnit = async <T extends QuantityTypeIdentifier>(
+  quantityType: T,
+): Promise<UnitForIdentifier<T>> => {
   const units = await Core.getPreferredUnits([quantityType])
   const unit = units[0]?.unit
 
@@ -13,6 +14,6 @@ const getPreferredUnit = async (
     )
   }
 
-  return unit
+  return unit as UnitForIdentifier<T>
 }
 export default getPreferredUnit

package/src/utils/getQuantitySampleById.ts

@@ -1,10 +1,11 @@
 import { QuantityTypes } from '../modules'
+import type { UnitForIdentifier } from '../types/QuantityType'
 import type { QuantityTypeIdentifier } from '../types/QuantityTypeIdentifier'
 
-async function getQuantitySampleById(
-  identifier: QuantityTypeIdentifier,
+async function getQuantitySampleById<T extends QuantityTypeIdentifier>(
+  identifier: T,
   uuid: string,
-  unit?: string,
+  unit?: UnitForIdentifier<T>,
 ) {
   const samples = await QuantityTypes.queryQuantitySamples(identifier, {
     limit: 1,

package/src/utils/subscribeToQuantitySamples.ts

@@ -3,9 +3,11 @@ import type { QuantityTypeIdentifier } from '../types'
 import type { OnQuantitySamplesCallback } from '../types/Subscriptions'
 import { subscribeToChanges } from './subscribeToChanges'
 
-export const subscribeToQuantitySamples = (
-  identifier: QuantityTypeIdentifier,
-  callback: (args: OnQuantitySamplesCallback) => void,
+export const subscribeToQuantitySamples = <
+  TIdentifier extends QuantityTypeIdentifier,
+>(
+  identifier: TIdentifier,
+  callback: (args: OnQuantitySamplesCallback<TIdentifier>) => void,
   after = new Date(),
 ) => {
   return subscribeToChanges(identifier, async ({ errorMessage }) => {

package/nitrogen/generated/ios/swift/HeartRateMotionContext.swift

@@ -1,44 +0,0 @@
-///
-/// HeartRateMotionContext.swift
-/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
-/// https://github.com/mrousavy/nitro
-/// Copyright © Marc Rousavy @ Margelo
-///
-
-/**
- * Represents the JS enum `HeartRateMotionContext`, backed by a C++ enum.
- */
-public typealias HeartRateMotionContext = margelo.nitro.healthkit.HeartRateMotionContext
-
-public extension HeartRateMotionContext {
-  /**
-   * Get a HeartRateMotionContext for the given String value, or
-   * return `nil` if the given value was invalid/unknown.
-   */
-  init?(fromString string: String) {
-    switch string {
-      case "active":
-        self = .active
-      case "notSet":
-        self = .notset
-      case "sedentary":
-        self = .sedentary
-      default:
-        return nil
-    }
-  }
-
-  /**
-   * Get the String value this HeartRateMotionContext represents.
-   */
-  var stringValue: String {
-    switch self {
-      case .active:
-        return "active"
-      case .notset:
-        return "notSet"
-      case .sedentary:
-        return "sedentary"
-    }
-  }
-}

package/nitrogen/generated/ios/swift/InsulinDeliveryReason.swift

@@ -1,40 +0,0 @@
-///
-/// InsulinDeliveryReason.swift
-/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
-/// https://github.com/mrousavy/nitro
-/// Copyright © Marc Rousavy @ Margelo
-///
-
-/**
- * Represents the JS enum `InsulinDeliveryReason`, backed by a C++ enum.
- */
-public typealias InsulinDeliveryReason = margelo.nitro.healthkit.InsulinDeliveryReason
-
-public extension InsulinDeliveryReason {
-  /**
-   * Get a InsulinDeliveryReason for the given String value, or
-   * return `nil` if the given value was invalid/unknown.
-   */
-  init?(fromString string: String) {
-    switch string {
-      case "basal":
-        self = .basal
-      case "bolus":
-        self = .bolus
-      default:
-        return nil
-    }
-  }
-
-  /**
-   * Get the String value this InsulinDeliveryReason represents.
-   */
-  var stringValue: String {
-    switch self {
-      case .basal:
-        return "basal"
-      case .bolus:
-        return "bolus"
-    }
-  }
-}