Service Design Specification - Object Design for chessGame

wechess-gameplay-service documentation

Document Overview

This document outlines the object design for the chessGame model in our application. It includes details about the model’s attributes, relationships, and any specific validation or business logic that applies.

chessGame Data Object

Object Overview

Description: No description provided.

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

Properties Schema

Property Type Required Description
playerWhiteId ID Yes User ID of the player assigned White (guest or registered); references auth:user.id.
playerBlackId ID No -
createdById ID Yes ID of the user who created the game (can be a guest or registered user).
status Enum Yes Lifecycle status: pending, active, paused, completed, terminated
mode Enum Yes Game mode: public (matchmaking), private (invitation-based)
invitationCode String No -
currentFEN String Yes Current board state in FEN notation for restoration/resume.
gameType Enum Yes Game type: timed, untimed, blitz, rapid
saveStatus Enum Yes Game mutual-saving: notSaveable, requested, paused (both agreed)
saveRequestWhite Boolean No Whether white has requested save/resume; mutual save when both true.
saveRequestBlack Boolean No Whether black has requested save/resume; mutual save when both true.
movedAt Date No Timestamp of last move (heartbeat/game activity).
result Enum No Game result/outcome: whiteWin, blackWin, draw, aborted
terminatedById ID No ID of administrator who forced terminated the game (if applicable).
reportStatus Enum No Moderation/review status: none, reported, underReview
guestPlayerWhite Boolean No True if white is a guest (not a registered user); needed to distinguish guest/registered in history.
guestPlayerBlack Boolean No True if black is a guest (not a registered user); needed to distinguish guest/registered in history.
initialFEN String No The starting FEN position when the game was created. Used to identify custom games.

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.

Constant Properties

playerWhiteId createdById mode invitationCode gameType initialFEN

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

playerWhiteId playerBlackId createdById status mode invitationCode currentFEN gameType saveStatus saveRequestWhite saveRequestBlack movedAt result terminatedById reportStatus guestPlayerWhite guestPlayerBlack initialFEN

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.

Elastic Search Indexing

playerWhiteId playerBlackId createdById status mode invitationCode currentFEN gameType saveStatus saveRequestWhite saveRequestBlack movedAt result terminatedById reportStatus guestPlayerWhite guestPlayerBlack initialFEN

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

playerWhiteId playerBlackId createdById status mode invitationCode movedAt result

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

mode invitationCode

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.

Relation Properties

playerWhiteId playerBlackId createdById terminatedById

Mindbricks supports relations between data objects, allowing you to define how objects are linked together. You can define relations in the data object properties, which will be used to create foreign key constraints in the database. For complex joins operations, Mindbricks supportsa BFF pattern, where you can view dynamic and static views based on Elastic Search Indexes. Use db level relations for simple one-to-one or one-to-many relationships, and use BFF views for complex joins that require multiple data objects to be joined together.

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

On Delete: Set Null Required: No

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

On Delete: Set Null Required: No

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

On Delete: Set Null Required: No

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

On Delete: Set Null Required: No

Filter Properties

status invitationCode

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.