fit-file-parser 5.2.0 → 5.2.1

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## Unreleased
 
+## 5.2.1
+
+### Fixed
+
+- Preserve unusual vendor field definitions in lossless raw-message output so
+  domain consumers can validate only the messages they understand.
+- Add corpus checks for raw-message-only and combined raw/decoded parsing.
+
+## 5.2.0
+
 ### Added
 
 - Add opt-in, message-filterable `raw_messages` output with exact native and

package/README.md

@@ -388,12 +388,16 @@ aggregate-only validation command:
 ```sh
 git clone https://github.com/ThomasKuehne/FIT-test-files.git ../FIT-test-files
 npm run corpus:check -- ../FIT-test-files --allow-force-recovery
+npm run corpus:check -- ../FIT-test-files --allow-force-recovery --raw-messages
+npm run corpus:check -- ../FIT-test-files --allow-force-recovery --raw-messages-with-decoded-output
 ```
 
 The command accepts any corpus path; the sibling location is only a convenient
-convention. The corpus contains a known header-CRC failure that is expected to
-recover only in force mode. It reports aggregate counts and never prints file
-names or parsed activity data.
+convention. Add `--raw-messages` to exercise lossless raw-message-only parsing
+for every message in each file, or `--raw-messages-with-decoded-output` to also
+verify the ordinary decoded output path. The corpus contains a known header-CRC
+failure that is expected to recover only in force mode. It reports aggregate
+counts and never prints file names or parsed activity data.
 
 Do not edit `src/garmin_profile.generated.ts` or `src/fit_types.ts` manually.
 Update the pinned SDK, audited vendor extensions, or a generator, then run

package/dist/binary.js

@@ -8,36 +8,14 @@ const GarminTimeOffset = 631065600000;
 const InvalidFieldData = Symbol('invalid FIT field data');
 const formatTypeMetadata = new Map();
 const uint8CompatibleTypes = new Set(['enum', 'uint8', 'byte']);
-const fitBaseTypeWidths = new Map([
-    [0, 1],
-    [1, 1],
-    [2, 1],
-    [3, 2],
-    [4, 2],
-    [5, 4],
-    [6, 4],
-    [7, 1],
-    [8, 4],
-    [9, 8],
-    [10, 1],
-    [11, 2],
-    [12, 4],
-    [13, 1],
-    [14, 8],
-    [15, 8],
-    [16, 8],
-]);
 function retainsRawMessages(options) {
     return options.includeRawMessages === true
         || Array.isArray(options.includeRawMessages);
 }
-function isValidRawFieldDefinition(size, baseType) {
-    if (size <= 0 || (baseType & 0x60) !== 0) {
-        return false;
-    }
-    const typeId = baseType & 0x1F;
-    const width = fitBaseTypeWidths.get(typeId);
-    return width !== undefined && (typeId === 7 || size % width === 0);
+function retainsRawMessage(options, globalMessageNumber) {
+    return options.includeRawMessages === true
+        || (Array.isArray(options.includeRawMessages)
+            && options.includeRawMessages.includes(globalMessageNumber));
 }
 function baseTypeSize(type) {
     switch (type) {
@@ -480,18 +458,11 @@ export function readRecord(blob, messageTypes, developerFields, startIndex, opti
             rawData: [],
         };
         const message = getFitMessage(mTypeDef.globalMessageNumber);
-        const nativeFieldNumbers = new Set();
         for (let i = 0; i < numberOfFields; i++) {
             const fDefIndex = startIndex + 6 + i * 3;
             const baseType = blob[fDefIndex + 2];
             const fieldNumber = blob[fDefIndex];
             const fieldSize = blob[fDefIndex + 1];
-            if (retainsRawMessages(options)
-                && (nativeFieldNumbers.has(fieldNumber)
-                    || !isValidRawFieldDefinition(fieldSize, baseType))) {
-                throw new Error('Invalid FIT native field definition');
-            }
-            nativeFieldNumbers.add(fieldNumber);
             const wireType = FIT.types.fit_base_type[baseType];
             const { field, type, baseType: profileBaseType, array, scale, offset, units, } = message.getAttributes(blob[fDefIndex]);
             const profileCompatible = areProfileBaseTypesCompatible(profileBaseType, wireType);
@@ -515,15 +486,8 @@ export function readRecord(blob, messageTypes, developerFields, startIndex, opti
             };
             mTypeDef.fieldDefs.push(fDef);
         }
-        const developerFieldNumbers = new Set();
         for (let i = 0; i < numberOfDeveloperDataFields; i++) {
             const fDefIndex = startIndex + 6 + numberOfFields * 3 + 1 + i * 3;
-            const developerFieldKey = `${blob[fDefIndex + 2]}:${blob[fDefIndex]}`;
-            if (retainsRawMessages(options)
-                && (blob[fDefIndex + 1] === 0 || developerFieldNumbers.has(developerFieldKey))) {
-                throw new Error('Invalid FIT developer field definition');
-            }
-            developerFieldNumbers.add(developerFieldKey);
             (_a = mTypeDef.developerFieldDefs) === null || _a === void 0 ? void 0 : _a.push({
                 fieldDefinitionNumber: blob[fDefIndex],
                 size: blob[fDefIndex + 1],
@@ -546,24 +510,13 @@ export function readRecord(blob, messageTypes, developerFields, startIndex, opti
     if (!messageType) {
         throw new Error('FIT data record has no local definition');
     }
-    if (isCompressedTimestamp && retainsRawMessages(options)) {
-        const timestampField = messageType.fieldDefs[0];
-        if (!timestampField
-            || timestampField.fDefNo !== 253
-            || timestampField.size !== 4
-            || (timestampField.baseTypeNo & 0x1F) !== 6) {
-            throw new Error('Invalid FIT compressed timestamp definition');
-        }
-    }
     let messageSize = 0;
     let readDataFromIndex = startIndex + 1;
     const fields = {};
     const message = getFitMessage(messageType.globalMessageNumber);
     const developerFieldDefs = (_b = messageType.developerFieldDefs) !== null && _b !== void 0 ? _b : [];
     const totalFieldCount = messageType.fieldDefs.length + developerFieldDefs.length;
-    const includeRawMessage = options.includeRawMessages === true
-        || (Array.isArray(options.includeRawMessages)
-            && options.includeRawMessages.includes(messageType.globalMessageNumber));
+    const includeRawMessage = retainsRawMessage(options, messageType.globalMessageNumber);
     const includeRawDeveloperFields = options.includeRawDeveloperFields === true
         || (Array.isArray(options.includeRawDeveloperFields)
             && options.includeRawDeveloperFields.includes(messageType.globalMessageNumber));

package/dist/cjs/binary.js

@@ -14,36 +14,14 @@ const GarminTimeOffset = 631065600000;
 const InvalidFieldData = Symbol('invalid FIT field data');
 const formatTypeMetadata = new Map();
 const uint8CompatibleTypes = new Set(['enum', 'uint8', 'byte']);
-const fitBaseTypeWidths = new Map([
-    [0, 1],
-    [1, 1],
-    [2, 1],
-    [3, 2],
-    [4, 2],
-    [5, 4],
-    [6, 4],
-    [7, 1],
-    [8, 4],
-    [9, 8],
-    [10, 1],
-    [11, 2],
-    [12, 4],
-    [13, 1],
-    [14, 8],
-    [15, 8],
-    [16, 8],
-]);
 function retainsRawMessages(options) {
     return options.includeRawMessages === true
         || Array.isArray(options.includeRawMessages);
 }
-function isValidRawFieldDefinition(size, baseType) {
-    if (size <= 0 || (baseType & 0x60) !== 0) {
-        return false;
-    }
-    const typeId = baseType & 0x1F;
-    const width = fitBaseTypeWidths.get(typeId);
-    return width !== undefined && (typeId === 7 || size % width === 0);
+function retainsRawMessage(options, globalMessageNumber) {
+    return options.includeRawMessages === true
+        || (Array.isArray(options.includeRawMessages)
+            && options.includeRawMessages.includes(globalMessageNumber));
 }
 function baseTypeSize(type) {
     switch (type) {
@@ -486,18 +464,11 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
             rawData: [],
         };
         const message = (0, messages_js_1.getFitMessage)(mTypeDef.globalMessageNumber);
-        const nativeFieldNumbers = new Set();
         for (let i = 0; i < numberOfFields; i++) {
             const fDefIndex = startIndex + 6 + i * 3;
             const baseType = blob[fDefIndex + 2];
             const fieldNumber = blob[fDefIndex];
             const fieldSize = blob[fDefIndex + 1];
-            if (retainsRawMessages(options)
-                && (nativeFieldNumbers.has(fieldNumber)
-                    || !isValidRawFieldDefinition(fieldSize, baseType))) {
-                throw new Error('Invalid FIT native field definition');
-            }
-            nativeFieldNumbers.add(fieldNumber);
             const wireType = fit_js_1.FIT.types.fit_base_type[baseType];
             const { field, type, baseType: profileBaseType, array, scale, offset, units, } = message.getAttributes(blob[fDefIndex]);
             const profileCompatible = areProfileBaseTypesCompatible(profileBaseType, wireType);
@@ -521,15 +492,8 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
             };
             mTypeDef.fieldDefs.push(fDef);
         }
-        const developerFieldNumbers = new Set();
         for (let i = 0; i < numberOfDeveloperDataFields; i++) {
             const fDefIndex = startIndex + 6 + numberOfFields * 3 + 1 + i * 3;
-            const developerFieldKey = `${blob[fDefIndex + 2]}:${blob[fDefIndex]}`;
-            if (retainsRawMessages(options)
-                && (blob[fDefIndex + 1] === 0 || developerFieldNumbers.has(developerFieldKey))) {
-                throw new Error('Invalid FIT developer field definition');
-            }
-            developerFieldNumbers.add(developerFieldKey);
             (_a = mTypeDef.developerFieldDefs) === null || _a === void 0 ? void 0 : _a.push({
                 fieldDefinitionNumber: blob[fDefIndex],
                 size: blob[fDefIndex + 1],
@@ -552,24 +516,13 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
     if (!messageType) {
         throw new Error('FIT data record has no local definition');
     }
-    if (isCompressedTimestamp && retainsRawMessages(options)) {
-        const timestampField = messageType.fieldDefs[0];
-        if (!timestampField
-            || timestampField.fDefNo !== 253
-            || timestampField.size !== 4
-            || (timestampField.baseTypeNo & 0x1F) !== 6) {
-            throw new Error('Invalid FIT compressed timestamp definition');
-        }
-    }
     let messageSize = 0;
     let readDataFromIndex = startIndex + 1;
     const fields = {};
     const message = (0, messages_js_1.getFitMessage)(messageType.globalMessageNumber);
     const developerFieldDefs = (_b = messageType.developerFieldDefs) !== null && _b !== void 0 ? _b : [];
     const totalFieldCount = messageType.fieldDefs.length + developerFieldDefs.length;
-    const includeRawMessage = options.includeRawMessages === true
-        || (Array.isArray(options.includeRawMessages)
-            && options.includeRawMessages.includes(messageType.globalMessageNumber));
+    const includeRawMessage = retainsRawMessage(options, messageType.globalMessageNumber);
     const includeRawDeveloperFields = options.includeRawDeveloperFields === true
         || (Array.isArray(options.includeRawDeveloperFields)
             && options.includeRawDeveloperFields.includes(messageType.globalMessageNumber));

package/package.json

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