fit-file-parser 1.20.0 → 2.0.0

package/dist/fit-parser.js

@@ -1,261 +1,241 @@
-'use strict';
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-
-var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
-
-var _binary = require('./binary');
-
-var _helper = require('./helper');
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-var FitParser = function () {
-  function FitParser() {
-    var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-
-    _classCallCheck(this, FitParser);
-
-    this.options = {
-      force: options.force != null ? options.force : true,
-      speedUnit: options.speedUnit || 'm/s',
-      lengthUnit: options.lengthUnit || 'm',
-      temperatureUnit: options.temperatureUnit || 'celsius',
-      elapsedRecordField: options.elapsedRecordField || false,
-      pressureUnit: options.pressureUnit || 'bar',
-      mode: options.mode || 'list'
-    };
-  }
-
-  _createClass(FitParser, [{
-    key: 'parse',
-    value: function parse(content, callback) {
-      var blob = new Uint8Array((0, _binary.getArrayBuffer)(content));
-
-      if (blob.length < 12) {
-        callback('File to small to be a FIT file', {});
-        if (!this.options.force) {
-          return;
-        }
-      }
-
-      var headerLength = blob[0];
-      if (headerLength !== 14 && headerLength !== 12) {
-        callback('Incorrect header size', {});
-        if (!this.options.force) {
-          return;
-        }
-      }
-
-      var fileTypeString = '';
-      for (var i = 8; i < 12; i++) {
-        fileTypeString += String.fromCharCode(blob[i]);
-      }
-      if (fileTypeString !== '.FIT') {
-        callback('Missing \'.FIT\' in header', {});
-        if (!this.options.force) {
-          return;
+import { calculateCRC, getArrayBuffer, readRecord } from './binary.js';
+import { mapDataIntoLap, mapDataIntoSession } from './helper.js';
+export default class FitParser {
+    constructor(options = {}) {
+        this.options = {
+            force: options.force != null ? options.force : true,
+            speedUnit: options.speedUnit || 'm/s',
+            lengthUnit: options.lengthUnit || 'm',
+            temperatureUnit: options.temperatureUnit || 'celsius',
+            elapsedRecordField: options.elapsedRecordField || false,
+            pressureUnit: options.pressureUnit || 'bar',
+            mode: options.mode || 'list',
+        };
+    }
+    parseAsync(content) {
+        return new Promise((resolve, reject) => {
+            this.parse(content, (error, data) => {
+                if (error) {
+                    reject(error);
+                }
+                else if (data) {
+                    resolve(data);
+                }
+            });
+        });
+    }
+    parse(content, callback) {
+        var _a;
+        const blob = new Uint8Array(getArrayBuffer(content));
+        if (blob.length < 12) {
+            callback('File to small to be a FIT file', undefined);
+            if (!this.options.force) {
+                return;
+            }
         }
-      }
-
-      if (headerLength === 14) {
-        var crcHeader = blob[12] + (blob[13] << 8);
-        var crcHeaderCalc = (0, _binary.calculateCRC)(blob, 0, 12);
-        if (crcHeader !== crcHeaderCalc) {
-          // callback('Header CRC mismatch', {});
-          // TODO: fix Header CRC check
-          if (!this.options.force) {
-            return;
-          }
+        const headerLength = blob[0];
+        if (headerLength !== 14 && headerLength !== 12) {
+            callback('Incorrect header size', undefined);
+            if (!this.options.force) {
+                return;
+            }
         }
-      }
-
-      var protocolVersion = blob[1];
-      var profileVersion = blob[2] + (blob[3] << 8);
-      var dataLength = blob[4] + (blob[5] << 8) + (blob[6] << 16) + (blob[7] << 24);
-      var crcStart = dataLength + headerLength;
-      var crcFile = blob[crcStart] + (blob[crcStart + 1] << 8);
-      var crcFileCalc = (0, _binary.calculateCRC)(blob, headerLength === 12 ? 0 : headerLength, crcStart);
-
-      if (crcFile !== crcFileCalc) {
-        // callback('File CRC mismatch', {});
-        // TODO: fix File CRC check
-        if (!this.options.force) {
-          return;
+        let fileTypeString = '';
+        for (let i = 8; i < 12; i++) {
+            fileTypeString += String.fromCharCode(blob[i]);
         }
-      }
-
-      var fitObj = {};
-      fitObj.protocolVersion = protocolVersion;
-      fitObj.profileVersion = profileVersion;
-
-      var sessions = [];
-      var laps = [];
-      var records = [];
-      var events = [];
-      var hrv = [];
-      var devices = [];
-      var applications = [];
-      var fieldDescriptions = [];
-      var dive_gases = [];
-      var course_points = [];
-      var sports = [];
-      var monitors = [];
-      var stress = [];
-      var definitions = [];
-      var file_ids = [];
-      var monitor_info = [];
-      var lengths = [];
-      var tank_updates = [];
-      var tank_summaries = [];
-
-      var loopIndex = headerLength;
-      var messageTypes = [];
-      var developerFields = [];
-
-      var isModeCascade = this.options.mode === 'cascade';
-      var isCascadeNeeded = isModeCascade || this.options.mode === 'both';
-
-      var startDate = void 0;
-      var lastStopTimestamp = void 0;
-      var pausedTime = 0;
-
-      while (loopIndex < crcStart) {
-        var _readRecord = (0, _binary.readRecord)(blob, messageTypes, developerFields, loopIndex, this.options, startDate, pausedTime),
-            nextIndex = _readRecord.nextIndex,
-            messageType = _readRecord.messageType,
-            message = _readRecord.message;
-
-        loopIndex = nextIndex;
-
-        switch (messageType) {
-          case 'lap':
-            laps.push(message);
-            break;
-          case 'session':
-            sessions.push(message);
-            break;
-          case 'event':
-            if (message.event === 'timer') {
-              if (message.event_type === 'stop_all') {
-                lastStopTimestamp = message.timestamp;
-              } else if (message.event_type === 'start' && lastStopTimestamp) {
-                pausedTime += (message.timestamp - lastStopTimestamp) / 1000;
-              }
+        if (fileTypeString !== '.FIT') {
+            callback('Missing \'.FIT\' in header', undefined);
+            if (!this.options.force) {
+                return;
             }
-            events.push(message);
-            break;
-          case 'length':
-            lengths.push(message);
-            break;
-          case 'hrv':
-            hrv.push(message);
-            break;
-          case 'record':
-            if (!startDate) {
-              startDate = message.timestamp;
-              message.elapsed_time = 0;
-              message.timer_time = 0;
-            }
-            records.push(message);
-            break;
-          case 'field_description':
-            fieldDescriptions.push(message);
-            break;
-          case 'device_info':
-            devices.push(message);
-            break;
-          case 'developer_data_id':
-            applications.push(message);
-            break;
-          case 'dive_gas':
-            dive_gases.push(message);
-            break;
-          case 'course_point':
-            course_points.push(message);
-            break;
-          case 'sport':
-            sports.push(message);
-            break;
-          case 'file_id':
-            if (message) {
-              file_ids.push(message);
+        }
+        if (headerLength === 14) {
+            const crcHeader = blob[12] + (blob[13] << 8);
+            const crcHeaderCalc = calculateCRC(blob, 0, 12);
+            if (crcHeader !== crcHeaderCalc) {
+                // callback('Header CRC mismatch', {});
+                // TODO: fix Header CRC check
+                if (!this.options.force) {
+                    return;
+                }
             }
-            break;
-          case 'definition':
-            if (message) {
-              definitions.push(message);
+        }
+        const protocolVersion = blob[1];
+        const profileVersion = blob[2] + (blob[3] << 8);
+        const dataLength = blob[4] + (blob[5] << 8) + (blob[6] << 16) + (blob[7] << 24);
+        const crcStart = dataLength + headerLength;
+        const crcFile = blob[crcStart] + (blob[crcStart + 1] << 8);
+        const crcFileCalc = calculateCRC(blob, headerLength === 12 ? 0 : headerLength, crcStart);
+        if (crcFile !== crcFileCalc) {
+            // callback('File CRC mismatch', {});
+            // TODO: fix File CRC check
+            if (!this.options.force) {
+                return;
             }
-            break;
-          case 'monitoring':
-            monitors.push(message);
-            break;
-          case 'monitoring_info':
-            monitor_info.push(message);
-            break;
-          case 'stress_level':
-            stress.push(message);
-            break;
-          case 'software':
-            fitObj.software = message;
-            break;
-          case 'tank_update':
-            tank_updates.push(message);
-            break;
-          case 'tank_summary':
-            tank_summaries.push(message);
-            break;
-          default:
-            if (messageType !== '') {
-              fitObj[messageType] = message;
+        }
+        const fitObj = {
+            profileVersion,
+            protocolVersion,
+        };
+        let sessions = [];
+        let laps = [];
+        const records = [];
+        const events = [];
+        const hr_zone = [];
+        const power_zone = [];
+        const hrv = [];
+        const devices = [];
+        const applications = [];
+        const fieldDescriptions = [];
+        const dive_gases = [];
+        const course_points = [];
+        const sports = [];
+        const monitors = [];
+        const stress = [];
+        const definitions = [];
+        const file_ids = [];
+        const monitor_info = [];
+        const lengths = [];
+        const tank_updates = [];
+        const tank_summaries = [];
+        let loopIndex = headerLength;
+        const messageTypes = [];
+        const developerFields = [];
+        const isModeCascade = this.options.mode === 'cascade';
+        const isCascadeNeeded = isModeCascade || this.options.mode === 'both';
+        let startDate;
+        let lastStopTimestamp;
+        let pausedTime = 0;
+        while (loopIndex < crcStart) {
+            const { nextIndex, messageType, message } = readRecord(blob, messageTypes, developerFields, loopIndex, this.options, startDate, pausedTime);
+            loopIndex = nextIndex;
+            switch (messageType) {
+                case 'lap':
+                    laps.push(message);
+                    break;
+                case 'session':
+                    sessions.push(message);
+                    break;
+                case 'event':
+                    if (message.event === 'timer') {
+                        if (message.event_type === 'stop_all') {
+                            lastStopTimestamp = message.timestamp;
+                        }
+                        else if (message.event_type === 'start' && lastStopTimestamp) {
+                            pausedTime += (message.timestamp - lastStopTimestamp) / 1000;
+                        }
+                    }
+                    events.push(message);
+                    break;
+                case 'length':
+                    lengths.push(message);
+                    break;
+                case 'hrv':
+                    hrv.push(message);
+                    break;
+                case 'hr_zone':
+                    hr_zone.push(message);
+                    break;
+                case 'power_zone':
+                    power_zone.push(message);
+                    break;
+                case 'record':
+                    if (!startDate) {
+                        startDate = message.timestamp;
+                        message.elapsed_time = 0;
+                        message.timer_time = 0;
+                    }
+                    records.push(message);
+                    break;
+                case 'field_description':
+                    fieldDescriptions.push(message);
+                    break;
+                case 'device_info':
+                    devices.push(message);
+                    break;
+                case 'developer_data_id':
+                    applications.push(message);
+                    break;
+                case 'dive_gas':
+                    dive_gases.push(message);
+                    break;
+                case 'course_point':
+                    course_points.push(message);
+                    break;
+                case 'sport':
+                    sports.push(message);
+                    break;
+                case 'file_id':
+                    if (message) {
+                        file_ids.push(message);
+                    }
+                    break;
+                case 'definition':
+                    if (message) {
+                        definitions.push(message);
+                    }
+                    break;
+                case 'monitoring':
+                    monitors.push(message);
+                    break;
+                case 'monitoring_info':
+                    monitor_info.push(message);
+                    break;
+                case 'stress_level':
+                    stress.push(message);
+                    break;
+                case 'software':
+                    fitObj.software = message;
+                    break;
+                case 'tank_update':
+                    tank_updates.push(message);
+                    break;
+                case 'tank_summary':
+                    tank_summaries.push(message);
+                    break;
+                default:
+                    if (messageType !== '') {
+                        fitObj[messageType] = message;
+                    }
+                    break;
             }
-            break;
         }
-      }
-
-      if (isCascadeNeeded) {
-        fitObj.activity = fitObj.activity || {};
-        laps = (0, _helper.mapDataIntoLap)(laps, 'records', records);
-        laps = (0, _helper.mapDataIntoLap)(laps, 'lengths', lengths);
-        sessions = (0, _helper.mapDataIntoSession)(sessions, laps);
-        fitObj.activity.sessions = sessions;
-        fitObj.activity.events = events;
-        fitObj.activity.hrv = hrv;
-        fitObj.activity.device_infos = devices;
-        fitObj.activity.developer_data_ids = applications;
-        fitObj.activity.field_descriptions = fieldDescriptions;
-        fitObj.activity.sports = sports;
-      }
-      if (!isModeCascade) {
-        fitObj.sessions = sessions;
-        fitObj.laps = laps;
-        fitObj.lengths = lengths;
-        fitObj.records = records;
-        fitObj.events = events;
-        fitObj.device_infos = devices;
-        fitObj.developer_data_ids = applications;
-        fitObj.field_descriptions = fieldDescriptions;
-        fitObj.hrv = hrv;
-        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(null, fitObj);
+        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 });
+        }
+        if (!isModeCascade) {
+            fitObj.sessions = sessions;
+            fitObj.laps = laps;
+            fitObj.lengths = lengths;
+            fitObj.records = records;
+            fitObj.events = events;
+            fitObj.device_infos = devices;
+            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);
     }
-  }]);
-
-  return FitParser;
-}();
-
-exports.default = FitParser;
+}

package/dist/fit.d.ts

@@ -0,0 +1,52 @@
+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;
+}>;
+export interface FieldDefinition {
+    type: string | number;
+    fDefNo: number;
+    size: number;
+    endianAbility: boolean;
+    littleEndian: boolean;
+    baseTypeNo: number;
+    name: string;
+    dataType: string;
+    scale?: number;
+    offset?: number;
+    developerDataIndex?: number;
+    isDeveloperField?: boolean;
+}
+export interface MessageObject {
+    field: string;
+    type: string;
+    scale: number | null;
+    offset: number;
+    units: string;
+}
+interface Message {
+    name: MessageName;
+    [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;
+    messages: {
+        [messageId: number]: Message;
+    };
+    types: {
+        [typeName: string]: Record<number, string | number>;
+    };
+}
+export declare const FIT: FitType;
+export {};