fit-file-parser 2.1.1 → 2.2.2

package/dist/fit_types.d.ts

@@ -16,7 +16,7 @@ export interface MessageIndex {
     selected: boolean;
 }
 export type File = 'device' | 'settings' | 'sport' | 'activity' | 'workout' | 'course' | 'schedules' | 'weight' | 'totals' | 'goals' | 'blood_pressure' | 'monitoring_a' | 'activity_summary' | 'monitoring_daily' | 'monitoring_b' | 'segment' | 'segment_list' | 'exd_configuration' | 'mfg_range_min' | 'mfg_range_max';
-export type MesgNum = 'file_id' | 'capabilities' | 'device_settings' | 'user_profile' | 'hrm_profile' | 'sdm_profile' | 'bike_profile' | 'zones_target' | 'hr_zone' | 'power_zone' | 'met_zone' | 'sport' | 'goal' | 'session' | 'lap' | 'record' | 'event' | 'device_info' | 'workout' | 'workout_step' | 'schedule' | 'weight_scale' | 'course' | 'course_point' | 'totals' | 'activity' | 'software' | 'file_capabilities' | 'mesg_capabilities' | 'field_capabilities' | 'file_creator' | 'blood_pressure' | 'speed_zone' | 'monitoring' | 'training_file' | 'hrv' | 'ant_rx' | 'ant_tx' | 'ant_channel_id' | 'length' | 'monitoring_info' | 'pad' | 'slave_device' | 'connectivity' | 'weather_conditions' | 'weather_alert' | 'cadence_zone' | 'hr' | 'segment_lap' | 'memo_glob' | 'segment_id' | 'segment_leaderboard_entry' | 'segment_point' | 'segment_file' | 'workout_session' | 'watchface_settings' | 'gps_metadata' | 'camera_event' | 'timestamp_correlation' | 'gyroscope_data' | 'accelerometer_data' | 'three_d_sensor_calibration' | 'video_frame' | 'obdii_data' | 'nmea_sentence' | 'aviation_attitude' | 'video' | 'video_title' | 'video_description' | 'video_clip' | 'exd_screen_configuration' | 'exd_data_field_configuration' | 'exd_data_concept_configuration' | 'field_description' | 'developer_data_id' | 'magnetometer_data' | 'barometer_data' | 'one_d_sensor_calibration' | 'set' | 'stress_level' | 'dive_settings' | 'dive_gas' | 'dive_alarm' | 'exercise_title' | 'dive_summary' | 'jump' | 'climb_pro' | 'tank_pressure' | 'tank_summary' | 'mfg_range_min' | 'mfg_range_max' | 'o_hr_settings' | 'tank_update' | 'definition';
+export type MesgNum = 'file_id' | 'capabilities' | 'device_settings' | 'user_profile' | 'hrm_profile' | 'sdm_profile' | 'bike_profile' | 'zones_target' | 'hr_zone' | 'power_zone' | 'met_zone' | 'sport' | 'goal' | 'session' | 'lap' | 'record' | 'event' | 'device_info' | 'workout' | 'workout_step' | 'schedule' | 'weight_scale' | 'course' | 'course_point' | 'totals' | 'activity' | 'software' | 'file_capabilities' | 'mesg_capabilities' | 'field_capabilities' | 'file_creator' | 'blood_pressure' | 'speed_zone' | 'monitoring' | 'training_file' | 'hrv' | 'ant_rx' | 'ant_tx' | 'ant_channel_id' | 'length' | 'monitoring_info' | 'pad' | 'slave_device' | 'connectivity' | 'weather_conditions' | 'weather_alert' | 'cadence_zone' | 'hr' | 'segment_lap' | 'memo_glob' | 'segment_id' | 'segment_leaderboard_entry' | 'segment_point' | 'segment_file' | 'workout_session' | 'watchface_settings' | 'gps_metadata' | 'camera_event' | 'timestamp_correlation' | 'gyroscope_data' | 'accelerometer_data' | 'three_d_sensor_calibration' | 'video_frame' | 'obdii_data' | 'nmea_sentence' | 'aviation_attitude' | 'video' | 'video_title' | 'video_description' | 'video_clip' | 'exd_screen_configuration' | 'exd_data_field_configuration' | 'exd_data_concept_configuration' | 'field_description' | 'developer_data_id' | 'magnetometer_data' | 'barometer_data' | 'one_d_sensor_calibration' | 'time_in_zone' | 'set' | 'stress_level' | 'dive_settings' | 'dive_gas' | 'dive_alarm' | 'exercise_title' | 'dive_summary' | 'jump' | 'climb_pro' | 'tank_update' | 'tank_summary' | 'o_hr_settings' | 'mfg_range_min' | 'mfg_range_max' | 'definition';
 export type Checksum = 'clear' | 'ok';
 export type FileFlags = '0' | 'read' | 'write' | 'erase';
 export type MesgCount = 'num_per_file' | 'max_per_file' | 'max_per_file_type';
@@ -363,6 +363,8 @@ export interface ParsedSession {
     training_stress_score?: number;
     intensity_factor?: number;
     left_right_balance?: LeftRightBalance100;
+    end_position_lat?: number;
+    end_position_long?: number;
     avg_stroke_count?: number;
     avg_stroke_distance?: number;
     swim_stroke?: SwimStroke;
@@ -387,10 +389,10 @@ export interface ParsedSession {
     max_pos_vertical_speed?: number;
     max_neg_vertical_speed?: number;
     min_heart_rate?: number;
-    time_in_hr_zone?: Uint32Array;
-    time_in_speed_zone?: Uint32Array;
-    time_in_cadence_zone?: Uint32Array;
-    time_in_power_zone?: Uint32Array;
+    time_in_hr_zone?: number[];
+    time_in_speed_zone?: number[];
+    time_in_cadence_zone?: number[];
+    time_in_power_zone?: number[];
     avg_lap_time?: number;
     best_lap_index?: number;
     min_altitude?: number;
@@ -418,6 +420,7 @@ export interface ParsedSession {
     avg_left_pedal_smoothness?: number;
     avg_right_pedal_smoothness?: number;
     avg_combined_pedal_smoothness?: number;
+    sport_profile_name?: string;
     sport_index?: number;
     time_standing?: number;
     stand_count?: number;
@@ -442,10 +445,24 @@ export interface ParsedSession {
     avg_vertical_ratio?: number;
     avg_stance_time_balance?: number;
     avg_step_length?: number;
-    total_anaerobic_effect?: number;
+    total_anaerobic_training_effect?: number;
     avg_vam?: number;
+    recovery_advisor?: number;
+    min_temperature?: number;
+    training_load_peak?: number;
+    enhanced_avg_respiration_rate?: number;
+    enhanced_max_respiration_rate?: number;
+    est_sweat_loss?: number;
+    enhanced_min_respiration_rate?: number;
+    total_grit?: number;
+    jump_count?: number;
+    avg_flow?: number;
+    primary_benefit?: number;
     workout_feel?: number;
     workout_rpe?: number;
+    resting_calories?: number;
+    avg_grit?: number;
+    avg_flow?: number;
     timestamp: string;
     message_index?: MessageIndex;
     laps?: ParsedLap[];
@@ -502,10 +519,10 @@ export interface ParsedLap {
     avg_neg_vertical_speed?: number;
     max_pos_vertical_speed?: number;
     max_neg_vertical_speed?: number;
-    time_in_hr_zone?: Uint32Array;
-    time_in_speed_zone?: Uint32Array;
-    time_in_cadence_zone?: Uint32Array;
-    time_in_power_zone?: Uint32Array;
+    time_in_hr_zone?: number[];
+    time_in_speed_zone?: number[];
+    time_in_cadence_zone?: number[];
+    time_in_power_zone?: number[];
     repetition_num?: number;
     min_altitude?: number;
     min_heart_rate?: number;
@@ -627,6 +644,8 @@ export interface ParsedRecord {
     ndl_time?: number;
     cns_load?: number;
     n2_load?: number;
+    grit?: number;
+    flow?: number;
     timestamp: string;
 }
 export interface ParsedEvent {
@@ -660,8 +679,10 @@ export interface ParsedDeviceInfo {
     ant_transmission_type?: number;
     ant_device_number?: number;
     ant_network?: AntNetwork;
+    ant_id?: number;
     source_type?: SourceType;
     product_name?: string;
+    battery_level?: number;
     timestamp: string;
 }
 export interface ParsedWorkout {
@@ -816,7 +837,7 @@ export interface ParsedMonitoring {
     timestamp: number;
 }
 export interface ParsedHrv {
-    time?: Uint16Array;
+    time?: number[];
 }
 export interface ParsedLength {
     event?: Event;
@@ -850,6 +871,13 @@ export interface ParsedOHrSettings {
     enabled?: number;
     timestamp: string;
 }
+export interface ParsedJump {
+    enhanced_mets?: number;
+    distance?: number;
+    height?: number;
+    score?: number;
+    timestamp: string;
+}
 export interface ParsedFieldDescription {
     developer_data_index?: number;
     field_definition_number?: number;
@@ -862,11 +890,30 @@ export interface ParsedFieldDescription {
 }
 export interface ParsedDeveloperDataId {
     developer_id?: number;
-    application_id?: unknown[];
+    application_id?: number[];
     manufacturer_id?: Manufacturer;
     developer_data_index?: number;
     application_version?: number;
 }
+export interface ParsedTimeInZone {
+    reference_mesg?: number;
+    reference_index?: number;
+    time_in_hr_zone?: number[];
+    time_in_speed_zone?: number[];
+    time_in_power_zone?: number[];
+    hr_zone_high_boundary_deprecated?: number[];
+    hr_zone_high_boundary?: number[];
+    speed_zone_high_boundary?: number[];
+    power_zone_high_boundary?: number[];
+    hr_calc_type?: HrZoneCalc;
+    max_heart_rate_deprecated?: number;
+    max_heart_rate?: number;
+    resting_heart_rate?: number;
+    threshold_heart_rate?: number;
+    pwr_calc_type?: PwrZoneCalc;
+    functional_threshold_power?: number;
+    timestamp: string;
+}
 export interface ParsedStressLevel {
     stress_level_value?: number;
     stress_level_time?: string;
@@ -971,4 +1018,6 @@ export interface ParsedFit {
     definitions?: unknown[];
     tank_updates?: ParsedTankUpdate[];
     tank_summaries?: ParsedTankSummary[];
+    jumps?: ParsedJump[];
+    time_in_zone?: ParsedTimeInZone[];
 }

package/dist/type_generator.js

@@ -40,8 +40,14 @@ export function generateArrayProperty(name, type, optional = true) {
 }
 export function generateTypeFromField(def) {
     switch (def.type) {
+        case 'uint32_array':
+        case 'uint16_array':
+        case 'uint8_array':
+        case 'sint32_array':
+        case 'sint16_array':
+        case 'sint8_array':
         case 'byte_array':
-            return ts.factory.createArrayTypeNode(ts.factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword));
+            return ts.factory.createArrayTypeNode(ts.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword));
         case 'bool':
             return ts.factory.createKeywordTypeNode(ts.SyntaxKind.BooleanKeyword);
         case 'date_time':
@@ -84,11 +90,7 @@ export function generateTypes(types) {
         const typeAlias = ts.factory.createTypeAliasDeclaration([
             ts.factory.createModifier(ts.SyntaxKind.ExportKeyword),
         ], snakeToCamel(name), undefined, ts.factory.createUnionTypeNode([...names.map(n => ts.factory.createLiteralTypeNode(ts.factory.createStringLiteral(String(n)))), ...(name === 'mesg_num'
-                // TODO those are somehow missing in the FIT.types.mesg_num definition
-                // especially 'tank_update' (319 in messages) is mapped to 'tank_pressure' a bug?
                 ? [
-                    ts.factory.createLiteralTypeNode(ts.factory.createStringLiteral('o_hr_settings')),
-                    ts.factory.createLiteralTypeNode(ts.factory.createStringLiteral('tank_update')),
                     ts.factory.createLiteralTypeNode(ts.factory.createStringLiteral('definition')),
                 ]
                 : [])]));
@@ -186,6 +188,8 @@ export function generateFitType() {
         definitions: 'unknown',
         tank_updates: 'parsed_tank_update',
         tank_summaries: 'parsed_tank_summary',
+        jumps: 'parsed_jump',
+        time_in_zone: 'parsed_time_in_zone',
     };
     const referenceProperties = {
         file_creator: 'parsed_file_creator',

package/eslint.config.js

@@ -12,4 +12,9 @@ export default antfu({
   rules: {
     'unicorn/prefer-node-protocol': 'off',
   },
+}, {
+  files: ['**/examples/*.js', '**/codegen/*.ts', '**/probe_session.js', '**/deep_probe.js'],
+  rules: {
+    'no-console': 'off',
+  },
 })

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "fit-file-parser",
   "type": "module",
-  "version": "2.1.1",
+  "version": "2.2.2",
   "private": false,
   "description": "Parse your .FIT files easily, directly from JS (Garmin, Polar, Suunto)",
   "author": {

package/probe_session.js

@@ -0,0 +1,49 @@
+import { createRequire } from 'module'
+
+// Note: Importing TS directly might not work with node without a loader.
+// Better to use the built file if available, or use ts-node.
+// But earlier I saw `dist/fit-parser.js`. Let's try to import that if key is default.
+// Actually, let's just use `fs.readFileSync` and basic node.
+// If `dist` is CJS, I can use `createRequire`.
+
+import fs from 'node:fs'
+
+const require = createRequire(import.meta.url)
+
+const FitParserDist = require('./dist/fit-parser.js').default
+
+const content = fs.readFileSync('/Users/dimitrios/Projects/sports-lib/samples/fit/jumps-mtb.fit')
+const fitParser = new FitParserDist({
+  force: true,
+  speedUnit: 'km/h',
+  lengthUnit: 'm',
+  temperatureUnit: 'celsius',
+  elapsedRecordField: true,
+  mode: 'both',
+})
+
+fitParser.parse(content, (error, data) => {
+  if (error) {
+    console.error(error)
+  }
+  else {
+    const session = data.sessions[0]
+    if (session) {
+      console.log('=== SESSION KEYS & VALUES ===')
+      Object.keys(session).forEach((key) => {
+        const val = session[key]
+        console.log(`${key}: ${val}`)
+        if (Math.abs(val - 11) < 0.1)
+          console.log(`>>> MATCH 11 (Jump Count?): ${key}`)
+        if (Math.abs(val - 159) < 0.1)
+          console.log(`>>> MATCH 159 (Resting Cals?): ${key}`)
+        if (Math.abs(val - 6079174) < 1)
+          console.log(`>>> MATCH 6M (Training Load?): ${key}`)
+        if (Math.abs(val - 100) < 0.1)
+          console.log(`>>> MATCH 100 (Avg VAM?): ${key}`)
+        if (Math.abs(val - 2756) < 1)
+          console.log(`>>> MATCH 2756 (Avg Resp?): ${key}`)
+      })
+    }
+  }
+})