UI Layer Protocol (ObjectUI)

The protocol for Views, Apps, Actions, and Analytics.

UI Layer Protocol (ObjectUI)

HotCRM uses a metadata-driven UI architecture. We define what to render, not how.

2.1 View Definition (`.view.ts`)

Protocal Location: packages/spec/src/ui/view.zod.ts

Views determine how collections of records are displayed.

Type	Use Case
`list`	Standard Table
`grid`	Excel-like Grid
`kanban`	Stage-based Board
`calendar`	Date-based Events
`gantt`	Project Timeline
`form`	Record Detail/Edit

Example (Kanban):

{
  type: 'kanban',
  group_by: 'status',
  columns: ['name', 'amount', 'owner'],
  card_fields: ['phone', 'email']
}

2.2 App Definition (`objectstack.config.ts`)

Protocal Location: packages/spec/src/ui/app.zod.ts

An App is a container of navigation items.

2.3 Actions (`.action.ts`)

Protocal Location: packages/spec/src/ui/action.zod.ts

Interactive elements (Buttons, Links).

button: Execute logic
url: Navigate
modal: Pop-up form
flow: Trigger Visual Flow

2.4 Analytics (Dashboards & Reports)

Protocal Location: packages/spec/src/ui/dashboard.zod.ts

Dashboard: A grid of Widgets (Charts, Metrics, Lists).
Report: A query engine definition (Tabular, Summary, Matrix).
Chart: Visualization config (Bar, Line, Pie).

Data Layer Protocol (ObjectQL)

The core metadata protocol defining Objects, Fields, Validations, and Logic.

Automation Protocol

Workflow Rules, Visual Flows, and Event Triggers.

On this page

UI Layer Protocol (ObjectUI)2.1 View Definition (.view.ts)2.2 App Definition (objectstack.config.ts)2.3 Actions (.action.ts)2.4 Analytics (Dashboards & Reports)