import { z } from 'zod';
import { RequiredUserIdSchema } from '../../schemas/required-refs/RequiredUserId.js';
import { UUIDSchema } from '../../schemas/UUIDSchema.js';
import {
  BaseDocumentWithTypeSchema,
  BaseDocumentWithUpdatedAndCreatedDatesSchema
} from '../BaseDocument.js';

/**
 * The docType value for WorkoutSet documents.
 */
export const WorkoutSet_docType = 'workoutSet';

/**
 * The schema for {@link WorkoutSet} documents.
 */
export const WorkoutSetSchema = z.object({
  ...BaseDocumentWithTypeSchema.shape,
  ...RequiredUserIdSchema.shape,
  ...BaseDocumentWithUpdatedAndCreatedDatesSchema.shape,
  docType: z.literal(WorkoutSet_docType).default(WorkoutSet_docType),
  /**
   * The ID of the workout exercise this set belongs to.
   */
  workoutExerciseId: UUIDSchema,
  /**
   * The ID of the workout session this set was performed in.
   */
  workoutSessionId: UUIDSchema,
  /**
   * The ID of the workout session exercise this set belongs to.
   */
  workoutSessionExerciseId: UUIDSchema,
  /**
   * The planned number of reps for this set.
   */
  plannedReps: z.int().positive().nullish(),
  /**
   * The planned weight for this set.
   */
  plannedWeight: z.number().nullish(),
  /**
   * The planned Reps in Reserve (RIR) for this set.
   *
   * RIR is the set's proximity to muscle failure - how many reps you have left
   * before you completely fail to produce the movement.
   *
   * Recommended range is 2-3 RIR on average, with 0-5 RIR being the effective range.
   */
  plannedRir: z.int().nonnegative().nullish(),
  /**
   * The actual number of reps performed in this set.
   */
  actualReps: z.int().nonnegative().nullish(),
  /**
   * The actual weight used for this set.
   */
  actualWeight: z.number().nullish(),
  /**
   * The actual Reps in Reserve (RIR) for this set.
   *
   * This should be recorded to track proximity to failure and adjust future
   * programming.
   */
  rir: z.int().nullish(),
  /**
   * Custom exercise properties for this set.
   *
   * This is populated from WorkoutExercise.customProperties at creation time.
   * When customProperties are changed on the exercise, they should be updated
   * on all existing WorkoutSet documents with that WorkoutExercise linked to it.
   */
  exerciseProperties: z.record(z.string(), z.unknown()).nullish()
});

/**
 * Represents a single set of an exercise performed during a workout session.
 *
 * Sets track both planned and actual performance data, allowing for comparison
 * between programming and execution. This is crucial for algorithm-based
 * progression and adaptation.
 *
 * Effective sets are defined as sets with:
 * - 5-30 reps
 * - 0-5 RIR (Reps in Reserve)
 * - Weight between 30% and 85% of 1RM per rep
 *
 * The recommended average RIR is 2-3 to balance stimulus and fatigue.
 */
export type WorkoutSet = z.infer<typeof WorkoutSetSchema>;

/**
 * A {@link WorkoutSet} with all planned and actual performance fields guaranteed non-nullable.
 */
export type CompletedWorkoutSet = WorkoutSet & {
  plannedReps: NonNullable<WorkoutSet['plannedReps']>;
  plannedWeight: NonNullable<WorkoutSet['plannedWeight']>;
  plannedRir: NonNullable<WorkoutSet['plannedRir']>;
  actualReps: NonNullable<WorkoutSet['actualReps']>;
  actualWeight: NonNullable<WorkoutSet['actualWeight']>;
  rir: NonNullable<WorkoutSet['rir']>;
};