@kingstinct/react-native-healthkit 8.7.2 → 9.0.0

package/src/types/CategoryTypeIdentifier.ts

@@ -0,0 +1,99 @@
+export type CategoryTypeIdentifierReadOnly =
+  | 'HKCategoryTypeIdentifierAppleStandHour'
+  | 'HKCategoryTypeIdentifierHighHeartRateEvent'
+  | 'HKCategoryTypeIdentifierLowHeartRateEvent'
+  | 'HKCategoryTypeIdentifierHeadphoneAudioExposureEvent'
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategorytypeidentifier Apple Docs }
+ */
+export type CategoryTypeIdentifierWriteable =
+  | 'HKCategoryTypeIdentifierSleepAnalysis'
+  | 'HKCategoryTypeIdentifierCervicalMucusQuality'
+  | 'HKCategoryTypeIdentifierOvulationTestResult'
+  /**
+   * @deprecated In iOS 18 beta
+   * @see {@link https://developer.apple.com/documentation/healthkit/hkcategorytypeidentifiermenstrualflow Apple Docs }
+   */
+  | 'HKCategoryTypeIdentifierMenstrualFlow'
+  | 'HKCategoryTypeIdentifierIntermenstrualBleeding'
+  | 'HKCategoryTypeIdentifierSexualActivity'
+  | 'HKCategoryTypeIdentifierMindfulSession'
+  | 'HKCategoryTypeIdentifierIrregularHeartRhythmEvent'
+  /**
+   * @deprecated Use environmentalAudioExposureEvent instead.
+   * @see {@link https://developer.apple.com/documentation/healthkit/hkcategorytypeidentifier/audioexposureevent Apple Docs }
+   */
+  | 'HKCategoryTypeIdentifierAudioExposureEvent'
+  | 'HKCategoryTypeIdentifierToothbrushingEvent'
+  | 'HKCategoryTypeIdentifierLowCardioFitnessEvent'
+  | 'HKCategoryTypeIdentifierContraceptive'
+  | 'HKCategoryTypeIdentifierLactation'
+  | 'HKCategoryTypeIdentifierPregnancy'
+  | 'HKCategoryTypeIdentifierPregnancyTestResult'
+  | 'HKCategoryTypeIdentifierProgesteroneTestResult'
+  | 'HKCategoryTypeIdentifierEnvironmentalAudioExposureEvent'
+  | 'HKCategoryTypeIdentifierAppleWalkingSteadinessEvent'
+  | 'HKCategoryTypeIdentifierHandwashingEvent'
+
+  // Symptoms
+  | 'HKCategoryTypeIdentifierAbdominalCramps'
+  | 'HKCategoryTypeIdentifierAcne'
+  | 'HKCategoryTypeIdentifierAppetiteChanges'
+  | 'HKCategoryTypeIdentifierBladderIncontinence'
+  | 'HKCategoryTypeIdentifierBloating'
+  | 'HKCategoryTypeIdentifierBreastPain'
+  | 'HKCategoryTypeIdentifierChestTightnessOrPain'
+  | 'HKCategoryTypeIdentifierChills'
+  | 'HKCategoryTypeIdentifierConstipation'
+  | 'HKCategoryTypeIdentifierCoughing'
+  | 'HKCategoryTypeIdentifierDiarrhea'
+  | 'HKCategoryTypeIdentifierDizziness'
+  | 'HKCategoryTypeIdentifierDrySkin'
+  | 'HKCategoryTypeIdentifierFainting'
+  | 'HKCategoryTypeIdentifierFatigue'
+  | 'HKCategoryTypeIdentifierFever'
+  | 'HKCategoryTypeIdentifierGeneralizedBodyAche'
+  | 'HKCategoryTypeIdentifierHairLoss'
+  | 'HKCategoryTypeIdentifierHeadache'
+  | 'HKCategoryTypeIdentifierHeartburn'
+  | 'HKCategoryTypeIdentifierHotFlashes'
+  | 'HKCategoryTypeIdentifierLossOfSmell'
+  | 'HKCategoryTypeIdentifierLossOfTaste'
+  | 'HKCategoryTypeIdentifierLowerBackPain'
+  | 'HKCategoryTypeIdentifierMemoryLapse'
+  | 'HKCategoryTypeIdentifierMoodChanges'
+  | 'HKCategoryTypeIdentifierNausea'
+  | 'HKCategoryTypeIdentifierNightSweats'
+  | 'HKCategoryTypeIdentifierPelvicPain'
+  | 'HKCategoryTypeIdentifierRapidPoundingOrFlutteringHeartbeat'
+  | 'HKCategoryTypeIdentifierRunnyNose'
+  | 'HKCategoryTypeIdentifierShortnessOfBreath'
+  | 'HKCategoryTypeIdentifierSinusCongestion'
+  | 'HKCategoryTypeIdentifierSkippedHeartbeat'
+  | 'HKCategoryTypeIdentifierSleepChanges'
+  | 'HKCategoryTypeIdentifierSoreThroat'
+  | 'HKCategoryTypeIdentifierVaginalDryness'
+  | 'HKCategoryTypeIdentifierVomiting'
+  | 'HKCategoryTypeIdentifierWheezing'
+
+  /**
+   * Bleeding After Pregnancy
+   * @see {@link https://developer.apple.com/documentation/healthkit/hkcategorytypeidentifierbleedingafterpregnancy Apple Docs }
+   * @since iOS 18
+   */
+  | 'HKCategoryTypeIdentifierBleedingAfterPregnancy'
+
+  /**
+   * Bleeding During Pregnancy
+   * @see {@link https://developer.apple.com/documentation/healthkit/hkcategorytypeidentifierbleedingduringpregnancy Apple Docs }
+   * @since iOS 18
+   */
+  | 'HKCategoryTypeIdentifierBleedingDuringPregnancy'
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategorytypeidentifier Apple Docs }
+ */
+export type CategoryTypeIdentifier =
+  | CategoryTypeIdentifierReadOnly
+  | CategoryTypeIdentifierWriteable

package/src/types/Characteristics.ts

@@ -0,0 +1,53 @@
+// Straight mapping to https://developer.apple.com/documentation/healthkit/hkcharacteristictypeidentifier
+export type CharacteristicTypeIdentifier =
+  | 'HKCharacteristicTypeIdentifierFitzpatrickSkinType'
+  | 'HKCharacteristicTypeIdentifierBiologicalSex'
+  | 'HKCharacteristicTypeIdentifierBloodType'
+  | 'HKCharacteristicTypeIdentifierDateOfBirth'
+  | 'HKCharacteristicTypeIdentifierWheelchairUse'
+  | 'HKCharacteristicTypeIdentifierActivityMoveMode'
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkbloodtype Apple Docs }
+ */
+export enum BloodType {
+  notSet = 0,
+  aPositive = 1,
+  aNegative = 2,
+  bPositive = 3,
+  bNegative = 4,
+  abPositive = 5,
+  abNegative = 6,
+  oPositive = 7,
+  oNegative = 8,
+}
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkbiologicalsex Apple Docs }
+ */
+export enum BiologicalSex {
+  notSet = 0,
+  female = 1,
+  male = 2,
+  other = 3,
+}
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkfitzpatrickskintype Apple Docs }
+ */
+export enum FitzpatrickSkinType {
+  notSet = 0,
+  I = 1,
+  II = 2,
+  III = 3,
+  IV = 4,
+  V = 5,
+  VI = 6,
+}
+
+// Maps directly to https://developer.apple.com/documentation/healthkit/hkwheelchairuse
+export enum WheelchairUse {
+  notSet = 0,
+  notUsingWheelchair = 1,
+  usingWheelchair = 2,
+}

package/src/types/Constants.ts

@@ -0,0 +1,25 @@
+/**
+ * Represents a workout type identifier.
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkworkouttypeidentifier Apple Docs HKWorkoutTypeIdentifier}
+ */
+export const WorkoutTypeIdentifier = 'HKWorkoutTypeIdentifier' as const
+
+/**
+ * Represents a workout route type identifier.
+ * @see {@link https://developer.apple.com/documentation/healthkit/HKWorkoutRouteTypeIdentifier Apple Docs WorkoutRouteTypeIdentifier}
+ */
+export const WorkoutRouteTypeIdentifier =
+  'HKWorkoutRouteTypeIdentifier' as const
+
+/**
+ * Represents a state of mind type identifier.
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkstateofmindtype Apple Docs HKStateOfMindType}
+ */
+export const StateOfMindTypeIdentifier = 'HKStateOfMindTypeIdentifier' as const
+
+/**
+ * Represents a series sample containing heartbeat data..
+ * @see {@link https://developer.apple.com/documentation/healthkit/HKDataTypeIdentifierHeartbeatSeries Apple Docs DataTypeIdentifierHeartbeatSeries}
+ */
+export const HeartbeatSeriesTypeIdentifier =
+  'HKDataTypeIdentifierHeartbeatSeries' as const

package/src/types/CorrelationType.ts

@@ -0,0 +1,31 @@
+import type { AnyMap } from 'react-native-nitro-modules'
+import type { CategorySample, CategorySampleForSaving } from './CategoryType'
+import type { QuantitySample, QuantitySampleForSaving } from './QuantitySample'
+import type { GenericMetadata } from './Shared'
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcorrelationtypeidentifier Apple Docs }
+ */
+export type CorrelationTypeIdentifier =
+  | 'HKCorrelationTypeIdentifierBloodPressure'
+  | 'HKCorrelationTypeIdentifierFood'
+
+type CorrelationObject = CategorySample | QuantitySample
+
+export interface CorrelationSample {
+  readonly correlationType: CorrelationTypeIdentifier
+  readonly objects: readonly CorrelationObject[]
+  readonly metadata: AnyMap
+  readonly startDate: Date
+  readonly endDate: Date
+}
+
+export type MetadataMapperForCorrelationIdentifier<
+  TCorrelationTypeIdentifier = CorrelationTypeIdentifier,
+> = TCorrelationTypeIdentifier extends 'CorrelationTypeIdentifierFood'
+  ? GenericMetadata & {
+      readonly HKFoodType?: string
+    }
+  : GenericMetadata
+
+export type SampleForSaving = CategorySampleForSaving | QuantitySampleForSaving

package/src/types/Device.ts

@@ -0,0 +1,13 @@
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkdevice Apple Docs }
+ */
+export interface Device {
+  readonly name: string | null // ex: "Apple Watch"
+  readonly firmwareVersion: string | null
+  readonly hardwareVersion: string | null // ex: "Watch6,2",
+  readonly localIdentifier: string | null
+  readonly manufacturer: string | null // ex: "Apple Inc."
+  readonly model: string | null // ex: "Watch"
+  readonly softwareVersion: string | null // ex: "9.0"
+  readonly udiDeviceIdentifier: string | null
+}

package/src/types/HeartbeatSeries.ts

@@ -0,0 +1,29 @@
+import type { AnyMap } from 'react-native-nitro-modules'
+import type { Device } from './Device'
+import type { DeletedSample, GenericMetadata } from './Shared'
+import type { SourceRevision } from './Source'
+
+export interface HeartbeatSeriesSampleMetadata extends GenericMetadata {
+  readonly HKMetadataKeyAlgorithmVersion: string
+}
+
+export interface Heartbeat {
+  readonly timeSinceSeriesStart: number
+  readonly precededByGap: boolean
+}
+
+export interface HeartbeatSeriesSample {
+  readonly uuid: string
+  readonly device?: Device
+  readonly startDate: Date
+  readonly endDate: Date
+  readonly heartbeats: readonly Heartbeat[]
+  readonly metadata?: AnyMap
+  readonly sourceRevision?: SourceRevision
+}
+
+export interface HeartbeatSeriesSamplesWithAnchorResponse {
+  readonly samples: readonly HeartbeatSeriesSample[]
+  readonly deletedSamples: readonly DeletedSample[]
+  readonly newAnchor: string
+}

package/src/types/InterfaceVerification.ts

@@ -0,0 +1,164 @@
+/**
+ * TypeScript utility types for verifying that two interfaces have matching method signatures.
+ *
+ * This is particularly useful for ensuring that typed and untyped versions of interfaces
+ * stay in sync when one has generics and the other doesn't.
+ *
+ * @example
+ * ```typescript
+ * import type { InterfaceAssertion } from "./InterfaceVerification";
+ *
+ * interface BaseModule extends HybridObject<{ ios: "swift" }> {
+ *   getData(id: string): Promise<string>;
+ * }
+ *
+ * interface BaseModuleTyped {
+ *   getData<T extends string>(id: T): Promise<string>;
+ * }
+ *
+ * // This will cause a TypeScript error if the interfaces don't match
+ * const _verification: InterfaceAssertion<BaseModule, BaseModuleTyped, keyof HybridObject> = true;
+ * ```
+ */
+
+/**
+ * Extracts method names from an interface, excluding specified keys
+ */
+export type ExtractMethodNames<
+  T,
+  ExcludeKeys extends keyof T = never,
+> = Exclude<keyof T, ExcludeKeys>
+
+/**
+ * Gets the parameter count of a function type
+ */
+export type GetParameterCount<T> = T extends (...args: infer P) => unknown
+  ? P['length']
+  : never
+
+/**
+ * Checks if two interfaces have the same method names
+ */
+export type CheckMethodNames<
+  BaseInterface,
+  TypedInterface,
+  ExcludeFromBase extends keyof BaseInterface = never,
+> = {
+  BaseMethodNames: ExtractMethodNames<BaseInterface, ExcludeFromBase>
+  TypedMethodNames: ExtractMethodNames<TypedInterface>
+  MissingInBase: Exclude<
+    ExtractMethodNames<TypedInterface>,
+    ExtractMethodNames<BaseInterface, ExcludeFromBase>
+  >
+  MissingInTyped: Exclude<
+    ExtractMethodNames<BaseInterface, ExcludeFromBase>,
+    ExtractMethodNames<TypedInterface>
+  >
+  InterfaceMismatch:
+    | Exclude<
+        ExtractMethodNames<TypedInterface>,
+        ExtractMethodNames<BaseInterface, ExcludeFromBase>
+      >
+    | Exclude<
+        ExtractMethodNames<BaseInterface, ExcludeFromBase>,
+        ExtractMethodNames<TypedInterface>
+      >
+}
+
+/**
+ * Checks parameter counts for shared methods between two interfaces
+ */
+export type CheckParameterCounts<
+  BaseInterface,
+  TypedInterface,
+  ExcludeFromBase extends keyof BaseInterface = never,
+> = {
+  SharedMethodNames: ExtractMethodNames<BaseInterface, ExcludeFromBase> &
+    ExtractMethodNames<TypedInterface>
+  ParameterCountMismatches: {
+    [K in ExtractMethodNames<BaseInterface, ExcludeFromBase> &
+      ExtractMethodNames<TypedInterface>]: GetParameterCount<
+      BaseInterface[K]
+    > extends GetParameterCount<TypedInterface[K]>
+      ? GetParameterCount<TypedInterface[K]> extends GetParameterCount<
+          BaseInterface[K]
+        >
+        ? never
+        : K
+      : K
+  }[ExtractMethodNames<BaseInterface, ExcludeFromBase> &
+    ExtractMethodNames<TypedInterface>]
+}
+
+/**
+ * Complete interface verification that checks both method names and parameter counts
+ */
+export type VerifyInterfaceSync<
+  BaseInterface,
+  TypedInterface,
+  ExcludeFromBase extends keyof BaseInterface = never,
+> = {
+  MethodCheck: CheckMethodNames<BaseInterface, TypedInterface, ExcludeFromBase>
+  ParameterCheck: CheckParameterCounts<
+    BaseInterface,
+    TypedInterface,
+    ExcludeFromBase
+  >
+
+  // Final verification result
+  Result: CheckMethodNames<
+    BaseInterface,
+    TypedInterface,
+    ExcludeFromBase
+  >['InterfaceMismatch'] extends never
+    ? CheckParameterCounts<
+        BaseInterface,
+        TypedInterface,
+        ExcludeFromBase
+      >['ParameterCountMismatches'] extends never
+      ? true
+      : {
+          ERROR: 'Parameter count mismatch detected'
+          MethodsWithParameterCountMismatch: CheckParameterCounts<
+            BaseInterface,
+            TypedInterface,
+            ExcludeFromBase
+          >['ParameterCountMismatches']
+        }
+    : {
+        ERROR: 'Interface mismatch detected'
+        MissingInBase: CheckMethodNames<
+          BaseInterface,
+          TypedInterface,
+          ExcludeFromBase
+        >['MissingInBase']
+        MissingInTyped: CheckMethodNames<
+          BaseInterface,
+          TypedInterface,
+          ExcludeFromBase
+        >['MissingInTyped']
+      }
+}
+
+/**
+ * Simplified interface verification for common use cases
+ */
+export type AssertInterfacesMatch<
+  BaseInterface,
+  TypedInterface,
+  ExcludeFromBase extends keyof BaseInterface = never,
+> = VerifyInterfaceSync<
+  BaseInterface,
+  TypedInterface,
+  ExcludeFromBase
+>['Result']
+
+/**
+ * Creates a compile-time assertion that two interfaces match
+ * Usage: const _check: InterfaceAssertion<BaseInterface, TypedInterface> = true;
+ */
+export type InterfaceAssertion<
+  BaseInterface,
+  TypedInterface,
+  ExcludeFromBase extends keyof BaseInterface = never,
+> = AssertInterfacesMatch<BaseInterface, TypedInterface, ExcludeFromBase>

package/src/types/InterfaceVerificationExample.ts

@@ -0,0 +1,89 @@
+/**
+ * Example usage of the InterfaceVerification utility
+ *
+ * This file demonstrates how to use the reusable interface verification utility
+ * to ensure that typed and untyped versions of interfaces stay in sync.
+ */
+
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { InterfaceAssertion } from './InterfaceVerification'
+
+// Example: Basic interface without generics
+export interface ExampleModule extends HybridObject<{ ios: 'swift' }> {
+  getData(id: string): Promise<string>
+  saveData(id: string, data: string): Promise<boolean>
+  deleteData(id: string): Promise<void>
+}
+
+// Example: Typed version with generics
+export interface ExampleModuleTyped {
+  getData<T extends string>(id: T): Promise<string>
+  saveData<T extends string>(id: T, data: string): Promise<boolean>
+  deleteData<T extends string>(id: T): Promise<void>
+}
+
+// Verification: This will cause a TypeScript error if the interfaces don't match
+const _exampleVerification: InterfaceAssertion<
+  ExampleModule,
+  ExampleModuleTyped,
+  keyof HybridObject
+> = true
+
+// Example: Interface with optional parameters
+export interface ConfigModule extends HybridObject<{ ios: 'swift' }> {
+  getConfig(key: string, defaultValue?: string): Promise<string>
+  setConfig(key: string, value: string, persistent?: boolean): Promise<void>
+}
+
+export interface ConfigModuleTyped {
+  getConfig<T extends string>(key: T, defaultValue?: string): Promise<string>
+  setConfig<T extends string>(
+    key: T,
+    value: string,
+    persistent?: boolean,
+  ): Promise<void>
+}
+
+// Verification for optional parameters
+const _configVerification: InterfaceAssertion<
+  ConfigModule,
+  ConfigModuleTyped,
+  keyof HybridObject
+> = true
+
+// Example: What happens when there's a mismatch
+export interface BadModule extends HybridObject<{ ios: 'swift' }> {
+  method1(): void
+  method2(param: string): void
+  // This method exists in BadModule but not in BadModuleTyped
+  extraMethod(): void
+}
+
+export interface BadModuleTyped {
+  method1(): void
+  method2(param: string): void
+  // Missing extraMethod - this will cause a TypeScript error
+}
+
+// This will show a TypeScript error indicating the mismatch
+// Uncomment to see the error:
+// const _badVerification: InterfaceAssertion<BadModule, BadModuleTyped, keyof HybridObject> = true;
+
+/**
+ * Usage Instructions:
+ *
+ * 1. Import the InterfaceAssertion type from InterfaceVerification
+ * 2. Create your base interface (extending HybridObject)
+ * 3. Create your typed interface (with generics)
+ * 4. Add a verification line:
+ *    const _verification: InterfaceAssertion<BaseInterface, TypedInterface, keyof HybridObject> = true;
+ *
+ * The verification will:
+ * - Check that both interfaces have the same method names
+ * - Check that corresponding methods have the same number of parameters
+ * - Show descriptive TypeScript errors if there are mismatches
+ *
+ * Error Types:
+ * - "Interface mismatch detected" - method names don't match
+ * - "Parameter count mismatch detected" - parameter counts don't match
+ */

package/src/types/QuantitySample.ts

@@ -0,0 +1,30 @@
+import type { AnyMap } from 'react-native-nitro-modules'
+
+import type { Device } from './Device'
+import type { QuantityTypeIdentifier } from './QuantityTypeIdentifier'
+import type { SourceRevision } from './Source'
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitysample Apple Docs }
+ */
+export interface QuantitySample {
+  readonly uuid: string
+  readonly device?: Device
+  readonly quantityType: QuantityTypeIdentifier
+  readonly startDate: Date
+  readonly endDate: Date
+  readonly quantity: number
+  readonly unit: string
+  readonly metadata: AnyMap
+  readonly sourceRevision?: SourceRevision
+}
+
+export interface QuantitySampleForSaving {
+  readonly startDate: Date
+  readonly endDate: Date
+  readonly quantityType: QuantityTypeIdentifier
+  readonly quantity: number
+  readonly unit: string
+  readonly metadata: AnyMap
+  readonly sourceRevision?: SourceRevision
+}