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

package/lib/documents/workout/WorkoutMesocycle.js

@@ -0,0 +1,84 @@
+import { z } from 'zod';
+import { RequiredUserIdSchema } from '../../schemas/required-refs/RequiredUserId.js';
+import { BaseDocumentWithTypeSchema, BaseDocumentWithUpdatedAndCreatedDatesSchema } from '../BaseDocument.js';
+/**
+ * The type of mesocycle.
+ *
+ * - MuscleGain: Automatic recommendations will be made for muscle gain
+ * - Resensitization: Automatic recommendations for MV training (maintenance)
+ * - Cut: Automatic recommendations for fat loss while maintaining muscle
+ * - FreeForm: No automatic recommendations, user has full control
+ */
+export var CycleType;
+(function (CycleType) {
+    CycleType["MuscleGain"] = "MuscleGain";
+    CycleType["Resensitization"] = "Resensitization";
+    CycleType["Cut"] = "Cut";
+    CycleType["FreeForm"] = "FreeForm";
+})(CycleType || (CycleType = {}));
+/**
+ * The docType value for WorkoutMesocycle documents.
+ */
+export const WorkoutMesocycle_docType = 'workoutMesocycle';
+/**
+ * The schema for {@link WorkoutMesocycle} documents.
+ */
+export const WorkoutMesocycleSchema = z
+    .object({
+    ...BaseDocumentWithTypeSchema.shape,
+    ...RequiredUserIdSchema.shape,
+    ...BaseDocumentWithUpdatedAndCreatedDatesSchema.shape,
+    docType: z.literal(WorkoutMesocycle_docType).default(WorkoutMesocycle_docType),
+    /**
+     * An optional title for this mesocycle.
+     */
+    title: z.string().nullish(),
+    /**
+     * The IDs of WorkoutExerciseCalibration documents used for this mesocycle.
+     *
+     * This locks which calibration was used for a mesocycle so historical 1RM
+     * values remain accurate even if calibrations are changed later.
+     */
+    calibratedExercises: z.array(z.uuidv7().transform((val) => val)).default([]),
+    /**
+     * The type of this mesocycle. See {@link CycleType} for details.
+     */
+    cycleType: z.enum(CycleType),
+    /**
+     * The planned number of workout sessions per microcycle.
+     */
+    plannedSessionCountPerMicrocycle: z.int().positive(),
+    /**
+     * The planned length of each microcycle in days.
+     *
+     * Typically 7 days (one week), but can vary.
+     */
+    plannedMicrocycleLengthInDays: z.int().positive(),
+    /**
+     * The planned rest days within each microcycle, represented as day indices.
+     *
+     * For example, [0, 3] would indicate rest on the first and fourth days of
+     * the microcycle.
+     */
+    plannedMicrocycleRestDays: z.array(z.int().nonnegative()).default([]),
+    /**
+     * The planned total number of microcycles including accumulation and deload.
+     *
+     * Should typically be 5-9 microcycles (4-8 accumulation weeks + 1 deload week).
+     */
+    plannedMicrocycleCount: z.int().min(2).max(20).nullish(),
+    /**
+     * The date this mesocycle was completed.
+     *
+     * This should be set after the user gets a "success" completion screen and
+     * has buttoned up any last prompts. This should guide them into the next
+     * mesocycle.
+     */
+    completedDate: z.date().nullish()
+})
+    .refine((data) => data.calibratedExercises.length >= data.plannedSessionCountPerMicrocycle, {
+    message: 'Number of calibrated exercises must be at least equal to planned sessions per microcycle.' +
+        ' Create a slight variation of an existing exercise if needed.',
+    path: ['calibratedExercises']
+});
+//# sourceMappingURL=WorkoutMesocycle.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WorkoutMesocycle.js","sourceRoot":"","sources":["../../../src/documents/workout/WorkoutMesocycle.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;;;;;;;GAOG;AACH,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,sCAAyB,CAAA;IACzB,gDAAmC,CAAA;IACnC,wBAAW,CAAA;IACX,kCAAqB,CAAA;AACvB,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,kBAAkB,CAAC;AAE3D;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC;KACpC,MAAM,CAAC;IACN,GAAG,0BAA0B,CAAC,KAAK;IACnC,GAAG,oBAAoB,CAAC,KAAK;IAC7B,GAAG,4CAA4C,CAAC,KAAK;IACrD,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAAC;IAC9E;;OAEG;IACH,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE;IAC3B;;;;;OAKG;IACH,mBAAmB,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;IACpF;;OAEG;IACH,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;IAC5B;;OAEG;IACH,gCAAgC,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACpD;;;;OAIG;IACH,6BAA6B,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACjD;;;;;OAKG;IACH,yBAAyB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACrE;;;;OAIG;IACH,sBAAsB,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE;IACxD;;;;;;OAMG;IACH,aAAa,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE;CAClC,CAAC;KACD,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,MAAM,IAAI,IAAI,CAAC,gCAAgC,EAAE;IAC1F,OAAO,EACL,2FAA2F;QAC3F,+DAA+D;IACjE,IAAI,EAAE,CAAC,qBAAqB,CAAC;CAC9B,CAAC,CAAC"}

package/lib/documents/workout/WorkoutMesocycle.ts

@@ -0,0 +1,102 @@
+import type { UUID } from 'crypto';
+import { z } from 'zod';
+import { RequiredUserIdSchema } from '../../schemas/required-refs/RequiredUserId.js';
+import {
+  BaseDocumentWithTypeSchema,
+  BaseDocumentWithUpdatedAndCreatedDatesSchema
+} from '../BaseDocument.js';
+
+/**
+ * The type of mesocycle.
+ *
+ * - MuscleGain: Automatic recommendations will be made for muscle gain
+ * - Resensitization: Automatic recommendations for MV training (maintenance)
+ * - Cut: Automatic recommendations for fat loss while maintaining muscle
+ * - FreeForm: No automatic recommendations, user has full control
+ */
+export enum CycleType {
+  MuscleGain = 'MuscleGain',
+  Resensitization = 'Resensitization',
+  Cut = 'Cut',
+  FreeForm = 'FreeForm'
+}
+
+/**
+ * The docType value for WorkoutMesocycle documents.
+ */
+export const WorkoutMesocycle_docType = 'workoutMesocycle';
+
+/**
+ * The schema for {@link WorkoutMesocycle} documents.
+ */
+export const WorkoutMesocycleSchema = z
+  .object({
+    ...BaseDocumentWithTypeSchema.shape,
+    ...RequiredUserIdSchema.shape,
+    ...BaseDocumentWithUpdatedAndCreatedDatesSchema.shape,
+    docType: z.literal(WorkoutMesocycle_docType).default(WorkoutMesocycle_docType),
+    /**
+     * An optional title for this mesocycle.
+     */
+    title: z.string().nullish(),
+    /**
+     * The IDs of WorkoutExerciseCalibration documents used for this mesocycle.
+     *
+     * This locks which calibration was used for a mesocycle so historical 1RM
+     * values remain accurate even if calibrations are changed later.
+     */
+    calibratedExercises: z.array(z.uuidv7().transform((val) => val as UUID)).default([]),
+    /**
+     * The type of this mesocycle. See {@link CycleType} for details.
+     */
+    cycleType: z.enum(CycleType),
+    /**
+     * The planned number of workout sessions per microcycle.
+     */
+    plannedSessionCountPerMicrocycle: z.int().positive(),
+    /**
+     * The planned length of each microcycle in days.
+     *
+     * Typically 7 days (one week), but can vary.
+     */
+    plannedMicrocycleLengthInDays: z.int().positive(),
+    /**
+     * The planned rest days within each microcycle, represented as day indices.
+     *
+     * For example, [0, 3] would indicate rest on the first and fourth days of
+     * the microcycle.
+     */
+    plannedMicrocycleRestDays: z.array(z.int().nonnegative()).default([]),
+    /**
+     * The planned total number of microcycles including accumulation and deload.
+     *
+     * Should typically be 5-9 microcycles (4-8 accumulation weeks + 1 deload week).
+     */
+    plannedMicrocycleCount: z.int().min(2).max(20).nullish(),
+    /**
+     * The date this mesocycle was completed.
+     *
+     * This should be set after the user gets a "success" completion screen and
+     * has buttoned up any last prompts. This should guide them into the next
+     * mesocycle.
+     */
+    completedDate: z.date().nullish()
+  })
+  .refine((data) => data.calibratedExercises.length >= data.plannedSessionCountPerMicrocycle, {
+    message:
+      'Number of calibrated exercises must be at least equal to planned sessions per microcycle.' +
+      ' Create a slight variation of an existing exercise if needed.',
+    path: ['calibratedExercises']
+  });
+
+/**
+ * Represents a mesocycle - an organized sequence of microcycles ordered to
+ * elicit a set of distinct training adaptations.
+ *
+ * A typical mesocycle is composed of two distinct phases:
+ * 1. Accumulation phase: Progress from MEV towards MRV
+ * 2. Deload phase: Shorter recovery period
+ *
+ * The accumulation phase should last 4-8 weeks, followed by a deload phase.
+ */
+export type WorkoutMesocycle = z.infer<typeof WorkoutMesocycleSchema>;

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

@@ -0,0 +1,27 @@
+import { z } from 'zod';
+/**
+ * The docType value for WorkoutMicrocycle documents.
+ */
+export declare const WorkoutMicrocycle_docType = "workoutMicrocycle";
+/**
+ * The schema for {@link WorkoutMicrocycle} documents.
+ */
+export declare const WorkoutMicrocycleSchema: z.ZodObject<{
+    docType: z.ZodDefault<z.ZodLiteral<"workoutMicrocycle">>;
+    workoutMesocycleId: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodUUID, z.ZodTransform<`${string}-${string}-${string}-${string}-${string}`, string>>>>;
+    startDate: z.ZodDate;
+    endDate: z.ZodDate;
+    sessionOrder: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodUUID, z.ZodTransform<`${string}-${string}-${string}-${string}-${string}`, string>>>>;
+    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 microcycle - the shortest cycle of training that includes all
+ * workout sessions and rest days and is repeated.
+ *
+ * Typically, but not always, this is a week (7 days).
+ */
+export type WorkoutMicrocycle = z.infer<typeof WorkoutMicrocycleSchema>;
+//# sourceMappingURL=WorkoutMicrocycle.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WorkoutMicrocycle.d.ts","sourceRoot":"","sources":["../../../src/documents/workout/WorkoutMicrocycle.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAOxB;;GAEG;AACH,eAAO,MAAM,yBAAyB,sBAAsB,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;iBA8BlC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC"}

package/lib/documents/workout/WorkoutMicrocycle.js

@@ -0,0 +1,42 @@
+import { z } from 'zod';
+import { RequiredUserIdSchema } from '../../schemas/required-refs/RequiredUserId.js';
+import { BaseDocumentWithTypeSchema, BaseDocumentWithUpdatedAndCreatedDatesSchema } from '../BaseDocument.js';
+/**
+ * The docType value for WorkoutMicrocycle documents.
+ */
+export const WorkoutMicrocycle_docType = 'workoutMicrocycle';
+/**
+ * The schema for {@link WorkoutMicrocycle} documents.
+ */
+export const WorkoutMicrocycleSchema = z.object({
+    ...BaseDocumentWithTypeSchema.shape,
+    ...RequiredUserIdSchema.shape,
+    ...BaseDocumentWithUpdatedAndCreatedDatesSchema.shape,
+    docType: z.literal(WorkoutMicrocycle_docType).default(WorkoutMicrocycle_docType),
+    /**
+     * The ID of the mesocycle this microcycle belongs to.
+     *
+     * This is optional because users can track workouts outside of a mesocycle.
+     */
+    workoutMesocycleId: z
+        .uuidv7()
+        .transform((val) => val)
+        .nullish(),
+    /**
+     * The start date of this microcycle.
+     */
+    startDate: z.date(),
+    /**
+     * The end date of this microcycle.
+     */
+    endDate: z.date(),
+    /**
+     * The order of sessions in this microcycle, represented as an array of
+     * WorkoutSession IDs.
+     *
+     * This makes it easier to reason about the order of sessions before dates
+     * are assigned.
+     */
+    sessionOrder: z.array(z.uuidv7().transform((val) => val)).default([])
+});
+//# sourceMappingURL=WorkoutMicrocycle.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WorkoutMicrocycle.js","sourceRoot":"","sources":["../../../src/documents/workout/WorkoutMicrocycle.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,yBAAyB,GAAG,mBAAmB,CAAC;AAE7D;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,GAAG,0BAA0B,CAAC,KAAK;IACnC,GAAG,oBAAoB,CAAC,KAAK;IAC7B,GAAG,4CAA4C,CAAC,KAAK;IACrD,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC,OAAO,CAAC,yBAAyB,CAAC;IAChF;;;;OAIG;IACH,kBAAkB,EAAE,CAAC;SAClB,MAAM,EAAE;SACR,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAW,CAAC;SAC/B,OAAO,EAAE;IACZ;;OAEG;IACH,SAAS,EAAE,CAAC,CAAC,IAAI,EAAE;IACnB;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE;IACjB;;;;;;OAMG;IACH,YAAY,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;CAC9E,CAAC,CAAC"}

package/lib/documents/workout/WorkoutMicrocycle.ts

@@ -0,0 +1,55 @@
+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 WorkoutMicrocycle documents.
+ */
+export const WorkoutMicrocycle_docType = 'workoutMicrocycle';
+
+/**
+ * The schema for {@link WorkoutMicrocycle} documents.
+ */
+export const WorkoutMicrocycleSchema = z.object({
+  ...BaseDocumentWithTypeSchema.shape,
+  ...RequiredUserIdSchema.shape,
+  ...BaseDocumentWithUpdatedAndCreatedDatesSchema.shape,
+  docType: z.literal(WorkoutMicrocycle_docType).default(WorkoutMicrocycle_docType),
+  /**
+   * The ID of the mesocycle this microcycle belongs to.
+   *
+   * This is optional because users can track workouts outside of a mesocycle.
+   */
+  workoutMesocycleId: z
+    .uuidv7()
+    .transform((val) => val as UUID)
+    .nullish(),
+  /**
+   * The start date of this microcycle.
+   */
+  startDate: z.date(),
+  /**
+   * The end date of this microcycle.
+   */
+  endDate: z.date(),
+  /**
+   * The order of sessions in this microcycle, represented as an array of
+   * WorkoutSession IDs.
+   *
+   * This makes it easier to reason about the order of sessions before dates
+   * are assigned.
+   */
+  sessionOrder: z.array(z.uuidv7().transform((val) => val as UUID)).default([])
+});
+
+/**
+ * Represents a microcycle - the shortest cycle of training that includes all
+ * workout sessions and rest days and is repeated.
+ *
+ * Typically, but not always, this is a week (7 days).
+ */
+export type WorkoutMicrocycle = z.infer<typeof WorkoutMicrocycleSchema>;

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

@@ -0,0 +1,22 @@
+import { z } from 'zod';
+/**
+ * The docType value for WorkoutMuscleGroup documents.
+ */
+export declare const WorkoutMuscleGroup_docType = "workoutMuscleGroup";
+/**
+ * The schema for {@link WorkoutMuscleGroup} documents.
+ */
+export declare const WorkoutMuscleGroupSchema: z.ZodObject<{
+    docType: z.ZodDefault<z.ZodLiteral<"workoutMuscleGroup">>;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    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 muscle group that can be targeted by exercises.
+ */
+export type WorkoutMuscleGroup = z.infer<typeof WorkoutMuscleGroupSchema>;
+//# sourceMappingURL=WorkoutMuscleGroup.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WorkoutMuscleGroup.d.ts","sourceRoot":"","sources":["../../../src/documents/workout/WorkoutMuscleGroup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAOxB;;GAEG;AACH,eAAO,MAAM,0BAA0B,uBAAuB,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;iBAanC,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC"}

package/lib/documents/workout/WorkoutMuscleGroup.js

@@ -0,0 +1,25 @@
+import { z } from 'zod';
+import { RequiredUserIdSchema } from '../../schemas/required-refs/RequiredUserId.js';
+import { BaseDocumentWithTypeSchema, BaseDocumentWithUpdatedAndCreatedDatesSchema } from '../BaseDocument.js';
+/**
+ * The docType value for WorkoutMuscleGroup documents.
+ */
+export const WorkoutMuscleGroup_docType = 'workoutMuscleGroup';
+/**
+ * The schema for {@link WorkoutMuscleGroup} documents.
+ */
+export const WorkoutMuscleGroupSchema = z.object({
+    ...BaseDocumentWithTypeSchema.shape,
+    ...RequiredUserIdSchema.shape,
+    ...BaseDocumentWithUpdatedAndCreatedDatesSchema.shape,
+    docType: z.literal(WorkoutMuscleGroup_docType).default(WorkoutMuscleGroup_docType),
+    /**
+     * The name of the muscle group.
+     */
+    name: z.string(),
+    /**
+     * An optional description of the muscle group.
+     */
+    description: z.string().nullish()
+});
+//# sourceMappingURL=WorkoutMuscleGroup.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WorkoutMuscleGroup.js","sourceRoot":"","sources":["../../../src/documents/workout/WorkoutMuscleGroup.ts"],"names":[],"mappings":"AAAA,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,0BAA0B,GAAG,oBAAoB,CAAC;AAE/D;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,GAAG,0BAA0B,CAAC,KAAK;IACnC,GAAG,oBAAoB,CAAC,KAAK;IAC7B,GAAG,4CAA4C,CAAC,KAAK;IACrD,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC,OAAO,CAAC,0BAA0B,CAAC;IAClF;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB;;OAEG;IACH,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE;CAClC,CAAC,CAAC"}

package/lib/documents/workout/WorkoutMuscleGroup.ts

@@ -0,0 +1,34 @@
+import { z } from 'zod';
+import { RequiredUserIdSchema } from '../../schemas/required-refs/RequiredUserId.js';
+import {
+  BaseDocumentWithTypeSchema,
+  BaseDocumentWithUpdatedAndCreatedDatesSchema
+} from '../BaseDocument.js';
+
+/**
+ * The docType value for WorkoutMuscleGroup documents.
+ */
+export const WorkoutMuscleGroup_docType = 'workoutMuscleGroup';
+
+/**
+ * The schema for {@link WorkoutMuscleGroup} documents.
+ */
+export const WorkoutMuscleGroupSchema = z.object({
+  ...BaseDocumentWithTypeSchema.shape,
+  ...RequiredUserIdSchema.shape,
+  ...BaseDocumentWithUpdatedAndCreatedDatesSchema.shape,
+  docType: z.literal(WorkoutMuscleGroup_docType).default(WorkoutMuscleGroup_docType),
+  /**
+   * The name of the muscle group.
+   */
+  name: z.string(),
+  /**
+   * An optional description of the muscle group.
+   */
+  description: z.string().nullish()
+});
+
+/**
+ * Represents a muscle group that can be targeted by exercises.
+ */
+export type WorkoutMuscleGroup = z.infer<typeof WorkoutMuscleGroupSchema>;

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

@@ -0,0 +1,39 @@
+import { z } from 'zod';
+/**
+ * The docType value for WorkoutSession documents.
+ */
+export declare const WorkoutSession_docType = "workoutSession";
+/**
+ * The schema for {@link WorkoutSession} documents.
+ */
+export declare const WorkoutSessionSchema: z.ZodObject<{
+    docType: z.ZodDefault<z.ZodLiteral<"workoutSession">>;
+    workoutMicrocycleId: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodUUID, z.ZodTransform<`${string}-${string}-${string}-${string}-${string}`, string>>>>;
+    title: z.ZodString;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    startTime: z.ZodDate;
+    complete: z.ZodDefault<z.ZodBoolean>;
+    sessionExerciseOrder: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodUUID, z.ZodTransform<`${string}-${string}-${string}-${string}-${string}`, string>>>>;
+    rsm: z.ZodOptional<z.ZodNullable<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>>>;
+    fatigue: z.ZodOptional<z.ZodNullable<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>>>;
+    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 workout session containing one or more exercises.
+ *
+ * A session can be part of a microcycle (which may be part of a mesocycle) or
+ * can be tracked independently for free-form workout tracking.
+ */
+export type WorkoutSession = z.infer<typeof WorkoutSessionSchema>;
+//# sourceMappingURL=WorkoutSession.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WorkoutSession.d.ts","sourceRoot":"","sources":["../../../src/documents/workout/WorkoutSession.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AASxB;;GAEG;AACH,eAAO,MAAM,sBAAsB,mBAAmB,CAAC;AAEvD;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;iBAoD/B,CAAC;AAEH;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC"}

package/lib/documents/workout/WorkoutSession.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 WorkoutSession documents.
+ */
+export const WorkoutSession_docType = 'workoutSession';
+/**
+ * The schema for {@link WorkoutSession} documents.
+ */
+export const WorkoutSessionSchema = z.object({
+    ...BaseDocumentWithTypeSchema.shape,
+    ...RequiredUserIdSchema.shape,
+    ...BaseDocumentWithUpdatedAndCreatedDatesSchema.shape,
+    docType: z.literal(WorkoutSession_docType).default(WorkoutSession_docType),
+    /**
+     * The ID of the microcycle this session belongs to.
+     *
+     * This is optional because users can track workouts outside of a microcycle.
+     */
+    workoutMicrocycleId: z
+        .uuidv7()
+        .transform((val) => val)
+        .nullish(),
+    /**
+     * The title of this workout session.
+     */
+    title: z.string(),
+    /**
+     * An optional description of this workout session.
+     */
+    description: z.string().nullish(),
+    /**
+     * The start time of this workout session.
+     */
+    startTime: z.date(),
+    /**
+     * Whether this workout session has been completed.
+     */
+    complete: z.boolean().default(false),
+    /**
+     * The order of exercises in this session, represented as an array of
+     * WorkoutSessionExercise IDs.
+     *
+     * This was chosen as a compromise for querying efficiency in order to quickly
+     * get metrics like "Last time you did this exercise when it was preceded by
+     * these 4 other exercises, you did this".
+     */
+    sessionExerciseOrder: z.array(z.uuidv7().transform((val) => val)).default([]),
+    /**
+     * The Raw Stimulus Magnitude for this session.
+     *
+     * This is the sum of mindMuscleConnection, pump, and disruption (0-9).
+     */
+    rsm: RsmSchema.nullish(),
+    /**
+     * The fatigue measurement for this session.
+     *
+     * The total fatigue score is the sum of all three components (0-9).
+     * The Stimulus to Fatigue Ratio (SFR) can be calculated as RSM total / Fatigue total.
+     */
+    fatigue: FatigueSchema.nullish()
+});
+//# sourceMappingURL=WorkoutSession.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WorkoutSession.js","sourceRoot":"","sources":["../../../src/documents/workout/WorkoutSession.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,sBAAsB,GAAG,gBAAgB,CAAC;AAEvD;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,GAAG,0BAA0B,CAAC,KAAK;IACnC,GAAG,oBAAoB,CAAC,KAAK;IAC7B,GAAG,4CAA4C,CAAC,KAAK;IACrD,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC;IAC1E;;;;OAIG;IACH,mBAAmB,EAAE,CAAC;SACnB,MAAM,EAAE;SACR,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAW,CAAC;SAC/B,OAAO,EAAE;IACZ;;OAEG;IACH,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB;;OAEG;IACH,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE;IACjC;;OAEG;IACH,SAAS,EAAE,CAAC,CAAC,IAAI,EAAE;IACnB;;OAEG;IACH,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IACpC;;;;;;;OAOG;IACH,oBAAoB,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;IACrF;;;;OAIG;IACH,GAAG,EAAE,SAAS,CAAC,OAAO,EAAE;IACxB;;;;;OAKG;IACH,OAAO,EAAE,aAAa,CAAC,OAAO,EAAE;CACjC,CAAC,CAAC"}

package/lib/documents/workout/WorkoutSession.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 WorkoutSession documents.
+ */
+export const WorkoutSession_docType = 'workoutSession';
+
+/**
+ * The schema for {@link WorkoutSession} documents.
+ */
+export const WorkoutSessionSchema = z.object({
+  ...BaseDocumentWithTypeSchema.shape,
+  ...RequiredUserIdSchema.shape,
+  ...BaseDocumentWithUpdatedAndCreatedDatesSchema.shape,
+  docType: z.literal(WorkoutSession_docType).default(WorkoutSession_docType),
+  /**
+   * The ID of the microcycle this session belongs to.
+   *
+   * This is optional because users can track workouts outside of a microcycle.
+   */
+  workoutMicrocycleId: z
+    .uuidv7()
+    .transform((val) => val as UUID)
+    .nullish(),
+  /**
+   * The title of this workout session.
+   */
+  title: z.string(),
+  /**
+   * An optional description of this workout session.
+   */
+  description: z.string().nullish(),
+  /**
+   * The start time of this workout session.
+   */
+  startTime: z.date(),
+  /**
+   * Whether this workout session has been completed.
+   */
+  complete: z.boolean().default(false),
+  /**
+   * The order of exercises in this session, represented as an array of
+   * WorkoutSessionExercise IDs.
+   *
+   * This was chosen as a compromise for querying efficiency in order to quickly
+   * get metrics like "Last time you did this exercise when it was preceded by
+   * these 4 other exercises, you did this".
+   */
+  sessionExerciseOrder: z.array(z.uuidv7().transform((val) => val as UUID)).default([]),
+  /**
+   * The Raw Stimulus Magnitude for this session.
+   *
+   * This is the sum of mindMuscleConnection, pump, and disruption (0-9).
+   */
+  rsm: RsmSchema.nullish(),
+  /**
+   * The fatigue measurement for this session.
+   *
+   * The total fatigue score is the sum of all three components (0-9).
+   * The Stimulus to Fatigue Ratio (SFR) can be calculated as RSM total / Fatigue total.
+   */
+  fatigue: FatigueSchema.nullish()
+});
+
+/**
+ * Represents a workout session containing one or more exercises.
+ *
+ * A session can be part of a microcycle (which may be part of a mesocycle) or
+ * can be tracked independently for free-form workout tracking.
+ */
+export type WorkoutSession = z.infer<typeof WorkoutSessionSchema>;

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

@@ -0,0 +1,39 @@
+import { z } from 'zod';
+/**
+ * The docType value for WorkoutSessionExercise documents.
+ */
+export declare const WorkoutSessionExercise_docType = "workoutSessionExercise";
+/**
+ * The schema for {@link WorkoutSessionExercise} documents.
+ */
+export declare const WorkoutSessionExerciseSchema: z.ZodObject<{
+    docType: z.ZodDefault<z.ZodLiteral<"workoutSessionExercise">>;
+    workoutSessionId: z.ZodPipe<z.ZodUUID, z.ZodTransform<`${string}-${string}-${string}-${string}-${string}`, string>>;
+    workoutExerciseId: z.ZodPipe<z.ZodUUID, z.ZodTransform<`${string}-${string}-${string}-${string}-${string}`, string>>;
+    setOrder: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodUUID, z.ZodTransform<`${string}-${string}-${string}-${string}-${string}`, string>>>>;
+    rsm: z.ZodOptional<z.ZodNullable<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>>>;
+    fatigue: z.ZodOptional<z.ZodNullable<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>>>;
+    sorenessScore: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+    performanceScore: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+    isRecoveryExercise: z.ZodDefault<z.ZodBoolean>;
+    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 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>;
+//# sourceMappingURL=WorkoutSessionExercise.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WorkoutSessionExercise.d.ts","sourceRoot":"","sources":["../../../src/documents/workout/WorkoutSessionExercise.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AASxB;;GAEG;AACH,eAAO,MAAM,8BAA8B,2BAA2B,CAAC;AAEvE;;GAEG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;iBAoDvC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC"}