-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathfield.zod.ts
More file actions
660 lines (588 loc) · 28.2 KB
/
field.zod.ts
File metadata and controls
660 lines (588 loc) · 28.2 KB
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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
import { z } from 'zod';
import { SystemIdentifierSchema } from '../shared/identifiers.zod';
import { EncryptionConfigSchema } from '../system/encryption.zod';
import { MaskingRuleSchema } from '../system/masking.zod';
/**
* Field Type Enum
*/
export const FieldType = z.enum([
// Core Text
'text', 'textarea', 'email', 'url', 'phone', 'password',
// Rich Content
'markdown', 'html', 'richtext',
// Numbers
'number', 'currency', 'percent',
// Date & Time
'date', 'datetime', 'time',
// Logic
'boolean', 'toggle', // Toggle is a distinct UI from checkbox
// Selection
'select', // Single select dropdown
'multiselect', // Multi select (often tags)
'radio', // Radio group
'checkboxes', // Checkbox group
// Relational
'lookup', 'master_detail', // Dynamic reference
'tree', // Hierarchical reference
// Media
'image', 'file', 'avatar', 'video', 'audio',
// Calculated / System
'formula', 'summary', 'autonumber',
// Enhanced Types
'location', // GPS coordinates
'address', // Structured address
'code', // Code editor (JSON/SQL/JS)
'json', // Structured JSON data
'color', // Color picker
'rating', // Star rating
'slider', // Numeric slider
'signature', // Digital signature
'qrcode', // QR code / Barcode
'progress', // Progress bar
'tags', // Simple tag list
// AI/ML Types
'vector', // Vector embeddings for AI/ML (semantic search, RAG)
]);
export type FieldType = z.infer<typeof FieldType>;
/**
* Select Option Schema
*
* Defines option values for select/picklist fields.
*
* **CRITICAL RULE**: The `value` field is a machine identifier that gets stored in the database.
* It MUST be lowercase to avoid case-sensitivity issues in queries and comparisons.
*
* @example Good
* { label: 'New', value: 'new' }
* { label: 'In Progress', value: 'in_progress' }
* { label: 'Closed Won', value: 'closed_won' }
*
* @example Bad (will be rejected)
* { label: 'New', value: 'New' } // uppercase
* { label: 'In Progress', value: 'In Progress' } // spaces and uppercase
* { label: 'Closed Won', value: 'Closed_Won' } // mixed case
*/
export const SelectOptionSchema = z.object({
label: z.string().describe('Display label (human-readable, any case allowed)'),
value: SystemIdentifierSchema.describe('Stored value (lowercase machine identifier)'),
color: z.string().optional().describe('Color code for badges/charts'),
default: z.boolean().optional().describe('Is default option'),
});
/**
* Location Coordinates Schema
* GPS coordinates for location field type
*/
export const LocationCoordinatesSchema = z.object({
latitude: z.number().min(-90).max(90).describe('Latitude coordinate'),
longitude: z.number().min(-180).max(180).describe('Longitude coordinate'),
altitude: z.number().optional().describe('Altitude in meters'),
accuracy: z.number().optional().describe('Accuracy in meters'),
});
/**
* Currency Configuration Schema
* Configuration for currency field type supporting multi-currency
*
* Note: Currency codes are validated by length only (3 characters) to support:
* - Standard ISO 4217 codes (USD, EUR, CNY, etc.)
* - Cryptocurrency codes (BTC, ETH, etc.)
* - Custom business-specific codes
* Stricter validation can be implemented at the application layer based on business requirements.
*/
export const CurrencyConfigSchema = z.object({
precision: z.number().int().min(0).max(10).default(2).describe('Decimal precision (default: 2)'),
currencyMode: z.enum(['dynamic', 'fixed']).default('dynamic').describe('Currency mode: dynamic (user selectable) or fixed (single currency)'),
defaultCurrency: z.string().length(3).default('CNY').describe('Default or fixed currency code (ISO 4217, e.g., USD, CNY, EUR)'),
});
/**
* Currency Value Schema
* Runtime value structure for currency fields
*
* Note: Currency codes are validated by length only (3 characters) to support flexibility.
* See CurrencyConfigSchema for details on currency code validation strategy.
*/
export const CurrencyValueSchema = z.object({
value: z.number().describe('Monetary amount'),
currency: z.string().length(3).describe('Currency code (ISO 4217)'),
});
/**
* Address Schema
* Structured address for address field type
*/
export const AddressSchema = z.object({
street: z.string().optional().describe('Street address'),
city: z.string().optional().describe('City name'),
state: z.string().optional().describe('State/Province'),
postalCode: z.string().optional().describe('Postal/ZIP code'),
country: z.string().optional().describe('Country name or code'),
countryCode: z.string().optional().describe('ISO country code (e.g., US, GB)'),
formatted: z.string().optional().describe('Formatted address string'),
});
/**
* Vector Configuration Schema
* Configuration for vector field type supporting AI/ML embeddings
*
* Vector fields store numerical embeddings for semantic search, similarity matching,
* and Retrieval-Augmented Generation (RAG) workflows.
*
* @example
* // Text embeddings for semantic search
* {
* dimensions: 1536, // OpenAI text-embedding-ada-002
* distanceMetric: 'cosine',
* indexed: true
* }
*
* @example
* // Image embeddings with normalization
* {
* dimensions: 512, // ResNet-50
* distanceMetric: 'euclidean',
* normalized: true,
* indexed: true
* }
*/
export const VectorConfigSchema = z.object({
dimensions: z.number().int().min(1).max(10000).describe('Vector dimensionality (e.g., 1536 for OpenAI embeddings)'),
distanceMetric: z.enum(['cosine', 'euclidean', 'dotProduct', 'manhattan']).default('cosine').describe('Distance/similarity metric for vector search'),
normalized: z.boolean().default(false).describe('Whether vectors are normalized (unit length)'),
indexed: z.boolean().default(true).describe('Whether to create a vector index for fast similarity search'),
indexType: z.enum(['hnsw', 'ivfflat', 'flat']).optional().describe('Vector index algorithm (HNSW for high accuracy, IVFFlat for large datasets)'),
});
/**
* File Attachment Configuration Schema
* Configuration for file and attachment field types
*
* Provides comprehensive file upload capabilities with:
* - File type restrictions (allowed/blocked)
* - File size limits (min/max)
* - Virus scanning integration
* - Storage provider integration
* - Image-specific features (dimensions, thumbnails)
*
* @example Basic file upload with size limit
* {
* maxSize: 10485760, // 10MB
* allowedTypes: ['.pdf', '.docx', '.xlsx'],
* virusScan: true
* }
*
* @example Image upload with validation
* {
* maxSize: 5242880, // 5MB
* allowedTypes: ['.jpg', '.jpeg', '.png', '.webp'],
* imageValidation: {
* maxWidth: 4096,
* maxHeight: 4096,
* generateThumbnails: true
* }
* }
*/
export const FileAttachmentConfigSchema = z.object({
/** File Size Limits */
minSize: z.number().min(0).optional().describe('Minimum file size in bytes'),
maxSize: z.number().min(1).optional().describe('Maximum file size in bytes (e.g., 10485760 = 10MB)'),
/** File Type Restrictions */
allowedTypes: z.array(z.string()).optional().describe('Allowed file extensions (e.g., [".pdf", ".docx", ".jpg"])'),
blockedTypes: z.array(z.string()).optional().describe('Blocked file extensions (e.g., [".exe", ".bat", ".sh"])'),
allowedMimeTypes: z.array(z.string()).optional().describe('Allowed MIME types (e.g., ["image/jpeg", "application/pdf"])'),
blockedMimeTypes: z.array(z.string()).optional().describe('Blocked MIME types'),
/** Virus Scanning */
virusScan: z.boolean().default(false).describe('Enable virus scanning for uploaded files'),
virusScanProvider: z.enum(['clamav', 'virustotal', 'metadefender', 'custom']).optional().describe('Virus scanning service provider'),
virusScanOnUpload: z.boolean().default(true).describe('Scan files immediately on upload'),
quarantineOnThreat: z.boolean().default(true).describe('Quarantine files if threat detected'),
/** Storage Configuration */
storageProvider: z.string().optional().describe('Object storage provider name (references ObjectStorageConfig)'),
storageBucket: z.string().optional().describe('Target bucket name'),
storagePrefix: z.string().optional().describe('Storage path prefix (e.g., "uploads/documents/")'),
/** Image-Specific Validation */
imageValidation: z.object({
minWidth: z.number().min(1).optional().describe('Minimum image width in pixels'),
maxWidth: z.number().min(1).optional().describe('Maximum image width in pixels'),
minHeight: z.number().min(1).optional().describe('Minimum image height in pixels'),
maxHeight: z.number().min(1).optional().describe('Maximum image height in pixels'),
aspectRatio: z.string().optional().describe('Required aspect ratio (e.g., "16:9", "1:1")'),
generateThumbnails: z.boolean().default(false).describe('Auto-generate thumbnails'),
thumbnailSizes: z.array(z.object({
name: z.string().describe('Thumbnail variant name (e.g., "small", "medium", "large")'),
width: z.number().min(1).describe('Thumbnail width in pixels'),
height: z.number().min(1).describe('Thumbnail height in pixels'),
crop: z.boolean().default(false).describe('Crop to exact dimensions'),
})).optional().describe('Thumbnail size configurations'),
preserveMetadata: z.boolean().default(false).describe('Preserve EXIF metadata'),
autoRotate: z.boolean().default(true).describe('Auto-rotate based on EXIF orientation'),
}).optional().describe('Image-specific validation rules'),
/** Upload Behavior */
allowMultiple: z.boolean().default(false).describe('Allow multiple file uploads (overrides field.multiple)'),
allowReplace: z.boolean().default(true).describe('Allow replacing existing files'),
allowDelete: z.boolean().default(true).describe('Allow deleting uploaded files'),
requireUpload: z.boolean().default(false).describe('Require at least one file when field is required'),
/** Metadata Extraction */
extractMetadata: z.boolean().default(true).describe('Extract file metadata (name, size, type, etc.)'),
extractText: z.boolean().default(false).describe('Extract text content from documents (OCR/parsing)'),
/** Versioning */
versioningEnabled: z.boolean().default(false).describe('Keep previous versions of replaced files'),
maxVersions: z.number().min(1).optional().describe('Maximum number of versions to retain'),
/** Access Control */
publicRead: z.boolean().default(false).describe('Allow public read access to uploaded files'),
presignedUrlExpiry: z.number().min(60).max(604800).default(3600).describe('Presigned URL expiration in seconds (default: 1 hour)'),
}).refine((data) => {
// Validate minSize is less than or equal to maxSize
if (data.minSize !== undefined && data.maxSize !== undefined && data.minSize > data.maxSize) {
return false;
}
return true;
}, {
message: 'minSize must be less than or equal to maxSize',
}).refine((data) => {
// Validate virusScanProvider requires virusScan to be enabled
if (data.virusScanProvider !== undefined && data.virusScan !== true) {
return false;
}
return true;
}, {
message: 'virusScanProvider requires virusScan to be enabled',
});
/**
* Data Quality Rules Schema
* Defines data quality validation and monitoring for fields
*
* @example Unique SSN field with completeness requirement
* {
* uniqueness: true,
* completeness: 0.95, // 95% of records must have this field
* accuracy: {
* source: 'government_db',
* threshold: 0.98
* }
* }
*/
export const DataQualityRulesSchema = z.object({
/** Enforce uniqueness constraint */
uniqueness: z.boolean().default(false).describe('Enforce unique values across all records'),
/** Completeness ratio (0-1) indicating minimum percentage of non-null values */
completeness: z.number().min(0).max(1).default(0).describe('Minimum ratio of non-null values (0-1, default: 0 = no requirement)'),
/** Accuracy validation against authoritative source */
accuracy: z.object({
source: z.string().describe('Reference data source for validation (e.g., "api.verify.com", "master_data")'),
threshold: z.number().min(0).max(1).describe('Minimum accuracy threshold (0-1, e.g., 0.95 = 95% match required)'),
}).optional().describe('Accuracy validation configuration'),
});
/**
* Computed Field Caching Schema
* Configuration for caching computed/formula field results
*
* @example Cache product price with 1-hour TTL, invalidate on inventory changes
* {
* enabled: true,
* ttl: 3600,
* invalidateOn: ['inventory.quantity', 'pricing.discount']
* }
*/
export const ComputedFieldCacheSchema = z.object({
/** Enable caching for this computed field */
enabled: z.boolean().describe('Enable caching for computed field results'),
/** Time-to-live in seconds */
ttl: z.number().min(0).describe('Cache TTL in seconds (0 = no expiration)'),
/** Array of field paths that trigger cache invalidation when changed */
invalidateOn: z.array(z.string()).describe('Field paths that invalidate cache (e.g., ["inventory.quantity", "pricing.base_price"])'),
});
/**
* Field Schema - Best Practice Enterprise Pattern
*/
/**
* Field Definition Schema
* Defines the properties, type, and behavior of a single field (column) on an object.
*
* @example Lookup Field
* {
* name: "account_id",
* label: "Account",
* type: "lookup",
* reference: "accounts",
* required: true
* }
*
* @example Select Field
* {
* name: "status",
* label: "Status",
* type: "select",
* options: [
* { label: "Open", value: "open" },
* { label: "Closed", value: "closed" }
* ],
* defaultValue: "open"
* }
*/
export const FieldSchema = z.object({
/** Identity */
name: z.string().regex(/^[a-z_][a-z0-9_]*$/).describe('Machine name (snake_case)').optional(),
label: z.string().optional().describe('Human readable label'),
type: FieldType.describe('Field Data Type'),
description: z.string().optional().describe('Tooltip/Help text'),
format: z.string().optional().describe('Format string (e.g. email, phone)'),
/** Storage Layer Mapping */
columnName: z.string().optional().describe('Physical column name in the target datasource. Defaults to the field key when not set.'),
/** Database Constraints */
required: z.boolean().default(false).describe('Is required'),
searchable: z.boolean().default(false).describe('Is searchable'),
multiple: z.boolean().default(false).describe('Allow multiple values (Stores as Array/JSON). Applicable for select, lookup, file, image.'),
unique: z.boolean().default(false).describe('Is unique constraint'),
defaultValue: z.unknown().optional().describe('Default value'),
/** Text/String Constraints */
maxLength: z.number().optional().describe('Max character length'),
minLength: z.number().optional().describe('Min character length'),
/** Number Constraints */
precision: z.number().optional().describe('Total digits'),
scale: z.number().optional().describe('Decimal places'),
min: z.number().optional().describe('Minimum value'),
max: z.number().optional().describe('Maximum value'),
/** Selection Options */
options: z.array(SelectOptionSchema).optional().describe('Static options for select/multiselect'),
/**
* Relationship Config
*
* Used by `lookup` and `master_detail` field types to define cross-object references.
* The `reference` property is **required** for these types — it identifies the target
* object whose records this field links to. The engine uses `reference` during $expand
* post-processing to resolve foreign key IDs into full related objects via batch queries.
*
* For `master_detail` fields, the parent record controls the lifecycle of child records
* (e.g., cascade delete). For `lookup` fields, the reference is a soft link.
*/
reference: z.string().optional().describe(
'Target object name (snake_case) for lookup/master_detail fields. '
+ 'Required for relationship types. Used by $expand to resolve foreign key IDs into full objects.'
),
referenceFilters: z.array(z.string()).optional().describe('Filters applied to lookup dialogs (e.g. "active = true")'),
writeRequiresMasterRead: z.boolean().optional().describe('If true, user needs read access to master record to edit this field'),
deleteBehavior: z.enum(['set_null', 'cascade', 'restrict']).optional().default('set_null').describe('What happens if referenced record is deleted'),
/** Calculation */
expression: z.string().optional().describe('Formula expression'),
summaryOperations: z.object({
object: z.string().describe('Source child object name for roll-up'),
field: z.string().describe('Field on child object to aggregate'),
function: z.enum(['count', 'sum', 'min', 'max', 'avg']).describe('Aggregation function to apply'),
}).optional().describe('Roll-up summary definition'),
/** Enhanced Field Type Configurations */
// Code field config
language: z.string().optional().describe('Programming language for syntax highlighting (e.g., javascript, python, sql)'),
theme: z.string().optional().describe('Code editor theme (e.g., dark, light, monokai)'),
lineNumbers: z.boolean().optional().describe('Show line numbers in code editor'),
// Rating field config
maxRating: z.number().optional().describe('Maximum rating value (default: 5)'),
allowHalf: z.boolean().optional().describe('Allow half-star ratings'),
// Location field config
displayMap: z.boolean().optional().describe('Display map widget for location field'),
allowGeocoding: z.boolean().optional().describe('Allow address-to-coordinate conversion'),
// Address field config
addressFormat: z.enum(['us', 'uk', 'international']).optional().describe('Address format template'),
// Color field config
colorFormat: z.enum(['hex', 'rgb', 'rgba', 'hsl']).optional().describe('Color value format'),
allowAlpha: z.boolean().optional().describe('Allow transparency/alpha channel'),
presetColors: z.array(z.string()).optional().describe('Preset color options'),
// Slider field config
step: z.number().optional().describe('Step increment for slider (default: 1)'),
showValue: z.boolean().optional().describe('Display current value on slider'),
marks: z.record(z.string(), z.string()).optional().describe('Custom marks/labels at specific values (e.g., {0: "Low", 50: "Medium", 100: "High"})'),
// QR Code / Barcode field config
// Note: qrErrorCorrection is only applicable when barcodeFormat='qr'
// Runtime validation should enforce this constraint
barcodeFormat: z.enum(['qr', 'ean13', 'ean8', 'code128', 'code39', 'upca', 'upce']).optional().describe('Barcode format type'),
qrErrorCorrection: z.enum(['L', 'M', 'Q', 'H']).optional().describe('QR code error correction level (L=7%, M=15%, Q=25%, H=30%). Only applicable when barcodeFormat is "qr"'),
displayValue: z.boolean().optional().describe('Display human-readable value below barcode/QR code'),
allowScanning: z.boolean().optional().describe('Enable camera scanning for barcode/QR code input'),
// Currency field config
currencyConfig: CurrencyConfigSchema.optional().describe('Configuration for currency field type'),
// Vector field config
vectorConfig: VectorConfigSchema.optional().describe('Configuration for vector field type (AI/ML embeddings)'),
// File attachment field config
fileAttachmentConfig: FileAttachmentConfigSchema.optional().describe('Configuration for file and attachment field types'),
/** Enhanced Security & Compliance */
// Encryption configuration
encryptionConfig: EncryptionConfigSchema.optional().describe('Field-level encryption configuration for sensitive data (GDPR/HIPAA/PCI-DSS)'),
// Data masking rules
maskingRule: MaskingRuleSchema.optional().describe('Data masking rules for PII protection'),
// Audit trail
auditTrail: z.boolean().default(false).describe('Enable detailed audit trail for this field (tracks all changes with user and timestamp)'),
/** Field Dependencies & Relationships */
// Field dependencies
dependencies: z.array(z.string()).optional().describe('Array of field names that this field depends on (for formulas, visibility rules, etc.)'),
/** Computed Field Optimization */
// Computed field caching
cached: ComputedFieldCacheSchema.optional().describe('Caching configuration for computed/formula fields'),
/** Data Quality & Governance */
// Data quality rules
dataQuality: DataQualityRulesSchema.optional().describe('Data quality validation and monitoring rules'),
/** Layout & Grouping */
group: z.string().optional().describe('Field group name for organizing fields in forms and layouts (e.g., "contact_info", "billing", "system")'),
/** Conditional Requirements */
conditionalRequired: z.string().optional().describe('Formula expression that makes this field required when TRUE (e.g., "status = \'closed_won\'")'),
/** Security & Visibility */
hidden: z.boolean().default(false).describe('Hidden from default UI'),
readonly: z.boolean().default(false).describe('Read-only in UI'),
sortable: z.boolean().optional().default(true).describe('Whether field is sortable in list views'),
inlineHelpText: z.string().optional().describe('Help text displayed below the field in forms'),
trackFeedHistory: z.boolean().optional().describe('Track field changes in Chatter/activity feed (Salesforce pattern)'),
caseSensitive: z.boolean().optional().describe('Whether text comparisons are case-sensitive'),
autonumberFormat: z.string().optional().describe('Auto-number display format pattern (e.g., "CASE-{0000}")'),
/** Indexing */
index: z.boolean().default(false).describe('Create standard database index'),
externalId: z.boolean().default(false).describe('Is external ID for upsert operations'),
});
export type Field = z.infer<typeof FieldSchema>;
export type SelectOption = z.infer<typeof SelectOptionSchema>;
export type LocationCoordinates = z.infer<typeof LocationCoordinatesSchema>;
export type Address = z.infer<typeof AddressSchema>;
export type CurrencyConfig = z.infer<typeof CurrencyConfigSchema>;
export type CurrencyConfigInput = z.input<typeof CurrencyConfigSchema>;
export type CurrencyValue = z.infer<typeof CurrencyValueSchema>;
export type VectorConfig = z.infer<typeof VectorConfigSchema>;
export type VectorConfigInput = z.input<typeof VectorConfigSchema>;
export type FileAttachmentConfig = z.infer<typeof FileAttachmentConfigSchema>;
export type FileAttachmentConfigInput = z.input<typeof FileAttachmentConfigSchema>;
export type DataQualityRules = z.infer<typeof DataQualityRulesSchema>;
export type DataQualityRulesInput = z.input<typeof DataQualityRulesSchema>;
export type ComputedFieldCache = z.infer<typeof ComputedFieldCacheSchema>;
/**
* Field Factory Helper
*/
export type FieldInput = Omit<Partial<Field>, 'type'>;
export const Field = {
text: (config: FieldInput = {}) => ({ type: 'text', ...config } as const),
textarea: (config: FieldInput = {}) => ({ type: 'textarea', ...config } as const),
number: (config: FieldInput = {}) => ({ type: 'number', ...config } as const),
boolean: (config: FieldInput = {}) => ({ type: 'boolean', ...config } as const),
date: (config: FieldInput = {}) => ({ type: 'date', ...config } as const),
datetime: (config: FieldInput = {}) => ({ type: 'datetime', ...config } as const),
currency: (config: FieldInput = {}) => ({ type: 'currency', ...config } as const),
percent: (config: FieldInput = {}) => ({ type: 'percent', ...config } as const),
url: (config: FieldInput = {}) => ({ type: 'url', ...config } as const),
email: (config: FieldInput = {}) => ({ type: 'email', ...config } as const),
phone: (config: FieldInput = {}) => ({ type: 'phone', ...config } as const),
image: (config: FieldInput = {}) => ({ type: 'image', ...config } as const),
file: (config: FieldInput = {}) => ({ type: 'file', ...config } as const),
avatar: (config: FieldInput = {}) => ({ type: 'avatar', ...config } as const),
formula: (config: FieldInput = {}) => ({ type: 'formula', ...config } as const),
summary: (config: FieldInput = {}) => ({ type: 'summary', ...config } as const),
autonumber: (config: FieldInput = {}) => ({ type: 'autonumber', ...config } as const),
markdown: (config: FieldInput = {}) => ({ type: 'markdown', ...config } as const),
html: (config: FieldInput = {}) => ({ type: 'html', ...config } as const),
password: (config: FieldInput = {}) => ({ type: 'password', ...config } as const),
/**
* Select field helper with backward-compatible API
*
* Automatically converts option values to lowercase to enforce naming conventions.
*
* @example Old API (array first) - auto-converts to lowercase
* Field.select(['High', 'Low'], { label: 'Priority' })
* // Results in: [{ label: 'High', value: 'high' }, { label: 'Low', value: 'low' }]
*
* @example New API (config object) - enforces lowercase
* Field.select({ options: [{label: 'High', value: 'high'}], label: 'Priority' })
*
* @example Multi-word values - converts to snake_case
* Field.select(['In Progress', 'Closed Won'], { label: 'Status' })
* // Results in: [{ label: 'In Progress', value: 'in_progress' }, { label: 'Closed Won', value: 'closed_won' }]
*/
select: (optionsOrConfig: SelectOption[] | string[] | FieldInput & { options: SelectOption[] | string[] }, config?: FieldInput) => {
// Helper function to convert string to lowercase snake_case
const toSnakeCase = (str: string): string => {
return str
.toLowerCase()
.replace(/\s+/g, '_') // Replace spaces with underscores
.replace(/[^a-z0-9_]/g, ''); // Remove invalid characters (keeping underscores only)
};
// Support both old and new signatures:
// Old: Field.select(['a', 'b'], { label: 'X' })
// New: Field.select({ options: [{label: 'A', value: 'a'}], label: 'X' })
let options: SelectOption[];
let finalConfig: FieldInput;
if (Array.isArray(optionsOrConfig)) {
// Old signature: array as first param
options = optionsOrConfig.map(o =>
typeof o === 'string'
? { label: o, value: toSnakeCase(o) } // Auto-convert string to snake_case
: { ...o, value: o.value.toLowerCase() } // Ensure value is lowercase
);
finalConfig = config || {};
} else {
// New signature: config object with options
options = (optionsOrConfig.options || []).map(o =>
typeof o === 'string'
? { label: o, value: toSnakeCase(o) } // Auto-convert string to snake_case
: { ...o, value: o.value.toLowerCase() } // Ensure value is lowercase
);
// Remove options from config to avoid confusion
const { options: _, ...restConfig } = optionsOrConfig;
finalConfig = restConfig;
}
return { type: 'select', options, ...finalConfig } as const;
},
lookup: (reference: string, config: FieldInput = {}) => ({
type: 'lookup',
reference,
...config
} as const),
masterDetail: (reference: string, config: FieldInput = {}) => ({
type: 'master_detail',
reference,
...config
} as const),
// Enhanced Field Type Helpers
location: (config: FieldInput = {}) => ({
type: 'location',
...config
} as const),
address: (config: FieldInput = {}) => ({
type: 'address',
...config
} as const),
richtext: (config: FieldInput = {}) => ({
type: 'richtext',
...config
} as const),
code: (language?: string, config: FieldInput = {}) => ({
type: 'code',
language,
...config
} as const),
color: (config: FieldInput = {}) => ({
type: 'color',
...config
} as const),
rating: (maxRating: number = 5, config: FieldInput = {}) => ({
type: 'rating',
maxRating,
...config
} as const),
signature: (config: FieldInput = {}) => ({
type: 'signature',
...config
} as const),
slider: (config: FieldInput = {}) => ({
type: 'slider',
...config
} as const),
qrcode: (config: FieldInput = {}) => ({
type: 'qrcode',
...config
} as const),
json: (config: FieldInput = {}) => ({
type: 'json',
...config
} as const),
vector: (dimensions: number, config: FieldInput = {}) => ({
type: 'vector',
vectorConfig: {
dimensions,
distanceMetric: 'cosine' as const,
normalized: false,
indexed: true,
...config.vectorConfig
},
...config
} as const),
};