@dlwiest/ts-tonal-client 0.2.0 → 0.3.0

package/dist/src/services/user-service.d.ts

@@ -1,51 +0,0 @@
-import { HttpClient } from '../http/http-client';
-import { TonalUserInfo, TonalGoal, TonalTrainingEffectGoalsResponse, TonalTrainingType, TonalGoalMetric, TonalDeviceRegistration, TonalUserDevice, TonalUserPermissions, TonalUserSettings, TonalDailyMetrics, TonalCurrentStreak, TonalActivitySummary, TonalUserStatistics, TonalAchievementStats, TonalEarnedAchievement, TonalHomeCalendar, TonalMuscleReadiness, TonalProgram, TonalTargetScoresResponse, TonalMetricScoresResponse } from '../types';
-export declare class UserService {
-    private httpClient;
-    constructor(httpClient: HttpClient);
-    getUserInfo(): Promise<TonalUserInfo>;
-    getGoals(): Promise<TonalGoal[]>;
-    getTrainingEffectGoals(): Promise<TonalTrainingEffectGoalsResponse>;
-    getTrainingTypes(): Promise<TonalTrainingType[]>;
-    getGoalMetrics(): Promise<TonalGoalMetric[]>;
-    /**
-     * Register or update a personal device for the user.
-     *
-     * NOTE: This endpoint has side effects and should be used with caution.
-     * It registers the device with Tonal's system and may affect notification
-     * settings and device management. For reverse-engineered clients, this
-     * could be considered unauthorized device registration.
-     *
-     * @internal This method is primarily for API completeness and documentation
-     */
-    registerPersonalDevice(userId: string, deviceInfo: TonalDeviceRegistration): Promise<TonalUserDevice>;
-    /**
-     * Get user privacy permissions/settings.
-     *
-     * Returns what information this user has made public vs private.
-     * Useful for understanding social features and respecting privacy preferences.
-     *
-     * @internal This method is for understanding user privacy settings
-     */
-    getUserPermissions(userId: string): Promise<TonalUserPermissions>;
-    /**
-     * Get comprehensive user settings and preferences.
-     *
-     * Returns audio/visual settings, feature flags, onboarding states, and user preferences.
-     * Provides insight into Tonal's full feature ecosystem and user customization options.
-     *
-     * @internal This method is for understanding user preferences and feature usage
-     */
-    getUserSettings(userId: string): Promise<TonalUserSettings>;
-    getDailyMetrics(userId: string, days?: number): Promise<TonalDailyMetrics[]>;
-    getCurrentStreak(userId: string): Promise<TonalCurrentStreak>;
-    getActivitySummaries(userId: string): Promise<TonalActivitySummary[]>;
-    getUserStatistics(userId: string): Promise<TonalUserStatistics>;
-    getAchievementStats(userId: string): Promise<TonalAchievementStats>;
-    getAchievements(userId: string): Promise<TonalEarnedAchievement[]>;
-    getHomeCalendar(userId: string): Promise<TonalHomeCalendar>;
-    getMuscleReadiness(userId: string): Promise<TonalMuscleReadiness>;
-    getProgramById(programId: string): Promise<TonalProgram>;
-    getTargetScores(userId: string): Promise<TonalTargetScoresResponse>;
-    getMetricScores(userId: string, startWeek?: number): Promise<TonalMetricScoresResponse>;
-}

package/dist/src/services/workout-service.d.ts

@@ -1,14 +0,0 @@
-import { HttpClient } from '../http/http-client';
-import { TonalWorkout, TonalSharedWorkout, TonalWorkoutEstimateSet, TonalWorkoutEstimateResponse, TonalWorkoutCreateRequest, TonalWorkoutUpdateRequest, TonalUserInfo } from '../types';
-export declare class WorkoutService {
-    private httpClient;
-    constructor(httpClient: HttpClient);
-    getUserWorkouts(offset?: number, limit?: number): Promise<TonalWorkout[]>;
-    getDailyLifts(userInfo: TonalUserInfo, timeZone?: string): Promise<TonalWorkout[]>;
-    getWorkoutById(workoutId: string): Promise<TonalWorkout>;
-    getWorkoutByShareUrl(shareUrl: string): Promise<TonalSharedWorkout>;
-    estimateWorkoutDuration(sets: TonalWorkoutEstimateSet[]): Promise<TonalWorkoutEstimateResponse>;
-    createWorkout(workoutData: TonalWorkoutCreateRequest): Promise<TonalWorkout>;
-    updateWorkout(workoutData: TonalWorkoutUpdateRequest): Promise<TonalWorkout>;
-    deleteWorkout(workoutId: string): Promise<void>;
-}

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

@@ -1,18 +0,0 @@
-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;
-}

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

@@ -1 +0,0 @@
-export type MuscleGroup = 'Obliques' | 'Abs' | 'Shoulders' | 'Glutes' | 'Back' | 'Biceps' | 'Quads' | 'Triceps' | 'Chest' | 'Hamstrings' | 'Calves' | 'Forearms';

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

@@ -1,6 +0,0 @@
-export * from './auth';
-export * from './common';
-export * from './movements';
-export * from './programs';
-export * from './users';
-export * from './workouts';

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

@@ -1,30 +0,0 @@
-import { MuscleGroup } from './common';
-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;
-}

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

@@ -1,46 +0,0 @@
-import { TonalWorkout } from './workouts';
-export interface TonalProgramWorkout {
-    id: string;
-    programId: string;
-    workoutId: string;
-    level: string;
-    workoutNumber: number;
-    workoutTitle: string;
-    programWeek: number;
-    programDay: number;
-    duration: number;
-}
-export interface TonalProgramTrainingEffectGoal {
-    goalID: string;
-    score: number;
-    goalMet: boolean;
-}
-export interface TonalProgram {
-    id: string;
-    createdAt: string;
-    name: string;
-    description: string;
-    productionCode: string;
-    workoutsPerWeek: number;
-    cadence: boolean[];
-    weeks: number;
-    publishState: string;
-    publishedAt: string;
-    level: string;
-    workouts: TonalWorkout[];
-    assetId: string;
-    goalIds: string[];
-    groupIds: string[];
-    coachId: string;
-    coachIds: string[];
-    trainingTypeIds: string[];
-    isAdjustable: boolean;
-    programWorkoutIds: string[];
-    programWorkouts: TonalProgramWorkout[];
-    nonComparableWorkouts: boolean;
-    mobileFriendly: boolean;
-    supportedDevices: string[];
-    featureGroupIds: string[] | null;
-    excludeFromCoachHighlights: boolean;
-    trainingEffectGoals: TonalProgramTrainingEffectGoal[];
-}

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

@@ -1,418 +0,0 @@
-export interface TonalUserDevice {
-    deviceId: string;
-    tonalDeviceId: string;
-    userId: string;
-    createdAt: string;
-    updatedAt: string;
-    loggedIn: boolean;
-    postWorkoutNotifs: boolean;
-    reminderNotifs: boolean;
-    productUpdateNotifs: boolean;
-    socialNotifs: boolean;
-    blogNotifs: boolean;
-    chatbotNotifs: boolean;
-    deviceModel: string;
-    osVersion: string;
-    appVersion: string;
-    platform: string;
-}
-export interface TonalDeviceRegistration {
-    userId: string;
-    tonalDeviceId: string;
-    deviceId: string;
-    deviceModel: string;
-    osVersion: string;
-    appVersion: string;
-    platform: string;
-    loggedIn: boolean;
-}
-export interface TonalUserPermissions {
-    userId: string;
-    memberDate: 'Public' | 'Private';
-    gender: 'Public' | 'Private';
-    age: 'Public' | 'Private';
-    streak: 'Public' | 'Private';
-    workoutCalendar: 'Public' | 'Private';
-    strengthScore: 'Public' | 'Private';
-    achievements: 'Public' | 'Private';
-    leaderboard: 'Public' | 'Private';
-    volume: 'Public' | 'Private';
-    workouts: 'Public' | 'Private';
-    movements: 'Public' | 'Private';
-    programs: 'Public' | 'Private';
-    activity: 'Public' | 'Private';
-    publicProfile: 'Public' | 'Private';
-    location: 'Public' | 'Private';
-    fullName: 'Public' | 'Private';
-}
-export interface TonalUserSettings {
-    userId: string;
-    overallVolume: number;
-    musicVolume: number;
-    coachVolume: number;
-    soundEffectsVolume: number;
-    coachingCuesVolume: number;
-    bluetoothOverallVolume: number;
-    bluetoothMusicVolume: number;
-    bluetoothCoachVolume: number;
-    bluetoothSoundEffectsVolume: number;
-    feedFmStation: string;
-    feedFmAutoPlay: boolean;
-    feedFmClientId: string;
-    preferredMusicService: string;
-    timeZone: string;
-    screenBrightness: number;
-    closedCaptions: boolean;
-    coachingCuesVoiceType: number;
-    workoutGraph: string;
-    workoutDemo: boolean;
-    demoPlayerSize: string;
-    dataInGuidedWorkouts: boolean;
-    defaultRecoveryWeightTooltipCount: number;
-    activeRecoveryRecoveryWeightTooltipCount: number;
-    timedWeightOffDisabledByDefault: boolean;
-    timedWeightOffDelayBeforeRampMs: number;
-    hasRequestedAccountDeletion: boolean;
-    isSmartViewEnabled: boolean;
-    smartViewMode: string;
-    hasSeenLeaderboardIntroTile: boolean;
-    hasSeenYearInReviewBanner: boolean;
-    hasSeenYearInReviewPromo: boolean;
-    hasSeenWarmUpSetsModal: boolean;
-    hasSeenWorkoutRemindersPopUp: boolean;
-    hasSeenScheduleWorkoutToolTip: boolean;
-    hasSeenPublicProfilePopUp: boolean;
-    hasSharedPublicProfile: boolean;
-    hasHiddenReferralPromo2022: boolean;
-    hasClosedTonal101Ad: boolean;
-    hasConnectedVisionCamera: boolean;
-    hasSeenTonalVisionPromo: boolean;
-    hasSeenARCoreDisclaimer: boolean;
-    hasSeenEditorialContentsPromo: boolean;
-    hasOpenedEditorialContentsPromo: boolean;
-    hasSeenCustomMovementDescriptions: boolean;
-    hasSeenMovementInfoAndGraphsFtue: boolean;
-    hasSeenFreeLiftMovementInfoFtue: boolean;
-    hasSeenMovementReplacementModal: boolean;
-    hasSeenRomPowerGraphModal: boolean;
-    hasSeenCustomMovementReplacementModal: boolean;
-    hasSeenAnkleStrapsPromo: boolean;
-    hasHiddenAnkleStraps: boolean;
-    hasSeenPilatesLoopsPromo: boolean;
-    hasHiddenPilatesLoops: boolean;
-    hasSeenPilatesLoopsPreOrderPromo: boolean;
-    hasHiddenPreOrderPilatesLoops: boolean;
-    hasSeenExclusionFiltersTooltip: boolean;
-    hasSeenExclusionFiltersTrainerTooltip: boolean;
-    hasSeenSmartViewInfoVid: boolean;
-    hasHiddenSmartViewDiscoveryTooltip: boolean;
-    hasSeenSmartViewMovementsTabToolTip: boolean;
-    hasSeenSmartViewClipsToolTip: boolean;
-    hasSeenLinkTonalOrderDialog: boolean;
-    hasSeenThirdPartyMetricsPromo: boolean;
-    hasDismissedUpdatePreferencesBanner: boolean;
-    hasDismissedThirdPartyMuscleReadinessTile: boolean;
-    hasSeenUpdatedAppleHealthScreen: boolean;
-    hasDismissedTrainingEffectGoalsBanner: boolean;
-    hasSeenTrainingEffectGoalsPromo: boolean;
-    hasSeenTrainingMetricsPromo: boolean;
-    hasSeenBodygramInstructions: boolean;
-    hasSeenChatbotAnnouncementModal: boolean;
-    hasDismissedChatbotTooltip: boolean;
-    hasSeenDropSetsPromo: boolean;
-    hasHiddenDropSetsPromoBanner: boolean;
-    hasSeenScorecardPromo: boolean;
-    hasHiddenScorecardPopover: boolean;
-    hasHiddenProgramScorecardPopover: boolean;
-    hasHiddenAeroPromoBanner: boolean;
-    hasSeenPostWorkoutSelfiePromo: boolean;
-    hasSeenCoachingCuesPopup: boolean;
-    hasSeenCoachingCuesVolumeTooltip: boolean;
-    hasSeenCounterPopover: boolean;
-    hasSeenDailyLiftPromo: boolean;
-    joinProgramPromptEnabled: boolean;
-    hasSeenTosUpdate: boolean;
-    hasSeenShareCustomWorkoutToolTip: boolean;
-    hasSeenCustomTabSharingToolTip: boolean;
-    hasSeenCustomWorkoutsSharingPromo: boolean;
-}
-export interface TonalDailyMetrics {
-    date: string;
-    totalVolume: number;
-    totalWorkouts: number;
-    totalDuration: number;
-    totalExternalActivities: number;
-    totalWork: number;
-    totalTimeUnderTension: number;
-}
-export interface TonalCurrentStreak {
-    userId: string;
-    currentStreak: number;
-    currentStreakStartDate: string;
-    lastUpdatedWeek: string;
-    maxStreak: number;
-    maxStreakStartDate: string;
-    updatedByActivityId: string;
-}
-export interface TonalActivitySummary {
-    id: string;
-    deletedAt: string | null;
-    userId: string;
-    name: string;
-    workoutId: string;
-    isInProgram: boolean;
-    isGuidedWorkout: boolean;
-    isBaselineWorkout: boolean;
-    timestamp: string;
-    UTCTimestamp: string;
-    localTimestamp: string;
-    endTime: string;
-    timeZone: string;
-    assetID?: string;
-    targetArea: string;
-    duration: number;
-    timeUnderTension: number;
-    repGoalPercentage: number | null;
-    totalReps: number;
-    totalVolume: number;
-    totalWork: number;
-    level: string;
-    programWeeks: number;
-    programWorkoutsPerWeek: number;
-    groupIds: string[];
-    workoutType: string;
-    completed: boolean;
-    deviceId: string;
-    appVersion: string;
-    activityType: string;
-    triggeredTimedWeightOff: boolean;
-}
-export interface TonalUserStatistics {
-    volume: {
-        total: number;
-        maxVolumeInWorkout: number;
-        maxVolumeInAWeek: number;
-        avgVolumePerWorkout: number;
-        avgVolumePerWeek: number;
-    };
-    workouts: {
-        total: number;
-        maxWorkoutDuration: number;
-        avgWorkoutDuration: number;
-        totalDuration: number;
-        totalTimeUnderTension: number;
-        maxWorkoutsPerWeek: number;
-        avgWorkoutsPerWeek: number;
-        totalFreeliftWorkouts: number;
-        totalCustomWorkouts: number;
-    };
-    movements: {
-        total: number;
-        movementIds: string[];
-    };
-    programs: {
-        total: number;
-        totalProgramVolume: number;
-        totalProgramWorkouts: number;
-        totalDuration: number;
-        programSummaries: unknown | null;
-    };
-}
-export interface TonalAchievementMilestone {
-    id: string;
-    name: string;
-    description: string;
-    shortDescription: string;
-    achievementCategoryId: string;
-    achievementCategory: unknown | null;
-    assetId: string;
-    value: number;
-    iconAssetId: string;
-    active: boolean;
-    needsTemplate: boolean;
-}
-export interface TonalAchievementStats {
-    totalAchievements: number;
-    nextMilestones: TonalAchievementMilestone[];
-}
-export interface TonalAchievementCategory {
-    id: string;
-    name: string;
-    type: string;
-}
-export interface TonalAchievementDefinition {
-    id: string;
-    name: string;
-    description: string;
-    shortDescription: string;
-    achievementCategoryId: string;
-    achievementCategory: TonalAchievementCategory;
-    assetId: string;
-    value: number | null;
-    iconAssetId: string;
-    active: boolean;
-    needsTemplate: boolean;
-}
-export interface TonalEarnedAchievement {
-    id: string;
-    achievementId: string;
-    userId: string;
-    createdAt: string;
-    name: string;
-    description: string;
-    shortDescription: string;
-    assetId: string;
-    workoutActivityId?: string;
-    iconAssetId: string;
-    achievement: TonalAchievementDefinition;
-    localTimestamp: string;
-}
-export interface TonalMuscleUtilization {
-    muscleGroup: string;
-    value: number;
-}
-export interface TonalWorkoutSummaryData {
-    workoutActivityId: string;
-    duration: number;
-    volume: number;
-    work: number;
-    muscleUtilization: TonalMuscleUtilization[];
-}
-export interface TonalCompatibilityStatus {
-    status: string;
-    lockedReason: string | null;
-}
-export interface TonalCalendarTile {
-    type: string;
-    assetId: string;
-    title: string;
-    duration: number;
-    completed?: boolean;
-    workoutId: string;
-    targetArea: string;
-    level?: string;
-    trainingTypeIds?: string[];
-    coachId?: string;
-    accessories?: string[];
-    compatibilityStatus?: TonalCompatibilityStatus;
-    workoutSummaryData?: TonalWorkoutSummaryData;
-}
-export interface TonalDailySchedule {
-    date: string;
-    recommendationType?: string;
-    tiles: TonalCalendarTile[];
-}
-export interface TonalHomeCalendar {
-    dailySchedules: TonalDailySchedule[];
-}
-export interface TonalGoal {
-    id: string;
-    name: string;
-    description: string;
-    active: boolean;
-    filterItemId: string;
-}
-export interface TonalTrainingEffectGoal {
-    id: string;
-    name: string;
-    description: string;
-    active: boolean;
-    filterItemId: string;
-}
-export interface TonalTrainingEffectGoalRelation {
-    id: string;
-    secondary: string[];
-    tertiary: string[];
-}
-export interface TonalTrainingEffectGoalsResponse {
-    goals: TonalTrainingEffectGoal[];
-    relations: TonalTrainingEffectGoalRelation[];
-}
-export interface TonalTrainingType {
-    id: string;
-    name: string;
-    description: string;
-    assetId: string;
-    infoVidId: string;
-    filterItemId: string;
-}
-export interface TonalGoalMetric {
-    id: string;
-    name: string;
-    goalId: string;
-    description: string;
-}
-export interface TonalUserGoal {
-    id: string;
-    userID: string;
-    goalID: string;
-    tier: number;
-}
-export interface TonalMuscleReadiness {
-    Chest: number;
-    Shoulders: number;
-    Back: number;
-    Triceps: number;
-    Biceps: number;
-    Abs: number;
-    Obliques: number;
-    Quads: number;
-    Glutes: number;
-    Hamstrings: number;
-    Calves: number;
-}
-export interface TonalTargetScore {
-    userId: string;
-    weekNumber: number;
-    metricId: string;
-    target: number;
-    lowRange: number;
-    highRange: number;
-}
-export interface TonalTargetScoresResponse {
-    [metricId: string]: TonalTargetScore[];
-}
-export interface TonalMetricScore {
-    userId: string;
-    weekNumber: number;
-    metricId: string;
-    score: number;
-}
-export interface TonalMetricScoresResponse {
-    [metricId: string]: TonalMetricScore[];
-}
-export interface TonalUserInfo {
-    id: string;
-    createdAt: string;
-    updatedAt: string;
-    deletedAt: string | null;
-    email: string;
-    firstName: string;
-    lastName: string;
-    gender: 'MALE' | 'FEMALE' | string;
-    heightInches: number;
-    weightPounds: number;
-    auth0Id: string;
-    dateOfBirth: string;
-    isGuestAccount: boolean;
-    isDemoAccount: boolean;
-    watchedSafetyVideo: boolean;
-    recentMobileDevice: TonalUserDevice;
-    emailVerified: boolean;
-    username: string;
-    workoutsPerWeek: number;
-    tonalStatus: 'purchased' | string;
-    social: unknown | null;
-    profileAssetID: string | null;
-    mobileWorkoutsEnabled: boolean;
-    accountType: 'PublicUser' | string;
-    location: string;
-    sharingCustomWorkoutsDisabled: boolean;
-    level: 'BEGINNER' | 'INTERMEDIATE' | 'ADVANCED' | string;
-    goalId: string;
-    goals: TonalUserGoal[];
-    workoutDurationMin: number;
-    workoutDurationMax: number;
-    updatedPreferencesAt: string;
-    primaryDeviceType: 'Classic' | string;
-}