fit-file-parser 6.2.1 → 6.2.2

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Change Log
 
+## 6.2.2 - 2026-10-11
+
+### Fixed
+
+- Restore ordinary decoding of existing Bryton and Magene FIT files whose
+  normal record headers set reserved bit 4. Their activity data was readable
+  before 5.2.0 and is recovered without modifying the original bytes.
+- Require complete definitions and native/developer payloads for messages
+  using reserved-header compatibility, including ordinary data records that
+  reference a definition with the reserved bit set.
+
+### Compatibility
+
+- Strict parsing, full raw-message retention, and the standalone raw reader
+  continue rejecting reserved header bits. Bit 5 in data headers remains
+  invalid in all modes. Checksum behavior still follows `force`.
+- No new options or parsed output fields. Existing successful imports need no
+  migration; retry previously rejected originals with the updated parser.
+
 ## 6.2.1 - 2026-10-10
 
 ### Added

package/README.md

@@ -150,6 +150,13 @@ malformed records and definitions. `parseAsync()` and callback callers keep
 their current defaults, recovery, and output. `parseFilesAsync()` uses that
 same decoder independently for each file.
 
+Ordinary decoding tolerates the reserved bit 4 in normal record headers used
+by some existing device files. Messages using this compatibility behavior must
+have complete definitions and payloads inside the declared data section. Bit 5
+in data headers remains invalid. Strict mode, full raw-message retention, and
+the standalone raw reader continue rejecting reserved header bits. Original
+bytes and the caller's checksum policy are unchanged.
+
 `strict: true` adds definition and record bounds checks so CRC bytes cannot be
 decoded as measurements. Full raw-message retention (`includeRawMessages`)
 continues to require complete records as it did before this option was added.

package/dist/binary.d.ts

@@ -8,6 +8,8 @@ export interface MessageTypeDefinition {
     fieldDefs: FieldDefinition[];
     developerFieldDefs?: DeveloperFieldDefinition[];
     rawData?: any[];
+    completeDefinition?: boolean;
+    reservedHeaderBit?: boolean;
 }
 export interface DeveloperFieldDefinition {
     developerDataIndex: number;

package/dist/binary.js

@@ -417,6 +417,8 @@ export function readRecord(blob, messageTypes, developerFields, startIndex, opti
     const recordHeader = blob[startIndex];
     let localMessageType = recordHeader & 15;
     const isCompressedTimestamp = (recordHeader & CompressedHeaderMask) === CompressedHeaderMask;
+    const reservedHeaderBit = !isCompressedTimestamp && (recordHeader & 0x10) !== 0;
+    const strictHeaders = options.strict || retainsRawMessages(options);
     if (isCompressedTimestamp) {
         // compressed timestamp
         localMessageType = (recordHeader & CompressedLocalMsgNumMask) >> 5;
@@ -424,15 +426,16 @@ export function readRecord(blob, messageTypes, developerFields, startIndex, opti
     else if ((recordHeader & 64) === 64) {
         // is definition message
         // startIndex + 1 is reserved
-        if ((options.strict || retainsRawMessages(options)) && startIndex + 6 > dataEnd) {
+        const requireCompleteDefinition = strictHeaders || reservedHeaderBit;
+        if (requireCompleteDefinition && startIndex + 6 > dataEnd) {
             throw new Error('Invalid FIT definition bounds');
         }
         const hasDeveloperData = (recordHeader & 32) === 32;
         const lEnd = blob[startIndex + 2] === 0;
         const numberOfFields = blob[startIndex + 5];
         const nativeDefinitionsEnd = startIndex + 6 + numberOfFields * 3;
-        if ((options.strict || retainsRawMessages(options))
-            && ((recordHeader & 16) !== 0
+        if (requireCompleteDefinition
+            && ((strictHeaders && reservedHeaderBit)
                 || blob[startIndex + 1] !== 0
                 || blob[startIndex + 2] > 1
                 || nativeDefinitionsEnd > dataEnd
@@ -444,7 +447,7 @@ export function readRecord(blob, messageTypes, developerFields, startIndex, opti
             : 0;
         const definitionEnd = nativeDefinitionsEnd
             + (hasDeveloperData ? 1 + numberOfDeveloperDataFields * 3 : 0);
-        if ((options.strict || retainsRawMessages(options)) && definitionEnd > dataEnd) {
+        if (requireCompleteDefinition && definitionEnd > dataEnd) {
             throw new Error('Invalid FIT developer definition bounds');
         }
         const mTypeDef = {
@@ -457,6 +460,13 @@ export function readRecord(blob, messageTypes, developerFields, startIndex, opti
             fieldDefs: [],
             developerFieldDefs: [],
             rawData: [],
+            // A later data header may use the reserved bit with an ordinary
+            // definition. Do not extend legacy partial-record recovery to that case.
+            completeDefinition: startIndex + 6 <= dataEnd
+                && blob[startIndex + 1] === 0
+                && blob[startIndex + 2] <= 1
+                && definitionEnd <= dataEnd,
+            reservedHeaderBit,
         };
         const message = getFitMessage(mTypeDef.globalMessageNumber);
         for (let i = 0; i < numberOfFields; i++) {
@@ -509,13 +519,20 @@ export function readRecord(blob, messageTypes, developerFields, startIndex, opti
             nextIndex: hasDeveloperData ? nextIndexWithDeveloperData : nextIndex,
         };
     }
-    if (!isCompressedTimestamp && (recordHeader & 0x30) !== 0) {
+    // Some existing producer files set bit 4 without changing the record layout.
+    // Recover only that bit in ordinary decoding; bit 5 and strict/raw parsing
+    // retain their previous rejection policy. Never rewrite the source bytes.
+    if (!isCompressedTimestamp && ((recordHeader & 0x20) !== 0 || (strictHeaders && reservedHeaderBit))) {
         throw new Error('Invalid FIT data record header');
     }
     const messageType = messageTypes[localMessageType];
     if (!messageType) {
         throw new Error('FIT data record has no local definition');
     }
+    const reservedHeaderCompatibility = reservedHeaderBit || messageType.reservedHeaderBit;
+    if (reservedHeaderCompatibility && !messageType.completeDefinition) {
+        throw new Error('Invalid FIT definition for reserved header compatibility');
+    }
     let messageSize = 0;
     let readDataFromIndex = startIndex + 1;
     const fields = {};
@@ -530,7 +547,7 @@ export function readRecord(blob, messageTypes, developerFields, startIndex, opti
     const rawDeveloperFields = includeRawDeveloperFields || includeRawMessage ? [] : undefined;
     const unmappedFields = options.includeUnmappedMessages ? [] : undefined;
     const unmappedDeveloperFields = options.includeUnmappedMessages ? [] : undefined;
-    if (options.strict || retainsRawMessages(options)) {
+    if (strictHeaders || reservedHeaderCompatibility) {
         const nativeSize = messageType.fieldDefs.reduce((total, field, index) => (total + (isCompressedTimestamp && index === 0 && field.fDefNo === 253 ? 0 : field.size)), 0);
         const developerSize = developerFieldDefs.reduce((total, field) => total + field.size, 0);
         if (startIndex + 1 + nativeSize + developerSize > dataEnd) {

package/dist/cjs/binary.d.ts

@@ -8,6 +8,8 @@ export interface MessageTypeDefinition {
     fieldDefs: FieldDefinition[];
     developerFieldDefs?: DeveloperFieldDefinition[];
     rawData?: any[];
+    completeDefinition?: boolean;
+    reservedHeaderBit?: boolean;
 }
 export interface DeveloperFieldDefinition {
     developerDataIndex: number;

package/dist/cjs/binary.js

@@ -423,6 +423,8 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
     const recordHeader = blob[startIndex];
     let localMessageType = recordHeader & 15;
     const isCompressedTimestamp = (recordHeader & CompressedHeaderMask) === CompressedHeaderMask;
+    const reservedHeaderBit = !isCompressedTimestamp && (recordHeader & 0x10) !== 0;
+    const strictHeaders = options.strict || retainsRawMessages(options);
     if (isCompressedTimestamp) {
         // compressed timestamp
         localMessageType = (recordHeader & CompressedLocalMsgNumMask) >> 5;
@@ -430,15 +432,16 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
     else if ((recordHeader & 64) === 64) {
         // is definition message
         // startIndex + 1 is reserved
-        if ((options.strict || retainsRawMessages(options)) && startIndex + 6 > dataEnd) {
+        const requireCompleteDefinition = strictHeaders || reservedHeaderBit;
+        if (requireCompleteDefinition && startIndex + 6 > dataEnd) {
             throw new Error('Invalid FIT definition bounds');
         }
         const hasDeveloperData = (recordHeader & 32) === 32;
         const lEnd = blob[startIndex + 2] === 0;
         const numberOfFields = blob[startIndex + 5];
         const nativeDefinitionsEnd = startIndex + 6 + numberOfFields * 3;
-        if ((options.strict || retainsRawMessages(options))
-            && ((recordHeader & 16) !== 0
+        if (requireCompleteDefinition
+            && ((strictHeaders && reservedHeaderBit)
                 || blob[startIndex + 1] !== 0
                 || blob[startIndex + 2] > 1
                 || nativeDefinitionsEnd > dataEnd
@@ -450,7 +453,7 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
             : 0;
         const definitionEnd = nativeDefinitionsEnd
             + (hasDeveloperData ? 1 + numberOfDeveloperDataFields * 3 : 0);
-        if ((options.strict || retainsRawMessages(options)) && definitionEnd > dataEnd) {
+        if (requireCompleteDefinition && definitionEnd > dataEnd) {
             throw new Error('Invalid FIT developer definition bounds');
         }
         const mTypeDef = {
@@ -463,6 +466,13 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
             fieldDefs: [],
             developerFieldDefs: [],
             rawData: [],
+            // A later data header may use the reserved bit with an ordinary
+            // definition. Do not extend legacy partial-record recovery to that case.
+            completeDefinition: startIndex + 6 <= dataEnd
+                && blob[startIndex + 1] === 0
+                && blob[startIndex + 2] <= 1
+                && definitionEnd <= dataEnd,
+            reservedHeaderBit,
         };
         const message = (0, messages_js_1.getFitMessage)(mTypeDef.globalMessageNumber);
         for (let i = 0; i < numberOfFields; i++) {
@@ -515,13 +525,20 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
             nextIndex: hasDeveloperData ? nextIndexWithDeveloperData : nextIndex,
         };
     }
-    if (!isCompressedTimestamp && (recordHeader & 0x30) !== 0) {
+    // Some existing producer files set bit 4 without changing the record layout.
+    // Recover only that bit in ordinary decoding; bit 5 and strict/raw parsing
+    // retain their previous rejection policy. Never rewrite the source bytes.
+    if (!isCompressedTimestamp && ((recordHeader & 0x20) !== 0 || (strictHeaders && reservedHeaderBit))) {
         throw new Error('Invalid FIT data record header');
     }
     const messageType = messageTypes[localMessageType];
     if (!messageType) {
         throw new Error('FIT data record has no local definition');
     }
+    const reservedHeaderCompatibility = reservedHeaderBit || messageType.reservedHeaderBit;
+    if (reservedHeaderCompatibility && !messageType.completeDefinition) {
+        throw new Error('Invalid FIT definition for reserved header compatibility');
+    }
     let messageSize = 0;
     let readDataFromIndex = startIndex + 1;
     const fields = {};
@@ -536,7 +553,7 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
     const rawDeveloperFields = includeRawDeveloperFields || includeRawMessage ? [] : undefined;
     const unmappedFields = options.includeUnmappedMessages ? [] : undefined;
     const unmappedDeveloperFields = options.includeUnmappedMessages ? [] : undefined;
-    if (options.strict || retainsRawMessages(options)) {
+    if (strictHeaders || reservedHeaderCompatibility) {
         const nativeSize = messageType.fieldDefs.reduce((total, field, index) => (total + (isCompressedTimestamp && index === 0 && field.fDefNo === 253 ? 0 : field.size)), 0);
         const developerSize = developerFieldDefs.reduce((total, field) => total + field.size, 0);
         if (startIndex + 1 + nativeSize + developerSize > dataEnd) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "fit-file-parser",
   "type": "module",
-  "version": "6.2.1",
+  "version": "6.2.2",
   "private": false,
   "description": "JavaScript and TypeScript library for parsing and encoding FIT files, with developer-field support, raw message access, and ESM/CommonJS builds.",
   "author": {