Data Object

MPO Version: 1.3.0

A DataObject is the core building block of a service in Mindbricks. It represents both the data schema (like a table in SQL or a collection in MongoDB) and the business logic that operates around it. Each DataObject includes a set of DataProperties (fields), and it governs how the data is stored, validated, secured, and exposed through automatically generated business APIs. Beyond simple data modeling, DataObjects enable complex logic configurations, such as access control, field-level behaviors, validation, and custom API route behavior. They serve not only as data containers but also as logical units of functionality within the microservice.

interface DataObject = {
  objectSettings : ObjectSettings;
  properties : DataProperty[];
}

ObjectSettings

MPO Version: 1.3.0

Configuration settings that govern the behavior, access control, and optimization strategies of a data object. These settings allow fine-grained control over how the data object behaves in terms of authorization, caching, indexing, payment processing, and membership relationships. This is the central point to define how the object integrates with infrastructure and security policies in a microservice.

interface ObjectSettings = {
  basicSettings : ObjectBasicSettings;
  authorization : ObjectAuthorization;
  redisEntityCacheSettings : RedisEntityCacheSettings;
  compositeIndexSettings : CompositeIndex[];
  stripeOrder : StripeOrder;
  membershipSettings : MembershipSettings;
}

ObjectBasicSettings

MPO Version: 1.3.0

Basic configuration for a data object, including its identity, documentation, and deletion strategy. A data object acts as a logical model for a database table or MongoDB collection, and is central to defining how data is stored, queried, and managed within a microservice.

interface ObjectBasicSettings = {
  name : String;
  description : Text;
  frontendDocument : Text;
  useSoftDelete : Boolean;
}

ObjectAuthorization

MPO Version: 1.3.0

Defines access control scope for this data object, including tenant scoping and public accessibility. These settings are applied globally unless explicitly overridden at the Business API level.

interface ObjectAuthorization = {
  dataObjectAccess : DataObjectAccess;
  objectDataIsInTenantLevel : Boolean;
}

DataObjectAccess

Defines the possible access levels for a DataObject. This type captures whether the object is only visible to its owner/admins (private), shared with authenticated project users (protected), or exposed to the public including anonymous users (public). The key difference is between restricted vs. shared access, and within shared access whether authentication is required.

const DataObjectAccess = {
  accessPrivate: "accessPrivate",
  accessProtected: "accessProtected",
  accessPublic: "accessPublic",
};

RedisEntityCacheSettings

MPO Version: 1.3.0

Configuration for Redis-based entity-level caching. Enables fast access to frequently used data by storing and serving object-level records from Redis, with support for custom cache criteria and smart expiration.

interface RedisEntityCacheSettings = {
  useEntityCaching : Boolean;
  configuration : RedisEntityCacheConfig;
}

RedisEntityCacheConfig

MPO Version: 1.3.0

Configuration for Redis-based entity-level caching. Enables fast access to frequently used data by storing and serving object-level records from Redis, with support for custom cache criteria and smart expiration.

interface RedisEntityCacheConfig = {
  useSmartCaching : Boolean;
  cacheCriteria : MScript;
  checkCriteriaOnlyInCreateAndUpdates : Boolean;
}

CompositeIndex

MPO Version: 1.3.0

Defines a composite index for a data object. Composite indexes improve database performance for queries that filter or sort based on multiple fields. Each index is created at the database level and can optionally handle duplicate conflicts during insert operations. Note that if you need unique constraints on a single field, you can use the unique property of the DataProperty instead. Composite indexes are particularly useful for optimizing complex queries that involve multiple fields, such as searching for users by email and client ID simultaneously or whne you need to ensure uniqueness across multiple fields (e.g., email and clientId). They are defined at the data object level and will be used across all related Business APIs.

interface CompositeIndex = {
  indexName : String;
  indexFields : PropRefer[];
  onDuplicate : OnDuplicate;
}

OnDuplicate

Enumeration that defines the conflict resolution strategy when a new record would violate a composite index constraint.

const OnDuplicate = {
  doUpdate: "doUpdate",
  throwError: "throwError",
  stopOperation: "stopOperation",
  doInsert: "doInsert",
};

StripeOrder

MPO Version: 1.3.0

Defines the settings for integrating this data object with Stripe to handle e-commerce orders and payments. When enabled, Mindbricks automatically generates the required logic and auxiliary objects for managing payment workflows. Ensure Stripe credentials are set at the project level to activate this integration.

interface StripeOrder = {
  objectIsAnOrderObject : Boolean;
  configuration : StripeOrderConfig;
}

StripeOrderConfig

MPO Version: 1.3.0

Configuration settings for Stripe order integration. Defines the order name, ID, amount, currency, description, and other properties used in the Stripe payment flow.

interface StripeOrderConfig = {
  orderName : String;
  orderId : MScript;
  amount : MScript;
  currency : MScript;
  description : MScript;
  orderStatusProperty : PropRefer;
  orderStatusUpdateDateProperty : PropRefer;
  orderOwnerIdProperty : PropRefer;
  mapPaymentResultToOrderStatus : PaymentResultMap;
  onCheckoutError : OnCheckoutError;
  edgeFunctionOnStatusChange : String;
}

OnPaymentError

Enum options for handling errors that occur during the payment process.

const OnPaymentError = {
  continueRoute: "continueRoute",
  throwError: "throwError",
};

PaymentResultMap

MPO Version: 1.3.0

Defines how various Stripe payment outcomes map to internal order status values using MScript expressions.

interface PaymentResultMap = {
  paymentResultStarted : MScript;
  paymentResultCanceled : MScript;
  paymentResultFailed : MScript;
  paymentResultSuccess : MScript;
}

MembershipSettings

MPO Version: 1.3.0

Configuration settings for membership-based access control of a data object. This object does not define access itself but relies on a separate membership data object to manage which users can access this data object. For example, an 'organization' object might have access control defined through an 'organizationMember' object, which holds references to both the user and the organization.

interface MembershipSettings = {
  hasMembership : Boolean;
  configuration : MembershipSettingsConfig;
}

MembershipSettingsConfig

MPO Version: 1.3.0

Configuration settings for membership-based access control of a data object. This object does not define access itself but relies on a separate membership data object to manage which users can access this data object. For example, an 'organization' object might have access control defined through an 'organizationMember' object, which holds references to both the user and the organization.

interface MembershipSettingsConfig = {
  membershipObjectName : DataObjectName;
  membershipObjectIdProperty : PropRefer;
  membershipUserIdProperty : PropRefer;
  membershipStatusCheck : MScript;
}