@luzmo/dashboard-contents-types 0.1.88 → 1.0.0

package/assets/json-schemas/dropdown-filter-slots.schema.json.d.ts

@@ -1,5 +1,5 @@
 declare const _default: {
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.88/dropdown-filter-slots.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.89/dropdown-filter-slots.schema.json",
     "$schema": "http://json-schema.org/draft-07/schema#",
     "definitions": {
         "ColumnSubtype": {
@@ -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",
+                    "properties": {
+                        "level": {
+                            "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
+                            "type": "number"
+                        },
+                        "periodToDate": {
+                            "description": "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",
@@ -134,13 +161,13 @@ declare const _default: {
                     "items": {
                         "anyOf": [
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/dropdown-filter-slots.schema.json#/definitions/NumericSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/dropdown-filter-slots.schema.json#/definitions/NumericSlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/dropdown-filter-slots.schema.json#/definitions/HierarchySlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/dropdown-filter-slots.schema.json#/definitions/HierarchySlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/dropdown-filter-slots.schema.json#/definitions/DateTimeSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/dropdown-filter-slots.schema.json#/definitions/DateTimeSlotContent"
                             }
                         ]
                     },
@@ -171,11 +198,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"
@@ -207,10 +239,32 @@ declare const _default: {
                         "number"
                     ]
                 },
-                "set": {
-                    "description": "Dataset id",
-                    "format": "uuid",
-                    "type": "string"
+                "periodOverPeriod": {
+                    "description": "Settings to configure period over period comparison",
+                    "properties": {
+                        "level": {
+                            "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
+                            "type": "number"
+                        },
+                        "periodToDate": {
+                            "description": "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": [
@@ -263,16 +317,16 @@ 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"
                         },
                         "columnSubType": {
-                            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/dropdown-filter-slots.schema.json#/definitions/ColumnSubtype",
+                            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/dropdown-filter-slots.schema.json#/definitions/ColumnSubtype",
                             "description": "Column subtype"
                         },
-                        "set": {
+                        "datasetId": {
                             "description": "Dataset id",
                             "format": "uuid",
                             "type": "string"
@@ -301,7 +355,7 @@ declare const _default: {
                         "string"
                     ]
                 },
-                "column": {
+                "columnId": {
                     "description": "Column id",
                     "format": "uuid",
                     "type": "string"
@@ -313,6 +367,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": {
@@ -340,8 +399,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.",
                     "type": "string"
                 },
                 "grandTotals": {
@@ -357,10 +415,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",
+                    "properties": {
+                        "level": {
+                            "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
+                            "type": "number"
+                        },
+                        "periodToDate": {
+                            "description": "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": [
@@ -393,7 +473,7 @@ declare const _default: {
     },
     "description": "Data definition of the Dropdown filter",
     "items": {
-        "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/dropdown-filter-slots.schema.json#/definitions/DimensionSlot"
+        "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/dropdown-filter-slots.schema.json#/definitions/DimensionSlot"
     },
     "maxItems": 1,
     "type": "array"

package/assets/json-schemas/dropdown-filter.schema.json.d.ts

@@ -1,6 +1,6 @@
 declare const _default: {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.88/dropdown-filter.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.89/dropdown-filter.schema.json",
     "type": "object",
     "description": "Dropdown Filter item",
     "properties": {
@@ -11,11 +11,11 @@ declare const _default: {
         },
         "options": {
             "description": "Options of the Dropdown Filter item",
-            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/dropdown-filter-options.schema.json"
+            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/dropdown-filter-options.schema.json"
         },
         "slots": {
             "description": "Data definition of the Dropdown Filter item",
-            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/dropdown-filter-slots.schema.json"
+            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/dropdown-filter-slots.schema.json"
         }
     }
 };

package/assets/json-schemas/evolution-number-options.schema.json.d.ts

@@ -1,21 +1,17 @@
 declare const _default: {
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.88/evolution-number-options.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.89/evolution-number-options.schema.json",
     "$schema": "http://json-schema.org/draft-07/schema#",
     "properties": {
         "color": {
+            "default": "",
             "description": "The main color for the item, if omitted the default color from the theme will be used.",
+            "examples": [
+                "#FF5733",
+                "#33FF57",
+                "#5733FF"
+            ],
             "type": "string"
         },
-        "display": {
-            "description": "Title display option",
-            "properties": {
-                "title": {
-                    "description": "Show or hide the title",
-                    "type": "boolean"
-                }
-            },
-            "type": "object"
-        },
         "evolutionColor": {
             "default": "normal",
             "description": "Evolution color",
@@ -82,6 +78,11 @@ declare const _default: {
                 "fit",
                 "stretch"
             ],
+            "examples": [
+                "fit",
+                "fill",
+                "stretch"
+            ],
             "type": "string"
         },
         "imageBackgroundOpacity": {
@@ -99,7 +100,14 @@ declare const _default: {
             "type": "string"
         },
         "imageContent": {
-            "description": "Image content",
+            "default": "",
+            "description": "Image content. It's used when \"imageMode\" is \"emoji\" or \"icon\".",
+            "examples": [
+                "1f601",
+                "1f602",
+                "fa-dollar",
+                "fa-bicycle"
+            ],
             "type": "string"
         },
         "imageMode": {
@@ -641,7 +649,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"
@@ -657,7 +665,7 @@ declare const _default: {
                                                     ],
                                                     "type": "string"
                                                 },
-                                                "set": {
+                                                "datasetId": {
                                                     "description": "Dataset id",
                                                     "format": "uuid",
                                                     "type": "string"
@@ -686,11 +694,6 @@ declare const _default: {
                                                 "string"
                                             ]
                                         },
-                                        "column": {
-                                            "description": "Column id",
-                                            "format": "uuid",
-                                            "type": "string"
-                                        },
                                         "columnHierarchies": {
                                             "anyOf": [
                                                 {
@@ -721,6 +724,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": [
@@ -728,6 +736,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": [
@@ -773,8 +786,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.",
                                             "type": "string"
                                         },
                                         "grandTotals": {
@@ -820,17 +832,39 @@ declare const _default: {
                                             ],
                                             "type": "string"
                                         },
+                                        "periodOverPeriod": {
+                                            "description": "Settings to configure period over period comparison",
+                                            "properties": {
+                                                "level": {
+                                                    "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
+                                                    "type": "number"
+                                                },
+                                                "periodToDate": {
+                                                    "description": "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": [
                                                 {
@@ -952,6 +986,11 @@ declare const _default: {
         },
         "numberFontSize": {
             "description": "Number font size",
+            "examples": [
+                58,
+                14,
+                20
+            ],
             "type": "number"
         },
         "showImage": {
@@ -966,7 +1005,7 @@ declare const _default: {
         },
         "showTitle": {
             "default": true,
-            "description": "Show title",
+            "description": "Show title, a value for the title is taken from a slot content's \"label\" option",
             "type": "boolean"
         },
         "subtitle": {
@@ -1021,6 +1060,12 @@ declare const _default: {
                     "type": "string"
                 },
                 "baseFontSize": {
+                    "description": "Base font size, usually it participates in calculations related to font sizes, spacings, etc.",
+                    "examples": [
+                        13,
+                        16,
+                        20
+                    ],
                     "type": "number"
                 },
                 "borders": {
@@ -1454,15 +1499,6 @@ declare const _default: {
             },
             "type": "object"
         },
-        "title": {
-            "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
-            "examples": [
-                {
-                    "en": "Title"
-                }
-            ],
-            "type": "object"
-        },
         "titleFontSize": {
             "description": "Title font size",
             "examples": [
@@ -1482,7 +1518,11 @@ declare const _default: {
             "type": "string"
         },
         "uploadedImage": {
-            "description": "Uploaded image",
+            "default": "",
+            "description": "Uploaded image name (usually uuid), it's used when constructing a URL of an image, for example, \"https://.../thumbnail/asset/512px/${uploadedImage}.png\". It's used when \"imageMode\" is \"image\".",
+            "examples": [
+                "8e15ed25-bd9d-4f84-b839-8b219b97b0a2"
+            ],
             "type": "string"
         },
         "verticalAlignment": {