@docupace/ihub-config 1.1.12 → 1.1.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,367 +1,367 @@
1
- interface IField {
2
- defaultValue: String
3
- hidden: Boolean
4
- label: String
5
- name: String!
6
- path: String!
7
- readonly: Boolean
8
- required: Boolean
9
- requiredCondition: String
10
- skipQuery: Boolean
11
- excludeFromQueryInput: Boolean
12
- visibilityCondition: String
13
- disabledCondition: String
14
- }
15
-
16
- interface IDateRangeField {
17
- defaultValue: [String] # [startDate, endDate]
18
- defaultValueExpressions: [String] # [startDate, endDate]
19
- format: String
20
- hidden: Boolean
21
- label: String
22
- name: String!
23
- paths: [String!]!
24
- readonly: Boolean
25
- required: Boolean
26
- requiredCondition: String
27
- skipQuery: Boolean
28
- excludeFromQueryInput: Boolean
29
- visibilityCondition: String
30
- disabledCondition: String
31
- }
32
-
33
- type InputField implements IField & IRowElement & IElement {
34
- cols: Int
35
- defaultValue: String
36
- helperText: String
37
- hidden: Boolean
38
- label: String
39
- masking: FieldMasking
40
- maxLength: Int
41
- minLength: Int
42
- name: String!
43
- path: String!
44
- placeholder: String
45
- readonly: Boolean
46
- required: Boolean
47
- requiredCondition: String
48
- skipQuery: Boolean
49
- excludeFromQueryInput: Boolean
50
- startAdornment: String
51
- type: FieldValueType
52
- validation: InputValidation
53
- visibilityCondition: String
54
- disabledCondition: String
55
- skipDirtyCheck: Boolean
56
- # Start of text area configuration, see https://mui.com/material-ui/react-text-field/#multiline
57
- multiline: Boolean # optional if at least one other text area parameter is provided
58
- rows: Int
59
- maxRows: Int
60
- minRows: Int
61
- # End of text area configuration
62
- }
63
-
64
- type CustomValidator implements IRowElement & IElement {
65
- validationRule: String
66
- errorMessage: String
67
- paths: [String!]!
68
- }
69
-
70
- union Fields = InputField | PhoneField | DateField | DateRangeField | SelectField | ToggleField | BooleanField | TextElement
71
-
72
- type ItemValidation {
73
- type: String!
74
- fields: [String!]!
75
- errorMessage: String
76
- }
77
-
78
- type RepeaterField implements IRowElement & IElement {
79
- path: String!
80
- title: String
81
- label: String
82
- buttonLabel: String
83
- required: Boolean
84
- skipId: Boolean
85
- fields: [Fields!]!
86
- visibilityCondition: String
87
- maxFields: String
88
- validateUnique: Boolean
89
- duplicateMessage: String
90
- itemValidation: ItemValidation
91
- }
92
-
93
- type ControlGroup implements IRowElement & IElement {
94
- path: String!
95
- title: String
96
- skipId: Boolean
97
- controlOptions: ISelectOptions!
98
- fields: [Fields!]!
99
- }
100
-
101
- type PhoneField implements IField & IRowElement & IElement {
102
- cols: Int
103
- defaultValue: String
104
- hidden: Boolean
105
- label: String
106
- name: String!
107
- path: String!
108
- placeholder: String
109
- readonly: Boolean
110
- required: Boolean
111
- requiredCondition: String
112
- skipQuery: Boolean
113
- excludeFromQueryInput: Boolean
114
- visibilityCondition: String
115
- disabledCondition: String
116
- }
117
-
118
- type DateField implements IField & IRowElement & IElement {
119
- cols: Int
120
- defaultValue: String
121
- hidden: Boolean
122
- label: String
123
- name: String!
124
- path: String!
125
- readonly: Boolean
126
- required: Boolean
127
- requiredCondition: String
128
- skipQuery: Boolean
129
- excludeFromQueryInput: Boolean
130
- visibilityCondition: String
131
- disabledCondition: String
132
- minDate: String # e.q. "now" or "2025-03-20"
133
- maxDate: String # e.q. "now" or "2025-03-20"
134
- }
135
-
136
- type DateRangeField implements IDateRangeField & IRowElement & IElement {
137
- cols: Int
138
- defaultValue: [String!] # [startDate, endDate]
139
- defaultValueExpressions: [String!] # [startDate, endDate]
140
- format: String
141
- hidden: Boolean
142
- label: String
143
- name: String!
144
- paths: [String!]!
145
- readonly: Boolean
146
- required: Boolean
147
- requiredCondition: String
148
- skipQuery: Boolean
149
- excludeFromQueryInput: Boolean
150
- visibilityCondition: String
151
- disabledCondition: String
152
- }
153
-
154
- type SelectField implements IField & IRowElement & IElement {
155
- cols: Int
156
- defaultValue: String
157
- defaultValuePath: String
158
- disableClearable: Boolean
159
- hidden: Boolean
160
- label: String
161
- multiple: Boolean
162
- name: String!
163
- path: String!
164
- placeholder: String
165
- readonly: Boolean
166
- required: Boolean
167
- requiredCondition: String
168
- selectOptions: ISelectOptions!
169
- skipQuery: Boolean
170
- excludeFromQueryInput: Boolean
171
- visibilityCondition: String
172
- disabledCondition: String
173
- excludeId: Boolean
174
- helperText: String
175
- autoSelectSingleOption: Boolean
176
- }
177
-
178
- type ToggleField implements IField & IRowElement & IElement {
179
- cols: Int
180
- defaultValue: String
181
- disableClearable: Boolean
182
- hidden: Boolean
183
- label: String
184
- multiple: Boolean
185
- name: String!
186
- path: String!
187
- readonly: Boolean
188
- required: Boolean
189
- requiredCondition: String
190
- selectOptions: ISelectOptions!
191
- size: String # see https://mui.com/material-ui/react-toggle-button/#size
192
- skipQuery: Boolean
193
- excludeFromQueryInput: Boolean
194
- visibilityCondition: String
195
- disabledCondition: String
196
- linkedFields: [String!]
197
- }
198
-
199
- type BooleanField implements IField & IRowElement & IElement {
200
- cols: Int
201
- defaultValue: String
202
- hidden: Boolean
203
- label: String
204
- name: String!
205
- path: String!
206
- readonly: Boolean
207
- required: Boolean
208
- requiredCondition: String
209
- skipQuery: Boolean
210
- excludeFromQueryInput: Boolean
211
- visibilityCondition: String
212
- disabledCondition: String
213
- linkedFields: [String!]
214
- }
215
-
216
- type ChipSelectWithInputField implements IField & IRowElement & IElement {
217
- cols: Int
218
- defaultValue: String
219
- defaultValuePath: String
220
- hidden: Boolean
221
- input: InputField
222
- label: String
223
- name: String!
224
- path: String!
225
- labelPath: String
226
- readonly: Boolean
227
- multiple: Boolean
228
- required: Boolean
229
- requiredCondition: String
230
- selectOptions: ISelectOptions!
231
- skipQuery: Boolean
232
- excludeFromQueryInput: Boolean
233
- subTitle: String
234
- title: String
235
- visibilityCondition: String
236
- disabledCondition: String
237
- linkedFields: [String!]
238
- validation: ChipSelectValidation
239
- }
240
-
241
- type CustomField implements IField & IRowElement & IElement {
242
- cols: Int
243
- component: String!
244
- config: JSON
245
- defaultValue: String
246
- hidden: Boolean
247
- label: String
248
- name: String!
249
- path: String!
250
- readonly: Boolean
251
- required: Boolean
252
- requiredCondition: String
253
- skipQuery: Boolean
254
- excludeFromQueryInput: Boolean
255
- visibilityCondition: String
256
- disabledCondition: String
257
- }
258
-
259
- type StatusChipField implements IField & IRowElement & IElement {
260
- align: String
261
- cols: Int
262
- label: String
263
- name: String!
264
- path: String!
265
- }
266
-
267
- type CheckboxGroupValue {
268
- label: String!
269
- path: String!
270
- skipQuery: Boolean
271
- excludeFromQueryInput: Boolean
272
- value: JSON!
273
- }
274
-
275
- type CheckboxGroup implements IRowElement & IElement {
276
- cols: Int
277
- name: String!
278
- required: Boolean
279
- requiredCondition: String
280
- subTitle: String
281
- title: String
282
- values: [CheckboxGroupValue!]!
283
- visibilityCondition: String
284
- disabledCondition: String
285
- }
286
-
287
- enum FieldValueType {
288
- Int
289
- Float
290
- }
291
-
292
- type StringValidationRule {
293
- message: String
294
- value: String
295
- }
296
-
297
- type IntValidationRule {
298
- message: String
299
- value: Int
300
- }
301
-
302
- type FloatValidationRule {
303
- message: String
304
- value: Float
305
- }
306
-
307
- type FormatValidationRule {
308
- name: String
309
- description: String
310
- message: String
311
- expression: String
312
- condition: String
313
- }
314
-
315
- type InputValidation {
316
- email: StringValidationRule
317
- length: IntValidationRule
318
- format: [FormatValidationRule!]
319
- min: FloatValidationRule
320
- max: FloatValidationRule
321
- }
322
-
323
- type ChipSelectValidation {
324
- compatibleWith: CompatibleWithRule
325
- uniqueInList: UniqueInListRule
326
- }
327
-
328
- type CompatibleWithRule {
329
- field: String!
330
- rules: [CompatibleWithRuleEntry!]!
331
- }
332
-
333
- type CompatibleWithRuleEntry {
334
- when: WhenClause!
335
- allowed: [String!]!
336
- message: String!
337
- }
338
-
339
- type WhenClause {
340
- equals: String
341
- in: [String!]
342
- }
343
-
344
- type UniqueInListRule {
345
- listPaths: [String!]!
346
- itemValuePath: String!
347
- value: String
348
- message: String!
349
- }
350
-
351
- # see more https://s-yadav.github.io/react-number-format/docs/props
352
- type PatternMasking {
353
- dynamic: Boolean
354
- format: String!
355
- mask: String
356
- }
357
-
358
- # see more https://s-yadav.github.io/react-number-format/docs/props
359
- type NumericMasking {
360
- thousandSeparator: String
361
- decimalSeparator: String
362
- decimalScale: Number
363
- fixedDecimalScale: Boolean
364
- allowNegative: Boolean
365
- }
366
-
367
- union FieldMasking = PatternMasking | NumericMasking
1
+ interface IField {
2
+ defaultValue: String
3
+ hidden: Boolean
4
+ label: String
5
+ name: String!
6
+ path: String!
7
+ readonly: Boolean
8
+ required: Boolean
9
+ requiredCondition: String
10
+ skipQuery: Boolean
11
+ excludeFromQueryInput: Boolean
12
+ visibilityCondition: String
13
+ disabledCondition: String
14
+ }
15
+
16
+ interface IDateRangeField {
17
+ defaultValue: [String] # [startDate, endDate]
18
+ defaultValueExpressions: [String] # [startDate, endDate]
19
+ format: String
20
+ hidden: Boolean
21
+ label: String
22
+ name: String!
23
+ paths: [String!]!
24
+ readonly: Boolean
25
+ required: Boolean
26
+ requiredCondition: String
27
+ skipQuery: Boolean
28
+ excludeFromQueryInput: Boolean
29
+ visibilityCondition: String
30
+ disabledCondition: String
31
+ }
32
+
33
+ type InputField implements IField & IRowElement & IElement {
34
+ cols: Int
35
+ defaultValue: String
36
+ helperText: String
37
+ hidden: Boolean
38
+ label: String
39
+ masking: FieldMasking
40
+ maxLength: Int
41
+ minLength: Int
42
+ name: String!
43
+ path: String!
44
+ placeholder: String
45
+ readonly: Boolean
46
+ required: Boolean
47
+ requiredCondition: String
48
+ skipQuery: Boolean
49
+ excludeFromQueryInput: Boolean
50
+ startAdornment: String
51
+ type: FieldValueType
52
+ validation: InputValidation
53
+ visibilityCondition: String
54
+ disabledCondition: String
55
+ skipDirtyCheck: Boolean
56
+ # Start of text area configuration, see https://mui.com/material-ui/react-text-field/#multiline
57
+ multiline: Boolean # optional if at least one other text area parameter is provided
58
+ rows: Int
59
+ maxRows: Int
60
+ minRows: Int
61
+ # End of text area configuration
62
+ }
63
+
64
+ type CustomValidator implements IRowElement & IElement {
65
+ validationRule: String
66
+ errorMessage: String
67
+ paths: [String!]!
68
+ }
69
+
70
+ union Fields = InputField | PhoneField | DateField | DateRangeField | SelectField | ToggleField | BooleanField | TextElement
71
+
72
+ type ItemValidation {
73
+ type: String!
74
+ fields: [String!]!
75
+ errorMessage: String
76
+ }
77
+
78
+ type RepeaterField implements IRowElement & IElement {
79
+ path: String!
80
+ title: String
81
+ label: String
82
+ buttonLabel: String
83
+ required: Boolean
84
+ skipId: Boolean
85
+ fields: [Fields!]!
86
+ visibilityCondition: String
87
+ maxFields: String
88
+ validateUnique: Boolean
89
+ duplicateMessage: String
90
+ itemValidation: ItemValidation
91
+ }
92
+
93
+ type ControlGroup implements IRowElement & IElement {
94
+ path: String!
95
+ title: String
96
+ skipId: Boolean
97
+ controlOptions: ISelectOptions!
98
+ fields: [Fields!]!
99
+ }
100
+
101
+ type PhoneField implements IField & IRowElement & IElement {
102
+ cols: Int
103
+ defaultValue: String
104
+ hidden: Boolean
105
+ label: String
106
+ name: String!
107
+ path: String!
108
+ placeholder: String
109
+ readonly: Boolean
110
+ required: Boolean
111
+ requiredCondition: String
112
+ skipQuery: Boolean
113
+ excludeFromQueryInput: Boolean
114
+ visibilityCondition: String
115
+ disabledCondition: String
116
+ }
117
+
118
+ type DateField implements IField & IRowElement & IElement {
119
+ cols: Int
120
+ defaultValue: String
121
+ hidden: Boolean
122
+ label: String
123
+ name: String!
124
+ path: String!
125
+ readonly: Boolean
126
+ required: Boolean
127
+ requiredCondition: String
128
+ skipQuery: Boolean
129
+ excludeFromQueryInput: Boolean
130
+ visibilityCondition: String
131
+ disabledCondition: String
132
+ minDate: String # e.q. "now" or "2025-03-20"
133
+ maxDate: String # e.q. "now" or "2025-03-20"
134
+ }
135
+
136
+ type DateRangeField implements IDateRangeField & IRowElement & IElement {
137
+ cols: Int
138
+ defaultValue: [String!] # [startDate, endDate]
139
+ defaultValueExpressions: [String!] # [startDate, endDate]
140
+ format: String
141
+ hidden: Boolean
142
+ label: String
143
+ name: String!
144
+ paths: [String!]!
145
+ readonly: Boolean
146
+ required: Boolean
147
+ requiredCondition: String
148
+ skipQuery: Boolean
149
+ excludeFromQueryInput: Boolean
150
+ visibilityCondition: String
151
+ disabledCondition: String
152
+ }
153
+
154
+ type SelectField implements IField & IRowElement & IElement {
155
+ cols: Int
156
+ defaultValue: String
157
+ defaultValuePath: String
158
+ disableClearable: Boolean
159
+ hidden: Boolean
160
+ label: String
161
+ multiple: Boolean
162
+ name: String!
163
+ path: String!
164
+ placeholder: String
165
+ readonly: Boolean
166
+ required: Boolean
167
+ requiredCondition: String
168
+ selectOptions: ISelectOptions!
169
+ skipQuery: Boolean
170
+ excludeFromQueryInput: Boolean
171
+ visibilityCondition: String
172
+ disabledCondition: String
173
+ excludeId: Boolean
174
+ helperText: String
175
+ autoSelectSingleOption: Boolean
176
+ }
177
+
178
+ type ToggleField implements IField & IRowElement & IElement {
179
+ cols: Int
180
+ defaultValue: String
181
+ disableClearable: Boolean
182
+ hidden: Boolean
183
+ label: String
184
+ multiple: Boolean
185
+ name: String!
186
+ path: String!
187
+ readonly: Boolean
188
+ required: Boolean
189
+ requiredCondition: String
190
+ selectOptions: ISelectOptions!
191
+ size: String # see https://mui.com/material-ui/react-toggle-button/#size
192
+ skipQuery: Boolean
193
+ excludeFromQueryInput: Boolean
194
+ visibilityCondition: String
195
+ disabledCondition: String
196
+ linkedFields: [String!]
197
+ }
198
+
199
+ type BooleanField implements IField & IRowElement & IElement {
200
+ cols: Int
201
+ defaultValue: String
202
+ hidden: Boolean
203
+ label: String
204
+ name: String!
205
+ path: String!
206
+ readonly: Boolean
207
+ required: Boolean
208
+ requiredCondition: String
209
+ skipQuery: Boolean
210
+ excludeFromQueryInput: Boolean
211
+ visibilityCondition: String
212
+ disabledCondition: String
213
+ linkedFields: [String!]
214
+ }
215
+
216
+ type ChipSelectWithInputField implements IField & IRowElement & IElement {
217
+ cols: Int
218
+ defaultValue: String
219
+ defaultValuePath: String
220
+ hidden: Boolean
221
+ input: InputField
222
+ label: String
223
+ name: String!
224
+ path: String!
225
+ labelPath: String
226
+ readonly: Boolean
227
+ multiple: Boolean
228
+ required: Boolean
229
+ requiredCondition: String
230
+ selectOptions: ISelectOptions!
231
+ skipQuery: Boolean
232
+ excludeFromQueryInput: Boolean
233
+ subTitle: String
234
+ title: String
235
+ visibilityCondition: String
236
+ disabledCondition: String
237
+ linkedFields: [String!]
238
+ validation: ChipSelectValidation
239
+ }
240
+
241
+ type CustomField implements IField & IRowElement & IElement {
242
+ cols: Int
243
+ component: String!
244
+ config: JSON
245
+ defaultValue: String
246
+ hidden: Boolean
247
+ label: String
248
+ name: String!
249
+ path: String!
250
+ readonly: Boolean
251
+ required: Boolean
252
+ requiredCondition: String
253
+ skipQuery: Boolean
254
+ excludeFromQueryInput: Boolean
255
+ visibilityCondition: String
256
+ disabledCondition: String
257
+ }
258
+
259
+ type StatusChipField implements IField & IRowElement & IElement {
260
+ align: String
261
+ cols: Int
262
+ label: String
263
+ name: String!
264
+ path: String!
265
+ }
266
+
267
+ type CheckboxGroupValue {
268
+ label: String!
269
+ path: String!
270
+ skipQuery: Boolean
271
+ excludeFromQueryInput: Boolean
272
+ value: JSON!
273
+ }
274
+
275
+ type CheckboxGroup implements IRowElement & IElement {
276
+ cols: Int
277
+ name: String!
278
+ required: Boolean
279
+ requiredCondition: String
280
+ subTitle: String
281
+ title: String
282
+ values: [CheckboxGroupValue!]!
283
+ visibilityCondition: String
284
+ disabledCondition: String
285
+ }
286
+
287
+ enum FieldValueType {
288
+ Int
289
+ Float
290
+ }
291
+
292
+ type StringValidationRule {
293
+ message: String
294
+ value: String
295
+ }
296
+
297
+ type IntValidationRule {
298
+ message: String
299
+ value: Int
300
+ }
301
+
302
+ type FloatValidationRule {
303
+ message: String
304
+ value: Float
305
+ }
306
+
307
+ type FormatValidationRule {
308
+ name: String
309
+ description: String
310
+ message: String
311
+ expression: String
312
+ condition: String
313
+ }
314
+
315
+ type InputValidation {
316
+ email: StringValidationRule
317
+ length: IntValidationRule
318
+ format: [FormatValidationRule!]
319
+ min: FloatValidationRule
320
+ max: FloatValidationRule
321
+ }
322
+
323
+ type ChipSelectValidation {
324
+ compatibleWith: CompatibleWithRule
325
+ uniqueInList: UniqueInListRule
326
+ }
327
+
328
+ type CompatibleWithRule {
329
+ field: String!
330
+ rules: [CompatibleWithRuleEntry!]!
331
+ }
332
+
333
+ type CompatibleWithRuleEntry {
334
+ when: WhenClause!
335
+ allowed: [String!]!
336
+ message: String!
337
+ }
338
+
339
+ type WhenClause {
340
+ equals: String
341
+ in: [String!]
342
+ }
343
+
344
+ type UniqueInListRule {
345
+ listPaths: [String!]!
346
+ itemValuePath: String!
347
+ value: String
348
+ message: String!
349
+ }
350
+
351
+ # see more https://s-yadav.github.io/react-number-format/docs/props
352
+ type PatternMasking {
353
+ dynamic: Boolean
354
+ format: String!
355
+ mask: String
356
+ }
357
+
358
+ # see more https://s-yadav.github.io/react-number-format/docs/props
359
+ type NumericMasking {
360
+ thousandSeparator: String
361
+ decimalSeparator: String
362
+ decimalScale: Number
363
+ fixedDecimalScale: Boolean
364
+ allowNegative: Boolean
365
+ }
366
+
367
+ union FieldMasking = PatternMasking | NumericMasking