@garmin/fitsdk 21.158.0 → 21.168.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,26 +1,23 @@
-{
-  "name": "@garmin/fitsdk",
-  "version": "21.158.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"
-  },
-  "author": "Garmin International, Inc.",
-  "license": "SEE LICENSE IN LICENSE.txt",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/garmin/fit-javascript-sdk"
-  },
-  "files": [
-    "src/"
-  ],
-  "devDependencies": {
-    "jest": "^28.1.2"
-  },
-  "jest": {
-    "transform": {}
-  }
-}
+{
+  "name": "@garmin/fitsdk",
+  "version": "21.168.0",
+  "description": "FIT JavaScript SDK",
+  "main": "src/index.js",
+  "type": "module",
+  "scripts": {
+    "build": "node .",
+    "test": "vitest run"
+  },
+  "author": "Garmin International, Inc.",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/garmin/fit-javascript-sdk"
+  },
+  "files": [
+    "src/"
+  ],
+  "devDependencies": {
+    "vitest": "^2.1.8"
+  }
+}

package/src/accumulator.js

@@ -1,58 +1,58 @@
-/////////////////////////////////////////////////////////////////////////////////////////////
-// Copyright 2024 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.158.0Release
-// Tag = production/release/21.158.0-0-gc9428aa
-/////////////////////////////////////////////////////////////////////////////////////////////
-
-
-class AccumulatedField {
-    #accumulatedValue = 0;
-    #lastValue = 0;
-
-    constructor(value) {
-        this.#accumulatedValue = value;
-        this.#lastValue = value;
-    }
-
-    accumulate(value, bits) {
-        const mask = (1 << bits) - 1;
-
-        this.#accumulatedValue += (value - this.#lastValue) & mask;
-        this.#lastValue = value;
-
-        return this.#accumulatedValue;
-    }
-}
-
-class Accumulator {
-    #messages = {};
-
-    createAccumulatedField(mesgNum, fieldNum, value) {
-        const accumualtedField = new AccumulatedField(value);
-
-        if (this.#messages[mesgNum] == null) {
-            this.#messages[mesgNum] = {};
-        }
-
-        this.#messages[mesgNum][fieldNum] = accumualtedField;
-
-        return accumualtedField;
-    }
-
-    accumulate(mesgNum, fieldNum, value, bits) {
-        let accumualtedField = this.#messages[mesgNum]?.[fieldNum];
-        
-        if(accumualtedField == null) {
-            accumualtedField = this.createAccumulatedField(mesgNum, fieldNum, value);
-        }
-
-        return accumualtedField.accumulate(value, bits);
-    }
-}
-
-export default Accumulator;
+/////////////////////////////////////////////////////////////////////////////////////////////
+// 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.168.0Release
+// Tag = production/release/21.168.0-0-gb831b31
+/////////////////////////////////////////////////////////////////////////////////////////////
+
+
+class AccumulatedField {
+    #accumulatedValue = 0;
+    #lastValue = 0;
+
+    constructor(value) {
+        this.#accumulatedValue = value;
+        this.#lastValue = value;
+    }
+
+    accumulate(value, bits) {
+        const mask = (1 << bits) - 1;
+
+        this.#accumulatedValue += (value - this.#lastValue) & mask;
+        this.#lastValue = value;
+
+        return this.#accumulatedValue;
+    }
+}
+
+class Accumulator {
+    #messages = {};
+
+    createAccumulatedField(mesgNum, fieldNum, value) {
+        const accumualtedField = new AccumulatedField(value);
+
+        if (this.#messages[mesgNum] == null) {
+            this.#messages[mesgNum] = {};
+        }
+
+        this.#messages[mesgNum][fieldNum] = accumualtedField;
+
+        return accumualtedField;
+    }
+
+    accumulate(mesgNum, fieldNum, value, bits) {
+        let accumualtedField = this.#messages[mesgNum]?.[fieldNum];
+        
+        if(accumualtedField == null) {
+            accumualtedField = this.createAccumulatedField(mesgNum, fieldNum, value);
+        }
+
+        return accumualtedField.accumulate(value, bits);
+    }
+}
+
+export default Accumulator;

package/src/bit-stream.js

@@ -1,85 +1,85 @@
-/////////////////////////////////////////////////////////////////////////////////////////////
-// Copyright 2024 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.158.0Release
-// Tag = production/release/21.158.0-0-gc9428aa
-/////////////////////////////////////////////////////////////////////////////////////////////
-
-
-import FIT from "./fit.js";
-
-class BitStream {
-    #array = null;
-    #currentArrayPosition = 0;
-    #bitPerPosition = 0;
-    #currentByte = 0;
-    #currentBit = 0;
-    #bitsAvailable = 0;
-
-    constructor(data, baseType = FIT.BaseType.UINT8) {
-        this.#array = Array.isArray(data) ? data : [data];
-        const baseTypeSize = FIT.BaseTypeDefinitions[baseType].size;
-        this.#bitPerPosition = baseTypeSize * 8;
-        this.reset();
-    }
-
-    get bitsAvailable() {
-        return this.#bitsAvailable;
-    }
-
-    get hasBitsAvailable() {
-        return this.#bitsAvailable > 0;
-    }
-
-    reset() {
-        this.#currentArrayPosition = 0;
-        this.#bitsAvailable = this.#bitPerPosition * this.#array.length;
-        this.#nextByte();
-    }
-
-    readBit() {
-        if (!this.hasBitsAvailable) {
-            this.#throwError();
-        }
-
-        if (this.#currentBit >= this.#bitPerPosition) {
-            this.#nextByte();
-        }
-
-        const bit = this.#currentByte & 0x01;
-        this.#currentByte = this.#currentByte >> 1;
-        this.#currentBit++;
-        this.#bitsAvailable--;
-
-        return bit;
-    }
-
-    readBits(nBitsToRead) {
-        let value = 0n;
-
-        for (let i = 0n; i < nBitsToRead; i++) {
-            value |= BigInt(this.readBit()) << i;
-        }
-
-        return Number(value);
-    }
-
-    #nextByte() {
-        if (this.#currentArrayPosition >= this.#array.length) {
-            this.#throwError();
-        }
-
-        this.#currentByte = this.#array[this.#currentArrayPosition++];
-        this.#currentBit = 0;
-    }
-
-    #throwError(error = "") {
-        throw Error("FIT Runtime Error no bits available.");
-    }
-}
-
-export default BitStream;
+/////////////////////////////////////////////////////////////////////////////////////////////
+// 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.168.0Release
+// Tag = production/release/21.168.0-0-gb831b31
+/////////////////////////////////////////////////////////////////////////////////////////////
+
+
+import FIT from "./fit.js";
+
+class BitStream {
+    #array = null;
+    #currentArrayPosition = 0;
+    #bitPerPosition = 0;
+    #currentByte = 0;
+    #currentBit = 0;
+    #bitsAvailable = 0;
+
+    constructor(data, baseType = FIT.BaseType.UINT8) {
+        this.#array = Array.isArray(data) ? data : [data];
+        const baseTypeSize = FIT.BaseTypeDefinitions[baseType].size;
+        this.#bitPerPosition = baseTypeSize * 8;
+        this.reset();
+    }
+
+    get bitsAvailable() {
+        return this.#bitsAvailable;
+    }
+
+    get hasBitsAvailable() {
+        return this.#bitsAvailable > 0;
+    }
+
+    reset() {
+        this.#currentArrayPosition = 0;
+        this.#bitsAvailable = this.#bitPerPosition * this.#array.length;
+        this.#nextByte();
+    }
+
+    readBit() {
+        if (!this.hasBitsAvailable) {
+            this.#throwError();
+        }
+
+        if (this.#currentBit >= this.#bitPerPosition) {
+            this.#nextByte();
+        }
+
+        const bit = this.#currentByte & 0x01;
+        this.#currentByte = this.#currentByte >> 1;
+        this.#currentBit++;
+        this.#bitsAvailable--;
+
+        return bit;
+    }
+
+    readBits(nBitsToRead) {
+        let value = 0n;
+
+        for (let i = 0n; i < nBitsToRead; i++) {
+            value |= BigInt(this.readBit()) << i;
+        }
+
+        return Number(value);
+    }
+
+    #nextByte() {
+        if (this.#currentArrayPosition >= this.#array.length) {
+            this.#throwError();
+        }
+
+        this.#currentByte = this.#array[this.#currentArrayPosition++];
+        this.#currentBit = 0;
+    }
+
+    #throwError(error = "") {
+        throw Error("FIT Runtime Error no bits available.");
+    }
+}
+
+export default BitStream;

package/src/crc-calculator.js

@@ -1,56 +1,56 @@
-/////////////////////////////////////////////////////////////////////////////////////////////
-// Copyright 2024 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.158.0Release
-// Tag = production/release/21.158.0-0-gc9428aa
-/////////////////////////////////////////////////////////////////////////////////////////////
-
-
-const crcTable = [
-    0x0000, 0xCC01, 0xD801, 0x1400, 0xF001, 0x3C00, 0x2800, 0xE401,
-    0xA001, 0x6C00, 0x7800, 0xB401, 0x5000, 0x9C01, 0x8801, 0x4400
-]
-
-class CrcCalculator {
-    #crc = 0;
-
-    constructor() {
-    }
-
-    get crc() {
-        return this.#crc;
-    }
-
-    #updateCRC(value) {
-        // compute checksum of lower four bits of byte
-        let tmp = crcTable[this.#crc & 0xF];
-        this.#crc = (this.#crc >> 4) & 0x0FFF;
-        this.#crc = this.#crc ^ tmp ^ crcTable[value & 0xF];
-
-        // compute checksum of upper four bits of byte
-        tmp = crcTable[this.#crc & 0xF];
-        this.#crc = (this.#crc >> 4) & 0x0FFF;
-        this.#crc = this.#crc ^ tmp ^ crcTable[(value >> 4) & 0xF];
-
-        return this.#crc;
-    }
-
-    addBytes(buf, start, end) {
-        for (let i = start; i < end; i++) {
-            this.#crc = this.#updateCRC(buf[i]);
-        }
-
-        return this.#crc;
-    }
-
-    static calculateCRC(buf, start, end) {
-        const crcCalculator = new CrcCalculator();
-        return crcCalculator.addBytes(buf, start, end);
-    }
-}
-
+/////////////////////////////////////////////////////////////////////////////////////////////
+// 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.168.0Release
+// Tag = production/release/21.168.0-0-gb831b31
+/////////////////////////////////////////////////////////////////////////////////////////////
+
+
+const crcTable = [
+    0x0000, 0xCC01, 0xD801, 0x1400, 0xF001, 0x3C00, 0x2800, 0xE401,
+    0xA001, 0x6C00, 0x7800, 0xB401, 0x5000, 0x9C01, 0x8801, 0x4400
+]
+
+class CrcCalculator {
+    #crc = 0;
+
+    constructor() {
+    }
+
+    get crc() {
+        return this.#crc;
+    }
+
+    #updateCRC(value) {
+        // compute checksum of lower four bits of byte
+        let tmp = crcTable[this.#crc & 0xF];
+        this.#crc = (this.#crc >> 4) & 0x0FFF;
+        this.#crc = this.#crc ^ tmp ^ crcTable[value & 0xF];
+
+        // compute checksum of upper four bits of byte
+        tmp = crcTable[this.#crc & 0xF];
+        this.#crc = (this.#crc >> 4) & 0x0FFF;
+        this.#crc = this.#crc ^ tmp ^ crcTable[(value >> 4) & 0xF];
+
+        return this.#crc;
+    }
+
+    addBytes(buf, start, end) {
+        for (let i = start; i < end; i++) {
+            this.#crc = this.#updateCRC(buf[i]);
+        }
+
+        return this.#crc;
+    }
+
+    static calculateCRC(buf, start, end) {
+        const crcCalculator = new CrcCalculator();
+        return crcCalculator.addBytes(buf, start, end);
+    }
+}
+
 export default CrcCalculator;