@luzmo/dashboard-contents-types 1.0.18 → 1.0.19

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 All notable changes to this project will be documented in this file.
 
+## [1.0.19] - 2025-10-29
+
+### Updates
+
+- Remove deprecated `ItemType`, `VisualItem`, `ChartItem`, `ControlItem`, `ContentItem` types.
+- Add context configs per each viz item.
+- Update Flex documentation.
+
 ## [1.0.18] - 2025-09-02
 
 ### Updates

package/LICENSE

@@ -1,7 +1,7 @@
-Copyright © 2024 Luzmo
+Copyright © 2025 Luzmo
 
 All rights reserved.
-Luzmo Types library (@luzmo/dashboard-content-types) must be used according to the Luzmo Terms of Service.
+Luzmo Types library (@luzmo/dashboard-contents-types) must be used according to the Luzmo Terms of Service.
 
 This license allows users with a current active Luzmo account to use the Luzmo Types library.
 This license terminates automatically if a user no longer has an active Luzmo account.

package/README.md

@@ -7,7 +7,7 @@ This packages contains different TypeScript types and JSON schemas for Luzmo das
 Here is a list of some content item TypeScript types. Additional types are also available in the package.
 
 | Type                           | Description                                           |
-|--------------------------------|-------------------------------------------------------|
+| ------------------------------ | ----------------------------------------------------- |
 | `AreaChart`                    | An Area Chart type.                                   |
 | `AreaChartViewOptions`         | An Area Chart options type.                           |
 | `AreaChartSlots`               | An Area Chart slots type.                             |
@@ -28,7 +28,7 @@ Here is a list of some content item TypeScript types. Additional types are also
 | `ChoroplethMapSlots`           | A Choropleth Map slots type.                          |
 | `CircularGauge`                | A Circular Gauge type.                                |
 | `CircularGaugeViewOptions`     | A Circular Gauge options type.                        |
-| `CircularGaugeSlots`           | A Circular Gauge slots type.                          | 
+| `CircularGaugeSlots`           | A Circular Gauge slots type.                          |
 | `ColumnChart`                  | A Column Chart type.                                  |
 | `ColumnChartViewOptions`       | A Column Chart options type.                          |
 | `ColumnChartSlots`             | A Column Chart slots type.                            |
@@ -38,9 +38,9 @@ Here is a list of some content item TypeScript types. Additional types are also
 | `ConditionalNumber`            | A Conditional Number type.                            |
 | `ConditionalNumberViewOptions` | A Conditional Number options type.                    |
 | `ConditionalNumberSlots`       | A Conditional Number slots type.                      |
-| `DateFilter`                   | A Date Filter type.                                   |
+| `DateComparisonFilter`         | A Date Filter type.                                   |
 | `DateFilterViewOptions`        | A Date Filter options type.                           |
-| `DateFilterSlots`              | A Date Filter slots type.                             |
+| `DateComparisonFilterSlots`    | A Date Filter slots type.                             |
 | `DonutChart`                   | A Donut Chart type.                                   |
 | `DonutChartViewOptions`        | A Donut Chart options type.                           |
 | `DonutChartSlots`              | A Donut Chart slots type.                             |
@@ -112,21 +112,25 @@ Here is a list of some content item TypeScript types. Additional types are also
 
 Each content item above has a corresponding JSON schema. Here’s an example of importing the JSON schema for the Bar Chart:
 
-```typescript 
-import { BarChartJSONSchema, BarChartOptionsJSONSchema, BarChartSlotsJSONSchema } from '@luzmo/dashboard-contents-types';
+```typescript
+import {
+  BarChartJSONSchema,
+  BarChartOptionsJSONSchema,
+  BarChartSlotsJSONSchema
+} from '@luzmo/dashboard-contents-types';
 
 console.log(BarChartJSONSchema);
 console.log(BarChartOptionsJSONSchema);
 console.log(BarChartSlotsJSONSchema);
 ```
 
-There is also an object that contains all the JSON schemas for the content items. In this object, each schema name serves as a key, with the corresponding schema as its value. Here’s an example: 
+There is also an object that contains all the JSON schemas for the content items. In this object, each schema name serves as a key, with the corresponding schema as its value. Here’s an example:
 
-```typescript 
+```typescript
 import { JSON_SCHEMAS } from '@luzmo/dashboard-contents-types';
 
 console.log(JSON_SCHEMAS);
 console.log(JSON_SCHEMAS['text-options.schema.json']);
 ```
 
-Using the `JSON_SCHEMAS` object will significantly increase the bundle size, so whenever possible import only the needed schemas, as demonstrated in the Bar Chart example above.
+**Important:** Using the `JSON_SCHEMAS` object will significantly increase the bundle size, so whenever possible import only the needed schemas, as demonstrated in the Bar Chart example above.

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

@@ -1,5 +1,5 @@
 declare const _default: {
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.97/area-chart-options.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.98/area-chart-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": {
@@ -236,11 +241,11 @@ declare const _default: {
                     "properties": {
                         "enabled": {
                             "default": false,
-                            "description": "Show or hide the X-axis grid",
+                            "description": "Show or hide the axis grid",
                             "type": "boolean"
                         },
                         "opacity": {
-                            "description": "Opacity of the X-axis grid",
+                            "description": "Opacity of the axis grid",
                             "examples": [
                                 1,
                                 0.5,
@@ -249,7 +254,7 @@ declare const _default: {
                             "type": "number"
                         },
                         "style": {
-                            "description": "Style of the X-axis grid",
+                            "description": "Style of the axis grid",
                             "enum": [
                                 "dashed",
                                 "dotted",
@@ -265,11 +270,11 @@ declare const _default: {
                     "properties": {
                         "enabled": {
                             "default": false,
-                            "description": "Show or hide the Y-axis grid",
+                            "description": "Show or hide the axis grid",
                             "type": "boolean"
                         },
                         "opacity": {
-                            "description": "Opacity of the Y-axis grid",
+                            "description": "Opacity of the axis grid",
                             "examples": [
                                 1,
                                 0.5,
@@ -278,7 +283,7 @@ declare const _default: {
                             "type": "number"
                         },
                         "style": {
-                            "description": "Style of the Y-axis grid",
+                            "description": "Style of the axis grid",
                             "enum": [
                                 "dashed",
                                 "dotted",
@@ -372,94 +377,97 @@ declare const _default: {
                     "type": "boolean"
                 },
                 "customEvents": {
-                    "anyOf": [
-                        {
-                            "properties": {
-                                "events": {
-                                    "items": {
-                                        "description": "Custom event configuration",
-                                        "properties": {
-                                            "label": {
-                                                "description": "Label in format {locale: \"label\"}, for example, {en: \"Total Revenue\"}",
-                                                "type": "object"
-                                            },
-                                            "name": {
-                                                "description": "Custom event name",
-                                                "type": "string"
+                    "default": null,
+                    "description": "Custom events interactivity option",
+                    "properties": {
+                        "events": {
+                            "items": {
+                                "description": "Custom event configuration",
+                                "properties": {
+                                    "label": {
+                                        "description": "Label in format {<locale>: \"label\"}, for example",
+                                        "examples": [
+                                            {
+                                                "en": "Total Revenue"
                                             }
-                                        },
+                                        ],
                                         "type": "object"
                                     },
-                                    "type": "array"
+                                    "name": {
+                                        "description": "Custom event name",
+                                        "type": "string"
+                                    }
                                 },
-                                "extraData": {
-                                    "items": {
-                                        "properties": {
-                                            "aggregation": {
-                                                "description": "Aggregation query type",
-                                                "enum": [
-                                                    "average",
-                                                    "count",
-                                                    "cumulativesum",
-                                                    "distinctcount",
-                                                    "histogram",
-                                                    "max",
-                                                    "median",
-                                                    "min",
-                                                    "rate",
-                                                    "stddev",
-                                                    "sum",
-                                                    "weightedaverage"
-                                                ],
-                                                "type": "string"
-                                            },
-                                            "columnId": {
-                                                "description": "Column id",
-                                                "format": "uuid",
-                                                "type": "string"
-                                            },
-                                            "datasetId": {
-                                                "description": "Dataset id",
-                                                "format": "uuid",
-                                                "type": "string"
-                                            },
-                                            "formulaId": {
-                                                "description": "Formula id",
-                                                "format": "uuid",
-                                                "type": "string"
-                                            },
-                                            "label": {
-                                                "description": "Label",
-                                                "type": "string"
-                                            },
-                                            "weightedColumnId": {
-                                                "description": "Weighted column id",
-                                                "format": "uuid",
-                                                "type": "string"
-                                            },
-                                            "weightedDatasetId": {
-                                                "description": "Weighted dataset id",
-                                                "format": "uuid",
-                                                "type": "string"
-                                            }
-                                        },
-                                        "type": "object"
-                                    },
-                                    "type": "array"
-                                }
+                                "type": "object"
                             },
-                            "type": "object"
+                            "type": "array"
                         },
-                        {
-                            "type": "null"
+                        "extraData": {
+                            "items": {
+                                "properties": {
+                                    "aggregation": {
+                                        "description": "Aggregation query type",
+                                        "enum": [
+                                            "average",
+                                            "count",
+                                            "cumulativesum",
+                                            "distinctcount",
+                                            "histogram",
+                                            "max",
+                                            "median",
+                                            "min",
+                                            "rate",
+                                            "stddev",
+                                            "sum",
+                                            "weightedaverage"
+                                        ],
+                                        "type": "string"
+                                    },
+                                    "columnId": {
+                                        "description": "Column id",
+                                        "format": "uuid",
+                                        "type": "string"
+                                    },
+                                    "datasetId": {
+                                        "description": "Dataset id",
+                                        "format": "uuid",
+                                        "type": "string"
+                                    },
+                                    "formulaId": {
+                                        "description": "Formula id",
+                                        "format": "uuid",
+                                        "type": "string"
+                                    },
+                                    "label": {
+                                        "description": "Label",
+                                        "type": "string"
+                                    },
+                                    "weightedColumnId": {
+                                        "description": "Weighted column id",
+                                        "format": "uuid",
+                                        "type": "string"
+                                    },
+                                    "weightedDatasetId": {
+                                        "description": "Weighted dataset id",
+                                        "format": "uuid",
+                                        "type": "string"
+                                    }
+                                },
+                                "type": "object"
+                            },
+                            "type": "array"
                         }
-                    ],
-                    "default": null,
-                    "description": "Custom events interactivity option"
+                    },
+                    "type": "object"
                 },
                 "customTooltip": {
                     "default": null,
-                    "description": "Custom tooltip interactivity option, in format {locale: \"tooltip\"}, for example, {en: \"Total Revenue\"}",
+                    "description": "Custom tooltip interactivity option, in format {<locale>: \"tooltip text\"}",
+                    "examples": [
+                        {
+                            "en": "Total Revenue"
+                        }
+                    ],
                     "type": [
                         "null",
                         "object"
@@ -556,6 +564,7 @@ declare const _default: {
                                                         "currency",
                                                         "duration",
                                                         "hierarchy_element_expression",
+                                                        "interval",
                                                         "ip_address",
                                                         "topography"
                                                     ],
@@ -596,7 +605,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"
@@ -665,7 +678,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": {
@@ -698,6 +717,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"
@@ -706,6 +926,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": [
@@ -731,6 +959,7 @@ declare const _default: {
                                                         "currency",
                                                         "duration",
                                                         "hierarchy_element_expression",
+                                                        "interval",
                                                         "ip_address",
                                                         "topography"
                                                     ],
@@ -800,7 +1029,12 @@ declare const _default: {
                             "type": "string"
                         },
                         "url": {
-                            "description": "URL in format {locale: \"url\"}, for example, {en: \"...\"}",
+                            "description": "URL in format {<locale>: \"url\"}",
+                            "examples": [
+                                {
+                                    "en": "https://example.com"
+                                }
+                            ],
                             "type": "object"
                         }
                     },
@@ -811,7 +1045,7 @@ declare const _default: {
         },
         "interpolation": {
             "default": "linear",
-            "description": "This option set the interpolation for the area drawn: \"linear\" or \"step-before\" or \"step-after\" or \"monotone\"",
+            "description": "This option set the interpolation",
             "enum": [
                 "linear",
                 "monotone",
@@ -936,7 +1170,7 @@ declare const _default: {
             "type": "boolean"
         },
         "missingValue": {
-            "description": "Fill missing days. Describes how missing date periods in the data are handled in the chart.",
+            "description": "Missing value configuration",
             "properties": {
                 "type": {
                     "default": "no",
@@ -1305,7 +1539,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"