Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions content/docs/references/api/requests/ExportRequest.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,14 @@ description: ExportRequest Schema Reference
| :--- | :--- | :--- | :--- |
| **object** | `string` | βœ… | Object name (e.g. account) |
| **fields** | `string \| object[]` | optional | Fields to retrieve |
| **aggregations** | `object[]` | optional | Aggregation functions (GROUP BY) |
| **windowFunctions** | `object[]` | optional | Window functions with OVER clause |
| **filters** | `any[] \| string \| any[]` | optional | Filtering criteria |
| **joins** | `object[]` | optional | Table joins |
| **groupBy** | `string[]` | optional | GROUP BY fields |
| **having** | `any[] \| string \| any[]` | optional | HAVING clause for aggregation filtering |
| **sort** | `object[]` | optional | Sorting instructions |
| **top** | `number` | optional | Limit results |
| **skip** | `number` | optional | Offset results |
| **distinct** | `boolean` | optional | SELECT DISTINCT flag |
| **format** | `Enum<'csv' \| 'json' \| 'xlsx'>` | optional | |
16 changes: 16 additions & 0 deletions content/docs/references/data/Address.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Address
description: Address Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **street** | `string` | optional | Street address |
| **city** | `string` | optional | City name |
| **state** | `string` | optional | State/Province |
| **postalCode** | `string` | optional | Postal/ZIP code |
| **country** | `string` | optional | Country name or code |
| **countryCode** | `string` | optional | ISO country code (e.g., US, GB) |
| **formatted** | `string` | optional | Formatted address string |
15 changes: 15 additions & 0 deletions content/docs/references/data/AggregationFunction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: AggregationFunction
description: AggregationFunction Schema Reference
---

## Allowed Values

* `count`
* `sum`
* `avg`
* `min`
* `max`
* `count_distinct`
* `array_agg`
* `string_agg`
13 changes: 13 additions & 0 deletions content/docs/references/data/AggregationNode.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: AggregationNode
description: AggregationNode Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **function** | `Enum<'count' \| 'sum' \| 'avg' \| 'min' \| 'max' \| 'count_distinct' \| 'array_agg' \| 'string_agg'>` | βœ… | Aggregation function |
| **field** | `string` | optional | Field to aggregate (optional for COUNT(*)) |
| **alias** | `string` | βœ… | Result column alias |
| **distinct** | `boolean` | optional | Apply DISTINCT before aggregation |
20 changes: 20 additions & 0 deletions content/docs/references/data/AsyncValidation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: AsyncValidation
description: AsyncValidation Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | βœ… | Unique rule name |
| **active** | `boolean` | optional | |
| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | |
| **message** | `string` | βœ… | Error message to display |
| **type** | `string` | βœ… | |
| **field** | `string` | βœ… | Field to validate |
| **validatorUrl** | `string` | optional | External API endpoint for validation |
| **validatorFunction** | `string` | optional | Reference to custom validator function |
| **timeout** | `number` | optional | Timeout in milliseconds |
| **debounce** | `number` | optional | Debounce delay in milliseconds |
| **params** | `Record<string, any>` | optional | Additional parameters to pass to validator |
17 changes: 17 additions & 0 deletions content/docs/references/data/ConditionalValidation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: ConditionalValidation
description: ConditionalValidation Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | βœ… | Unique rule name |
| **active** | `boolean` | optional | |
| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | |
| **message** | `string` | βœ… | Error message to display |
| **type** | `string` | βœ… | |
| **when** | `string` | βœ… | Condition formula (e.g. "type = 'enterprise'") |
| **then** | `object \| object \| object \| object \| object \| object \| object \| any` | βœ… | Validation rule to apply when condition is true |
| **otherwise** | `object \| object \| object \| object \| object \| object \| object \| any` | optional | Validation rule to apply when condition is false |
16 changes: 16 additions & 0 deletions content/docs/references/data/CrossFieldValidation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: CrossFieldValidation
description: CrossFieldValidation Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | βœ… | Unique rule name |
| **active** | `boolean` | optional | |
| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | |
| **message** | `string` | βœ… | Error message to display |
| **type** | `string` | βœ… | |
| **condition** | `string` | βœ… | Formula expression comparing fields (e.g. "end_date > start_date") |
| **fields** | `string[]` | βœ… | Fields involved in the validation |
17 changes: 17 additions & 0 deletions content/docs/references/data/CustomValidator.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: CustomValidator
description: CustomValidator Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | βœ… | Unique rule name |
| **active** | `boolean` | optional | |
| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | |
| **message** | `string` | βœ… | Error message to display |
| **type** | `string` | βœ… | |
| **field** | `string` | optional | Field to validate (optional for record-level validation) |
| **validatorFunction** | `string` | βœ… | Function name or reference to custom validator |
| **params** | `Record<string, any>` | optional | Additional parameters for the validator |
14 changes: 14 additions & 0 deletions content/docs/references/data/JoinNode.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: JoinNode
description: JoinNode Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **type** | `Enum<'inner' \| 'left' \| 'right' \| 'full'>` | βœ… | Join type |
| **object** | `string` | βœ… | Object/table to join |
| **alias** | `string` | optional | Table alias |
| **on** | `any[] \| string \| any[] \| string \| any[][]` | βœ… | Join condition |
| **subquery** | `object` | optional | Subquery instead of object |
11 changes: 11 additions & 0 deletions content/docs/references/data/JoinType.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: JoinType
description: JoinType Schema Reference
---

## Allowed Values

* `inner`
* `left`
* `right`
* `full`
13 changes: 13 additions & 0 deletions content/docs/references/data/LocationCoordinates.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: LocationCoordinates
description: LocationCoordinates Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **latitude** | `number` | βœ… | Latitude coordinate |
| **longitude** | `number` | βœ… | Longitude coordinate |
| **altitude** | `number` | optional | Altitude in meters |
| **accuracy** | `number` | optional | Accuracy in meters |
20 changes: 20 additions & 0 deletions content/docs/references/data/WindowFunction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: WindowFunction
description: WindowFunction Schema Reference
---

## Allowed Values

* `row_number`
* `rank`
* `dense_rank`
* `percent_rank`
* `lag`
* `lead`
* `first_value`
* `last_value`
* `sum`
* `avg`
* `count`
* `min`
* `max`
13 changes: 13 additions & 0 deletions content/docs/references/data/WindowFunctionNode.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: WindowFunctionNode
description: WindowFunctionNode Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **function** | `Enum<'row_number' \| 'rank' \| 'dense_rank' \| 'percent_rank' \| 'lag' \| 'lead' \| 'first_value' \| 'last_value' \| 'sum' \| 'avg' \| 'count' \| 'min' \| 'max'>` | βœ… | Window function name |
| **field** | `string` | optional | Field to operate on (for aggregate window functions) |
| **alias** | `string` | βœ… | Result column alias |
| **over** | `object` | βœ… | Window specification (OVER clause) |
12 changes: 12 additions & 0 deletions content/docs/references/data/WindowSpec.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: WindowSpec
description: WindowSpec Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **partitionBy** | `string[]` | optional | PARTITION BY fields |
| **orderBy** | `object[]` | optional | ORDER BY specification |
| **frame** | `object` | optional | Window frame specification |
13 changes: 12 additions & 1 deletion content/docs/references/data/core/Field.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: Field Schema Reference
| :--- | :--- | :--- | :--- |
| **name** | `string` | optional | Machine name (snake_case) |
| **label** | `string` | optional | Human readable label |
| **type** | `Enum<'text' \| 'textarea' \| 'email' \| 'url' \| 'phone' \| 'password' \| 'markdown' \| 'html' \| 'number' \| 'currency' \| 'percent' \| 'date' \| 'datetime' \| 'time' \| 'boolean' \| 'select' \| 'lookup' \| 'master_detail' \| 'image' \| 'file' \| 'avatar' \| 'formula' \| 'summary' \| 'autonumber'>` | βœ… | Field Data Type |
| **type** | `Enum<'text' \| 'textarea' \| 'email' \| 'url' \| 'phone' \| 'password' \| 'markdown' \| 'html' \| 'richtext' \| 'number' \| 'currency' \| 'percent' \| 'date' \| 'datetime' \| 'time' \| 'boolean' \| 'select' \| 'lookup' \| 'master_detail' \| 'image' \| 'file' \| 'avatar' \| 'formula' \| 'summary' \| 'autonumber' \| 'location' \| 'address' \| 'code' \| 'color' \| 'rating' \| 'signature'>` | βœ… | Field Data Type |
| **description** | `string` | optional | Tooltip/Help text |
| **format** | `string` | optional | Format string (e.g. email, phone) |
| **required** | `boolean` | optional | Is required |
Expand All @@ -31,6 +31,17 @@ description: Field Schema Reference
| **expression** | `string` | optional | Formula expression |
| **formula** | `string` | optional | Deprecated: Use expression |
| **summaryOperations** | `object` | optional | Roll-up summary definition |
| **language** | `string` | optional | Programming language for syntax highlighting (e.g., javascript, python, sql) |
| **theme** | `string` | optional | Code editor theme (e.g., dark, light, monokai) |
| **lineNumbers** | `boolean` | optional | Show line numbers in code editor |
| **maxRating** | `number` | optional | Maximum rating value (default: 5) |
| **allowHalf** | `boolean` | optional | Allow half-star ratings |
| **displayMap** | `boolean` | optional | Display map widget for location field |
| **allowGeocoding** | `boolean` | optional | Allow address-to-coordinate conversion |
| **addressFormat** | `Enum<'us' \| 'uk' \| 'international'>` | optional | Address format template |
| **colorFormat** | `Enum<'hex' \| 'rgb' \| 'rgba' \| 'hsl'>` | optional | Color value format |
| **allowAlpha** | `boolean` | optional | Allow transparency/alpha channel |
| **presetColors** | `string[]` | optional | Preset color options |
| **hidden** | `boolean` | optional | Hidden from default UI |
| **readonly** | `boolean` | optional | Read-only in UI |
| **encryption** | `boolean` | optional | Encrypt at rest |
Expand Down
9 changes: 8 additions & 1 deletion content/docs/references/data/types/FieldType.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ description: FieldType Schema Reference
* `password`
* `markdown`
* `html`
* `richtext`
* `number`
* `currency`
* `percent`
Expand All @@ -28,4 +29,10 @@ description: FieldType Schema Reference
* `avatar`
* `formula`
* `summary`
* `autonumber`
* `autonumber`
* `location`
* `address`
* `code`
* `color`
* `rating`
* `signature`
6 changes: 6 additions & 0 deletions content/docs/references/data/types/Query.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,13 @@ description: Query Schema Reference
| :--- | :--- | :--- | :--- |
| **object** | `string` | βœ… | Object name (e.g. account) |
| **fields** | `string \| object[]` | optional | Fields to retrieve |
| **aggregations** | `object[]` | optional | Aggregation functions (GROUP BY) |
| **windowFunctions** | `object[]` | optional | Window functions with OVER clause |
| **filters** | `any[] \| string \| any[]` | optional | Filtering criteria |
| **joins** | `object[]` | optional | Table joins |
| **groupBy** | `string[]` | optional | GROUP BY fields |
| **having** | `any[] \| string \| any[]` | optional | HAVING clause for aggregation filtering |
| **sort** | `object[]` | optional | Sorting instructions |
| **top** | `number` | optional | Limit results |
| **skip** | `number` | optional | Offset results |
| **distinct** | `boolean` | optional | SELECT DISTINCT flag |
11 changes: 11 additions & 0 deletions content/docs/references/ui/Animation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Animation
description: Animation Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **duration** | `object` | optional | |
| **timing** | `object` | optional | |
17 changes: 17 additions & 0 deletions content/docs/references/ui/BorderRadius.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: BorderRadius
description: BorderRadius Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **none** | `string` | optional | No border radius (0) |
| **sm** | `string` | optional | Small border radius (e.g., 0.125rem) |
| **base** | `string` | optional | Base border radius (e.g., 0.25rem) |
| **md** | `string` | optional | Medium border radius (e.g., 0.375rem) |
| **lg** | `string` | optional | Large border radius (e.g., 0.5rem) |
| **xl** | `string` | optional | Extra large border radius (e.g., 0.75rem) |
| **2xl** | `string` | optional | 2X large border radius (e.g., 1rem) |
| **full** | `string` | optional | Full border radius (50%) |
15 changes: 15 additions & 0 deletions content/docs/references/ui/Breakpoints.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Breakpoints
description: Breakpoints Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **xs** | `string` | optional | Extra small breakpoint (e.g., 480px) |
| **sm** | `string` | optional | Small breakpoint (e.g., 640px) |
| **md** | `string` | optional | Medium breakpoint (e.g., 768px) |
| **lg** | `string` | optional | Large breakpoint (e.g., 1024px) |
| **xl** | `string` | optional | Extra large breakpoint (e.g., 1280px) |
| **2xl** | `string` | optional | 2X large breakpoint (e.g., 1536px) |
26 changes: 26 additions & 0 deletions content/docs/references/ui/ColorPalette.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: ColorPalette
description: ColorPalette Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **primary** | `string` | βœ… | Primary brand color (hex, rgb, or hsl) |
| **secondary** | `string` | optional | Secondary brand color |
| **accent** | `string` | optional | Accent color for highlights |
| **success** | `string` | optional | Success state color (default: green) |
| **warning** | `string` | optional | Warning state color (default: yellow) |
| **error** | `string` | optional | Error state color (default: red) |
| **info** | `string` | optional | Info state color (default: blue) |
| **background** | `string` | optional | Background color |
| **surface** | `string` | optional | Surface/card background color |
| **text** | `string` | optional | Primary text color |
| **textSecondary** | `string` | optional | Secondary text color |
| **border** | `string` | optional | Border color |
| **disabled** | `string` | optional | Disabled state color |
| **primaryLight** | `string` | optional | Lighter shade of primary |
| **primaryDark** | `string` | optional | Darker shade of primary |
| **secondaryLight** | `string` | optional | Lighter shade of secondary |
| **secondaryDark** | `string` | optional | Darker shade of secondary |
17 changes: 17 additions & 0 deletions content/docs/references/ui/Shadow.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Shadow
description: Shadow Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **none** | `string` | optional | No shadow |
| **sm** | `string` | optional | Small shadow |
| **base** | `string` | optional | Base shadow |
| **md** | `string` | optional | Medium shadow |
| **lg** | `string` | optional | Large shadow |
| **xl** | `string` | optional | Extra large shadow |
| **2xl** | `string` | optional | 2X large shadow |
| **inner** | `string` | optional | Inner shadow (inset) |
Loading
Loading