@luzmo/dashboard-contents-types 1.0.4 → 1.0.6

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 All notable changes to this project will be documented in this file.
 
+## [1.0.6] - 2024-11-22
+
+### Updates
+
+- New JSON schemas and types for dashboard contents
+
+## [1.0.5] - 2024-11-18
+
+### Updates
+
+- Expose slot configs for charts
+
 ## [1.0.4] - 2024-11-14
 
 ### Updates

package/assets/json-schemas/area-chart-options.schema.json.d.ts

@@ -1056,11 +1056,11 @@ declare const _default: {
                                                     "type": "number"
                                                 },
                                                 "type": {
-                                                    "description": "Period over period comparison type:\n'none' - turned off,\n'past' - absolute value comparison to the past,\n'change' - percentage change comparison to the past",
+                                                    "description": "Period over period comparison type",
                                                     "enum": [
-                                                        "change",
                                                         "none",
-                                                        "past"
+                                                        "past",
+                                                        "percentageChange"
                                                     ],
                                                     "type": "string"
                                                 }
@@ -1168,7 +1168,7 @@ declare const _default: {
             "type": "string"
         },
         "legend": {
-            "description": "Legend options",
+            "description": "Legend options, they are applied if the legend is displayed",
             "properties": {
                 "position": {
                     "description": "Position of the legend. Only available when the legend is shown.",
@@ -1337,7 +1337,7 @@ declare const _default: {
                     "description": "Custom border styling",
                     "properties": {
                         "border-bottom-width": {
-                            "description": "Border bottom width",
+                            "description": "Border bottom width, it is visible when a border style and color are set",
                             "examples": [
                                 "0px",
                                 "1px",
@@ -1346,7 +1346,7 @@ declare const _default: {
                             "type": "string"
                         },
                         "border-color": {
-                            "description": "Border color",
+                            "description": "Border color, it is visible when a border style and width are set",
                             "examples": [
                                 "rgba(216, 216, 216, 1)",
                                 "rgb(147, 146, 148)"
@@ -1354,7 +1354,7 @@ declare const _default: {
                             "type": "string"
                         },
                         "border-left-width": {
-                            "description": "Border left width",
+                            "description": "Border left width, it is visible when a border style and color are set",
                             "examples": [
                                 "0px",
                                 "1px",
@@ -1372,7 +1372,7 @@ declare const _default: {
                             "type": "string"
                         },
                         "border-right-width": {
-                            "description": "Border right width",
+                            "description": "Border right width, it is visible when a border style and color are set",
                             "examples": [
                                 "0px",
                                 "1px",
@@ -1381,7 +1381,7 @@ declare const _default: {
                             "type": "string"
                         },
                         "border-style": {
-                            "description": "Border style",
+                            "description": "Border style, it is visible when a border color and width are set",
                             "examples": [
                                 "none",
                                 "solid",
@@ -1391,7 +1391,7 @@ declare const _default: {
                             "type": "string"
                         },
                         "border-top-width": {
-                            "description": "Border top width",
+                            "description": "Border top width, it is visible when a border style and color are set",
                             "examples": [
                                 "0px",
                                 "1px",
@@ -1433,12 +1433,15 @@ declare const _default: {
                     "type": "object"
                 },
                 "colors": {
-                    "description": "Custom color palette",
+                    "description": "Custom color palette, an array of colors which may affect different areas of a chart, for example, lines, bars, etc.",
                     "examples": [
                         [
-                            "rgb(68, 52, 255)",
-                            "rgb(68, 52, 255)",
-                            "rgb(218, 214, 255)"
+                            "red",
+                            "green",
+                            "blue",
+                            "yellow",
+                            "orange",
+                            "purple"
                         ]
                     ],
                     "items": {
@@ -1449,19 +1452,6 @@ declare const _default: {
                 "font": {
                     "description": "Custom font styling",
                     "properties": {
-                        "font-style": {
-                            "const": "normal",
-                            "description": "Use it to reset the font style to \"normal\"",
-                            "type": "string"
-                        },
-                        "font-weight": {
-                            "description": "Font weight",
-                            "examples": [
-                                400,
-                                700
-                            ],
-                            "type": "number"
-                        },
                         "fontFamily": {
                             "description": "Font family",
                             "examples": [
@@ -1474,7 +1464,7 @@ declare const _default: {
                             "type": "string"
                         },
                         "fontSize": {
-                            "description": "Font size in px",
+                            "description": "Font size in px, if not set, it will be inherited from the theme. It can be overridden if more specific \"fontSize\" is set, for example, \"fontSize\" inside options like \"title\", \"axis\", \"legend\", \"tooltip\", etc.",
                             "examples": [
                                 10,
                                 15,
@@ -1503,10 +1493,10 @@ declare const _default: {
                     "type": "string"
                 },
                 "legend": {
-                    "description": "Custom legend styling",
+                    "description": "Custom legend styling, it's applied if the legend is displayed",
                     "properties": {
                         "fontSize": {
-                            "description": "Legend font size in px",
+                            "description": "Legend font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
                             "examples": [
                                 12,
                                 16
@@ -1540,7 +1530,7 @@ declare const _default: {
                     "type": "object"
                 },
                 "title": {
-                    "description": "Custom title styling",
+                    "description": "Custom title styling, it's applied if the title is displayed",
                     "properties": {
                         "align": {
                             "description": "Title align",
@@ -1573,7 +1563,7 @@ declare const _default: {
                             "type": "boolean"
                         },
                         "fontSize": {
-                            "description": "Title's font size in px",
+                            "description": "Title's font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
                             "examples": [
                                 16,
                                 20
@@ -1609,7 +1599,7 @@ declare const _default: {
                     "type": "object"
                 },
                 "tooltip": {
-                    "description": "Custom tooltip styling",
+                    "description": "Custom tooltip styling, it's applied if the tooltip is turned on",
                     "properties": {
                         "background": {
                             "description": "Tooltip's background",
@@ -1622,16 +1612,7 @@ declare const _default: {
                             "type": "string"
                         },
                         "fontSize": {
-                            "description": "Tooltip's font size in px",
-                            "examples": [
-                                12,
-                                16,
-                                20
-                            ],
-                            "type": "number"
-                        },
-                        "lineHeight": {
-                            "description": "Tooltip's line height in px",
+                            "description": "Tooltip's font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
                             "examples": [
                                 12,
                                 16,
@@ -1640,7 +1621,7 @@ declare const _default: {
                             "type": "number"
                         },
                         "opacity": {
-                            "description": "Tooltip's opacity",
+                            "description": "Tooltip's opacity, it should be between 0 and 1, for example, 0.8",
                             "examples": [
                                 0.5,
                                 0.8,
@@ -1670,7 +1651,7 @@ declare const _default: {
             "type": "string"
         },
         "title": {
-            "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}",
+            "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}. It's applied if the title is displayed.",
             "examples": [
                 {
                     "en": "Title"
@@ -1681,6 +1662,7 @@ declare const _default: {
     },
     "type": "object"
 }
+
 ;
 
 export default _default;

package/assets/json-schemas/area-chart-slots.schema.json.d.ts

@@ -98,31 +98,8 @@ declare const _default: {
                     "type": "string"
                 },
                 "periodOverPeriod": {
-                    "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
-                    "properties": {
-                        "level": {
-                            "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
-                            "type": "number"
-                        },
-                        "periodToDate": {
-                            "description": "Turn ON/OFF period to date comparison",
-                            "type": "boolean"
-                        },
-                        "quantity": {
-                            "description": "Number of periods",
-                            "type": "number"
-                        },
-                        "type": {
-                            "description": "Period over period comparison type:\n'none' - turned off,\n'past' - absolute value comparison to the past,\n'change' - percentage change comparison to the past",
-                            "enum": [
-                                "change",
-                                "none",
-                                "past"
-                            ],
-                            "type": "string"
-                        }
-                    },
-                    "type": "object"
+                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/area-chart-slots.schema.json#/definitions/PeriodOverPeriod",
+                    "description": "Settings to configure period over period comparison. It can be used only in a measure slot."
                 },
                 "subtype": {
                     "description": "There's no subtype for \"datetime\", it can be null or omitted",
@@ -212,31 +189,8 @@ declare const _default: {
                     ]
                 },
                 "periodOverPeriod": {
-                    "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
-                    "properties": {
-                        "level": {
-                            "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
-                            "type": "number"
-                        },
-                        "periodToDate": {
-                            "description": "Turn ON/OFF period to date comparison",
-                            "type": "boolean"
-                        },
-                        "quantity": {
-                            "description": "Number of periods",
-                            "type": "number"
-                        },
-                        "type": {
-                            "description": "Period over period comparison type:\n'none' - turned off,\n'past' - absolute value comparison to the past,\n'change' - percentage change comparison to the past",
-                            "enum": [
-                                "change",
-                                "none",
-                                "past"
-                            ],
-                            "type": "string"
-                        }
-                    },
-                    "type": "object"
+                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/area-chart-slots.schema.json#/definitions/PeriodOverPeriod",
+                    "description": "Settings to configure period over period comparison. It can be used only in a measure slot."
                 },
                 "subtype": {
                     "anyOf": [
@@ -445,31 +399,8 @@ declare const _default: {
                     "type": "object"
                 },
                 "periodOverPeriod": {
-                    "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
-                    "properties": {
-                        "level": {
-                            "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
-                            "type": "number"
-                        },
-                        "periodToDate": {
-                            "description": "Turn ON/OFF period to date comparison",
-                            "type": "boolean"
-                        },
-                        "quantity": {
-                            "description": "Number of periods",
-                            "type": "number"
-                        },
-                        "type": {
-                            "description": "Period over period comparison type:\n'none' - turned off,\n'past' - absolute value comparison to the past,\n'change' - percentage change comparison to the past",
-                            "enum": [
-                                "change",
-                                "none",
-                                "past"
-                            ],
-                            "type": "string"
-                        }
-                    },
-                    "type": "object"
+                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/area-chart-slots.schema.json#/definitions/PeriodOverPeriod",
+                    "description": "Settings to configure period over period comparison. It can be used only in a measure slot."
                 },
                 "subtype": {
                     "anyOf": [
@@ -499,6 +430,36 @@ declare const _default: {
             },
             "type": "object"
         },
+        "PeriodOverPeriod": {
+            "properties": {
+                "level": {
+                    "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
+                    "type": "number"
+                },
+                "periodToDate": {
+                    "description": "Turn ON/OFF period to date comparison",
+                    "type": "boolean"
+                },
+                "quantity": {
+                    "description": "Number of periods",
+                    "type": "number"
+                },
+                "type": {
+                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/area-chart-slots.schema.json#/definitions/PeriodOverPeriodType",
+                    "description": "Period over period comparison type"
+                }
+            },
+            "type": "object"
+        },
+        "PeriodOverPeriodType": {
+            "description": "Period over period comparison type:\n'none' - turned off,\n'past' - absolute value comparison to the past,\n'percentageChange' - percentage change comparison to the past",
+            "enum": [
+                "none",
+                "past",
+                "percentageChange"
+            ],
+            "type": "string"
+        },
         "XAxisSlot": {
             "description": "Category slot definition of the area chart. This defines the areas on the Y-axis.",
             "properties": {

package/assets/json-schemas/bar-chart-options.schema.json.d.ts

@@ -3116,11 +3116,11 @@ declare const _default: {
                                                     "type": "number"
                                                 },
                                                 "type": {
-                                                    "description": "Period over period comparison type:\n'none' - turned off,\n'past' - absolute value comparison to the past,\n'change' - percentage change comparison to the past",
+                                                    "description": "Period over period comparison type",
                                                     "enum": [
-                                                        "change",
                                                         "none",
-                                                        "past"
+                                                        "past",
+                                                        "percentageChange"
                                                     ],
                                                     "type": "string"
                                                 }
@@ -3222,7 +3222,7 @@ declare const _default: {
             "type": "object"
         },
         "legend": {
-            "description": "Legend options",
+            "description": "Legend options, they are applied if the legend is displayed",
             "properties": {
                 "position": {
                     "description": "Position of the legend. Only available when the legend is shown.",
@@ -3481,7 +3481,7 @@ declare const _default: {
                     "description": "Custom border styling",
                     "properties": {
                         "border-bottom-width": {
-                            "description": "Border bottom width",
+                            "description": "Border bottom width, it is visible when a border style and color are set",
                             "examples": [
                                 "0px",
                                 "1px",
@@ -3490,7 +3490,7 @@ declare const _default: {
                             "type": "string"
                         },
                         "border-color": {
-                            "description": "Border color",
+                            "description": "Border color, it is visible when a border style and width are set",
                             "examples": [
                                 "rgba(216, 216, 216, 1)",
                                 "rgb(147, 146, 148)"
@@ -3498,7 +3498,7 @@ declare const _default: {
                             "type": "string"
                         },
                         "border-left-width": {
-                            "description": "Border left width",
+                            "description": "Border left width, it is visible when a border style and color are set",
                             "examples": [
                                 "0px",
                                 "1px",
@@ -3516,7 +3516,7 @@ declare const _default: {
                             "type": "string"
                         },
                         "border-right-width": {
-                            "description": "Border right width",
+                            "description": "Border right width, it is visible when a border style and color are set",
                             "examples": [
                                 "0px",
                                 "1px",
@@ -3525,7 +3525,7 @@ declare const _default: {
                             "type": "string"
                         },
                         "border-style": {
-                            "description": "Border style",
+                            "description": "Border style, it is visible when a border color and width are set",
                             "examples": [
                                 "none",
                                 "solid",
@@ -3535,7 +3535,7 @@ declare const _default: {
                             "type": "string"
                         },
                         "border-top-width": {
-                            "description": "Border top width",
+                            "description": "Border top width, it is visible when a border style and color are set",
                             "examples": [
                                 "0px",
                                 "1px",
@@ -3577,12 +3577,15 @@ declare const _default: {
                     "type": "object"
                 },
                 "colors": {
-                    "description": "Custom color palette",
+                    "description": "Custom color palette, an array of colors which may affect different areas of a chart, for example, lines, bars, etc.",
                     "examples": [
                         [
-                            "rgb(68, 52, 255)",
-                            "rgb(68, 52, 255)",
-                            "rgb(218, 214, 255)"
+                            "red",
+                            "green",
+                            "blue",
+                            "yellow",
+                            "orange",
+                            "purple"
                         ]
                     ],
                     "items": {
@@ -3593,19 +3596,6 @@ declare const _default: {
                 "font": {
                     "description": "Custom font styling",
                     "properties": {
-                        "font-style": {
-                            "const": "normal",
-                            "description": "Use it to reset the font style to \"normal\"",
-                            "type": "string"
-                        },
-                        "font-weight": {
-                            "description": "Font weight",
-                            "examples": [
-                                400,
-                                700
-                            ],
-                            "type": "number"
-                        },
                         "fontFamily": {
                             "description": "Font family",
                             "examples": [
@@ -3618,7 +3608,7 @@ declare const _default: {
                             "type": "string"
                         },
                         "fontSize": {
-                            "description": "Font size in px",
+                            "description": "Font size in px, if not set, it will be inherited from the theme. It can be overridden if more specific \"fontSize\" is set, for example, \"fontSize\" inside options like \"title\", \"axis\", \"legend\", \"tooltip\", etc.",
                             "examples": [
                                 10,
                                 15,
@@ -3647,10 +3637,10 @@ declare const _default: {
                     "type": "string"
                 },
                 "legend": {
-                    "description": "Custom legend styling",
+                    "description": "Custom legend styling, it's applied if the legend is displayed",
                     "properties": {
                         "fontSize": {
-                            "description": "Legend font size in px",
+                            "description": "Legend font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
                             "examples": [
                                 12,
                                 16
@@ -3684,7 +3674,7 @@ declare const _default: {
                     "type": "object"
                 },
                 "title": {
-                    "description": "Custom title styling",
+                    "description": "Custom title styling, it's applied if the title is displayed",
                     "properties": {
                         "align": {
                             "description": "Title align",
@@ -3717,7 +3707,7 @@ declare const _default: {
                             "type": "boolean"
                         },
                         "fontSize": {
-                            "description": "Title's font size in px",
+                            "description": "Title's font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
                             "examples": [
                                 16,
                                 20
@@ -3753,7 +3743,7 @@ declare const _default: {
                     "type": "object"
                 },
                 "tooltip": {
-                    "description": "Custom tooltip styling",
+                    "description": "Custom tooltip styling, it's applied if the tooltip is turned on",
                     "properties": {
                         "background": {
                             "description": "Tooltip's background",
@@ -3766,16 +3756,7 @@ declare const _default: {
                             "type": "string"
                         },
                         "fontSize": {
-                            "description": "Tooltip's font size in px",
-                            "examples": [
-                                12,
-                                16,
-                                20
-                            ],
-                            "type": "number"
-                        },
-                        "lineHeight": {
-                            "description": "Tooltip's line height in px",
+                            "description": "Tooltip's font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
                             "examples": [
                                 12,
                                 16,
@@ -3784,7 +3765,7 @@ declare const _default: {
                             "type": "number"
                         },
                         "opacity": {
-                            "description": "Tooltip's opacity",
+                            "description": "Tooltip's opacity, it should be between 0 and 1, for example, 0.8",
                             "examples": [
                                 0.5,
                                 0.8,
@@ -3814,7 +3795,7 @@ declare const _default: {
             "type": "string"
         },
         "title": {
-            "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}",
+            "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}. It's applied if the title is displayed.",
             "examples": [
                 {
                     "en": "Title"
@@ -3825,6 +3806,7 @@ declare const _default: {
     },
     "type": "object"
 }
+
 ;
 
 export default _default;