react-native-health-connect/src/types/base.types.ts

React native library for health connect (Android only)

import type { Metadata } from './metadata.types';

export interface BaseRecord {
  metadata?: Metadata;
}

export interface ZoneOffset {
  id: string;
  totalSeconds: number;
}

export interface InstantaneousRecord extends BaseRecord {
  time: string;
}

export interface IntervalRecord extends BaseRecord {
  startTime: string;
  endTime: string;
}

export type TimeRangeFilter =
  | {
      operator: 'between';
      startTime: string;
      endTime: string;
    }
  | {
      operator: 'after';
      startTime: string;
    }
  | {
      operator: 'before';
      endTime: string;
    };

// Duration is a fixed length of time in Java (daylight savings are ignored for DAYS)
export interface DurationRangeSlicer {
  duration: 'MILLIS' | 'SECONDS' | 'MINUTES' | 'HOURS' | 'DAYS';
  length: number;
}

// Period is date-based amount of time in Java
export interface PeriodRangeSlicer {
  period: 'DAYS' | 'WEEKS' | 'MONTHS' | 'YEARS';
  length: number;
}

export interface Energy {
  value: number;
  unit: 'calories' | 'joules' | 'kilocalories' | 'kilojoules';
}

export interface EnergyResult {
  inCalories: number;
  inJoules: number;
  inKilocalories: number;
  inKilojoules: number;
}

export interface Velocity {
  value: number;
  unit: 'kilometersPerHour' | 'metersPerSecond' | 'milesPerHour';
}

export interface VelocityResult {
  inKilometersPerHour: number;
  inMetersPerSecond: number;
  inMilesPerHour: number;
}

export interface BloodGlucose {
  value: number;
  unit: 'milligramsPerDeciliter' | 'millimolesPerLiter';
}

export interface Power {
  value: number;
  unit: 'watts' | 'kilocaloriesPerDay';
}

export interface PowerResult {
  inWatts: number;
  inKilocaloriesPerDay: number;
}

export interface Temperature {
  value: number;
  unit: 'celsius' | 'fahrenheit';
}

export interface Pressure {
  value: number;
  unit: 'millimetersOfMercury';
}

export interface PressureResult {
  inMillimetersOfMercury: number;
}

export interface Mass {
  value: number;
  unit:
    | 'grams'
    | 'kilograms'
    | 'milligrams'
    | 'micrograms'
    | 'ounces'
    | 'pounds';
}

export interface MassResult {
  inGrams: number;
  inKilograms: number;
  inMilligrams: number;
  inMicrograms: number;
  inOunces: number;
  inPounds: number;
}

export interface Length {
  value: number;
  unit: 'meters' | 'kilometers' | 'miles' | 'inches' | 'feet';
}

export interface LengthResult {
  inMeters: number;
  inKilometers: number;
  inMiles: number;
  inInches: number;
  inFeet: number;
}

export interface Volume {
  value: number;
  unit: 'liters' | 'fluidOuncesUs' | 'milliliters';
}

export interface VolumeResult {
  inLiters: number;
  inFluidOuncesUs: number;
  inMilliliters: number;
}

interface BaseSample {
  time: string;
}

export interface CyclingPedalingCadenceSample extends BaseSample {
  // Cycling revolutions per minute. Valid range: 0-10000.
  revolutionsPerMinute: number;
}

export interface HeartRateSample extends BaseSample {
  // Heart beats per minute. Validation range: 1-300.
  beatsPerMinute: number;
}

export interface SpeedSample extends BaseSample {
  // Speed in Velocity unit. Valid range: 0-1000000 meters/sec.
  speed: Velocity;
}

export interface SpeedSampleResult extends BaseSample {
  // Speed in Velocity unit. Valid range: 0-1000000 meters/sec.
  speed: VelocityResult;
}

export interface StepsCadenceSample extends BaseSample {
  rate: number;
}

export interface PowerSample extends BaseSample {
  power: Power;
}

export interface PowerSampleResult extends BaseSample {
  power: PowerResult;
}

export interface ExerciseSegment {
  startTime: string;
  endTime: string;
  // Use ExerciseSegmentType from constants
  segmentType: number;
  repetitions: number;
}

export interface ExerciseLap {
  startTime: string;
  endTime: string;
  length: Length;
}

export interface SleepStage {
  startTime: string;
  endTime: string;
  // Use SleepStageType constant
  stage: number;
}

export interface Location {
  time: string;
  latitude: number;
  longitude: number;
  horizontalAccuracy?: Length;
  verticalAccuracy?: Length;
  altitude?: Length;
}

export enum ExerciseRouteResultType {
  DATA,
  NO_DATA,
  CONSENT_REQUIRED,
}

export interface ExerciseRoute {
  type?: ExerciseRouteResultType; // ReadRecord(s) will always populate this, write and readExerciseRoute will not
  route: Location[];
}