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
16 changes: 16 additions & 0 deletions content/docs/references/data/Trigger.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Trigger
description: Trigger Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | โœ… | Trigger name (snake_case) |
| **object** | `string` | โœ… | Target object name |
| **timing** | `Enum<'before' \| 'after'>` | โœ… | Execution timing |
| **action** | `Enum<'insert' \| 'update' \| 'delete'> \| Enum<'insert' \| 'update' \| 'delete'>[]` | โœ… | Database operation(s) to trigger on |
| **description** | `string` | optional | Trigger description |
| **active** | `boolean` | optional | Is trigger active |
| **order** | `number` | optional | Execution order |
10 changes: 10 additions & 0 deletions content/docs/references/data/TriggerAction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: TriggerAction
description: TriggerAction Schema Reference
---

## Allowed Values

* `insert`
* `update`
* `delete`
17 changes: 17 additions & 0 deletions content/docs/references/data/TriggerContext.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: TriggerContext
description: TriggerContext Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **action** | `Enum<'insert' \| 'update' \| 'delete'>` | โœ… | Database operation type |
| **timing** | `Enum<'before' \| 'after'>` | โœ… | Trigger execution timing |
| **doc** | `Record<string, any>` | โœ… | Current document/record |
| **previousDoc** | `Record<string, any>` | optional | Previous document state |
| **userId** | `string` | โœ… | Current user ID |
| **user** | `Record<string, any>` | โœ… | Current user record |
| **ql** | `any` | optional | ObjectQL data access API |
| **logger** | `any` | optional | Logging interface |
9 changes: 9 additions & 0 deletions content/docs/references/data/TriggerTiming.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: TriggerTiming
description: TriggerTiming Schema Reference
---

## Allowed Values

* `before`
* `after`
14 changes: 14 additions & 0 deletions content/docs/references/system/DriverCapabilities.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: DriverCapabilities
description: DriverCapabilities Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **transactions** | `boolean` | โœ… | Supports transactions |
| **joins** | `boolean` | โœ… | Supports SQL joins |
| **fullTextSearch** | `boolean` | โœ… | Supports full-text search |
| **jsonFields** | `boolean` | โœ… | Supports JSON field types |
| **arrayFields** | `boolean` | โœ… | Supports array field types |
12 changes: 12 additions & 0 deletions content/docs/references/system/DriverInterface.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: DriverInterface
description: DriverInterface Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | โœ… | Driver name |
| **version** | `string` | โœ… | Driver version |
| **supports** | `object` | โœ… | Driver capabilities |
11 changes: 11 additions & 0 deletions content/docs/references/system/Plugin.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Plugin
description: Plugin Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **id** | `string` | optional | Plugin identifier |
| **version** | `string` | optional | Plugin version |
14 changes: 14 additions & 0 deletions content/docs/references/system/PluginContext.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: PluginContext
description: PluginContext Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **ql** | `any` | optional | ObjectQL data access API |
| **os** | `any` | optional | ObjectOS system API |
| **logger** | `any` | optional | Logging interface |
| **metadata** | `any` | optional | Metadata registry |
| **events** | `any` | optional | Event bus |
9 changes: 9 additions & 0 deletions content/docs/references/system/PluginLifecycle.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: PluginLifecycle
description: PluginLifecycle Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
16 changes: 16 additions & 0 deletions content/docs/references/ui/FieldWidgetProps.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: FieldWidgetProps
description: FieldWidgetProps Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **value** | `any` | optional | Current field value |
| **readonly** | `boolean` | optional | Read-only mode flag |
| **required** | `boolean` | optional | Required field flag |
| **error** | `string` | optional | Validation error message |
| **field** | `object` | โœ… | Field schema definition |
| **record** | `Record<string, any>` | optional | Complete record data |
| **options** | `Record<string, any>` | optional | Custom widget options |
39 changes: 39 additions & 0 deletions packages/spec/json-schema/DriverCapabilities.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"$ref": "#/definitions/DriverCapabilities",
"definitions": {
"DriverCapabilities": {
"type": "object",
"properties": {
"transactions": {
"type": "boolean",
"description": "Supports transactions"
},
"joins": {
"type": "boolean",
"description": "Supports SQL joins"
},
"fullTextSearch": {
"type": "boolean",
"description": "Supports full-text search"
},
"jsonFields": {
"type": "boolean",
"description": "Supports JSON field types"
},
"arrayFields": {
"type": "boolean",
"description": "Supports array field types"
}
},
"required": [
"transactions",
"joins",
"fullTextSearch",
"jsonFields",
"arrayFields"
],
"additionalProperties": false
}
},
"$schema": "http://json-schema.org/draft-07/schema#"
}
59 changes: 59 additions & 0 deletions packages/spec/json-schema/DriverInterface.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
{
"$ref": "#/definitions/DriverInterface",
"definitions": {
"DriverInterface": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Driver name"
},
"version": {
"type": "string",
"description": "Driver version"
},
"supports": {
"type": "object",
"properties": {
"transactions": {
"type": "boolean",
"description": "Supports transactions"
},
"joins": {
"type": "boolean",
"description": "Supports SQL joins"
},
"fullTextSearch": {
"type": "boolean",
"description": "Supports full-text search"
},
"jsonFields": {
"type": "boolean",
"description": "Supports JSON field types"
},
"arrayFields": {
"type": "boolean",
"description": "Supports array field types"
}
},
"required": [
"transactions",
"joins",
"fullTextSearch",
"jsonFields",
"arrayFields"
],
"additionalProperties": false,
"description": "Driver capabilities"
}
},
"required": [
"name",
"version",
"supports"
],
"additionalProperties": false
}
},
"$schema": "http://json-schema.org/draft-07/schema#"
}
Loading
Loading