@dlwiest/ts-tonal-client 0.0.1 → 0.1.0

package/dist/src/types/workouts.d.ts

@@ -0,0 +1,120 @@
+import { MuscleGroup } from './common';
+export type WorkoutPublishState = 'published' | 'archived' | string;
+export 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?: unknown;
+}
+export interface TonalWorkout {
+    id: string;
+    createdAt: string;
+    title: string;
+    shortDescription: string;
+    description: string;
+    productionCode: string;
+    assetId: string;
+    coachId: string;
+    sets: WorkoutSet[];
+    duration: number;
+    publishState: WorkoutPublishState;
+    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[];
+    accessories?: string[];
+    muscleGroupsForExclusion: MuscleGroup[] | null;
+    playbackType: string;
+    isImported: boolean;
+    createdSource?: unknown | null;
+}
+export interface TonalSharedWorkout {
+    id: string;
+    sharerUserId: string;
+    parentWorkoutId: string;
+    workoutSnapshotId: string;
+    workoutSnapshotHash: string;
+    deepLinkUrl: string;
+    workoutSnapshot: TonalWorkout;
+}
+export interface TonalWorkoutEstimateSet {
+    blockStart: boolean;
+    movementId: string;
+    prescribedReps?: number;
+    prescribedDuration?: number;
+    dropSet: boolean;
+    repetition: number;
+    repetitionTotal: number;
+    blockNumber: number;
+    burnout: boolean;
+    spotter: boolean;
+    eccentric: boolean;
+    chains: boolean;
+    flex: boolean;
+    warmUp: boolean;
+    weightPercentage: number;
+    setGroup: number;
+    round: number;
+    description: string;
+}
+export interface TonalWorkoutEstimateResponse {
+    duration: number;
+}
+export interface TonalWorkoutCreateRequest {
+    title: string;
+    sets: TonalWorkoutEstimateSet[];
+    createdSource?: 'WorkoutBuilder' | 'FreeLift' | 'SharedWorkout' | 'DailyLift' | 'TonalWorkout' | 'WorkoutGenerator' | 'ActivityFeed';
+    shortDescription?: string;
+    description?: string;
+}
+export interface TonalWorkoutUpdateRequest {
+    id: string;
+    title: string;
+    description?: string;
+    coachId: string;
+    sets: TonalWorkoutEstimateSet[];
+    level?: string;
+    assetId: string;
+    createdSource?: 'WorkoutBuilder' | 'FreeLift' | 'SharedWorkout' | 'DailyLift' | 'TonalWorkout' | 'WorkoutGenerator' | 'ActivityFeed';
+}

package/dist/src/types.d.ts

@@ -0,0 +1,125 @@
+export interface TonalApiError {
+    error: string;
+    error_description?: string;
+    statusCode?: number;
+}
+export declare class TonalClientError extends Error {
+    readonly statusCode?: number;
+    readonly originalError?: unknown;
+    constructor(message: string, statusCode?: number, originalError?: unknown);
+}
+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?: unknown;
+}
+export interface TonalSharedWorkout {
+    id: string;
+    sharerUserId: string;
+    parentWorkoutId: string;
+    workoutSnapshotId: string;
+    workoutSnapshotHash: string;
+    deepLinkUrl: string;
+    workoutSnapshot: TonalWorkout;
+}
+export {};

package/package.json

@@ -1,23 +1,60 @@
 {
   "name": "@dlwiest/ts-tonal-client",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "TypeScript client for Tonal API",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",
   "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.esm.js",
+      "require": "./dist/index.js"
+    }
+  },
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "rollup -c --bundleConfigAsCjs"
+    "build": "rollup -c --bundleConfigAsCjs",
+    "typecheck": "tsc --noEmit",
+    "dev": "tsc --watch --noEmit",
+    "prepublishOnly": "npm run typecheck && npm run build",
+    "example:movements": "tsx examples/get-movements.ts",
+    "example:movements:save": "tsx examples/get-movements.ts --save",
+    "example:workout:id": "tsx examples/get-workout-by-id.ts",
+    "example:workout:share": "tsx examples/get-workout-by-share-url.ts",
+    "example:user": "tsx examples/get-user-info.ts",
+    "example:goals": "tsx examples/get-goals.ts",
+    "example:user-workouts": "tsx examples/get-user-workouts.ts",
+    "example:estimate": "tsx examples/estimate-workout.ts",
+    "example:create-workout": "tsx examples/create-workout.ts",
+    "example:edit-workout": "tsx examples/edit-workout.ts",
+    "example:delete-workout": "tsx examples/delete-workout.ts",
+    "example:daily-lifts": "tsx examples/get-daily-lifts.ts",
+    "example:training-effect-goals": "tsx examples/get-training-effect-goals.ts",
+    "example:training-types": "tsx examples/get-training-types.ts",
+    "example:goal-metrics": "tsx examples/get-goal-metrics.ts",
+    "example:user-settings": "tsx examples/get-user-settings.ts",
+    "example:daily-metrics": "tsx examples/get-daily-metrics.ts",
+    "example:current-streak": "tsx examples/get-current-streak.ts",
+    "example:activity-summaries": "tsx examples/get-activity-summaries.ts",
+    "example:user-statistics": "tsx examples/get-user-statistics.ts",
+    "example:achievement-stats": "tsx examples/get-achievement-stats.ts",
+    "example:achievements": "tsx examples/get-achievements.ts",
+    "example:home-calendar": "tsx examples/get-home-calendar.ts",
+    "example:muscle-readiness": "tsx examples/get-muscle-readiness.ts",
+    "example:program-by-id": "tsx examples/get-program-by-id.ts",
+    "example:target-scores": "tsx examples/get-target-scores.ts",
+    "example:metric-scores": "tsx examples/get-metric-scores.ts"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/dlwiest/ts-tonal-client.git"
   },
-  "keywords": [],
-  "author": "",
+  "keywords": ["tonal", "tonal-api", "typescript", "client"],
+  "author": "dlwiest",
   "license": "ISC",
   "bugs": {
     "url": "https://github.com/dlwiest/ts-tonal-client/issues"
@@ -26,10 +63,12 @@
   "devDependencies": {
     "@rollup/plugin-typescript": "^11.1.0",
     "@types/node": "^20.14.8",
+    "dotenv": "^16.4.5",
     "rollup": "^3.20.2",
     "rollup-plugin-dts": "^5.3.1",
     "ts-node": "^10.9.2",
     "tslib": "^2.7.0",
+    "tsx": "^4.20.6",
     "typescript": "^5.5.4"
   }
 }