fit-file-parser 4.0.0 → 4.0.2

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 4.0.2
+
+- Preserve record alignment when developer-field descriptions are missing or
+  appear after their message definitions.
+- Decode subsequent developer-field values once their descriptions become
+  available, in both strict and force modes.
+
 ## 4.0.0
 
 ### FIT decoder performance

package/dist/binary.d.ts

@@ -7,8 +7,16 @@ export interface MessageTypeDefinition {
     globalMessageNumber: number;
     numberOfFields: number;
     fieldDefs: FieldDefinition[];
+    developerFieldDefs?: DeveloperFieldDefinition[];
     rawData?: any[];
 }
+export interface DeveloperFieldDefinition {
+    developerDataIndex: number;
+    fieldDefinitionNumber: number;
+    size: number;
+    resolvedFieldDef?: FieldDefinition;
+    resolvedFrom?: unknown;
+}
 export declare function addEndian(littleEndian: boolean, bytes: number[]): number;
 export declare function readRecord(blob: Uint8Array, messageTypes: MessageTypeDefinition[], developerFields: any[], startIndex: number, options: FitParserOptions, startDate: number | undefined, pausedTime: number, dataView?: DataView): {
     messageType: MesgNum | '';

package/dist/binary.js

@@ -319,8 +319,63 @@ function applyOptions(data, field, options, fields) {
             return data;
     }
 }
+function applyGarminProductName(fields) {
+    if (fields.product_name !== undefined || fields.manufacturer !== 'garmin') {
+        return;
+    }
+    const product = fields.product;
+    if (typeof product !== 'number') {
+        return;
+    }
+    const productName = FIT.types.garmin_product[product];
+    if (typeof productName === 'string') {
+        // Keep the raw protocol ID and expose the SDK product name separately.
+        fields.product_name = productName;
+    }
+}
+function resolveDeveloperFieldDefinition(developerFieldDef, littleEndian, developerFields, options) {
+    var _a, _b, _c, _d;
+    const description = (_a = developerFields[developerFieldDef.developerDataIndex]) === null || _a === void 0 ? void 0 : _a[developerFieldDef.fieldDefinitionNumber];
+    if (!description) {
+        developerFieldDef.resolvedFieldDef = undefined;
+        developerFieldDef.resolvedFrom = undefined;
+        return undefined;
+    }
+    if (developerFieldDef.resolvedFrom === description
+        && developerFieldDef.resolvedFieldDef) {
+        return developerFieldDef.resolvedFieldDef;
+    }
+    const baseType = description.fit_base_type_id;
+    const type = FIT.types.fit_base_type[baseType];
+    if (typeof baseType !== 'number' || type === undefined) {
+        developerFieldDef.resolvedFieldDef = undefined;
+        developerFieldDef.resolvedFrom = undefined;
+        if (options.force) {
+            return undefined;
+        }
+        throw new Error(`Unsupported base type for developer data index ${developerFieldDef.developerDataIndex}, field ${developerFieldDef.fieldDefinitionNumber}`);
+    }
+    const resolvedFieldDef = {
+        type,
+        fDefNo: developerFieldDef.fieldDefinitionNumber,
+        size: developerFieldDef.size,
+        endianAbility: (baseType & 128) === 128,
+        littleEndian,
+        baseTypeNo: baseType,
+        name: (_b = description.field_name) !== null && _b !== void 0 ? _b : '',
+        dataType: getFitMessageBaseType(baseType & 15),
+        scale: (_c = description.scale) !== null && _c !== void 0 ? _c : 1,
+        offset: (_d = description.offset) !== null && _d !== void 0 ? _d : 0,
+        requiresBoundedDataView: requiresBoundedEndianDataView(type, developerFieldDef.size),
+        developerDataIndex: developerFieldDef.developerDataIndex,
+        isDeveloperField: true,
+    };
+    developerFieldDef.resolvedFieldDef = resolvedFieldDef;
+    developerFieldDef.resolvedFrom = description;
+    return resolvedFieldDef;
+}
 export function readRecord(blob, messageTypes, developerFields, startIndex, options, startDate, pausedTime, dataView = new DataView(blob.buffer, blob.byteOffset, blob.byteLength)) {
-    var _a, _b, _c, _d, _e;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
     const recordHeader = blob[startIndex];
     let localMessageType = recordHeader & 15;
     if ((recordHeader & CompressedHeaderMask) === CompressedHeaderMask) {
@@ -344,6 +399,7 @@ export function readRecord(blob, messageTypes, developerFields, startIndex, opti
             ]),
             numberOfFields: numberOfFields + numberOfDeveloperDataFields,
             fieldDefs: [],
+            developerFieldDefs: [],
             rawData: [],
         };
         const message = getFitMessage(mTypeDef.globalMessageNumber);
@@ -366,41 +422,15 @@ export function readRecord(blob, messageTypes, developerFields, startIndex, opti
             };
             mTypeDef.fieldDefs.push(fDef);
         }
-        // numberOfDeveloperDataFields = 0 so it wont crash here and wont loop
         for (let i = 0; i < numberOfDeveloperDataFields; i++) {
-            // If we fail to parse then try catch
-            try {
-                const fDefIndex = startIndex + 6 + numberOfFields * 3 + 1 + i * 3;
-                const fieldNum = blob[fDefIndex];
-                const size = blob[fDefIndex + 1];
-                const devDataIndex = blob[fDefIndex + 2];
-                const devDef = developerFields[devDataIndex][fieldNum];
-                const baseType = devDef.fit_base_type_id;
-                const fDef = {
-                    type: FIT.types.fit_base_type[baseType],
-                    fDefNo: fieldNum,
-                    size,
-                    endianAbility: (baseType & 128) === 128,
-                    littleEndian: lEnd,
-                    baseTypeNo: baseType,
-                    name: devDef.field_name,
-                    dataType: getFitMessageBaseType(baseType & 15),
-                    scale: devDef.scale || 1,
-                    offset: devDef.offset || 0,
-                    requiresBoundedDataView: requiresBoundedEndianDataView(FIT.types.fit_base_type[baseType], size),
-                    developerDataIndex: devDataIndex,
-                    isDeveloperField: true,
-                };
-                mTypeDef.fieldDefs.push(fDef);
-            }
-            catch (e) {
-                if (options.force) {
-                    continue;
-                }
-                throw e;
-            }
+            const fDefIndex = startIndex + 6 + numberOfFields * 3 + 1 + i * 3;
+            (_a = mTypeDef.developerFieldDefs) === null || _a === void 0 ? void 0 : _a.push({
+                fieldDefinitionNumber: blob[fDefIndex],
+                size: blob[fDefIndex + 1],
+                developerDataIndex: blob[fDefIndex + 2],
+            });
         }
-        mTypeDef.rawData = Array.from({ length: mTypeDef.fieldDefs.length }, () => InvalidFieldData);
+        mTypeDef.rawData = Array.from({ length: mTypeDef.numberOfFields }, () => InvalidFieldData);
         messageTypes[localMessageType] = mTypeDef;
         const nextIndex = startIndex + 6 + mTypeDef.numberOfFields * 3;
         const nextIndexWithDeveloperData = nextIndex + 1;
@@ -416,7 +446,9 @@ export function readRecord(blob, messageTypes, developerFields, startIndex, opti
     let readDataFromIndex = startIndex + 1;
     const fields = {};
     const message = getFitMessage(messageType.globalMessageNumber);
-    const rawData = (_a = messageType.rawData) !== null && _a !== void 0 ? _a : (messageType.rawData = Array.from({ length: messageType.fieldDefs.length }, () => InvalidFieldData));
+    const developerFieldDefs = (_b = messageType.developerFieldDefs) !== null && _b !== void 0 ? _b : [];
+    const totalFieldCount = messageType.fieldDefs.length + developerFieldDefs.length;
+    const rawData = (_c = messageType.rawData) !== null && _c !== void 0 ? _c : (messageType.rawData = Array.from({ length: totalFieldCount }, () => InvalidFieldData));
     let validFieldCount = 0;
     for (let i = 0; i < messageType.fieldDefs.length; i++) {
         const fDef = messageType.fieldDefs[i];
@@ -431,6 +463,26 @@ export function readRecord(blob, messageTypes, developerFields, startIndex, opti
         readDataFromIndex += fDef.size;
         messageSize += fDef.size;
     }
+    for (let i = 0; i < developerFieldDefs.length; i++) {
+        const developerFieldDef = developerFieldDefs[i];
+        const rawDataIndex = messageType.fieldDefs.length + i;
+        const fDef = resolveDeveloperFieldDefinition(developerFieldDef, messageType.littleEndian, developerFields, options);
+        if (fDef) {
+            const data = readData(blob, dataView, fDef, readDataFromIndex, options);
+            if (!isInvalidValue(data, fDef.type) && !isInvalidBaseTypeValue(data, fDef.baseTypeNo)) {
+                rawData[rawDataIndex] = data;
+                validFieldCount++;
+            }
+            else {
+                rawData[rawDataIndex] = InvalidFieldData;
+            }
+        }
+        else {
+            rawData[rawDataIndex] = InvalidFieldData;
+        }
+        readDataFromIndex += developerFieldDef.size;
+        messageSize += developerFieldDef.size;
+    }
     for (let i = 0; i < messageType.fieldDefs.length; i++) {
         const data = rawData[i];
         if (data === InvalidFieldData) {
@@ -442,6 +494,17 @@ export function readRecord(blob, messageTypes, developerFields, startIndex, opti
             fields[field] = data;
         }
     }
+    for (let i = 0; i < developerFieldDefs.length; i++) {
+        const data = rawData[messageType.fieldDefs.length + i];
+        const fDef = developerFieldDefs[i].resolvedFieldDef;
+        if (data === InvalidFieldData || !fDef) {
+            continue;
+        }
+        const field = fDef.name;
+        if (field !== 'unknown' && field !== '') {
+            fields[field] = data;
+        }
+    }
     for (let i = 0; i < messageType.fieldDefs.length; i++) {
         const data = rawData[i];
         if (data === InvalidFieldData) {
@@ -451,19 +514,31 @@ export function readRecord(blob, messageTypes, developerFields, startIndex, opti
         if (fDef.isDeveloperField) {
             const field = fDef.name;
             const { type } = fDef;
-            const scale = (_b = fDef.scale) !== null && _b !== void 0 ? _b : null;
-            const offset = (_c = fDef.offset) !== null && _c !== void 0 ? _c : 0;
+            const scale = (_d = fDef.scale) !== null && _d !== void 0 ? _d : null;
+            const offset = (_e = fDef.offset) !== null && _e !== void 0 ? _e : 0;
             fields[fDef.name] = applyOptions(formatByType(data, type, scale, offset), field, options, fields);
         }
         else {
             const { name: field, type } = fDef;
-            const scale = (_d = fDef.scale) !== null && _d !== void 0 ? _d : null;
-            const offset = (_e = fDef.offset) !== null && _e !== void 0 ? _e : 0;
+            const scale = (_f = fDef.scale) !== null && _f !== void 0 ? _f : null;
+            const offset = (_g = fDef.offset) !== null && _g !== void 0 ? _g : 0;
             if (field !== 'unknown' && field !== '' && field !== undefined) {
                 fields[field] = applyOptions(formatByType(data, type, scale, offset), field, options, fields);
             }
         }
     }
+    for (let i = 0; i < developerFieldDefs.length; i++) {
+        const data = rawData[messageType.fieldDefs.length + i];
+        const fDef = developerFieldDefs[i].resolvedFieldDef;
+        if (data === InvalidFieldData || !fDef) {
+            continue;
+        }
+        const field = fDef.name;
+        if (field !== 'unknown' && field !== '') {
+            fields[field] = applyOptions(formatByType(data, fDef.type, (_h = fDef.scale) !== null && _h !== void 0 ? _h : null, (_j = fDef.offset) !== null && _j !== void 0 ? _j : 0), field, options, fields);
+        }
+    }
+    applyGarminProductName(fields);
     if (validFieldCount > 0 && message.name === 'record' && options.elapsedRecordField) {
         fields.elapsed_time = (fields.timestamp - (startDate || 0)) / 1000;
         fields.timer_time = fields.elapsed_time - pausedTime;

package/dist/cjs/binary.d.ts

@@ -7,8 +7,16 @@ export interface MessageTypeDefinition {
     globalMessageNumber: number;
     numberOfFields: number;
     fieldDefs: FieldDefinition[];
+    developerFieldDefs?: DeveloperFieldDefinition[];
     rawData?: any[];
 }
+export interface DeveloperFieldDefinition {
+    developerDataIndex: number;
+    fieldDefinitionNumber: number;
+    size: number;
+    resolvedFieldDef?: FieldDefinition;
+    resolvedFrom?: unknown;
+}
 export declare function addEndian(littleEndian: boolean, bytes: number[]): number;
 export declare function readRecord(blob: Uint8Array, messageTypes: MessageTypeDefinition[], developerFields: any[], startIndex: number, options: FitParserOptions, startDate: number | undefined, pausedTime: number, dataView?: DataView): {
     messageType: MesgNum | '';

package/dist/cjs/binary.js

@@ -325,8 +325,63 @@ function applyOptions(data, field, options, fields) {
             return data;
     }
 }
+function applyGarminProductName(fields) {
+    if (fields.product_name !== undefined || fields.manufacturer !== 'garmin') {
+        return;
+    }
+    const product = fields.product;
+    if (typeof product !== 'number') {
+        return;
+    }
+    const productName = fit_js_1.FIT.types.garmin_product[product];
+    if (typeof productName === 'string') {
+        // Keep the raw protocol ID and expose the SDK product name separately.
+        fields.product_name = productName;
+    }
+}
+function resolveDeveloperFieldDefinition(developerFieldDef, littleEndian, developerFields, options) {
+    var _a, _b, _c, _d;
+    const description = (_a = developerFields[developerFieldDef.developerDataIndex]) === null || _a === void 0 ? void 0 : _a[developerFieldDef.fieldDefinitionNumber];
+    if (!description) {
+        developerFieldDef.resolvedFieldDef = undefined;
+        developerFieldDef.resolvedFrom = undefined;
+        return undefined;
+    }
+    if (developerFieldDef.resolvedFrom === description
+        && developerFieldDef.resolvedFieldDef) {
+        return developerFieldDef.resolvedFieldDef;
+    }
+    const baseType = description.fit_base_type_id;
+    const type = fit_js_1.FIT.types.fit_base_type[baseType];
+    if (typeof baseType !== 'number' || type === undefined) {
+        developerFieldDef.resolvedFieldDef = undefined;
+        developerFieldDef.resolvedFrom = undefined;
+        if (options.force) {
+            return undefined;
+        }
+        throw new Error(`Unsupported base type for developer data index ${developerFieldDef.developerDataIndex}, field ${developerFieldDef.fieldDefinitionNumber}`);
+    }
+    const resolvedFieldDef = {
+        type,
+        fDefNo: developerFieldDef.fieldDefinitionNumber,
+        size: developerFieldDef.size,
+        endianAbility: (baseType & 128) === 128,
+        littleEndian,
+        baseTypeNo: baseType,
+        name: (_b = description.field_name) !== null && _b !== void 0 ? _b : '',
+        dataType: (0, messages_js_1.getFitMessageBaseType)(baseType & 15),
+        scale: (_c = description.scale) !== null && _c !== void 0 ? _c : 1,
+        offset: (_d = description.offset) !== null && _d !== void 0 ? _d : 0,
+        requiresBoundedDataView: requiresBoundedEndianDataView(type, developerFieldDef.size),
+        developerDataIndex: developerFieldDef.developerDataIndex,
+        isDeveloperField: true,
+    };
+    developerFieldDef.resolvedFieldDef = resolvedFieldDef;
+    developerFieldDef.resolvedFrom = description;
+    return resolvedFieldDef;
+}
 function readRecord(blob, messageTypes, developerFields, startIndex, options, startDate, pausedTime, dataView = new DataView(blob.buffer, blob.byteOffset, blob.byteLength)) {
-    var _a, _b, _c, _d, _e;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
     const recordHeader = blob[startIndex];
     let localMessageType = recordHeader & 15;
     if ((recordHeader & CompressedHeaderMask) === CompressedHeaderMask) {
@@ -350,6 +405,7 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
             ]),
             numberOfFields: numberOfFields + numberOfDeveloperDataFields,
             fieldDefs: [],
+            developerFieldDefs: [],
             rawData: [],
         };
         const message = (0, messages_js_1.getFitMessage)(mTypeDef.globalMessageNumber);
@@ -372,41 +428,15 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
             };
             mTypeDef.fieldDefs.push(fDef);
         }
-        // numberOfDeveloperDataFields = 0 so it wont crash here and wont loop
         for (let i = 0; i < numberOfDeveloperDataFields; i++) {
-            // If we fail to parse then try catch
-            try {
-                const fDefIndex = startIndex + 6 + numberOfFields * 3 + 1 + i * 3;
-                const fieldNum = blob[fDefIndex];
-                const size = blob[fDefIndex + 1];
-                const devDataIndex = blob[fDefIndex + 2];
-                const devDef = developerFields[devDataIndex][fieldNum];
-                const baseType = devDef.fit_base_type_id;
-                const fDef = {
-                    type: fit_js_1.FIT.types.fit_base_type[baseType],
-                    fDefNo: fieldNum,
-                    size,
-                    endianAbility: (baseType & 128) === 128,
-                    littleEndian: lEnd,
-                    baseTypeNo: baseType,
-                    name: devDef.field_name,
-                    dataType: (0, messages_js_1.getFitMessageBaseType)(baseType & 15),
-                    scale: devDef.scale || 1,
-                    offset: devDef.offset || 0,
-                    requiresBoundedDataView: requiresBoundedEndianDataView(fit_js_1.FIT.types.fit_base_type[baseType], size),
-                    developerDataIndex: devDataIndex,
-                    isDeveloperField: true,
-                };
-                mTypeDef.fieldDefs.push(fDef);
-            }
-            catch (e) {
-                if (options.force) {
-                    continue;
-                }
-                throw e;
-            }
+            const fDefIndex = startIndex + 6 + numberOfFields * 3 + 1 + i * 3;
+            (_a = mTypeDef.developerFieldDefs) === null || _a === void 0 ? void 0 : _a.push({
+                fieldDefinitionNumber: blob[fDefIndex],
+                size: blob[fDefIndex + 1],
+                developerDataIndex: blob[fDefIndex + 2],
+            });
         }
-        mTypeDef.rawData = Array.from({ length: mTypeDef.fieldDefs.length }, () => InvalidFieldData);
+        mTypeDef.rawData = Array.from({ length: mTypeDef.numberOfFields }, () => InvalidFieldData);
         messageTypes[localMessageType] = mTypeDef;
         const nextIndex = startIndex + 6 + mTypeDef.numberOfFields * 3;
         const nextIndexWithDeveloperData = nextIndex + 1;
@@ -422,7 +452,9 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
     let readDataFromIndex = startIndex + 1;
     const fields = {};
     const message = (0, messages_js_1.getFitMessage)(messageType.globalMessageNumber);
-    const rawData = (_a = messageType.rawData) !== null && _a !== void 0 ? _a : (messageType.rawData = Array.from({ length: messageType.fieldDefs.length }, () => InvalidFieldData));
+    const developerFieldDefs = (_b = messageType.developerFieldDefs) !== null && _b !== void 0 ? _b : [];
+    const totalFieldCount = messageType.fieldDefs.length + developerFieldDefs.length;
+    const rawData = (_c = messageType.rawData) !== null && _c !== void 0 ? _c : (messageType.rawData = Array.from({ length: totalFieldCount }, () => InvalidFieldData));
     let validFieldCount = 0;
     for (let i = 0; i < messageType.fieldDefs.length; i++) {
         const fDef = messageType.fieldDefs[i];
@@ -437,6 +469,26 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
         readDataFromIndex += fDef.size;
         messageSize += fDef.size;
     }
+    for (let i = 0; i < developerFieldDefs.length; i++) {
+        const developerFieldDef = developerFieldDefs[i];
+        const rawDataIndex = messageType.fieldDefs.length + i;
+        const fDef = resolveDeveloperFieldDefinition(developerFieldDef, messageType.littleEndian, developerFields, options);
+        if (fDef) {
+            const data = readData(blob, dataView, fDef, readDataFromIndex, options);
+            if (!isInvalidValue(data, fDef.type) && !isInvalidBaseTypeValue(data, fDef.baseTypeNo)) {
+                rawData[rawDataIndex] = data;
+                validFieldCount++;
+            }
+            else {
+                rawData[rawDataIndex] = InvalidFieldData;
+            }
+        }
+        else {
+            rawData[rawDataIndex] = InvalidFieldData;
+        }
+        readDataFromIndex += developerFieldDef.size;
+        messageSize += developerFieldDef.size;
+    }
     for (let i = 0; i < messageType.fieldDefs.length; i++) {
         const data = rawData[i];
         if (data === InvalidFieldData) {
@@ -448,6 +500,17 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
             fields[field] = data;
         }
     }
+    for (let i = 0; i < developerFieldDefs.length; i++) {
+        const data = rawData[messageType.fieldDefs.length + i];
+        const fDef = developerFieldDefs[i].resolvedFieldDef;
+        if (data === InvalidFieldData || !fDef) {
+            continue;
+        }
+        const field = fDef.name;
+        if (field !== 'unknown' && field !== '') {
+            fields[field] = data;
+        }
+    }
     for (let i = 0; i < messageType.fieldDefs.length; i++) {
         const data = rawData[i];
         if (data === InvalidFieldData) {
@@ -457,19 +520,31 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
         if (fDef.isDeveloperField) {
             const field = fDef.name;
             const { type } = fDef;
-            const scale = (_b = fDef.scale) !== null && _b !== void 0 ? _b : null;
-            const offset = (_c = fDef.offset) !== null && _c !== void 0 ? _c : 0;
+            const scale = (_d = fDef.scale) !== null && _d !== void 0 ? _d : null;
+            const offset = (_e = fDef.offset) !== null && _e !== void 0 ? _e : 0;
             fields[fDef.name] = applyOptions(formatByType(data, type, scale, offset), field, options, fields);
         }
         else {
             const { name: field, type } = fDef;
-            const scale = (_d = fDef.scale) !== null && _d !== void 0 ? _d : null;
-            const offset = (_e = fDef.offset) !== null && _e !== void 0 ? _e : 0;
+            const scale = (_f = fDef.scale) !== null && _f !== void 0 ? _f : null;
+            const offset = (_g = fDef.offset) !== null && _g !== void 0 ? _g : 0;
             if (field !== 'unknown' && field !== '' && field !== undefined) {
                 fields[field] = applyOptions(formatByType(data, type, scale, offset), field, options, fields);
             }
         }
     }
+    for (let i = 0; i < developerFieldDefs.length; i++) {
+        const data = rawData[messageType.fieldDefs.length + i];
+        const fDef = developerFieldDefs[i].resolvedFieldDef;
+        if (data === InvalidFieldData || !fDef) {
+            continue;
+        }
+        const field = fDef.name;
+        if (field !== 'unknown' && field !== '') {
+            fields[field] = applyOptions(formatByType(data, fDef.type, (_h = fDef.scale) !== null && _h !== void 0 ? _h : null, (_j = fDef.offset) !== null && _j !== void 0 ? _j : 0), field, options, fields);
+        }
+    }
+    applyGarminProductName(fields);
     if (validFieldCount > 0 && message.name === 'record' && options.elapsedRecordField) {
         fields.elapsed_time = (fields.timestamp - (startDate || 0)) / 1000;
         fields.timer_time = fields.elapsed_time - pausedTime;