-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathfield.zod.ts
More file actions
262 lines (227 loc) · 10.2 KB
/
Copy pathfield.zod.ts
File metadata and controls
262 lines (227 loc) · 10.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
import { z } from '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',
// Selection
'select', // Static options
// Relational
'lookup', 'master_detail', // Dynamic reference to other objects
// Media
'image', 'file', 'avatar',
// Calculated / System
'formula', 'summary', 'autonumber',
// Enhanced Types
'location', // GPS coordinates
'address', // Structured address
'code', // Code with syntax highlighting
'color', // Color picker
'rating', // Star rating
'signature' // Digital signature
]);
export type FieldType = z.infer<typeof FieldType>;
/**
* Select Option Schema
*/
export const SelectOptionSchema = z.object({
label: z.string().describe('Display label'),
value: z.string().describe('Stored value'),
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'),
});
/**
* 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'),
});
/**
* Field Schema - Best Practice Enterprise Pattern
*/
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)'),
/** 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.any().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 */
reference: z.string().optional().describe('Target Object Name'),
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'),
formula: z.string().optional().describe('Deprecated: Use expression'),
summaryOperations: z.object({
object: z.string(),
field: z.string(),
function: z.enum(['count', 'sum', 'min', 'max', 'avg'])
}).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'),
/** Security & Visibility */
hidden: z.boolean().default(false).describe('Hidden from default UI'),
readonly: z.boolean().default(false).describe('Read-only in UI'),
encryption: z.boolean().default(false).describe('Encrypt at rest'),
/** 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>;
/**
* 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
*
* @example Old API (array first)
* Field.select(['High', 'Low'], { label: 'Priority' })
*
* @example New API (config object)
* Field.select({ options: [{label: 'High', value: 'high'}], label: 'Priority' })
*/
select: (optionsOrConfig: SelectOption[] | string[] | FieldInput & { options: SelectOption[] | string[] }, config?: FieldInput) => {
// 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: o } : o);
finalConfig = config || {};
} else {
// New signature: config object with options
options = (optionsOrConfig.options || []).map(o => typeof o === 'string' ? { label: o, value: o } : o);
// 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),
};