fit-file-parser 4.0.2 → 5.0.1

package/dist/cjs/fit-parser.js

@@ -31,23 +31,23 @@ class FitParser {
         });
     }
     parse(content, callback) {
-        var _a;
+        var _a, _b;
         const blob = content instanceof ArrayBuffer
             ? new Uint8Array(content)
             : new Uint8Array(content.buffer, content.byteOffset, content.byteLength);
         const dataView = new DataView(blob.buffer, blob.byteOffset, blob.byteLength);
         if (blob.length < 12) {
             callback('File to small to be a FIT file', undefined);
-            if (!this.options.force) {
-                return;
-            }
+            return;
         }
         const headerLength = blob[0];
         if (headerLength !== 14 && headerLength !== 12) {
             callback('Incorrect header size', undefined);
-            if (!this.options.force) {
-                return;
-            }
+            return;
+        }
+        if (blob.length < headerLength) {
+            callback('File to small to be a FIT file', undefined);
+            return;
         }
         let fileTypeString = '';
         for (let i = 8; i < 12; i++) {
@@ -55,29 +55,33 @@ class FitParser {
         }
         if (fileTypeString !== '.FIT') {
             callback('Missing \'.FIT\' in header', undefined);
-            if (!this.options.force) {
-                return;
-            }
+            return;
         }
         if (headerLength === 14 && !this.options.force) {
             const crcHeader = blob[12] + (blob[13] << 8);
             const crcHeaderCalc = (0, binary_js_1.calculateCRC)(blob, 0, 12);
-            if (crcHeader !== crcHeaderCalc) {
-                // callback('Header CRC mismatch', {});
-                // TODO: fix Header CRC check
+            if (crcHeader !== 0 && crcHeader !== crcHeaderCalc) {
+                callback('Header CRC mismatch', undefined);
                 return;
             }
         }
         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 dataLength = dataView.getUint32(4, true);
         const crcStart = dataLength + headerLength;
+        if (crcStart > blob.length) {
+            callback('File data exceeds input length', undefined);
+            return;
+        }
+        if (!this.options.force && crcStart + 2 > blob.length) {
+            callback('File CRC missing', undefined);
+            return;
+        }
         if (!this.options.force) {
             const crcFile = blob[crcStart] + (blob[crcStart + 1] << 8);
-            const crcFileCalc = (0, binary_js_1.calculateCRC)(blob, headerLength === 12 ? 0 : headerLength, crcStart);
+            const crcFileCalc = (0, binary_js_1.calculateCRC)(blob, 0, crcStart);
             if (crcFile !== crcFileCalc) {
-                // callback('File CRC mismatch', {});
-                // TODO: fix File CRC check
+                callback('File CRC mismatch', undefined);
                 return;
             }
         }
@@ -85,6 +89,7 @@ class FitParser {
             profileVersion,
             protocolVersion,
         };
+        const messages = {};
         let sessions = [];
         let laps = [];
         const records = [];
@@ -107,6 +112,7 @@ class FitParser {
         const tank_updates = [];
         const tank_summaries = [];
         const jumps = [];
+        const sets = [];
         const splits = [];
         const split_summaries = [];
         const time_in_zone = [];
@@ -115,14 +121,20 @@ class FitParser {
         let loopIndex = headerLength;
         const messageTypes = [];
         const developerFields = [];
+        const decoderState = {};
         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 } = (0, binary_js_1.readRecord)(blob, messageTypes, developerFields, loopIndex, this.options, startDate, pausedTime, dataView);
+            const { nextIndex, messageType, message } = (0, binary_js_1.readRecord)(blob, messageTypes, developerFields, loopIndex, this.options, startDate, pausedTime, dataView, decoderState);
             loopIndex = nextIndex;
+            if (messageType !== ''
+                && messageType !== 'definition'
+                && message !== undefined) {
+                ((_a = messages[messageType]) !== null && _a !== void 0 ? _a : (messages[messageType] = [])).push(message);
+            }
             switch (messageType) {
                 case 'lap':
                     laps.push(message);
@@ -156,8 +168,10 @@ class FitParser {
                 case 'record':
                     if (!startDate) {
                         startDate = message.timestamp;
-                        message.elapsed_time = 0;
-                        message.timer_time = 0;
+                        if (this.options.elapsedRecordField) {
+                            message.elapsed_time = 0;
+                            message.timer_time = 0;
+                        }
                     }
                     records.push(message);
                     break;
@@ -210,6 +224,9 @@ class FitParser {
                 case 'jump':
                     jumps.push(message);
                     break;
+                case 'set':
+                    sets.push(message);
+                    break;
                 case 'split':
                     splits.push(message);
                     break;
@@ -250,15 +267,17 @@ class FitParser {
         fitObj.time_in_zone = time_in_zone;
         fitObj.activity_metrics = activity_metrics;
         fitObj.user_metrics = user_metrics;
+        fitObj.messages = messages;
         if (isCascadeNeeded) {
             laps = (0, helper_js_1.mapDataIntoLap)(laps, 'records', records);
             laps = (0, helper_js_1.mapDataIntoLap)(laps, 'lengths', lengths);
             sessions = (0, helper_js_1.mapDataIntoSession)(sessions, laps);
-            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
+            fitObj.activity = Object.assign(Object.assign({}, ((_b = fitObj.activity) !== null && _b !== void 0 ? _b : {})), { // ugly but we assume the activity was parsed correctly with all other members correctly
                 sessions,
                 events,
                 hrv,
                 device_infos, developer_data_ids: applications, field_descriptions: fieldDescriptions, sports,
+                sets,
                 splits,
                 split_summaries });
         }
@@ -272,6 +291,7 @@ class FitParser {
             fitObj.developer_data_ids = applications;
             fitObj.field_descriptions = fieldDescriptions;
             fitObj.hrv = hrv;
+            fitObj.sets = sets;
         }
         callback(undefined, fitObj);
     }

package/dist/cjs/fit.d.ts

@@ -1,8 +1,11 @@
 import type { FitOptions, MesgNum } from './fit_types.js';
+export type MessageName = Exclude<MesgNum, number | 'definition'>;
 export interface FieldDefinition {
     type: string | number;
+    rawType?: string | number;
     fDefNo: number;
     size: number;
+    array?: boolean;
     endianAbility: boolean;
     littleEndian: boolean;
     baseTypeNo: number;
@@ -10,6 +13,7 @@ export interface FieldDefinition {
     dataType: string;
     scale?: number | null;
     offset?: number;
+    units?: string;
     requiresBoundedDataView?: boolean;
     developerDataIndex?: number;
     isDeveloperField?: boolean;
@@ -17,22 +21,26 @@ export interface FieldDefinition {
 export interface MessageObject {
     field: string;
     type: string;
+    baseType?: string;
+    array?: boolean;
     scale: number | null;
     offset: number;
     units: string;
 }
 export interface Message {
-    name: MesgNum;
+    name: MessageName;
     [fieldId: number]: MessageObject;
 }
 export interface FitType {
     scConst: number;
     options: FitOptions;
-    messages: {
-        [messageId: number]: Message;
-    };
-    types: {
-        [typeName: string]: Record<number, string | number>;
-    };
+    messages: Record<number, Message>;
+    types: Record<string, Record<number, string | number>>;
 }
+/**
+ * Garmin fields observed in the external FIT corpus but absent from the pinned
+ * public SDK profile. These additions may not replace standard SDK fields.
+ */
+export declare const FIT_VENDOR_MESSAGE_EXTENSIONS: Record<number, Message>;
+export declare const FIT_VENDOR_TYPE_EXTENSIONS: Record<string, Record<number, string>>;
 export declare const FIT: FitType;