hevy-shared 1.0.567 → 1.0.569

package/built/index.d.ts

@@ -1,4 +1,4 @@
-import { Lookup } from './typeUtils';
+import { Lookup as _Lookup } from './typeUtils';
 export * from './constants';
 export * from './utils';
 export * from './units';
@@ -16,8 +16,12 @@ export * from './normalizedWorkoutUtils';
 export * from './routineUtils';
 export * from './typeUtils';
 export * from './async';
+export * from './index.zod';
 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>;
+/**
+ * @schema enum(['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;
 export type WeightUnit = 'kg' | 'lbs';
 export declare const isWeightUnit: (x: string) => x is WeightUnit;
@@ -29,13 +33,22 @@ export type BodyMeasurementUnit = 'cm' | 'in';
 export declare const isBodyMeasurementUnit: (x: string) => x is BodyMeasurementUnit;
 /** Monday is first */
 export declare const orderedWeekdays: readonly ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"];
-export type Weekday = Lookup<typeof orderedWeekdays>;
+/**
+ * @schema enum(['monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sunday'])
+ */
+export type Weekday = _Lookup<typeof orderedWeekdays>;
 export declare const isWeekday: (x: string) => x is Weekday;
 declare const _timerVolumeOptions: readonly ["off", "low", "normal", "high"];
-export type TimerVolumeOption = Lookup<typeof _timerVolumeOptions>;
+/**
+ * @schema enum(['off', 'low', 'normal', 'high'])
+ */
+export type TimerVolumeOption = _Lookup<typeof _timerVolumeOptions>;
 export declare const isTimerVolumeOption: (x: string) => x is TimerVolumeOption;
 declare const _livePRVolumeOption: readonly ["off", "low", "normal", "high"];
-export type LivePRVolumeOption = Lookup<typeof _livePRVolumeOption>;
+/**
+ * @schema enum(['off', 'low', 'normal', 'high'])
+ */
+export type LivePRVolumeOption = _Lookup<typeof _livePRVolumeOption>;
 export declare const isLivePRVolumeOption: (x: string) => x is LivePRVolumeOption;
 export interface ErrorResponse {
     error: string;
@@ -109,7 +122,10 @@ export interface CoachAppPushTarget {
     token: string;
 }
 declare const _coachRoles: readonly ["member", "admin", "owner"];
-export type CoachRole = Lookup<typeof _coachRoles>;
+/**
+ * @schema enum(['member', 'admin', 'owner'])
+ */
+export type CoachRole = _Lookup<typeof _coachRoles>;
 export declare const isCoachRole: (role: any) => role is CoachRole;
 export interface CoachAccount {
     id: string;
@@ -434,7 +450,10 @@ export interface UserShadowBanMetadata {
     recaptcha_score?: number | null;
 }
 declare const _supportedProStores: readonly ["app_store", "play_store", "stripe", "hevy-gift", "gympass", "paddle", "hevy-coach"];
-type UserHevyProSubcriptionStore = Lookup<typeof _supportedProStores>;
+/**
+ * @schema enum(['app_store', 'play_store', 'stripe', 'hevy-gift', 'gympass', 'paddle', 'hevy-coach'])
+ */
+type UserHevyProSubcriptionStore = _Lookup<typeof _supportedProStores>;
 export interface UserHevyProSubcription {
     is_pro: boolean;
     active_subscription?: {
@@ -470,10 +489,19 @@ export interface UserPreferences {
     volume_includes_warmup_sets?: boolean;
 }
 export type UpdateUserPreferencesRequest = Omit<UserPreferences, 'username' | 'volume_includes_warmup_sets'>;
+/**
+ * @schema enum(['not-following', 'following', 'requested'])
+ */
 export type FollowingStatus = 'not-following' | 'following' | 'requested';
+/**
+ * @schema record(FollowingStatus.exclude(['not-following']))
+ */
 export type FollowingStatusMap = {
-    [id: string]: Omit<FollowingStatus, 'not-following'>;
+    [id: string]: Exclude<FollowingStatus, 'not-following'>;
 };
+/**
+ * @schema record(z.enum(['following', 'requested']))
+ */
 export type FollowingStatusesResponse = {
     [id: string]: 'following' | 'requested';
 };
@@ -547,19 +575,31 @@ export interface PublicUserProfile {
     last_workout?: Workout;
 }
 export declare const muscleGroups: readonly ["abdominals", "abductors", "adductors", "biceps", "lower_back", "upper_back", "cardio", "chest", "calves", "forearms", "glutes", "hamstrings", "lats", "quadriceps", "shoulders", "triceps", "traps", "neck", "full_body", "other"];
-export type MuscleGroup = Lookup<typeof muscleGroups>;
+/**
+ * @schema enum(['abdominals', 'abductors', 'adductors', 'biceps', 'lower_back', 'upper_back', 'cardio', 'chest', 'calves', 'forearms', 'glutes', 'hamstrings', 'lats', 'quadriceps', 'shoulders', 'triceps', 'traps', '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", "abductors", "adductors", "biceps", "lower_back", "upper_back", "cardio", "chest", "calves", "forearms", "glutes", "hamstrings", "lats", "quadriceps", "shoulders", "triceps", "traps", "neck", "full_body", "other"];
-export type MuscleGroupFilter = Lookup<typeof muscleGroupFilters>;
+/**
+ * @schema enum(['all_muscles', 'abdominals', 'abductors', 'adductors', 'biceps', 'lower_back', 'upper_back', 'cardio', 'chest', 'calves', 'forearms', 'glutes', 'hamstrings', 'lats', 'quadriceps', 'shoulders', 'triceps', 'traps', 'neck', 'full_body', 'other'])
+ */
+export type MuscleGroupFilter = _Lookup<typeof muscleGroupFilters>;
 export declare const isMuscleGroupFilter: (x: string) => x is MuscleGroupFilter;
 /**
  * Equipment
  */
 export declare const equipments: readonly ["none", "barbell", "dumbbell", "kettlebell", "machine", "plate", "resistance_band", "suspension", "other"];
-export type Equipment = Lookup<typeof equipments>;
+/**
+ * @schema enum(['none', 'barbell', 'dumbbell', 'kettlebell', 'machine', 'plate', 'resistance_band', 'suspension', 'other'])
+ */
+export type Equipment = _Lookup<typeof equipments>;
 export declare const isEquipment: (x: string) => x is Equipment;
 export declare const equipmentFilters: readonly ["all_equipment", "none", "barbell", "dumbbell", "kettlebell", "machine", "plate", "resistance_band", "suspension", "other"];
-export type EquipmentFilter = Lookup<typeof equipmentFilters>;
+/**
+ * @schema enum(['all_equipment', 'none', 'barbell', 'dumbbell', 'kettlebell', 'machine', 'plate', 'resistance_band', 'suspension', 'other'])
+ */
+export type EquipmentFilter = _Lookup<typeof equipmentFilters>;
 export declare const isEquipmentFilter: (x: string) => x is EquipmentFilter;
 export declare const exerciseRepTypes: readonly ["weight_reps", "reps_only", "bodyweight_reps", "bodyweight_assisted_reps"];
 /**
@@ -570,11 +610,20 @@ export declare const exerciseRepTypes: readonly ["weight_reps", "reps_only", "bo
  * bodyweight_assisted_reps = Pull Ups (Assisted)
  * reps_only = Pull ups
  */
-export type ExerciseRepType = Lookup<typeof exerciseRepTypes>;
+/**
+ * @schema enum(['weight_reps', 'reps_only', 'bodyweight_reps', 'bodyweight_assisted_reps'])
+ */
+export type ExerciseRepType = _Lookup<typeof exerciseRepTypes>;
 export declare const isExerciseRepType: (x: any) => x is ExerciseRepType;
 export declare const exerciseTypes: readonly ["weight_reps", "reps_only", "bodyweight_reps", "bodyweight_assisted_reps", "duration", "weight_duration", "distance_duration", "short_distance_weight", "floors_duration", "steps_duration"];
-export type ExerciseType = Lookup<typeof exerciseTypes>;
+/**
+ * @schema enum(['weight_reps', 'reps_only', 'bodyweight_reps', 'bodyweight_assisted_reps', 'duration', 'weight_duration', 'distance_duration', 'short_distance_weight', 'floors_duration', 'steps_duration'])
+ */
+export type ExerciseType = _Lookup<typeof exerciseTypes>;
 export declare const isExerciseType: (x: any) => x is ExerciseType;
+/**
+ * @schema enum(['weight_reps', 'reps_only', 'bodyweight_reps', 'bodyweight_assisted_reps', 'duration', 'weight_duration', 'distance_duration', 'short_distance_weight'])
+ */
 export type CustomExerciseType = Exclude<ExerciseType, 'floors_duration' | 'steps_duration'>;
 export declare const customExericseTypes: CustomExerciseType[];
 export declare const isCustomExerciseType: (x: any) => x is CustomExerciseType;
@@ -622,7 +671,12 @@ export interface LibraryExercise extends BaseExerciseTemplate {
     zh_cn_title?: string;
     zh_tw_title?: string;
     localised_instructions?: {
-        [language in InstructionsLanguage]?: string;
+        en?: string;
+        it?: string;
+        de?: string;
+        es?: string;
+        fr?: string;
+        pt?: string;
     };
 }
 /**
@@ -639,20 +693,29 @@ export interface CustomExercise extends BaseExerciseTemplate {
     parent_exercise_template_id?: string;
 }
 export declare const supportedInstructionsLanguages: readonly ["en", "it", "de", "es", "fr", "pt"];
-export type InstructionsLanguage = Lookup<typeof supportedInstructionsLanguages>;
+/**
+ * @schema enum(['en', 'it', 'de', 'es', 'fr', 'pt'])
+ */
+export type InstructionsLanguage = _Lookup<typeof supportedInstructionsLanguages>;
 /** Workouts */
 declare const _setPersonalRecordTypes: readonly ["best_weight", "best_reps", "best_volume", "best_1rm", "best_duration", "best_distance"];
-export type SetPersonalRecordType = Lookup<typeof _setPersonalRecordTypes>;
+/**
+ * @schema enum(['best_weight', 'best_reps', 'best_volume', 'best_1rm', 'best_duration', 'best_distance'])
+ */
+export type SetPersonalRecordType = _Lookup<typeof _setPersonalRecordTypes>;
 export interface SetPersonalRecord {
     exercise_template_id: string;
     type: SetPersonalRecordType;
     record: number;
 }
 export declare const validRpeValues: readonly [6, 7, 7.5, 8, 8.5, 9, 9.5, 10];
-export type RPE = Lookup<typeof validRpeValues>;
+export type RPE = 6 | 7 | 7.5 | 8 | 8.5 | 9 | 9.5 | 10;
 export declare const isRPE: (x: number) => x is RPE;
 declare const _setTypes: readonly ["warmup", "normal", "failure", "dropset"];
-export type SetType = Lookup<typeof _setTypes>;
+/**
+ * @schema enum(['warmup', 'normal', 'failure', 'dropset'])
+ */
+export type SetType = _Lookup<typeof _setTypes>;
 export declare const isSetType: (x: string) => x is SetType;
 export interface RepRange {
     start: number | null;
@@ -738,7 +801,6 @@ export interface WorkoutComment {
     like_count: number;
     is_liked_by_user: boolean;
     parent_comment_id?: number;
-    replying_to_comment_id?: number;
 }
 export interface WorkoutImage {
     type: 'image';
@@ -908,13 +970,15 @@ export interface PostWorkoutRequestSet {
     custom_metric?: number;
     rpe?: RPE;
 }
+type UpdateWorkoutRequestWorkoutOptionalFields = Pick<PostWorkoutRequestWorkout, 'title' | 'description' | 'media' | 'exercises' | 'is_private' | 'is_biometrics_public'>;
+type UpdateWorkoutRequestWorkoutRequiredFields = Required<Pick<PostWorkoutRequestWorkout, 'start_time' | 'end_time'>>;
 /**
  * Used to update an existing workout. Props that are defined will be used to
  * update the corresponding values of the workout in the database, and those
  * that are undefined will not be changed.
  */
-export type UpdateWorkoutRequestWorkout = Partial<Pick<PostWorkoutRequestWorkout, 'title' | 'description' | 'media' | 'exercises' | 'is_private' | 'is_biometrics_public'>> & {
-    start_and_end_time?: Required<Pick<PostWorkoutRequestWorkout, 'start_time' | 'end_time'>>;
+export type UpdateWorkoutRequestWorkout = Partial<UpdateWorkoutRequestWorkoutOptionalFields> & {
+    start_and_end_time?: UpdateWorkoutRequestWorkoutRequiredFields;
 };
 /** Routines */
 export interface RoutineSet {
@@ -1147,10 +1211,28 @@ export interface OutstandingInvitesForCoachTeamResponse {
     invites: CoachTeamInvite[];
 }
 export declare const measurementsList: readonly ["weight_kg", "fat_percent", "neck_cm", "shoulder_cm", "chest_cm", "left_bicep_cm", "right_bicep_cm", "left_forearm_cm", "right_forearm_cm", "abdomen", "waist", "hips", "left_thigh", "right_thigh", "left_calf", "right_calf"];
-type MeasurementProperties = {
-    [key in typeof measurementsList[number]]?: number;
-};
-export type BodyMeasurementKey = Lookup<typeof measurementsList>;
+interface MeasurementProperties {
+    weight_kg?: number;
+    fat_percent?: number;
+    neck_cm?: number;
+    shoulder_cm?: number;
+    chest_cm?: number;
+    left_bicep_cm?: number;
+    right_bicep_cm?: number;
+    left_forearm_cm?: number;
+    right_forearm_cm?: number;
+    abdomen?: number;
+    waist?: number;
+    hips?: number;
+    left_thigh?: number;
+    right_thigh?: number;
+    left_calf?: number;
+    right_calf?: number;
+}
+/**
+ * @schema enum(['weight_kg', 'fat_percent', 'neck_cm', 'shoulder_cm', 'chest_cm', 'left_bicep_cm', 'right_bicep_cm', 'left_forearm_cm', 'right_forearm_cm', 'abdomen', 'waist', 'hips', 'left_thigh', 'right_thigh', 'left_calf', 'right_calf'])
+ */
+export type BodyMeasurementKey = _Lookup<typeof measurementsList>;
 export declare const isBodyMeasurementKey: (key: string) => key is BodyMeasurementKey;
 export interface BodyMeasurement extends MeasurementProperties {
     id: number;
@@ -1276,9 +1358,28 @@ export interface UserExerciseSet {
     user_bodyweight_kg: number | null;
     custom_metric: number | null;
 }
-export type SetCountMuscleSplitResponse = {
-    [key in MuscleGroup]: number;
-};
+export interface SetCountMuscleSplitResponse {
+    abdominals: number;
+    abductors: number;
+    adductors: number;
+    biceps: number;
+    lower_back: number;
+    upper_back: number;
+    cardio: number;
+    chest: number;
+    calves: number;
+    forearms: number;
+    glutes: number;
+    hamstrings: number;
+    lats: number;
+    quadriceps: number;
+    shoulders: number;
+    triceps: number;
+    traps: number;
+    neck: number;
+    full_body: number;
+    other: number;
+}
 export type ComparableExerciseTemplatesResponse = Array<{
     exercise_template_id: string;
 }>;
@@ -1308,7 +1409,7 @@ export interface ExerciseLeaderboardResponse {
 }
 export type StrengthLevel = 'beginner' | 'intermediate' | 'advanced' | 'elite';
 export interface GetStrengthLevelParams {
-    sex: Omit<Sex, 'other'>;
+    sex: 'male' | 'female';
     best_1rm_kg: number;
     exercise_template_id: string;
     age: number;
@@ -1429,10 +1530,14 @@ export interface StripeCustomerPortalSessionRequest {
 export interface StripeCustomerPortalSessionResponse {
     url: string;
 }
+/**
+ * @schema union([z.string(), z.number(), z.boolean(), z.array(z.any())]).nullable()
+ */
 export type UserValue = string | number | boolean | null | UserValue[];
-export type UserKeyValues = {
-    [key: string]: UserValue;
-};
+export type UserKeyValues = Record<string, UserValue>;
+/**
+ * @schema enum(['male', 'female', 'other'])
+ */
 export type Sex = 'male' | 'female' | 'other';
 /**
  * Used for the chat backend to validate authentication details
@@ -1441,8 +1546,9 @@ export type UserAuthenticationValidationResponse = 'unauthorized' | 'authorized_
 declare const _validUserWorkoutMetricsTypes: readonly ["duration", "reps"];
 /**
  * Used for hevy-web for fetching profile metrics and calendar data
+ * @schema enum(['duration', 'reps'])
  */
-export type UserWorkoutMetricsType = Lookup<typeof _validUserWorkoutMetricsTypes>;
+export type UserWorkoutMetricsType = _Lookup<typeof _validUserWorkoutMetricsTypes>;
 export declare const isValidUserWorkoutMetricsType: (x: any) => x is UserWorkoutMetricsType;
 interface WorkoutMetricBase {
     workout_id: string;
@@ -1535,8 +1641,8 @@ interface BaseFeedback {
     type: FeedbackType;
     userId: string;
     message?: string;
-    data?: any;
-    debugInfo?: any;
+    data?: object | null;
+    debugInfo?: object | null;
 }
 export interface GeneralFeedback extends BaseFeedback {
     type: 'general';
@@ -1604,8 +1710,8 @@ export type BackofficeFeedback = {
     type: string;
     username?: string;
     message?: string;
-    data?: any;
-    debug_info?: any;
+    data?: object | null;
+    debug_info?: object | null;
     created_at: Date;
 };
 export interface BackofficeFeedbacksResponse {

package/built/index.js

@@ -15,7 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isValidUserWorkoutMetricsType = exports.isBodyMeasurementKey = exports.measurementsList = exports.isWorkoutBiometrics = exports.isHeartRateSamples = exports.isPublicWorkout = exports.isSetType = exports.isRPE = exports.validRpeValues = exports.supportedInstructionsLanguages = 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.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;
-const typeUtils_1 = require("./typeUtils");
+const typeUtils_1 = require("./typeUtils"); // import as _Lookup to avoid a lint error as ts-to-zod emits an unused dummy value
 __exportStar(require("./constants"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./units"), exports);
@@ -33,6 +33,7 @@ __exportStar(require("./normalizedWorkoutUtils"), exports);
 __exportStar(require("./routineUtils"), exports);
 __exportStar(require("./typeUtils"), exports);
 __exportStar(require("./async"), exports);
+__exportStar(require("./index.zod"), exports);
 exports.supportedLanguages = [
     'en',
     'es',