fit-file-parser 2.0.4 → 2.1.0

package/dist/cjs/fit_types.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ *
+ * this file is auto generated using src/type_generator.ts
+ * it parses the big FIT definition object from src/fit.js into usable typescript types
+ * do not edit this file directly, instead edit the generator and
+ * regenerate it with "npm run codegen"
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/helper.d.ts

@@ -0,0 +1,3 @@
+import type { ParsedLap, ParsedSession } from './fit_types.js';
+export declare function mapDataIntoLap(inputLaps: ParsedLap[], lapKey: 'records' | 'lengths', data: any[]): ParsedLap[];
+export declare function mapDataIntoSession(inputSessions: ParsedSession[], laps: ParsedLap[]): ParsedSession[];

package/dist/cjs/helper.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapDataIntoLap = mapDataIntoLap;
+exports.mapDataIntoSession = mapDataIntoSession;
+function mapDataIntoLap(inputLaps, lapKey, data) {
+    const laps = [...inputLaps];
+    let index = 0;
+    for (let i = 0; i < laps.length; i++) {
+        const lap = laps[i];
+        const nextLap = laps[i + 1];
+        const tempData = [];
+        const lapStartTime = new Date(lap.start_time).getTime();
+        const nextLapStartTime = nextLap
+            ? new Date(nextLap.start_time).getTime()
+            : null;
+        for (let j = index; j < data.length; j++) {
+            const row = data[j];
+            if (nextLap && nextLapStartTime) {
+                const timestamp = new Date(row.timestamp).getTime();
+                if (lapStartTime <= timestamp && nextLapStartTime > timestamp) {
+                    tempData.push(row);
+                }
+                else if (nextLapStartTime <= timestamp) {
+                    index = j;
+                    break;
+                }
+            }
+            else {
+                tempData.push(row);
+            }
+        }
+        if (!laps[i][lapKey]) {
+            laps[i][lapKey] = tempData;
+        }
+    }
+    return laps;
+}
+function mapDataIntoSession(inputSessions, laps) {
+    const sessions = [...inputSessions];
+    let lapIndex = 0;
+    for (let i = 0; i < sessions.length; i++) {
+        const session = sessions[i];
+        const nextSession = sessions[i + 1];
+        const tempLaps = [];
+        const sessionStartTime = new Date(session.start_time).getTime();
+        const nextSessionStartTime = nextSession
+            ? new Date(nextSession.start_time).getTime()
+            : null;
+        for (let j = lapIndex; j < laps.length; j++) {
+            const lap = laps[j];
+            if (nextSession && nextSessionStartTime) {
+                const lapStartTime = new Date(lap.start_time).getTime();
+                if (sessionStartTime <= lapStartTime
+                    && nextSessionStartTime > lapStartTime) {
+                    tempLaps.push(lap);
+                }
+                else if (nextSessionStartTime <= lapStartTime) {
+                    lapIndex = j;
+                    break;
+                }
+            }
+            else {
+                tempLaps.push(lap);
+            }
+        }
+        if (!sessions[i].laps) {
+            sessions[i].laps = tempLaps;
+        }
+    }
+    return sessions;
+}

package/dist/cjs/messages.d.ts

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

package/dist/cjs/messages.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFitMessage = getFitMessage;
+exports.getFitMessageBaseType = getFitMessageBaseType;
+const fit_js_1 = require("./fit.js");
+function getFieldObject(fieldNum, messageNum) {
+    const message = fit_js_1.FIT.messages[messageNum];
+    if (!message) {
+        return {};
+    }
+    return message[fieldNum] || {};
+}
+function getMessageName(messageNum) {
+    const message = fit_js_1.FIT.messages[messageNum];
+    return message ? message.name : '';
+}
+function getFitMessage(messageNum) {
+    return {
+        name: getMessageName(messageNum),
+        getAttributes: (fieldNum) => getFieldObject(fieldNum, messageNum),
+    };
+}
+// TODO
+function getFitMessageBaseType(inp) {
+    return inp;
+}

package/dist/cjs/package.json

@@ -0,0 +1 @@
+{"type": "commonjs"}

package/dist/cjs/type_generator.d.ts

@@ -0,0 +1,26 @@
+import type { PropertySignature, Statement, TypeNode } from 'typescript';
+import type { Message, MessageObject } from './fit.js';
+import ts from 'typescript';
+type SnakeToCamelCase<S extends string> = S extends `${infer T}_${infer U}` ? `${T}${Capitalize<SnakeToCamelCase<U>>}` : S;
+export declare function line(): ts.Node;
+export declare function comment(contents: string): ts.Node[];
+export declare function header(): ts.Node;
+export declare function capitalize<T extends string>(s: T): string;
+export declare function snakeToCamel<T extends string>(s: T): SnakeToCamelCase<Capitalize<T>>;
+export declare function unicodeToChar(text: string): string;
+export declare function generateProperty(name: string, type: TypeNode, optional?: boolean): PropertySignature;
+export declare function generateArrayProperty(name: string, type: TypeNode, optional?: boolean): PropertySignature;
+export declare function generateTypeFromField(def: MessageObject): TypeNode;
+export declare function generateTypes(types: {
+    [typeName: string]: Record<number, string | number>;
+}): Statement[];
+export declare function generateOptions(options: {
+    [typeName: string]: Record<number, string | number>;
+}): ts.Node[];
+export declare function generateUtilities(): Statement[];
+export declare function generateFitType(): Statement;
+export declare function generateMessages(messages: {
+    [messageId: number]: Message;
+}): Statement[];
+export declare function main(): string;
+export {};

package/dist/cjs/type_generator.js

@@ -0,0 +1,263 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.line = line;
+exports.comment = comment;
+exports.header = header;
+exports.capitalize = capitalize;
+exports.snakeToCamel = snakeToCamel;
+exports.unicodeToChar = unicodeToChar;
+exports.generateProperty = generateProperty;
+exports.generateArrayProperty = generateArrayProperty;
+exports.generateTypeFromField = generateTypeFromField;
+exports.generateTypes = generateTypes;
+exports.generateOptions = generateOptions;
+exports.generateUtilities = generateUtilities;
+exports.generateFitType = generateFitType;
+exports.generateMessages = generateMessages;
+exports.main = main;
+const typescript_1 = __importDefault(require("typescript"));
+const fit_js_1 = require("./fit.js");
+function line() {
+    return typescript_1.default.factory.createIdentifier('\n');
+}
+function comment(contents) {
+    return [
+        typescript_1.default.factory.createIdentifier('\n'),
+        typescript_1.default.factory.createIdentifier(`// ${contents}`),
+        typescript_1.default.factory.createIdentifier('\n'),
+    ];
+}
+function header() {
+    return typescript_1.default.factory.createNodeArray([typescript_1.default.factory.createJSDocComment(`
+this file is auto generated using src/type_generator.ts
+it parses the big FIT definition object from src/fit.js into usable typescript types
+do not edit this file directly, instead edit the generator and
+regenerate it with "npm run codegen"
+`)])[0];
+}
+function capitalize(s) {
+    if (s.length === 0) {
+        return s;
+    }
+    return (s[0].toUpperCase() + s.slice(1));
+}
+function snakeToCamel(s) {
+    return s.split('_').map(part => capitalize(part)).join('');
+}
+function unicodeToChar(text) {
+    return text.replace(/\\u[\dA-F]{4}/gi, (match) => {
+        return String.fromCharCode(Number.parseInt(match.replace(/\\u/g, ''), 16));
+    });
+}
+function generateProperty(name, type, optional = true) {
+    return typescript_1.default.factory.createPropertySignature(undefined, typescript_1.default.factory.createIdentifier(name), optional ? typescript_1.default.factory.createToken(typescript_1.default.SyntaxKind.QuestionToken) : undefined, type);
+}
+function generateArrayProperty(name, type, optional = true) {
+    return generateProperty(name, typescript_1.default.factory.createArrayTypeNode(type), optional);
+}
+function generateTypeFromField(def) {
+    switch (def.type) {
+        case 'byte_array':
+            return typescript_1.default.factory.createArrayTypeNode(typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.UnknownKeyword));
+        case 'bool':
+            return typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.BooleanKeyword);
+        case 'date_time':
+        case 'string':
+            return typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.StringKeyword);
+        case 'uint32':
+        case 'uint64':
+        case 'uint16':
+        case 'uint8':
+        case 'int32':
+        case 'int64':
+        case 'int16':
+        case 'int8':
+        case 'sint32':
+        case 'sint16':
+        case 'sint8':
+        case 'float32':
+        case 'float64':
+        case 'uint32z':
+        case 'uint64z':
+        case 'uint16z':
+        case 'uint8z':
+        case 'localtime_into_day':
+        case 'byte':
+        case 'device_index':
+            return typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.NumberKeyword);
+        default:
+            return typescript_1.default.factory.createTypeReferenceNode(snakeToCamel(def.type));
+    }
+}
+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 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'
+                // TODO those are somehow missing in the FIT.types.mesg_num definition
+                // especially 'tank_update' (319 in messages) is mapped to 'tank_pressure' a bug?
+                ? [
+                    typescript_1.default.factory.createLiteralTypeNode(typescript_1.default.factory.createStringLiteral('o_hr_settings')),
+                    typescript_1.default.factory.createLiteralTypeNode(typescript_1.default.factory.createStringLiteral('tank_update')),
+                    typescript_1.default.factory.createLiteralTypeNode(typescript_1.default.factory.createStringLiteral('definition')),
+                ]
+                : [])]));
+        nodes.push(typeAlias);
+    });
+    return nodes;
+}
+function generateOptions(options) {
+    const nodes = [];
+    const optionNames = Object.keys(options);
+    // generate type aliases for each option (all unit values)
+    optionNames.forEach((name) => {
+        const option = options[name];
+        const names = Object.keys(option);
+        const unit = typescript_1.default.factory.createTypeAliasDeclaration([
+            typescript_1.default.factory.createModifier(typescript_1.default.SyntaxKind.ExportKeyword),
+        ], capitalize(name), undefined, typescript_1.default.factory.createUnionTypeNode(names.map(n => typescript_1.default.factory.createLiteralTypeNode(typescript_1.default.factory.createStringLiteral(unicodeToChar(n))))));
+        nodes.push(unit);
+    });
+    nodes.push(line());
+    // generate FitOptions interface which contains all options and their respective types (from above)
+    const fitOptions = typescript_1.default.factory.createInterfaceDeclaration([
+        typescript_1.default.factory.createModifier(typescript_1.default.SyntaxKind.ExportKeyword),
+    ], 'FitOptions', undefined, undefined, [
+        ...optionNames.map(name => generateProperty(name, typescript_1.default.factory.createTypeReferenceNode(typescript_1.default.factory.createIdentifier('Unit'), [typescript_1.default.factory.createTypeReferenceNode(typescript_1.default.factory.createIdentifier(capitalize(name)))]), false)),
+    ]);
+    nodes.push(fitOptions);
+    return nodes;
+}
+function generateUtilities() {
+    const nodes = [];
+    const unitType = typescript_1.default.factory.createTypeAliasDeclaration([typescript_1.default.factory.createModifier(typescript_1.default.SyntaxKind.ExportKeyword)], 'Unit', [typescript_1.default.factory.createTypeParameterDeclaration(undefined, 'T', typescript_1.default.factory.createTypeReferenceNode('string'))], typescript_1.default.factory.createTypeReferenceNode('Record', [
+        typescript_1.default.factory.createTypeReferenceNode('T'),
+        typescript_1.default.factory.createTypeLiteralNode([
+            generateProperty('multiplier', typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.NumberKeyword), false),
+            generateProperty('offset', typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.NumberKeyword), false),
+        ]),
+    ]));
+    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) {
+    if (msg.name === 'lap') {
+        return [
+            generateArrayProperty('records', typescript_1.default.factory.createTypeReferenceNode(snakeToCamel('parsed_record'))),
+            generateArrayProperty('lengths', typescript_1.default.factory.createTypeReferenceNode(snakeToCamel('parsed_length'))),
+        ];
+    }
+    if (msg.name === 'session') {
+        return [
+            generateArrayProperty('laps', typescript_1.default.factory.createTypeReferenceNode(snakeToCamel('parsed_lap'))),
+        ];
+    }
+    if (msg.name === 'activity') {
+        const props = {
+            sessions: 'parsed_session',
+            events: 'parsed_event',
+            hrv: 'parsed_hrv',
+            device_infos: 'parsed_device_info',
+            developer_data_ids: 'parsed_developer_data_id',
+            field_descriptions: 'parsed_field_description',
+            sports: 'parsed_sport',
+        };
+        return Object.keys(props).map(prop => generateArrayProperty(prop, typescript_1.default.factory.createTypeReferenceNode(snakeToCamel(props[prop]))));
+    }
+    return [];
+}
+function generateFitType() {
+    const collectionProperties = {
+        laps: 'parsed_lap',
+        records: 'parsed_record',
+        sessions: 'parsed_session',
+        lengths: 'parsed_length',
+        events: 'parsed_event',
+        device_infos: 'parsed_device_info',
+        developer_data_ids: 'parsed_developer_data_id',
+        field_descriptions: 'parsed_field_description',
+        hrv: 'parsed_hrv',
+        hr_zone: 'parsed_hr_zone',
+        power_zone: 'parsed_power_zone',
+        dive_gases: 'parsed_dive_gas',
+        course_points: 'parsed_course_point',
+        sports: 'parsed_sport',
+        monitors: 'parsed_monitoring',
+        stress: 'parsed_stress_level',
+        file_ids: 'parsed_file_id',
+        monitor_info: 'parsed_monitoring_info',
+        definitions: 'unknown',
+        tank_updates: 'parsed_tank_update',
+        tank_summaries: 'parsed_tank_summary',
+    };
+    const referenceProperties = {
+        file_creator: 'parsed_file_creator',
+        device_settings: 'parsed_device_settings',
+        dive_summary: '?parsed_dive_summary',
+        dive_settings: '?parsed_dive_settings',
+        software: 'parsed_software',
+        user_profile: 'parsed_user_profile',
+        activity: 'parsed_activity',
+        zones_target: '?parsed_zones_target',
+    };
+    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)),
+        ...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])))),
+    ]);
+}
+function generateMessages(messages) {
+    const nodes = [];
+    Object.keys(messages).forEach((name) => {
+        const msg = fit_js_1.FIT.messages[Number(name)];
+        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').map((id) => {
+                const def = msg[Number(id)];
+                return generateProperty(def.field, generateTypeFromField(def), !['start_time', 'timestamp'].includes(def.field));
+            }),
+            ...generateAdditionalFields(msg),
+        ]);
+        nodes.push(messageType);
+    });
+    return nodes;
+}
+function main() {
+    const sourceFile = typescript_1.default.createSourceFile('', '', typescript_1.default.ScriptTarget.Latest);
+    const nodes = [];
+    const printer = typescript_1.default.createPrinter({ newLine: typescript_1.default.NewLineKind.LineFeed });
+    nodes.push(header());
+    nodes.push(...comment('utility types used internally'));
+    nodes.push(...generateUtilities());
+    nodes.push(...comment('parsed from Fit.types'));
+    nodes.push(...generateTypes(fit_js_1.FIT.types));
+    nodes.push(...comment('parsed from Fit.options'));
+    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('the returned type after parsing a .fit file'));
+    nodes.push(generateFitType());
+    const nodesArray = typescript_1.default.factory.createNodeArray(nodes);
+    return printer.printList(typescript_1.default.ListFormat.MultiLine, nodesArray, sourceFile);
+}

package/dist/cjs/types.d.ts

@@ -0,0 +1,55 @@
+export interface ParsedElement {
+    [key: string]: any;
+    message_index?: Record<string, any>;
+}
+export interface ParsedTimestampableElement extends ParsedElement {
+    timestamp: string;
+}
+export interface ParsedLap extends ParsedTimestampableElement {
+    records?: ParsedTimestampableElement[];
+    lengths?: ParsedTimestampableElement[];
+}
+export interface ParsedActivity extends ParsedTimestampableElement {
+    sessions?: ParsedSession[];
+    events?: ParsedTimestampableElement[];
+    hrv?: ParsedHrv[];
+    device_infos?: ParsedTimestampableElement[];
+    developer_data_ids?: any[];
+    field_descriptions?: any[];
+    sports?: ParsedElement[];
+}
+export interface ParsedSession extends ParsedTimestampableElement {
+    laps?: ParsedLap[];
+}
+export interface ParsedHrv {
+    time: number[];
+}
+export interface ParsedFit {
+    protocolVersion: number;
+    profileVersion: number;
+    software?: unknown;
+    user_profile: ParsedElement;
+    laps?: ParsedLap[];
+    records?: ParsedTimestampableElement[];
+    sessions?: ParsedSession[];
+    activity: ParsedActivity;
+    lengths?: ParsedElement[];
+    events?: ParsedTimestampableElement[];
+    device_infos?: ParsedTimestampableElement[];
+    developer_data_ids?: ParsedElement[];
+    field_descriptions?: ParsedElement[];
+    hrv?: ParsedHrv[];
+    hr_zone?: ParsedElement[];
+    power_zone?: ParsedElement[];
+    dive_gases?: ParsedTimestampableElement[];
+    course_points?: ParsedElement[];
+    sports?: ParsedElement[];
+    devices?: ParsedElement[];
+    monitors?: ParsedElement[];
+    stress?: ParsedElement[];
+    file_ids?: ParsedElement[];
+    monitor_info?: ParsedElement[];
+    definitions?: ParsedElement[];
+    tank_updates?: ParsedElement[];
+    tank_summaries?: ParsedElement[];
+}

package/dist/cjs/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/fit-parser.d.ts

@@ -1,4 +1,4 @@
-import type { Buffer } from 'node:buffer';
+import type { Buffer } from 'buffer';
 import type { ParsedFit } from './fit_types.js';
 export interface FitParserOptions {
     force?: boolean;

package/eslint.config.js

@@ -4,4 +4,12 @@ export default antfu({
   type: 'lib',
   gitignore: true,
   ignores: ['**/test/*.json'],
+  stylistic: {
+    indent: 2,
+    quotes: 'single',
+  },
+  formatters: true,
+  rules: {
+    'unicorn/prefer-node-protocol': 'off',
+  },
 })

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "fit-file-parser",
   "type": "module",
-  "version": "2.0.4",
+  "version": "2.1.0",
   "private": false,
   "description": "Parse your .FIT files easily, directly from JS (Garmin, Polar, Suunto)",
   "author": {
@@ -35,10 +35,11 @@
   "exports": {
     ".": {
       "types": "./dist/fit-parser.d.ts",
-      "import": "./dist/fit-parser.js"
+      "import": "./dist/fit-parser.js",
+      "require": "./dist/cjs/fit-parser.js"
     }
   },
-  "main": "dist/fit-parser.js",
+  "main": "dist/cjs/fit-parser.js",
   "maintainers": [
     {
       "email": "jimmykane9@gmail.com",
@@ -58,15 +59,20 @@
     "lint": "eslint .",
     "fmt": "eslint --fix .",
     "type-check": "tsc --noEmit",
-    "build": "tsc --noCheck"
+    "build": "tsc --noCheck && tsc --project tsconfig.cjs.json --noCheck && echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json"
   },
   "test": "vitest",
+  "dependencies": {
+    "buffer": "^6.0.3"
+  },
   "devDependencies": {
     "@antfu/eslint-config": "^6.2.0",
     "@types/node": "^24.10.1",
     "@vitest/coverage-v8": "^4.0.13",
     "eslint": "^9.10.0",
+    "eslint-plugin-format": "^1.1.0",
+    "tsx": "^4.21.0",
     "typescript": "^5.9.3",
     "vitest": "^4.0.13"
   }
-}
+}

package/tsconfig.cjs.json

@@ -0,0 +1,8 @@
+{
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+        "module": "commonjs",
+        "outDir": "./dist/cjs",
+        "verbatimModuleSyntax": false
+    }
+}