ts-garmin 0.1.0

package/dist/garmin/types/hydration.d.ts

@@ -0,0 +1,17 @@
+export declare interface HydrationData {
+  userId: number
+  calendarDate: string
+  valueInML: number
+  goalInML: number
+  sweatLossInML?: number
+  activityIntakeInML?: number
+  timestampLocal?: string
+  lastEntryTimestampLocal?: string
+}
+export declare interface WaterIntake {
+  id?: number
+  userProfileId: number
+  calendarDate: string
+  valueInML: number
+  timestampLocal?: string
+}

package/dist/garmin/types/index.d.ts

@@ -0,0 +1,353 @@
+export declare interface IUserInfo {
+  userProfileId: GCUserProfileId
+  username: string
+  emailAddress: string
+  locale: string
+  measurementSystemKey: string
+  timeFormatKey: string
+  dateFormatKey: string
+  numberFormatKey: string
+  heartRateDisplayFormatKey: string
+  powerDisplayFormatKey: string
+  timeZoneGroupKey: string
+  dayKey: unknown
+  isPublicByDefault: boolean
+  roles: string[]
+  displayName: GCUserHash
+  tocAcceptedDate: string
+  defaultActivityPrivacy: unknown
+  customerId: string
+  birthdate: unknown
+  socialNetwork: string
+  socialIcon: string
+  systemUser: boolean
+  systemMetricUser: boolean
+  underAge: boolean
+}
+export declare interface ISocialProfile {
+  id: number
+  profileId: GCUserProfileId
+  garminGUID: string
+  displayName: GCUserHash
+  fullName: string
+  userName: string
+  profileImageUuid: unknown
+  profileImageUrlLarge: string
+  profileImageUrlMedium: string
+  profileImageUrlSmall: string
+  location: string
+  facebookUrl: unknown
+  twitterUrl: unknown
+  personalWebsite: unknown
+  motivation: unknown
+  bio: unknown
+  primaryActivity: unknown
+  favoriteActivityTypes: unknown[]
+  runningTrainingSpeed: number
+  cyclingTrainingSpeed: number
+  favoriteCyclingActivityTypes: unknown[]
+  cyclingClassification: unknown
+  cyclingMaxAvgPower: number
+  swimmingTrainingSpeed: number
+  profileVisibility: string
+  activityStartVisibility: string
+  activityMapVisibility: string
+  courseVisibility: string
+  activityHeartRateVisibility: string
+  activityPowerVisibility: string
+  badgeVisibility: string
+  showAge: boolean
+  showWeight: boolean
+  showHeight: boolean
+  showWeightClass: boolean
+  showAgeRange: boolean
+  showGender: boolean
+  showActivityClass: boolean
+  showVO2Max: boolean
+  showPersonalRecords: boolean
+  showLast12Months: boolean
+  showLifetimeTotals: boolean
+  showUpcomingEvents: boolean
+  showRecentFavorites: boolean
+  showRecentDevice: boolean
+  showRecentGear: boolean
+  showBadges: boolean
+  otherActivity: null
+  otherPrimaryActivity: null
+  otherMotivation: null
+  userRoles: string[]
+  nameApproved: boolean
+  userProfileFullName: string
+  makeGolfScorecardsPrivate: boolean
+  allowGolfLiveScoring: boolean
+  allowGolfScoringByConnections: boolean
+  userLevel: number
+  userPoint: number
+  levelUpdateDate: string
+  levelIsViewed: boolean
+  levelPointThreshold: number
+  userPointOffset: number
+  userPro: boolean
+}
+export declare interface IOauth1Consumer {
+  key: string
+  secret: string
+}
+export declare interface IOauth1 {
+  token: IOauth1Token
+}
+export declare interface IGarminTokens {
+  oauth1: IOauth1Token
+  oauth2: IOauth2Token
+}
+export declare interface IOauth1Token {
+  oauth_token: string
+  oauth_token_secret: string
+}
+export declare interface IOauth2Token {
+  scope: string
+  jti: string
+  access_token: string
+  token_type: string
+  refresh_token: string
+  expires_in: number
+  refresh_token_expires_in: number
+  expires_at: number
+  refresh_token_expires_at: number
+  last_update_date: string
+  expires_date: string
+}
+export declare interface IUserSettings {
+  id: number
+  userData: IUserData
+  userSleep: {
+    sleepTime: number
+    defaultSleepTime: boolean
+    wakeTime: number
+    defaultWakeTime: boolean
+  }
+  connectDate: unknown
+  sourceType: unknown
+  userSleepWindows: IUserSleepWindows[]
+}
+export declare interface IUserData {
+  gender: unknown
+  weight: unknown
+  height: unknown
+  timeFormat: string
+  birthDate: unknown
+  measurementSystem: string
+  activityLevel: unknown
+  handedness: string
+  powerFormat: {
+    formatId: number
+    formatKey: string
+    minFraction: number
+    maxFraction: number
+    groupingUsed: boolean
+    displayFormat: unknown
+  }
+  heartRateFormat: {
+    formatId: number
+    formatKey: string
+    minFraction: number
+    maxFraction: number
+    groupingUsed: boolean
+    displayFormat: unknown
+  }
+  firstDayOfWeek: {
+    dayId: number
+    dayName: string
+    sortOrder: number
+    isPossibleFirstDay: boolean
+  }
+  vo2MaxRunning: unknown
+  vo2MaxCycling: unknown
+  lactateThresholdSpeed: unknown
+  lactateThresholdHeartRate: unknown
+  diveNumber: unknown
+  intensityMinutesCalcMethod: string
+  moderateIntensityMinutesHrZone: number
+  vigorousIntensityMinutesHrZone: number
+  hydrationMeasurementUnit: string
+  hydrationContainers: unknown[]
+  hydrationAutoGoalEnabled: boolean
+  firstbeatMaxStressScore: unknown
+  firstbeatCyclingLtTimestamp: unknown
+  firstbeatRunningLtTimestamp: unknown
+  thresholdHeartRateAutoDetected: unknown
+  ftpAutoDetected: unknown
+  trainingStatusPausedDate: unknown
+  weatherLocation: {
+    useFixedLocation: unknown
+    latitude: unknown
+    longitude: unknown
+    locationName: unknown
+    isoCountryCode: unknown
+    postalCode: unknown
+  }
+  golfDistanceUnit: string
+  golfElevationUnit: unknown
+  golfSpeedUnit: unknown
+  externalBottomTime: unknown
+}
+export declare interface IUserSleepWindows {
+  sleepWindowFrequency: string
+  startSleepTimeSecondsFromMidnight: number
+  endSleepTimeSecondsFromMidnight: number
+}
+export declare interface ICountActivities {
+  countOfActivities: number
+  date: string
+  stats: {
+    all: Record<string, unknown>
+  }
+}
+export declare interface IDailyStepsType {
+  calendarDate: string
+  stepGoal: number
+  totalDistance: number
+  totalSteps: number
+}
+export declare interface IWorkout {
+  workoutId?: number
+  ownerId?: number
+  workoutName: string
+  description?: string
+  updateDate: Date
+  createdDate: Date
+  sportType: ISportType
+  trainingPlanId: null
+  author: IAuthor
+  estimatedDurationInSecs: number
+  estimatedDistanceInMeters: null
+  estimateType: null
+  estimatedDistanceUnit: IUnit
+  poolLength: number
+  poolLengthUnit: IUnit
+  workoutProvider: string
+  workoutSourceId: string
+  consumer: null
+  atpPlanId: null
+  workoutNameI18nKey: null
+  descriptionI18nKey: null
+  shared: boolean
+  estimated: boolean
+}
+export declare interface IWorkoutDetail extends IWorkout {
+  workoutSegments: IWorkoutSegment[]
+  subSportType?: null
+  avgTrainingSpeed?: null
+  isWheelchair?: boolean
+}
+export declare interface IAuthor {
+  userProfilePk: null
+  displayName: null
+  fullName: null
+  profileImgNameLarge: null
+  profileImgNameMedium: null
+  profileImgNameSmall: null
+  userPro: boolean
+  vivokidUser: boolean
+}
+export declare interface IUnit {
+  unitId?: null
+  unitKey: string | null
+  factor?: null
+}
+export declare interface ISportType {
+  sportTypeId: number
+  sportTypeKey: string
+  displayOrder?: number
+}
+export declare interface IWorkoutSegment {
+  segmentOrder: number
+  sportType: ISportType
+  workoutSteps: IWorkoutStep[]
+}
+export declare interface IWorkoutStep {
+  type: string
+  stepId: number
+  stepOrder: number
+  stepType: IStepType
+  childStepId: null
+  description: null
+  endCondition: IEndCondition
+  endConditionValue: number | null
+  preferredEndConditionUnit: IUnit | null
+  endConditionCompare: null
+  targetType: ITargetType
+  targetValueOne: null
+  targetValueTwo: null
+  targetValueUnit: null
+  zoneNumber: null
+  secondaryTargetType: null
+  secondaryTargetValueOne: null
+  secondaryTargetValueTwo: null
+  secondaryTargetValueUnit: null
+  secondaryZoneNumber: null
+  endConditionZone: null
+  strokeType: IStrokeType
+  equipmentType: IEquipmentType
+  category: null
+  exerciseName: null
+  workoutProvider: null
+  providerExerciseSourceId: null
+  weightValue: null
+  weightUnit: null
+}
+export declare interface IEndCondition {
+  conditionTypeId: number
+  conditionTypeKey: string
+  displayOrder: number
+  displayable: boolean
+}
+export declare interface IEquipmentType {
+  equipmentTypeId: number
+  equipmentTypeKey: null
+  displayOrder: number
+}
+export declare interface IStepType {
+  stepTypeId: number
+  stepTypeKey: string
+  displayOrder: number
+}
+export declare interface IStrokeType {
+  strokeTypeId: number
+  strokeTypeKey: null
+  displayOrder: number
+}
+export declare interface ITargetType {
+  workoutTargetTypeId: number
+  workoutTargetTypeKey: string
+  displayOrder: number
+}
+export type GCUserProfileId = number;
+export type GCUserHash = string;
+export type GCWorkoutId = string;
+export type GCGearId = string;
+export type GCBadgeId = number;
+export type GarminDomain = 'garmin.com' | 'garmin.cn';
+export type ExportFileTypeValue = keyof typeof ExportFileType;
+export type UploadFileTypeValue = keyof typeof UploadFileType;
+export declare enum ExportFileType {
+  tcx = 'tcx',
+  gpx = 'gpx',
+  kml = 'kml',
+  zip = 'zip',
+}
+export declare enum UploadFileType {
+  tcx = 'tcx',
+  gpx = 'gpx',
+  fit = 'fit',
+}
+export * from './activity';
+export * from './gear';
+export * from './gpx';
+export * from './sleep';
+export * from './workout';
+export * from './calendar';
+export * from './heartrate';
+export * from './hydration';
+export * from './weight';
+export * from './wellness';

package/dist/garmin/types/sleep.d.ts

@@ -0,0 +1,120 @@
+export declare interface SleepDTO {
+  id: number
+  userProfilePK: number
+  calendarDate: string
+  sleepTimeSeconds: number
+  napTimeSeconds: number
+  sleepWindowConfirmed: boolean
+  sleepWindowConfirmationType: string
+  sleepStartTimestampGMT: number
+  sleepEndTimestampGMT: number
+  sleepStartTimestampLocal: number
+  sleepEndTimestampLocal: number
+  autoSleepStartTimestampGMT: number | null
+  autoSleepEndTimestampGMT: number | null
+  sleepQualityTypePK: number | null
+  sleepResultTypePK: number | null
+  unmeasurableSleepSeconds: number
+  deepSleepSeconds: number
+  lightSleepSeconds: number
+  remSleepSeconds: number
+  awakeSleepSeconds: number
+  deviceRemCapable: boolean
+  retro: boolean
+  sleepFromDevice: boolean
+  averageRespirationValue: number
+  lowestRespirationValue: number
+  highestRespirationValue: number
+  awakeCount: number
+  avgSleepStress: number
+  ageGroup: string
+  sleepScoreFeedback: string
+  sleepScoreInsight: string
+  sleepScores: {
+    totalDuration: {
+      qualifierKey: string
+      optimalStart: number
+      optimalEnd: number
+    }
+    stress: {
+      qualifierKey: string
+      optimalStart: number
+      optimalEnd: number
+    }
+    awakeCount: {
+      qualifierKey: string
+      optimalStart: number
+      optimalEnd: number
+    }
+    overall: {
+      value: number
+      qualifierKey: string
+    }
+    remPercentage: {
+      value: number
+      qualifierKey: string
+      optimalStart: number
+      optimalEnd: number
+      idealStartInSeconds: number
+      idealEndInSeconds: number
+    }
+    restlessness: {
+      qualifierKey: string
+      optimalStart: number
+      optimalEnd: number
+    }
+    lightPercentage: {
+      value: number
+      qualifierKey: string
+      optimalStart: number
+      optimalEnd: number
+      idealStartInSeconds: number
+      idealEndInSeconds: number
+    }
+    deepPercentage: {
+      value: number
+      qualifierKey: string
+      optimalStart: number
+      optimalEnd: number
+      idealStartInSeconds: number
+      idealEndInSeconds: number
+    }
+  }
+  sleepVersion: number
+}
+export declare interface SleepMovement {
+  startGMT: string
+  endGMT: string
+  activityLevel: number
+}
+export declare interface SleepLevels {
+  startGMT: string
+  endGMT: string
+  activityLevel: number
+}
+export declare interface WellnessEpochRespirationDataDTO {
+  startTimeGMT: number
+  respirationValue: number
+}
+export declare interface SleepHeartRate {
+  value: number
+  startGMT: number
+}
+export declare interface SleepBodyBattery {
+  value: number
+  startGMT: number
+}
+export declare interface SleepData {
+  dailySleepDTO: SleepDTO
+  sleepMovement: SleepMovement[]
+  remSleepData: boolean
+  sleepLevels: SleepLevels[]
+  restlessMomentsCount: number
+  wellnessEpochRespirationDataDTOList: WellnessEpochRespirationDataDTO[]
+  sleepHeartRate: SleepHeartRate[]
+  sleepBodyBattery: SleepBodyBattery[]
+  avgOvernightHrv: number
+  hrvStatus: string
+  bodyBatteryChange: number
+  restingHeartRate: number
+}

package/dist/garmin/types/weight.d.ts

@@ -0,0 +1,50 @@
+export declare interface WeightData {
+  startDate: string
+  endDate: string
+  dateWeightList: {
+    samplePk: number
+    date: number
+    calendarDate: string
+    weight: number
+    bmi?: number
+    bodyFatPercentage?: number
+    bodyWater?: number
+    boneMass?: number
+    muscleMass?: number
+    physiqueRating?: number
+    visceralFat?: number
+    metabolicAge?: number
+    sourceType: string
+    timestampGMT: number
+    weightDelta?: number
+  }[]
+  totalAverage: {
+    from: number
+    until: number
+    weight?: number
+    bmi?: number
+    bodyFatPercentage?: number
+    bodyWater?: number
+    boneMass?: number
+    muscleMass?: number
+    physiqueRating?: number
+    visceralFat?: number
+    metabolicAge?: number
+  }
+}
+export declare interface UpdateWeight {
+  samplePk: number
+  date: number
+  calendarDate: string
+  weight: number
+  bmi?: number
+  bodyFatPercentage?: number
+  bodyWater?: number
+  boneMass?: number
+  muscleMass?: number
+  physiqueRating?: number
+  visceralFat?: number
+  metabolicAge?: number
+  sourceType: string
+  timestampGMT: number
+}

package/dist/garmin/types/wellness.d.ts

@@ -0,0 +1,108 @@
+export declare interface StressData {
+  userProfilePK: number
+  calendarDate: string
+  startTimestampGMT: string | null
+  endTimestampGMT: string | null
+  startTimestampLocal: string | null
+  endTimestampLocal: string | null
+  maxStressLevel: number | null
+  avgStressLevel: number | null
+  stressChartValueOffset: number | null
+  stressChartYAxisOrigin: number | null
+  stressValueDescriptorsDTOList: Array<{
+    key: string
+    index: number
+  }>
+  stressValuesArray: [number, number][]
+}
+export declare interface HrvSummary {
+  calendarDate: string
+  weeklyAvg: number
+  lastNightAvg: number
+  lastNight5MinHigh: number
+  baseline: {
+    lowUpper: number
+    balancedLow: number
+    balancedUpper: number
+    markerValue: number
+  }
+  status: 'LOW' | 'BALANCED' | 'HIGH' | 'UNBALANCED'
+  feedbackPhrase: string
+  createTimeStamp: string
+}
+export declare interface HrvReading {
+  hrvValue: number
+  readingTimeGMT: string
+  readingTimeLocal: string
+}
+export declare interface HrvData {
+  userProfilePk: number
+  hrvSummary: HrvSummary | null
+  hrvReadings: HrvReading[]
+}
+export declare interface TrainingReadiness {
+  userProfilePK: number
+  calendarDate: string
+  timestamp: string
+  timestampLocal: string
+  deviceId: number
+  level: 'LOW' | 'MODERATE' | 'HIGH' | 'PRIME'
+  feedbackLong: string
+  feedbackShort: string
+  score: number
+  sleepScore: number
+  sleepScoreFactorPercent: number
+  sleepScoreFactorFeedback: string
+  recoveryTime: number
+  recoveryTimeFactorPercent: number
+  recoveryTimeFactorFeedback: string
+  acwrFactorPercent: number
+  acwrFactorFeedback: string
+  acuteLoad: number
+  stressHistoryFactorPercent: number
+  stressHistoryFactorFeedback: string
+  hrvFactorPercent: number
+  hrvFactorFeedback: string
+  hrvWeeklyAverage: number
+  sleepHistoryFactorPercent?: number
+  sleepHistoryFactorFeedback?: string
+}
+export declare interface BodyBatteryData {
+  userProfilePK: number
+  calendarDate: string
+  startTimestampGMT: string
+  endTimestampGMT: string
+  startTimestampLocal: string
+  endTimestampLocal: string
+  charged: number
+  drained: number
+  bodyBatteryValueDescriptorsDTOList: Array<{
+    key: string
+    index: number
+  }>
+  bodyBatteryValuesArray: [number, number][]
+}
+export declare interface DailySummaryStats {
+  calendarDate: string
+  totalSteps: number
+  stepGoal: number
+  totalDistance: number
+  floorsAscended: number
+  floorsDescended: number
+  floorsGoal: number
+  activeCalories: number
+  totalCalories: number
+  bmrCalories: number
+  moderateIntensityMinutes: number
+  vigorousIntensityMinutes: number
+  intensityMinutesGoal: number
+  restingHeartRate: number
+  minHeartRate: number
+  maxHeartRate: number
+  averageStressLevel: number
+  maxStressLevel: number
+  bodyBatteryChargedValue: number
+  bodyBatteryDrainedValue: number
+  bodyBatteryHighestValue: number
+  bodyBatteryLowestValue: number
+}

package/dist/garmin/types/workout.d.ts

@@ -0,0 +1,56 @@
+export declare interface Workout {
+  workoutId: number
+  ownerId: number
+  workoutName: string
+  description: string | null
+  updateDate: string
+  createdDate: string
+  sportType: {
+    sportTypeId: number
+    sportTypeKey: string
+    displayOrder: number
+  }
+  trainingPlanId: number | null
+  author: {
+    userProfilePk: number
+    displayName: string
+    fullName: string
+    profileImgNameLarge: string | null
+    profileImgNameMedium: string | null
+    profileImgNameSmall: string | null
+    userPro: boolean
+    vivokidUser: boolean
+  }
+  estimatedDurationInSecs: number
+  estimatedDistanceInMeters: number
+  estimateType: string
+  estimatedDistanceUnit: {
+    unitId: number
+    unitKey: string
+    factor: {
+      source: string
+      parsedValue: number
+    }
+  }
+  poolLength: {
+    source: string
+    parsedValue: number
+  }
+  poolLengthUnit: {
+    unitId: number | null
+    unitKey: string | null
+    factor: {
+      source: string
+      parsedValue: number
+    } | null
+  }
+  workoutProvider: unknown | null
+  workoutSourceId: unknown | null
+  consumer: unknown | null
+  atpPlanId: unknown | null
+  workoutNameI18nKey: string | null
+  descriptionI18nKey: string | null
+  workoutThumbnailUrl: string | null
+  shared: boolean
+  estimated: boolean
+}