@persei/perseed-api 4.34.15 → 4.34.17

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.
@@ -0,0 +1,509 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "$ref": "#/definitions/UpdateDashboardWidgetPayload",
4
+ "definitions": {
5
+ "UpdateDashboardWidgetPayload": {
6
+ "type": "object",
7
+ "properties": {
8
+ "title": {
9
+ "type": "string"
10
+ },
11
+ "description": {
12
+ "type": "string"
13
+ },
14
+ "weight": {
15
+ "type": "number"
16
+ },
17
+ "size": {
18
+ "anyOf": [
19
+ {
20
+ "type": "number"
21
+ },
22
+ {
23
+ "$ref": "#/definitions/ColProps"
24
+ }
25
+ ]
26
+ },
27
+ "type": {
28
+ "anyOf": [
29
+ {
30
+ "type": "string",
31
+ "const": "SectionCard"
32
+ },
33
+ {
34
+ "type": "string",
35
+ "const": "ValueCard"
36
+ },
37
+ {
38
+ "type": "string",
39
+ "const": "PatientList"
40
+ },
41
+ {
42
+ "type": "string",
43
+ "const": "Dashboard"
44
+ }
45
+ ]
46
+ },
47
+ "params": {
48
+ "anyOf": [
49
+ {
50
+ "$ref": "#/definitions/SectionCardProps"
51
+ },
52
+ {
53
+ "$ref": "#/definitions/ValueCardProps"
54
+ },
55
+ {
56
+ "$ref": "#/definitions/PatientListProps"
57
+ },
58
+ {
59
+ "$ref": "#/definitions/DashboardProps"
60
+ }
61
+ ]
62
+ }
63
+ },
64
+ "additionalProperties": false
65
+ },
66
+ "ColProps": {
67
+ "type": "object",
68
+ "properties": {
69
+ "flex": {
70
+ "$ref": "#/definitions/FlexType"
71
+ },
72
+ "span": {
73
+ "$ref": "#/definitions/ColSpanType"
74
+ },
75
+ "order": {
76
+ "$ref": "#/definitions/ColSpanType"
77
+ },
78
+ "offset": {
79
+ "$ref": "#/definitions/ColSpanType"
80
+ },
81
+ "push": {
82
+ "$ref": "#/definitions/ColSpanType"
83
+ },
84
+ "pull": {
85
+ "$ref": "#/definitions/ColSpanType"
86
+ },
87
+ "xs": {
88
+ "anyOf": [
89
+ {
90
+ "$ref": "#/definitions/ColSpanType"
91
+ },
92
+ {
93
+ "$ref": "#/definitions/ColSize"
94
+ }
95
+ ]
96
+ },
97
+ "sm": {
98
+ "anyOf": [
99
+ {
100
+ "$ref": "#/definitions/ColSpanType"
101
+ },
102
+ {
103
+ "$ref": "#/definitions/ColSize"
104
+ }
105
+ ]
106
+ },
107
+ "md": {
108
+ "anyOf": [
109
+ {
110
+ "$ref": "#/definitions/ColSpanType"
111
+ },
112
+ {
113
+ "$ref": "#/definitions/ColSize"
114
+ }
115
+ ]
116
+ },
117
+ "lg": {
118
+ "anyOf": [
119
+ {
120
+ "$ref": "#/definitions/ColSpanType"
121
+ },
122
+ {
123
+ "$ref": "#/definitions/ColSize"
124
+ }
125
+ ]
126
+ },
127
+ "xl": {
128
+ "anyOf": [
129
+ {
130
+ "$ref": "#/definitions/ColSpanType"
131
+ },
132
+ {
133
+ "$ref": "#/definitions/ColSize"
134
+ }
135
+ ]
136
+ },
137
+ "xxl": {
138
+ "anyOf": [
139
+ {
140
+ "$ref": "#/definitions/ColSpanType"
141
+ },
142
+ {
143
+ "$ref": "#/definitions/ColSize"
144
+ }
145
+ ]
146
+ },
147
+ "prefixCls": {
148
+ "type": "string"
149
+ }
150
+ },
151
+ "additionalProperties": false
152
+ },
153
+ "FlexType": {
154
+ "anyOf": [
155
+ {
156
+ "type": "number"
157
+ },
158
+ {
159
+ "type": "string",
160
+ "const": "none"
161
+ },
162
+ {
163
+ "type": "string",
164
+ "const": "auto"
165
+ },
166
+ {
167
+ "type": "string"
168
+ }
169
+ ]
170
+ },
171
+ "ColSpanType": {
172
+ "type": ["number", "string"]
173
+ },
174
+ "ColSize": {
175
+ "type": "object",
176
+ "properties": {
177
+ "flex": {
178
+ "$ref": "#/definitions/FlexType"
179
+ },
180
+ "span": {
181
+ "$ref": "#/definitions/ColSpanType"
182
+ },
183
+ "order": {
184
+ "$ref": "#/definitions/ColSpanType"
185
+ },
186
+ "offset": {
187
+ "$ref": "#/definitions/ColSpanType"
188
+ },
189
+ "push": {
190
+ "$ref": "#/definitions/ColSpanType"
191
+ },
192
+ "pull": {
193
+ "$ref": "#/definitions/ColSpanType"
194
+ }
195
+ },
196
+ "additionalProperties": false
197
+ },
198
+ "SectionCardProps": {
199
+ "type": "object",
200
+ "properties": {
201
+ "icon": {
202
+ "type": "string"
203
+ },
204
+ "background": {
205
+ "type": "string"
206
+ },
207
+ "titleBackground": {
208
+ "type": "string"
209
+ },
210
+ "title": {
211
+ "$ref": "#/definitions/I18nTextTranslation"
212
+ },
213
+ "widgets": {
214
+ "type": "array",
215
+ "items": {
216
+ "type": "number"
217
+ }
218
+ }
219
+ },
220
+ "required": ["icon", "title", "widgets"],
221
+ "additionalProperties": false
222
+ },
223
+ "I18nTextTranslation": {
224
+ "anyOf": [
225
+ {
226
+ "$ref": "#/definitions/I18nTextLocales"
227
+ },
228
+ {
229
+ "type": "string"
230
+ }
231
+ ]
232
+ },
233
+ "I18nTextLocales": {
234
+ "type": "object",
235
+ "properties": {
236
+ "default": {
237
+ "type": "string"
238
+ }
239
+ },
240
+ "required": ["default"],
241
+ "additionalProperties": {
242
+ "type": "string"
243
+ }
244
+ },
245
+ "ValueCardProps": {
246
+ "type": "object",
247
+ "properties": {
248
+ "title": {
249
+ "$ref": "#/definitions/I18nTextTranslation"
250
+ },
251
+ "icon": {
252
+ "type": "string"
253
+ },
254
+ "text": {
255
+ "$ref": "#/definitions/I18nTextTranslation"
256
+ },
257
+ "subtext": {
258
+ "$ref": "#/definitions/I18nTextTranslation"
259
+ },
260
+ "titleTextColor": {
261
+ "type": "string"
262
+ },
263
+ "bodyTextColor": {
264
+ "type": "string"
265
+ },
266
+ "data": {
267
+ "type": "object"
268
+ },
269
+ "dataLoader": {
270
+ "$ref": "#/definitions/DashboardWidgetDataLoader%3CWidgetOutcomesDataLoader%3E"
271
+ }
272
+ },
273
+ "required": ["title", "icon", "text"],
274
+ "additionalProperties": false
275
+ },
276
+ "DashboardWidgetDataLoader<WidgetOutcomesDataLoader>": {
277
+ "type": "object",
278
+ "properties": {
279
+ "type": {
280
+ "type": "string",
281
+ "const": "outcomes"
282
+ },
283
+ "params": {
284
+ "type": "object",
285
+ "properties": {
286
+ "ecosystem": {
287
+ "type": "string"
288
+ },
289
+ "projectName": {
290
+ "type": "string"
291
+ },
292
+ "clinicId": {
293
+ "type": "number"
294
+ },
295
+ "name": {
296
+ "anyOf": [
297
+ {
298
+ "type": "string"
299
+ },
300
+ {
301
+ "type": "array",
302
+ "items": {
303
+ "type": "string"
304
+ }
305
+ }
306
+ ]
307
+ },
308
+ "identifier": {
309
+ "anyOf": [
310
+ {
311
+ "type": "string"
312
+ },
313
+ {
314
+ "type": "array",
315
+ "items": {
316
+ "type": "string"
317
+ }
318
+ }
319
+ ]
320
+ },
321
+ "from": {
322
+ "type": "string"
323
+ },
324
+ "to": {
325
+ "type": "string"
326
+ },
327
+ "datesContained": {
328
+ "type": "boolean"
329
+ },
330
+ "aggType": {
331
+ "$ref": "#/definitions/AggFunction"
332
+ },
333
+ "groupBy": {
334
+ "anyOf": [
335
+ {
336
+ "$ref": "#/definitions/OutcomesGroupBy"
337
+ },
338
+ {
339
+ "type": "array",
340
+ "items": {
341
+ "$ref": "#/definitions/OutcomesGroupBy"
342
+ }
343
+ }
344
+ ]
345
+ },
346
+ "limit": {
347
+ "type": "number"
348
+ },
349
+ "orderBy": {
350
+ "type": "string"
351
+ },
352
+ "orderDir": {
353
+ "$ref": "#/definitions/OrderDir"
354
+ }
355
+ },
356
+ "required": ["ecosystem", "projectName", "name"],
357
+ "additionalProperties": false
358
+ }
359
+ },
360
+ "required": ["type", "params"],
361
+ "additionalProperties": false
362
+ },
363
+ "AggFunction": {
364
+ "type": "string",
365
+ "enum": ["avg", "count", "max", "min", "sum"]
366
+ },
367
+ "OutcomesGroupBy": {
368
+ "anyOf": [
369
+ {
370
+ "type": "string",
371
+ "const": "name"
372
+ },
373
+ {
374
+ "type": "string",
375
+ "const": "identifier"
376
+ },
377
+ {
378
+ "type": "string",
379
+ "const": "value"
380
+ },
381
+ {
382
+ "$ref": "#/definitions/OutcomesDateFields"
383
+ },
384
+ {
385
+ "$ref": "#/definitions/OutcomeDateField"
386
+ }
387
+ ]
388
+ },
389
+ "OutcomesDateFields": {
390
+ "type": "string",
391
+ "enum": ["from", "to"]
392
+ },
393
+ "OutcomeDateField": {
394
+ "type": "string",
395
+ "enum": [
396
+ "from.date",
397
+ "from.day",
398
+ "from.dayname",
399
+ "from.dayofmonth",
400
+ "from.dayofweek",
401
+ "from.dayofyear",
402
+ "from.hour",
403
+ "from.minute",
404
+ "from.month",
405
+ "from.monthname",
406
+ "from.time",
407
+ "from.second",
408
+ "from.week",
409
+ "from.weekday",
410
+ "from.weekofyear",
411
+ "from.year",
412
+ "from.yearweek",
413
+ "to.date",
414
+ "to.day",
415
+ "to.dayname",
416
+ "to.dayofmonth",
417
+ "to.dayofweek",
418
+ "to.dayofyear",
419
+ "to.hour",
420
+ "to.minute",
421
+ "to.month",
422
+ "to.monthname",
423
+ "to.time",
424
+ "to.second",
425
+ "to.week",
426
+ "to.weekday",
427
+ "to.weekofyear",
428
+ "to.year",
429
+ "to.yearweek"
430
+ ]
431
+ },
432
+ "OrderDir": {
433
+ "type": "string",
434
+ "enum": ["asc", "desc"]
435
+ },
436
+ "PatientListProps": {
437
+ "type": "object",
438
+ "properties": {
439
+ "loadUserProfiles": {
440
+ "type": "boolean"
441
+ },
442
+ "loadAdherence": {
443
+ "type": "boolean"
444
+ },
445
+ "extraFields": {
446
+ "type": "array",
447
+ "items": {
448
+ "type": "string"
449
+ }
450
+ },
451
+ "loadPushTokens": {
452
+ "type": "boolean"
453
+ },
454
+ "loadUserAccessData": {
455
+ "type": "boolean"
456
+ },
457
+ "programId": {
458
+ "type": "number"
459
+ },
460
+ "prevAdherenceDays": {
461
+ "type": "number"
462
+ },
463
+ "relatedData": {
464
+ "type": "object",
465
+ "properties": {
466
+ "join": {
467
+ "type": "array",
468
+ "items": {
469
+ "type": "string"
470
+ }
471
+ }
472
+ },
473
+ "additionalProperties": false
474
+ },
475
+ "filter": {
476
+ "type": "object",
477
+ "properties": {
478
+ "conditions": {
479
+ "type": "object",
480
+ "additionalProperties": {}
481
+ }
482
+ },
483
+ "additionalProperties": false
484
+ }
485
+ },
486
+ "additionalProperties": false
487
+ },
488
+ "DashboardProps": {
489
+ "type": "object",
490
+ "properties": {
491
+ "title": {
492
+ "type": "string"
493
+ },
494
+ "active": {
495
+ "type": "boolean"
496
+ },
497
+ "config": {},
498
+ "icon": {
499
+ "type": ["string", "null"]
500
+ },
501
+ "weight": {
502
+ "type": "number"
503
+ }
504
+ },
505
+ "required": ["title"],
506
+ "additionalProperties": false
507
+ }
508
+ }
509
+ }
@@ -1,41 +1,8 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
- "$ref": "#/definitions/UpdateDashboardPayload",
3
+ "$ref": "#/definitions/CreateDashboardWidgetPayload",
4
4
  "definitions": {
5
- "UpdateDashboardPayload": {
6
- "type": "object",
7
- "properties": {
8
- "title": {
9
- "type": "string"
10
- },
11
- "active": {
12
- "type": "boolean"
13
- },
14
- "config": {
15
- "$ref": "#/definitions/DashboardConfig"
16
- },
17
- "icon": {
18
- "type": ["string", "null"]
19
- },
20
- "weight": {
21
- "type": "number"
22
- }
23
- },
24
- "additionalProperties": false
25
- },
26
- "DashboardConfig": {
27
- "type": "object",
28
- "properties": {
29
- "widgets": {
30
- "type": "array",
31
- "items": {
32
- "$ref": "#/definitions/Widget"
33
- }
34
- }
35
- },
36
- "additionalProperties": false
37
- },
38
- "Widget": {
5
+ "CreateDashboardWidgetPayload": {
39
6
  "anyOf": [
40
7
  {
41
8
  "type": "object",
@@ -48,6 +15,15 @@
48
15
  "params": {
49
16
  "$ref": "#/definitions/SectionCardProps"
50
17
  },
18
+ "title": {
19
+ "type": "string"
20
+ },
21
+ "description": {
22
+ "type": "string"
23
+ },
24
+ "weight": {
25
+ "type": "number"
26
+ },
51
27
  "size": {
52
28
  "anyOf": [
53
29
  {
@@ -59,7 +35,7 @@
59
35
  ]
60
36
  }
61
37
  },
62
- "required": ["params", "type"]
38
+ "required": ["params", "title", "type"]
63
39
  },
64
40
  {
65
41
  "type": "object",
@@ -72,6 +48,15 @@
72
48
  "params": {
73
49
  "$ref": "#/definitions/ValueCardProps"
74
50
  },
51
+ "title": {
52
+ "type": "string"
53
+ },
54
+ "description": {
55
+ "type": "string"
56
+ },
57
+ "weight": {
58
+ "type": "number"
59
+ },
75
60
  "size": {
76
61
  "anyOf": [
77
62
  {
@@ -83,7 +68,7 @@
83
68
  ]
84
69
  }
85
70
  },
86
- "required": ["params", "type"]
71
+ "required": ["params", "title", "type"]
87
72
  },
88
73
  {
89
74
  "type": "object",
@@ -96,6 +81,15 @@
96
81
  "params": {
97
82
  "$ref": "#/definitions/PatientListProps"
98
83
  },
84
+ "title": {
85
+ "type": "string"
86
+ },
87
+ "description": {
88
+ "type": "string"
89
+ },
90
+ "weight": {
91
+ "type": "number"
92
+ },
99
93
  "size": {
100
94
  "anyOf": [
101
95
  {
@@ -107,7 +101,40 @@
107
101
  ]
108
102
  }
109
103
  },
110
- "required": ["params", "type"]
104
+ "required": ["params", "title", "type"]
105
+ },
106
+ {
107
+ "type": "object",
108
+ "additionalProperties": false,
109
+ "properties": {
110
+ "type": {
111
+ "type": "string",
112
+ "const": "Dashboard"
113
+ },
114
+ "params": {
115
+ "$ref": "#/definitions/DashboardProps"
116
+ },
117
+ "title": {
118
+ "type": "string"
119
+ },
120
+ "description": {
121
+ "type": "string"
122
+ },
123
+ "weight": {
124
+ "type": "number"
125
+ },
126
+ "size": {
127
+ "anyOf": [
128
+ {
129
+ "type": "number"
130
+ },
131
+ {
132
+ "$ref": "#/definitions/ColProps"
133
+ }
134
+ ]
135
+ }
136
+ },
137
+ "required": ["params", "title", "type"]
111
138
  }
112
139
  ]
113
140
  },
@@ -129,7 +156,7 @@
129
156
  "widgets": {
130
157
  "type": "array",
131
158
  "items": {
132
- "$ref": "#/definitions/Widget"
159
+ "type": "number"
133
160
  }
134
161
  }
135
162
  },
@@ -315,13 +342,13 @@
315
342
  "type": "object"
316
343
  },
317
344
  "dataLoader": {
318
- "$ref": "#/definitions/WidgetDataLoader%3CWidgetOutcomesDataLoader%3E"
345
+ "$ref": "#/definitions/DashboardWidgetDataLoader%3CWidgetOutcomesDataLoader%3E"
319
346
  }
320
347
  },
321
348
  "required": ["title", "icon", "text"],
322
349
  "additionalProperties": false
323
350
  },
324
- "WidgetDataLoader<WidgetOutcomesDataLoader>": {
351
+ "DashboardWidgetDataLoader<WidgetOutcomesDataLoader>": {
325
352
  "type": "object",
326
353
  "properties": {
327
354
  "type": {
@@ -532,6 +559,26 @@
532
559
  }
533
560
  },
534
561
  "additionalProperties": false
562
+ },
563
+ "DashboardProps": {
564
+ "type": "object",
565
+ "properties": {
566
+ "title": {
567
+ "type": "string"
568
+ },
569
+ "active": {
570
+ "type": "boolean"
571
+ },
572
+ "config": {},
573
+ "icon": {
574
+ "type": ["string", "null"]
575
+ },
576
+ "weight": {
577
+ "type": "number"
578
+ }
579
+ },
580
+ "required": ["title"],
581
+ "additionalProperties": false
535
582
  }
536
583
  }
537
584
  }