---
url: /docs/api/core/README.md
description: >-
  TypeScript API reference for @kaiord/core, domain types, schemas, ports and
  use cases.
---

**@kaiord/core**

***

# @kaiord/core

## Classes

* [FitParsingError](classes/FitParsingError.md)
* [GarminParsingError](classes/GarminParsingError.md)
* [KrdValidationError](classes/KrdValidationError.md)
* [MissingFtpError](classes/MissingFtpError.md)
* [MissingMaxHeartRateError](classes/MissingMaxHeartRateError.md)
* [ServiceApiError](classes/ServiceApiError.md)
* [ServiceAuthError](classes/ServiceAuthError.md)
* [TcxParsingError](classes/TcxParsingError.md)
* [TcxValidationError](classes/TcxValidationError.md)
* [ToleranceExceededError](classes/ToleranceExceededError.md)
* [UnsupportedKrdTypeError](classes/UnsupportedKrdTypeError.md)
* [ZwiftParsingError](classes/ZwiftParsingError.md)
* [ZwiftValidationError](classes/ZwiftValidationError.md)

## Type Aliases

* [Activity](type-aliases/Activity.md)
* [ActivityLevel](type-aliases/ActivityLevel.md)
* [ActivitySummary](type-aliases/ActivitySummary.md)
* [AdaptiveTdeeResult](type-aliases/AdaptiveTdeeResult.md)
* [AffineUnit](type-aliases/AffineUnit.md)
* [Analytics](type-aliases/Analytics.md)
* [AnalyticsEvent](type-aliases/AnalyticsEvent.md)
* [AssembleDayEnergyBalanceInput](type-aliases/AssembleDayEnergyBalanceInput.md)
* [AuthProvider](type-aliases/AuthProvider.md)
* [BinaryReader](type-aliases/BinaryReader.md)
* [BinaryWriter](type-aliases/BinaryWriter.md)
* [BiologicalSex](type-aliases/BiologicalSex.md)
* [BmrFormula](type-aliases/BmrFormula.md)
* [BmrInput](type-aliases/BmrInput.md)
* [BmrResult](type-aliases/BmrResult.md)
* [BodyComposition](type-aliases/BodyComposition.md)
* [BridgeId](type-aliases/BridgeId.md)
* [CadenceValue](type-aliases/CadenceValue.md)
* [CanonicalMeasurement](type-aliases/CanonicalMeasurement.md)
* [CatalogFallback](type-aliases/CatalogFallback.md)
* [ComputeAdaptiveTdeeInput](type-aliases/ComputeAdaptiveTdeeInput.md)
* [ComputeDailyDeltaInput](type-aliases/ComputeDailyDeltaInput.md)
* [ComputeDailyDeltaResult](type-aliases/ComputeDailyDeltaResult.md)
* [ComputeFlagInput](type-aliases/ComputeFlagInput.md)
* [ComputeMacroTargetsInput](type-aliases/ComputeMacroTargetsInput.md)
* [ComputePeriodizedTargetInput](type-aliases/ComputePeriodizedTargetInput.md)
* [DailyWellness](type-aliases/DailyWellness.md)
* [DayEnergyBalance](type-aliases/DayEnergyBalance.md)
* [DayExpenditureInput](type-aliases/DayExpenditureInput.md)
* [DayExpenditureResult](type-aliases/DayExpenditureResult.md)
* [Duration](type-aliases/Duration.md)
* [DurationType](type-aliases/DurationType.md)
* [EmaOptions](type-aliases/EmaOptions.md)
* [EmaPoint](type-aliases/EmaPoint.md)
* [EmaResult](type-aliases/EmaResult.md)
* [EnergyBalanceRollup](type-aliases/EnergyBalanceRollup.md)
* [EnergyGoal](type-aliases/EnergyGoal.md)
* [Equipment](type-aliases/Equipment.md)
* [ExpectedActivityKcalInput](type-aliases/ExpectedActivityKcalInput.md)
* [ExpenditureSource](type-aliases/ExpenditureSource.md)
* [FileType](type-aliases/FileType.md)
* [GoalType](type-aliases/GoalType.md)
* [HashProjection](type-aliases/HashProjection.md)
* [HealthExtensionPayload](type-aliases/HealthExtensionPayload.md)
* [HealthFileType](type-aliases/HealthFileType.md)
* [HeartRateSeries](type-aliases/HeartRateSeries.md)
* [HeartRateValue](type-aliases/HeartRateValue.md)
* [HrvSummary](type-aliases/HrvSummary.md)
* [Intensity](type-aliases/Intensity.md)
* [KnownUnit](type-aliases/KnownUnit.md)
* [KRD](type-aliases/KRD.md)
* [KRDEvent](type-aliases/KRDEvent.md)
* [KRDExtensions](type-aliases/KRDExtensions.md)
* [KRDLap](type-aliases/KRDLap.md)
* [KRDLapTrigger](type-aliases/KRDLapTrigger.md)
* [KRDMetadata](type-aliases/KRDMetadata.md)
* [KRDRecord](type-aliases/KRDRecord.md)
* [KRDSession](type-aliases/KRDSession.md)
* [LabFlag](type-aliases/LabFlag.md)
* [LabPanel](type-aliases/LabPanel.md)
* [LabParameter](type-aliases/LabParameter.md)
* [LabProvenance](type-aliases/LabProvenance.md)
* [LabRefRange](type-aliases/LabRefRange.md)
* [LabRefSource](type-aliases/LabRefSource.md)
* [LabReport](type-aliases/LabReport.md)
* [LabValue](type-aliases/LabValue.md)
* [LengthUnit](type-aliases/LengthUnit.md)
* [ListOptions](type-aliases/ListOptions.md)
* [Logger](type-aliases/Logger.md)
* [LogLevel](type-aliases/LogLevel.md)
* [MacroNutrients](type-aliases/MacroNutrients.md)
* [ManagedDataRegistryEntry](type-aliases/ManagedDataRegistryEntry.md)
* [ManagedDataType](type-aliases/ManagedDataType.md)
* [MealSlot](type-aliases/MealSlot.md)
* [MeasuredWellness](type-aliases/MeasuredWellness.md)
* [PaceValue](type-aliases/PaceValue.md)
* [PlannedSession](type-aliases/PlannedSession.md)
* [PlannedSessionStatus](type-aliases/PlannedSessionStatus.md)
* [PowerValue](type-aliases/PowerValue.md)
* [PowerZone](type-aliases/PowerZone.md)
* [ProfileSnapshot](type-aliases/ProfileSnapshot.md)
* [PushOptions](type-aliases/PushOptions.md)
* [PushResult](type-aliases/PushResult.md)
* [RepetitionBlock](type-aliases/RepetitionBlock.md)
* [ResolvedExpenditure](type-aliases/ResolvedExpenditure.md)
* [SchemaValidator](type-aliases/SchemaValidator.md)
* [Sex](type-aliases/Sex.md)
* [SleepRecord](type-aliases/SleepRecord.md)
* [SleepStage](type-aliases/SleepStage.md)
* [Sport](type-aliases/Sport.md)
* [SportCategory](type-aliases/SportCategory.md)
* [StrainSummary](type-aliases/StrainSummary.md)
* [StressEpisode](type-aliases/StressEpisode.md)
* [StrokeTypeValue](type-aliases/StrokeTypeValue.md)
* [SubSport](type-aliases/SubSport.md)
* [SwimStroke](type-aliases/SwimStroke.md)
* [Target](type-aliases/Target.md)
* [TargetType](type-aliases/TargetType.md)
* [TargetUnit](type-aliases/TargetUnit.md)
* [TextReader](type-aliases/TextReader.md)
* [TextWriter](type-aliases/TextWriter.md)
* [TokenData](type-aliases/TokenData.md)
* [TokenStore](type-aliases/TokenStore.md)
* [ToleranceChecker](type-aliases/ToleranceChecker.md)
* [ToleranceConfig](type-aliases/ToleranceConfig.md)
* [ToleranceViolation](type-aliases/ToleranceViolation.md)
* [TrainingZoneBand](type-aliases/TrainingZoneBand.md)
* [TrainingZones](type-aliases/TrainingZones.md)
* [TrainingZoneSet](type-aliases/TrainingZoneSet.md)
* [ValidateRoundTrip](type-aliases/ValidateRoundTrip.md)
* [ValidationError](type-aliases/ValidationError.md)
* [VitalsSummary](type-aliases/VitalsSummary.md)
* [WeightMeasurement](type-aliases/WeightMeasurement.md)
* [Workout](type-aliases/Workout.md)
* [WorkoutService](type-aliases/WorkoutService.md)
* [WorkoutStep](type-aliases/WorkoutStep.md)
* [WorkoutSummary](type-aliases/WorkoutSummary.md)

## Variables

* [activitySchema](variables/activitySchema.md)
* [activitySummarySchema](variables/activitySummarySchema.md)
* [BODY_FAT_TOLERANCE_PERCENT](variables/BODY_FAT_TOLERANCE_PERCENT.md)
* [bodyCompositionSchema](variables/bodyCompositionSchema.md)
* [CUSTOM_PARAMETER_PREFIX](variables/CUSTOM_PARAMETER_PREFIX.md)
* [DAILY_KCAL_TOLERANCE](variables/DAILY_KCAL_TOLERANCE.md)
* [DAILY_STEPS_TOLERANCE](variables/DAILY_STEPS_TOLERANCE.md)
* [dailyWellnessSchema](variables/dailyWellnessSchema.md)
* [dayEnergyBalanceSchema](variables/dayEnergyBalanceSchema.md)
* [DEFAULT_MET](variables/DEFAULT_MET.md)
* [DEFAULT_NEAT_FACTOR](variables/DEFAULT_NEAT_FACTOR.md)
* [DEFAULT_TOLERANCES](variables/DEFAULT_TOLERANCES.md)
* [durationSchema](variables/durationSchema.md)
* [durationTypeSchema](variables/durationTypeSchema.md)
* [energyGoalSchema](variables/energyGoalSchema.md)
* [equipmentSchema](variables/equipmentSchema.md)
* [expenditureSourceSchema](variables/expenditureSourceSchema.md)
* [fileTypeSchema](variables/fileTypeSchema.md)
* [FIT_TO_SWIM_STROKE](variables/FIT_TO_SWIM_STROKE.md)
* [FLOOR_KCAL](variables/FLOOR_KCAL.md)
* [goalTypeSchema](variables/goalTypeSchema.md)
* [healthExtensionPayloadSchema](variables/healthExtensionPayloadSchema.md)
* [healthFileTypes](variables/healthFileTypes.md)
* [HEART_RATE_SERIES_BPM_TOLERANCE](variables/HEART_RATE_SERIES_BPM_TOLERANCE.md)
* [heartRateSeriesSchema](variables/heartRateSeriesSchema.md)
* [HRV_TOLERANCE_MS](variables/HRV_TOLERANCE_MS.md)
* [hrvSummarySchema](variables/hrvSummarySchema.md)
* [intensitySchema](variables/intensitySchema.md)
* [KCAL_PER_KG_FAT](variables/KCAL_PER_KG_FAT.md)
* [knownUnitSchema](variables/knownUnitSchema.md)
* [krdEventSchema](variables/krdEventSchema.md)
* [krdExtensionsSchema](variables/krdExtensionsSchema.md)
* [krdLapSchema](variables/krdLapSchema.md)
* [krdLapTriggerSchema](variables/krdLapTriggerSchema.md)
* [krdMetadataSchema](variables/krdMetadataSchema.md)
* [krdRecordSchema](variables/krdRecordSchema.md)
* [krdSchema](variables/krdSchema.md)
* [krdSessionSchema](variables/krdSessionSchema.md)
* [LAB_PARAMETER_CATALOG](variables/LAB_PARAMETER_CATALOG.md)
* [labFlagSchema](variables/labFlagSchema.md)
* [labPanelSchema](variables/labPanelSchema.md)
* [labParameterSchema](variables/labParameterSchema.md)
* [labProvenanceSchema](variables/labProvenanceSchema.md)
* [labRefRangeSchema](variables/labRefRangeSchema.md)
* [labRefSourceSchema](variables/labRefSourceSchema.md)
* [labReportSchema](variables/labReportSchema.md)
* [labValueSchema](variables/labValueSchema.md)
* [lengthUnitSchema](variables/lengthUnitSchema.md)
* [macroNutrientsSchema](variables/macroNutrientsSchema.md)
* [MANAGED_DATA_REGISTRY](variables/MANAGED_DATA_REGISTRY.md)
* [managedDataTypes](variables/managedDataTypes.md)
* [mealSlotSchema](variables/mealSlotSchema.md)
* [MET_TABLE](variables/MET_TABLE.md)
* [MIN_ADAPTIVE_DAYS](variables/MIN_ADAPTIVE_DAYS.md)
* [MUSCLE_SURPLUS_CAP](variables/MUSCLE_SURPLUS_CAP.md)
* [NEAT_FACTOR](variables/NEAT_FACTOR.md)
* [plannedSessionSchema](variables/plannedSessionSchema.md)
* [plannedSessionStatusSchema](variables/plannedSessionStatusSchema.md)
* [POWER_ZONE_PERCENT_FTP](variables/POWER_ZONE_PERCENT_FTP.md)
* [POWER_ZONES](variables/POWER_ZONES.md)
* [profileSnapshotSchema](variables/profileSnapshotSchema.md)
* [repetitionBlockSchema](variables/repetitionBlockSchema.md)
* [SLEEP_STAGE_TOLERANCE_SECONDS](variables/SLEEP_STAGE_TOLERANCE_SECONDS.md)
* [SLEEP_TOTAL_DURATION_TOLERANCE_SECONDS](variables/SLEEP_TOTAL_DURATION_TOLERANCE_SECONDS.md)
* [sleepRecordSchema](variables/sleepRecordSchema.md)
* [sleepStageSchema](variables/sleepStageSchema.md)
* [sportSchema](variables/sportSchema.md)
* [STALE_SNAPSHOT_THRESHOLD_DAYS](variables/STALE_SNAPSHOT_THRESHOLD_DAYS.md)
* [STRAIN_SCORE_TOLERANCE](variables/STRAIN_SCORE_TOLERANCE.md)
* [strainSummarySchema](variables/strainSummarySchema.md)
* [STRESS_TOLERANCE](variables/STRESS_TOLERANCE.md)
* [stressEpisodeSchema](variables/stressEpisodeSchema.md)
* [subSportSchema](variables/subSportSchema.md)
* [SWIM_STROKE_TO_FIT](variables/SWIM_STROKE_TO_FIT.md)
* [swimStrokeSchema](variables/swimStrokeSchema.md)
* [targetSchema](variables/targetSchema.md)
* [targetTypeSchema](variables/targetTypeSchema.md)
* [targetUnitSchema](variables/targetUnitSchema.md)
* [toleranceConfigSchema](variables/toleranceConfigSchema.md)
* [toleranceViolationSchema](variables/toleranceViolationSchema.md)
* [trainingZoneBandSchema](variables/trainingZoneBandSchema.md)
* [trainingZoneSetSchema](variables/trainingZoneSetSchema.md)
* [trainingZonesSchema](variables/trainingZonesSchema.md)
* [VITALS_RESPIRATORY_RATE_TOLERANCE](variables/VITALS_RESPIRATORY_RATE_TOLERANCE.md)
* [VITALS_RESTING_HEART_RATE_TOLERANCE](variables/VITALS_RESTING_HEART_RATE_TOLERANCE.md)
* [VITALS_SPO2_TOLERANCE](variables/VITALS_SPO2_TOLERANCE.md)
* [vitalsSummarySchema](variables/vitalsSummarySchema.md)
* [WEIGHT_TOLERANCE_KG](variables/WEIGHT_TOLERANCE_KG.md)
* [weightMeasurementSchema](variables/weightMeasurementSchema.md)
* [workoutLikeFileTypes](variables/workoutLikeFileTypes.md)
* [workoutSchema](variables/workoutSchema.md)
* [workoutStepSchema](variables/workoutStepSchema.md)

## Functions

* [aggregateEnergyBalance](functions/aggregateEnergyBalance.md)
* [assembleDayEnergyBalance](functions/assembleDayEnergyBalance.md)
* [canonicalHash](functions/canonicalHash.md)
* [compareKRDs](functions/compareKRDs.md)
* [computeAdaptiveTdee](functions/computeAdaptiveTdee.md)
* [computeBmr](functions/computeBmr.md)
* [computeDailyDelta](functions/computeDailyDelta.md)
* [computeFlag](functions/computeFlag.md)
* [computeMacroTargets](functions/computeMacroTargets.md)
* [computePeriodizedTarget](functions/computePeriodizedTarget.md)
* [convertBound](functions/convertBound.md)
* [convertLengthToMeters](functions/convertLengthToMeters.md)
* [convertMeasurement](functions/convertMeasurement.md)
* [createConsoleLogger](functions/createConsoleLogger.md)
* [createFitParsingError](functions/createFitParsingError.md)
* [createGarminParsingError](functions/createGarminParsingError.md)
* [createKrdValidationError](functions/createKrdValidationError.md)
* [createMissingFtpError](functions/createMissingFtpError.md)
* [createMissingMaxHeartRateError](functions/createMissingMaxHeartRateError.md)
* [createNoopAnalytics](functions/createNoopAnalytics.md)
* [createSchemaValidator](functions/createSchemaValidator.md)
* [createServiceApiError](functions/createServiceApiError.md)
* [createServiceAuthError](functions/createServiceAuthError.md)
* [createTcxParsingError](functions/createTcxParsingError.md)
* [createTcxValidationError](functions/createTcxValidationError.md)
* [createToleranceChecker](functions/createToleranceChecker.md)
* [createUnsupportedKrdTypeError](functions/createUnsupportedKrdTypeError.md)
* [createWorkoutKRD](functions/createWorkoutKRD.md)
* [createZwiftParsingError](functions/createZwiftParsingError.md)
* [createZwiftValidationError](functions/createZwiftValidationError.md)
* [customParameterKey](functions/customParameterKey.md)
* [deriveExternalId](functions/deriveExternalId.md)
* [estimateExpectedActivityKcal](functions/estimateExpectedActivityKcal.md)
* [exponentialMovingAverage](functions/exponentialMovingAverage.md)
* [extractWorkout](functions/extractWorkout.md)
* [fingerprintSnapshot](functions/fingerprintSnapshot.md)
* [fromBinary](functions/fromBinary.md)
* [fromCanonicalValue](functions/fromCanonicalValue.md)
* [fromText](functions/fromText.md)
* [getLabParameter](functions/getLabParameter.md)
* [isCustomParameterKey](functions/isCustomParameterKey.md)
* [isHealthFileType](functions/isHealthFileType.md)
* [isPowerZone](functions/isPowerZone.md)
* [isRepetitionBlock](functions/isRepetitionBlock.md)
* [metForSport](functions/metForSport.md)
* [neatFactorForActivityLevel](functions/neatFactorForActivityLevel.md)
* [parseRefTextBounds](functions/parseRefTextBounds.md)
* [percentFtpToZone](functions/percentFtpToZone.md)
* [resolveAffineUnit](functions/resolveAffineUnit.md)
* [resolveDayExpenditure](functions/resolveDayExpenditure.md)
* [sportCategory](functions/sportCategory.md)
* [toBinary](functions/toBinary.md)
* [toCanonicalValue](functions/toCanonicalValue.md)
* [toText](functions/toText.md)
* [validateKrd](functions/validateKrd.md)
* [validateRoundTrip](functions/validateRoundTrip.md)
* [zoneToPercentFtp](functions/zoneToPercentFtp.md)