fit-file-parser 4.0.1 → 4.1.0

package/dist/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/type_generator.js

@@ -39,6 +39,9 @@ export function generateArrayProperty(name, type, optional = true) {
     return generateProperty(name, ts.factory.createArrayTypeNode(type), optional);
 }
 export function generateTypeFromField(def) {
+    if (def.array === true) {
+        return ts.factory.createArrayTypeNode(generateTypeFromField(Object.assign(Object.assign({}, def), { array: false })));
+    }
     switch (def.type) {
         case 'uint32_array':
         case 'uint16_array':
@@ -48,6 +51,8 @@ export function generateTypeFromField(def) {
         case 'sint8_array':
         case 'byte_array':
             return ts.factory.createArrayTypeNode(ts.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword));
+        case 'exercise_category_array':
+            return ts.factory.createArrayTypeNode(ts.factory.createTypeReferenceNode('ExerciseCategory'));
         case 'bool':
             return ts.factory.createKeywordTypeNode(ts.SyntaxKind.BooleanKeyword);
         case 'date_time':
@@ -89,11 +94,13 @@ export function generateTypes(types) {
         const names = Object.values(type);
         const typeAlias = ts.factory.createTypeAliasDeclaration([
             ts.factory.createModifier(ts.SyntaxKind.ExportKeyword),
-        ], snakeToCamel(name), undefined, ts.factory.createUnionTypeNode([...names.map(n => ts.factory.createLiteralTypeNode(ts.factory.createStringLiteral(String(n)))), ...(name === 'mesg_num'
-                ? [
-                    ts.factory.createLiteralTypeNode(ts.factory.createStringLiteral('definition')),
-                ]
-                : [])]));
+        ], snakeToCamel(name), undefined, names.length === 0
+            ? ts.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword)
+            : ts.factory.createUnionTypeNode([...names.map(n => ts.factory.createLiteralTypeNode(ts.factory.createStringLiteral(String(n)))), ...(name === 'mesg_num'
+                    ? [
+                        ts.factory.createLiteralTypeNode(ts.factory.createStringLiteral('definition')),
+                    ]
+                    : [])]));
         nodes.push(typeAlias);
     });
     return nodes;
@@ -160,6 +167,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',
         };
@@ -191,6 +199,7 @@ export 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',
@@ -207,15 +216,27 @@ export 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.messages)
+        .filter(message => !existingMessageNames.has(message.name))
+        .map(message => generateProperty(message.name, ts.factory.createTypeReferenceNode(snakeToCamel(`parsed_${message.name}`))));
     return ts.factory.createInterfaceDeclaration([ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)], 'ParsedFit', undefined, undefined, [
         generateProperty('protocolVersion', ts.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword)),
         generateProperty('profileVersion', ts.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword)),
+        generateProperty('messages', ts.factory.createTypeReferenceNode('ParsedMessages')),
         ...Object.keys(referenceProperties).map(prop => generateProperty(prop, ts.factory.createTypeReferenceNode(snakeToCamel(referenceProperties[prop].replace('?', ''))), referenceProperties[prop].startsWith('?'))),
         ...Object.keys(collectionProperties).map(prop => generateArrayProperty(prop, collectionProperties[prop] === 'unknown'
             ? ts.factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword)
             : ts.factory.createTypeReferenceNode(snakeToCamel(collectionProperties[prop])))),
+        ...additionalReferenceProperties,
     ]);
 }
+export function generateParsedMessages(messages) {
+    return ts.factory.createInterfaceDeclaration([ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)], 'ParsedMessages', undefined, undefined, Object.values(messages).map(message => generateArrayProperty(message.name, ts.factory.createTypeReferenceNode(snakeToCamel(`parsed_${message.name}`)))));
+}
 export function generateMessages(messages) {
     const nodes = [];
     Object.keys(messages).forEach((name) => {
@@ -225,11 +246,15 @@ export function generateMessages(messages) {
             ts.factory.createModifier(ts.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),
@@ -251,6 +276,8 @@ export function main() {
     nodes.push(...generateOptions(FIT.options));
     nodes.push(...comment('parsed from Fit.messages'));
     nodes.push(...generateMessages(FIT.messages));
+    nodes.push(...comment('all recognized messages, retained in file order'));
+    nodes.push(generateParsedMessages(FIT.messages));
     nodes.push(...comment('the returned type after parsing a .fit file'));
     nodes.push(generateFitType());
     const nodesArray = ts.factory.createNodeArray(nodes);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "fit-file-parser",
   "type": "module",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "private": false,
   "description": "Parse your .FIT files easily, directly from JS (Garmin, Polar, Suunto)",
   "author": {
@@ -54,10 +54,13 @@
     }
   ],
   "scripts": {
-    "dev": "tsx --watch --watch-path=src/type_generator.ts --watch-path=src/fit.ts codegen/codegen.ts",
-    "codegen": "tsx codegen/codegen.ts",
-    "codegen:check": "tsx codegen/codegen.ts --check",
-    "check": "npm run codegen:check && npm run lint && npm run type-check && npm test -- --run && npm run build",
+    "dev": "tsx --watch --watch-path=src/type_generator.ts --watch-path=src/fit.ts --watch-path=src/garmin_profile.generated.ts codegen/codegen.ts",
+    "codegen:profile": "tsx codegen/garmin-profile.ts",
+    "codegen": "npm run codegen:profile && tsx codegen/codegen.ts",
+    "codegen:check": "tsx codegen/garmin-profile.ts --check && tsx codegen/codegen.ts --check",
+    "profile:audit": "npm run codegen:check && tsx scripts/profile-audit.ts",
+    "corpus:check": "tsx scripts/corpus-check.ts",
+    "check": "npm run profile:audit && npm run lint && npm run type-check && npm test -- --run && npm run build",
     "example-output": "node examples/parse.js examples/example.fit > examples/output-example.json",
     "example-output-tank": "node examples/parse.js examples/example-diving.fit > examples/output-diving.json",
     "example-output-summary-first": "node examples/parse.js examples/triathlon_summary_first.fit > examples/output_summary_first.json",
@@ -77,7 +80,7 @@
   },
   "devDependencies": {
     "@antfu/eslint-config": "^6.2.0",
-    "@garmin/fitsdk": "^21.208.0",
+    "@garmin/fitsdk": "21.208.0",
     "@types/node": "^24.10.1",
     "@vitest/coverage-v8": "^4.0.13",
     "eslint": "^9.10.0",