@dimrev4/fitness-v3-backend 0.0.3

package/.openapi-generator/FILES

@@ -0,0 +1,30 @@
+.gitignore
+.npmignore
+README.md
+api.ts
+base.ts
+common.ts
+configuration.ts
+docs/AuthV1Api.md
+docs/ConfirmOtpRequestDto.md
+docs/CreateMeasurementRequestDto.md
+docs/DeleteMeasurementResponseDto.md
+docs/GetMeResponseDto.md
+docs/GetMeasurementsResponseDto.md
+docs/GroupDto.md
+docs/LoginRequestDto.md
+docs/LoginResponseDto.md
+docs/LogoutResponseDto.md
+docs/MeasurementDto.md
+docs/MeasurementsV1Api.md
+docs/RegisterRequestDto.md
+docs/RegisterResponseDto.md
+docs/UpdateMeasurementRequestDto.md
+docs/UserDetailsDto.md
+docs/UserDto.md
+docs/UserToGroupDetailsDto.md
+git_push.sh
+index.ts
+package.json
+tsconfig.esm.json
+tsconfig.json

package/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.14.0

package/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

package/README.md

@@ -0,0 +1,423 @@
+# @dimrev4/user-core 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/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.
+
+## 🚀 Features
+
+- 🔐 JWT Authentication, Registration, Logout
+
+- 👥 Full User CRUD with self-service endpoints
+
+- 🏢 Group management with membership control
+
+- 🛡️ Granular permissions (system + group-level)
+
+- 📊 Pagination, filtering, and sorting support
+
+- 💪 100% TypeScript with full type safety
+
+- ⚡ Axios-based with interceptors support
+
+## 📦 Installation
+
+```bash
+npm install @dimrev4/user-core
+# or
+yarn add @dimrev4/user-core
+# or
+pnpm add @dimrev4/user-core
+```
+
+## 🔧 Quick Start
+
+### 1. Setup
+
+```typescript
+import {
+  Configuration,
+  AuthV1Api,
+  UserV1Api,
+  GroupV1Api,
+} from '@dimrev4/user-core';
+
+const config = new Configuration({
+  basePath: 'https://api.yourdomain.com',
+});
+
+const authApi = new AuthV1Api(config);
+const userApi = new UserV1Api(config);
+const groupApi = new GroupV1Api(config);
+```
+
+### 2. Authentication
+
+```typescript
+// Login
+const loginResponse = await authApi.authV1ControllerLogin({
+  email: 'user@example.com',
+  password: 'securePassword123!',
+});
+
+const { user, accessToken } = loginResponse.data;
+
+// Create authenticated client
+const authConfig = new Configuration({
+  basePath: 'https://api.yourdomain.com',
+  accessToken,
+});
+
+const authenticatedUserApi = new UserV1Api(authConfig);
+```
+
+### 3. User Management
+
+```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({
+  limit: 10,
+  offset: 0,
+  orderBy: 'createdAt',
+});
+
+// Create user
+const newUser = await authenticatedUserApi.userV1ControllerCreate({
+  email: 'newuser@company.com',
+  username: 'newuser',
+  password: 'SecurePass123!',
+});
+```
+
+### 4. Group Management
+
+```typescript
+// Create group
+const group = await groupApi.groupV1ControllerCreate({
+  name: 'Development Team',
+  userId: 'creator-user-id',
+});
+
+const groupId = group.data.id;
+
+// Add user to group
+const groupMembersApi = new GroupV1Api(authConfig);
+await groupMembersApi.groupMembersV1ControllerAddUserToGroup(
+  groupId,
+  'user-id',
+  {
+    canCreate: true,
+    canRead: true,
+    canUpdate: true,
+    canDelete: false,
+  },
+);
+```
+
+## 🏗️ API Overview
+
+### Authentication (AuthV1Api)
+
+- POST /api/auth/v1/login - Authenticate user
+- POST /api/auth/v1/register - Create new account
+- POST /api/auth/v1/logout - Invalidate session
+- POST /api/auth/v1/get-me - Get current user info
+
+### User Management (UserV1Api)
+
+- 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
+
+### Group Management (GroupV1Api)
+
+- 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
+
+### Group Members (GroupMembersV1Api)
+
+- 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
+
+## 🔐 Permissions
+
+### System Permissions
+
+```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
+  }
+}
+```
+
+### Group Permissions
+
+```json
+{
+  "isRoot": true, // Full group admin
+  "canCreate": true, // Create group content
+  "canRead": true, // View group content
+  "canUpdate": true, // Modify group content
+  "canDelete": true // Delete group content
+}
+```
+
+## 🧪 Error Handling
+
+```typescript
+import { AxiosError } from 'axios';
+
+try {
+  const users = await authenticatedUserApi.userV1ControllerGetUsers();
+} catch (error) {
+  if (error instanceof AxiosError) {
+    switch (error.response?.status) {
+      case 400:
+        console.error('Validation failed:', error.response.data.message);
+        break;
+      case 401:
+        console.error('Unauthorized:', error.response.data.message);
+        // Handle token refresh or redirect
+        break;
+      case 403:
+        console.error('Forbidden: Insufficient permissions');
+        break;
+      case 404:
+        console.error('Resource not found');
+        break;
+      case 409:
+        console.error('Conflict:', error.response.data.message);
+        break;
+      default:
+        console.error('API Error:', error.message);
+    }
+  }
+}
+```
+
+## ⚙️ Advanced Configuration
+
+### Custom Axios Instance
+
+```typescript
+import axios from 'axios';
+import { Configuration, UserV1Api } from '@dimrev4/user-core';
+
+const axiosInstance = axios.create({
+  timeout: 15000,
+});
+
+// Add auth token automatically
+axiosInstance.interceptors.request.use((config) => {
+  const token = localStorage.getItem('access_token');
+  if (token) {
+    config.headers.Authorization = `Bearer ${token}`;
+  }
+  return config;
+});
+
+const config = new Configuration({});
+const userApi = new UserV1Api(config, undefined, axiosInstance);
+```
+
+### Environment Setup
+
+```typescript
+const config = new Configuration({
+  basePath:
+    process.env.NODE_ENV === 'production'
+      ? 'https://api.yourdomain.com'
+      : 'http://localhost:3000/api',
+  timeout: 10000,
+  accessToken: process.env.API_TOKEN,
+});
+```
+
+## 🌍 Pagination & Filtering
+
+```typescript
+const users = await authenticatedUserApi.userV1ControllerGetUsers({
+  // Pagination
+  offset: 0,
+  limit: 25,
+
+  // Filtering
+  username: 'john',
+  email: 'company.com',
+
+  // Sorting
+  orderBy: 'createdAt', // createdAt, updatedAt, username, email
+});
+
+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: [],
+      }),
+    );
+  }),
+);
+
+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');
+});
+```
+
+## 🚨 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   |
+
+### Token Management Helper
+
+```typescript
+class AuthManager {
+  static 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);
+        return response.data.user;
+      });
+  }
+
+  static logout(config: Configuration) {
+    localStorage.removeItem('access_token');
+    config.accessToken = '';
+  }
+
+  static getAuthenticatedConfig(baseUrl: string): Configuration {
+    return new Configuration({
+      basePath: baseUrl,
+      accessToken: localStorage.getItem('access_token') || '',
+    });
+  }
+}
+
+// Usage
+const config = AuthManager.getAuthenticatedConfig('https://api.example.com');
+const userApi = new UserV1Api(config);
+```
+
+## 📊 TypeScript Types
+
+Key interfaces for type safety:
+
+```typescript
+interface CreateUserRequestDto {
+  email: string;
+  username: string;
+  password: string;
+}
+
+interface UserDetailsDto {
+  id: string;
+  username: string;
+  email: string;
+  createdAt: string;
+  updatedAt: string;
+  deletedAt: string | null;
+  userToGroup: UserToGroupDetailsDto[];
+}
+
+interface GroupDetailsDto {
+  id: string;
+  name: string;
+  createdAt: string;
+  updatedAt: string;
+  deletedAt: string | null;
+  userToGroup: UserToGroupDetailsDto[];
+}
+
+interface UserToGroupDetailsDto {
+  groupId: string;
+  userId: string;
+  canCreate: boolean;
+  canRead: boolean;
+  canUpdate: boolean;
+  canDelete: boolean;
+  isRoot: boolean;
+  group: GroupDto;
+  user: UserDto;
+}
+```
+
+## 🔗 Resources
+
+- API Docs: Available at /api endpoint (Swagger UI)
+- Repository: GitHub
+- Issues: GitHub Issues
+- License: Unlicense
+
+## 🤝 Contributing
+
+1. Fork the repository
+2. Update OpenAPI spec for new features
+3. Run npm run generate to rebuild SDK
+4. Submit pull request with tests
+
+---
+
+Auto-generated from User Core API v0.0 | Last Updated: Oct 2025