@dlwiest/ts-tonal-client 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Derrick Wiest
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,84 @@
+# Tonal Client
+
+This repository contains a TypeScript client for accessing Tonal data. It is designed to interact with Tonal's systems to retrieve various types of workout-related data.
+
+
+## Features
+
+- Retrieve detailed workout data by ID.
+- Access shared workouts through share URLs.
+- Fetch movements and other related workout data.
+
+## Installation
+
+To use this client, clone the repository and install the necessary dependencies:
+
+```bash
+git clone https://github.com/dlwiest/ts-tonal-client.git
+cd ts-tonal-client
+npm install
+```
+
+In order to test with the example scripts in `/src/examples` you will need to create a `.env` file based on the formatting described in `.env.sample`.
+Note that your Tonal username is most likely an email address.
+
+## Usage
+
+The client can be used in scripts or applications that require data from Tonal. Here are some examples of how to use the client:
+
+### Get Movements
+
+```typescript
+// Example: Fetching movements
+import { TonalClient } from './src/client';
+
+async function fetchMovements() {
+    const client = await TonalClient.create({ username: 'your_username', password: 'your_password' });
+    const movements = await client.getMovements();
+    console.log(movements);
+}
+
+fetchMovements();
+```
+
+### Get Workout by ID
+
+```typescript
+// Example: Fetching a workout by ID
+import { TonalClient } from './src/client';
+
+async function fetchWorkoutById(workoutId: string) {
+    const client = await TonalClient.create({ username: 'your_username', password: 'your_password' });
+    const workout = await client.getWorkoutById(workoutId);
+    console.log(workout);
+}
+
+fetchWorkoutById('workout_id_here');
+```
+
+### Get Workout by Share URL
+
+```typescript
+// Example: Fetching a workout by its share URL
+import { TonalClient } from './src/client';
+
+async function fetchWorkoutByShareUrl(shareUrl: string) {
+    const client = await TonalClient.create({ username: 'your_username', password: 'your_password' });
+    const workout = await client.getWorkoutByShareUrl(shareUrl);
+    console.log(workout);
+}
+
+fetchWorkoutByShareUrl('https://link.tonal.com/custom-workout/your_workout_id');
+```
+
+## Contributing
+
+Contributions to this project are welcome, especially in the areas of error handling, expanding functionality, and improving the robustness of the client.
+
+## License
+
+This project is open-sourced under the MIT License. See the [LICENSE](LICENSE) file for more details.
+
+## Contact
+
+For any queries or further assistance, please contact [Derrick Wiest](mailto:me@dlwiest.com).

package/dist/client.d.ts

@@ -0,0 +1,16 @@
+import { TonalMovement, TonalSharedWorkout, TonalWorkout } from './types';
+export declare class TonalClient {
+    private username;
+    private password;
+    private idToken;
+    private tokenExpiresAt;
+    private constructor();
+    static create({ username, password }: {
+        username: string;
+        password: string;
+    }): Promise<TonalClient>;
+    private refreshToken;
+    getMovements(): Promise<TonalMovement[]>;
+    getWorkoutById(id: string): Promise<TonalWorkout>;
+    getWorkoutByShareUrl(shareUrl: string): Promise<TonalSharedWorkout>;
+}

package/dist/index.d.ts

@@ -0,0 +1,132 @@
+interface OAuthTokenResponse {
+    access_token: string;
+    id_token: string;
+    refresh_token: string;
+    scope: string;
+    token_type: string;
+    expires_in: number;
+}
+type MuscleGroup = 'Obliques' | 'Abs' | 'Shoulders' | 'Glutes' | 'Back' | 'Biceps' | 'Quads' | 'Triceps' | 'Chest' | 'Hamstrings' | 'Calves' | 'Forearms';
+interface TonalMovement {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    shortName: string;
+    muscleGroups: MuscleGroup[];
+    bodyRegion: string;
+    bodyRegionDisplay: string;
+    baseOfSupport: string;
+    pushPull: string;
+    family: string;
+    familyDisplay: string;
+    inFreeLift: boolean;
+    onMachine: boolean;
+    countReps: boolean;
+    isTwoSided: boolean;
+    isBilateral: boolean;
+    isAlternating: boolean;
+    offMachineAccessory: string;
+    descriptionHow: string;
+    descriptionWhy: string;
+    sortOrder: number;
+    imageAssetId: string;
+    skillLevel: number;
+    active: boolean;
+    featureGroupIds: null | string[];
+    isGeneric: boolean;
+}
+interface TonalWorkout {
+    id: string;
+    createdAt: string;
+    title: string;
+    shortDescription: string;
+    description: string;
+    productionCode: string;
+    assetId: string;
+    coachId: string;
+    sets: WorkoutSet[];
+    duration: number;
+    publishState: string;
+    programId: string | null;
+    level: string;
+    groupIds: string[];
+    targetArea: string;
+    tags: string[] | null;
+    bodyRegions: MuscleGroup[];
+    goalIds: string[] | null;
+    trainingEffectGoals: string[];
+    disableModification: boolean;
+    publishedAt: string;
+    localPublishedAt: string;
+    type: string;
+    userId: string;
+    style: string;
+    trainingType: string;
+    trainingTypeIds: string[] | null;
+    mobileFriendly: boolean;
+    live: boolean;
+    recoveryWeight: boolean;
+    supportedDevices: string[] | null;
+    featureGroupIds: string[] | null;
+    movementIds: string[];
+    muscleGroupsForExclusion: MuscleGroup[] | null;
+    playbackType: string;
+    isImported: boolean;
+}
+interface WorkoutSet {
+    id: string;
+    workoutId: string;
+    blockStart: boolean;
+    movementId: string;
+    prescribedReps: number;
+    repetition: number;
+    repetitionTotal: number;
+    blockNumber: number;
+    burnout: boolean;
+    spotter: boolean;
+    eccentric: boolean;
+    chains: boolean;
+    skipSetup: boolean;
+    skipDemo: boolean;
+    finalSet: boolean;
+    calibration: boolean;
+    practice: boolean;
+    flex: boolean;
+    progressive: boolean;
+    weightPercentage: number;
+    warmUp: boolean;
+    durationBasedRepGoal: number;
+    setGroup: number;
+    round: number;
+    description: string;
+    dropSet: boolean;
+    omitempty: null | any;
+}
+interface TonalSharedWorkout {
+    id: string;
+    sharerUserId: string;
+    parentWorkoutId: string;
+    workoutSnapshotId: string;
+    workoutSnapshotHash: string;
+    deepLinkUrl: string;
+    workoutSnapshot: TonalWorkout;
+}
+
+declare class TonalClient {
+    private username;
+    private password;
+    private idToken;
+    private tokenExpiresAt;
+    private constructor();
+    static create({ username, password }: {
+        username: string;
+        password: string;
+    }): Promise<TonalClient>;
+    private refreshToken;
+    getMovements(): Promise<TonalMovement[]>;
+    getWorkoutById(id: string): Promise<TonalWorkout>;
+    getWorkoutByShareUrl(shareUrl: string): Promise<TonalSharedWorkout>;
+}
+
+export { MuscleGroup, OAuthTokenResponse, TonalMovement, TonalSharedWorkout, TonalWorkout, TonalClient as default };

package/dist/index.esm.js

@@ -0,0 +1,147 @@
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise, SuppressedError, Symbol, Iterator */
+
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+class TonalClient {
+    constructor({ username, password }) {
+        this.username = username;
+        this.password = password;
+        this.idToken = '';
+        this.tokenExpiresAt = 0;
+    }
+    // TonalClient factory
+    static create(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ username, password }) {
+            const client = new TonalClient({ username, password });
+            yield client.refreshToken();
+            return client;
+        });
+    }
+    // Request a new ID token from Auth0
+    refreshToken() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = {
+                username: this.username,
+                password: this.password,
+                client_id: 'ERCyexW-xoVG_Yy3RDe-eV4xsOnRHP6L',
+                grant_type: 'password',
+                scope: 'offline_access',
+            };
+            try {
+                const response = yield fetch('https://tonal.auth0.com/oauth/token', {
+                    method: 'POST',
+                    headers: {
+                        'Content-Type': 'application/json',
+                    },
+                    body: JSON.stringify(data),
+                });
+                if (response.status === 403) {
+                    throw new Error('Invalid username or password');
+                }
+                const json = (yield response.json());
+                this.idToken = json.id_token;
+                this.tokenExpiresAt = Date.now() + json.expires_in * 1000;
+            }
+            catch (e) {
+                console.error(e);
+                throw new Error('Failed to retrieve access token');
+            }
+        });
+    }
+    // Get all movements available on Tonal
+    getMovements() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                if (this.tokenExpiresAt < Date.now()) {
+                    yield this.refreshToken();
+                }
+                const response = yield fetch('https://api.tonal.com/v6/movements', {
+                    headers: {
+                        Authorization: `Bearer ${this.idToken}`,
+                    },
+                });
+                return (yield response.json());
+            }
+            catch (e) {
+                console.error(e);
+                throw new Error('Failed to retrieve movements');
+            }
+        });
+    }
+    // Get a workout by its ID
+    getWorkoutById(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                if (this.tokenExpiresAt < Date.now()) {
+                    yield this.refreshToken();
+                }
+                const response = yield fetch(`https://api.tonal.com/v6/workouts/${id}`, {
+                    headers: {
+                        Authorization: `Bearer ${this.idToken}`,
+                    },
+                });
+                const json = (yield response.json());
+                return json;
+            }
+            catch (e) {
+                console.error(e);
+                throw new Error('Failed to retrieve workout');
+            }
+        });
+    }
+    // Get a workout by its share URL
+    getWorkoutByShareUrl(shareUrl) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!shareUrl) {
+                throw new Error('Share URL is required');
+            }
+            const shareId = shareUrl.split('/').pop();
+            try {
+                if (this.tokenExpiresAt < Date.now()) {
+                    yield this.refreshToken();
+                }
+                const response = yield fetch(`https://api.tonal.com/v6/user-workouts/sharing-records/${shareId}`, {
+                    headers: {
+                        Authorization: `Bearer ${this.idToken}`,
+                    },
+                });
+                const json = (yield response.json());
+                return json;
+            }
+            catch (e) {
+                console.error(e);
+                throw new Error('Failed to retrieve workout');
+            }
+        });
+    }
+}
+
+export { TonalClient as default };

package/dist/index.js

@@ -0,0 +1,149 @@
+'use strict';
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise, SuppressedError, Symbol, Iterator */
+
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+class TonalClient {
+    constructor({ username, password }) {
+        this.username = username;
+        this.password = password;
+        this.idToken = '';
+        this.tokenExpiresAt = 0;
+    }
+    // TonalClient factory
+    static create(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ username, password }) {
+            const client = new TonalClient({ username, password });
+            yield client.refreshToken();
+            return client;
+        });
+    }
+    // Request a new ID token from Auth0
+    refreshToken() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = {
+                username: this.username,
+                password: this.password,
+                client_id: 'ERCyexW-xoVG_Yy3RDe-eV4xsOnRHP6L',
+                grant_type: 'password',
+                scope: 'offline_access',
+            };
+            try {
+                const response = yield fetch('https://tonal.auth0.com/oauth/token', {
+                    method: 'POST',
+                    headers: {
+                        'Content-Type': 'application/json',
+                    },
+                    body: JSON.stringify(data),
+                });
+                if (response.status === 403) {
+                    throw new Error('Invalid username or password');
+                }
+                const json = (yield response.json());
+                this.idToken = json.id_token;
+                this.tokenExpiresAt = Date.now() + json.expires_in * 1000;
+            }
+            catch (e) {
+                console.error(e);
+                throw new Error('Failed to retrieve access token');
+            }
+        });
+    }
+    // Get all movements available on Tonal
+    getMovements() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                if (this.tokenExpiresAt < Date.now()) {
+                    yield this.refreshToken();
+                }
+                const response = yield fetch('https://api.tonal.com/v6/movements', {
+                    headers: {
+                        Authorization: `Bearer ${this.idToken}`,
+                    },
+                });
+                return (yield response.json());
+            }
+            catch (e) {
+                console.error(e);
+                throw new Error('Failed to retrieve movements');
+            }
+        });
+    }
+    // Get a workout by its ID
+    getWorkoutById(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                if (this.tokenExpiresAt < Date.now()) {
+                    yield this.refreshToken();
+                }
+                const response = yield fetch(`https://api.tonal.com/v6/workouts/${id}`, {
+                    headers: {
+                        Authorization: `Bearer ${this.idToken}`,
+                    },
+                });
+                const json = (yield response.json());
+                return json;
+            }
+            catch (e) {
+                console.error(e);
+                throw new Error('Failed to retrieve workout');
+            }
+        });
+    }
+    // Get a workout by its share URL
+    getWorkoutByShareUrl(shareUrl) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!shareUrl) {
+                throw new Error('Share URL is required');
+            }
+            const shareId = shareUrl.split('/').pop();
+            try {
+                if (this.tokenExpiresAt < Date.now()) {
+                    yield this.refreshToken();
+                }
+                const response = yield fetch(`https://api.tonal.com/v6/user-workouts/sharing-records/${shareId}`, {
+                    headers: {
+                        Authorization: `Bearer ${this.idToken}`,
+                    },
+                });
+                const json = (yield response.json());
+                return json;
+            }
+            catch (e) {
+                console.error(e);
+                throw new Error('Failed to retrieve workout');
+            }
+        });
+    }
+}
+
+module.exports = TonalClient;

package/dist/types.d.ts

@@ -0,0 +1,115 @@
+export interface OAuthTokenResponse {
+    access_token: string;
+    id_token: string;
+    refresh_token: string;
+    scope: string;
+    token_type: string;
+    expires_in: number;
+}
+export type MuscleGroup = 'Obliques' | 'Abs' | 'Shoulders' | 'Glutes' | 'Back' | 'Biceps' | 'Quads' | 'Triceps' | 'Chest' | 'Hamstrings' | 'Calves' | 'Forearms';
+export interface TonalMovement {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    shortName: string;
+    muscleGroups: MuscleGroup[];
+    bodyRegion: string;
+    bodyRegionDisplay: string;
+    baseOfSupport: string;
+    pushPull: string;
+    family: string;
+    familyDisplay: string;
+    inFreeLift: boolean;
+    onMachine: boolean;
+    countReps: boolean;
+    isTwoSided: boolean;
+    isBilateral: boolean;
+    isAlternating: boolean;
+    offMachineAccessory: string;
+    descriptionHow: string;
+    descriptionWhy: string;
+    sortOrder: number;
+    imageAssetId: string;
+    skillLevel: number;
+    active: boolean;
+    featureGroupIds: null | string[];
+    isGeneric: boolean;
+}
+export interface TonalWorkout {
+    id: string;
+    createdAt: string;
+    title: string;
+    shortDescription: string;
+    description: string;
+    productionCode: string;
+    assetId: string;
+    coachId: string;
+    sets: WorkoutSet[];
+    duration: number;
+    publishState: string;
+    programId: string | null;
+    level: string;
+    groupIds: string[];
+    targetArea: string;
+    tags: string[] | null;
+    bodyRegions: MuscleGroup[];
+    goalIds: string[] | null;
+    trainingEffectGoals: string[];
+    disableModification: boolean;
+    publishedAt: string;
+    localPublishedAt: string;
+    type: string;
+    userId: string;
+    style: string;
+    trainingType: string;
+    trainingTypeIds: string[] | null;
+    mobileFriendly: boolean;
+    live: boolean;
+    recoveryWeight: boolean;
+    supportedDevices: string[] | null;
+    featureGroupIds: string[] | null;
+    movementIds: string[];
+    muscleGroupsForExclusion: MuscleGroup[] | null;
+    playbackType: string;
+    isImported: boolean;
+}
+interface WorkoutSet {
+    id: string;
+    workoutId: string;
+    blockStart: boolean;
+    movementId: string;
+    prescribedReps: number;
+    repetition: number;
+    repetitionTotal: number;
+    blockNumber: number;
+    burnout: boolean;
+    spotter: boolean;
+    eccentric: boolean;
+    chains: boolean;
+    skipSetup: boolean;
+    skipDemo: boolean;
+    finalSet: boolean;
+    calibration: boolean;
+    practice: boolean;
+    flex: boolean;
+    progressive: boolean;
+    weightPercentage: number;
+    warmUp: boolean;
+    durationBasedRepGoal: number;
+    setGroup: number;
+    round: number;
+    description: string;
+    dropSet: boolean;
+    omitempty: null | any;
+}
+export interface TonalSharedWorkout {
+    id: string;
+    sharerUserId: string;
+    parentWorkoutId: string;
+    workoutSnapshotId: string;
+    workoutSnapshotHash: string;
+    deepLinkUrl: string;
+    workoutSnapshot: TonalWorkout;
+}
+export {};

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@dlwiest/ts-tonal-client",
+  "version": "0.0.1",
+  "description": "TypeScript client for Tonal API",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rollup -c --bundleConfigAsCjs"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dlwiest/ts-tonal-client.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/dlwiest/ts-tonal-client/issues"
+  },
+  "homepage": "https://github.com/dlwiest/ts-tonal-client#readme",
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^11.1.0",
+    "@types/node": "^20.14.8",
+    "rollup": "^3.20.2",
+    "rollup-plugin-dts": "^5.3.1",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.7.0",
+    "typescript": "^5.5.4"
+  }
+}