@tryterra/react-native 2.1.0 → 2.2.1

package/src/generated/types.ts

@@ -17,7 +17,9 @@ export type DataCategory =
   | "body"
   | "daily"
   | "sleep"
-  | "nutrition";
+  | "nutrition"
+  | "menstruation"
+  | "athlete"; // ios only
 
 export const DataCategoryValues: readonly DataCategory[] = [
   "activity",
@@ -25,6 +27,8 @@ export const DataCategoryValues: readonly DataCategory[] = [
   "daily",
   "sleep",
   "nutrition",
+  "menstruation",
+  "athlete",
 ];
 
 export type PermissionStatus =
@@ -55,6 +59,156 @@ export const MotionContextValues: readonly MotionContext[] = [
   "active",
 ];
 
+/**
+ * On both platforms, wire names strip HKQuantityTypeIdentifierDietary from HealthKit
+ * identifiers and lowercase the first letter. Units: kcal for energyConsumed; grams for
+ * protein, carbohydrates, the four fats, sugar and fiber; milligrams for everything else,
+ * never micrograms.
+ */
+export type Nutrient =
+  | "energyConsumed"
+  | "protein"
+  | "carbohydrates"
+  | "fatTotal"
+  | "fatSaturated"
+  | "fatMonounsaturated"
+  | "fatPolyunsaturated"
+  | "sugar"
+  | "fiber"
+  | "cholesterol"
+  | "sodium"
+  | "potassium"
+  | "calcium"
+  | "iron"
+  | "magnesium"
+  | "zinc"
+  | "phosphorus"
+  | "iodine"
+  | "manganese"
+  | "molybdenum"
+  | "selenium"
+  | "copper"
+  | "chromium"
+  | "chloride"
+  | "caffeine"
+  | "vitaminA"
+  | "vitaminC"
+  | "vitaminD"
+  | "vitaminE"
+  | "vitaminK"
+  | "vitaminB6"
+  | "vitaminB12"
+  | "thiamin"
+  | "riboflavin"
+  | "niacin"
+  | "folate"
+  | "biotin"
+  | "pantothenicAcid";
+
+export const NutrientValues: readonly Nutrient[] = [
+  "energyConsumed",
+  "protein",
+  "carbohydrates",
+  "fatTotal",
+  "fatSaturated",
+  "fatMonounsaturated",
+  "fatPolyunsaturated",
+  "sugar",
+  "fiber",
+  "cholesterol",
+  "sodium",
+  "potassium",
+  "calcium",
+  "iron",
+  "magnesium",
+  "zinc",
+  "phosphorus",
+  "iodine",
+  "manganese",
+  "molybdenum",
+  "selenium",
+  "copper",
+  "chromium",
+  "chloride",
+  "caffeine",
+  "vitaminA",
+  "vitaminC",
+  "vitaminD",
+  "vitaminE",
+  "vitaminK",
+  "vitaminB6",
+  "vitaminB12",
+  "thiamin",
+  "riboflavin",
+  "niacin",
+  "folate",
+  "biotin",
+  "pantothenicAcid",
+];
+
+/**
+ * Which meal a quantity was logged against. unknown is the store's explicit answer, not an
+ * absence: HealthKit has no meal type at all, so every iOS quantity is unknown.
+ */
+export type MealType =
+  | "breakfast"
+  | "lunch"
+  | "dinner"
+  | "snack"
+  | "unknown";
+
+export const MealTypeValues: readonly MealType[] = [
+  "breakfast",
+  "lunch",
+  "dinner",
+  "snack",
+  "unknown",
+];
+
+/** How heavy a logged day's flow was. */
+export type MenstruationFlow =
+  | "unspecified"
+  | "light"
+  | "medium"
+  | "heavy"
+  | "none";
+
+export const MenstruationFlowValues: readonly MenstruationFlow[] = [
+  "unspecified",
+  "light",
+  "medium",
+  "heavy",
+  "none",
+];
+
+/** Available on ios only. */
+export type BiologicalSex =
+  | "female" // ios only
+  | "male" // ios only
+  | "other" // ios only
+  | "notSet"; // ios only
+
+export const BiologicalSexValues: readonly BiologicalSex[] = [
+  "female",
+  "male",
+  "other",
+  "notSet",
+];
+
+/**
+ * A move-time user's daily totals are minutes rather than active energy.
+ *
+ * Available on ios only.
+ */
+export type ActivityMoveMode =
+  | "activeEnergy" // ios only
+  | "appleMoveTime"; // ios only
+
+export const ActivityMoveModeValues: readonly ActivityMoveMode[] = [
+  "activeEnergy",
+  "appleMoveTime",
+];
+
 /**
  * Why background delivery is restricted. Android discloses which; Apple reports the state
  * without a reason.
@@ -202,6 +356,167 @@ export const WorkoutSchedulingStatusValues: readonly WorkoutSchedulingStatus[] =
   "authorized",
 ];
 
+/**
+ * distance* are metres, *EnergyBurned kilocalories, flightsClimbed a count, and
+ * appleExerciseTime minutes.
+ */
+export type DayTotalMetric =
+  | "distanceWalkingRunning"
+  | "distanceCycling"
+  | "distanceSwimming"
+  | "distanceWheelchair"
+  | "activeEnergyBurned"
+  | "basalEnergyBurned"
+  | "flightsClimbed"
+  | "appleExerciseTime"; // ios only
+
+export const DayTotalMetricValues: readonly DayTotalMetric[] = [
+  "distanceWalkingRunning",
+  "distanceCycling",
+  "distanceSwimming",
+  "distanceWheelchair",
+  "activeEnergyBurned",
+  "basalEnergyBurned",
+  "flightsClimbed",
+  "appleExerciseTime",
+];
+
+/** activeEnergy and basalEnergy are kilocalories, distance metres, floorsClimbed a count. */
+export type IntradayMetric =
+  | "activeEnergy"
+  | "basalEnergy" // ios only
+  | "distance"
+  | "floorsClimbed";
+
+export const IntradayMetricValues: readonly IntradayMetric[] = [
+  "activeEnergy",
+  "basalEnergy",
+  "distance",
+  "floorsClimbed",
+];
+
+/** speed is metres per second, power watts, cadence pedal revolutions per minute. */
+export type WorkoutIntensityMetric =
+  | "speed"
+  | "power"
+  | "cadence";
+
+export const WorkoutIntensityMetricValues: readonly WorkoutIntensityMetric[] = [
+  "speed",
+  "power",
+  "cadence",
+];
+
+/**
+ * The body composition figure a measurement carries. weight and leanBodyMass are kilograms,
+ * height centimetres, bodyFatPercentage a fraction in 0..1, bmi dimensionless.
+ */
+export type BodyMetric =
+  | "weight"
+  | "height"
+  | "bodyFatPercentage"
+  | "leanBodyMass"
+  | "bmi"; // ios only
+
+export const BodyMetricValues: readonly BodyMetric[] = [
+  "weight",
+  "height",
+  "bodyFatPercentage",
+  "leanBodyMass",
+  "bmi",
+];
+
+/** The unit the writing app chose. Never converted on the device. */
+export type BloodGlucoseUnit =
+  | "mg/dL"
+  | "mmol/L";
+
+export const BloodGlucoseUnitValues: readonly BloodGlucoseUnit[] = [
+  "mg/dL",
+  "mmol/L",
+];
+
+/** unknown is the store saying nothing about the meal, distinct from absent. */
+export type GlucoseMealTime =
+  | "preprandial"
+  | "postprandial"
+  | "unknown";
+
+export const GlucoseMealTimeValues: readonly GlucoseMealTime[] = [
+  "preprandial",
+  "postprandial",
+  "unknown",
+];
+
+/** interstitial is a continuous monitor. */
+export type GlucoseSpecimen =
+  | "capillary"
+  | "interstitial"
+  | "plasma"
+  | "serum"
+  | "tears"
+  | "wholeBlood"
+  | "unknown";
+
+export const GlucoseSpecimenValues: readonly GlucoseSpecimen[] = [
+  "capillary",
+  "interstitial",
+  "plasma",
+  "serum",
+  "tears",
+  "wholeBlood",
+  "unknown",
+];
+
+/**
+ * body and basal are absolute; wrist and skin are deltas from a baseline and routinely
+ * negative.
+ */
+export type BodyTemperatureMetric =
+  | "body"
+  | "basal"
+  | "wrist" // ios only
+  | "skin";
+
+export const BodyTemperatureMetricValues: readonly BodyTemperatureMetric[] = [
+  "body",
+  "basal",
+  "wrist",
+  "skin",
+];
+
+/** HealthKit records SDNN only and Health Connect RMSSD only; they are never one series. */
+export type HeartRateVariabilityMetric =
+  | "sdnn"
+  | "rmssd";
+
+export const HeartRateVariabilityMetricValues: readonly HeartRateVariabilityMetric[] = [
+  "sdnn",
+  "rmssd",
+];
+
+export type VO2MaxTestType =
+  | "maxExercise"
+  | "predictedSubMaxExercise"
+  | "predictedNonExercise";
+
+export const VO2MaxTestTypeValues: readonly VO2MaxTestType[] = [
+  "maxExercise",
+  "predictedSubMaxExercise",
+  "predictedNonExercise",
+];
+
+export type MenstrualEventKind =
+  | "intermenstrualBleeding"
+  | "ovulationTest"
+  | "cervicalMucus";
+
+export const MenstrualEventKindValues: readonly MenstrualEventKind[] = [
+  "intermenstrualBleeding",
+  "ovulationTest",
+  "cervicalMucus",
+];
+
 /**
  * The person a connect is for. A stored link is restored only for the person it was made for;
  * anybody else gets a fresh link. Never sent to Terra as identity.
@@ -257,6 +572,33 @@ export type StreamMessage =
   | { kind: "error"; error: TerraErrorPayload }
   | { kind: "complete" };
 
+/**
+ * What a BodyReading measured, with the unit fixed by the variant. Blood glucose alone keeps
+ * the writer's unit.
+ */
+export type BodyReadingKind =
+  | { type: "measurement"; metric: BodyMetric; value: number }
+  | { type: "bloodPressure"; systolic: number; diastolic: number }
+  | { type: "bloodGlucose"; value: number; unit: BloodGlucoseUnit; mealTime?: GlucoseMealTime | undefined; specimen?: GlucoseSpecimen | undefined }
+  | { type: "oxygenSaturation"; fraction: number }
+  | { type: "temperature"; metric: BodyTemperatureMetric; celsius: number }
+  | { type: "heartRateVariability"; metric: HeartRateVariabilityMetric; milliseconds: number }
+  | { type: "respiratoryRate"; breathsPerMinute: number }
+  | { type: "vo2Max"; millilitresPerKilogramMinute: number; testType?: VO2MaxTestType | undefined };
+
+/**
+ * Apple's store is part of the OS, so it is there or the device cannot have it; Health Connect
+ * is an app a person can lack.
+ */
+export type StoreAvailability =
+  | { kind: "available" }
+  | { kind: "unsupportedDevice" }
+  | { kind: "providerAppMissing" }
+  | { kind: "providerAppTooOld"; installed: string }
+  | { kind: "moduleMissing" }
+  | { kind: "partnerPolicyMissing" }
+  | { kind: "featureUnavailable" };
+
 /** Who recorded a sample. The only stable handle an app has for filtering by app or device. */
 export interface SampleSource {
   readonly name: string;
@@ -331,6 +673,51 @@ export interface Workout {
   readonly source: SampleSource;
   readonly userEntered: boolean;
   readonly timeZone?: string | undefined;
+  /**
+   * ExerciseSessionRecord.title on Android; HKMetadataKeyWorkoutBrandName on Apple, which has no
+   * title field.
+   */
+  readonly title?: string | undefined;
+}
+
+/** Quantities of one meal share foodCorrelationId. */
+export interface DietaryQuantity {
+  readonly id: string;
+  readonly nutrient: Nutrient;
+  readonly value: number;
+  readonly start: Date;
+  readonly end: Date;
+  readonly mealType: MealType;
+  readonly name?: string | undefined;
+  /**
+   * HealthKit's food correlation, absent for a loose quantity. Always set on Android, where it
+   * is the NutritionRecord's id - the id nutrition.delete takes for a meal this app logged.
+   */
+  readonly foodCorrelationId?: string | undefined;
+  readonly source: SampleSource;
+  readonly userEntered: boolean;
+  readonly timeZone?: string | undefined;
+}
+
+/** start and end are the local midnights of that day in timeZone. */
+export interface MenstruationFlowDay {
+  readonly id: string;
+  readonly start: Date;
+  readonly end: Date;
+  readonly flow: MenstruationFlow;
+  readonly cycleStart: boolean;
+  readonly source: SampleSource;
+  readonly userEntered: boolean;
+  readonly timeZone?: string | undefined;
+}
+
+/** Available on ios only. */
+export interface AthleteProfile {
+  readonly biologicalSex: BiologicalSex;
+  /** A calendar day, as HealthKit stores it, never an instant. */
+  readonly dateOfBirth?: string | undefined;
+  readonly wheelchairUse?: boolean | undefined;
+  readonly activityMoveMode?: ActivityMoveMode | undefined;
 }
 
 /** A day whose data changed. Carries no health value by construction. */
@@ -623,6 +1010,44 @@ export interface WorkoutList {
   readonly samples: readonly Workout[];
 }
 
+export interface DietaryQuantityList {
+  readonly samples: readonly DietaryQuantity[];
+}
+
+export interface MenstruationFlowDayList {
+  readonly samples: readonly MenstruationFlowDay[];
+}
+
+/** A cycle event logged at an instant. */
+export interface MenstrualEvent {
+  readonly id: string;
+  readonly kind: MenstrualEventKind;
+  readonly time: Date;
+  /**
+   * ovulationTest: negative, positive, high, indeterminate or luteinizingHormoneSurge.
+   * cervicalMucus: dry, sticky, creamy, watery, eggWhite or unusual. Absent for
+   * intermenstrualBleeding, which is a flag.
+   */
+  readonly value?: string | undefined;
+  /**
+   * The store's own record type, passed through: OvulationTestRecord on Android,
+   * HKCategoryTypeIdentifierOvulationTestResult on Apple.
+   */
+  readonly storeIdentifier: string;
+  readonly source: SampleSource;
+  readonly userEntered: boolean;
+  readonly timeZone?: string | undefined;
+}
+
+export interface MenstrualEventList {
+  readonly samples: readonly MenstrualEvent[];
+}
+
+/** Available on ios only. */
+export interface AthleteProfileResult {
+  readonly profile?: AthleteProfile | undefined;
+}
+
 /** Available on ios only. */
 export interface PlannedWorkoutList {
   readonly workouts: readonly PlannedWorkout[];
@@ -665,3 +1090,133 @@ export interface NutritionEntryList {
   readonly entries: readonly NutritionEntry[];
 }
 
+/**
+ * The store's own total for one local day, from its statistics engine. start and end are that
+ * day's midnights.
+ */
+export interface DayTotal {
+  readonly metric: DayTotalMetric;
+  readonly start: Date;
+  readonly end: Date;
+  readonly value: number;
+  readonly unit: string;
+  readonly timeZone?: string | undefined;
+}
+
+/**
+ * One record a day total is made of, as the store holds it. A record crossing midnight is
+ * whole.
+ */
+export interface IntradaySample {
+  readonly id: string;
+  readonly metric: IntradayMetric;
+  readonly start: Date;
+  readonly end: Date;
+  readonly value: number;
+  readonly source: SampleSource;
+  readonly userEntered: boolean;
+  readonly timeZone?: string | undefined;
+}
+
+/** The store's own resting heart rate for a day, never derived from heart rate readings. */
+export interface RestingHeartRateSample {
+  readonly id: string;
+  readonly start: Date;
+  readonly end: Date;
+  readonly beatsPerMinute: number;
+  readonly source: SampleSource;
+  readonly userEntered: boolean;
+  readonly timeZone?: string | undefined;
+}
+
+/** A point reading has start equal to end; skin and wrist temperature span a stretch. */
+export interface BodyReading {
+  readonly id: string;
+  readonly kind: BodyReadingKind;
+  readonly start: Date;
+  readonly end: Date;
+  readonly source: SampleSource;
+  readonly userEntered: boolean;
+  readonly timeZone?: string | undefined;
+}
+
+export interface RoutePoint {
+  readonly time: Date;
+  readonly latitude: number;
+  readonly longitude: number;
+}
+
+/**
+ * The GPS track a workout left, thinned to one point a second and at most 5,000 points. start
+ * and end are the first and last point.
+ */
+export interface WorkoutRoute {
+  readonly id: string;
+  readonly workoutId: string;
+  readonly start: Date;
+  readonly end: Date;
+  readonly points: readonly RoutePoint[];
+  readonly source: SampleSource;
+  readonly timeZone?: string | undefined;
+}
+
+/** One speed, power or cadence reading. Android's are instants, so start equals end there. */
+export interface WorkoutIntensitySample {
+  readonly id: string;
+  readonly metric: WorkoutIntensityMetric;
+  /**
+   * Set on Apple, where HealthKit stores a reading inside its workout. Health Connect stores
+   * them free-standing, so Android leaves it absent rather than guessing by time.
+   */
+  readonly workoutId?: string | undefined;
+  readonly start: Date;
+  readonly end: Date;
+  readonly value: number;
+  readonly source: SampleSource;
+  readonly userEntered: boolean;
+  readonly timeZone?: string | undefined;
+}
+
+/** One drink, in millilitres. */
+export interface HydrationSample {
+  readonly id: string;
+  readonly start: Date;
+  readonly end: Date;
+  readonly millilitres: number;
+  readonly source: SampleSource;
+  readonly userEntered: boolean;
+  readonly timeZone?: string | undefined;
+}
+
+export interface DayTotalList {
+  readonly totals: readonly DayTotal[];
+}
+
+export interface IntradaySampleList {
+  readonly samples: readonly IntradaySample[];
+}
+
+export interface RestingHeartRateList {
+  readonly samples: readonly RestingHeartRateSample[];
+}
+
+export interface BodyReadingList {
+  readonly samples: readonly BodyReading[];
+}
+
+export interface WorkoutRouteList {
+  readonly routes: readonly WorkoutRoute[];
+}
+
+export interface WorkoutIntensityList {
+  readonly samples: readonly WorkoutIntensitySample[];
+}
+
+export interface HydrationList {
+  readonly samples: readonly HydrationSample[];
+}
+
+export interface AvailabilityResult {
+  readonly availability: StoreAvailability;
+}
+

package/src/index.ts

@@ -17,10 +17,12 @@ export { createTerra } from "./createTerra";
 export { Terra } from "./Terra";
 export type {
   ActivityMetrics,
+  AthleteMetrics,
   Background,
   BodyMetrics,
   DailyMetrics,
   Diagnostics,
+  MenstruationMetrics,
   NativeBridge,
   NutritionMetrics,
   Permissions,