@luzmo/dashboard-contents-types 1.0.18 → 1.0.19

package/assets/json-schemas/date-filter-options.schema.json.d.ts

@@ -1,5 +1,5 @@
 declare const _default: {
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.97/date-filter-options.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.98/date-filter-options.schema.json",
     "$schema": "http://json-schema.org/draft-07/schema#",
     "properties": {
         "annotate": {
@@ -12,7 +12,12 @@ declare const _default: {
                             "type": "boolean"
                         },
                         "content": {
-                            "description": "Information tooltip content in format {locale: \"content\"}, for example, {en: \"Content\"}",
+                            "description": "Information tooltip content in format {<locale>: \"content\"}",
+                            "examples": [
+                                {
+                                    "en": "Content"
+                                }
+                            ],
                             "type": "object"
                         },
                         "position": {
@@ -232,6 +237,7 @@ declare const _default: {
                                                         "currency",
                                                         "duration",
                                                         "hierarchy_element_expression",
+                                                        "interval",
                                                         "ip_address",
                                                         "topography"
                                                     ],
@@ -272,7 +278,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"
@@ -341,7 +351,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": {
@@ -374,6 +390,207 @@ 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": {
+                                                                    "type": "object"
+                                                                },
+                                                                "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": {
+                                                                    "type": "object"
+                                                                },
+                                                                "order": {
+                                                                    "type": "number"
+                                                                },
+                                                                "securable_id": {
+                                                                    "type": "string"
+                                                                },
+                                                                "source_name": {
+                                                                    "type": "string"
+                                                                },
+                                                                "subtype": {
+                                                                    "enum": [
+                                                                        "coordinates",
+                                                                        "currency",
+                                                                        "duration",
+                                                                        "hierarchy_element_expression",
+                                                                        "interval",
+                                                                        "ip_address",
+                                                                        "topography"
+                                                                    ],
+                                                                    "type": "string"
+                                                                },
+                                                                "type": {
+                                                                    "enum": [
+                                                                        "array[datetime]",
+                                                                        "array[hierarchy]",
+                                                                        "array[numeric]",
+                                                                        "array[spatial]",
+                                                                        "datetime",
+                                                                        "hierarchy",
+                                                                        "numeric",
+                                                                        "spatial"
+                                                                    ],
+                                                                    "type": "string"
+                                                                },
+                                                                "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"
@@ -382,6 +599,14 @@ declare const _default: {
                                                     "description": "Number of periods",
                                                     "type": "number"
                                                 },
+                                                "rangeType": {
+                                                    "description": "Range type",
+                                                    "enum": [
+                                                        "relative",
+                                                        "user-defined"
+                                                    ],
+                                                    "type": "string"
+                                                },
                                                 "type": {
                                                     "description": "Period over period comparison type",
                                                     "enum": [
@@ -407,6 +632,7 @@ declare const _default: {
                                                         "currency",
                                                         "duration",
                                                         "hierarchy_element_expression",
+                                                        "interval",
                                                         "ip_address",
                                                         "topography"
                                                     ],
@@ -777,7 +1003,7 @@ declare const _default: {
             "type": "string"
         },
         "title": {
-            "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}. It's applied if the title is displayed.",
+            "description": "Title in format { <locale>: \"title\"}. It's applied if the title is displayed.",
             "examples": [
                 {
                     "en": "Title"

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

@@ -1,7 +1,32 @@
 declare const _default: {
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.97/date-filter-slots.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.98/date-filter-slots.schema.json",
     "$schema": "http://json-schema.org/draft-07/schema#",
     "definitions": {
+        "ColumnSubtype": {
+            "enum": [
+                "coordinates",
+                "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": {
@@ -61,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": {
@@ -88,7 +119,7 @@ declare const _default: {
                     "type": "string"
                 },
                 "periodOverPeriod": {
-                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.97/date-filter-slots.schema.json#/definitions/PeriodOverPeriod",
+                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/date-filter-slots.schema.json#/definitions/PeriodOverPeriod",
                     "description": "Settings to configure period over period comparison. It can be used only in a measure slot."
                 },
                 "subtype": {
@@ -126,6 +157,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/date-filter-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/date-filter-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/date-filter-slots.schema.json#/definitions/ColumnSubtype"
+                                },
+                                "type": {
+                                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/date-filter-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"
@@ -134,8 +347,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/date-filter-slots.schema.json#/definitions/PeriodOverPeriodType",
+                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/date-filter-slots.schema.json#/definitions/PeriodOverPeriodType",
                     "description": "Period over period comparison type"
                 }
             },
@@ -151,13 +372,16 @@ declare const _default: {
             ],
             "type": "string"
         },
+        "Record<string,string>": {
+            "type": "object"
+        },
         "TimeSlot": {
             "description": "Time slot definition of the date filter. It can accept only datetime type column, and it's a required slot.\nThis can include multiple time slots to filter on multiple columns at once.",
             "properties": {
                 "content": {
                     "description": "Time slot definition",
                     "items": {
-                        "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.97/date-filter-slots.schema.json#/definitions/DateTimeSlotContent"
+                        "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/date-filter-slots.schema.json#/definitions/DateTimeSlotContent"
                     },
                     "type": "array"
                 },
@@ -172,7 +396,7 @@ declare const _default: {
     },
     "description": "Data definition of the Date filter",
     "items": {
-        "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.97/date-filter-slots.schema.json#/definitions/TimeSlot"
+        "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.98/date-filter-slots.schema.json#/definitions/TimeSlot"
     },
     "maxItems": 1,
     "type": "array"

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