@dgpholdings/greatoak-shared 1.2.92 → 1.2.94

package/dist/__mocks__/user.mock.js

@@ -5,7 +5,6 @@ const testIds_1 = require("./testIds");
 exports.mockUser = {
     // TUserPreferences fields (flat in TUserMetric)
     preferredDurationMinutes: 45,
-    fitnessGoals: ["hypertrophy"],
     preferredEquipment: ["dumbbell", "barbell"],
     preferCompoundMovements: true,
     includeWarmup: "ai_decide",
@@ -17,6 +16,7 @@ exports.mockUser = {
     bodyFatPercentage: 15,
     metricSystem: "EU",
     appLanguage: "en",
+    goalProfile: undefined,
     preferencesUpdatedAt: new Date("2023-01-01").toISOString(),
     femaleHealth: null, // Male user
     constellationLevel: 1,

package/dist/constants/index.d.ts

@@ -1,3 +1,2 @@
 export * from "./BodyCategories";
 export * from "./AiExerciseVocabulary";
-export * from "./goalJourney";

package/dist/constants/index.js

@@ -16,4 +16,3 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BodyCategories"), exports);
 __exportStar(require("./AiExerciseVocabulary"), exports);
-__exportStar(require("./goalJourney"), exports);

package/dist/types/TApiAiQuickStartWorkout.d.ts

@@ -1,4 +1,5 @@
 import { TAiEnergyLevel, TAiUserInjury, TQuickStartEquipmentGroupExplicit } from "../constants/AiExerciseVocabulary";
+import { TTrainingPhase, TUserFitnessGoal } from "./goalFeature";
 import { TTemplate } from "./TApiTemplateData";
 export type TApiAiQuickStartWorkoutReq = {
     /**
@@ -62,6 +63,12 @@ export type TApiAiQuickStartWorkoutReq = {
      * backend treats it as "no equipment filter" — i.e. all candidates eligible.
      */
     equipmentSelectionOverride: TQuickStartEquipmentSelection;
+    goalContext?: {
+        activeGoal: TUserFitnessGoal;
+        currentPhase: TTrainingPhase;
+        currentWeek: number;
+        phaseName: string;
+    };
 };
 export type TQuickStartEquipmentSelection = {
     type: "preferences";

package/dist/types/TApiAuth.d.ts

@@ -1,5 +1,4 @@
-import type { TAiFitnessGoal } from "../constants/AiExerciseVocabulary";
-import { TAuthType, TGender, TProfessionalCategory, TUserMetric, TUserType, TInjuryInfo } from "./TApiUser";
+import { TAuthType, TGender, TInjuryInfo, TProfessionalCategory, TUserMetric, TUserType } from "./TApiUser";
 import { TActivityLevel } from "./TUserPreferences";
 /**
  * Anonymous signup request.
@@ -25,7 +24,6 @@ export type TApiSignupAnonymousReq = {
     gender: TGender;
     bodyFatPercentage: number;
     metricSystem: "US" | "EU";
-    fitnessGoals: TAiFitnessGoal[];
     fitnessLevel: TActivityLevel;
     injuryInfo?: TInjuryInfo;
     gdprAnalytics: boolean;

package/dist/types/TApiUser.d.ts

@@ -1,6 +1,7 @@
 import type { TAiFitnessGoal, TAiUserInjury } from "../constants/AiExerciseVocabulary";
 import { TConstellationUserLevel } from "../utils";
 import { TGdprData } from "./commonTypes";
+import { TGoalProfile } from "./goalFeature";
 import { TUserPreferences } from "./TUserPreferences";
 export type TAuthType = "email" | "apple" | "anonymous" | "token";
 export type TGender = "male" | "female" | "unmentioned";
@@ -25,8 +26,9 @@ export type TUserMetric = TUserPreferences & {
     userType: TUserType;
     professionType?: TProfessionalCategory;
     gender: TGender;
-    weightKg?: number;
-    heightCm?: number;
+    weightKg: number;
+    heightCm: number;
+    goalProfile: TGoalProfile | undefined;
     emailAddress?: string;
     injuryInfo?: TInjuryInfo;
     subscriptionStatus: TSubscriptionStatus;

package/dist/types/TUserPreferences.d.ts

@@ -1,11 +1,10 @@
-import { TAiEquipmentType, TAiFitnessGoal } from "../constants";
+import { TAiEquipmentType } from "../constants";
 import { TBodyPart } from "./TApiExercise";
 export type TPreferredDuration = 20 | 30 | 45 | 60 | 90 | 120;
 export type TAIDecision = "yes" | "no" | "ai_decide";
 export type TWarmupStyle = "dynamic_stretching" | "light_cardio";
 export type TStablePreferences = {
     preferredDurationMinutes: TPreferredDuration;
-    fitnessGoals: TAiFitnessGoal[];
     preferredEquipment: TAiEquipmentType[];
     preferCompoundMovements: boolean;
     includeWarmup: TAIDecision;
@@ -13,7 +12,7 @@ export type TStablePreferences = {
     warmupStyle: TWarmupStyle | null;
     favouriteMuscleGroups: TBodyPart[];
     blacklistedExerciseIds: string[];
-    fitnessLevel?: TActivityLevel;
+    fitnessLevel: TActivityLevel;
     bodyFatPercentage?: number;
     metricSystem: "US" | "EU";
     appLanguage: string;

package/dist/types/goalFeature/TApiGoalContextRes.d.ts

@@ -0,0 +1,64 @@
+import { TWorkoutIntent } from "../../constants";
+import { TDaysPerWeek, TSessionIntent, TTrainingPhase, TUserFitnessGoal } from "./goalJourney";
+export type TGoalProfile = {
+    activeGoal: TUserFitnessGoal;
+    goalStartDate: string;
+    daysPerWeek: TDaysPerWeek;
+    phaseCompletions: {
+        phase: TTrainingPhase;
+        completedAt: string;
+        celebrationShown: boolean;
+    }[];
+    previousGoals: {
+        goal: TUserFitnessGoal;
+        startDate: string;
+        endDate: string;
+        weeksCompleted: number;
+        reasonEnded: "completed" | "changed";
+    }[];
+};
+export type TGoalContext = {
+    goal: TUserFitnessGoal;
+    daysPerWeek: TDaysPerWeek;
+    currentPhase: TTrainingPhase;
+    currentWeek: number;
+    weeklyStructure: TSessionIntent[];
+    lastSessionDate: string;
+    lastSessionIntent: TSessionIntent;
+    sessionsCompletedThisWeek: number;
+    totalSessionsSinceGoalStart: number;
+    sessionsInLast4Weeks: number;
+};
+export type TIntentRecommendation = {
+    intent: TWorkoutIntent;
+    confidence: number;
+    rationale: string;
+    decisionPath: "global_recovery" | "returning_user" | "gap_bridge" | "structure_follow" | "muscle_override";
+    intentScores: Partial<Record<TWorkoutIntent, number>>;
+};
+export type TGoalSessionSummary = {
+    sessionId: string;
+    createdAt: string;
+    intentId: TWorkoutIntent | undefined;
+    exercises: {
+        exerciseId: string;
+        thumbnailUrl: string;
+        name: string;
+    }[];
+};
+export type TApiGoalContextRes = {
+    status: 200;
+    goalProfile: TGoalProfile;
+    goalContext: TGoalContext;
+    recommendation: TIntentRecommendation;
+    recentSessions: TGoalSessionSummary[];
+    weeklySessionCounts: {
+        weekNumber: number;
+        weekStartDate: string;
+        count: number;
+    }[];
+    newPhaseUnlocked?: TTrainingPhase;
+} | {
+    status: 400 | 401 | 404 | 500;
+    message: string;
+};

package/dist/types/goalFeature/TApiGoalContextRes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/goalFeature/goalJourney.d.ts

@@ -0,0 +1,111 @@
+import { TActivityLevel } from "..";
+import { TAiFitnessGoal, TWorkoutIntent } from "../../constants/AiExerciseVocabulary";
+export declare const USER_FITNESS_GOALS: readonly ["lose_weight", "build_muscle", "lean_and_toned", "glutes_and_legs", "get_stronger", "boost_endurance", "athletic_performance", "general_fitness", "posture_and_back", "stress_relief", "rehabilitation", "core_strength", "mobility_flexibility"];
+export type TUserFitnessGoal = (typeof USER_FITNESS_GOALS)[number];
+export type TSessionIntent = TWorkoutIntent | "rest";
+export declare const GOAL_SESSION_INTENTS: Record<TUserFitnessGoal, TWeeklyIntentTemplate>;
+export declare const GOAL_TO_AI_FITNESS_GOAL: Record<TUserFitnessGoal, TAiFitnessGoal>;
+export declare const TRAINING_PHASES: readonly ["foundation", "momentum", "push", "peak"];
+export type TTrainingPhase = (typeof TRAINING_PHASES)[number];
+export type TPhaseDisplay = {
+    /** i18n key for the phase name — e.g. "goalPhase.foundation.name" */
+    nameKey: string;
+    /** English fallback for nameKey */
+    nameEn: string;
+    /** i18n key for the short subtitle — e.g. "goalPhase.foundation.subtitle" */
+    subtitleKey: string;
+    /** English fallback for subtitleKey */
+    subtitleEn: string;
+    /** i18n key for the longer purpose description shown in phase detail */
+    purposeKey: string;
+    /** English fallback for purposeKey */
+    purposeEn: string;
+    /** i18n key for the week range label — e.g. "goalPhase.foundation.duration" */
+    durationKey: string;
+    /** English fallback for durationKey */
+    durationEn: string;
+    /** Inclusive week range [startWeek, endWeek]. Phase 4 end is open (99). */
+    weekRange: [number, number];
+    /**
+     * Reference intensity as a percentage (0–100).
+     * For UI progress bars / intensity indicators only — not used in algorithm.
+     */
+    intensityPercent: number;
+};
+export declare const PHASE_DISPLAY: Record<TTrainingPhase, TPhaseDisplay>;
+export type TIntentDisplay = {
+    /** i18n key for the full label — e.g. "sessionIntent.push.label" */
+    labelKey: string;
+    /** English fallback for labelKey */
+    labelEn: string;
+    /**
+     * i18n key for the short label used in compact journey nodes.
+     * e.g. "sessionIntent.push.shortLabel"
+     */
+    shortLabelKey: string;
+    /** English fallback for shortLabelKey */
+    shortLabelEn: string;
+    /**
+     * Emoji for the session node icon.
+     * Not translated — emoji is universal.
+     */
+    emoji: string;
+};
+export declare const INTENT_DISPLAY: Record<Exclude<TSessionIntent, "arms" | "back" | "unstructured">, TIntentDisplay>;
+export type TGoalDisplay = {
+    /** i18n key for the goal name — e.g. "userGoal.loseWeight.name" */
+    nameKey: string;
+    /** English fallback for nameKey */
+    nameEn: string;
+    /** i18n key for the short description shown on goal selection screen */
+    descriptionKey: string;
+    /** English fallback for descriptionKey */
+    descriptionEn: string;
+    /**
+     * i18n key for the motivational tagline shown on the goal journey screen.
+     * e.g. "userGoal.loseWeight.tagline"
+     */
+    taglineKey: string;
+    /** English fallback for taglineKey */
+    taglineEn: string;
+    /** Emoji representing the goal — universal, not translated */
+    emoji: string;
+    /**
+     * Goal category — used to group goals on the selection screen.
+     * Category label itself is also translated via categoryKey.
+     */
+    category: "appearance" | "performance" | "health" | "focused";
+};
+export declare const GOAL_DISPLAY: Record<TUserFitnessGoal, TGoalDisplay>;
+export type TGoalCategory = TGoalDisplay["category"];
+export type TGoalCategoryDisplay = {
+    labelKey: string;
+    labelEn: string;
+};
+export declare const GOAL_CATEGORY_DISPLAY: Record<TGoalCategory, TGoalCategoryDisplay>;
+export declare const PHASE_ENTRY_CREDIT: Record<TActivityLevel, number>;
+export declare const RECENCY_CREDIT: Record<TActivityLevel, number>;
+/**
+ * Derive training phase from time + volume + recency.
+ * All three must pass — week count alone is NOT sufficient.
+ * A user doing 12 sessions over one year has not built a training base.
+ *
+ * On goal start day (no sessions yet), pass:
+ *   totalSessions = PHASE_ENTRY_CREDIT[user.fitnessLevel]
+ *   sessionsInLast4Weeks = RECENCY_CREDIT[user.fitnessLevel]
+ */
+export declare function derivePhase(weekNumber: number, totalSessions: number, sessionsInLast4Weeks: number): TTrainingPhase;
+export declare const DAYS_PER_WEEK_OPTIONS: readonly [2, 3, 4, 5];
+export type TDaysPerWeek = (typeof DAYS_PER_WEEK_OPTIONS)[number];
+export type TDurationHint = "short" | "medium" | "long";
+export type TWeeklyIntentTemplate = [
+    TSessionIntent,
+    TSessionIntent,
+    TSessionIntent,
+    TSessionIntent,
+    TSessionIntent,
+    TSessionIntent,
+    TSessionIntent
+];
+export type TGoalPhaseHints = Record<TTrainingPhase, string>;
+export declare const GOAL_PHASE_HINTS: Record<TUserFitnessGoal, TGoalPhaseHints>;