Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 | 7x | /**
* Entity Schema - System Entity Definition (TypeScript)
*
* This is a hardcoded schema for the "entity" entity itself.
* System entities (entity, role, user) are NOT stored in the database
* to avoid bootstrap problems and ensure type safety.
*
* User-created entities have their schemas stored in the database.
*/
export interface FieldDefinition {
name: string
type:
| 'text'
| 'textarea'
| 'number'
| 'date'
| 'select'
| 'multiselect'
| 'reference'
| 'json'
| 'user'
| 'boolean'
label: string
required: boolean
readOnly?: boolean
defaultValue?: any
options?: Array<{ value: string; label: string }>
description?: string
deprecated?: boolean
conditionalDisplay?: {
field: string
operator: 'equals' | 'notEquals' | 'contains'
value: any
}
schema?: any // JSON schema for complex types
}
export interface FormDefinition {
id: string
name: string
description?: string
fields: string[] // Array of field names to include in form
}
export interface WorkflowDefinition {
states: Array<{
id: string
label: Record<string, string> | string
}>
transitions: Array<{
from: string // state id
to: string // state id
label?: Record<string, string> | string
requiresPermission?: string
}>
positions?: Record<string, { x: number; y: number }> // state id -> position
}
export interface EntitySchema {
id: string
name: string
description?: string
isSystemEntity: boolean
visibility: 'flow-members' | 'restricted' | 'public'
fields: FieldDefinition[]
forms?: FormDefinition[]
workflows?: WorkflowDefinition[]
defaultPermissions?: {
create: string
read: string
update: string
delete: string
}
}
export const ENTITY_SCHEMA: EntitySchema = {
id: 'entity',
name: 'Entity',
description: 'Defines the structure and behavior of entities in the system',
isSystemEntity: true,
visibility: 'restricted', // Only admins can access entity metadata
fields: [
{
name: 'id',
type: 'text',
label: 'Entity ID',
required: true,
readOnly: true,
description: 'Unique identifier for the entity'
},
{
name: 'name',
type: 'text',
label: 'Name',
required: true,
description: 'Display name of the entity'
},
{
name: 'description',
type: 'textarea',
label: 'Description',
required: false,
description: 'Description of what this entity represents'
},
{
name: 'visibility',
type: 'select',
label: 'Visibility',
required: true,
defaultValue: 'flow-members',
options: [
{ value: 'flow-members', label: 'Flow Members (default)' },
{ value: 'restricted', label: 'Restricted' },
{ value: 'public', label: 'Public' }
],
description: 'Controls who can access this entity'
},
{
name: 'publicPermissions',
type: 'multiselect',
label: 'Public Permissions',
required: false,
options: [
{ value: 'entity:read', label: 'Read entity metadata' },
{ value: 'items:read', label: 'Read items' },
{ value: 'items:form-*:create', label: 'Create items (any form)' }
],
description: 'Permissions granted to other tenants (only for public entities)',
conditionalDisplay: {
field: 'visibility',
operator: 'equals',
value: 'public'
}
},
{
name: 'fields',
type: 'json',
label: 'Fields',
required: true,
description: 'Array of field definitions',
schema: {
type: 'array',
items: {
type: 'object',
properties: {
name: { type: 'string' },
type: {
type: 'string',
enum: [
'text',
'textarea',
'number',
'date',
'select',
'multiselect',
'reference',
'json',
'user',
'boolean'
]
},
label: { type: 'string' },
required: { type: 'boolean' },
readOnly: { type: 'boolean' },
defaultValue: { type: 'any' },
options: { type: 'array' },
description: { type: 'string' }
},
required: ['name', 'type', 'label']
}
}
},
{
name: 'forms',
type: 'json',
label: 'Forms',
required: false,
description: 'Array of form definitions for creating/updating items',
schema: {
type: 'array',
items: {
type: 'object',
properties: {
id: { type: 'string' },
name: { type: 'string' },
description: { type: 'string' },
fields: { type: 'array' }
},
required: ['id', 'name', 'fields']
}
}
},
{
name: 'workflows',
type: 'json',
label: 'Workflows',
required: false,
description: 'Workflow state machine definitions',
schema: {
type: 'array',
items: {
type: 'object',
properties: {
fieldName: { type: 'string' },
states: { type: 'array' },
transitions: { type: 'array' }
},
required: ['fieldName', 'states', 'transitions']
}
}
},
{
name: 'isPublic',
type: 'boolean',
label: 'Is Public (deprecated)',
required: false,
defaultValue: false,
deprecated: true,
description: 'Legacy field - use visibility instead'
},
{
name: 'tenantId',
type: 'text',
label: 'Tenant ID',
required: true,
readOnly: true,
description: 'ID of the tenant that owns this entity'
},
{
name: 'createdBy',
type: 'user',
label: 'Created By',
required: true,
readOnly: true,
description: 'User who created this entity'
},
{
name: 'createdAt',
type: 'date',
label: 'Created At',
required: true,
readOnly: true,
description: 'Timestamp when entity was created'
},
{
name: 'updatedAt',
type: 'date',
label: 'Updated At',
required: true,
readOnly: true,
description: 'Timestamp when entity was last updated'
}
],
// Default permissions for entity operations (for reference only)
defaultPermissions: {
create: 'entity:create',
read: 'entity-*:read',
update: 'entity-{entityId}:update',
delete: 'entity-{entityId}:delete'
}
}
|