@tryterra/react-native 0.0.0-stage → 2.2.1

package/src/generated/types.ts

@@ -0,0 +1,1222 @@
+// Generated from surface/terra-surface.json by surface/gen. Do not edit by hand.
+// Regenerate with: node surface/gen/src/cli.ts generate
+
+/** A health store the SDK can link. One connection per source per device. */
+export type Source =
+  | "health"
+  | "samsungHealth"; // android only
+
+export const SourceValues: readonly Source[] = [
+  "health",
+  "samsungHealth",
+];
+
+/** The unit permissions are asked for and changes are reported against. */
+export type DataCategory =
+  | "activity"
+  | "body"
+  | "daily"
+  | "sleep"
+  | "nutrition"
+  | "menstruation"
+  | "athlete"; // ios only
+
+export const DataCategoryValues: readonly DataCategory[] = [
+  "activity",
+  "body",
+  "daily",
+  "sleep",
+  "nutrition",
+  "menstruation",
+  "athlete",
+];
+
+export type PermissionStatus =
+  | "granted"
+  | "denied"
+  | "notDetermined"
+  | "notDisclosed"
+  | "unsupported"
+  | "unavailable"; // ios only
+
+export const PermissionStatusValues: readonly PermissionStatus[] = [
+  "granted",
+  "denied",
+  "notDetermined",
+  "notDisclosed",
+  "unsupported",
+  "unavailable",
+];
+
+export type MotionContext =
+  | "unknown"
+  | "sedentary"
+  | "active";
+
+export const MotionContextValues: readonly MotionContext[] = [
+  "unknown",
+  "sedentary",
+  "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.
+ *
+ * Available on android only.
+ */
+export type BackgroundRestrictionReason =
+  | "oemRestricted" // android only
+  | "backgroundReadDenied" // android only
+  | "healthConnectFeatureUnavailable" // android only
+  | "storeFeatureUnavailable" // android only
+  | "ticksNotRunning"; // android only
+
+export const BackgroundRestrictionReasonValues: readonly BackgroundRestrictionReason[] = [
+  "oemRestricted",
+  "backgroundReadDenied",
+  "healthConnectFeatureUnavailable",
+  "storeFeatureUnavailable",
+  "ticksNotRunning",
+];
+
+export type DiagnosticsReason =
+  | "uploadFailed"
+  | "backfillAbandoned"
+  | "backgroundObservationUnavailable"
+  | "backgroundRestricted"
+  | "backgroundRefreshUnscheduled"
+  | "quiet"
+  | "requested";
+
+export const DiagnosticsReasonValues: readonly DiagnosticsReason[] = [
+  "uploadFailed",
+  "backfillAbandoned",
+  "backgroundObservationUnavailable",
+  "backgroundRestricted",
+  "backgroundRefreshUnscheduled",
+  "quiet",
+  "requested",
+];
+
+export type DeviceKeyRevokeOutcome =
+  | "revoked"
+  | "alreadyRevoked"
+  | "routeAbsent";
+
+export const DeviceKeyRevokeOutcomeValues: readonly DeviceKeyRevokeOutcome[] = [
+  "revoked",
+  "alreadyRevoked",
+  "routeAbsent",
+];
+
+/**
+ * The redacted error name an event carries. Deliberately not TerraErrorCode: an event names
+ * the failure without the detail bag, because a support report leaves the device.
+ */
+export type FailureCode =
+  | "healthDataUnavailable"
+  | "notConnected"
+  | "tokenUnavailable"
+  | "tokenRejected"
+  | "tokenProviderFailed"
+  | "offline"
+  | "timedOut"
+  | "serverError"
+  | "transport"
+  | "malformedResponse"
+  | "userLimitReached"
+  | "upgradeRequired"
+  | "platform"
+  | "deviceKeyUnavailable"
+  | "signatureRejected"
+  | "linkRevoked"
+  | "linkConflict"
+  | "clockSkewed"
+  | "devIDMismatch"
+  | "syncAlreadyRunning"
+  | "linkAlreadyRunning"
+  | "storeLocked"
+  | "storeUnreadable"
+  | "deadlineExceeded"
+  | "permissionDenied"
+  | "authorizationNotDetermined"
+  | "sampleNotFound"
+  | "rollbackIncomplete"
+  | "distanceNotAttributable"
+  | "bloodPressureIncomplete"
+  | "authorizationUnavailableInExtension"
+  | "routeAwaitingConverter"
+  | "readQuotaExceeded" // android only
+  | "plannedWorkoutUnnamed"; // ios only
+
+export const FailureCodeValues: readonly FailureCode[] = [
+  "healthDataUnavailable",
+  "notConnected",
+  "tokenUnavailable",
+  "tokenRejected",
+  "tokenProviderFailed",
+  "offline",
+  "timedOut",
+  "serverError",
+  "transport",
+  "malformedResponse",
+  "userLimitReached",
+  "upgradeRequired",
+  "platform",
+  "deviceKeyUnavailable",
+  "signatureRejected",
+  "linkRevoked",
+  "linkConflict",
+  "clockSkewed",
+  "devIDMismatch",
+  "syncAlreadyRunning",
+  "linkAlreadyRunning",
+  "storeLocked",
+  "storeUnreadable",
+  "deadlineExceeded",
+  "permissionDenied",
+  "authorizationNotDetermined",
+  "sampleNotFound",
+  "rollbackIncomplete",
+  "distanceNotAttributable",
+  "bloodPressureIncomplete",
+  "authorizationUnavailableInExtension",
+  "routeAwaitingConverter",
+  "readQuotaExceeded",
+  "plannedWorkoutUnnamed",
+];
+
+/**
+ * Whether Terra's plans can be put on the person's Apple Watch. unsupported before iOS 17 or
+ * where WorkoutKit cannot schedule.
+ *
+ * Available on ios only.
+ */
+export type WorkoutSchedulingStatus =
+  | "unsupported" // ios only
+  | "notDetermined" // ios only
+  | "denied" // ios only
+  | "authorized"; // ios only
+
+export const WorkoutSchedulingStatusValues: readonly WorkoutSchedulingStatus[] = [
+  "unsupported",
+  "notDetermined",
+  "denied",
+  "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.
+ */
+export type EndUser =
+  | { kind: "reference"; id: string }
+  | { kind: "anonymous" };
+
+/** A half-open window [start, end). Resolved against the device's calendar natively. */
+export type TimeRange =
+  | { kind: "lastHours"; hours: number }
+  | { kind: "lastDays"; days: number }
+  | { kind: "today" }
+  | { kind: "between"; start: Date; end: Date };
+
+export type SleepStage =
+  | { kind: "inBed" }
+  | { kind: "awake" }
+  | { kind: "asleep" }
+  | { kind: "light" }
+  | { kind: "deep" }
+  | { kind: "rem" }
+  | { kind: "unknown"; raw: string };
+
+export type WorkoutActivity =
+  | { kind: "running" }
+  | { kind: "walking" }
+  | { kind: "cycling" }
+  | { kind: "swimming" }
+  | { kind: "strengthTraining" }
+  | { kind: "other"; label: string };
+
+/**
+ * What the SDK believes about delivery right now. Wire spelling matches DiagnosticsWire.state
+ * and Apple's DiagnosticsState Encodable.
+ */
+export type DiagnosticsState =
+  | { state: "healthy" }
+  | { state: "quiet"; since: Date }
+  | { state: "backgroundRestricted"; reason?: BackgroundRestrictionReason | undefined }
+  | { state: "backgroundRefreshUnscheduled" }
+  | { state: "pendingRetry" }
+  | { state: "linkRevoked" }
+  | { state: "devIDMismatch" };
+
+/**
+ * What a subscription delivers. A stream can fail or finish, and without saying so the
+ * framework layer has to invent a convention for both - two of those, one per wrapper, is a
+ * contract nobody wrote down.
+ */
+export type StreamMessage =
+  | { kind: "data"; element: Record<string, unknown> }
+  | { 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;
+  readonly bundleId: string;
+  readonly productType?: string | undefined;
+  readonly deviceType?: string | undefined;
+}
+
+/**
+ * A link record. A value, not a handle: Apple's Connection carries sync and disconnect
+ * methods, and an object with behaviour cannot cross the bridge, so those are ops on the
+ * client.
+ */
+export interface Connection {
+  readonly source: Source;
+  readonly userId: string;
+  /**
+   * Android's StoredConnection carries the store-side id. Apple's Connection does not.
+   *
+   * Available on android only.
+   */
+  readonly providerUserId?: string | undefined;
+}
+
+export interface HeartRateSample {
+  readonly id: string;
+  readonly time: Date;
+  readonly beatsPerMinute: number;
+  readonly source: SampleSource;
+  readonly motionContext?: MotionContext | undefined;
+  readonly userEntered: boolean;
+  readonly timeZone?: string | undefined;
+}
+
+/**
+ * A step total over an interval. Apple derives the id from the source and start; Android
+ * carries a RecordId when it has one, so the id is optional on the wire.
+ */
+export interface StepCount {
+  readonly id?: string | undefined;
+  readonly start: Date;
+  readonly end: Date;
+  readonly steps: number;
+  readonly source: SampleSource;
+  readonly userEntered: boolean;
+  readonly timeZone?: string | undefined;
+}
+
+export interface SleepSegment {
+  readonly id: string;
+  readonly start: Date;
+  readonly end: Date;
+  readonly stage: SleepStage;
+  readonly source: SampleSource;
+  readonly userEntered: boolean;
+  readonly timeZone?: string | undefined;
+}
+
+/**
+ * indoor is optional because Health Connect does not always record it; Apple always has an
+ * answer.
+ */
+export interface Workout {
+  readonly id: string;
+  readonly start: Date;
+  readonly end: Date;
+  readonly activity: WorkoutActivity;
+  readonly activityTypeCode: number;
+  readonly indoor?: boolean | undefined;
+  readonly activeEnergyKilocalories?: number | undefined;
+  readonly distanceMeters?: number | undefined;
+  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. */
+export interface HealthChange {
+  readonly category: DataCategory;
+  readonly day: string;
+}
+
+export interface WorkoutScope {
+  readonly activity: WorkoutActivity;
+  readonly energy: boolean;
+  readonly distance: boolean;
+}
+
+/**
+ * Lists rather than sets: JSON has no set, so the category lists are marked `set` and every
+ * generated codec de-duplicates and sorts them, so two orderings compare equal.
+ */
+export interface HealthAccess {
+  readonly read: readonly DataCategory[];
+  readonly write: readonly DataCategory[];
+  readonly workouts: readonly WorkoutScope[];
+}
+
+export interface HeartRateEntry {
+  readonly time: Date;
+  readonly beatsPerMinute: number;
+  readonly recordId?: string | undefined;
+}
+
+export interface StepEntry {
+  readonly start: Date;
+  readonly end: Date;
+  readonly steps: number;
+  readonly recordId?: string | undefined;
+}
+
+export interface SleepEntry {
+  readonly start: Date;
+  readonly end: Date;
+  readonly stage: SleepStage;
+  readonly recordId?: string | undefined;
+}
+
+export interface WorkoutEntry {
+  readonly start: Date;
+  readonly end: Date;
+  readonly activity: WorkoutActivity;
+  readonly totalEnergyKilocalories?: number | undefined;
+  readonly totalDistanceMeters?: number | undefined;
+  readonly recordId?: string | undefined;
+}
+
+export interface BodyEntry {
+  readonly time: Date;
+  readonly bodyMassKilograms?: number | undefined;
+  readonly bodyFatPercent?: number | undefined;
+  readonly bodyMassIndex?: number | undefined;
+  readonly heightMeters?: number | undefined;
+  readonly leanBodyMassKilograms?: number | undefined;
+  readonly bodyTemperatureCelsius?: number | undefined;
+  readonly oxygenSaturationPercent?: number | undefined;
+  readonly bloodGlucoseMilligramsPerDeciliter?: number | undefined;
+  readonly bloodPressureSystolicMillimetersOfMercury?: number | undefined;
+  readonly bloodPressureDiastolicMillimetersOfMercury?: number | undefined;
+  readonly recordId?: string | undefined;
+}
+
+/**
+ * Every field optional and every unit in the name, matching NutritionEntry.Nutrients on both
+ * platforms field for field.
+ */
+export interface Nutrients {
+  readonly energyKilocalories?: number | undefined;
+  readonly proteinGrams?: number | undefined;
+  readonly carbohydratesGrams?: number | undefined;
+  readonly fiberGrams?: number | undefined;
+  readonly sugarGrams?: number | undefined;
+  readonly fatTotalGrams?: number | undefined;
+  readonly fatSaturatedGrams?: number | undefined;
+  readonly fatMonounsaturatedGrams?: number | undefined;
+  readonly fatPolyunsaturatedGrams?: number | undefined;
+  readonly cholesterolMilligrams?: number | undefined;
+  readonly sodiumMilligrams?: number | undefined;
+  readonly potassiumMilligrams?: number | undefined;
+  readonly calciumMilligrams?: number | undefined;
+  readonly ironMilligrams?: number | undefined;
+  readonly magnesiumMilligrams?: number | undefined;
+  readonly zincMilligrams?: number | undefined;
+  readonly waterLiters?: number | undefined;
+  readonly caffeineMilligrams?: number | undefined;
+  readonly vitaminAMicrograms?: number | undefined;
+  readonly vitaminCMilligrams?: number | undefined;
+  readonly vitaminDMicrograms?: number | undefined;
+  readonly vitaminEMilligrams?: number | undefined;
+  readonly vitaminKMicrograms?: number | undefined;
+  readonly vitaminB6Milligrams?: number | undefined;
+  readonly vitaminB12Micrograms?: number | undefined;
+  readonly folateMicrograms?: number | undefined;
+  readonly thiaminMilligrams?: number | undefined;
+  readonly riboflavinMilligrams?: number | undefined;
+  readonly niacinMilligrams?: number | undefined;
+  readonly biotinMicrograms?: number | undefined;
+  readonly pantothenicAcidMilligrams?: number | undefined;
+  readonly phosphorusMilligrams?: number | undefined;
+  readonly iodineMicrograms?: number | undefined;
+  readonly chromiumMicrograms?: number | undefined;
+  readonly copperMilligrams?: number | undefined;
+  readonly manganeseMilligrams?: number | undefined;
+  readonly molybdenumMicrograms?: number | undefined;
+  readonly seleniumMicrograms?: number | undefined;
+  readonly chlorideMilligrams?: number | undefined;
+}
+
+export interface NutritionEntry {
+  readonly start: Date;
+  readonly end: Date;
+  readonly name?: string | undefined;
+  readonly nutrients: Nutrients;
+  readonly recordId?: string | undefined;
+}
+
+/**
+ * An error carried as a value rather than thrown, inside a sync result. The same shape the
+ * bridge rejects a promise with.
+ */
+export interface TerraErrorPayload {
+  readonly code: string;
+  readonly retryable: boolean;
+  readonly message: string;
+  readonly source?: Source | undefined;
+  readonly details?: Record<string, unknown> | undefined;
+}
+
+/** Available on ios only. */
+export interface PlannedWorkout {
+  readonly id: string;
+  readonly plannedOn: string;
+  readonly activity: WorkoutActivity;
+  readonly title?: string | undefined;
+  readonly completedAt?: Date | undefined;
+}
+
+/**
+ * The flat object both SDKs already emit: `at`, `event`, and whatever keys that kind carries.
+ * Carried through unchanged rather than reshaped, because reshaping it would be a hand-written
+ * second contract on each platform that no vector could pin - and the encoding it would be
+ * translating is one DiagnosticsWire and Apple's Encodable already agree on, and that
+ * EventPrivacyTest already guards against carrying a health value.
+ */
+export type TerraEvent = Record<string, unknown>;
+
+/**
+ * The redacted report, carried as the wire object DiagnosticsWire.report and Apple's
+ * SupportReport.json already produce.
+ */
+export interface SupportReport {
+  readonly sdkVersion: string;
+  readonly generatedAt: Date;
+  readonly state: DiagnosticsState;
+  readonly lastDelivery?: Date | undefined;
+  readonly isConnected: boolean;
+  readonly requestedCategories: readonly string[];
+  readonly requestedWrites: readonly string[];
+  readonly requestedWorkouts: readonly string[];
+  readonly recentEvents: readonly TerraEvent[];
+}
+
+/**
+ * What the JS side needs to know about the native client it is attaching to. bootstrapped
+ * false is a host setup bug, and the wrapper says so with the exact line to add.
+ */
+export interface BootstrapState {
+  readonly bootstrapped: boolean;
+  readonly devId?: string | undefined;
+  readonly platform: string;
+  readonly sdkVersion: string;
+  readonly backgroundRegistered: boolean;
+}
+
+/**
+ * The broker asking JS for a link token. Answered by token.resolve or token.reject with the
+ * same requestId.
+ */
+export interface TokenRequest {
+  readonly requestId: string;
+}
+
+/** No request fields, or no response value. */
+export type Empty = Record<string, never>;
+
+export interface SourceRequest {
+  readonly source?: Source | undefined;
+}
+
+export interface RangeRequest {
+  readonly range: TimeRange;
+}
+
+export interface CategoryRequest {
+  readonly category: DataCategory;
+  readonly source?: Source | undefined;
+}
+
+export interface RecordIdRequest {
+  readonly id: string;
+}
+
+export interface ConnectRequest {
+  readonly source?: Source | undefined;
+  readonly endUser: EndUser;
+  /**
+   * A grant already in hand, from a QR code or a deep link. Absent means the token provider is
+   * asked.
+   */
+  readonly token?: string | undefined;
+}
+
+export interface PermissionRequest {
+  readonly read: readonly DataCategory[];
+  readonly write: readonly DataCategory[];
+  readonly workouts: readonly WorkoutScope[];
+  readonly source?: Source | undefined;
+}
+
+/**
+ * What the sheet granted. Android answers with the access this call obtained; HealthKit will
+ * not report read grants, so Apple answers nothing at all.
+ */
+export interface PermissionGrant {
+  /** Available on android only. */
+  readonly granted?: HealthAccess | undefined;
+}
+
+export interface TokenResolveRequest {
+  readonly requestId: string;
+  readonly token: string;
+}
+
+export interface TokenRejectRequest {
+  readonly requestId: string;
+  readonly message: string;
+}
+
+export interface TokenProviderRequest {
+  readonly present: boolean;
+  readonly timeoutMs: number;
+}
+
+/** Available on ios only. */
+export interface MarkCompleteRequest {
+  readonly id: string;
+  readonly at?: Date | undefined;
+}
+
+export interface BoolResult {
+  readonly value: boolean;
+}
+
+export interface StatusResult {
+  readonly status: PermissionStatus;
+}
+
+/** Available on android only. */
+export interface StatusesResult {
+  readonly statuses: Partial<Record<DataCategory, PermissionStatus>>;
+}
+
+export interface RecordIdList {
+  readonly ids: readonly string[];
+}
+
+export interface ConnectionList {
+  readonly connections: readonly Connection[];
+}
+
+export interface HeartRateList {
+  readonly samples: readonly HeartRateSample[];
+}
+
+export interface StepCountList {
+  readonly samples: readonly StepCount[];
+}
+
+export interface SleepSegmentList {
+  readonly samples: readonly SleepSegment[];
+}
+
+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[];
+}
+
+/**
+ * Once authorized, every sync run keeps the Watch schedule in step with Terra.
+ *
+ * Available on ios only.
+ */
+export interface WorkoutScheduling {
+  readonly status: WorkoutSchedulingStatus;
+}
+
+export interface LastDeliveryResult {
+  readonly at?: Date | undefined;
+}
+
+export interface HeartRateEntryList {
+  readonly entries: readonly HeartRateEntry[];
+}
+
+export interface BodyEntryList {
+  readonly entries: readonly BodyEntry[];
+}
+
+export interface StepEntryList {
+  readonly entries: readonly StepEntry[];
+}
+
+export interface SleepEntryList {
+  readonly entries: readonly SleepEntry[];
+}
+
+export interface WorkoutEntryList {
+  readonly entries: readonly WorkoutEntry[];
+}
+
+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;
+}
+