Skip to content

Commit 02fb21e

Browse files
Copilothotlong
andcommitted
Update ARCHITECTURE.md and field-types.mdx with latest Zod schemas
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 1fa64f8 commit 02fb21e

2 files changed

Lines changed: 77 additions & 14 deletions

File tree

ARCHITECTURE.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,10 @@
6969
│ ├── workflow.zod.ts → State machine, transitions
7070
│ ├── flow.zod.ts → Visual flow automation
7171
│ ├── query.zod.ts → AST for queries (filter, sort, join)
72+
│ ├── filter.zod.ts → Query filter conditions
7273
│ ├── dataset.zod.ts → Virtual datasets
7374
│ ├── mapping.zod.ts → ETL transformations
74-
│ └── trigger.zod.ts → [MISSING] Trigger context
75+
│ └── trigger.zod.ts → Trigger context
7576
7677
├── UI Protocol (ObjectUI)
7778
│ ├── app.zod.ts → App structure, navigation tree
@@ -80,8 +81,8 @@
8081
│ ├── report.zod.ts → Report types, grouping
8182
│ ├── action.zod.ts → Button actions, navigation
8283
│ ├── page.zod.ts → FlexiPage regions, components
83-
│ ├── theme.zod.ts → [MISSING] Color, typography, spacing
84-
│ └── widget.zod.ts → [MISSING] Custom field components
84+
│ ├── theme.zod.ts → Color, typography, spacing
85+
│ └── widget.zod.ts → Custom field components
8586
8687
├── System Protocol (ObjectOS)
8788
│ ├── manifest.zod.ts → Package definition (objectstack.config.ts)
@@ -95,18 +96,24 @@
9596
│ ├── webhook.zod.ts → HTTP callbacks
9697
│ ├── translation.zod.ts → i18n definitions
9798
│ ├── discovery.zod.ts → Metadata introspection
98-
│ ├── plugin.zod.ts → [MISSING] Plugin lifecycle
99-
│ ├── driver.zod.ts → [MISSING] Database driver interface
100-
│ ├── marketplace.zod.ts → [PLANNED] App store metadata
101-
│ ├── tenant.zod.ts → [PLANNED] Multi-tenancy
102-
│ ├── events.zod.ts → [PLANNED] Event bus
103-
│ └── realtime.zod.ts → [PLANNED] WebSocket sync
99+
│ ├── plugin.zod.ts → Plugin lifecycle
100+
│ ├── driver.zod.ts → Database driver interface
101+
│ ├── tenant.zod.ts → Multi-tenancy
102+
│ ├── events.zod.ts → Event bus
103+
│ ├── realtime.zod.ts → WebSocket sync
104+
│ ├── organization.zod.ts → Organization management
105+
│ ├── audit.zod.ts → Audit logging
106+
│ └── job.zod.ts → Background jobs
104107
105108
├── AI Protocol
106-
│ ├── agent.zod.ts → AI agent configuration
107-
│ ├── model.zod.ts → [PLANNED] LLM registry
108-
│ ├── rag.zod.ts → [PLANNED] RAG pipeline
109-
│ └── nlq.zod.ts → [PLANNED] Natural language query
109+
│ ├── agent.zod.ts → AI agent configuration
110+
│ ├── model-registry.zod.ts → LLM registry
111+
│ ├── rag-pipeline.zod.ts → RAG pipeline
112+
│ ├── nlq.zod.ts → Natural language query
113+
│ ├── conversation.zod.ts → Conversation management
114+
│ ├── cost.zod.ts → AI cost tracking
115+
│ ├── predictive.zod.ts → Predictive analytics
116+
│ └── workflow-automation.zod.ts → AI workflow automation
110117
111118
└── API Protocol
112119
└── contract.zod.ts → Request/response envelopes

content/docs/guides/field-types.mdx

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Complete guide to all ObjectStack field types with examples and con
66

77
# Field Types Reference
88

9-
ObjectStack supports **30+ field types** covering text, numbers, dates, selections, relationships, media, calculations, and enhanced types. This guide provides practical examples for each type.
9+
ObjectStack supports **35 field types** covering text, numbers, dates, selections, relationships, media, calculations, and enhanced types. This guide provides practical examples for each type.
1010

1111
## Core Text Fields
1212

@@ -524,6 +524,8 @@ coordinates: Field.location({
524524
})
525525
```
526526

527+
> **Note:** `geolocation` is an alternative name for the `location` field type. Both refer to the same GPS coordinate field.
528+
527529
**Data Structure:**
528530
```typescript
529531
{
@@ -638,6 +640,60 @@ customer_signature: Field.signature({
638640

639641
---
640642

643+
### Slider
644+
Numeric slider for visual value selection.
645+
646+
```typescript
647+
volume: Field.slider({
648+
label: 'Volume Level',
649+
min: 0,
650+
max: 100,
651+
step: 1,
652+
defaultValue: 50,
653+
})
654+
655+
price_range: Field.slider({
656+
label: 'Price Range',
657+
min: 0,
658+
max: 10000,
659+
step: 100,
660+
marks: { 0: '$0', 5000: '$5K', 10000: '$10K' },
661+
})
662+
```
663+
664+
**Configuration:**
665+
- `min` - Minimum value
666+
- `max` - Maximum value
667+
- `step` - Increment step size
668+
- `marks` - Optional labeled markers on the slider
669+
670+
---
671+
672+
### QR Code
673+
QR code / Barcode field for scanning and generation.
674+
675+
```typescript
676+
product_barcode: Field.qrcode({
677+
label: 'Product Barcode',
678+
format: 'qr', // 'qr', 'barcode', 'ean13', 'code128'
679+
readonly: false,
680+
})
681+
682+
ticket_code: Field.qrcode({
683+
label: 'Event Ticket',
684+
format: 'qr',
685+
autoGenerate: true, // Generate on record creation
686+
})
687+
```
688+
689+
**Supported Formats:**
690+
- `qr` - QR Code
691+
- `barcode` - Standard barcode
692+
- `ean13` - EAN-13 barcode
693+
- `code128` - Code 128 barcode
694+
695+
---
696+
641697
## Field Configuration Reference
642698

643699
### Common Properties

0 commit comments

Comments
 (0)