-
Notifications
You must be signed in to change notification settings - Fork 14
/
annotations.go
456 lines (388 loc) · 10.7 KB
/
annotations.go
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
package entrefine
import (
"entgo.io/ent/entc/gen"
"entgo.io/ent/schema"
)
// CodeFieldOptions code field is configurable
//
// **Example**
//
// ```go
//
// CodeFieldOptions{
// Language: "javascript"
// }
//
// ```
type CodeFieldOptions struct {
Language string `json:"Language,omitempty"`
}
// Action item related action
type Action struct {
Operation string `json:"Operation,omitempty"` // Operation of graphql
Fields []string `json:"Fields,omitempty"` // Fields to take after operation
Props map[string]any `json:"Props,omitempty"` // Props are directly passing to react component
Single bool `json:"Single"` // Show on single item
Bulk bool `json:"Bulk,omitempty"` // Show on bulk selected items
SuccessMessage string `json:"SuccessMessage,omitempty"` // Message on success
FailMessage string `json:"FailMessage,omitempty"` // Message on fail
CustomComponent string `json:"CustomComponent,omitempty"` // Custom component TODO: custom component
Description string `json:"Description,omitempty"` // Description of action
Label string `json:"Label,omitempty"` // Label of button
Icon string `json:"Icon,omitempty"` // Icon of button
OnList bool `json:"OnList,omitempty"` // Display on list
OnShow bool `json:"OnShow,omitempty"` // Display on show
OnEdit bool `json:"OnEdit,omitempty"` // Display on edit
}
var (
// EditAction standard edit action
EditAction = Action{
Operation: "Edit",
OnList: true,
OnShow: true,
}
// ShowAction standard show action
ShowAction = Action{
Operation: "Show",
OnList: true,
}
// DeleteAction standard delete action
DeleteAction = Action{
Operation: "Delete",
Label: "Delete",
Icon: "RA.Icons.DeleteOutlined",
OnList: true,
OnShow: true,
Bulk: true,
Props: map[string]any{
"danger": true,
},
}
)
// RefineAnnotation struct container of all annotations
type RefineAnnotation struct {
TitleField bool `json:"TitleField,omitempty"` // Mark field as title of entity
ImageField bool `json:"ImageField,omitempty"` // Mark field as image
MainImageField bool `json:"MainImageField,omitempty"` // Mark field as main image of entity
CodeField *CodeFieldOptions `json:"CodeField,omitempty"` // Mark field as code field
URLField bool `json:"URLField,omitempty"` // Mark field as url field
RichTextField bool `json:"RichTextField,omitempty"` // Mark field as rich text field
NoList bool `json:"NoList,omitempty"`
NoShow bool `json:"NoShow,omitempty"`
NoCreate bool `json:"NoCreate,omitempty"`
NoEdit bool `json:"NoEdit,omitempty"`
HideOnList bool `json:"HideOnList,omitempty"`
HideOnShow bool `json:"HideOnShow,omitempty"`
HideOnForm bool `json:"HideOnForm,omitempty"`
HideOnCreate bool `json:"HideOnCreate,omitempty"`
HideOnUpdate bool `json:"HideOnUpdate,omitempty"`
FilterOperator *string `json:"FilterOperator,omitempty"`
Icon *string `json:"Icon,omitempty"`
Label *string `json:"Label,omitempty"`
Description *string `json:"Description,omitempty"`
Prefix *string `json:"Prefix,omitempty"`
Suffix *string `json:"Suffix,omitempty"`
Actions []Action `json:"Actions,omitempty"`
View *string `json:"View,omitempty"`
ViewOnShow *string `json:"ViewOnShow,omitempty"`
ViewOnList *string `json:"ViewOnList,omitempty"`
ViewOnForm *string `json:"ViewOnForm,omitempty"`
Badge *string `json:"Badge,omitempty"`
EdgesDiagram *string `json:"EdgesDiagram,omitempty"`
}
// Merge implements the schema.Merger interface.
func (ra RefineAnnotation) Merge(other schema.Annotation) schema.Annotation {
var annotation RefineAnnotation
switch other := other.(type) {
case RefineAnnotation:
annotation = other
case *RefineAnnotation:
if other != nil {
annotation = *other
}
default:
return ra
}
if annotation.TitleField {
ra.TitleField = annotation.TitleField
}
if annotation.CodeField != nil {
ra.CodeField = annotation.CodeField
}
if annotation.TitleField {
ra.TitleField = annotation.TitleField
}
if annotation.URLField {
ra.URLField = annotation.URLField
}
if annotation.ImageField {
ra.ImageField = annotation.ImageField
}
if annotation.MainImageField {
ra.MainImageField = annotation.MainImageField
}
if annotation.RichTextField {
ra.RichTextField = annotation.RichTextField
}
if annotation.HideOnShow {
ra.HideOnList = annotation.HideOnList
}
if annotation.HideOnList {
ra.HideOnList = annotation.HideOnList
}
if annotation.HideOnForm {
ra.HideOnForm = annotation.HideOnForm
}
if annotation.HideOnCreate {
ra.HideOnCreate = annotation.HideOnCreate
}
if annotation.HideOnUpdate {
ra.HideOnUpdate = annotation.HideOnUpdate
}
if annotation.NoList {
ra.NoList = annotation.NoList
}
if annotation.NoShow {
ra.NoShow = annotation.NoShow
}
if annotation.NoCreate {
ra.NoCreate = annotation.NoCreate
}
if annotation.NoEdit {
ra.NoEdit = annotation.NoEdit
}
if annotation.FilterOperator != nil {
ra.FilterOperator = annotation.FilterOperator
}
if annotation.Label != nil {
ra.Label = annotation.Label
}
if annotation.Description != nil {
ra.Description = annotation.Description
}
if annotation.Icon != nil {
ra.Icon = annotation.Icon
}
if annotation.Prefix != nil {
ra.Prefix = annotation.Prefix
}
if annotation.Suffix != nil {
ra.Suffix = annotation.Suffix
}
if annotation.View != nil {
ra.View = annotation.View
}
if annotation.ViewOnList != nil {
ra.ViewOnList = annotation.ViewOnList
}
if annotation.ViewOnShow != nil {
ra.ViewOnShow = annotation.ViewOnShow
}
if annotation.Badge != nil {
ra.Badge = annotation.Badge
}
if len(annotation.Actions) > 0 {
ra.Actions = append(ra.Actions, annotation.Actions...)
}
if annotation.EdgesDiagram != nil {
ra.EdgesDiagram = annotation.EdgesDiagram
}
return ra
}
// Name annotation
func (ra RefineAnnotation) Name() string {
return "REFINE"
}
// Actions actions/buttons on list items
func Actions(actions ...Action) RefineAnnotation {
return RefineAnnotation{
Actions: actions,
}
}
// OnlyOnList show field only on list
func OnlyOnList() RefineAnnotation {
return RefineAnnotation{
HideOnList: false,
HideOnShow: true,
HideOnForm: true,
}
}
// OnlyOnForm show field only on form
func OnlyOnForm() RefineAnnotation {
return RefineAnnotation{
HideOnList: true,
HideOnShow: true,
HideOnForm: false,
}
}
// OnlyOnShow show field only on show page
func OnlyOnShow() RefineAnnotation {
return RefineAnnotation{
HideOnList: true,
HideOnShow: false,
HideOnForm: true,
}
}
// NoList disable entity browse, also hide from navigation
func NoList() RefineAnnotation {
return RefineAnnotation{
NoList: true,
}
}
// NoShow disable entity show page
func NoShow() RefineAnnotation {
return RefineAnnotation{
NoShow: true,
}
}
// NoCreate disable entity creation form
func NoCreate() RefineAnnotation {
return RefineAnnotation{
NoCreate: true,
}
}
// NoEdit disable entity edit form
func NoEdit() RefineAnnotation {
return RefineAnnotation{
NoEdit: true,
}
}
// HideOnList hide field on list
func HideOnList() RefineAnnotation {
return RefineAnnotation{
HideOnList: true,
}
}
// HideOnShow hide field on show page
func HideOnShow() RefineAnnotation {
return RefineAnnotation{
HideOnShow: true,
}
}
// HideOnForm hide field on form
func HideOnForm() RefineAnnotation {
return RefineAnnotation{
HideOnForm: true,
}
}
// HideOnCreate hide field on form
func HideOnCreate() RefineAnnotation {
return RefineAnnotation{
HideOnCreate: true,
}
}
// HideOnUpdate hide field on form
func HideOnUpdate() RefineAnnotation {
return RefineAnnotation{
HideOnUpdate: true,
}
}
// TitleField mark field as a title field
func TitleField() RefineAnnotation {
return RefineAnnotation{
TitleField: true,
}
}
// ImageField mark field as an image field
func ImageField() RefineAnnotation {
return RefineAnnotation{
ImageField: true,
}
}
// MainImageField mark field as a main image field
func MainImageField() RefineAnnotation {
return RefineAnnotation{
MainImageField: true,
ImageField: true,
}
}
// RichTextField mark field as a rich text field (wysiwyg editor)
func RichTextField() RefineAnnotation {
return RefineAnnotation{
RichTextField: true,
}
}
// CodeField mark field as a code field
func CodeField(config *CodeFieldOptions) RefineAnnotation {
return RefineAnnotation{
CodeField: config,
}
}
// URLField mark field as an url field
func URLField() RefineAnnotation {
return RefineAnnotation{
URLField: true,
}
}
// Icon define icon of entity that will be shown on navigations, breadcrumbs e.t.c.
func Icon(icon string) RefineAnnotation {
return RefineAnnotation{
Icon: &icon,
}
}
// Label define label of field
// todo: implement generator
func Label(label string) RefineAnnotation {
return RefineAnnotation{
Label: &label,
}
}
// Description define description of field/entity
// todo: implement generator
func Description(description string) RefineAnnotation {
return RefineAnnotation{
Label: &description,
}
}
// Prefix add prefix to value of field
// todo: implement generator
func Prefix(prefix string) RefineAnnotation {
return RefineAnnotation{
Prefix: &prefix,
}
}
// Suffix add suffix to value of field
func Suffix(suffix string) RefineAnnotation {
return RefineAnnotation{
Prefix: &suffix,
}
}
// View define field views on list and show
func View(name string) RefineAnnotation {
return RefineAnnotation{
View: &name,
ViewOnList: &name,
ViewOnShow: &name,
}
}
// ViewOnList define field view on list
func ViewOnList(name string) RefineAnnotation {
return RefineAnnotation{
ViewOnList: &name,
}
}
// ViewOnShow define field view on show page
func ViewOnShow(name string) RefineAnnotation {
return RefineAnnotation{
ViewOnShow: &name,
}
}
// ViewOnForm define field view on form
func ViewOnForm(name string) RefineAnnotation {
return RefineAnnotation{
ViewOnForm: &name,
}
}
// Badge define entity badge view
func Badge(name string) RefineAnnotation {
return RefineAnnotation{
Badge: &name,
}
}
// FilterOperator define entity field filter operator
func FilterOperator(operator gen.Op) RefineAnnotation {
opName := operator.Name()
return RefineAnnotation{
FilterOperator: &opName,
}
}