fit-file-parser 4.0.1 → 4.1.0

package/dist/cjs/type_generator.d.ts

@@ -19,6 +19,9 @@ export declare function generateOptions(options: {
 }): ts.Node[];
 export declare function generateUtilities(): Statement[];
 export declare function generateFitType(): Statement;
+export declare function generateParsedMessages(messages: {
+    [messageId: number]: Message;
+}): Statement;
 export declare function generateMessages(messages: {
     [messageId: number]: Message;
 }): Statement[];

package/dist/cjs/type_generator.js

@@ -16,6 +16,7 @@ exports.generateTypes = generateTypes;
 exports.generateOptions = generateOptions;
 exports.generateUtilities = generateUtilities;
 exports.generateFitType = generateFitType;
+exports.generateParsedMessages = generateParsedMessages;
 exports.generateMessages = generateMessages;
 exports.main = main;
 const typescript_1 = __importDefault(require("typescript"));
@@ -59,6 +60,9 @@ function generateArrayProperty(name, type, optional = true) {
     return generateProperty(name, typescript_1.default.factory.createArrayTypeNode(type), optional);
 }
 function generateTypeFromField(def) {
+    if (def.array === true) {
+        return typescript_1.default.factory.createArrayTypeNode(generateTypeFromField(Object.assign(Object.assign({}, def), { array: false })));
+    }
     switch (def.type) {
         case 'uint32_array':
         case 'uint16_array':
@@ -68,6 +72,8 @@ function generateTypeFromField(def) {
         case 'sint8_array':
         case 'byte_array':
             return typescript_1.default.factory.createArrayTypeNode(typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.NumberKeyword));
+        case 'exercise_category_array':
+            return typescript_1.default.factory.createArrayTypeNode(typescript_1.default.factory.createTypeReferenceNode('ExerciseCategory'));
         case 'bool':
             return typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.BooleanKeyword);
         case 'date_time':
@@ -109,11 +115,13 @@ function generateTypes(types) {
         const names = Object.values(type);
         const typeAlias = typescript_1.default.factory.createTypeAliasDeclaration([
             typescript_1.default.factory.createModifier(typescript_1.default.SyntaxKind.ExportKeyword),
-        ], snakeToCamel(name), undefined, typescript_1.default.factory.createUnionTypeNode([...names.map(n => typescript_1.default.factory.createLiteralTypeNode(typescript_1.default.factory.createStringLiteral(String(n)))), ...(name === 'mesg_num'
-                ? [
-                    typescript_1.default.factory.createLiteralTypeNode(typescript_1.default.factory.createStringLiteral('definition')),
-                ]
-                : [])]));
+        ], snakeToCamel(name), undefined, names.length === 0
+            ? typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.NumberKeyword)
+            : typescript_1.default.factory.createUnionTypeNode([...names.map(n => typescript_1.default.factory.createLiteralTypeNode(typescript_1.default.factory.createStringLiteral(String(n)))), ...(name === 'mesg_num'
+                    ? [
+                        typescript_1.default.factory.createLiteralTypeNode(typescript_1.default.factory.createStringLiteral('definition')),
+                    ]
+                    : [])]));
         nodes.push(typeAlias);
     });
     return nodes;
@@ -180,6 +188,7 @@ function generateAdditionalFields(msg) {
             developer_data_ids: 'parsed_developer_data_id',
             field_descriptions: 'parsed_field_description',
             sports: 'parsed_sport',
+            sets: 'parsed_set',
             splits: 'parsed_split',
             split_summaries: 'parsed_split_summary',
         };
@@ -211,6 +220,7 @@ function generateFitType() {
         tank_updates: 'parsed_tank_update',
         tank_summaries: 'parsed_tank_summary',
         jumps: 'parsed_jump',
+        sets: 'parsed_set',
         splits: 'parsed_split',
         split_summaries: 'parsed_split_summary',
         time_in_zone: 'parsed_time_in_zone',
@@ -227,15 +237,27 @@ function generateFitType() {
         activity: 'parsed_activity',
         zones_target: '?parsed_zones_target',
     };
+    const existingMessageNames = new Set([
+        ...Object.values(collectionProperties),
+        ...Object.values(referenceProperties),
+    ].map(name => name.replace('?', '').replace(/^parsed_/, '')));
+    const additionalReferenceProperties = Object.values(fit_js_1.FIT.messages)
+        .filter(message => !existingMessageNames.has(message.name))
+        .map(message => generateProperty(message.name, typescript_1.default.factory.createTypeReferenceNode(snakeToCamel(`parsed_${message.name}`))));
     return typescript_1.default.factory.createInterfaceDeclaration([typescript_1.default.factory.createModifier(typescript_1.default.SyntaxKind.ExportKeyword)], 'ParsedFit', undefined, undefined, [
         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')),
         ...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)
             : typescript_1.default.factory.createTypeReferenceNode(snakeToCamel(collectionProperties[prop])))),
+        ...additionalReferenceProperties,
     ]);
 }
+function generateParsedMessages(messages) {
+    return typescript_1.default.factory.createInterfaceDeclaration([typescript_1.default.factory.createModifier(typescript_1.default.SyntaxKind.ExportKeyword)], 'ParsedMessages', undefined, undefined, Object.values(messages).map(message => generateArrayProperty(message.name, typescript_1.default.factory.createTypeReferenceNode(snakeToCamel(`parsed_${message.name}`)))));
+}
 function generateMessages(messages) {
     const nodes = [];
     Object.keys(messages).forEach((name) => {
@@ -245,11 +267,15 @@ function generateMessages(messages) {
             typescript_1.default.factory.createModifier(typescript_1.default.SyntaxKind.ExportKeyword),
         ], snakeToCamel(`parsed_${msg.name}`), undefined, undefined, [
             ...Object.keys(msg).filter(n => n !== 'name').reduce((acc, id) => {
+                var _a;
                 const def = msg[Number(id)];
-                if (!usedFields.has(def.field)) {
-                    usedFields.add(def.field);
-                    acc.push(generateProperty(def.field, generateTypeFromField(def), !['start_time', 'timestamp'].includes(def.field)));
-                }
+                const definitions = [def, ...((_a = def.aliases) !== null && _a !== void 0 ? _a : [])];
+                definitions.forEach((definition) => {
+                    if (!usedFields.has(definition.field)) {
+                        usedFields.add(definition.field);
+                        acc.push(generateProperty(definition.field, generateTypeFromField(definition), !['start_time', 'timestamp'].includes(definition.field)));
+                    }
+                });
                 return acc;
             }, []),
             ...generateAdditionalFields(msg),
@@ -271,6 +297,8 @@ function main() {
     nodes.push(...generateOptions(fit_js_1.FIT.options));
     nodes.push(...comment('parsed from Fit.messages'));
     nodes.push(...generateMessages(fit_js_1.FIT.messages));
+    nodes.push(...comment('all recognized messages, retained in file order'));
+    nodes.push(generateParsedMessages(fit_js_1.FIT.messages));
     nodes.push(...comment('the returned type after parsing a .fit file'));
     nodes.push(generateFitType());
     const nodesArray = typescript_1.default.factory.createNodeArray(nodes);

package/dist/fit-parser.js

@@ -26,23 +26,23 @@ export default class FitParser {
         });
     }
     parse(content, callback) {
-        var _a;
+        var _a, _b;
         const blob = content instanceof ArrayBuffer
             ? new Uint8Array(content)
             : new Uint8Array(content.buffer, content.byteOffset, content.byteLength);
         const dataView = new DataView(blob.buffer, blob.byteOffset, blob.byteLength);
         if (blob.length < 12) {
             callback('File to small to be a FIT file', undefined);
-            if (!this.options.force) {
-                return;
-            }
+            return;
         }
         const headerLength = blob[0];
         if (headerLength !== 14 && headerLength !== 12) {
             callback('Incorrect header size', undefined);
-            if (!this.options.force) {
-                return;
-            }
+            return;
+        }
+        if (blob.length < headerLength) {
+            callback('File to small to be a FIT file', undefined);
+            return;
         }
         let fileTypeString = '';
         for (let i = 8; i < 12; i++) {
@@ -50,29 +50,33 @@ export default class FitParser {
         }
         if (fileTypeString !== '.FIT') {
             callback('Missing \'.FIT\' in header', undefined);
-            if (!this.options.force) {
-                return;
-            }
+            return;
         }
         if (headerLength === 14 && !this.options.force) {
             const crcHeader = blob[12] + (blob[13] << 8);
             const crcHeaderCalc = calculateCRC(blob, 0, 12);
-            if (crcHeader !== crcHeaderCalc) {
-                // callback('Header CRC mismatch', {});
-                // TODO: fix Header CRC check
+            if (crcHeader !== 0 && crcHeader !== crcHeaderCalc) {
+                callback('Header CRC mismatch', undefined);
                 return;
             }
         }
         const protocolVersion = blob[1];
         const profileVersion = blob[2] + (blob[3] << 8);
-        const dataLength = blob[4] + (blob[5] << 8) + (blob[6] << 16) + (blob[7] << 24);
+        const dataLength = dataView.getUint32(4, true);
         const crcStart = dataLength + headerLength;
+        if (crcStart > blob.length) {
+            callback('File data exceeds input length', undefined);
+            return;
+        }
+        if (!this.options.force && crcStart + 2 > blob.length) {
+            callback('File CRC missing', undefined);
+            return;
+        }
         if (!this.options.force) {
             const crcFile = blob[crcStart] + (blob[crcStart + 1] << 8);
-            const crcFileCalc = calculateCRC(blob, headerLength === 12 ? 0 : headerLength, crcStart);
+            const crcFileCalc = calculateCRC(blob, 0, crcStart);
             if (crcFile !== crcFileCalc) {
-                // callback('File CRC mismatch', {});
-                // TODO: fix File CRC check
+                callback('File CRC mismatch', undefined);
                 return;
             }
         }
@@ -80,6 +84,7 @@ export default class FitParser {
             profileVersion,
             protocolVersion,
         };
+        const messages = {};
         let sessions = [];
         let laps = [];
         const records = [];
@@ -102,6 +107,7 @@ export default class FitParser {
         const tank_updates = [];
         const tank_summaries = [];
         const jumps = [];
+        const sets = [];
         const splits = [];
         const split_summaries = [];
         const time_in_zone = [];
@@ -110,14 +116,20 @@ export default class FitParser {
         let loopIndex = headerLength;
         const messageTypes = [];
         const developerFields = [];
+        const decoderState = {};
         const isModeCascade = this.options.mode === 'cascade';
         const isCascadeNeeded = isModeCascade || this.options.mode === 'both';
         let startDate;
         let lastStopTimestamp;
         let pausedTime = 0;
         while (loopIndex < crcStart) {
-            const { nextIndex, messageType, message } = readRecord(blob, messageTypes, developerFields, loopIndex, this.options, startDate, pausedTime, dataView);
+            const { nextIndex, messageType, message } = readRecord(blob, messageTypes, developerFields, loopIndex, this.options, startDate, pausedTime, dataView, decoderState);
             loopIndex = nextIndex;
+            if (messageType !== ''
+                && messageType !== 'definition'
+                && message !== undefined) {
+                ((_a = messages[messageType]) !== null && _a !== void 0 ? _a : (messages[messageType] = [])).push(message);
+            }
             switch (messageType) {
                 case 'lap':
                     laps.push(message);
@@ -205,6 +217,9 @@ export default class FitParser {
                 case 'jump':
                     jumps.push(message);
                     break;
+                case 'set':
+                    sets.push(message);
+                    break;
                 case 'split':
                     splits.push(message);
                     break;
@@ -245,15 +260,17 @@ export default class FitParser {
         fitObj.time_in_zone = time_in_zone;
         fitObj.activity_metrics = activity_metrics;
         fitObj.user_metrics = user_metrics;
+        fitObj.messages = messages;
         if (isCascadeNeeded) {
             laps = mapDataIntoLap(laps, 'records', records);
             laps = mapDataIntoLap(laps, 'lengths', lengths);
             sessions = mapDataIntoSession(sessions, laps);
-            fitObj.activity = Object.assign(Object.assign({}, ((_a = fitObj.activity) !== null && _a !== void 0 ? _a : {})), { // ugly but we assume the activity was parsed correctly with all other members correctly
+            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
                 sessions,
                 events,
                 hrv,
                 device_infos, developer_data_ids: applications, field_descriptions: fieldDescriptions, sports,
+                sets,
                 splits,
                 split_summaries });
         }
@@ -267,6 +284,7 @@ export default class FitParser {
             fitObj.developer_data_ids = applications;
             fitObj.field_descriptions = fieldDescriptions;
             fitObj.hrv = hrv;
+            fitObj.sets = sets;
         }
         callback(undefined, fitObj);
     }

package/dist/fit.d.ts

@@ -1,8 +1,10 @@
 import type { FitOptions, MesgNum } from './fit_types.js';
 export interface FieldDefinition {
     type: string | number;
+    rawType?: string | number;
     fDefNo: number;
     size: number;
+    array?: boolean;
     endianAbility: boolean;
     littleEndian: boolean;
     baseTypeNo: number;
@@ -13,13 +15,17 @@ export interface FieldDefinition {
     requiresBoundedDataView?: boolean;
     developerDataIndex?: number;
     isDeveloperField?: boolean;
+    aliases?: MessageObject[];
 }
 export interface MessageObject {
     field: string;
     type: string;
+    baseType?: string;
+    array?: boolean;
     scale: number | null;
     offset: number;
     units: string;
+    aliases?: MessageObject[];
 }
 export interface Message {
     name: MesgNum;

package/dist/fit.js

@@ -1,3 +1,4 @@
+import { GARMIN_MESSAGES, GARMIN_TYPES } from './garmin_profile.generated.js';
 const metersInOneKilometer = 1000;
 const secondsInOneHour = 3600;
 // according to https://en.wikipedia.org/wiki/Mile
@@ -8,7 +9,7 @@ const psiInOneBar = 14.5037738;
 // which contains all the types and values
 // i would wish for some kind of inference mechanism here but for now we leave it as any
 // maybe zod could help here
-export const FIT = {
+const FIT_OVERRIDES = {
     scConst: 180 / Math.pow(2, 31),
     options: {
         speedUnits: {
@@ -46,6 +47,11 @@ export const FIT = {
             },
         },
         temperatureUnits: {
+            // canonical native temperature unit: degree Celsius [°C]
+            'celsius': {
+                multiplier: 1,
+                offset: 0,
+            },
             // native temperature unit: degree Celsius [°C]
             '°C': {
                 multiplier: 1,
@@ -54,7 +60,7 @@ export const FIT = {
             // kelvin [K]
             'kelvin': {
                 multiplier: 1,
-                offset: -273.15,
+                offset: 273.15,
             },
             // degree fahrenheit [°F]
             'fahrenheit': {
@@ -1794,20 +1800,6 @@ export const FIT = {
                 offset: 0,
                 units: 'percent',
             },
-            214: {
-                field: 'avg_grit',
-                type: 'float32',
-                scale: null,
-                offset: 0,
-                units: '',
-            },
-            215: {
-                field: 'avg_flow',
-                type: 'float32',
-                scale: null,
-                offset: 0,
-                units: '',
-            },
             140: {
                 field: 'recovery_advisor',
                 type: 'uint16', // Minutes?
@@ -4132,22 +4124,25 @@ export const FIT = {
             },
             2: {
                 field: 'distance',
-                type: 'float32',
-                scale: null,
+                type: 'uint32',
+                baseType: 'uint32',
+                scale: 100,
                 offset: 0,
                 units: 'm',
             },
             3: {
                 field: 'cycles',
-                type: 'float32',
-                scale: null,
+                type: 'uint32',
+                baseType: 'uint32',
+                scale: 2,
                 offset: 0,
                 units: 'cycles',
             },
             4: {
                 field: 'active_time',
-                type: 'float32',
-                scale: null,
+                type: 'uint32',
+                baseType: 'uint32',
+                scale: 1000,
                 offset: 0,
                 units: 's',
             },
@@ -4202,28 +4197,33 @@ export const FIT = {
             },
             12: {
                 field: 'temperature',
-                type: 'float32',
-                scale: null,
+                type: 'sint16',
+                baseType: 'sint16',
+                scale: 100,
                 offset: 0,
                 units: 'C',
             },
             14: {
                 field: 'temperature_min',
-                type: 'float32',
-                scale: null,
+                type: 'sint16',
+                baseType: 'sint16',
+                scale: 100,
                 offset: 0,
                 units: 'C',
             },
             15: {
                 field: 'temperature_max',
-                type: 'float32',
-                scale: null,
+                type: 'sint16',
+                baseType: 'sint16',
+                scale: 100,
                 offset: 0,
                 units: 'C',
             },
             16: {
                 field: 'activity_time',
-                type: 'int32',
+                type: 'uint16',
+                baseType: 'uint16',
+                array: true,
                 scale: null,
                 offset: 0,
                 units: '',
@@ -4594,17 +4594,6 @@ export const FIT = {
                 units: '',
             },
         },
-        108: {
-            name: 'o_hr_settings',
-            253: {
-                field: 'timestamp',
-                type: 'date_time',
-                scale: null,
-                offset: 0,
-                units: '',
-            },
-            0: { field: 'enabled', type: 'byte', scale: null, offset: 0, units: '' },
-        },
         140: {
             name: 'activity_metrics',
             1: {
@@ -4739,6 +4728,86 @@ export const FIT = {
                 units: '',
             },
         },
+        225: {
+            name: 'set',
+            254: {
+                field: 'timestamp',
+                type: 'date_time',
+                scale: null,
+                offset: 0,
+                units: '',
+            },
+            0: {
+                field: 'duration',
+                type: 'uint32',
+                scale: 1000,
+                offset: 0,
+                units: 's',
+            },
+            3: {
+                field: 'repetitions',
+                type: 'uint16',
+                scale: null,
+                offset: 0,
+                units: '',
+            },
+            4: {
+                field: 'weight',
+                type: 'uint16',
+                scale: 16,
+                offset: 0,
+                units: 'kg',
+            },
+            5: {
+                field: 'set_type',
+                type: 'set_type',
+                scale: null,
+                offset: 0,
+                units: '',
+            },
+            6: {
+                field: 'start_time',
+                type: 'date_time',
+                scale: null,
+                offset: 0,
+                units: '',
+            },
+            7: {
+                field: 'category',
+                type: 'exercise_category_array',
+                scale: null,
+                offset: 0,
+                units: '',
+            },
+            8: {
+                field: 'category_subtype',
+                type: 'uint16_array',
+                scale: null,
+                offset: 0,
+                units: '',
+            },
+            9: {
+                field: 'weight_display_unit',
+                type: 'fit_base_unit',
+                scale: null,
+                offset: 0,
+                units: '',
+            },
+            10: {
+                field: 'message_index',
+                type: 'message_index',
+                scale: null,
+                offset: 0,
+                units: '',
+            },
+            11: {
+                field: 'wkt_step_index',
+                type: 'message_index',
+                scale: null,
+                offset: 0,
+                units: '',
+            },
+        },
         227: {
             name: 'stress_level',
             0: {
@@ -5200,7 +5269,7 @@ export const FIT = {
                 units: 's',
             },
             4: {
-                field: 'time_in_power_zone',
+                field: 'time_in_cadence_zone',
                 type: 'uint32_array',
                 scale: 1000,
                 offset: 0,
@@ -5228,11 +5297,11 @@ export const FIT = {
                 units: 'm/s',
             },
             8: {
-                field: 'power_zone_high_boundary',
-                type: 'uint16_array',
+                field: 'cadence_zone_high_boundary',
+                type: 'uint8_array',
                 scale: null,
                 offset: 0,
-                units: 'watts',
+                units: 'rpm',
             },
             9: {
                 field: 'power_zone_high_boundary',
@@ -9085,3 +9154,57 @@ export const FIT = {
         },
     },
 };
+function equivalentProfileName(left, right) {
+    return String(left).replace(/_/g, '').toLowerCase()
+        === String(right).replace(/_/g, '').toLowerCase();
+}
+function mergeMessages() {
+    const messages = Object.assign({}, FIT_OVERRIDES.messages);
+    Object.entries(GARMIN_MESSAGES).forEach(([messageId, generatedMessage]) => {
+        const overrideMessage = FIT_OVERRIDES.messages[Number(messageId)];
+        if (!overrideMessage) {
+            messages[Number(messageId)] = generatedMessage;
+            return;
+        }
+        const mergedMessage = Object.assign(Object.assign({}, overrideMessage), generatedMessage);
+        Object.entries(generatedMessage).forEach(([fieldId, generatedField]) => {
+            var _a;
+            if (fieldId === 'name') {
+                return;
+            }
+            const overrideField = overrideMessage[Number(fieldId)];
+            const hasCompatibleName = overrideField
+                && equivalentProfileName(overrideField.field, generatedField.field);
+            mergedMessage[Number(fieldId)] = hasCompatibleName
+                ? Object.assign(Object.assign(Object.assign({}, generatedField), overrideField), { baseType: generatedField.baseType, array: (_a = overrideField.array) !== null && _a !== void 0 ? _a : generatedField.array }) : Object.assign(Object.assign(Object.assign({}, overrideField), generatedField), { aliases: overrideField ? [overrideField] : undefined });
+        });
+        messages[Number(messageId)] = mergedMessage;
+    });
+    return messages;
+}
+function mergeTypes() {
+    const typeNames = new Set([
+        ...Object.keys(GARMIN_TYPES),
+        ...Object.keys(FIT_OVERRIDES.types),
+    ]);
+    return Object.fromEntries([...typeNames].map((typeName) => {
+        var _a, _b;
+        const generatedValues = (_a = GARMIN_TYPES[typeName]) !== null && _a !== void 0 ? _a : {};
+        const overrideValues = (_b = FIT_OVERRIDES.types[typeName]) !== null && _b !== void 0 ? _b : {};
+        const values = Object.assign({}, generatedValues);
+        Object.entries(overrideValues).forEach(([valueId, overrideValue]) => {
+            const generatedValue = generatedValues[Number(valueId)];
+            if (generatedValue === undefined
+                || equivalentProfileName(overrideValue, generatedValue)) {
+                values[Number(valueId)] = overrideValue;
+            }
+        });
+        return [typeName, values];
+    }));
+}
+export const FIT = {
+    scConst: FIT_OVERRIDES.scConst,
+    options: FIT_OVERRIDES.options,
+    messages: mergeMessages(),
+    types: mergeTypes(),
+};