fit-file-parser 1.20.0 → 2.0.0

package/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.x, 22.x, 24.x, 25.x]
+
+    steps:
+      - uses: actions/checkout@v6
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v6
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm run build
+      - run: npm run test
+      - run: npm run lint
+        if: matrix.node-version == '25.x'
+      - run: npm run type-check
+        if: matrix.node-version == '25.x'

package/CHANGELOG.md

@@ -1,38 +1,38 @@
 # Change Log
 
 <a name="1.5.4"></a>
+
 ## [1.5.4](https://github.com/jimmykane/fit-parser/compare/v1.0.0...v1.5.3) (2019-03-01)
-* **Features**: HRV, Developer fields, devices and much more
-* **Miscellaneous**: Fix most of the issues parsing fit files
+
+- **Features**: HRV, Developer fields, devices and much more
+- **Miscellaneous**: Fix most of the issues parsing fit files
 
 <a name="1.0.1"></a>
-## [1.0.1](https://github.com/pierremtb/easy-fit/compare/v1.0.0...v1.0.1) (2018-09-18)
 
+## [1.0.1](https://github.com/pierremtb/easy-fit/compare/v1.0.0...v1.0.1) (2018-09-18)
 
 ### 😭 Unclassified (not [following convention](https://github.com/sportheroes/bk-conventional-changelog#types-of-commits))
 
-* **Miscellaneous**: fix: Applied to src/fit offset adjustments from commit 9ed802 ([70b3eb6](https://github.com/pierremtb/easy-fit/commit/70b3eb6) - [JoeTheFkingFrypan](https://github.com/JoeTheFkingFrypan))
-
-
+- **Miscellaneous**: fix: Applied to src/fit offset adjustments from commit 9ed802 ([70b3eb6](https://github.com/pierremtb/easy-fit/commit/70b3eb6) - [JoeTheFkingFrypan](https://github.com/JoeTheFkingFrypan))
 
 <a name="1.0.0"></a>
-# [1.0.0](https://github.com/pierremtb/easy-fit/compare/0.0.7...1.0.0) (2018-09-17)
 
+# [1.0.0](https://github.com/pierremtb/easy-fit/compare/0.0.7...1.0.0) (2018-09-17)
 
 ### 😭 Unclassified (not [following convention](https://github.com/sportheroes/bk-conventional-changelog#types-of-commits))
 
-* **Miscellaneous**: Fix readme typo ([2282c06](https://github.com/pierremtb/easy-fit/commit/2282c06)))
-* **Miscellaneous**: chore: preparing to release fork internally ([3eef5f7](https://github.com/pierremtb/easy-fit/commit/3eef5f7) - [JoeTheFkingFrypan](https://github.com/JoeTheFkingFrypan))
-* **Miscellaneous**: fix: Typo leading to uint16 to never be invalidated ([9ed802c](https://github.com/pierremtb/easy-fit/commit/9ed802c) - [JoeTheFkingFrypan](https://github.com/JoeTheFkingFrypan))
-* **Miscellaneous**: Merge remote-tracking branch 'jenglert/master' ([819d78e](https://github.com/pierremtb/easy-fit/commit/819d78e)))
-* **Miscellaneous**: fix missing buffer dependency and compile dst ([a4b237a](https://github.com/pierremtb/easy-fit/commit/a4b237a)))
-* **Miscellaneous**: Merge remote-tracking branch 'FrostDigital/master' ([6fa9258](https://github.com/pierremtb/easy-fit/commit/6fa9258)))
-* **Miscellaneous**: Makes parsing of fit files with developer defined fields possible (#1) ([9aea666](https://github.com/pierremtb/easy-fit/commit/9aea666))), closes [#1](https://github.com/pierremtb/easy-fit/issues/1)
-* **Miscellaneous**: fix: Adjusted offset for all altitude-related fields ([1ff0fa4](https://github.com/pierremtb/easy-fit/commit/1ff0fa4) - [JoeTheFkingFrypan](https://github.com/JoeTheFkingFrypan))
-* **Miscellaneous**: chore(devices): add forerunner 735 xt ([aacaa04](https://github.com/pierremtb/easy-fit/commit/aacaa04)))
-* **Miscellaneous**: Compile src ([ee4aa00](https://github.com/pierremtb/easy-fit/commit/ee4aa00)))
-* **Miscellaneous**: Add support for other lap types ([dcf42a1](https://github.com/pierremtb/easy-fit/commit/dcf42a1)))
-* **Miscellaneous**: Compile src ([50b9b21](https://github.com/pierremtb/easy-fit/commit/50b9b21)))
-* **Miscellaneous**: Merge remote-tracking branch 'pierremtb/master' ([f7f5ff0](https://github.com/pierremtb/easy-fit/commit/f7f5ff0)))
-* **Miscellaneous**: Add support for more manufacturers ([2d122d2](https://github.com/pierremtb/easy-fit/commit/2d122d2)))
-* **Miscellaneous**: Really compiled last changes on binary.js this time, small details on package.json file -> bumped to 0.0.8 ([e5dc98f](https://github.com/pierremtb/easy-fit/commit/e5dc98f)))
+- **Miscellaneous**: Fix readme typo ([2282c06](https://github.com/pierremtb/easy-fit/commit/2282c06)))
+- **Miscellaneous**: chore: preparing to release fork internally ([3eef5f7](https://github.com/pierremtb/easy-fit/commit/3eef5f7) - [JoeTheFkingFrypan](https://github.com/JoeTheFkingFrypan))
+- **Miscellaneous**: fix: Typo leading to uint16 to never be invalidated ([9ed802c](https://github.com/pierremtb/easy-fit/commit/9ed802c) - [JoeTheFkingFrypan](https://github.com/JoeTheFkingFrypan))
+- **Miscellaneous**: Merge remote-tracking branch 'jenglert/master' ([819d78e](https://github.com/pierremtb/easy-fit/commit/819d78e)))
+- **Miscellaneous**: fix missing buffer dependency and compile dst ([a4b237a](https://github.com/pierremtb/easy-fit/commit/a4b237a)))
+- **Miscellaneous**: Merge remote-tracking branch 'FrostDigital/master' ([6fa9258](https://github.com/pierremtb/easy-fit/commit/6fa9258)))
+- **Miscellaneous**: Makes parsing of fit files with developer defined fields possible (#1) ([9aea666](https://github.com/pierremtb/easy-fit/commit/9aea666))), closes [#1](https://github.com/pierremtb/easy-fit/issues/1)
+- **Miscellaneous**: fix: Adjusted offset for all altitude-related fields ([1ff0fa4](https://github.com/pierremtb/easy-fit/commit/1ff0fa4) - [JoeTheFkingFrypan](https://github.com/JoeTheFkingFrypan))
+- **Miscellaneous**: chore(devices): add forerunner 735 xt ([aacaa04](https://github.com/pierremtb/easy-fit/commit/aacaa04)))
+- **Miscellaneous**: Compile src ([ee4aa00](https://github.com/pierremtb/easy-fit/commit/ee4aa00)))
+- **Miscellaneous**: Add support for other lap types ([dcf42a1](https://github.com/pierremtb/easy-fit/commit/dcf42a1)))
+- **Miscellaneous**: Compile src ([50b9b21](https://github.com/pierremtb/easy-fit/commit/50b9b21)))
+- **Miscellaneous**: Merge remote-tracking branch 'pierremtb/master' ([f7f5ff0](https://github.com/pierremtb/easy-fit/commit/f7f5ff0)))
+- **Miscellaneous**: Add support for more manufacturers ([2d122d2](https://github.com/pierremtb/easy-fit/commit/2d122d2)))
+- **Miscellaneous**: Really compiled last changes on binary.js this time, small details on package.json file -> bumped to 0.0.8 ([e5dc98f](https://github.com/pierremtb/easy-fit/commit/e5dc98f)))

package/CONTRIBUTORS.md

@@ -1,7 +1,9 @@
 #Early prototype and binary manipulations:
 @mlofjard (https://github.com/mlofjard/jsonfit)
 
-#Pull requests: 
+#Pull requests:
+
 - Ian Forsyth (@ianforsyth)
 - Aengus McCullough (@aengus1)
 - Manuel Baun (@Manuelbaun)
+- Robert Schönthal (@digitalkaoz)

package/README.md

@@ -1,8 +1,7 @@
 # fit-file-parser
 
 > Parse your .FIT files easily, directly from JS.
-> Written in ES6. (Hope to change)
-
+> Written in Typescript
 
 ## Install
 
@@ -14,16 +13,18 @@ $ npm install fit-file-parser --save
 
 See in [examples](./examples) folder:
 
-```javascript
-// Require the module
-var FitParser = require('./../dist/fit-file-parser.js').default;
+### using callbacks
 
-// Read a .FIT file
-var fs = require('fs');
-fs.readFile('./example.fit', function (err, content) {
+```javascript
+import fs from 'node:fs/promises'
+import FitParser from 'fit-file-parser'
 
+fs.readFile('./example.fit', (err, content) => {
   // Create a FitParser instance (options argument is optional)
-  var fitParser = new FitParser({
+  if (err) {
+    console.error(err)
+  }
+  const fitParser = new FitParser({
     force: true,
     speedUnit: 'km/h',
     lengthUnit: 'km',
@@ -31,28 +32,39 @@ fs.readFile('./example.fit', function (err, content) {
     pressureUnit: 'bar', // accept bar, cbar and psi (default is bar)
     elapsedRecordField: true,
     mode: 'cascade',
-  });
-  
+  })
+
   // Parse your file
-  fitParser.parse(content, function (error, data) {
-  
+  fitParser.parse(content, (error, data) => {
     // Handle result of parse method
     if (error) {
-      console.log(error);
-    } else {
-      console.log(JSON.stringify(data));
+      console.error(error)
+    }
+    else {
+      console.log(JSON.stringify(data))
     }
-    
-  });
-  
-});
+  })
+})
 ```
 
-## API Documentation
+### using async/await
+
+```javascript
+import fs from 'node:fs/promises'
+import FitParser from 'fit-file-parser'
+
+const buffer = await fs.readFile('./example.fit')
+const fitObject = await fitParser.parseAsync(buffer)
+```
+
+## API Documentation
+
 ### new FitParser(Object _options_)
+
 Needed to create a new instance. _options_ is optional, and is used to customize the returned object.
 
 Allowed properties :
+
 - `mode`: String
   - `cascade`: Returned object is organized as a tree, eg. each lap contains a `records` fields, that is an array of its records (**default**)
   - `list`: Returned object is organized as lists of sessions, laps, records, etc..., without parent-child relation
@@ -77,9 +89,15 @@ Allowed properties :
   - `false` (**default**)
 
 ### fitParser.parse(Buffer _file_, Function _callback_)
+
 _callback_ receives two arguments, the first as a error String, and the second as Object, result of parsing.
 
+### fitParser.parseAsync(Buffer _file_)
+
+returns a Promise that resolves to the result of parsing.
+
 ## Contributors
+
 All started thanks to [Pierre Jacquier](https://github.com/pierremtb)
 
 Big thanks to [Mikael Lofjärd](https://github.com/mlofjard) for [his early prototype](https://github.com/mlofjard/jsonfit).

package/dist/binary.d.ts

@@ -0,0 +1,11 @@
+import type { FitParserOptions } from './fit-parser.js';
+import type { MessageName } from './fit.js';
+import { Buffer } from 'node:buffer';
+export declare function addEndian(littleEndian: boolean, bytes: number[]): number;
+export declare function readRecord(blob: Uint8Array, messageTypes: any[], developerFields: any[], startIndex: number, options: FitParserOptions, startDate: number | undefined, pausedTime: number): {
+    messageType: MessageName | '';
+    nextIndex: number;
+    message?: any;
+};
+export declare function getArrayBuffer(buffer: ArrayBuffer | Buffer): ArrayBuffer;
+export declare function calculateCRC(blob: Uint8Array, start: number, end: number): number;