Service Design Specification

tutorhub-coursescheduling-service documentation Version: 1.0.48

Scope

This document provides a structured architectural overview of the courseScheduling microservice, detailing its configuration, data model, authorization logic, business rules, and API design. It has been automatically generated based on the service definition within Mindbricks, ensuring that the information reflects the source of truth used during code generation and deployment.

The document is intended to serve multiple audiences:

Note for Frontend Developers: While this document is valuable for understanding business logic and data interactions, please refer to the Service API Documentation for endpoint-level specifications and integration details.

Note for Backend Developers: Since the code for this service is automatically generated by Mindbricks, you typically won’t need to implement or modify it manually. However, this document is especially valuable when you’re building other services—whether within Mindbricks or externally—that need to interact with or depend on this service. It provides a clear reference to the service’s data contracts, business rules, and API structure, helping ensure compatibility and correct integration.

CourseScheduling Service Settings

Handles all scheduling: tutor availability, lesson slot management/booking, preliminary meeting scheduling for screened courses. Ensures schedule privacy (authenticated only).

Service Overview

This service is configured to listen for HTTP requests on port 3002, serving both the main API interface and default administrative endpoints.

The following routes are available by default:

The service uses a PostgreSQL database for data storage, with the database name set to tutorhub-coursescheduling-service.

This service is accessible via the following environment-specific URLs:

Authentication & Security

This service requires user authentication for access. It supports both JWT and RSA-based authentication mechanisms, ensuring secure user sessions and data integrity. If a crud route also is configured to require login, it will check a valid JWT token in the request query/header/bearer/cookie. If the token is valid, it will extract the user information from the token and make the fetched session data available in the request context.

Service Data Objects

The service uses a PostgreSQL database for data storage, with the database name set to tutorhub-coursescheduling-service.

Data deletion is managed using a soft delete strategy. Instead of removing records from the database, they are flagged as inactive by setting the isActive field to false.

Object Name Description Public Access
availability Weekly availability window for a tutor, determines open slots for student booking. Each tuple is for a specific day/time window. accessPrivate
lessonSlot No description accessPrivate
preliminaryMeeting Request for a pre-enrollment screening meeting with a tutor, required for some advanced coursePacks. accessPrivate

availability Data Object

Object Overview

Description: Weekly availability window for a tutor, determines open slots for student booking. Each tuple is for a specific day/time window.

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

Composite Indexes

The index also defines a conflict resolution strategy for duplicate key violations.

When a new record would violate this composite index, the following action will be taken:

On Duplicate: doUpdate

The existing record will be updated with the new data.No error will be thrown.

Properties Schema

Property Type Required Description
tutorProfileId ID Yes FK to tutorCatalog:tutorProfile. Only owner tutor or admin can edit.
dayOfWeek Enum Yes Day of week: sunday-saturday.
startTime String Yes Start time of window (HH:mm, 24h).
endTime String Yes End time of window (HH:mm, 24h).
isRecurring Boolean Yes If true, this slot recurs weekly.
specificDate Date No Specific date (YYYY-MM-DD) for non-recurring availability. Null for recurring slots.
teachingMode Enum Yes -

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

tutorProfileId

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

tutorProfileId dayOfWeek startTime endTime isRecurring specificDate teachingMode

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

tutorProfileId dayOfWeek startTime endTime isRecurring specificDate teachingMode

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

tutorProfileId specificDate

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.

Relation Properties

tutorProfileId

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: Yes

Filter Properties

teachingMode

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.

lessonSlot 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

Composite Indexes

The index also defines a conflict resolution strategy for duplicate key violations.

When a new record would violate this composite index, the following action will be taken:

On Duplicate: throwError

An error will be thrown, preventing the insertion of conflicting data.

Properties Schema

Property Type Required Description
coursePackId ID Yes FK to tutorCatalog:coursePack. Only tutors for the pack, enrolled student, or admin may update/view.
studentId ID No FK to auth:user (student). Set on booking. Nullable when open (free).
scheduledDate Date Yes Date for the lesson slot (yyyy-mm-dd).
scheduledTime String Yes Start time of lesson (HH:mm 24h).
status Enum Yes State of lesson slot (free, booked, completed, canceled).
locationType Enum No -
locationDetails String No Optional: Location address/details; editable after booking by either party.
sessionMode Enum Yes Chosen delivery mode for this lesson. Set at booking time based on student choice or tutor's teachingMode. 'online' triggers Google Meet link generation, 'faceToFace' uses locationType/locationDetails.
meetLink String No Google Meet URL for online lessons. Auto-populated when sessionMode is 'online'. Null for face-to-face sessions.

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

coursePackId scheduledDate scheduledTime

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

coursePackId studentId scheduledDate scheduledTime status locationType locationDetails sessionMode meetLink

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

coursePackId studentId scheduledDate scheduledTime status locationType sessionMode

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

coursePackId studentId scheduledDate scheduledTime status sessionMode

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.

Relation Properties

coursePackId studentId

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: Yes

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

coursePackId studentId status sessionMode

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.

preliminaryMeeting Data Object

Object Overview

Description: Request for a pre-enrollment screening meeting with a tutor, required for some advanced coursePacks.

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

Composite Indexes

The index also defines a conflict resolution strategy for duplicate key violations.

When a new record would violate this composite index, the following action will be taken:

On Duplicate: doUpdate

The existing record will be updated with the new data.No error will be thrown.

Properties Schema

Property Type Required Description
coursePackId ID Yes FK to tutorCatalog:coursePack (the advanced course)
studentId ID Yes FK to auth:user (student who requested).
scheduledDatetime Date No Datetime for screening meeting; may be null until both parties agree.
tutorDecision Enum Yes -
comments String No Optional field for tutor to provide comments/notes about screening result.
meetingLink String No Video call link (Google Meet, Zoom, etc.) for the screening interview. Set by the tutor when scheduling.

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

coursePackId studentId

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

coursePackId studentId scheduledDatetime tutorDecision comments meetingLink

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

coursePackId studentId scheduledDatetime tutorDecision

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

coursePackId studentId tutorDecision

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.

Relation Properties

coursePackId studentId

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: Yes

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: Yes

Business Logic

courseScheduling has got 14 Business APIs to manage its internal and crud logic. For the details of each business API refer to its chapter.

Service Library

Functions

validateSlotAgainstAvailability.js

module.exports = function validateSlotAgainstAvailability(availabilities, scheduledDate, scheduledTime) {
  if (!availabilities || availabilities.length === 0) {
    return { valid: false, error: 'No tutor availability found for this course.' };
  }
  const dateStr = (scheduledDate || '').split('T')[0];
  const d = new Date(dateStr + 'T00:00:00Z');
  if (isNaN(d.getTime())) return { valid: false, error: 'Invalid scheduled date.' };

  const dayNames = ['sunday','monday','tuesday','wednesday','thursday','friday','saturday'];
  const slotDay = dayNames[d.getUTCDay()];
  const slotHour = parseInt((scheduledTime || '').split(':')[0], 10);
  const slotMin = parseInt((scheduledTime || '').split(':')[1], 10) || 0;
  const slotMinutes = slotHour * 60 + slotMin;

  for (const av of availabilities) {
    if (av.dayOfWeek !== slotDay) continue;
    if (!av.isRecurring && av.specificDate) {
      const avDate = (av.specificDate || '').split('T')[0];
      if (avDate !== dateStr) continue;
    }
    const [sh, sm] = (av.startTime || '').split(':').map(Number);
    const [eh, em] = (av.endTime || '').split(':').map(Number);
    const startMin = sh * 60 + (sm || 0);
    const endMin = eh * 60 + (em || 0);
    if (slotMinutes >= startMin && slotMinutes < endMin) {
      return { valid: true, error: null };
    }
  }
  return { valid: false, error: 'No matching availability for ' + slotDay + ' at ' + scheduledTime + '.' };
};

This document was generated from the service architecture definition and should be kept in sync with implementation changes.