@kingstinct/react-native-healthkit 8.7.2 → 9.0.0

package/src/types/QueryOptions.ts

@@ -0,0 +1,69 @@
+import type { WorkoutProxy } from '../specs/WorkoutProxy.nitro'
+
+type PredicateWithUUID = {
+  readonly uuid: string
+}
+
+type PredicateWithUUIDs = {
+  readonly uuids: readonly string[]
+}
+
+type PredicateWithStartAndEnd = {
+  readonly startDate?: Date
+  readonly endDate?: Date
+  readonly strictEndDate?: boolean
+  readonly strictStartDate?: boolean
+}
+
+type PredicateWithMetadataKey = {
+  readonly withMetadataKey: string
+}
+
+export type FilterForSamplesAnd = {
+  AND: PredicateForSamples[]
+}
+
+export type FilterForSamplesOr = {
+  OR: PredicateForSamples[]
+}
+
+export type PredicateFromWorkout = {
+  workout: WorkoutProxy
+}
+
+export type FilterForSamples =
+  | PredicateForSamples
+  | FilterForSamplesAnd
+  | FilterForSamplesOr
+
+export type PredicateForSamples =
+  | PredicateWithUUID
+  | PredicateWithUUIDs
+  | PredicateWithMetadataKey
+  | PredicateWithStartAndEnd
+  | PredicateFromWorkout
+
+/**
+ * Generic options for querying.
+ */
+export interface GenericQueryOptions {
+  filter?: FilterForSamples
+  readonly limit?: number
+}
+
+export interface QueryOptionsWithAnchor extends GenericQueryOptions {
+  readonly anchor?: string
+}
+
+export interface QueryOptionsWithSortOrder extends GenericQueryOptions {
+  readonly ascending?: boolean
+}
+
+export interface QueryOptionsWithSortOrderAndUnit
+  extends QueryOptionsWithSortOrder {
+  readonly unit?: string
+}
+
+export interface QueryOptionsWithAnchorAndUnit extends QueryOptionsWithAnchor {
+  readonly unit?: string
+}

package/src/types/README-InterfaceVerification.md

@@ -0,0 +1,103 @@
+# Interface Verification Utility
+
+A TypeScript utility for ensuring that typed and untyped versions of interfaces stay in sync during development.
+
+## Overview
+
+When working with libraries like `react-native-nitro-modules`, you often have two versions of an interface:
+1. A base interface that extends `HybridObject` (for the native bridge)
+2. A typed interface with generics for better type safety
+
+This utility ensures both interfaces have the same method names and parameter counts, catching mismatches at compile-time.
+
+## Quick Start
+
+```typescript
+import type { InterfaceAssertion } from "../types/InterfaceVerification";
+
+// Base interface
+export interface MyModule extends HybridObject<{ ios: "swift" }> {
+	getData(id: string): Promise<string>;
+	saveData(id: string, data: string): Promise<boolean>;
+}
+
+// Typed interface
+export interface MyModuleTyped {
+	getData<T extends string>(id: T): Promise<string>;
+	saveData<T extends string>(id: T, data: string): Promise<boolean>;
+}
+
+// Verification - will cause TypeScript error if interfaces don't match
+const _verification: InterfaceAssertion<MyModule, MyModuleTyped, keyof HybridObject> = true;
+```
+
+## Features
+
+- ✅ **Method name verification** - Ensures both interfaces have the same methods
+- ✅ **Parameter count verification** - Ensures corresponding methods have the same number of parameters
+- ✅ **Descriptive error messages** - Shows exactly what's missing or mismatched
+- ✅ **Zero runtime cost** - Pure TypeScript types with no JavaScript output
+- ✅ **Compile-time checking** - Catches issues during development, not runtime
+
+## Error Types
+
+### Interface Mismatch
+When method names don't match between interfaces:
+
+```typescript
+// Error: Interface mismatch detected
+// MissingInBase: "newMethod"
+// MissingInTyped: never
+```
+
+### Parameter Count Mismatch
+When corresponding methods have different parameter counts:
+
+```typescript
+// Error: Parameter count mismatch detected
+// MethodsWithParameterCountMismatch: "getData"
+```
+
+## API Reference
+
+### `InterfaceAssertion<BaseInterface, TypedInterface, ExcludeFromBase>`
+
+Main utility type for interface verification.
+
+**Parameters:**
+- `BaseInterface` - The base interface (usually extending HybridObject)
+- `TypedInterface` - The typed interface with generics
+- `ExcludeFromBase` - Keys to exclude from the base interface (e.g., `keyof HybridObject`)
+
+**Returns:**
+- `true` if interfaces match
+- Error object with descriptive message if they don't match
+
+### Other Utility Types
+
+- `ExtractMethodNames<T, ExcludeKeys>` - Extracts method names from an interface
+- `GetParameterCount<T>` - Gets parameter count of a function type
+- `CheckMethodNames<BaseInterface, TypedInterface, ExcludeFromBase>` - Detailed method name comparison
+- `CheckParameterCounts<BaseInterface, TypedInterface, ExcludeFromBase>` - Detailed parameter count comparison
+
+## Usage in Your Project
+
+1. Copy `InterfaceVerification.ts` to your project
+2. Import `InterfaceAssertion` in your module files
+3. Add verification lines after your interface definitions
+4. TypeScript will show errors if interfaces don't match
+
+## Best Practices
+
+1. **Always exclude inherited keys** - Use `keyof HybridObject` or similar to exclude inherited methods
+2. **Add verification immediately** - Add the verification line right after defining both interfaces
+3. **Use descriptive naming** - Name your verification constants with `_verification` or similar
+4. **Keep interfaces close** - Define both interfaces in the same file when possible
+
+## Examples
+
+See `InterfaceVerificationExample.ts` for complete examples including:
+- Basic interfaces
+- Interfaces with optional parameters
+- What happens when interfaces don't match
+- Real-world usage patterns

package/src/types/Shared.ts

@@ -0,0 +1,79 @@
+import type {
+  CategoryTypeIdentifier,
+  CategoryTypeIdentifierWriteable,
+} from './CategoryTypeIdentifier'
+import type {
+  QuantityTypeIdentifier,
+  QuantityTypeIdentifierWriteable,
+} from './QuantityTypeIdentifier'
+
+import type {
+  HeartbeatSeriesTypeIdentifier,
+  StateOfMindTypeIdentifier,
+  WorkoutRouteTypeIdentifier,
+  WorkoutTypeIdentifier,
+} from './Constants'
+
+import type { AnyMap } from 'react-native-nitro-modules'
+import type { CharacteristicTypeIdentifier } from './Characteristics'
+import type { CorrelationTypeIdentifier } from './CorrelationType'
+
+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 interface DeletedSample {
+  readonly uuid: string
+  readonly metadata?: AnyMap
+}
+
+export type ObjectTypeIdentifier =
+  | CharacteristicTypeIdentifier
+  | SampleTypeIdentifier
+  | typeof ActivitySummaryTypeIdentifier
+
+export type SampleTypeIdentifier =
+  | CategoryTypeIdentifier
+  | CorrelationTypeIdentifier
+  | QuantityTypeIdentifier
+  | typeof StateOfMindTypeIdentifier
+  | typeof AudiogramTypeIdentifier
+  | typeof HeartbeatSeriesTypeIdentifier
+  | typeof WorkoutRouteTypeIdentifier
+  | typeof WorkoutTypeIdentifier
+
+export type SampleTypeIdentifierWriteable =
+  | CategoryTypeIdentifierWriteable
+  | CorrelationTypeIdentifier
+  | QuantityTypeIdentifierWriteable
+  | typeof StateOfMindTypeIdentifier
+  | typeof AudiogramTypeIdentifier
+  | typeof HeartbeatSeriesTypeIdentifier
+  | typeof WorkoutRouteTypeIdentifier
+  | typeof WorkoutTypeIdentifier
+
+/**
+ * Represents a type that identifies activity summary objects.
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkactivitysummarytype Apple Docs HKActivitySummaryType}
+ */
+export const ActivitySummaryTypeIdentifier =
+  'ActivitySummaryTypeIdentifier' as const
+
+/**
+ * Represents an audiogram type identifier.
+ * @see {@link https://developer.apple.com/documentation/healthkit/HKAudiogramSampleType Apple Docs HKAudiogramSampleType}
+ */
+export const AudiogramTypeIdentifier = 'HKAudiogramSampleType' as const

package/src/types/Source.ts

@@ -0,0 +1,11 @@
+import type { SourceProxy } from '../specs/SourceProxy.nitro'
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkobject/1615483-sourcerevision Apple Docs }
+ */
+export interface SourceRevision {
+  readonly source?: SourceProxy
+  readonly version?: string
+  readonly operatingSystemVersion?: string | null
+  readonly productType?: string | null
+}

package/src/types/StateOfMind.ts

@@ -0,0 +1,110 @@
+import type { AnyMap } from 'react-native-nitro-modules'
+import type { Device } from './Device'
+import type { SourceRevision } from './Source'
+
+export enum StateOfMindValenceClassification {
+  veryUnpleasant = 1,
+  unpleasant = 2,
+  slightlyUnpleasant = 3,
+  neutral = 4,
+  slightlyPleasant = 5,
+  pleasant = 6,
+  veryPleasant = 7,
+}
+
+export interface StateOfMindSample {
+  readonly uuid: string
+  readonly device?: Device
+  readonly startDate: Date
+  readonly endDate: Date
+  readonly metadata?: AnyMap
+  readonly sourceRevision?: SourceRevision
+  // State of mind sample properties
+  /**
+   * @see {@link https://developer.apple.com/documentation/healthkit/hkstateofmind/4337998-valence Apple Docs }
+   * Value between -1 and 1
+   */
+  readonly valence: number
+  readonly kind: StateOfMindKind
+  readonly valenceClassification: StateOfMindValenceClassification
+  readonly associations: readonly StateOfMindAssociation[]
+  readonly labels: readonly StateOfMindLabel[]
+}
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkstateofmind/label Apple Docs}
+ */
+export enum StateOfMindLabel {
+  amazed = 1,
+  amused = 2,
+  angry = 3,
+  anxious = 4,
+  ashamed = 5,
+  brave = 6,
+  calm = 7,
+  content = 8,
+  disappointed = 9,
+  discouraged = 10,
+  disgusted = 11,
+  embarrassed = 12,
+  excited = 13,
+  frustrated = 14,
+  grateful = 15,
+  guilty = 16,
+  happy = 17,
+  hopeless = 18,
+  irritated = 19,
+  jealous = 20,
+  joyful = 21,
+  lonely = 22,
+  passionate = 23,
+  peaceful = 24,
+  proud = 25,
+  relieved = 26,
+  sad = 27,
+  scared = 28,
+  stressed = 29,
+  surprised = 30,
+  worried = 31,
+
+  annoyed = 32,
+  confident = 33,
+  drained = 34,
+  hopeful = 35,
+  indifferent = 36,
+  overwhelmed = 37,
+  satisfied = 38,
+}
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkstateofmind/kind Apple Docs}
+ */
+export enum StateOfMindKind {
+  dailyMood = 2,
+  momentaryEmotion = 1,
+}
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkstateofmind/association Apple Docs}
+ * @since iOS 17.0+
+ */
+export enum StateOfMindAssociation {
+  community = 1,
+  currentEvents = 2,
+  dating = 3,
+  education = 4,
+  family = 5,
+  fitness = 6,
+  friends = 7,
+  health = 8,
+  hobbies = 9,
+  identity = 10,
+  money = 11,
+  partner = 12,
+  selfCare = 13,
+  spirituality = 14,
+  tasks = 15,
+  travel = 16,
+  work = 17,
+  weather = 18,
+}

package/src/types/Subscriptons.ts

@@ -0,0 +1,10 @@
+import type { SampleTypeIdentifier } from './Shared'
+
+export interface EmitterSubscription {
+  remove: () => void
+}
+
+export interface OnChangeCallbackArgs {
+  readonly typeIdentifier: SampleTypeIdentifier
+  readonly errorMessage?: string
+}

package/src/types/Units.ts

@@ -0,0 +1,190 @@
+// Unit types are a straight mapping from here https://developer.apple.com/documentation/healthkit/hkunit/1615733-init
+export type MetricPrefix =
+  | ''
+  | 'p'
+  | 'n'
+  | 'mc'
+  | 'm'
+  | 'c'
+  | 'd'
+  | 'da'
+  | 'h'
+  | 'k'
+  | 'M'
+  | 'G'
+  | 'T'
+  | 'f'
+
+export type UnitMetric =
+  | 'g'
+  | 'J'
+  | 'K'
+  | 'l'
+  | 'm'
+  | 'Pa'
+  | 's'
+  | 'S'
+  | 'Hz'
+  | 'V'
+
+export type Units =
+  | 'dBHL'
+  | 'dBASPL'
+  | '%'
+  | 'count'
+  | 'IU'
+  | 'appleEffortScore'
+
+export type MeterUnit<Prefix extends MetricPrefix> = `${Prefix}m`
+export type LiterUnit<Prefix extends MetricPrefix> = `${Prefix}l`
+export type GramUnit<Prefix extends MetricPrefix> = `${Prefix}g`
+export type PascalUnit<Prefix extends MetricPrefix> = `${Prefix}Pa`
+export type SecondUnit<Prefix extends MetricPrefix> = `${Prefix}s`
+export type JouleUnit<Prefix extends MetricPrefix> = `${Prefix}J`
+export type HertzUnit<Prefix extends MetricPrefix> = `${Prefix}Hz`
+export type VoltUnit<Prefix extends MetricPrefix> = `${Prefix}V`
+export type SiemenUnit<Prefix extends MetricPrefix> = `${Prefix}S`
+
+// not 100% sure about these
+export type MoleUnit<MolarMass extends number> = `mol<${MolarMass}>`
+export type MoleUnitWith<
+  MolarMass extends number,
+  Prefix extends MetricPrefix,
+> = `${Prefix}mol<${MolarMass}>`
+
+export type FrequencyUnit = HertzUnit<MetricPrefix>
+
+/**
+ * More SI prefixes also available as literals, just type the string
+ * @example 'cm', 'km'
+ */
+export type UnitOfLength =
+  | 'ft'
+  /**
+   * More SI prefixes also available as literals, just type the string
+   * @example 'cm', 'km'
+   */
+  | 'm'
+  | 'in'
+  | 'yd'
+  | 'mi'
+
+export type LengthUnit = MeterUnit<MetricPrefix> | UnitOfLength
+
+/**
+ * More SI prefixes also available as literals, just type the string
+ * @example 'ml', 'cl'
+ */
+export type UnitOfVolume =
+  | 'cup_imp'
+  | 'fl_oz_imp'
+  | 'pt_imp'
+  | 'cup_us'
+  | 'fl_oz_us'
+  | 'pt_us'
+  /**
+   * More SI prefixes also available as literals, just type the string
+   * @example 'ml', 'cl'
+   */
+  | 'l'
+
+export type VolumeUnit = LiterUnit<MetricPrefix> | UnitOfVolume
+
+/**
+ * More SI prefixes also available as literals, just type the string
+ * @example 'mg', 'kg'
+ */
+export type UnitOfMass =
+  | 'oz'
+  | 'st'
+  | 'lb'
+  /**
+   * More SI prefixes also available as literals, just type the string
+   * @example 'mg', 'kg'
+   */
+  | 'g'
+
+/**
+ * More SI prefixes also available as literals, just type the string
+ * @example 'mg', 'kg'
+ */
+export type MassUnit = GramUnit<MetricPrefix> | UnitOfMass
+
+/**
+ * More SI prefixes also available as literals, just type the string
+ * @example 'kPa', 'hPa'
+ */
+export type UnitOfPressure =
+  | 'atm'
+  | 'cmAq'
+  | 'mmHg'
+  | 'inHg'
+  | 'dBASPL'
+  /**
+   * More SI prefixes also available as literals, just type the string
+   * @example 'kPa', 'hPa'
+   */
+  | 'Pa'
+
+/**
+ * More SI prefixes also available as literals, just type the string
+ * @example 'kPa', 'hPa'
+ */
+export type PressureUnit = PascalUnit<MetricPrefix> | UnitOfPressure
+
+/**
+ * More SI prefixes also available as literals, just type the string
+ * @example 'ms'
+ */
+export type UnitOfTime =
+  | 'd'
+  | 'min'
+  | 'hr'
+  /**
+   * More SI prefixes also available as literals, just type the string
+   * @example 'ms'
+   */
+  | 's'
+
+/**
+ * More SI prefixes also available as literals, just type the string
+ * @example 'ms'
+ */
+export type TimeUnit = SecondUnit<MetricPrefix> | UnitOfTime
+export type TemperatureUnit = 'degC' | 'degF' | 'K'
+
+/**
+ * More SI prefixes also available as literals, just type the string
+ * @example 'kJ'
+ */
+export type UnitOfEnergy = 'kcal' | 'Cal' | 'cal' | 'J'
+
+export type EnergyUnit = JouleUnit<MetricPrefix> | UnitOfEnergy
+
+export type BloodGlucoseUnit = 'mmol<180.15588000005408>/l' | 'mg/dL'
+
+export type SpeedUnit<
+  TLength extends LengthUnit,
+  TTime extends TimeUnit,
+> = `${TLength}/${TTime}`
+
+export type CountPerTime<TTime extends TimeUnit> = `count/${TTime}`
+
+export type Unit =
+  | BloodGlucoseUnit
+  | CountPerTime<TimeUnit>
+  | EnergyUnit
+  | FrequencyUnit
+  | Units
+  | LengthUnit
+  | MassUnit
+  | PressureUnit
+  | SpeedUnit<LengthUnit, TimeUnit>
+  | TemperatureUnit
+  | TimeUnit
+  | VolumeUnit
+
+export interface IdentifierWithUnit {
+  typeIdentifier: string
+  unit: string
+}

package/src/types/WeatherCondition.ts

@@ -0,0 +1,31 @@
+// documented at https://developer.apple.com/documentation/healthkit/hkweathercondition
+export enum HKWeatherCondition {
+  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,
+}

package/src/types/WorkoutKit.ts

@@ -0,0 +1,18 @@
+import type { WorkoutActivityType } from './Workouts'
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkworkoutconfiguration Apple Docs }
+ */
+export interface WorkoutConfiguration {
+  readonly activityType: WorkoutActivityType
+  readonly locationType?: WorkoutSessionLocationType
+}
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkworkoutsessionlocationtype Apple Docs }
+ */
+export enum WorkoutSessionLocationType {
+  unknown = 1,
+  indoor = 2,
+  outdoor = 3,
+}