Compare commits
4 Commits
pagelayout
...
worktree-2
| Author | SHA1 | Date | |
|---|---|---|---|
|
2f0aeb948b | ||
|
|
0ad62cbf8d | ||
|
|
5a80f33078 | ||
|
|
57f27d28cd |
1
.env.api
1
.env.api
@@ -2,7 +2,6 @@ NODE_ENV=development
|
|||||||
PORT=3000
|
PORT=3000
|
||||||
|
|
||||||
DATABASE_URL="mysql://platform:platform@db:3306/platform"
|
DATABASE_URL="mysql://platform:platform@db:3306/platform"
|
||||||
CENTRAL_DATABASE_URL="mysql://root:asjdnfqTash37faggT@db:3306/central_platform"
|
|
||||||
REDIS_URL="redis://redis:6379"
|
REDIS_URL="redis://redis:6379"
|
||||||
|
|
||||||
# JWT, multi-tenant hints, etc.
|
# JWT, multi-tenant hints, etc.
|
||||||
|
|||||||
@@ -1,406 +0,0 @@
|
|||||||
# Field Types System Architecture
|
|
||||||
|
|
||||||
## System Overview
|
|
||||||
|
|
||||||
```
|
|
||||||
┌─────────────────────────────────────────────────────────────────┐
|
|
||||||
│ Frontend (Vue 3 + Nuxt) │
|
|
||||||
├─────────────────────────────────────────────────────────────────┤
|
|
||||||
│ │
|
|
||||||
│ ┌───────────────────────────────────────────────────────────┐ │
|
|
||||||
│ │ View Components │ │
|
|
||||||
│ ├───────────────────────────────────────────────────────────┤ │
|
|
||||||
│ │ ListView.vue │ DetailView.vue │ EditView.vue │ │
|
|
||||||
│ │ - Data Table │ - Read Display │ - Form │ │
|
|
||||||
│ │ - Search │ - Sections │ - Validation │ │
|
|
||||||
│ │ - Sort/Filter │ - Actions │ - Sections │ │
|
|
||||||
│ │ - Bulk Actions │ │ │ │
|
|
||||||
│ └────────────────────────┬──────────────────────────────────┘ │
|
|
||||||
│ │ uses │
|
|
||||||
│ ┌────────────────────────▼──────────────────────────────────┐ │
|
|
||||||
│ │ FieldRenderer.vue │ │
|
|
||||||
│ │ Universal component for rendering any field type │ │
|
|
||||||
│ │ - Handles LIST, DETAIL, EDIT modes │ │
|
|
||||||
│ │ - Type-aware rendering │ │
|
|
||||||
│ │ - Validation support │ │
|
|
||||||
│ └────────────────────────┬──────────────────────────────────┘ │
|
|
||||||
│ │ uses │
|
|
||||||
│ ┌────────────────────────▼──────────────────────────────────┐ │
|
|
||||||
│ │ shadcn-vue Components │ │
|
|
||||||
│ │ Input, Textarea, Select, Checkbox, Switch, Calendar, │ │
|
|
||||||
│ │ Table, Badge, Dialog, Popover, etc. │ │
|
|
||||||
│ └───────────────────────────────────────────────────────────┘ │
|
|
||||||
│ │
|
|
||||||
│ ┌───────────────────────────────────────────────────────────┐ │
|
|
||||||
│ │ Composables │ │
|
|
||||||
│ ├───────────────────────────────────────────────────────────┤ │
|
|
||||||
│ │ useFields() │ useViewState() │ │
|
|
||||||
│ │ - Map backend data │ - CRUD operations │ │
|
|
||||||
│ │ - Build configs │ - State management │ │
|
|
||||||
│ │ - Generate sections │ - Navigation │ │
|
|
||||||
│ └───────────────────────────────────────────────────────────┘ │
|
|
||||||
│ │
|
|
||||||
│ ┌───────────────────────────────────────────────────────────┐ │
|
|
||||||
│ │ Type Definitions │ │
|
|
||||||
│ │ field-types.ts - TypeScript interfaces for field system │ │
|
|
||||||
│ └───────────────────────────────────────────────────────────┘ │
|
|
||||||
└─────────────────────────────────────────────────────────────────┘
|
|
||||||
│
|
|
||||||
│ HTTP/REST API
|
|
||||||
▼
|
|
||||||
┌─────────────────────────────────────────────────────────────────┐
|
|
||||||
│ Backend (NestJS) │
|
|
||||||
├─────────────────────────────────────────────────────────────────┤
|
|
||||||
│ │
|
|
||||||
│ ┌───────────────────────────────────────────────────────────┐ │
|
|
||||||
│ │ Controllers │ │
|
|
||||||
│ ├───────────────────────────────────────────────────────────┤ │
|
|
||||||
│ │ SetupObjectController │ RuntimeObjectController │ │
|
|
||||||
│ │ - GET /objects │ - GET /objects/:name │ │
|
|
||||||
│ │ - GET /objects/:name │ - GET /objects/:name/:id │ │
|
|
||||||
│ │ - GET /ui-config ✨ │ - POST /objects/:name │ │
|
|
||||||
│ │ - POST /objects │ - PUT /objects/:name/:id │ │
|
|
||||||
│ └────────────────────────┬────────────────┬─────────────────┘ │
|
|
||||||
│ │ │ │
|
|
||||||
│ ┌────────────────────────▼────────────────▼─────────────────┐ │
|
|
||||||
│ │ Services │ │
|
|
||||||
│ ├───────────────────────────────────────────────────────────┤ │
|
|
||||||
│ │ ObjectService │ FieldMapperService ✨ │ │
|
|
||||||
│ │ - CRUD operations │ - Map field definitions │ │
|
|
||||||
│ │ - Query building │ - Generate UI configs │ │
|
|
||||||
│ │ - Validation │ - Default metadata │ │
|
|
||||||
│ └────────────────────────┬──────────────────────────────────┘ │
|
|
||||||
│ │ │
|
|
||||||
│ ┌────────────────────────▼──────────────────────────────────┐ │
|
|
||||||
│ │ Models │ │
|
|
||||||
│ │ ObjectDefinition │ FieldDefinition ✨ │ │
|
|
||||||
│ │ - Object metadata │ - Field metadata │ │
|
|
||||||
│ │ │ - UIMetadata interface │ │
|
|
||||||
│ └───────────────────────────────────────────────────────────┘ │
|
|
||||||
└─────────────────────────────────────────────────────────────────┘
|
|
||||||
│
|
|
||||||
│ Prisma/Knex
|
|
||||||
▼
|
|
||||||
┌─────────────────────────────────────────────────────────────────┐
|
|
||||||
│ Database (PostgreSQL) │
|
|
||||||
├─────────────────────────────────────────────────────────────────┤
|
|
||||||
│ │
|
|
||||||
│ ┌───────────────────────────────────────────────────────────┐ │
|
|
||||||
│ │ object_definitions │ │
|
|
||||||
│ │ - id, tenant_id, api_name, label, plural_label │ │
|
|
||||||
│ │ - description, is_system, table_name │ │
|
|
||||||
│ └───────────────────────────────────────────────────────────┘ │
|
|
||||||
│ │ │
|
|
||||||
│ │ 1:many │
|
|
||||||
│ ▼ │
|
|
||||||
│ ┌───────────────────────────────────────────────────────────┐ │
|
|
||||||
│ │ field_definitions │ │
|
|
||||||
│ │ - id, object_definition_id, api_name, label, type │ │
|
|
||||||
│ │ - is_required, is_unique, is_system │ │
|
|
||||||
│ │ - ui_metadata (JSONB) ✨ NEW │ │
|
|
||||||
│ │ { │ │
|
|
||||||
│ │ placeholder, helpText, showOnList, showOnDetail, │ │
|
|
||||||
│ │ showOnEdit, sortable, options, rows, min, max, │ │
|
|
||||||
│ │ validationRules, format, prefix, suffix, etc. │ │
|
|
||||||
│ │ } │ │
|
|
||||||
│ └───────────────────────────────────────────────────────────┘ │
|
|
||||||
└─────────────────────────────────────────────────────────────────┘
|
|
||||||
|
|
||||||
✨ = New/Enhanced component
|
|
||||||
```
|
|
||||||
|
|
||||||
## Data Flow
|
|
||||||
|
|
||||||
### 1. Loading Object Definition
|
|
||||||
|
|
||||||
```
|
|
||||||
┌──────────┐ GET /api/setup/objects/Contact/ui-config ┌──────────┐
|
|
||||||
│ │ ──────────────────────────────────────────────────> │ │
|
|
||||||
│ Frontend │ │ Backend │
|
|
||||||
│ │ <────────────────────────────────────────────────── │ │
|
|
||||||
└──────────┘ { objectDef with mapped fields } └──────────┘
|
|
||||||
│
|
|
||||||
│ useFields().buildListViewConfig(objectDef)
|
|
||||||
▼
|
|
||||||
┌──────────────────────────────────────┐
|
|
||||||
│ ListViewConfig │
|
|
||||||
│ - objectApiName: "Contact" │
|
|
||||||
│ - mode: "list" │
|
|
||||||
│ - fields: [ │
|
|
||||||
│ { │
|
|
||||||
│ apiName: "firstName", │
|
|
||||||
│ type: "text", │
|
|
||||||
│ showOnList: true, │
|
|
||||||
│ ... │
|
|
||||||
│ } │
|
|
||||||
│ ] │
|
|
||||||
└──────────────────────────────────────┘
|
|
||||||
│
|
|
||||||
│ Pass to ListView component
|
|
||||||
▼
|
|
||||||
┌──────────────────────────────────────┐
|
|
||||||
│ ListView renders data table │
|
|
||||||
└──────────────────────────────────────┘
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2. Fetching Records
|
|
||||||
|
|
||||||
```
|
|
||||||
┌──────────┐ GET /api/runtime/objects/Contact ┌──────────┐
|
|
||||||
│ │ ──────────────────────────────────────────────────> │ │
|
|
||||||
│ Frontend │ │ Backend │
|
|
||||||
│ │ <────────────────────────────────────────────────── │ │
|
|
||||||
└──────────┘ [{ id, firstName, lastName, ... }] └──────────┘
|
|
||||||
│
|
|
||||||
▼
|
|
||||||
┌──────────────────────────────────────┐
|
|
||||||
│ ListView displays records │
|
|
||||||
│ Each field rendered by │
|
|
||||||
│ FieldRenderer with mode="list" │
|
|
||||||
└──────────────────────────────────────┘
|
|
||||||
```
|
|
||||||
|
|
||||||
### 3. Field Rendering
|
|
||||||
|
|
||||||
```
|
|
||||||
┌─────────────────────────────────────────────────────────────┐
|
|
||||||
│ FieldRenderer │
|
|
||||||
│ Props: { field, modelValue, mode } │
|
|
||||||
└────────────────────────┬────────────────────────────────────┘
|
|
||||||
│
|
|
||||||
┌────────────────┼────────────────┐
|
|
||||||
│ │ │
|
|
||||||
▼ ▼ ▼
|
|
||||||
mode="list" mode="detail" mode="edit"
|
|
||||||
│ │ │
|
|
||||||
▼ ▼ ▼
|
|
||||||
Simple text Formatted Input component
|
|
||||||
or badge display with based on type:
|
|
||||||
display labels - Input
|
|
||||||
- Textarea
|
|
||||||
- Select
|
|
||||||
- DatePicker
|
|
||||||
- Checkbox
|
|
||||||
- etc.
|
|
||||||
```
|
|
||||||
|
|
||||||
### 4. Saving Record
|
|
||||||
|
|
||||||
```
|
|
||||||
┌──────────┐ ┌──────────┐
|
|
||||||
│ EditView │ ──> User fills form ──> Validation │ │
|
|
||||||
│ │ │ │ │
|
|
||||||
│ │ ▼ │ │
|
|
||||||
│ │ Valid? │ │
|
|
||||||
│ │ ✓ Yes │ │
|
|
||||||
│ │ @save event │ │ │
|
|
||||||
│ │ ──────────────────────────┘ │ │
|
|
||||||
│ │ │ │
|
|
||||||
│ │ POST/PUT /api/runtime/objects/Contact/:id │ Backend │
|
|
||||||
│ Frontend │ ──────────────────────────────────────────────────> │ │
|
|
||||||
│ │ │ │
|
|
||||||
│ │ <────────────────────────────────────────────────── │ │
|
|
||||||
│ │ { saved record } │ │
|
|
||||||
│ │ │ │
|
|
||||||
│ │ ──> Navigate to DetailView │ │
|
|
||||||
└──────────┘ └──────────┘
|
|
||||||
```
|
|
||||||
|
|
||||||
## Component Hierarchy
|
|
||||||
|
|
||||||
```
|
|
||||||
Page/App
|
|
||||||
└── ObjectViewContainer
|
|
||||||
├── ListView
|
|
||||||
│ ├── Search/Filters
|
|
||||||
│ ├── Table
|
|
||||||
│ │ ├── TableHeader
|
|
||||||
│ │ │ └── Sortable columns
|
|
||||||
│ │ └── TableBody
|
|
||||||
│ │ └── TableRow (for each record)
|
|
||||||
│ │ └── TableCell (for each field)
|
|
||||||
│ │ └── FieldRenderer (mode="list")
|
|
||||||
│ └── Actions (Create, Export, etc.)
|
|
||||||
│
|
|
||||||
├── DetailView
|
|
||||||
│ ├── Header with actions
|
|
||||||
│ └── Sections
|
|
||||||
│ └── Card (for each section)
|
|
||||||
│ └── FieldRenderer (mode="detail") for each field
|
|
||||||
│
|
|
||||||
└── EditView
|
|
||||||
├── Header with Save/Cancel
|
|
||||||
└── Form
|
|
||||||
└── Sections
|
|
||||||
└── Card (for each section)
|
|
||||||
└── FieldRenderer (mode="edit") for each field
|
|
||||||
└── Input component based on field type
|
|
||||||
```
|
|
||||||
|
|
||||||
## Field Type Mapping
|
|
||||||
|
|
||||||
```
|
|
||||||
Database Type → FieldType Enum → Component (Edit Mode)
|
|
||||||
─────────────────────────────────────────────────────────
|
|
||||||
string → TEXT → Input[type="text"]
|
|
||||||
text → TEXTAREA → Textarea
|
|
||||||
email → EMAIL → Input[type="email"]
|
|
||||||
url → URL → Input[type="url"]
|
|
||||||
integer → NUMBER → Input[type="number"]
|
|
||||||
decimal → NUMBER → Input[type="number"]
|
|
||||||
currency → CURRENCY → Input[type="number"] + prefix
|
|
||||||
boolean → BOOLEAN → Checkbox
|
|
||||||
date → DATE → DatePicker
|
|
||||||
datetime → DATETIME → DatePicker (with time)
|
|
||||||
picklist → SELECT → Select
|
|
||||||
multipicklist → MULTI_SELECT → Select[multiple]
|
|
||||||
lookup → BELONGS_TO → Combobox (relation picker)
|
|
||||||
file → FILE → FileUpload
|
|
||||||
image → IMAGE → ImageUpload
|
|
||||||
richtext → MARKDOWN → Textarea (+ preview)
|
|
||||||
json → JSON → Textarea (JSON editor)
|
|
||||||
```
|
|
||||||
|
|
||||||
## View Mode Rendering
|
|
||||||
|
|
||||||
```
|
|
||||||
Field Type: TEXT
|
|
||||||
─────────────────────────────────────────────────────
|
|
||||||
LIST mode │ Simple text, truncated
|
|
||||||
│ <span>{{ value }}</span>
|
|
||||||
─────────────────────────────────────────────────────
|
|
||||||
DETAIL mode │ Text with label
|
|
||||||
│ <div>
|
|
||||||
│ <Label>Name</Label>
|
|
||||||
│ <span>{{ value }}</span>
|
|
||||||
│ </div>
|
|
||||||
─────────────────────────────────────────────────────
|
|
||||||
EDIT mode │ Input field
|
|
||||||
│ <Input v-model="value" />
|
|
||||||
─────────────────────────────────────────────────────
|
|
||||||
|
|
||||||
Field Type: BOOLEAN
|
|
||||||
─────────────────────────────────────────────────────
|
|
||||||
LIST mode │ Badge (Yes/No)
|
|
||||||
│ <Badge>Yes</Badge>
|
|
||||||
─────────────────────────────────────────────────────
|
|
||||||
DETAIL mode │ Checkbox (disabled) + text
|
|
||||||
│ <Checkbox :checked="value" disabled />
|
|
||||||
│ <span>Yes</span>
|
|
||||||
─────────────────────────────────────────────────────
|
|
||||||
EDIT mode │ Checkbox (editable)
|
|
||||||
│ <Checkbox v-model="value" />
|
|
||||||
─────────────────────────────────────────────────────
|
|
||||||
|
|
||||||
Field Type: SELECT
|
|
||||||
─────────────────────────────────────────────────────
|
|
||||||
LIST mode │ Selected label
|
|
||||||
│ <span>Active</span>
|
|
||||||
─────────────────────────────────────────────────────
|
|
||||||
DETAIL mode │ Selected label with styling
|
|
||||||
│ <Badge>Active</Badge>
|
|
||||||
─────────────────────────────────────────────────────
|
|
||||||
EDIT mode │ Dropdown select
|
|
||||||
│ <Select v-model="value">
|
|
||||||
│ <SelectItem value="active">Active</SelectItem>
|
|
||||||
│ </Select>
|
|
||||||
─────────────────────────────────────────────────────
|
|
||||||
```
|
|
||||||
|
|
||||||
## API Endpoints
|
|
||||||
|
|
||||||
```
|
|
||||||
Setup/Configuration (Metadata)
|
|
||||||
────────────────────────────────────────────────────
|
|
||||||
GET /api/setup/objects
|
|
||||||
Returns: List of all object definitions
|
|
||||||
|
|
||||||
GET /api/setup/objects/:objectName
|
|
||||||
Returns: Object definition with fields
|
|
||||||
|
|
||||||
GET /api/setup/objects/:objectName/ui-config ✨
|
|
||||||
Returns: Object definition with UI-ready field configs
|
|
||||||
(fields mapped to frontend format with UIMetadata)
|
|
||||||
|
|
||||||
POST /api/setup/objects
|
|
||||||
Body: { apiName, label, description, ... }
|
|
||||||
Returns: Created object definition
|
|
||||||
|
|
||||||
POST /api/setup/objects/:objectName/fields
|
|
||||||
Body: { apiName, label, type, uiMetadata, ... }
|
|
||||||
Returns: Created field definition
|
|
||||||
|
|
||||||
Runtime (Data CRUD)
|
|
||||||
────────────────────────────────────────────────────
|
|
||||||
GET /api/runtime/objects/:objectName
|
|
||||||
Query: { search, filters, page, pageSize }
|
|
||||||
Returns: Array of records
|
|
||||||
|
|
||||||
GET /api/runtime/objects/:objectName/:recordId
|
|
||||||
Returns: Single record
|
|
||||||
|
|
||||||
POST /api/runtime/objects/:objectName
|
|
||||||
Body: { field1: value1, field2: value2, ... }
|
|
||||||
Returns: Created record
|
|
||||||
|
|
||||||
PUT /api/runtime/objects/:objectName/:recordId
|
|
||||||
Body: { field1: value1, field2: value2, ... }
|
|
||||||
Returns: Updated record
|
|
||||||
|
|
||||||
DELETE /api/runtime/objects/:objectName/:recordId
|
|
||||||
Returns: Success status
|
|
||||||
```
|
|
||||||
|
|
||||||
## Key Features
|
|
||||||
|
|
||||||
### Frontend
|
|
||||||
- ✅ Universal field renderer for 15+ field types
|
|
||||||
- ✅ Three view modes (list, detail, edit)
|
|
||||||
- ✅ Client-side validation with custom rules
|
|
||||||
- ✅ Responsive design (mobile-friendly)
|
|
||||||
- ✅ Accessible components (WCAG compliant)
|
|
||||||
- ✅ Type-safe with TypeScript
|
|
||||||
- ✅ Composables for easy integration
|
|
||||||
- ✅ Demo page for testing
|
|
||||||
|
|
||||||
### Backend
|
|
||||||
- ✅ UI metadata stored in JSONB column
|
|
||||||
- ✅ Field mapper service for transformation
|
|
||||||
- ✅ Default metadata generation
|
|
||||||
- ✅ Validation rule support
|
|
||||||
- ✅ Flexible field type system
|
|
||||||
- ✅ Multi-tenant support
|
|
||||||
- ✅ RESTful API
|
|
||||||
|
|
||||||
### Database
|
|
||||||
- ✅ Flexible schema with JSONB metadata
|
|
||||||
- ✅ Support for custom objects
|
|
||||||
- ✅ Versioning and migration support
|
|
||||||
- ✅ Indexed for performance
|
|
||||||
|
|
||||||
## Extension Points
|
|
||||||
|
|
||||||
```
|
|
||||||
1. Custom Field Types
|
|
||||||
└─> Add to FieldType enum
|
|
||||||
└─> Add rendering logic to FieldRenderer.vue
|
|
||||||
└─> Add mapping in FieldMapperService
|
|
||||||
|
|
||||||
2. Custom Validation Rules
|
|
||||||
└─> Add to ValidationRule type
|
|
||||||
└─> Add validation logic in EditView.vue
|
|
||||||
|
|
||||||
3. Custom Actions
|
|
||||||
└─> Add to ViewAction interface
|
|
||||||
└─> Handle in view components
|
|
||||||
|
|
||||||
4. Custom Sections
|
|
||||||
└─> Configure in DetailViewConfig/EditViewConfig
|
|
||||||
└─> Auto-generation in useFields()
|
|
||||||
|
|
||||||
5. Custom Formatting
|
|
||||||
└─> Add to UIMetadata
|
|
||||||
└─> Implement in FieldRenderer.vue
|
|
||||||
```
|
|
||||||
|
|
||||||
This architecture provides a scalable, maintainable, and extensible system for building dynamic forms and views! 🎉
|
|
||||||
@@ -1,282 +0,0 @@
|
|||||||
# Field Types System - Implementation Checklist
|
|
||||||
|
|
||||||
Use this checklist to ensure proper implementation of the field type system in your production environment.
|
|
||||||
|
|
||||||
## ✅ Backend Setup
|
|
||||||
|
|
||||||
### Database
|
|
||||||
- [ ] Run migration: `npm run migrate:tenant` to add `ui_metadata` column
|
|
||||||
- [ ] Verify migration succeeded: Check `field_definitions` table has `ui_metadata` column
|
|
||||||
- [ ] (Optional) Run seed: `knex seed:run --specific=example_account_fields_with_ui_metadata.js`
|
|
||||||
- [ ] Test database access with sample queries
|
|
||||||
|
|
||||||
### Services
|
|
||||||
- [ ] Verify `FieldMapperService` is registered in `ObjectModule`
|
|
||||||
- [ ] Test field mapping: Call `mapFieldDefinitionToConfig()` with sample field
|
|
||||||
- [ ] Verify default UI metadata generation works
|
|
||||||
- [ ] Test `mapObjectDefinitionToDTO()` with full object
|
|
||||||
|
|
||||||
### Controllers
|
|
||||||
- [ ] Verify `/api/setup/objects/:objectName/ui-config` endpoint works
|
|
||||||
- [ ] Test endpoint returns properly formatted field configs
|
|
||||||
- [ ] Verify authentication/authorization works on endpoints
|
|
||||||
- [ ] Test with different tenant IDs
|
|
||||||
|
|
||||||
### Models
|
|
||||||
- [ ] Confirm `FieldDefinition` model has `uiMetadata` property
|
|
||||||
- [ ] Verify `UIMetadata` interface is properly typed
|
|
||||||
- [ ] Test CRUD operations with UI metadata
|
|
||||||
|
|
||||||
## ✅ Frontend Setup
|
|
||||||
|
|
||||||
### Dependencies
|
|
||||||
- [ ] Verify all shadcn-vue components are installed
|
|
||||||
- [ ] Check: `table`, `input`, `select`, `checkbox`, `switch`, `textarea`, `calendar`, `badge`, `dialog`
|
|
||||||
- [ ] Confirm `components.json` is properly configured
|
|
||||||
- [ ] Test component imports work
|
|
||||||
|
|
||||||
### Type Definitions
|
|
||||||
- [ ] Verify `/frontend/types/field-types.ts` exists
|
|
||||||
- [ ] Check all `FieldType` enum values are defined
|
|
||||||
- [ ] Verify interface exports work across components
|
|
||||||
- [ ] Test TypeScript compilation with no errors
|
|
||||||
|
|
||||||
### Components
|
|
||||||
- [ ] Test `FieldRenderer.vue` with all field types
|
|
||||||
- [ ] Verify `ListView.vue` renders data table correctly
|
|
||||||
- [ ] Test `DetailView.vue` with sections and collapsibles
|
|
||||||
- [ ] Verify `EditView.vue` form validation works
|
|
||||||
- [ ] Test `DatePicker.vue` component
|
|
||||||
|
|
||||||
### Composables
|
|
||||||
- [ ] Test `useFields()` mapping functions
|
|
||||||
- [ ] Verify `useViewState()` CRUD operations
|
|
||||||
- [ ] Test state management and navigation
|
|
||||||
- [ ] Verify error handling works
|
|
||||||
|
|
||||||
### Pages
|
|
||||||
- [ ] Test demo page at `/demo/field-views`
|
|
||||||
- [ ] Verify dynamic route at `/app/objects/:objectName`
|
|
||||||
- [ ] Test all three views (list, detail, edit)
|
|
||||||
- [ ] Verify navigation between views works
|
|
||||||
|
|
||||||
## ✅ Integration Testing
|
|
||||||
|
|
||||||
### End-to-End Flows
|
|
||||||
- [ ] Create new object definition via API
|
|
||||||
- [ ] Add fields with UI metadata
|
|
||||||
- [ ] Fetch object UI config from frontend
|
|
||||||
- [ ] Render ListView with real data
|
|
||||||
- [ ] Click row to view DetailView
|
|
||||||
- [ ] Click edit to view EditView
|
|
||||||
- [ ] Submit form and verify save works
|
|
||||||
- [ ] Delete record and verify it's removed
|
|
||||||
|
|
||||||
### Field Type Testing
|
|
||||||
Test each field type in all three modes:
|
|
||||||
|
|
||||||
#### Text Fields
|
|
||||||
- [ ] TEXT - List, Detail, Edit modes
|
|
||||||
- [ ] TEXTAREA - List, Detail, Edit modes
|
|
||||||
- [ ] PASSWORD - Edit mode (masked)
|
|
||||||
- [ ] EMAIL - All modes with validation
|
|
||||||
- [ ] URL - All modes with validation
|
|
||||||
|
|
||||||
#### Numeric Fields
|
|
||||||
- [ ] NUMBER - All modes
|
|
||||||
- [ ] CURRENCY - All modes with prefix/suffix
|
|
||||||
|
|
||||||
#### Selection Fields
|
|
||||||
- [ ] SELECT - All modes with options
|
|
||||||
- [ ] MULTI_SELECT - All modes with options
|
|
||||||
- [ ] BOOLEAN - All modes (badge, checkbox)
|
|
||||||
|
|
||||||
#### Date/Time Fields
|
|
||||||
- [ ] DATE - All modes with date picker
|
|
||||||
- [ ] DATETIME - All modes with date/time picker
|
|
||||||
|
|
||||||
### Validation Testing
|
|
||||||
- [ ] Required field validation
|
|
||||||
- [ ] Email format validation
|
|
||||||
- [ ] URL format validation
|
|
||||||
- [ ] Min/max length validation
|
|
||||||
- [ ] Min/max value validation
|
|
||||||
- [ ] Pattern matching validation
|
|
||||||
- [ ] Custom validation rules
|
|
||||||
|
|
||||||
### UI/UX Testing
|
|
||||||
- [ ] Responsive design on mobile devices
|
|
||||||
- [ ] Keyboard navigation works
|
|
||||||
- [ ] Focus management is correct
|
|
||||||
- [ ] Loading states display properly
|
|
||||||
- [ ] Error messages are clear
|
|
||||||
- [ ] Success feedback is visible
|
|
||||||
- [ ] Tooltips and help text display
|
|
||||||
|
|
||||||
## ✅ Performance Testing
|
|
||||||
|
|
||||||
### Frontend
|
|
||||||
- [ ] ListView handles 100+ records smoothly
|
|
||||||
- [ ] Sorting is fast
|
|
||||||
- [ ] Search is responsive
|
|
||||||
- [ ] Form submission is snappy
|
|
||||||
- [ ] No memory leaks on navigation
|
|
||||||
- [ ] Component re-renders are optimized
|
|
||||||
|
|
||||||
### Backend
|
|
||||||
- [ ] Field mapping is performant
|
|
||||||
- [ ] Database queries are optimized
|
|
||||||
- [ ] API response times are acceptable
|
|
||||||
- [ ] Bulk operations handle multiple records
|
|
||||||
- [ ] Concurrent requests handled properly
|
|
||||||
|
|
||||||
## ✅ Security Checklist
|
|
||||||
|
|
||||||
### Authentication
|
|
||||||
- [ ] All API endpoints require authentication
|
|
||||||
- [ ] JWT tokens are validated
|
|
||||||
- [ ] Tenant isolation is enforced
|
|
||||||
- [ ] User permissions are checked
|
|
||||||
|
|
||||||
### Authorization
|
|
||||||
- [ ] Read permissions enforced
|
|
||||||
- [ ] Write permissions enforced
|
|
||||||
- [ ] Delete permissions enforced
|
|
||||||
- [ ] Field-level security (if needed)
|
|
||||||
|
|
||||||
### Input Validation
|
|
||||||
- [ ] Server-side validation on all inputs
|
|
||||||
- [ ] SQL injection prevention
|
|
||||||
- [ ] XSS prevention in field values
|
|
||||||
- [ ] CSRF protection enabled
|
|
||||||
|
|
||||||
### Data Protection
|
|
||||||
- [ ] Sensitive fields masked appropriately
|
|
||||||
- [ ] Audit logging for changes
|
|
||||||
- [ ] Data encryption at rest (if needed)
|
|
||||||
- [ ] Proper error messages (no leaking)
|
|
||||||
|
|
||||||
## ✅ Documentation
|
|
||||||
|
|
||||||
### Code Documentation
|
|
||||||
- [ ] JSDoc comments on key functions
|
|
||||||
- [ ] TypeScript interfaces documented
|
|
||||||
- [ ] Complex logic explained with comments
|
|
||||||
- [ ] README files in each major directory
|
|
||||||
|
|
||||||
### User Documentation
|
|
||||||
- [ ] Quick start guide available
|
|
||||||
- [ ] Field types reference documented
|
|
||||||
- [ ] API endpoints documented
|
|
||||||
- [ ] Common use cases documented
|
|
||||||
- [ ] Troubleshooting guide available
|
|
||||||
|
|
||||||
## ✅ Production Readiness
|
|
||||||
|
|
||||||
### Deployment
|
|
||||||
- [ ] Environment variables configured
|
|
||||||
- [ ] Database connection verified
|
|
||||||
- [ ] API endpoints accessible
|
|
||||||
- [ ] Frontend build succeeds
|
|
||||||
- [ ] Assets are served correctly
|
|
||||||
|
|
||||||
### Monitoring
|
|
||||||
- [ ] Error tracking configured (Sentry, etc.)
|
|
||||||
- [ ] Performance monitoring enabled
|
|
||||||
- [ ] API rate limiting configured
|
|
||||||
- [ ] Log aggregation set up
|
|
||||||
- [ ] Alerts configured for critical issues
|
|
||||||
|
|
||||||
### Backup & Recovery
|
|
||||||
- [ ] Database backup strategy defined
|
|
||||||
- [ ] Recovery procedures documented
|
|
||||||
- [ ] Migration rollback tested
|
|
||||||
- [ ] Data export functionality works
|
|
||||||
|
|
||||||
### Scaling
|
|
||||||
- [ ] Database indexes optimized
|
|
||||||
- [ ] API caching strategy defined
|
|
||||||
- [ ] CDN configured for static assets
|
|
||||||
- [ ] Load balancing tested (if applicable)
|
|
||||||
|
|
||||||
## ✅ Quality Assurance
|
|
||||||
|
|
||||||
### Testing Coverage
|
|
||||||
- [ ] Unit tests for services
|
|
||||||
- [ ] Integration tests for API endpoints
|
|
||||||
- [ ] Component tests for views
|
|
||||||
- [ ] E2E tests for critical flows
|
|
||||||
- [ ] Test coverage > 70%
|
|
||||||
|
|
||||||
### Code Quality
|
|
||||||
- [ ] Linting passes with no errors
|
|
||||||
- [ ] TypeScript strict mode enabled
|
|
||||||
- [ ] Code reviews completed
|
|
||||||
- [ ] No console errors in production
|
|
||||||
- [ ] Accessibility audit passed
|
|
||||||
|
|
||||||
### Browser Compatibility
|
|
||||||
- [ ] Chrome/Chromium tested
|
|
||||||
- [ ] Firefox tested
|
|
||||||
- [ ] Safari tested
|
|
||||||
- [ ] Edge tested
|
|
||||||
- [ ] Mobile browsers tested
|
|
||||||
|
|
||||||
## ✅ Maintenance Plan
|
|
||||||
|
|
||||||
### Regular Tasks
|
|
||||||
- [ ] Dependency updates scheduled
|
|
||||||
- [ ] Security patches applied promptly
|
|
||||||
- [ ] Performance monitoring reviewed
|
|
||||||
- [ ] User feedback collected
|
|
||||||
- [ ] Bug fix process defined
|
|
||||||
|
|
||||||
### Future Enhancements
|
|
||||||
- [ ] Custom field types roadmap
|
|
||||||
- [ ] Advanced validation rules planned
|
|
||||||
- [ ] Relationship field implementation
|
|
||||||
- [ ] File upload functionality
|
|
||||||
- [ ] Rich text editor integration
|
|
||||||
|
|
||||||
## 🎯 Success Criteria
|
|
||||||
|
|
||||||
Your field type system is production-ready when:
|
|
||||||
|
|
||||||
- ✅ All backend endpoints return correct data
|
|
||||||
- ✅ All frontend views render without errors
|
|
||||||
- ✅ All field types display correctly in all modes
|
|
||||||
- ✅ Form validation works as expected
|
|
||||||
- ✅ CRUD operations complete successfully
|
|
||||||
- ✅ Performance meets requirements
|
|
||||||
- ✅ Security measures are in place
|
|
||||||
- ✅ Documentation is complete
|
|
||||||
- ✅ Team is trained on usage
|
|
||||||
- ✅ Monitoring is active
|
|
||||||
|
|
||||||
## 📝 Sign-Off
|
|
||||||
|
|
||||||
Once all items are checked, have the following team members sign off:
|
|
||||||
|
|
||||||
- [ ] Backend Developer: _________________ Date: _______
|
|
||||||
- [ ] Frontend Developer: ________________ Date: _______
|
|
||||||
- [ ] QA Engineer: ______________________ Date: _______
|
|
||||||
- [ ] DevOps Engineer: ___________________ Date: _______
|
|
||||||
- [ ] Product Manager: ___________________ Date: _______
|
|
||||||
|
|
||||||
## 🚀 Launch Readiness
|
|
||||||
|
|
||||||
- [ ] All checklist items completed
|
|
||||||
- [ ] Stakeholders notified
|
|
||||||
- [ ] Launch date confirmed
|
|
||||||
- [ ] Rollback plan prepared
|
|
||||||
- [ ] Support team briefed
|
|
||||||
|
|
||||||
**Ready for production!** 🎉
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Notes:**
|
|
||||||
- Keep this checklist updated as new features are added
|
|
||||||
- Review quarterly for improvements
|
|
||||||
- Share learnings with the team
|
|
||||||
- Celebrate successes! 🎊
|
|
||||||
@@ -1,479 +0,0 @@
|
|||||||
# Field Types & Views System
|
|
||||||
|
|
||||||
A comprehensive field type system inspired by Laravel Nova, built with Vue 3 and shadcn-vue components. This system provides a flexible way to define and render fields in list, detail, and edit views.
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
The system consists of:
|
|
||||||
|
|
||||||
1. **Field Type Definitions** - TypeScript types and enums defining all available field types
|
|
||||||
2. **Field Renderer** - A universal component that renders fields based on type and view mode
|
|
||||||
3. **View Components** - ListView (data table), DetailView, and EditView components
|
|
||||||
4. **Composables** - Utilities for working with fields and managing CRUD operations
|
|
||||||
5. **Backend Support** - Extended field definitions with UI metadata
|
|
||||||
|
|
||||||
## Field Types
|
|
||||||
|
|
||||||
### Text Fields
|
|
||||||
- `TEXT` - Single-line text input
|
|
||||||
- `TEXTAREA` - Multi-line text input
|
|
||||||
- `PASSWORD` - Password input (masked)
|
|
||||||
- `EMAIL` - Email input with validation
|
|
||||||
- `URL` - URL input
|
|
||||||
|
|
||||||
### Numeric Fields
|
|
||||||
- `NUMBER` - Numeric input
|
|
||||||
- `CURRENCY` - Currency input with formatting
|
|
||||||
|
|
||||||
### Selection Fields
|
|
||||||
- `SELECT` - Dropdown select
|
|
||||||
- `MULTI_SELECT` - Multi-select dropdown
|
|
||||||
- `BOOLEAN` - Checkbox/switch
|
|
||||||
|
|
||||||
### Date/Time Fields
|
|
||||||
- `DATE` - Date picker
|
|
||||||
- `DATETIME` - Date and time picker
|
|
||||||
- `TIME` - Time picker
|
|
||||||
|
|
||||||
### Relationship Fields
|
|
||||||
- `BELONGS_TO` - Many-to-one relationship
|
|
||||||
- `HAS_MANY` - One-to-many relationship
|
|
||||||
- `MANY_TO_MANY` - Many-to-many relationship
|
|
||||||
|
|
||||||
### Rich Content
|
|
||||||
- `MARKDOWN` - Markdown editor
|
|
||||||
- `CODE` - Code editor
|
|
||||||
|
|
||||||
### File Fields
|
|
||||||
- `FILE` - File upload
|
|
||||||
- `IMAGE` - Image upload
|
|
||||||
|
|
||||||
### Other
|
|
||||||
- `COLOR` - Color picker
|
|
||||||
- `JSON` - JSON editor
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
### Basic Example
|
|
||||||
|
|
||||||
```vue
|
|
||||||
<script setup lang="ts">
|
|
||||||
import { ListView, DetailView, EditView } from '@/components/views'
|
|
||||||
import { FieldType, ViewMode } from '@/types/field-types'
|
|
||||||
|
|
||||||
// Define your fields
|
|
||||||
const fields = [
|
|
||||||
{
|
|
||||||
id: '1',
|
|
||||||
apiName: 'name',
|
|
||||||
label: 'Name',
|
|
||||||
type: FieldType.TEXT,
|
|
||||||
isRequired: true,
|
|
||||||
placeholder: 'Enter name',
|
|
||||||
showOnList: true,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
id: '2',
|
|
||||||
apiName: 'email',
|
|
||||||
label: 'Email',
|
|
||||||
type: FieldType.EMAIL,
|
|
||||||
isRequired: true,
|
|
||||||
validationRules: [
|
|
||||||
{ type: 'email', message: 'Invalid email format' }
|
|
||||||
],
|
|
||||||
},
|
|
||||||
{
|
|
||||||
id: '3',
|
|
||||||
apiName: 'status',
|
|
||||||
label: 'Status',
|
|
||||||
type: FieldType.SELECT,
|
|
||||||
options: [
|
|
||||||
{ label: 'Active', value: 'active' },
|
|
||||||
{ label: 'Inactive', value: 'inactive' },
|
|
||||||
],
|
|
||||||
},
|
|
||||||
]
|
|
||||||
|
|
||||||
// Create view config
|
|
||||||
const listConfig = {
|
|
||||||
objectApiName: 'Contact',
|
|
||||||
mode: ViewMode.LIST,
|
|
||||||
fields,
|
|
||||||
searchable: true,
|
|
||||||
exportable: true,
|
|
||||||
}
|
|
||||||
|
|
||||||
const data = ref([])
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<ListView
|
|
||||||
:config="listConfig"
|
|
||||||
:data="data"
|
|
||||||
selectable
|
|
||||||
@row-click="handleRowClick"
|
|
||||||
@create="handleCreate"
|
|
||||||
/>
|
|
||||||
</template>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Using with Backend Data
|
|
||||||
|
|
||||||
```vue
|
|
||||||
<script setup lang="ts">
|
|
||||||
import { useFields, useViewState } from '@/composables/useFieldViews'
|
|
||||||
import { ListView } from '@/components/views'
|
|
||||||
|
|
||||||
const { buildListViewConfig } = useFields()
|
|
||||||
const {
|
|
||||||
records,
|
|
||||||
loading,
|
|
||||||
fetchRecords,
|
|
||||||
showDetail,
|
|
||||||
showEdit,
|
|
||||||
deleteRecords
|
|
||||||
} = useViewState('/api/contacts')
|
|
||||||
|
|
||||||
// Fetch object definition from backend
|
|
||||||
const objectDef = await $fetch('/api/objects/contact')
|
|
||||||
|
|
||||||
// Build view config from backend data
|
|
||||||
const listConfig = buildListViewConfig(objectDef, {
|
|
||||||
searchable: true,
|
|
||||||
exportable: true,
|
|
||||||
})
|
|
||||||
|
|
||||||
// Fetch records
|
|
||||||
await fetchRecords()
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<ListView
|
|
||||||
:config="listConfig"
|
|
||||||
:data="records"
|
|
||||||
:loading="loading"
|
|
||||||
@row-click="showDetail"
|
|
||||||
@create="showEdit"
|
|
||||||
@delete="deleteRecords"
|
|
||||||
/>
|
|
||||||
</template>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Sections and Grouping
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
const detailConfig = {
|
|
||||||
objectApiName: 'Contact',
|
|
||||||
mode: ViewMode.DETAIL,
|
|
||||||
fields,
|
|
||||||
sections: [
|
|
||||||
{
|
|
||||||
title: 'Basic Information',
|
|
||||||
description: 'Primary contact details',
|
|
||||||
fields: ['firstName', 'lastName', 'email'],
|
|
||||||
},
|
|
||||||
{
|
|
||||||
title: 'Company Information',
|
|
||||||
fields: ['company', 'jobTitle', 'department'],
|
|
||||||
},
|
|
||||||
{
|
|
||||||
title: 'Additional Details',
|
|
||||||
fields: ['notes', 'tags'],
|
|
||||||
collapsible: true,
|
|
||||||
defaultCollapsed: true,
|
|
||||||
},
|
|
||||||
],
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Field Configuration
|
|
||||||
|
|
||||||
### FieldConfig Interface
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
interface FieldConfig {
|
|
||||||
// Basic properties
|
|
||||||
id: string
|
|
||||||
apiName: string
|
|
||||||
label: string
|
|
||||||
type: FieldType
|
|
||||||
|
|
||||||
// Display
|
|
||||||
placeholder?: string
|
|
||||||
helpText?: string
|
|
||||||
defaultValue?: any
|
|
||||||
|
|
||||||
// Validation
|
|
||||||
isRequired?: boolean
|
|
||||||
isReadOnly?: boolean
|
|
||||||
validationRules?: FieldValidationRule[]
|
|
||||||
|
|
||||||
// View visibility
|
|
||||||
showOnList?: boolean
|
|
||||||
showOnDetail?: boolean
|
|
||||||
showOnEdit?: boolean
|
|
||||||
sortable?: boolean
|
|
||||||
|
|
||||||
// Type-specific options
|
|
||||||
options?: FieldOption[] // For select fields
|
|
||||||
rows?: number // For textarea
|
|
||||||
min?: number // For number/date
|
|
||||||
max?: number // For number/date
|
|
||||||
step?: number // For number
|
|
||||||
accept?: string // For file uploads
|
|
||||||
relationObject?: string // For relationships
|
|
||||||
|
|
||||||
// Formatting
|
|
||||||
format?: string
|
|
||||||
prefix?: string
|
|
||||||
suffix?: string
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Validation Rules
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
const field = {
|
|
||||||
// ... other config
|
|
||||||
validationRules: [
|
|
||||||
{ type: 'required', message: 'This field is required' },
|
|
||||||
{ type: 'min', value: 5, message: 'Minimum 5 characters' },
|
|
||||||
{ type: 'max', value: 100, message: 'Maximum 100 characters' },
|
|
||||||
{ type: 'email', message: 'Invalid email format' },
|
|
||||||
{ type: 'url', message: 'Invalid URL format' },
|
|
||||||
{ type: 'pattern', value: '^[A-Z]', message: 'Must start with uppercase' },
|
|
||||||
],
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## View Components
|
|
||||||
|
|
||||||
### ListView
|
|
||||||
|
|
||||||
Features:
|
|
||||||
- Data table with sortable columns
|
|
||||||
- Row selection with bulk actions
|
|
||||||
- Search functionality
|
|
||||||
- Custom actions
|
|
||||||
- Export capability
|
|
||||||
- Pagination support
|
|
||||||
|
|
||||||
Events:
|
|
||||||
- `row-click` - When a row is clicked
|
|
||||||
- `row-select` - When rows are selected
|
|
||||||
- `create` - When create button is clicked
|
|
||||||
- `edit` - When edit button is clicked
|
|
||||||
- `delete` - When delete is triggered
|
|
||||||
- `action` - When custom action is triggered
|
|
||||||
- `sort` - When column sort changes
|
|
||||||
- `search` - When search is performed
|
|
||||||
|
|
||||||
### DetailView
|
|
||||||
|
|
||||||
Features:
|
|
||||||
- Organized sections
|
|
||||||
- Collapsible sections
|
|
||||||
- Custom actions
|
|
||||||
- Read-only display optimized for each field type
|
|
||||||
|
|
||||||
Events:
|
|
||||||
- `edit` - When edit button is clicked
|
|
||||||
- `delete` - When delete button is clicked
|
|
||||||
- `back` - When back button is clicked
|
|
||||||
- `action` - When custom action is triggered
|
|
||||||
|
|
||||||
### EditView
|
|
||||||
|
|
||||||
Features:
|
|
||||||
- Form with validation
|
|
||||||
- Organized sections with collapsible support
|
|
||||||
- Required field indicators
|
|
||||||
- Help text and placeholders
|
|
||||||
- Error messages
|
|
||||||
- Save/Cancel actions
|
|
||||||
|
|
||||||
Events:
|
|
||||||
- `save` - When form is submitted (passes validated data)
|
|
||||||
- `cancel` - When cancel is clicked
|
|
||||||
- `back` - When back is clicked
|
|
||||||
|
|
||||||
## Backend Integration
|
|
||||||
|
|
||||||
### Field Definition Model
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
export interface UIMetadata {
|
|
||||||
placeholder?: string
|
|
||||||
helpText?: string
|
|
||||||
showOnList?: boolean
|
|
||||||
showOnDetail?: boolean
|
|
||||||
showOnEdit?: boolean
|
|
||||||
sortable?: boolean
|
|
||||||
options?: FieldOption[]
|
|
||||||
rows?: number
|
|
||||||
min?: number
|
|
||||||
max?: number
|
|
||||||
step?: number
|
|
||||||
format?: string
|
|
||||||
prefix?: string
|
|
||||||
suffix?: string
|
|
||||||
validationRules?: ValidationRule[]
|
|
||||||
}
|
|
||||||
|
|
||||||
export class FieldDefinition extends BaseModel {
|
|
||||||
// ... existing fields
|
|
||||||
uiMetadata?: UIMetadata
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Migration
|
|
||||||
|
|
||||||
Run the migration to add UI metadata support:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd backend
|
|
||||||
npm run migrate:tenant
|
|
||||||
```
|
|
||||||
|
|
||||||
### API Response Example
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"id": "field-1",
|
|
||||||
"objectDefinitionId": "obj-1",
|
|
||||||
"apiName": "firstName",
|
|
||||||
"label": "First Name",
|
|
||||||
"type": "text",
|
|
||||||
"isRequired": true,
|
|
||||||
"uiMetadata": {
|
|
||||||
"placeholder": "Enter first name",
|
|
||||||
"helpText": "Customer's legal first name",
|
|
||||||
"showOnList": true,
|
|
||||||
"showOnDetail": true,
|
|
||||||
"showOnEdit": true,
|
|
||||||
"sortable": true,
|
|
||||||
"validationRules": [
|
|
||||||
{
|
|
||||||
"type": "min",
|
|
||||||
"value": 2,
|
|
||||||
"message": "Name must be at least 2 characters"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Composables
|
|
||||||
|
|
||||||
### useFields()
|
|
||||||
|
|
||||||
Utilities for working with field configurations:
|
|
||||||
|
|
||||||
- `mapFieldDefinitionToConfig(fieldDef)` - Convert backend field definition to FieldConfig
|
|
||||||
- `buildListViewConfig(objectDef, customConfig)` - Build ListView configuration
|
|
||||||
- `buildDetailViewConfig(objectDef, customConfig)` - Build DetailView configuration
|
|
||||||
- `buildEditViewConfig(objectDef, customConfig)` - Build EditView configuration
|
|
||||||
- `generateSections(fields)` - Auto-generate sections based on field types
|
|
||||||
|
|
||||||
### useViewState(apiEndpoint)
|
|
||||||
|
|
||||||
CRUD operations and state management:
|
|
||||||
|
|
||||||
- **State**: `records`, `currentRecord`, `currentView`, `loading`, `saving`, `error`
|
|
||||||
- **Methods**: `fetchRecords()`, `fetchRecord(id)`, `createRecord(data)`, `updateRecord(id, data)`, `deleteRecord(id)`, `deleteRecords(ids)`
|
|
||||||
- **Navigation**: `showList()`, `showDetail(record)`, `showEdit(record)`, `handleSave(data)`
|
|
||||||
|
|
||||||
## Demo
|
|
||||||
|
|
||||||
Visit `/demo/field-views` to see an interactive demo of all field types and views.
|
|
||||||
|
|
||||||
## Best Practices
|
|
||||||
|
|
||||||
1. **Field Organization** - Group related fields into sections for better UX
|
|
||||||
2. **Validation** - Always provide clear validation messages
|
|
||||||
3. **Help Text** - Use help text to guide users
|
|
||||||
4. **Required Fields** - Mark required fields appropriately
|
|
||||||
5. **Default Values** - Provide sensible defaults when possible
|
|
||||||
6. **Read-Only Fields** - Use for system fields or computed values
|
|
||||||
7. **Conditional Logic** - Use `dependsOn` for conditional field visibility
|
|
||||||
8. **Mobile Responsive** - All components are mobile-responsive by default
|
|
||||||
|
|
||||||
## Extending
|
|
||||||
|
|
||||||
### Adding Custom Field Types
|
|
||||||
|
|
||||||
1. Add new type to `FieldType` enum in [types/field-types.ts](../types/field-types.ts)
|
|
||||||
2. Add rendering logic to [FieldRenderer.vue](../components/fields/FieldRenderer.vue)
|
|
||||||
3. Update validation logic in [EditView.vue](../components/views/EditView.vue)
|
|
||||||
|
|
||||||
### Custom Actions
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
const config = {
|
|
||||||
// ... other config
|
|
||||||
actions: [
|
|
||||||
{
|
|
||||||
id: 'export-pdf',
|
|
||||||
label: 'Export PDF',
|
|
||||||
icon: 'FileDown',
|
|
||||||
variant: 'outline',
|
|
||||||
confirmation: 'Export this record to PDF?',
|
|
||||||
handler: async () => {
|
|
||||||
// Custom logic
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Components Structure
|
|
||||||
|
|
||||||
```
|
|
||||||
frontend/
|
|
||||||
├── components/
|
|
||||||
│ ├── fields/
|
|
||||||
│ │ └── FieldRenderer.vue # Universal field renderer
|
|
||||||
│ ├── views/
|
|
||||||
│ │ ├── ListView.vue # Data table view
|
|
||||||
│ │ ├── DetailView.vue # Read-only detail view
|
|
||||||
│ │ └── EditView.vue # Form/edit view
|
|
||||||
│ └── ui/ # shadcn-vue components
|
|
||||||
│ ├── table/
|
|
||||||
│ ├── input/
|
|
||||||
│ ├── select/
|
|
||||||
│ ├── checkbox/
|
|
||||||
│ ├── switch/
|
|
||||||
│ ├── textarea/
|
|
||||||
│ ├── calendar/
|
|
||||||
│ ├── date-picker/
|
|
||||||
│ └── ...
|
|
||||||
├── types/
|
|
||||||
│ └── field-types.ts # Type definitions
|
|
||||||
├── composables/
|
|
||||||
│ └── useFieldViews.ts # Utilities
|
|
||||||
└── pages/
|
|
||||||
└── demo/
|
|
||||||
└── field-views.vue # Interactive demo
|
|
||||||
```
|
|
||||||
|
|
||||||
## Performance Considerations
|
|
||||||
|
|
||||||
- Fields are rendered on-demand based on view mode
|
|
||||||
- Large datasets should use pagination (built-in support)
|
|
||||||
- Validation is performed client-side before API calls
|
|
||||||
- Use `v-memo` for large lists to optimize re-renders
|
|
||||||
|
|
||||||
## Accessibility
|
|
||||||
|
|
||||||
All components follow accessibility best practices:
|
|
||||||
- Proper ARIA labels
|
|
||||||
- Keyboard navigation support
|
|
||||||
- Focus management
|
|
||||||
- Screen reader friendly
|
|
||||||
- High contrast support
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
Part of the Neo platform.
|
|
||||||
@@ -1,267 +0,0 @@
|
|||||||
# Field Types & Views Implementation Summary
|
|
||||||
|
|
||||||
## What Was Built
|
|
||||||
|
|
||||||
A complete Laravel Nova-inspired field type system with list, detail, and edit views using shadcn-vue components.
|
|
||||||
|
|
||||||
## 📁 Files Created
|
|
||||||
|
|
||||||
### Frontend
|
|
||||||
|
|
||||||
#### Type Definitions
|
|
||||||
- **`/frontend/types/field-types.ts`** - Complete TypeScript definitions for field types, view modes, and configurations
|
|
||||||
|
|
||||||
#### Components
|
|
||||||
- **`/frontend/components/fields/FieldRenderer.vue`** - Universal field renderer that handles all field types in all view modes
|
|
||||||
- **`/frontend/components/views/ListView.vue`** - Data table with search, sort, filter, bulk actions
|
|
||||||
- **`/frontend/components/views/DetailView.vue`** - Read-only detail view with sections
|
|
||||||
- **`/frontend/components/views/EditView.vue`** - Form with validation and sections
|
|
||||||
- **`/frontend/components/ui/date-picker/DatePicker.vue`** - Custom date picker component
|
|
||||||
|
|
||||||
#### Composables
|
|
||||||
- **`/frontend/composables/useFieldViews.ts`** - Utilities for field mapping and CRUD operations
|
|
||||||
|
|
||||||
#### Pages
|
|
||||||
- **`/frontend/pages/demo/field-views.vue`** - Interactive demo page
|
|
||||||
- **`/frontend/pages/app/objects/[objectName]/[[recordId]]/[[view]].vue`** - Dynamic object view page
|
|
||||||
|
|
||||||
### Backend
|
|
||||||
|
|
||||||
#### Models
|
|
||||||
- **Updated `/backend/src/models/field-definition.model.ts`** - Added UIMetadata interface and uiMetadata property
|
|
||||||
|
|
||||||
#### Services
|
|
||||||
- **`/backend/src/object/field-mapper.service.ts`** - Service for mapping backend field definitions to frontend configs
|
|
||||||
|
|
||||||
#### Controllers
|
|
||||||
- **Updated `/backend/src/object/setup-object.controller.ts`** - Added `/ui-config` endpoint
|
|
||||||
|
|
||||||
#### Migrations
|
|
||||||
- **`/backend/migrations/tenant/20250126000005_add_ui_metadata_to_fields.js`** - Database migration for UI metadata
|
|
||||||
|
|
||||||
### Documentation
|
|
||||||
- **`/FIELD_TYPES_GUIDE.md`** - Comprehensive documentation
|
|
||||||
- **`/FIELD_TYPES_IMPLEMENTATION_SUMMARY.md`** - This file
|
|
||||||
|
|
||||||
## 🎨 Field Types Supported
|
|
||||||
|
|
||||||
### Text Fields
|
|
||||||
- Text, Textarea, Password, Email, URL
|
|
||||||
|
|
||||||
### Numeric Fields
|
|
||||||
- Number, Currency
|
|
||||||
|
|
||||||
### Selection Fields
|
|
||||||
- Select, Multi-Select, Boolean
|
|
||||||
|
|
||||||
### Date/Time Fields
|
|
||||||
- Date, DateTime, Time
|
|
||||||
|
|
||||||
### Relationship Fields
|
|
||||||
- BelongsTo, HasMany, ManyToMany
|
|
||||||
|
|
||||||
### Rich Content
|
|
||||||
- Markdown, Code
|
|
||||||
|
|
||||||
### File Fields
|
|
||||||
- File, Image
|
|
||||||
|
|
||||||
### Other
|
|
||||||
- Color, JSON
|
|
||||||
|
|
||||||
## 🔧 Components Installed
|
|
||||||
|
|
||||||
Installed from shadcn-vue:
|
|
||||||
- Table (with all sub-components)
|
|
||||||
- Checkbox
|
|
||||||
- Switch
|
|
||||||
- Textarea
|
|
||||||
- Calendar
|
|
||||||
- Popover
|
|
||||||
- Command
|
|
||||||
- Badge
|
|
||||||
- Dialog
|
|
||||||
|
|
||||||
## 🚀 How to Use
|
|
||||||
|
|
||||||
### 1. View the Demo
|
|
||||||
```bash
|
|
||||||
# Start the frontend dev server
|
|
||||||
cd frontend
|
|
||||||
npm run dev
|
|
||||||
|
|
||||||
# Visit http://localhost:3000/demo/field-views
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2. Use in Your App
|
|
||||||
|
|
||||||
```vue
|
|
||||||
<script setup>
|
|
||||||
import { ListView } from '@/components/views'
|
|
||||||
import { FieldType, ViewMode } from '@/types/field-types'
|
|
||||||
|
|
||||||
const config = {
|
|
||||||
objectApiName: 'Contact',
|
|
||||||
mode: ViewMode.LIST,
|
|
||||||
fields: [
|
|
||||||
{
|
|
||||||
id: '1',
|
|
||||||
apiName: 'name',
|
|
||||||
label: 'Name',
|
|
||||||
type: FieldType.TEXT,
|
|
||||||
isRequired: true,
|
|
||||||
},
|
|
||||||
// ... more fields
|
|
||||||
],
|
|
||||||
}
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<ListView :config="config" :data="records" />
|
|
||||||
</template>
|
|
||||||
```
|
|
||||||
|
|
||||||
### 3. Integrate with Backend
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// Frontend
|
|
||||||
const objectDef = await $fetch('/api/setup/objects/Contact/ui-config')
|
|
||||||
const listConfig = buildListViewConfig(objectDef)
|
|
||||||
|
|
||||||
// Backend - the endpoint returns properly formatted field configs
|
|
||||||
GET /api/setup/objects/{objectApiName}/ui-config
|
|
||||||
```
|
|
||||||
|
|
||||||
## 🗃️ Database Changes
|
|
||||||
|
|
||||||
Run the migration to add UI metadata support:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd backend
|
|
||||||
npm run migrate:tenant
|
|
||||||
```
|
|
||||||
|
|
||||||
This adds a `ui_metadata` JSONB column to the `field_definitions` table.
|
|
||||||
|
|
||||||
## 📋 API Endpoints
|
|
||||||
|
|
||||||
### New Endpoint
|
|
||||||
- `GET /api/setup/objects/:objectApiName/ui-config` - Returns object definition with frontend-ready field configs
|
|
||||||
|
|
||||||
### Existing Endpoints
|
|
||||||
- `GET /api/setup/objects` - List all object definitions
|
|
||||||
- `GET /api/setup/objects/:objectApiName` - Get object definition
|
|
||||||
- `POST /api/setup/objects` - Create object definition
|
|
||||||
- `POST /api/setup/objects/:objectApiName/fields` - Create field definition
|
|
||||||
|
|
||||||
## ✨ Features
|
|
||||||
|
|
||||||
### ListView
|
|
||||||
- Sortable columns
|
|
||||||
- Row selection with bulk actions
|
|
||||||
- Search functionality
|
|
||||||
- Custom actions
|
|
||||||
- Export support
|
|
||||||
- Responsive design
|
|
||||||
|
|
||||||
### DetailView
|
|
||||||
- Organized sections
|
|
||||||
- Collapsible sections
|
|
||||||
- Read-only optimized display
|
|
||||||
- Custom actions
|
|
||||||
- Field-type aware rendering
|
|
||||||
|
|
||||||
### EditView
|
|
||||||
- Client-side validation
|
|
||||||
- Required field indicators
|
|
||||||
- Help text and placeholders
|
|
||||||
- Error messages
|
|
||||||
- Organized sections
|
|
||||||
- Collapsible sections
|
|
||||||
|
|
||||||
### FieldRenderer
|
|
||||||
- Handles all 20+ field types
|
|
||||||
- Three rendering modes (list, detail, edit)
|
|
||||||
- Type-specific components
|
|
||||||
- Validation support
|
|
||||||
- Formatting options
|
|
||||||
|
|
||||||
## 🔄 Integration with Existing System
|
|
||||||
|
|
||||||
The field type system integrates seamlessly with your existing multi-tenant app builder:
|
|
||||||
|
|
||||||
1. **Object Definitions** - Uses existing `object_definitions` table
|
|
||||||
2. **Field Definitions** - Extends existing `field_definitions` table with `ui_metadata`
|
|
||||||
3. **Runtime Pages** - Dynamic route at `/app/objects/:objectName` automatically renders appropriate views
|
|
||||||
4. **Composables** - `useFieldViews` provides utilities for mapping backend data
|
|
||||||
|
|
||||||
## 📝 Next Steps
|
|
||||||
|
|
||||||
1. **Run the migration** to add UI metadata support
|
|
||||||
2. **Test the demo** at `/demo/field-views`
|
|
||||||
3. **Integrate with your objects** using the dynamic route
|
|
||||||
4. **Customize field types** as needed for your use case
|
|
||||||
5. **Add validation rules** to field definitions
|
|
||||||
6. **Configure UI metadata** for better UX
|
|
||||||
|
|
||||||
## 🎯 Best Practices
|
|
||||||
|
|
||||||
1. Always provide clear labels and help text
|
|
||||||
2. Use validation rules with custom messages
|
|
||||||
3. Organize fields into logical sections
|
|
||||||
4. Mark required fields appropriately
|
|
||||||
5. Use appropriate field types for data
|
|
||||||
6. Test on mobile devices
|
|
||||||
7. Use read-only for system fields
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
See [FIELD_TYPES_GUIDE.md](./FIELD_TYPES_GUIDE.md) for complete documentation including:
|
|
||||||
- Detailed usage examples
|
|
||||||
- Field configuration options
|
|
||||||
- Validation rules
|
|
||||||
- Event handling
|
|
||||||
- Customization guide
|
|
||||||
- Performance tips
|
|
||||||
- Accessibility features
|
|
||||||
|
|
||||||
## 🐛 Troubleshooting
|
|
||||||
|
|
||||||
### Missing UI Metadata
|
|
||||||
If fields don't render correctly, ensure:
|
|
||||||
1. Migration has been run
|
|
||||||
2. `uiMetadata` is populated in database
|
|
||||||
3. Field types are correctly mapped
|
|
||||||
|
|
||||||
### Components Not Found
|
|
||||||
Ensure all shadcn-vue components are installed:
|
|
||||||
```bash
|
|
||||||
cd frontend
|
|
||||||
npx shadcn-vue@latest add table checkbox switch textarea calendar popover command badge
|
|
||||||
```
|
|
||||||
|
|
||||||
### Type Errors
|
|
||||||
Ensure TypeScript types are properly imported:
|
|
||||||
```typescript
|
|
||||||
import { FieldType, ViewMode, type FieldConfig } from '@/types/field-types'
|
|
||||||
```
|
|
||||||
|
|
||||||
## 💡 Tips
|
|
||||||
|
|
||||||
1. Use the `FieldMapperService` to automatically generate UI configs
|
|
||||||
2. Leverage `useViewState` composable for CRUD operations
|
|
||||||
3. Customize field rendering by extending `FieldRenderer.vue`
|
|
||||||
4. Add custom actions to views for workflow automation
|
|
||||||
5. Use sections to organize complex forms
|
|
||||||
|
|
||||||
## 🎉 Success!
|
|
||||||
|
|
||||||
You now have a complete, production-ready field type system inspired by Laravel Nova! The system is:
|
|
||||||
- ✅ Fully typed with TypeScript
|
|
||||||
- ✅ Responsive and accessible
|
|
||||||
- ✅ Integrated with your backend
|
|
||||||
- ✅ Extensible and customizable
|
|
||||||
- ✅ Well-documented
|
|
||||||
- ✅ Demo-ready
|
|
||||||
|
|
||||||
Happy building! 🚀
|
|
||||||
@@ -1,390 +0,0 @@
|
|||||||
# Page Layouts Architecture Diagram
|
|
||||||
|
|
||||||
## System Overview
|
|
||||||
|
|
||||||
```
|
|
||||||
┌─────────────────────────────────────────────────────────────────┐
|
|
||||||
│ FRONTEND (Vue 3 + Nuxt) │
|
|
||||||
├─────────────────────────────────────────────────────────────────┤
|
|
||||||
│ │
|
|
||||||
│ ┌───────────────────────────────────────────────────────────┐ │
|
|
||||||
│ │ Setup → Objects → [Object] → Layouts Tab │ │
|
|
||||||
│ ├───────────────────────────────────────────────────────────┤ │
|
|
||||||
│ │ │ │
|
|
||||||
│ │ ┌─────────────┐ ┌───────────────────────────────┐ │ │
|
|
||||||
│ │ │ Layouts │ │ PageLayoutEditor │ │ │
|
|
||||||
│ │ │ List │ --> │ ┌─────────────────────────┐ │ │ │
|
|
||||||
│ │ │ │ │ │ 6-Column Grid │ │ │ │
|
|
||||||
│ │ │ • Standard │ │ │ ┌───┬───┬───┬───┬───┐ │ │ │ │
|
|
||||||
│ │ │ • Compact │ │ │ │ F │ F │ F │ F │ F │ │ │ │ │
|
|
||||||
│ │ │ • Detailed │ │ │ ├───┴───┴───┴───┴───┤ │ │ │ │
|
|
||||||
│ │ │ │ │ │ │ Field 1 (w:5) │ │ │ │ │
|
|
||||||
│ │ │ [+ New] │ │ │ └─────────────────── │ │ │ │ │
|
|
||||||
│ │ └─────────────┘ │ └─────────────────────────┘ │ │ │
|
|
||||||
│ │ │ │ │ │
|
|
||||||
│ │ │ Sidebar: │ │ │
|
|
||||||
│ │ │ ┌─────────────────────────┐ │ │ │
|
|
||||||
│ │ │ │ Available Fields │ │ │ │
|
|
||||||
│ │ │ │ □ Email │ │ │ │
|
|
||||||
│ │ │ │ □ Phone │ │ │ │
|
|
||||||
│ │ │ │ □ Status │ │ │ │
|
|
||||||
│ │ │ └─────────────────────────┘ │ │ │
|
|
||||||
│ │ └───────────────────────────────┘ │ │
|
|
||||||
│ └───────────────────────────────────────────────────────┘ │
|
|
||||||
│ │
|
|
||||||
│ ┌───────────────────────────────────────────────────────┐ │
|
|
||||||
│ │ Record Detail/Edit Views │ │
|
|
||||||
│ ├───────────────────────────────────────────────────────┤ │
|
|
||||||
│ │ │ │
|
|
||||||
│ │ DetailViewEnhanced / EditViewEnhanced │ │
|
|
||||||
│ │ ↓ │ │
|
|
||||||
│ │ ┌─────────────────────────────────────────────────┐ │ │
|
|
||||||
│ │ │ PageLayoutRenderer │ │ │
|
|
||||||
│ │ │ │ │ │
|
|
||||||
│ │ │ Fetches default layout for object │ │ │
|
|
||||||
│ │ │ Renders fields in custom grid positions │ │ │
|
|
||||||
│ │ │ Fallback to 2-column if no layout │ │ │
|
|
||||||
│ │ └─────────────────────────────────────────────────┘ │ │
|
|
||||||
│ └───────────────────────────────────────────────────────┘ │
|
|
||||||
│ │
|
|
||||||
│ ┌───────────────────────────────────────────────────────┐ │
|
|
||||||
│ │ Composables (usePageLayouts) │ │
|
|
||||||
│ ├───────────────────────────────────────────────────────┤ │
|
|
||||||
│ │ • getPageLayouts() • createPageLayout() │ │
|
|
||||||
│ │ • getPageLayout() • updatePageLayout() │ │
|
|
||||||
│ │ • getDefaultPageLayout()• deletePageLayout() │ │
|
|
||||||
│ └───────────────────────────────────────────────────────┘ │
|
|
||||||
└─────────────────────────────────────────────────────────────┘
|
|
||||||
↕ HTTP REST API
|
|
||||||
┌─────────────────────────────────────────────────────────────┐
|
|
||||||
│ BACKEND (NestJS) │
|
|
||||||
├─────────────────────────────────────────────────────────────┤
|
|
||||||
│ │
|
|
||||||
│ ┌───────────────────────────────────────────────────────┐ │
|
|
||||||
│ │ PageLayoutController (API Layer) │ │
|
|
||||||
│ ├───────────────────────────────────────────────────────┤ │
|
|
||||||
│ │ POST /page-layouts │ │
|
|
||||||
│ │ GET /page-layouts?objectId={id} │ │
|
|
||||||
│ │ GET /page-layouts/:id │ │
|
|
||||||
│ │ GET /page-layouts/default/:objectId │ │
|
|
||||||
│ │ PATCH /page-layouts/:id │ │
|
|
||||||
│ │ DELETE /page-layouts/:id │ │
|
|
||||||
│ └───────────────────────────────────────────────────────┘ │
|
|
||||||
│ ↕ │
|
|
||||||
│ ┌───────────────────────────────────────────────────────┐ │
|
|
||||||
│ │ PageLayoutService (Business Logic) │ │
|
|
||||||
│ ├───────────────────────────────────────────────────────┤ │
|
|
||||||
│ │ • Tenant isolation │ │
|
|
||||||
│ │ • Default layout management │ │
|
|
||||||
│ │ • CRUD operations │ │
|
|
||||||
│ │ • Validation │ │
|
|
||||||
│ └───────────────────────────────────────────────────────┘ │
|
|
||||||
│ ↕ │
|
|
||||||
│ ┌───────────────────────────────────────────────────────┐ │
|
|
||||||
│ │ PrismaService (Data Layer) │ │
|
|
||||||
│ ├───────────────────────────────────────────────────────┤ │
|
|
||||||
│ │ • Raw SQL queries │ │
|
|
||||||
│ │ • Tenant database routing │ │
|
|
||||||
│ │ • Transaction management │ │
|
|
||||||
│ └───────────────────────────────────────────────────────┘ │
|
|
||||||
└─────────────────────────────────────────────────────────────┘
|
|
||||||
↕
|
|
||||||
┌─────────────────────────────────────────────────────────────┐
|
|
||||||
│ DATABASE (PostgreSQL) │
|
|
||||||
├─────────────────────────────────────────────────────────────┤
|
|
||||||
│ │
|
|
||||||
│ ┌───────────────────────────────────────────────────────┐ │
|
|
||||||
│ │ Table: page_layouts │ │
|
|
||||||
│ ├───────────────────────────────────────────────────────┤ │
|
|
||||||
│ │ id UUID PRIMARY KEY │ │
|
|
||||||
│ │ name VARCHAR(255) │ │
|
|
||||||
│ │ object_id UUID → object_definitions(id) │ │
|
|
||||||
│ │ is_default BOOLEAN │ │
|
|
||||||
│ │ layout_config JSONB │ │
|
|
||||||
│ │ description TEXT │ │
|
|
||||||
│ │ created_at TIMESTAMP │ │
|
|
||||||
│ │ updated_at TIMESTAMP │ │
|
|
||||||
│ └───────────────────────────────────────────────────────┘ │
|
|
||||||
│ │
|
|
||||||
│ Example layout_config JSONB: │
|
|
||||||
│ { │
|
|
||||||
│ "fields": [ │
|
|
||||||
│ { │
|
|
||||||
│ "fieldId": "uuid-123", │
|
|
||||||
│ "x": 0, // Column start (0-5) │
|
|
||||||
│ "y": 0, // Row start │
|
|
||||||
│ "w": 3, // Width (1-6 columns) │
|
|
||||||
│ "h": 1 // Height (fixed at 1) │
|
|
||||||
│ } │
|
|
||||||
│ ] │
|
|
||||||
│ } │
|
|
||||||
└─────────────────────────────────────────────────────────────┘
|
|
||||||
```
|
|
||||||
|
|
||||||
## Data Flow Diagrams
|
|
||||||
|
|
||||||
### Creating a Layout
|
|
||||||
|
|
||||||
```
|
|
||||||
Admin User
|
|
||||||
│
|
|
||||||
├─→ Navigates to Setup → Objects → [Object] → Page Layouts
|
|
||||||
│
|
|
||||||
├─→ Clicks "New Layout"
|
|
||||||
│
|
|
||||||
├─→ Enters layout name
|
|
||||||
│
|
|
||||||
├─→ PageLayoutEditor mounts
|
|
||||||
│ │
|
|
||||||
│ ├─→ Loads object fields
|
|
||||||
│ ├─→ Initializes GridStack with 6 columns
|
|
||||||
│ └─→ Shows available fields in sidebar
|
|
||||||
│
|
|
||||||
├─→ Drags fields from sidebar to grid
|
|
||||||
│ │
|
|
||||||
│ ├─→ GridStack handles positioning
|
|
||||||
│ ├─→ User resizes field width (1-6 columns)
|
|
||||||
│ └─→ User arranges fields
|
|
||||||
│
|
|
||||||
├─→ Clicks "Save Layout"
|
|
||||||
│
|
|
||||||
├─→ usePageLayouts.createPageLayout()
|
|
||||||
│ │
|
|
||||||
│ └─→ POST /page-layouts
|
|
||||||
│ │
|
|
||||||
│ └─→ PageLayoutController.create()
|
|
||||||
│ │
|
|
||||||
│ └─→ PageLayoutService.create()
|
|
||||||
│ │
|
|
||||||
│ ├─→ If is_default, unset others
|
|
||||||
│ └─→ INSERT INTO page_layouts
|
|
||||||
│
|
|
||||||
└─→ Layout saved ✓
|
|
||||||
```
|
|
||||||
|
|
||||||
### Rendering a Layout in Detail View
|
|
||||||
|
|
||||||
```
|
|
||||||
User Opens Record
|
|
||||||
│
|
|
||||||
├─→ Navigates to /[object]/[id]/detail
|
|
||||||
│
|
|
||||||
├─→ DetailViewEnhanced mounts
|
|
||||||
│ │
|
|
||||||
│ └─→ onMounted() hook
|
|
||||||
│ │
|
|
||||||
│ └─→ usePageLayouts.getDefaultPageLayout(objectId)
|
|
||||||
│ │
|
|
||||||
│ └─→ GET /page-layouts/default/:objectId
|
|
||||||
│ │
|
|
||||||
│ └─→ PageLayoutService.findDefaultByObject()
|
|
||||||
│ │
|
|
||||||
│ └─→ SELECT * FROM page_layouts
|
|
||||||
│ WHERE object_id = $1
|
|
||||||
│ AND is_default = true
|
|
||||||
│
|
|
||||||
├─→ Layout received
|
|
||||||
│ │
|
|
||||||
│ ├─→ If layout exists:
|
|
||||||
│ │ │
|
|
||||||
│ │ └─→ PageLayoutRenderer renders with layout
|
|
||||||
│ │ │
|
|
||||||
│ │ ├─→ Creates CSS Grid (6 columns)
|
|
||||||
│ │ ├─→ Positions fields based on x, y, w, h
|
|
||||||
│ │ └─→ Renders FieldRenderer for each field
|
|
||||||
│ │
|
|
||||||
│ └─→ If no layout:
|
|
||||||
│ │
|
|
||||||
│ └─→ Falls back to 2-column layout
|
|
||||||
│
|
|
||||||
└─→ Record displayed with custom layout ✓
|
|
||||||
```
|
|
||||||
|
|
||||||
## Grid Layout System
|
|
||||||
|
|
||||||
### 6-Column Grid Structure
|
|
||||||
|
|
||||||
```
|
|
||||||
┌──────┬──────┬──────┬──────┬──────┬──────┐
|
|
||||||
│ 0 │ 1 │ 2 │ 3 │ 4 │ 5 │ ← Column indices
|
|
||||||
└──────┴──────┴──────┴──────┴──────┴──────┘
|
|
||||||
Each column = 16.67% of container width
|
|
||||||
```
|
|
||||||
|
|
||||||
### Example Layouts
|
|
||||||
|
|
||||||
#### Two-Column Layout (Default)
|
|
||||||
```
|
|
||||||
┌─────────────────────┬─────────────────────┐
|
|
||||||
│ Name (w:3) │ Email (w:3) │
|
|
||||||
├─────────────────────┼─────────────────────┤
|
|
||||||
│ Phone (w:3) │ Company (w:3) │
|
|
||||||
├─────────────────────┴─────────────────────┤
|
|
||||||
│ Description (w:6) │
|
|
||||||
└───────────────────────────────────────────┘
|
|
||||||
|
|
||||||
Field configs:
|
|
||||||
- Name: {x:0, y:0, w:3, h:1}
|
|
||||||
- Email: {x:3, y:0, w:3, h:1}
|
|
||||||
- Phone: {x:0, y:1, w:3, h:1}
|
|
||||||
- Company: {x:3, y:1, w:3, h:1}
|
|
||||||
- Description: {x:0, y:2, w:6, h:1}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Three-Column Layout
|
|
||||||
```
|
|
||||||
┌───────────┬───────────┬───────────┐
|
|
||||||
│ F1 (w:2) │ F2 (w:2) │ F3 (w:2) │
|
|
||||||
├───────────┴───────────┴───────────┤
|
|
||||||
│ F4 (w:6) │
|
|
||||||
└───────────────────────────────────┘
|
|
||||||
|
|
||||||
Field configs:
|
|
||||||
- F1: {x:0, y:0, w:2, h:1}
|
|
||||||
- F2: {x:2, y:0, w:2, h:1}
|
|
||||||
- F3: {x:4, y:0, w:2, h:1}
|
|
||||||
- F4: {x:0, y:1, w:6, h:1}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Mixed Width Layout
|
|
||||||
```
|
|
||||||
┌───────────────┬───────┬───────────┐
|
|
||||||
│ Title (w:3) │ ID(1) │ Type (w:2)│
|
|
||||||
├───────────────┴───────┴───────────┤
|
|
||||||
│ Address (w:6) │
|
|
||||||
├──────────┬────────────────────────┤
|
|
||||||
│ City(2) │ State/ZIP (w:4) │
|
|
||||||
└──────────┴────────────────────────┘
|
|
||||||
|
|
||||||
Field configs:
|
|
||||||
- Title: {x:0, y:0, w:3, h:1}
|
|
||||||
- ID: {x:3, y:0, w:1, h:1}
|
|
||||||
- Type: {x:4, y:0, w:2, h:1}
|
|
||||||
- Address: {x:0, y:1, w:6, h:1}
|
|
||||||
- City: {x:0, y:2, w:2, h:1}
|
|
||||||
- State: {x:2, y:2, w:4, h:1}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Component Hierarchy
|
|
||||||
|
|
||||||
```
|
|
||||||
App.vue
|
|
||||||
│
|
|
||||||
└─→ NuxtLayout (default)
|
|
||||||
│
|
|
||||||
├─→ Setup Pages
|
|
||||||
│ │
|
|
||||||
│ └─→ pages/setup/objects/[apiName].vue
|
|
||||||
│ │
|
|
||||||
│ └─→ Tabs Component
|
|
||||||
│ │
|
|
||||||
│ ├─→ Tab: Fields (existing)
|
|
||||||
│ │
|
|
||||||
│ └─→ Tab: Page Layouts
|
|
||||||
│ │
|
|
||||||
│ ├─→ Layout List View
|
|
||||||
│ │ └─→ Card per layout
|
|
||||||
│ │
|
|
||||||
│ └─→ Layout Editor View
|
|
||||||
│ │
|
|
||||||
│ └─→ PageLayoutEditor
|
|
||||||
│ │
|
|
||||||
│ ├─→ GridStack (6 columns)
|
|
||||||
│ │ └─→ Field items
|
|
||||||
│ │
|
|
||||||
│ └─→ Sidebar
|
|
||||||
│ └─→ Available fields
|
|
||||||
│
|
|
||||||
└─→ Record Pages
|
|
||||||
│
|
|
||||||
└─→ pages/[objectName]/[[recordId]]/[[view]].vue
|
|
||||||
│
|
|
||||||
├─→ DetailViewEnhanced
|
|
||||||
│ │
|
|
||||||
│ └─→ PageLayoutRenderer
|
|
||||||
│ └─→ FieldRenderer (per field)
|
|
||||||
│
|
|
||||||
└─→ EditViewEnhanced
|
|
||||||
│
|
|
||||||
└─→ PageLayoutRenderer
|
|
||||||
└─→ FieldRenderer (per field)
|
|
||||||
```
|
|
||||||
|
|
||||||
## State Management
|
|
||||||
|
|
||||||
```
|
|
||||||
┌─────────────────────────────────────┐
|
|
||||||
│ Component State (ref/reactive) │
|
|
||||||
├─────────────────────────────────────┤
|
|
||||||
│ • selectedLayout │
|
|
||||||
│ • layouts[] │
|
|
||||||
│ • loadingLayouts │
|
|
||||||
│ • pageLayout (current) │
|
|
||||||
│ • formData │
|
|
||||||
│ • gridItems │
|
|
||||||
│ • placedFieldIds │
|
|
||||||
└─────────────────────────────────────┘
|
|
||||||
↕
|
|
||||||
┌─────────────────────────────────────┐
|
|
||||||
│ Composables (Reactive) │
|
|
||||||
├─────────────────────────────────────┤
|
|
||||||
│ • usePageLayouts() - API calls │
|
|
||||||
│ • useApi() - HTTP client │
|
|
||||||
│ • useAuth() - Authentication │
|
|
||||||
│ • useToast() - Notifications │
|
|
||||||
└─────────────────────────────────────┘
|
|
||||||
↕
|
|
||||||
┌─────────────────────────────────────┐
|
|
||||||
│ Browser Storage │
|
|
||||||
├─────────────────────────────────────┤
|
|
||||||
│ • localStorage: token, tenantId │
|
|
||||||
│ • SessionStorage: (none yet) │
|
|
||||||
│ • Cookies: (managed by server) │
|
|
||||||
└─────────────────────────────────────┘
|
|
||||||
```
|
|
||||||
|
|
||||||
## Security Flow
|
|
||||||
|
|
||||||
```
|
|
||||||
┌────────────────────────────────────────────────┐
|
|
||||||
│ 1. User Login │
|
|
||||||
│ → Receives JWT token │
|
|
||||||
│ → Token stored in localStorage │
|
|
||||||
└────────────────────────────────────────────────┘
|
|
||||||
↓
|
|
||||||
┌────────────────────────────────────────────────┐
|
|
||||||
│ 2. API Request │
|
|
||||||
│ → useApi() adds Authorization header │
|
|
||||||
│ → useApi() adds x-tenant-id header │
|
|
||||||
└────────────────────────────────────────────────┘
|
|
||||||
↓
|
|
||||||
┌────────────────────────────────────────────────┐
|
|
||||||
│ 3. Backend Validation │
|
|
||||||
│ → JwtAuthGuard validates token │
|
|
||||||
│ → Extracts user info (userId, tenantId) │
|
|
||||||
│ → Attaches to request object │
|
|
||||||
└────────────────────────────────────────────────┘
|
|
||||||
↓
|
|
||||||
┌────────────────────────────────────────────────┐
|
|
||||||
│ 4. Service Layer │
|
|
||||||
│ → Receives tenantId from request │
|
|
||||||
│ → All queries scoped to tenant │
|
|
||||||
│ → Tenant isolation enforced │
|
|
||||||
└────────────────────────────────────────────────┘
|
|
||||||
↓
|
|
||||||
┌────────────────────────────────────────────────┐
|
|
||||||
│ 5. Database │
|
|
||||||
│ → Tenant-specific database selected │
|
|
||||||
│ → Query executed in tenant context │
|
|
||||||
│ → Results returned │
|
|
||||||
└────────────────────────────────────────────────┘
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Legend:**
|
|
||||||
- `→` : Data flow direction
|
|
||||||
- `↕` : Bidirectional communication
|
|
||||||
- `├─→` : Hierarchical relationship
|
|
||||||
- `└─→` : Terminal branch
|
|
||||||
- `✓` : Successful operation
|
|
||||||
@@ -1,356 +0,0 @@
|
|||||||
# Page Layouts Feature - Implementation Complete ✅
|
|
||||||
|
|
||||||
## Summary
|
|
||||||
|
|
||||||
Successfully implemented a comprehensive page layouts feature for customizing field display in detail and edit views using a 6-column drag-and-drop grid system powered by GridStack.js.
|
|
||||||
|
|
||||||
## What Was Built
|
|
||||||
|
|
||||||
### Backend (NestJS + PostgreSQL)
|
|
||||||
- ✅ Database migration for `page_layouts` table
|
|
||||||
- ✅ Complete CRUD API with 6 endpoints
|
|
||||||
- ✅ Service layer with tenant isolation
|
|
||||||
- ✅ DTO validation
|
|
||||||
- ✅ JWT authentication integration
|
|
||||||
|
|
||||||
### Frontend (Vue 3 + Nuxt)
|
|
||||||
- ✅ **PageLayoutEditor** - Visual drag-and-drop layout builder
|
|
||||||
- ✅ **PageLayoutRenderer** - Dynamic field rendering based on layouts
|
|
||||||
- ✅ **DetailViewEnhanced** - Enhanced detail view with layout support
|
|
||||||
- ✅ **EditViewEnhanced** - Enhanced edit view with layout support
|
|
||||||
- ✅ **usePageLayouts** - Composable for API interactions
|
|
||||||
- ✅ Setup page integration with tabs (Fields | Page Layouts)
|
|
||||||
|
|
||||||
## Key Features
|
|
||||||
|
|
||||||
### Layout Editor
|
|
||||||
- 6-column responsive grid
|
|
||||||
- Drag fields from sidebar to grid
|
|
||||||
- Reposition fields via drag-and-drop
|
|
||||||
- Horizontal resizing (1-6 columns width)
|
|
||||||
- Default 3-column width (2-column appearance)
|
|
||||||
- Fixed 80px height for consistency
|
|
||||||
- Remove fields from layout
|
|
||||||
- Clear all functionality
|
|
||||||
- Save/load layout state
|
|
||||||
|
|
||||||
### Layout Renderer
|
|
||||||
- CSS Grid-based rendering
|
|
||||||
- Position-aware field placement
|
|
||||||
- Size-aware field scaling
|
|
||||||
- All field types supported
|
|
||||||
- Readonly mode (detail view)
|
|
||||||
- Edit mode (form view)
|
|
||||||
- Automatic fallback to 2-column layout
|
|
||||||
|
|
||||||
### API Endpoints
|
|
||||||
```
|
|
||||||
POST /page-layouts Create new layout
|
|
||||||
GET /page-layouts?objectId={id} List layouts for object
|
|
||||||
GET /page-layouts/:id Get specific layout
|
|
||||||
GET /page-layouts/default/:objectId Get default layout
|
|
||||||
PATCH /page-layouts/:id Update layout (changed from PUT)
|
|
||||||
DELETE /page-layouts/:id Delete layout
|
|
||||||
```
|
|
||||||
|
|
||||||
## Files Created
|
|
||||||
|
|
||||||
### Backend
|
|
||||||
```
|
|
||||||
backend/
|
|
||||||
├── migrations/tenant/
|
|
||||||
│ └── 20250126000008_create_page_layouts.js
|
|
||||||
└── src/
|
|
||||||
├── app.module.ts (updated)
|
|
||||||
└── page-layout/
|
|
||||||
├── dto/
|
|
||||||
│ └── page-layout.dto.ts
|
|
||||||
├── page-layout.controller.ts
|
|
||||||
├── page-layout.service.ts
|
|
||||||
└── page-layout.module.ts
|
|
||||||
```
|
|
||||||
|
|
||||||
### Frontend
|
|
||||||
```
|
|
||||||
frontend/
|
|
||||||
├── components/
|
|
||||||
│ ├── PageLayoutEditor.vue
|
|
||||||
│ ├── PageLayoutRenderer.vue
|
|
||||||
│ └── views/
|
|
||||||
│ ├── DetailViewEnhanced.vue
|
|
||||||
│ └── EditViewEnhanced.vue
|
|
||||||
├── composables/
|
|
||||||
│ └── usePageLayouts.ts
|
|
||||||
├── pages/
|
|
||||||
│ └── setup/
|
|
||||||
│ └── objects/
|
|
||||||
│ └── [apiName].vue (updated)
|
|
||||||
└── types/
|
|
||||||
└── page-layout.ts
|
|
||||||
```
|
|
||||||
|
|
||||||
### Documentation
|
|
||||||
```
|
|
||||||
/root/neo/
|
|
||||||
├── PAGE_LAYOUTS_GUIDE.md
|
|
||||||
├── PAGE_LAYOUTS_IMPLEMENTATION_SUMMARY.md
|
|
||||||
├── PAGE_LAYOUTS_COMPLETE.md (this file)
|
|
||||||
└── setup-page-layouts.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
## Quick Start
|
|
||||||
|
|
||||||
### 1. Run Database Migration
|
|
||||||
```bash
|
|
||||||
cd backend
|
|
||||||
npm run migrate:tenant
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2. Start Services
|
|
||||||
```bash
|
|
||||||
# Terminal 1
|
|
||||||
cd backend && npm run start:dev
|
|
||||||
|
|
||||||
# Terminal 2
|
|
||||||
cd frontend && npm run dev
|
|
||||||
```
|
|
||||||
|
|
||||||
### 3. Create Your First Layout
|
|
||||||
1. Login to application
|
|
||||||
2. Navigate to **Setup → Objects → [Select Object]**
|
|
||||||
3. Click **Page Layouts** tab
|
|
||||||
4. Click **New Layout**
|
|
||||||
5. Name your layout
|
|
||||||
6. Drag fields from sidebar onto grid
|
|
||||||
7. Resize and arrange as needed
|
|
||||||
8. Click **Save Layout**
|
|
||||||
|
|
||||||
### 4. See It In Action
|
|
||||||
Visit any record detail or edit page for that object to see your custom layout!
|
|
||||||
|
|
||||||
## Technical Highlights
|
|
||||||
|
|
||||||
### Grid System
|
|
||||||
- **6 columns** for flexible layouts
|
|
||||||
- **Default 3-column width** (creates 2-column appearance)
|
|
||||||
- **Fixed 80px height** for visual consistency
|
|
||||||
- **CSS Grid** for performant rendering
|
|
||||||
- **Responsive** design
|
|
||||||
|
|
||||||
### Data Storage
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"fields": [
|
|
||||||
{
|
|
||||||
"fieldId": "field-uuid-here",
|
|
||||||
"x": 0, // Start column (0-5)
|
|
||||||
"y": 0, // Start row (0-based)
|
|
||||||
"w": 3, // Width in columns (1-6)
|
|
||||||
"h": 1 // Height in rows (always 1)
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Type Safety
|
|
||||||
- Full TypeScript support
|
|
||||||
- Validated DTOs on backend
|
|
||||||
- Type-safe composables
|
|
||||||
- Strongly-typed components
|
|
||||||
|
|
||||||
### Performance
|
|
||||||
- Layouts cached after first load
|
|
||||||
- JSONB column for efficient queries
|
|
||||||
- CSS Grid for fast rendering
|
|
||||||
- Optimized drag-and-drop
|
|
||||||
|
|
||||||
## Integration Examples
|
|
||||||
|
|
||||||
### Use Enhanced Views
|
|
||||||
```vue
|
|
||||||
<script setup>
|
|
||||||
import DetailViewEnhanced from '@/components/views/DetailViewEnhanced.vue'
|
|
||||||
import EditViewEnhanced from '@/components/views/EditViewEnhanced.vue'
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<DetailViewEnhanced
|
|
||||||
:config="detailConfig"
|
|
||||||
:data="record"
|
|
||||||
:object-id="objectId"
|
|
||||||
@edit="handleEdit"
|
|
||||||
/>
|
|
||||||
</template>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Use Renderer Directly
|
|
||||||
```vue
|
|
||||||
<script setup>
|
|
||||||
import PageLayoutRenderer from '@/components/PageLayoutRenderer.vue'
|
|
||||||
|
|
||||||
const { getDefaultPageLayout } = usePageLayouts()
|
|
||||||
const layout = ref(null)
|
|
||||||
|
|
||||||
onMounted(async () => {
|
|
||||||
layout.value = await getDefaultPageLayout(objectId)
|
|
||||||
})
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<PageLayoutRenderer
|
|
||||||
:fields="fields"
|
|
||||||
:layout="layout?.layoutConfig"
|
|
||||||
v-model="formData"
|
|
||||||
/>
|
|
||||||
</template>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Backward Compatibility
|
|
||||||
|
|
||||||
✅ Fully backward compatible:
|
|
||||||
- Objects without layouts use traditional views
|
|
||||||
- Existing components unaffected
|
|
||||||
- Enhanced views auto-detect layouts
|
|
||||||
- Graceful fallback to 2-column layout
|
|
||||||
|
|
||||||
## Testing Checklist
|
|
||||||
|
|
||||||
- [x] Migration runs without errors
|
|
||||||
- [x] API endpoints accessible
|
|
||||||
- [x] Can create page layout
|
|
||||||
- [x] Fields draggable from sidebar
|
|
||||||
- [x] Fields repositionable on grid
|
|
||||||
- [x] Fields resizable (width)
|
|
||||||
- [x] Layout saves successfully
|
|
||||||
- [x] Layout loads in detail view
|
|
||||||
- [x] Layout works in edit view
|
|
||||||
- [x] Multiple layouts per object
|
|
||||||
- [x] Default layout auto-loads
|
|
||||||
- [x] Can delete layout
|
|
||||||
- [x] Fallback works when no layout
|
|
||||||
|
|
||||||
## Known Limitations
|
|
||||||
|
|
||||||
1. **Height not resizable** - All fields have uniform 80px height
|
|
||||||
2. **No vertical sizing** - Only horizontal width is adjustable
|
|
||||||
3. **Single default layout** - Only one layout can be default per object
|
|
||||||
4. **No layout cloning** - Must create from scratch (future enhancement)
|
|
||||||
|
|
||||||
## Future Enhancements
|
|
||||||
|
|
||||||
- [ ] Variable field heights
|
|
||||||
- [ ] Multi-row field spanning
|
|
||||||
- [ ] Layout templates
|
|
||||||
- [ ] Clone/duplicate layouts
|
|
||||||
- [ ] Layout permissions
|
|
||||||
- [ ] Related list sections
|
|
||||||
- [ ] Responsive breakpoints
|
|
||||||
- [ ] Custom components
|
|
||||||
- [ ] Layout preview mode
|
|
||||||
- [ ] A/B testing support
|
|
||||||
|
|
||||||
## Troubleshooting
|
|
||||||
|
|
||||||
### Layout Not Appearing
|
|
||||||
**Check:**
|
|
||||||
- Migration ran successfully
|
|
||||||
- Default layout is set
|
|
||||||
- objectId prop passed to enhanced views
|
|
||||||
- Browser console for errors
|
|
||||||
|
|
||||||
### Fields Not Draggable
|
|
||||||
**Check:**
|
|
||||||
- GridStack CSS loaded
|
|
||||||
- `draggable="true"` on sidebar items
|
|
||||||
- Browser JavaScript enabled
|
|
||||||
- No console errors
|
|
||||||
|
|
||||||
### Layout Not Saving
|
|
||||||
**Check:**
|
|
||||||
- API endpoint accessible
|
|
||||||
- JWT token valid
|
|
||||||
- Network tab for failed requests
|
|
||||||
- Backend logs for errors
|
|
||||||
|
|
||||||
## Performance Notes
|
|
||||||
|
|
||||||
- Initial layout fetch: ~50-100ms
|
|
||||||
- Drag operation: <16ms (60fps)
|
|
||||||
- Save operation: ~100-200ms
|
|
||||||
- Render time: ~50ms for 20 fields
|
|
||||||
|
|
||||||
## Security
|
|
||||||
|
|
||||||
- ✅ JWT authentication required
|
|
||||||
- ✅ Tenant isolation enforced
|
|
||||||
- ✅ Input validation on DTOs
|
|
||||||
- ✅ RBAC compatible (admin only for editing)
|
|
||||||
- ✅ SQL injection prevented (parameterized queries)
|
|
||||||
|
|
||||||
## Browser Support
|
|
||||||
|
|
||||||
- ✅ Chrome 90+
|
|
||||||
- ✅ Firefox 88+
|
|
||||||
- ✅ Safari 14+
|
|
||||||
- ✅ Edge 90+
|
|
||||||
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
### Backend
|
|
||||||
- @nestjs/common: ^10.3.0
|
|
||||||
- class-validator: (existing)
|
|
||||||
- knex: (existing)
|
|
||||||
|
|
||||||
### Frontend
|
|
||||||
- gridstack: ^10.x (newly added)
|
|
||||||
- vue: ^3.4.15
|
|
||||||
- nuxt: ^3.10.0
|
|
||||||
|
|
||||||
## Maintenance
|
|
||||||
|
|
||||||
### Adding New Field Types
|
|
||||||
1. Add type to field component mapping in PageLayoutRenderer
|
|
||||||
2. Ensure field component follows FieldRenderer interface
|
|
||||||
3. Test in both detail and edit modes
|
|
||||||
|
|
||||||
### Modifying Grid Settings
|
|
||||||
Edit PageLayoutEditor.vue:
|
|
||||||
```typescript
|
|
||||||
GridStack.init({
|
|
||||||
column: 6, // Number of columns
|
|
||||||
cellHeight: 80, // Cell height in px
|
|
||||||
// ...other options
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
## Success Metrics
|
|
||||||
|
|
||||||
✅ **Implementation**: 100% complete
|
|
||||||
✅ **Type Safety**: Full TypeScript coverage
|
|
||||||
✅ **Testing**: All core functionality verified
|
|
||||||
✅ **Documentation**: Comprehensive guides created
|
|
||||||
✅ **Performance**: Meets 60fps drag operations
|
|
||||||
✅ **Compatibility**: Backward compatible
|
|
||||||
|
|
||||||
## Support
|
|
||||||
|
|
||||||
For questions or issues:
|
|
||||||
1. Check [PAGE_LAYOUTS_GUIDE.md](./PAGE_LAYOUTS_GUIDE.md) for detailed usage
|
|
||||||
2. Review [PAGE_LAYOUTS_IMPLEMENTATION_SUMMARY.md](./PAGE_LAYOUTS_IMPLEMENTATION_SUMMARY.md) for technical details
|
|
||||||
3. Check browser console for client-side errors
|
|
||||||
4. Review backend logs for server-side issues
|
|
||||||
|
|
||||||
## Credits
|
|
||||||
|
|
||||||
- **GridStack.js** - Drag-and-drop grid library
|
|
||||||
- **shadcn/ui** - UI component library
|
|
||||||
- **NestJS** - Backend framework
|
|
||||||
- **Nuxt 3** - Frontend framework
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Status**: ✅ PRODUCTION READY
|
|
||||||
|
|
||||||
**Last Updated**: December 22, 2025
|
|
||||||
|
|
||||||
**Version**: 1.0.0
|
|
||||||
@@ -1,304 +0,0 @@
|
|||||||
# Page Layouts Feature
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
The Page Layouts feature allows administrators to customize how fields are displayed in detail and edit views using a visual drag-and-drop interface based on GridStack.js with a 6-column grid system.
|
|
||||||
|
|
||||||
## Architecture
|
|
||||||
|
|
||||||
### Backend Components
|
|
||||||
|
|
||||||
1. **Database Schema** (`migrations/tenant/20250126000008_create_page_layouts.js`)
|
|
||||||
- `page_layouts` table stores layout configurations
|
|
||||||
- Fields: `id`, `name`, `object_id`, `is_default`, `layout_config`, `description`
|
|
||||||
- JSON-based `layout_config` stores field positions and sizes
|
|
||||||
|
|
||||||
2. **API Endpoints** (`src/page-layout/`)
|
|
||||||
- `POST /page-layouts` - Create a new page layout
|
|
||||||
- `GET /page-layouts?objectId={id}` - Get all layouts for an object
|
|
||||||
- `GET /page-layouts/:id` - Get a specific layout
|
|
||||||
- `GET /page-layouts/default/:objectId` - Get the default layout for an object
|
|
||||||
- `PATCH /page-layouts/:id` - Update a layout
|
|
||||||
- `DELETE /page-layouts/:id` - Delete a layout
|
|
||||||
|
|
||||||
### Frontend Components
|
|
||||||
|
|
||||||
1. **PageLayoutEditor.vue** - Visual editor for creating/editing layouts
|
|
||||||
- 6-column grid system using GridStack.js
|
|
||||||
- Drag and drop fields from sidebar
|
|
||||||
- Resize fields horizontally (1-6 columns width)
|
|
||||||
- Default width: 3 columns (2-column template effect)
|
|
||||||
- Save layout configuration
|
|
||||||
|
|
||||||
2. **PageLayoutRenderer.vue** - Renders fields based on saved layouts
|
|
||||||
- Used in detail and edit views
|
|
||||||
- Falls back to traditional 2-column layout if no layout configured
|
|
||||||
- Supports all field types
|
|
||||||
|
|
||||||
3. **DetailViewEnhanced.vue** & **EditViewEnhanced.vue**
|
|
||||||
- Enhanced versions of views with page layout support
|
|
||||||
- Automatically fetch and use default page layout
|
|
||||||
- Maintain backward compatibility with section-based layouts
|
|
||||||
|
|
||||||
### Types
|
|
||||||
|
|
||||||
- **PageLayout** (`types/page-layout.ts`)
|
|
||||||
- Layout metadata and configuration
|
|
||||||
- Field position and size definitions
|
|
||||||
- Grid configuration options
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
### 1. Run Database Migration
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd backend
|
|
||||||
npm run migrate:tenant
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2. Configure Page Layouts
|
|
||||||
|
|
||||||
Navigate to **Setup → Objects → [Object Name] → Page Layouts** tab:
|
|
||||||
|
|
||||||
1. Click "New Layout" to create a layout
|
|
||||||
2. Enter a layout name
|
|
||||||
3. Drag fields from the right sidebar onto the 6-column grid
|
|
||||||
4. Resize fields by dragging their edges (width only)
|
|
||||||
5. Rearrange fields by dragging them to new positions
|
|
||||||
6. Click "Save Layout" to persist changes
|
|
||||||
|
|
||||||
### 3. Use in Views
|
|
||||||
|
|
||||||
#### Option A: Use Enhanced Views (Recommended)
|
|
||||||
|
|
||||||
Replace existing views in your page:
|
|
||||||
|
|
||||||
```vue
|
|
||||||
<script setup>
|
|
||||||
import DetailViewEnhanced from '@/components/views/DetailViewEnhanced.vue'
|
|
||||||
import EditViewEnhanced from '@/components/views/EditViewEnhanced.vue'
|
|
||||||
|
|
||||||
const objectDefinition = ref(null)
|
|
||||||
|
|
||||||
// Fetch object definition...
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<!-- Detail View -->
|
|
||||||
<DetailViewEnhanced
|
|
||||||
:config="detailConfig"
|
|
||||||
:data="currentRecord"
|
|
||||||
:object-id="objectDefinition.id"
|
|
||||||
@edit="handleEdit"
|
|
||||||
@delete="handleDelete"
|
|
||||||
@back="handleBack"
|
|
||||||
/>
|
|
||||||
|
|
||||||
<!-- Edit View -->
|
|
||||||
<EditViewEnhanced
|
|
||||||
:config="editConfig"
|
|
||||||
:data="currentRecord"
|
|
||||||
:object-id="objectDefinition.id"
|
|
||||||
@save="handleSave"
|
|
||||||
@cancel="handleCancel"
|
|
||||||
@back="handleBack"
|
|
||||||
/>
|
|
||||||
</template>
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Option B: Use PageLayoutRenderer Directly
|
|
||||||
|
|
||||||
```vue
|
|
||||||
<script setup>
|
|
||||||
import PageLayoutRenderer from '@/components/PageLayoutRenderer.vue'
|
|
||||||
import { usePageLayouts } from '~/composables/usePageLayouts'
|
|
||||||
|
|
||||||
const { getDefaultPageLayout } = usePageLayouts()
|
|
||||||
const pageLayout = ref(null)
|
|
||||||
|
|
||||||
onMounted(async () => {
|
|
||||||
const layout = await getDefaultPageLayout(objectId)
|
|
||||||
if (layout) {
|
|
||||||
pageLayout.value = layout.layoutConfig
|
|
||||||
}
|
|
||||||
})
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<PageLayoutRenderer
|
|
||||||
:fields="fields"
|
|
||||||
:layout="pageLayout"
|
|
||||||
:model-value="formData"
|
|
||||||
:readonly="false"
|
|
||||||
@update:model-value="formData = $event"
|
|
||||||
/>
|
|
||||||
</template>
|
|
||||||
```
|
|
||||||
|
|
||||||
### 4. Composable API
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
const {
|
|
||||||
getPageLayouts, // Get all layouts for an object
|
|
||||||
getPageLayout, // Get a specific layout
|
|
||||||
getDefaultPageLayout, // Get default layout for an object
|
|
||||||
createPageLayout, // Create new layout
|
|
||||||
updatePageLayout, // Update existing layout
|
|
||||||
deletePageLayout // Delete layout
|
|
||||||
} = usePageLayouts()
|
|
||||||
|
|
||||||
// Example: Create a layout
|
|
||||||
await createPageLayout({
|
|
||||||
name: 'Sales Layout',
|
|
||||||
objectId: 'uuid-here',
|
|
||||||
isDefault: true,
|
|
||||||
layoutConfig: {
|
|
||||||
fields: [
|
|
||||||
{ fieldId: 'field-1', x: 0, y: 0, w: 3, h: 1 },
|
|
||||||
{ fieldId: 'field-2', x: 3, y: 0, w: 3, h: 1 },
|
|
||||||
]
|
|
||||||
}
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
## Grid System
|
|
||||||
|
|
||||||
### Configuration
|
|
||||||
- **Columns**: 6
|
|
||||||
- **Default field width**: 3 columns (50% width)
|
|
||||||
- **Min width**: 1 column (16.67%)
|
|
||||||
- **Max width**: 6 columns (100%)
|
|
||||||
- **Height**: Fixed at 1 unit (80px), uniform across all fields
|
|
||||||
|
|
||||||
### Layout Example
|
|
||||||
|
|
||||||
```
|
|
||||||
┌─────────────────────┬─────────────────────┐
|
|
||||||
│ Field 1 (w:3) │ Field 2 (w:3) │ ← Two 3-column fields
|
|
||||||
├─────────────────────┴─────────────────────┤
|
|
||||||
│ Field 3 (w:6) │ ← One full-width field
|
|
||||||
├──────────┬──────────┬──────────┬──────────┤
|
|
||||||
│ F4 (w:2) │ F5 (w:2) │ F6 (w:2) │ (empty) │ ← Three 2-column fields
|
|
||||||
└──────────┴──────────┴──────────┴──────────┘
|
|
||||||
```
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
### Editor
|
|
||||||
- ✅ 6-column responsive grid
|
|
||||||
- ✅ Drag fields from sidebar to grid
|
|
||||||
- ✅ Drag to reposition fields on grid
|
|
||||||
- ✅ Resize fields horizontally (1-6 columns)
|
|
||||||
- ✅ Remove fields from layout
|
|
||||||
- ✅ Save layout configuration
|
|
||||||
- ✅ Clear all fields
|
|
||||||
|
|
||||||
### Renderer
|
|
||||||
- ✅ Renders fields based on saved layout
|
|
||||||
- ✅ Respects field positioning and sizing
|
|
||||||
- ✅ Supports all field types
|
|
||||||
- ✅ Falls back to 2-column layout if no layout configured
|
|
||||||
- ✅ Works in both readonly (detail) and edit modes
|
|
||||||
|
|
||||||
### Layout Management
|
|
||||||
- ✅ Multiple layouts per object
|
|
||||||
- ✅ Default layout designation
|
|
||||||
- ✅ Create, read, update, delete layouts
|
|
||||||
- ✅ Tab-based interface in object setup
|
|
||||||
|
|
||||||
## Backward Compatibility
|
|
||||||
|
|
||||||
The system maintains full backward compatibility:
|
|
||||||
- Objects without page layouts use traditional section-based views
|
|
||||||
- Existing DetailView and EditView components continue to work
|
|
||||||
- Enhanced views automatically detect and use page layouts when available
|
|
||||||
|
|
||||||
## Technical Details
|
|
||||||
|
|
||||||
### Layout Storage Format
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"fields": [
|
|
||||||
{
|
|
||||||
"fieldId": "uuid-of-field",
|
|
||||||
"x": 0, // Column start (0-5)
|
|
||||||
"y": 0, // Row start (0-based)
|
|
||||||
"w": 3, // Width in columns (1-6)
|
|
||||||
"h": 1 // Height in rows (fixed at 1)
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Field Component Mapping
|
|
||||||
|
|
||||||
The renderer automatically maps field types to appropriate components:
|
|
||||||
- TEXT → TextFieldView
|
|
||||||
- NUMBER → NumberFieldView
|
|
||||||
- DATE/DATETIME → DateFieldView
|
|
||||||
- BOOLEAN → BooleanFieldView
|
|
||||||
- PICKLIST → SelectFieldView
|
|
||||||
- EMAIL → EmailFieldView
|
|
||||||
- PHONE → PhoneFieldView
|
|
||||||
- URL → UrlFieldView
|
|
||||||
- CURRENCY → CurrencyFieldView
|
|
||||||
- PERCENT → PercentFieldView
|
|
||||||
- TEXTAREA → TextareaFieldView
|
|
||||||
|
|
||||||
## Development
|
|
||||||
|
|
||||||
### Adding New Field Types
|
|
||||||
|
|
||||||
1. Create field view component in `components/fields/`
|
|
||||||
2. Add mapping in `PageLayoutRenderer.vue`:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
const componentMap: Record<string, any> = {
|
|
||||||
// ... existing mappings
|
|
||||||
NEW_TYPE: NewFieldView,
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Customizing Grid Settings
|
|
||||||
|
|
||||||
Edit `PageLayoutEditor.vue`:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
grid = GridStack.init({
|
|
||||||
column: 6, // Change column count
|
|
||||||
cellHeight: 80, // Change cell height
|
|
||||||
minRow: 1, // Minimum rows
|
|
||||||
float: true, // Allow floating
|
|
||||||
acceptWidgets: true,
|
|
||||||
animate: true,
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
## Troubleshooting
|
|
||||||
|
|
||||||
### Layout not appearing
|
|
||||||
- Ensure migration has been run
|
|
||||||
- Check that a default layout is set
|
|
||||||
- Verify objectId is passed to enhanced views
|
|
||||||
|
|
||||||
### Fields not draggable
|
|
||||||
- Check GridStack CSS is loaded
|
|
||||||
- Verify draggable attribute on sidebar fields
|
|
||||||
- Check browser console for errors
|
|
||||||
|
|
||||||
### Layout not saving
|
|
||||||
- Verify API endpoints are accessible
|
|
||||||
- Check authentication token
|
|
||||||
- Review backend logs for errors
|
|
||||||
|
|
||||||
## Future Enhancements
|
|
||||||
|
|
||||||
- [ ] Variable field heights
|
|
||||||
- [ ] Field-level permissions in layouts
|
|
||||||
- [ ] Clone/duplicate layouts
|
|
||||||
- [ ] Layout templates
|
|
||||||
- [ ] Layout preview mode
|
|
||||||
- [ ] Responsive breakpoints
|
|
||||||
- [ ] Related list sections
|
|
||||||
- [ ] Custom components in layouts
|
|
||||||
@@ -1,286 +0,0 @@
|
|||||||
# Page Layouts Implementation Summary
|
|
||||||
|
|
||||||
## ✅ Completed Components
|
|
||||||
|
|
||||||
### Backend (100%)
|
|
||||||
|
|
||||||
1. **Database Schema** ✓
|
|
||||||
- Migration file: `backend/migrations/tenant/20250126000008_create_page_layouts.js`
|
|
||||||
- Table: `page_layouts` with JSONB layout configuration storage
|
|
||||||
|
|
||||||
2. **API Layer** ✓
|
|
||||||
- Service: `backend/src/page-layout/page-layout.service.ts`
|
|
||||||
- Controller: `backend/src/page-layout/page-layout.controller.ts`
|
|
||||||
- DTOs: `backend/src/page-layout/dto/page-layout.dto.ts`
|
|
||||||
- Module: `backend/src/page-layout/page-layout.module.ts`
|
|
||||||
- Registered in: `backend/src/app.module.ts`
|
|
||||||
|
|
||||||
### Frontend (100%)
|
|
||||||
|
|
||||||
1. **Core Components** ✓
|
|
||||||
- **PageLayoutEditor.vue** - Drag-and-drop layout editor with 6-column grid
|
|
||||||
- **PageLayoutRenderer.vue** - Renders fields based on saved layouts
|
|
||||||
- **DetailViewEnhanced.vue** - Detail view with page layout support
|
|
||||||
- **EditViewEnhanced.vue** - Edit view with page layout support
|
|
||||||
|
|
||||||
2. **Types & Interfaces** ✓
|
|
||||||
- `frontend/types/page-layout.ts` - TypeScript definitions
|
|
||||||
|
|
||||||
3. **Composables** ✓
|
|
||||||
- `frontend/composables/usePageLayouts.ts` - API interaction layer
|
|
||||||
|
|
||||||
4. **Page Integration** ✓
|
|
||||||
- Updated: `frontend/pages/setup/objects/[apiName].vue` with tabs
|
|
||||||
- Tab 1: Fields list
|
|
||||||
- Tab 2: Page layouts management and editor
|
|
||||||
|
|
||||||
### Dependencies ✓
|
|
||||||
- GridStack.js installed in frontend
|
|
||||||
- All required UI components available (Tabs, Button, Card, etc.)
|
|
||||||
|
|
||||||
## 🎯 Key Features Implemented
|
|
||||||
|
|
||||||
### Layout Editor
|
|
||||||
- [x] 6-column grid system
|
|
||||||
- [x] Drag fields from sidebar to grid
|
|
||||||
- [x] Reposition fields via drag-and-drop
|
|
||||||
- [x] Resize fields horizontally (1-6 columns)
|
|
||||||
- [x] Default 3-column width per field
|
|
||||||
- [x] Uniform height (80px)
|
|
||||||
- [x] Remove fields from layout
|
|
||||||
- [x] Clear all functionality
|
|
||||||
- [x] Save layout state
|
|
||||||
|
|
||||||
### Layout Renderer
|
|
||||||
- [x] Grid-based field rendering
|
|
||||||
- [x] Respects saved positions and sizes
|
|
||||||
- [x] All field types supported
|
|
||||||
- [x] Readonly mode (detail view)
|
|
||||||
- [x] Edit mode (form view)
|
|
||||||
- [x] Fallback to 2-column layout
|
|
||||||
|
|
||||||
### Layout Management
|
|
||||||
- [x] Create multiple layouts per object
|
|
||||||
- [x] Set default layout
|
|
||||||
- [x] Edit existing layouts
|
|
||||||
- [x] Delete layouts
|
|
||||||
- [x] List all layouts for object
|
|
||||||
|
|
||||||
### Integration
|
|
||||||
- [x] Setup page with tabs
|
|
||||||
- [x] Enhanced detail/edit views
|
|
||||||
- [x] Automatic default layout loading
|
|
||||||
- [x] Backward compatibility maintained
|
|
||||||
|
|
||||||
## 📦 File Structure
|
|
||||||
|
|
||||||
```
|
|
||||||
backend/
|
|
||||||
├── migrations/tenant/
|
|
||||||
│ └── 20250126000008_create_page_layouts.js
|
|
||||||
└── src/
|
|
||||||
└── page-layout/
|
|
||||||
├── dto/
|
|
||||||
│ └── page-layout.dto.ts
|
|
||||||
├── page-layout.controller.ts
|
|
||||||
├── page-layout.service.ts
|
|
||||||
└── page-layout.module.ts
|
|
||||||
|
|
||||||
frontend/
|
|
||||||
├── components/
|
|
||||||
│ ├── PageLayoutEditor.vue
|
|
||||||
│ ├── PageLayoutRenderer.vue
|
|
||||||
│ └── views/
|
|
||||||
│ ├── DetailViewEnhanced.vue
|
|
||||||
│ └── EditViewEnhanced.vue
|
|
||||||
├── composables/
|
|
||||||
│ └── usePageLayouts.ts
|
|
||||||
├── pages/
|
|
||||||
│ └── setup/
|
|
||||||
│ └── objects/
|
|
||||||
│ └── [apiName].vue (updated)
|
|
||||||
└── types/
|
|
||||||
└── page-layout.ts
|
|
||||||
|
|
||||||
Documentation/
|
|
||||||
├── PAGE_LAYOUTS_GUIDE.md
|
|
||||||
├── PAGE_LAYOUTS_IMPLEMENTATION_SUMMARY.md
|
|
||||||
└── setup-page-layouts.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
## 🚀 Quick Start
|
|
||||||
|
|
||||||
### 1. Run Setup Script
|
|
||||||
```bash
|
|
||||||
./setup-page-layouts.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2. Manual Setup (Alternative)
|
|
||||||
```bash
|
|
||||||
# Backend migration
|
|
||||||
cd backend
|
|
||||||
npm run migrate:tenant
|
|
||||||
|
|
||||||
# Frontend dependencies (already installed)
|
|
||||||
cd frontend
|
|
||||||
npm install gridstack
|
|
||||||
```
|
|
||||||
|
|
||||||
### 3. Start Services
|
|
||||||
```bash
|
|
||||||
# Terminal 1: Backend
|
|
||||||
cd backend
|
|
||||||
npm run start:dev
|
|
||||||
|
|
||||||
# Terminal 2: Frontend
|
|
||||||
cd frontend
|
|
||||||
npm run dev
|
|
||||||
```
|
|
||||||
|
|
||||||
### 4. Create Your First Layout
|
|
||||||
|
|
||||||
1. Login to your application
|
|
||||||
2. Navigate to **Setup → Objects**
|
|
||||||
3. Select an object (e.g., Account, Contact)
|
|
||||||
4. Click the **Page Layouts** tab
|
|
||||||
5. Click **New Layout**
|
|
||||||
6. Name your layout (e.g., "Standard Layout")
|
|
||||||
7. Drag fields from the right sidebar onto the grid
|
|
||||||
8. Resize and arrange as desired
|
|
||||||
9. Click **Save Layout**
|
|
||||||
|
|
||||||
### 5. View Results
|
|
||||||
|
|
||||||
Navigate to a record detail or edit page for that object to see your layout in action!
|
|
||||||
|
|
||||||
## 🔧 Testing Checklist
|
|
||||||
|
|
||||||
- [ ] Migration runs successfully
|
|
||||||
- [ ] Can create a new page layout
|
|
||||||
- [ ] Fields appear in sidebar
|
|
||||||
- [ ] Can drag field from sidebar to grid
|
|
||||||
- [ ] Can reposition field on grid
|
|
||||||
- [ ] Can resize field width
|
|
||||||
- [ ] Can remove field from grid
|
|
||||||
- [ ] Layout saves successfully
|
|
||||||
- [ ] Layout loads on detail view
|
|
||||||
- [ ] Layout works on edit view
|
|
||||||
- [ ] Multiple layouts can coexist
|
|
||||||
- [ ] Default layout is used automatically
|
|
||||||
- [ ] Can delete a layout
|
|
||||||
- [ ] Fallback works when no layout exists
|
|
||||||
|
|
||||||
## 📊 API Endpoints
|
|
||||||
|
|
||||||
```
|
|
||||||
POST /page-layouts - Create layout
|
|
||||||
GET /page-layouts?objectId={id} - List layouts
|
|
||||||
GET /page-layouts/:id - Get specific layout
|
|
||||||
GET /page-layouts/default/:objectId - Get default layout
|
|
||||||
PATCH /page-layouts/:id - Update layout
|
|
||||||
DELETE /page-layouts/:id - Delete layout
|
|
||||||
```
|
|
||||||
|
|
||||||
## 🎨 Grid System Specs
|
|
||||||
|
|
||||||
- **Columns**: 6
|
|
||||||
- **Cell Height**: 80px
|
|
||||||
- **Default Width**: 3 columns (50%)
|
|
||||||
- **Min Width**: 1 column (16.67%)
|
|
||||||
- **Max Width**: 6 columns (100%)
|
|
||||||
- **Height**: 1 row (fixed, not resizable)
|
|
||||||
|
|
||||||
## 🔄 Integration Examples
|
|
||||||
|
|
||||||
### Using Enhanced Views
|
|
||||||
|
|
||||||
```vue
|
|
||||||
<script setup>
|
|
||||||
import DetailViewEnhanced from '@/components/views/DetailViewEnhanced.vue'
|
|
||||||
import EditViewEnhanced from '@/components/views/EditViewEnhanced.vue'
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<DetailViewEnhanced
|
|
||||||
:config="detailConfig"
|
|
||||||
:data="currentRecord"
|
|
||||||
:object-id="objectDefinition.id"
|
|
||||||
@edit="handleEdit"
|
|
||||||
/>
|
|
||||||
</template>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Using Renderer Directly
|
|
||||||
|
|
||||||
```vue
|
|
||||||
<script setup>
|
|
||||||
import PageLayoutRenderer from '@/components/PageLayoutRenderer.vue'
|
|
||||||
|
|
||||||
const { getDefaultPageLayout } = usePageLayouts()
|
|
||||||
const layout = ref(null)
|
|
||||||
|
|
||||||
onMounted(async () => {
|
|
||||||
const result = await getDefaultPageLayout(objectId)
|
|
||||||
layout.value = result?.layoutConfig
|
|
||||||
})
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<PageLayoutRenderer
|
|
||||||
:fields="fields"
|
|
||||||
:layout="layout"
|
|
||||||
:model-value="formData"
|
|
||||||
@update:model-value="formData = $event"
|
|
||||||
/>
|
|
||||||
</template>
|
|
||||||
```
|
|
||||||
|
|
||||||
## 🐛 Common Issues & Solutions
|
|
||||||
|
|
||||||
### Issue: GridStack CSS not loading
|
|
||||||
**Solution**: Add to your main layout or nuxt.config.ts:
|
|
||||||
```javascript
|
|
||||||
css: ['gridstack/dist/gridstack.min.css']
|
|
||||||
```
|
|
||||||
|
|
||||||
### Issue: Fields not draggable
|
|
||||||
**Solution**: Ensure the field elements have `draggable="true"` attribute
|
|
||||||
|
|
||||||
### Issue: Layout not appearing in views
|
|
||||||
**Solution**: Pass `objectId` prop to enhanced views
|
|
||||||
|
|
||||||
### Issue: Migration fails
|
|
||||||
**Solution**: Check database connection and ensure migrations directory is correct
|
|
||||||
|
|
||||||
## 📈 Performance Considerations
|
|
||||||
|
|
||||||
- Layouts are cached on the frontend after first fetch
|
|
||||||
- JSONB column in PostgreSQL provides efficient storage and querying
|
|
||||||
- GridStack uses CSS Grid for performant rendering
|
|
||||||
- Only default layout is auto-loaded (other layouts loaded on-demand)
|
|
||||||
|
|
||||||
## 🔐 Security
|
|
||||||
|
|
||||||
- All endpoints protected by JWT authentication
|
|
||||||
- Tenant isolation maintained through service layer
|
|
||||||
- Layout operations scoped to authenticated user's tenant
|
|
||||||
- Input validation on all DTOs
|
|
||||||
|
|
||||||
## 🎓 Learning Resources
|
|
||||||
|
|
||||||
- [GridStack.js Documentation](https://gridstackjs.com)
|
|
||||||
- [PAGE_LAYOUTS_GUIDE.md](./PAGE_LAYOUTS_GUIDE.md) - Comprehensive usage guide
|
|
||||||
- Backend API follows NestJS best practices
|
|
||||||
- Frontend follows Vue 3 Composition API patterns
|
|
||||||
|
|
||||||
## 🚦 Status: Production Ready ✅
|
|
||||||
|
|
||||||
All core functionality is implemented and tested. The feature is backward compatible and ready for production use.
|
|
||||||
|
|
||||||
## 📝 Notes
|
|
||||||
|
|
||||||
- Height resizing intentionally disabled for consistent UI
|
|
||||||
- Default width of 3 columns provides good starting point (2-column effect)
|
|
||||||
- Sidebar shows only fields not yet on the layout
|
|
||||||
- Multiple layouts per object supported (admin can switch between them)
|
|
||||||
- Enhanced views maintain full compatibility with existing views
|
|
||||||
@@ -1,385 +0,0 @@
|
|||||||
# Quick Start: Field Types & Views
|
|
||||||
|
|
||||||
Get up and running with the field type system in 5 minutes!
|
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- Backend server running
|
|
||||||
- Frontend dev server running
|
|
||||||
- Database migrations applied
|
|
||||||
|
|
||||||
## Step 1: Apply Migration (1 min)
|
|
||||||
|
|
||||||
Add UI metadata support to the database:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd backend
|
|
||||||
npm run migrate:tenant
|
|
||||||
```
|
|
||||||
|
|
||||||
This adds the `ui_metadata` column to `field_definitions` table.
|
|
||||||
|
|
||||||
## Step 2: View the Demo (1 min)
|
|
||||||
|
|
||||||
See the system in action:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd frontend
|
|
||||||
npm run dev
|
|
||||||
```
|
|
||||||
|
|
||||||
Visit: **http://localhost:3000/demo/field-views**
|
|
||||||
|
|
||||||
You'll see:
|
|
||||||
- ✅ Interactive list view with data table
|
|
||||||
- ✅ Detail view with formatted fields
|
|
||||||
- ✅ Edit view with form validation
|
|
||||||
- ✅ All 15+ field types in action
|
|
||||||
|
|
||||||
## Step 3: Basic Usage (2 min)
|
|
||||||
|
|
||||||
Create a simple list view in your app:
|
|
||||||
|
|
||||||
```vue
|
|
||||||
<script setup lang="ts">
|
|
||||||
import { ref } from 'vue'
|
|
||||||
import { ListView } from '@/components/views'
|
|
||||||
import { FieldType, ViewMode } from '@/types/field-types'
|
|
||||||
|
|
||||||
const config = {
|
|
||||||
objectApiName: 'Product',
|
|
||||||
mode: ViewMode.LIST,
|
|
||||||
fields: [
|
|
||||||
{
|
|
||||||
id: '1',
|
|
||||||
apiName: 'name',
|
|
||||||
label: 'Product Name',
|
|
||||||
type: FieldType.TEXT,
|
|
||||||
isRequired: true,
|
|
||||||
sortable: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
id: '2',
|
|
||||||
apiName: 'price',
|
|
||||||
label: 'Price',
|
|
||||||
type: FieldType.CURRENCY,
|
|
||||||
prefix: '$',
|
|
||||||
sortable: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
id: '3',
|
|
||||||
apiName: 'inStock',
|
|
||||||
label: 'In Stock',
|
|
||||||
type: FieldType.BOOLEAN,
|
|
||||||
},
|
|
||||||
],
|
|
||||||
searchable: true,
|
|
||||||
}
|
|
||||||
|
|
||||||
const products = ref([
|
|
||||||
{ id: '1', name: 'Widget', price: 29.99, inStock: true },
|
|
||||||
{ id: '2', name: 'Gadget', price: 49.99, inStock: false },
|
|
||||||
])
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<ListView
|
|
||||||
:config="config"
|
|
||||||
:data="products"
|
|
||||||
@row-click="(row) => console.log('Clicked:', row)"
|
|
||||||
@create="() => console.log('Create new')"
|
|
||||||
/>
|
|
||||||
</template>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Step 4: Integrate with Backend (1 min)
|
|
||||||
|
|
||||||
Fetch object definitions from your API:
|
|
||||||
|
|
||||||
```vue
|
|
||||||
<script setup lang="ts">
|
|
||||||
import { ref, onMounted } from 'vue'
|
|
||||||
import { useApi } from '@/composables/useApi'
|
|
||||||
import { useFields } from '@/composables/useFieldViews'
|
|
||||||
import { ListView } from '@/components/views'
|
|
||||||
|
|
||||||
const api = useApi()
|
|
||||||
const { buildListViewConfig } = useFields()
|
|
||||||
|
|
||||||
const config = ref(null)
|
|
||||||
const data = ref([])
|
|
||||||
|
|
||||||
onMounted(async () => {
|
|
||||||
// Fetch object definition with UI config
|
|
||||||
const objectDef = await api.get('/api/setup/objects/Contact/ui-config')
|
|
||||||
config.value = buildListViewConfig(objectDef.data)
|
|
||||||
|
|
||||||
// Fetch records
|
|
||||||
const records = await api.get('/api/runtime/objects/Contact')
|
|
||||||
data.value = records.data
|
|
||||||
})
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<ListView v-if="config" :config="config" :data="data" />
|
|
||||||
</template>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Common Field Types
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// Text Input
|
|
||||||
{
|
|
||||||
apiName: 'name',
|
|
||||||
label: 'Name',
|
|
||||||
type: FieldType.TEXT,
|
|
||||||
placeholder: 'Enter name',
|
|
||||||
isRequired: true,
|
|
||||||
}
|
|
||||||
|
|
||||||
// Email with validation
|
|
||||||
{
|
|
||||||
apiName: 'email',
|
|
||||||
label: 'Email',
|
|
||||||
type: FieldType.EMAIL,
|
|
||||||
validationRules: [
|
|
||||||
{ type: 'email', message: 'Invalid email' }
|
|
||||||
],
|
|
||||||
}
|
|
||||||
|
|
||||||
// Select/Dropdown
|
|
||||||
{
|
|
||||||
apiName: 'status',
|
|
||||||
label: 'Status',
|
|
||||||
type: FieldType.SELECT,
|
|
||||||
options: [
|
|
||||||
{ label: 'Active', value: 'active' },
|
|
||||||
{ label: 'Inactive', value: 'inactive' },
|
|
||||||
],
|
|
||||||
}
|
|
||||||
|
|
||||||
// Boolean/Checkbox
|
|
||||||
{
|
|
||||||
apiName: 'isActive',
|
|
||||||
label: 'Active',
|
|
||||||
type: FieldType.BOOLEAN,
|
|
||||||
}
|
|
||||||
|
|
||||||
// Date Picker
|
|
||||||
{
|
|
||||||
apiName: 'startDate',
|
|
||||||
label: 'Start Date',
|
|
||||||
type: FieldType.DATE,
|
|
||||||
}
|
|
||||||
|
|
||||||
// Currency
|
|
||||||
{
|
|
||||||
apiName: 'price',
|
|
||||||
label: 'Price',
|
|
||||||
type: FieldType.CURRENCY,
|
|
||||||
prefix: '$',
|
|
||||||
step: 0.01,
|
|
||||||
}
|
|
||||||
|
|
||||||
// Textarea
|
|
||||||
{
|
|
||||||
apiName: 'description',
|
|
||||||
label: 'Description',
|
|
||||||
type: FieldType.TEXTAREA,
|
|
||||||
rows: 4,
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Three View Types
|
|
||||||
|
|
||||||
### ListView - Data Table
|
|
||||||
```vue
|
|
||||||
<ListView
|
|
||||||
:config="listConfig"
|
|
||||||
:data="records"
|
|
||||||
selectable
|
|
||||||
@row-click="handleRowClick"
|
|
||||||
@create="handleCreate"
|
|
||||||
@delete="handleDelete"
|
|
||||||
/>
|
|
||||||
```
|
|
||||||
|
|
||||||
### DetailView - Read-only Display
|
|
||||||
```vue
|
|
||||||
<DetailView
|
|
||||||
:config="detailConfig"
|
|
||||||
:data="record"
|
|
||||||
@edit="handleEdit"
|
|
||||||
@delete="handleDelete"
|
|
||||||
@back="handleBack"
|
|
||||||
/>
|
|
||||||
```
|
|
||||||
|
|
||||||
### EditView - Form with Validation
|
|
||||||
```vue
|
|
||||||
<EditView
|
|
||||||
:config="editConfig"
|
|
||||||
:data="record"
|
|
||||||
:saving="saving"
|
|
||||||
@save="handleSave"
|
|
||||||
@cancel="handleCancel"
|
|
||||||
@back="handleBack"
|
|
||||||
/>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Using Composables
|
|
||||||
|
|
||||||
### useFields() - Build Configs
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { useFields } from '@/composables/useFieldViews'
|
|
||||||
|
|
||||||
const { buildListViewConfig, buildDetailViewConfig, buildEditViewConfig } = useFields()
|
|
||||||
|
|
||||||
// Convert backend object definition to view configs
|
|
||||||
const listConfig = buildListViewConfig(objectDef)
|
|
||||||
const detailConfig = buildDetailViewConfig(objectDef)
|
|
||||||
const editConfig = buildEditViewConfig(objectDef)
|
|
||||||
```
|
|
||||||
|
|
||||||
### useViewState() - CRUD Operations
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { useViewState } from '@/composables/useFieldViews'
|
|
||||||
|
|
||||||
const {
|
|
||||||
records, // Array of records
|
|
||||||
currentRecord, // Currently selected record
|
|
||||||
currentView, // 'list' | 'detail' | 'edit'
|
|
||||||
loading, // Loading state
|
|
||||||
saving, // Saving state
|
|
||||||
fetchRecords, // Fetch all records
|
|
||||||
fetchRecord, // Fetch single record
|
|
||||||
handleSave, // Save (create or update)
|
|
||||||
deleteRecords, // Delete records
|
|
||||||
showList, // Navigate to list view
|
|
||||||
showDetail, // Navigate to detail view
|
|
||||||
showEdit, // Navigate to edit view
|
|
||||||
} = useViewState('/api/objects/Contact')
|
|
||||||
|
|
||||||
// Fetch records
|
|
||||||
await fetchRecords()
|
|
||||||
|
|
||||||
// Create new
|
|
||||||
showEdit()
|
|
||||||
|
|
||||||
// View details
|
|
||||||
showDetail(record)
|
|
||||||
|
|
||||||
// Save changes
|
|
||||||
await handleSave(formData)
|
|
||||||
```
|
|
||||||
|
|
||||||
## Full CRUD Example
|
|
||||||
|
|
||||||
```vue
|
|
||||||
<script setup lang="ts">
|
|
||||||
import { computed } from 'vue'
|
|
||||||
import { useViewState, useFields } from '@/composables/useFieldViews'
|
|
||||||
import { ListView, DetailView, EditView } from '@/components/views'
|
|
||||||
|
|
||||||
// Fetch object definition
|
|
||||||
const objectDef = await $fetch('/api/setup/objects/Contact/ui-config')
|
|
||||||
|
|
||||||
// Build configs
|
|
||||||
const { buildListViewConfig, buildDetailViewConfig, buildEditViewConfig } = useFields()
|
|
||||||
const listConfig = buildListViewConfig(objectDef)
|
|
||||||
const detailConfig = buildDetailViewConfig(objectDef)
|
|
||||||
const editConfig = buildEditViewConfig(objectDef)
|
|
||||||
|
|
||||||
// Setup CRUD operations
|
|
||||||
const {
|
|
||||||
records,
|
|
||||||
currentRecord,
|
|
||||||
currentView,
|
|
||||||
loading,
|
|
||||||
saving,
|
|
||||||
fetchRecords,
|
|
||||||
handleSave,
|
|
||||||
deleteRecords,
|
|
||||||
showList,
|
|
||||||
showDetail,
|
|
||||||
showEdit,
|
|
||||||
} = useViewState('/api/objects/Contact')
|
|
||||||
|
|
||||||
// Fetch initial data
|
|
||||||
await fetchRecords()
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<div>
|
|
||||||
<!-- List View -->
|
|
||||||
<ListView
|
|
||||||
v-if="currentView === 'list'"
|
|
||||||
:config="listConfig"
|
|
||||||
:data="records"
|
|
||||||
:loading="loading"
|
|
||||||
@row-click="showDetail"
|
|
||||||
@create="() => showEdit()"
|
|
||||||
@delete="deleteRecords"
|
|
||||||
/>
|
|
||||||
|
|
||||||
<!-- Detail View -->
|
|
||||||
<DetailView
|
|
||||||
v-else-if="currentView === 'detail'"
|
|
||||||
:config="detailConfig"
|
|
||||||
:data="currentRecord"
|
|
||||||
@edit="showEdit"
|
|
||||||
@delete="() => deleteRecords([currentRecord.id])"
|
|
||||||
@back="showList"
|
|
||||||
/>
|
|
||||||
|
|
||||||
<!-- Edit View -->
|
|
||||||
<EditView
|
|
||||||
v-else-if="currentView === 'edit'"
|
|
||||||
:config="editConfig"
|
|
||||||
:data="currentRecord"
|
|
||||||
:saving="saving"
|
|
||||||
@save="handleSave"
|
|
||||||
@cancel="currentRecord?.id ? showDetail(currentRecord) : showList()"
|
|
||||||
@back="showList"
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
</template>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Next Steps
|
|
||||||
|
|
||||||
1. ✅ Read [FIELD_TYPES_GUIDE.md](./FIELD_TYPES_GUIDE.md) for complete documentation
|
|
||||||
2. ✅ Check [FIELD_TYPES_IMPLEMENTATION_SUMMARY.md](./FIELD_TYPES_IMPLEMENTATION_SUMMARY.md) for what was built
|
|
||||||
3. ✅ Run the demo at `/demo/field-views`
|
|
||||||
4. ✅ Try the dynamic route at `/app/objects/:objectName`
|
|
||||||
5. ✅ Customize field types as needed
|
|
||||||
6. ✅ Add validation rules to your fields
|
|
||||||
7. ✅ Configure sections for better organization
|
|
||||||
|
|
||||||
## Troubleshooting
|
|
||||||
|
|
||||||
**Fields not rendering?**
|
|
||||||
- Ensure migration is run: `npm run migrate:tenant`
|
|
||||||
- Check `ui_metadata` in database
|
|
||||||
- Verify field types are correct
|
|
||||||
|
|
||||||
**Components not found?**
|
|
||||||
```bash
|
|
||||||
cd frontend
|
|
||||||
npx shadcn-vue@latest add table checkbox switch textarea calendar
|
|
||||||
```
|
|
||||||
|
|
||||||
**Type errors?**
|
|
||||||
```typescript
|
|
||||||
import { FieldType, ViewMode, type FieldConfig } from '@/types/field-types'
|
|
||||||
```
|
|
||||||
|
|
||||||
## Need Help?
|
|
||||||
|
|
||||||
- See examples in `/frontend/pages/demo/field-views.vue`
|
|
||||||
- Check seed data in `/backend/seeds/example_contact_fields_with_ui_metadata.js`
|
|
||||||
- Read the full guide in `FIELD_TYPES_GUIDE.md`
|
|
||||||
|
|
||||||
Happy coding! 🎉
|
|
||||||
@@ -1,302 +0,0 @@
|
|||||||
# Tenant Migration Guide
|
|
||||||
|
|
||||||
## Quick Start
|
|
||||||
|
|
||||||
### Create a New Migration
|
|
||||||
```bash
|
|
||||||
cd backend
|
|
||||||
npm run migrate:make add_your_feature_name
|
|
||||||
```
|
|
||||||
|
|
||||||
Edit the generated file in `backend/migrations/tenant/`
|
|
||||||
|
|
||||||
### Test on Single Tenant
|
|
||||||
```bash
|
|
||||||
npm run migrate:tenant acme-corp
|
|
||||||
```
|
|
||||||
|
|
||||||
### Apply to All Tenants
|
|
||||||
```bash
|
|
||||||
npm run migrate:all-tenants
|
|
||||||
```
|
|
||||||
|
|
||||||
## Available Commands
|
|
||||||
|
|
||||||
| Command | Description |
|
|
||||||
|---------|-------------|
|
|
||||||
| `npm run migrate:make <name>` | Create a new migration file |
|
|
||||||
| `npm run migrate:tenant <slug>` | Run migrations for a specific tenant |
|
|
||||||
| `npm run migrate:all-tenants` | Run migrations for all active tenants |
|
|
||||||
| `npm run migrate:latest` | Run migrations (default DB - rarely used) |
|
|
||||||
| `npm run migrate:rollback` | Rollback last migration (default DB) |
|
|
||||||
|
|
||||||
## Architecture
|
|
||||||
|
|
||||||
### Multi-Tenant Database Structure
|
|
||||||
|
|
||||||
```
|
|
||||||
┌─────────────────────────┐
|
|
||||||
│ Central Database │
|
|
||||||
│ │
|
|
||||||
│ - tenants table │
|
|
||||||
│ - users table │
|
|
||||||
│ - (encrypted creds) │
|
|
||||||
└─────────────────────────┘
|
|
||||||
│
|
|
||||||
│ manages
|
|
||||||
│
|
|
||||||
┌───────┴────────┐
|
|
||||||
│ │
|
|
||||||
┌───▼────┐ ┌───▼────┐
|
|
||||||
│ Tenant │ │ Tenant │
|
|
||||||
│ DB1 │ ... │ DBN │
|
|
||||||
│ │ │ │
|
|
||||||
│ - users│ │ - users│
|
|
||||||
│ - roles│ │ - roles│
|
|
||||||
│ - apps │ │ - apps │
|
|
||||||
│ - ... │ │ - ... │
|
|
||||||
└────────┘ └────────┘
|
|
||||||
```
|
|
||||||
|
|
||||||
### How Migrations Work
|
|
||||||
|
|
||||||
1. **New Tenant Provisioning** (Automatic)
|
|
||||||
- User creates tenant via API
|
|
||||||
- `TenantProvisioningService.provisionTenant()` is called
|
|
||||||
- Database is created
|
|
||||||
- All migrations in `migrations/tenant/` are automatically run
|
|
||||||
- Tenant status set to ACTIVE
|
|
||||||
|
|
||||||
2. **Existing Tenants** (Manual)
|
|
||||||
- Developer creates new migration file
|
|
||||||
- Tests on single tenant: `npm run migrate:tenant test-tenant`
|
|
||||||
- Applies to all: `npm run migrate:all-tenants`
|
|
||||||
- Each tenant database is updated independently
|
|
||||||
|
|
||||||
### Migration Scripts
|
|
||||||
|
|
||||||
#### `migrate-tenant.ts`
|
|
||||||
- Accepts tenant slug or ID as argument
|
|
||||||
- Fetches tenant from central database
|
|
||||||
- Decrypts database password
|
|
||||||
- Creates Knex connection to tenant DB
|
|
||||||
- Runs pending migrations
|
|
||||||
- Reports success/failure
|
|
||||||
|
|
||||||
#### `migrate-all-tenants.ts`
|
|
||||||
- Fetches all ACTIVE tenants from central DB
|
|
||||||
- Iterates through each tenant
|
|
||||||
- Runs migrations sequentially
|
|
||||||
- Collects success/failure results
|
|
||||||
- Provides comprehensive summary
|
|
||||||
- Exits with error if any tenant fails
|
|
||||||
|
|
||||||
## Security
|
|
||||||
|
|
||||||
### Password Encryption
|
|
||||||
|
|
||||||
Tenant database passwords are encrypted using **AES-256-CBC** and stored in the central database.
|
|
||||||
|
|
||||||
**Required Environment Variable:**
|
|
||||||
```bash
|
|
||||||
DB_ENCRYPTION_KEY=your-32-character-secret-key!!
|
|
||||||
```
|
|
||||||
|
|
||||||
This key must:
|
|
||||||
- Be exactly 32 characters (256 bits)
|
|
||||||
- Match the key used by backend services
|
|
||||||
- Be kept secure (never commit to git)
|
|
||||||
- Be the same across all environments accessing tenant DBs
|
|
||||||
|
|
||||||
### Encryption Flow
|
|
||||||
|
|
||||||
```
|
|
||||||
Tenant Creation:
|
|
||||||
Plain Password → Encrypt → Store in Central DB
|
|
||||||
|
|
||||||
Migration Time:
|
|
||||||
Encrypted Password → Decrypt → Connect to Tenant DB → Run Migrations
|
|
||||||
```
|
|
||||||
|
|
||||||
## Example Workflow
|
|
||||||
|
|
||||||
### Adding a New Field to All Tenants
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# 1. Create migration
|
|
||||||
cd backend
|
|
||||||
npm run migrate:make add_priority_to_tasks
|
|
||||||
|
|
||||||
# 2. Edit the migration file
|
|
||||||
# migrations/tenant/20250127120000_add_priority_to_tasks.js
|
|
||||||
|
|
||||||
# 3. Test on staging tenant
|
|
||||||
npm run migrate:tenant staging-company
|
|
||||||
|
|
||||||
# 4. Verify it worked
|
|
||||||
# Connect to staging DB and check schema
|
|
||||||
|
|
||||||
# 5. Apply to all tenants
|
|
||||||
npm run migrate:all-tenants
|
|
||||||
```
|
|
||||||
|
|
||||||
Expected output:
|
|
||||||
```
|
|
||||||
🚀 Starting migration for all tenants...
|
|
||||||
|
|
||||||
📋 Found 5 active tenant(s)
|
|
||||||
|
|
||||||
🔄 Migrating tenant: Acme Corp (acme_corp_db)
|
|
||||||
✅ Acme Corp: Ran 1 migrations:
|
|
||||||
- 20250127120000_add_priority_to_tasks.js
|
|
||||||
|
|
||||||
🔄 Migrating tenant: TechStart (techstart_db)
|
|
||||||
✅ TechStart: Ran 1 migrations:
|
|
||||||
- 20250127120000_add_priority_to_tasks.js
|
|
||||||
|
|
||||||
...
|
|
||||||
|
|
||||||
============================================================
|
|
||||||
📊 Migration Summary
|
|
||||||
============================================================
|
|
||||||
✅ Successful: 5
|
|
||||||
❌ Failed: 0
|
|
||||||
|
|
||||||
🎉 All tenant migrations completed successfully!
|
|
||||||
```
|
|
||||||
|
|
||||||
## Troubleshooting
|
|
||||||
|
|
||||||
### Error: "Cannot find module '../prisma/generated-central/client'"
|
|
||||||
|
|
||||||
**Solution:** Generate Prisma client
|
|
||||||
```bash
|
|
||||||
cd backend
|
|
||||||
npx prisma generate --schema=prisma/schema-central.prisma
|
|
||||||
```
|
|
||||||
|
|
||||||
### Error: "Invalid encrypted password format"
|
|
||||||
|
|
||||||
**Solution:** Check `DB_ENCRYPTION_KEY` environment variable matches the one used for encryption.
|
|
||||||
|
|
||||||
### Error: "Migration failed: Table already exists"
|
|
||||||
|
|
||||||
**Cause:** Migration was partially applied or run manually
|
|
||||||
|
|
||||||
**Solution:**
|
|
||||||
```bash
|
|
||||||
# Check migration status in tenant DB
|
|
||||||
mysql -h <host> -u <user> -p<pass> <dbname> -e "SELECT * FROM knex_migrations"
|
|
||||||
|
|
||||||
# If migration is listed, it's already applied
|
|
||||||
# If not, investigate why table exists and fix manually
|
|
||||||
```
|
|
||||||
|
|
||||||
### Migration Hangs
|
|
||||||
|
|
||||||
**Possible causes:**
|
|
||||||
- Network connection to database lost
|
|
||||||
- Database server down
|
|
||||||
- Migration has long-running query
|
|
||||||
|
|
||||||
**Solution:** Add timeout to migration and check database connectivity
|
|
||||||
|
|
||||||
## Best Practices
|
|
||||||
|
|
||||||
1. ✅ **Test first**: Always test migrations on a single tenant before applying to all
|
|
||||||
2. ✅ **Rollback ready**: Write `down()` functions for every migration
|
|
||||||
3. ✅ **Idempotent**: Use `IF NOT EXISTS` clauses where possible
|
|
||||||
4. ✅ **Backup**: Take database backups before major migrations
|
|
||||||
5. ✅ **Monitor**: Watch the output of `migrate:all-tenants` carefully
|
|
||||||
6. ✅ **Version control**: Commit migration files to git
|
|
||||||
7. ✅ **Document**: Add comments explaining complex migrations
|
|
||||||
|
|
||||||
8. ❌ **Don't skip testing**: Never run untested migrations on production
|
|
||||||
9. ❌ **Don't modify**: Never modify existing migration files after they're deployed
|
|
||||||
10. ❌ **Don't forget down()**: Always implement rollback logic
|
|
||||||
|
|
||||||
## Integration with TenantProvisioningService
|
|
||||||
|
|
||||||
The migrations are also used during tenant provisioning:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// src/tenant/tenant-provisioning.service.ts
|
|
||||||
|
|
||||||
async provisionTenant(tenantId: string): Promise<void> {
|
|
||||||
// ... create database ...
|
|
||||||
|
|
||||||
// Run migrations automatically
|
|
||||||
await this.runTenantMigrations(tenant);
|
|
||||||
|
|
||||||
// ... update tenant status ...
|
|
||||||
}
|
|
||||||
|
|
||||||
async runTenantMigrations(tenant: any): Promise<void> {
|
|
||||||
const knexConfig = {
|
|
||||||
client: 'mysql2',
|
|
||||||
connection: {
|
|
||||||
host: tenant.dbHost,
|
|
||||||
port: tenant.dbPort,
|
|
||||||
user: tenant.dbUser,
|
|
||||||
password: decryptedPassword,
|
|
||||||
database: tenant.dbName,
|
|
||||||
},
|
|
||||||
migrations: {
|
|
||||||
directory: './migrations/tenant',
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
const knexInstance = knex(knexConfig);
|
|
||||||
await knexInstance.migrate.latest();
|
|
||||||
await knexInstance.destroy();
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
This ensures every new tenant starts with the complete schema.
|
|
||||||
|
|
||||||
## CI/CD Integration
|
|
||||||
|
|
||||||
### Docker Compose
|
|
||||||
```yaml
|
|
||||||
services:
|
|
||||||
backend:
|
|
||||||
image: your-backend:latest
|
|
||||||
command: sh -c "npm run migrate:all-tenants && npm run start:prod"
|
|
||||||
environment:
|
|
||||||
- DB_ENCRYPTION_KEY=${DB_ENCRYPTION_KEY}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Kubernetes Job
|
|
||||||
```yaml
|
|
||||||
apiVersion: batch/v1
|
|
||||||
kind: Job
|
|
||||||
metadata:
|
|
||||||
name: tenant-migrations
|
|
||||||
spec:
|
|
||||||
template:
|
|
||||||
spec:
|
|
||||||
containers:
|
|
||||||
- name: migrate
|
|
||||||
image: your-backend:latest
|
|
||||||
command: ["npm", "run", "migrate:all-tenants"]
|
|
||||||
env:
|
|
||||||
- name: DB_ENCRYPTION_KEY
|
|
||||||
valueFrom:
|
|
||||||
secretKeyRef:
|
|
||||||
name: db-secrets
|
|
||||||
key: encryption-key
|
|
||||||
restartPolicy: OnFailure
|
|
||||||
```
|
|
||||||
|
|
||||||
## Further Documentation
|
|
||||||
|
|
||||||
- [Backend Scripts README](backend/scripts/README.md) - Detailed script documentation
|
|
||||||
- [Multi-Tenant Implementation](MULTI_TENANT_IMPLEMENTATION.md) - Architecture overview
|
|
||||||
- [Multi-Tenant Migration](MULTI_TENANT_MIGRATION.md) - Migration strategy
|
|
||||||
|
|
||||||
## Support
|
|
||||||
|
|
||||||
For questions or issues:
|
|
||||||
1. Check the [Backend Scripts README](backend/scripts/README.md)
|
|
||||||
2. Review existing migration files in `backend/migrations/tenant/`
|
|
||||||
3. Check Knex documentation: https://knexjs.org/guide/migrations.html
|
|
||||||
@@ -1,374 +0,0 @@
|
|||||||
# Tenant Migration Implementation - Complete
|
|
||||||
|
|
||||||
## ✅ Implementation Summary
|
|
||||||
|
|
||||||
All tenant migration functionality has been successfully added to the backend. This implementation provides comprehensive tools for managing database schema changes across all tenants in the multi-tenant platform.
|
|
||||||
|
|
||||||
## 📁 Files Created
|
|
||||||
|
|
||||||
### Scripts Directory: `/root/neo/backend/scripts/`
|
|
||||||
|
|
||||||
1. **`migrate-tenant.ts`** (167 lines)
|
|
||||||
- Migrates a single tenant by slug or ID
|
|
||||||
- Handles password decryption
|
|
||||||
- Provides detailed progress output
|
|
||||||
- Usage: `npm run migrate:tenant <slug-or-id>`
|
|
||||||
|
|
||||||
2. **`migrate-all-tenants.ts`** (170 lines)
|
|
||||||
- Migrates all active tenants in sequence
|
|
||||||
- Collects success/failure statistics
|
|
||||||
- Provides comprehensive summary
|
|
||||||
- Exits with error code if any tenant fails
|
|
||||||
- Usage: `npm run migrate:all-tenants`
|
|
||||||
|
|
||||||
3. **`check-migration-status.ts`** (181 lines)
|
|
||||||
- Checks migration status across all tenants
|
|
||||||
- Shows completed and pending migrations
|
|
||||||
- Identifies which tenants need updates
|
|
||||||
- Usage: `npm run migrate:status`
|
|
||||||
|
|
||||||
4. **`README.md`** (Comprehensive documentation)
|
|
||||||
- Detailed usage instructions
|
|
||||||
- Security notes on password encryption
|
|
||||||
- Troubleshooting guide
|
|
||||||
- Best practices
|
|
||||||
- Example workflows
|
|
||||||
|
|
||||||
### Documentation Files
|
|
||||||
|
|
||||||
5. **`/root/neo/TENANT_MIGRATION_GUIDE.md`** (Root level guide)
|
|
||||||
- Quick start guide
|
|
||||||
- Architecture diagrams
|
|
||||||
- Complete workflow examples
|
|
||||||
- CI/CD integration examples
|
|
||||||
- Security documentation
|
|
||||||
|
|
||||||
### Updated Files
|
|
||||||
|
|
||||||
6. **`/root/neo/backend/package.json`**
|
|
||||||
- Added 6 new migration scripts to the `scripts` section
|
|
||||||
|
|
||||||
## 🚀 Available Commands
|
|
||||||
|
|
||||||
| Command | Description |
|
|
||||||
|---------|-------------|
|
|
||||||
| `npm run migrate:make <name>` | Create a new migration file in `migrations/tenant/` |
|
|
||||||
| `npm run migrate:status` | Check migration status for all tenants |
|
|
||||||
| `npm run migrate:tenant <slug>` | Run pending migrations for a specific tenant |
|
|
||||||
| `npm run migrate:all-tenants` | Run pending migrations for all active tenants |
|
|
||||||
| `npm run migrate:latest` | Run migrations on default database (rarely used) |
|
|
||||||
| `npm run migrate:rollback` | Rollback last migration on default database |
|
|
||||||
|
|
||||||
## 🔧 How It Works
|
|
||||||
|
|
||||||
### Architecture
|
|
||||||
|
|
||||||
```
|
|
||||||
┌─────────────────────────────────────────────────────────┐
|
|
||||||
│ Central Database │
|
|
||||||
│ │
|
|
||||||
│ ┌──────────┐ ┌──────────┐ ┌──────────┐ │
|
|
||||||
│ │ Tenant │ │ Tenant │ │ Tenant │ │
|
|
||||||
│ │ 1 │ │ 2 │ │ N │ │
|
|
||||||
│ └──────────┘ └──────────┘ └──────────┘ │
|
|
||||||
│ │ │ │ │
|
|
||||||
│ │ (encrypted │ │ │
|
|
||||||
│ │ password) │ │ │
|
|
||||||
└───────┼──────────────┼──────────────┼───────────────────┘
|
|
||||||
│ │ │
|
|
||||||
▼ ▼ ▼
|
|
||||||
┌───────────┐ ┌───────────┐ ┌───────────┐
|
|
||||||
│ Tenant │ │ Tenant │ │ Tenant │
|
|
||||||
│ DB 1 │ │ DB 2 │ │ DB N │
|
|
||||||
│ │ │ │ │ │
|
|
||||||
│ Migrations│ │ Migrations│ │ Migrations│
|
|
||||||
│ Applied │ │ Applied │ │ Applied │
|
|
||||||
└───────────┘ └───────────┘ └───────────┘
|
|
||||||
```
|
|
||||||
|
|
||||||
### Migration Flow
|
|
||||||
|
|
||||||
1. **Creating a Migration**
|
|
||||||
```bash
|
|
||||||
npm run migrate:make add_custom_fields
|
|
||||||
# Creates: migrations/tenant/20250127123456_add_custom_fields.js
|
|
||||||
```
|
|
||||||
|
|
||||||
2. **Testing on Single Tenant**
|
|
||||||
```bash
|
|
||||||
npm run migrate:tenant acme-corp
|
|
||||||
# Output:
|
|
||||||
# 📋 Tenant: Acme Corp (acme-corp)
|
|
||||||
# 📊 Database: acme_corp_db
|
|
||||||
# 🔄 Running migrations...
|
|
||||||
# ✅ Ran 1 migration(s):
|
|
||||||
# - 20250127123456_add_custom_fields.js
|
|
||||||
```
|
|
||||||
|
|
||||||
3. **Checking Status**
|
|
||||||
```bash
|
|
||||||
npm run migrate:status
|
|
||||||
# Shows which tenants have pending migrations
|
|
||||||
```
|
|
||||||
|
|
||||||
4. **Applying to All Tenants**
|
|
||||||
```bash
|
|
||||||
npm run migrate:all-tenants
|
|
||||||
# Migrates all active tenants sequentially
|
|
||||||
# Provides summary of successes/failures
|
|
||||||
```
|
|
||||||
|
|
||||||
## 🔐 Security Features
|
|
||||||
|
|
||||||
### Password Encryption
|
|
||||||
- Tenant database passwords are encrypted using **AES-256-CBC**
|
|
||||||
- Stored encrypted in central database
|
|
||||||
- Automatically decrypted during migration
|
|
||||||
- Requires `DB_ENCRYPTION_KEY` environment variable
|
|
||||||
|
|
||||||
### Environment Setup
|
|
||||||
```bash
|
|
||||||
# Required for migration scripts
|
|
||||||
export DB_ENCRYPTION_KEY="your-32-character-secret-key!!"
|
|
||||||
```
|
|
||||||
|
|
||||||
This key must match the key used by `TenantService` for encryption/decryption.
|
|
||||||
|
|
||||||
## 📋 Example Workflows
|
|
||||||
|
|
||||||
### Scenario 1: Adding a Field to All Tenants
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# 1. Create migration
|
|
||||||
npm run migrate:make add_priority_field
|
|
||||||
|
|
||||||
# 2. Edit the generated file
|
|
||||||
# migrations/tenant/20250127120000_add_priority_field.js
|
|
||||||
|
|
||||||
# 3. Test on one tenant
|
|
||||||
npm run migrate:tenant test-company
|
|
||||||
|
|
||||||
# 4. Check status
|
|
||||||
npm run migrate:status
|
|
||||||
|
|
||||||
# 5. Apply to all
|
|
||||||
npm run migrate:all-tenants
|
|
||||||
```
|
|
||||||
|
|
||||||
### Scenario 2: Checking Migration Status
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run migrate:status
|
|
||||||
|
|
||||||
# Output:
|
|
||||||
# 📋 Found 3 active tenant(s)
|
|
||||||
#
|
|
||||||
# 📦 Acme Corp (acme-corp)
|
|
||||||
# Database: acme_corp_db
|
|
||||||
# Completed: 5 migration(s)
|
|
||||||
# ✅ Up to date
|
|
||||||
#
|
|
||||||
# 📦 TechStart (techstart)
|
|
||||||
# Database: techstart_db
|
|
||||||
# Completed: 4 migration(s)
|
|
||||||
# ⚠️ Pending: 1 migration(s)
|
|
||||||
# - 20250127120000_add_priority_field.js
|
|
||||||
#
|
|
||||||
# 💡 Run: npm run migrate:all-tenants
|
|
||||||
```
|
|
||||||
|
|
||||||
### Scenario 3: New Tenant Provisioning (Automatic)
|
|
||||||
|
|
||||||
When a new tenant is created via the API:
|
|
||||||
```typescript
|
|
||||||
// Happens automatically in TenantProvisioningService
|
|
||||||
POST /tenants
|
|
||||||
{
|
|
||||||
"name": "New Company",
|
|
||||||
"slug": "new-company"
|
|
||||||
}
|
|
||||||
|
|
||||||
// Backend automatically:
|
|
||||||
// 1. Creates database
|
|
||||||
// 2. Runs all migrations
|
|
||||||
// 3. Sets tenant status to ACTIVE
|
|
||||||
```
|
|
||||||
|
|
||||||
## 🛠️ Technical Implementation
|
|
||||||
|
|
||||||
### Script Structure
|
|
||||||
|
|
||||||
All scripts follow this pattern:
|
|
||||||
|
|
||||||
1. **Import Dependencies**
|
|
||||||
```typescript
|
|
||||||
import { PrismaClient as CentralPrismaClient } from '../prisma/generated-central/client';
|
|
||||||
import knex, { Knex } from 'knex';
|
|
||||||
import { createDecipheriv } from 'crypto';
|
|
||||||
```
|
|
||||||
|
|
||||||
2. **Decrypt Password**
|
|
||||||
```typescript
|
|
||||||
function decryptPassword(encryptedPassword: string): string {
|
|
||||||
// AES-256-CBC decryption
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
3. **Create Tenant Connection**
|
|
||||||
```typescript
|
|
||||||
function createTenantKnexConnection(tenant: any): Knex {
|
|
||||||
const decryptedPassword = decryptPassword(tenant.dbPassword);
|
|
||||||
return knex({ /* config */ });
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
4. **Run Migrations**
|
|
||||||
```typescript
|
|
||||||
const [batchNo, log] = await tenantKnex.migrate.latest();
|
|
||||||
```
|
|
||||||
|
|
||||||
5. **Report Results**
|
|
||||||
```typescript
|
|
||||||
console.log(`✅ Ran ${log.length} migrations`);
|
|
||||||
```
|
|
||||||
|
|
||||||
## 🧪 Testing the Implementation
|
|
||||||
|
|
||||||
### 1. Verify Scripts Are Available
|
|
||||||
```bash
|
|
||||||
cd /root/neo/backend
|
|
||||||
npm run | grep migrate
|
|
||||||
```
|
|
||||||
|
|
||||||
Expected output:
|
|
||||||
```
|
|
||||||
migrate:make
|
|
||||||
migrate:latest
|
|
||||||
migrate:rollback
|
|
||||||
migrate:status
|
|
||||||
migrate:tenant
|
|
||||||
migrate:all-tenants
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2. Test Creating a Migration
|
|
||||||
```bash
|
|
||||||
npm run migrate:make test_migration
|
|
||||||
```
|
|
||||||
|
|
||||||
Should create a file in `migrations/tenant/`
|
|
||||||
|
|
||||||
### 3. Check Status (if tenants exist)
|
|
||||||
```bash
|
|
||||||
npm run migrate:status
|
|
||||||
```
|
|
||||||
|
|
||||||
### 4. Test Single Tenant Migration (if tenants exist)
|
|
||||||
```bash
|
|
||||||
npm run migrate:tenant <your-tenant-slug>
|
|
||||||
```
|
|
||||||
|
|
||||||
## 📚 Documentation Locations
|
|
||||||
|
|
||||||
- **Quick Reference**: `/root/neo/TENANT_MIGRATION_GUIDE.md`
|
|
||||||
- **Detailed Scripts Docs**: `/root/neo/backend/scripts/README.md`
|
|
||||||
- **Architecture Overview**: `/root/neo/MULTI_TENANT_IMPLEMENTATION.md`
|
|
||||||
|
|
||||||
## 🎯 Key Features
|
|
||||||
|
|
||||||
✅ **Single Tenant Migration** - Target specific tenants for testing
|
|
||||||
✅ **Bulk Migration** - Update all tenants at once
|
|
||||||
✅ **Status Checking** - See which tenants need updates
|
|
||||||
✅ **Progress Tracking** - Detailed output for each operation
|
|
||||||
✅ **Error Handling** - Graceful failure with detailed error messages
|
|
||||||
✅ **Security** - Encrypted password storage and decryption
|
|
||||||
✅ **Comprehensive Docs** - Multiple levels of documentation
|
|
||||||
|
|
||||||
## 🔄 Integration Points
|
|
||||||
|
|
||||||
### With Existing Code
|
|
||||||
|
|
||||||
1. **TenantProvisioningService**
|
|
||||||
- Already uses `runTenantMigrations()` method
|
|
||||||
- New scripts complement automatic provisioning
|
|
||||||
- Same migration directory: `migrations/tenant/`
|
|
||||||
|
|
||||||
2. **Knex Configuration**
|
|
||||||
- Uses existing `knexfile.js`
|
|
||||||
- Same migration table: `knex_migrations`
|
|
||||||
- Compatible with existing migrations
|
|
||||||
|
|
||||||
3. **Prisma Central Client**
|
|
||||||
- Scripts use central DB to fetch tenant list
|
|
||||||
- Same encryption/decryption logic as backend services
|
|
||||||
|
|
||||||
## 🚦 Next Steps
|
|
||||||
|
|
||||||
### To Use This Implementation:
|
|
||||||
|
|
||||||
1. **Ensure Environment Variables**
|
|
||||||
```bash
|
|
||||||
export DB_ENCRYPTION_KEY="your-32-character-secret-key!!"
|
|
||||||
```
|
|
||||||
|
|
||||||
2. **Generate Prisma Client** (if not already done)
|
|
||||||
```bash
|
|
||||||
cd /root/neo/backend
|
|
||||||
npx prisma generate --schema=prisma/schema-central.prisma
|
|
||||||
```
|
|
||||||
|
|
||||||
3. **Check Current Status**
|
|
||||||
```bash
|
|
||||||
npm run migrate:status
|
|
||||||
```
|
|
||||||
|
|
||||||
4. **Create Your First Migration**
|
|
||||||
```bash
|
|
||||||
npm run migrate:make add_my_feature
|
|
||||||
```
|
|
||||||
|
|
||||||
5. **Test and Apply**
|
|
||||||
```bash
|
|
||||||
# Test on one tenant
|
|
||||||
npm run migrate:tenant <slug>
|
|
||||||
|
|
||||||
# Apply to all
|
|
||||||
npm run migrate:all-tenants
|
|
||||||
```
|
|
||||||
|
|
||||||
## 📊 Complete File List
|
|
||||||
|
|
||||||
```
|
|
||||||
/root/neo/
|
|
||||||
├── TENANT_MIGRATION_GUIDE.md (new)
|
|
||||||
└── backend/
|
|
||||||
├── package.json (updated - 6 new scripts)
|
|
||||||
├── knexfile.js (existing)
|
|
||||||
├── migrations/
|
|
||||||
│ └── tenant/ (existing)
|
|
||||||
│ ├── 20250126000001_create_users_and_rbac.js
|
|
||||||
│ ├── 20250126000002_create_object_definitions.js
|
|
||||||
│ ├── 20250126000003_create_apps.js
|
|
||||||
│ ├── 20250126000004_create_standard_objects.js
|
|
||||||
│ └── 20250126000005_add_ui_metadata_to_fields.js
|
|
||||||
├── scripts/ (new directory)
|
|
||||||
│ ├── README.md (new)
|
|
||||||
│ ├── migrate-tenant.ts (new)
|
|
||||||
│ ├── migrate-all-tenants.ts (new)
|
|
||||||
│ └── check-migration-status.ts (new)
|
|
||||||
└── src/
|
|
||||||
└── tenant/
|
|
||||||
└── tenant-provisioning.service.ts (existing - uses migrations)
|
|
||||||
```
|
|
||||||
|
|
||||||
## ✨ Summary
|
|
||||||
|
|
||||||
The tenant migration system is now fully implemented with:
|
|
||||||
- ✅ 3 TypeScript migration scripts
|
|
||||||
- ✅ 6 npm commands
|
|
||||||
- ✅ 2 comprehensive documentation files
|
|
||||||
- ✅ Full integration with existing architecture
|
|
||||||
- ✅ Security features (password encryption)
|
|
||||||
- ✅ Error handling and progress reporting
|
|
||||||
- ✅ Status checking capabilities
|
|
||||||
|
|
||||||
You can now manage database migrations across all tenants efficiently and safely! 🎉
|
|
||||||
@@ -1,91 +0,0 @@
|
|||||||
╔══════════════════════════════════════════════════════════════════════╗
|
|
||||||
║ TENANT MIGRATION - QUICK REFERENCE ║
|
|
||||||
╚══════════════════════════════════════════════════════════════════════╝
|
|
||||||
|
|
||||||
📍 LOCATION: /root/neo/backend
|
|
||||||
|
|
||||||
┌─────────────────────────────────────────────────────────────────────┐
|
|
||||||
│ COMMON COMMANDS │
|
|
||||||
└─────────────────────────────────────────────────────────────────────┘
|
|
||||||
|
|
||||||
Create Migration:
|
|
||||||
$ npm run migrate:make add_my_feature
|
|
||||||
|
|
||||||
Check Status:
|
|
||||||
$ npm run migrate:status
|
|
||||||
|
|
||||||
Test on One Tenant:
|
|
||||||
$ npm run migrate:tenant acme-corp
|
|
||||||
|
|
||||||
Apply to All Tenants:
|
|
||||||
$ npm run migrate:all-tenants
|
|
||||||
|
|
||||||
|
|
||||||
┌─────────────────────────────────────────────────────────────────────┐
|
|
||||||
│ ALL AVAILABLE COMMANDS │
|
|
||||||
└─────────────────────────────────────────────────────────────────────┘
|
|
||||||
|
|
||||||
npm run migrate:make <name> Create new migration file
|
|
||||||
npm run migrate:status Check status across all tenants
|
|
||||||
npm run migrate:tenant <slug> Migrate specific tenant
|
|
||||||
npm run migrate:all-tenants Migrate all active tenants
|
|
||||||
npm run migrate:latest Migrate default DB (rarely used)
|
|
||||||
npm run migrate:rollback Rollback default DB (rarely used)
|
|
||||||
|
|
||||||
|
|
||||||
┌─────────────────────────────────────────────────────────────────────┐
|
|
||||||
│ TYPICAL WORKFLOW │
|
|
||||||
└─────────────────────────────────────────────────────────────────────┘
|
|
||||||
|
|
||||||
1. Create: npm run migrate:make add_priority_field
|
|
||||||
2. Edit: vim migrations/tenant/20250127_*.js
|
|
||||||
3. Test: npm run migrate:tenant test-company
|
|
||||||
4. Status: npm run migrate:status
|
|
||||||
5. Deploy: npm run migrate:all-tenants
|
|
||||||
|
|
||||||
|
|
||||||
┌─────────────────────────────────────────────────────────────────────┐
|
|
||||||
│ ENVIRONMENT REQUIRED │
|
|
||||||
└─────────────────────────────────────────────────────────────────────┘
|
|
||||||
|
|
||||||
export DB_ENCRYPTION_KEY="your-32-character-secret-key!!"
|
|
||||||
|
|
||||||
|
|
||||||
┌─────────────────────────────────────────────────────────────────────┐
|
|
||||||
│ FILE LOCATIONS │
|
|
||||||
└─────────────────────────────────────────────────────────────────────┘
|
|
||||||
|
|
||||||
Scripts: backend/scripts/migrate-*.ts
|
|
||||||
Migrations: backend/migrations/tenant/
|
|
||||||
Config: backend/knexfile.js
|
|
||||||
Docs: TENANT_MIGRATION_GUIDE.md
|
|
||||||
|
|
||||||
|
|
||||||
┌─────────────────────────────────────────────────────────────────────┐
|
|
||||||
│ DOCUMENTATION │
|
|
||||||
└─────────────────────────────────────────────────────────────────────┘
|
|
||||||
|
|
||||||
Quick Guide: cat TENANT_MIGRATION_GUIDE.md
|
|
||||||
Script Docs: cat backend/scripts/README.md
|
|
||||||
Complete: cat TENANT_MIGRATION_IMPLEMENTATION_COMPLETE.md
|
|
||||||
|
|
||||||
|
|
||||||
┌─────────────────────────────────────────────────────────────────────┐
|
|
||||||
│ TROUBLESHOOTING │
|
|
||||||
└─────────────────────────────────────────────────────────────────────┘
|
|
||||||
|
|
||||||
Missing Prisma Client:
|
|
||||||
$ npx prisma generate --schema=prisma/schema-central.prisma
|
|
||||||
|
|
||||||
Check Scripts Available:
|
|
||||||
$ npm run | grep migrate
|
|
||||||
|
|
||||||
Connection Error:
|
|
||||||
- Check DB_ENCRYPTION_KEY matches encryption key
|
|
||||||
- Verify central database is accessible
|
|
||||||
- Ensure tenant databases are online
|
|
||||||
|
|
||||||
|
|
||||||
╔══════════════════════════════════════════════════════════════════════╗
|
|
||||||
║ For detailed help: cat TENANT_MIGRATION_GUIDE.md ║
|
|
||||||
╚══════════════════════════════════════════════════════════════════════╝
|
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
/**
|
|
||||||
* @param { import("knex").Knex } knex
|
|
||||||
* @returns { Promise<void> }
|
|
||||||
*/
|
|
||||||
exports.up = function(knex) {
|
|
||||||
return knex.schema.table('field_definitions', (table) => {
|
|
||||||
table.jsonb('ui_metadata').nullable().comment('JSON metadata for UI rendering including display options, validation rules, and field-specific configurations');
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param { import("knex").Knex } knex
|
|
||||||
* @returns { Promise<void> }
|
|
||||||
*/
|
|
||||||
exports.down = function(knex) {
|
|
||||||
return knex.schema.table('field_definitions', (table) => {
|
|
||||||
table.dropColumn('ui_metadata');
|
|
||||||
});
|
|
||||||
};
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
exports.up = function (knex) {
|
|
||||||
return knex.schema.table('object_definitions', (table) => {
|
|
||||||
table.string('nameField', 255).comment('API name of the field to use as record display name');
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
exports.down = function (knex) {
|
|
||||||
return knex.schema.table('object_definitions', (table) => {
|
|
||||||
table.dropColumn('nameField');
|
|
||||||
});
|
|
||||||
};
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
exports.up = function (knex) {
|
|
||||||
return knex.schema.table('object_definitions', (table) => {
|
|
||||||
table.uuid('app_id').nullable()
|
|
||||||
.comment('Optional: App that this object belongs to');
|
|
||||||
|
|
||||||
table
|
|
||||||
.foreign('app_id')
|
|
||||||
.references('id')
|
|
||||||
.inTable('apps')
|
|
||||||
.onDelete('SET NULL');
|
|
||||||
|
|
||||||
table.index(['app_id']);
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
exports.down = function (knex) {
|
|
||||||
return knex.schema.table('object_definitions', (table) => {
|
|
||||||
table.dropForeign('app_id');
|
|
||||||
table.dropIndex('app_id');
|
|
||||||
table.dropColumn('app_id');
|
|
||||||
});
|
|
||||||
};
|
|
||||||
@@ -1,29 +0,0 @@
|
|||||||
/**
|
|
||||||
* @param { import("knex").Knex } knex
|
|
||||||
* @returns { Promise<void> }
|
|
||||||
*/
|
|
||||||
exports.up = function(knex) {
|
|
||||||
return knex.schema.createTable('page_layouts', (table) => {
|
|
||||||
table.uuid('id').primary().defaultTo(knex.raw('(UUID())'));
|
|
||||||
table.string('name').notNullable();
|
|
||||||
table.uuid('object_id').notNullable();
|
|
||||||
table.boolean('is_default').defaultTo(false);
|
|
||||||
table.json('layout_config').notNullable();
|
|
||||||
table.text('description');
|
|
||||||
table.timestamps(true, true);
|
|
||||||
|
|
||||||
// Foreign key to object_definitions
|
|
||||||
table.foreign('object_id').references('id').inTable('object_definitions').onDelete('CASCADE');
|
|
||||||
|
|
||||||
// Index for faster lookups
|
|
||||||
table.index(['object_id', 'is_default']);
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param { import("knex").Knex } knex
|
|
||||||
* @returns { Promise<void> }
|
|
||||||
*/
|
|
||||||
exports.down = function(knex) {
|
|
||||||
return knex.schema.dropTable('page_layouts');
|
|
||||||
};
|
|
||||||
@@ -17,13 +17,7 @@
|
|||||||
"test:watch": "jest --watch",
|
"test:watch": "jest --watch",
|
||||||
"test:cov": "jest --coverage",
|
"test:cov": "jest --coverage",
|
||||||
"test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
|
"test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
|
||||||
"test:e2e": "jest --config ./test/jest-e2e.json",
|
"test:e2e": "jest --config ./test/jest-e2e.json"
|
||||||
"migrate:make": "knex migrate:make --knexfile=knexfile.js",
|
|
||||||
"migrate:latest": "knex migrate:latest --knexfile=knexfile.js",
|
|
||||||
"migrate:rollback": "knex migrate:rollback --knexfile=knexfile.js",
|
|
||||||
"migrate:status": "ts-node -r tsconfig-paths/register scripts/check-migration-status.ts",
|
|
||||||
"migrate:tenant": "ts-node -r tsconfig-paths/register scripts/migrate-tenant.ts",
|
|
||||||
"migrate:all-tenants": "ts-node -r tsconfig-paths/register scripts/migrate-all-tenants.ts"
|
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@nestjs/bullmq": "^10.1.0",
|
"@nestjs/bullmq": "^10.1.0",
|
||||||
|
|||||||
@@ -1,15 +0,0 @@
|
|||||||
-- CreateTable
|
|
||||||
CREATE TABLE `users` (
|
|
||||||
`id` VARCHAR(191) NOT NULL,
|
|
||||||
`email` VARCHAR(191) NOT NULL,
|
|
||||||
`password` VARCHAR(191) NOT NULL,
|
|
||||||
`firstName` VARCHAR(191) NULL,
|
|
||||||
`lastName` VARCHAR(191) NULL,
|
|
||||||
`role` VARCHAR(191) NOT NULL DEFAULT 'admin',
|
|
||||||
`isActive` BOOLEAN NOT NULL DEFAULT true,
|
|
||||||
`createdAt` DATETIME(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),
|
|
||||||
`updatedAt` DATETIME(3) NOT NULL,
|
|
||||||
|
|
||||||
UNIQUE INDEX `users_email_key`(`email`),
|
|
||||||
PRIMARY KEY (`id`)
|
|
||||||
) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
|
|
||||||
@@ -1,7 +1,6 @@
|
|||||||
generator client {
|
generator client {
|
||||||
provider = "prisma-client-js"
|
provider = "prisma-client-js"
|
||||||
output = "../node_modules/.prisma/central"
|
output = "../node_modules/.prisma/central"
|
||||||
binaryTargets = ["native", "debian-openssl-3.0.x"]
|
|
||||||
}
|
}
|
||||||
|
|
||||||
datasource db {
|
datasource db {
|
||||||
@@ -9,20 +8,6 @@ datasource db {
|
|||||||
url = env("CENTRAL_DATABASE_URL")
|
url = env("CENTRAL_DATABASE_URL")
|
||||||
}
|
}
|
||||||
|
|
||||||
model User {
|
|
||||||
id String @id @default(cuid())
|
|
||||||
email String @unique
|
|
||||||
password String
|
|
||||||
firstName String?
|
|
||||||
lastName String?
|
|
||||||
role String @default("admin") // admin, superadmin
|
|
||||||
isActive Boolean @default(true)
|
|
||||||
createdAt DateTime @default(now())
|
|
||||||
updatedAt DateTime @updatedAt
|
|
||||||
|
|
||||||
@@map("users")
|
|
||||||
}
|
|
||||||
|
|
||||||
model Tenant {
|
model Tenant {
|
||||||
id String @id @default(cuid())
|
id String @id @default(cuid())
|
||||||
name String
|
name String
|
||||||
|
|||||||
@@ -1,11 +1,9 @@
|
|||||||
// Tenant-specific database schema
|
// Tenant-specific database schema
|
||||||
// This schema is applied to each tenant's database
|
// This schema is applied to each tenant's database
|
||||||
// NOTE: Each tenant has its own database, so there is NO tenantId column in these tables
|
|
||||||
|
|
||||||
generator client {
|
generator client {
|
||||||
provider = "prisma-client-js"
|
provider = "prisma-client-js"
|
||||||
output = "../node_modules/.prisma/tenant"
|
output = "../node_modules/.prisma/tenant"
|
||||||
binaryTargets = ["native", "debian-openssl-3.0.x"]
|
|
||||||
}
|
}
|
||||||
|
|
||||||
datasource db {
|
datasource db {
|
||||||
@@ -13,10 +11,30 @@ datasource db {
|
|||||||
url = env("TENANT_DATABASE_URL")
|
url = env("TENANT_DATABASE_URL")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Multi-tenancy
|
||||||
|
model Tenant {
|
||||||
|
id String @id @default(uuid())
|
||||||
|
name String
|
||||||
|
slug String @unique
|
||||||
|
isActive Boolean @default(true)
|
||||||
|
createdAt DateTime @default(now())
|
||||||
|
updatedAt DateTime @updatedAt
|
||||||
|
|
||||||
|
users User[]
|
||||||
|
objectDefinitions ObjectDefinition[]
|
||||||
|
accounts Account[]
|
||||||
|
apps App[]
|
||||||
|
roles Role[]
|
||||||
|
permissions Permission[]
|
||||||
|
|
||||||
|
@@map("tenants")
|
||||||
|
}
|
||||||
|
|
||||||
// User & Auth
|
// User & Auth
|
||||||
model User {
|
model User {
|
||||||
id String @id @default(uuid())
|
id String @id @default(uuid())
|
||||||
email String @unique
|
tenantId String
|
||||||
|
email String
|
||||||
password String
|
password String
|
||||||
firstName String?
|
firstName String?
|
||||||
lastName String?
|
lastName String?
|
||||||
@@ -24,39 +42,48 @@ model User {
|
|||||||
createdAt DateTime @default(now())
|
createdAt DateTime @default(now())
|
||||||
updatedAt DateTime @updatedAt
|
updatedAt DateTime @updatedAt
|
||||||
|
|
||||||
|
tenant Tenant @relation(fields: [tenantId], references: [id], onDelete: Cascade)
|
||||||
userRoles UserRole[]
|
userRoles UserRole[]
|
||||||
accounts Account[]
|
accounts Account[]
|
||||||
|
|
||||||
|
@@unique([tenantId, email])
|
||||||
|
@@index([tenantId])
|
||||||
@@map("users")
|
@@map("users")
|
||||||
}
|
}
|
||||||
|
|
||||||
// RBAC - Spatie-like
|
// RBAC - Spatie-like
|
||||||
model Role {
|
model Role {
|
||||||
id String @id @default(uuid())
|
id String @id @default(uuid())
|
||||||
|
tenantId String
|
||||||
name String
|
name String
|
||||||
guardName String @default("api")
|
guardName String @default("api")
|
||||||
description String?
|
description String?
|
||||||
createdAt DateTime @default(now())
|
createdAt DateTime @default(now())
|
||||||
updatedAt DateTime @updatedAt
|
updatedAt DateTime @updatedAt
|
||||||
|
|
||||||
|
tenant Tenant @relation(fields: [tenantId], references: [id], onDelete: Cascade)
|
||||||
userRoles UserRole[]
|
userRoles UserRole[]
|
||||||
rolePermissions RolePermission[]
|
rolePermissions RolePermission[]
|
||||||
|
|
||||||
@@unique([name, guardName])
|
@@unique([tenantId, name, guardName])
|
||||||
|
@@index([tenantId])
|
||||||
@@map("roles")
|
@@map("roles")
|
||||||
}
|
}
|
||||||
|
|
||||||
model Permission {
|
model Permission {
|
||||||
id String @id @default(uuid())
|
id String @id @default(uuid())
|
||||||
|
tenantId String
|
||||||
name String
|
name String
|
||||||
guardName String @default("api")
|
guardName String @default("api")
|
||||||
description String?
|
description String?
|
||||||
createdAt DateTime @default(now())
|
createdAt DateTime @default(now())
|
||||||
updatedAt DateTime @updatedAt
|
updatedAt DateTime @updatedAt
|
||||||
|
|
||||||
|
tenant Tenant @relation(fields: [tenantId], references: [id], onDelete: Cascade)
|
||||||
rolePermissions RolePermission[]
|
rolePermissions RolePermission[]
|
||||||
|
|
||||||
@@unique([name, guardName])
|
@@unique([tenantId, name, guardName])
|
||||||
|
@@index([tenantId])
|
||||||
@@map("permissions")
|
@@map("permissions")
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -93,59 +120,66 @@ model RolePermission {
|
|||||||
// Object Definition (Metadata)
|
// Object Definition (Metadata)
|
||||||
model ObjectDefinition {
|
model ObjectDefinition {
|
||||||
id String @id @default(uuid())
|
id String @id @default(uuid())
|
||||||
apiName String @unique
|
tenantId String
|
||||||
|
apiName String
|
||||||
label String
|
label String
|
||||||
pluralLabel String?
|
pluralLabel String?
|
||||||
description String? @db.Text
|
description String? @db.Text
|
||||||
isSystem Boolean @default(false)
|
isSystem Boolean @default(false)
|
||||||
isCustom Boolean @default(true)
|
tableName String?
|
||||||
createdAt DateTime @default(now()) @map("created_at")
|
isActive Boolean @default(true)
|
||||||
updatedAt DateTime @updatedAt @map("updated_at")
|
createdAt DateTime @default(now())
|
||||||
|
updatedAt DateTime @updatedAt
|
||||||
|
|
||||||
|
tenant Tenant @relation(fields: [tenantId], references: [id], onDelete: Cascade)
|
||||||
fields FieldDefinition[]
|
fields FieldDefinition[]
|
||||||
pages AppPage[]
|
pages AppPage[]
|
||||||
|
|
||||||
|
@@unique([tenantId, apiName])
|
||||||
|
@@index([tenantId])
|
||||||
@@map("object_definitions")
|
@@map("object_definitions")
|
||||||
}
|
}
|
||||||
|
|
||||||
model FieldDefinition {
|
model FieldDefinition {
|
||||||
id String @id @default(uuid())
|
id String @id @default(uuid())
|
||||||
objectDefinitionId String
|
objectId String
|
||||||
apiName String
|
apiName String
|
||||||
label String
|
label String
|
||||||
type String // String, Number, Date, Boolean, Reference, etc.
|
type String // text, number, boolean, date, datetime, lookup, picklist, etc.
|
||||||
length Int?
|
|
||||||
precision Int?
|
|
||||||
scale Int?
|
|
||||||
referenceObject String?
|
|
||||||
defaultValue String? @db.Text
|
|
||||||
description String? @db.Text
|
description String? @db.Text
|
||||||
isRequired Boolean @default(false)
|
isRequired Boolean @default(false)
|
||||||
isUnique Boolean @default(false)
|
isUnique Boolean @default(false)
|
||||||
isSystem Boolean @default(false)
|
isReadonly Boolean @default(false)
|
||||||
isCustom Boolean @default(true)
|
isLookup Boolean @default(false)
|
||||||
displayOrder Int @default(0)
|
referenceTo String? // objectApiName for lookup fields
|
||||||
createdAt DateTime @default(now()) @map("created_at")
|
defaultValue String?
|
||||||
updatedAt DateTime @updatedAt @map("updated_at")
|
options Json? // for picklist fields
|
||||||
|
validationRules Json? // custom validation rules
|
||||||
|
isActive Boolean @default(true)
|
||||||
|
createdAt DateTime @default(now())
|
||||||
|
updatedAt DateTime @updatedAt
|
||||||
|
|
||||||
object ObjectDefinition @relation(fields: [objectDefinitionId], references: [id], onDelete: Cascade)
|
object ObjectDefinition @relation(fields: [objectId], references: [id], onDelete: Cascade)
|
||||||
|
|
||||||
@@unique([objectDefinitionId, apiName])
|
@@unique([objectId, apiName])
|
||||||
@@index([objectDefinitionId])
|
@@index([objectId])
|
||||||
@@map("field_definitions")
|
@@map("field_definitions")
|
||||||
}
|
}
|
||||||
|
|
||||||
// Example static object: Account
|
// Example static object: Account
|
||||||
model Account {
|
model Account {
|
||||||
id String @id @default(uuid())
|
id String @id @default(uuid())
|
||||||
|
tenantId String
|
||||||
name String
|
name String
|
||||||
status String @default("active")
|
status String @default("active")
|
||||||
ownerId String
|
ownerId String
|
||||||
createdAt DateTime @default(now())
|
createdAt DateTime @default(now())
|
||||||
updatedAt DateTime @updatedAt
|
updatedAt DateTime @updatedAt
|
||||||
|
|
||||||
|
tenant Tenant @relation(fields: [tenantId], references: [id], onDelete: Cascade)
|
||||||
owner User @relation(fields: [ownerId], references: [id])
|
owner User @relation(fields: [ownerId], references: [id])
|
||||||
|
|
||||||
|
@@index([tenantId])
|
||||||
@@index([ownerId])
|
@@index([ownerId])
|
||||||
@@map("accounts")
|
@@map("accounts")
|
||||||
}
|
}
|
||||||
@@ -153,7 +187,8 @@ model Account {
|
|||||||
// Application Builder
|
// Application Builder
|
||||||
model App {
|
model App {
|
||||||
id String @id @default(uuid())
|
id String @id @default(uuid())
|
||||||
slug String @unique
|
tenantId String
|
||||||
|
slug String
|
||||||
label String
|
label String
|
||||||
description String? @db.Text
|
description String? @db.Text
|
||||||
icon String?
|
icon String?
|
||||||
@@ -161,8 +196,11 @@ model App {
|
|||||||
createdAt DateTime @default(now())
|
createdAt DateTime @default(now())
|
||||||
updatedAt DateTime @updatedAt
|
updatedAt DateTime @updatedAt
|
||||||
|
|
||||||
|
tenant Tenant @relation(fields: [tenantId], references: [id], onDelete: Cascade)
|
||||||
pages AppPage[]
|
pages AppPage[]
|
||||||
|
|
||||||
|
@@unique([tenantId, slug])
|
||||||
|
@@index([tenantId])
|
||||||
@@map("apps")
|
@@map("apps")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,194 +0,0 @@
|
|||||||
# Tenant Migration Scripts
|
|
||||||
|
|
||||||
This directory contains scripts for managing database migrations across all tenants in the multi-tenant platform.
|
|
||||||
|
|
||||||
## Available Scripts
|
|
||||||
|
|
||||||
### 1. Create a New Migration
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run migrate:make <migration_name>
|
|
||||||
```
|
|
||||||
|
|
||||||
Creates a new migration file in `migrations/tenant/` directory.
|
|
||||||
|
|
||||||
**Example:**
|
|
||||||
```bash
|
|
||||||
npm run migrate:make add_status_field_to_contacts
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2. Migrate a Single Tenant
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run migrate:tenant <tenant-slug-or-id>
|
|
||||||
```
|
|
||||||
|
|
||||||
Runs all pending migrations for a specific tenant. You can identify the tenant by its slug or ID.
|
|
||||||
|
|
||||||
**Example:**
|
|
||||||
```bash
|
|
||||||
npm run migrate:tenant acme-corp
|
|
||||||
npm run migrate:tenant cm5a1b2c3d4e5f6g7h8i9j0k
|
|
||||||
```
|
|
||||||
|
|
||||||
### 3. Migrate All Tenants
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run migrate:all-tenants
|
|
||||||
```
|
|
||||||
|
|
||||||
Runs all pending migrations for **all active tenants** in the system. This is useful when:
|
|
||||||
- You've created a new migration that needs to be applied to all tenants
|
|
||||||
- You're updating the schema across the entire platform
|
|
||||||
- You need to ensure all tenants are up to date
|
|
||||||
|
|
||||||
**Output:**
|
|
||||||
- Shows progress for each tenant
|
|
||||||
- Lists which migrations were applied
|
|
||||||
- Provides a summary at the end
|
|
||||||
- Exits with error code if any tenant fails
|
|
||||||
|
|
||||||
### 4. Rollback Migration (Manual)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run migrate:rollback
|
|
||||||
```
|
|
||||||
|
|
||||||
⚠️ **Warning:** This runs a rollback on the **default database** configured in `knexfile.js`. For tenant-specific rollbacks, you'll need to manually configure the connection.
|
|
||||||
|
|
||||||
## Migration Flow
|
|
||||||
|
|
||||||
### During New Tenant Provisioning
|
|
||||||
|
|
||||||
When a new tenant is created via the API, migrations are automatically run as part of the provisioning process:
|
|
||||||
|
|
||||||
1. Tenant database is created
|
|
||||||
2. `TenantProvisioningService.runTenantMigrations()` is called
|
|
||||||
3. All migrations in `migrations/tenant/` are executed
|
|
||||||
|
|
||||||
### For Existing Tenants
|
|
||||||
|
|
||||||
When you add a new migration file and need to apply it to existing tenants:
|
|
||||||
|
|
||||||
1. Create the migration:
|
|
||||||
```bash
|
|
||||||
npm run migrate:make add_new_feature
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Edit the generated migration file in `migrations/tenant/`
|
|
||||||
|
|
||||||
3. Test on a single tenant first:
|
|
||||||
```bash
|
|
||||||
npm run migrate:tenant test-tenant
|
|
||||||
```
|
|
||||||
|
|
||||||
4. If successful, apply to all tenants:
|
|
||||||
```bash
|
|
||||||
npm run migrate:all-tenants
|
|
||||||
```
|
|
||||||
|
|
||||||
## Migration Directory Structure
|
|
||||||
|
|
||||||
```
|
|
||||||
backend/
|
|
||||||
├── migrations/
|
|
||||||
│ └── tenant/ # Tenant-specific migrations
|
|
||||||
│ ├── 20250126000001_create_users_and_rbac.js
|
|
||||||
│ ├── 20250126000002_create_object_definitions.js
|
|
||||||
│ └── ...
|
|
||||||
├── scripts/
|
|
||||||
│ ├── migrate-tenant.ts # Single tenant migration
|
|
||||||
│ └── migrate-all-tenants.ts # All tenants migration
|
|
||||||
└── knexfile.js # Knex configuration
|
|
||||||
```
|
|
||||||
|
|
||||||
## Security Notes
|
|
||||||
|
|
||||||
### Database Password Encryption
|
|
||||||
|
|
||||||
Tenant database passwords are encrypted in the central database using AES-256-CBC encryption. The migration scripts automatically:
|
|
||||||
|
|
||||||
1. Fetch tenant connection details from the central database
|
|
||||||
2. Decrypt the database password using the `DB_ENCRYPTION_KEY` environment variable
|
|
||||||
3. Connect to the tenant database
|
|
||||||
4. Run migrations
|
|
||||||
5. Close the connection
|
|
||||||
|
|
||||||
**Required Environment Variable:**
|
|
||||||
```bash
|
|
||||||
DB_ENCRYPTION_KEY=your-32-character-secret-key!!
|
|
||||||
```
|
|
||||||
|
|
||||||
This key must match the key used by `TenantService` for encryption.
|
|
||||||
|
|
||||||
## Troubleshooting
|
|
||||||
|
|
||||||
### Migration Fails for One Tenant
|
|
||||||
|
|
||||||
If `migrate:all-tenants` fails for a specific tenant:
|
|
||||||
|
|
||||||
1. Check the error message in the output
|
|
||||||
2. Investigate the tenant's database directly
|
|
||||||
3. Fix the issue (manual SQL, data cleanup, etc.)
|
|
||||||
4. Re-run migrations for that tenant: `npm run migrate:tenant <slug>`
|
|
||||||
5. Once fixed, run `migrate:all-tenants` again to ensure others are updated
|
|
||||||
|
|
||||||
### Migration Already Exists
|
|
||||||
|
|
||||||
Knex tracks which migrations have been run in the `knex_migrations` table in each tenant database. If a migration was already applied, it will be skipped automatically.
|
|
||||||
|
|
||||||
### Connection Issues
|
|
||||||
|
|
||||||
If you see connection errors:
|
|
||||||
|
|
||||||
1. Verify the central database is accessible
|
|
||||||
2. Check that tenant database credentials are correct
|
|
||||||
3. Ensure `DB_ENCRYPTION_KEY` matches the one used for encryption
|
|
||||||
4. Verify the tenant's database server is running and accessible
|
|
||||||
|
|
||||||
## Example Migration File
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
// migrations/tenant/20250126000006_add_custom_fields.js
|
|
||||||
|
|
||||||
exports.up = async function(knex) {
|
|
||||||
await knex.schema.table('field_definitions', (table) => {
|
|
||||||
table.boolean('is_custom').defaultTo(false);
|
|
||||||
table.string('custom_type', 50).nullable();
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
exports.down = async function(knex) {
|
|
||||||
await knex.schema.table('field_definitions', (table) => {
|
|
||||||
table.dropColumn('is_custom');
|
|
||||||
table.dropColumn('custom_type');
|
|
||||||
});
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Best Practices
|
|
||||||
|
|
||||||
1. **Always test on a single tenant first** before running migrations on all tenants
|
|
||||||
2. **Include rollback logic** in your `down()` function
|
|
||||||
3. **Use transactions** for complex multi-step migrations
|
|
||||||
4. **Backup production databases** before running migrations
|
|
||||||
5. **Monitor the output** when running `migrate:all-tenants` to catch any failures
|
|
||||||
6. **Version control** your migration files
|
|
||||||
7. **Document breaking changes** in migration comments
|
|
||||||
8. **Consider data migrations** separately from schema migrations when dealing with large datasets
|
|
||||||
|
|
||||||
## CI/CD Integration
|
|
||||||
|
|
||||||
In your deployment pipeline, you can automatically migrate all tenants:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# After deploying new code
|
|
||||||
npm run migrate:all-tenants
|
|
||||||
```
|
|
||||||
|
|
||||||
Or integrate it into your Docker deployment:
|
|
||||||
|
|
||||||
```dockerfile
|
|
||||||
# In your Dockerfile or docker-compose.yml
|
|
||||||
CMD npm run migrate:all-tenants && npm run start:prod
|
|
||||||
```
|
|
||||||
@@ -1,181 +0,0 @@
|
|||||||
import { PrismaClient as CentralPrismaClient } from '.prisma/central';
|
|
||||||
import knex, { Knex } from 'knex';
|
|
||||||
import { createDecipheriv } from 'crypto';
|
|
||||||
|
|
||||||
// Encryption configuration
|
|
||||||
const ALGORITHM = 'aes-256-cbc';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Decrypt a tenant's database password
|
|
||||||
*/
|
|
||||||
function decryptPassword(encryptedPassword: string): string {
|
|
||||||
try {
|
|
||||||
// Check if password is already plaintext (for legacy/development)
|
|
||||||
if (!encryptedPassword.includes(':')) {
|
|
||||||
return encryptedPassword;
|
|
||||||
}
|
|
||||||
|
|
||||||
const key = Buffer.from(process.env.ENCRYPTION_KEY, 'hex');
|
|
||||||
const parts = encryptedPassword.split(':');
|
|
||||||
if (parts.length !== 2) {
|
|
||||||
throw new Error('Invalid encrypted password format');
|
|
||||||
}
|
|
||||||
|
|
||||||
const iv = Buffer.from(parts[0], 'hex');
|
|
||||||
const encrypted = parts[1];
|
|
||||||
|
|
||||||
const decipher = createDecipheriv(ALGORITHM, key, iv);
|
|
||||||
|
|
||||||
let decrypted = decipher.update(encrypted, 'hex', 'utf8');
|
|
||||||
decrypted += decipher.final('utf8');
|
|
||||||
|
|
||||||
return decrypted;
|
|
||||||
} catch (error) {
|
|
||||||
console.error('Error decrypting password:', error);
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a Knex connection for a specific tenant
|
|
||||||
*/
|
|
||||||
function createTenantKnexConnection(tenant: any): Knex {
|
|
||||||
const decryptedPassword = decryptPassword(tenant.dbPassword);
|
|
||||||
|
|
||||||
return knex({
|
|
||||||
client: 'mysql2',
|
|
||||||
connection: {
|
|
||||||
host: tenant.dbHost,
|
|
||||||
port: tenant.dbPort,
|
|
||||||
user: tenant.dbUsername,
|
|
||||||
password: decryptedPassword,
|
|
||||||
database: tenant.dbName,
|
|
||||||
},
|
|
||||||
migrations: {
|
|
||||||
tableName: 'knex_migrations',
|
|
||||||
directory: './migrations/tenant',
|
|
||||||
},
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get migration status for a specific tenant
|
|
||||||
*/
|
|
||||||
async function getTenantMigrationStatus(tenant: any): Promise<{
|
|
||||||
completed: string[];
|
|
||||||
pending: string[];
|
|
||||||
}> {
|
|
||||||
const tenantKnex = createTenantKnexConnection(tenant);
|
|
||||||
|
|
||||||
try {
|
|
||||||
const [completed, pending] = await tenantKnex.migrate.list();
|
|
||||||
return {
|
|
||||||
completed: completed[1] || [],
|
|
||||||
pending: pending || [],
|
|
||||||
};
|
|
||||||
} catch (error) {
|
|
||||||
throw error;
|
|
||||||
} finally {
|
|
||||||
await tenantKnex.destroy();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Check migration status across all tenants
|
|
||||||
*/
|
|
||||||
async function checkMigrationStatus() {
|
|
||||||
console.log('🔍 Checking migration status for all tenants...\n');
|
|
||||||
|
|
||||||
const centralPrisma = new CentralPrismaClient();
|
|
||||||
|
|
||||||
try {
|
|
||||||
// Fetch all active tenants
|
|
||||||
const tenants = await centralPrisma.tenant.findMany({
|
|
||||||
where: {
|
|
||||||
status: 'ACTIVE',
|
|
||||||
},
|
|
||||||
orderBy: {
|
|
||||||
name: 'asc',
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
if (tenants.length === 0) {
|
|
||||||
console.log('⚠️ No active tenants found.');
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log(`📋 Found ${tenants.length} active tenant(s)\n`);
|
|
||||||
console.log('='.repeat(80));
|
|
||||||
|
|
||||||
let allUpToDate = true;
|
|
||||||
const tenantsWithPending: { name: string; pending: string[] }[] = [];
|
|
||||||
|
|
||||||
// Check each tenant
|
|
||||||
for (const tenant of tenants) {
|
|
||||||
try {
|
|
||||||
const status = await getTenantMigrationStatus(tenant);
|
|
||||||
|
|
||||||
console.log(`\n📦 ${tenant.name} (${tenant.slug})`);
|
|
||||||
console.log(` Database: ${tenant.dbName}`);
|
|
||||||
console.log(` Completed: ${status.completed.length} migration(s)`);
|
|
||||||
|
|
||||||
if (status.pending.length > 0) {
|
|
||||||
allUpToDate = false;
|
|
||||||
console.log(` ⚠️ Pending: ${status.pending.length} migration(s)`);
|
|
||||||
status.pending.forEach((migration) => {
|
|
||||||
console.log(` - ${migration}`);
|
|
||||||
});
|
|
||||||
tenantsWithPending.push({
|
|
||||||
name: tenant.name,
|
|
||||||
pending: status.pending,
|
|
||||||
});
|
|
||||||
} else {
|
|
||||||
console.log(` ✅ Up to date`);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Show last 3 completed migrations
|
|
||||||
if (status.completed.length > 0) {
|
|
||||||
const recent = status.completed.slice(-3);
|
|
||||||
console.log(` Recent migrations:`);
|
|
||||||
recent.forEach((migration) => {
|
|
||||||
console.log(` - ${migration}`);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
} catch (error) {
|
|
||||||
console.log(`\n❌ ${tenant.name}: Failed to check status`);
|
|
||||||
console.log(` Error: ${error.message}`);
|
|
||||||
allUpToDate = false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Print summary
|
|
||||||
console.log('\n' + '='.repeat(80));
|
|
||||||
console.log('📊 Summary');
|
|
||||||
console.log('='.repeat(80));
|
|
||||||
|
|
||||||
if (allUpToDate) {
|
|
||||||
console.log('✅ All tenants are up to date!');
|
|
||||||
} else {
|
|
||||||
console.log(`⚠️ ${tenantsWithPending.length} tenant(s) have pending migrations:\n`);
|
|
||||||
tenantsWithPending.forEach(({ name, pending }) => {
|
|
||||||
console.log(` ${name}: ${pending.length} pending`);
|
|
||||||
});
|
|
||||||
console.log('\n💡 Run: npm run migrate:all-tenants');
|
|
||||||
}
|
|
||||||
} catch (error) {
|
|
||||||
console.error('❌ Fatal error:', error);
|
|
||||||
process.exit(1);
|
|
||||||
} finally {
|
|
||||||
await centralPrisma.$disconnect();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Run the status check
|
|
||||||
checkMigrationStatus()
|
|
||||||
.then(() => {
|
|
||||||
process.exit(0);
|
|
||||||
})
|
|
||||||
.catch((error) => {
|
|
||||||
console.error('Unhandled error:', error);
|
|
||||||
process.exit(1);
|
|
||||||
});
|
|
||||||
@@ -1,50 +0,0 @@
|
|||||||
import { PrismaClient as CentralPrismaClient } from '../node_modules/.prisma/central';
|
|
||||||
import * as bcrypt from 'bcrypt';
|
|
||||||
|
|
||||||
// Central database client
|
|
||||||
const centralPrisma = new CentralPrismaClient();
|
|
||||||
|
|
||||||
async function createAdminUser() {
|
|
||||||
const email = 'admin@example.com';
|
|
||||||
const password = 'admin123';
|
|
||||||
const firstName = 'Admin';
|
|
||||||
const lastName = 'User';
|
|
||||||
|
|
||||||
try {
|
|
||||||
// Check if admin user already exists
|
|
||||||
const existingUser = await centralPrisma.user.findUnique({
|
|
||||||
where: { email },
|
|
||||||
});
|
|
||||||
|
|
||||||
if (existingUser) {
|
|
||||||
console.log(`User ${email} already exists`);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Hash password
|
|
||||||
const hashedPassword = await bcrypt.hash(password, 10);
|
|
||||||
|
|
||||||
// Create admin user in central database
|
|
||||||
const user = await centralPrisma.user.create({
|
|
||||||
data: {
|
|
||||||
email,
|
|
||||||
password: hashedPassword,
|
|
||||||
firstName,
|
|
||||||
lastName,
|
|
||||||
role: 'superadmin',
|
|
||||||
isActive: true,
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
console.log('\nAdmin user created successfully!');
|
|
||||||
console.log('Email:', email);
|
|
||||||
console.log('Password:', password);
|
|
||||||
console.log('User ID:', user.id);
|
|
||||||
} catch (error) {
|
|
||||||
console.error('Error creating admin user:', error);
|
|
||||||
} finally {
|
|
||||||
await centralPrisma.$disconnect();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
createAdminUser();
|
|
||||||
@@ -1,138 +0,0 @@
|
|||||||
import { PrismaClient as CentralPrismaClient } from '../node_modules/.prisma/central';
|
|
||||||
import * as bcrypt from 'bcrypt';
|
|
||||||
import { Knex, knex } from 'knex';
|
|
||||||
|
|
||||||
// Central database client
|
|
||||||
const centralPrisma = new CentralPrismaClient();
|
|
||||||
|
|
||||||
async function createTenantUser() {
|
|
||||||
const tenantSlug = 'tenant1';
|
|
||||||
const email = 'user@example.com';
|
|
||||||
const password = 'user123';
|
|
||||||
const firstName = 'Test';
|
|
||||||
const lastName = 'User';
|
|
||||||
|
|
||||||
try {
|
|
||||||
// Get tenant database connection info
|
|
||||||
const tenant = await centralPrisma.tenant.findFirst({
|
|
||||||
where: { slug: tenantSlug },
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!tenant) {
|
|
||||||
console.log(`Tenant ${tenantSlug} not found. Creating tenant...`);
|
|
||||||
|
|
||||||
// Create tenant in central database
|
|
||||||
const newTenant = await centralPrisma.tenant.create({
|
|
||||||
data: {
|
|
||||||
name: 'Default Tenant',
|
|
||||||
slug: tenantSlug,
|
|
||||||
dbHost: 'db',
|
|
||||||
dbPort: 3306,
|
|
||||||
dbName: 'platform',
|
|
||||||
dbUsername: 'platform',
|
|
||||||
dbPassword: 'platform',
|
|
||||||
status: 'active',
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
console.log('Tenant created:', newTenant.slug);
|
|
||||||
} else {
|
|
||||||
console.log('Tenant found:', tenant.slug);
|
|
||||||
}
|
|
||||||
|
|
||||||
const tenantInfo = tenant || {
|
|
||||||
dbHost: 'db',
|
|
||||||
dbPort: 3306,
|
|
||||||
dbName: 'platform',
|
|
||||||
dbUsername: 'platform',
|
|
||||||
dbPassword: 'platform',
|
|
||||||
};
|
|
||||||
|
|
||||||
// Connect to tenant database (using root for now since tenant password is encrypted)
|
|
||||||
const tenantDb: Knex = knex({
|
|
||||||
client: 'mysql2',
|
|
||||||
connection: {
|
|
||||||
host: tenantInfo.dbHost,
|
|
||||||
port: tenantInfo.dbPort,
|
|
||||||
database: tenantInfo.dbName,
|
|
||||||
user: 'root',
|
|
||||||
password: 'asjdnfqTash37faggT',
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
// Check if user already exists
|
|
||||||
const existingUser = await tenantDb('users')
|
|
||||||
.where({ email })
|
|
||||||
.first();
|
|
||||||
|
|
||||||
if (existingUser) {
|
|
||||||
console.log(`User ${email} already exists in tenant ${tenantSlug}`);
|
|
||||||
await tenantDb.destroy();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Hash password
|
|
||||||
const hashedPassword = await bcrypt.hash(password, 10);
|
|
||||||
|
|
||||||
// Create user
|
|
||||||
await tenantDb('users').insert({
|
|
||||||
email,
|
|
||||||
password: hashedPassword,
|
|
||||||
firstName,
|
|
||||||
lastName,
|
|
||||||
isActive: true,
|
|
||||||
created_at: new Date(),
|
|
||||||
updated_at: new Date(),
|
|
||||||
});
|
|
||||||
|
|
||||||
console.log(`\nUser created successfully in tenant ${tenantSlug}!`);
|
|
||||||
console.log('Email:', email);
|
|
||||||
console.log('Password:', password);
|
|
||||||
|
|
||||||
// Create admin role if it doesn't exist
|
|
||||||
let adminRole = await tenantDb('roles')
|
|
||||||
.where({ name: 'admin' })
|
|
||||||
.first();
|
|
||||||
|
|
||||||
if (!adminRole) {
|
|
||||||
await tenantDb('roles').insert({
|
|
||||||
name: 'admin',
|
|
||||||
guardName: 'api',
|
|
||||||
description: 'Administrator role with full access',
|
|
||||||
created_at: new Date(),
|
|
||||||
updated_at: new Date(),
|
|
||||||
});
|
|
||||||
|
|
||||||
adminRole = await tenantDb('roles')
|
|
||||||
.where({ name: 'admin' })
|
|
||||||
.first();
|
|
||||||
|
|
||||||
console.log('Admin role created');
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get the created user
|
|
||||||
const user = await tenantDb('users')
|
|
||||||
.where({ email })
|
|
||||||
.first();
|
|
||||||
|
|
||||||
// Assign admin role to user
|
|
||||||
if (adminRole && user) {
|
|
||||||
await tenantDb('user_roles').insert({
|
|
||||||
userId: user.id,
|
|
||||||
roleId: adminRole.id,
|
|
||||||
created_at: new Date(),
|
|
||||||
updated_at: new Date(),
|
|
||||||
});
|
|
||||||
|
|
||||||
console.log('Admin role assigned to user');
|
|
||||||
}
|
|
||||||
|
|
||||||
await tenantDb.destroy();
|
|
||||||
} catch (error) {
|
|
||||||
console.error('Error creating tenant user:', error);
|
|
||||||
} finally {
|
|
||||||
await centralPrisma.$disconnect();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
createTenantUser();
|
|
||||||
@@ -1,168 +0,0 @@
|
|||||||
import { PrismaClient as CentralPrismaClient } from '.prisma/central';
|
|
||||||
import knex, { Knex } from 'knex';
|
|
||||||
import { createDecipheriv } from 'crypto';
|
|
||||||
|
|
||||||
// Encryption configuration - must match the one used in tenant service
|
|
||||||
const ALGORITHM = 'aes-256-cbc';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Decrypt a tenant's database password
|
|
||||||
*/
|
|
||||||
function decryptPassword(encryptedPassword: string): string {
|
|
||||||
try {
|
|
||||||
// Check if password is already plaintext (for legacy/development)
|
|
||||||
if (!encryptedPassword.includes(':')) {
|
|
||||||
console.warn('⚠️ Password appears to be unencrypted, using as-is');
|
|
||||||
return encryptedPassword;
|
|
||||||
}
|
|
||||||
|
|
||||||
const key = Buffer.from(process.env.ENCRYPTION_KEY, 'hex');
|
|
||||||
const parts = encryptedPassword.split(':');
|
|
||||||
if (parts.length !== 2) {
|
|
||||||
throw new Error('Invalid encrypted password format');
|
|
||||||
}
|
|
||||||
|
|
||||||
const iv = Buffer.from(parts[0], 'hex');
|
|
||||||
const encrypted = parts[1];
|
|
||||||
|
|
||||||
const decipher = createDecipheriv(ALGORITHM, key, iv);
|
|
||||||
|
|
||||||
let decrypted = decipher.update(encrypted, 'hex', 'utf8');
|
|
||||||
decrypted += decipher.final('utf8');
|
|
||||||
|
|
||||||
return decrypted;
|
|
||||||
} catch (error) {
|
|
||||||
console.error('Error decrypting password:', error);
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a Knex connection for a specific tenant
|
|
||||||
*/
|
|
||||||
function createTenantKnexConnection(tenant: any): Knex {
|
|
||||||
const decryptedPassword = decryptPassword(tenant.dbPassword);
|
|
||||||
|
|
||||||
// Replace 'db' hostname with 'localhost' when running outside Docker
|
|
||||||
const dbHost = tenant.dbHost === 'db' ? 'localhost' : tenant.dbHost;
|
|
||||||
|
|
||||||
return knex({
|
|
||||||
client: 'mysql2',
|
|
||||||
connection: {
|
|
||||||
host: dbHost,
|
|
||||||
port: tenant.dbPort,
|
|
||||||
user: tenant.dbUsername,
|
|
||||||
password: decryptedPassword,
|
|
||||||
database: tenant.dbName,
|
|
||||||
},
|
|
||||||
migrations: {
|
|
||||||
tableName: 'knex_migrations',
|
|
||||||
directory: './migrations/tenant',
|
|
||||||
},
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Run migrations for a specific tenant
|
|
||||||
*/
|
|
||||||
async function migrateTenant(tenant: any): Promise<void> {
|
|
||||||
console.log(`\n🔄 Migrating tenant: ${tenant.name} (${tenant.dbName})`);
|
|
||||||
|
|
||||||
const tenantKnex = createTenantKnexConnection(tenant);
|
|
||||||
|
|
||||||
try {
|
|
||||||
const [batchNo, log] = await tenantKnex.migrate.latest();
|
|
||||||
|
|
||||||
if (log.length === 0) {
|
|
||||||
console.log(`✅ ${tenant.name}: Already up to date`);
|
|
||||||
} else {
|
|
||||||
console.log(`✅ ${tenant.name}: Ran ${log.length} migrations:`);
|
|
||||||
log.forEach((migration) => {
|
|
||||||
console.log(` - ${migration}`);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
} catch (error) {
|
|
||||||
console.error(`❌ ${tenant.name}: Migration failed:`, error.message);
|
|
||||||
throw error;
|
|
||||||
} finally {
|
|
||||||
await tenantKnex.destroy();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Main function to migrate all active tenants
|
|
||||||
*/
|
|
||||||
async function migrateAllTenants() {
|
|
||||||
console.log('🚀 Starting migration for all tenants...\n');
|
|
||||||
|
|
||||||
const centralPrisma = new CentralPrismaClient();
|
|
||||||
|
|
||||||
try {
|
|
||||||
// Fetch all active tenants
|
|
||||||
const tenants = await centralPrisma.tenant.findMany({
|
|
||||||
where: {
|
|
||||||
status: 'ACTIVE',
|
|
||||||
},
|
|
||||||
orderBy: {
|
|
||||||
name: 'asc',
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
if (tenants.length === 0) {
|
|
||||||
console.log('⚠️ No active tenants found.');
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log(`📋 Found ${tenants.length} active tenant(s)\n`);
|
|
||||||
|
|
||||||
let successCount = 0;
|
|
||||||
let failureCount = 0;
|
|
||||||
const failures: { tenant: string; error: string }[] = [];
|
|
||||||
|
|
||||||
// Migrate each tenant sequentially
|
|
||||||
for (const tenant of tenants) {
|
|
||||||
try {
|
|
||||||
await migrateTenant(tenant);
|
|
||||||
successCount++;
|
|
||||||
} catch (error) {
|
|
||||||
failureCount++;
|
|
||||||
failures.push({
|
|
||||||
tenant: tenant.name,
|
|
||||||
error: error.message,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Print summary
|
|
||||||
console.log('\n' + '='.repeat(60));
|
|
||||||
console.log('📊 Migration Summary');
|
|
||||||
console.log('='.repeat(60));
|
|
||||||
console.log(`✅ Successful: ${successCount}`);
|
|
||||||
console.log(`❌ Failed: ${failureCount}`);
|
|
||||||
|
|
||||||
if (failures.length > 0) {
|
|
||||||
console.log('\n❌ Failed Tenants:');
|
|
||||||
failures.forEach(({ tenant, error }) => {
|
|
||||||
console.log(` - ${tenant}: ${error}`);
|
|
||||||
});
|
|
||||||
process.exit(1);
|
|
||||||
} else {
|
|
||||||
console.log('\n🎉 All tenant migrations completed successfully!');
|
|
||||||
}
|
|
||||||
} catch (error) {
|
|
||||||
console.error('❌ Fatal error:', error);
|
|
||||||
process.exit(1);
|
|
||||||
} finally {
|
|
||||||
await centralPrisma.$disconnect();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Run the migration
|
|
||||||
migrateAllTenants()
|
|
||||||
.then(() => {
|
|
||||||
process.exit(0);
|
|
||||||
})
|
|
||||||
.catch((error) => {
|
|
||||||
console.error('Unhandled error:', error);
|
|
||||||
process.exit(1);
|
|
||||||
});
|
|
||||||
@@ -1,134 +0,0 @@
|
|||||||
import { PrismaClient as CentralPrismaClient } from '.prisma/central';
|
|
||||||
import knex, { Knex } from 'knex';
|
|
||||||
import { createDecipheriv } from 'crypto';
|
|
||||||
|
|
||||||
// Encryption configuration
|
|
||||||
const ALGORITHM = 'aes-256-cbc';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Decrypt a tenant's database password
|
|
||||||
*/
|
|
||||||
function decryptPassword(encryptedPassword: string): string {
|
|
||||||
try {
|
|
||||||
// Check if password is already plaintext (for legacy/development)
|
|
||||||
if (!encryptedPassword.includes(':')) {
|
|
||||||
console.warn('⚠️ Password appears to be unencrypted, using as-is');
|
|
||||||
return encryptedPassword;
|
|
||||||
}
|
|
||||||
|
|
||||||
const key = Buffer.from(process.env.ENCRYPTION_KEY, 'hex');
|
|
||||||
const parts = encryptedPassword.split(':');
|
|
||||||
if (parts.length !== 2) {
|
|
||||||
throw new Error('Invalid encrypted password format');
|
|
||||||
}
|
|
||||||
|
|
||||||
const iv = Buffer.from(parts[0], 'hex');
|
|
||||||
const encrypted = parts[1];
|
|
||||||
|
|
||||||
const decipher = createDecipheriv(ALGORITHM, key, iv);
|
|
||||||
|
|
||||||
let decrypted = decipher.update(encrypted, 'hex', 'utf8');
|
|
||||||
decrypted += decipher.final('utf8');
|
|
||||||
|
|
||||||
return decrypted;
|
|
||||||
} catch (error) {
|
|
||||||
console.error('Error decrypting password:', error);
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a Knex connection for a specific tenant
|
|
||||||
*/
|
|
||||||
function createTenantKnexConnection(tenant: any): Knex {
|
|
||||||
const decryptedPassword = decryptPassword(tenant.dbPassword);
|
|
||||||
|
|
||||||
return knex({
|
|
||||||
client: 'mysql2',
|
|
||||||
connection: {
|
|
||||||
host: tenant.dbHost,
|
|
||||||
port: tenant.dbPort,
|
|
||||||
user: tenant.dbUsername,
|
|
||||||
password: decryptedPassword,
|
|
||||||
database: tenant.dbName,
|
|
||||||
},
|
|
||||||
migrations: {
|
|
||||||
tableName: 'knex_migrations',
|
|
||||||
directory: './migrations/tenant',
|
|
||||||
},
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Migrate a specific tenant by slug or ID
|
|
||||||
*/
|
|
||||||
async function migrateTenant() {
|
|
||||||
const tenantIdentifier = process.argv[2];
|
|
||||||
|
|
||||||
if (!tenantIdentifier) {
|
|
||||||
console.error('❌ Usage: npm run migrate:tenant <tenant-slug-or-id>');
|
|
||||||
process.exit(1);
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log(`🔍 Looking for tenant: ${tenantIdentifier}\n`);
|
|
||||||
|
|
||||||
const centralPrisma = new CentralPrismaClient();
|
|
||||||
|
|
||||||
try {
|
|
||||||
// Find tenant by slug or ID
|
|
||||||
const tenant = await centralPrisma.tenant.findFirst({
|
|
||||||
where: {
|
|
||||||
OR: [
|
|
||||||
{ slug: tenantIdentifier },
|
|
||||||
{ id: tenantIdentifier },
|
|
||||||
],
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!tenant) {
|
|
||||||
console.error(`❌ Tenant not found: ${tenantIdentifier}`);
|
|
||||||
process.exit(1);
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log(`📋 Tenant: ${tenant.name} (${tenant.slug})`);
|
|
||||||
console.log(`📊 Database: ${tenant.dbName}`);
|
|
||||||
console.log(`🔄 Running migrations...\n`);
|
|
||||||
|
|
||||||
const tenantKnex = createTenantKnexConnection(tenant);
|
|
||||||
|
|
||||||
try {
|
|
||||||
const [batchNo, log] = await tenantKnex.migrate.latest();
|
|
||||||
|
|
||||||
if (log.length === 0) {
|
|
||||||
console.log(`✅ Already up to date (batch ${batchNo})`);
|
|
||||||
} else {
|
|
||||||
console.log(`✅ Ran ${log.length} migration(s) (batch ${batchNo}):`);
|
|
||||||
log.forEach((migration) => {
|
|
||||||
console.log(` - ${migration}`);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log('\n🎉 Migration completed successfully!');
|
|
||||||
} catch (error) {
|
|
||||||
console.error('❌ Migration failed:', error.message);
|
|
||||||
throw error;
|
|
||||||
} finally {
|
|
||||||
await tenantKnex.destroy();
|
|
||||||
}
|
|
||||||
} catch (error) {
|
|
||||||
console.error('❌ Fatal error:', error);
|
|
||||||
process.exit(1);
|
|
||||||
} finally {
|
|
||||||
await centralPrisma.$disconnect();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Run the migration
|
|
||||||
migrateTenant()
|
|
||||||
.then(() => {
|
|
||||||
process.exit(0);
|
|
||||||
})
|
|
||||||
.catch((error) => {
|
|
||||||
console.error('Unhandled error:', error);
|
|
||||||
process.exit(1);
|
|
||||||
});
|
|
||||||
@@ -1,72 +0,0 @@
|
|||||||
import { getCentralPrisma } from '../src/prisma/central-prisma.service';
|
|
||||||
import * as knex from 'knex';
|
|
||||||
import * as crypto from 'crypto';
|
|
||||||
|
|
||||||
function decrypt(text: string): string {
|
|
||||||
const parts = text.split(':');
|
|
||||||
const iv = Buffer.from(parts.shift()!, 'hex');
|
|
||||||
const encryptedText = Buffer.from(parts.join(':'), 'hex');
|
|
||||||
const key = Buffer.from(process.env.ENCRYPTION_KEY, 'hex');
|
|
||||||
const decipher = crypto.createDecipheriv(
|
|
||||||
'aes-256-cbc',
|
|
||||||
key,
|
|
||||||
iv,
|
|
||||||
);
|
|
||||||
let decrypted = decipher.update(encryptedText);
|
|
||||||
decrypted = Buffer.concat([decrypted, decipher.final()]);
|
|
||||||
return decrypted.toString();
|
|
||||||
}
|
|
||||||
|
|
||||||
async function updateNameField() {
|
|
||||||
const centralPrisma = getCentralPrisma();
|
|
||||||
|
|
||||||
try {
|
|
||||||
// Find tenant1
|
|
||||||
const tenant = await centralPrisma.tenant.findFirst({
|
|
||||||
where: {
|
|
||||||
OR: [
|
|
||||||
{ id: 'tenant1' },
|
|
||||||
{ slug: 'tenant1' },
|
|
||||||
],
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!tenant) {
|
|
||||||
console.error('❌ Tenant tenant1 not found');
|
|
||||||
process.exit(1);
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log(`📋 Tenant: ${tenant.name} (${tenant.slug})`);
|
|
||||||
console.log(`📊 Database: ${tenant.dbName}`);
|
|
||||||
|
|
||||||
// Decrypt password
|
|
||||||
const password = decrypt(tenant.dbPassword);
|
|
||||||
|
|
||||||
// Create connection
|
|
||||||
const tenantKnex = knex.default({
|
|
||||||
client: 'mysql2',
|
|
||||||
connection: {
|
|
||||||
host: tenant.dbHost,
|
|
||||||
port: tenant.dbPort,
|
|
||||||
user: tenant.dbUsername,
|
|
||||||
password: password,
|
|
||||||
database: tenant.dbName,
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
// Update Account object
|
|
||||||
await tenantKnex('object_definitions')
|
|
||||||
.where({ apiName: 'Account' })
|
|
||||||
.update({ nameField: 'name' });
|
|
||||||
|
|
||||||
console.log('✅ Updated Account object nameField to "name"');
|
|
||||||
|
|
||||||
await tenantKnex.destroy();
|
|
||||||
await centralPrisma.$disconnect();
|
|
||||||
} catch (error) {
|
|
||||||
console.error('❌ Error:', error);
|
|
||||||
process.exit(1);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
updateNameField();
|
|
||||||
@@ -1,147 +0,0 @@
|
|||||||
/**
|
|
||||||
* Example seed data for Account object with UI metadata
|
|
||||||
* Run this after migrations to add UI metadata to existing Account fields
|
|
||||||
*/
|
|
||||||
|
|
||||||
exports.seed = async function(knex) {
|
|
||||||
// Get the Account object
|
|
||||||
const accountObj = await knex('object_definitions')
|
|
||||||
.where({ apiName: 'Account' })
|
|
||||||
.first();
|
|
||||||
|
|
||||||
if (!accountObj) {
|
|
||||||
console.log('Account object not found. Please run migrations first.');
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log(`Found Account object with ID: ${accountObj.id}`);
|
|
||||||
|
|
||||||
// Update existing Account fields with UI metadata
|
|
||||||
const fieldsToUpdate = [
|
|
||||||
{
|
|
||||||
apiName: 'name',
|
|
||||||
ui_metadata: JSON.stringify({
|
|
||||||
fieldType: 'TEXT',
|
|
||||||
placeholder: 'Enter account name',
|
|
||||||
helpText: 'The name of the organization or company',
|
|
||||||
showOnList: true,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true,
|
|
||||||
section: 'basic',
|
|
||||||
sectionLabel: 'Basic Information',
|
|
||||||
sectionOrder: 1,
|
|
||||||
validationRules: [
|
|
||||||
{ type: 'required', message: 'Account name is required' },
|
|
||||||
{ type: 'minLength', value: 2, message: 'Account name must be at least 2 characters' },
|
|
||||||
{ type: 'maxLength', value: 255, message: 'Account name cannot exceed 255 characters' }
|
|
||||||
]
|
|
||||||
})
|
|
||||||
},
|
|
||||||
{
|
|
||||||
apiName: 'website',
|
|
||||||
ui_metadata: JSON.stringify({
|
|
||||||
fieldType: 'URL',
|
|
||||||
placeholder: 'https://www.example.com',
|
|
||||||
helpText: 'Company website URL',
|
|
||||||
showOnList: true,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true,
|
|
||||||
section: 'basic',
|
|
||||||
sectionLabel: 'Basic Information',
|
|
||||||
sectionOrder: 1,
|
|
||||||
validationRules: [
|
|
||||||
{ type: 'url', message: 'Please enter a valid URL' }
|
|
||||||
]
|
|
||||||
})
|
|
||||||
},
|
|
||||||
{
|
|
||||||
apiName: 'phone',
|
|
||||||
ui_metadata: JSON.stringify({
|
|
||||||
fieldType: 'TEXT',
|
|
||||||
placeholder: '+1 (555) 000-0000',
|
|
||||||
helpText: 'Primary phone number',
|
|
||||||
showOnList: true,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: false,
|
|
||||||
section: 'contact',
|
|
||||||
sectionLabel: 'Contact Information',
|
|
||||||
sectionOrder: 2,
|
|
||||||
validationRules: [
|
|
||||||
{ type: 'pattern', value: '^\\+?[0-9\\s\\-\\(\\)]+$', message: 'Please enter a valid phone number' }
|
|
||||||
]
|
|
||||||
})
|
|
||||||
},
|
|
||||||
{
|
|
||||||
apiName: 'industry',
|
|
||||||
ui_metadata: JSON.stringify({
|
|
||||||
fieldType: 'SELECT',
|
|
||||||
placeholder: 'Select industry',
|
|
||||||
helpText: 'The primary industry this account operates in',
|
|
||||||
showOnList: true,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true,
|
|
||||||
section: 'details',
|
|
||||||
sectionLabel: 'Account Details',
|
|
||||||
sectionOrder: 3,
|
|
||||||
options: [
|
|
||||||
{ value: 'technology', label: 'Technology' },
|
|
||||||
{ value: 'finance', label: 'Finance' },
|
|
||||||
{ value: 'healthcare', label: 'Healthcare' },
|
|
||||||
{ value: 'manufacturing', label: 'Manufacturing' },
|
|
||||||
{ value: 'retail', label: 'Retail' },
|
|
||||||
{ value: 'education', label: 'Education' },
|
|
||||||
{ value: 'government', label: 'Government' },
|
|
||||||
{ value: 'nonprofit', label: 'Non-Profit' },
|
|
||||||
{ value: 'other', label: 'Other' }
|
|
||||||
]
|
|
||||||
})
|
|
||||||
},
|
|
||||||
{
|
|
||||||
apiName: 'ownerId',
|
|
||||||
ui_metadata: JSON.stringify({
|
|
||||||
fieldType: 'SELECT',
|
|
||||||
placeholder: 'Select owner',
|
|
||||||
helpText: 'The user who owns this account',
|
|
||||||
showOnList: true,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true,
|
|
||||||
section: 'system',
|
|
||||||
sectionLabel: 'System Information',
|
|
||||||
sectionOrder: 4,
|
|
||||||
// This would be dynamically populated from the users table
|
|
||||||
// For now, providing static structure
|
|
||||||
isReference: true,
|
|
||||||
referenceObject: 'User',
|
|
||||||
referenceDisplayField: 'name'
|
|
||||||
})
|
|
||||||
}
|
|
||||||
];
|
|
||||||
|
|
||||||
// Update each field with UI metadata
|
|
||||||
for (const fieldUpdate of fieldsToUpdate) {
|
|
||||||
const result = await knex('field_definitions')
|
|
||||||
.where({
|
|
||||||
objectDefinitionId: accountObj.id,
|
|
||||||
apiName: fieldUpdate.apiName
|
|
||||||
})
|
|
||||||
.update({
|
|
||||||
ui_metadata: fieldUpdate.ui_metadata,
|
|
||||||
updated_at: knex.fn.now()
|
|
||||||
});
|
|
||||||
|
|
||||||
if (result > 0) {
|
|
||||||
console.log(`✓ Updated ${fieldUpdate.apiName} with UI metadata`);
|
|
||||||
} else {
|
|
||||||
console.log(`✗ Field ${fieldUpdate.apiName} not found`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log('\n✅ Account fields UI metadata seed completed successfully!');
|
|
||||||
console.log('You can now fetch the Account object UI config via:');
|
|
||||||
console.log('GET /api/setup/objects/Account/ui-config');
|
|
||||||
};
|
|
||||||
@@ -1,349 +0,0 @@
|
|||||||
/**
|
|
||||||
* Example seed data for Contact object with UI metadata
|
|
||||||
* Run this after creating the object definition
|
|
||||||
*/
|
|
||||||
|
|
||||||
exports.seed = async function(knex) {
|
|
||||||
// Get or create the Contact object
|
|
||||||
const [contactObj] = await knex('object_definitions')
|
|
||||||
.where({ api_name: 'Contact' })
|
|
||||||
.select('id');
|
|
||||||
|
|
||||||
if (!contactObj) {
|
|
||||||
console.log('Contact object not found. Please create it first.');
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Define fields with UI metadata
|
|
||||||
const fields = [
|
|
||||||
{
|
|
||||||
object_definition_id: contactObj.id,
|
|
||||||
api_name: 'firstName',
|
|
||||||
label: 'First Name',
|
|
||||||
type: 'text',
|
|
||||||
is_required: true,
|
|
||||||
is_system: false,
|
|
||||||
is_custom: false,
|
|
||||||
display_order: 1,
|
|
||||||
ui_metadata: {
|
|
||||||
placeholder: 'Enter first name',
|
|
||||||
helpText: 'The contact\'s given name',
|
|
||||||
showOnList: true,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true,
|
|
||||||
validationRules: [
|
|
||||||
{ type: 'min', value: 2, message: 'First name must be at least 2 characters' },
|
|
||||||
{ type: 'max', value: 50, message: 'First name cannot exceed 50 characters' }
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
object_definition_id: contactObj.id,
|
|
||||||
api_name: 'lastName',
|
|
||||||
label: 'Last Name',
|
|
||||||
type: 'text',
|
|
||||||
is_required: true,
|
|
||||||
is_system: false,
|
|
||||||
is_custom: false,
|
|
||||||
display_order: 2,
|
|
||||||
ui_metadata: {
|
|
||||||
placeholder: 'Enter last name',
|
|
||||||
helpText: 'The contact\'s family name',
|
|
||||||
showOnList: true,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true,
|
|
||||||
validationRules: [
|
|
||||||
{ type: 'min', value: 2, message: 'Last name must be at least 2 characters' },
|
|
||||||
{ type: 'max', value: 50, message: 'Last name cannot exceed 50 characters' }
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
object_definition_id: contactObj.id,
|
|
||||||
api_name: 'email',
|
|
||||||
label: 'Email',
|
|
||||||
type: 'email',
|
|
||||||
is_required: true,
|
|
||||||
is_unique: true,
|
|
||||||
is_system: false,
|
|
||||||
is_custom: false,
|
|
||||||
display_order: 3,
|
|
||||||
ui_metadata: {
|
|
||||||
placeholder: 'email@example.com',
|
|
||||||
helpText: 'Primary email address',
|
|
||||||
showOnList: true,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true,
|
|
||||||
validationRules: [
|
|
||||||
{ type: 'email', message: 'Please enter a valid email address' }
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
object_definition_id: contactObj.id,
|
|
||||||
api_name: 'phone',
|
|
||||||
label: 'Phone',
|
|
||||||
type: 'text',
|
|
||||||
is_required: false,
|
|
||||||
is_system: false,
|
|
||||||
is_custom: false,
|
|
||||||
display_order: 4,
|
|
||||||
ui_metadata: {
|
|
||||||
placeholder: '+1 (555) 000-0000',
|
|
||||||
helpText: 'Primary phone number',
|
|
||||||
showOnList: true,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: false,
|
|
||||||
validationRules: [
|
|
||||||
{ type: 'pattern', value: '^\\+?[0-9\\s\\-\\(\\)]+$', message: 'Please enter a valid phone number' }
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
object_definition_id: contactObj.id,
|
|
||||||
api_name: 'company',
|
|
||||||
label: 'Company',
|
|
||||||
type: 'text',
|
|
||||||
is_required: false,
|
|
||||||
is_system: false,
|
|
||||||
is_custom: false,
|
|
||||||
display_order: 5,
|
|
||||||
ui_metadata: {
|
|
||||||
placeholder: 'Company name',
|
|
||||||
helpText: 'The organization this contact works for',
|
|
||||||
showOnList: true,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
object_definition_id: contactObj.id,
|
|
||||||
api_name: 'jobTitle',
|
|
||||||
label: 'Job Title',
|
|
||||||
type: 'text',
|
|
||||||
is_required: false,
|
|
||||||
is_system: false,
|
|
||||||
is_custom: false,
|
|
||||||
display_order: 6,
|
|
||||||
ui_metadata: {
|
|
||||||
placeholder: 'e.g., Senior Manager',
|
|
||||||
showOnList: false,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: false
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
object_definition_id: contactObj.id,
|
|
||||||
api_name: 'status',
|
|
||||||
label: 'Status',
|
|
||||||
type: 'picklist',
|
|
||||||
is_required: true,
|
|
||||||
is_system: false,
|
|
||||||
is_custom: false,
|
|
||||||
display_order: 7,
|
|
||||||
default_value: 'active',
|
|
||||||
ui_metadata: {
|
|
||||||
showOnList: true,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true,
|
|
||||||
options: [
|
|
||||||
{ label: 'Active', value: 'active' },
|
|
||||||
{ label: 'Inactive', value: 'inactive' },
|
|
||||||
{ label: 'Pending', value: 'pending' },
|
|
||||||
{ label: 'Archived', value: 'archived' }
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
object_definition_id: contactObj.id,
|
|
||||||
api_name: 'leadSource',
|
|
||||||
label: 'Lead Source',
|
|
||||||
type: 'picklist',
|
|
||||||
is_required: false,
|
|
||||||
is_system: false,
|
|
||||||
is_custom: false,
|
|
||||||
display_order: 8,
|
|
||||||
ui_metadata: {
|
|
||||||
placeholder: 'Select lead source',
|
|
||||||
showOnList: false,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true,
|
|
||||||
options: [
|
|
||||||
{ label: 'Website', value: 'website' },
|
|
||||||
{ label: 'Referral', value: 'referral' },
|
|
||||||
{ label: 'Social Media', value: 'social' },
|
|
||||||
{ label: 'Conference', value: 'conference' },
|
|
||||||
{ label: 'Cold Call', value: 'cold_call' },
|
|
||||||
{ label: 'Other', value: 'other' }
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
object_definition_id: contactObj.id,
|
|
||||||
api_name: 'isVip',
|
|
||||||
label: 'VIP Customer',
|
|
||||||
type: 'boolean',
|
|
||||||
is_required: false,
|
|
||||||
is_system: false,
|
|
||||||
is_custom: false,
|
|
||||||
display_order: 9,
|
|
||||||
default_value: 'false',
|
|
||||||
ui_metadata: {
|
|
||||||
helpText: 'Mark as VIP for priority support',
|
|
||||||
showOnList: true,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
object_definition_id: contactObj.id,
|
|
||||||
api_name: 'birthDate',
|
|
||||||
label: 'Birth Date',
|
|
||||||
type: 'date',
|
|
||||||
is_required: false,
|
|
||||||
is_system: false,
|
|
||||||
is_custom: false,
|
|
||||||
display_order: 10,
|
|
||||||
ui_metadata: {
|
|
||||||
showOnList: false,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true,
|
|
||||||
format: 'yyyy-MM-dd'
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
object_definition_id: contactObj.id,
|
|
||||||
api_name: 'website',
|
|
||||||
label: 'Website',
|
|
||||||
type: 'url',
|
|
||||||
is_required: false,
|
|
||||||
is_system: false,
|
|
||||||
is_custom: false,
|
|
||||||
display_order: 11,
|
|
||||||
ui_metadata: {
|
|
||||||
placeholder: 'https://example.com',
|
|
||||||
showOnList: false,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: false,
|
|
||||||
validationRules: [
|
|
||||||
{ type: 'url', message: 'Please enter a valid URL starting with http:// or https://' }
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
object_definition_id: contactObj.id,
|
|
||||||
api_name: 'mailingAddress',
|
|
||||||
label: 'Mailing Address',
|
|
||||||
type: 'textarea',
|
|
||||||
is_required: false,
|
|
||||||
is_system: false,
|
|
||||||
is_custom: false,
|
|
||||||
display_order: 12,
|
|
||||||
ui_metadata: {
|
|
||||||
placeholder: 'Enter full mailing address',
|
|
||||||
rows: 3,
|
|
||||||
showOnList: false,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: false
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
object_definition_id: contactObj.id,
|
|
||||||
api_name: 'notes',
|
|
||||||
label: 'Notes',
|
|
||||||
type: 'textarea',
|
|
||||||
is_required: false,
|
|
||||||
is_system: false,
|
|
||||||
is_custom: false,
|
|
||||||
display_order: 13,
|
|
||||||
ui_metadata: {
|
|
||||||
placeholder: 'Additional notes about this contact...',
|
|
||||||
rows: 5,
|
|
||||||
showOnList: false,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: false
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
object_definition_id: contactObj.id,
|
|
||||||
api_name: 'annualRevenue',
|
|
||||||
label: 'Annual Revenue',
|
|
||||||
type: 'currency',
|
|
||||||
is_required: false,
|
|
||||||
is_system: false,
|
|
||||||
is_custom: false,
|
|
||||||
display_order: 14,
|
|
||||||
ui_metadata: {
|
|
||||||
prefix: '$',
|
|
||||||
step: 0.01,
|
|
||||||
min: 0,
|
|
||||||
showOnList: false,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
object_definition_id: contactObj.id,
|
|
||||||
api_name: 'numberOfEmployees',
|
|
||||||
label: 'Number of Employees',
|
|
||||||
type: 'integer',
|
|
||||||
is_required: false,
|
|
||||||
is_system: false,
|
|
||||||
is_custom: false,
|
|
||||||
display_order: 15,
|
|
||||||
ui_metadata: {
|
|
||||||
min: 1,
|
|
||||||
step: 1,
|
|
||||||
showOnList: false,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
];
|
|
||||||
|
|
||||||
// Insert or update fields
|
|
||||||
for (const field of fields) {
|
|
||||||
const existing = await knex('field_definitions')
|
|
||||||
.where({
|
|
||||||
object_definition_id: field.object_definition_id,
|
|
||||||
api_name: field.api_name
|
|
||||||
})
|
|
||||||
.first();
|
|
||||||
|
|
||||||
if (existing) {
|
|
||||||
await knex('field_definitions')
|
|
||||||
.where({ id: existing.id })
|
|
||||||
.update({
|
|
||||||
...field,
|
|
||||||
ui_metadata: JSON.stringify(field.ui_metadata),
|
|
||||||
updated_at: knex.fn.now()
|
|
||||||
});
|
|
||||||
console.log(`Updated field: ${field.api_name}`);
|
|
||||||
} else {
|
|
||||||
await knex('field_definitions').insert({
|
|
||||||
...field,
|
|
||||||
ui_metadata: JSON.stringify(field.ui_metadata),
|
|
||||||
created_at: knex.fn.now(),
|
|
||||||
updated_at: knex.fn.now()
|
|
||||||
});
|
|
||||||
console.log(`Created field: ${field.api_name}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log('Contact fields seeded successfully!');
|
|
||||||
};
|
|
||||||
@@ -12,7 +12,7 @@ import { JwtAuthGuard } from '../auth/jwt-auth.guard';
|
|||||||
import { TenantId } from '../tenant/tenant.decorator';
|
import { TenantId } from '../tenant/tenant.decorator';
|
||||||
|
|
||||||
@Controller('setup/apps')
|
@Controller('setup/apps')
|
||||||
@UseGuards(JwtAuthGuard)
|
//@UseGuards(JwtAuthGuard)
|
||||||
export class SetupAppController {
|
export class SetupAppController {
|
||||||
constructor(private appBuilderService: AppBuilderService) {}
|
constructor(private appBuilderService: AppBuilderService) {}
|
||||||
|
|
||||||
|
|||||||
@@ -6,7 +6,6 @@ import { AuthModule } from './auth/auth.module';
|
|||||||
import { RbacModule } from './rbac/rbac.module';
|
import { RbacModule } from './rbac/rbac.module';
|
||||||
import { ObjectModule } from './object/object.module';
|
import { ObjectModule } from './object/object.module';
|
||||||
import { AppBuilderModule } from './app-builder/app-builder.module';
|
import { AppBuilderModule } from './app-builder/app-builder.module';
|
||||||
import { PageLayoutModule } from './page-layout/page-layout.module';
|
|
||||||
|
|
||||||
@Module({
|
@Module({
|
||||||
imports: [
|
imports: [
|
||||||
@@ -19,7 +18,6 @@ import { PageLayoutModule } from './page-layout/page-layout.module';
|
|||||||
RbacModule,
|
RbacModule,
|
||||||
ObjectModule,
|
ObjectModule,
|
||||||
AppBuilderModule,
|
AppBuilderModule,
|
||||||
PageLayoutModule,
|
|
||||||
],
|
],
|
||||||
})
|
})
|
||||||
export class AppModule {}
|
export class AppModule {}
|
||||||
|
|||||||
@@ -79,12 +79,4 @@ export class AuthController {
|
|||||||
|
|
||||||
return user;
|
return user;
|
||||||
}
|
}
|
||||||
|
|
||||||
@HttpCode(HttpStatus.OK)
|
|
||||||
@Post('logout')
|
|
||||||
async logout() {
|
|
||||||
// For stateless JWT, logout is handled on client-side
|
|
||||||
// This endpoint exists for consistency and potential future enhancements
|
|
||||||
return { message: 'Logged out successfully' };
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,12 +5,10 @@ import { ConfigService } from '@nestjs/config';
|
|||||||
import { AuthService } from './auth.service';
|
import { AuthService } from './auth.service';
|
||||||
import { AuthController } from './auth.controller';
|
import { AuthController } from './auth.controller';
|
||||||
import { JwtStrategy } from './jwt.strategy';
|
import { JwtStrategy } from './jwt.strategy';
|
||||||
import { TenantModule } from '../tenant/tenant.module';
|
|
||||||
|
|
||||||
@Module({
|
@Module({
|
||||||
imports: [
|
imports: [
|
||||||
PassportModule,
|
PassportModule,
|
||||||
TenantModule,
|
|
||||||
JwtModule.registerAsync({
|
JwtModule.registerAsync({
|
||||||
inject: [ConfigService],
|
inject: [ConfigService],
|
||||||
useFactory: (config: ConfigService) => ({
|
useFactory: (config: ConfigService) => ({
|
||||||
|
|||||||
@@ -1,12 +1,12 @@
|
|||||||
import { Injectable } from '@nestjs/common';
|
import { Injectable } from '@nestjs/common';
|
||||||
import { JwtService } from '@nestjs/jwt';
|
import { JwtService } from '@nestjs/jwt';
|
||||||
import { TenantDatabaseService } from '../tenant/tenant-database.service';
|
import { PrismaService } from '../prisma/prisma.service';
|
||||||
import * as bcrypt from 'bcrypt';
|
import * as bcrypt from 'bcrypt';
|
||||||
|
|
||||||
@Injectable()
|
@Injectable()
|
||||||
export class AuthService {
|
export class AuthService {
|
||||||
constructor(
|
constructor(
|
||||||
private tenantDbService: TenantDatabaseService,
|
private prisma: PrismaService,
|
||||||
private jwtService: JwtService,
|
private jwtService: JwtService,
|
||||||
) {}
|
) {}
|
||||||
|
|
||||||
@@ -15,29 +15,34 @@ export class AuthService {
|
|||||||
email: string,
|
email: string,
|
||||||
password: string,
|
password: string,
|
||||||
): Promise<any> {
|
): Promise<any> {
|
||||||
const tenantDb = await this.tenantDbService.getTenantKnex(tenantId);
|
const user = await this.prisma.user.findUnique({
|
||||||
|
where: {
|
||||||
const user = await tenantDb('users')
|
tenantId_email: {
|
||||||
.where({ email })
|
|
||||||
.first();
|
|
||||||
|
|
||||||
if (!user) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (await bcrypt.compare(password, user.password)) {
|
|
||||||
// Load user roles and permissions
|
|
||||||
const userRoles = await tenantDb('user_roles')
|
|
||||||
.where({ userId: user.id })
|
|
||||||
.join('roles', 'user_roles.roleId', 'roles.id')
|
|
||||||
.select('roles.*');
|
|
||||||
|
|
||||||
const { password: _, ...result } = user;
|
|
||||||
return {
|
|
||||||
...result,
|
|
||||||
tenantId,
|
tenantId,
|
||||||
userRoles,
|
email,
|
||||||
};
|
},
|
||||||
|
},
|
||||||
|
include: {
|
||||||
|
tenant: true,
|
||||||
|
userRoles: {
|
||||||
|
include: {
|
||||||
|
role: {
|
||||||
|
include: {
|
||||||
|
rolePermissions: {
|
||||||
|
include: {
|
||||||
|
permission: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
if (user && (await bcrypt.compare(password, user.password))) {
|
||||||
|
const { password, ...result } = user;
|
||||||
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
return null;
|
return null;
|
||||||
@@ -47,6 +52,7 @@ export class AuthService {
|
|||||||
const payload = {
|
const payload = {
|
||||||
sub: user.id,
|
sub: user.id,
|
||||||
email: user.email,
|
email: user.email,
|
||||||
|
tenantId: user.tenantId,
|
||||||
};
|
};
|
||||||
|
|
||||||
return {
|
return {
|
||||||
@@ -56,6 +62,7 @@ export class AuthService {
|
|||||||
email: user.email,
|
email: user.email,
|
||||||
firstName: user.firstName,
|
firstName: user.firstName,
|
||||||
lastName: user.lastName,
|
lastName: user.lastName,
|
||||||
|
tenantId: user.tenantId,
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
@@ -67,24 +74,18 @@ export class AuthService {
|
|||||||
firstName?: string,
|
firstName?: string,
|
||||||
lastName?: string,
|
lastName?: string,
|
||||||
) {
|
) {
|
||||||
const tenantDb = await this.tenantDbService.getTenantKnex(tenantId);
|
|
||||||
|
|
||||||
const hashedPassword = await bcrypt.hash(password, 10);
|
const hashedPassword = await bcrypt.hash(password, 10);
|
||||||
|
|
||||||
const [userId] = await tenantDb('users').insert({
|
const user = await this.prisma.user.create({
|
||||||
|
data: {
|
||||||
|
tenantId,
|
||||||
email,
|
email,
|
||||||
password: hashedPassword,
|
password: hashedPassword,
|
||||||
firstName,
|
firstName,
|
||||||
lastName,
|
lastName,
|
||||||
isActive: true,
|
},
|
||||||
created_at: new Date(),
|
|
||||||
updated_at: new Date(),
|
|
||||||
});
|
});
|
||||||
|
|
||||||
const user = await tenantDb('users')
|
|
||||||
.where({ id: userId })
|
|
||||||
.first();
|
|
||||||
|
|
||||||
const { password: _, ...result } = user;
|
const { password: _, ...result } = user;
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,49 +1,5 @@
|
|||||||
import { BaseModel } from './base.model';
|
import { BaseModel } from './base.model';
|
||||||
|
|
||||||
export interface FieldOption {
|
|
||||||
label: string;
|
|
||||||
value: string | number | boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface ValidationRule {
|
|
||||||
type: 'required' | 'min' | 'max' | 'email' | 'url' | 'pattern' | 'custom';
|
|
||||||
value?: any;
|
|
||||||
message?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface UIMetadata {
|
|
||||||
// Display properties
|
|
||||||
placeholder?: string;
|
|
||||||
helpText?: string;
|
|
||||||
|
|
||||||
// View visibility
|
|
||||||
showOnList?: boolean;
|
|
||||||
showOnDetail?: boolean;
|
|
||||||
showOnEdit?: boolean;
|
|
||||||
sortable?: boolean;
|
|
||||||
|
|
||||||
// Field type specific options
|
|
||||||
options?: FieldOption[]; // For select, multi-select
|
|
||||||
rows?: number; // For textarea
|
|
||||||
min?: number; // For number, date
|
|
||||||
max?: number; // For number, date
|
|
||||||
step?: number; // For number
|
|
||||||
accept?: string; // For file/image
|
|
||||||
relationDisplayField?: string; // Which field to display for relations
|
|
||||||
|
|
||||||
// Formatting
|
|
||||||
format?: string; // Date format, number format, etc.
|
|
||||||
prefix?: string; // Currency symbol, etc.
|
|
||||||
suffix?: string;
|
|
||||||
|
|
||||||
// Validation
|
|
||||||
validationRules?: ValidationRule[];
|
|
||||||
|
|
||||||
// Advanced
|
|
||||||
dependsOn?: string[]; // Field dependencies
|
|
||||||
computedValue?: string; // Formula for computed fields
|
|
||||||
}
|
|
||||||
|
|
||||||
export class FieldDefinition extends BaseModel {
|
export class FieldDefinition extends BaseModel {
|
||||||
static tableName = 'field_definitions';
|
static tableName = 'field_definitions';
|
||||||
|
|
||||||
@@ -63,7 +19,6 @@ export class FieldDefinition extends BaseModel {
|
|||||||
isSystem!: boolean;
|
isSystem!: boolean;
|
||||||
isCustom!: boolean;
|
isCustom!: boolean;
|
||||||
displayOrder!: number;
|
displayOrder!: number;
|
||||||
uiMetadata?: UIMetadata;
|
|
||||||
|
|
||||||
static relationMappings = {
|
static relationMappings = {
|
||||||
objectDefinition: {
|
objectDefinition: {
|
||||||
|
|||||||
@@ -1,295 +0,0 @@
|
|||||||
import { Injectable } from '@nestjs/common';
|
|
||||||
import { FieldDefinition } from '../models/field-definition.model';
|
|
||||||
|
|
||||||
export interface FieldConfigDTO {
|
|
||||||
id: string;
|
|
||||||
apiName: string;
|
|
||||||
label: string;
|
|
||||||
type: string;
|
|
||||||
placeholder?: string;
|
|
||||||
helpText?: string;
|
|
||||||
defaultValue?: any;
|
|
||||||
isRequired?: boolean;
|
|
||||||
isReadOnly?: boolean;
|
|
||||||
showOnList?: boolean;
|
|
||||||
showOnDetail?: boolean;
|
|
||||||
showOnEdit?: boolean;
|
|
||||||
sortable?: boolean;
|
|
||||||
options?: Array<{ label: string; value: any }>;
|
|
||||||
rows?: number;
|
|
||||||
min?: number;
|
|
||||||
max?: number;
|
|
||||||
step?: number;
|
|
||||||
accept?: string;
|
|
||||||
relationObject?: string;
|
|
||||||
relationDisplayField?: string;
|
|
||||||
format?: string;
|
|
||||||
prefix?: string;
|
|
||||||
suffix?: string;
|
|
||||||
validationRules?: Array<{
|
|
||||||
type: string;
|
|
||||||
value?: any;
|
|
||||||
message?: string;
|
|
||||||
}>;
|
|
||||||
dependsOn?: string[];
|
|
||||||
computedValue?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface ObjectDefinitionDTO {
|
|
||||||
id: string;
|
|
||||||
apiName: string;
|
|
||||||
label: string;
|
|
||||||
pluralLabel?: string;
|
|
||||||
description?: string;
|
|
||||||
isSystem: boolean;
|
|
||||||
fields: FieldConfigDTO[];
|
|
||||||
}
|
|
||||||
|
|
||||||
@Injectable()
|
|
||||||
export class FieldMapperService {
|
|
||||||
/**
|
|
||||||
* Convert a field definition from the database to a frontend-friendly FieldConfig
|
|
||||||
*/
|
|
||||||
mapFieldToDTO(field: any): FieldConfigDTO {
|
|
||||||
const uiMetadata = field.uiMetadata || {};
|
|
||||||
|
|
||||||
return {
|
|
||||||
id: field.id,
|
|
||||||
apiName: field.apiName,
|
|
||||||
label: field.label,
|
|
||||||
type: this.mapFieldType(field.type),
|
|
||||||
|
|
||||||
// Display properties
|
|
||||||
placeholder: uiMetadata.placeholder || field.description,
|
|
||||||
helpText: uiMetadata.helpText || field.description,
|
|
||||||
defaultValue: field.defaultValue,
|
|
||||||
|
|
||||||
// Validation
|
|
||||||
isRequired: field.isRequired || false,
|
|
||||||
isReadOnly: field.isSystem || uiMetadata.isReadOnly || false,
|
|
||||||
|
|
||||||
// View visibility
|
|
||||||
showOnList: uiMetadata.showOnList !== false,
|
|
||||||
showOnDetail: uiMetadata.showOnDetail !== false,
|
|
||||||
showOnEdit: uiMetadata.showOnEdit !== false && !field.isSystem,
|
|
||||||
sortable: uiMetadata.sortable !== false,
|
|
||||||
|
|
||||||
// Field type specific options
|
|
||||||
options: uiMetadata.options,
|
|
||||||
rows: uiMetadata.rows,
|
|
||||||
min: uiMetadata.min,
|
|
||||||
max: uiMetadata.max,
|
|
||||||
step: uiMetadata.step,
|
|
||||||
accept: uiMetadata.accept,
|
|
||||||
relationObject: field.referenceObject,
|
|
||||||
relationDisplayField: uiMetadata.relationDisplayField,
|
|
||||||
|
|
||||||
// Formatting
|
|
||||||
format: uiMetadata.format,
|
|
||||||
prefix: uiMetadata.prefix,
|
|
||||||
suffix: uiMetadata.suffix,
|
|
||||||
|
|
||||||
// Validation rules
|
|
||||||
validationRules: this.buildValidationRules(field, uiMetadata),
|
|
||||||
|
|
||||||
// Advanced
|
|
||||||
dependsOn: uiMetadata.dependsOn,
|
|
||||||
computedValue: uiMetadata.computedValue,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Map database field type to frontend FieldType enum
|
|
||||||
*/
|
|
||||||
private mapFieldType(dbType: string): string {
|
|
||||||
const typeMap: Record<string, string> = {
|
|
||||||
'string': 'text',
|
|
||||||
'text': 'textarea',
|
|
||||||
'integer': 'number',
|
|
||||||
'decimal': 'number',
|
|
||||||
'boolean': 'boolean',
|
|
||||||
'date': 'date',
|
|
||||||
'datetime': 'datetime',
|
|
||||||
'time': 'time',
|
|
||||||
'email': 'email',
|
|
||||||
'url': 'url',
|
|
||||||
'phone': 'text',
|
|
||||||
'picklist': 'select',
|
|
||||||
'multipicklist': 'multiSelect',
|
|
||||||
'lookup': 'belongsTo',
|
|
||||||
'master-detail': 'belongsTo',
|
|
||||||
'currency': 'currency',
|
|
||||||
'percent': 'number',
|
|
||||||
'textarea': 'textarea',
|
|
||||||
'richtext': 'markdown',
|
|
||||||
'file': 'file',
|
|
||||||
'image': 'image',
|
|
||||||
'json': 'json',
|
|
||||||
};
|
|
||||||
|
|
||||||
return typeMap[dbType.toLowerCase()] || 'text';
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Build validation rules array
|
|
||||||
*/
|
|
||||||
private buildValidationRules(field: any, uiMetadata: any): Array<any> {
|
|
||||||
const rules = uiMetadata.validationRules || [];
|
|
||||||
|
|
||||||
// Add required rule if field is required and not already in rules
|
|
||||||
if (field.isRequired && !rules.some(r => r.type === 'required')) {
|
|
||||||
rules.unshift({
|
|
||||||
type: 'required',
|
|
||||||
message: `${field.label} is required`,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add length validation for string fields
|
|
||||||
if (field.length && field.type === 'string') {
|
|
||||||
rules.push({
|
|
||||||
type: 'max',
|
|
||||||
value: field.length,
|
|
||||||
message: `${field.label} must not exceed ${field.length} characters`,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add email validation
|
|
||||||
if (field.type === 'email' && !rules.some(r => r.type === 'email')) {
|
|
||||||
rules.push({
|
|
||||||
type: 'email',
|
|
||||||
message: `${field.label} must be a valid email address`,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add URL validation
|
|
||||||
if (field.type === 'url' && !rules.some(r => r.type === 'url')) {
|
|
||||||
rules.push({
|
|
||||||
type: 'url',
|
|
||||||
message: `${field.label} must be a valid URL`,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return rules;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Convert object definition with fields to DTO
|
|
||||||
*/
|
|
||||||
mapObjectDefinitionToDTO(objectDef: any): ObjectDefinitionDTO {
|
|
||||||
return {
|
|
||||||
id: objectDef.id,
|
|
||||||
apiName: objectDef.apiName,
|
|
||||||
label: objectDef.label,
|
|
||||||
pluralLabel: objectDef.pluralLabel,
|
|
||||||
description: objectDef.description,
|
|
||||||
isSystem: objectDef.isSystem || false,
|
|
||||||
fields: (objectDef.fields || [])
|
|
||||||
.filter((f: any) => f.isActive !== false)
|
|
||||||
.sort((a: any, b: any) => (a.displayOrder || 0) - (b.displayOrder || 0))
|
|
||||||
.map((f: any) => this.mapFieldToDTO(f)),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Generate default UI metadata for a field type
|
|
||||||
*/
|
|
||||||
generateDefaultUIMetadata(fieldType: string): any {
|
|
||||||
const defaults: Record<string, any> = {
|
|
||||||
text: {
|
|
||||||
showOnList: true,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true,
|
|
||||||
},
|
|
||||||
textarea: {
|
|
||||||
showOnList: false,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: false,
|
|
||||||
rows: 4,
|
|
||||||
},
|
|
||||||
number: {
|
|
||||||
showOnList: true,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true,
|
|
||||||
},
|
|
||||||
currency: {
|
|
||||||
showOnList: true,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true,
|
|
||||||
prefix: '$',
|
|
||||||
step: 0.01,
|
|
||||||
},
|
|
||||||
boolean: {
|
|
||||||
showOnList: true,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true,
|
|
||||||
},
|
|
||||||
date: {
|
|
||||||
showOnList: true,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true,
|
|
||||||
format: 'yyyy-MM-dd',
|
|
||||||
},
|
|
||||||
datetime: {
|
|
||||||
showOnList: false,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true,
|
|
||||||
format: 'yyyy-MM-dd HH:mm:ss',
|
|
||||||
},
|
|
||||||
email: {
|
|
||||||
showOnList: true,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true,
|
|
||||||
validationRules: [{ type: 'email' }],
|
|
||||||
},
|
|
||||||
url: {
|
|
||||||
showOnList: false,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: false,
|
|
||||||
validationRules: [{ type: 'url' }],
|
|
||||||
},
|
|
||||||
select: {
|
|
||||||
showOnList: true,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true,
|
|
||||||
options: [],
|
|
||||||
},
|
|
||||||
multiSelect: {
|
|
||||||
showOnList: false,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: false,
|
|
||||||
options: [],
|
|
||||||
},
|
|
||||||
image: {
|
|
||||||
showOnList: false,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: false,
|
|
||||||
accept: 'image/*',
|
|
||||||
},
|
|
||||||
file: {
|
|
||||||
showOnList: false,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: false,
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
return defaults[fieldType] || {
|
|
||||||
showOnList: true,
|
|
||||||
showOnDetail: true,
|
|
||||||
showOnEdit: true,
|
|
||||||
sortable: true,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -3,13 +3,12 @@ import { ObjectService } from './object.service';
|
|||||||
import { RuntimeObjectController } from './runtime-object.controller';
|
import { RuntimeObjectController } from './runtime-object.controller';
|
||||||
import { SetupObjectController } from './setup-object.controller';
|
import { SetupObjectController } from './setup-object.controller';
|
||||||
import { SchemaManagementService } from './schema-management.service';
|
import { SchemaManagementService } from './schema-management.service';
|
||||||
import { FieldMapperService } from './field-mapper.service';
|
|
||||||
import { TenantModule } from '../tenant/tenant.module';
|
import { TenantModule } from '../tenant/tenant.module';
|
||||||
|
|
||||||
@Module({
|
@Module({
|
||||||
imports: [TenantModule],
|
imports: [TenantModule],
|
||||||
providers: [ObjectService, SchemaManagementService, FieldMapperService],
|
providers: [ObjectService, SchemaManagementService],
|
||||||
controllers: [RuntimeObjectController, SetupObjectController],
|
controllers: [RuntimeObjectController, SetupObjectController],
|
||||||
exports: [ObjectService, SchemaManagementService, FieldMapperService],
|
exports: [ObjectService, SchemaManagementService],
|
||||||
})
|
})
|
||||||
export class ObjectModule {}
|
export class ObjectModule {}
|
||||||
|
|||||||
@@ -1,62 +1,42 @@
|
|||||||
import { Injectable, NotFoundException } from '@nestjs/common';
|
import { Injectable, NotFoundException } from '@nestjs/common';
|
||||||
import { TenantDatabaseService } from '../tenant/tenant-database.service';
|
import { PrismaService } from '../prisma/prisma.service';
|
||||||
|
|
||||||
@Injectable()
|
@Injectable()
|
||||||
export class ObjectService {
|
export class ObjectService {
|
||||||
constructor(private tenantDbService: TenantDatabaseService) {}
|
constructor(private prisma: PrismaService) {}
|
||||||
|
|
||||||
// Setup endpoints - Object metadata management
|
// Setup endpoints - Object metadata management
|
||||||
async getObjectDefinitions(tenantId: string) {
|
async getObjectDefinitions(tenantId: string) {
|
||||||
const knex = await this.tenantDbService.getTenantKnex(tenantId);
|
return this.prisma.objectDefinition.findMany({
|
||||||
|
where: { tenantId },
|
||||||
const objects = await knex('object_definitions')
|
include: {
|
||||||
.select('object_definitions.*')
|
fields: true,
|
||||||
.orderBy('label', 'asc');
|
},
|
||||||
|
orderBy: { label: 'asc' },
|
||||||
// Fetch app information for objects that have app_id
|
});
|
||||||
for (const obj of objects) {
|
|
||||||
if (obj.app_id) {
|
|
||||||
const app = await knex('apps')
|
|
||||||
.where({ id: obj.app_id })
|
|
||||||
.select('id', 'slug', 'label', 'description')
|
|
||||||
.first();
|
|
||||||
obj.app = app;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return objects;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async getObjectDefinition(tenantId: string, apiName: string) {
|
async getObjectDefinition(tenantId: string, apiName: string) {
|
||||||
const knex = await this.tenantDbService.getTenantKnex(tenantId);
|
const obj = await this.prisma.objectDefinition.findUnique({
|
||||||
|
where: {
|
||||||
const obj = await knex('object_definitions')
|
tenantId_apiName: {
|
||||||
.where({ apiName })
|
tenantId,
|
||||||
.first();
|
apiName,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
include: {
|
||||||
|
fields: {
|
||||||
|
where: { isActive: true },
|
||||||
|
orderBy: { label: 'asc' },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
if (!obj) {
|
if (!obj) {
|
||||||
throw new NotFoundException(`Object ${apiName} not found`);
|
throw new NotFoundException(`Object ${apiName} not found`);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Get fields for this object
|
return obj;
|
||||||
const fields = await knex('field_definitions')
|
|
||||||
.where({ objectDefinitionId: obj.id })
|
|
||||||
.orderBy('label', 'asc');
|
|
||||||
|
|
||||||
// Get app information if object belongs to an app
|
|
||||||
let app = null;
|
|
||||||
if (obj.app_id) {
|
|
||||||
app = await knex('apps')
|
|
||||||
.where({ id: obj.app_id })
|
|
||||||
.select('id', 'slug', 'label', 'description')
|
|
||||||
.first();
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
...obj,
|
|
||||||
fields,
|
|
||||||
app,
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async createObjectDefinition(
|
async createObjectDefinition(
|
||||||
@@ -69,15 +49,13 @@ export class ObjectService {
|
|||||||
isSystem?: boolean;
|
isSystem?: boolean;
|
||||||
},
|
},
|
||||||
) {
|
) {
|
||||||
const knex = await this.tenantDbService.getTenantKnex(tenantId);
|
return this.prisma.objectDefinition.create({
|
||||||
const [id] = await knex('object_definitions').insert({
|
data: {
|
||||||
id: knex.raw('(UUID())'),
|
tenantId,
|
||||||
...data,
|
...data,
|
||||||
created_at: knex.fn.now(),
|
tableName: `custom_${data.apiName.toLowerCase()}`,
|
||||||
updated_at: knex.fn.now(),
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
return knex('object_definitions').where({ id }).first();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async createFieldDefinition(
|
async createFieldDefinition(
|
||||||
@@ -90,41 +68,20 @@ export class ObjectService {
|
|||||||
description?: string;
|
description?: string;
|
||||||
isRequired?: boolean;
|
isRequired?: boolean;
|
||||||
isUnique?: boolean;
|
isUnique?: boolean;
|
||||||
referenceObject?: string;
|
isLookup?: boolean;
|
||||||
|
referenceTo?: string;
|
||||||
defaultValue?: string;
|
defaultValue?: string;
|
||||||
|
options?: any;
|
||||||
},
|
},
|
||||||
) {
|
) {
|
||||||
const knex = await this.tenantDbService.getTenantKnex(tenantId);
|
|
||||||
const obj = await this.getObjectDefinition(tenantId, objectApiName);
|
const obj = await this.getObjectDefinition(tenantId, objectApiName);
|
||||||
|
|
||||||
const [id] = await knex('field_definitions').insert({
|
return this.prisma.fieldDefinition.create({
|
||||||
id: knex.raw('(UUID())'),
|
data: {
|
||||||
objectDefinitionId: obj.id,
|
objectId: obj.id,
|
||||||
...data,
|
...data,
|
||||||
created_at: knex.fn.now(),
|
},
|
||||||
updated_at: knex.fn.now(),
|
|
||||||
});
|
});
|
||||||
|
|
||||||
return knex('field_definitions').where({ id }).first();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Helper to get table name from object definition
|
|
||||||
private getTableName(objectApiName: string): string {
|
|
||||||
// Convert CamelCase to snake_case and pluralize
|
|
||||||
// Account -> accounts, ContactPerson -> contact_persons
|
|
||||||
const snakeCase = objectApiName
|
|
||||||
.replace(/([A-Z])/g, '_$1')
|
|
||||||
.toLowerCase()
|
|
||||||
.replace(/^_/, '');
|
|
||||||
|
|
||||||
// Simple pluralization (can be enhanced)
|
|
||||||
if (snakeCase.endsWith('y')) {
|
|
||||||
return snakeCase.slice(0, -1) + 'ies';
|
|
||||||
} else if (snakeCase.endsWith('s')) {
|
|
||||||
return snakeCase;
|
|
||||||
} else {
|
|
||||||
return snakeCase + 's';
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Runtime endpoints - CRUD operations
|
// Runtime endpoints - CRUD operations
|
||||||
@@ -134,27 +91,20 @@ export class ObjectService {
|
|||||||
userId: string,
|
userId: string,
|
||||||
filters?: any,
|
filters?: any,
|
||||||
) {
|
) {
|
||||||
const knex = await this.tenantDbService.getTenantKnex(tenantId);
|
// For demonstration, using Account as example static object
|
||||||
|
if (objectApiName === 'Account') {
|
||||||
// Verify object exists
|
return this.prisma.account.findMany({
|
||||||
await this.getObjectDefinition(tenantId, objectApiName);
|
where: {
|
||||||
|
tenantId,
|
||||||
const tableName = this.getTableName(objectApiName);
|
ownerId: userId, // Basic sharing rule
|
||||||
|
...filters,
|
||||||
let query = knex(tableName);
|
},
|
||||||
|
});
|
||||||
// Add ownership filter if ownerId field exists
|
|
||||||
const hasOwner = await knex.schema.hasColumn(tableName, 'ownerId');
|
|
||||||
if (hasOwner) {
|
|
||||||
query = query.where({ ownerId: userId });
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Apply additional filters
|
// For custom objects, you'd need dynamic query building
|
||||||
if (filters) {
|
// This is a simplified version
|
||||||
query = query.where(filters);
|
throw new Error(`Runtime queries for ${objectApiName} not yet implemented`);
|
||||||
}
|
|
||||||
|
|
||||||
return query.select('*');
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async getRecord(
|
async getRecord(
|
||||||
@@ -163,22 +113,14 @@ export class ObjectService {
|
|||||||
recordId: string,
|
recordId: string,
|
||||||
userId: string,
|
userId: string,
|
||||||
) {
|
) {
|
||||||
const knex = await this.tenantDbService.getTenantKnex(tenantId);
|
if (objectApiName === 'Account') {
|
||||||
|
const record = await this.prisma.account.findFirst({
|
||||||
// Verify object exists
|
where: {
|
||||||
await this.getObjectDefinition(tenantId, objectApiName);
|
id: recordId,
|
||||||
|
tenantId,
|
||||||
const tableName = this.getTableName(objectApiName);
|
ownerId: userId,
|
||||||
|
},
|
||||||
let query = knex(tableName).where({ id: recordId });
|
});
|
||||||
|
|
||||||
// Add ownership filter if ownerId field exists
|
|
||||||
const hasOwner = await knex.schema.hasColumn(tableName, 'ownerId');
|
|
||||||
if (hasOwner) {
|
|
||||||
query = query.where({ ownerId: userId });
|
|
||||||
}
|
|
||||||
|
|
||||||
const record = await query.first();
|
|
||||||
|
|
||||||
if (!record) {
|
if (!record) {
|
||||||
throw new NotFoundException('Record not found');
|
throw new NotFoundException('Record not found');
|
||||||
@@ -187,36 +129,26 @@ export class ObjectService {
|
|||||||
return record;
|
return record;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
throw new Error(`Runtime queries for ${objectApiName} not yet implemented`);
|
||||||
|
}
|
||||||
|
|
||||||
async createRecord(
|
async createRecord(
|
||||||
tenantId: string,
|
tenantId: string,
|
||||||
objectApiName: string,
|
objectApiName: string,
|
||||||
data: any,
|
data: any,
|
||||||
userId: string,
|
userId: string,
|
||||||
) {
|
) {
|
||||||
const knex = await this.tenantDbService.getTenantKnex(tenantId);
|
if (objectApiName === 'Account') {
|
||||||
|
return this.prisma.account.create({
|
||||||
// Verify object exists
|
data: {
|
||||||
await this.getObjectDefinition(tenantId, objectApiName);
|
tenantId,
|
||||||
|
ownerId: userId,
|
||||||
const tableName = this.getTableName(objectApiName);
|
|
||||||
|
|
||||||
// Check if table has ownerId column
|
|
||||||
const hasOwner = await knex.schema.hasColumn(tableName, 'ownerId');
|
|
||||||
|
|
||||||
const recordData: any = {
|
|
||||||
id: knex.raw('(UUID())'),
|
|
||||||
...data,
|
...data,
|
||||||
created_at: knex.fn.now(),
|
},
|
||||||
updated_at: knex.fn.now(),
|
});
|
||||||
};
|
|
||||||
|
|
||||||
if (hasOwner) {
|
|
||||||
recordData.ownerId = userId;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const [id] = await knex(tableName).insert(recordData);
|
throw new Error(`Runtime queries for ${objectApiName} not yet implemented`);
|
||||||
|
|
||||||
return knex(tableName).where({ id }).first();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async updateRecord(
|
async updateRecord(
|
||||||
@@ -226,18 +158,17 @@ export class ObjectService {
|
|||||||
data: any,
|
data: any,
|
||||||
userId: string,
|
userId: string,
|
||||||
) {
|
) {
|
||||||
const knex = await this.tenantDbService.getTenantKnex(tenantId);
|
if (objectApiName === 'Account') {
|
||||||
|
// Verify ownership
|
||||||
// Verify object exists and user has access
|
|
||||||
await this.getRecord(tenantId, objectApiName, recordId, userId);
|
await this.getRecord(tenantId, objectApiName, recordId, userId);
|
||||||
|
|
||||||
const tableName = this.getTableName(objectApiName);
|
return this.prisma.account.update({
|
||||||
|
where: { id: recordId },
|
||||||
|
data,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
await knex(tableName)
|
throw new Error(`Runtime queries for ${objectApiName} not yet implemented`);
|
||||||
.where({ id: recordId })
|
|
||||||
.update({ ...data, updated_at: knex.fn.now() });
|
|
||||||
|
|
||||||
return knex(tableName).where({ id: recordId }).first();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async deleteRecord(
|
async deleteRecord(
|
||||||
@@ -246,15 +177,15 @@ export class ObjectService {
|
|||||||
recordId: string,
|
recordId: string,
|
||||||
userId: string,
|
userId: string,
|
||||||
) {
|
) {
|
||||||
const knex = await this.tenantDbService.getTenantKnex(tenantId);
|
if (objectApiName === 'Account') {
|
||||||
|
// Verify ownership
|
||||||
// Verify object exists and user has access
|
|
||||||
await this.getRecord(tenantId, objectApiName, recordId, userId);
|
await this.getRecord(tenantId, objectApiName, recordId, userId);
|
||||||
|
|
||||||
const tableName = this.getTableName(objectApiName);
|
return this.prisma.account.delete({
|
||||||
|
where: { id: recordId },
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
await knex(tableName).where({ id: recordId }).delete();
|
throw new Error(`Runtime queries for ${objectApiName} not yet implemented`);
|
||||||
|
|
||||||
return { success: true };
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,17 +7,13 @@ import {
|
|||||||
UseGuards,
|
UseGuards,
|
||||||
} from '@nestjs/common';
|
} from '@nestjs/common';
|
||||||
import { ObjectService } from './object.service';
|
import { ObjectService } from './object.service';
|
||||||
import { FieldMapperService } from './field-mapper.service';
|
|
||||||
import { JwtAuthGuard } from '../auth/jwt-auth.guard';
|
import { JwtAuthGuard } from '../auth/jwt-auth.guard';
|
||||||
import { TenantId } from '../tenant/tenant.decorator';
|
import { TenantId } from '../tenant/tenant.decorator';
|
||||||
|
|
||||||
@Controller('setup/objects')
|
@Controller('setup/objects')
|
||||||
@UseGuards(JwtAuthGuard)
|
@UseGuards(JwtAuthGuard)
|
||||||
export class SetupObjectController {
|
export class SetupObjectController {
|
||||||
constructor(
|
constructor(private objectService: ObjectService) {}
|
||||||
private objectService: ObjectService,
|
|
||||||
private fieldMapperService: FieldMapperService,
|
|
||||||
) {}
|
|
||||||
|
|
||||||
@Get()
|
@Get()
|
||||||
async getObjectDefinitions(@TenantId() tenantId: string) {
|
async getObjectDefinitions(@TenantId() tenantId: string) {
|
||||||
@@ -32,18 +28,6 @@ export class SetupObjectController {
|
|||||||
return this.objectService.getObjectDefinition(tenantId, objectApiName);
|
return this.objectService.getObjectDefinition(tenantId, objectApiName);
|
||||||
}
|
}
|
||||||
|
|
||||||
@Get(':objectApiName/ui-config')
|
|
||||||
async getObjectUIConfig(
|
|
||||||
@TenantId() tenantId: string,
|
|
||||||
@Param('objectApiName') objectApiName: string,
|
|
||||||
) {
|
|
||||||
const objectDef = await this.objectService.getObjectDefinition(
|
|
||||||
tenantId,
|
|
||||||
objectApiName,
|
|
||||||
);
|
|
||||||
return this.fieldMapperService.mapObjectDefinitionToDTO(objectDef);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Post()
|
@Post()
|
||||||
async createObjectDefinition(
|
async createObjectDefinition(
|
||||||
@TenantId() tenantId: string,
|
@TenantId() tenantId: string,
|
||||||
|
|||||||
@@ -1,54 +0,0 @@
|
|||||||
import { IsString, IsUUID, IsBoolean, IsOptional, IsObject } from 'class-validator';
|
|
||||||
|
|
||||||
export class CreatePageLayoutDto {
|
|
||||||
@IsString()
|
|
||||||
name: string;
|
|
||||||
|
|
||||||
@IsUUID()
|
|
||||||
objectId: string;
|
|
||||||
|
|
||||||
@IsBoolean()
|
|
||||||
@IsOptional()
|
|
||||||
isDefault?: boolean;
|
|
||||||
|
|
||||||
@IsObject()
|
|
||||||
layoutConfig: {
|
|
||||||
fields: Array<{
|
|
||||||
fieldId: string;
|
|
||||||
x: number;
|
|
||||||
y: number;
|
|
||||||
w: number;
|
|
||||||
h: number;
|
|
||||||
}>;
|
|
||||||
};
|
|
||||||
|
|
||||||
@IsString()
|
|
||||||
@IsOptional()
|
|
||||||
description?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export class UpdatePageLayoutDto {
|
|
||||||
@IsString()
|
|
||||||
@IsOptional()
|
|
||||||
name?: string;
|
|
||||||
|
|
||||||
@IsBoolean()
|
|
||||||
@IsOptional()
|
|
||||||
isDefault?: boolean;
|
|
||||||
|
|
||||||
@IsObject()
|
|
||||||
@IsOptional()
|
|
||||||
layoutConfig?: {
|
|
||||||
fields: Array<{
|
|
||||||
fieldId: string;
|
|
||||||
x: number;
|
|
||||||
y: number;
|
|
||||||
w: number;
|
|
||||||
h: number;
|
|
||||||
}>;
|
|
||||||
};
|
|
||||||
|
|
||||||
@IsString()
|
|
||||||
@IsOptional()
|
|
||||||
description?: string;
|
|
||||||
}
|
|
||||||
@@ -1,55 +0,0 @@
|
|||||||
import {
|
|
||||||
Controller,
|
|
||||||
Get,
|
|
||||||
Post,
|
|
||||||
Body,
|
|
||||||
Patch,
|
|
||||||
Param,
|
|
||||||
Delete,
|
|
||||||
UseGuards,
|
|
||||||
Query,
|
|
||||||
} from '@nestjs/common';
|
|
||||||
import { PageLayoutService } from './page-layout.service';
|
|
||||||
import { CreatePageLayoutDto, UpdatePageLayoutDto } from './dto/page-layout.dto';
|
|
||||||
import { JwtAuthGuard } from '../auth/jwt-auth.guard';
|
|
||||||
import { TenantId } from '../tenant/tenant.decorator';
|
|
||||||
|
|
||||||
@Controller('page-layouts')
|
|
||||||
@UseGuards(JwtAuthGuard)
|
|
||||||
export class PageLayoutController {
|
|
||||||
constructor(private readonly pageLayoutService: PageLayoutService) {}
|
|
||||||
|
|
||||||
@Post()
|
|
||||||
create(@TenantId() tenantId: string, @Body() createPageLayoutDto: CreatePageLayoutDto) {
|
|
||||||
return this.pageLayoutService.create(tenantId, createPageLayoutDto);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Get()
|
|
||||||
findAll(@TenantId() tenantId: string, @Query('objectId') objectId?: string) {
|
|
||||||
return this.pageLayoutService.findAll(tenantId, objectId);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Get('default/:objectId')
|
|
||||||
findDefaultByObject(@TenantId() tenantId: string, @Param('objectId') objectId: string) {
|
|
||||||
return this.pageLayoutService.findDefaultByObject(tenantId, objectId);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Get(':id')
|
|
||||||
findOne(@TenantId() tenantId: string, @Param('id') id: string) {
|
|
||||||
return this.pageLayoutService.findOne(tenantId, id);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Patch(':id')
|
|
||||||
update(
|
|
||||||
@TenantId() tenantId: string,
|
|
||||||
@Param('id') id: string,
|
|
||||||
@Body() updatePageLayoutDto: UpdatePageLayoutDto,
|
|
||||||
) {
|
|
||||||
return this.pageLayoutService.update(tenantId, id, updatePageLayoutDto);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Delete(':id')
|
|
||||||
remove(@TenantId() tenantId: string, @Param('id') id: string) {
|
|
||||||
return this.pageLayoutService.remove(tenantId, id);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
import { Module } from '@nestjs/common';
|
|
||||||
import { PageLayoutService } from './page-layout.service';
|
|
||||||
import { PageLayoutController } from './page-layout.controller';
|
|
||||||
import { TenantModule } from '../tenant/tenant.module';
|
|
||||||
|
|
||||||
@Module({
|
|
||||||
imports: [TenantModule],
|
|
||||||
controllers: [PageLayoutController],
|
|
||||||
providers: [PageLayoutService],
|
|
||||||
exports: [PageLayoutService],
|
|
||||||
})
|
|
||||||
export class PageLayoutModule {}
|
|
||||||
@@ -1,118 +0,0 @@
|
|||||||
import { Injectable, NotFoundException } from '@nestjs/common';
|
|
||||||
import { TenantDatabaseService } from '../tenant/tenant-database.service';
|
|
||||||
import { CreatePageLayoutDto, UpdatePageLayoutDto } from './dto/page-layout.dto';
|
|
||||||
|
|
||||||
@Injectable()
|
|
||||||
export class PageLayoutService {
|
|
||||||
constructor(private tenantDbService: TenantDatabaseService) {}
|
|
||||||
|
|
||||||
async create(tenantId: string, createDto: CreatePageLayoutDto) {
|
|
||||||
const knex = await this.tenantDbService.getTenantKnex(tenantId);
|
|
||||||
|
|
||||||
// If this layout is set as default, unset other defaults for the same object
|
|
||||||
if (createDto.isDefault) {
|
|
||||||
await knex('page_layouts')
|
|
||||||
.where({ object_id: createDto.objectId })
|
|
||||||
.update({ is_default: false });
|
|
||||||
}
|
|
||||||
|
|
||||||
const [id] = await knex('page_layouts').insert({
|
|
||||||
name: createDto.name,
|
|
||||||
object_id: createDto.objectId,
|
|
||||||
is_default: createDto.isDefault || false,
|
|
||||||
layout_config: JSON.stringify(createDto.layoutConfig),
|
|
||||||
description: createDto.description || null,
|
|
||||||
});
|
|
||||||
|
|
||||||
// Get the inserted record
|
|
||||||
const result = await knex('page_layouts').where({ id }).first();
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
|
|
||||||
async findAll(tenantId: string, objectId?: string) {
|
|
||||||
const knex = await this.tenantDbService.getTenantKnex(tenantId);
|
|
||||||
|
|
||||||
let query = knex('page_layouts');
|
|
||||||
|
|
||||||
if (objectId) {
|
|
||||||
query = query.where({ object_id: objectId });
|
|
||||||
}
|
|
||||||
|
|
||||||
const layouts = await query.orderByRaw('is_default DESC, name ASC');
|
|
||||||
return layouts;
|
|
||||||
}
|
|
||||||
|
|
||||||
async findOne(tenantId: string, id: string) {
|
|
||||||
const knex = await this.tenantDbService.getTenantKnex(tenantId);
|
|
||||||
|
|
||||||
const layout = await knex('page_layouts').where({ id }).first();
|
|
||||||
|
|
||||||
if (!layout) {
|
|
||||||
throw new NotFoundException(`Page layout with ID ${id} not found`);
|
|
||||||
}
|
|
||||||
|
|
||||||
return layout;
|
|
||||||
}
|
|
||||||
|
|
||||||
async findDefaultByObject(tenantId: string, objectId: string) {
|
|
||||||
const knex = await this.tenantDbService.getTenantKnex(tenantId);
|
|
||||||
|
|
||||||
const layout = await knex('page_layouts')
|
|
||||||
.where({ object_id: objectId, is_default: true })
|
|
||||||
.first();
|
|
||||||
|
|
||||||
return layout || null;
|
|
||||||
}
|
|
||||||
|
|
||||||
async update(tenantId: string, id: string, updateDto: UpdatePageLayoutDto) {
|
|
||||||
const knex = await this.tenantDbService.getTenantKnex(tenantId);
|
|
||||||
|
|
||||||
// Check if layout exists
|
|
||||||
await this.findOne(tenantId, id);
|
|
||||||
|
|
||||||
// If setting as default, unset other defaults for the same object
|
|
||||||
if (updateDto.isDefault) {
|
|
||||||
const layout = await this.findOne(tenantId, id);
|
|
||||||
await knex('page_layouts')
|
|
||||||
.where({ object_id: layout.object_id })
|
|
||||||
.whereNot({ id })
|
|
||||||
.update({ is_default: false });
|
|
||||||
}
|
|
||||||
|
|
||||||
const updates: any = {};
|
|
||||||
|
|
||||||
if (updateDto.name !== undefined) {
|
|
||||||
updates.name = updateDto.name;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (updateDto.isDefault !== undefined) {
|
|
||||||
updates.is_default = updateDto.isDefault;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (updateDto.layoutConfig !== undefined) {
|
|
||||||
updates.layout_config = JSON.stringify(updateDto.layoutConfig);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (updateDto.description !== undefined) {
|
|
||||||
updates.description = updateDto.description;
|
|
||||||
}
|
|
||||||
|
|
||||||
updates.updated_at = knex.fn.now();
|
|
||||||
|
|
||||||
await knex('page_layouts').where({ id }).update(updates);
|
|
||||||
|
|
||||||
// Get the updated record
|
|
||||||
const result = await knex('page_layouts').where({ id }).first();
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
|
|
||||||
async remove(tenantId: string, id: string) {
|
|
||||||
const knex = await this.tenantDbService.getTenantKnex(tenantId);
|
|
||||||
|
|
||||||
await this.findOne(tenantId, id);
|
|
||||||
|
|
||||||
await knex('page_layouts').where({ id }).delete();
|
|
||||||
|
|
||||||
return { message: 'Page layout deleted successfully' };
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
import { Injectable, OnModuleInit, OnModuleDestroy } from '@nestjs/common';
|
import { Injectable, OnModuleInit, OnModuleDestroy } from '@nestjs/common';
|
||||||
import { PrismaClient } from '.prisma/tenant';
|
import { PrismaClient } from '@prisma/client';
|
||||||
|
|
||||||
@Injectable()
|
@Injectable()
|
||||||
export class PrismaService
|
export class PrismaService
|
||||||
|
|||||||
@@ -8,30 +8,22 @@ export class TenantDatabaseService {
|
|||||||
private readonly logger = new Logger(TenantDatabaseService.name);
|
private readonly logger = new Logger(TenantDatabaseService.name);
|
||||||
private tenantConnections: Map<string, Knex> = new Map();
|
private tenantConnections: Map<string, Knex> = new Map();
|
||||||
|
|
||||||
async getTenantKnex(tenantIdOrSlug: string): Promise<Knex> {
|
async getTenantKnex(tenantId: string): Promise<Knex> {
|
||||||
if (this.tenantConnections.has(tenantIdOrSlug)) {
|
if (this.tenantConnections.has(tenantId)) {
|
||||||
return this.tenantConnections.get(tenantIdOrSlug);
|
return this.tenantConnections.get(tenantId);
|
||||||
}
|
}
|
||||||
|
|
||||||
const centralPrisma = getCentralPrisma();
|
const centralPrisma = getCentralPrisma();
|
||||||
|
const tenant = await centralPrisma.tenant.findUnique({
|
||||||
// Try to find tenant by ID first, then by slug
|
where: { id: tenantId },
|
||||||
let tenant = await centralPrisma.tenant.findUnique({
|
|
||||||
where: { id: tenantIdOrSlug },
|
|
||||||
});
|
});
|
||||||
|
|
||||||
if (!tenant) {
|
if (!tenant) {
|
||||||
tenant = await centralPrisma.tenant.findUnique({
|
throw new Error(`Tenant ${tenantId} not found`);
|
||||||
where: { slug: tenantIdOrSlug },
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!tenant) {
|
|
||||||
throw new Error(`Tenant ${tenantIdOrSlug} not found`);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if (tenant.status !== 'active') {
|
if (tenant.status !== 'active') {
|
||||||
throw new Error(`Tenant ${tenantIdOrSlug} is not active`);
|
throw new Error(`Tenant ${tenantId} is not active`);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Decrypt password
|
// Decrypt password
|
||||||
@@ -64,7 +56,7 @@ export class TenantDatabaseService {
|
|||||||
throw error;
|
throw error;
|
||||||
}
|
}
|
||||||
|
|
||||||
this.tenantConnections.set(tenantIdOrSlug, tenantKnex);
|
this.tenantConnections.set(tenantId, tenantKnex);
|
||||||
return tenantKnex;
|
return tenantKnex;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -19,53 +19,29 @@ export class TenantMiddleware implements NestMiddleware {
|
|||||||
const hostname = host.split(':')[0]; // Remove port if present
|
const hostname = host.split(':')[0]; // Remove port if present
|
||||||
const parts = hostname.split('.');
|
const parts = hostname.split('.');
|
||||||
|
|
||||||
this.logger.log(`Host header: ${host}, hostname: ${hostname}, parts: ${JSON.stringify(parts)}`);
|
// For local development, accept x-tenant-id header as fallback
|
||||||
|
|
||||||
// For local development, accept x-tenant-id header
|
|
||||||
let tenantId = req.headers['x-tenant-id'] as string;
|
let tenantId = req.headers['x-tenant-id'] as string;
|
||||||
let subdomain: string | null = null;
|
let subdomain: string | null = null;
|
||||||
|
|
||||||
this.logger.log(`Host header: ${host}, hostname: ${hostname}, parts: ${JSON.stringify(parts)}, x-tenant-id: ${tenantId}`);
|
// Extract subdomain (e.g., "acme" from "acme.routebox.co")
|
||||||
|
if (parts.length > 2) {
|
||||||
// If x-tenant-id is explicitly provided, use it directly
|
|
||||||
if (tenantId) {
|
|
||||||
this.logger.log(`Using explicit x-tenant-id: ${tenantId}`);
|
|
||||||
(req as any).tenantId = tenantId;
|
|
||||||
next();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Extract subdomain (e.g., "tenant1" from "tenant1.routebox.co")
|
|
||||||
// For production domains with 3+ parts, extract first part as subdomain
|
|
||||||
if (parts.length >= 3) {
|
|
||||||
subdomain = parts[0];
|
subdomain = parts[0];
|
||||||
// Ignore www subdomain
|
// Ignore www subdomain
|
||||||
if (subdomain === 'www') {
|
if (subdomain === 'www') {
|
||||||
subdomain = null;
|
subdomain = null;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// For development (e.g., tenant1.localhost), also check 2 parts
|
|
||||||
else if (parts.length === 2 && parts[1] === 'localhost') {
|
|
||||||
subdomain = parts[0];
|
|
||||||
}
|
|
||||||
|
|
||||||
this.logger.log(`Extracted subdomain: ${subdomain}`);
|
|
||||||
|
|
||||||
// Get tenant by subdomain if available
|
// Get tenant by subdomain if available
|
||||||
if (subdomain) {
|
if (subdomain) {
|
||||||
try {
|
|
||||||
const tenant = await this.tenantDbService.getTenantByDomain(subdomain);
|
const tenant = await this.tenantDbService.getTenantByDomain(subdomain);
|
||||||
if (tenant) {
|
if (tenant) {
|
||||||
tenantId = tenant.id;
|
tenantId = tenant.id;
|
||||||
this.logger.log(
|
this.logger.log(
|
||||||
`Tenant identified: ${tenant.name} (${tenant.id}) from subdomain: ${subdomain}`,
|
`Tenant identified: ${tenant.name} (${tenant.id}) from subdomain: ${subdomain}`,
|
||||||
);
|
);
|
||||||
}
|
} else {
|
||||||
} catch (error) {
|
this.logger.warn(`No tenant found for subdomain: ${subdomain}`);
|
||||||
this.logger.warn(`No tenant found for subdomain: ${subdomain}`, error.message);
|
|
||||||
// Fall back to using subdomain as tenantId directly if domain lookup fails
|
|
||||||
tenantId = subdomain;
|
|
||||||
this.logger.log(`Using subdomain as tenantId fallback: ${tenantId}`);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,10 +1,5 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import { Toaster } from 'vue-sonner'
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<div>
|
<div>
|
||||||
<Toaster position="top-right" :duration="4000" richColors />
|
|
||||||
<NuxtPage />
|
<NuxtPage />
|
||||||
</div>
|
</div>
|
||||||
</template>
|
</template>
|
||||||
|
|||||||
@@ -22,8 +22,6 @@
|
|||||||
--input: 214.3 31.8% 91.4%;
|
--input: 214.3 31.8% 91.4%;
|
||||||
--ring: 222.2 84% 4.9%;
|
--ring: 222.2 84% 4.9%;
|
||||||
--radius: 0.5rem;
|
--radius: 0.5rem;
|
||||||
--popover: 0 0% 100%;
|
|
||||||
--popover-foreground: 222.2 84% 4.9%;
|
|
||||||
--sidebar-background: 0 0% 98%;
|
--sidebar-background: 0 0% 98%;
|
||||||
--sidebar-foreground: 240 5.3% 26.1%;
|
--sidebar-foreground: 240 5.3% 26.1%;
|
||||||
--sidebar-primary: 240 5.9% 10%;
|
--sidebar-primary: 240 5.9% 10%;
|
||||||
@@ -52,8 +50,6 @@
|
|||||||
--border: 217.2 32.6% 17.5%;
|
--border: 217.2 32.6% 17.5%;
|
||||||
--input: 217.2 32.6% 17.5%;
|
--input: 217.2 32.6% 17.5%;
|
||||||
--ring: 212.7 26.8% 83.9%;
|
--ring: 212.7 26.8% 83.9%;
|
||||||
--popover: 222.2 84% 4.9%;
|
|
||||||
--popover-foreground: 210 40% 98%;
|
|
||||||
--sidebar-background: 240 5.9% 10%;
|
--sidebar-background: 240 5.9% 10%;
|
||||||
--sidebar-foreground: 240 4.8% 95.9%;
|
--sidebar-foreground: 240 4.8% 95.9%;
|
||||||
--sidebar-primary: 224.3 76.3% 48%;
|
--sidebar-primary: 224.3 76.3% 48%;
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
<script setup lang="ts">
|
<script setup lang="ts">
|
||||||
import { ref, onMounted } from 'vue'
|
|
||||||
import {
|
import {
|
||||||
Sidebar,
|
Sidebar,
|
||||||
SidebarContent,
|
SidebarContent,
|
||||||
@@ -17,56 +16,9 @@ import {
|
|||||||
SidebarRail,
|
SidebarRail,
|
||||||
} from '@/components/ui/sidebar'
|
} from '@/components/ui/sidebar'
|
||||||
import { Collapsible, CollapsibleContent, CollapsibleTrigger } from '@/components/ui/collapsible'
|
import { Collapsible, CollapsibleContent, CollapsibleTrigger } from '@/components/ui/collapsible'
|
||||||
import { LayoutGrid, Boxes, Settings, Home, ChevronRight, Database, Layers, LogOut } from 'lucide-vue-next'
|
import { LayoutGrid, Boxes, Settings, Home, ChevronRight, Database, Layers } from 'lucide-vue-next'
|
||||||
|
|
||||||
const { logout } = useAuth()
|
const menuItems = [
|
||||||
const { api } = useApi()
|
|
||||||
|
|
||||||
const handleLogout = async () => {
|
|
||||||
await logout()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fetch objects and group by app
|
|
||||||
const apps = ref<any[]>([])
|
|
||||||
const topLevelObjects = ref<any[]>([])
|
|
||||||
const loading = ref(true)
|
|
||||||
|
|
||||||
onMounted(async () => {
|
|
||||||
try {
|
|
||||||
const response = await api.get('/setup/objects')
|
|
||||||
const allObjects = response.data || response || []
|
|
||||||
|
|
||||||
// Group objects by app
|
|
||||||
const appMap = new Map<string, any>()
|
|
||||||
const noAppObjects: any[] = []
|
|
||||||
|
|
||||||
allObjects.forEach((obj: any) => {
|
|
||||||
const appId = obj.app_id || obj.appId
|
|
||||||
if (appId) {
|
|
||||||
if (!appMap.has(appId)) {
|
|
||||||
appMap.set(appId, {
|
|
||||||
id: appId,
|
|
||||||
name: obj.app?.name || obj.app?.label || 'Unknown App',
|
|
||||||
label: obj.app?.label || obj.app?.name || 'Unknown App',
|
|
||||||
objects: []
|
|
||||||
})
|
|
||||||
}
|
|
||||||
appMap.get(appId)!.objects.push(obj)
|
|
||||||
} else {
|
|
||||||
noAppObjects.push(obj)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
apps.value = Array.from(appMap.values())
|
|
||||||
topLevelObjects.value = noAppObjects
|
|
||||||
} catch (e) {
|
|
||||||
console.error('Failed to load objects:', e)
|
|
||||||
} finally {
|
|
||||||
loading.value = false
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
const staticMenuItems = [
|
|
||||||
{
|
{
|
||||||
title: 'Home',
|
title: 'Home',
|
||||||
url: '/',
|
url: '/',
|
||||||
@@ -88,6 +40,17 @@ const staticMenuItems = [
|
|||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
title: 'Runtime',
|
||||||
|
icon: Database,
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
title: 'My Apps',
|
||||||
|
url: '/app',
|
||||||
|
icon: Layers,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
]
|
]
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
@@ -113,12 +76,11 @@ const staticMenuItems = [
|
|||||||
</SidebarMenu>
|
</SidebarMenu>
|
||||||
</SidebarHeader>
|
</SidebarHeader>
|
||||||
<SidebarContent>
|
<SidebarContent>
|
||||||
<!-- Static Menu Items -->
|
|
||||||
<SidebarGroup>
|
<SidebarGroup>
|
||||||
<SidebarGroupLabel>Navigation</SidebarGroupLabel>
|
<SidebarGroupLabel>Application</SidebarGroupLabel>
|
||||||
<SidebarGroupContent>
|
<SidebarGroupContent>
|
||||||
<SidebarMenu>
|
<SidebarMenu>
|
||||||
<template v-for="item in staticMenuItems" :key="item.title">
|
<template v-for="item in menuItems" :key="item.title">
|
||||||
<!-- Simple menu item -->
|
<!-- Simple menu item -->
|
||||||
<SidebarMenuItem v-if="!item.items">
|
<SidebarMenuItem v-if="!item.items">
|
||||||
<SidebarMenuButton as-child>
|
<SidebarMenuButton as-child>
|
||||||
@@ -159,70 +121,12 @@ const staticMenuItems = [
|
|||||||
</SidebarMenu>
|
</SidebarMenu>
|
||||||
</SidebarGroupContent>
|
</SidebarGroupContent>
|
||||||
</SidebarGroup>
|
</SidebarGroup>
|
||||||
|
|
||||||
<!-- Top-level Objects (no app) -->
|
|
||||||
<SidebarGroup v-if="!loading && topLevelObjects.length > 0">
|
|
||||||
<SidebarGroupLabel>Objects</SidebarGroupLabel>
|
|
||||||
<SidebarGroupContent>
|
|
||||||
<SidebarMenu>
|
|
||||||
<SidebarMenuItem v-for="obj in topLevelObjects" :key="obj.id">
|
|
||||||
<SidebarMenuButton as-child>
|
|
||||||
<NuxtLink :to="`/${obj.apiName.toLowerCase()}`">
|
|
||||||
<Database class="h-4 w-4" />
|
|
||||||
<span>{{ obj.label || obj.apiName }}</span>
|
|
||||||
</NuxtLink>
|
|
||||||
</SidebarMenuButton>
|
|
||||||
</SidebarMenuItem>
|
|
||||||
</SidebarMenu>
|
|
||||||
</SidebarGroupContent>
|
|
||||||
</SidebarGroup>
|
|
||||||
|
|
||||||
<!-- App-grouped Objects -->
|
|
||||||
<SidebarGroup v-if="!loading && apps.length > 0">
|
|
||||||
<SidebarGroupLabel>Apps</SidebarGroupLabel>
|
|
||||||
<SidebarGroupContent>
|
|
||||||
<SidebarMenu>
|
|
||||||
<Collapsible
|
|
||||||
v-for="app in apps"
|
|
||||||
:key="app.id"
|
|
||||||
as-child
|
|
||||||
:default-open="true"
|
|
||||||
class="group/collapsible"
|
|
||||||
>
|
|
||||||
<SidebarMenuItem>
|
|
||||||
<CollapsibleTrigger as-child>
|
|
||||||
<SidebarMenuButton :tooltip="app.label">
|
|
||||||
<LayoutGrid class="h-4 w-4" />
|
|
||||||
<span>{{ app.label }}</span>
|
|
||||||
<ChevronRight
|
|
||||||
class="ml-auto transition-transform duration-200 group-data-[state=open]/collapsible:rotate-90"
|
|
||||||
/>
|
|
||||||
</SidebarMenuButton>
|
|
||||||
</CollapsibleTrigger>
|
|
||||||
<CollapsibleContent>
|
|
||||||
<SidebarMenuSub>
|
|
||||||
<SidebarMenuSubItem v-for="obj in app.objects" :key="obj.id">
|
|
||||||
<SidebarMenuSubButton as-child>
|
|
||||||
<NuxtLink :to="`/${obj.apiName.toLowerCase()}`">
|
|
||||||
<Database class="h-4 w-4" />
|
|
||||||
<span>{{ obj.label || obj.apiName }}</span>
|
|
||||||
</NuxtLink>
|
|
||||||
</SidebarMenuSubButton>
|
|
||||||
</SidebarMenuSubItem>
|
|
||||||
</SidebarMenuSub>
|
|
||||||
</CollapsibleContent>
|
|
||||||
</SidebarMenuItem>
|
|
||||||
</Collapsible>
|
|
||||||
</SidebarMenu>
|
|
||||||
</SidebarGroupContent>
|
|
||||||
</SidebarGroup>
|
|
||||||
</SidebarContent>
|
</SidebarContent>
|
||||||
<SidebarFooter>
|
<SidebarFooter>
|
||||||
<SidebarMenu>
|
<SidebarMenu>
|
||||||
<SidebarMenuItem>
|
<SidebarMenuItem>
|
||||||
<SidebarMenuButton @click="handleLogout" class="cursor-pointer hover:bg-accent">
|
<SidebarMenuButton>
|
||||||
<LogOut class="h-4 w-4" />
|
<span class="text-sm text-muted-foreground">Logged in as user</span>
|
||||||
<span>Logout</span>
|
|
||||||
</SidebarMenuButton>
|
</SidebarMenuButton>
|
||||||
</SidebarMenuItem>
|
</SidebarMenuItem>
|
||||||
</SidebarMenu>
|
</SidebarMenu>
|
||||||
|
|||||||
@@ -5,34 +5,8 @@ import { Label } from '@/components/ui/label'
|
|||||||
|
|
||||||
const config = useRuntimeConfig()
|
const config = useRuntimeConfig()
|
||||||
const router = useRouter()
|
const router = useRouter()
|
||||||
const { toast } = useToast()
|
|
||||||
|
|
||||||
// Cookie for server-side auth check
|
const tenantId = ref('123')
|
||||||
const tokenCookie = useCookie('token')
|
|
||||||
|
|
||||||
// Extract subdomain from hostname (e.g., tenant1.localhost → tenant1)
|
|
||||||
const getSubdomain = () => {
|
|
||||||
if (!import.meta.client) return null
|
|
||||||
const hostname = window.location.hostname
|
|
||||||
const parts = hostname.split('.')
|
|
||||||
|
|
||||||
console.log('Extracting subdomain from:', hostname, 'parts:', parts)
|
|
||||||
|
|
||||||
// For localhost development: tenant1.localhost or localhost
|
|
||||||
if (hostname === 'localhost' || hostname === '127.0.0.1') {
|
|
||||||
return null // Use default tenant for plain localhost
|
|
||||||
}
|
|
||||||
|
|
||||||
// For subdomains like tenant1.routebox.co or tenant1.localhost
|
|
||||||
if (parts.length >= 2 && parts[0] !== 'www') {
|
|
||||||
console.log('Using subdomain:', parts[0])
|
|
||||||
return parts[0] // Return subdomain
|
|
||||||
}
|
|
||||||
|
|
||||||
return null
|
|
||||||
}
|
|
||||||
|
|
||||||
const subdomain = ref(getSubdomain())
|
|
||||||
const email = ref('')
|
const email = ref('')
|
||||||
const password = ref('')
|
const password = ref('')
|
||||||
const loading = ref(false)
|
const loading = ref(false)
|
||||||
@@ -43,18 +17,12 @@ const handleLogin = async () => {
|
|||||||
loading.value = true
|
loading.value = true
|
||||||
error.value = ''
|
error.value = ''
|
||||||
|
|
||||||
const headers: Record<string, string> = {
|
|
||||||
'Content-Type': 'application/json',
|
|
||||||
}
|
|
||||||
|
|
||||||
// Only send x-tenant-id if we have a subdomain
|
|
||||||
if (subdomain.value) {
|
|
||||||
headers['x-tenant-id'] = subdomain.value
|
|
||||||
}
|
|
||||||
|
|
||||||
const response = await fetch(`${config.public.apiBaseUrl}/api/auth/login`, {
|
const response = await fetch(`${config.public.apiBaseUrl}/api/auth/login`, {
|
||||||
method: 'POST',
|
method: 'POST',
|
||||||
headers,
|
headers: {
|
||||||
|
'Content-Type': 'application/json',
|
||||||
|
'x-tenant-id': tenantId.value,
|
||||||
|
},
|
||||||
body: JSON.stringify({
|
body: JSON.stringify({
|
||||||
email: email.value,
|
email: email.value,
|
||||||
password: password.value,
|
password: password.value,
|
||||||
@@ -68,23 +36,15 @@ const handleLogin = async () => {
|
|||||||
|
|
||||||
const data = await response.json()
|
const data = await response.json()
|
||||||
|
|
||||||
// Store credentials in localStorage
|
// Store credentials
|
||||||
// Store the tenant ID that was used for login
|
localStorage.setItem('tenantId', tenantId.value)
|
||||||
const tenantToStore = subdomain.value || data.user?.tenantId || 'tenant1'
|
|
||||||
localStorage.setItem('tenantId', tenantToStore)
|
|
||||||
localStorage.setItem('token', data.access_token)
|
localStorage.setItem('token', data.access_token)
|
||||||
localStorage.setItem('user', JSON.stringify(data.user))
|
localStorage.setItem('user', JSON.stringify(data.user))
|
||||||
|
|
||||||
// Also store token in cookie for server-side auth check
|
|
||||||
tokenCookie.value = data.access_token
|
|
||||||
|
|
||||||
toast.success('Login successful!')
|
|
||||||
|
|
||||||
// Redirect to home
|
// Redirect to home
|
||||||
router.push('/')
|
router.push('/')
|
||||||
} catch (e: any) {
|
} catch (e: any) {
|
||||||
error.value = e.message || 'Login failed'
|
error.value = e.message || 'Login failed'
|
||||||
toast.error(e.message || 'Login failed')
|
|
||||||
} finally {
|
} finally {
|
||||||
loading.value = false
|
loading.value = false
|
||||||
}
|
}
|
||||||
@@ -105,6 +65,10 @@ const handleLogin = async () => {
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="grid gap-6">
|
<div class="grid gap-6">
|
||||||
|
<div class="grid gap-2">
|
||||||
|
<Label for="tenantId">Tenant ID</Label>
|
||||||
|
<Input id="tenantId" v-model="tenantId" type="text" placeholder="123" required />
|
||||||
|
</div>
|
||||||
<div class="grid gap-2">
|
<div class="grid gap-2">
|
||||||
<Label for="email">Email</Label>
|
<Label for="email">Email</Label>
|
||||||
<Input id="email" v-model="email" type="email" placeholder="m@example.com" required />
|
<Input id="email" v-model="email" type="email" placeholder="m@example.com" required />
|
||||||
|
|||||||
@@ -1,334 +0,0 @@
|
|||||||
<template>
|
|
||||||
<div class="page-layout-editor">
|
|
||||||
<div class="flex h-full">
|
|
||||||
<!-- Main Grid Area -->
|
|
||||||
<div class="flex-1 p-4 overflow-auto">
|
|
||||||
<div class="mb-4 flex justify-between items-center">
|
|
||||||
<h3 class="text-lg font-semibold">{{ layoutName || 'Page Layout' }}</h3>
|
|
||||||
<div class="flex gap-2">
|
|
||||||
<Button variant="outline" size="sm" @click="handleClear">
|
|
||||||
Clear All
|
|
||||||
</Button>
|
|
||||||
<Button size="sm" @click="handleSave">
|
|
||||||
Save Layout
|
|
||||||
</Button>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="border rounded-lg bg-slate-50 dark:bg-slate-900 p-4 min-h-[600px]">
|
|
||||||
<div
|
|
||||||
ref="gridContainer"
|
|
||||||
class="grid-stack"
|
|
||||||
@dragover.prevent="handleDragOver"
|
|
||||||
@drop="handleDrop"
|
|
||||||
>
|
|
||||||
<!-- Grid items will be dynamically added here -->
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<!-- Available Fields Sidebar -->
|
|
||||||
<div class="w-80 border-l bg-white dark:bg-slate-950 p-4 overflow-auto">
|
|
||||||
<h3 class="text-lg font-semibold mb-4">Available Fields</h3>
|
|
||||||
<p class="text-xs text-muted-foreground mb-4">Click or drag to add field to grid</p>
|
|
||||||
<div class="space-y-2" id="sidebar-fields">
|
|
||||||
<div
|
|
||||||
v-for="field in availableFields"
|
|
||||||
:key="field.id"
|
|
||||||
class="p-3 border rounded cursor-move bg-white dark:bg-slate-900 hover:border-primary hover:bg-slate-50 dark:hover:bg-slate-800 transition-colors"
|
|
||||||
:data-field-id="field.id"
|
|
||||||
draggable="true"
|
|
||||||
@dragstart="handleDragStart($event, field)"
|
|
||||||
@click="addFieldToGrid(field)"
|
|
||||||
>
|
|
||||||
<div class="font-medium text-sm">{{ field.label }}</div>
|
|
||||||
<div class="text-xs text-muted-foreground">{{ field.apiName }}</div>
|
|
||||||
<div class="text-xs text-muted-foreground">Type: {{ field.type }}</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</template>
|
|
||||||
|
|
||||||
<script setup lang="ts">
|
|
||||||
import { ref, onMounted, onBeforeUnmount, watch, nextTick } from 'vue'
|
|
||||||
import { GridStack } from 'gridstack'
|
|
||||||
import 'gridstack/dist/gridstack.min.css'
|
|
||||||
import type { FieldLayoutItem } from '~/types/page-layout'
|
|
||||||
import type { FieldConfig } from '~/types/field-types'
|
|
||||||
import { Button } from '@/components/ui/button'
|
|
||||||
|
|
||||||
const props = defineProps<{
|
|
||||||
fields: FieldConfig[]
|
|
||||||
initialLayout?: FieldLayoutItem[]
|
|
||||||
layoutName?: string
|
|
||||||
}>()
|
|
||||||
|
|
||||||
const emit = defineEmits<{
|
|
||||||
save: [layout: FieldLayoutItem[]]
|
|
||||||
}>()
|
|
||||||
|
|
||||||
const gridContainer = ref<HTMLElement | null>(null)
|
|
||||||
let grid: GridStack | null = null
|
|
||||||
const gridItems = ref<Map<string, any>>(new Map())
|
|
||||||
|
|
||||||
// Fields that are already on the grid
|
|
||||||
const placedFieldIds = ref<Set<string>>(new Set())
|
|
||||||
|
|
||||||
// Fields available to be added
|
|
||||||
const availableFields = computed(() => {
|
|
||||||
return props.fields.filter(field => !placedFieldIds.value.has(field.id))
|
|
||||||
})
|
|
||||||
|
|
||||||
const initGrid = () => {
|
|
||||||
if (!gridContainer.value) return
|
|
||||||
|
|
||||||
grid = GridStack.init({
|
|
||||||
column: 6,
|
|
||||||
cellHeight: 80,
|
|
||||||
minRow: 10,
|
|
||||||
float: true,
|
|
||||||
animate: true,
|
|
||||||
acceptWidgets: true,
|
|
||||||
disableOneColumnMode: true,
|
|
||||||
resizable: {
|
|
||||||
handles: 'e, w'
|
|
||||||
}
|
|
||||||
}, gridContainer.value)
|
|
||||||
|
|
||||||
// Listen for changes
|
|
||||||
grid.on('change', () => {
|
|
||||||
updatePlacedFields()
|
|
||||||
})
|
|
||||||
|
|
||||||
// Listen for item removal
|
|
||||||
grid.on('removed', (event, items) => {
|
|
||||||
items.forEach(item => {
|
|
||||||
const contentEl = item.el?.querySelector('.grid-stack-item-content')
|
|
||||||
const fieldId = contentEl?.getAttribute('data-field-id')
|
|
||||||
if (fieldId) {
|
|
||||||
placedFieldIds.value.delete(fieldId)
|
|
||||||
gridItems.value.delete(fieldId)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
// Load initial layout if provided
|
|
||||||
if (props.initialLayout && props.initialLayout.length > 0) {
|
|
||||||
loadLayout(props.initialLayout)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const loadLayout = (layout: FieldLayoutItem[]) => {
|
|
||||||
if (!grid) return
|
|
||||||
|
|
||||||
layout.forEach(item => {
|
|
||||||
const field = props.fields.find(f => f.id === item.fieldId)
|
|
||||||
if (field) {
|
|
||||||
addFieldToGrid(field, item.x, item.y, item.w, item.h)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
const handleDragStart = (event: DragEvent, field: FieldConfig) => {
|
|
||||||
if (event.dataTransfer) {
|
|
||||||
event.dataTransfer.effectAllowed = 'copy';
|
|
||||||
event.dataTransfer.setData('application/json', JSON.stringify(field));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const handleDragOver = (event: DragEvent) => {
|
|
||||||
event.preventDefault();
|
|
||||||
if (event.dataTransfer) {
|
|
||||||
event.dataTransfer.dropEffect = 'copy';
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
const handleDrop = (event: DragEvent) => {
|
|
||||||
event.preventDefault();
|
|
||||||
|
|
||||||
const fieldData = event.dataTransfer?.getData('application/json');
|
|
||||||
if (!fieldData || !grid) return;
|
|
||||||
|
|
||||||
const field = JSON.parse(fieldData);
|
|
||||||
|
|
||||||
// Get the grid bounding rect
|
|
||||||
const gridRect = gridContainer.value?.getBoundingClientRect();
|
|
||||||
if (!gridRect) return;
|
|
||||||
|
|
||||||
// Calculate grid position from drop coordinates
|
|
||||||
const x = event.clientX - gridRect.left;
|
|
||||||
const y = event.clientY - gridRect.top;
|
|
||||||
|
|
||||||
// Convert pixels to grid coordinates (approx)
|
|
||||||
const cellWidth = gridRect.width / 6; // 6 columns
|
|
||||||
const cellHeight = 80; // from our config
|
|
||||||
|
|
||||||
const gridX = Math.floor(x / cellWidth);
|
|
||||||
const gridY = Math.floor(y / cellHeight);
|
|
||||||
|
|
||||||
// Add the field at the calculated position
|
|
||||||
addFieldToGrid(field, gridX, gridY);
|
|
||||||
};
|
|
||||||
|
|
||||||
const addFieldToGrid = (field: FieldConfig, x?: number, y?: number, w: number = 3, h: number = 1) => {
|
|
||||||
if (!grid || placedFieldIds.value.has(field.id)) return
|
|
||||||
|
|
||||||
// Create the widget element manually
|
|
||||||
const widgetEl = document.createElement('div')
|
|
||||||
widgetEl.className = 'grid-stack-item'
|
|
||||||
|
|
||||||
const contentEl = document.createElement('div')
|
|
||||||
contentEl.className = 'grid-stack-item-content bg-white dark:bg-slate-900 border rounded p-3 shadow-sm'
|
|
||||||
contentEl.setAttribute('data-field-id', field.id)
|
|
||||||
|
|
||||||
contentEl.innerHTML = `
|
|
||||||
<div class="flex justify-between items-start">
|
|
||||||
<div class="flex-1">
|
|
||||||
<div class="font-medium text-sm">${field.label}</div>
|
|
||||||
<div class="text-xs text-muted-foreground">${field.apiName}</div>
|
|
||||||
<div class="text-xs text-muted-foreground">Type: ${field.type}</div>
|
|
||||||
</div>
|
|
||||||
<button class="remove-btn text-destructive hover:text-destructive/80 text-xl leading-none ml-2" type="button">
|
|
||||||
×
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
`
|
|
||||||
|
|
||||||
// Add click handler for remove button
|
|
||||||
const removeBtn = contentEl.querySelector('.remove-btn')
|
|
||||||
if (removeBtn) {
|
|
||||||
removeBtn.addEventListener('click', (e) => {
|
|
||||||
e.stopPropagation()
|
|
||||||
if (grid) {
|
|
||||||
grid.removeWidget(widgetEl)
|
|
||||||
placedFieldIds.value.delete(field.id)
|
|
||||||
gridItems.value.delete(field.id)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
widgetEl.appendChild(contentEl)
|
|
||||||
|
|
||||||
// Use makeWidget for GridStack v11+
|
|
||||||
grid.makeWidget(widgetEl)
|
|
||||||
|
|
||||||
// Set grid position after making it a widget
|
|
||||||
grid.update(widgetEl, {
|
|
||||||
x: x,
|
|
||||||
y: y,
|
|
||||||
w: w,
|
|
||||||
h: h,
|
|
||||||
minW: 1,
|
|
||||||
maxW: 6,
|
|
||||||
})
|
|
||||||
|
|
||||||
placedFieldIds.value.add(field.id)
|
|
||||||
gridItems.value.set(field.id, widgetEl)
|
|
||||||
}
|
|
||||||
|
|
||||||
const updatePlacedFields = () => {
|
|
||||||
if (!grid) return
|
|
||||||
|
|
||||||
const items = grid.getGridItems()
|
|
||||||
const newPlacedIds = new Set<string>()
|
|
||||||
|
|
||||||
items.forEach(item => {
|
|
||||||
const contentEl = item.querySelector('.grid-stack-item-content')
|
|
||||||
const fieldId = contentEl?.getAttribute('data-field-id')
|
|
||||||
if (fieldId) {
|
|
||||||
newPlacedIds.add(fieldId)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
placedFieldIds.value = newPlacedIds
|
|
||||||
}
|
|
||||||
|
|
||||||
const handleClear = () => {
|
|
||||||
if (!grid) return
|
|
||||||
|
|
||||||
if (confirm('Are you sure you want to clear all fields from the layout?')) {
|
|
||||||
grid.removeAll()
|
|
||||||
placedFieldIds.value.clear()
|
|
||||||
gridItems.value.clear()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const handleSave = () => {
|
|
||||||
if (!grid) return
|
|
||||||
|
|
||||||
const items = grid.getGridItems()
|
|
||||||
const layout: FieldLayoutItem[] = []
|
|
||||||
|
|
||||||
items.forEach(item => {
|
|
||||||
// Look for data-field-id in the content element
|
|
||||||
const contentEl = item.querySelector('.grid-stack-item-content')
|
|
||||||
const fieldId = contentEl?.getAttribute('data-field-id')
|
|
||||||
const node = (item as any).gridstackNode
|
|
||||||
|
|
||||||
if (fieldId && node) {
|
|
||||||
layout.push({
|
|
||||||
fieldId,
|
|
||||||
x: node.x,
|
|
||||||
y: node.y,
|
|
||||||
w: node.w,
|
|
||||||
h: node.h,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
emit('save', layout)
|
|
||||||
}
|
|
||||||
|
|
||||||
onMounted(() => {
|
|
||||||
initGrid()
|
|
||||||
})
|
|
||||||
|
|
||||||
onBeforeUnmount(() => {
|
|
||||||
if (grid) {
|
|
||||||
grid.destroy(false)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
// Watch for fields changes
|
|
||||||
watch(() => props.fields, () => {
|
|
||||||
updatePlacedFields()
|
|
||||||
}, { deep: true })
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<style>
|
|
||||||
.grid-stack {
|
|
||||||
background: transparent;
|
|
||||||
}
|
|
||||||
|
|
||||||
.grid-stack-item {
|
|
||||||
cursor: move;
|
|
||||||
}
|
|
||||||
|
|
||||||
.grid-stack-item-content {
|
|
||||||
cursor: move;
|
|
||||||
overflow: hidden;
|
|
||||||
}
|
|
||||||
|
|
||||||
.grid-stack-item .remove-btn {
|
|
||||||
cursor: pointer;
|
|
||||||
font-size: 20px;
|
|
||||||
line-height: 1;
|
|
||||||
padding: 4px 8px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Customize grid appearance */
|
|
||||||
.grid-stack > .grid-stack-item > .ui-resizable-se {
|
|
||||||
background: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.grid-stack > .grid-stack-item > .ui-resizable-handle {
|
|
||||||
background-color: rgba(0, 0, 0, 0.1);
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Dark mode adjustments */
|
|
||||||
.dark .grid-stack > .grid-stack-item > .ui-resizable-handle {
|
|
||||||
background-color: rgba(255, 255, 255, 0.1);
|
|
||||||
}
|
|
||||||
</style>
|
|
||||||
@@ -1,101 +0,0 @@
|
|||||||
<template>
|
|
||||||
<div class="page-layout-renderer w-full">
|
|
||||||
<div
|
|
||||||
v-if="layout && layout.fields.length > 0"
|
|
||||||
class="grid grid-cols-6 gap-4 auto-rows-[80px]"
|
|
||||||
>
|
|
||||||
<div
|
|
||||||
v-for="fieldItem in sortedFields"
|
|
||||||
:key="fieldItem.fieldId"
|
|
||||||
:style="getFieldStyle(fieldItem)"
|
|
||||||
class="flex flex-col min-h-[60px]"
|
|
||||||
>
|
|
||||||
<FieldRenderer
|
|
||||||
v-if="fieldItem.field"
|
|
||||||
:field="fieldItem.field"
|
|
||||||
:model-value="modelValue?.[fieldItem.field.apiName]"
|
|
||||||
:mode="readonly ? VM.DETAIL : VM.EDIT"
|
|
||||||
@update:model-value="handleFieldUpdate(fieldItem.field.apiName, $event)"
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<!-- Fallback: Simple two-column layout if no page layout is configured -->
|
|
||||||
<div v-else class="grid grid-cols-1 md:grid-cols-2 gap-4">
|
|
||||||
<div
|
|
||||||
v-for="field in fields"
|
|
||||||
:key="field.id"
|
|
||||||
class="flex flex-col min-h-[60px]"
|
|
||||||
>
|
|
||||||
<FieldRenderer
|
|
||||||
:field="field"
|
|
||||||
:model-value="modelValue?.[field.apiName]"
|
|
||||||
:mode="readonly ? VM.DETAIL : VM.EDIT"
|
|
||||||
@update:model-value="handleFieldUpdate(field.apiName, $event)"
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</template>
|
|
||||||
|
|
||||||
<script setup lang="ts">
|
|
||||||
import { computed, watch } from 'vue'
|
|
||||||
import type { FieldConfig, ViewMode } from '~/types/field-types'
|
|
||||||
import type { PageLayoutConfig, FieldLayoutItem } from '~/types/page-layout'
|
|
||||||
import FieldRenderer from '@/components/fields/FieldRenderer.vue'
|
|
||||||
import { ViewMode as VM } from '~/types/field-types'
|
|
||||||
|
|
||||||
const props = defineProps<{
|
|
||||||
fields: FieldConfig[]
|
|
||||||
layout?: PageLayoutConfig | null
|
|
||||||
modelValue?: Record<string, any>
|
|
||||||
readonly?: boolean
|
|
||||||
}>()
|
|
||||||
|
|
||||||
const emit = defineEmits<{
|
|
||||||
'update:modelValue': [value: Record<string, any>]
|
|
||||||
}>()
|
|
||||||
|
|
||||||
// Map field IDs to field objects and sort by position
|
|
||||||
const sortedFields = computed(() => {
|
|
||||||
if (!props.layout || !props.layout.fields) return []
|
|
||||||
|
|
||||||
const fieldsMap = new Map(props.fields.map(f => [f.id, f]))
|
|
||||||
|
|
||||||
return props.layout.fields
|
|
||||||
.map(item => ({
|
|
||||||
...item,
|
|
||||||
field: fieldsMap.get(item.fieldId),
|
|
||||||
}))
|
|
||||||
.filter(item => item.field)
|
|
||||||
.sort((a, b) => {
|
|
||||||
// Sort by y position first, then x position
|
|
||||||
if (a.y !== b.y) return a.y - b.y
|
|
||||||
return a.x - b.x
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
const getFieldStyle = (item: FieldLayoutItem) => {
|
|
||||||
return {
|
|
||||||
gridColumnStart: item.x + 1,
|
|
||||||
gridColumnEnd: `span ${item.w}`,
|
|
||||||
gridRowStart: item.y + 1,
|
|
||||||
gridRowEnd: `span ${item.h}`,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const handleFieldUpdate = (fieldName: string, value: any) => {
|
|
||||||
if (props.readonly) return
|
|
||||||
|
|
||||||
const updated = {
|
|
||||||
...props.modelValue,
|
|
||||||
[fieldName]: value,
|
|
||||||
}
|
|
||||||
|
|
||||||
emit('update:modelValue', updated)
|
|
||||||
}
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<style scoped>
|
|
||||||
/* Additional styles if needed */
|
|
||||||
</style>
|
|
||||||
@@ -1,202 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import { computed } from 'vue'
|
|
||||||
import { Input } from '@/components/ui/input'
|
|
||||||
import { Textarea } from '@/components/ui/textarea'
|
|
||||||
import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from '@/components/ui/select'
|
|
||||||
import { Checkbox } from '@/components/ui/checkbox'
|
|
||||||
import { Switch } from '@/components/ui/switch'
|
|
||||||
import { DatePicker } from '@/components/ui/date-picker'
|
|
||||||
import { Badge } from '@/components/ui/badge'
|
|
||||||
import { FieldConfig, FieldType, ViewMode } from '@/types/field-types'
|
|
||||||
import { Label } from '@/components/ui/label'
|
|
||||||
|
|
||||||
interface Props {
|
|
||||||
field: FieldConfig
|
|
||||||
modelValue: any
|
|
||||||
mode: ViewMode
|
|
||||||
readonly?: boolean
|
|
||||||
}
|
|
||||||
|
|
||||||
const props = defineProps<Props>()
|
|
||||||
const emit = defineEmits<{
|
|
||||||
'update:modelValue': [value: any]
|
|
||||||
}>()
|
|
||||||
|
|
||||||
const value = computed({
|
|
||||||
get: () => props.modelValue,
|
|
||||||
set: (val) => emit('update:modelValue', val),
|
|
||||||
})
|
|
||||||
|
|
||||||
const isReadOnly = computed(() => props.readonly || props.field.isReadOnly || props.mode === ViewMode.DETAIL)
|
|
||||||
const isEditMode = computed(() => props.mode === ViewMode.EDIT)
|
|
||||||
const isListMode = computed(() => props.mode === ViewMode.LIST)
|
|
||||||
const isDetailMode = computed(() => props.mode === ViewMode.DETAIL)
|
|
||||||
|
|
||||||
const formatValue = (val: any): string => {
|
|
||||||
if (val === null || val === undefined) return '-'
|
|
||||||
|
|
||||||
switch (props.field.type) {
|
|
||||||
case FieldType.DATE:
|
|
||||||
return val instanceof Date ? val.toLocaleDateString() : new Date(val).toLocaleDateString()
|
|
||||||
case FieldType.DATETIME:
|
|
||||||
return val instanceof Date ? val.toLocaleString() : new Date(val).toLocaleString()
|
|
||||||
case FieldType.BOOLEAN:
|
|
||||||
return val ? 'Yes' : 'No'
|
|
||||||
case FieldType.CURRENCY:
|
|
||||||
return `${props.field.prefix || '$'}${Number(val).toFixed(2)}${props.field.suffix || ''}`
|
|
||||||
case FieldType.SELECT:
|
|
||||||
const option = props.field.options?.find(opt => opt.value === val)
|
|
||||||
return option?.label || val
|
|
||||||
case FieldType.MULTI_SELECT:
|
|
||||||
if (!Array.isArray(val)) return '-'
|
|
||||||
return val.map(v => {
|
|
||||||
const opt = props.field.options?.find(o => o.value === v)
|
|
||||||
return opt?.label || v
|
|
||||||
}).join(', ')
|
|
||||||
default:
|
|
||||||
return String(val)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<div class="field-renderer space-y-2">
|
|
||||||
<!-- Label (shown in edit and detail modes) -->
|
|
||||||
<Label v-if="!isListMode" :for="field.id" class="flex items-center gap-2">
|
|
||||||
{{ field.label }}
|
|
||||||
<span v-if="field.isRequired && isEditMode" class="text-destructive">*</span>
|
|
||||||
</Label>
|
|
||||||
|
|
||||||
<!-- Help Text -->
|
|
||||||
<p v-if="field.helpText && !isListMode" class="text-sm text-muted-foreground">
|
|
||||||
{{ field.helpText }}
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<!-- List View - Simple text display -->
|
|
||||||
<div v-if="isListMode" class="text-sm truncate">
|
|
||||||
<Badge v-if="field.type === FieldType.BOOLEAN" :variant="value ? 'default' : 'secondary'">
|
|
||||||
{{ formatValue(value) }}
|
|
||||||
</Badge>
|
|
||||||
<template v-else>
|
|
||||||
{{ formatValue(value) }}
|
|
||||||
</template>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<!-- Detail View - Formatted display -->
|
|
||||||
<div v-else-if="isDetailMode" class="space-y-1">
|
|
||||||
<div v-if="field.type === FieldType.BOOLEAN" class="flex items-center gap-2">
|
|
||||||
<Checkbox :checked="value" disabled />
|
|
||||||
<span class="text-sm">{{ formatValue(value) }}</span>
|
|
||||||
</div>
|
|
||||||
<div v-else-if="field.type === FieldType.MULTI_SELECT" class="flex flex-wrap gap-2">
|
|
||||||
<Badge v-for="(item, idx) in value" :key="idx" variant="secondary">
|
|
||||||
{{ props.field.options?.find(opt => opt.value === item)?.label || item }}
|
|
||||||
</Badge>
|
|
||||||
</div>
|
|
||||||
<div v-else-if="field.type === FieldType.URL && value" class="text-sm">
|
|
||||||
<a :href="value" target="_blank" class="text-primary hover:underline">
|
|
||||||
{{ value }}
|
|
||||||
</a>
|
|
||||||
</div>
|
|
||||||
<div v-else-if="field.type === FieldType.EMAIL && value" class="text-sm">
|
|
||||||
<a :href="`mailto:${value}`" class="text-primary hover:underline">
|
|
||||||
{{ value }}
|
|
||||||
</a>
|
|
||||||
</div>
|
|
||||||
<div v-else-if="field.type === FieldType.MARKDOWN && value" class="prose prose-sm">
|
|
||||||
<div v-html="value" />
|
|
||||||
</div>
|
|
||||||
<div v-else class="text-sm font-medium">
|
|
||||||
{{ formatValue(value) }}
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<!-- Edit View - Input components -->
|
|
||||||
<div v-else-if="isEditMode && !isReadOnly">
|
|
||||||
<!-- Text Input -->
|
|
||||||
<Input
|
|
||||||
v-if="[FieldType.TEXT, FieldType.EMAIL, FieldType.URL, FieldType.PASSWORD].includes(field.type)"
|
|
||||||
:id="field.id"
|
|
||||||
v-model="value"
|
|
||||||
:type="field.type === FieldType.PASSWORD ? 'password' : field.type === FieldType.EMAIL ? 'email' : field.type === FieldType.URL ? 'url' : 'text'"
|
|
||||||
:placeholder="field.placeholder"
|
|
||||||
:required="field.isRequired"
|
|
||||||
:disabled="field.isReadOnly"
|
|
||||||
/>
|
|
||||||
|
|
||||||
<!-- Textarea -->
|
|
||||||
<Textarea
|
|
||||||
v-else-if="field.type === FieldType.TEXTAREA || field.type === FieldType.MARKDOWN"
|
|
||||||
:id="field.id"
|
|
||||||
v-model="value"
|
|
||||||
:placeholder="field.placeholder"
|
|
||||||
:rows="field.rows || 4"
|
|
||||||
:required="field.isRequired"
|
|
||||||
:disabled="field.isReadOnly"
|
|
||||||
/>
|
|
||||||
|
|
||||||
<!-- Number Input -->
|
|
||||||
<Input
|
|
||||||
v-else-if="[FieldType.NUMBER, FieldType.CURRENCY].includes(field.type)"
|
|
||||||
:id="field.id"
|
|
||||||
v-model.number="value"
|
|
||||||
type="number"
|
|
||||||
:placeholder="field.placeholder"
|
|
||||||
:min="field.min"
|
|
||||||
:max="field.max"
|
|
||||||
:step="field.step || (field.type === FieldType.CURRENCY ? 0.01 : 1)"
|
|
||||||
:required="field.isRequired"
|
|
||||||
:disabled="field.isReadOnly"
|
|
||||||
/>
|
|
||||||
|
|
||||||
<!-- Select -->
|
|
||||||
<Select v-else-if="field.type === FieldType.SELECT" v-model="value">
|
|
||||||
<SelectTrigger :id="field.id">
|
|
||||||
<SelectValue :placeholder="field.placeholder || 'Select an option'" />
|
|
||||||
</SelectTrigger>
|
|
||||||
<SelectContent>
|
|
||||||
<SelectItem v-for="option in field.options" :key="String(option.value)" :value="String(option.value)">
|
|
||||||
{{ option.label }}
|
|
||||||
</SelectItem>
|
|
||||||
</SelectContent>
|
|
||||||
</Select>
|
|
||||||
|
|
||||||
<!-- Boolean - Checkbox -->
|
|
||||||
<div v-else-if="field.type === FieldType.BOOLEAN" class="flex items-center gap-2">
|
|
||||||
<Checkbox :id="field.id" v-model:checked="value" :disabled="field.isReadOnly" />
|
|
||||||
<Label :for="field.id" class="text-sm font-normal cursor-pointer">
|
|
||||||
{{ field.placeholder || field.label }}
|
|
||||||
</Label>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<!-- Date Picker -->
|
|
||||||
<DatePicker
|
|
||||||
v-else-if="[FieldType.DATE, FieldType.DATETIME].includes(field.type)"
|
|
||||||
v-model="value"
|
|
||||||
:placeholder="field.placeholder"
|
|
||||||
:disabled="field.isReadOnly"
|
|
||||||
/>
|
|
||||||
|
|
||||||
<!-- Fallback -->
|
|
||||||
<Input
|
|
||||||
v-else
|
|
||||||
:id="field.id"
|
|
||||||
v-model="value"
|
|
||||||
:placeholder="field.placeholder"
|
|
||||||
:required="field.isRequired"
|
|
||||||
:disabled="field.isReadOnly"
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<!-- Read-only Edit View -->
|
|
||||||
<div v-else-if="isEditMode && isReadOnly" class="text-sm text-muted-foreground">
|
|
||||||
{{ formatValue(value) }}
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</template>
|
|
||||||
|
|
||||||
<style scoped>
|
|
||||||
.field-renderer {
|
|
||||||
width: 100%;
|
|
||||||
}
|
|
||||||
</style>
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import type { BadgeVariants } from "."
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
import { badgeVariants } from "."
|
|
||||||
|
|
||||||
const props = defineProps<{
|
|
||||||
variant?: BadgeVariants["variant"]
|
|
||||||
class?: HTMLAttributes["class"]
|
|
||||||
}>()
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<div :class="cn(badgeVariants({ variant }), props.class)">
|
|
||||||
<slot />
|
|
||||||
</div>
|
|
||||||
</template>
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
import type { VariantProps } from "class-variance-authority"
|
|
||||||
import { cva } from "class-variance-authority"
|
|
||||||
|
|
||||||
export { default as Badge } from "./Badge.vue"
|
|
||||||
|
|
||||||
export const badgeVariants = cva(
|
|
||||||
"inline-flex gap-1 items-center rounded-md border px-2.5 py-0.5 text-xs font-semibold transition-colors focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2",
|
|
||||||
{
|
|
||||||
variants: {
|
|
||||||
variant: {
|
|
||||||
default:
|
|
||||||
"border-transparent bg-primary text-primary-foreground shadow hover:bg-primary/80",
|
|
||||||
secondary:
|
|
||||||
"border-transparent bg-secondary text-secondary-foreground hover:bg-secondary/80",
|
|
||||||
destructive:
|
|
||||||
"border-transparent bg-destructive text-destructive-foreground shadow hover:bg-destructive/80",
|
|
||||||
outline: "text-foreground",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
defaultVariants: {
|
|
||||||
variant: "default",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
|
||||||
export type BadgeVariants = VariantProps<typeof badgeVariants>
|
|
||||||
@@ -1,19 +1,19 @@
|
|||||||
<script setup lang="ts">
|
<script setup lang="ts">
|
||||||
import type { PrimitiveProps } from "reka-ui"
|
import type { PrimitiveProps } from 'reka-ui'
|
||||||
import type { HTMLAttributes } from "vue"
|
import type { HTMLAttributes } from 'vue'
|
||||||
import type { ButtonVariants } from "."
|
import type { ButtonVariants } from '.'
|
||||||
import { Primitive } from "reka-ui"
|
import { Primitive } from 'reka-ui'
|
||||||
import { cn } from "@/lib/utils"
|
import { cn } from '@/lib/utils'
|
||||||
import { buttonVariants } from "."
|
import { buttonVariants } from '.'
|
||||||
|
|
||||||
interface Props extends PrimitiveProps {
|
interface Props extends PrimitiveProps {
|
||||||
variant?: ButtonVariants["variant"]
|
variant?: ButtonVariants['variant']
|
||||||
size?: ButtonVariants["size"]
|
size?: ButtonVariants['size']
|
||||||
class?: HTMLAttributes["class"]
|
class?: HTMLAttributes['class']
|
||||||
}
|
}
|
||||||
|
|
||||||
const props = withDefaults(defineProps<Props>(), {
|
const props = withDefaults(defineProps<Props>(), {
|
||||||
as: "button",
|
as: 'button',
|
||||||
})
|
})
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|||||||
@@ -1,38 +1,36 @@
|
|||||||
import type { VariantProps } from "class-variance-authority"
|
import type { VariantProps } from 'class-variance-authority'
|
||||||
import { cva } from "class-variance-authority"
|
import { cva } from 'class-variance-authority'
|
||||||
|
|
||||||
export { default as Button } from "./Button.vue"
|
export { default as Button } from './Button.vue'
|
||||||
|
|
||||||
export const buttonVariants = cva(
|
export const buttonVariants = cva(
|
||||||
"inline-flex items-center justify-center gap-2 whitespace-nowrap rounded-md text-sm font-medium transition-colors focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-ring disabled:pointer-events-none disabled:opacity-50 [&_svg]:pointer-events-none [&_svg]:size-4 [&_svg]:shrink-0",
|
'inline-flex items-center justify-center gap-2 whitespace-nowrap rounded-md text-sm font-medium transition-colors focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-ring disabled:pointer-events-none disabled:opacity-50 [&_svg]:pointer-events-none [&_svg]:size-4 [&_svg]:shrink-0',
|
||||||
{
|
{
|
||||||
variants: {
|
variants: {
|
||||||
variant: {
|
variant: {
|
||||||
default: "bg-primary text-primary-foreground shadow hover:bg-primary/90",
|
default: 'bg-primary text-primary-foreground shadow hover:bg-primary/90',
|
||||||
destructive:
|
destructive: 'bg-destructive text-destructive-foreground shadow-sm hover:bg-destructive/90',
|
||||||
"bg-destructive text-destructive-foreground shadow-sm hover:bg-destructive/90",
|
|
||||||
outline:
|
outline:
|
||||||
"border border-input bg-background shadow-sm hover:bg-accent hover:text-accent-foreground",
|
'border border-input bg-background shadow-sm hover:bg-accent hover:text-accent-foreground',
|
||||||
secondary:
|
secondary: 'bg-secondary text-secondary-foreground shadow-sm hover:bg-secondary/80',
|
||||||
"bg-secondary text-secondary-foreground shadow-sm hover:bg-secondary/80",
|
ghost: 'hover:bg-accent hover:text-accent-foreground',
|
||||||
ghost: "hover:bg-accent hover:text-accent-foreground",
|
link: 'text-primary underline-offset-4 hover:underline',
|
||||||
link: "text-primary underline-offset-4 hover:underline",
|
|
||||||
},
|
},
|
||||||
size: {
|
size: {
|
||||||
"default": "h-9 px-4 py-2",
|
default: 'h-9 px-4 py-2',
|
||||||
"xs": "h-7 rounded px-2",
|
xs: 'h-7 rounded px-2',
|
||||||
"sm": "h-8 rounded-md px-3 text-xs",
|
sm: 'h-8 rounded-md px-3 text-xs',
|
||||||
"lg": "h-10 rounded-md px-8",
|
lg: 'h-10 rounded-md px-8',
|
||||||
"icon": "h-9 w-9",
|
icon: 'h-9 w-9',
|
||||||
"icon-sm": "size-8",
|
'icon-sm': 'size-8',
|
||||||
"icon-lg": "size-10",
|
'icon-lg': 'size-10',
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
defaultVariants: {
|
defaultVariants: {
|
||||||
variant: "default",
|
variant: 'default',
|
||||||
size: "default",
|
size: 'default',
|
||||||
},
|
|
||||||
},
|
},
|
||||||
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
export type ButtonVariants = VariantProps<typeof buttonVariants>
|
export type ButtonVariants = VariantProps<typeof buttonVariants>
|
||||||
|
|||||||
@@ -1,58 +0,0 @@
|
|||||||
<script lang="ts" setup>
|
|
||||||
import type { CalendarRootEmits, CalendarRootProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import { CalendarRoot, useForwardPropsEmits } from "reka-ui"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
import { CalendarCell, CalendarCellTrigger, CalendarGrid, CalendarGridBody, CalendarGridHead, CalendarGridRow, CalendarHeadCell, CalendarHeader, CalendarHeading, CalendarNextButton, CalendarPrevButton } from "."
|
|
||||||
|
|
||||||
const props = defineProps<CalendarRootProps & { class?: HTMLAttributes["class"] }>()
|
|
||||||
|
|
||||||
const emits = defineEmits<CalendarRootEmits>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const forwarded = useForwardPropsEmits(delegatedProps, emits)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<CalendarRoot
|
|
||||||
v-slot="{ grid, weekDays }"
|
|
||||||
:class="cn('p-3', props.class)"
|
|
||||||
v-bind="forwarded"
|
|
||||||
>
|
|
||||||
<CalendarHeader>
|
|
||||||
<CalendarPrevButton />
|
|
||||||
<CalendarHeading />
|
|
||||||
<CalendarNextButton />
|
|
||||||
</CalendarHeader>
|
|
||||||
|
|
||||||
<div class="flex flex-col gap-y-4 mt-4 sm:flex-row sm:gap-x-4 sm:gap-y-0">
|
|
||||||
<CalendarGrid v-for="month in grid" :key="month.value.toString()">
|
|
||||||
<CalendarGridHead>
|
|
||||||
<CalendarGridRow>
|
|
||||||
<CalendarHeadCell
|
|
||||||
v-for="day in weekDays" :key="day"
|
|
||||||
>
|
|
||||||
{{ day }}
|
|
||||||
</CalendarHeadCell>
|
|
||||||
</CalendarGridRow>
|
|
||||||
</CalendarGridHead>
|
|
||||||
<CalendarGridBody>
|
|
||||||
<CalendarGridRow v-for="(weekDates, index) in month.rows" :key="`weekDate-${index}`" class="mt-2 w-full">
|
|
||||||
<CalendarCell
|
|
||||||
v-for="weekDate in weekDates"
|
|
||||||
:key="weekDate.toString()"
|
|
||||||
:date="weekDate"
|
|
||||||
>
|
|
||||||
<CalendarCellTrigger
|
|
||||||
:day="weekDate"
|
|
||||||
:month="month.value"
|
|
||||||
/>
|
|
||||||
</CalendarCell>
|
|
||||||
</CalendarGridRow>
|
|
||||||
</CalendarGridBody>
|
|
||||||
</CalendarGrid>
|
|
||||||
</div>
|
|
||||||
</CalendarRoot>
|
|
||||||
</template>
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
<script lang="ts" setup>
|
|
||||||
import type { CalendarCellProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import { CalendarCell, useForwardProps } from "reka-ui"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
|
|
||||||
const props = defineProps<CalendarCellProps & { class?: HTMLAttributes["class"] }>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const forwardedProps = useForwardProps(delegatedProps)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<CalendarCell
|
|
||||||
:class="cn('relative p-0 text-center text-sm focus-within:relative focus-within:z-20 [&:has([data-selected])]:rounded-md [&:has([data-selected])]:bg-accent [&:has([data-selected][data-outside-view])]:bg-accent/50', props.class)"
|
|
||||||
v-bind="forwardedProps"
|
|
||||||
>
|
|
||||||
<slot />
|
|
||||||
</CalendarCell>
|
|
||||||
</template>
|
|
||||||
@@ -1,36 +0,0 @@
|
|||||||
<script lang="ts" setup>
|
|
||||||
import type { CalendarCellTriggerProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import { CalendarCellTrigger, useForwardProps } from "reka-ui"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
import { buttonVariants } from '@/components/ui/button'
|
|
||||||
|
|
||||||
const props = defineProps<CalendarCellTriggerProps & { class?: HTMLAttributes["class"] }>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const forwardedProps = useForwardProps(delegatedProps)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<CalendarCellTrigger
|
|
||||||
:class="cn(
|
|
||||||
buttonVariants({ variant: 'ghost' }),
|
|
||||||
'h-8 w-8 p-0 font-normal',
|
|
||||||
'[&[data-today]:not([data-selected])]:bg-accent [&[data-today]:not([data-selected])]:text-accent-foreground',
|
|
||||||
// Selected
|
|
||||||
'data-[selected]:bg-primary data-[selected]:text-primary-foreground data-[selected]:opacity-100 data-[selected]:hover:bg-primary data-[selected]:hover:text-primary-foreground data-[selected]:focus:bg-primary data-[selected]:focus:text-primary-foreground',
|
|
||||||
// Disabled
|
|
||||||
'data-[disabled]:text-muted-foreground data-[disabled]:opacity-50',
|
|
||||||
// Unavailable
|
|
||||||
'data-[unavailable]:text-destructive-foreground data-[unavailable]:line-through',
|
|
||||||
// Outside months
|
|
||||||
'data-[outside-view]:text-muted-foreground data-[outside-view]:opacity-50 [&[data-outside-view][data-selected]]:bg-accent/50 [&[data-outside-view][data-selected]]:text-muted-foreground [&[data-outside-view][data-selected]]:opacity-30',
|
|
||||||
props.class,
|
|
||||||
)"
|
|
||||||
v-bind="forwardedProps"
|
|
||||||
>
|
|
||||||
<slot />
|
|
||||||
</CalendarCellTrigger>
|
|
||||||
</template>
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
<script lang="ts" setup>
|
|
||||||
import type { CalendarGridProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import { CalendarGrid, useForwardProps } from "reka-ui"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
|
|
||||||
const props = defineProps<CalendarGridProps & { class?: HTMLAttributes["class"] }>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const forwardedProps = useForwardProps(delegatedProps)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<CalendarGrid
|
|
||||||
:class="cn('w-full border-collapse space-y-1', props.class)"
|
|
||||||
v-bind="forwardedProps"
|
|
||||||
>
|
|
||||||
<slot />
|
|
||||||
</CalendarGrid>
|
|
||||||
</template>
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
<script lang="ts" setup>
|
|
||||||
import type { CalendarGridBodyProps } from "reka-ui"
|
|
||||||
import { CalendarGridBody } from "reka-ui"
|
|
||||||
|
|
||||||
const props = defineProps<CalendarGridBodyProps>()
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<CalendarGridBody v-bind="props">
|
|
||||||
<slot />
|
|
||||||
</CalendarGridBody>
|
|
||||||
</template>
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
<script lang="ts" setup>
|
|
||||||
import type { CalendarGridHeadProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { CalendarGridHead } from "reka-ui"
|
|
||||||
|
|
||||||
const props = defineProps<CalendarGridHeadProps & { class?: HTMLAttributes["class"] }>()
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<CalendarGridHead v-bind="props">
|
|
||||||
<slot />
|
|
||||||
</CalendarGridHead>
|
|
||||||
</template>
|
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
<script lang="ts" setup>
|
|
||||||
import type { CalendarGridRowProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import { CalendarGridRow, useForwardProps } from "reka-ui"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
|
|
||||||
const props = defineProps<CalendarGridRowProps & { class?: HTMLAttributes["class"] }>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const forwardedProps = useForwardProps(delegatedProps)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<CalendarGridRow :class="cn('flex', props.class)" v-bind="forwardedProps">
|
|
||||||
<slot />
|
|
||||||
</CalendarGridRow>
|
|
||||||
</template>
|
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
<script lang="ts" setup>
|
|
||||||
import type { CalendarHeadCellProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import { CalendarHeadCell, useForwardProps } from "reka-ui"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
|
|
||||||
const props = defineProps<CalendarHeadCellProps & { class?: HTMLAttributes["class"] }>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const forwardedProps = useForwardProps(delegatedProps)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<CalendarHeadCell :class="cn('w-8 rounded-md text-[0.8rem] font-normal text-muted-foreground', props.class)" v-bind="forwardedProps">
|
|
||||||
<slot />
|
|
||||||
</CalendarHeadCell>
|
|
||||||
</template>
|
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
<script lang="ts" setup>
|
|
||||||
import type { CalendarHeaderProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import { CalendarHeader, useForwardProps } from "reka-ui"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
|
|
||||||
const props = defineProps<CalendarHeaderProps & { class?: HTMLAttributes["class"] }>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const forwardedProps = useForwardProps(delegatedProps)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<CalendarHeader :class="cn('relative flex w-full items-center justify-between pt-1', props.class)" v-bind="forwardedProps">
|
|
||||||
<slot />
|
|
||||||
</CalendarHeader>
|
|
||||||
</template>
|
|
||||||
@@ -1,29 +0,0 @@
|
|||||||
<script lang="ts" setup>
|
|
||||||
import type { CalendarHeadingProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import { CalendarHeading, useForwardProps } from "reka-ui"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
|
|
||||||
const props = defineProps<CalendarHeadingProps & { class?: HTMLAttributes["class"] }>()
|
|
||||||
|
|
||||||
defineSlots<{
|
|
||||||
default: (props: { headingValue: string }) => any
|
|
||||||
}>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const forwardedProps = useForwardProps(delegatedProps)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<CalendarHeading
|
|
||||||
v-slot="{ headingValue }"
|
|
||||||
:class="cn('text-sm font-medium', props.class)"
|
|
||||||
v-bind="forwardedProps"
|
|
||||||
>
|
|
||||||
<slot :heading-value>
|
|
||||||
{{ headingValue }}
|
|
||||||
</slot>
|
|
||||||
</CalendarHeading>
|
|
||||||
</template>
|
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
<script lang="ts" setup>
|
|
||||||
import type { CalendarNextProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import { ChevronRight } from "lucide-vue-next"
|
|
||||||
import { CalendarNext, useForwardProps } from "reka-ui"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
import { buttonVariants } from '@/components/ui/button'
|
|
||||||
|
|
||||||
const props = defineProps<CalendarNextProps & { class?: HTMLAttributes["class"] }>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const forwardedProps = useForwardProps(delegatedProps)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<CalendarNext
|
|
||||||
:class="cn(
|
|
||||||
buttonVariants({ variant: 'outline' }),
|
|
||||||
'h-7 w-7 bg-transparent p-0 opacity-50 hover:opacity-100',
|
|
||||||
props.class,
|
|
||||||
)"
|
|
||||||
v-bind="forwardedProps"
|
|
||||||
>
|
|
||||||
<slot>
|
|
||||||
<ChevronRight class="h-4 w-4" />
|
|
||||||
</slot>
|
|
||||||
</CalendarNext>
|
|
||||||
</template>
|
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
<script lang="ts" setup>
|
|
||||||
import type { CalendarPrevProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import { ChevronLeft } from "lucide-vue-next"
|
|
||||||
import { CalendarPrev, useForwardProps } from "reka-ui"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
import { buttonVariants } from '@/components/ui/button'
|
|
||||||
|
|
||||||
const props = defineProps<CalendarPrevProps & { class?: HTMLAttributes["class"] }>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const forwardedProps = useForwardProps(delegatedProps)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<CalendarPrev
|
|
||||||
:class="cn(
|
|
||||||
buttonVariants({ variant: 'outline' }),
|
|
||||||
'h-7 w-7 bg-transparent p-0 opacity-50 hover:opacity-100',
|
|
||||||
props.class,
|
|
||||||
)"
|
|
||||||
v-bind="forwardedProps"
|
|
||||||
>
|
|
||||||
<slot>
|
|
||||||
<ChevronLeft class="h-4 w-4" />
|
|
||||||
</slot>
|
|
||||||
</CalendarPrev>
|
|
||||||
</template>
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
export { default as Calendar } from "./Calendar.vue"
|
|
||||||
export { default as CalendarCell } from "./CalendarCell.vue"
|
|
||||||
export { default as CalendarCellTrigger } from "./CalendarCellTrigger.vue"
|
|
||||||
export { default as CalendarGrid } from "./CalendarGrid.vue"
|
|
||||||
export { default as CalendarGridBody } from "./CalendarGridBody.vue"
|
|
||||||
export { default as CalendarGridHead } from "./CalendarGridHead.vue"
|
|
||||||
export { default as CalendarGridRow } from "./CalendarGridRow.vue"
|
|
||||||
export { default as CalendarHeadCell } from "./CalendarHeadCell.vue"
|
|
||||||
export { default as CalendarHeader } from "./CalendarHeader.vue"
|
|
||||||
export { default as CalendarHeading } from "./CalendarHeading.vue"
|
|
||||||
export { default as CalendarNextButton } from "./CalendarNextButton.vue"
|
|
||||||
export { default as CalendarPrevButton } from "./CalendarPrevButton.vue"
|
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { CheckboxRootEmits, CheckboxRootProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import { Check } from "lucide-vue-next"
|
|
||||||
import { CheckboxIndicator, CheckboxRoot, useForwardPropsEmits } from "reka-ui"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
|
|
||||||
const props = defineProps<CheckboxRootProps & { class?: HTMLAttributes["class"] }>()
|
|
||||||
const emits = defineEmits<CheckboxRootEmits>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const forwarded = useForwardPropsEmits(delegatedProps, emits)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<CheckboxRoot
|
|
||||||
v-bind="forwarded"
|
|
||||||
:class="
|
|
||||||
cn('grid place-content-center peer h-4 w-4 shrink-0 rounded-sm border border-primary shadow focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-ring disabled:cursor-not-allowed disabled:opacity-50 data-[state=checked]:bg-primary data-[state=checked]:text-primary-foreground',
|
|
||||||
props.class)"
|
|
||||||
>
|
|
||||||
<CheckboxIndicator class="grid place-content-center text-current">
|
|
||||||
<slot>
|
|
||||||
<Check class="h-4 w-4" />
|
|
||||||
</slot>
|
|
||||||
</CheckboxIndicator>
|
|
||||||
</CheckboxRoot>
|
|
||||||
</template>
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
export { default as Checkbox } from "./Checkbox.vue"
|
|
||||||
@@ -1,86 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { ListboxRootEmits, ListboxRootProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import { ListboxRoot, useFilter, useForwardPropsEmits } from "reka-ui"
|
|
||||||
import { reactive, ref, watch } from "vue"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
import { provideCommandContext } from "."
|
|
||||||
|
|
||||||
const props = withDefaults(defineProps<ListboxRootProps & { class?: HTMLAttributes["class"] }>(), {
|
|
||||||
modelValue: "",
|
|
||||||
})
|
|
||||||
|
|
||||||
const emits = defineEmits<ListboxRootEmits>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const forwarded = useForwardPropsEmits(delegatedProps, emits)
|
|
||||||
|
|
||||||
const allItems = ref<Map<string, string>>(new Map())
|
|
||||||
const allGroups = ref<Map<string, Set<string>>>(new Map())
|
|
||||||
|
|
||||||
const { contains } = useFilter({ sensitivity: "base" })
|
|
||||||
const filterState = reactive({
|
|
||||||
search: "",
|
|
||||||
filtered: {
|
|
||||||
/** The count of all visible items. */
|
|
||||||
count: 0,
|
|
||||||
/** Map from visible item id to its search score. */
|
|
||||||
items: new Map() as Map<string, number>,
|
|
||||||
/** Set of groups with at least one visible item. */
|
|
||||||
groups: new Set() as Set<string>,
|
|
||||||
},
|
|
||||||
})
|
|
||||||
|
|
||||||
function filterItems() {
|
|
||||||
if (!filterState.search) {
|
|
||||||
filterState.filtered.count = allItems.value.size
|
|
||||||
// Do nothing, each item will know to show itself because search is empty
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Reset the groups
|
|
||||||
filterState.filtered.groups = new Set()
|
|
||||||
let itemCount = 0
|
|
||||||
|
|
||||||
// Check which items should be included
|
|
||||||
for (const [id, value] of allItems.value) {
|
|
||||||
const score = contains(value, filterState.search)
|
|
||||||
filterState.filtered.items.set(id, score ? 1 : 0)
|
|
||||||
if (score)
|
|
||||||
itemCount++
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check which groups have at least 1 item shown
|
|
||||||
for (const [groupId, group] of allGroups.value) {
|
|
||||||
for (const itemId of group) {
|
|
||||||
if (filterState.filtered.items.get(itemId)! > 0) {
|
|
||||||
filterState.filtered.groups.add(groupId)
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
filterState.filtered.count = itemCount
|
|
||||||
}
|
|
||||||
|
|
||||||
watch(() => filterState.search, () => {
|
|
||||||
filterItems()
|
|
||||||
})
|
|
||||||
|
|
||||||
provideCommandContext({
|
|
||||||
allItems,
|
|
||||||
allGroups,
|
|
||||||
filterState,
|
|
||||||
})
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<ListboxRoot
|
|
||||||
v-bind="forwarded"
|
|
||||||
:class="cn('flex h-full w-full flex-col overflow-hidden rounded-md bg-popover text-popover-foreground', props.class)"
|
|
||||||
>
|
|
||||||
<slot />
|
|
||||||
</ListboxRoot>
|
|
||||||
</template>
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { DialogRootEmits, DialogRootProps } from "reka-ui"
|
|
||||||
import { useForwardPropsEmits } from "reka-ui"
|
|
||||||
import { Dialog, DialogContent } from '@/components/ui/dialog'
|
|
||||||
import Command from "./Command.vue"
|
|
||||||
|
|
||||||
const props = defineProps<DialogRootProps>()
|
|
||||||
const emits = defineEmits<DialogRootEmits>()
|
|
||||||
|
|
||||||
const forwarded = useForwardPropsEmits(props, emits)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<Dialog v-bind="forwarded">
|
|
||||||
<DialogContent class="overflow-hidden p-0 shadow-lg">
|
|
||||||
<Command class="[&_[cmdk-group-heading]]:px-2 [&_[cmdk-group-heading]]:font-medium [&_[cmdk-group-heading]]:text-muted-foreground [&_[cmdk-group]:not([hidden])_~[cmdk-group]]:pt-0 [&_[cmdk-group]]:px-2 [&_[cmdk-input-wrapper]_svg]:h-5 [&_[cmdk-input-wrapper]_svg]:w-5 [&_[cmdk-input]]:h-12 [&_[cmdk-item]]:px-2 [&_[cmdk-item]]:py-3 [&_[cmdk-item]_svg]:h-5 [&_[cmdk-item]_svg]:w-5">
|
|
||||||
<slot />
|
|
||||||
</Command>
|
|
||||||
</DialogContent>
|
|
||||||
</Dialog>
|
|
||||||
</template>
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { PrimitiveProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import { Primitive } from "reka-ui"
|
|
||||||
import { computed } from "vue"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
import { useCommand } from "."
|
|
||||||
|
|
||||||
const props = defineProps<PrimitiveProps & { class?: HTMLAttributes["class"] }>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const { filterState } = useCommand()
|
|
||||||
const isRender = computed(() => !!filterState.search && filterState.filtered.count === 0,
|
|
||||||
)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<Primitive v-if="isRender" v-bind="delegatedProps" :class="cn('py-6 text-center text-sm', props.class)">
|
|
||||||
<slot />
|
|
||||||
</Primitive>
|
|
||||||
</template>
|
|
||||||
@@ -1,44 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { ListboxGroupProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import { ListboxGroup, ListboxGroupLabel, useId } from "reka-ui"
|
|
||||||
import { computed, onMounted, onUnmounted } from "vue"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
import { provideCommandGroupContext, useCommand } from "."
|
|
||||||
|
|
||||||
const props = defineProps<ListboxGroupProps & {
|
|
||||||
class?: HTMLAttributes["class"]
|
|
||||||
heading?: string
|
|
||||||
}>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const { allGroups, filterState } = useCommand()
|
|
||||||
const id = useId()
|
|
||||||
|
|
||||||
const isRender = computed(() => !filterState.search ? true : filterState.filtered.groups.has(id))
|
|
||||||
|
|
||||||
provideCommandGroupContext({ id })
|
|
||||||
onMounted(() => {
|
|
||||||
if (!allGroups.value.has(id))
|
|
||||||
allGroups.value.set(id, new Set())
|
|
||||||
})
|
|
||||||
onUnmounted(() => {
|
|
||||||
allGroups.value.delete(id)
|
|
||||||
})
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<ListboxGroup
|
|
||||||
v-bind="delegatedProps"
|
|
||||||
:id="id"
|
|
||||||
:class="cn('overflow-hidden p-1 text-foreground [&_[cmdk-group-heading]]:px-2 [&_[cmdk-group-heading]]:py-1.5 [&_[cmdk-group-heading]]:text-xs [&_[cmdk-group-heading]]:font-medium [&_[cmdk-group-heading]]:text-muted-foreground', props.class)"
|
|
||||||
:hidden="isRender ? undefined : true"
|
|
||||||
>
|
|
||||||
<ListboxGroupLabel v-if="heading" class="px-2 py-1.5 text-xs font-medium text-muted-foreground">
|
|
||||||
{{ heading }}
|
|
||||||
</ListboxGroupLabel>
|
|
||||||
<slot />
|
|
||||||
</ListboxGroup>
|
|
||||||
</template>
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { ListboxFilterProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import { Search } from "lucide-vue-next"
|
|
||||||
import { ListboxFilter, useForwardProps } from "reka-ui"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
import { useCommand } from "."
|
|
||||||
|
|
||||||
defineOptions({
|
|
||||||
inheritAttrs: false,
|
|
||||||
})
|
|
||||||
|
|
||||||
const props = defineProps<ListboxFilterProps & {
|
|
||||||
class?: HTMLAttributes["class"]
|
|
||||||
}>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const forwardedProps = useForwardProps(delegatedProps)
|
|
||||||
|
|
||||||
const { filterState } = useCommand()
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<div class="flex items-center border-b px-3" cmdk-input-wrapper>
|
|
||||||
<Search class="mr-2 h-4 w-4 shrink-0 opacity-50" />
|
|
||||||
<ListboxFilter
|
|
||||||
v-bind="{ ...forwardedProps, ...$attrs }"
|
|
||||||
v-model="filterState.search"
|
|
||||||
auto-focus
|
|
||||||
:class="cn('flex h-10 w-full rounded-md bg-transparent py-3 text-sm outline-none placeholder:text-muted-foreground disabled:cursor-not-allowed disabled:opacity-50', props.class)"
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
</template>
|
|
||||||
@@ -1,75 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { ListboxItemEmits, ListboxItemProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit, useCurrentElement } from "@vueuse/core"
|
|
||||||
import { ListboxItem, useForwardPropsEmits, useId } from "reka-ui"
|
|
||||||
import { computed, onMounted, onUnmounted, ref } from "vue"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
import { useCommand, useCommandGroup } from "."
|
|
||||||
|
|
||||||
const props = defineProps<ListboxItemProps & { class?: HTMLAttributes["class"] }>()
|
|
||||||
const emits = defineEmits<ListboxItemEmits>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const forwarded = useForwardPropsEmits(delegatedProps, emits)
|
|
||||||
|
|
||||||
const id = useId()
|
|
||||||
const { filterState, allItems, allGroups } = useCommand()
|
|
||||||
const groupContext = useCommandGroup()
|
|
||||||
|
|
||||||
const isRender = computed(() => {
|
|
||||||
if (!filterState.search) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
const filteredCurrentItem = filterState.filtered.items.get(id)
|
|
||||||
// If the filtered items is undefined means not in the all times map yet
|
|
||||||
// Do the first render to add into the map
|
|
||||||
if (filteredCurrentItem === undefined) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check with filter
|
|
||||||
return filteredCurrentItem > 0
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
const itemRef = ref()
|
|
||||||
const currentElement = useCurrentElement(itemRef)
|
|
||||||
onMounted(() => {
|
|
||||||
if (!(currentElement.value instanceof HTMLElement))
|
|
||||||
return
|
|
||||||
|
|
||||||
// textValue to perform filter
|
|
||||||
allItems.value.set(id, currentElement.value.textContent ?? props?.value!.toString())
|
|
||||||
|
|
||||||
const groupId = groupContext?.id
|
|
||||||
if (groupId) {
|
|
||||||
if (!allGroups.value.has(groupId)) {
|
|
||||||
allGroups.value.set(groupId, new Set([id]))
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
allGroups.value.get(groupId)?.add(id)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
onUnmounted(() => {
|
|
||||||
allItems.value.delete(id)
|
|
||||||
})
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<ListboxItem
|
|
||||||
v-if="isRender"
|
|
||||||
v-bind="forwarded"
|
|
||||||
:id="id"
|
|
||||||
ref="itemRef"
|
|
||||||
:class="cn('relative flex cursor-default gap-2 select-none items-center rounded-sm px-2 py-1.5 text-sm outline-none data-[highlighted]:bg-accent data-[highlighted]:text-accent-foreground data-[disabled]:pointer-events-none data-[disabled]:opacity-50 [&_svg]:size-4 [&_svg]:shrink-0', props.class)"
|
|
||||||
@select="() => {
|
|
||||||
filterState.search = ''
|
|
||||||
}"
|
|
||||||
>
|
|
||||||
<slot />
|
|
||||||
</ListboxItem>
|
|
||||||
</template>
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { ListboxContentProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import { ListboxContent, useForwardProps } from "reka-ui"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
|
|
||||||
const props = defineProps<ListboxContentProps & { class?: HTMLAttributes["class"] }>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const forwarded = useForwardProps(delegatedProps)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<ListboxContent v-bind="forwarded" :class="cn('max-h-[300px] overflow-y-auto overflow-x-hidden', props.class)">
|
|
||||||
<div role="presentation">
|
|
||||||
<slot />
|
|
||||||
</div>
|
|
||||||
</ListboxContent>
|
|
||||||
</template>
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { SeparatorProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import { Separator } from "reka-ui"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
|
|
||||||
const props = defineProps<SeparatorProps & { class?: HTMLAttributes["class"] }>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<Separator
|
|
||||||
v-bind="delegatedProps"
|
|
||||||
:class="cn('-mx-1 h-px bg-border', props.class)"
|
|
||||||
>
|
|
||||||
<slot />
|
|
||||||
</Separator>
|
|
||||||
</template>
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
|
|
||||||
const props = defineProps<{
|
|
||||||
class?: HTMLAttributes["class"]
|
|
||||||
}>()
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<span :class="cn('ml-auto text-xs tracking-widest text-muted-foreground', props.class)">
|
|
||||||
<slot />
|
|
||||||
</span>
|
|
||||||
</template>
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
import type { Ref } from "vue"
|
|
||||||
import { createContext } from "reka-ui"
|
|
||||||
|
|
||||||
export { default as Command } from "./Command.vue"
|
|
||||||
export { default as CommandDialog } from "./CommandDialog.vue"
|
|
||||||
export { default as CommandEmpty } from "./CommandEmpty.vue"
|
|
||||||
export { default as CommandGroup } from "./CommandGroup.vue"
|
|
||||||
export { default as CommandInput } from "./CommandInput.vue"
|
|
||||||
export { default as CommandItem } from "./CommandItem.vue"
|
|
||||||
export { default as CommandList } from "./CommandList.vue"
|
|
||||||
export { default as CommandSeparator } from "./CommandSeparator.vue"
|
|
||||||
export { default as CommandShortcut } from "./CommandShortcut.vue"
|
|
||||||
|
|
||||||
export const [useCommand, provideCommandContext] = createContext<{
|
|
||||||
allItems: Ref<Map<string, string>>
|
|
||||||
allGroups: Ref<Map<string, Set<string>>>
|
|
||||||
filterState: {
|
|
||||||
search: string
|
|
||||||
filtered: { count: number, items: Map<string, number>, groups: Set<string> }
|
|
||||||
}
|
|
||||||
}>("Command")
|
|
||||||
|
|
||||||
export const [useCommandGroup, provideCommandGroupContext] = createContext<{
|
|
||||||
id?: string
|
|
||||||
}>("CommandGroup")
|
|
||||||
@@ -1,74 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import { ref, computed } from 'vue'
|
|
||||||
import { Calendar } from '@/components/ui/calendar'
|
|
||||||
import { Button } from '@/components/ui/button'
|
|
||||||
import { Popover, PopoverContent, PopoverTrigger } from '@/components/ui/popover'
|
|
||||||
import { CalendarIcon } from 'lucide-vue-next'
|
|
||||||
import { cn } from '@/lib/utils'
|
|
||||||
import { CalendarDate, type DateValue } from '@internationalized/date'
|
|
||||||
|
|
||||||
interface Props {
|
|
||||||
modelValue?: Date | string | null
|
|
||||||
placeholder?: string
|
|
||||||
disabled?: boolean
|
|
||||||
format?: string
|
|
||||||
}
|
|
||||||
|
|
||||||
const props = withDefaults(defineProps<Props>(), {
|
|
||||||
placeholder: 'Pick a date',
|
|
||||||
format: 'PPP',
|
|
||||||
})
|
|
||||||
|
|
||||||
const emit = defineEmits<{
|
|
||||||
'update:modelValue': [value: Date | null]
|
|
||||||
}>()
|
|
||||||
|
|
||||||
const placeholder = ref<DateValue>(new CalendarDate(new Date().getFullYear(), new Date().getMonth() + 1, new Date().getDate()))
|
|
||||||
|
|
||||||
const value = computed<DateValue | undefined>({
|
|
||||||
get: () => {
|
|
||||||
if (!props.modelValue) return undefined
|
|
||||||
const date = props.modelValue instanceof Date ? props.modelValue : new Date(props.modelValue)
|
|
||||||
return new CalendarDate(date.getFullYear(), date.getMonth() + 1, date.getDate())
|
|
||||||
},
|
|
||||||
set: (dateValue) => {
|
|
||||||
if (!dateValue) {
|
|
||||||
emit('update:modelValue', null)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
const jsDate = new Date(dateValue.year, dateValue.month - 1, dateValue.day)
|
|
||||||
emit('update:modelValue', jsDate)
|
|
||||||
},
|
|
||||||
})
|
|
||||||
|
|
||||||
const formatDate = (dateValue: DateValue | undefined) => {
|
|
||||||
if (!dateValue) return props.placeholder
|
|
||||||
const date = new Date(dateValue.year, dateValue.month - 1, dateValue.day)
|
|
||||||
return date.toLocaleDateString('en-US', {
|
|
||||||
year: 'numeric',
|
|
||||||
month: 'long',
|
|
||||||
day: 'numeric',
|
|
||||||
})
|
|
||||||
}
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<Popover>
|
|
||||||
<PopoverTrigger as-child>
|
|
||||||
<Button
|
|
||||||
variant="outline"
|
|
||||||
:class="cn(
|
|
||||||
'w-full justify-start text-left font-normal',
|
|
||||||
!value && 'text-muted-foreground'
|
|
||||||
)"
|
|
||||||
:disabled="disabled"
|
|
||||||
>
|
|
||||||
<CalendarIcon class="mr-2 h-4 w-4" />
|
|
||||||
{{ formatDate(value) }}
|
|
||||||
</Button>
|
|
||||||
</PopoverTrigger>
|
|
||||||
<PopoverContent class="w-auto p-0">
|
|
||||||
<Calendar v-model="value" :placeholder="placeholder" />
|
|
||||||
</PopoverContent>
|
|
||||||
</Popover>
|
|
||||||
</template>
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
export { default as DatePicker } from './DatePicker.vue'
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { DialogRootEmits, DialogRootProps } from "reka-ui"
|
|
||||||
import { DialogRoot, useForwardPropsEmits } from "reka-ui"
|
|
||||||
|
|
||||||
const props = defineProps<DialogRootProps>()
|
|
||||||
const emits = defineEmits<DialogRootEmits>()
|
|
||||||
|
|
||||||
const forwarded = useForwardPropsEmits(props, emits)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<DialogRoot v-bind="forwarded">
|
|
||||||
<slot />
|
|
||||||
</DialogRoot>
|
|
||||||
</template>
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { DialogCloseProps } from "reka-ui"
|
|
||||||
import { DialogClose } from "reka-ui"
|
|
||||||
|
|
||||||
const props = defineProps<DialogCloseProps>()
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<DialogClose v-bind="props">
|
|
||||||
<slot />
|
|
||||||
</DialogClose>
|
|
||||||
</template>
|
|
||||||
@@ -1,46 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { DialogContentEmits, DialogContentProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import { X } from "lucide-vue-next"
|
|
||||||
import {
|
|
||||||
DialogClose,
|
|
||||||
DialogContent,
|
|
||||||
DialogOverlay,
|
|
||||||
DialogPortal,
|
|
||||||
useForwardPropsEmits,
|
|
||||||
} from "reka-ui"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
|
|
||||||
const props = defineProps<DialogContentProps & { class?: HTMLAttributes["class"] }>()
|
|
||||||
const emits = defineEmits<DialogContentEmits>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const forwarded = useForwardPropsEmits(delegatedProps, emits)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<DialogPortal>
|
|
||||||
<DialogOverlay
|
|
||||||
class="fixed inset-0 z-50 bg-black/80 data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0"
|
|
||||||
/>
|
|
||||||
<DialogContent
|
|
||||||
v-bind="forwarded"
|
|
||||||
:class="
|
|
||||||
cn(
|
|
||||||
'fixed left-1/2 top-1/2 z-50 grid w-full max-w-lg -translate-x-1/2 -translate-y-1/2 gap-4 border bg-background p-6 shadow-lg duration-200 data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 data-[state=closed]:zoom-out-95 data-[state=open]:zoom-in-95 data-[state=closed]:slide-out-to-left-1/2 data-[state=closed]:slide-out-to-top-[48%] data-[state=open]:slide-in-from-left-1/2 data-[state=open]:slide-in-from-top-[48%] sm:rounded-lg',
|
|
||||||
props.class,
|
|
||||||
)"
|
|
||||||
>
|
|
||||||
<slot />
|
|
||||||
|
|
||||||
<DialogClose
|
|
||||||
class="absolute right-4 top-4 rounded-sm opacity-70 ring-offset-background transition-opacity hover:opacity-100 focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2 disabled:pointer-events-none data-[state=open]:bg-accent data-[state=open]:text-muted-foreground"
|
|
||||||
>
|
|
||||||
<X class="w-4 h-4" />
|
|
||||||
<span class="sr-only">Close</span>
|
|
||||||
</DialogClose>
|
|
||||||
</DialogContent>
|
|
||||||
</DialogPortal>
|
|
||||||
</template>
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { DialogDescriptionProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import { DialogDescription, useForwardProps } from "reka-ui"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
|
|
||||||
const props = defineProps<DialogDescriptionProps & { class?: HTMLAttributes["class"] }>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const forwardedProps = useForwardProps(delegatedProps)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<DialogDescription
|
|
||||||
v-bind="forwardedProps"
|
|
||||||
:class="cn('text-sm text-muted-foreground', props.class)"
|
|
||||||
>
|
|
||||||
<slot />
|
|
||||||
</DialogDescription>
|
|
||||||
</template>
|
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
|
|
||||||
const props = defineProps<{ class?: HTMLAttributes["class"] }>()
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<div
|
|
||||||
:class="
|
|
||||||
cn(
|
|
||||||
'flex flex-col-reverse sm:flex-row sm:justify-end sm:gap-x-2',
|
|
||||||
props.class,
|
|
||||||
)
|
|
||||||
"
|
|
||||||
>
|
|
||||||
<slot />
|
|
||||||
</div>
|
|
||||||
</template>
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
|
|
||||||
const props = defineProps<{
|
|
||||||
class?: HTMLAttributes["class"]
|
|
||||||
}>()
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<div
|
|
||||||
:class="cn('flex flex-col gap-y-1.5 text-center sm:text-left', props.class)"
|
|
||||||
>
|
|
||||||
<slot />
|
|
||||||
</div>
|
|
||||||
</template>
|
|
||||||
@@ -1,55 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { DialogContentEmits, DialogContentProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import { X } from "lucide-vue-next"
|
|
||||||
import {
|
|
||||||
DialogClose,
|
|
||||||
DialogContent,
|
|
||||||
DialogOverlay,
|
|
||||||
DialogPortal,
|
|
||||||
useForwardPropsEmits,
|
|
||||||
} from "reka-ui"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
|
|
||||||
const props = defineProps<DialogContentProps & { class?: HTMLAttributes["class"] }>()
|
|
||||||
const emits = defineEmits<DialogContentEmits>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const forwarded = useForwardPropsEmits(delegatedProps, emits)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<DialogPortal>
|
|
||||||
<DialogOverlay
|
|
||||||
class="fixed inset-0 z-50 grid place-items-center overflow-y-auto bg-black/80 data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0"
|
|
||||||
>
|
|
||||||
<DialogContent
|
|
||||||
:class="
|
|
||||||
cn(
|
|
||||||
'relative z-50 grid w-full max-w-lg my-8 gap-4 border border-border bg-background p-6 shadow-lg duration-200 sm:rounded-lg md:w-full',
|
|
||||||
props.class,
|
|
||||||
)
|
|
||||||
"
|
|
||||||
v-bind="forwarded"
|
|
||||||
@pointer-down-outside="(event) => {
|
|
||||||
const originalEvent = event.detail.originalEvent;
|
|
||||||
const target = originalEvent.target as HTMLElement;
|
|
||||||
if (originalEvent.offsetX > target.clientWidth || originalEvent.offsetY > target.clientHeight) {
|
|
||||||
event.preventDefault();
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
>
|
|
||||||
<slot />
|
|
||||||
|
|
||||||
<DialogClose
|
|
||||||
class="absolute top-4 right-4 p-0.5 transition-colors rounded-md hover:bg-secondary"
|
|
||||||
>
|
|
||||||
<X class="w-4 h-4" />
|
|
||||||
<span class="sr-only">Close</span>
|
|
||||||
</DialogClose>
|
|
||||||
</DialogContent>
|
|
||||||
</DialogOverlay>
|
|
||||||
</DialogPortal>
|
|
||||||
</template>
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { DialogTitleProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import { DialogTitle, useForwardProps } from "reka-ui"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
|
|
||||||
const props = defineProps<DialogTitleProps & { class?: HTMLAttributes["class"] }>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const forwardedProps = useForwardProps(delegatedProps)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<DialogTitle
|
|
||||||
v-bind="forwardedProps"
|
|
||||||
:class="
|
|
||||||
cn(
|
|
||||||
'text-lg font-semibold leading-none tracking-tight',
|
|
||||||
props.class,
|
|
||||||
)
|
|
||||||
"
|
|
||||||
>
|
|
||||||
<slot />
|
|
||||||
</DialogTitle>
|
|
||||||
</template>
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { DialogTriggerProps } from "reka-ui"
|
|
||||||
import { DialogTrigger } from "reka-ui"
|
|
||||||
|
|
||||||
const props = defineProps<DialogTriggerProps>()
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<DialogTrigger v-bind="props">
|
|
||||||
<slot />
|
|
||||||
</DialogTrigger>
|
|
||||||
</template>
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
export { default as Dialog } from "./Dialog.vue"
|
|
||||||
export { default as DialogClose } from "./DialogClose.vue"
|
|
||||||
export { default as DialogContent } from "./DialogContent.vue"
|
|
||||||
export { default as DialogDescription } from "./DialogDescription.vue"
|
|
||||||
export { default as DialogFooter } from "./DialogFooter.vue"
|
|
||||||
export { default as DialogHeader } from "./DialogHeader.vue"
|
|
||||||
export { default as DialogScrollContent } from "./DialogScrollContent.vue"
|
|
||||||
export { default as DialogTitle } from "./DialogTitle.vue"
|
|
||||||
export { default as DialogTrigger } from "./DialogTrigger.vue"
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { PopoverRootEmits, PopoverRootProps } from "reka-ui"
|
|
||||||
import { PopoverRoot, useForwardPropsEmits } from "reka-ui"
|
|
||||||
|
|
||||||
const props = defineProps<PopoverRootProps>()
|
|
||||||
const emits = defineEmits<PopoverRootEmits>()
|
|
||||||
|
|
||||||
const forwarded = useForwardPropsEmits(props, emits)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<PopoverRoot v-bind="forwarded">
|
|
||||||
<slot />
|
|
||||||
</PopoverRoot>
|
|
||||||
</template>
|
|
||||||
@@ -1,41 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { PopoverContentEmits, PopoverContentProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import {
|
|
||||||
PopoverContent,
|
|
||||||
useForwardPropsEmits,
|
|
||||||
} from "reka-ui"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
|
|
||||||
defineOptions({
|
|
||||||
inheritAttrs: false,
|
|
||||||
})
|
|
||||||
|
|
||||||
const props = withDefaults(
|
|
||||||
defineProps<PopoverContentProps & { class?: HTMLAttributes["class"] }>(),
|
|
||||||
{
|
|
||||||
align: "center",
|
|
||||||
sideOffset: 4,
|
|
||||||
},
|
|
||||||
)
|
|
||||||
const emits = defineEmits<PopoverContentEmits>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const forwarded = useForwardPropsEmits(delegatedProps, emits)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<PopoverContent
|
|
||||||
v-bind="{ ...forwarded, ...$attrs }"
|
|
||||||
:class="
|
|
||||||
cn(
|
|
||||||
'z-50 w-72 rounded-md border bg-popover p-4 text-popover-foreground shadow-md outline-none data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 data-[state=closed]:zoom-out-95 data-[state=open]:zoom-in-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2',
|
|
||||||
props.class,
|
|
||||||
)
|
|
||||||
"
|
|
||||||
>
|
|
||||||
<slot />
|
|
||||||
</PopoverContent>
|
|
||||||
</template>
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { PopoverTriggerProps } from "reka-ui"
|
|
||||||
import { PopoverTrigger } from "reka-ui"
|
|
||||||
|
|
||||||
const props = defineProps<PopoverTriggerProps>()
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<PopoverTrigger v-bind="props">
|
|
||||||
<slot />
|
|
||||||
</PopoverTrigger>
|
|
||||||
</template>
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
export { default as Popover } from "./Popover.vue"
|
|
||||||
export { default as PopoverContent } from "./PopoverContent.vue"
|
|
||||||
export { default as PopoverTrigger } from "./PopoverTrigger.vue"
|
|
||||||
export { PopoverAnchor } from "reka-ui"
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
import type { SwitchRootEmits, SwitchRootProps } from "reka-ui"
|
|
||||||
import type { HTMLAttributes } from "vue"
|
|
||||||
import { reactiveOmit } from "@vueuse/core"
|
|
||||||
import {
|
|
||||||
SwitchRoot,
|
|
||||||
SwitchThumb,
|
|
||||||
useForwardPropsEmits,
|
|
||||||
} from "reka-ui"
|
|
||||||
import { cn } from "@/lib/utils"
|
|
||||||
|
|
||||||
const props = defineProps<SwitchRootProps & { class?: HTMLAttributes["class"] }>()
|
|
||||||
|
|
||||||
const emits = defineEmits<SwitchRootEmits>()
|
|
||||||
|
|
||||||
const delegatedProps = reactiveOmit(props, "class")
|
|
||||||
|
|
||||||
const forwarded = useForwardPropsEmits(delegatedProps, emits)
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<SwitchRoot
|
|
||||||
v-bind="forwarded"
|
|
||||||
:class="cn(
|
|
||||||
'peer inline-flex h-5 w-9 shrink-0 cursor-pointer items-center rounded-full border-2 border-transparent shadow-sm transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 focus-visible:ring-offset-background disabled:cursor-not-allowed disabled:opacity-50 data-[state=checked]:bg-primary data-[state=unchecked]:bg-input',
|
|
||||||
props.class,
|
|
||||||
)"
|
|
||||||
>
|
|
||||||
<SwitchThumb
|
|
||||||
:class="cn('pointer-events-none block h-4 w-4 rounded-full bg-background shadow-lg ring-0 transition-transform data-[state=checked]:translate-x-4 data-[state=unchecked]:translate-x-0')"
|
|
||||||
>
|
|
||||||
<slot name="thumb" />
|
|
||||||
</SwitchThumb>
|
|
||||||
</SwitchRoot>
|
|
||||||
</template>
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user