Service Design Specification

clonesahibinden-categorylocation-service documentation Version: 1.0.1

Scope

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

CategoryLocation Service Settings

Manages the category and location hierarchies for listings. Provides CRUD with uniqueness enforcement, navigation endpoints for category/location trees, and supports efficient public browsing with heavy read optimization.

Service Overview

This service is configured to listen for HTTP requests on port 3001, 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-categorylocation-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-categorylocation-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
category Represents a listing category; supports up to three levels of nesting for hierarchical browsing and filtering. Self-referencing parent-child relationship. Slug is unique for public URL routing. Sort order is unique within parent for ordered display. accessPublic
location Represents a hierarchical location of country/city/district for listings. Used for filtering/search/location field on all listings. accessPublic

category Data Object

Object Overview

Description: Represents a listing category; supports up to three levels of nesting for hierarchical browsing and filtering. Self-referencing parent-child relationship. Slug is unique for public URL routing. Sort order is unique within parent for ordered display.

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

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. 

{isActive:true}

This object is only cached if this criteria is met.

The criteria is checked during all operations, including read operations. If your criteria is all about the data properties, you can use the checkCriteriaOnlyInCreateAndUpdates option to improve performance.

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.

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
description Text No Optional extended description for category (for admin display or frontend info).
icon String No Icon identifier (string or URL to a static asset) for this category.
name String Yes Category name, e.g. 'Automobiles', 'Electronics'.
parentCategoryId ID No References parent category for hierarchy. Top-level (root) categories have null.
slug String Yes SEO-friendly unique slug for URL and search. Lowercase, hyphens only.
sortOrder Integer Yes Order for listing within siblings. Unique per parent.

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.

Auto Update Properties

description icon name parentCategoryId slug sortOrder

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.

Elastic Search Indexing

description icon name parentCategoryId slug sortOrder

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

name parentCategoryId slug sortOrder

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

slug

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

parentCategoryId slug

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

slug

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

parentCategoryId

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

Filter Properties

name parentCategoryId slug

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.

location Data Object

Object Overview

Description: Represents a hierarchical location of country/city/district for listings. Used for filtering/search/location field on all listings.

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

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. 

{isActive:true}

This object is only cached if this criteria is met.

The criteria is checked during all operations, including read operations. If your criteria is all about the data properties, you can use the checkCriteriaOnlyInCreateAndUpdates option to improve performance.

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
city String Yes City name.
country String Yes Country name (typically 'Turkey').
district String Yes District name, for fine-grained search.
latitude Double No Latitude for map/search.
longitude Double No Longitude for map/search.
postalCode String No Postal code for location.

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.

Auto Update Properties

city country district latitude longitude postalCode

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.

Elastic Search Indexing

city country district latitude longitude postalCode

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

city country district

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.

Filter Properties

city country district

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.

Business Logic

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

Edge Controllers

m2mCreateCategory

Configuration:

REST Settings:

m2mBulkCreateCategory

Configuration:

REST Settings:

m2mUpdateCategoryById

Configuration:

REST Settings:

m2mDeleteCategoryById

Configuration:

REST Settings:

m2mUpdateCategoryByQuery

Configuration:

REST Settings:

m2mDeleteCategoryByQuery

Configuration:

REST Settings:

m2mUpdateCategoryByIdList

Configuration:

REST Settings:

m2mCreateLocation

Configuration:

REST Settings:

m2mBulkCreateLocation

Configuration:

REST Settings:

m2mUpdateLocationById

Configuration:

REST Settings:

m2mDeleteLocationById

Configuration:

REST Settings:

m2mUpdateLocationByQuery

Configuration:

REST Settings:

m2mDeleteLocationByQuery

Configuration:

REST Settings:

m2mUpdateLocationByIdList

Configuration:

REST Settings:

Service Library

Functions

No general functions defined.

Hook Functions

No hook functions defined.

Edge Functions

m2mCreateCategory.js

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

m2mBulkCreateCategory.js

module.exports = async (request) => {
        const { createBulkCategory } = 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 createBulkCategory(dataList, context);
        return { status: 200, content: result };
      }

m2mUpdateCategoryById.js

module.exports = async (request) => {
        const { updateCategoryById } = 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 updateCategoryById(id, dataClause, context);
        return { status: 200, content: result };
      }

m2mDeleteCategoryById.js

module.exports = async (request) => {
        const { deleteCategoryById } = 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 deleteCategoryById(id, context);
        return { status: 200, content: result };
      }

m2mUpdateCategoryByQuery.js

module.exports = async (request) => {
        const { updateCategoryByQuery } = 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 updateCategoryByQuery(dataClause, query, context);
        return { status: 200, content: result };
      }

m2mDeleteCategoryByQuery.js

module.exports = async (request) => {
        const { deleteCategoryByQuery } = 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 deleteCategoryByQuery(query, context);
        return { status: 200, content: result };
      }

m2mUpdateCategoryByIdList.js

module.exports = async (request) => {
        const { updateCategoryByIdList } = 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 updateCategoryByIdList(idList, dataClause, context);
        return { status: 200, content: result };
      }

m2mCreateLocation.js

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

m2mBulkCreateLocation.js

module.exports = async (request) => {
        const { createBulkLocation } = 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 createBulkLocation(dataList, context);
        return { status: 200, content: result };
      }

m2mUpdateLocationById.js

module.exports = async (request) => {
        const { updateLocationById } = 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 updateLocationById(id, dataClause, context);
        return { status: 200, content: result };
      }

m2mDeleteLocationById.js

module.exports = async (request) => {
        const { deleteLocationById } = 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 deleteLocationById(id, context);
        return { status: 200, content: result };
      }

m2mUpdateLocationByQuery.js

module.exports = async (request) => {
        const { updateLocationByQuery } = 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 updateLocationByQuery(dataClause, query, context);
        return { status: 200, content: result };
      }

m2mDeleteLocationByQuery.js

module.exports = async (request) => {
        const { deleteLocationByQuery } = 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 deleteLocationByQuery(query, context);
        return { status: 200, content: result };
      }

m2mUpdateLocationByIdList.js

module.exports = async (request) => {
        const { updateLocationByIdList } = 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 updateLocationByIdList(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.