@sunsteel/contracts 0.27.0 → 0.29.0

package/dist/index.cjs

@@ -20,6 +20,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  ACHIEVEMENT_CATEGORIES: () => ACHIEVEMENT_CATEGORIES,
+  ACHIEVEMENT_DEFINITIONS: () => ACHIEVEMENT_DEFINITIONS,
   EXERCISE_EQUIPMENT: () => EXERCISE_EQUIPMENT,
   EXERCISE_MECHANICS: () => EXERCISE_MECHANICS,
   FOLLOW_SUGGESTIONS_DEFAULT_LIMIT: () => FOLLOW_SUGGESTIONS_DEFAULT_LIMIT,
@@ -237,6 +239,62 @@ var MEASURABLE_GOAL_TYPES = [
 var MEASURABLE_GOAL_DIRECTIONS = ["AT_LEAST", "AT_MOST"];
 var MEASURABLE_GOALS_MAX = 8;
 
+// src/achievements.ts
+var ACHIEVEMENT_CATEGORIES = [
+  "SESSIONS",
+  "SETS",
+  "VOLUME_KG",
+  "RECORDS",
+  "STREAK_DAYS"
+];
+var formatCount = (value) => value.toLocaleString("en-US");
+function titleFor(category, threshold) {
+  const count = formatCount(threshold);
+  switch (category) {
+    case "SESSIONS":
+      return threshold === 1 ? "First Session" : `${count} Sessions`;
+    case "SETS":
+      return `${count} Sets Completed`;
+    case "VOLUME_KG":
+      return `${count} kg Moved`;
+    case "RECORDS":
+      return threshold === 1 ? "First Record" : `${count} Records`;
+    case "STREAK_DAYS":
+      return `${count}-Day Streak`;
+  }
+}
+function descriptionFor(category, threshold) {
+  const count = formatCount(threshold);
+  switch (category) {
+    case "SESSIONS":
+      return `Complete ${count} ${threshold === 1 ? "training session" : "training sessions"}.`;
+    case "SETS":
+      return `Complete ${count} logged sets.`;
+    case "VOLUME_KG":
+      return `Accumulate ${count} kg of external-load volume.`;
+    case "RECORDS":
+      return `Establish records for ${count} ${threshold === 1 ? "exercise" : "exercises"}.`;
+    case "STREAK_DAYS":
+      return `Build a ${count}-day training streak.`;
+  }
+}
+var THRESHOLDS = {
+  SESSIONS: [1, 10, 25, 50, 100],
+  SETS: [10, 100, 250, 500, 1e3],
+  VOLUME_KG: [1e3, 1e4, 5e4, 1e5, 25e4],
+  RECORDS: [1, 5, 10, 25, 50],
+  STREAK_DAYS: [2, 3, 5, 10, 20]
+};
+var ACHIEVEMENT_DEFINITIONS = ACHIEVEMENT_CATEGORIES.flatMap(
+  (category) => THRESHOLDS[category].map((threshold) => ({
+    id: `${category.toLowerCase()}:${threshold}`,
+    category,
+    threshold,
+    title: titleFor(category, threshold),
+    description: descriptionFor(category, threshold)
+  }))
+);
+
 // src/workout.ts
 var SESSION_SHARE_FIELDS = [
   "duration",
@@ -258,7 +316,9 @@ var SESSION_SHARE_MAX_ACTIVE_LINKS = 10;
 var TRAINING_EVENT_TYPES = [
   "SESSION_COMPLETED",
   "PERSONAL_RECORD",
-  "PROGRESSION_CHANGED"
+  "PROGRESSION_CHANGED",
+  "STREAK_MILESTONE",
+  "ACHIEVEMENT_UNLOCKED"
 ];
 var PROGRESS_TIMELINE_EVENT_TYPES = [
   "PERSONAL_RECORD",
@@ -266,6 +326,8 @@ var PROGRESS_TIMELINE_EVENT_TYPES = [
 ];
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ACHIEVEMENT_CATEGORIES,
+  ACHIEVEMENT_DEFINITIONS,
   EXERCISE_EQUIPMENT,
   EXERCISE_MECHANICS,
   FOLLOW_SUGGESTIONS_DEFAULT_LIMIT,

package/dist/index.d.cts

@@ -50,6 +50,12 @@ interface WorkoutSession {
     notes?: string | null;
     lastActivityAt?: IsoDateString | null;
     setLogs?: SetLog[];
+    /**
+     * LIVE-11: slots performed with a different exercise in this session. The
+     * routine day (snapshot) keeps the original prescription; set logs for a
+     * substituted slot carry the substitute's `exerciseId`.
+     */
+    exerciseSubstitutions?: SessionExerciseSubstitution[];
     reused?: boolean;
     routine?: {
         id: string;
@@ -154,6 +160,38 @@ interface UpsertSetLogRequest {
     rpe?: number;
     isCompleted?: boolean;
 }
+/**
+ * LIVE-11: an exercise performed in place of one routine slot for a single
+ * session. The substitute's muscles are captured when the swap is made, so
+ * later catalog changes cannot rewrite what the session trained.
+ */
+interface SessionExerciseSubstitution {
+    /** The replaced slot, as in `routineDay.exercises[].id`. */
+    routineExerciseId: string;
+    exercise: {
+        id: string;
+        name: string;
+        primaryMuscles: MuscleGroup[];
+        secondaryMuscles: MuscleGroup[];
+    };
+    substitutedAt: IsoDateString;
+}
+/** Body of PUT /workouts/sessions/:id/exercises/:routineExerciseId/substitution. */
+interface SubstituteSessionExerciseRequest {
+    exerciseId: string;
+    /** Also use this exercise in the routine from the next session on. */
+    applyToRoutine?: boolean;
+}
+/**
+ * Stable successful response of the substitution PUT and DELETE. A swap is
+ * refused once the slot has a completed set; incomplete drafts for the slot
+ * are cleared because their values belonged to the other exercise.
+ */
+interface SubstituteSessionExerciseResponse {
+    session: WorkoutSession;
+    /** True only when `applyToRoutine` was asked for and the routine still has the slot. */
+    routineUpdated: boolean;
+}
 type PersonalRecordKind = 'WEIGHT' | 'REPS' | 'VOLUME' | 'ESTIMATED_1RM';
 /** A record frontier crossed by the set mutation that produced this response. */
 interface EarnedPersonalRecord {
@@ -288,7 +326,7 @@ interface WorkoutStatsResponse {
     activeDaysThisWeek: number;
 }
 
-declare const TRAINING_EVENT_TYPES: readonly ["SESSION_COMPLETED", "PERSONAL_RECORD", "PROGRESSION_CHANGED"];
+declare const TRAINING_EVENT_TYPES: readonly ["SESSION_COMPLETED", "PERSONAL_RECORD", "PROGRESSION_CHANGED", "STREAK_MILESTONE", "ACHIEVEMENT_UNLOCKED"];
 type TrainingEventType = (typeof TRAINING_EVENT_TYPES)[number];
 /** Stable successful response of GET /workouts/progress. */
 interface WorkoutProgressQuery {
@@ -883,6 +921,42 @@ interface PersonalGoalsResponse {
     goals: PersonalGoalProgress[];
 }
 
+declare const ACHIEVEMENT_CATEGORIES: readonly ["SESSIONS", "SETS", "VOLUME_KG", "RECORDS", "STREAK_DAYS"];
+type AchievementCategory = (typeof ACHIEVEMENT_CATEGORIES)[number];
+interface AchievementDefinition {
+    id: string;
+    category: AchievementCategory;
+    threshold: number;
+    title: string;
+    description: string;
+}
+/** Stable milestone catalog shared by the writer and every presentation. */
+declare const ACHIEVEMENT_DEFINITIONS: readonly AchievementDefinition[];
+interface AchievementUnlockedEventPayload extends AchievementDefinition {
+    schemaVersion: 1;
+    backfilled: boolean;
+}
+interface StreakMilestoneEventPayload {
+    schemaVersion: 1;
+    achievementId: string;
+    streakDays: number;
+    backfilled: boolean;
+}
+interface EarnedAchievement extends AchievementDefinition {
+    eventId: string;
+    unlockedAt: IsoDateString;
+    sourceSessionId: string | null;
+    /** True when existing verified history was recognized after ACH-01 shipped. */
+    backfilled: boolean;
+}
+/** Stable successful response of GET /achievements. */
+interface AchievementsResponse {
+    analyticsReady: boolean;
+    earnedCount: number;
+    availableCount: number;
+    achievements: EarnedAchievement[];
+}
+
 interface RoutineSet {
     setNumber: number;
     repType: RepType;
@@ -947,4 +1021,4 @@ interface CreateRoutineRequest {
 }
 type UpdateRoutineRequest = Partial<CreateRoutineRequest>;
 
-export { type Brand, type CreateRoutineDayInput, type CreateRoutineExerciseInput, type CreateRoutineRequest, type CreateSessionShareRequest, EXERCISE_EQUIPMENT, EXERCISE_MECHANICS, type EarnedPersonalRecord, type Exercise, type ExerciseEquipment, type ExerciseId, type ExerciseMechanic, type ExercisePerformanceHistoryQuery, type ExercisePerformanceHistoryResponse, type ExercisePerformancePrescription, type ExercisePerformancePrescriptionSet, type ExercisePerformanceSession, type ExercisePerformanceSet, type ExercisePerformanceSummary, type ExerciseStrengthSummary, type ExerciseStrengthTrendPoint, type ExerciseStrengthTrendQuery, type ExerciseStrengthTrendResponse, FOLLOW_SUGGESTIONS_DEFAULT_LIMIT, FOLLOW_SUGGESTIONS_MAX_LIMIT, FOLLOW_SUGGESTION_REASONS, type FinishStatus, type FinishWorkoutRequest, type FinishWorkoutResponse, type FollowSuggestion, type FollowSuggestionReason, type FollowSuggestionsResponse, type IsoDateString, type ListSessionsParams, MEASURABLE_GOALS_MAX, MEASURABLE_GOAL_DIRECTIONS, MEASURABLE_GOAL_TYPES, MOVEMENT_PATTERNS, MUSCLE_GROUPS, type MeasurableGoal, type MeasurableGoalDirection, type MeasurableGoalExercise, type MeasurableGoalInput, type MeasurableGoalType, type MovementPattern, type MuscleGroup, type MuscleGroupHeatmapQuery, type MuscleGroupHeatmapResponse, type MuscleGroupHeatmapValue, type MuscleGroupHeatmapWeek, type MuscleVolumeTrendSeries, PREFERRED_TRAINING_STYLE_VALUES, PROFILE_BIO_MAX_LENGTH, PROFILE_FAVORITE_EXERCISES_MAX, PROFILE_LOCATION_MAX_LENGTH, PROFILE_TRAINING_DISCIPLINES_MAX, PROFILE_TRAINING_GOALS_MAX, PROFILE_VISIBILITY_VALUES, PROGRESSION_SCHEMES, PROGRESS_TIMELINE_EVENT_TYPES, type PaginatedResponse, type PersonalGoalProgress, type PersonalGoalsResponse, type PersonalRecordEntry, type PersonalRecordKind, type PlatePairInventory, type PreferredTrainingStyle, type PreviousPerformanceResponse, type PreviousSessionRecap, type PreviousSetPerformance, type ProfileDiscoverySettings, type ProfileFavoriteExercise, type ProfilePrivacySettings, type ProfileViewerAccess, type ProfileVisibility, type ProgressTimelineEventType, type ProgressTimelineItem, type ProgressTimelinePersonalRecordItem, type ProgressTimelineProgressionItem, type ProgressTimelineQuery, type ProgressTimelineRecordPerformance, type ProgressTimelineRecordReason, type ProgressTimelineResponse, type ProgressTimelineSessionContext, type ProgressionChange, type ProgressionRule, type ProgressionScheme, type ProgressionSetChange, type PublicBodyMetrics, type PublicTrainingSummary, type PublicUserProfile, RELATIONSHIP_LIST_DEFAULT_LIMIT, RELATIONSHIP_LIST_KINDS, RELATIONSHIP_LIST_MAX_LIMIT, REP_TYPES, RESERVED_USERNAMES, type RecentActivityEntry, type RelationshipListKind, type RelationshipListQuery, type RelationshipListResponse, type RelationshipMember, type RepType, type ReplaceMeasurableGoalsRequest, type ReplaceTrainingLocationsRequest, type Routine, type RoutineDay, type RoutineDayId, type RoutineExercise, type RoutineId, type RoutineSet, SESSION_SHARE_DEFAULT_FIELDS, SESSION_SHARE_FIELDS, SESSION_SHARE_MAX_ACTIVE_LINKS, SEXES, type SessionComparisonExercise, type SessionComparisonQuery, type SessionComparisonResponse, type SessionComparisonRoutineDay, type SessionComparisonSession, type SessionComparisonSet, type SessionRecapRecord, type SessionShare, type SessionShareField, type SessionShareListResponse, type SetAccountTimeZoneRequest, type SetLog, type Sex, type SharedSessionOwner, type SharedSessionRecap, type StartWorkoutRequest, type StartWorkoutResponse, type SupabaseAuthResponse, type SupabaseAuthUser, type SupabaseMigrationResponse, TRAINING_DISCIPLINE_VALUES, TRAINING_EVENT_TYPES, TRAINING_EXPERIENCE_LEVEL_VALUES, TRAINING_GOAL_VALUES, type TrainingDiscipline, type TrainingEventType, type TrainingExperienceLevel, type TrainingGoal, type TrainingIdentity, type TrainingLocationPreference, type TrainingLocationPreferenceInput, USERNAME_MAX_LENGTH, USERNAME_MIN_LENGTH, USERNAME_PATTERN_SOURCE, type UpdateProfileDiscoveryRequest, type UpdateProfilePrivacyRequest, type UpdateProfileRequest, type UpdateRoutineRequest, type UpsertSetLogRequest, type UpsertSetLogResponse, type UserId, type UserProfile, type UserSearchResponse, type VolumeTrendPoint, type VolumeTrendQuery, type VolumeTrendResponse, type VolumeTrendSeries, 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 };
+export { ACHIEVEMENT_CATEGORIES, ACHIEVEMENT_DEFINITIONS, type AchievementCategory, type AchievementDefinition, type AchievementUnlockedEventPayload, type AchievementsResponse, type Brand, type CreateRoutineDayInput, type CreateRoutineExerciseInput, type CreateRoutineRequest, type CreateSessionShareRequest, EXERCISE_EQUIPMENT, EXERCISE_MECHANICS, type EarnedAchievement, type EarnedPersonalRecord, type Exercise, type ExerciseEquipment, type ExerciseId, type ExerciseMechanic, type ExercisePerformanceHistoryQuery, type ExercisePerformanceHistoryResponse, type ExercisePerformancePrescription, type ExercisePerformancePrescriptionSet, type ExercisePerformanceSession, type ExercisePerformanceSet, type ExercisePerformanceSummary, type ExerciseStrengthSummary, type ExerciseStrengthTrendPoint, type ExerciseStrengthTrendQuery, type ExerciseStrengthTrendResponse, FOLLOW_SUGGESTIONS_DEFAULT_LIMIT, FOLLOW_SUGGESTIONS_MAX_LIMIT, FOLLOW_SUGGESTION_REASONS, type FinishStatus, type FinishWorkoutRequest, type FinishWorkoutResponse, type FollowSuggestion, type FollowSuggestionReason, type FollowSuggestionsResponse, type IsoDateString, type ListSessionsParams, MEASURABLE_GOALS_MAX, MEASURABLE_GOAL_DIRECTIONS, MEASURABLE_GOAL_TYPES, MOVEMENT_PATTERNS, MUSCLE_GROUPS, type MeasurableGoal, type MeasurableGoalDirection, type MeasurableGoalExercise, type MeasurableGoalInput, type MeasurableGoalType, type MovementPattern, type MuscleGroup, type MuscleGroupHeatmapQuery, type MuscleGroupHeatmapResponse, type MuscleGroupHeatmapValue, type MuscleGroupHeatmapWeek, type MuscleVolumeTrendSeries, PREFERRED_TRAINING_STYLE_VALUES, PROFILE_BIO_MAX_LENGTH, PROFILE_FAVORITE_EXERCISES_MAX, PROFILE_LOCATION_MAX_LENGTH, PROFILE_TRAINING_DISCIPLINES_MAX, PROFILE_TRAINING_GOALS_MAX, PROFILE_VISIBILITY_VALUES, PROGRESSION_SCHEMES, PROGRESS_TIMELINE_EVENT_TYPES, type PaginatedResponse, type PersonalGoalProgress, type PersonalGoalsResponse, type PersonalRecordEntry, type PersonalRecordKind, type PlatePairInventory, type PreferredTrainingStyle, type PreviousPerformanceResponse, type PreviousSessionRecap, type PreviousSetPerformance, type ProfileDiscoverySettings, type ProfileFavoriteExercise, type ProfilePrivacySettings, type ProfileViewerAccess, type ProfileVisibility, type ProgressTimelineEventType, type ProgressTimelineItem, type ProgressTimelinePersonalRecordItem, type ProgressTimelineProgressionItem, type ProgressTimelineQuery, type ProgressTimelineRecordPerformance, type ProgressTimelineRecordReason, type ProgressTimelineResponse, type ProgressTimelineSessionContext, type ProgressionChange, type ProgressionRule, type ProgressionScheme, type ProgressionSetChange, type PublicBodyMetrics, type PublicTrainingSummary, type PublicUserProfile, RELATIONSHIP_LIST_DEFAULT_LIMIT, RELATIONSHIP_LIST_KINDS, RELATIONSHIP_LIST_MAX_LIMIT, REP_TYPES, RESERVED_USERNAMES, type RecentActivityEntry, type RelationshipListKind, type RelationshipListQuery, type RelationshipListResponse, type RelationshipMember, type RepType, type ReplaceMeasurableGoalsRequest, type ReplaceTrainingLocationsRequest, type Routine, type RoutineDay, type RoutineDayId, type RoutineExercise, type RoutineId, type RoutineSet, SESSION_SHARE_DEFAULT_FIELDS, SESSION_SHARE_FIELDS, SESSION_SHARE_MAX_ACTIVE_LINKS, SEXES, type SessionComparisonExercise, type SessionComparisonQuery, type SessionComparisonResponse, type SessionComparisonRoutineDay, type SessionComparisonSession, type SessionComparisonSet, type SessionExerciseSubstitution, type SessionRecapRecord, type SessionShare, type SessionShareField, type SessionShareListResponse, type SetAccountTimeZoneRequest, type SetLog, type Sex, type SharedSessionOwner, type SharedSessionRecap, type StartWorkoutRequest, type StartWorkoutResponse, type StreakMilestoneEventPayload, type SubstituteSessionExerciseRequest, type SubstituteSessionExerciseResponse, type SupabaseAuthResponse, type SupabaseAuthUser, type SupabaseMigrationResponse, TRAINING_DISCIPLINE_VALUES, TRAINING_EVENT_TYPES, TRAINING_EXPERIENCE_LEVEL_VALUES, TRAINING_GOAL_VALUES, type TrainingDiscipline, type TrainingEventType, type TrainingExperienceLevel, type TrainingGoal, type TrainingIdentity, type TrainingLocationPreference, type TrainingLocationPreferenceInput, USERNAME_MAX_LENGTH, USERNAME_MIN_LENGTH, USERNAME_PATTERN_SOURCE, type UpdateProfileDiscoveryRequest, type UpdateProfilePrivacyRequest, type UpdateProfileRequest, type UpdateRoutineRequest, type UpsertSetLogRequest, type UpsertSetLogResponse, type UserId, type UserProfile, type UserSearchResponse, type VolumeTrendPoint, type VolumeTrendQuery, type VolumeTrendResponse, type VolumeTrendSeries, 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

@@ -50,6 +50,12 @@ interface WorkoutSession {
     notes?: string | null;
     lastActivityAt?: IsoDateString | null;
     setLogs?: SetLog[];
+    /**
+     * LIVE-11: slots performed with a different exercise in this session. The
+     * routine day (snapshot) keeps the original prescription; set logs for a
+     * substituted slot carry the substitute's `exerciseId`.
+     */
+    exerciseSubstitutions?: SessionExerciseSubstitution[];
     reused?: boolean;
     routine?: {
         id: string;
@@ -154,6 +160,38 @@ interface UpsertSetLogRequest {
     rpe?: number;
     isCompleted?: boolean;
 }
+/**
+ * LIVE-11: an exercise performed in place of one routine slot for a single
+ * session. The substitute's muscles are captured when the swap is made, so
+ * later catalog changes cannot rewrite what the session trained.
+ */
+interface SessionExerciseSubstitution {
+    /** The replaced slot, as in `routineDay.exercises[].id`. */
+    routineExerciseId: string;
+    exercise: {
+        id: string;
+        name: string;
+        primaryMuscles: MuscleGroup[];
+        secondaryMuscles: MuscleGroup[];
+    };
+    substitutedAt: IsoDateString;
+}
+/** Body of PUT /workouts/sessions/:id/exercises/:routineExerciseId/substitution. */
+interface SubstituteSessionExerciseRequest {
+    exerciseId: string;
+    /** Also use this exercise in the routine from the next session on. */
+    applyToRoutine?: boolean;
+}
+/**
+ * Stable successful response of the substitution PUT and DELETE. A swap is
+ * refused once the slot has a completed set; incomplete drafts for the slot
+ * are cleared because their values belonged to the other exercise.
+ */
+interface SubstituteSessionExerciseResponse {
+    session: WorkoutSession;
+    /** True only when `applyToRoutine` was asked for and the routine still has the slot. */
+    routineUpdated: boolean;
+}
 type PersonalRecordKind = 'WEIGHT' | 'REPS' | 'VOLUME' | 'ESTIMATED_1RM';
 /** A record frontier crossed by the set mutation that produced this response. */
 interface EarnedPersonalRecord {
@@ -288,7 +326,7 @@ interface WorkoutStatsResponse {
     activeDaysThisWeek: number;
 }
 
-declare const TRAINING_EVENT_TYPES: readonly ["SESSION_COMPLETED", "PERSONAL_RECORD", "PROGRESSION_CHANGED"];
+declare const TRAINING_EVENT_TYPES: readonly ["SESSION_COMPLETED", "PERSONAL_RECORD", "PROGRESSION_CHANGED", "STREAK_MILESTONE", "ACHIEVEMENT_UNLOCKED"];
 type TrainingEventType = (typeof TRAINING_EVENT_TYPES)[number];
 /** Stable successful response of GET /workouts/progress. */
 interface WorkoutProgressQuery {
@@ -883,6 +921,42 @@ interface PersonalGoalsResponse {
     goals: PersonalGoalProgress[];
 }
 
+declare const ACHIEVEMENT_CATEGORIES: readonly ["SESSIONS", "SETS", "VOLUME_KG", "RECORDS", "STREAK_DAYS"];
+type AchievementCategory = (typeof ACHIEVEMENT_CATEGORIES)[number];
+interface AchievementDefinition {
+    id: string;
+    category: AchievementCategory;
+    threshold: number;
+    title: string;
+    description: string;
+}
+/** Stable milestone catalog shared by the writer and every presentation. */
+declare const ACHIEVEMENT_DEFINITIONS: readonly AchievementDefinition[];
+interface AchievementUnlockedEventPayload extends AchievementDefinition {
+    schemaVersion: 1;
+    backfilled: boolean;
+}
+interface StreakMilestoneEventPayload {
+    schemaVersion: 1;
+    achievementId: string;
+    streakDays: number;
+    backfilled: boolean;
+}
+interface EarnedAchievement extends AchievementDefinition {
+    eventId: string;
+    unlockedAt: IsoDateString;
+    sourceSessionId: string | null;
+    /** True when existing verified history was recognized after ACH-01 shipped. */
+    backfilled: boolean;
+}
+/** Stable successful response of GET /achievements. */
+interface AchievementsResponse {
+    analyticsReady: boolean;
+    earnedCount: number;
+    availableCount: number;
+    achievements: EarnedAchievement[];
+}
+
 interface RoutineSet {
     setNumber: number;
     repType: RepType;
@@ -947,4 +1021,4 @@ interface CreateRoutineRequest {
 }
 type UpdateRoutineRequest = Partial<CreateRoutineRequest>;
 
-export { type Brand, type CreateRoutineDayInput, type CreateRoutineExerciseInput, type CreateRoutineRequest, type CreateSessionShareRequest, EXERCISE_EQUIPMENT, EXERCISE_MECHANICS, type EarnedPersonalRecord, type Exercise, type ExerciseEquipment, type ExerciseId, type ExerciseMechanic, type ExercisePerformanceHistoryQuery, type ExercisePerformanceHistoryResponse, type ExercisePerformancePrescription, type ExercisePerformancePrescriptionSet, type ExercisePerformanceSession, type ExercisePerformanceSet, type ExercisePerformanceSummary, type ExerciseStrengthSummary, type ExerciseStrengthTrendPoint, type ExerciseStrengthTrendQuery, type ExerciseStrengthTrendResponse, FOLLOW_SUGGESTIONS_DEFAULT_LIMIT, FOLLOW_SUGGESTIONS_MAX_LIMIT, FOLLOW_SUGGESTION_REASONS, type FinishStatus, type FinishWorkoutRequest, type FinishWorkoutResponse, type FollowSuggestion, type FollowSuggestionReason, type FollowSuggestionsResponse, type IsoDateString, type ListSessionsParams, MEASURABLE_GOALS_MAX, MEASURABLE_GOAL_DIRECTIONS, MEASURABLE_GOAL_TYPES, MOVEMENT_PATTERNS, MUSCLE_GROUPS, type MeasurableGoal, type MeasurableGoalDirection, type MeasurableGoalExercise, type MeasurableGoalInput, type MeasurableGoalType, type MovementPattern, type MuscleGroup, type MuscleGroupHeatmapQuery, type MuscleGroupHeatmapResponse, type MuscleGroupHeatmapValue, type MuscleGroupHeatmapWeek, type MuscleVolumeTrendSeries, PREFERRED_TRAINING_STYLE_VALUES, PROFILE_BIO_MAX_LENGTH, PROFILE_FAVORITE_EXERCISES_MAX, PROFILE_LOCATION_MAX_LENGTH, PROFILE_TRAINING_DISCIPLINES_MAX, PROFILE_TRAINING_GOALS_MAX, PROFILE_VISIBILITY_VALUES, PROGRESSION_SCHEMES, PROGRESS_TIMELINE_EVENT_TYPES, type PaginatedResponse, type PersonalGoalProgress, type PersonalGoalsResponse, type PersonalRecordEntry, type PersonalRecordKind, type PlatePairInventory, type PreferredTrainingStyle, type PreviousPerformanceResponse, type PreviousSessionRecap, type PreviousSetPerformance, type ProfileDiscoverySettings, type ProfileFavoriteExercise, type ProfilePrivacySettings, type ProfileViewerAccess, type ProfileVisibility, type ProgressTimelineEventType, type ProgressTimelineItem, type ProgressTimelinePersonalRecordItem, type ProgressTimelineProgressionItem, type ProgressTimelineQuery, type ProgressTimelineRecordPerformance, type ProgressTimelineRecordReason, type ProgressTimelineResponse, type ProgressTimelineSessionContext, type ProgressionChange, type ProgressionRule, type ProgressionScheme, type ProgressionSetChange, type PublicBodyMetrics, type PublicTrainingSummary, type PublicUserProfile, RELATIONSHIP_LIST_DEFAULT_LIMIT, RELATIONSHIP_LIST_KINDS, RELATIONSHIP_LIST_MAX_LIMIT, REP_TYPES, RESERVED_USERNAMES, type RecentActivityEntry, type RelationshipListKind, type RelationshipListQuery, type RelationshipListResponse, type RelationshipMember, type RepType, type ReplaceMeasurableGoalsRequest, type ReplaceTrainingLocationsRequest, type Routine, type RoutineDay, type RoutineDayId, type RoutineExercise, type RoutineId, type RoutineSet, SESSION_SHARE_DEFAULT_FIELDS, SESSION_SHARE_FIELDS, SESSION_SHARE_MAX_ACTIVE_LINKS, SEXES, type SessionComparisonExercise, type SessionComparisonQuery, type SessionComparisonResponse, type SessionComparisonRoutineDay, type SessionComparisonSession, type SessionComparisonSet, type SessionRecapRecord, type SessionShare, type SessionShareField, type SessionShareListResponse, type SetAccountTimeZoneRequest, type SetLog, type Sex, type SharedSessionOwner, type SharedSessionRecap, type StartWorkoutRequest, type StartWorkoutResponse, type SupabaseAuthResponse, type SupabaseAuthUser, type SupabaseMigrationResponse, TRAINING_DISCIPLINE_VALUES, TRAINING_EVENT_TYPES, TRAINING_EXPERIENCE_LEVEL_VALUES, TRAINING_GOAL_VALUES, type TrainingDiscipline, type TrainingEventType, type TrainingExperienceLevel, type TrainingGoal, type TrainingIdentity, type TrainingLocationPreference, type TrainingLocationPreferenceInput, USERNAME_MAX_LENGTH, USERNAME_MIN_LENGTH, USERNAME_PATTERN_SOURCE, type UpdateProfileDiscoveryRequest, type UpdateProfilePrivacyRequest, type UpdateProfileRequest, type UpdateRoutineRequest, type UpsertSetLogRequest, type UpsertSetLogResponse, type UserId, type UserProfile, type UserSearchResponse, type VolumeTrendPoint, type VolumeTrendQuery, type VolumeTrendResponse, type VolumeTrendSeries, 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 };
+export { ACHIEVEMENT_CATEGORIES, ACHIEVEMENT_DEFINITIONS, type AchievementCategory, type AchievementDefinition, type AchievementUnlockedEventPayload, type AchievementsResponse, type Brand, type CreateRoutineDayInput, type CreateRoutineExerciseInput, type CreateRoutineRequest, type CreateSessionShareRequest, EXERCISE_EQUIPMENT, EXERCISE_MECHANICS, type EarnedAchievement, type EarnedPersonalRecord, type Exercise, type ExerciseEquipment, type ExerciseId, type ExerciseMechanic, type ExercisePerformanceHistoryQuery, type ExercisePerformanceHistoryResponse, type ExercisePerformancePrescription, type ExercisePerformancePrescriptionSet, type ExercisePerformanceSession, type ExercisePerformanceSet, type ExercisePerformanceSummary, type ExerciseStrengthSummary, type ExerciseStrengthTrendPoint, type ExerciseStrengthTrendQuery, type ExerciseStrengthTrendResponse, FOLLOW_SUGGESTIONS_DEFAULT_LIMIT, FOLLOW_SUGGESTIONS_MAX_LIMIT, FOLLOW_SUGGESTION_REASONS, type FinishStatus, type FinishWorkoutRequest, type FinishWorkoutResponse, type FollowSuggestion, type FollowSuggestionReason, type FollowSuggestionsResponse, type IsoDateString, type ListSessionsParams, MEASURABLE_GOALS_MAX, MEASURABLE_GOAL_DIRECTIONS, MEASURABLE_GOAL_TYPES, MOVEMENT_PATTERNS, MUSCLE_GROUPS, type MeasurableGoal, type MeasurableGoalDirection, type MeasurableGoalExercise, type MeasurableGoalInput, type MeasurableGoalType, type MovementPattern, type MuscleGroup, type MuscleGroupHeatmapQuery, type MuscleGroupHeatmapResponse, type MuscleGroupHeatmapValue, type MuscleGroupHeatmapWeek, type MuscleVolumeTrendSeries, PREFERRED_TRAINING_STYLE_VALUES, PROFILE_BIO_MAX_LENGTH, PROFILE_FAVORITE_EXERCISES_MAX, PROFILE_LOCATION_MAX_LENGTH, PROFILE_TRAINING_DISCIPLINES_MAX, PROFILE_TRAINING_GOALS_MAX, PROFILE_VISIBILITY_VALUES, PROGRESSION_SCHEMES, PROGRESS_TIMELINE_EVENT_TYPES, type PaginatedResponse, type PersonalGoalProgress, type PersonalGoalsResponse, type PersonalRecordEntry, type PersonalRecordKind, type PlatePairInventory, type PreferredTrainingStyle, type PreviousPerformanceResponse, type PreviousSessionRecap, type PreviousSetPerformance, type ProfileDiscoverySettings, type ProfileFavoriteExercise, type ProfilePrivacySettings, type ProfileViewerAccess, type ProfileVisibility, type ProgressTimelineEventType, type ProgressTimelineItem, type ProgressTimelinePersonalRecordItem, type ProgressTimelineProgressionItem, type ProgressTimelineQuery, type ProgressTimelineRecordPerformance, type ProgressTimelineRecordReason, type ProgressTimelineResponse, type ProgressTimelineSessionContext, type ProgressionChange, type ProgressionRule, type ProgressionScheme, type ProgressionSetChange, type PublicBodyMetrics, type PublicTrainingSummary, type PublicUserProfile, RELATIONSHIP_LIST_DEFAULT_LIMIT, RELATIONSHIP_LIST_KINDS, RELATIONSHIP_LIST_MAX_LIMIT, REP_TYPES, RESERVED_USERNAMES, type RecentActivityEntry, type RelationshipListKind, type RelationshipListQuery, type RelationshipListResponse, type RelationshipMember, type RepType, type ReplaceMeasurableGoalsRequest, type ReplaceTrainingLocationsRequest, type Routine, type RoutineDay, type RoutineDayId, type RoutineExercise, type RoutineId, type RoutineSet, SESSION_SHARE_DEFAULT_FIELDS, SESSION_SHARE_FIELDS, SESSION_SHARE_MAX_ACTIVE_LINKS, SEXES, type SessionComparisonExercise, type SessionComparisonQuery, type SessionComparisonResponse, type SessionComparisonRoutineDay, type SessionComparisonSession, type SessionComparisonSet, type SessionExerciseSubstitution, type SessionRecapRecord, type SessionShare, type SessionShareField, type SessionShareListResponse, type SetAccountTimeZoneRequest, type SetLog, type Sex, type SharedSessionOwner, type SharedSessionRecap, type StartWorkoutRequest, type StartWorkoutResponse, type StreakMilestoneEventPayload, type SubstituteSessionExerciseRequest, type SubstituteSessionExerciseResponse, type SupabaseAuthResponse, type SupabaseAuthUser, type SupabaseMigrationResponse, TRAINING_DISCIPLINE_VALUES, TRAINING_EVENT_TYPES, TRAINING_EXPERIENCE_LEVEL_VALUES, TRAINING_GOAL_VALUES, type TrainingDiscipline, type TrainingEventType, type TrainingExperienceLevel, type TrainingGoal, type TrainingIdentity, type TrainingLocationPreference, type TrainingLocationPreferenceInput, USERNAME_MAX_LENGTH, USERNAME_MIN_LENGTH, USERNAME_PATTERN_SOURCE, type UpdateProfileDiscoveryRequest, type UpdateProfilePrivacyRequest, type UpdateProfileRequest, type UpdateRoutineRequest, type UpsertSetLogRequest, type UpsertSetLogResponse, type UserId, type UserProfile, type UserSearchResponse, type VolumeTrendPoint, type VolumeTrendQuery, type VolumeTrendResponse, type VolumeTrendSeries, 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

@@ -175,6 +175,62 @@ var MEASURABLE_GOAL_TYPES = [
 var MEASURABLE_GOAL_DIRECTIONS = ["AT_LEAST", "AT_MOST"];
 var MEASURABLE_GOALS_MAX = 8;
 
+// src/achievements.ts
+var ACHIEVEMENT_CATEGORIES = [
+  "SESSIONS",
+  "SETS",
+  "VOLUME_KG",
+  "RECORDS",
+  "STREAK_DAYS"
+];
+var formatCount = (value) => value.toLocaleString("en-US");
+function titleFor(category, threshold) {
+  const count = formatCount(threshold);
+  switch (category) {
+    case "SESSIONS":
+      return threshold === 1 ? "First Session" : `${count} Sessions`;
+    case "SETS":
+      return `${count} Sets Completed`;
+    case "VOLUME_KG":
+      return `${count} kg Moved`;
+    case "RECORDS":
+      return threshold === 1 ? "First Record" : `${count} Records`;
+    case "STREAK_DAYS":
+      return `${count}-Day Streak`;
+  }
+}
+function descriptionFor(category, threshold) {
+  const count = formatCount(threshold);
+  switch (category) {
+    case "SESSIONS":
+      return `Complete ${count} ${threshold === 1 ? "training session" : "training sessions"}.`;
+    case "SETS":
+      return `Complete ${count} logged sets.`;
+    case "VOLUME_KG":
+      return `Accumulate ${count} kg of external-load volume.`;
+    case "RECORDS":
+      return `Establish records for ${count} ${threshold === 1 ? "exercise" : "exercises"}.`;
+    case "STREAK_DAYS":
+      return `Build a ${count}-day training streak.`;
+  }
+}
+var THRESHOLDS = {
+  SESSIONS: [1, 10, 25, 50, 100],
+  SETS: [10, 100, 250, 500, 1e3],
+  VOLUME_KG: [1e3, 1e4, 5e4, 1e5, 25e4],
+  RECORDS: [1, 5, 10, 25, 50],
+  STREAK_DAYS: [2, 3, 5, 10, 20]
+};
+var ACHIEVEMENT_DEFINITIONS = ACHIEVEMENT_CATEGORIES.flatMap(
+  (category) => THRESHOLDS[category].map((threshold) => ({
+    id: `${category.toLowerCase()}:${threshold}`,
+    category,
+    threshold,
+    title: titleFor(category, threshold),
+    description: descriptionFor(category, threshold)
+  }))
+);
+
 // src/workout.ts
 var SESSION_SHARE_FIELDS = [
   "duration",
@@ -196,13 +252,17 @@ var SESSION_SHARE_MAX_ACTIVE_LINKS = 10;
 var TRAINING_EVENT_TYPES = [
   "SESSION_COMPLETED",
   "PERSONAL_RECORD",
-  "PROGRESSION_CHANGED"
+  "PROGRESSION_CHANGED",
+  "STREAK_MILESTONE",
+  "ACHIEVEMENT_UNLOCKED"
 ];
 var PROGRESS_TIMELINE_EVENT_TYPES = [
   "PERSONAL_RECORD",
   "PROGRESSION_CHANGED"
 ];
 export {
+  ACHIEVEMENT_CATEGORIES,
+  ACHIEVEMENT_DEFINITIONS,
   EXERCISE_EQUIPMENT,
   EXERCISE_MECHANICS,
   FOLLOW_SUGGESTIONS_DEFAULT_LIMIT,

package/package.json

@@ -1,40 +1,40 @@
-{
-  "name": "@sunsteel/contracts",
-  "version": "0.27.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.29.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"
+  }
+}