fit-file-parser 4.0.2 → 5.0.1

package/dist/cjs/helper.js

@@ -2,21 +2,30 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mapDataIntoLap = mapDataIntoLap;
 exports.mapDataIntoSession = mapDataIntoSession;
+function timestampValue(value) {
+    if (value === undefined || value === null) {
+        return undefined;
+    }
+    const timestamp = value instanceof Date
+        ? value.getTime()
+        : new Date(value).getTime();
+    return Number.isFinite(timestamp) ? timestamp : undefined;
+}
 function mapDataIntoLap(inputLaps, lapKey, data) {
+    var _a;
     const laps = [...inputLaps];
     let index = 0;
     for (let i = 0; i < laps.length; i++) {
         const nextLap = laps[i + 1];
         const tempData = [];
-        const nextLapStartTime = nextLap
-            ? new Date(nextLap.start_time).getTime()
-            : null;
+        const nextLapStartTime = timestampValue(nextLap === null || nextLap === void 0 ? void 0 : nextLap.start_time);
         for (let j = index; j < data.length; j++) {
             const row = data[j];
-            if (nextLap && nextLapStartTime) {
-                const timestamp = new Date(row.timestamp || row.start_time).getTime();
-                if (nextLapStartTime > timestamp) {
+            if (nextLap && nextLapStartTime !== undefined) {
+                const timestamp = timestampValue((_a = row.timestamp) !== null && _a !== void 0 ? _a : row.start_time);
+                if (timestamp === undefined || nextLapStartTime > timestamp) {
                     tempData.push(row);
+                    index = j + 1;
                 }
                 else if (nextLapStartTime <= timestamp) {
                     index = j;
@@ -25,6 +34,7 @@ function mapDataIntoLap(inputLaps, lapKey, data) {
             }
             else {
                 tempData.push(row);
+                index = j + 1;
             }
         }
         if (!laps[i][lapKey]) {
@@ -39,15 +49,14 @@ function mapDataIntoSession(inputSessions, laps) {
     for (let i = 0; i < sessions.length; i++) {
         const nextSession = sessions[i + 1];
         const tempLaps = [];
-        const nextSessionStartTime = nextSession
-            ? new Date(nextSession.start_time).getTime()
-            : null;
+        const nextSessionStartTime = timestampValue(nextSession === null || nextSession === void 0 ? void 0 : nextSession.start_time);
         for (let j = lapIndex; j < laps.length; j++) {
             const lap = laps[j];
-            if (nextSession && nextSessionStartTime) {
-                const lapStartTime = new Date(lap.start_time).getTime();
-                if (nextSessionStartTime > lapStartTime) {
+            if (nextSession && nextSessionStartTime !== undefined) {
+                const lapStartTime = timestampValue(lap.start_time);
+                if (lapStartTime === undefined || nextSessionStartTime > lapStartTime) {
                     tempLaps.push(lap);
+                    lapIndex = j + 1;
                 }
                 else if (nextSessionStartTime <= lapStartTime) {
                     lapIndex = j;
@@ -56,6 +65,7 @@ function mapDataIntoSession(inputSessions, laps) {
             }
             else {
                 tempLaps.push(lap);
+                lapIndex = j + 1;
             }
         }
         if (!sessions[i].laps) {

package/dist/cjs/messages.d.ts

@@ -1,7 +1,6 @@
-import type { MessageObject } from './fit.js';
-import type { MesgNum } from './fit_types.js';
+import type { MessageName, MessageObject } from './fit.js';
 export declare function getFitMessage(messageNum: number): {
-    name: MesgNum | '';
+    name: MessageName | '';
     getAttributes: (fieldNum: number) => MessageObject;
 };
 export declare function getFitMessageBaseType(inp: any): any;

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"));
@@ -58,7 +59,16 @@ function generateProperty(name, type, optional = true) {
 function generateArrayProperty(name, type, optional = true) {
     return generateProperty(name, typescript_1.default.factory.createArrayTypeNode(type), optional);
 }
+function generateNullableArrayType(type) {
+    return typescript_1.default.factory.createArrayTypeNode(typescript_1.default.factory.createParenthesizedType(typescript_1.default.factory.createUnionTypeNode([
+        type,
+        typescript_1.default.factory.createLiteralTypeNode(typescript_1.default.factory.createNull()),
+    ])));
+}
 function generateTypeFromField(def) {
+    if (def.array === true) {
+        return generateNullableArrayType(generateTypeFromField(Object.assign(Object.assign({}, def), { array: false })));
+    }
     switch (def.type) {
         case 'uint32_array':
         case 'uint16_array':
@@ -67,12 +77,15 @@ function generateTypeFromField(def) {
         case 'sint16_array':
         case 'sint8_array':
         case 'byte_array':
-            return typescript_1.default.factory.createArrayTypeNode(typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.NumberKeyword));
-        case 'bool':
-            return typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.BooleanKeyword);
+            return generateNullableArrayType(typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.NumberKeyword));
+        case 'exercise_category_array':
+            return generateNullableArrayType(typescript_1.default.factory.createTypeReferenceNode('ExerciseCategory'));
         case 'date_time':
+        case 'local_date_time':
+            return typescript_1.default.factory.createTypeReferenceNode('Date');
         case 'string':
             return typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.StringKeyword);
+        case 'bool':
         case 'uint32':
         case 'uint64':
         case 'uint16':
@@ -102,18 +115,30 @@ function generateTypes(types) {
     const nodes = [];
     const typeNames = Object.keys(types);
     typeNames.forEach((name) => {
-        if (name === 'message_index') {
-            return;
-        }
         const type = types[name];
-        const names = Object.values(type);
+        const names = [...new Set(Object.values(type))];
+        const isMask = names.includes('mask');
+        const typeNode = isMask
+            ? typescript_1.default.factory.createTypeLiteralNode([
+                generateProperty('value', typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.NumberKeyword), false),
+                ...names
+                    .filter(value => value !== 'mask')
+                    .map(value => generateProperty(String(value), typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.BooleanKeyword), false)),
+            ])
+            : 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')),
+                        ]
+                        : []),
+                    typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.NumberKeyword),
+                ]);
         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, typeNode);
         nodes.push(typeAlias);
     });
     return nodes;
@@ -150,13 +175,6 @@ function generateUtilities() {
         ]),
     ]));
     nodes.push(unitType);
-    const messageIndex = typescript_1.default.factory.createInterfaceDeclaration([typescript_1.default.factory.createModifier(typescript_1.default.SyntaxKind.ExportKeyword)], 'MessageIndex', undefined, undefined, [
-        generateProperty('0', typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.BooleanKeyword), false),
-        generateProperty('value', typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.NumberKeyword), false),
-        generateProperty('reserved', typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.BooleanKeyword), false),
-        generateProperty('selected', typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.BooleanKeyword), false),
-    ]);
-    nodes.push(messageIndex);
     return nodes;
 }
 function generateAdditionalFields(msg) {
@@ -180,6 +198,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 +230,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,31 +247,38 @@ 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) => {
         const msg = fit_js_1.FIT.messages[Number(name)];
-        const usedFields = new Set();
         const messageType = typescript_1.default.factory.createInterfaceDeclaration([
             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) => {
+            ...Object.keys(msg).filter(n => n !== 'name').map((id) => {
                 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)));
-                }
-                return acc;
-            }, []),
+                return generateProperty(def.field, generateTypeFromField(def));
+            }),
             ...generateAdditionalFields(msg),
         ]);
         nodes.push(messageType);
@@ -271,6 +298,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);
@@ -151,8 +163,10 @@ export default class FitParser {
                 case 'record':
                     if (!startDate) {
                         startDate = message.timestamp;
-                        message.elapsed_time = 0;
-                        message.timer_time = 0;
+                        if (this.options.elapsedRecordField) {
+                            message.elapsed_time = 0;
+                            message.timer_time = 0;
+                        }
                     }
                     records.push(message);
                     break;
@@ -205,6 +219,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 +262,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 +286,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,11 @@
 import type { FitOptions, MesgNum } from './fit_types.js';
+export type MessageName = Exclude<MesgNum, number | 'definition'>;
 export interface FieldDefinition {
     type: string | number;
+    rawType?: string | number;
     fDefNo: number;
     size: number;
+    array?: boolean;
     endianAbility: boolean;
     littleEndian: boolean;
     baseTypeNo: number;
@@ -10,6 +13,7 @@ export interface FieldDefinition {
     dataType: string;
     scale?: number | null;
     offset?: number;
+    units?: string;
     requiresBoundedDataView?: boolean;
     developerDataIndex?: number;
     isDeveloperField?: boolean;
@@ -17,22 +21,26 @@ export interface FieldDefinition {
 export interface MessageObject {
     field: string;
     type: string;
+    baseType?: string;
+    array?: boolean;
     scale: number | null;
     offset: number;
     units: string;
 }
 export interface Message {
-    name: MesgNum;
+    name: MessageName;
     [fieldId: number]: MessageObject;
 }
 export interface FitType {
     scConst: number;
     options: FitOptions;
-    messages: {
-        [messageId: number]: Message;
-    };
-    types: {
-        [typeName: string]: Record<number, string | number>;
-    };
+    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;