# Service Design Specification - Object Design for chatMessage **tutorhub-messaging-service** documentation ## Document Overview This document outlines the object design for the `chatMessage` model in our application. It includes details about the model's attributes, relationships, and any specific validation or business logic that applies. ## chatMessage Data Object ### Object Overview **Description:** Auto-generated message DataObject for the chat RealtimeHub. Stores all messages with typed content payloads. 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. ### Properties Schema | Property | Type | Required | Description | |----------|------|----------|-------------| | `roomId` | ID | Yes | Reference to the room this message belongs to | | `senderId` | ID | No | Reference to the user who sent this message | | `senderName` | String | No | Display name of the sender (denormalized from user profile at send time) | | `senderAvatar` | String | No | Avatar URL of the sender (denormalized from user profile at send time) | | `messageType` | Enum | Yes | Content type discriminator for this message | | `content` | Object | Yes | Type-specific content payload (structure depends on messageType) | | `timestamp` | | No | Message creation time | | `status` | Enum | No | Message moderation status | | `replyTo` | Object | No | Reply thread reference { id, preview } | * Required properties are mandatory for creating objects and must be provided in the request body if no default value is set. ### 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. - **roomId**: '00000000-0000-0000-0000-000000000000' - **messageType**: "text" - **content**: {} - **timestamp**: now() - **status**: approved ### Constant Properties `roomId` `senderId` `senderName` `senderAvatar` `messageType` `timestamp` `replyTo` 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 `roomId` `senderId` `senderName` `senderAvatar` `messageType` `content` `timestamp` `status` `replyTo` 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. ### 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. - **messageType**: [text, image, document, system, warning] - **status**: [pending, approved, rejected] ### Elastic Search Indexing `roomId` `senderId` `senderName` `senderAvatar` `messageType` `content` `timestamp` `status` `replyTo` 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 `roomId` `senderId` `senderName` `senderAvatar` `messageType` `content` `timestamp` `status` `replyTo` 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. ### Secondary Key Properties `roomId` 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. ### Session Data Properties `senderId` Session data properties are used to store data that is specific to the user session, allowing for personalized experiences and temporary data storage. If a property is configured as session data, it will be automatically mapped to the related field in the user session during CRUD operations. Note that session data properties can not be mutated by the user, but only by the system. - **senderId**: ID property will be mapped to the session parameter `userId`. ### Filter Properties `roomId` `senderId` `senderName` `senderAvatar` `messageType` `content` `timestamp` `status` `replyTo` 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. - **roomId**: ID has a filter named `roomId` - **senderId**: ID has a filter named `senderId` - **senderName**: String has a filter named `senderName` - **senderAvatar**: String has a filter named `senderAvatar` - **messageType**: Enum has a filter named `messageType` - **content**: Object has a filter named `content` - **timestamp**: has a filter named `timestamp` - **status**: Enum has a filter named `status` - **replyTo**: Object has a filter named `replyTo`