Sports Lib

https://github.com/sports-alliance/sports-lib
Admin
A library for processing GPX, TCX, FIT, and JSON files from sports activity services such as Strava,...
Tokens:969
Snippets:5
Trust Score:4.3
License:AGPL-3.0
Update:1 year ago
Show doc for...
Tokens:
Raw
### Import GPX File

Source: https://github.com/sports-alliance/sports-lib/blob/develop/README.md

Imports data from a GPX file using its string representation. It requires the DOMParser for XML parsing. The function returns a promise that resolves with an event object containing methods to get distance and duration.

```typescript
import {SportsLib} from '@sports-alliance/sports-lib';
import {DOMParser} from 'xmldom'

// For GPX you need a string 
const gpxString = 'Some string from a file etc';
SportsLib.importFromGPX(gpxString, DOMParser).then((event)=>{
  // do Stuff with the file
  const distance = event.getDistance();
  const duration = event.getDuration();
});
```

--------------------------------

### Convert FIT to GPX using Sports Lib

Source: https://github.com/sports-alliance/sports-lib/blob/develop/README.md

Demonstrates a complete workflow for converting a FIT file to a GPX file. It reads a FIT file using Node.js 'fs', imports it with SportsLib, converts it to GPX format using EventExporterGPX, and writes the resulting GPX string to a new file.

```typescript
import fs from 'fs';
import sportsLibPkg from '@sports-alliance/sports-lib';
import exporterPkg from '@sports-alliance/sports-lib/lib/events/adapters/exporters/exporter.gpx.js'

const { SportsLib } = sportsLibPkg;
const { EventExporterGPX } = exporterPkg;

// Input and output file path
const inputFilePath = '/tmp/test.fit';
const outputGpxFilePath = '/tmp/test.gpx';

// reads the FIT file into memory
const inputFile = fs.readFileSync(inputFilePath, null);
if (!inputFile || !inputFile.buffer) {
    console.error('Ooops, could not read the inputFile or it does not exists, see details below');
    console.error(JSON.stringify(inputFilePath));
    return;
}
const inputFileBuffer = inputFile.buffer;
// uses lib to read the FIT file
SportsLib.importFromFit(inputFileBuffer).then((event) => {
    // convert to gpx
    const gpxPromise = new EventExporterGPX().getAsString(event);
    gpxPromise.then((gpxString) => {
        // writes the gpx to file
        fs.writeFileSync(outputGpxFilePath, gpxString, (wError) => {
            if (wError) {
                console.error('Ooops, something went wrong while saving the GPX file, see details below.');
                console.error(JSON.stringify(wError));
            }
        });
        // all done, celebrate!
        console.log('Converted FIT file to GPX successfully!');
        console.log('GPX file saved here: ' + outputGpxFilePath);
    }).catch((cError) => {
        console.error('Ooops, something went wrong while converting the FIT file, see details below');
        console.error(JSON.stringify(cError));
    });
});
```

--------------------------------

### Import FIT File

Source: https://github.com/sports-alliance/sports-lib/blob/develop/README.md

Imports data from a FIT file, which is expected as an ArrayBuffer (binary data). The function returns a promise that resolves with an event object, allowing retrieval of distance and duration.

```typescript
import {SportsLib} from '@sports-alliance/sports-lib';

// For FIT you need an ArrayBuffer (binary) 
SportsLib.importFromFit(arrayBuffer).then((event)=>{
  // do Stuff with the file
  const distance = event.getDistance();
  const duration = event.getDuration();
});
```

--------------------------------

### Export Event to GPX String

Source: https://github.com/sports-alliance/sports-lib/blob/develop/README.md

Exports an event object to a GPX formatted string. It also demonstrates how to create a Blob object from the exported string with the appropriate file type.

```typescript
// Get an event as seen above
const gpxString = await new EventExporterGPX().getAsString(event);
// Send the blob
const blob = new Blob(
  [jsonString],
  {type: new EventExporterGPX().fileType},
);
```

--------------------------------

### Import TCX File

Source: https://github.com/sports-alliance/sports-lib/blob/develop/README.md

Imports data from a TCX file. The TCX file content is expected as a string which is then parsed into an XML document. The function returns a promise resolving with an event object, from which distance and duration can be extracted.

```typescript
import {SportsLib} from '@sports-alliance/sports-lib';

// For TCX you need a string 
const tcxString = 'Some string from a file etc';
SportsLib.importFromTCX((new DOMParser()).parseFromString(tcxString, 'application/xml')).then((event)=>{
  // do Stuff with the file
  const distance = event.getDistance();
  const duration = event.getDuration();
});
```
Tokens:
Raw