@luzmo/dashboard-contents-types 1.0.1 → 1.0.3

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.
Files changed (90) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/assets/json-schemas/area-chart-options.schema.json.d.ts +17 -129
  3. package/assets/json-schemas/bar-chart-options.schema.json.d.ts +17 -129
  4. package/assets/json-schemas/box-plot-options.schema.json.d.ts +16 -165
  5. package/assets/json-schemas/bubble-chart-options.schema.json.d.ts +17 -129
  6. package/assets/json-schemas/bullet-chart-options.schema.json.d.ts +12 -175
  7. package/assets/json-schemas/choropleth-map-options.schema.json.d.ts +12 -150
  8. package/assets/json-schemas/circular-gauge-options.schema.json.d.ts +15 -176
  9. package/assets/json-schemas/column-chart-options.schema.json.d.ts +17 -129
  10. package/assets/json-schemas/combination-chart-options.schema.json.d.ts +17 -129
  11. package/assets/json-schemas/date-filter-options.schema.json.d.ts +10 -228
  12. package/assets/json-schemas/donut-chart-options.schema.json.d.ts +16 -140
  13. package/assets/json-schemas/dropdown-filter-options.schema.json.d.ts +10 -228
  14. package/assets/json-schemas/evolution-number-options.schema.json.d.ts +15 -176
  15. package/assets/json-schemas/funnel-chart-options.schema.json.d.ts +16 -140
  16. package/assets/json-schemas/image-options.schema.json.d.ts +5 -339
  17. package/assets/json-schemas/line-chart-options.schema.json.d.ts +17 -129
  18. package/assets/json-schemas/pivot-table-options.schema.json.d.ts +11 -186
  19. package/assets/json-schemas/regular-table-options.schema.json.d.ts +11 -186
  20. package/assets/json-schemas/sankey-diagram-options.schema.json.d.ts +15 -176
  21. package/assets/json-schemas/scatter-plot-options.schema.json.d.ts +17 -129
  22. package/assets/json-schemas/search-filter-options.schema.json.d.ts +1051 -0
  23. package/assets/json-schemas/search-filter-slots.schema.json.d.ts +484 -0
  24. package/assets/json-schemas/search-filter.schema.json.d.ts +23 -0
  25. package/assets/json-schemas/slicer-filter-options.schema.json.d.ts +10 -228
  26. package/assets/json-schemas/slider-filter-options.schema.json.d.ts +10 -228
  27. package/assets/json-schemas/text-options.schema.json.d.ts +6 -296
  28. package/index.js +66 -45
  29. package/index.mjs +2025 -4267
  30. package/json-schemas.d.ts +1173 -1938
  31. package/json-schemas.d.ts.map +1 -1
  32. package/package.json +1 -1
  33. package/src/lib/area-chart/area-chart-options.d.ts +6 -3
  34. package/src/lib/area-chart/area-chart-options.d.ts.map +1 -1
  35. package/src/lib/bar-chart/bar-chart-options.d.ts +6 -3
  36. package/src/lib/bar-chart/bar-chart-options.d.ts.map +1 -1
  37. package/src/lib/box-plot/box-plot-options.d.ts +6 -3
  38. package/src/lib/box-plot/box-plot-options.d.ts.map +1 -1
  39. package/src/lib/bubble-chart/bubble-chart-options.d.ts +6 -3
  40. package/src/lib/bubble-chart/bubble-chart-options.d.ts.map +1 -1
  41. package/src/lib/bullet-chart/bullet-chart-options.d.ts +6 -1
  42. package/src/lib/bullet-chart/bullet-chart-options.d.ts.map +1 -1
  43. package/src/lib/choropleth-map/choropleth-map-options.d.ts +6 -2
  44. package/src/lib/choropleth-map/choropleth-map-options.d.ts.map +1 -1
  45. package/src/lib/circular-gauge/circular-gauge-options.d.ts +6 -1
  46. package/src/lib/circular-gauge/circular-gauge-options.d.ts.map +1 -1
  47. package/src/lib/column-chart/column-chart-options.d.ts +6 -3
  48. package/src/lib/column-chart/column-chart-options.d.ts.map +1 -1
  49. package/src/lib/combination-chart/combination-chart-options.d.ts +6 -3
  50. package/src/lib/combination-chart/combination-chart-options.d.ts.map +1 -1
  51. package/src/lib/conditional-number/conditional-number-options.d.ts +6 -1
  52. package/src/lib/conditional-number/conditional-number-options.d.ts.map +1 -1
  53. package/src/lib/date-filter/date-filter-options.d.ts +6 -2
  54. package/src/lib/date-filter/date-filter-options.d.ts.map +1 -1
  55. package/src/lib/donut-chart/donut-chart-options.d.ts +6 -2
  56. package/src/lib/donut-chart/donut-chart-options.d.ts.map +1 -1
  57. package/src/lib/dropdown-filter/dropdown-filter-options.d.ts +6 -1
  58. package/src/lib/dropdown-filter/dropdown-filter-options.d.ts.map +1 -1
  59. package/src/lib/evolution-number/evolution-number-options.d.ts +6 -1
  60. package/src/lib/evolution-number/evolution-number-options.d.ts.map +1 -1
  61. package/src/lib/funnel-chart/funnel-chart-options.d.ts +6 -2
  62. package/src/lib/funnel-chart/funnel-chart-options.d.ts.map +1 -1
  63. package/src/lib/image/image-options.d.ts +6 -1
  64. package/src/lib/image/image-options.d.ts.map +1 -1
  65. package/src/lib/line-chart/line-chart-options.d.ts +6 -3
  66. package/src/lib/line-chart/line-chart-options.d.ts.map +1 -1
  67. package/src/lib/pivot-table/pivot-table-options.d.ts +6 -2
  68. package/src/lib/pivot-table/pivot-table-options.d.ts.map +1 -1
  69. package/src/lib/regular-table/regular-table-options.d.ts +6 -1
  70. package/src/lib/regular-table/regular-table-options.d.ts.map +1 -1
  71. package/src/lib/sankey-diagram/sankey-diagram-options.d.ts +6 -2
  72. package/src/lib/sankey-diagram/sankey-diagram-options.d.ts.map +1 -1
  73. package/src/lib/scatter-plot/scatter-plot-options.d.ts +6 -3
  74. package/src/lib/scatter-plot/scatter-plot-options.d.ts.map +1 -1
  75. package/src/lib/search-filter/search-filter-options.d.ts +12 -2
  76. package/src/lib/search-filter/search-filter-options.d.ts.map +1 -1
  77. package/src/lib/shared/index.d.ts +1 -3
  78. package/src/lib/shared/index.d.ts.map +1 -1
  79. package/src/lib/shared/slots.d.ts +1 -0
  80. package/src/lib/shared/slots.d.ts.map +1 -1
  81. package/src/lib/shared/theme.d.ts +87 -81
  82. package/src/lib/shared/theme.d.ts.map +1 -1
  83. package/src/lib/slicer-filter/slicer-filter-options.d.ts +6 -2
  84. package/src/lib/slicer-filter/slicer-filter-options.d.ts.map +1 -1
  85. package/src/lib/slider-filter/slider-filter-options.d.ts +6 -2
  86. package/src/lib/slider-filter/slider-filter-options.d.ts.map +1 -1
  87. package/src/lib/text/text-options.d.ts +6 -1
  88. package/src/lib/text/text-options.d.ts.map +1 -1
  89. package/src/lib/shared/axis-view-options.d.ts +0 -3
  90. package/src/lib/shared/axis-view-options.d.ts.map +0 -1
package/assets/json-schemas/donut-chart-options.schema.json.d.ts CHANGED
@@ -2303,6 +2303,9 @@ declare const _default: {
2303
2303
  "currency_id": {
2304
2304
  "type": "string"
2305
2305
  },
2306
+ "description": {
2307
+ "type": "object"
2308
+ },
2306
2309
  "duration_format": {
2307
2310
  "enum": [
2308
2311
  "long",
@@ -3159,37 +3162,8 @@ declare const _default: {
3159
3162
  "theme": {
3160
3163
  "description": "Theme configuration",
3161
3164
  "properties": {
3162
- "axis": {
3163
- "description": "Axis styling",
3164
- "examples": [
3165
- {
3166
- "fontSize": 12
3167
- },
3168
- {
3169
- "fontSize": 10
3170
- }
3171
- ],
3172
- "type": "object"
3173
- },
3174
- "background": {
3175
- "description": "Background color",
3176
- "examples": [
3177
- "rgb(245, 245, 245)",
3178
- "rgb(61, 61, 61)"
3179
- ],
3180
- "type": "string"
3181
- },
3182
- "baseFontSize": {
3183
- "description": "Base font size, usually it participates in calculations related to font sizes, spacings, etc.",
3184
- "examples": [
3185
- 13,
3186
- 16,
3187
- 20
3188
- ],
3189
- "type": "number"
3190
- },
3191
3165
  "borders": {
3192
- "description": "Border styling",
3166
+ "description": "Custom border styling",
3193
3167
  "properties": {
3194
3168
  "border-bottom-width": {
3195
3169
  "description": "Border bottom width",
@@ -3258,7 +3232,7 @@ declare const _default: {
3258
3232
  "type": "object"
3259
3233
  },
3260
3234
  "boxShadow": {
3261
- "description": "Shadow styling",
3235
+ "description": "Custom shadow styling",
3262
3236
  "properties": {
3263
3237
  "color": {
3264
3238
  "description": "Shadow color",
@@ -3288,29 +3262,12 @@ declare const _default: {
3288
3262
  "type": "object"
3289
3263
  },
3290
3264
  "colors": {
3291
- "description": "A list of theme colors",
3265
+ "description": "Custom color palette",
3292
3266
  "examples": [
3293
3267
  [
3294
- "rgb(122, 112, 112)",
3295
- "rgb(175, 169, 169)",
3296
- "rgb(228, 226, 226)"
3297
- ],
3298
- [
3299
- "rgb(48, 36, 179)",
3300
- "rgb(105, 93, 255)",
3301
- "rgb(199, 194, 255)",
3302
- "rgb(134, 4, 129)",
3303
- "rgb(204, 55, 198)",
3304
- "rgb(236, 180, 234)",
3305
- "rgb(220, 141, 0)",
3306
- "rgb(249, 206, 61)",
3307
- "rgb(253, 237, 182)",
3308
- "rgb(6, 142, 84)",
3309
- "rgb(58, 213, 147)",
3310
- "rgb(181, 239, 215)",
3311
- "rgb(85, 78, 78)",
3312
- "rgb(149, 141, 141)",
3313
- "rgb(215, 212, 212)"
3268
+ "rgb(68, 52, 255)",
3269
+ "rgb(68, 52, 255)",
3270
+ "rgb(218, 214, 255)"
3314
3271
  ]
3315
3272
  ],
3316
3273
  "items": {
@@ -3318,24 +3275,8 @@ declare const _default: {
3318
3275
  },
3319
3276
  "type": "array"
3320
3277
  },
3321
- "editBackground": {
3322
- "description": "Edit background",
3323
- "examples": [
3324
- "rgb(228, 228, 228)",
3325
- "rgb(245, 245, 245)",
3326
- "rgb(61, 61, 61)"
3327
- ],
3328
- "type": "string"
3329
- },
3330
- "editModeBackground": {
3331
- "description": "Edit mode background",
3332
- "examples": [
3333
- "rgb(245, 245, 245)"
3334
- ],
3335
- "type": "string"
3336
- },
3337
3278
  "font": {
3338
- "description": "Font styling",
3279
+ "description": "Custom font styling",
3339
3280
  "properties": {
3340
3281
  "font-style": {
3341
3282
  "const": "normal",
@@ -3379,40 +3320,15 @@ declare const _default: {
3379
3320
  "type": "object"
3380
3321
  },
3381
3322
  "id": {
3382
- "description": "Id of the theme, like \"seasonal\", \"urban\", etc.",
3323
+ "description": "Id of the theme, for example, \"seasonal\", \"urban\" or custom theme uuid. If you just pass custom theme options, it have to be skipped.",
3383
3324
  "examples": [
3384
3325
  "seasonal",
3385
3326
  "urban"
3386
3327
  ],
3387
3328
  "type": "string"
3388
3329
  },
3389
- "itemSpecific": {
3390
- "description": "Item specific styling",
3391
- "properties": {
3392
- "padding": {
3393
- "description": "Padding of the item",
3394
- "examples": [
3395
- 0,
3396
- 4,
3397
- 8,
3398
- 10
3399
- ],
3400
- "type": "number"
3401
- },
3402
- "rounding": {
3403
- "description": "Rounding of the item",
3404
- "examples": [
3405
- 0,
3406
- 8,
3407
- 12
3408
- ],
3409
- "type": "number"
3410
- }
3411
- },
3412
- "type": "object"
3413
- },
3414
3330
  "itemsBackground": {
3415
- "description": "Item background color",
3331
+ "description": "Custom item background color",
3416
3332
  "examples": [
3417
3333
  "rgb(255, 255, 255)",
3418
3334
  "rgb(71, 69, 69)",
@@ -3421,7 +3337,7 @@ declare const _default: {
3421
3337
  "type": "string"
3422
3338
  },
3423
3339
  "legend": {
3424
- "description": "Legend styling",
3340
+ "description": "Custom legend styling",
3425
3341
  "properties": {
3426
3342
  "fontSize": {
3427
3343
  "description": "Legend font size in px",
@@ -3457,48 +3373,8 @@ declare const _default: {
3457
3373
  },
3458
3374
  "type": "object"
3459
3375
  },
3460
- "mainColor": {
3461
- "description": "Theme main color",
3462
- "examples": [
3463
- "rgb(123, 144, 255)",
3464
- "rgb(255, 174, 52)",
3465
- "rgb(123, 144, 255)"
3466
- ],
3467
- "type": "string"
3468
- },
3469
- "margins": {
3470
- "description": "Dashboard vertical and horizontal margins",
3471
- "examples": [
3472
- [
3473
- 16,
3474
- 16
3475
- ],
3476
- [
3477
- 20,
3478
- 20
3479
- ]
3480
- ],
3481
- "items": [
3482
- {
3483
- "type": "number"
3484
- },
3485
- {
3486
- "type": "number"
3487
- }
3488
- ],
3489
- "maxItems": 2,
3490
- "minItems": 2,
3491
- "type": "array"
3492
- },
3493
- "name": {
3494
- "description": "Theme name",
3495
- "examples": [
3496
- "manual"
3497
- ],
3498
- "type": "string"
3499
- },
3500
3376
  "title": {
3501
- "description": "Title styling",
3377
+ "description": "Custom title styling",
3502
3378
  "properties": {
3503
3379
  "align": {
3504
3380
  "description": "Title align",
@@ -3567,7 +3443,7 @@ declare const _default: {
3567
3443
  "type": "object"
3568
3444
  },
3569
3445
  "tooltip": {
3570
- "description": "Tooltip styling",
3446
+ "description": "Custom tooltip styling",
3571
3447
  "properties": {
3572
3448
  "background": {
3573
3449
  "description": "Tooltip's background",
@@ -3610,7 +3486,7 @@ declare const _default: {
3610
3486
  "type": "object"
3611
3487
  },
3612
3488
  "type": {
3613
- "description": "Theme type",
3489
+ "description": "It should be \"custom\" if custom theme id is specified or if you specify custom theme options to set the theme. Skip it otherwise.",
3614
3490
  "examples": [
3615
3491
  "custom"
3616
3492
  ],
package/assets/json-schemas/dropdown-filter-options.schema.json.d.ts CHANGED
@@ -118,6 +118,9 @@ declare const _default: {
118
118
  "currency_id": {
119
119
  "type": "string"
120
120
  },
121
+ "description": {
122
+ "type": "object"
123
+ },
121
124
  "duration_format": {
122
125
  "enum": [
123
126
  "long",
@@ -902,37 +905,8 @@ declare const _default: {
902
905
  "theme": {
903
906
  "description": "Theme configuration",
904
907
  "properties": {
905
- "axis": {
906
- "description": "Axis styling",
907
- "examples": [
908
- {
909
- "fontSize": 12
910
- },
911
- {
912
- "fontSize": 10
913
- }
914
- ],
915
- "type": "object"
916
- },
917
- "background": {
918
- "description": "Background color",
919
- "examples": [
920
- "rgb(245, 245, 245)",
921
- "rgb(61, 61, 61)"
922
- ],
923
- "type": "string"
924
- },
925
- "baseFontSize": {
926
- "description": "Base font size, usually it participates in calculations related to font sizes, spacings, etc.",
927
- "examples": [
928
- 13,
929
- 16,
930
- 20
931
- ],
932
- "type": "number"
933
- },
934
908
  "borders": {
935
- "description": "Border styling",
909
+ "description": "Custom border styling",
936
910
  "properties": {
937
911
  "border-bottom-width": {
938
912
  "description": "Border bottom width",
@@ -1001,7 +975,7 @@ declare const _default: {
1001
975
  "type": "object"
1002
976
  },
1003
977
  "boxShadow": {
1004
- "description": "Shadow styling",
978
+ "description": "Custom shadow styling",
1005
979
  "properties": {
1006
980
  "color": {
1007
981
  "description": "Shadow color",
@@ -1030,55 +1004,8 @@ declare const _default: {
1030
1004
  },
1031
1005
  "type": "object"
1032
1006
  },
1033
- "colors": {
1034
- "description": "A list of theme colors",
1035
- "examples": [
1036
- [
1037
- "rgb(122, 112, 112)",
1038
- "rgb(175, 169, 169)",
1039
- "rgb(228, 226, 226)"
1040
- ],
1041
- [
1042
- "rgb(48, 36, 179)",
1043
- "rgb(105, 93, 255)",
1044
- "rgb(199, 194, 255)",
1045
- "rgb(134, 4, 129)",
1046
- "rgb(204, 55, 198)",
1047
- "rgb(236, 180, 234)",
1048
- "rgb(220, 141, 0)",
1049
- "rgb(249, 206, 61)",
1050
- "rgb(253, 237, 182)",
1051
- "rgb(6, 142, 84)",
1052
- "rgb(58, 213, 147)",
1053
- "rgb(181, 239, 215)",
1054
- "rgb(85, 78, 78)",
1055
- "rgb(149, 141, 141)",
1056
- "rgb(215, 212, 212)"
1057
- ]
1058
- ],
1059
- "items": {
1060
- "type": "string"
1061
- },
1062
- "type": "array"
1063
- },
1064
- "editBackground": {
1065
- "description": "Edit background",
1066
- "examples": [
1067
- "rgb(228, 228, 228)",
1068
- "rgb(245, 245, 245)",
1069
- "rgb(61, 61, 61)"
1070
- ],
1071
- "type": "string"
1072
- },
1073
- "editModeBackground": {
1074
- "description": "Edit mode background",
1075
- "examples": [
1076
- "rgb(245, 245, 245)"
1077
- ],
1078
- "type": "string"
1079
- },
1080
1007
  "font": {
1081
- "description": "Font styling",
1008
+ "description": "Custom font styling",
1082
1009
  "properties": {
1083
1010
  "font-style": {
1084
1011
  "const": "normal",
@@ -1122,40 +1049,15 @@ declare const _default: {
1122
1049
  "type": "object"
1123
1050
  },
1124
1051
  "id": {
1125
- "description": "Id of the theme, like \"seasonal\", \"urban\", etc.",
1052
+ "description": "Id of the theme, for example, \"seasonal\", \"urban\" or custom theme uuid. If you just pass custom theme options, it have to be skipped.",
1126
1053
  "examples": [
1127
1054
  "seasonal",
1128
1055
  "urban"
1129
1056
  ],
1130
1057
  "type": "string"
1131
1058
  },
1132
- "itemSpecific": {
1133
- "description": "Item specific styling",
1134
- "properties": {
1135
- "padding": {
1136
- "description": "Padding of the item",
1137
- "examples": [
1138
- 0,
1139
- 4,
1140
- 8,
1141
- 10
1142
- ],
1143
- "type": "number"
1144
- },
1145
- "rounding": {
1146
- "description": "Rounding of the item",
1147
- "examples": [
1148
- 0,
1149
- 8,
1150
- 12
1151
- ],
1152
- "type": "number"
1153
- }
1154
- },
1155
- "type": "object"
1156
- },
1157
1059
  "itemsBackground": {
1158
- "description": "Item background color",
1060
+ "description": "Custom item background color",
1159
1061
  "examples": [
1160
1062
  "rgb(255, 255, 255)",
1161
1063
  "rgb(71, 69, 69)",
@@ -1163,85 +1065,8 @@ declare const _default: {
1163
1065
  ],
1164
1066
  "type": "string"
1165
1067
  },
1166
- "legend": {
1167
- "description": "Legend styling",
1168
- "properties": {
1169
- "fontSize": {
1170
- "description": "Legend font size in px",
1171
- "examples": [
1172
- 12,
1173
- 16
1174
- ],
1175
- "type": "number"
1176
- },
1177
- "lineHeight": {
1178
- "description": "Legend line height in px",
1179
- "examples": [
1180
- 12,
1181
- 16,
1182
- 20
1183
- ],
1184
- "type": "number"
1185
- },
1186
- "type": {
1187
- "description": "Legend type",
1188
- "enum": [
1189
- "circle",
1190
- "line",
1191
- "normal"
1192
- ],
1193
- "examples": [
1194
- "normal",
1195
- "line",
1196
- "circle"
1197
- ],
1198
- "type": "string"
1199
- }
1200
- },
1201
- "type": "object"
1202
- },
1203
- "mainColor": {
1204
- "description": "Theme main color",
1205
- "examples": [
1206
- "rgb(123, 144, 255)",
1207
- "rgb(255, 174, 52)",
1208
- "rgb(123, 144, 255)"
1209
- ],
1210
- "type": "string"
1211
- },
1212
- "margins": {
1213
- "description": "Dashboard vertical and horizontal margins",
1214
- "examples": [
1215
- [
1216
- 16,
1217
- 16
1218
- ],
1219
- [
1220
- 20,
1221
- 20
1222
- ]
1223
- ],
1224
- "items": [
1225
- {
1226
- "type": "number"
1227
- },
1228
- {
1229
- "type": "number"
1230
- }
1231
- ],
1232
- "maxItems": 2,
1233
- "minItems": 2,
1234
- "type": "array"
1235
- },
1236
- "name": {
1237
- "description": "Theme name",
1238
- "examples": [
1239
- "manual"
1240
- ],
1241
- "type": "string"
1242
- },
1243
1068
  "title": {
1244
- "description": "Title styling",
1069
+ "description": "Custom title styling",
1245
1070
  "properties": {
1246
1071
  "align": {
1247
1072
  "description": "Title align",
@@ -1309,51 +1134,8 @@ declare const _default: {
1309
1134
  },
1310
1135
  "type": "object"
1311
1136
  },
1312
- "tooltip": {
1313
- "description": "Tooltip styling",
1314
- "properties": {
1315
- "background": {
1316
- "description": "Tooltip's background",
1317
- "examples": [
1318
- "rgb(248, 248, 248)",
1319
- "rgb(248, 248, 248)",
1320
- "rgb(130, 128, 128)",
1321
- "rgb(61, 61, 61)"
1322
- ],
1323
- "type": "string"
1324
- },
1325
- "fontSize": {
1326
- "description": "Tooltip's font size in px",
1327
- "examples": [
1328
- 12,
1329
- 16,
1330
- 20
1331
- ],
1332
- "type": "number"
1333
- },
1334
- "lineHeight": {
1335
- "description": "Tooltip's line height in px",
1336
- "examples": [
1337
- 12,
1338
- 16,
1339
- 20
1340
- ],
1341
- "type": "number"
1342
- },
1343
- "opacity": {
1344
- "description": "Tooltip's opacity",
1345
- "examples": [
1346
- 0.5,
1347
- 0.8,
1348
- 1
1349
- ],
1350
- "type": "number"
1351
- }
1352
- },
1353
- "type": "object"
1354
- },
1355
1137
  "type": {
1356
- "description": "Theme type",
1138
+ "description": "It should be \"custom\" if custom theme id is specified or if you specify custom theme options to set the theme. Skip it otherwise.",
1357
1139
  "examples": [
1358
1140
  "custom"
1359
1141
  ],