@luzmo/dashboard-contents-types 1.0.18 → 1.0.19

package/assets/json-schemas/heat-map-slots.schema.json.d.ts

@@ -1,5 +1,5 @@
 declare const _default: {
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.97/heat-map-slots.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.98/heat-map-slots.schema.json",
     "$schema": "http://json-schema.org/draft-07/schema#",
     "definitions": {
         "ColumnSubtype": {
@@ -8,11 +8,25 @@ declare const _default: {
                 "currency",
                 "duration",
                 "hierarchy_element_expression",
+                "interval",
                 "ip_address",
                 "topography"
             ],
             "type": "string"
         },
+        "ColumnType": {
+            "enum": [
+                "array[datetime]",
+                "array[hierarchy]",
+                "array[numeric]",
+                "array[spatial]",
+                "datetime",
+                "hierarchy",
+                "numeric",
+                "spatial"
+            ],
+            "type": "string"
+        },
         "DateTimeSlotContent": {
             "properties": {
                 "aggregationFunc": {
@@ -72,7 +86,13 @@ declare const _default: {
                     "type": "object"
                 },
                 "label": {
-                    "description": "Label in format {locale: \"label\"}, for example, {en: \"Total Revenue\"}",
+                    "description": "Label in format {<locale>: \"label\"}",
+                    "examples": [
+                        {
+                            "de": "Gesamtumsatz",
+                            "en": "Total Revenue"
+                        }
+                    ],
                     "type": "object"
                 },
                 "level": {
@@ -99,7 +119,7 @@ declare const _default: {
                     "type": "string"
                 },
                 "periodOverPeriod": {
-                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.97/heat-map-slots.schema.json#/definitions/PeriodOverPeriod",
+                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/heat-map-slots.schema.json#/definitions/PeriodOverPeriod",
                     "description": "Settings to configure period over period comparison. It can be used only in a measure slot."
                 },
                 "subtype": {
@@ -137,7 +157,7 @@ declare const _default: {
                 "content": {
                     "description": "Geo slot definition",
                     "items": {
-                        "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.97/heat-map-slots.schema.json#/definitions/SpatialSlotContent"
+                        "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/heat-map-slots.schema.json#/definitions/SpatialSlotContent"
                     },
                     "maxItems": 1,
                     "type": "array"
@@ -191,7 +211,13 @@ declare const _default: {
                     "type": "object"
                 },
                 "label": {
-                    "description": "Label in format {locale: \"label\"}, for example, {en: \"Total Revenue\"}",
+                    "description": "Label in format {<locale>: \"label\"}",
+                    "examples": [
+                        {
+                            "de": "Gesamtumsatz",
+                            "en": "Total Revenue"
+                        }
+                    ],
                     "type": "object"
                 },
                 "level": {
@@ -209,7 +235,7 @@ declare const _default: {
                     ]
                 },
                 "periodOverPeriod": {
-                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.97/heat-map-slots.schema.json#/definitions/PeriodOverPeriod",
+                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/heat-map-slots.schema.json#/definitions/PeriodOverPeriod",
                     "description": "Settings to configure period over period comparison. It can be used only in a measure slot."
                 },
                 "subtype": {
@@ -220,6 +246,7 @@ declare const _default: {
                                 "currency",
                                 "duration",
                                 "hierarchy_element_expression",
+                                "interval",
                                 "ip_address",
                                 "topography"
                             ],
@@ -247,13 +274,13 @@ declare const _default: {
                     "items": {
                         "anyOf": [
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.97/heat-map-slots.schema.json#/definitions/NumericSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/heat-map-slots.schema.json#/definitions/NumericSlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.97/heat-map-slots.schema.json#/definitions/HierarchySlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/heat-map-slots.schema.json#/definitions/HierarchySlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.97/heat-map-slots.schema.json#/definitions/DateTimeSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/heat-map-slots.schema.json#/definitions/DateTimeSlotContent"
                             }
                         ]
                     },
@@ -297,7 +324,7 @@ declare const _default: {
                             "type": "string"
                         },
                         "columnSubType": {
-                            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.97/heat-map-slots.schema.json#/definitions/ColumnSubtype",
+                            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/heat-map-slots.schema.json#/definitions/ColumnSubtype",
                             "description": "Column subtype"
                         },
                         "datasetId": {
@@ -335,7 +362,11 @@ declare const _default: {
                     "type": "string"
                 },
                 "currency": {
-                    "description": "Currency code, for example \"€\" or \"$\". It is only used when the column type is \"numeric\" and subtype is \"currency\".",
+                    "description": "Currency code. It is only used when the column type is \"numeric\" and subtype is \"currency\".",
+                    "examples": [
+                        "€",
+                        "$"
+                    ],
                     "type": [
                         "null",
                         "string"
@@ -386,11 +417,17 @@ declare const _default: {
                     "type": "object"
                 },
                 "label": {
-                    "description": "Label in format {locale: \"label\"}, for example, {en: \"Total Revenue\"}",
+                    "description": "Label in format {<locale>: \"label\"}",
+                    "examples": [
+                        {
+                            "de": "Gesamtumsatz",
+                            "en": "Total Revenue"
+                        }
+                    ],
                     "type": "object"
                 },
                 "periodOverPeriod": {
-                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.97/heat-map-slots.schema.json#/definitions/PeriodOverPeriod",
+                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/heat-map-slots.schema.json#/definitions/PeriodOverPeriod",
                     "description": "Settings to configure period over period comparison. It can be used only in a measure slot."
                 },
                 "subtype": {
@@ -401,6 +438,7 @@ declare const _default: {
                                 "currency",
                                 "duration",
                                 "hierarchy_element_expression",
+                                "interval",
                                 "ip_address",
                                 "topography"
                             ],
@@ -426,6 +464,188 @@ declare const _default: {
                     "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
                     "type": "number"
                 },
+                "offsetDateColumn": {
+                    "allOf": [
+                        {
+                            "properties": {
+                                "cardinality": {
+                                    "type": "number"
+                                },
+                                "color": {
+                                    "type": "string"
+                                },
+                                "currency": {
+                                    "properties": {
+                                        "id": {
+                                            "type": "string"
+                                        },
+                                        "name": {
+                                            "type": "string"
+                                        },
+                                        "symbol": {
+                                            "type": "string"
+                                        }
+                                    },
+                                    "type": "object"
+                                },
+                                "currency_id": {
+                                    "type": "string"
+                                },
+                                "description": {
+                                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/heat-map-slots.schema.json#/definitions/Record<string,string>"
+                                },
+                                "duration_format": {
+                                    "enum": [
+                                        "long",
+                                        "short",
+                                        "time"
+                                    ],
+                                    "type": "string"
+                                },
+                                "duration_levels": {
+                                    "items": {
+                                        "type": "number"
+                                    },
+                                    "type": "array"
+                                },
+                                "expression": {
+                                    "type": "string"
+                                },
+                                "format": {
+                                    "type": "string"
+                                },
+                                "hierarchyLevels": {
+                                    "items": {
+                                        "properties": {
+                                            "color": {
+                                                "type": "string"
+                                            },
+                                            "id": {
+                                                "type": "string"
+                                            },
+                                            "level": {
+                                                "type": "number"
+                                            },
+                                            "name": {
+                                                "type": "object"
+                                            }
+                                        },
+                                        "type": "object"
+                                    },
+                                    "type": "array"
+                                },
+                                "hierarchy_enabled": {
+                                    "type": "boolean"
+                                },
+                                "highestLevel": {
+                                    "type": "number"
+                                },
+                                "id": {
+                                    "type": "string"
+                                },
+                                "informat": {
+                                    "type": "string"
+                                },
+                                "isLabel": {
+                                    "type": "boolean"
+                                },
+                                "joins": {
+                                    "items": {
+                                        "properties": {
+                                            "currency_id": {
+                                                "type": [
+                                                    "null",
+                                                    "string"
+                                                ]
+                                            },
+                                            "hierarchy_enabled": {
+                                                "type": "boolean"
+                                            },
+                                            "id": {
+                                                "type": "string"
+                                            },
+                                            "join": {
+                                                "properties": {
+                                                    "column_id": {
+                                                        "type": "string"
+                                                    },
+                                                    "created_at": {
+                                                        "type": "string"
+                                                    },
+                                                    "joins_id": {
+                                                        "type": "string"
+                                                    },
+                                                    "subtype": {
+                                                        "type": "string"
+                                                    },
+                                                    "type": {
+                                                        "enum": [
+                                                            "exact",
+                                                            "lookup"
+                                                        ],
+                                                        "type": "string"
+                                                    },
+                                                    "update_at": {
+                                                        "type": "string"
+                                                    },
+                                                    "updated_at": {
+                                                        "type": "string"
+                                                    }
+                                                },
+                                                "type": "object"
+                                            },
+                                            "securable_id": {
+                                                "type": "string"
+                                            }
+                                        },
+                                        "type": "object"
+                                    },
+                                    "type": "array"
+                                },
+                                "level": {
+                                    "type": "number"
+                                },
+                                "lowestLevel": {
+                                    "type": "number"
+                                },
+                                "name": {
+                                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/heat-map-slots.schema.json#/definitions/Record<string,string>"
+                                },
+                                "order": {
+                                    "type": "number"
+                                },
+                                "securable_id": {
+                                    "type": "string"
+                                },
+                                "source_name": {
+                                    "type": "string"
+                                },
+                                "subtype": {
+                                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/heat-map-slots.schema.json#/definitions/ColumnSubtype"
+                                },
+                                "type": {
+                                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/heat-map-slots.schema.json#/definitions/ColumnType"
+                                },
+                                "version": {
+                                    "type": "number"
+                                },
+                                "width": {
+                                    "type": "number"
+                                }
+                            },
+                            "type": "object"
+                        },
+                        {
+                            "properties": {
+                                "datasetId": {
+                                    "type": "string"
+                                }
+                            },
+                            "type": "object"
+                        }
+                    ],
+                    "description": "Offset date column"
+                },
                 "periodToDate": {
                     "description": "Turn ON/OFF period to date comparison",
                     "type": "boolean"
@@ -434,8 +654,16 @@ declare const _default: {
                     "description": "Number of periods",
                     "type": "number"
                 },
+                "rangeType": {
+                    "description": "Range type",
+                    "enum": [
+                        "relative",
+                        "user-defined"
+                    ],
+                    "type": "string"
+                },
                 "type": {
-                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.97/heat-map-slots.schema.json#/definitions/PeriodOverPeriodType",
+                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/heat-map-slots.schema.json#/definitions/PeriodOverPeriodType",
                     "description": "Period over period comparison type"
                 }
             },
@@ -451,6 +679,9 @@ declare const _default: {
             ],
             "type": "string"
         },
+        "Record<string,string>": {
+            "type": "object"
+        },
         "SpatialSlotContent": {
             "properties": {
                 "color": {
@@ -475,7 +706,13 @@ declare const _default: {
                     "type": "boolean"
                 },
                 "label": {
-                    "description": "Label in format {locale: \"label\"}, for example, {en: \"Total Revenue\"}",
+                    "description": "Label in format {<locale>: \"label\"}",
+                    "examples": [
+                        {
+                            "de": "Gesamtumsatz",
+                            "en": "Total Revenue"
+                        }
+                    ],
                     "type": "object"
                 },
                 "subtype": {
@@ -486,6 +723,7 @@ declare const _default: {
                                 "currency",
                                 "duration",
                                 "hierarchy_element_expression",
+                                "interval",
                                 "ip_address",
                                 "topography"
                             ],
@@ -510,10 +748,10 @@ declare const _default: {
     "items": {
         "anyOf": [
             {
-                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.97/heat-map-slots.schema.json#/definitions/GeoSlot"
+                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/heat-map-slots.schema.json#/definitions/GeoSlot"
             },
             {
-                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.97/heat-map-slots.schema.json#/definitions/MeasureSlot"
+                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/heat-map-slots.schema.json#/definitions/MeasureSlot"
             }
         ]
     },

package/assets/json-schemas/heat-map.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.97/heat-map.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.98/heat-map.schema.json",
     "type": "object",
     "description": "Heat Map item",
     "properties": {
@@ -11,11 +11,11 @@ declare const _default: {
         },
         "options": {
             "description": "Options of the Heat Map item",
-            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.97/heat-map-options.schema.json"
+            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/heat-map-options.schema.json"
         },
         "slots": {
             "description": "Data definition of the Heat Map item",
-            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.97/heat-map-slots.schema.json"
+            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/heat-map-slots.schema.json"
         }
     }
 };