hevy-shared 1.0.702 → 1.0.703

package/built/hevyTrainer.d.ts

@@ -0,0 +1,126 @@
+import { WeeklyTrainingFrequency, TrainingGoal, TrainingLevel, Equipment, SimplifiedMuscleGroup, MuscleGroup, LibraryExercise } from '.';
+export type HevyTrainerExerciseCategory = typeof hevyTrainerExerciseCategories[number];
+export type HevyTrainerRoutineName = typeof routineNames[number];
+export type HevyTrainerProgramEquipment = Extract<Equipment, 'barbell' | 'dumbbell' | 'machine'>;
+export declare const hevyTrainerExerciseCategories: readonly ["compound", "isolation"];
+export declare const routineNames: readonly ["full_body_1", "full_body_2_a", "full_body_2_b", "full_body_3_a", "full_body_3_b", "full_body_3_c", "upper_1_a", "lower_1_a", "upper_1_b", "lower_1_b", "push_1", "pull_1", "legs_1", "upper_2", "lower_2", "push_2_a", "pull_2_a", "legs_2_a", "push_2_b", "pull_2_b", "legs_2_b"];
+export type exerciseId = string;
+export declare const frequencyMap: Record<WeeklyTrainingFrequency, string>;
+export declare const programSplits: Record<WeeklyTrainingFrequency, HevyTrainerRoutineName[]>;
+export type SetsPerGoal = {
+    [key in TrainingGoal]: number;
+};
+export type Sets = {
+    [key in string]: SetsPerGoal;
+};
+export interface RepRange {
+    rep_range_start: number;
+    rep_range_end: number;
+}
+export type RepRangesPerCategory = {
+    [key in HevyTrainerExerciseCategory]: RepRange;
+};
+export type RepRanges = {
+    [key in TrainingGoal]: RepRangesPerCategory;
+};
+export type RestTimersPerCategory = {
+    [key in HevyTrainerExerciseCategory]: number;
+};
+export type RestTimers = {
+    [key in TrainingGoal]: RestTimersPerCategory;
+};
+export type ExercisePriorities = {
+    [key in MuscleGroup]: exerciseId[];
+};
+export type ExerciseNotes = {
+    [key in exerciseId]: string;
+};
+export interface ExercisePrescription {
+    muscle_group: MuscleGroup | 'focus_muscle';
+    category: HevyTrainerExerciseCategory;
+    warmup_set_count?: number;
+}
+export interface WorkoutTemplate {
+    exercises: ExercisePrescription[];
+    notes?: string;
+}
+export type Templates = {
+    [key in HevyTrainerRoutineName]: WorkoutTemplate;
+};
+export interface TrainerPreset {
+    id?: number;
+    username: string;
+    title?: string;
+    is_default?: boolean;
+    updated_at?: string;
+    settings: TrainerPresetSettings;
+    workout_tab_ai_insight_prompt?: string;
+}
+export interface TrainerPresetSettings {
+    sets: Sets;
+    rep_ranges: RepRanges;
+    rest_timers: RestTimers;
+    templates: Templates;
+    exercise_priorities: ExercisePriorities;
+    exercise_notes: ExerciseNotes;
+}
+export interface TrainerProgramExercise {
+    exerciseTemplate: HevyTrainerLibraryExercise;
+    muscleGroup: MuscleGroup | 'focus_muscle';
+    category: HevyTrainerExerciseCategory;
+    sets: number;
+    warmupSetCount?: number;
+    repRangeStart: number;
+    repRangeEnd: number;
+    restTimerSeconds: number;
+    notes?: string;
+}
+export interface TrainerProgramRoutine {
+    name: HevyTrainerRoutineName;
+    exercises: TrainerProgramExercise[];
+    notes?: string;
+}
+export interface TrainerProgram {
+    name: WeeklyTrainingFrequency;
+    routines: TrainerProgramRoutine[];
+}
+export type HevyTrainerLibraryExercise = Pick<LibraryExercise, 'id' | 'title' | 'priority' | 'muscle_group' | 'other_muscles' | 'exercise_type' | 'equipment_category' | 'category' | 'level' | 'goal'>;
+export interface ExercisePrescriptionError {
+    type: 'exercise_not_found';
+    prescription: ExercisePrescription;
+    muscleGroup: MuscleGroup;
+    context: {
+        goal: TrainingGoal;
+        level: TrainingLevel;
+        equipments: HevyTrainerProgramEquipment[];
+        focusMuscle?: SimplifiedMuscleGroup;
+    };
+}
+export interface TrainerProgramExerciseResult {
+    success: true;
+    exercise: TrainerProgramExercise;
+}
+export interface TrainerProgramExerciseError {
+    success: false;
+    error: ExercisePrescriptionError;
+}
+export type TrainerProgramExerciseAttempt = TrainerProgramExerciseResult | TrainerProgramExerciseError;
+export interface TrainerProgramResult {
+    success: true;
+    program: TrainerProgram;
+}
+export interface TrainerProgramError {
+    success: false;
+    errors: ExercisePrescriptionError[];
+    partialProgram?: TrainerProgram;
+}
+export type TrainerProgramAttempt = TrainerProgramResult | TrainerProgramError;
+export declare const generateProgram: ({ trainerPreset, selectedDays, selectedGoal, selectedLevel, selectedEquipments, exerciseStore, focusMuscle, }: {
+    trainerPreset: TrainerPreset;
+    selectedDays: WeeklyTrainingFrequency;
+    selectedGoal: TrainingGoal;
+    selectedLevel: TrainingLevel;
+    selectedEquipments: HevyTrainerProgramEquipment[];
+    exerciseStore: HevyTrainerLibraryExercise[];
+    focusMuscle?: SimplifiedMuscleGroup;
+}) => TrainerProgramAttempt;

package/built/hevyTrainer.js

@@ -0,0 +1,245 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateProgram = exports.programSplits = exports.frequencyMap = exports.routineNames = exports.hevyTrainerExerciseCategories = void 0;
+const _1 = require(".");
+exports.hevyTrainerExerciseCategories = ['compound', 'isolation'];
+exports.routineNames = [
+    // Full body 1x
+    'full_body_1',
+    // Full body 2x
+    'full_body_2_a',
+    'full_body_2_b',
+    // Full body 3x
+    'full_body_3_a',
+    'full_body_3_b',
+    'full_body_3_c',
+    // Upper body x4 per week
+    'upper_1_a',
+    'lower_1_a',
+    'upper_1_b',
+    'lower_1_b',
+    // Push Pull Legs Upper Lower 5x per week
+    'push_1',
+    'pull_1',
+    'legs_1',
+    'upper_2',
+    'lower_2',
+    // Push Pull Legs x6 per week
+    'push_2_a',
+    'pull_2_a',
+    'legs_2_a',
+    'push_2_b',
+    'pull_2_b',
+    'legs_2_b',
+];
+exports.frequencyMap = {
+    1: 'one_day',
+    2: 'two_days',
+    3: 'three_days',
+    4: 'four_days',
+    5: 'five_days',
+    6: 'six_days',
+};
+exports.programSplits = {
+    1: ['full_body_1'],
+    2: ['full_body_2_a', 'full_body_2_b'],
+    3: ['full_body_3_a', 'full_body_3_b', 'full_body_3_c'],
+    4: ['upper_1_a', 'lower_1_a', 'upper_1_b', 'lower_1_b'],
+    5: ['push_1', 'pull_1', 'legs_1', 'upper_2', 'lower_2'],
+    6: ['push_2_a', 'pull_2_a', 'legs_2_a', 'push_2_b', 'pull_2_b', 'legs_2_b'],
+};
+const isolationExerciseAlternatives = {
+    chest: ['B74A95BB', '392887AA', '39C99849'],
+    triceps: ['6575F52D', 'CD6DC8E5'],
+    quadriceps: ['32HKJ34K', 'A733CC5B', '9694DA61'],
+    hamstrings: ['F6948F17', '487B3755', 'CDA23948'],
+    glutes: [],
+    lats: [],
+    lower_back: [],
+    upper_back: [],
+    shoulders: [],
+    biceps: [],
+    adductors: [],
+    abductors: [],
+    calves: [],
+    forearms: [],
+    abdominals: [],
+    other: [],
+    cardio: [],
+    traps: [],
+    neck: [],
+    full_body: [],
+};
+const getMuscleGroup = ({ muscleGroupPrescription, programFocusMuscleExerciseCount, focusMuscle, }) => {
+    if (muscleGroupPrescription === 'focus_muscle') {
+        if (!!focusMuscle) {
+            const n = _1.simplifiedMuscleGroupToMuscleGroups[focusMuscle].length;
+            return _1.simplifiedMuscleGroupToMuscleGroups[focusMuscle][programFocusMuscleExerciseCount % n];
+        }
+        // User has not selected a focus muscle, so we skip this extra exercise for the focus muscle
+        return undefined;
+    }
+    return muscleGroupPrescription;
+};
+const isExerciseMatch = ({ exercisePrescription, exercise, equipments, routineBarbellExerciseCount, level, goal, }) => {
+    var _a, _b;
+    return ((exercise.category === exercisePrescription.category ||
+        (exercise.category === 'assistance-compound' && // Airtable also has `assistance-compound` as another category
+            exercisePrescription.category === 'compound')) && // but we are not differentiating between them and using `compound` instead
+        ((_a = exercise.level) === null || _a === void 0 ? void 0 : _a.includes(level)) &&
+        ((_b = exercise.goal) === null || _b === void 0 ? void 0 : _b.includes(goal)) &&
+        (equipments.includes(exercise.equipment_category) ||
+            exercise.equipment_category === 'none' ||
+            exercise.equipment_category === 'other') &&
+        // Up to 2 barbell exercises per routine, unless there is only one equipment category selected
+        (exercise.equipment_category !== 'barbell' ||
+            routineBarbellExerciseCount < 2 ||
+            equipments.length === 1));
+};
+const isAlternativeIsolationExerciseMatch = ({ exercise, exercisePrescription, equipments, level, muscleGroup, }) => {
+    var _a;
+    return (exercisePrescription.category === 'isolation' &&
+        isolationExerciseAlternatives[muscleGroup].includes(exercise.id) &&
+        (equipments.includes(exercise.equipment_category) ||
+            exercise.equipment_category === 'none' ||
+            exercise.equipment_category === 'other') &&
+        ((_a = exercise.level) === null || _a === void 0 ? void 0 : _a.includes(level)));
+};
+const generateProgram = ({ trainerPreset, selectedDays, selectedGoal, selectedLevel, selectedEquipments, exerciseStore, focusMuscle, }) => {
+    var _a;
+    const routines = exports.programSplits[selectedDays];
+    const program = {
+        name: selectedDays,
+        routines: [],
+    };
+    // Have a map of muscle group to exercises sorted by exercise priority
+    const sortedExercises = Object.entries(trainerPreset.settings.exercise_priorities).reduce((acc, [muscleGroup, exercises]) => {
+        acc[muscleGroup] = exercises.map((exercise) => exerciseStore.find((e) => e.id === exercise));
+        return acc;
+    }, {});
+    // Then add remaining exercises to the map
+    Object.keys(sortedExercises).forEach((muscleGroup) => {
+        const remainingExercises = exerciseStore
+            .filter((e) => e.muscle_group === muscleGroup &&
+            !sortedExercises[muscleGroup].includes(e))
+            .sort((a, b) => b.priority - a.priority);
+        sortedExercises[muscleGroup].push(...remainingExercises);
+    });
+    const programUsedExercises = new Set();
+    let programFocusMuscleExerciseCount = 0;
+    const allErrors = [];
+    for (const routine of routines) {
+        const routineTemplate = trainerPreset.settings.templates[routine];
+        let routineBarbellExerciseCount = 0;
+        const routineUsedExercises = new Set();
+        const routineExercises = [];
+        for (const exercisePrescription of routineTemplate.exercises) {
+            const muscleGroup = getMuscleGroup({
+                muscleGroupPrescription: exercisePrescription.muscle_group,
+                programFocusMuscleExerciseCount,
+                focusMuscle,
+            });
+            // If the muscle group is not found, skip the exercise
+            if (!muscleGroup) {
+                continue;
+            }
+            // First pass: Try to find an exact match for the exercise that is not used in the program
+            let exercise = sortedExercises[muscleGroup].find((e) => isExerciseMatch({
+                exercisePrescription,
+                exercise: e,
+                equipments: selectedEquipments,
+                routineBarbellExerciseCount,
+                level: selectedLevel,
+                goal: selectedGoal,
+            }) && !programUsedExercises.has(e.title));
+            if (exercise === undefined) {
+                // Second pass
+                // By allowing the same exercise to be assigned in the same program more than once
+                const extendedMatchingExercise = sortedExercises[muscleGroup].find((e) => isExerciseMatch({
+                    exercisePrescription,
+                    exercise: e,
+                    equipments: selectedEquipments,
+                    routineBarbellExerciseCount,
+                    level: selectedLevel,
+                    goal: selectedGoal,
+                }) && !routineUsedExercises.has(e.title));
+                exercise = extendedMatchingExercise;
+            }
+            if (exercise === undefined) {
+                // Third pass
+                // Check if isolation exercise alternatives are available and not used in the program
+                const alternativeIsolationExercise = sortedExercises[muscleGroup].find((e) => isAlternativeIsolationExerciseMatch({
+                    exercise: e,
+                    exercisePrescription,
+                    equipments: selectedEquipments,
+                    level: selectedLevel,
+                    muscleGroup,
+                }) && !programUsedExercises.has(e.title));
+                exercise = alternativeIsolationExercise;
+            }
+            if (exercise === undefined) {
+                // Fourth pass
+                // Check if isolation exercise alternatives are available and not used in the workout
+                const extendedIsolationExercise = sortedExercises[muscleGroup].find((e) => isAlternativeIsolationExerciseMatch({
+                    exercise: e,
+                    exercisePrescription,
+                    equipments: selectedEquipments,
+                    level: selectedLevel,
+                    muscleGroup,
+                }) && !routineUsedExercises.has(e.title));
+                exercise = extendedIsolationExercise;
+            }
+            if (!!exercise) {
+                programUsedExercises.add(exercise.title);
+                routineUsedExercises.add(exercise.title);
+                if (exercise.equipment_category === 'barbell')
+                    routineBarbellExerciseCount++;
+                if (exercisePrescription.muscle_group === 'focus_muscle')
+                    programFocusMuscleExerciseCount++;
+                routineExercises.push({
+                    exerciseTemplate: exercise,
+                    muscleGroup: exercisePrescription.muscle_group,
+                    category: exercisePrescription.category,
+                    sets: trainerPreset.settings.sets[exports.frequencyMap[selectedDays]][selectedGoal],
+                    warmupSetCount: exercisePrescription.warmup_set_count,
+                    repRangeStart: trainerPreset.settings.rep_ranges[selectedGoal][exercisePrescription.category].rep_range_start,
+                    repRangeEnd: trainerPreset.settings.rep_ranges[selectedGoal][exercisePrescription.category].rep_range_end,
+                    restTimerSeconds: trainerPreset.settings.rest_timers[selectedGoal][exercisePrescription.category],
+                    notes: (_a = trainerPreset.settings.exercise_notes[exercise.id]) !== null && _a !== void 0 ? _a : '',
+                });
+            }
+            else {
+                // Collect error instead of throwing
+                allErrors.push({
+                    type: 'exercise_not_found',
+                    prescription: exercisePrescription,
+                    muscleGroup,
+                    context: {
+                        goal: selectedGoal,
+                        level: selectedLevel,
+                        equipments: selectedEquipments,
+                        focusMuscle,
+                    },
+                });
+            }
+        }
+        program.routines.push({
+            name: routine,
+            notes: routineTemplate.notes,
+            exercises: routineExercises,
+        });
+    }
+    // Return result based on whether there were errors
+    if (allErrors.length > 0) {
+        return {
+            success: false,
+            errors: allErrors,
+            partialProgram: program.routines.length > 0 ? program : undefined,
+        };
+    }
+    return {
+        success: true,
+        program,
+    };
+};
+exports.generateProgram = generateProgram;

package/built/index.d.ts

@@ -17,6 +17,7 @@ export * from './routineUtils';
 export * from './typeUtils';
 export * from './async';
 export * from './adminPermissions';
+export * from './hevyTrainer';
 export declare const supportedLanguages: readonly ["en", "es", "de", "fr", "it", "pt", "tr", "zh_CN", "zh_TW", "ru", "ja", "ko"];
 export type Language = Lookup<typeof supportedLanguages>;
 export declare const isLanguage: (x: string) => x is Language;
@@ -555,18 +556,19 @@ export declare const coreMuscles: readonly ["abdominals"];
 export declare const shoulderMuscles: readonly ["shoulders"];
 export declare const armMuscles: readonly ["biceps", "triceps", "forearms"];
 export declare const legMuscles: readonly ["quadriceps", "hamstrings", "calves", "glutes", "abductors", "adductors"];
-export declare const backMuscles: readonly ["lats", "traps", "lower_back", "upper_back"];
+export declare const backMuscles: readonly ["lats", "upper_back", "traps", "lower_back"];
 export declare const chestMuscles: readonly ["chest"];
 export declare const miscellaneousMuscles: readonly ["cardio", "neck", "full_body", "other"];
 export declare const simplifiedMuscleGroups: readonly ["core", "shoulders", "arms", "legs", "back", "chest"];
 export type SimplifiedMuscleGroup = Lookup<typeof simplifiedMuscleGroups>;
 export declare const isSimplifiedMuscleGroup: (x: string) => x is SimplifiedMuscleGroup;
-export declare const muscleGroups: readonly ["abdominals", "shoulders", "biceps", "triceps", "forearms", "quadriceps", "hamstrings", "calves", "glutes", "abductors", "adductors", "lats", "traps", "lower_back", "upper_back", "chest", "cardio", "neck", "full_body", "other"];
+export declare const muscleGroups: readonly ["abdominals", "shoulders", "biceps", "triceps", "forearms", "quadriceps", "hamstrings", "calves", "glutes", "abductors", "adductors", "lats", "upper_back", "traps", "lower_back", "chest", "cardio", "neck", "full_body", "other"];
 export type MuscleGroup = Lookup<typeof muscleGroups>;
 export declare const isMuscleGroup: (x: string) => x is MuscleGroup;
-export declare const muscleGroupFilters: readonly ["all_muscles", "abdominals", "shoulders", "biceps", "triceps", "forearms", "quadriceps", "hamstrings", "calves", "glutes", "abductors", "adductors", "lats", "traps", "lower_back", "upper_back", "chest", "cardio", "neck", "full_body", "other"];
+export declare const muscleGroupFilters: readonly ["all_muscles", "abdominals", "shoulders", "biceps", "triceps", "forearms", "quadriceps", "hamstrings", "calves", "glutes", "abductors", "adductors", "lats", "upper_back", "traps", "lower_back", "chest", "cardio", "neck", "full_body", "other"];
 export type MuscleGroupFilter = Lookup<typeof muscleGroupFilters>;
 export declare const isMuscleGroupFilter: (x: string) => x is MuscleGroupFilter;
+export declare const simplifiedMuscleGroupToMuscleGroups: Record<SimplifiedMuscleGroup, readonly MuscleGroup[]>;
 /**
  * Equipment
  */

package/built/index.js

@@ -14,8 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.measurementsList = exports.isWorkoutBiometrics = exports.isHeartRateSamples = exports.isPublicWorkout = exports.isSetType = exports.isRPE = exports.validRpeValues = exports.isSetPersonalRecordType = exports.supportedInstructionsLanguages = exports.weeklyTrainingFrequencies = exports.hevyTrainerProgramEquipments = exports.exerciseCategories = exports.trainingLevels = exports.trainingGoals = exports.isCustomExerciseType = exports.customExericseTypes = exports.isExerciseType = exports.exerciseTypes = exports.isExerciseRepType = exports.exerciseRepTypes = exports.isEquipmentFilter = exports.equipmentFilters = exports.isEquipment = exports.equipments = exports.isMuscleGroupFilter = exports.muscleGroupFilters = exports.isMuscleGroup = exports.muscleGroups = exports.isSimplifiedMuscleGroup = exports.simplifiedMuscleGroups = exports.miscellaneousMuscles = exports.chestMuscles = exports.backMuscles = exports.legMuscles = exports.armMuscles = exports.shoulderMuscles = exports.coreMuscles = exports.DefaultClientConfiguration = exports.isCoachRole = exports.isErrorResponse = exports.isLivePRVolumeOption = exports.isTimerVolumeOption = exports.isWeekday = exports.orderedWeekdays = exports.isBodyMeasurementUnit = exports.isDistanceUnitShort = exports.isDistanceUnit = exports.isWeightUnit = exports.isLanguage = exports.supportedLanguages = void 0;
-exports.isSuggestedUserSource = exports.isValidUserWorkoutMetricsType = exports.isBodyMeasurementKey = void 0;
+exports.isWorkoutBiometrics = exports.isHeartRateSamples = exports.isPublicWorkout = exports.isSetType = exports.isRPE = exports.validRpeValues = exports.isSetPersonalRecordType = exports.supportedInstructionsLanguages = exports.weeklyTrainingFrequencies = exports.hevyTrainerProgramEquipments = exports.exerciseCategories = exports.trainingLevels = exports.trainingGoals = exports.isCustomExerciseType = exports.customExericseTypes = exports.isExerciseType = exports.exerciseTypes = exports.isExerciseRepType = exports.exerciseRepTypes = exports.isEquipmentFilter = exports.equipmentFilters = exports.isEquipment = exports.equipments = exports.simplifiedMuscleGroupToMuscleGroups = exports.isMuscleGroupFilter = exports.muscleGroupFilters = exports.isMuscleGroup = exports.muscleGroups = exports.isSimplifiedMuscleGroup = exports.simplifiedMuscleGroups = exports.miscellaneousMuscles = exports.chestMuscles = exports.backMuscles = exports.legMuscles = exports.armMuscles = exports.shoulderMuscles = exports.coreMuscles = exports.DefaultClientConfiguration = exports.isCoachRole = exports.isErrorResponse = exports.isLivePRVolumeOption = exports.isTimerVolumeOption = exports.isWeekday = exports.orderedWeekdays = exports.isBodyMeasurementUnit = exports.isDistanceUnitShort = exports.isDistanceUnit = exports.isWeightUnit = exports.isLanguage = exports.supportedLanguages = void 0;
+exports.isSuggestedUserSource = exports.isValidUserWorkoutMetricsType = exports.isBodyMeasurementKey = exports.measurementsList = void 0;
 const typeUtils_1 = require("./typeUtils");
 __exportStar(require("./constants"), exports);
 __exportStar(require("./utils"), exports);
@@ -35,6 +35,7 @@ __exportStar(require("./routineUtils"), exports);
 __exportStar(require("./typeUtils"), exports);
 __exportStar(require("./async"), exports);
 __exportStar(require("./adminPermissions"), exports);
+__exportStar(require("./hevyTrainer"), exports);
 exports.supportedLanguages = [
     'en',
     'es',
@@ -118,9 +119,9 @@ exports.legMuscles = [
 ];
 exports.backMuscles = [
     'lats',
+    'upper_back',
     'traps',
     'lower_back',
-    'upper_back',
 ];
 exports.chestMuscles = ['chest'];
 exports.miscellaneousMuscles = [
@@ -153,6 +154,14 @@ exports.isMuscleGroup = isMuscleGroup;
 exports.muscleGroupFilters = ['all_muscles', ...exports.muscleGroups];
 const isMuscleGroupFilter = (x) => (0, typeUtils_1.isInArray)(x, exports.muscleGroupFilters);
 exports.isMuscleGroupFilter = isMuscleGroupFilter;
+exports.simplifiedMuscleGroupToMuscleGroups = {
+    chest: exports.chestMuscles,
+    shoulders: exports.shoulderMuscles,
+    back: exports.backMuscles,
+    arms: exports.armMuscles,
+    legs: exports.legMuscles,
+    core: exports.coreMuscles,
+};
 /**
  * Equipment
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hevy-shared",
-  "version": "1.0.702",
+  "version": "1.0.703",
   "description": "",
   "main": "built/index.js",
   "types": "built/index.d.ts",