@aneuhold/core-ts-db-lib 4.0.4 → 4.1.0

package/lib/documents/workout/WorkoutSessionExercise.js

@@ -0,0 +1,66 @@
+import { z } from 'zod';
+import { FatigueSchema } from '../../embedded-types/workout/Fatigue.js';
+import { RsmSchema } from '../../embedded-types/workout/Rsm.js';
+import { RequiredUserIdSchema } from '../../schemas/required-refs/RequiredUserId.js';
+import { BaseDocumentWithTypeSchema, BaseDocumentWithUpdatedAndCreatedDatesSchema } from '../BaseDocument.js';
+/**
+ * The docType value for WorkoutSessionExercise documents.
+ */
+export const WorkoutSessionExercise_docType = 'workoutSessionExercise';
+/**
+ * The schema for {@link WorkoutSessionExercise} documents.
+ */
+export const WorkoutSessionExerciseSchema = z.object({
+    ...BaseDocumentWithTypeSchema.shape,
+    ...RequiredUserIdSchema.shape,
+    ...BaseDocumentWithUpdatedAndCreatedDatesSchema.shape,
+    docType: z.literal(WorkoutSessionExercise_docType).default(WorkoutSessionExercise_docType),
+    /**
+     * The ID of the workout session this exercise belongs to.
+     */
+    workoutSessionId: z.uuidv7().transform((val) => val),
+    /**
+     * The ID of the workout exercise being performed.
+     */
+    workoutExerciseId: z.uuidv7().transform((val) => val),
+    /**
+     * The order of sets for this exercise, represented as an array of WorkoutSet IDs.
+     */
+    setOrder: z.array(z.uuidv7().transform((val) => val)).default([]),
+    /**
+     * The Raw Stimulus Magnitude for this specific exercise within the session.
+     *
+     * This is the sum of mindMuscleConnection, pump, and disruption (0-9).
+     */
+    rsm: RsmSchema.nullish(),
+    /**
+     * The fatigue measurement for this specific exercise within the session.
+     *
+     * The total fatigue score is the sum of all three components (0-9).
+     */
+    fatigue: FatigueSchema.nullish(),
+    /**
+     * The soreness score for this session exercise (0-3).
+     *
+     * - 0: You did not get at all sore in the target muscles
+     * - 1: You got stiff for a few hours after training and had mild soreness that resolved by next session
+     * - 2: You got DOMS that resolved just in time for the next session
+     * - 3: You got DOMS that remained for the next session
+     */
+    sorenessScore: z.int().min(0).max(3).nullish(),
+    /**
+     * The performance score for this session exercise (0-3).
+     *
+     * - 0: You hit your target reps, but had to do 2+ more reps than planned to hit target RIR, or hit target reps at 2+ reps before target RIR
+     * - 1: You hit your target reps, but had to do 0-1 more reps than planned to hit target RIR, or hit target reps at 1 rep before target RIR
+     * - 2: You hit your target reps after your target RIR
+     * - 3: You could not match last week's reps at any RIR
+     */
+    performanceScore: z.int().min(0).max(3).nullish(),
+    /**
+     * Determines if this exercise is being used as a recovery exercise, due to high soreness / low
+     * performance in the previous microcycle for this exercise.
+     */
+    isRecoveryExercise: z.boolean().default(false)
+});
+//# sourceMappingURL=WorkoutSessionExercise.js.map

package/lib/documents/workout/WorkoutSessionExercise.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WorkoutSessionExercise.js","sourceRoot":"","sources":["../../../src/documents/workout/WorkoutSessionExercise.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AACxE,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,+CAA+C,CAAC;AACrF,OAAO,EACL,0BAA0B,EAC1B,4CAA4C,EAC7C,MAAM,oBAAoB,CAAC;AAE5B;;GAEG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,wBAAwB,CAAC;AAEvE;;GAEG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,GAAG,0BAA0B,CAAC,KAAK;IACnC,GAAG,oBAAoB,CAAC,KAAK;IAC7B,GAAG,4CAA4C,CAAC,KAAK;IACrD,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,8BAA8B,CAAC,CAAC,OAAO,CAAC,8BAA8B,CAAC;IAC1F;;OAEG;IACH,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAW,CAAC;IAC5D;;OAEG;IACH,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAW,CAAC;IAC7D;;OAEG;IACH,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAW,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACzE;;;;OAIG;IACH,GAAG,EAAE,SAAS,CAAC,OAAO,EAAE;IACxB;;;;OAIG;IACH,OAAO,EAAE,aAAa,CAAC,OAAO,EAAE;IAChC;;;;;;;OAOG;IACH,aAAa,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE;IAC9C;;;;;;;OAOG;IACH,gBAAgB,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE;IACjD;;;OAGG;IACH,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;CAC/C,CAAC,CAAC"}

package/lib/documents/workout/WorkoutSessionExercise.ts

@@ -0,0 +1,79 @@
+import type { UUID } from 'crypto';
+import { z } from 'zod';
+import { FatigueSchema } from '../../embedded-types/workout/Fatigue.js';
+import { RsmSchema } from '../../embedded-types/workout/Rsm.js';
+import { RequiredUserIdSchema } from '../../schemas/required-refs/RequiredUserId.js';
+import {
+  BaseDocumentWithTypeSchema,
+  BaseDocumentWithUpdatedAndCreatedDatesSchema
+} from '../BaseDocument.js';
+
+/**
+ * The docType value for WorkoutSessionExercise documents.
+ */
+export const WorkoutSessionExercise_docType = 'workoutSessionExercise';
+
+/**
+ * The schema for {@link WorkoutSessionExercise} documents.
+ */
+export const WorkoutSessionExerciseSchema = z.object({
+  ...BaseDocumentWithTypeSchema.shape,
+  ...RequiredUserIdSchema.shape,
+  ...BaseDocumentWithUpdatedAndCreatedDatesSchema.shape,
+  docType: z.literal(WorkoutSessionExercise_docType).default(WorkoutSessionExercise_docType),
+  /**
+   * The ID of the workout session this exercise belongs to.
+   */
+  workoutSessionId: z.uuidv7().transform((val) => val as UUID),
+  /**
+   * The ID of the workout exercise being performed.
+   */
+  workoutExerciseId: z.uuidv7().transform((val) => val as UUID),
+  /**
+   * The order of sets for this exercise, represented as an array of WorkoutSet IDs.
+   */
+  setOrder: z.array(z.uuidv7().transform((val) => val as UUID)).default([]),
+  /**
+   * The Raw Stimulus Magnitude for this specific exercise within the session.
+   *
+   * This is the sum of mindMuscleConnection, pump, and disruption (0-9).
+   */
+  rsm: RsmSchema.nullish(),
+  /**
+   * The fatigue measurement for this specific exercise within the session.
+   *
+   * The total fatigue score is the sum of all three components (0-9).
+   */
+  fatigue: FatigueSchema.nullish(),
+  /**
+   * The soreness score for this session exercise (0-3).
+   *
+   * - 0: You did not get at all sore in the target muscles
+   * - 1: You got stiff for a few hours after training and had mild soreness that resolved by next session
+   * - 2: You got DOMS that resolved just in time for the next session
+   * - 3: You got DOMS that remained for the next session
+   */
+  sorenessScore: z.int().min(0).max(3).nullish(),
+  /**
+   * The performance score for this session exercise (0-3).
+   *
+   * - 0: You hit your target reps, but had to do 2+ more reps than planned to hit target RIR, or hit target reps at 2+ reps before target RIR
+   * - 1: You hit your target reps, but had to do 0-1 more reps than planned to hit target RIR, or hit target reps at 1 rep before target RIR
+   * - 2: You hit your target reps after your target RIR
+   * - 3: You could not match last week's reps at any RIR
+   */
+  performanceScore: z.int().min(0).max(3).nullish(),
+  /**
+   * Determines if this exercise is being used as a recovery exercise, due to high soreness / low
+   * performance in the previous microcycle for this exercise.
+   */
+  isRecoveryExercise: z.boolean().default(false)
+});
+
+/**
+ * Represents a specific exercise performed within a workout session.
+ *
+ * This is a join entity that connects a WorkoutSession to a WorkoutExercise
+ * and contains the sets performed for that exercise in that session.
+ */
+export type WorkoutSessionExercise = z.infer<typeof WorkoutSessionExerciseSchema>;

package/lib/documents/workout/WorkoutSet.d.ts

@@ -0,0 +1,41 @@
+import { z } from 'zod';
+/**
+ * The docType value for WorkoutSet documents.
+ */
+export declare const WorkoutSet_docType = "workoutSet";
+/**
+ * The schema for {@link WorkoutSet} documents.
+ */
+export declare const WorkoutSetSchema: z.ZodObject<{
+    docType: z.ZodDefault<z.ZodLiteral<"workoutSet">>;
+    workoutExerciseId: z.ZodPipe<z.ZodUUID, z.ZodTransform<`${string}-${string}-${string}-${string}-${string}`, string>>;
+    workoutSessionId: z.ZodPipe<z.ZodUUID, z.ZodTransform<`${string}-${string}-${string}-${string}-${string}`, string>>;
+    workoutSessionExerciseId: z.ZodPipe<z.ZodUUID, z.ZodTransform<`${string}-${string}-${string}-${string}-${string}`, string>>;
+    plannedReps: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+    plannedWeight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    plannedRir: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+    actualReps: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+    actualWeight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    rir: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+    exerciseProperties: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    createdDate: z.ZodDefault<z.ZodDate>;
+    lastUpdatedDate: z.ZodDefault<z.ZodDate>;
+    _id: z.ZodPipe<z.ZodDefault<z.ZodUUID>, z.ZodTransform<`${string}-${string}-${string}-${string}-${string}`, string>>;
+    userId: z.ZodPipe<z.ZodUUID, z.ZodTransform<`${string}-${string}-${string}-${string}-${string}`, string>>;
+}, z.core.$strip>;
+/**
+ * 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>;
+//# sourceMappingURL=WorkoutSet.d.ts.map

package/lib/documents/workout/WorkoutSet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WorkoutSet.d.ts","sourceRoot":"","sources":["../../../src/documents/workout/WorkoutSet.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAOxB;;GAEG;AACH,eAAO,MAAM,kBAAkB,eAAe,CAAC;AAE/C;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;iBAyD3B,CAAC;AAEH;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC"}

package/lib/documents/workout/WorkoutSet.js

@@ -0,0 +1,69 @@
+import { z } from 'zod';
+import { RequiredUserIdSchema } from '../../schemas/required-refs/RequiredUserId.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: z.uuidv7().transform((val) => val),
+    /**
+     * The ID of the workout session this set was performed in.
+     */
+    workoutSessionId: z.uuidv7().transform((val) => val),
+    /**
+     * The ID of the workout session exercise this set belongs to.
+     */
+    workoutSessionExerciseId: z.uuidv7().transform((val) => val),
+    /**
+     * 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()
+});
+//# sourceMappingURL=WorkoutSet.js.map

package/lib/documents/workout/WorkoutSet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WorkoutSet.js","sourceRoot":"","sources":["../../../src/documents/workout/WorkoutSet.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,oBAAoB,EAAE,MAAM,+CAA+C,CAAC;AACrF,OAAO,EACL,0BAA0B,EAC1B,4CAA4C,EAC7C,MAAM,oBAAoB,CAAC;AAE5B;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,YAAY,CAAC;AAE/C;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,GAAG,0BAA0B,CAAC,KAAK;IACnC,GAAG,oBAAoB,CAAC,KAAK;IAC7B,GAAG,4CAA4C,CAAC,KAAK;IACrD,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;IAClE;;OAEG;IACH,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAW,CAAC;IAC7D;;OAEG;IACH,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAW,CAAC;IAC5D;;OAEG;IACH,wBAAwB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAW,CAAC;IACpE;;OAEG;IACH,WAAW,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE;IACzC;;OAEG;IACH,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE;IACnC;;;;;;;OAOG;IACH,UAAU,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE;IAC3C;;OAEG;IACH,UAAU,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE;IAC3C;;OAEG;IACH,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE;IAClC;;;;;OAKG;IACH,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE;IACtB;;;;;;OAMG;IACH,kBAAkB,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;CAChE,CAAC,CAAC"}

package/lib/documents/workout/WorkoutSet.ts

@@ -0,0 +1,90 @@
+import type { UUID } from 'crypto';
+import { z } from 'zod';
+import { RequiredUserIdSchema } from '../../schemas/required-refs/RequiredUserId.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: z.uuidv7().transform((val) => val as UUID),
+  /**
+   * The ID of the workout session this set was performed in.
+   */
+  workoutSessionId: z.uuidv7().transform((val) => val as UUID),
+  /**
+   * The ID of the workout session exercise this set belongs to.
+   */
+  workoutSessionExerciseId: z.uuidv7().transform((val) => val as UUID),
+  /**
+   * 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>;

package/lib/embedded-types/workout/Fatigue.d.ts

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+/**
+ * Zod schema for {@link Fatigue}.
+ */
+export declare const FatigueSchema: z.ZodObject<{
+    jointAndTissueDisruption: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+    perceivedEffort: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+    unusedMusclePerformance: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+}, z.core.$strip>;
+/**
+ * Fatigue measurement for a workout session or exercise.
+ *
+ * The Stimulus to Fatigue Ratio (SFR) can be calculated as RSM / total fatigue score.
+ */
+export type Fatigue = z.infer<typeof FatigueSchema>;
+//# sourceMappingURL=Fatigue.d.ts.map

package/lib/embedded-types/workout/Fatigue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Fatigue.d.ts","sourceRoot":"","sources":["../../../src/embedded-types/workout/Fatigue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,eAAO,MAAM,aAAa;;;;iBA4BxB,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC"}

package/lib/embedded-types/workout/Fatigue.js

@@ -0,0 +1,34 @@
+import { z } from 'zod';
+/**
+ * Zod schema for {@link Fatigue}.
+ */
+export const FatigueSchema = z.object({
+    /**
+     * Joint and connective tissue disruption score (0-3).
+     *
+     * - 0: You had minimal to no pain or perturbation in your joints or connective tissues
+     * - 1: You had some pain or perturbation in your joints and connective tissues but recovered by the next day
+     * - 2: You had some persistent pain or tightness in your connective tissues that lasted through the following day or several days
+     * - 3: You develop chronic pain in the joints and connective tissues that persists across days to weeks or longer
+     */
+    jointAndTissueDisruption: z.int().min(0).max(3).nullish(),
+    /**
+     * Perceived effort score (0-3).
+     *
+     * - 0: Training felt very easy and hardly taxed you psychologically
+     * - 1: You put effort into the training, but felt recovered by the end of the day
+     * - 2: You put a large effort into the training and felt drained through the next day
+     * - 3: You put an all-out effort into the training and felt drained for days
+     */
+    perceivedEffort: z.int().min(0).max(3).nullish(),
+    /**
+     * Unused muscle performance score (0-3).
+     *
+     * - 0: Performance on subsequent exercises targeting unused muscles was better than expected
+     * - 1: Performance on subsequent exercises targeting unused muscles was as expected
+     * - 2: Performance on subsequent exercises targeting unused muscles was worse than expected
+     * - 3: Your performance on subsequent exercises targeting unused muscles was hugely deteriorated
+     */
+    unusedMusclePerformance: z.int().min(0).max(3).nullish()
+});
+//# sourceMappingURL=Fatigue.js.map

package/lib/embedded-types/workout/Fatigue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Fatigue.js","sourceRoot":"","sources":["../../../src/embedded-types/workout/Fatigue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC;;;;;;;OAOG;IACH,wBAAwB,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE;IACzD;;;;;;;OAOG;IACH,eAAe,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE;IAChD;;;;;;;OAOG;IACH,uBAAuB,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE;CACzD,CAAC,CAAC"}

package/lib/embedded-types/workout/Fatigue.ts

@@ -0,0 +1,41 @@
+import { z } from 'zod';
+
+/**
+ * Zod schema for {@link Fatigue}.
+ */
+export const FatigueSchema = z.object({
+  /**
+   * Joint and connective tissue disruption score (0-3).
+   *
+   * - 0: You had minimal to no pain or perturbation in your joints or connective tissues
+   * - 1: You had some pain or perturbation in your joints and connective tissues but recovered by the next day
+   * - 2: You had some persistent pain or tightness in your connective tissues that lasted through the following day or several days
+   * - 3: You develop chronic pain in the joints and connective tissues that persists across days to weeks or longer
+   */
+  jointAndTissueDisruption: z.int().min(0).max(3).nullish(),
+  /**
+   * Perceived effort score (0-3).
+   *
+   * - 0: Training felt very easy and hardly taxed you psychologically
+   * - 1: You put effort into the training, but felt recovered by the end of the day
+   * - 2: You put a large effort into the training and felt drained through the next day
+   * - 3: You put an all-out effort into the training and felt drained for days
+   */
+  perceivedEffort: z.int().min(0).max(3).nullish(),
+  /**
+   * Unused muscle performance score (0-3).
+   *
+   * - 0: Performance on subsequent exercises targeting unused muscles was better than expected
+   * - 1: Performance on subsequent exercises targeting unused muscles was as expected
+   * - 2: Performance on subsequent exercises targeting unused muscles was worse than expected
+   * - 3: Your performance on subsequent exercises targeting unused muscles was hugely deteriorated
+   */
+  unusedMusclePerformance: z.int().min(0).max(3).nullish()
+});
+
+/**
+ * Fatigue measurement for a workout session or exercise.
+ *
+ * The Stimulus to Fatigue Ratio (SFR) can be calculated as RSM / total fatigue score.
+ */
+export type Fatigue = z.infer<typeof FatigueSchema>;

package/lib/embedded-types/workout/Rsm.d.ts

@@ -0,0 +1,17 @@
+import { z } from 'zod';
+/**
+ * Zod schema for {@link RSM}.
+ */
+export declare const RsmSchema: z.ZodObject<{
+    mindMuscleConnection: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+    pump: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+    disruption: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+}, z.core.$strip>;
+/**
+ * Raw Stimulus Magnitude (RSM) - the amount of muscle growth stimulus any given
+ * workout session or exercise gives.
+ *
+ * The total RSM score is the sum of mindMuscleConnection, pump, and disruption (0-9).
+ */
+export type RSM = z.infer<typeof RsmSchema>;
+//# sourceMappingURL=Rsm.d.ts.map

package/lib/embedded-types/workout/Rsm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Rsm.d.ts","sourceRoot":"","sources":["../../../src/embedded-types/workout/Rsm.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,eAAO,MAAM,SAAS;;;;iBA4BpB,CAAC;AAEH;;;;;GAKG;AACH,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAC"}

package/lib/embedded-types/workout/Rsm.js

@@ -0,0 +1,34 @@
+import { z } from 'zod';
+/**
+ * Zod schema for {@link RSM}.
+ */
+export const RsmSchema = z.object({
+    /**
+     * Mind muscle connection score (0-3).
+     *
+     * - 0: You felt barely aware of your target muscles during the exercise
+     * - 1: You felt like your target muscles worked, but mildly
+     * - 2: You felt a good amount of tension and/or burn in the target muscles
+     * - 3: You felt tension and burn close to the limit in your target muscles
+     */
+    mindMuscleConnection: z.int().min(0).max(3).nullish(),
+    /**
+     * Pump score (0-3).
+     *
+     * - 0: You got no pump at all in the target muscles
+     * - 1: You got a very mild pump in the target muscles
+     * - 2: You got a decent pump in the target muscles
+     * - 3: You got close to maximal pump in the target muscles
+     */
+    pump: z.int().min(0).max(3).nullish(),
+    /**
+     * Muscle disruption score (0-3).
+     *
+     * - 0: You had no fatigue, perturbation, or soreness in the target muscles
+     * - 1: You had some weakness and stiffness after the session in the target muscles, but recovered by the next day
+     * - 2: You had weakness and stiffness after the session and experienced soreness the following day
+     * - 3: You got much weaker and felt perturbation in the target muscles right after the session and also had soreness for a few days or more
+     */
+    disruption: z.int().min(0).max(3).nullish()
+});
+//# sourceMappingURL=Rsm.js.map

package/lib/embedded-types/workout/Rsm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Rsm.js","sourceRoot":"","sources":["../../../src/embedded-types/workout/Rsm.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC;;;;;;;OAOG;IACH,oBAAoB,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE;IACrD;;;;;;;OAOG;IACH,IAAI,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE;IACrC;;;;;;;OAOG;IACH,UAAU,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE;CAC5C,CAAC,CAAC"}

package/lib/embedded-types/workout/Rsm.ts

@@ -0,0 +1,42 @@
+import { z } from 'zod';
+
+/**
+ * Zod schema for {@link RSM}.
+ */
+export const RsmSchema = z.object({
+  /**
+   * Mind muscle connection score (0-3).
+   *
+   * - 0: You felt barely aware of your target muscles during the exercise
+   * - 1: You felt like your target muscles worked, but mildly
+   * - 2: You felt a good amount of tension and/or burn in the target muscles
+   * - 3: You felt tension and burn close to the limit in your target muscles
+   */
+  mindMuscleConnection: z.int().min(0).max(3).nullish(),
+  /**
+   * Pump score (0-3).
+   *
+   * - 0: You got no pump at all in the target muscles
+   * - 1: You got a very mild pump in the target muscles
+   * - 2: You got a decent pump in the target muscles
+   * - 3: You got close to maximal pump in the target muscles
+   */
+  pump: z.int().min(0).max(3).nullish(),
+  /**
+   * Muscle disruption score (0-3).
+   *
+   * - 0: You had no fatigue, perturbation, or soreness in the target muscles
+   * - 1: You had some weakness and stiffness after the session in the target muscles, but recovered by the next day
+   * - 2: You had weakness and stiffness after the session and experienced soreness the following day
+   * - 3: You got much weaker and felt perturbation in the target muscles right after the session and also had soreness for a few days or more
+   */
+  disruption: z.int().min(0).max(3).nullish()
+});
+
+/**
+ * Raw Stimulus Magnitude (RSM) - the amount of muscle growth stimulus any given
+ * workout session or exercise gives.
+ *
+ * The total RSM score is the sum of mindMuscleConnection, pump, and disruption (0-9).
+ */
+export type RSM = z.infer<typeof RsmSchema>;

package/lib/services/DocumentService.d.ts

@@ -8,6 +8,25 @@ import type { BaseDocument } from '../documents/BaseDocument.js';
 export type DocumentMap<T extends BaseDocument> = {
     [docId: UUID]: T | undefined;
 };
+/**
+ * Represents database operations for a document type.
+ *
+ * @template T - The type of document, must extend BaseDocument.
+ */
+export type DocumentOperations<T extends BaseDocument> = {
+    /**
+     * Documents to create.
+     */
+    create?: T[];
+    /**
+     * Documents to update. Must include _id field.
+     */
+    update?: Partial<T>[];
+    /**
+     * Document IDs to delete.
+     */
+    delete?: UUID[];
+};
 /**
  * A service for low-level utilities related to documents.
  */

package/lib/services/DocumentService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DocumentService.d.ts","sourceRoot":"","sources":["../../src/services/DocumentService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAEjE;;;;GAIG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,YAAY,IAAI;IAChD,CAAC,KAAK,EAAE,IAAI,GAAG,CAAC,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IAClC;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC;IAI5C,MAAM,CAAC,UAAU,IAAI,IAAI;CAG1B"}
+{"version":3,"file":"DocumentService.d.ts","sourceRoot":"","sources":["../../src/services/DocumentService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAEjE;;;;GAIG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,YAAY,IAAI;IAChD,CAAC,KAAK,EAAE,IAAI,GAAG,CAAC,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,YAAY,IAAI;IACvD;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;IACb;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IAClC;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC;IAI5C,MAAM,CAAC,UAAU,IAAI,IAAI;CAG1B"}

package/lib/services/DocumentService.js.map

@@ -1 +1 @@
-{"version":3,"file":"DocumentService.js","sourceRoot":"","sources":["../../src/services/DocumentService.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAYpC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IAClC;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAmB,GAAM;QACtC,OAAO,eAAe,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IAED,MAAM,CAAC,UAAU;QACf,OAAO,MAAM,EAAU,CAAC;IAC1B,CAAC;CACF"}
+{"version":3,"file":"DocumentService.js","sourceRoot":"","sources":["../../src/services/DocumentService.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAgCpC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IAClC;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAmB,GAAM;QACtC,OAAO,eAAe,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IAED,MAAM,CAAC,UAAU;QACf,OAAO,MAAM,EAAU,CAAC;IAC1B,CAAC;CACF"}

package/lib/services/DocumentService.ts

@@ -11,6 +11,26 @@ export type DocumentMap<T extends BaseDocument> = {
   [docId: UUID]: T | undefined;
 };
 
+/**
+ * Represents database operations for a document type.
+ *
+ * @template T - The type of document, must extend BaseDocument.
+ */
+export type DocumentOperations<T extends BaseDocument> = {
+  /**
+   * Documents to create.
+   */
+  create?: T[];
+  /**
+   * Documents to update. Must include _id field.
+   */
+  update?: Partial<T>[];
+  /**
+   * Document IDs to delete.
+   */
+  delete?: UUID[];
+};
+
 /**
  * A service for low-level utilities related to documents.
  */