@dgpholdings/greatoak-shared 1.2.34 → 1.2.36

package/dist/types/TApiExercise.d.ts

@@ -123,6 +123,18 @@ export type TExercise = {
     isFavorite?: boolean;
     scoringSpecialHandling?: "plyometric" | "stretch-mobility" | "continuous-duration" | "loaded-carry";
     isFlaggedCorrection?: boolean;
+    regressionExerciseId?: string;
+    progressionExerciseId?: string;
+    bodyweightDependency?: "high" | "medium" | "low" | "none";
+    bmiThresholds?: {
+        overweightTrigger?: number;
+        obeseTrigger?: number;
+    };
+    weightMultiplier?: {
+        male: number;
+        female: number;
+        default: number;
+    };
 };
 export type TBodyPartExercises = Record<TBodyPart, TExercise[]>;
 export type TApiCreateOrUpdateExerciseReq = {

package/dist/types/TApiProPlan.d.ts

@@ -37,8 +37,12 @@ export type TProPlan = {
             fr?: string;
         };
         exercises: TTemplateExercise[];
+        estimatedDuration: number;
         planThumbnailImageUrl?: string;
     }[];
+    progressionRequirements?: {
+        noOfWeeks?: number;
+    };
     createdAt?: Date;
     updatedAt?: Date;
 } & ({

package/dist/types/TApiUser.d.ts

@@ -8,6 +8,7 @@ export type TFitnessGoal = "strength" | "hypertrophy" | "endurance" | "general"
 export type TSubscriptionStatus = "active" | "cancelled" | "expired" | "trial" | "grace" | "none";
 export type TSubscriptionType = "monthly" | "yearly" | "trial";
 export type TAppStore = "app_store" | "play_store" | null;
+export type TActivityLevel = "sedentary" | "lightly-active" | "moderately-active" | "very-active";
 export type TUserMetric = {
     userId: string;
     dob: Date;
@@ -21,7 +22,7 @@ export type TUserMetric = {
     weightKg?: number;
     heightCm?: number;
     emailAddress?: string;
-    fitnessLevel?: number;
+    fitnessLevel?: TActivityLevel;
     bodyFatPercentage?: number;
     metricSystem: "US" | "EU";
     subscriptionStatus: TSubscriptionStatus;

package/dist/types/commonTypes.d.ts

@@ -65,6 +65,7 @@ export type TTemplateExercise = {
     exerciseNote: string;
     restTimeSecs?: number;
     initialRecords: TRecord[];
+    isAutoScaled?: boolean;
 };
 export type TGdprData = {
     consentVersion: string;

package/dist/utils/adoptionEngine/scaleProPlan.util.d.ts

@@ -0,0 +1,9 @@
+import { TProPlan, TUserMetric, TExercise } from "../../types";
+/**
+ * Calculates the BMI (Body Mass Index).
+ */
+export declare const calculateBMI: (weightKg: number, heightCm: number) => number;
+/**
+ * The Adoption Engine: Safely scales a Master Pro Plan to fit an individual user's body type.
+ */
+export declare const scaleProPlan: (masterPlan: TProPlan, userMetric: TUserMetric, exercisesDictionary: Record<string, TExercise>) => TProPlan;

package/dist/utils/adoptionEngine/scaleProPlan.util.js

@@ -0,0 +1,139 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scaleProPlan = exports.calculateBMI = void 0;
+const NO_THRESHOLD = Infinity;
+/**
+ * Calculates the BMI (Body Mass Index).
+ */
+const calculateBMI = (weightKg, heightCm) => {
+    if (!weightKg || !heightCm || heightCm <= 0)
+        return 0;
+    const heightM = heightCm / 100;
+    return Number((weightKg / (heightM * heightM)).toFixed(1));
+};
+exports.calculateBMI = calculateBMI;
+/**
+ * Rounds a calculated weight load to the nearest sensible gym increment (e.g. 2.5kg).
+ */
+const roundToNearest = (val, increment) => Math.round(val / increment) * increment;
+/**
+ * Calculates effective BMI threshold based on the user's fitness activity level.
+ * Active users carry more muscle, so their BMI threshold for bodyweight safety triggers is raised.
+ */
+const getAdjustedBMIThreshold = (baseThreshold, activityLevel) => {
+    if (!baseThreshold)
+        return NO_THRESHOLD;
+    switch (activityLevel) {
+        case "very-active":
+            return baseThreshold + 5; // e.g. Obese trigger moves from 30 to 35
+        case "moderately-active":
+            return baseThreshold + 3; // e.g. Obese trigger moves from 30 to 33
+        case "lightly-active":
+            return baseThreshold + 1;
+        case "sedentary":
+        default:
+            return baseThreshold; // No adjustment
+    }
+};
+/**
+ * Modifies an individual record based on fallback logic (when no regression exercise exists, or for softer triggers).
+ * Reduces volume or duration by roughly 30%.
+ */
+const applyFallbackScalingToRecord = (record) => {
+    const scaledRecord = Object.assign({}, record);
+    const SCALE_FACTOR = 0.7;
+    // Scale reps
+    if (scaledRecord.type === "reps-only" || scaledRecord.type === "weight-reps") {
+        const currentReps = parseInt(scaledRecord.reps, 10);
+        if (!isNaN(currentReps) && currentReps > 0) {
+            scaledRecord.reps = Math.max(1, Math.round(currentReps * SCALE_FACTOR)).toString();
+        }
+    }
+    // Scale duration for all time-based records
+    if (scaledRecord.type === "duration" ||
+        scaledRecord.type === "cardio-machine" ||
+        scaledRecord.type === "cardio-free") {
+        const [mm, ss] = scaledRecord.durationMmSs.split(":").map(Number);
+        if (!isNaN(mm) && !isNaN(ss)) {
+            const totalSecs = mm * 60 + ss;
+            const newSecs = Math.max(5, Math.round(totalSecs * SCALE_FACTOR)); // minimum 5 seconds
+            const newMm = Math.floor(newSecs / 60).toString();
+            const newMmPadded = newMm.length < 2 ? "0" + newMm : newMm;
+            const newSs = (newSecs % 60).toString();
+            const newSsPadded = newSs.length < 2 ? "0" + newSs : newSs;
+            scaledRecord.durationMmSs = `${newMmPadded}:${newSsPadded}`;
+        }
+    }
+    return scaledRecord;
+};
+/**
+ * The Adoption Engine: Safely scales a Master Pro Plan to fit an individual user's body type.
+ */
+const scaleProPlan = (masterPlan, userMetric, exercisesDictionary) => {
+    // We don't mutate the original
+    const tailoredPlan = JSON.parse(JSON.stringify(masterPlan));
+    const { weightKg, heightCm, gender, fitnessLevel } = userMetric;
+    const bmi = weightKg && heightCm ? (0, exports.calculateBMI)(weightKg, heightCm) : 0;
+    tailoredPlan.days.forEach((day) => {
+        day.exercises = day.exercises.map((templateExercise) => {
+            const exerciseMeta = exercisesDictionary[templateExercise.exerciseId];
+            // If we can't find metadata, return as-is
+            if (!exerciseMeta)
+                return templateExercise;
+            let isModified = false;
+            let newExerciseId = templateExercise.exerciseId;
+            let newRecords = [...templateExercise.initialRecords];
+            // 1. Check Safety Triggers (BMI & Bodyweight Dependency)
+            if (bmi > 0 &&
+                (exerciseMeta.bodyweightDependency === "high" || exerciseMeta.bodyweightDependency === "medium") &&
+                exerciseMeta.bmiThresholds) {
+                const obeseTrigger = getAdjustedBMIThreshold(exerciseMeta.bmiThresholds.obeseTrigger, fitnessLevel);
+                const overweightTrigger = getAdjustedBMIThreshold(exerciseMeta.bmiThresholds.overweightTrigger, fitnessLevel);
+                if (bmi >= obeseTrigger) {
+                    // Tier 1: Hard swap to regression (if available) AND scale down volume
+                    newRecords = newRecords.map(applyFallbackScalingToRecord);
+                    isModified = true;
+                    if (exerciseMeta.regressionExerciseId && exercisesDictionary[exerciseMeta.regressionExerciseId]) {
+                        newExerciseId = exerciseMeta.regressionExerciseId;
+                    }
+                }
+                else if (bmi >= overweightTrigger) {
+                    // Tier 2: Softer response. Keep the exercise, but scale down the volume/duration.
+                    newRecords = newRecords.map(applyFallbackScalingToRecord);
+                    isModified = true;
+                }
+            }
+            // 2. Check Load Multipliers
+            if (weightKg && exerciseMeta.weightMultiplier && newRecords.length > 0) {
+                const multiplier = gender === "male"
+                    ? exerciseMeta.weightMultiplier.male
+                    : gender === "female"
+                        ? exerciseMeta.weightMultiplier.female
+                        : exerciseMeta.weightMultiplier.default;
+                if (multiplier && multiplier > 0) {
+                    // Round to nearest 2.5kg to match real-world gym equipment
+                    const suggestedLoadKg = roundToNearest(weightKg * multiplier, 2.5);
+                    newRecords = newRecords.map((record) => {
+                        if (record.type === "weight-reps") {
+                            isModified = true;
+                            return Object.assign(Object.assign({}, record), { kg: suggestedLoadKg.toString() });
+                        }
+                        // Guard against applying load to a falsy "0" aux weight
+                        if (record.type === "reps-only" || record.type === "duration" || record.type === "cardio-free") {
+                            const currentAux = parseFloat(record.auxWeightKg || "0");
+                            if (!isNaN(currentAux) && currentAux > 0) {
+                                isModified = true;
+                                return Object.assign(Object.assign({}, record), { auxWeightKg: suggestedLoadKg.toString() });
+                            }
+                        }
+                        return record;
+                    });
+                }
+            }
+            // Return the tailored template exercise
+            return Object.assign(Object.assign({}, templateExercise), { exerciseId: newExerciseId, initialRecords: newRecords, isAutoScaled: isModified || undefined });
+        });
+    });
+    return tailoredPlan;
+};
+exports.scaleProPlan = scaleProPlan;

package/dist/utils/index.d.ts

@@ -8,3 +8,4 @@ export { generatePlanCode } from "./planCode.util";
 export { maskEmail, isAnonymousEmail, isEmail } from "./email.utils";
 export { NOOP } from "./noop.utils";
 export { calculateExerciseScoreV2, calculateTotalVolume } from "./scoring";
+export { scaleProPlan, calculateBMI } from "./adoptionEngine/scaleProPlan.util";

package/dist/utils/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.calculateTotalVolume = exports.calculateExerciseScoreV2 = exports.NOOP = exports.isEmail = exports.isAnonymousEmail = exports.maskEmail = exports.generatePlanCode = exports.toError = exports.slugifyText = exports.isDefinedNumber = exports.isDefined = exports.countryToCurrencyCode = exports.getDaysAndHoursDifference = exports.isUserAllowedToUpdate = exports.mmssToSecs = exports.toNumber = void 0;
+exports.calculateBMI = exports.scaleProPlan = exports.calculateTotalVolume = exports.calculateExerciseScoreV2 = exports.NOOP = exports.isEmail = exports.isAnonymousEmail = exports.maskEmail = exports.generatePlanCode = exports.toError = exports.slugifyText = exports.isDefinedNumber = exports.isDefined = exports.countryToCurrencyCode = exports.getDaysAndHoursDifference = exports.isUserAllowedToUpdate = exports.mmssToSecs = exports.toNumber = void 0;
 var number_util_1 = require("./number.util");
 Object.defineProperty(exports, "toNumber", { enumerable: true, get: function () { return number_util_1.toNumber; } });
 var time_util_1 = require("./time.util");
@@ -27,3 +27,6 @@ Object.defineProperty(exports, "NOOP", { enumerable: true, get: function () { re
 var scoring_1 = require("./scoring");
 Object.defineProperty(exports, "calculateExerciseScoreV2", { enumerable: true, get: function () { return scoring_1.calculateExerciseScoreV2; } });
 Object.defineProperty(exports, "calculateTotalVolume", { enumerable: true, get: function () { return scoring_1.calculateTotalVolume; } });
+var scaleProPlan_util_1 = require("./adoptionEngine/scaleProPlan.util");
+Object.defineProperty(exports, "scaleProPlan", { enumerable: true, get: function () { return scaleProPlan_util_1.scaleProPlan; } });
+Object.defineProperty(exports, "calculateBMI", { enumerable: true, get: function () { return scaleProPlan_util_1.calculateBMI; } });

package/dist/utils/scaleProPlan.util.d.ts

@@ -0,0 +1,9 @@
+import { TProPlan, TUserMetric, TExercise } from "../types";
+/**
+ * Calculates the BMI (Body Mass Index).
+ */
+export declare const calculateBMI: (weightKg: number, heightCm: number) => number;
+/**
+ * The Adoption Engine: Safely scales a Master Pro Plan to fit an individual user's body type.
+ */
+export declare const scaleProPlan: (masterPlan: TProPlan, userMetric: TUserMetric, exercisesDictionary: Record<string, TExercise>) => TProPlan;

package/dist/utils/scaleProPlan.util.js

@@ -0,0 +1,139 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scaleProPlan = exports.calculateBMI = void 0;
+const NO_THRESHOLD = Infinity;
+/**
+ * Calculates the BMI (Body Mass Index).
+ */
+const calculateBMI = (weightKg, heightCm) => {
+    if (!weightKg || !heightCm || heightCm <= 0)
+        return 0;
+    const heightM = heightCm / 100;
+    return Number((weightKg / (heightM * heightM)).toFixed(1));
+};
+exports.calculateBMI = calculateBMI;
+/**
+ * Rounds a calculated weight load to the nearest sensible gym increment (e.g. 2.5kg).
+ */
+const roundToNearest = (val, increment) => Math.round(val / increment) * increment;
+/**
+ * Calculates effective BMI threshold based on the user's fitness activity level.
+ * Active users carry more muscle, so their BMI threshold for bodyweight safety triggers is raised.
+ */
+const getAdjustedBMIThreshold = (baseThreshold, activityLevel) => {
+    if (!baseThreshold)
+        return NO_THRESHOLD;
+    switch (activityLevel) {
+        case "very-active":
+            return baseThreshold + 5; // e.g. Obese trigger moves from 30 to 35
+        case "moderately-active":
+            return baseThreshold + 3; // e.g. Obese trigger moves from 30 to 33
+        case "lightly-active":
+            return baseThreshold + 1;
+        case "sedentary":
+        default:
+            return baseThreshold; // No adjustment
+    }
+};
+/**
+ * Modifies an individual record based on fallback logic (when no regression exercise exists, or for softer triggers).
+ * Reduces volume or duration by roughly 30%.
+ */
+const applyFallbackScalingToRecord = (record) => {
+    const scaledRecord = Object.assign({}, record);
+    const SCALE_FACTOR = 0.7;
+    // Scale reps
+    if (scaledRecord.type === "reps-only" || scaledRecord.type === "weight-reps") {
+        const currentReps = parseInt(scaledRecord.reps, 10);
+        if (!isNaN(currentReps) && currentReps > 0) {
+            scaledRecord.reps = Math.max(1, Math.round(currentReps * SCALE_FACTOR)).toString();
+        }
+    }
+    // Scale duration for all time-based records
+    if (scaledRecord.type === "duration" ||
+        scaledRecord.type === "cardio-machine" ||
+        scaledRecord.type === "cardio-free") {
+        const [mm, ss] = scaledRecord.durationMmSs.split(":").map(Number);
+        if (!isNaN(mm) && !isNaN(ss)) {
+            const totalSecs = mm * 60 + ss;
+            const newSecs = Math.max(5, Math.round(totalSecs * SCALE_FACTOR)); // minimum 5 seconds
+            const newMm = Math.floor(newSecs / 60).toString();
+            const newMmPadded = newMm.length < 2 ? "0" + newMm : newMm;
+            const newSs = (newSecs % 60).toString();
+            const newSsPadded = newSs.length < 2 ? "0" + newSs : newSs;
+            scaledRecord.durationMmSs = `${newMmPadded}:${newSsPadded}`;
+        }
+    }
+    return scaledRecord;
+};
+/**
+ * The Adoption Engine: Safely scales a Master Pro Plan to fit an individual user's body type.
+ */
+const scaleProPlan = (masterPlan, userMetric, exercisesDictionary) => {
+    // We don't mutate the original
+    const tailoredPlan = JSON.parse(JSON.stringify(masterPlan));
+    const { weightKg, heightCm, gender, fitnessLevel } = userMetric;
+    const bmi = weightKg && heightCm ? (0, exports.calculateBMI)(weightKg, heightCm) : 0;
+    tailoredPlan.days.forEach((day) => {
+        day.exercises = day.exercises.map((templateExercise) => {
+            const exerciseMeta = exercisesDictionary[templateExercise.exerciseId];
+            // If we can't find metadata, return as-is
+            if (!exerciseMeta)
+                return templateExercise;
+            let isModified = false;
+            let newExerciseId = templateExercise.exerciseId;
+            let newRecords = [...templateExercise.initialRecords];
+            // 1. Check Safety Triggers (BMI & Bodyweight Dependency)
+            if (bmi > 0 &&
+                (exerciseMeta.bodyweightDependency === "high" || exerciseMeta.bodyweightDependency === "medium") &&
+                exerciseMeta.bmiThresholds) {
+                const obeseTrigger = getAdjustedBMIThreshold(exerciseMeta.bmiThresholds.obeseTrigger, fitnessLevel);
+                const overweightTrigger = getAdjustedBMIThreshold(exerciseMeta.bmiThresholds.overweightTrigger, fitnessLevel);
+                if (bmi >= obeseTrigger) {
+                    // Tier 1: Hard swap to regression (if available) AND scale down volume
+                    newRecords = newRecords.map(applyFallbackScalingToRecord);
+                    isModified = true;
+                    if (exerciseMeta.regressionExerciseId && exercisesDictionary[exerciseMeta.regressionExerciseId]) {
+                        newExerciseId = exerciseMeta.regressionExerciseId;
+                    }
+                }
+                else if (bmi >= overweightTrigger) {
+                    // Tier 2: Softer response. Keep the exercise, but scale down the volume/duration.
+                    newRecords = newRecords.map(applyFallbackScalingToRecord);
+                    isModified = true;
+                }
+            }
+            // 2. Check Load Multipliers
+            if (weightKg && exerciseMeta.weightMultiplier && newRecords.length > 0) {
+                const multiplier = gender === "male"
+                    ? exerciseMeta.weightMultiplier.male
+                    : gender === "female"
+                        ? exerciseMeta.weightMultiplier.female
+                        : exerciseMeta.weightMultiplier.default;
+                if (multiplier && multiplier > 0) {
+                    // Round to nearest 2.5kg to match real-world gym equipment
+                    const suggestedLoadKg = roundToNearest(weightKg * multiplier, 2.5);
+                    newRecords = newRecords.map((record) => {
+                        if (record.type === "weight-reps") {
+                            isModified = true;
+                            return Object.assign(Object.assign({}, record), { kg: suggestedLoadKg.toString() });
+                        }
+                        // Guard against applying load to a falsy "0" aux weight
+                        if (record.type === "reps-only" || record.type === "duration" || record.type === "cardio-free") {
+                            const currentAux = parseFloat(record.auxWeightKg || "0");
+                            if (!isNaN(currentAux) && currentAux > 0) {
+                                isModified = true;
+                                return Object.assign(Object.assign({}, record), { auxWeightKg: suggestedLoadKg.toString() });
+                            }
+                        }
+                        return record;
+                    });
+                }
+            }
+            // Return the tailored template exercise
+            return Object.assign(Object.assign({}, templateExercise), { exerciseId: newExerciseId, initialRecords: newRecords, isAutoScaled: isModified || undefined });
+        });
+    });
+    return tailoredPlan;
+};
+exports.scaleProPlan = scaleProPlan;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@dgpholdings/greatoak-shared",
-	"version": "1.2.34",
+	"version": "1.2.36",
 	"description": "Shared TypeScript types and utilities for @dgpholdings projects",
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",