@luzmo/dashboard-contents-types 0.1.89 → 1.0.1

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+All notable changes to this project will be documented in this file.
+
+## [1.0.1] - 2024-10-14
+
+### Updates
+
+- Updated types
+
+## [0.1.88] - 2024-09-09
+
+- Types and JSON schemas from Luzmo dashboard contents v0.1.88

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

@@ -39,7 +39,7 @@ declare const _default: {
                     "type": "object"
                 },
                 "y": {
-                    "description": "Y2-axis options",
+                    "description": "Y-axis options",
                     "properties": {
                         "color": {
                             "description": "Y-axis color",
@@ -118,107 +118,6 @@ declare const _default: {
                         }
                     },
                     "type": "object"
-                },
-                "y2": {
-                    "description": "Y2-axis options",
-                    "properties": {
-                        "active": {
-                            "default": false,
-                            "description": "Toggle whether the Y2-axis is active",
-                            "type": "boolean"
-                        },
-                        "color": {
-                            "description": "Y2-axis color",
-                            "examples": [
-                                "#000000",
-                                "black",
-                                "rgba(0,0,0,1)"
-                            ],
-                            "type": "string"
-                        },
-                        "manualAxesRange": {
-                            "description": "Set manual axes range",
-                            "examples": [
-                                [
-                                    0,
-                                    100
-                                ]
-                            ],
-                            "items": [
-                                {
-                                    "type": "number"
-                                },
-                                {
-                                    "type": "number"
-                                }
-                            ],
-                            "maxItems": 2,
-                            "minItems": 2,
-                            "type": "array"
-                        },
-                        "measureIndexes": {
-                            "default": [
-                                1
-                            ],
-                            "description": "Array of measure indexes to be displayed on the Y2-axis",
-                            "examples": [
-                                [
-                                    1,
-                                    2
-                                ]
-                            ],
-                            "items": {
-                                "type": "number"
-                            },
-                            "type": "array"
-                        },
-                        "scale": {
-                            "description": "Y-axis scale type: linear or logarithmic",
-                            "enum": [
-                                "linear",
-                                "logarithmic"
-                            ],
-                            "type": "string"
-                        },
-                        "scaleLogBase": {
-                            "description": "Base of the logarithmic scale. Only applies if the scale is logarithmic.",
-                            "examples": [
-                                2,
-                                10
-                            ],
-                            "type": "number"
-                        },
-                        "ticksDensity": {
-                            "description": "Density of the ticks on the Y2-axis",
-                            "enum": [
-                                "compact",
-                                "normal",
-                                "sparse"
-                            ],
-                            "type": "string"
-                        },
-                        "ticksMode": {
-                            "default": "ticks",
-                            "description": "Ticks mode of the Y2-axis: hide, ticks, or gridlines",
-                            "enum": [
-                                "gridlines",
-                                "hide",
-                                "ticks"
-                            ],
-                            "type": "string"
-                        },
-                        "type": {
-                            "default": "default",
-                            "description": "Y-axis type: default, manual or variable",
-                            "enum": [
-                                "default",
-                                "manual",
-                                "variable"
-                            ],
-                            "type": "string"
-                        }
-                    },
-                    "type": "object"
                 }
             },
             "type": "object"
@@ -267,27 +166,6 @@ declare const _default: {
                         }
                     },
                     "type": "object"
-                },
-                "y2": {
-                    "description": "Another Y-axis label options",
-                    "properties": {
-                        "enabled": {
-                            "default": false,
-                            "description": "Show or hide the Y2-axis labels",
-                            "type": "boolean"
-                        },
-                        "position": {
-                            "default": "middle",
-                            "description": "Position of the Y2-axis labels",
-                            "enum": [
-                                "bottom",
-                                "middle",
-                                "top"
-                            ],
-                            "type": "string"
-                        }
-                    },
-                    "type": "object"
                 }
             },
             "type": "object"
@@ -383,35 +261,6 @@ declare const _default: {
                         }
                     },
                     "type": "object"
-                },
-                "y2": {
-                    "description": "Y-axis grid options",
-                    "properties": {
-                        "enabled": {
-                            "default": false,
-                            "description": "Show or hide the Y2-axis grid",
-                            "type": "boolean"
-                        },
-                        "opacity": {
-                            "description": "Opacity of the Y2-axis grid",
-                            "examples": [
-                                1,
-                                0.5,
-                                0.1
-                            ],
-                            "type": "number"
-                        },
-                        "style": {
-                            "description": "Style of the Y2-axis grid",
-                            "enum": [
-                                "dashed",
-                                "dotted",
-                                "solid"
-                            ],
-                            "type": "string"
-                        }
-                    },
-                    "type": "object"
                 }
             },
             "type": "object"
@@ -1005,7 +854,7 @@ declare const _default: {
                                         "aggregationWeight": {
                                             "description": "Aggregation weight. It can be used with a \"numeric\" column type.",
                                             "properties": {
-                                                "column": {
+                                                "columnId": {
                                                     "description": "Column id",
                                                     "format": "uuid",
                                                     "type": "string"
@@ -1021,7 +870,7 @@ declare const _default: {
                                                     ],
                                                     "type": "string"
                                                 },
-                                                "set": {
+                                                "datasetId": {
                                                     "description": "Dataset id",
                                                     "format": "uuid",
                                                     "type": "string"
@@ -1050,11 +899,6 @@ declare const _default: {
                                                 "string"
                                             ]
                                         },
-                                        "column": {
-                                            "description": "Column id",
-                                            "format": "uuid",
-                                            "type": "string"
-                                        },
                                         "columnHierarchies": {
                                             "anyOf": [
                                                 {
@@ -1085,6 +929,11 @@ declare const _default: {
                                                 }
                                             ]
                                         },
+                                        "columnId": {
+                                            "description": "Column id",
+                                            "format": "uuid",
+                                            "type": "string"
+                                        },
                                         "currency": {
                                             "description": "Currency code, for example \"€\" or \"$\". It is only used when the column type is \"numeric\" and subtype is \"currency\".",
                                             "type": [
@@ -1092,6 +941,11 @@ declare const _default: {
                                                 "string"
                                             ]
                                         },
+                                        "datasetId": {
+                                            "description": "Dataset id",
+                                            "format": "uuid",
+                                            "type": "string"
+                                        },
                                         "datetimeDisplayMode": {
                                             "description": "If it's set it will be used for datetime formatting together with weekStart, weekDayNameFormat, monthNameFormat",
                                             "enum": [
@@ -1137,8 +991,7 @@ declare const _default: {
                                             "type": "string"
                                         },
                                         "formula": {
-                                            "description": "Dataset formula id. Formula is an entity similar to a column. Formula can be added on the dataset details page.",
-                                            "format": "uuid",
+                                            "description": "A dataset formula id or an ad-hoc formula. A formula is an entity similar to a column. You can add formulas on the dataset details page or use ad-hoc formulas. You can find more information about formulas in the article https://academy.luzmo.com/article/52tm82oo",
                                             "type": "string"
                                         },
                                         "grandTotals": {
@@ -1184,17 +1037,39 @@ 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"
+                                        },
                                         "readonly": {
                                             "type": "boolean"
                                         },
                                         "selected": {
                                             "type": "boolean"
                                         },
-                                        "set": {
-                                            "description": "Dataset id",
-                                            "format": "uuid",
-                                            "type": "string"
-                                        },
                                         "subtype": {
                                             "anyOf": [
                                                 {
@@ -1338,6 +1213,67 @@ declare const _default: {
             },
             "type": "object"
         },
+        "loader": {
+            "description": "The loader configuration",
+            "properties": {
+                "background": {
+                    "default": "#f9f9f9",
+                    "description": "Background color of the chart loader element",
+                    "type": "string"
+                },
+                "fontColor": {
+                    "default": "#5a5a5a",
+                    "description": "Font color of the text of the chart loaders",
+                    "type": "string"
+                },
+                "locale": {
+                    "default": "en",
+                    "description": "Locale to be used if \"msg\" is set",
+                    "examples": [
+                        "en",
+                        "fr"
+                    ],
+                    "type": "string"
+                },
+                "mode": {
+                    "default": "light",
+                    "description": "Light or dark loader",
+                    "type": "string"
+                },
+                "msg": {
+                    "description": "Loading message",
+                    "examples": [
+                        "Loading dashboard..."
+                    ],
+                    "type": "string"
+                },
+                "showBranded": {
+                    "default": false,
+                    "description": "Shows the branded \"powered by\" information",
+                    "type": "boolean"
+                },
+                "spinnerBackground": {
+                    "default": "rgba(169, 169, 169, 0.14)",
+                    "description": "Background color of the spinner",
+                    "type": "string"
+                },
+                "spinnerColor": {
+                    "default": "rgba(255, 165, 0, 0.7)",
+                    "description": "Spinner color of the loader",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "locale": {
+            "default": "en",
+            "description": "Locale to be used",
+            "examples": [
+                "en",
+                "fr"
+            ],
+            "type": "string"
+        },
         "missingValue": {
             "description": "Missing value configuration",
             "properties": {
@@ -1837,6 +1773,14 @@ declare const _default: {
             },
             "type": "object"
         },
+        "timezoneId": {
+            "description": "The timezone that will be used in the dashboard. This timezone id needs to be a valid id that is available in the IANA timezone database",
+            "examples": [
+                "Europe/Brussels",
+                "America/New_York"
+            ],
+            "type": "string"
+        },
         "title": {
             "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
             "examples": [

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

@@ -29,11 +29,16 @@ declare const _default: {
                         "string"
                     ]
                 },
-                "column": {
+                "columnId": {
                     "description": "Column id",
                     "format": "uuid",
                     "type": "string"
                 },
+                "datasetId": {
+                    "description": "Dataset id",
+                    "format": "uuid",
+                    "type": "string"
+                },
                 "datetimeDisplayMode": {
                     "description": "If it's set it will be used for datetime formatting together with weekStart, weekDayNameFormat, monthNameFormat",
                     "enum": [
@@ -92,10 +97,32 @@ declare const _default: {
                     ],
                     "type": "string"
                 },
-                "set": {
-                    "description": "Dataset id",
-                    "format": "uuid",
-                    "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"
                 },
                 "subtype": {
                     "description": "There's no subtype for \"datetime\", it can be null or omitted",
@@ -143,11 +170,16 @@ declare const _default: {
                         "string"
                     ]
                 },
-                "column": {
+                "columnId": {
                     "description": "Column id",
                     "format": "uuid",
                     "type": "string"
                 },
+                "datasetId": {
+                    "description": "Dataset id",
+                    "format": "uuid",
+                    "type": "string"
+                },
                 "format": {
                     "description": "D3 format, it is used for \"numeric\" formatting (https://observablehq.com/@d3/d3-format), for \"datetime\" formatting (https://d3js.org/d3-time-format).\nIt can also be used for \"hierarchy\" formatting but when it's used in the measure slot.",
                     "type": "string"
@@ -179,10 +211,32 @@ declare const _default: {
                         "number"
                     ]
                 },
-                "set": {
-                    "description": "Dataset id",
-                    "format": "uuid",
-                    "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"
                 },
                 "subtype": {
                     "anyOf": [
@@ -292,7 +346,7 @@ declare const _default: {
                 "aggregationWeight": {
                     "description": "Aggregation weight. It can be used with a \"numeric\" column type.",
                     "properties": {
-                        "column": {
+                        "columnId": {
                             "description": "Column id",
                             "format": "uuid",
                             "type": "string"
@@ -301,7 +355,7 @@ declare const _default: {
                             "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/area-chart-slots.schema.json#/definitions/ColumnSubtype",
                             "description": "Column subtype"
                         },
-                        "set": {
+                        "datasetId": {
                             "description": "Dataset id",
                             "format": "uuid",
                             "type": "string"
@@ -330,7 +384,7 @@ declare const _default: {
                         "string"
                     ]
                 },
-                "column": {
+                "columnId": {
                     "description": "Column id",
                     "format": "uuid",
                     "type": "string"
@@ -342,6 +396,11 @@ declare const _default: {
                         "string"
                     ]
                 },
+                "datasetId": {
+                    "description": "Dataset id",
+                    "format": "uuid",
+                    "type": "string"
+                },
                 "duration": {
                     "description": "Duration definition. It's only used when the column type is \"numeric\" and subtype is \"duration\".",
                     "properties": {
@@ -369,8 +428,7 @@ declare const _default: {
                     "type": "string"
                 },
                 "formula": {
-                    "description": "Dataset formula id. Formula is an entity similar to a column. Formula can be added on the dataset details page.",
-                    "format": "uuid",
+                    "description": "A dataset formula id or an ad-hoc formula. A formula is an entity similar to a column. You can add formulas on the dataset details page or use ad-hoc formulas. You can find more information about formulas in the article https://academy.luzmo.com/article/52tm82oo",
                     "type": "string"
                 },
                 "grandTotals": {
@@ -386,10 +444,32 @@ declare const _default: {
                     "description": "Label in format {locale: \"label\"}, for example, {en: \"Total Revenue\"}",
                     "type": "object"
                 },
-                "set": {
-                    "description": "Dataset id",
-                    "format": "uuid",
-                    "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"
                 },
                 "subtype": {
                     "anyOf": [