@sunsteel/contracts 0.10.0 → 0.12.0

package/dist/index.cjs

@@ -24,6 +24,7 @@ __export(index_exports, {
   PROGRESSION_SCHEMES: () => PROGRESSION_SCHEMES,
   REP_TYPES: () => REP_TYPES,
   SEXES: () => SEXES,
+  TRAINING_EVENT_TYPES: () => TRAINING_EVENT_TYPES,
   WEIGHT_UNITS: () => WEIGHT_UNITS,
   WORKOUT_SESSION_STATUSES: () => WORKOUT_SESSION_STATUSES
 });
@@ -62,12 +63,20 @@ var MUSCLE_GROUPS = [
   "CORE",
   "ADDUCTOR"
 ];
+
+// src/analytics.ts
+var TRAINING_EVENT_TYPES = [
+  "SESSION_COMPLETED",
+  "PERSONAL_RECORD",
+  "PROGRESSION_CHANGED"
+];
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   MUSCLE_GROUPS,
   PROGRESSION_SCHEMES,
   REP_TYPES,
   SEXES,
+  TRAINING_EVENT_TYPES,
   WEIGHT_UNITS,
   WORKOUT_SESSION_STATUSES
 });

package/dist/index.d.cts

@@ -286,6 +286,30 @@ interface FinishWorkoutRequest {
     status: FinishStatus;
     notes?: string;
 }
+type ProgressionRule = 'ALL_SETS_REACHED_TARGET' | 'SET_REACHED_TARGET';
+interface ProgressionSetChange {
+    setNumber: number;
+    targetReps: number;
+    performedReps: number;
+    previousWeightKg: number;
+    newWeightKg: number;
+}
+/** An automatic prescription update produced while completing a session. */
+interface ProgressionChange {
+    routineExerciseId: string;
+    exerciseId: string;
+    exerciseName: string;
+    progressionScheme: Extract<ProgressionScheme, 'DOUBLE_PROGRESSION' | 'DYNAMIC_DOUBLE_PROGRESSION'>;
+    rule: ProgressionRule;
+    minWeightIncrementKg: number;
+    sets: ProgressionSetChange[];
+}
+/** Stable successful response of PATCH /workouts/sessions/:id/finish. */
+interface FinishWorkoutResponse {
+    session: WorkoutSession;
+    progressionChanges: ProgressionChange[];
+    recap: WorkoutSessionRecap | null;
+}
 interface UpsertSetLogRequest {
     routineExerciseId: string;
     exerciseId: string;
@@ -311,6 +335,37 @@ interface UpsertSetLogResponse {
     setLog: SetLog;
     earnedRecords: EarnedPersonalRecord[];
 }
+/** Final record frontier earned by one completed session. */
+interface SessionRecapRecord extends EarnedPersonalRecord {
+    setNumber: number;
+    achievedAt: IsoDateString;
+}
+/** Metrics from the latest earlier execution of the same routine day. */
+interface PreviousSessionRecap {
+    sessionId: string;
+    endedAt: IsoDateString;
+    durationSec: number;
+    totalVolumeKg: number;
+    completedSets: number;
+    durationDeltaSec: number;
+    volumeDeltaKg: number;
+    completedSetsDelta: number;
+}
+/** Stable successful response of GET /workouts/sessions/:id/recap. */
+interface WorkoutSessionRecap {
+    sessionId: string;
+    routineName: string;
+    dayName?: string | null;
+    startedAt: IsoDateString;
+    endedAt: IsoDateString;
+    durationSec: number;
+    totalVolumeKg: number;
+    completedSets: number;
+    notes?: string | null;
+    records: SessionRecapRecord[];
+    progressionChanges: ProgressionChange[];
+    previousSession: PreviousSessionRecap | null;
+}
 interface WorkoutSessionSummary {
     id: string;
     status: WorkoutSessionStatus;
@@ -350,6 +405,8 @@ interface WorkoutStatsResponse {
     activeDaysThisWeek: number;
 }
 
+declare const TRAINING_EVENT_TYPES: readonly ["SESSION_COMPLETED", "PERSONAL_RECORD", "PROGRESSION_CHANGED"];
+type TrainingEventType = (typeof TRAINING_EVENT_TYPES)[number];
 /** Stable successful response of GET /workouts/progress. */
 interface WorkoutProgressQuery {
     timeZone: string;
@@ -404,4 +461,4 @@ interface WorkoutAnalyticsStatus {
     generationId: string | null;
 }
 
-export { type Brand, type CreateRoutineDayInput, type CreateRoutineExerciseInput, type CreateRoutineRequest, type EarnedPersonalRecord, type Exercise, type ExerciseId, type FinishStatus, type FinishWorkoutRequest, type IsoDateString, type ListSessionsParams, MUSCLE_GROUPS, type MuscleGroup, PROGRESSION_SCHEMES, type PaginatedResponse, type PersonalRecordEntry, type PersonalRecordKind, type PlatePairInventory, type PreviousPerformanceResponse, type PreviousSetPerformance, type ProgressionScheme, type PublicUserProfile, REP_TYPES, type RecentActivityEntry, type RepType, type ReplaceTrainingLocationsRequest, type Routine, type RoutineDay, type RoutineDayId, type RoutineExercise, type RoutineId, type RoutineSet, SEXES, type SetAccountTimeZoneRequest, type SetLog, type Sex, type StartWorkoutRequest, type StartWorkoutResponse, type SupabaseAuthResponse, type SupabaseAuthUser, type SupabaseMigrationResponse, type TrainingLocationPreference, type TrainingLocationPreferenceInput, type UpdateProfileRequest, type UpdateRoutineRequest, type UpsertSetLogRequest, type UpsertSetLogResponse, type UserId, type UserProfile, type UserSearchResponse, WEIGHT_UNITS, WORKOUT_SESSION_STATUSES, type WeightUnit, type WorkoutAnalyticsStatus, type WorkoutProgressQuery, type WorkoutProgressResponse, type WorkoutSession, type WorkoutSessionId, type WorkoutSessionListResponse, type WorkoutSessionSnapshotV1, type WorkoutSessionStatus, type WorkoutSessionSummary, type WorkoutStatsQuery, type WorkoutStatsResponse };
+export { type Brand, type CreateRoutineDayInput, type CreateRoutineExerciseInput, type CreateRoutineRequest, type EarnedPersonalRecord, type Exercise, type ExerciseId, type FinishStatus, type FinishWorkoutRequest, type FinishWorkoutResponse, type IsoDateString, type ListSessionsParams, MUSCLE_GROUPS, type MuscleGroup, PROGRESSION_SCHEMES, type PaginatedResponse, type PersonalRecordEntry, type PersonalRecordKind, type PlatePairInventory, type PreviousPerformanceResponse, type PreviousSessionRecap, type PreviousSetPerformance, type ProgressionChange, type ProgressionRule, type ProgressionScheme, type ProgressionSetChange, type PublicUserProfile, REP_TYPES, type RecentActivityEntry, type RepType, type ReplaceTrainingLocationsRequest, type Routine, type RoutineDay, type RoutineDayId, type RoutineExercise, type RoutineId, type RoutineSet, SEXES, type SessionRecapRecord, type SetAccountTimeZoneRequest, type SetLog, type Sex, type StartWorkoutRequest, type StartWorkoutResponse, type SupabaseAuthResponse, type SupabaseAuthUser, type SupabaseMigrationResponse, TRAINING_EVENT_TYPES, type TrainingEventType, type TrainingLocationPreference, type TrainingLocationPreferenceInput, type UpdateProfileRequest, type UpdateRoutineRequest, type UpsertSetLogRequest, type UpsertSetLogResponse, type UserId, type UserProfile, type UserSearchResponse, WEIGHT_UNITS, WORKOUT_SESSION_STATUSES, type WeightUnit, type WorkoutAnalyticsStatus, type WorkoutProgressQuery, type WorkoutProgressResponse, type WorkoutSession, type WorkoutSessionId, type WorkoutSessionListResponse, type WorkoutSessionRecap, type WorkoutSessionSnapshotV1, type WorkoutSessionStatus, type WorkoutSessionSummary, type WorkoutStatsQuery, type WorkoutStatsResponse };

package/dist/index.d.ts

@@ -286,6 +286,30 @@ interface FinishWorkoutRequest {
     status: FinishStatus;
     notes?: string;
 }
+type ProgressionRule = 'ALL_SETS_REACHED_TARGET' | 'SET_REACHED_TARGET';
+interface ProgressionSetChange {
+    setNumber: number;
+    targetReps: number;
+    performedReps: number;
+    previousWeightKg: number;
+    newWeightKg: number;
+}
+/** An automatic prescription update produced while completing a session. */
+interface ProgressionChange {
+    routineExerciseId: string;
+    exerciseId: string;
+    exerciseName: string;
+    progressionScheme: Extract<ProgressionScheme, 'DOUBLE_PROGRESSION' | 'DYNAMIC_DOUBLE_PROGRESSION'>;
+    rule: ProgressionRule;
+    minWeightIncrementKg: number;
+    sets: ProgressionSetChange[];
+}
+/** Stable successful response of PATCH /workouts/sessions/:id/finish. */
+interface FinishWorkoutResponse {
+    session: WorkoutSession;
+    progressionChanges: ProgressionChange[];
+    recap: WorkoutSessionRecap | null;
+}
 interface UpsertSetLogRequest {
     routineExerciseId: string;
     exerciseId: string;
@@ -311,6 +335,37 @@ interface UpsertSetLogResponse {
     setLog: SetLog;
     earnedRecords: EarnedPersonalRecord[];
 }
+/** Final record frontier earned by one completed session. */
+interface SessionRecapRecord extends EarnedPersonalRecord {
+    setNumber: number;
+    achievedAt: IsoDateString;
+}
+/** Metrics from the latest earlier execution of the same routine day. */
+interface PreviousSessionRecap {
+    sessionId: string;
+    endedAt: IsoDateString;
+    durationSec: number;
+    totalVolumeKg: number;
+    completedSets: number;
+    durationDeltaSec: number;
+    volumeDeltaKg: number;
+    completedSetsDelta: number;
+}
+/** Stable successful response of GET /workouts/sessions/:id/recap. */
+interface WorkoutSessionRecap {
+    sessionId: string;
+    routineName: string;
+    dayName?: string | null;
+    startedAt: IsoDateString;
+    endedAt: IsoDateString;
+    durationSec: number;
+    totalVolumeKg: number;
+    completedSets: number;
+    notes?: string | null;
+    records: SessionRecapRecord[];
+    progressionChanges: ProgressionChange[];
+    previousSession: PreviousSessionRecap | null;
+}
 interface WorkoutSessionSummary {
     id: string;
     status: WorkoutSessionStatus;
@@ -350,6 +405,8 @@ interface WorkoutStatsResponse {
     activeDaysThisWeek: number;
 }
 
+declare const TRAINING_EVENT_TYPES: readonly ["SESSION_COMPLETED", "PERSONAL_RECORD", "PROGRESSION_CHANGED"];
+type TrainingEventType = (typeof TRAINING_EVENT_TYPES)[number];
 /** Stable successful response of GET /workouts/progress. */
 interface WorkoutProgressQuery {
     timeZone: string;
@@ -404,4 +461,4 @@ interface WorkoutAnalyticsStatus {
     generationId: string | null;
 }
 
-export { type Brand, type CreateRoutineDayInput, type CreateRoutineExerciseInput, type CreateRoutineRequest, type EarnedPersonalRecord, type Exercise, type ExerciseId, type FinishStatus, type FinishWorkoutRequest, type IsoDateString, type ListSessionsParams, MUSCLE_GROUPS, type MuscleGroup, PROGRESSION_SCHEMES, type PaginatedResponse, type PersonalRecordEntry, type PersonalRecordKind, type PlatePairInventory, type PreviousPerformanceResponse, type PreviousSetPerformance, type ProgressionScheme, type PublicUserProfile, REP_TYPES, type RecentActivityEntry, type RepType, type ReplaceTrainingLocationsRequest, type Routine, type RoutineDay, type RoutineDayId, type RoutineExercise, type RoutineId, type RoutineSet, SEXES, type SetAccountTimeZoneRequest, type SetLog, type Sex, type StartWorkoutRequest, type StartWorkoutResponse, type SupabaseAuthResponse, type SupabaseAuthUser, type SupabaseMigrationResponse, type TrainingLocationPreference, type TrainingLocationPreferenceInput, type UpdateProfileRequest, type UpdateRoutineRequest, type UpsertSetLogRequest, type UpsertSetLogResponse, type UserId, type UserProfile, type UserSearchResponse, WEIGHT_UNITS, WORKOUT_SESSION_STATUSES, type WeightUnit, type WorkoutAnalyticsStatus, type WorkoutProgressQuery, type WorkoutProgressResponse, type WorkoutSession, type WorkoutSessionId, type WorkoutSessionListResponse, type WorkoutSessionSnapshotV1, type WorkoutSessionStatus, type WorkoutSessionSummary, type WorkoutStatsQuery, type WorkoutStatsResponse };
+export { type Brand, type CreateRoutineDayInput, type CreateRoutineExerciseInput, type CreateRoutineRequest, type EarnedPersonalRecord, type Exercise, type ExerciseId, type FinishStatus, type FinishWorkoutRequest, type FinishWorkoutResponse, type IsoDateString, type ListSessionsParams, MUSCLE_GROUPS, type MuscleGroup, PROGRESSION_SCHEMES, type PaginatedResponse, type PersonalRecordEntry, type PersonalRecordKind, type PlatePairInventory, type PreviousPerformanceResponse, type PreviousSessionRecap, type PreviousSetPerformance, type ProgressionChange, type ProgressionRule, type ProgressionScheme, type ProgressionSetChange, type PublicUserProfile, REP_TYPES, type RecentActivityEntry, type RepType, type ReplaceTrainingLocationsRequest, type Routine, type RoutineDay, type RoutineDayId, type RoutineExercise, type RoutineId, type RoutineSet, SEXES, type SessionRecapRecord, type SetAccountTimeZoneRequest, type SetLog, type Sex, type StartWorkoutRequest, type StartWorkoutResponse, type SupabaseAuthResponse, type SupabaseAuthUser, type SupabaseMigrationResponse, TRAINING_EVENT_TYPES, type TrainingEventType, type TrainingLocationPreference, type TrainingLocationPreferenceInput, type UpdateProfileRequest, type UpdateRoutineRequest, type UpsertSetLogRequest, type UpsertSetLogResponse, type UserId, type UserProfile, type UserSearchResponse, WEIGHT_UNITS, WORKOUT_SESSION_STATUSES, type WeightUnit, type WorkoutAnalyticsStatus, type WorkoutProgressQuery, type WorkoutProgressResponse, type WorkoutSession, type WorkoutSessionId, type WorkoutSessionListResponse, type WorkoutSessionRecap, type WorkoutSessionSnapshotV1, type WorkoutSessionStatus, type WorkoutSessionSummary, type WorkoutStatsQuery, type WorkoutStatsResponse };

package/dist/index.js

@@ -31,11 +31,19 @@ var MUSCLE_GROUPS = [
   "CORE",
   "ADDUCTOR"
 ];
+
+// src/analytics.ts
+var TRAINING_EVENT_TYPES = [
+  "SESSION_COMPLETED",
+  "PERSONAL_RECORD",
+  "PROGRESSION_CHANGED"
+];
 export {
   MUSCLE_GROUPS,
   PROGRESSION_SCHEMES,
   REP_TYPES,
   SEXES,
+  TRAINING_EVENT_TYPES,
   WEIGHT_UNITS,
   WORKOUT_SESSION_STATUSES
 };

package/package.json

@@ -1,40 +1,40 @@
-{
-  "name": "@sunsteel/contracts",
-  "version": "0.10.0",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ezee969/sunsteel-contracts.git"
-  },
-  "private": false,
-  "engines": {
-    "node": ">=20.11"
-  },
-  "type": "module",
-  "sideEffects": false,
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
-    }
-  },
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "tsup src/index.ts --format esm,cjs --dts --clean",
-    "dev": "tsup src/index.ts --format esm,cjs --dts --watch",
-    "typecheck": "tsc --noEmit",
-    "lint": "npm run typecheck",
-    "verify": "npm run typecheck && npm run build",
-    "verify:security": "npm audit",
-    "prepublishOnly": "npm run build"
-  },
-  "devDependencies": {
-    "tsup": "^8.3.5",
-    "typescript": "^5.7.3"
-  }
-}
+{
+  "name": "@sunsteel/contracts",
+  "version": "0.12.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ezee969/sunsteel-contracts.git"
+  },
+  "private": false,
+  "engines": {
+    "node": ">=20.11"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean",
+    "dev": "tsup src/index.ts --format esm,cjs --dts --watch",
+    "typecheck": "tsc --noEmit",
+    "lint": "npm run typecheck",
+    "verify": "npm run typecheck && npm run build",
+    "verify:security": "npm audit",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.3"
+  }
+}