hevy-shared 1.0.906 → 1.0.908

package/built/hevyTrainer.d.ts

@@ -1,16 +1,20 @@
-import { WeeklyTrainingFrequency, TrainingGoal, TrainingLevel, Equipment, SimplifiedMuscleGroup, MuscleGroup, LibraryExercise, ExerciseCategory } from '.';
+import { WeeklyTrainingFrequency, TrainingGoal, TrainingLevel, SimplifiedMuscleGroup, MuscleGroup, LibraryExercise, ExerciseCategory, GranularEquipment } 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 type WorkoutDurationMinutes = typeof workoutDurationOptions[number];
 export declare const workoutDurationOptions: readonly [40, 60, 80];
+export type WorkoutDurationMinutes = typeof workoutDurationOptions[number];
+export declare const trainerGymTypes: readonly ["home_gym", "garage_gym", "commercial_gym", "full_gym"];
+export type TrainerGymType = typeof trainerGymTypes[number];
+export declare const granularEquipmentDefaults: {
+    [key in TrainerGymType]: GranularEquipment[];
+};
+export declare const hevyTrainerExerciseCategories: readonly ["compound", "isolation"];
 export declare const defaultDurationPerFrequency: Record<WeeklyTrainingFrequency, WorkoutDurationMinutes>;
 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 interface ExerciseSelectionCriteria {
     exerciseCategory: HevyTrainerExerciseCategory | 'all';
-    equipments: HevyTrainerProgramEquipment[];
+    granularEquipments: GranularEquipment[];
     routineBarbellExerciseCount: number;
     level: TrainingLevel;
     goal: TrainingGoal;
@@ -32,7 +36,7 @@ export interface ProgramGenerationParams<T extends HevyTrainerLibraryExercise> {
     selectedDays: WeeklyTrainingFrequency;
     selectedGoal: TrainingGoal;
     selectedLevel: TrainingLevel;
-    selectedEquipments: HevyTrainerProgramEquipment[];
+    selectedGranularEquipments: GranularEquipment[];
     selectedWorkoutDurationMinutes?: WorkoutDurationMinutes;
     exerciseStore: T[];
     focusMuscle?: SimplifiedMuscleGroup;
@@ -150,7 +154,7 @@ export declare const getPrioritySortedExercises: <T extends HevyTrainerLibraryEx
  * Selects the best exercise for a given prescription using a multi-pass strategy
  */
 export declare const pickExerciseForPrescription: <T extends HevyTrainerLibraryExercise>(params: ExerciseSelectionParams<T>) => T | undefined;
-export type HevyTrainerLibraryExercise = Pick<LibraryExercise, 'id' | 'title' | 'priority' | 'muscle_group' | 'other_muscles' | 'exercise_type' | 'equipment_category' | 'category' | 'level' | 'goal'>;
+export type HevyTrainerLibraryExercise = Pick<LibraryExercise, 'id' | 'title' | 'priority' | 'muscle_group' | 'other_muscles' | 'exercise_type' | 'equipment_category' | 'category' | 'level' | 'goal' | 'granular_equipments'>;
 export interface ExercisePrescriptionError {
     type: 'exercise_not_found';
     prescription: ExercisePrescription;
@@ -158,7 +162,7 @@ export interface ExercisePrescriptionError {
     context: {
         goal: TrainingGoal;
         level: TrainingLevel;
-        equipments: HevyTrainerProgramEquipment[];
+        granularEquipments: GranularEquipment[];
         focusMuscle?: SimplifiedMuscleGroup;
     };
 }

package/built/hevyTrainer.js

@@ -1,10 +1,82 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateProgram = exports.pickExerciseForPrescription = exports.getPrioritySortedExercises = exports.normalizeExerciseCategory = exports.getTrainerRestTimerSeconds = exports.getTrainerRepRange = exports.getTrainerSetCount = exports.programSplits = exports.frequencyMap = exports.routineNames = exports.defaultDurationPerFrequency = exports.workoutDurationOptions = exports.hevyTrainerExerciseCategories = void 0;
+exports.generateProgram = exports.pickExerciseForPrescription = exports.getPrioritySortedExercises = exports.normalizeExerciseCategory = exports.getTrainerRestTimerSeconds = exports.getTrainerRepRange = exports.getTrainerSetCount = exports.programSplits = exports.frequencyMap = exports.routineNames = exports.defaultDurationPerFrequency = exports.hevyTrainerExerciseCategories = exports.granularEquipmentDefaults = exports.trainerGymTypes = exports.workoutDurationOptions = void 0;
 const _1 = require(".");
 const MAX_BARBELL_EXERCISES_PER_ROUTINE = 2;
-exports.hevyTrainerExerciseCategories = ['compound', 'isolation'];
 exports.workoutDurationOptions = [40, 60, 80];
+exports.trainerGymTypes = [
+    'home_gym',
+    'garage_gym',
+    'commercial_gym',
+    'full_gym',
+];
+exports.granularEquipmentDefaults = {
+    home_gym: ['dumbbell', 'pullup_bar', 'adjustable_bench'],
+    garage_gym: [
+        'dumbbell',
+        'kettlebell',
+        'barbell',
+        'plate',
+        'pullup_bar',
+        'dip_bar',
+        'squat_rack',
+        'adjustable_bench',
+        'spinning',
+    ],
+    commercial_gym: [
+        'dumbbell',
+        'barbell',
+        'plate',
+        'ez_bar',
+        'pullup_bar',
+        'dip_bar',
+        'squat_rack',
+        'adjustable_bench',
+        'single_cable_machine',
+        'lat_pulldown_cable',
+        'leg_press_machine',
+        'smith_machine',
+        'stack_machines',
+        'treadmill',
+        'elliptical_trainer',
+        'spinning',
+    ],
+    // All equipment is available in a full gym
+    full_gym: [
+        'barbell',
+        'dumbbell',
+        'kettlebell',
+        'plate',
+        'medicine_ball',
+        'ez_bar',
+        'landmine',
+        'trap_bar',
+        'pullup_bar',
+        'dip_bar',
+        'squat_rack',
+        'flat_bench',
+        'adjustable_bench',
+        'dual_cable_machine',
+        'single_cable_machine',
+        'lat_pulldown_cable',
+        'leg_press_machine',
+        'smith_machine',
+        't_bar',
+        'plate_machines',
+        'stack_machines',
+        'treadmill',
+        'elliptical_trainer',
+        'rowing_machine',
+        'spinning',
+        'stair_machine',
+        'air_bike',
+        'suspension_band',
+        'battle_rope',
+        'rings',
+        'rope',
+    ],
+};
+exports.hevyTrainerExerciseCategories = ['compound', 'isolation'];
 // These are the values that Philip decided for the default duration per frequency
 exports.defaultDurationPerFrequency = {
     1: 80,
@@ -120,18 +192,17 @@ const isFocusMuscleExtraExerciseAllowed = (templateName, focusMuscle) => {
     }
 };
 /**
- * Checks if an exercise is compatible with the user's equipments
+ * Checks if an exercise is compatible with the user's selected granular equipments
  *
- * - We enable plate exercises where users have barbell as an equipment
- * - None and other equipment categories are also always allowed
- * - Otherwise, the exercise is only allowed if the user has that equipment
+ * - If the exercise has no granular equipments, it is compatible no matter what the user has selected
+ * - Otherwise, the exercise is only allowed if the user has all the granular equipments
  */
-const isEquipmentCompatible = (exercise, allowedEquipments) => {
-    return (allowedEquipments.includes(exercise.equipment_category) ||
-        exercise.equipment_category === 'none' ||
-        exercise.equipment_category === 'other' ||
-        (exercise.equipment_category === 'plate' &&
-            allowedEquipments.includes('barbell')));
+const isEquipmentCompatible = (exercise, userSelectedGranularEquipments) => {
+    if (!exercise.granular_equipments ||
+        exercise.granular_equipments.length === 0) {
+        return true;
+    }
+    return exercise.granular_equipments.every((granularEquipment) => userSelectedGranularEquipments.includes(granularEquipment));
 };
 /**
  * Checks if the routine barbell exercise limit is exceeded
@@ -232,8 +303,8 @@ const isExerciseMatch = (exercise, criteria) => {
             criteria.exerciseCategory === 'compound');
     const levelMatch = (_b = (_a = exercise.level) === null || _a === void 0 ? void 0 : _a.includes(criteria.level)) !== null && _b !== void 0 ? _b : false;
     const goalMatch = (_d = (_c = exercise.goal) === null || _c === void 0 ? void 0 : _c.includes(criteria.goal)) !== null && _d !== void 0 ? _d : false;
-    const equipmentMatch = isEquipmentCompatible(exercise, criteria.equipments);
-    const barbellLimitOk = !isBarbellLimitExceeded(exercise, criteria.routineBarbellExerciseCount, criteria.equipments);
+    const equipmentMatch = isEquipmentCompatible(exercise, criteria.granularEquipments);
+    const barbellLimitOk = !isBarbellLimitExceeded(exercise, criteria.routineBarbellExerciseCount, criteria.granularEquipments);
     return (categoryMatch && levelMatch && goalMatch && equipmentMatch && barbellLimitOk);
 };
 /**
@@ -243,7 +314,7 @@ const isAlternativeIsolationExerciseMatch = (exercise, criteria) => {
     var _a, _b;
     const isIsolationCategory = criteria.exerciseCategory === 'isolation';
     const isAlternativeExercise = isolationExerciseAlternatives[criteria.muscleGroup].includes(exercise.id);
-    const equipmentMatch = isEquipmentCompatible(exercise, criteria.equipments);
+    const equipmentMatch = isEquipmentCompatible(exercise, criteria.granularEquipments);
     const levelMatch = (_b = (_a = exercise.level) === null || _a === void 0 ? void 0 : _a.includes(criteria.level)) !== null && _b !== void 0 ? _b : false;
     return (isIsolationCategory && isAlternativeExercise && equipmentMatch && levelMatch);
 };
@@ -317,7 +388,7 @@ exports.pickExerciseForPrescription = pickExerciseForPrescription;
  */
 const generateProgram = (params) => {
     var _a;
-    const { trainerAlgorithmSettings, selectedDays, selectedGoal, selectedLevel, selectedEquipments, selectedWorkoutDurationMinutes, exerciseStore, focusMuscle, excludedExerciseIds, } = params;
+    const { trainerAlgorithmSettings, selectedDays, selectedGoal, selectedLevel, selectedGranularEquipments, selectedWorkoutDurationMinutes, exerciseStore, focusMuscle, excludedExerciseIds, } = params;
     const routines = exports.programSplits[selectedDays];
     const program = {
         name: selectedDays,
@@ -356,7 +427,7 @@ const generateProgram = (params) => {
                 sortedExercises,
                 criteria: {
                     exerciseCategory: exercisePrescription.category,
-                    equipments: selectedEquipments,
+                    granularEquipments: selectedGranularEquipments,
                     muscleGroup,
                     routineBarbellExerciseCount,
                     level: selectedLevel,
@@ -397,7 +468,7 @@ const generateProgram = (params) => {
                     context: {
                         goal: selectedGoal,
                         level: selectedLevel,
-                        equipments: selectedEquipments,
+                        granularEquipments: selectedGranularEquipments,
                         focusMuscle,
                     },
                 });

package/built/index.d.ts

@@ -647,6 +647,9 @@ export type TrainingLevel = Lookup<typeof trainingLevels>;
 export type ExerciseCategory = Lookup<typeof exerciseCategories>;
 export type HevyTrainerProgramEquipment = Extract<Equipment, 'barbell' | 'dumbbell' | 'machine'>;
 export declare const hevyTrainerProgramEquipments: readonly ["barbell", "dumbbell", "machine"];
+export declare const granularEquipments: readonly ["barbell", "dumbbell", "kettlebell", "plate", "medicine_ball", "ez_bar", "landmine", "trap_bar", "pullup_bar", "dip_bar", "squat_rack", "flat_bench", "adjustable_bench", "dual_cable_machine", "single_cable_machine", "lat_pulldown_cable", "leg_press_machine", "smith_machine", "t_bar", "plate_machines", "stack_machines", "treadmill", "elliptical_trainer", "rowing_machine", "spinning", "stair_machine", "air_bike", "suspension_band", "battle_rope", "rings", "rope"];
+export type GranularEquipment = Lookup<typeof granularEquipments>;
+export declare const isGranularEquipment: (x: string) => x is GranularEquipment;
 export declare const weeklyTrainingFrequencies: readonly [1, 2, 3, 4, 5, 6];
 export type WeeklyTrainingFrequency = Lookup<typeof weeklyTrainingFrequencies>;
 /**
@@ -698,6 +701,7 @@ export interface LibraryExercise extends BaseExerciseTemplate {
     goal: TrainingGoal[] | undefined;
     level: TrainingLevel[] | undefined;
     category: ExerciseCategory | undefined;
+    granular_equipments: GranularEquipment[] | undefined;
     url_female?: string;
     thumbnail_url_female?: string;
 }
@@ -1251,7 +1255,9 @@ export interface HevyTrainerProgram {
     title: string;
     level: TrainingLevel;
     goal: TrainingGoal;
+    /** @deprecated Use granular_equipments instead */
     equipments: HevyTrainerProgramEquipment[];
+    granular_equipments: GranularEquipment[];
     weekly_frequency: WeeklyTrainingFrequency;
     routines: HevyTrainerRoutine[];
     focus_muscle?: SimplifiedMuscleGroup;
@@ -1263,7 +1269,9 @@ export interface PostHevyTrainerProgramRequestBody {
         title: string;
         level: TrainingLevel;
         goal: TrainingGoal;
+        /** @deprecated Use granular_equipments instead */
         equipments: HevyTrainerProgramEquipment[];
+        granular_equipments: GranularEquipment[];
         weekly_frequency: WeeklyTrainingFrequency;
         focus_muscle?: SimplifiedMuscleGroup;
         routines: RoutineUpdate[];
@@ -1277,7 +1285,9 @@ export interface UpdateHevyTrainerProgramRequestBody {
         title: string;
         level: TrainingLevel;
         goal: TrainingGoal;
+        /** @deprecated Use granular_equipments instead */
         equipments: HevyTrainerProgramEquipment[];
+        granular_equipments: GranularEquipment[];
         weekly_frequency: WeeklyTrainingFrequency;
         focus_muscle?: SimplifiedMuscleGroup;
         next_workout_index?: number;
@@ -1915,10 +1925,6 @@ export interface ExerciseHistoryWorkout {
 export declare const supportedScopes: readonly ["read-workout", "modify-workout", "read-routine", "modify-routine", "unrestricted"];
 export type OAuthScope = Lookup<typeof supportedScopes>;
 export declare const isOAuthScope: (x: string) => x is OAuthScope;
-export interface MuscleGroupSetCount {
-    muscleGroup: MuscleGroup;
-    sets: number;
-}
 export interface WorkoutsWithMediaBackofficeResponse {
     username: string;
     workouts: {

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.isHevyTrainerRoutine = 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.parseClientAuthTokenResponse = exports.isCoachRole = exports.isErrorResponse = exports.isLivePRVolumeOption = exports.isTimerVolumeOption = exports.isWeekday = exports.orderedWeekdays = exports.isBodyMeasurementUnit = exports.isDistanceUnitShort = exports.isDistanceUnit = exports.isWeightUnit = void 0;
-exports.isOAuthScope = exports.supportedScopes = exports.isSuggestedUserSource = exports.isValidUserWorkoutMetricsType = exports.isBodyMeasurementKey = exports.measurementsList = void 0;
+exports.isHeartRateSamples = exports.isPublicWorkout = exports.isSetType = exports.isRPE = exports.validRpeValues = exports.isSetPersonalRecordType = exports.supportedInstructionsLanguages = exports.weeklyTrainingFrequencies = exports.isGranularEquipment = exports.granularEquipments = 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.parseClientAuthTokenResponse = exports.isCoachRole = exports.isErrorResponse = exports.isLivePRVolumeOption = exports.isTimerVolumeOption = exports.isWeekday = exports.orderedWeekdays = exports.isBodyMeasurementUnit = exports.isDistanceUnitShort = exports.isDistanceUnit = exports.isWeightUnit = void 0;
+exports.isOAuthScope = exports.supportedScopes = exports.isSuggestedUserSource = exports.isValidUserWorkoutMetricsType = exports.isBodyMeasurementKey = exports.measurementsList = exports.isHevyTrainerRoutine = exports.isWorkoutBiometrics = void 0;
 const typeUtils_1 = require("./typeUtils");
 __exportStar(require("./constants"), exports);
 __exportStar(require("./utils"), exports);
@@ -232,6 +232,41 @@ exports.hevyTrainerProgramEquipments = [
     'dumbbell',
     'machine',
 ];
+exports.granularEquipments = [
+    'barbell',
+    'dumbbell',
+    'kettlebell',
+    'plate',
+    'medicine_ball',
+    'ez_bar',
+    'landmine',
+    'trap_bar',
+    'pullup_bar',
+    'dip_bar',
+    'squat_rack',
+    'flat_bench',
+    'adjustable_bench',
+    'dual_cable_machine',
+    'single_cable_machine',
+    'lat_pulldown_cable',
+    'leg_press_machine',
+    'smith_machine',
+    't_bar',
+    'plate_machines',
+    'stack_machines',
+    'treadmill',
+    'elliptical_trainer',
+    'rowing_machine',
+    'spinning',
+    'stair_machine',
+    'air_bike',
+    'suspension_band',
+    'battle_rope',
+    'rings',
+    'rope',
+];
+const isGranularEquipment = (x) => (0, typeUtils_1.isInArray)(x, exports.granularEquipments);
+exports.isGranularEquipment = isGranularEquipment;
 exports.weeklyTrainingFrequencies = [1, 2, 3, 4, 5, 6];
 exports.supportedInstructionsLanguages = [
     'en',

package/package.json

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