@flow-js/garmin-connect 1.6.3

package/examples/example-gpx-file.js

@@ -0,0 +1,54 @@
+const { GarminConnect } = require('../dist/index');
+const fs = require('fs/promises');
+const path = require('path');
+
+const GPX_FILE_NAME = 'paris-marathon.gpx';
+const GPX_FILE_FOLDER = './assets/';
+
+(async function () {
+    const GARMIN_USERNAME = process.env.GARMIN_USERNAME;
+    const GARMIN_PASSWORD = process.env.GARMIN_PASSWORD;
+
+    if (!GARMIN_USERNAME || !GARMIN_PASSWORD) {
+        throw new Error(
+            'GARMIN_USERNAME and GARMIN_PASSWORD must be set in the environment variables'
+        );
+    }
+
+    const GCClient = new GarminConnect({
+        username: GARMIN_USERNAME,
+        password: GARMIN_PASSWORD
+    });
+    await GCClient.login();
+
+    const fileContent = (
+        await fs.readFile(path.join(GPX_FILE_FOLDER, GPX_FILE_NAME), 'utf8')
+    ).toString();
+
+    const response = await GCClient.importGpx(GPX_FILE_NAME, fileContent);
+
+    const createCourseResponse = await GCClient.createCourse(
+        1,
+        response.courseName,
+        response.geoPoints,
+        response.coursePoints
+    );
+
+    console.log(
+        'Course created with id:',
+        createCourseResponse.courseId,
+        `https://connect.garmin.com/modern/course/${createCourseResponse.courseId}`
+    );
+
+    const listCourses = await GCClient.listCourses();
+    console.log(
+        'Last course:',
+        listCourses.coursesForUser[0].courseId,
+        listCourses.coursesForUser[0].courseName
+    );
+
+    const downloadGpx = await GCClient.exportCourseAsGpx(
+        createCourseResponse.courseId
+    );
+    console.log('Downloaded GPX size:', downloadGpx.length);
+})();

package/examples/example-workout.js

@@ -0,0 +1,162 @@
+const {
+    GarminConnect,
+    CadenceTarget,
+    CaloriesDuration,
+    DistanceDuration,
+    HeartRateDuration,
+    HrmTarget,
+    HrmZoneTarget,
+    LapPressDuration,
+    PaceTarget,
+    PowerZone,
+    PowerZoneTarget,
+    TimeDuration,
+    WorkoutBuilder,
+    Step,
+    NoTarget,
+    StepType,
+    WorkoutType
+} = require('garmin-connect');
+
+(async function () {
+    const GARMIN_USERNAME = process.env.GARMIN_USERNAME;
+    const GARMIN_PASSWORD = process.env.GARMIN_PASSWORD;
+
+    if (!GARMIN_USERNAME || !GARMIN_PASSWORD) {
+        throw new Error(
+            'GARMIN_USERNAME and GARMIN_PASSWORD must be set in the environment variables'
+        );
+    }
+
+    const wb = new WorkoutBuilder(
+        WorkoutType.Running,
+        'Workout running ' + new Date().toISOString()
+    );
+
+    /**
+     * There are multiple StepTypes: WarmUp, Run, Recovery, Rest, Cooldown, Other
+     */
+    wb.addStep(
+        new Step(
+            StepType.Run,
+            TimeDuration.fromSeconds(45),
+            new NoTarget(),
+            'Comment for the step: Run for 45 seconds'
+        )
+    );
+
+    wb.addStep(
+        new Step(
+            StepType.Recovery,
+            TimeDuration.hhmmss(0, 1, 30),
+            new NoTarget(),
+            'Comment for the step: Run for 1 minute 30 seconds'
+        )
+    );
+
+    /** There are multiple durations: TimeDuration, DistanceDuration, HeartRateDuration, CaloriesDuration, LapPressDuration */
+    wb.addStep(
+        new Step(
+            StepType.Run,
+            DistanceDuration.fromKilometers(2),
+            new NoTarget(),
+            'Run for 2km'
+        )
+    );
+
+    wb.addStep(
+        new Step(
+            StepType.WarmUp,
+            HeartRateDuration.greaterThan(130),
+            new NoTarget(),
+            'Warm up until HR > 130 bpm'
+        )
+    );
+
+    wb.addStep(
+        new Step(
+            StepType.Cooldown,
+            new LapPressDuration(),
+            new NoTarget(),
+            'Cooldown for as long as you need'
+        )
+    );
+
+    wb.addStep(
+        new Step(
+            StepType.Rest,
+            new CaloriesDuration(200),
+            new NoTarget(),
+            'Rest until you burned 200 calories'
+        )
+    );
+
+    /**
+     * There are multiple targets: PaceTarget, HrmZoneTarget, HrmTarget, PowerZoneTarget, PowerZone, CadenceTarget, NoTarget
+     */
+    wb.addStep(
+        new Step(
+            StepType.Run,
+            TimeDuration.fromSeconds(30),
+            PaceTarget.pace(5, 30, 10),
+            'Run at 5:30 min/km pace (+- 10 sec) for 30 seconds'
+        )
+    );
+
+    wb.addStep(
+        new Step(
+            StepType.Run,
+            TimeDuration.fromSeconds(30),
+            new HrmZoneTarget(5),
+            'Run at HR zone 5 for 30 seconds'
+        )
+    );
+
+    wb.addStep(
+        new Step(
+            StepType.Run,
+            TimeDuration.fromSeconds(30),
+            HrmTarget.hrm(150, 10),
+            'Run at HR 150 bpm (+- 10 bpm) for 30 seconds'
+        )
+    );
+
+    wb.addStep(
+        new Step(
+            StepType.Run,
+            TimeDuration.fromSeconds(30),
+            new PowerZoneTarget(3),
+            'Run at Power zone 3 for 30 seconds'
+        )
+    );
+
+    wb.addStep(
+        new Step(
+            StepType.Run,
+            TimeDuration.fromSeconds(30),
+            PowerZone.power(250, 20),
+            'Run at Power 250 watts (+- 20 watts) for 30 seconds'
+        )
+    );
+
+    wb.addStep(
+        new Step(
+            StepType.Run,
+            TimeDuration.fromSeconds(30),
+            CadenceTarget.cadence(80, 5),
+            'Run at Cadence 80 rpm (+- 5 rpm) for 30 seconds'
+        )
+    );
+
+    const workout = wb.build();
+
+    // Save workout to Garmin Connect
+    const GCClient = new GarminConnect({
+        username: GARMIN_USERNAME,
+        password: GARMIN_PASSWORD
+    });
+
+    await GCClient.login();
+
+    await GCClient.createWorkout(workout);
+})();

package/examples/example.js

@@ -0,0 +1,34 @@
+const { GarminConnect } = require('garmin-connect');
+
+// Has to be run in an async function to be able to use the await keyword
+const main = async () => {
+    // Create a new Garmin Connect Client
+    const GCClient = new GarminConnect({
+        username: 'your-email',
+        password: 'your-password'
+    });
+
+    // TODO: Test China Domain
+    // China Domain
+    // const GCClient = new GarminConnect({
+    //     username: 'your-email',
+    //     password: 'your-password'
+    // }, 'garmin.cn');
+
+    // Uses credentials from garmin.config.json or uses supplied params
+    await GCClient.login();
+
+    // // Get user info
+    // const info = await GCClient.getUserInfo();
+
+    // Log info to make sure signin was successful
+    // console.log(info);
+    // // Get user settings
+    const settings = await GCClient.getUserSettings();
+
+    // Log info to make sure signin was successful
+    console.log(settings);
+};
+
+// Run the code
+main();

package/package.json

@@ -0,0 +1,67 @@
+{
+    "name": "@flow-js/garmin-connect",
+    "version": "1.6.3",
+    "description": "Makes it simple to interface with Garmin Connect to get or set any data point",
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "scripts": {
+        "build": "tsc --build --clean && find ./dist -type d -empty -delete; tsc",
+        "build:windows": "tsc --build --clean && tsc",
+        "build:watch": "npm run build -- --watch",
+        "build:watch-windows": "npm run build:windows -- --watch",
+        "prettier:all": "prettier --write .",
+        "pretty": "pretty-quick --staged",
+        "prepack": "npm run build"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/florianpasteur/garmin-connect.git"
+    },
+    "keywords": [
+        "garmin",
+        "connect",
+        "scraper",
+        "weight",
+        "running",
+        "workout",
+        "activity",
+        "activities",
+        "download",
+        "downloader"
+    ],
+    "author": "Oskar Bernberg (Pythe1337N)",
+    "license": "MIT",
+    "files": [
+        "dist/*",
+        "examples/*"
+    ],
+    "devDependencies": {
+        "@types/app-root-path": "^1.2.4",
+        "@types/lodash": "^4.14.199",
+        "@types/luxon": "^3.3.2",
+        "@types/node": "^18.11.15",
+        "@types/qs": "^6.9.7",
+        "@types/request-promise": "^4.1.48",
+        "pre-commit": "^1.2.2",
+        "prettier": "^2.8.1",
+        "pretty-quick": "^3.1.3",
+        "ts-node": "^10.9.2",
+        "typescript": "^4.9.4"
+    },
+    "homepage": "https://github.com/florianpasteur/garmin-connect#readme",
+    "bugs": {
+        "url": "https://github.com/florianpasteur/garmin-connect/issues"
+    },
+    "runkitExampleFilename": "./examples/example.js",
+    "dependencies": {
+        "app-root-path": "^3.1.0",
+        "axios": "^1.5.1",
+        "crypto": "^1.0.1",
+        "form-data": "^4.0.0",
+        "lodash": "^4.17.21",
+        "luxon": "^3.4.3",
+        "oauth-1.0a": "^2.2.6",
+        "qs": "^6.11.2"
+    },
+    "pre-commit": "pretty"
+}