fit-file-parser 5.0.1 → 5.1.0

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 ## Unreleased
 
+## 5.1.0
+
+### Added
+
+- Add opt-in, message-filterable `raw_developer_fields` output with exact
+  developer-field bytes, global-message occurrence, developer-data index, and
+  field-definition number. Existing decoded output remains unchanged when the
+  option is disabled.
+
+## 5.0.2
+
+### Fixed
+
+- Clarify the 5.0 migration for standard session field 196: use canonical
+  `metabolic_calories` rather than the old duplicate `resting_calories` label.
+- Clarify that the removed guessed `recovery_advisor` label was standard
+  session field 140, which the SDK defines as `avg_depth` in meters.
+
 ## 5.0.1
 
 ### Fixed

package/README.md

@@ -54,14 +54,18 @@ SDK-backed names. Common migrations include:
 | `repeat_dive_time`             | `repeat_dive_interval`       |
 | `cadence_zone_high_boundary`   | `cadence_zone_high_bondary`  |
 | `HipSwingExcerciseName`        | `HipSwingExerciseName`       |
+| `resting_calories`             | `metabolic_calories`         |
 
 The same alphanumeric-token rule applies to enum strings, for example
 `camera_orientation_90` becomes `camera_orientation90`, `po_2_warn` becomes
 `po2_warn`, and `power_3s` becomes `power3s`. The generated TypeScript
 declarations are the exhaustive name and value reference for the pinned SDK.
 
-The handwritten `resting_calories` and guessed `recovery_advisor` fields have
-no 5.0 replacement. Other behavior to account for during migration:
+Parser 4 exposed standard session field 196 (`metabolic_calories`) a second
+time as `resting_calories`; use the canonical `metabolic_calories` name in 5.0.
+`recovery_advisor` was a guessed label for standard session field 140, whose
+canonical SDK field is `avg_depth` in meters. Other behavior to account for
+during migration:
 
 - `product_name` is emitted only when it exists in the FIT input. It is no
   longer inferred from `manufacturer` and `product`.
@@ -131,20 +135,55 @@ callback API receives as its first argument.
 
 All options are optional.
 
-| Option               | Values                                  | Default   | Behavior                                                                                                                                       |
-| -------------------- | --------------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
-| `mode`               | `list`, `cascade`, `both`               | `list`    | Controls whether primary activity collections are returned as root lists, nested data, or both.                                                |
-| `force`              | `true`, `false`                         | `true`    | Skips header and file CRC validation and enables supported best-effort field recovery. Structural header and data bounds are always validated. |
-| `speedUnit`          | `m/s`, `km/h`, `mph`                    | `m/s`     | Converts speed-related fields.                                                                                                                 |
-| `lengthUnit`         | `m`, `km`, `mi`                         | `m`       | Converts distance, altitude, and other length-related fields.                                                                                  |
-| `temperatureUnit`    | `celsius`, `°C`, `kelvin`, `fahrenheit` | `celsius` | Converts temperature fields. `°C` remains available as a legacy alias.                                                                         |
-| `pressureUnit`       | `bar`, `cbar`, `psi`                    | `bar`     | Converts pressure and tank-pressure fields.                                                                                                    |
-| `elapsedRecordField` | `true`, `false`                         | `false`   | Adds `elapsed_time` and `timer_time`, in seconds, to records.                                                                                  |
+| Option                      | Values                                  | Default   | Behavior                                                                                                                                       |
+| --------------------------- | --------------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| `mode`                      | `list`, `cascade`, `both`               | `list`    | Controls whether primary activity collections are returned as root lists, nested data, or both.                                                |
+| `force`                     | `true`, `false`                         | `true`    | Skips header and file CRC validation and enables supported best-effort field recovery. Structural header and data bounds are always validated. |
+| `speedUnit`                 | `m/s`, `km/h`, `mph`                    | `m/s`     | Converts speed-related fields.                                                                                                                 |
+| `lengthUnit`                | `m`, `km`, `mi`                         | `m`       | Converts distance, altitude, and other length-related fields.                                                                                  |
+| `temperatureUnit`           | `celsius`, `°C`, `kelvin`, `fahrenheit` | `celsius` | Converts temperature fields. `°C` remains available as a legacy alias.                                                                         |
+| `pressureUnit`              | `bar`, `cbar`, `psi`                    | `bar`     | Converts pressure and tank-pressure fields.                                                                                                    |
+| `elapsedRecordField`        | `true`, `false`                         | `false`   | Adds `elapsed_time` and `timer_time`, in seconds, to records.                                                                                  |
+| `includeRawDeveloperFields` | `true`, `false`, message-number array   | `false`   | Adds a lossless, message-associated view of developer-field bytes at `raw_developer_fields`.                                                   |
 
 `force: true` does not make arbitrary bytes a valid FIT file. Inputs that are
 too short, have an invalid header size or signature, or declare data beyond the
 available bytes are rejected in both modes.
 
+### Lossless developer fields
+
+By default, developer fields retain the existing decoded, name-keyed output.
+Set `includeRawDeveloperFields: true` when a consumer also needs exact field
+bytes or must distinguish same-named fields from different developer-data
+indexes:
+
+```javascript
+const data = await new FitParser({
+  force: false,
+  includeRawDeveloperFields: [18],
+}).parseAsync(content)
+
+for (const field of data.raw_developer_fields ?? []) {
+  console.log({
+    globalMessageNumber: field.global_message_number,
+    messageIndex: field.message_index,
+    developerDataIndex: field.developer_data_index,
+    fieldDefinitionNumber: field.field_definition_number,
+    rawBytes: field.raw_value,
+  })
+}
+```
+
+`message_index` is the zero-based occurrence of that global message number in
+file order. `raw_value` is a defensive plain-number copy of the exact FIT field
+bytes, including interior NUL bytes and invalid sentinels. Join
+`developer_data_index` and `field_definition_number` to the existing
+`developer_data_ids` and `field_descriptions` collections to interpret an
+application and field. The parser deliberately does not infer application- or
+provider-specific semantics. Pass `true` to retain developer fields from every
+global message, or an array such as `[18]` to bound collection to specific FIT
+message numbers.
+
 ## Output modes
 
 The mode controls where sessions, laps, records, and related activity

package/dist/binary.d.ts

@@ -20,11 +20,18 @@ export interface DecoderState {
     lastTimestamp?: number;
     monitoringTimestamp?: number;
 }
+export interface RawDeveloperFieldValue {
+    developerDataIndex: number;
+    fieldDefinitionNumber: number;
+    rawValue: number[];
+}
 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, decoderState?: DecoderState): {
+export declare function readRecord(blob: Uint8Array, messageTypes: MessageTypeDefinition[], developerFields: any[], startIndex: number, options: FitParserOptions, startDate: number | undefined, pausedTime: number, dataView?: DataView, decoderState?: DecoderState, dataEnd?: number): {
     messageType: MessageName | 'definition' | '';
     nextIndex: number;
     message?: any;
+    globalMessageNumber?: number;
+    rawDeveloperFields?: RawDeveloperFieldValue[];
 };
 export declare function getArrayBuffer(buffer: ArrayBuffer | Buffer): ArrayBuffer;
 export declare function calculateCRC(blob: Uint8Array, start: number, end: number): number;

package/dist/binary.js

@@ -399,7 +399,7 @@ function resolveDeveloperFieldDefinition(developerFieldDef, littleEndian, develo
     developerFieldDef.resolvedFrom = description;
     return resolvedFieldDef;
 }
-export function readRecord(blob, messageTypes, developerFields, startIndex, options, startDate, pausedTime, dataView = new DataView(blob.buffer, blob.byteOffset, blob.byteLength), decoderState = {}) {
+export function readRecord(blob, messageTypes, developerFields, startIndex, options, startDate, pausedTime, dataView = new DataView(blob.buffer, blob.byteOffset, blob.byteLength), decoderState = {}, dataEnd = dataView.byteLength) {
     var _a, _b, _c;
     const recordHeader = blob[startIndex];
     let localMessageType = recordHeader & 15;
@@ -479,6 +479,10 @@ export function readRecord(blob, messageTypes, developerFields, startIndex, opti
     const message = getFitMessage(messageType.globalMessageNumber);
     const developerFieldDefs = (_b = messageType.developerFieldDefs) !== null && _b !== void 0 ? _b : [];
     const totalFieldCount = messageType.fieldDefs.length + developerFieldDefs.length;
+    const includeRawDeveloperFields = options.includeRawDeveloperFields === true
+        || (Array.isArray(options.includeRawDeveloperFields)
+            && options.includeRawDeveloperFields.includes(messageType.globalMessageNumber));
+    const rawDeveloperFields = includeRawDeveloperFields ? [] : undefined;
     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++) {
@@ -502,6 +506,14 @@ export function readRecord(blob, messageTypes, developerFields, startIndex, opti
     for (let i = 0; i < developerFieldDefs.length; i++) {
         const developerFieldDef = developerFieldDefs[i];
         const rawDataIndex = messageType.fieldDefs.length + i;
+        if (rawDeveloperFields
+            && readDataFromIndex + developerFieldDef.size <= dataEnd) {
+            rawDeveloperFields.push({
+                developerDataIndex: developerFieldDef.developerDataIndex,
+                fieldDefinitionNumber: developerFieldDef.fieldDefinitionNumber,
+                rawValue: Array.from(blob.subarray(readDataFromIndex, readDataFromIndex + developerFieldDef.size)),
+            });
+        }
         const fDef = resolveDeveloperFieldDefinition(developerFieldDef, messageType.littleEndian, developerFields, options);
         if (fDef) {
             const data = readData(blob, dataView, fDef, readDataFromIndex);
@@ -607,9 +619,11 @@ export function readRecord(blob, messageTypes, developerFields, startIndex, opti
         }
     }
     return {
+        globalMessageNumber: messageType.globalMessageNumber,
         messageType: message.name,
         nextIndex: startIndex + messageSize + 1,
         message: fields,
+        rawDeveloperFields,
     };
 }
 export function getArrayBuffer(buffer) {

package/dist/cjs/binary.d.ts

@@ -20,11 +20,18 @@ export interface DecoderState {
     lastTimestamp?: number;
     monitoringTimestamp?: number;
 }
+export interface RawDeveloperFieldValue {
+    developerDataIndex: number;
+    fieldDefinitionNumber: number;
+    rawValue: number[];
+}
 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, decoderState?: DecoderState): {
+export declare function readRecord(blob: Uint8Array, messageTypes: MessageTypeDefinition[], developerFields: any[], startIndex: number, options: FitParserOptions, startDate: number | undefined, pausedTime: number, dataView?: DataView, decoderState?: DecoderState, dataEnd?: number): {
     messageType: MessageName | 'definition' | '';
     nextIndex: number;
     message?: any;
+    globalMessageNumber?: number;
+    rawDeveloperFields?: RawDeveloperFieldValue[];
 };
 export declare function getArrayBuffer(buffer: ArrayBuffer | Buffer): ArrayBuffer;
 export declare function calculateCRC(blob: Uint8Array, start: number, end: number): number;

package/dist/cjs/binary.js

@@ -405,7 +405,7 @@ function resolveDeveloperFieldDefinition(developerFieldDef, littleEndian, develo
     developerFieldDef.resolvedFrom = description;
     return resolvedFieldDef;
 }
-function readRecord(blob, messageTypes, developerFields, startIndex, options, startDate, pausedTime, dataView = new DataView(blob.buffer, blob.byteOffset, blob.byteLength), decoderState = {}) {
+function readRecord(blob, messageTypes, developerFields, startIndex, options, startDate, pausedTime, dataView = new DataView(blob.buffer, blob.byteOffset, blob.byteLength), decoderState = {}, dataEnd = dataView.byteLength) {
     var _a, _b, _c;
     const recordHeader = blob[startIndex];
     let localMessageType = recordHeader & 15;
@@ -485,6 +485,10 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
     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 includeRawDeveloperFields = options.includeRawDeveloperFields === true
+        || (Array.isArray(options.includeRawDeveloperFields)
+            && options.includeRawDeveloperFields.includes(messageType.globalMessageNumber));
+    const rawDeveloperFields = includeRawDeveloperFields ? [] : undefined;
     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++) {
@@ -508,6 +512,14 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
     for (let i = 0; i < developerFieldDefs.length; i++) {
         const developerFieldDef = developerFieldDefs[i];
         const rawDataIndex = messageType.fieldDefs.length + i;
+        if (rawDeveloperFields
+            && readDataFromIndex + developerFieldDef.size <= dataEnd) {
+            rawDeveloperFields.push({
+                developerDataIndex: developerFieldDef.developerDataIndex,
+                fieldDefinitionNumber: developerFieldDef.fieldDefinitionNumber,
+                rawValue: Array.from(blob.subarray(readDataFromIndex, readDataFromIndex + developerFieldDef.size)),
+            });
+        }
         const fDef = resolveDeveloperFieldDefinition(developerFieldDef, messageType.littleEndian, developerFields, options);
         if (fDef) {
             const data = readData(blob, dataView, fDef, readDataFromIndex);
@@ -613,9 +625,11 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
         }
     }
     return {
+        globalMessageNumber: messageType.globalMessageNumber,
         messageType: message.name,
         nextIndex: startIndex + messageSize + 1,
         message: fields,
+        rawDeveloperFields,
     };
 }
 function getArrayBuffer(buffer) {

package/dist/cjs/fit-parser.d.ts

@@ -2,6 +2,7 @@ import type { Buffer } from 'buffer';
 import type { ParsedFit } from './fit_types.js';
 export { FitBaseType, FitEncoder } from './fit-encoder.js';
 export type { FitEncoderField, FitEncoderOptions } from './fit-encoder.js';
+export type { ParsedFit, ParsedRawDeveloperField } from './fit_types.js';
 export interface FitParserOptions {
     force?: boolean;
     speedUnit?: string;
@@ -10,6 +11,8 @@ export interface FitParserOptions {
     elapsedRecordField?: boolean;
     pressureUnit?: string;
     mode?: 'list' | 'cascade' | 'both';
+    /** Retains exact developer-field bytes for all or selected global message numbers. */
+    includeRawDeveloperFields?: boolean | readonly number[];
 }
 type FitParserCallback = (error: string | undefined, data: ParsedFit | undefined) => void;
 export default class FitParser {

package/dist/cjs/fit-parser.js

@@ -8,6 +8,7 @@ Object.defineProperty(exports, "FitBaseType", { enumerable: true, get: function
 Object.defineProperty(exports, "FitEncoder", { enumerable: true, get: function () { return fit_encoder_js_1.FitEncoder; } });
 class FitParser {
     constructor(options = {}) {
+        var _a;
         this.options = {
             force: options.force != null ? options.force : true,
             speedUnit: options.speedUnit || 'm/s',
@@ -16,6 +17,7 @@ class FitParser {
             elapsedRecordField: options.elapsedRecordField || false,
             pressureUnit: options.pressureUnit || 'bar',
             mode: options.mode || 'list',
+            includeRawDeveloperFields: (_a = options.includeRawDeveloperFields) !== null && _a !== void 0 ? _a : false,
         };
     }
     parseAsync(content) {
@@ -31,7 +33,7 @@ class FitParser {
         });
     }
     parse(content, callback) {
-        var _a, _b;
+        var _a, _b, _c;
         const blob = content instanceof ArrayBuffer
             ? new Uint8Array(content)
             : new Uint8Array(content.buffer, content.byteOffset, content.byteLength);
@@ -118,6 +120,11 @@ class FitParser {
         const time_in_zone = [];
         const activity_metrics = [];
         const user_metrics = [];
+        const rawDeveloperFields = this.options.includeRawDeveloperFields === true
+            || Array.isArray(this.options.includeRawDeveloperFields)
+            ? []
+            : undefined;
+        const messageCountsByGlobalNumber = new Map();
         let loopIndex = headerLength;
         const messageTypes = [];
         const developerFields = [];
@@ -128,12 +135,25 @@ class FitParser {
         let lastStopTimestamp;
         let pausedTime = 0;
         while (loopIndex < crcStart) {
-            const { nextIndex, messageType, message } = (0, binary_js_1.readRecord)(blob, messageTypes, developerFields, loopIndex, this.options, startDate, pausedTime, dataView, decoderState);
+            const { globalMessageNumber, message, messageType, nextIndex, rawDeveloperFields: recordRawDeveloperFields, } = (0, binary_js_1.readRecord)(blob, messageTypes, developerFields, loopIndex, this.options, startDate, pausedTime, dataView, decoderState, crcStart);
             loopIndex = nextIndex;
+            if (globalMessageNumber !== undefined) {
+                const messageIndex = (_a = messageCountsByGlobalNumber.get(globalMessageNumber)) !== null && _a !== void 0 ? _a : 0;
+                messageCountsByGlobalNumber.set(globalMessageNumber, messageIndex + 1);
+                recordRawDeveloperFields === null || recordRawDeveloperFields === void 0 ? void 0 : recordRawDeveloperFields.forEach((field) => {
+                    rawDeveloperFields === null || rawDeveloperFields === void 0 ? void 0 : rawDeveloperFields.push({
+                        global_message_number: globalMessageNumber,
+                        message_index: messageIndex,
+                        developer_data_index: field.developerDataIndex,
+                        field_definition_number: field.fieldDefinitionNumber,
+                        raw_value: field.rawValue,
+                    });
+                });
+            }
             if (messageType !== ''
                 && messageType !== 'definition'
                 && message !== undefined) {
-                ((_a = messages[messageType]) !== null && _a !== void 0 ? _a : (messages[messageType] = [])).push(message);
+                ((_b = messages[messageType]) !== null && _b !== void 0 ? _b : (messages[messageType] = [])).push(message);
             }
             switch (messageType) {
                 case 'lap':
@@ -268,11 +288,14 @@ class FitParser {
         fitObj.activity_metrics = activity_metrics;
         fitObj.user_metrics = user_metrics;
         fitObj.messages = messages;
+        if (rawDeveloperFields) {
+            fitObj.raw_developer_fields = rawDeveloperFields;
+        }
         if (isCascadeNeeded) {
             laps = (0, helper_js_1.mapDataIntoLap)(laps, 'records', records);
             laps = (0, helper_js_1.mapDataIntoLap)(laps, 'lengths', lengths);
             sessions = (0, helper_js_1.mapDataIntoSession)(sessions, laps);
-            fitObj.activity = Object.assign(Object.assign({}, ((_b = fitObj.activity) !== null && _b !== void 0 ? _b : {})), { // ugly but we assume the activity was parsed correctly with all other members correctly
+            fitObj.activity = Object.assign(Object.assign({}, ((_c = fitObj.activity) !== null && _c !== void 0 ? _c : {})), { // ugly but we assume the activity was parsed correctly with all other members correctly
                 sessions,
                 events,
                 hrv,

package/dist/cjs/fit_types.d.ts

@@ -9,6 +9,13 @@ export type Unit<T extends string> = Record<T, {
     multiplier: number;
     offset: number;
 }>;
+export interface ParsedRawDeveloperField {
+    global_message_number: number;
+    message_index: number;
+    developer_data_index: number;
+    field_definition_number: number;
+    raw_value: number[];
+}
 export type Activity = 'manual' | 'auto_multi_sport' | number;
 export type ActivityClass = 'level_max' | 'level' | 'athlete' | number;
 export type ActivityLevel = 'low' | 'medium' | 'high' | number;
@@ -2070,6 +2077,7 @@ export interface ParsedFit {
     protocolVersion?: number;
     profileVersion?: number;
     messages?: ParsedMessages;
+    raw_developer_fields?: ParsedRawDeveloperField[];
     file_creator: ParsedFileCreator;
     device_settings: ParsedDeviceSettings;
     dive_summary?: ParsedDiveSummary;

package/dist/cjs/type_generator.js

@@ -175,6 +175,13 @@ function generateUtilities() {
         ]),
     ]));
     nodes.push(unitType);
+    nodes.push(typescript_1.default.factory.createInterfaceDeclaration([typescript_1.default.factory.createModifier(typescript_1.default.SyntaxKind.ExportKeyword)], 'ParsedRawDeveloperField', undefined, undefined, [
+        generateProperty('global_message_number', typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.NumberKeyword), false),
+        generateProperty('message_index', typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.NumberKeyword), false),
+        generateProperty('developer_data_index', typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.NumberKeyword), false),
+        generateProperty('field_definition_number', typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.NumberKeyword), false),
+        generateArrayProperty('raw_value', typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.NumberKeyword), false),
+    ]));
     return nodes;
 }
 function generateAdditionalFields(msg) {
@@ -258,6 +265,7 @@ function generateFitType() {
         generateProperty('protocolVersion', typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.NumberKeyword)),
         generateProperty('profileVersion', typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.NumberKeyword)),
         generateProperty('messages', typescript_1.default.factory.createTypeReferenceNode('ParsedMessages')),
+        generateArrayProperty('raw_developer_fields', typescript_1.default.factory.createTypeReferenceNode('ParsedRawDeveloperField')),
         ...Object.keys(referenceProperties).map(prop => generateProperty(prop, typescript_1.default.factory.createTypeReferenceNode(snakeToCamel(referenceProperties[prop].replace('?', ''))), referenceProperties[prop].startsWith('?'))),
         ...Object.keys(collectionProperties).map(prop => generateArrayProperty(prop, collectionProperties[prop] === 'unknown'
             ? typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.UnknownKeyword)

package/dist/fit-parser.d.ts

@@ -2,6 +2,7 @@ import type { Buffer } from 'buffer';
 import type { ParsedFit } from './fit_types.js';
 export { FitBaseType, FitEncoder } from './fit-encoder.js';
 export type { FitEncoderField, FitEncoderOptions } from './fit-encoder.js';
+export type { ParsedFit, ParsedRawDeveloperField } from './fit_types.js';
 export interface FitParserOptions {
     force?: boolean;
     speedUnit?: string;
@@ -10,6 +11,8 @@ export interface FitParserOptions {
     elapsedRecordField?: boolean;
     pressureUnit?: string;
     mode?: 'list' | 'cascade' | 'both';
+    /** Retains exact developer-field bytes for all or selected global message numbers. */
+    includeRawDeveloperFields?: boolean | readonly number[];
 }
 type FitParserCallback = (error: string | undefined, data: ParsedFit | undefined) => void;
 export default class FitParser {

package/dist/fit-parser.js

@@ -3,6 +3,7 @@ import { mapDataIntoLap, mapDataIntoSession } from './helper.js';
 export { FitBaseType, FitEncoder } from './fit-encoder.js';
 export default class FitParser {
     constructor(options = {}) {
+        var _a;
         this.options = {
             force: options.force != null ? options.force : true,
             speedUnit: options.speedUnit || 'm/s',
@@ -11,6 +12,7 @@ export default class FitParser {
             elapsedRecordField: options.elapsedRecordField || false,
             pressureUnit: options.pressureUnit || 'bar',
             mode: options.mode || 'list',
+            includeRawDeveloperFields: (_a = options.includeRawDeveloperFields) !== null && _a !== void 0 ? _a : false,
         };
     }
     parseAsync(content) {
@@ -26,7 +28,7 @@ export default class FitParser {
         });
     }
     parse(content, callback) {
-        var _a, _b;
+        var _a, _b, _c;
         const blob = content instanceof ArrayBuffer
             ? new Uint8Array(content)
             : new Uint8Array(content.buffer, content.byteOffset, content.byteLength);
@@ -113,6 +115,11 @@ export default class FitParser {
         const time_in_zone = [];
         const activity_metrics = [];
         const user_metrics = [];
+        const rawDeveloperFields = this.options.includeRawDeveloperFields === true
+            || Array.isArray(this.options.includeRawDeveloperFields)
+            ? []
+            : undefined;
+        const messageCountsByGlobalNumber = new Map();
         let loopIndex = headerLength;
         const messageTypes = [];
         const developerFields = [];
@@ -123,12 +130,25 @@ export default class FitParser {
         let lastStopTimestamp;
         let pausedTime = 0;
         while (loopIndex < crcStart) {
-            const { nextIndex, messageType, message } = readRecord(blob, messageTypes, developerFields, loopIndex, this.options, startDate, pausedTime, dataView, decoderState);
+            const { globalMessageNumber, message, messageType, nextIndex, rawDeveloperFields: recordRawDeveloperFields, } = readRecord(blob, messageTypes, developerFields, loopIndex, this.options, startDate, pausedTime, dataView, decoderState, crcStart);
             loopIndex = nextIndex;
+            if (globalMessageNumber !== undefined) {
+                const messageIndex = (_a = messageCountsByGlobalNumber.get(globalMessageNumber)) !== null && _a !== void 0 ? _a : 0;
+                messageCountsByGlobalNumber.set(globalMessageNumber, messageIndex + 1);
+                recordRawDeveloperFields === null || recordRawDeveloperFields === void 0 ? void 0 : recordRawDeveloperFields.forEach((field) => {
+                    rawDeveloperFields === null || rawDeveloperFields === void 0 ? void 0 : rawDeveloperFields.push({
+                        global_message_number: globalMessageNumber,
+                        message_index: messageIndex,
+                        developer_data_index: field.developerDataIndex,
+                        field_definition_number: field.fieldDefinitionNumber,
+                        raw_value: field.rawValue,
+                    });
+                });
+            }
             if (messageType !== ''
                 && messageType !== 'definition'
                 && message !== undefined) {
-                ((_a = messages[messageType]) !== null && _a !== void 0 ? _a : (messages[messageType] = [])).push(message);
+                ((_b = messages[messageType]) !== null && _b !== void 0 ? _b : (messages[messageType] = [])).push(message);
             }
             switch (messageType) {
                 case 'lap':
@@ -263,11 +283,14 @@ export default class FitParser {
         fitObj.activity_metrics = activity_metrics;
         fitObj.user_metrics = user_metrics;
         fitObj.messages = messages;
+        if (rawDeveloperFields) {
+            fitObj.raw_developer_fields = rawDeveloperFields;
+        }
         if (isCascadeNeeded) {
             laps = mapDataIntoLap(laps, 'records', records);
             laps = mapDataIntoLap(laps, 'lengths', lengths);
             sessions = mapDataIntoSession(sessions, laps);
-            fitObj.activity = Object.assign(Object.assign({}, ((_b = fitObj.activity) !== null && _b !== void 0 ? _b : {})), { // ugly but we assume the activity was parsed correctly with all other members correctly
+            fitObj.activity = Object.assign(Object.assign({}, ((_c = fitObj.activity) !== null && _c !== void 0 ? _c : {})), { // ugly but we assume the activity was parsed correctly with all other members correctly
                 sessions,
                 events,
                 hrv,

package/dist/fit_types.d.ts

@@ -9,6 +9,13 @@ export type Unit<T extends string> = Record<T, {
     multiplier: number;
     offset: number;
 }>;
+export interface ParsedRawDeveloperField {
+    global_message_number: number;
+    message_index: number;
+    developer_data_index: number;
+    field_definition_number: number;
+    raw_value: number[];
+}
 export type Activity = 'manual' | 'auto_multi_sport' | number;
 export type ActivityClass = 'level_max' | 'level' | 'athlete' | number;
 export type ActivityLevel = 'low' | 'medium' | 'high' | number;
@@ -2070,6 +2077,7 @@ export interface ParsedFit {
     protocolVersion?: number;
     profileVersion?: number;
     messages?: ParsedMessages;
+    raw_developer_fields?: ParsedRawDeveloperField[];
     file_creator: ParsedFileCreator;
     device_settings: ParsedDeviceSettings;
     dive_summary?: ParsedDiveSummary;

package/dist/type_generator.js

@@ -154,6 +154,13 @@ export function generateUtilities() {
         ]),
     ]));
     nodes.push(unitType);
+    nodes.push(ts.factory.createInterfaceDeclaration([ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)], 'ParsedRawDeveloperField', undefined, undefined, [
+        generateProperty('global_message_number', ts.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword), false),
+        generateProperty('message_index', ts.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword), false),
+        generateProperty('developer_data_index', ts.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword), false),
+        generateProperty('field_definition_number', ts.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword), false),
+        generateArrayProperty('raw_value', ts.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword), false),
+    ]));
     return nodes;
 }
 function generateAdditionalFields(msg) {
@@ -237,6 +244,7 @@ export function generateFitType() {
         generateProperty('protocolVersion', ts.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword)),
         generateProperty('profileVersion', ts.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword)),
         generateProperty('messages', ts.factory.createTypeReferenceNode('ParsedMessages')),
+        generateArrayProperty('raw_developer_fields', ts.factory.createTypeReferenceNode('ParsedRawDeveloperField')),
         ...Object.keys(referenceProperties).map(prop => generateProperty(prop, ts.factory.createTypeReferenceNode(snakeToCamel(referenceProperties[prop].replace('?', ''))), referenceProperties[prop].startsWith('?'))),
         ...Object.keys(collectionProperties).map(prop => generateArrayProperty(prop, collectionProperties[prop] === 'unknown'
             ? ts.factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword)

package/package.json

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