@garmin/fitsdk 21.141.0 → 21.161.0

package/README.md

@@ -68,6 +68,8 @@ The Read method accepts an optional options object that can be used to customize
 ````js
 const { messages, errors } = decoder.read({
     mesgListener: (messageNumber, message) => {},
+    mesgDefinitionListener: (mesgDefinition) => {},
+    fieldDescriptionListener: (key, developerDataIdMesg, fieldDescriptionMesg) => {},
     applyScaleAndOffset: true,
     expandSubFields: true,
     expandComponents: true,
@@ -97,6 +99,10 @@ const { messages, errors } = decoder.read({
 
 console.log(recordFields);
 ````
+#### mesgDefinitionListener: (mesgDefinition) => {}
+Optional callback function that can be used to inspect message defintions as they are decoded from the file.
+#### fieldDescriptionListener: (key, developerDataIdMesg, fieldDescriptionMesg) => {}
+Optional callback function that can be used to inspect developer field descriptions as they are decoded from the file.
 #### applyScaleAndOffset: true | false
 When true the scale and offset values as defined in the FIT Profile are applied to the raw field values.
 ````js

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@garmin/fitsdk",
-  "version": "21.141.0",
+  "version": "21.161.0",
   "description": "FIT JavaScript SDK",
   "main": "src/index.js",
   "type": "module",
   "scripts": {
     "build": "node .",
-    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js"
+    "test": "vitest run"
   },
   "author": "Garmin International, Inc.",
   "license": "SEE LICENSE IN LICENSE.txt",
@@ -18,9 +18,6 @@
     "src/"
   ],
   "devDependencies": {
-    "jest": "^28.1.2"
-  },
-  "jest": {
-    "transform": {}
+    "vitest": "^2.1.8"
   }
-}
+}

package/src/accumulator.js

@@ -1,12 +1,12 @@
 /////////////////////////////////////////////////////////////////////////////////////////////
-// Copyright 2024 Garmin International, Inc.
+// Copyright 2025 Garmin International, Inc.
 // Licensed under the Flexible and Interoperable Data Transfer (FIT) Protocol License; you
 // may not use this file except in compliance with the Flexible and Interoperable Data
 // Transfer (FIT) Protocol License.
 /////////////////////////////////////////////////////////////////////////////////////////////
 // ****WARNING****  This file is auto-generated!  Do NOT edit this file.
-// Profile Version = 21.141.0Release
-// Tag = production/release/21.141.0-0-g2aa27e1
+// Profile Version = 21.161.0Release
+// Tag = production/release/21.161.0-0-g58854c0
 /////////////////////////////////////////////////////////////////////////////////////////////
 
 
@@ -32,16 +32,26 @@ class AccumulatedField {
 class Accumulator {
     #messages = {};
 
-    add(mesgNum, fieldNum, value) {
+    createAccumulatedField(mesgNum, fieldNum, value) {
+        const accumualtedField = new AccumulatedField(value);
+
         if (this.#messages[mesgNum] == null) {
             this.#messages[mesgNum] = {};
         }
 
-        this.#messages[mesgNum][fieldNum] = new AccumulatedField(value);
+        this.#messages[mesgNum][fieldNum] = accumualtedField;
+
+        return accumualtedField;
     }
 
     accumulate(mesgNum, fieldNum, value, bits) {
-        return this.#messages[mesgNum]?.[fieldNum]?.accumulate(value, bits) ?? value;
+        let accumualtedField = this.#messages[mesgNum]?.[fieldNum];
+        
+        if(accumualtedField == null) {
+            accumualtedField = this.createAccumulatedField(mesgNum, fieldNum, value);
+        }
+
+        return accumualtedField.accumulate(value, bits);
     }
 }
 

package/src/bit-stream.js

@@ -1,12 +1,12 @@
 /////////////////////////////////////////////////////////////////////////////////////////////
-// Copyright 2024 Garmin International, Inc.
+// Copyright 2025 Garmin International, Inc.
 // Licensed under the Flexible and Interoperable Data Transfer (FIT) Protocol License; you
 // may not use this file except in compliance with the Flexible and Interoperable Data
 // Transfer (FIT) Protocol License.
 /////////////////////////////////////////////////////////////////////////////////////////////
 // ****WARNING****  This file is auto-generated!  Do NOT edit this file.
-// Profile Version = 21.141.0Release
-// Tag = production/release/21.141.0-0-g2aa27e1
+// Profile Version = 21.161.0Release
+// Tag = production/release/21.161.0-0-g58854c0
 /////////////////////////////////////////////////////////////////////////////////////////////
 
 

package/src/crc-calculator.js

@@ -1,12 +1,12 @@
 /////////////////////////////////////////////////////////////////////////////////////////////
-// Copyright 2024 Garmin International, Inc.
+// Copyright 2025 Garmin International, Inc.
 // Licensed under the Flexible and Interoperable Data Transfer (FIT) Protocol License; you
 // may not use this file except in compliance with the Flexible and Interoperable Data
 // Transfer (FIT) Protocol License.
 /////////////////////////////////////////////////////////////////////////////////////////////
 // ****WARNING****  This file is auto-generated!  Do NOT edit this file.
-// Profile Version = 21.141.0Release
-// Tag = production/release/21.141.0-0-g2aa27e1
+// Profile Version = 21.161.0Release
+// Tag = production/release/21.161.0-0-g58854c0
 /////////////////////////////////////////////////////////////////////////////////////////////
 
 

package/src/decoder.js

@@ -1,12 +1,12 @@
 /////////////////////////////////////////////////////////////////////////////////////////////
-// Copyright 2024 Garmin International, Inc.
+// Copyright 2025 Garmin International, Inc.
 // Licensed under the Flexible and Interoperable Data Transfer (FIT) Protocol License; you
 // may not use this file except in compliance with the Flexible and Interoperable Data
 // Transfer (FIT) Protocol License.
 /////////////////////////////////////////////////////////////////////////////////////////////
 // ****WARNING****  This file is auto-generated!  Do NOT edit this file.
-// Profile Version = 21.141.0Release
-// Tag = production/release/21.141.0-0-g2aa27e1
+// Profile Version = 21.161.0Release
+// Tag = production/release/21.161.0-0-g58854c0
 /////////////////////////////////////////////////////////////////////////////////////////////
 
 
@@ -25,8 +25,17 @@ const MESG_DEFINITION_MASK = 0x40;
 const DEV_DATA_MASK = 0x20;
 const MESG_HEADER_MASK = 0x00;
 const LOCAL_MESG_NUM_MASK = 0x0F;
+
+const HEADER_WITH_CRC_SIZE = 14;
+const HEADER_WITHOUT_CRC_SIZE = 12;
 const CRC_SIZE = 2;
 
+const DecodeMode = Object.freeze({
+    NORMAL: "normal",
+    SKIP_HEADER: "skipHeader",
+    DATA_ONLY: "dataOnly"
+});
+
 class Decoder {
     #localMessageDefinitions = [];
     #developerDataDefinitions = {};
@@ -36,7 +45,11 @@ class Decoder {
     #fieldsWithSubFields = [];
     #fieldsToExpand = [];
 
+    #decodeMode = DecodeMode.NORMAL;
+
     #mesgListener = null;
+    #mesgDefinitionListener = null;
+    #fieldDescriptionListener = null;
     #optExpandSubFields = true;
     #optExpandComponents = true;
     #optApplyScaleAndOffset = true;
@@ -67,7 +80,7 @@ class Decoder {
     static isFIT(stream) {
         try {
             const fileHeaderSize = stream.peekByte();
-            if ([14, 12].includes(fileHeaderSize) != true) {
+            if ([HEADER_WITH_CRC_SIZE, HEADER_WITHOUT_CRC_SIZE].includes(fileHeaderSize) != true) {
                 return false;
             }
 
@@ -75,7 +88,7 @@ class Decoder {
                 return false;
             }
 
-            const fileHeader = Decoder.#readFileHeader(stream, true);
+            const fileHeader = Decoder.#readFileHeader(stream, { resetPosition: true, });
             if (fileHeader.dataType !== ".FIT") {
                 return false;
             }
@@ -105,7 +118,7 @@ class Decoder {
                 return false;
             }
 
-            const fileHeader = Decoder.#readFileHeader(this.#stream, true);
+            const fileHeader = Decoder.#readFileHeader(this.#stream, { resetPosition: true, });
 
             if (this.#stream.length < fileHeader.headerSize + fileHeader.dataSize + CRC_SIZE) {
                 return false;
@@ -113,7 +126,7 @@ class Decoder {
 
             const buf = new Uint8Array(this.#stream.slice(0, this.#stream.length))
 
-            if (fileHeader.headerSize === 14 && fileHeader.headerCRC !== 0x0000
+            if (fileHeader.headerSize === HEADER_WITH_CRC_SIZE && fileHeader.headerCRC !== 0x0000
                 && fileHeader.headerCRC != CrcCalculator.calculateCRC(buf, 0, 12)) {
                 return false;
             }
@@ -138,11 +151,28 @@ class Decoder {
      * @param {Object} message - The message
      */
 
+    /**
+     * Message Definition Listener Callback
+     *
+     * @callback Decoder~mesgDefinitionListener
+     * @param {Object} messageDefinition - The message Definition
+     */
+
+    /**
+     * Developer Field Description Listener Callback
+     *
+     * @callback Decoder~fieldDescriptionListener
+     * @param {Number} key - The key associated with this pairing of of Developer Data Id and Field Description Mesgs
+     * @param {Object} developerDataIdMesg - The Developer Data Id Mesg associated with this pairing
+     * @param {Object} fieldDescriptionMesg - The Field Description Mesg associated with this pairing
+     */
 
     /**
      * Read the messages from the stream.
      * @param {Object=} [options] - Read options (optional)
      * @param {Decoder~mesgListener} [options.mesgListener=null] - (optional, default null) mesgListener(mesgNum, message)
+     * @param {Decoder~mesgDefinitionListener} [options.mesgDefinitionListener=null] - (optional, default null) mesgDefinitionListener(mesgDefinition)
+     * @param {Decoder~fieldDescriptionListener} [options.fieldDescriptionListener=null] - (optional, default null) fieldDescriptionListener(key, developerDataIdMesg, fieldDescriptionMesg)
      * @param {Boolean} [options.expandSubFields=true] - (optional, default true)
      * @param {Boolean} [options.expandComponents=true] - (optional, default true)
      * @param {Boolean} [options.applyScaleAndOffset=true] - (optional, default true)
@@ -150,19 +180,27 @@ class Decoder {
      * @param {boolean} [options.convertDateTimesToDates=true] - (optional, default true)
      * @param {Boolean} [options.includeUnknownData=false] - (optional, default false)
      * @param {boolean} [options.mergeHeartRates=true] - (optional, default false)
+     * @param {boolean} [options.skipHeader=false] - (optional, default false)
+     * @param {boolean} [options.dataOnly=false] - (optional, default false)
      * @return {Object} result - {messages:Array, errors:Array}
      */
     read({
         mesgListener = null,
+        mesgDefinitionListener = null,
+        fieldDescriptionListener = null,
         expandSubFields = true,
         expandComponents = true,
         applyScaleAndOffset = true,
         convertTypesToStrings = true,
         convertDateTimesToDates = true,
         includeUnknownData = false,
-        mergeHeartRates = true } = {}) {
+        mergeHeartRates = true,
+        skipHeader = false,
+        dataOnly = false,} = {}) {
 
         this.#mesgListener = mesgListener;
+        this.#mesgDefinitionListener = mesgDefinitionListener;
+        this.#fieldDescriptionListener = fieldDescriptionListener;
         this.#optExpandSubFields = expandSubFields
         this.#optExpandComponents = expandComponents;
         this.#optApplyScaleAndOffset = applyScaleAndOffset;
@@ -182,7 +220,11 @@ class Decoder {
                 this.#throwError("mergeHeartRates requires applyScaleAndOffset and expandComponents to be enabled");
             }
 
-            this.#stream.reset();
+            if (dataOnly && skipHeader) {
+                this.#throwError("dataOnly and skipHeader cannot both be enabled")
+            }
+
+            this.#decodeMode = skipHeader ? DecodeMode.SKIP_HEADER : dataOnly ? DecodeMode.DATA_ONLY : DecodeMode.NORMAL;
 
             while (this.#stream.position < this.#stream.length) {
                 this.#decodeNextFile();
@@ -203,23 +245,23 @@ class Decoder {
     #decodeNextFile() {
         const position = this.#stream.position;
 
-        if (!this.isFIT()) {
+        if (this.#decodeMode === DecodeMode.NORMAL && !this.isFIT()) {
             this.#throwError("input is not a FIT file");
         }
 
         this.#stream.crcCalculator = new CrcCalculator();
 
-        const fileHeader = Decoder.#readFileHeader(this.#stream);
+        const { headerSize, dataSize } = Decoder.#readFileHeader(this.#stream, { decodeMode: this.#decodeMode });
 
         // Read data messages and definitions
-        while (this.#stream.position < (position + fileHeader.headerSize + fileHeader.dataSize)) {
+        while (this.#stream.position < (position + headerSize + dataSize)) {
             this.#decodeNextRecord();
         }
 
         // Check the CRC
         const calculatedCrc = this.#stream.crcCalculator.crc;
         const crc = this.#stream.readUInt16();
-        if (crc !== calculatedCrc) {
+        if (this.#decodeMode === DecodeMode.NORMAL && crc !== calculatedCrc) {
             this.#throwError("CRC error");
         }
     }
@@ -291,6 +333,8 @@ class Decoder {
             }
         }
 
+        this.#mesgDefinitionListener?.({...messageDefinition});
+
         let messageProfile = Profile.messages[messageDefinition.globalMessageNumber];
 
         if (messageProfile == null && this.#optIncludeUnknownData) {
@@ -341,7 +385,7 @@ class Decoder {
                 }
 
                 if (field?.isAccumulated) {
-                    this.#accumulator.add(mesgNum, fieldDefinition.fieldDefinitionNumber, rawFieldValue);
+                    this.#setAccumulatedField(messageDefinition, message, field, rawFieldValue);
                 }
             }
         });
@@ -395,6 +439,14 @@ class Decoder {
 
             this.#messages[messageDefinition.messagesKey].push(message);
             this.#mesgListener?.(messageDefinition.globalMessageNumber, message);
+
+            if (mesgNum === Profile.MesgNum.FIELD_DESCRIPTION && this.#fieldDescriptionListener != null) {
+                const developerDataIdMesg = this.#messages.developerDataIdMesgs?.find((developerDataIdMesg) => {
+                    return developerDataIdMesg.developerDataIndex === message.developerDataIndex;
+                }) ?? {};
+
+                this.#fieldDescriptionListener(message.key, {...developerDataIdMesg}, {...message});
+            }
         }
     }
 
@@ -530,7 +582,7 @@ class Decoder {
         while (this.#fieldsToExpand.length > 0) {
             const name = this.#fieldsToExpand.shift();
 
-            const { rawFieldValue, fieldDefinitionNumber, isSubField } = message[name];
+            const { rawFieldValue, fieldDefinitionNumber, isSubField } = message[name] ?? mesg[name];
             let field = Profile.messages[mesgNum].fields[fieldDefinitionNumber];
             field = isSubField ? this.#lookupSubfield(field, name) : field;
             const baseType = FIT.FieldTypeToBaseType[field.type];
@@ -546,6 +598,10 @@ class Decoder {
             const bitStream = new BitStream(rawFieldValue, baseType);
 
             for (let j = 0; j < field.components.length; j++) {
+                if (bitStream.bitsAvailable < field.bits[j]) {
+                    break;
+                }
+
                 const targetField = fields[field.components[j]];
                 if (mesg[targetField.name] == null) {
                     const baseType = FIT.FieldTypeToBaseType[targetField.type];
@@ -560,22 +616,22 @@ class Decoder {
                     };
                 }
 
-                if (bitStream.bitsAvailable < field.bits[j]) {
-                    break;
-                }
-
                 let value = bitStream.readBits(field.bits[j]);
 
-                value = this.#accumulator.accumulate(mesgNum, targetField.num, value, field.bits[j]) ?? value;
+                if (targetField.isAccumulated) {
+                    value = this.#accumulator.accumulate(mesgNum, targetField.num, value, field.bits[j]);
+                }
+
+                // Undo component scale and offset before applying the destination field's scale and offset
+                value = (value / field.scale[j] - field.offset[j]);
 
-                mesg[targetField.name].rawFieldValue.push(value);
+                const rawValue = (value + targetField.offset) * targetField.scale;
+                mesg[targetField.name].rawFieldValue.push(rawValue);
 
-                if (value === mesg[targetField.name].invalidValue) {
+                if (rawValue === mesg[targetField.name].invalidValue) {
                     mesg[targetField.name].fieldValue.push(null);
                 }
                 else {
-                    value = value / field.scale[j] - field.offset[j];
-
                     if (this.#optConvertTypesToStrings) {
                         value = this.#convertTypeToString(mesg, targetField, value);
                     }
@@ -681,6 +737,26 @@ class Decoder {
         }
     }
 
+    #setAccumulatedField(messageDefinition, message, field, rawFieldValue) {
+        const rawFieldValues = Array.isArray(rawFieldValue) ? rawFieldValue : [rawFieldValue];
+
+        rawFieldValues.forEach((value) => {
+            Object.values(message).forEach((containingField) => {
+                let components = messageDefinition.fields[containingField.fieldDefinitionNumber].components ?? []
+
+                components.forEach((componentFieldNum, i) => {
+                    const targetField = messageDefinition.fields[componentFieldNum];
+
+                    if(targetField?.num == field.num && targetField?.isAccumulated) {
+                        value = (((value / field.scale) - field.offset) + containingField.offset[i]) * containingField.scale[i];
+                    }
+                });
+            });
+
+            this.#accumulator.createAccumulatedField(messageDefinition.num, field.num, value);
+        });
+    }
+
     #convertTypeToString(messageDefinition, field, rawFieldValue) {
         if ([Profile.MesgNum.DEVELOPER_DATA_ID, Profile.MesgNum.FIELD_DESCRIPTION].includes(messageDefinition.globalMessageNumber)) {
             return rawFieldValue;
@@ -711,9 +787,22 @@ class Decoder {
         return subField != null ? subField : {};
     }
 
-    static #readFileHeader(stream, resetPosition = false) {
+    static #readFileHeader(stream, { resetPosition = false, decodeMode = DecodeMode.NORMAL }) {
         const position = stream.position;
 
+        if(decodeMode !== DecodeMode.NORMAL) {
+            if(decodeMode === DecodeMode.SKIP_HEADER) {
+                stream.seek(HEADER_WITH_CRC_SIZE);
+            }
+
+            const headerSize = decodeMode === DecodeMode.SKIP_HEADER ? HEADER_WITH_CRC_SIZE : 0;
+
+            return {
+                headerSize,
+                dataSize:  stream.length - headerSize - CRC_SIZE,
+            };
+        }
+
         const fileHeader = {
             headerSize: stream.readByte(),
             protocolVersion: stream.readByte(),