Service Design Specification

clonesahibinden-favorite-service documentation Version: 1.0.3

Scope

This document provides a structured architectural overview of the favorite 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.

Favorite Service Settings

Handles all user favorites for classified listings, including add/remove, listing user-specific collections, and providing favorited status for listings. Prevents duplicate favorites and maintains favorite counts on listings for optimal UX. Cascade-cleans favorites if user or listing is deleted.

Service Overview

This service is configured to listen for HTTP requests on port 3006, 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 clonesahibinden-favorite-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 clonesahibinden-favorite-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
favorite Stores which user favorited which listing, with timestamp. Enforces unique favorites per (user,listing) pair, and cascades on user/listing deletion. accessPrivate

favorite Data Object

Object Overview

Description: Stores which user favorited which listing, with timestamp. Enforces unique favorites per (user,listing) pair, and cascades on user/listing deletion.

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
favoritedAt Date Yes Date and time when the favorite was added.
listingId ID Yes Target listing being favorited.
userId ID Yes User who favorited the listing.

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.

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.

Constant Properties

favoritedAt listingId userId

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.

Elastic Search Indexing

favoritedAt listingId userId

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

listingId userId

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

listingId userId

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

Session Data Properties

userId

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.

This property is also used to store the owner of the session data, allowing for ownership checks and access control.

Business Logic

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

Edge Controllers

m2mCreateFavorite

Configuration:

REST Settings:

m2mBulkCreateFavorite

Configuration:

REST Settings:

m2mUpdateFavoriteById

Configuration:

REST Settings:

m2mDeleteFavoriteById

Configuration:

REST Settings:

m2mUpdateFavoriteByQuery

Configuration:

REST Settings:

m2mDeleteFavoriteByQuery

Configuration:

REST Settings:

m2mUpdateFavoriteByIdList

Configuration:

REST Settings:

Service Library

Functions

No general functions defined.

Hook Functions

No hook functions defined.

Edge Functions

m2mCreateFavorite.js

module.exports = async (request) => {
        const { createFavorite } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const data = request.body?.data || request.data || request;
        const result = await createFavorite(data, context);
        return { status: 200, content: result };
      }

m2mBulkCreateFavorite.js

module.exports = async (request) => {
        const { createBulkFavorite } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const dataList = request.body?.dataList || request.dataList || (Array.isArray(request.body) ? request.body : [request.body]);
        if (!Array.isArray(dataList) || dataList.length === 0) {
          return { status: 400, message: "dataList must be a non-empty array" };
        }
        const result = await createBulkFavorite(dataList, context);
        return { status: 200, content: result };
      }

m2mUpdateFavoriteById.js

module.exports = async (request) => {
        const { updateFavoriteById } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const id = request.body?.id || request.params?.id || request.id;
        const dataClause = request.body?.dataClause || request.dataClause || request.body;
        if (dataClause && dataClause.id) delete dataClause.id;
        if (!id) {
          return { status: 400, message: "ID is required" };
        }
        const result = await updateFavoriteById(id, dataClause, context);
        return { status: 200, content: result };
      }

m2mDeleteFavoriteById.js

module.exports = async (request) => {
        const { deleteFavoriteById } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const id = request.body?.id || request.params?.id || request.id;
        if (!id) {
          return { status: 400, message: "ID is required" };
        }
        const result = await deleteFavoriteById(id, context);
        return { status: 200, content: result };
      }

m2mUpdateFavoriteByQuery.js

module.exports = async (request) => {
        const { updateFavoriteByQuery } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const dataClause = request.body?.dataClause || request.dataClause || request.body;
        const query = request.body?.query || request.query || {};
        if (!query || typeof query !== "object" || Object.keys(query).length === 0) {
          return { status: 400, message: "Query is required and must be a non-empty object" };
        }
        const result = await updateFavoriteByQuery(dataClause, query, context);
        return { status: 200, content: result };
      }

m2mDeleteFavoriteByQuery.js

module.exports = async (request) => {
        const { deleteFavoriteByQuery } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const query = request.body?.query || request.query || {};
        if (!query || typeof query !== "object" || Object.keys(query).length === 0) {
          return { status: 400, message: "Query is required and must be a non-empty object" };
        }
        const result = await deleteFavoriteByQuery(query, context);
        return { status: 200, content: result };
      }

m2mUpdateFavoriteByIdList.js

module.exports = async (request) => {
        const { updateFavoriteByIdList } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const idList = request.body?.idList || request.idList || [];
        const dataClause = request.body?.dataClause || request.dataClause || request.body;
        if (dataClause && dataClause.idList) delete dataClause.idList;
        if (!Array.isArray(idList) || idList.length === 0) {
          return { status: 400, message: "idList must be a non-empty array" };
        }
        const result = await updateFavoriteByIdList(idList, dataClause, context);
        return { status: 200, content: result };
      }

Templates

No templates defined.

Assets

No assets defined.

Public Assets

No public assets defined.

Event Emission

Integration Patterns

Deployment Considerations

Environment Configuration

Implementation Guidelines

Development Workflow

  1. Data Model Implementation: Generate database schema from data object definitions
  2. CRUD Route Generation: Implement auto-generated routes with custom logic
  3. Custom Logic Integration: Implement hook functions and edge functions
  4. Authentication Integration: Configure with project-level authentication
  5. Testing: Unit and integration testing for all components

Code Generation Expectations

Custom Code Integration Points

Testing Strategy

Unit Testing

Integration Testing

Performance Testing

Appendices

Data Type Reference

Type Description Storage
ID Unique identifier UUID (SQL) / ObjectID (NoSQL)
String Short text (≤255 chars) VARCHAR
Text Long-form text TEXT
Integer 32-bit whole numbers INT
Boolean True/false values BOOLEAN
Double 64-bit floating point DOUBLE
Float 32-bit floating point FLOAT
Short 16-bit integers SMALLINT
Object JSON object JSONB (PostgreSQL) / Object (MongoDB)
Date ISO 8601 timestamp TIMESTAMP
Enum Fixed numeric values SMALLINT with lookup

Enum Value Mappings

Request Locations

HTTP Methods

Edge Function Signature

async function edgeFunction(request) {
  // Custom request processing
  // Return response object or throw error
  return {
    data: {},
    status: 200,
    message: "Success"
  };
}

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