@luzmo/dashboard-contents-types 1.0.17 → 1.0.19-beta.0

package/CHANGELOG.md

@@ -0,0 +1,115 @@
+All notable changes to this project will be documented in this file.
+
+## [1.0.19] - 2025-10-24
+
+### 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
+
+- Update Period over period type: add new properties to support upcoming variable period over period feature
+
+## [1.0.17] - 2025-04-14
+
+### Updates
+
+- Update Bar chart options: add missing values "absolute" and "percentageAllBars" for "bars.label" options 
+
+## [1.0.16] - 2025-03-28
+
+### Updates
+
+- Update missing dep topojson-specification
+
+## [1.0.14] - 2025-02-24
+
+### Updates
+
+- Fix Readme
+
+## [1.0.13] - 2025-02-21
+
+### Updates
+
+- Update ItemQuery type
+
+## [1.0.12] - 2025-02-06
+
+### Updates
+
+- Add additional types for making building queries easier
+
+## [1.0.11] - 2025-01-31
+
+### Updates
+
+- Update ExportType to be support more values
+
+## [1.0.10] - 2025-01-13
+
+### Updates
+
+- Update types
+
+## [1.0.9] - 2025-01-08
+
+### Updates
+
+- Remove code related to @angular/cdk
+
+## [1.0.8] - 2024-12-19
+
+### Updates
+
+- Add LICENSE to the library
+
+## [1.0.7] - 2024-12-13
+
+### Updates
+
+- New JSON schemas and types for dashboard contents
+
+## [1.0.6] - 2024-11-22
+
+### Updates
+
+- New JSON schemas and types for dashboard contents
+
+## [1.0.5] - 2024-11-18
+
+### Updates
+
+- Expose slot configs for charts
+
+## [1.0.4] - 2024-11-14
+
+### Updates
+
+- Remove JSON schemas from the library
+
+## [1.0.3] - 2024-10-22
+
+### Updates
+
+- Fix displaying Search Filter in Flex
+
+## [1.0.2] - 2024-10-21
+
+### Updates
+
+- Changes related to theme options
+
+## [1.0.1] - 2024-10-14
+
+### Updates
+
+- Update types
+
+## [0.1.88] - 2024-09-09
+
+- Types and JSON schemas from Luzmo dashboard contents v0.1.88

package/LICENSE

@@ -0,0 +1,15 @@
+Copyright © 2025 Luzmo
+
+All rights reserved.
+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.
+
+Please view the Luzmo Terms of Service at: https://www.luzmo.com/information-pages/terms-of-use
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,136 @@
+# Types for Luzmo dashboard contents
+
+This packages contains different TypeScript types and JSON schemas for Luzmo dashboard contents.
+
+## Content Item Types
+
+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.                             |
+| `BarChart`                     | A Bar Chart type.                                     |
+| `BarChartViewOptions`          | A Bar Chart options type.                             |
+| `BarChartSlots`                | A Bar Chart slots type.                               |
+| `BoxPlot`                      | A Box Plot type.                                      |
+| `BoxPlotViewOptions`           | A Box Plot options type.                              |
+| `BoxPlotSlots`                 | A Box Plot slots type.                                |
+| `BubbleChart`                  | A Bubble Chart type.                                  |
+| `BubbleChartViewOptions`       | A Bubble Chart options type.                          |
+| `BubbleChartSlots`             | A Bubble Chart slots type.                            |
+| `BulletChart`                  | A Bullet Chart type.                                  |
+| `BulletChartViewOptions`       | A Bullet Chart options type.                          |
+| `BulletChartSlots`             | A Bullet Chart slots type.                            |
+| `ChoroplethMap`                | A Choropleth Map type.                                |
+| `ChoroplethMapViewOptions`     | A Choropleth Map options type.                        |
+| `ChoroplethMapSlots`           | A Choropleth Map slots type.                          |
+| `CircularGauge`                | A Circular Gauge type.                                |
+| `CircularGaugeViewOptions`     | A Circular Gauge options type.                        |
+| `CircularGaugeSlots`           | A Circular Gauge slots type.                          |
+| `ColumnChart`                  | A Column Chart type.                                  |
+| `ColumnChartViewOptions`       | A Column Chart options type.                          |
+| `ColumnChartSlots`             | A Column Chart slots type.                            |
+| `CombinationChart`             | A Combination Chart type.                             |
+| `CombinationChartViewOptions`  | A Combination Chart options type.                     |
+| `CombinationChartSlots`        | A Combination Chart slots type.                       |
+| `ConditionalNumber`            | A Conditional Number type.                            |
+| `ConditionalNumberViewOptions` | A Conditional Number options type.                    |
+| `ConditionalNumberSlots`       | A Conditional Number slots type.                      |
+| `DateComparisonFilter`         | A Date Filter type.                                   |
+| `DateFilterViewOptions`        | A Date Filter options type.                           |
+| `DateComparisonFilterSlots`    | A Date Filter slots type.                             |
+| `DonutChart`                   | A Donut Chart type.                                   |
+| `DonutChartViewOptions`        | A Donut Chart options type.                           |
+| `DonutChartSlots`              | A Donut Chart slots type.                             |
+| `DropdownFilter`               | A Dropdown Filter type.                               |
+| `DropdownFilterViewOptions`    | A Dropdown Filter options type.                       |
+| `DropdownFilterSlots`          | A Dropdown Filter slots type.                         |
+| `EvolutionNumber`              | An Evolution Number type.                             |
+| `EvolutionNumberViewOptions`   | An Evolution Number options type.                     |
+| `EvolutionNumberSlots`         | An Evolution Number slots type.                       |
+| `FunnelChart`                  | A Funnel Chart type.                                  |
+| `FunnelChartViewOptions`       | A Funnel Chart options type.                          |
+| `FunnelChartSlots`             | A Funnel Chart slots type.                            |
+| `HeatMap`                      | A Heat Map type.                                      |
+| `HeatMapViewOptions`           | A Heat Map options type.                              |
+| `HeatMapSlots`                 | A Heat Map slots type.                                |
+| `HexbinMap`                    | A Hexbin Map type.                                    |
+| `HexbinMapViewOptions`         | A Hexbin Map options type.                            |
+| `HexbinMapSlots`               | A Hexbin Map slots type.                              |
+| `Image`                        | An Image type.                                        |
+| `ImageViewOptions`             | An Image options type.                                |
+| `LineChart`                    | A Line Chart type.                                    |
+| `LineChartViewOptions`         | A Line Chart options type.                            |
+| `LineChartSlots`               | A Line Chart slots type.                              |
+| `MarkerMap`                    | A Marker Map type.                                    |
+| `MarkerMapViewOptions`         | A Marker Map options type.                            |
+| `MarkerMapSlots`               | A Marker Map slots type.                              |
+| `PivotTable`                   | A Pivot Table type.                                   |
+| `PivotTableViewOptions`        | A Pivot Table options type.                           |
+| `PivotTableSlots`              | A Pivot Table slots type.                             |
+| `RegularTable`                 | A Regular Table type.                                 |
+| `RegularTableViewOptions`      | A Regular Table options type.                         |
+| `RegularTableSlots`            | A Regular Table slots type.                           |
+| `RouteMap`                     | A Route Map type.                                     |
+| `RouteMapViewOptions`          | A Route Map options type.                             |
+| `RouteMapSlots`                | A Route Map slots type.                               |
+| `SankeyDiagram`                | A ScatterPlot type.                                   |
+| `SankeyDiagramViewOptions`     | A Sankey Diagram options type.                        |
+| `SankeyDiagramSlots`           | A Sankey Diagram slots type.                          |
+| `ScatterPlot`                  | A Scatter Plot type.                                  |
+| `ScatterPlotViewOptions`       | A Scatter Plot options type.                          |
+| `ScatterPlotSlots`             | A Scatter Plot slots type.                            |
+| `SearchFilter`                 | A Search Filter type.                                 |
+| `SearchFilterViewOptions`      | A Search Filter options type.                         |
+| `SearchFilterSlots`            | A Search Filter slots type.                           |
+| `SlicerFilter`                 | A Slicer Filter type.                                 |
+| `SlicerFilterViewOptions`      | A Slicer Filter options type.                         |
+| `SlicerFilterSlots`            | A Slicer Filter slots type.                           |
+| `SliderFilter`                 | A Slider Filter type.                                 |
+| `SliderFilterViewOptions`      | A Slider Filter options type.                         |
+| `SliderFilterSlots`            | A Slider Filter slots type.                           |
+| `SpikeMap`                     | A Spike Map type.                                     |
+| `SpikeMapViewOptions`          | A Spike Map options type.                             |
+| `SpikeMapSlots`                | A Spike Map slots type.                               |
+| `SymbolMap`                    | A Symbol Map type.                                    |
+| `SymbolMapViewOptions`         | A Symbol Map options type.                            |
+| `SymbolMapSlots`               | A Symbol Map slots type.                              |
+| `WordcloudChart`               | A Wordcloud Chart type.                               |
+| `WordcloudChartViewOptions`    | A Wordcloud Chart options type.                       |
+| `WordcloudChartSlots`          | A Wordcloud Chart slots type.                         |
+| `Text`                         | A Text type.                                          |
+| `TextViewOptions`              | A Text options type.                                  |
+| `Video`                        | A Video type.                                         |
+| `VideoViewOptions`             | A Video options type.                                 |
+| `VizItemType`                  | A union type for content item types.                  |
+| `Options`                      | A union type for all the options from all the charts. |
+| `Slots`                        | A union type for all the slots from all the charts.   |
+
+## JSON Schemas
+
+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';
+
+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:
+
+```typescript
+import { JSON_SCHEMAS } from '@luzmo/dashboard-contents-types';
+
+console.log(JSON_SCHEMAS);
+console.log(JSON_SCHEMAS['text-options.schema.json']);
+```
+
+**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.