@dimrev4/fitness-v3-backend 0.0.3 → 0.0.4

package/README.md

@@ -1,25 +1,25 @@
-# @dimrev4/user-core SDK
+# @dimrev4/fitness-v3-backend SDK
 
 <p align="center">
-  <img src="https://img.shields.io/npm/v/@dimrev4/user-core" alt="npm version" />
-  <img src="https://img.shields.io/npm/dm/@dimrev4/user-core" alt="npm downloads" />
-  <img src="https://img.shields.io/github/license/dimRev/user-core" alt="license" />
+  <img src="https://img.shields.io/npm/v/@dimrev4/fitness-v3-backend" alt="npm version" />
+  <img src="https://img.shields.io/npm/dm/@dimrev4/fitness-v3-backend" alt="npm downloads" />
+  <img src="https://img.shields.io/github/license/dimRev/fitness-v3-backend" alt="license" />
   <img src="https://img.shields.io/badge/TypeScript-100%25-blue" alt="TypeScript" />
 </p>
 
-TypeScript SDK for User Core API - Comprehensive client for user management, authentication, groups, and permissions in fitness applications.
+TypeScript SDK for Fitness V3 Backend API - Comprehensive client for body measurements, meal tracking, and fitness data management in fitness applications.
 
 ## 🚀 Features
 
-- 🔐 JWT Authentication, Registration, Logout
+- � **Body Measurements** - Track weight, body fat, muscle mass, and other metrics
 
-- 👥 Full User CRUD with self-service endpoints
+- 🔐 **Authentication Integration** - Seamless integration with User Core API
 
-- 🏢 Group management with membership control
+- �️ **Meal Management** - Save meals and track consumption (planned)
 
-- 🛡️ Granular permissions (system + group-level)
+- � **Time-based Filtering** - Query data by date ranges with pagination
 
-- 📊 Pagination, filtering, and sorting support
+- 👥 **Group Support** - Access group-shared measurements with proper permissions
 
 - 💪 100% TypeScript with full type safety
 
@@ -28,11 +28,11 @@ TypeScript SDK for User Core API - Comprehensive client for user management, aut
 ## 📦 Installation
 
 ```bash
-npm install @dimrev4/user-core
+npm install @dimrev4/fitness-v3-backend
 # or
-yarn add @dimrev4/user-core
+yarn add @dimrev4/fitness-v3-backend
 # or
-pnpm add @dimrev4/user-core
+pnpm add @dimrev4/fitness-v3-backend
 ```
 
 ## 🔧 Quick Start
@@ -43,23 +43,21 @@ pnpm add @dimrev4/user-core
 import {
   Configuration,
   AuthV1Api,
-  UserV1Api,
-  GroupV1Api,
-} from '@dimrev4/user-core';
+  MeasurementsV1Api,
+} from '@dimrev4/fitness-v3-backend';
 
 const config = new Configuration({
-  basePath: 'https://api.yourdomain.com',
+  basePath: 'https://fitness-api.yourdomain.com',
 });
 
 const authApi = new AuthV1Api(config);
-const userApi = new UserV1Api(config);
-const groupApi = new GroupV1Api(config);
+const measurementsApi = new MeasurementsV1Api(config);
 ```
 
 ### 2. Authentication
 
 ```typescript
-// Login
+// Login (integrates with User Core API)
 const loginResponse = await authApi.authV1ControllerLogin({
   email: 'user@example.com',
   password: 'securePassword123!',
@@ -69,121 +67,210 @@ const { user, accessToken } = loginResponse.data;
 
 // Create authenticated client
 const authConfig = new Configuration({
-  basePath: 'https://api.yourdomain.com',
+  basePath: 'https://fitness-api.yourdomain.com',
   accessToken,
 });
 
-const authenticatedUserApi = new UserV1Api(authConfig);
+const authenticatedMeasurementsApi = new MeasurementsV1Api(authConfig);
 ```
 
-### 3. User Management
+### 3. Body Measurements
 
 ```typescript
-// Get current user
-const me = await authenticatedUserApi.userV1ControllerGetUserSelf();
-console.log('Current user:', me.data.username);
-
-// List users with pagination
-const users = await authenticatedUserApi.userV1ControllerGetUsers({
+// Get current user's measurements with date filtering
+const measurements = await authenticatedMeasurementsApi.getAllByUserId({
   limit: 10,
   offset: 0,
-  orderBy: 'createdAt',
+  fromDate: '2025-01-01',
+  toDate: '2025-01-31',
 });
 
-// Create user
-const newUser = await authenticatedUserApi.userV1ControllerCreate({
-  email: 'newuser@company.com',
-  username: 'newuser',
-  password: 'SecurePass123!',
-});
-```
+console.log('Recent measurements:', measurements.data.measurements);
 
-### 4. Group Management
-
-```typescript
-// Create group
-const group = await groupApi.groupV1ControllerCreate({
-  name: 'Development Team',
-  userId: 'creator-user-id',
+// Create a new measurement
+const newMeasurement = await authenticatedMeasurementsApi.createMeasurement({
+  date: new Date().toISOString(),
+  weightKG: 75.5,
+  heightCM: 175.2,
+  bmi: 24.6,
 });
 
-const groupId = group.data.id;
+// Get specific measurement
+const measurement =
+  await authenticatedMeasurementsApi.getMeasurementById('measurement-id');
 
-// Add user to group
-const groupMembersApi = new GroupV1Api(authConfig);
-await groupMembersApi.groupMembersV1ControllerAddUserToGroup(
-  groupId,
-  'user-id',
+// Update measurement
+const updatedMeasurement = await authenticatedMeasurementsApi.updateMeasurement(
+  'measurement-id',
   {
-    canCreate: true,
-    canRead: true,
-    canUpdate: true,
-    canDelete: false,
+    weightKG: 75.8,
+    bmi: 24.7,
   },
 );
+
+// Delete measurement (soft delete)
+const deleteResponse =
+  await authenticatedMeasurementsApi.deleteMeasurement('measurement-id');
+```
+
+### 4. Group-Based Measurements
+
+```typescript
+// Get measurements for a group (requires group read permissions)
+const groupMeasurements =
+  await authenticatedMeasurementsApi.getAllByUserIdAdmin('group-id', {
+    limit: 20,
+    offset: 0,
+    fromDate: '2025-01-01',
+    toDate: '2025-01-31',
+  });
+
+// Get specific measurement by group
+const groupMeasurement =
+  await authenticatedMeasurementsApi.getMeasurementByGroupIdAndMeasurementId(
+    'group-id',
+    'measurement-id',
+  );
 ```
 
 ## 🏗️ API Overview
 
 ### Authentication (AuthV1Api)
 
-- POST /api/auth/v1/login - Authenticate user
-- POST /api/auth/v1/register - Create new account
+- POST /api/auth/v1/login - Authenticate user (integrates with User Core)
+- POST /api/auth/v1/register - Create new account (integrates with User Core)
+- POST /api/auth/v1/confirm-otp - Confirm OTP for registration
 - POST /api/auth/v1/logout - Invalidate session
 - POST /api/auth/v1/get-me - Get current user info
 
-### User Management (UserV1Api)
+### Body Measurements (MeasurementsV1Api)
 
-- GET /api/users/v1 - List users (paginated)
-- GET /api/users/v1/self - Get current user
-- GET /api/users/v1/{id} - Get user by ID
-- POST /api/users/v1 - Create user
-- PUT /api/users/v1/self - Update own profile
-- DELETE /api/users/v1/self - Delete own account
+- GET /api/measurements/v1 - Get user's measurements (with date filtering)
+- POST /api/measurements/v1 - Create new measurement
+- GET /api/measurements/v1/{id} - Get specific measurement
+- PATCH /api/measurements/v1/{id} - Update measurement
+- DELETE /api/measurements/v1/{id} - Soft delete measurement
 
-### Group Management (GroupV1Api)
+### Group-Based Measurements (MeasurementsV1Api)
 
-- GET /api/groups/v1 - List all groups
-- GET /api/groups/v1/self - Get user's groups
-- POST /api/groups/v1 - Create group
-- PUT /api/groups/v1/{id} - Update group
-- DELETE /api/groups/v1/{id} - Delete group
+- GET /api/measurements/v1/group/{groupId} - Get group measurements (requires read permission)
+- GET /api/measurements/v1/group/{groupId}/{measurementId} - Get specific group measurement
 
-### Group Members (GroupMembersV1Api)
+### Meals (Planned - SavedMealsV1Api, UserMealsV1Api)
 
-- POST /api/groups/members/v1/{groupId}/{userId} - Add user to group
-- PUT /api/groups/members/v1/{groupId}/{userId} - Update permissions
-- DELETE /api/groups/members/v1/{groupId}/{userId} - Remove user
+- GET /api/meals/v1/saved - Get saved meal templates
+- POST /api/meals/v1/saved - Create saved meal template
+- GET /api/meals/v1/user - Get user meal consumption history
+- POST /api/meals/v1/user - Log meal consumption
 
-## 🔐 Permissions
+## � Data Models
 
-### System Permissions
+### Measurement
 
 ```json
 {
-  "user": {
-    "readAll": true, // List all users
-    "readOne": true, // View specific user
-    "create": true, // Create users
-    "update": true, // Update any user
-    "delete": true // Delete any user
-  },
-  "group": {
-    "readAll": true, // List all groups
-    "create": true, // Create groups
-    "update": true, // Update groups
-    "delete": true // Delete groups
-  }
+  "id": "e9c83a87-37ac-4938-8d88-379c4ac81c5c",
+  "date": "2025-01-15T10:30:00.000Z",
+  "weightKG": 75.5,
+  "heightCM": 175.2,
+  "bmi": 24.6,
+  "userId": "user-id",
+  "createdAt": "2025-01-15T10:30:00.000Z",
+  "updatedAt": "2025-01-15T10:30:00.000Z",
+  "deletedAt": null
+}
+```
+
+### Saved Meal
+
+```json
+{
+  "id": "meal-id",
+  "name": "Protein Shake",
+  "description": "Post-workout protein shake with banana",
+  "recipe": "1 scoop protein powder, 1 banana, 200ml milk...",
+  "imgUrl": "https://example.com/protein-shake.jpg",
+  "MealType": "SNACK",
+  "FoodCategory": "PROTEIN",
+  "calories": 350.5,
+  "totalFatGrams": 8.2,
+  "saturatedFatGrams": 3.1,
+  "transFatGrams": 0.0,
+  "cholesterolMg": 15.0,
+  "sodiumMg": 120.0,
+  "totalCarbohydrateGrams": 35.0,
+  "dietaryFiberGrams": 4.2,
+  "totalSugarGrams": 28.0,
+  "addedSugarGrams": 5.0,
+  "proteinGrams": 30.0,
+  "vitaminDGrams": 2.5,
+  "calciumGrams": 250.0,
+  "ironGrams": 3.0,
+  "potassiumGrams": 450.0,
+  "createdAt": "2025-01-15T10:30:00.000Z",
+  "updatedAt": "2025-01-15T10:30:00.000Z",
+  "deletedAt": null
 }
 ```
 
+### User Meal
+
+```json
+{
+  "id": "user-meal-id",
+  "name": "My Custom Protein Shake",
+  "description": "My personalized post-workout shake",
+  "recipe": "1 scoop protein powder, 1 banana, 200ml almond milk...",
+  "imgUrl": "https://example.com/my-shake.jpg",
+  "MealType": "SNACK",
+  "FoodCategory": "PROTEIN",
+  "calories": 320.0,
+  "totalFatGrams": 6.5,
+  "saturatedFatGrams": 2.1,
+  "transFatGrams": 0.0,
+  "cholesterolMg": 10.0,
+  "sodiumMg": 100.0,
+  "totalCarbohydrateGrams": 32.0,
+  "dietaryFiberGrams": 4.0,
+  "totalSugarGrams": 25.0,
+  "addedSugarGrams": 3.0,
+  "proteinGrams": 28.0,
+  "vitaminDGrams": 2.0,
+  "calciumGrams": 200.0,
+  "ironGrams": 2.5,
+  "potassiumGrams": 400.0,
+  "userId": "user-id",
+  "createdAt": "2025-01-15T10:30:00.000Z",
+  "updatedAt": "2025-01-15T10:30:00.000Z",
+  "deletedAt": null
+}
+```
+
+### User Meal Consumption
+
+```json
+{
+  "id": "consumption-id",
+  "userId": "user-id",
+  "mealId": "user-meal-id",
+  "date": "2025-01-15T14:00:00.000Z",
+  "createdAt": "2025-01-15T14:00:00.000Z",
+  "updatedAt": "2025-01-15T14:00:00.000Z",
+  "deletedAt": null
+}
+```
+
+## 🔐 Group Permissions
+
+For group-based endpoints, users must have appropriate permissions:
+
 ### Group Permissions
 
 ```json
 {
   "isRoot": true, // Full group admin
   "canCreate": true, // Create group content
-  "canRead": true, // View group content
+  "canRead": true, // View group content (required for group measurement endpoints)
   "canUpdate": true, // Modify group content
   "canDelete": true // Delete group content
 }
@@ -195,7 +282,7 @@ await groupMembersApi.groupMembersV1ControllerAddUserToGroup(
 import { AxiosError } from 'axios';
 
 try {
-  const users = await authenticatedUserApi.userV1ControllerGetUsers();
+  const measurements = await authenticatedMeasurementsApi.getAllByUserId();
 } catch (error) {
   if (error instanceof AxiosError) {
     switch (error.response?.status) {
@@ -204,13 +291,13 @@ try {
         break;
       case 401:
         console.error('Unauthorized:', error.response.data.message);
-        // Handle token refresh or redirect
+        // Handle token refresh or redirect to login
         break;
       case 403:
         console.error('Forbidden: Insufficient permissions');
         break;
       case 404:
-        console.error('Resource not found');
+        console.error('Measurement not found');
         break;
       case 409:
         console.error('Conflict:', error.response.data.message);
@@ -228,7 +315,7 @@ try {
 
 ```typescript
 import axios from 'axios';
-import { Configuration, UserV1Api } from '@dimrev4/user-core';
+import { Configuration, MeasurementsV1Api } from '@dimrev4/fitness-v3-backend';
 
 const axiosInstance = axios.create({
   timeout: 15000,
@@ -244,7 +331,7 @@ axiosInstance.interceptors.request.use((config) => {
 });
 
 const config = new Configuration({});
-const userApi = new UserV1Api(config, undefined, axiosInstance);
+const measurementsApi = new MeasurementsV1Api(config, undefined, axiosInstance);
 ```
 
 ### Environment Setup
@@ -253,8 +340,8 @@ const userApi = new UserV1Api(config, undefined, axiosInstance);
 const config = new Configuration({
   basePath:
     process.env.NODE_ENV === 'production'
-      ? 'https://api.yourdomain.com'
-      : 'http://localhost:3000/api',
+      ? 'https://fitness-api.yourdomain.com'
+      : 'http://localhost:42070/api',
   timeout: 10000,
   accessToken: process.env.API_TOKEN,
 });
@@ -263,102 +350,75 @@ const config = new Configuration({
 ## 🌍 Pagination & Filtering
 
 ```typescript
-const users = await authenticatedUserApi.userV1ControllerGetUsers({
+const measurements = await authenticatedMeasurementsApi.getAllByUserId({
   // Pagination
   offset: 0,
   limit: 25,
 
-  // Filtering
-  username: 'john',
-  email: 'company.com',
-
-  // Sorting
-  orderBy: 'createdAt', // createdAt, updatedAt, username, email
+  // Date filtering
+  fromDate: '2025-01-01',
+  toDate: '2025-01-31',
 });
 
-console.log(`${users.data.totalItems} users found`);
-console.log(`Page ${users.data.currentPage} of ${users.data.totalPages}`);
-```
-
-## 🧪 Testing
-
-### Mock with MSW
-
-```typescript
-import { rest } from 'msw';
-import { setupServer } from 'msw/node';
-import { UserV1Api } from '@dimrev4/user-core';
-
-const server = setupServer(
-  rest.get('*/api/users/v1/self', (req, res, ctx) => {
-    return res(
-      ctx.status(200),
-      ctx.json({
-        id: '1',
-        username: 'testuser',
-        email: 'test@example.com',
-        createdAt: new Date().toISOString(),
-        updatedAt: new Date().toISOString(),
-        deletedAt: null,
-        userToGroup: [],
-      }),
-    );
-  }),
+console.log(`${measurements.data.totalItems} measurements found`);
+console.log(
+  `Page ${measurements.data.currentPage} of ${measurements.data.totalPages}`,
 );
 
-beforeAll(() => server.listen());
-afterAll(() => server.close());
-
-test('gets current user', async () => {
-  const config = new Configuration({ basePath: 'http://localhost' });
-  const api = new UserV1Api(config);
-
-  const response = await api.userV1ControllerGetUserSelf();
-  expect(response.data.username).toBe('testuser');
-});
+// Group measurements with filtering
+const groupMeasurements =
+  await authenticatedMeasurementsApi.getAllByUserIdAdmin('group-id', {
+    offset: 0,
+    limit: 50,
+    fromDate: '2025-01-01',
+    toDate: '2025-01-31',
+  });
 ```
 
 ## 🚨 Common Issues
 
-| Issue                  | Solution                                |
-| ---------------------- | --------------------------------------- |
-| 401 Unauthorized       | Set accessToken in Configuration        |
-| 403 Forbidden          | Check required permissions for endpoint |
-| CORS Error             | Configure API CORS or use proxy in dev  |
-| Token not sent         | Use accessToken parameter in config     |
-| Validation Error (400) | Check request body against DTO schema   |
+| Issue                     | Solution                                    |
+| ------------------------- | ------------------------------------------- |
+| 401 Unauthorized          | Set accessToken in Configuration            |
+| 403 Forbidden             | Check group permissions for group endpoints |
+| CORS Error                | Configure API CORS or use proxy in dev      |
+| Token not sent            | Use accessToken parameter in config         |
+| Validation Error (400)    | Check request body against DTO schema       |
+| 404 Measurement Not Found | Verify measurement ID and user access       |
 
 ### Token Management Helper
 
 ```typescript
-class AuthManager {
-  static login(email: string, password: string, config: Configuration) {
+class FitnessAuthManager {
+  static async login(email: string, password: string, config: Configuration) {
     const authApi = new AuthV1Api(config);
     return authApi
       .authV1ControllerLogin({ email, password })
       .then((response) => {
         config.accessToken = response.data.accessToken;
-        localStorage.setItem('access_token', response.data.accessToken);
+        localStorage.setItem('fitness_access_token', response.data.accessToken);
         return response.data.user;
       });
   }
 
   static logout(config: Configuration) {
-    localStorage.removeItem('access_token');
+    localStorage.removeItem('fitness_access_token');
     config.accessToken = '';
   }
 
   static getAuthenticatedConfig(baseUrl: string): Configuration {
     return new Configuration({
       basePath: baseUrl,
-      accessToken: localStorage.getItem('access_token') || '',
+      accessToken: localStorage.getItem('fitness_access_token') || '',
     });
   }
 }
 
 // Usage
-const config = AuthManager.getAuthenticatedConfig('https://api.example.com');
-const userApi = new UserV1Api(config);
+const config = FitnessAuthManager.getAuthenticatedConfig(
+  'https://fitness-api.example.com',
+);
+const measurementsApi = new MeasurementsV1Api(config);
 ```
 
 ## 📊 TypeScript Types
@@ -366,41 +426,134 @@ const userApi = new UserV1Api(config);
 Key interfaces for type safety:
 
 ```typescript
-interface CreateUserRequestDto {
-  email: string;
-  username: string;
-  password: string;
+interface CreateMeasurementRequestDto {
+  date: string; // ISO date string
+  weightKG: number;
+  heightCM: number;
+  bmi: number;
 }
 
-interface UserDetailsDto {
+interface MeasurementDto {
   id: string;
-  username: string;
-  email: string;
+  date: string;
+  weightKG: number;
+  heightCM: number;
+  bmi: number;
+  userId: string;
   createdAt: string;
   updatedAt: string;
   deletedAt: string | null;
-  userToGroup: UserToGroupDetailsDto[];
 }
 
-interface GroupDetailsDto {
+interface GetMeasurementsResponseDto {
+  measurements: MeasurementDto[];
+  totalItems: number;
+  currentPage: number;
+  totalPages: number;
+}
+
+interface UpdateMeasurementRequestDto {
+  date?: string;
+  weightKG?: number;
+  heightCM?: number;
+  bmi?: number;
+}
+
+interface DeleteMeasurementResponseDto {
+  success: boolean;
+  message: string;
+}
+
+interface SavedMealDto {
   id: string;
   name: string;
+  description: string;
+  recipe: string;
+  imgUrl: string;
+  MealType: 'BREAKFAST' | 'LUNCH' | 'DINNER' | 'SNACK' | 'DESSERT';
+  FoodCategory:
+    | 'DAIRY'
+    | 'PROTEIN'
+    | 'CARBOHYDRATES'
+    | 'FRUITS'
+    | 'VEGETABLES'
+    | 'FATS'
+    | 'GRAINS'
+    | 'BEVERAGES'
+    | 'SWEETS';
+  calories: number;
+  totalFatGrams: number;
+  saturatedFatGrams: number;
+  transFatGrams: number;
+  cholesterolMg: number;
+  sodiumMg: number;
+  totalCarbohydrateGrams: number;
+  dietaryFiberGrams: number;
+  totalSugarGrams: number;
+  addedSugarGrams: number;
+  proteinGrams: number;
+  vitaminDGrams: number;
+  calciumGrams: number;
+  ironGrams: number;
+  potassiumGrams: number;
   createdAt: string;
   updatedAt: string;
   deletedAt: string | null;
-  userToGroup: UserToGroupDetailsDto[];
 }
 
-interface UserToGroupDetailsDto {
-  groupId: string;
+interface UserMealDto {
+  id: string;
+  name: string;
+  description: string;
+  recipe: string;
+  imgUrl: string;
+  MealType: 'BREAKFAST' | 'LUNCH' | 'DINNER' | 'SNACK' | 'DESSERT';
+  FoodCategory:
+    | 'DAIRY'
+    | 'PROTEIN'
+    | 'CARBOHYDRATES'
+    | 'FRUITS'
+    | 'VEGETABLES'
+    | 'FATS'
+    | 'GRAINS'
+    | 'BEVERAGES'
+    | 'SWEETS';
+  calories: number;
+  totalFatGrams: number;
+  saturatedFatGrams: number;
+  transFatGrams: number;
+  cholesterolMg: number;
+  sodiumMg: number;
+  totalCarbohydrateGrams: number;
+  dietaryFiberGrams: number;
+  totalSugarGrams: number;
+  addedSugarGrams: number;
+  proteinGrams: number;
+  vitaminDGrams: number;
+  calciumGrams: number;
+  ironGrams: number;
+  potassiumGrams: number;
+  userId: string;
+  createdAt: string;
+  updatedAt: string;
+  deletedAt: string | null;
+}
+
+interface UserMealConsumptionDto {
+  id: string;
   userId: string;
-  canCreate: boolean;
-  canRead: boolean;
-  canUpdate: boolean;
-  canDelete: boolean;
-  isRoot: boolean;
-  group: GroupDto;
-  user: UserDto;
+  mealId: string;
+  date: string;
+  createdAt: string;
+  updatedAt: string;
+  deletedAt: string | null;
+}
+
+interface GetMeResponseDto {
+  id: string;
+  username: string;
+  email: string;
+  // ... other user properties from User Core API
 }
 ```
 
@@ -415,9 +568,9 @@ interface UserToGroupDetailsDto {
 
 1. Fork the repository
 2. Update OpenAPI spec for new features
-3. Run npm run generate to rebuild SDK
+3. Run `pnpm run sdk:generate` to rebuild SDK
 4. Submit pull request with tests
 
 ---
 
-Auto-generated from User Core API v0.0 | Last Updated: Oct 2025
+Auto-generated from Fitness V3 Backend API v0.0.3 | Last Updated: Oct 2025

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dimrev4/fitness-v3-backend",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "OpenAPI client for @dimrev4/fitness-v3-backend",
   "author": "OpenAPI-Generator Contributors",
   "repository": {