@openlifelog/sdk 1.0.0

package/resources/workouts.ts

@@ -0,0 +1,147 @@
+import type { HttpClient } from '../utils/http';
+import type {
+  Workout,
+  CreateWorkoutRequest,
+  UpdateWorkoutRequest,
+  AddExercisesToWorkoutRequest,
+  UpdateWorkoutExerciseRequest,
+  ListWorkoutsParams,
+  ListResponse,
+  CountResponse,
+} from '../types';
+import { createPaginatedIterator, type PaginatedIterator } from '../utils/pagination';
+
+/**
+ * Workouts resource
+ * Handles workout template operations
+ */
+export class WorkoutsResource {
+  constructor(private http: HttpClient) {}
+
+  /**
+   * List workout templates
+   */
+  async list(params?: ListWorkoutsParams): Promise<ListResponse<Workout>> {
+    const response = await this.http.get<ListResponse<Workout>>('/v1/workouts', params);
+    return response.data;
+  }
+
+  /**
+   * List workouts with automatic pagination
+   */
+  listAutoPaginate(params?: ListWorkoutsParams): PaginatedIterator<Workout> {
+    return createPaginatedIterator((cursor) =>
+      this.list({ ...params, cursor })
+    );
+  }
+
+  /**
+   * Get total count of workouts
+   */
+  async count(): Promise<CountResponse> {
+    const response = await this.http.get<CountResponse>('/v1/workouts/count');
+    return response.data;
+  }
+
+  /**
+   * Search workouts by name
+   */
+  async search(params: { q: string; limit?: number; cursor?: string }): Promise<ListResponse<Workout>> {
+    const response = await this.http.get<ListResponse<Workout>>('/v1/workouts/search', params);
+    return response.data;
+  }
+
+  /**
+   * Get specific workout with all exercises
+   */
+  async get(workoutId: string): Promise<Workout> {
+    const response = await this.http.get<Workout>(`/v1/workouts/${workoutId}`);
+    return response.data;
+  }
+
+  /**
+   * Create a new workout template
+   */
+  async create(request: CreateWorkoutRequest): Promise<Workout> {
+    const response = await this.http.post<Workout>('/v1/workouts', request);
+    return response.data;
+  }
+
+  /**
+   * Update a workout template
+   */
+  async update(workoutId: string, request: UpdateWorkoutRequest): Promise<Workout> {
+    const response = await this.http.put<Workout>(`/v1/workouts/${workoutId}`, request);
+    return response.data;
+  }
+
+  /**
+   * Clone an existing workout
+   */
+  async clone(workoutId: string): Promise<Workout> {
+    const response = await this.http.post<Workout>(`/v1/workouts/${workoutId}/clone`);
+    return response.data;
+  }
+
+  /**
+   * Delete a workout template
+   */
+  async delete(workoutId: string): Promise<void> {
+    await this.http.delete(`/v1/workouts/${workoutId}`);
+  }
+
+  /**
+   * Add exercises to workout
+   */
+  async addExercises(workoutId: string, request: AddExercisesToWorkoutRequest): Promise<void> {
+    await this.http.post(`/v1/workouts/${workoutId}/exercises`, request);
+  }
+
+  /**
+   * Update exercise in workout
+   */
+  async updateExercise(
+    workoutId: string,
+    exerciseId: string,
+    request: UpdateWorkoutExerciseRequest
+  ): Promise<void> {
+    await this.http.put(`/v1/workouts/${workoutId}/exercises/${exerciseId}`, request);
+  }
+
+  /**
+   * Remove exercise from workout
+   */
+  async removeExercise(workoutId: string, exerciseId: string): Promise<void> {
+    await this.http.delete(`/v1/workouts/${workoutId}/exercises/${exerciseId}`);
+  }
+
+  /**
+   * Get all workouts containing a specific exercise
+   */
+  async getWorkoutsByExercise(exerciseId: string): Promise<ListResponse<Workout>> {
+    const response = await this.http.get<ListResponse<Workout>>(`/v1/exercises/${exerciseId}/workouts`);
+    return response.data;
+  }
+
+  /**
+   * Get favorite workouts
+   */
+  async getFavorites(params?: ListWorkoutsParams): Promise<ListResponse<Workout>> {
+    const response = await this.http.get<ListResponse<Workout>>('/v1/workouts/favorites', params);
+    return response.data;
+  }
+
+  /**
+   * Add workout to favorites
+   */
+  async addToFavorites(workoutId: string): Promise<void> {
+    await this.http.post(`/v1/workouts/${workoutId}/favorite`);
+  }
+
+  /**
+   * Remove workout from favorites
+   */
+  async removeFromFavorites(workoutId: string): Promise<void> {
+    await this.http.delete(`/v1/workouts/${workoutId}/favorite`);
+  }
+}

package/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "lib": ["ES2020"],
+    "moduleResolution": "node",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "outDir": "./dist",
+    "rootDir": ".",
+    "resolveJsonModule": true,
+    "allowSyntheticDefaultImports": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "removeComments": true,
+    "preserveConstEnums": true
+  },
+  "include": ["./**/*"],
+  "exclude": ["node_modules", "dist", "**/*.test.ts", "**/*.spec.ts"]
+}

package/types/ai.ts

@@ -0,0 +1,55 @@
+import type { DateRangeParams } from './common';
+
+/**
+ * AI features types
+ */
+
+/**
+ * Insight type
+ */
+export type InsightType =
+  | 'nutrition_pattern'
+  | 'workout_pattern'
+  | 'performance_trend'
+  | 'goal_progress'
+  | 'recommendation';
+
+/**
+ * Insight severity
+ */
+export type InsightSeverity = 'info' | 'warning' | 'success' | 'error';
+
+/**
+ * AI insight
+ */
+export interface Insight {
+  type: InsightType;
+  message: string;
+  severity: InsightSeverity;
+  metric?: string;
+  period?: string;
+  data?: Record<string, any>;
+}
+
+/**
+ * AI recommendation
+ */
+export interface Recommendation {
+  category: string;
+  suggestion: string;
+  rationale?: string;
+  priority?: 'low' | 'medium' | 'high';
+}
+
+/**
+ * Food insights response
+ */
+export interface FoodInsightsResponse {
+  insights: Insight[];
+  recommendations: Recommendation[];
+}
+
+/**
+ * Get food insights parameters
+ */
+export interface GetFoodInsightsParams extends DateRangeParams {}

package/types/common.ts

@@ -0,0 +1,177 @@
+/**
+ * Common types used across the SDK
+ */
+
+/**
+ * Measurement system preference
+ */
+export type MeasurementSystem = 'metric' | 'imperial';
+
+/**
+ * ISO 8601 date-time string
+ */
+export type DateTime = string;
+
+/**
+ * Date in YYYY-MM-DD format
+ */
+export type DateString = string;
+
+/**
+ * UUID string
+ */
+export type UUID = string;
+
+/**
+ * Pagination information returned by list endpoints
+ */
+export interface PageInfo {
+  nextCursor?: string;
+  hasMore: boolean;
+}
+
+/**
+ * Standard list response with pagination
+ */
+export interface ListResponse<T> {
+  data: T[];
+  pageInfo: PageInfo;
+}
+
+/**
+ * Common query parameters for list endpoints
+ */
+export interface ListParams {
+  limit?: number;
+  cursor?: string;
+}
+
+/**
+ * Date range filter parameters
+ */
+export interface DateRangeParams {
+  startDate?: DateString;
+  endDate?: DateString;
+}
+
+/**
+ * Search parameters
+ */
+export interface SearchParams extends ListParams {
+  search?: string;
+  q?: string;
+}
+
+/**
+ * Count response
+ */
+export interface CountResponse {
+  count: number;
+}
+
+/**
+ * Success response wrapper
+ */
+export interface SuccessResponse<T = any> {
+  success: boolean;
+  data?: T;
+  message?: string;
+}
+
+/**
+ * Error response from API
+ */
+export interface ErrorResponse {
+  error: string;
+  message?: string;
+  code?: number;
+}
+
+/**
+ * Meal type options for food logging
+ */
+export type MealType = 'breakfast' | 'lunch' | 'dinner' | 'snack';
+
+/**
+ * Workout session status
+ */
+export type SessionStatus = 'planned' | 'in_progress' | 'completed' | 'abandoned' | 'paused';
+
+/**
+ * Goal target type
+ */
+export type GoalTargetType = 'exact' | 'min' | 'max';
+
+/**
+ * Nutrition goal type
+ */
+export type NutritionGoalType = 'exact' | 'range' | 'min' | 'max';
+
+/**
+ * Exercise category
+ */
+export type ExerciseCategory = 'strength' | 'cardio' | 'flexibility' | 'sport' | 'other';
+
+/**
+ * Movement pattern
+ */
+export type MovementPattern = 'compound' | 'isolation' | 'unilateral' | 'bilateral';
+
+/**
+ * Force direction
+ */
+export type ForceDirection = 'push' | 'pull' | 'static' | 'dynamic';
+
+/**
+ * Workout format types
+ */
+export type WorkoutFormat =
+  | 'straight_sets'
+  | 'superset'
+  | 'circuit'
+  | 'pyramid'
+  | 'drop_set'
+  | 'rest_pause'
+  | 'emom';
+
+/**
+ * Muscle groups
+ */
+export type MuscleGroup =
+  | 'chest'
+  | 'back'
+  | 'shoulders'
+  | 'biceps'
+  | 'triceps'
+  | 'forearms'
+  | 'abs'
+  | 'obliques'
+  | 'quadriceps'
+  | 'hamstrings'
+  | 'glutes'
+  | 'calves'
+  | 'traps'
+  | 'lats'
+  | 'front_delts'
+  | 'side_delts'
+  | 'rear_delts';
+
+/**
+ * Equipment types
+ */
+export type Equipment =
+  | 'barbell'
+  | 'dumbbell'
+  | 'kettlebell'
+  | 'machine'
+  | 'cable'
+  | 'bodyweight'
+  | 'resistance_band'
+  | 'bench'
+  | 'rack'
+  | 'pull_up_bar';
+
+/**
+ * Record type for personal records
+ */
+export type RecordType = 'weight' | 'reps' | 'volume' | 'distance' | 'duration';

package/types/exercise.ts

@@ -0,0 +1,75 @@
+import type {
+  DateTime,
+  UUID,
+  SearchParams,
+  ExerciseCategory,
+  MovementPattern,
+  ForceDirection,
+  MuscleGroup,
+  Equipment,
+} from './common';
+
+/**
+ * Exercise types
+ */
+
+/**
+ * Exercise capabilities
+ */
+export interface ExerciseCapabilities {
+  supportsWeight: boolean;
+  supportsBodyweightOnly: boolean;
+  supportsAssistance: boolean;
+  supportsDistance: boolean;
+  supportsDuration: boolean;
+  supportsTempo: boolean;
+}
+
+/**
+ * Exercise
+ */
+export interface Exercise {
+  id: UUID;
+  name: string;
+  description?: string;
+  category: ExerciseCategory | string;
+  exerciseType?: string;
+  movementPattern?: MovementPattern | string;
+  forceDirection?: ForceDirection | string;
+  primaryMuscles: (MuscleGroup | string)[];
+  secondaryMuscles: (MuscleGroup | string)[];
+  equipment: (Equipment | string)[];
+  capabilities: ExerciseCapabilities;
+  createdBy?: UUID;
+  createdAt: DateTime;
+  updatedAt: DateTime;
+}
+
+/**
+ * Create exercise request
+ */
+export interface CreateExerciseRequest {
+  name: string;
+  description?: string;
+  category: ExerciseCategory | string;
+  exerciseType?: string;
+  movementPattern?: MovementPattern | string;
+  forceDirection?: ForceDirection | string;
+  primaryMuscles: (MuscleGroup | string)[];
+  secondaryMuscles?: (MuscleGroup | string)[];
+  equipment: (Equipment | string)[];
+  capabilities: ExerciseCapabilities;
+}
+
+/**
+ * Update exercise request
+ */
+export type UpdateExerciseRequest = Partial<CreateExerciseRequest>;
+
+/**
+ * List exercises parameters
+ */
+export interface ListExercisesParams extends SearchParams {
+  category?: ExerciseCategory | string;
+  muscleGroup?: MuscleGroup | string;
+}

package/types/food.ts

@@ -0,0 +1,208 @@
+import type { DateTime, UUID, ListParams, SearchParams, DateRangeParams, MealType, DateString } from './common';
+
+/**
+ * Food and nutrition types
+ */
+
+/**
+ * Nutritional information for food items
+ */
+export interface NutritionalInformation {
+  // Macronutrients (required)
+  calories: number;
+  protein: number;
+  carbohydrates: number;
+  fat: number;
+
+  // Common micronutrients (optional)
+  fiber?: number;
+  sugar?: number;
+  saturatedFat?: number;
+  transFat?: number;
+  cholesterol?: number;
+  sodium?: number;
+  potassium?: number;
+  calcium?: number;
+  iron?: number;
+  vitaminA?: number;
+  vitaminC?: number;
+  vitaminD?: number;
+  vitaminE?: number;
+  vitaminK?: number;
+  vitaminB6?: number;
+  vitaminB12?: number;
+  thiamin?: number;
+  riboflavin?: number;
+  niacin?: number;
+  folate?: number;
+  magnesium?: number;
+  phosphorus?: number;
+  zinc?: number;
+  copper?: number;
+  manganese?: number;
+  selenium?: number;
+
+  // Amino acids (optional)
+  alanine?: number;
+  arginine?: number;
+  asparticAcid?: number;
+  cysteine?: number;
+  glutamicAcid?: number;
+  glycine?: number;
+  histidine?: number;
+  isoleucine?: number;
+  leucine?: number;
+  lysine?: number;
+  methionine?: number;
+  phenylalanine?: number;
+  proline?: number;
+  serine?: number;
+  threonine?: number;
+  tryptophan?: number;
+  tyrosine?: number;
+  valine?: number;
+}
+
+/**
+ * Serving size for food
+ */
+export interface ServingSize {
+  name: string;
+  grams: number;
+  isDefault: boolean;
+}
+
+/**
+ * Food item
+ */
+export interface Food {
+  id: UUID;
+  name: string;
+  description?: string;
+  brand?: string;
+  barcodeUpc?: string;
+  barcodeEan?: string;
+  barcodeGtin?: string;
+  barcodeOther?: string;
+  type: 'food' | 'beverage' | 'meal';
+  nutrients: NutritionalInformation;
+  servingSizes: ServingSize[];
+  calories: number;
+  protein: number;
+  carbs: number;
+  fat: number;
+  createdAt: DateTime;
+  updatedAt: DateTime;
+}
+
+/**
+ * Create food request
+ */
+export interface CreateFoodRequest {
+  name: string;
+  description?: string;
+  brand?: string;
+  barcodeUpc?: string;
+  barcodeEan?: string;
+  barcodeGtin?: string;
+  barcodeOther?: string;
+  type?: 'food' | 'beverage' | 'meal';
+  nutrients: NutritionalInformation;
+  servingSizes: Omit<ServingSize, 'id'>[];
+}
+
+/**
+ * Update food request
+ */
+export type UpdateFoodRequest = Partial<CreateFoodRequest>;
+
+/**
+ * List foods parameters
+ */
+export interface ListFoodsParams extends SearchParams {
+  search?: string;
+}
+
+/**
+ * Food log entry
+ */
+export interface FoodLog {
+  id: UUID;
+  userId: UUID;
+  foodId: UUID;
+  name: string;
+  servingSizeName?: string;
+  quantity: number;
+  unitGrams: number;
+  totalGrams: number;
+  nutrients: Record<string, number>;
+  mealType?: MealType;
+  loggedAt: DateTime;
+  notes?: string;
+  createdAt: DateTime;
+  foodName?: string;
+  foodBrand?: string;
+}
+
+/**
+ * Create food log request
+ */
+export interface CreateFoodLogRequest {
+  foodId: UUID;
+  name: string;
+  servingSizeName?: string;
+  quantity: number;
+  unitGrams: number;
+  mealType?: MealType;
+  loggedAt?: DateTime;
+  notes?: string;
+}
+
+/**
+ * Update food log request
+ */
+export type UpdateFoodLogRequest = Partial<CreateFoodLogRequest>;
+
+/**
+ * List food logs parameters
+ */
+export interface ListFoodLogsParams extends ListParams, DateRangeParams {
+  date?: DateString;
+  mealType?: MealType;
+}
+
+/**
+ * Daily nutrition summary
+ */
+export interface DailyNutritionSummary {
+  date: DateString;
+  mealType?: MealType;
+  totalCalories: number;
+  totalProtein: number;
+  totalCarbs: number;
+  totalFat: number;
+  itemCount: number;
+  nutrients?: Record<string, number>;
+}
+
+/**
+ * Get daily summary parameters
+ */
+export interface GetDailySummaryParams {
+  date?: DateString;
+  mealType?: MealType;
+}
+
+/**
+ * Quick entry food log request
+ * For quickly logging food with just name and nutrients
+ */
+export interface QuickEntryFoodLogRequest {
+  name: string;
+  calories?: number;
+  protein?: number;
+  carbohydrates?: number;
+  fat?: number;
+  mealType?: MealType;
+  loggedAt?: DateTime;
+}