@openlifelog/sdk 1.0.0

package/types/goal.ts

@@ -0,0 +1,169 @@
+import type {
+  DateTime,
+  UUID,
+  GoalTargetType,
+  NutritionGoalType,
+  DateString,
+  ListParams,
+  DateRangeParams,
+} from './common';
+
+/**
+ * Goals and targets types
+ */
+
+/**
+ * User goal (for metrics)
+ */
+export interface UserGoal {
+  id: UUID;
+  userId: UUID;
+  metricId: UUID;
+  targetValue: number;
+  targetType: GoalTargetType;
+  effectiveFrom: DateString;
+  effectiveUntil?: DateString;
+  createdAt: DateTime;
+  metricKey?: string;
+  metricName?: string;
+  unit?: string;
+}
+
+/**
+ * Create user goal request
+ */
+export interface CreateUserGoalRequest {
+  metricKey: string;
+  targetValue: number;
+  targetType: GoalTargetType;
+  effectiveFrom?: DateString;
+  effectiveUntil?: DateString;
+}
+
+/**
+ * Update user goal request
+ */
+export interface UpdateUserGoalRequest {
+  targetValue?: number;
+  targetType?: GoalTargetType;
+  effectiveFrom?: DateString;
+  effectiveUntil?: DateString;
+}
+
+/**
+ * Goal progress status
+ */
+export type GoalProgressStatus = 'on_track' | 'below' | 'above' | 'no_data';
+
+/**
+ * Goal progress entry
+ */
+export interface GoalProgress {
+  id: UUID;
+  metricName: string;
+  targetValue: number;
+  targetType: GoalTargetType;
+  currentValue?: number;
+  status: GoalProgressStatus;
+  percentage?: number;
+}
+
+/**
+ * Daily goal progress
+ */
+export interface DailyGoalProgress {
+  date: DateString;
+  goals: GoalProgress[];
+}
+
+/**
+ * Nutrition goal definition
+ */
+export interface NutritionGoal {
+  type: NutritionGoalType;
+  value?: number;
+  min?: number;
+  max?: number;
+}
+
+/**
+ * User nutrition goals
+ */
+export interface UserNutritionGoals {
+  id: UUID;
+  userId: UUID;
+  effectiveDate: DateString;
+  goals: Record<string, NutritionGoal>;
+  caloriesTarget?: number;
+  proteinTarget?: number;
+  carbohydratesTarget?: number;
+  fatTarget?: number;
+  notes?: string;
+  createdAt: DateTime;
+}
+
+/**
+ * Create nutrition goals request
+ */
+export interface CreateNutritionGoalsRequest {
+  effectiveDate: DateString;
+  goals: Record<string, NutritionGoal>;
+  notes?: string;
+}
+
+/**
+ * Update nutrition goals request
+ */
+export type UpdateNutritionGoalsRequest = Partial<CreateNutritionGoalsRequest>;
+
+/**
+ * Bulk create nutrition goals request
+ */
+export interface BulkCreateNutritionGoalsRequest {
+  goals: Array<{
+    effectiveDate: DateString;
+    goals: Record<string, NutritionGoal>;
+    notes?: string;
+  }>;
+}
+
+/**
+ * Copy nutrition goals request
+ */
+export interface CopyNutritionGoalsRequest {
+  fromDate: DateString;
+  toDate: DateString;
+}
+
+/**
+ * Nutrition progress entry
+ */
+export interface NutritionProgress {
+  nutrientKey: string;
+  goal: NutritionGoal;
+  current: number;
+  target?: number;
+  percentage: number;
+  status: GoalProgressStatus;
+  remaining?: number;
+}
+
+/**
+ * Daily nutrition progress
+ */
+export interface DailyNutritionProgress {
+  date: DateString;
+  effectiveGoalDate: DateString;
+  progress: NutritionProgress[];
+  summary: {
+    onTrack: number;
+    below: number;
+    over: number;
+    noData: number;
+  };
+}
+
+/**
+ * List nutrition goals history parameters
+ */
+export interface ListNutritionGoalsHistoryParams extends ListParams, DateRangeParams {}

package/types/index.ts

@@ -0,0 +1,17 @@
+/**
+ * Export all types
+ */
+
+// Common types
+export * from './common';
+
+// Domain types
+export * from './user';
+export * from './food';
+export * from './exercise';
+export * from './workout';
+export * from './session';
+export * from './program';
+export * from './metric';
+export * from './goal';
+export * from './ai';

package/types/metric.ts

@@ -0,0 +1,108 @@
+import type { DateTime, UUID, ListParams, DateRangeParams, DateString } from './common';
+
+/**
+ * Metrics and tracking types
+ */
+
+/**
+ * Metric aggregation type
+ */
+export type MetricAggregationType = 'sum' | 'average' | 'min' | 'max' | 'latest';
+
+/**
+ * Metric category
+ */
+export type MetricCategory =
+  | 'body_composition'
+  | 'cardiovascular'
+  | 'strength'
+  | 'flexibility'
+  | 'sleep'
+  | 'stress'
+  | 'nutrition'
+  | 'hydration'
+  | 'custom';
+
+/**
+ * Metric definition
+ */
+export interface Metric {
+  id: UUID;
+  key: string;
+  name: string;
+  description?: string;
+  category: MetricCategory | string;
+  unit: string;
+  aggregationType: MetricAggregationType;
+  createdAt: DateTime;
+}
+
+/**
+ * Metric event (tracked data point)
+ */
+export interface MetricEvent {
+  id: UUID;
+  userId: UUID;
+  metricId: UUID;
+  metricKey: string;
+  value: number;
+  metadata?: Record<string, any>;
+  loggedAt: DateTime;
+  source?: string;
+  referenceId?: UUID;
+  createdAt: DateTime;
+}
+
+/**
+ * Create metric event request
+ */
+export interface CreateMetricEventRequest {
+  metricKey: string;
+  value: number;
+  metadata?: Record<string, any>;
+  loggedAt?: DateTime;
+  source?: string;
+}
+
+/**
+ * Update metric event request
+ */
+export interface UpdateMetricEventRequest {
+  value?: number;
+  metadata?: Record<string, any>;
+  loggedAt?: DateTime;
+}
+
+/**
+ * Bulk create metric events request
+ */
+export interface BulkCreateMetricEventsRequest {
+  metrics: CreateMetricEventRequest[];
+}
+
+/**
+ * List metric events parameters
+ */
+export interface ListMetricEventsParams extends ListParams, DateRangeParams {
+  metricId?: UUID;
+  metricKey?: string;
+}
+
+/**
+ * Daily metric aggregate
+ */
+export interface DailyMetricAggregate {
+  date: DateString;
+  metricKey: string;
+  value: number;
+  count: number;
+  min?: number;
+  max?: number;
+}
+
+/**
+ * Get daily metric parameters
+ */
+export interface GetDailyMetricParams {
+  date?: DateString;
+}

package/types/program.ts

@@ -0,0 +1,120 @@
+import type { DateTime, UUID, DateString } from './common';
+import type { SetData } from './workout';
+
+/**
+ * Training program types
+ */
+
+/**
+ * Program schedule exercise
+ */
+export interface ProgramScheduleExercise {
+  exerciseId: UUID;
+  orderIndex: number;
+  sets: SetData[];
+}
+
+/**
+ * Program schedule day
+ */
+export interface ProgramScheduleDay {
+  week: number;
+  day: number;
+  name: string;
+  exercises: ProgramScheduleExercise[];
+}
+
+/**
+ * Program metadata
+ */
+export interface ProgramMetadata {
+  difficulty?: string;
+  type?: string;
+  equipment?: string[];
+  duration?: string;
+  [key: string]: any;
+}
+
+/**
+ * Training program
+ */
+export interface Program {
+  id: UUID;
+  name: string;
+  description?: string;
+  createdBy: UUID;
+  isTemplate: boolean;
+  schedule: ProgramScheduleDay[];
+  metadata?: ProgramMetadata;
+  createdAt: DateTime;
+  updatedAt: DateTime;
+}
+
+/**
+ * Create program request
+ */
+export interface CreateProgramRequest {
+  name: string;
+  description?: string;
+  schedule: ProgramScheduleDay[];
+  metadata?: ProgramMetadata;
+}
+
+/**
+ * Update program request
+ */
+export type UpdateProgramRequest = Partial<CreateProgramRequest>;
+
+/**
+ * Enroll in program request
+ */
+export interface EnrollInProgramRequest {
+  startDate: DateString;
+}
+
+/**
+ * Program enrollment
+ */
+export interface ProgramEnrollment {
+  id: UUID;
+  userId: UUID;
+  programId: UUID;
+  startDate: DateString;
+  currentWeek: number;
+  currentDay: number;
+  status: 'active' | 'paused' | 'completed';
+  completedAt?: DateTime;
+  createdAt: DateTime;
+  updatedAt: DateTime;
+}
+
+/**
+ * Update enrollment request
+ */
+export interface UpdateEnrollmentRequest {
+  status?: 'active' | 'paused' | 'completed';
+  currentWeek?: number;
+  currentDay?: number;
+}
+
+/**
+ * Program enrollment progress
+ */
+export interface EnrollmentProgress {
+  enrollmentId: UUID;
+  totalWeeks: number;
+  totalDays: number;
+  completedDays: number;
+  currentWeek: number;
+  currentDay: number;
+  completionPercentage: number;
+}
+
+/**
+ * Current week schedule
+ */
+export interface CurrentWeekSchedule {
+  enrollmentId: UUID;
+  week: number;
+  days: ProgramScheduleDay[];
+}

package/types/session.ts

@@ -0,0 +1,196 @@
+import type {
+  DateTime,
+  UUID,
+  ListParams,
+  DateRangeParams,
+  SessionStatus,
+  RecordType,
+  DateString,
+} from './common';
+import type { SetData } from './workout';
+
+/**
+ * Workout session types (performance tracking)
+ */
+
+/**
+ * Session exercise detail (actual performance in a session)
+ */
+export interface SessionExerciseDetail {
+  id: UUID;
+  sessionId: UUID;
+  exerciseId: UUID;
+  workoutExerciseId?: UUID;
+  orderPerformed: number;
+  startedAt?: DateTime;
+  completedAt?: DateTime;
+  workoutFormat: string;
+  setsData: SetData[];
+  totalSets: number;
+  completedSets: number;
+  totalVolume?: number;
+  totalDistance?: number;
+  totalDuration?: number;
+  skipped: boolean;
+  notes?: string;
+  formRating?: number; // 1-5
+  rpe?: number; // 1-10
+  exerciseName: string;
+  exerciseDescription?: string;
+}
+
+/**
+ * Workout session
+ */
+export interface WorkoutSession {
+  id: UUID;
+  userId: UUID;
+  workoutId?: UUID;
+  name?: string;
+  programEnrollmentId?: UUID;
+  scheduledFor?: DateTime;
+  startedAt?: DateTime;
+  completedAt?: DateTime;
+  pausedDuration?: string;
+  status: SessionStatus;
+  userBodyweight?: number;
+  totalVolume?: number;
+  totalDistance?: number;
+  totalDuration?: number;
+  totalSetsCompleted: number;
+  totalExercisesCompleted: number;
+  notes?: string;
+  mood?: string;
+  location?: string;
+  createdAt: DateTime;
+  updatedAt: DateTime;
+  exercises?: SessionExerciseDetail[];
+}
+
+/**
+ * Create workout session request
+ */
+export interface CreateWorkoutSessionRequest {
+  workoutId?: UUID;
+  name?: string;
+  status?: SessionStatus;
+  userBodyweight?: number;
+  scheduledFor?: DateTime;
+  notes?: string;
+  mood?: string;
+  location?: string;
+}
+
+/**
+ * Add exercise to session (used in unified update)
+ */
+export interface AddExerciseItem {
+  exerciseId: UUID;
+  targetSets: number;
+  notes?: string;
+}
+
+/**
+ * Update exercise in session (used in unified update)
+ */
+export interface UpdateExerciseItem {
+  id: UUID;
+  targetSets?: number;
+  notes?: string;
+  startedAt?: DateTime;
+  completedAt?: DateTime;
+  skipped?: boolean;
+  skipReason?: string;
+}
+
+/**
+ * Update workout session request (Unified Update)
+ * Supports session-level updates, exercise operations, and set operations
+ */
+export interface UpdateWorkoutSessionRequest {
+  // Session-level updates
+  name?: string;
+  status?: SessionStatus;
+  startedAt?: DateTime;
+  completedAt?: DateTime;
+  notes?: string;
+  mood?: string;
+  location?: string;
+  completionPercentage?: number;
+  pausedDuration?: string;
+  userBodyweight?: number;
+
+  // Exercise operations
+  addExercises?: AddExerciseItem[];
+  updateExercises?: UpdateExerciseItem[];
+  removeExercises?: UUID[];
+  reorderExercises?: Record<UUID, number>;
+
+  // Sets operations (by exercise ID)
+  updateSets?: Record<UUID, any[]>;
+}
+
+/**
+ * List workout sessions parameters
+ */
+export interface ListWorkoutSessionsParams extends ListParams, DateRangeParams {
+  status?: SessionStatus;
+  workoutId?: UUID;
+  includeExercises?: boolean;
+}
+
+/**
+ * Exercise performance history entry
+ */
+export interface ExerciseHistoryEntry {
+  date: DateString;
+  sessionId: UUID;
+  totalVolume?: number;
+  totalSets: number;
+  completedSets: number;
+  rpe?: number;
+  formRating?: number;
+  notes?: string;
+}
+
+/**
+ * Exercise performance history
+ */
+export interface ExerciseHistory {
+  exerciseId: UUID;
+  exerciseName: string;
+  history: ExerciseHistoryEntry[];
+}
+
+/**
+ * Personal record
+ */
+export interface PersonalRecord {
+  exerciseId: UUID;
+  exerciseName: string;
+  recordType: RecordType;
+  value: number;
+  unit: string;
+  achievedDate: DateString;
+  sessionId: UUID;
+}
+
+/**
+ * Personal record history entry
+ */
+export interface PersonalRecordHistoryEntry {
+  value: number;
+  date: DateString;
+  sessionId: UUID;
+}
+
+/**
+ * Personal record history
+ */
+export interface PersonalRecordHistory {
+  exerciseId: UUID;
+  exerciseName: string;
+  recordType: RecordType;
+  unit: string;
+  history: PersonalRecordHistoryEntry[];
+}

package/types/user.ts

@@ -0,0 +1,79 @@
+import type { DateTime, UUID, MeasurementSystem } from './common';
+
+/**
+ * User types
+ */
+
+/**
+ * User account information
+ */
+export interface User {
+  id: UUID;
+  name: string;
+  email: string;
+  emailVerified: boolean;
+  isActive: boolean;
+  isOnboarded: boolean;
+  timezone: string; // IANA timezone (e.g., "America/Denver")
+  locale: string; // e.g., "en-US"
+  dateFormat: string; // e.g., "ISO8601"
+  createdAt: DateTime;
+  updatedAt: DateTime;
+}
+
+/**
+ * User preferences
+ */
+export interface UserPreferences {
+  userId: UUID;
+  measurementSystem: MeasurementSystem;
+  createdAt: DateTime;
+  updatedAt: DateTime;
+}
+
+/**
+ * Authentication request/response types
+ */
+
+export interface SignupRequest {
+  name: string;
+  email: string;
+  password: string;
+}
+
+export interface LoginRequest {
+  email: string;
+  password: string;
+}
+
+export interface AuthResponse {
+  token: string;
+  user: User;
+}
+
+export interface PasswordResetRequest {
+  email: string;
+}
+
+export interface PasswordResetConfirm {
+  token: string;
+  newPassword: string;
+}
+
+/**
+ * Update user profile request
+ */
+export interface UpdateUserRequest {
+  name?: string;
+  isOnboarded?: boolean;
+  timezone?: string;
+  locale?: string;
+  dateFormat?: string;
+}
+
+/**
+ * Update user preferences request
+ */
+export interface UpdatePreferencesRequest {
+  measurementSystem?: MeasurementSystem;
+}