@robinhealth/health-sdk 0.0.1

package/src/types.ts

@@ -0,0 +1,189 @@
+export enum HealthDataType {
+  Steps = 'Steps',
+  DistanceWalkingRunning = 'DistanceWalkingRunning',
+  ActiveEnergyBurned = 'ActiveEnergyBurned',
+  FlightsClimbed = 'FlightsClimbed',
+  HeartRate = 'HeartRate',
+  RestingHeartRate = 'RestingHeartRate',
+  BloodPressureSystolic = 'BloodPressureSystolic',
+  BloodPressureDiastolic = 'BloodPressureDiastolic',
+  BloodOxygen = 'BloodOxygen',
+  RespiratoryRate = 'RespiratoryRate',
+  SleepAnalysis = 'SleepAnalysis',
+  // Tier 2 — Body Composition
+  BodyFatPercentage = 'BodyFatPercentage',
+  BodyMassIndex = 'BodyMassIndex',
+  BasalEnergyBurned = 'BasalEnergyBurned',
+  // Tier 3 — Supplementary
+  Water = 'Water',
+}
+
+export enum PermissionStatus {
+  GRANTED = 'GRANTED',
+  DECLINED = 'DECLINED',
+  UNKNOWN = 'UNKNOWN',
+}
+
+export enum SleepStage {
+  Awake = 'awake',
+  Light = 'light',
+  Deep = 'deep',
+  REM = 'rem',
+  Unknown = 'unknown',
+}
+
+export enum WorkoutActivityType {
+  americanFootball = 'americanFootball',
+  archery = 'archery',
+  australianFootball = 'australianFootball',
+  badminton = 'badminton',
+  baseball = 'baseball',
+  basketball = 'basketball',
+  bowling = 'bowling',
+  boxing = 'boxing',
+  climbing = 'climbing',
+  cricket = 'cricket',
+  crossTraining = 'crossTraining',
+  curling = 'curling',
+  cycling = 'cycling',
+  dance = 'dance',
+  danceInspiredTraining = 'danceInspiredTraining',
+  elliptical = 'elliptical',
+  equestrianSports = 'equestrianSports',
+  fencing = 'fencing',
+  fishing = 'fishing',
+  functionalStrengthTraining = 'functionalStrengthTraining',
+  golf = 'golf',
+  gymnastics = 'gymnastics',
+  handball = 'handball',
+  hiking = 'hiking',
+  hockey = 'hockey',
+  hunting = 'hunting',
+  lacrosse = 'lacrosse',
+  martialArts = 'martialArts',
+  mindAndBody = 'mindAndBody',
+  mixedMetabolicCardioTraining = 'mixedMetabolicCardioTraining',
+  paddleSports = 'paddleSports',
+  play = 'play',
+  preparationAndRecovery = 'preparationAndRecovery',
+  racquetball = 'racquetball',
+  rowing = 'rowing',
+  rugby = 'rugby',
+  running = 'running',
+  sailing = 'sailing',
+  skatingSports = 'skatingSports',
+  snowSports = 'snowSports',
+  soccer = 'soccer',
+  softball = 'softball',
+  squash = 'squash',
+  stairClimbing = 'stairClimbing',
+  surfingSports = 'surfingSports',
+  swimming = 'swimming',
+  tableTennis = 'tableTennis',
+  tennis = 'tennis',
+  trackAndField = 'trackAndField',
+  traditionalStrengthTraining = 'traditionalStrengthTraining',
+  volleyball = 'volleyball',
+  walking = 'walking',
+  waterFitness = 'waterFitness',
+  waterPolo = 'waterPolo',
+  waterSports = 'waterSports',
+  wrestling = 'wrestling',
+  yoga = 'yoga',
+  barre = 'barre',
+  coreTraining = 'coreTraining',
+  crossCountrySkiing = 'crossCountrySkiing',
+  downhillSkiing = 'downhillSkiing',
+  flexibility = 'flexibility',
+  highIntensityIntervalTraining = 'highIntensityIntervalTraining',
+  jumpRope = 'jumpRope',
+  kickboxing = 'kickboxing',
+  pilates = 'pilates',
+  snowboarding = 'snowboarding',
+  stairs = 'stairs',
+  stepTraining = 'stepTraining',
+  wheelchairWalkPace = 'wheelchairWalkPace',
+  wheelchairRunPace = 'wheelchairRunPace',
+  taiChi = 'taiChi',
+  mixedCardio = 'mixedCardio',
+  handCycling = 'handCycling',
+  discSports = 'discSports',
+  fitnessGaming = 'fitnessGaming',
+  cardioDance = 'cardioDance',
+  socialDance = 'socialDance',
+  pickleball = 'pickleball',
+  cooldown = 'cooldown',
+  swimBikeRun = 'swimBikeRun',
+  transition = 'transition',
+  underwaterDiving = 'underwaterDiving',
+  other = 'other',
+}
+
+export interface Workout {
+  workoutType: WorkoutActivityType;
+  duration: number;
+  energyBurned: number | null;
+  distance: number | null;
+  heartRateAvg: number | null;
+  heartRateMax: number | null;
+  startDate: Date;
+  endDate: Date;
+  sourceName: string;
+}
+
+export interface HealthSample {
+  type: HealthDataType;
+  value: number;
+  unit: string;
+  startDate: Date;
+  endDate: Date;
+  sourceName?: string;
+}
+
+export interface SleepStageSample extends HealthSample {
+  stage: SleepStage;
+}
+
+export interface SleepSession {
+  startDate: Date;
+  endDate: Date;
+  totalDuration: number;
+  stages: {
+    awake: number;
+    light: number;
+    deep: number;
+    rem: number;
+    unknown: number;
+  };
+  sourceName: string;
+}
+
+export interface HealthAggregate {
+  type: HealthDataType;
+  sum?: number;
+  avg?: number;
+  min?: number;
+  max?: number;
+  unit: string;
+  startDate: Date;
+  endDate: Date;
+}
+
+export interface HealthProvider {
+  isAvailable(): Promise<boolean>;
+  shouldRequestAuthorization(dataTypes: HealthDataType[]): Promise<boolean>;
+  requestAuthorization(dataTypes: HealthDataType[]): Promise<boolean>;
+  getPermissionStatus(): Promise<PermissionStatus>;
+  querySamples(
+    type: HealthDataType,
+    startDate: Date,
+    endDate: Date,
+  ): Promise<HealthSample[]>;
+  queryAggregated(
+    type: HealthDataType,
+    startDate: Date,
+    endDate: Date,
+  ): Promise<HealthAggregate>;
+  queryWorkouts(startDate: Date, endDate: Date): Promise<Workout[]>;
+  querySleepSessions(startDate: Date, endDate: Date): Promise<SleepSession[]>;
+}