fit-file-parser 5.2.1 → 6.0.2

package/dist/cjs/fit-parser.js

@@ -8,7 +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, _b, _c;
+        var _a, _b, _c, _d;
         this.options = {
             force: options.force != null ? options.force : true,
             speedUnit: options.speedUnit || 'm/s',
@@ -19,7 +19,8 @@ class FitParser {
             mode: options.mode || 'list',
             includeRawDeveloperFields: (_a = options.includeRawDeveloperFields) !== null && _a !== void 0 ? _a : false,
             includeRawMessages: (_b = options.includeRawMessages) !== null && _b !== void 0 ? _b : false,
-            rawMessagesOnly: (_c = options.rawMessagesOnly) !== null && _c !== void 0 ? _c : false,
+            includeUnmappedMessages: (_c = options.includeUnmappedMessages) !== null && _c !== void 0 ? _c : false,
+            rawMessagesOnly: (_d = options.rawMessagesOnly) !== null && _d !== void 0 ? _d : false,
         };
     }
     parseAsync(content) {
@@ -130,6 +131,7 @@ class FitParser {
             || Array.isArray(this.options.includeRawMessages)
             ? []
             : undefined;
+        const unmappedMessages = this.options.includeUnmappedMessages ? [] : undefined;
         const messageCountsByGlobalNumber = new Map();
         let loopIndex = headerLength;
         const messageTypes = [];
@@ -141,7 +143,7 @@ class FitParser {
         let lastStopTimestamp;
         let pausedTime = 0;
         while (loopIndex < crcStart) {
-            const { globalMessageNumber, littleEndian, message, messageType, nextIndex, compressedTimestamp, rawFields: recordRawFields, rawDeveloperFields: recordRawDeveloperFields, } = (0, binary_js_1.readRecord)(blob, messageTypes, developerFields, loopIndex, this.options, startDate, pausedTime, dataView, decoderState, crcStart);
+            const { globalMessageNumber, littleEndian, message, messageType, nextIndex, compressedTimestamp, rawFields: recordRawFields, rawDeveloperFields: recordRawDeveloperFields, unmappedFields: recordUnmappedFields, unmappedDeveloperFields: recordUnmappedDeveloperFields, } = (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;
@@ -168,6 +170,20 @@ class FitParser {
                         raw_value: field.rawValue,
                     });
                 });
+                if (littleEndian !== undefined
+                    && ((recordUnmappedFields === null || recordUnmappedFields === void 0 ? void 0 : recordUnmappedFields.length) || (recordUnmappedDeveloperFields === null || recordUnmappedDeveloperFields === void 0 ? void 0 : recordUnmappedDeveloperFields.length))) {
+                    unmappedMessages === null || unmappedMessages === void 0 ? void 0 : unmappedMessages.push(Object.assign(Object.assign({ global_message_number: globalMessageNumber, message_index: messageIndex, little_endian: littleEndian }, (compressedTimestamp === undefined
+                        ? {}
+                        : { compressed_timestamp: compressedTimestamp })), { fields: (recordUnmappedFields !== null && recordUnmappedFields !== void 0 ? recordUnmappedFields : []).map(field => ({
+                            field_definition_number: field.fieldDefinitionNumber,
+                            base_type: field.baseType,
+                            raw_value: field.rawValue,
+                        })), developer_fields: (recordUnmappedDeveloperFields !== null && recordUnmappedDeveloperFields !== void 0 ? recordUnmappedDeveloperFields : []).map(field => ({
+                            developer_data_index: field.developerDataIndex,
+                            field_definition_number: field.fieldDefinitionNumber,
+                            raw_value: field.rawValue,
+                        })) }));
+                }
             }
             if (this.options.rawMessagesOnly) {
                 continue;
@@ -298,6 +314,9 @@ class FitParser {
             if (rawMessages) {
                 fitObj.raw_messages = rawMessages;
             }
+            if (unmappedMessages && unmappedMessages.length > 0) {
+                fitObj.unmapped_messages = unmappedMessages;
+            }
             callback(undefined, fitObj);
             return;
         }
@@ -326,6 +345,9 @@ class FitParser {
         if (rawMessages) {
             fitObj.raw_messages = rawMessages;
         }
+        if (unmappedMessages && unmappedMessages.length > 0) {
+            fitObj.unmapped_messages = unmappedMessages;
+        }
         if (isCascadeNeeded) {
             laps = (0, helper_js_1.mapDataIntoLap)(laps, 'records', records);
             laps = (0, helper_js_1.mapDataIntoLap)(laps, 'lengths', lengths);

package/dist/cjs/fit.d.ts

@@ -37,10 +37,4 @@ export interface FitType {
     messages: Record<number, Message>;
     types: Record<string, Record<number, string | number>>;
 }
-/**
- * Garmin fields observed in the external FIT corpus but absent from the pinned
- * public SDK profile. These additions may not replace standard SDK fields.
- */
-export declare const FIT_VENDOR_MESSAGE_EXTENSIONS: Record<number, Message>;
-export declare const FIT_VENDOR_TYPE_EXTENSIONS: Record<string, Record<number, string>>;
 export declare const FIT: FitType;

package/dist/cjs/fit.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FIT = exports.FIT_VENDOR_TYPE_EXTENSIONS = exports.FIT_VENDOR_MESSAGE_EXTENSIONS = void 0;
-const garmin_profile_generated_js_1 = require("./garmin_profile.generated.js");
+exports.FIT = void 0;
+const profile_js_1 = require("./profile.js");
 const metersInOneKilometer = 1000;
 const secondsInOneHour = 3600;
 // according to https://en.wikipedia.org/wiki/Mile
@@ -31,119 +31,9 @@ const options = {
         psi: { multiplier: psiInOneBar, offset: 0 },
     },
 };
-/**
- * Garmin fields observed in the external FIT corpus but absent from the pinned
- * public SDK profile. These additions may not replace standard SDK fields.
- */
-exports.FIT_VENDOR_MESSAGE_EXTENSIONS = {
-    18: {
-        name: 'session',
-        178: field('est_sweat_loss', 'uint16', 1, 'ml'),
-        188: field('primary_benefit', 'uint8'),
-        205: field('beginning_potential_stamina', 'uint8', 1, 'percent'),
-        206: field('ending_potential_stamina', 'uint8', 1, 'percent'),
-        207: field('min_stamina', 'uint8', 1, 'percent'),
-    },
-    20: {
-        name: 'record',
-        90: field('garmin_performance_condition', 'sint8'),
-        137: field('potential_stamina', 'uint8', 1, 'percent'),
-        138: field('stamina', 'uint8', 1, 'percent'),
-    },
-    23: {
-        name: 'device_info',
-        24: field('ant_id', 'uint32z'),
-    },
-    // Undocumented Garmin user metrics message observed in activity FIT files.
-    79: {
-        name: 'user_metrics',
-        0: field('vo2_max', 'uint16', 1024 / 3.5, 'ml/kg/min'),
-        1: field('age', 'uint8', 1, 'years'),
-        2: field('height', 'uint8', 100, 'm'),
-        3: field('weight', 'uint16', 10, 'kg'),
-        4: field('gender', 'gender'),
-        6: field('max_heart_rate', 'uint8', 1, 'bpm'),
-        8: field('remaining_recovery_time', 'uint16'),
-        11: field('lthr', 'uint16', 1, 'bpm'),
-        12: field('ltpower', 'uint16', 1, 'watts'),
-        13: field('ltspeed', 'uint16', 1000, 'm/s'),
-        16: field('start_of_activity', 'date_time'),
-        19: field('first_vo2_max', 'uint32', 65536 / 3.5, 'ml/kg/min'),
-        35: field('end_of_previous_activity', 'date_time'),
-        253: field('timestamp', 'date_time'),
-    },
-    // Undocumented Garmin activity metrics message observed in activity FIT files.
-    140: {
-        name: 'activity_metrics',
-        1: field('new_max_heart_rate', 'uint8', 1, 'bpm'),
-        4: field('aerobic_training_effect', 'uint8', 10),
-        7: field('vo2_max', 'uint32', 65536 / 3.5, 'ml/kg/min'),
-        9: field('recovery_time', 'uint16', 1, 'min'),
-        11: field('sport', 'sport'),
-        20: field('anaerobic_training_effect', 'uint8', 10),
-        29: field('first_vo2_max', 'uint32', 65536 / 3.5, 'ml/kg/min'),
-        41: field('primary_benefit', 'uint8'),
-        60: field('total_ascent', 'uint16', 1, 'm'),
-        61: field('total_descent', 'uint16', 1, 'm'),
-        62: field('avg_power', 'uint16', 1, 'watts'),
-        63: field('avg_heart_rate', 'uint8', 1, 'bpm'),
-    },
-    312: {
-        name: 'split',
-        107: field('beginning_potential_stamina', 'uint8', 1, 'percent'),
-        108: field('ending_potential_stamina', 'uint8', 1, 'percent'),
-        109: field('min_stamina', 'uint8', 1, 'percent'),
-    },
-};
-exports.FIT_VENDOR_TYPE_EXTENSIONS = {
-    mesg_num: {
-        79: 'user_metrics',
-        140: 'activity_metrics',
-    },
-};
-function field(name, type, scale = 1, units = '', baseType) {
-    return Object.assign(Object.assign({ field: name, type }, (baseType ? { baseType } : {})), { scale, offset: 0, units });
-}
-function mergeVendorMessages() {
-    const messages = Object.assign({}, garmin_profile_generated_js_1.GARMIN_MESSAGES);
-    Object.entries(exports.FIT_VENDOR_MESSAGE_EXTENSIONS).forEach(([messageIdText, extension]) => {
-        const messageId = Number(messageIdText);
-        const standardMessage = messages[messageId];
-        if (!standardMessage) {
-            messages[messageId] = extension;
-            return;
-        }
-        if (standardMessage.name !== extension.name) {
-            throw new Error(`Vendor message ${messageId} conflicts with the Garmin SDK name`);
-        }
-        Object.keys(extension)
-            .filter(key => key !== 'name')
-            .forEach((fieldId) => {
-            if (standardMessage[Number(fieldId)]) {
-                throw new Error(`Vendor message ${messageId}, field ${fieldId} conflicts with the Garmin SDK profile`);
-            }
-        });
-        messages[messageId] = Object.assign(Object.assign({}, standardMessage), extension);
-    });
-    return messages;
-}
-function mergeVendorTypes() {
-    const types = Object.fromEntries(Object.entries(garmin_profile_generated_js_1.GARMIN_TYPES).map(([name, values]) => [name, Object.assign({}, values)]));
-    Object.entries(exports.FIT_VENDOR_TYPE_EXTENSIONS).forEach(([name, extension]) => {
-        var _a;
-        const standardValues = (_a = types[name]) !== null && _a !== void 0 ? _a : {};
-        Object.keys(extension).forEach((valueId) => {
-            if (standardValues[Number(valueId)] !== undefined) {
-                throw new Error(`Vendor type ${name}, value ${valueId} conflicts with the Garmin SDK profile`);
-            }
-        });
-        types[name] = Object.assign(Object.assign({}, standardValues), extension);
-    });
-    return types;
-}
 exports.FIT = {
     scConst: 180 / Math.pow(2, 31),
     options,
-    messages: mergeVendorMessages(),
-    types: mergeVendorTypes(),
+    messages: profile_js_1.PROFILE_MESSAGES,
+    types: profile_js_1.PROFILE_TYPES,
 };

package/dist/cjs/fit_types.d.ts

@@ -2097,6 +2097,7 @@ export interface ParsedFit {
     messages?: ParsedMessages;
     raw_developer_fields?: ParsedRawDeveloperField[];
     raw_messages?: ParsedRawFitMessage[];
+    unmapped_messages?: ParsedRawFitMessage[];
     file_creator: ParsedFileCreator;
     device_settings: ParsedDeviceSettings;
     dive_summary?: ParsedDiveSummary;

package/dist/cjs/profile.d.ts

@@ -0,0 +1,9 @@
+import type { Message } from './fit.js';
+/**
+ * Static, community-maintained FIT interoperability profile.
+ *
+ * This table is ordinary project source maintained under the repository's MIT
+ * license. See PROFILE.md for the maintenance and verification policy.
+ */
+export declare const PROFILE_MESSAGES: Record<number, Message>;
+export declare const PROFILE_TYPES: Record<string, Record<number, string | number>>;

package/dist/{garmin_profile.generated.js → cjs/profile.js}

@@ -1,10 +1,13 @@
-export const GARMIN_PROFILE_VERSION = {
-    major: 21,
-    minor: 208,
-    patch: 0,
-    type: 'Release',
-};
-export const GARMIN_MESSAGES = {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PROFILE_TYPES = exports.PROFILE_MESSAGES = void 0;
+/**
+ * Static, community-maintained FIT interoperability profile.
+ *
+ * This table is ordinary project source maintained under the repository's MIT
+ * license. See PROFILE.md for the maintenance and verification policy.
+ */
+exports.PROFILE_MESSAGES = {
     0: {
         0: {
             field: 'type',
@@ -2586,6 +2589,13 @@ export const GARMIN_MESSAGES = {
             offset: 0,
             units: 'Breaths/min',
         },
+        178: {
+            field: 'est_sweat_loss',
+            type: 'uint16',
+            scale: 1,
+            offset: 0,
+            units: 'ml',
+        },
         180: {
             field: 'enhanced_min_respiration_rate',
             type: 'uint16',
@@ -2640,6 +2650,13 @@ export const GARMIN_MESSAGES = {
             offset: 0,
             units: 'Flow',
         },
+        188: {
+            field: 'primary_benefit',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: '',
+        },
         192: {
             field: 'workout_feel',
             type: 'uint8',
@@ -2721,6 +2738,27 @@ export const GARMIN_MESSAGES = {
             offset: 0,
             units: 'm',
         },
+        205: {
+            field: 'beginning_potential_stamina',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'percent',
+        },
+        206: {
+            field: 'ending_potential_stamina',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'percent',
+        },
+        207: {
+            field: 'min_stamina',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'percent',
+        },
         208: {
             field: 'avg_core_temperature',
             type: 'uint16',
@@ -4419,6 +4457,13 @@ export const GARMIN_MESSAGES = {
             offset: 0,
             units: 'm',
         },
+        90: {
+            field: 'garmin_performance_condition',
+            type: 'sint8',
+            scale: 1,
+            offset: 0,
+            units: '',
+        },
         91: {
             field: 'absolute_pressure',
             type: 'uint32',
@@ -4626,6 +4671,20 @@ export const GARMIN_MESSAGES = {
             offset: 0,
             units: 'percent',
         },
+        137: {
+            field: 'potential_stamina',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'percent',
+        },
+        138: {
+            field: 'stamina',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'percent',
+        },
         139: {
             field: 'core_temperature',
             type: 'uint16',
@@ -4956,6 +5015,13 @@ export const GARMIN_MESSAGES = {
             offset: 0,
             units: '',
         },
+        24: {
+            field: 'ant_id',
+            type: 'uint32z',
+            scale: 1,
+            offset: 0,
+            units: '',
+        },
         25: {
             field: 'source_type',
             type: 'source_type',
@@ -6398,6 +6464,107 @@ export const GARMIN_MESSAGES = {
         },
         name: 'hrv',
     },
+    79: {
+        0: {
+            field: 'vo2_max',
+            type: 'uint16',
+            scale: 292.57142857142856,
+            offset: 0,
+            units: 'ml/kg/min',
+        },
+        1: {
+            field: 'age',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'years',
+        },
+        2: {
+            field: 'height',
+            type: 'uint8',
+            scale: 100,
+            offset: 0,
+            units: 'm',
+        },
+        3: {
+            field: 'weight',
+            type: 'uint16',
+            scale: 10,
+            offset: 0,
+            units: 'kg',
+        },
+        4: {
+            field: 'gender',
+            type: 'gender',
+            scale: 1,
+            offset: 0,
+            units: '',
+        },
+        6: {
+            field: 'max_heart_rate',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'bpm',
+        },
+        8: {
+            field: 'remaining_recovery_time',
+            type: 'uint16',
+            scale: 1,
+            offset: 0,
+            units: '',
+        },
+        11: {
+            field: 'lthr',
+            type: 'uint16',
+            scale: 1,
+            offset: 0,
+            units: 'bpm',
+        },
+        12: {
+            field: 'ltpower',
+            type: 'uint16',
+            scale: 1,
+            offset: 0,
+            units: 'watts',
+        },
+        13: {
+            field: 'ltspeed',
+            type: 'uint16',
+            scale: 1000,
+            offset: 0,
+            units: 'm/s',
+        },
+        16: {
+            field: 'start_of_activity',
+            type: 'date_time',
+            scale: 1,
+            offset: 0,
+            units: '',
+        },
+        19: {
+            field: 'first_vo2_max',
+            type: 'uint32',
+            scale: 18724.571428571428,
+            offset: 0,
+            units: 'ml/kg/min',
+        },
+        35: {
+            field: 'end_of_previous_activity',
+            type: 'date_time',
+            scale: 1,
+            offset: 0,
+            units: '',
+        },
+        253: {
+            field: 'timestamp',
+            type: 'date_time',
+            scale: 1,
+            offset: 0,
+            units: '',
+        },
+        name: 'user_metrics',
+    },
     80: {
         0: {
             field: 'fractional_timestamp',
@@ -7253,6 +7420,93 @@ export const GARMIN_MESSAGES = {
         },
         name: 'hr',
     },
+    140: {
+        1: {
+            field: 'new_max_heart_rate',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'bpm',
+        },
+        4: {
+            field: 'aerobic_training_effect',
+            type: 'uint8',
+            scale: 10,
+            offset: 0,
+            units: '',
+        },
+        7: {
+            field: 'vo2_max',
+            type: 'uint32',
+            scale: 18724.571428571428,
+            offset: 0,
+            units: 'ml/kg/min',
+        },
+        9: {
+            field: 'recovery_time',
+            type: 'uint16',
+            scale: 1,
+            offset: 0,
+            units: 'min',
+        },
+        11: {
+            field: 'sport',
+            type: 'sport',
+            scale: 1,
+            offset: 0,
+            units: '',
+        },
+        20: {
+            field: 'anaerobic_training_effect',
+            type: 'uint8',
+            scale: 10,
+            offset: 0,
+            units: '',
+        },
+        29: {
+            field: 'first_vo2_max',
+            type: 'uint32',
+            scale: 18724.571428571428,
+            offset: 0,
+            units: 'ml/kg/min',
+        },
+        41: {
+            field: 'primary_benefit',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: '',
+        },
+        60: {
+            field: 'total_ascent',
+            type: 'uint16',
+            scale: 1,
+            offset: 0,
+            units: 'm',
+        },
+        61: {
+            field: 'total_descent',
+            type: 'uint16',
+            scale: 1,
+            offset: 0,
+            units: 'm',
+        },
+        62: {
+            field: 'avg_power',
+            type: 'uint16',
+            scale: 1,
+            offset: 0,
+            units: 'watts',
+        },
+        63: {
+            field: 'avg_heart_rate',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'bpm',
+        },
+        name: 'activity_metrics',
+    },
     142: {
         0: {
             field: 'event',
@@ -11787,6 +12041,27 @@ export const GARMIN_MESSAGES = {
             offset: 0,
             units: 's',
         },
+        107: {
+            field: 'beginning_potential_stamina',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'percent',
+        },
+        108: {
+            field: 'ending_potential_stamina',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'percent',
+        },
+        109: {
+            field: 'min_stamina',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'percent',
+        },
         110: {
             field: 'total_moving_time',
             type: 'uint32',
@@ -13032,7 +13307,7 @@ export const GARMIN_MESSAGES = {
         name: 'sleep_disruption_overnight_severity',
     },
 };
-export const GARMIN_TYPES = {
+exports.PROFILE_TYPES = {
     activity: {
         0: 'manual',
         1: 'auto_multi_sport',
@@ -15762,6 +16037,7 @@ export const GARMIN_TYPES = {
         55: 'monitoring',
         72: 'training_file',
         78: 'hrv',
+        79: 'user_metrics',
         80: 'ant_rx',
         81: 'ant_tx',
         82: 'ant_channel_id',
@@ -15774,6 +16050,7 @@ export const GARMIN_TYPES = {
         129: 'weather_alert',
         131: 'cadence_zone',
         132: 'hr',
+        140: 'activity_metrics',
         142: 'segment_lap',
         145: 'memo_glob',
         148: 'segment_id',

package/dist/cjs/type_generator.js

@@ -285,6 +285,7 @@ function generateFitType() {
         generateProperty('messages', typescript_1.default.factory.createTypeReferenceNode('ParsedMessages')),
         generateArrayProperty('raw_developer_fields', typescript_1.default.factory.createTypeReferenceNode('ParsedRawDeveloperField')),
         generateArrayProperty('raw_messages', typescript_1.default.factory.createTypeReferenceNode('ParsedRawFitMessage')),
+        generateArrayProperty('unmapped_messages', typescript_1.default.factory.createTypeReferenceNode('ParsedRawFitMessage')),
         ...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

@@ -15,6 +15,8 @@ export interface FitParserOptions {
     includeRawDeveloperFields?: boolean | readonly number[];
     /** Retains exact native and developer fields for all or selected global message numbers. */
     includeRawMessages?: boolean | readonly number[];
+    /** Retains exact bytes for fields that have no semantic profile mapping. */
+    includeUnmappedMessages?: boolean;
     /** Returns only parser metadata and retained raw messages instead of decoded activity collections. */
     rawMessagesOnly?: boolean;
 }