# Service Design Specification - Object Design for user **aifitapp-auth-service** documentation ## Document Overview This document outlines the object design for the `user` model in our application. It includes details about the model's attributes, relationships, and any specific validation or business logic that applies. ## user Data Object ### Object Overview **Description:** A data object that stores the user information and handles login settings. This object represents a core data structure within the service and acts as the blueprint for database interaction, API generation, and business logic enforcement. It is defined using the `ObjectSettings` pattern, which governs its behavior, access control, caching strategy, and integration points with other systems such as Stripe and Redis. ### Core Configuration - **Soft Delete:** Enabled — Determines whether records are marked inactive (`isActive = false`) instead of being physically deleted. - **Public Access:** accessPrivate — If enabled, anonymous users may access this object’s data depending on API-level rules. ### Redis Entity Caching This data object is configured for Redis entity caching, which improves data retrieval performance by storing frequently accessed data in Redis. Each time a new instance is created, updated or deleted, the cache is updated accordingly. Any get requests by id will first check the cache before querying the database. If you want to use the cache by other select criteria, you can configure any data property as a Redis cluster. ### Properties Schema | Property | Type | Required | Description | |----------|------|----------|-------------| | `email` | String | Yes | A string value to represent the user's email. | | `password` | String | Yes | A string value to represent the user's password. It will be stored as hashed. | | `fullname` | String | Yes | A string value to represent the fullname of the user | | `avatar` | String | No | The avatar url of the user. A random avatar will be generated if not provided | | `roleId` | String | Yes | A string value to represent the roleId of the user. | | `emailVerified` | Boolean | Yes | A boolean value to represent the email verification status of the user. | | `activityLevel` | Enum | No | User's general daily activity level, used as the TDEE activity multiplier. | | `availableEquipment` | String | No | List of equipment available to the user for training program generation. | | `country` | String | No | User's country of residence, used for regional food suggestions and cuisine preferences. | | `dateOfBirth` | Date | No | User's date of birth, used for age-based calorie and program calculations. | | `dietaryRestrictions` | String | No | List of user dietary restrictions or allergies for meal plan customization. | | `fitnessGoal` | Enum | No | User's primary fitness goal driving program and nutrition recommendations. | | `height` | Float | No | User's height in centimeters, used for BMR and TDEE calculations. | | `sex` | Enum | Yes | User's biological sex, used for BMR calculations and program customization. | | `trainingExperience` | Enum | No | User's training experience level, influencing program complexity and progression rates. | | `weeklyTrainingDays` | Integer | No | Number of days per week the user is available to train, used for program split selection. | | `weight` | Float | No | User's current body weight in kilograms, used for calorie and macro calculations. | * Required properties are mandatory for creating objects and must be provided in the request body if no default value is set. ### Array Properties `availableEquipment` `dietaryRestrictions` Array properties can hold multiple values and are indicated by the `[]` suffix in their type. Avoid using arrays in properties that are used for relations, as they will not work correctly. Note that using connection objects instead of arrays is recommended for relations, as they provide better performance and flexibility. ### Default Values Default values are automatically assigned to properties when a new object is created, if no value is provided in the request body. Since default values are applied on db level, they should be literal values, not expressions.If you want to use expressions, you can use transposed parameters in any business API to set default values dynamically. - **email**: 'default' - **password**: 'default' - **fullname**: 'default' - **roleId**: user ### Always Create with Default Values Some of the default values are set to be always used when creating a new object, even if the property value is provided in the request body. It ensures that the property is always initialized with a default value when the object is created. - **roleId**: Will be created with value `user` - **emailVerified**: Will be created with value `false` ### Constant Properties `email` Constant properties are defined to be immutable after creation, meaning they cannot be updated or changed once set. They are typically used for properties that should remain constant throughout the object's lifecycle. A property is set to be constant if the `Allow Update` option is set to `false`. ### Auto Update Properties `fullname` `avatar` `activityLevel` `availableEquipment` `country` `dateOfBirth` `dietaryRestrictions` `fitnessGoal` `height` `sex` `trainingExperience` `weeklyTrainingDays` `weight` An update crud API created with the option `Auto Params` enabled will automatically update these properties with the provided values in the request body. If you want to update any property in your own business logic not by user input, you can set the `Allow Auto Update` option to false. These properties will be added to the update API's body parameters and can be updated by the user if any value is provided in the request body. ### Hashed Properties `password` Hashed properties are stored in the database as a hash value, providing an additional layer of security for sensitive data. ### Enum Properties Enum properties are defined with a set of allowed values, ensuring that only valid options can be assigned to them. The enum options value will be stored as strings in the database, but when a data object is created an addtional property with the same name plus an idx suffix will be created, which will hold the index of the selected enum option. You can use the index property to sort by the enum value or when your enum options represent a sequence of values. - **activityLevel**: [sedentary, lightTraining, moderate, heavyTraining, athlete] - **fitnessGoal**: [fatLoss, muscleGain, recomposition, strengthMaintenance, generalHealth] - **sex**: [male, female] - **trainingExperience**: [beginner, intermediate, advanced] ### Elastic Search Indexing `email` `fullname` `roleId` `emailVerified` `activityLevel` `availableEquipment` `country` `dateOfBirth` `dietaryRestrictions` `fitnessGoal` `height` `sex` `trainingExperience` `weeklyTrainingDays` `weight` Properties that are indexed in Elastic Search will be searchable via the Elastic Search API. While all properties are stored in the elastic search index of the data object, only those marked for Elastic Search indexing will be available for search queries. ### Database Indexing `email` Properties that are indexed in the database will be optimized for query performance, allowing for faster data retrieval. Make a property indexed in the database if you want to use it frequently in query filters or sorting. ### Unique Properties `email` Unique properties are enforced to have distinct values across all instances of the data object, preventing duplicate entries. Note that a unique property is automatically indexed in the database so you will not need to set the `Indexed in DB` option. ### Cache Select Properties `email` Cache select properties are used to collect data from Redis entity cache with a different key than the data object id. This allows you to cache data that is not directly related to the data object id, but a frequently used filter. ### Secondary Key Properties `email` Secondary key properties are used to create an additional indexed identifiers for the data object, allowing for alternative access patterns. Different than normal indexed properties, secondary keys will act as primary keys and Mindbricks will provide automatic secondary key db utility functions to access the data object by the secondary key. ### Filter Properties `email` `fullname` `roleId` `activityLevel` `country` `fitnessGoal` `sex` `trainingExperience` Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API's that have "Auto Params" enabled. - **email**: String has a filter named `email` - **fullname**: String has a filter named `fullname` - **roleId**: String has a filter named `roleId` - **activityLevel**: Enum has a filter named `activityLevel` - **country**: String has a filter named `country` - **fitnessGoal**: Enum has a filter named `fitnessGoal` - **sex**: Enum has a filter named `sex` - **trainingExperience**: Enum has a filter named `trainingExperience`