fit-file-parser 5.2.0 → 6.0.2

package/dist/cjs/binary.js

@@ -14,36 +14,14 @@ const GarminTimeOffset = 631065600000;
 const InvalidFieldData = Symbol('invalid FIT field data');
 const formatTypeMetadata = new Map();
 const uint8CompatibleTypes = new Set(['enum', 'uint8', 'byte']);
-const fitBaseTypeWidths = new Map([
-    [0, 1],
-    [1, 1],
-    [2, 1],
-    [3, 2],
-    [4, 2],
-    [5, 4],
-    [6, 4],
-    [7, 1],
-    [8, 4],
-    [9, 8],
-    [10, 1],
-    [11, 2],
-    [12, 4],
-    [13, 1],
-    [14, 8],
-    [15, 8],
-    [16, 8],
-]);
 function retainsRawMessages(options) {
     return options.includeRawMessages === true
         || Array.isArray(options.includeRawMessages);
 }
-function isValidRawFieldDefinition(size, baseType) {
-    if (size <= 0 || (baseType & 0x60) !== 0) {
-        return false;
-    }
-    const typeId = baseType & 0x1F;
-    const width = fitBaseTypeWidths.get(typeId);
-    return width !== undefined && (typeId === 7 || size % width === 0);
+function retainsRawMessage(options, globalMessageNumber) {
+    return options.includeRawMessages === true
+        || (Array.isArray(options.includeRawMessages)
+            && options.includeRawMessages.includes(globalMessageNumber));
 }
 function baseTypeSize(type) {
     switch (type) {
@@ -486,18 +464,11 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
             rawData: [],
         };
         const message = (0, messages_js_1.getFitMessage)(mTypeDef.globalMessageNumber);
-        const nativeFieldNumbers = new Set();
         for (let i = 0; i < numberOfFields; i++) {
             const fDefIndex = startIndex + 6 + i * 3;
             const baseType = blob[fDefIndex + 2];
             const fieldNumber = blob[fDefIndex];
             const fieldSize = blob[fDefIndex + 1];
-            if (retainsRawMessages(options)
-                && (nativeFieldNumbers.has(fieldNumber)
-                    || !isValidRawFieldDefinition(fieldSize, baseType))) {
-                throw new Error('Invalid FIT native field definition');
-            }
-            nativeFieldNumbers.add(fieldNumber);
             const wireType = fit_js_1.FIT.types.fit_base_type[baseType];
             const { field, type, baseType: profileBaseType, array, scale, offset, units, } = message.getAttributes(blob[fDefIndex]);
             const profileCompatible = areProfileBaseTypesCompatible(profileBaseType, wireType);
@@ -521,15 +492,8 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
             };
             mTypeDef.fieldDefs.push(fDef);
         }
-        const developerFieldNumbers = new Set();
         for (let i = 0; i < numberOfDeveloperDataFields; i++) {
             const fDefIndex = startIndex + 6 + numberOfFields * 3 + 1 + i * 3;
-            const developerFieldKey = `${blob[fDefIndex + 2]}:${blob[fDefIndex]}`;
-            if (retainsRawMessages(options)
-                && (blob[fDefIndex + 1] === 0 || developerFieldNumbers.has(developerFieldKey))) {
-                throw new Error('Invalid FIT developer field definition');
-            }
-            developerFieldNumbers.add(developerFieldKey);
             (_a = mTypeDef.developerFieldDefs) === null || _a === void 0 ? void 0 : _a.push({
                 fieldDefinitionNumber: blob[fDefIndex],
                 size: blob[fDefIndex + 1],
@@ -552,29 +516,20 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
     if (!messageType) {
         throw new Error('FIT data record has no local definition');
     }
-    if (isCompressedTimestamp && retainsRawMessages(options)) {
-        const timestampField = messageType.fieldDefs[0];
-        if (!timestampField
-            || timestampField.fDefNo !== 253
-            || timestampField.size !== 4
-            || (timestampField.baseTypeNo & 0x1F) !== 6) {
-            throw new Error('Invalid FIT compressed timestamp definition');
-        }
-    }
     let messageSize = 0;
     let readDataFromIndex = startIndex + 1;
     const fields = {};
     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 includeRawMessage = options.includeRawMessages === true
-        || (Array.isArray(options.includeRawMessages)
-            && options.includeRawMessages.includes(messageType.globalMessageNumber));
+    const includeRawMessage = retainsRawMessage(options, messageType.globalMessageNumber);
     const includeRawDeveloperFields = options.includeRawDeveloperFields === true
         || (Array.isArray(options.includeRawDeveloperFields)
             && options.includeRawDeveloperFields.includes(messageType.globalMessageNumber));
     const rawFields = includeRawMessage ? [] : undefined;
     const rawDeveloperFields = includeRawDeveloperFields || includeRawMessage ? [] : undefined;
+    const unmappedFields = options.includeUnmappedMessages ? [] : undefined;
+    const unmappedDeveloperFields = options.includeUnmappedMessages ? [] : undefined;
     if (retainsRawMessages(options)) {
         const nativeSize = messageType.fieldDefs.reduce((total, field, index) => (total + (isCompressedTimestamp && index === 0 && field.fDefNo === 253 ? 0 : field.size)), 0);
         const developerSize = developerFieldDefs.reduce((total, field) => total + field.size, 0);
@@ -590,12 +545,17 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
             rawData[i] = InvalidFieldData;
             continue;
         }
-        if (rawFields && readDataFromIndex + fDef.size <= dataEnd) {
-            rawFields.push({
+        if ((rawFields || (unmappedFields && !isOutputFieldName(fDef.name)))
+            && readDataFromIndex + fDef.size <= dataEnd) {
+            const rawField = {
                 fieldDefinitionNumber: fDef.fDefNo,
                 baseType: fDef.baseTypeNo,
                 rawValue: Array.from(blob.subarray(readDataFromIndex, readDataFromIndex + fDef.size)),
-            });
+            };
+            rawFields === null || rawFields === void 0 ? void 0 : rawFields.push(rawField);
+            if (!isOutputFieldName(fDef.name)) {
+                unmappedFields === null || unmappedFields === void 0 ? void 0 : unmappedFields.push(rawField);
+            }
         }
         const data = readData(blob, dataView, fDef, readDataFromIndex);
         if (data !== InvalidFieldData
@@ -619,15 +579,21 @@ 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
+        let rawDeveloperField;
+        if ((rawDeveloperFields
+            || (unmappedDeveloperFields && developerFieldDef.resolvedFieldDef === undefined))
             && readDataFromIndex + developerFieldDef.size <= dataEnd) {
-            rawDeveloperFields.push({
+            rawDeveloperField = {
                 developerDataIndex: developerFieldDef.developerDataIndex,
                 fieldDefinitionNumber: developerFieldDef.fieldDefinitionNumber,
                 rawValue: Array.from(blob.subarray(readDataFromIndex, readDataFromIndex + developerFieldDef.size)),
-            });
+            };
+            rawDeveloperFields === null || rawDeveloperFields === void 0 ? void 0 : rawDeveloperFields.push(rawDeveloperField);
         }
         const fDef = resolveDeveloperFieldDefinition(developerFieldDef, messageType.littleEndian, developerFields, options);
+        if (!fDef && rawDeveloperField) {
+            unmappedDeveloperFields === null || unmappedDeveloperFields === void 0 ? void 0 : unmappedDeveloperFields.push(rawDeveloperField);
+        }
         if (fDef) {
             const data = readData(blob, dataView, fDef, readDataFromIndex);
             if (data !== InvalidFieldData
@@ -745,6 +711,10 @@ function readRecord(blob, messageTypes, developerFields, startIndex, options, st
         message: fields,
         rawFields,
         rawDeveloperFields,
+        unmappedFields: unmappedFields && unmappedFields.length > 0 ? unmappedFields : undefined,
+        unmappedDeveloperFields: unmappedDeveloperFields && unmappedDeveloperFields.length > 0
+            ? unmappedDeveloperFields
+            : undefined,
     };
 }
 function getArrayBuffer(buffer) {

package/dist/cjs/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;
 }

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>>;