fit-file-parser 2.0.2 → 2.0.4

package/.editorconfig

@@ -0,0 +1,3 @@
+[*]
+indent_style = space
+indent_size = 2

package/.github/workflows/ci.yml

@@ -20,10 +20,21 @@ jobs:
         uses: actions/setup-node@v6
         with:
           node-version: ${{ matrix.node-version }}
+          cache: npm
+          cache-dependency-path: package-lock.json
       - run: npm ci
       - run: npm run build
-      - run: npm run test
+      - run: npm run test -- --coverage
       - run: npm run lint
         if: matrix.node-version == '25.x'
       - run: npm run type-check
         if: matrix.node-version == '25.x'
+      - run: |
+          npm run codegen
+          if git diff --exit-code src/fit_types.ts; then
+            echo "✓ src/fit_types.ts is unchanged after codegen"
+          else
+            echo "✗ src/fit_types.ts has been modified - please commit the changes"
+            exit 1
+          fi
+        if: matrix.node-version == '25.x'

package/README.md

@@ -57,6 +57,49 @@ const buffer = await fs.readFile('./example.fit')
 const fitObject = await fitParser.parseAsync(buffer)
 ```
 
+## Development
+
+To build the project, run:
+
+```
+npm run build
+```
+To run tests, run:
+
+```
+npm test
+```
+
+To rebuild the typescript types (as they are autogenerated from the `FIT` object) run:
+
+```npm run codegen
+```
+
+> this will update the file `src/fit_types.ts` as it is only running with node (with type stripping), regenerating them requires node>=245
+
+To run the codegen in watch mode during local development, run:
+
+```npm run dev
+```
+
+To build the local examples, run:
+
+```
+npm run examples
+```
+
+To lint and format the code, run:
+
+```
+npm run lint
+```
+
+To run the typechecker, run:
+
+```
+npm run type-check
+```
+
 ## API Documentation
 
 ### new FitParser(Object _options_)

package/codegen/codegen.ts

@@ -0,0 +1,9 @@
+import { execSync } from 'node:child_process'
+import fs from 'node:fs'
+import { main } from '../src/type_generator.js'
+
+const out = main()
+
+fs.writeFileSync(`${import.meta.dirname}/../src/fit_types.ts`, out)
+
+execSync('npx eslint --fix src/fit_types.ts', { stdio: 'inherit' })

package/dist/binary.d.ts

@@ -1,9 +1,9 @@
 import type { FitParserOptions } from './fit-parser.js';
-import type { MessageName } from './fit.js';
+import type { MesgNum } from './fit_types.js';
 import { Buffer } from 'node:buffer';
 export declare function addEndian(littleEndian: boolean, bytes: number[]): number;
 export declare function readRecord(blob: Uint8Array, messageTypes: any[], developerFields: any[], startIndex: number, options: FitParserOptions, startDate: number | undefined, pausedTime: number): {
-    messageType: MessageName | '';
+    messageType: MesgNum | '';
     nextIndex: number;
     message?: any;
 };

package/dist/fit-parser.d.ts

@@ -1,5 +1,5 @@
 import type { Buffer } from 'node:buffer';
-import type { ParsedFit } from './types.js';
+import type { ParsedFit } from './fit_types.js';
 export interface FitParserOptions {
     force?: boolean;
     speedUnit?: string;

package/dist/fit-parser.js

@@ -85,7 +85,7 @@ export default class FitParser {
         const hr_zone = [];
         const power_zone = [];
         const hrv = [];
-        const devices = [];
+        const device_infos = [];
         const applications = [];
         const fieldDescriptions = [];
         const dive_gases = [];
@@ -152,7 +152,7 @@ export default class FitParser {
                     fieldDescriptions.push(message);
                     break;
                 case 'device_info':
-                    devices.push(message);
+                    device_infos.push(message);
                     break;
                 case 'developer_data_id':
                     applications.push(message);
@@ -201,16 +201,27 @@ export default class FitParser {
                     break;
             }
         }
+        fitObj.hr_zone = hr_zone;
+        fitObj.power_zone = power_zone;
+        fitObj.dive_gases = dive_gases;
+        fitObj.course_points = course_points;
+        fitObj.sports = sports;
+        fitObj.monitors = monitors;
+        fitObj.stress = stress;
+        fitObj.file_ids = file_ids;
+        fitObj.monitor_info = monitor_info;
+        fitObj.definitions = definitions;
+        fitObj.tank_updates = tank_updates;
+        fitObj.tank_summaries = tank_summaries;
         if (isCascadeNeeded) {
             laps = mapDataIntoLap(laps, 'records', records);
             laps = mapDataIntoLap(laps, 'lengths', lengths);
             sessions = mapDataIntoSession(sessions, laps);
-            fitObj.hr_zone = hr_zone;
-            fitObj.power_zone = power_zone;
             fitObj.activity = Object.assign(Object.assign({}, ((_a = fitObj.activity) !== null && _a !== void 0 ? _a : {})), { // ugly but we assume the activity was parsed correctly with all other members correctly
                 sessions,
                 events,
-                hrv, device_infos: devices, developer_data_ids: applications, field_descriptions: fieldDescriptions, sports });
+                hrv,
+                device_infos, developer_data_ids: applications, field_descriptions: fieldDescriptions, sports });
         }
         if (!isModeCascade) {
             fitObj.sessions = sessions;
@@ -218,23 +229,10 @@ export default class FitParser {
             fitObj.lengths = lengths;
             fitObj.records = records;
             fitObj.events = events;
-            fitObj.device_infos = devices;
+            fitObj.device_infos = device_infos;
             fitObj.developer_data_ids = applications;
             fitObj.field_descriptions = fieldDescriptions;
             fitObj.hrv = hrv;
-            fitObj.hr_zone = hr_zone;
-            fitObj.power_zone = power_zone;
-            fitObj.dive_gases = dive_gases;
-            fitObj.course_points = course_points;
-            fitObj.sports = sports;
-            fitObj.devices = devices;
-            fitObj.monitors = monitors;
-            fitObj.stress = stress;
-            fitObj.file_ids = file_ids;
-            fitObj.monitor_info = monitor_info;
-            fitObj.definitions = definitions;
-            fitObj.tank_updates = tank_updates;
-            fitObj.tank_summaries = tank_summaries;
         }
         callback(undefined, fitObj);
     }

package/dist/fit.d.ts

@@ -1,12 +1,4 @@
-export type SpeedUnits = 'm/s' | 'mph' | 'km/h';
-export type LengthUnits = 'm' | 'mi' | 'km';
-export type TemperatureUnits = '°C' | 'kelvin' | 'fahrenheit';
-export type PressureUnits = 'cbar' | 'bar' | 'psi';
-export type MessageName = 'file_id' | 'file_creator' | 'timestamp_correlation' | 'o_hr_settings' | 'software' | 'slave_device' | 'capabilities' | 'file_capabilities' | 'mesg_capabilities' | 'field_capabilities' | 'device_settings' | 'user_profile' | 'hrm_profile' | 'sdm_profile' | 'bike_profile' | 'connectivity' | 'watchface_settings' | 'ohr_settings' | 'time_in_zone' | 'zones_target' | 'sport' | 'hr_zone' | 'speed_zone' | 'cadence_zone' | 'power_zone' | 'met_zone' | 'dive_settings' | 'dive_alarm' | 'dive_gas' | 'goal' | 'activity' | 'session' | 'lap' | 'length' | 'record' | 'event' | 'device_info' | 'device_aux_battery_info' | 'training_file' | 'weather_conditions' | 'weather_alert' | 'gps_metadata' | 'camera_event' | 'gyroscope_data' | 'accelerometer_data' | 'magnetometer_data' | 'barometer_data' | 'three_d_sensor_calibration' | 'one_d_sensor_calibration' | 'video_frame' | 'obdii_data' | 'nmea_sentence' | 'aviation_attitude' | 'video' | 'video_title' | 'video_description' | 'video_clip' | 'set' | 'jump' | 'course' | 'course_point' | 'segment_id' | 'segment_leaderboard_entry' | 'segment_point' | 'segment_lap' | 'segment_file' | 'workout' | 'workout_session' | 'workout_step' | 'exercise_title' | 'schedule' | 'totals' | 'weight_scale' | 'blood_pressure' | 'monitoring_info' | 'monitoring' | 'monitoring_hr_data' | 'hr' | 'memo_glob' | 'stress_level' | 'dive_summary' | 'hrv' | 'beat_intervals' | 'respiration_rate' | 'spo2_data' | 'sleep_level' | 'pad' | 'field_description' | 'developer_data_id' | 'definition' | 'tank_update' | 'tank_summary';
-export type Unit<T extends string> = Record<T, {
-    multiplier: number;
-    offset: number;
-}>;
+import type { FitOptions, MesgNum } from './fit_types.js';
 export interface FieldDefinition {
     type: string | number;
     fDefNo: number;
@@ -28,19 +20,13 @@ export interface MessageObject {
     offset: number;
     units: string;
 }
-interface Message {
-    name: MessageName;
+export interface Message {
+    name: MesgNum;
     [fieldId: number]: MessageObject;
 }
-export interface FitTypeOptions {
-    speedUnits: Unit<SpeedUnits>;
-    lengthUnits: Unit<LengthUnits>;
-    temperatureUnits: Unit<TemperatureUnits>;
-    pressureUnits: Unit<PressureUnits>;
-}
 export interface FitType {
     scConst: number;
-    options: FitTypeOptions;
+    options: FitOptions;
     messages: {
         [messageId: number]: Message;
     };
@@ -49,4 +35,3 @@ export interface FitType {
     };
 }
 export declare const FIT: FitType;
-export {};

package/dist/fit.js

@@ -1,4 +1,3 @@
-// some unit conversion constants
 const metersInOneKilometer = 1000;
 const secondsInOneHour = 3600;
 // according to https://en.wikipedia.org/wiki/Mile