@luzmo/dashboard-contents-types 1.0.46 → 1.0.47

package/assets/json-schemas/kpi-slots.schema.json.d.ts

@@ -0,0 +1,615 @@
+declare const _default: {
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.107/kpi-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"
+        },
+        "ComparisonMeasureSlot": {
+            "description": "Comparison measure slot definition of the KPI: the measure whose change versus an earlier period is shown,\nusually the same column as the \"measure\" slot. Its content carries the \"periodOverPeriod\" configuration\n(relative offset, e.g. 1 month back). The compared period is the one selected by the date filters\napplied to the KPI, shifted back by that offset. Not meant for targets or other benchmark values.",
+            "properties": {
+                "content": {
+                    "description": "Comparison measure slot definition",
+                    "items": {
+                        "anyOf": [
+                            {
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.107/kpi-slots.schema.json#/definitions/NumericSlotContent"
+                            },
+                            {
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.107/kpi-slots.schema.json#/definitions/HierarchySlotContent"
+                            }
+                        ]
+                    },
+                    "maxItems": 1,
+                    "type": "array"
+                },
+                "name": {
+                    "const": "comparison-measure",
+                    "description": "Name of the slot",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "HierarchySlotContent": {
+            "properties": {
+                "aggregationFunc": {
+                    "description": "Basic aggregation function. It can be used when a \"hierarchy\" column is used in a measure slot.",
+                    "enum": [
+                        "count",
+                        "distinctcount"
+                    ],
+                    "type": "string"
+                },
+                "color": {
+                    "description": "Color of the column. Any column type can have it, but it's applied when a column is set as a measure and when multiple measures are defined.",
+                    "type": [
+                        "null",
+                        "string"
+                    ]
+                },
+                "columnId": {
+                    "description": "Column id",
+                    "format": "uuid",
+                    "type": "string"
+                },
+                "datasetId": {
+                    "description": "Dataset id",
+                    "format": "uuid",
+                    "type": "string"
+                },
+                "expression": {
+                    "description": "An ad-hoc, non-aggregation derived-column expression (Luzmo expression syntax with\n`{datasetId:columnId}` column tokens), used to group by / bucket a calculated value that is not\na persisted column. Aggregation calculations use `formula` (ad-hoc formula) instead.",
+                    "type": "string"
+                },
+                "field": {
+                    "description": "Property name in an inline-data record. It replaces dataset-backed source identifiers when a\nchart receives inline data.",
+                    "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"
+                },
+                "formulaId": {
+                    "description": "A formula id",
+                    "format": "uuid",
+                    "type": "string"
+                },
+                "grandTotals": {
+                    "description": "Enable or disable grand totals, they're only used in Pivot table",
+                    "properties": {
+                        "enabled": {
+                            "type": "boolean"
+                        }
+                    },
+                    "type": "object"
+                },
+                "label": {
+                    "description": "Label in format {<locale>: \"label\"}",
+                    "examples": [
+                        {
+                            "de": "Gesamtumsatz",
+                            "en": "Total Revenue"
+                        }
+                    ],
+                    "type": "object"
+                },
+                "level": {
+                    "description": "\"hierarchy\" or \"datetime\" level",
+                    "type": [
+                        "number",
+                        "null"
+                    ]
+                },
+                "lowestLevel": {
+                    "description": "Lowest \"hierarchy\" or \"datetime\" level",
+                    "type": [
+                        "null",
+                        "number"
+                    ]
+                },
+                "periodOverPeriod": {
+                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.107/kpi-slots.schema.json#/definitions/PeriodOverPeriod",
+                    "description": "Settings to configure period over period comparison. It can be used only in a measure slot."
+                },
+                "subtype": {
+                    "anyOf": [
+                        {
+                            "enum": [
+                                "coordinates",
+                                "currency",
+                                "duration",
+                                "hierarchy_element_expression",
+                                "interval",
+                                "ip_address",
+                                "topography"
+                            ],
+                            "type": "string"
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ],
+                    "description": "Column subtype"
+                },
+                "type": {
+                    "const": "hierarchy",
+                    "description": "\"hierarchy\" column type",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "MeasureSlot": {
+            "description": "Measure slot definition of the KPI: the main number, calculated for the period selected by the date filters applied to the KPI.",
+            "properties": {
+                "content": {
+                    "description": "Measure slot definition",
+                    "items": {
+                        "anyOf": [
+                            {
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.107/kpi-slots.schema.json#/definitions/NumericSlotContent"
+                            },
+                            {
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.107/kpi-slots.schema.json#/definitions/HierarchySlotContent"
+                            }
+                        ]
+                    },
+                    "maxItems": 1,
+                    "type": "array"
+                },
+                "name": {
+                    "const": "measure",
+                    "description": "Name of the slot",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "NumericSlotContent": {
+            "properties": {
+                "aggregationFunc": {
+                    "description": "Aggregation function. It can be used with a \"numeric\" column type, and with some limitations with \"hierarchy\" and \"datetime\" column types.",
+                    "enum": [
+                        "average",
+                        "count",
+                        "cumulativesum",
+                        "distinctcount",
+                        "histogram",
+                        "max",
+                        "median",
+                        "min",
+                        "rate",
+                        "stddev",
+                        "sum",
+                        "weightedaverage"
+                    ],
+                    "type": "string"
+                },
+                "aggregationWeight": {
+                    "description": "Aggregation weight. It can be used with a \"numeric\" column type.",
+                    "properties": {
+                        "columnId": {
+                            "description": "Column id",
+                            "format": "uuid",
+                            "type": "string"
+                        },
+                        "columnSubType": {
+                            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.107/kpi-slots.schema.json#/definitions/ColumnSubtype",
+                            "description": "Column subtype"
+                        },
+                        "datasetId": {
+                            "description": "Dataset id",
+                            "format": "uuid",
+                            "type": "string"
+                        }
+                    },
+                    "type": "object"
+                },
+                "bins": {
+                    "description": "Bin definition. It can be used when a \"numeric\" column is used as a category.",
+                    "properties": {
+                        "enabled": {
+                            "description": "Enable or disable binning",
+                            "type": "boolean"
+                        },
+                        "number": {
+                            "description": "Defines the range of the bins",
+                            "type": "number"
+                        }
+                    },
+                    "type": "object"
+                },
+                "color": {
+                    "description": "Color of the column. Any column type can have it, but it's applied when a column is set as a measure and when multiple measures are defined.",
+                    "type": [
+                        "null",
+                        "string"
+                    ]
+                },
+                "columnId": {
+                    "description": "Column id",
+                    "format": "uuid",
+                    "type": "string"
+                },
+                "currency": {
+                    "description": "Currency code. It is only used when the column type is \"numeric\" and subtype is \"currency\".",
+                    "examples": [
+                        "€",
+                        "$"
+                    ],
+                    "type": [
+                        "null",
+                        "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": {
+                        "format": {
+                            "description": "Duration format",
+                            "enum": [
+                                "long",
+                                "short",
+                                "time"
+                            ],
+                            "type": "string"
+                        },
+                        "levels": {
+                            "description": "Duration levels used",
+                            "items": {
+                                "type": "number"
+                            },
+                            "type": "array"
+                        }
+                    },
+                    "type": "object"
+                },
+                "expression": {
+                    "description": "An ad-hoc, non-aggregation derived-column expression (Luzmo expression syntax with\n`{datasetId:columnId}` column tokens), used to group by / bucket a calculated value that is not\na persisted column. Aggregation calculations use `formula` (ad-hoc formula) instead.",
+                    "type": "string"
+                },
+                "field": {
+                    "description": "Property name in an inline-data record. It replaces dataset-backed source identifiers when a\nchart receives inline data.",
+                    "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"
+                },
+                "formula": {
+                    "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"
+                },
+                "formulaId": {
+                    "description": "A formula id",
+                    "format": "uuid",
+                    "type": "string"
+                },
+                "grandTotals": {
+                    "description": "Enable or disable grand totals, they're only used in Pivot table",
+                    "properties": {
+                        "enabled": {
+                            "type": "boolean"
+                        }
+                    },
+                    "type": "object"
+                },
+                "label": {
+                    "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.107/kpi-slots.schema.json#/definitions/PeriodOverPeriod",
+                    "description": "Settings to configure period over period comparison. It can be used only in a measure slot."
+                },
+                "subtype": {
+                    "anyOf": [
+                        {
+                            "enum": [
+                                "coordinates",
+                                "currency",
+                                "duration",
+                                "hierarchy_element_expression",
+                                "interval",
+                                "ip_address",
+                                "topography"
+                            ],
+                            "type": "string"
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ],
+                    "description": "Column subtype"
+                },
+                "type": {
+                    "const": "numeric",
+                    "description": "\"numeric\" column / formula type",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "PeriodOverPeriod": {
+            "properties": {
+                "level": {
+                    "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
+                    "type": "number"
+                },
+                "offsetDateColumn": {
+                    "allOf": [
+                        {
+                            "properties": {
+                                "ai_context": {
+                                    "type": [
+                                        "null",
+                                        "string"
+                                    ]
+                                },
+                                "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.107/kpi-slots.schema.json#/definitions/Record%3Cstring%2Cstring%3E"
+                                },
+                                "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.107/kpi-slots.schema.json#/definitions/Record%3Cstring%2Cstring%3E"
+                                },
+                                "order": {
+                                    "type": "number"
+                                },
+                                "securable_id": {
+                                    "type": "string"
+                                },
+                                "source_name": {
+                                    "type": "string"
+                                },
+                                "subtype": {
+                                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.107/kpi-slots.schema.json#/definitions/ColumnSubtype"
+                                },
+                                "type": {
+                                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.107/kpi-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"
+                },
+                "quantity": {
+                    "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.107/kpi-slots.schema.json#/definitions/PeriodOverPeriodType",
+                    "description": "Period over period comparison type"
+                }
+            },
+            "type": "object"
+        },
+        "PeriodOverPeriodType": {
+            "description": "Period over period comparison type:\n'none' - turned off,\n'past' - absolute value comparison to the past,\n'absoluteChange' - absolute change comparison to the past,\n'percentageChange' - percentage change comparison to the past",
+            "enum": [
+                "none",
+                "past",
+                "absoluteChange",
+                "percentageChange"
+            ],
+            "type": "string"
+        },
+        "Record<string,string>": {
+            "type": "object"
+        }
+    },
+    "description": "Data definition of the KPI",
+    "items": {
+        "anyOf": [
+            {
+                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.107/kpi-slots.schema.json#/definitions/MeasureSlot"
+            },
+            {
+                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.107/kpi-slots.schema.json#/definitions/ComparisonMeasureSlot"
+            }
+        ]
+    },
+    "maxItems": 2,
+    "type": "array"
+}
+
+;
+
+export default _default;