npm - @luzmo/dashboard-contents-types - Versions diffs - 1.0.11 → 1.0.12 - Mend

@luzmo/dashboard-contents-types 1.0.11 → 1.0.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/CHANGELOG.md +7 -1
package/README.md +132 -71
package/package.json +3 -2
package/src/lib/shared/common.d.ts +24 -0
package/src/lib/shared/common.d.ts.map +1 -1
package/src/lib/shared/query.d.ts +153 -0
package/src/lib/shared/query.d.ts.map +1 -1
package/LICENSE +0 -15

package/CHANGELOG.md CHANGED Viewed

@@ -1,10 +1,16 @@
 All notable changes to this project will be documented in this file.
+## [1.0.12] - 2025-02-06
+### Updates
+- Added additional types for making building queries easier.
 ## [1.0.11] - 2025-01-31
 ### Updates
-- Updated ExportType to VizItemExportType
+- Updated ExportType to be support more values
 ## [1.0.10] - 2025-01-13

package/README.md CHANGED Viewed

@@ -1,71 +1,132 @@
-All notable changes to this project will be documented in this file.
-## [1.0.11] - 2025-01-31
-### Updates
-- Updated ExportType to be support more values
-## [1.0.10] - 2025-01-13
-### Updates
-- Updated types
-## [1.0.9] - 2025-01-08
-### Updates
-- Removed code related to @angular/cdk
-## [1.0.8] - 2024-12-19
-### Updates
-- Added 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
-- Updated types
-## [0.1.88] - 2024-09-09
-- Types and JSON schemas from Luzmo dashboard contents v0.1.88
+# 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.                      |
+| `DateFilter`                   | A Date Filter type.                                   |
+| `DateFilterViewOptions`        | A Date Filter options type.                           |
+| `DateFilterSlots`              | 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']);
+```
+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/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@luzmo/dashboard-contents-types",
-  "version": "1.0.11",
+  "version": "1.0.12",
   "dependencies": {
     "tslib": "^2.3.0",
     "leaflet": "1.9.4"
@@ -8,5 +8,6 @@
   "main": "./index.js",
   "module": "./index.mjs",
   "typings": "./index.d.ts",
-  "license": "SEE LICENSE IN LICENSE"
+  "license": "SEE LICENSE IN LICENSE",
+  "sideEffects": false
 }

package/src/lib/shared/common.d.ts CHANGED Viewed

@@ -101,3 +101,27 @@ export type VizItemType = 'area-chart' | 'bar-chart' | 'bubble-chart' | 'box-plo
 export type ItemType = VizItemType;
 export type DatetimeDisplayMode = 'default' | 'weekday_number' | 'weekday_name' | 'day_in_month' | 'day_in_year' | 'month_name' | 'month_number' | 'week_number' | 'second_in_minute' | 'minute_in_hour' | 'hour_in_day' | 'quarter_number';
 export type ScreenMode = 'desktop' | 'tablet' | 'mobile' | 'largeScreen' | 'fixed';
+export type PopupMessageClassMap = {
+    empty: 'fill';
+    noData: 'no-data';
+    queryFailed: 'query-failed';
+    noAccess: 'no-access';
+    noColumnAccess: 'no-column-access';
+    datasetNotFound: 'dataset-not-found';
+    rateLimitExceeded: 'rate-limit-exceeded';
+    tooMany: 'too-many';
+    qeVersionNotSupport: 'qe-version-not-support';
+};
+export type PopupMessageClass = PopupMessageClassMap[keyof PopupMessageClassMap];
+export interface ItemQueryPerformance {
+    validating: number;
+    preparing: number;
+    queuing: number;
+    querying: number;
+    processing: number;
+    rows: number;
+    rendering: number;
+    totalTime: number;
+    outRows: number;
+    queries?: number;
+}

package/src/lib/shared/common.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../../../../libs/dashboard-contents-types/src/lib/shared/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAIxC,MAAM,MAAM,cAAc,GACxB,SAAS,GACP,KAAK,GACL,UAAU,GACV,MAAM,GACN,QAAQ,GACR,OAAO,GACP,YAAY,GACZ,QAAQ,GACR,aAAa,CAAC;AAQlB;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,OAAO,GAAG,WAAW,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,aAAa,CAAC;AAIpD;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,KAAK,EAAE,cAAc,CAAC;CACvB;AAED,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,IAAI,EAAE,iBAAiB,CAAC;IACxB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,EAAE,GAAG,GAAG,KAAK,GAAG,KAAK,CAAC;IAC1B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,cAAc,GAAG,eAAe,CAAC;AAIlG,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,YAAY,CAAC,EAAE;QACb;;;WAGG;QACH,IAAI,CAAC,EAAE,gBAAgB,CAAC;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,IAAI,GAAG,OAAO,GAAG,QAAQ,CAAC;AAEzD,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE;QACN;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC5B;AAED,MAAM,MAAM,aAAa,GAAG,cAAc,GAAG,EAAE,CAAC;AAEhD,MAAM,MAAM,WAAW,GACrB,YAAY,GACV,WAAW,GACX,cAAc,GACd,UAAU,GACV,cAAc,GACd,gBAAgB,GAChB,gBAAgB,GAChB,mBAAmB,GACnB,cAAc,GACd,mBAAmB,GACnB,aAAa,GACb,aAAa,GACb,iBAAiB,GACjB,qBAAqB,GACrB,kBAAkB,GAClB,cAAc,GACd,UAAU,GACV,YAAY,GACZ,YAAY,GACZ,cAAc,GACd,OAAO,GACP,YAAY,GACZ,qBAAqB,GACrB,YAAY,GACZ,oBAAoB,GACpB,YAAY,GACZ,2BAA2B,GAC3B,aAAa,GACb,eAAe,GACf,aAAa,GACb,eAAe,GACf,WAAW,GACX,gBAAgB,GAChB,cAAc,GACd,eAAe,GACf,eAAe,GACf,eAAe,GACf,QAAQ,GACR,mBAAmB,GACnB,WAAW,GACX,YAAY,GACZ,gBAAgB,GAChB,YAAY,GACZ,MAAM,GACN,eAAe,GACf,cAAc,GACd,OAAO,GACP,iBAAiB,CAAC;AAMtB,MAAM,MAAM,QAAQ,GAAG,WAAW,CAAC;AAEnC,MAAM,MAAM,mBAAmB,GAC7B,SAAS,GACP,gBAAgB,GAChB,cAAc,GACd,cAAc,GACd,aAAa,GACb,YAAY,GACZ,cAAc,GACd,aAAa,GACb,kBAAkB,GAClB,gBAAgB,GAChB,aAAa,GACb,gBAAgB,CAAC;AAErB,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,aAAa,GAAG,OAAO,CAAC"}
1	+ {"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../../../../libs/dashboard-contents-types/src/lib/shared/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAIxC,MAAM,MAAM,cAAc,GACxB,SAAS,GACP,KAAK,GACL,UAAU,GACV,MAAM,GACN,QAAQ,GACR,OAAO,GACP,YAAY,GACZ,QAAQ,GACR,aAAa,CAAC;AAQlB;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,OAAO,GAAG,WAAW,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,aAAa,CAAC;AAIpD;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,KAAK,EAAE,cAAc,CAAC;CACvB;AAED,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,IAAI,EAAE,iBAAiB,CAAC;IACxB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,EAAE,GAAG,GAAG,KAAK,GAAG,KAAK,CAAC;IAC1B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,cAAc,GAAG,eAAe,CAAC;AAIlG,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,YAAY,CAAC,EAAE;QACb;;;WAGG;QACH,IAAI,CAAC,EAAE,gBAAgB,CAAC;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,IAAI,GAAG,OAAO,GAAG,QAAQ,CAAC;AAEzD,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE;QACN;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC5B;AAED,MAAM,MAAM,aAAa,GAAG,cAAc,GAAG,EAAE,CAAC;AAEhD,MAAM,MAAM,WAAW,GACrB,YAAY,GACV,WAAW,GACX,cAAc,GACd,UAAU,GACV,cAAc,GACd,gBAAgB,GAChB,gBAAgB,GAChB,mBAAmB,GACnB,cAAc,GACd,mBAAmB,GACnB,aAAa,GACb,aAAa,GACb,iBAAiB,GACjB,qBAAqB,GACrB,kBAAkB,GAClB,cAAc,GACd,UAAU,GACV,YAAY,GACZ,YAAY,GACZ,cAAc,GACd,OAAO,GACP,YAAY,GACZ,qBAAqB,GACrB,YAAY,GACZ,oBAAoB,GACpB,YAAY,GACZ,2BAA2B,GAC3B,aAAa,GACb,eAAe,GACf,aAAa,GACb,eAAe,GACf,WAAW,GACX,gBAAgB,GAChB,cAAc,GACd,eAAe,GACf,eAAe,GACf,eAAe,GACf,QAAQ,GACR,mBAAmB,GACnB,WAAW,GACX,YAAY,GACZ,gBAAgB,GAChB,YAAY,GACZ,MAAM,GACN,eAAe,GACf,cAAc,GACd,OAAO,GACP,iBAAiB,CAAC;AAMtB,MAAM,MAAM,QAAQ,GAAG,WAAW,CAAC;AAEnC,MAAM,MAAM,mBAAmB,GAC7B,SAAS,GACP,gBAAgB,GAChB,cAAc,GACd,cAAc,GACd,aAAa,GACb,YAAY,GACZ,cAAc,GACd,aAAa,GACb,kBAAkB,GAClB,gBAAgB,GAChB,aAAa,GACb,gBAAgB,CAAC;AAErB,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,aAAa,GAAG,OAAO,CAAC;AAEnF,MAAM,MAAM,oBAAoB,GAAG;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,SAAS,CAAC;IAClB,WAAW,EAAE,cAAc,CAAC;IAC5B,QAAQ,EAAE,WAAW,CAAC;IACtB,cAAc,EAAE,kBAAkB,CAAC;IACnC,eAAe,EAAE,mBAAmB,CAAC;IACrC,iBAAiB,EAAE,qBAAqB,CAAC;IACzC,OAAO,EAAE,UAAU,CAAC;IACpB,mBAAmB,EAAE,wBAAwB,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,MAAM,oBAAoB,CAAC,CAAC;AAEjF,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAEhB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/src/lib/shared/query.d.ts CHANGED Viewed

@@ -1,3 +1,8 @@
+import type { Arc, GeometryCollection } from 'topojson-specification';
+import { Subject } from 'rxjs';
+import type { OrderDirection } from './sort';
+import type { ItemFilter, ItemQueryDimension, ItemQueryDiscretization } from './item-filter-group';
+import { ItemQueryPerformance, PopupMessageClassMap } from './common';
 /**
  * Basic aggregation query type
  */
@@ -23,3 +28,151 @@ export interface ItemQueryRanking {
      */
     number: number;
 }
+export type ItemData = {
+    cached?: boolean;
+    data?: any[];
+    join?: {
+        criteria: {
+            /**
+             * @format uuid
+             */
+            dataset_id: string;
+            /**
+             * @format uuid
+             */
+            column_id: string;
+        }[];
+        type: 'lookup' | 'temporal' | 'fuzzy';
+    }[];
+    bins?: any;
+    performance?: ItemQueryPerformance;
+    status?: {
+        cancelled?: boolean;
+        demo?: boolean;
+        error?: keyof PopupMessageClassMap;
+        errorFullMsg?: string;
+        errorMsg?: string;
+        noQuery?: boolean;
+        timestamp?: string;
+        /**
+         * @format uuid
+         */
+        queryId?: string;
+        /**
+         * @format uuid
+         */
+        traceId?: string;
+    };
+    topojson?: {
+        type: 'Topology';
+        arcs: Arc[];
+        objects: {
+            topography: GeometryCollection<{
+                [key: string]: any;
+            }>;
+        };
+    };
+    _pid?: string;
+    observable?: Subject<unknown>;
+};
+export type QueryAndFilterGroup = (ItemFilter | QueryOrFilterGroup)[];
+export interface QueryOrFilterGroup {
+    or: (ItemFilter | QueryAndFilterGroup | QueryOrFilterGroup)[];
+}
+export interface ItemQuery {
+    dimensions?: ItemQueryDimension[];
+    measures?: ItemQueryMeasure[];
+    where?: QueryAndFilterGroup;
+    having?: ItemFilter[];
+    limit?: {
+        by: number;
+        offset?: number;
+    };
+    options?: {
+        locale_id?: string;
+        timezone_id?: string;
+        synchronized?: boolean;
+        rollup_data?: boolean;
+        paging?: {
+            by: number;
+            offset: number;
+        };
+    };
+    order?: ItemQuerySort[];
+    context?: {
+        /**
+         * @format uuid
+         */
+        chart_id: string;
+        /**
+         * @format uuid
+         */
+        dashboard_id: string;
+        /**
+         * @format uuid
+         */
+        share_id?: string;
+        flex?: boolean;
+    };
+}
+export interface ItemQueryMeasure {
+    /**
+     * @format uuid
+     */
+    column_id?: string;
+    /**
+     * Ad-hoc formula
+     */
+    formula?: string;
+    /**
+     * Formula id
+     * @format uuid
+     */
+    formula_id?: string;
+    /**
+     * @format uuid
+     */
+    dataset_id?: string;
+    level?: number;
+    expression?: string;
+    aggregation?: {
+        type: ItemQueryAggregation;
+        /**
+         * @format uuid
+         */
+        dataset_id?: string;
+        /**
+         * @format uuid
+         */
+        column_id?: string;
+        level?: number;
+        discretization?: ItemQueryDiscretization;
+        expression?: string;
+    };
+}
+export interface ItemQuerySort {
+    aggregation?: {
+        type: ItemQueryAggregation;
+        /**
+         * @format uuid
+         */
+        dataset_id?: string;
+        /**
+         * @format uuid
+         */
+        column_id?: string;
+        level?: number;
+    };
+    /**
+     * @format uuid
+     */
+    column_id?: string;
+    /**
+     * @format uuid
+     */
+    dataset_id?: string;
+    discretization?: ItemQueryDiscretization;
+    expression?: string;
+    level?: number;
+    order?: OrderDirection;
+}

package/src/lib/shared/query.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../../../../../libs/dashboard-contents-types/src/lib/shared/query.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,OAAO,GAAG,eAAe,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,yBAAyB,GAC1D,KAAK,GACL,eAAe,GACf,SAAS,GACT,QAAQ,GACR,KAAK,GACL,KAAK,GACL,QAAQ,GACR,iBAAiB,GACjB,MAAM,GACN,WAAW,CAAC;AAEd;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,SAAS,EAAE,KAAK,GAAG,QAAQ,CAAC;IAC5B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB"}
1	+ {"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../../../../../libs/dashboard-contents-types/src/lib/shared/query.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,KAAK,EAAE,UAAU,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AACnG,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,OAAO,GAAG,eAAe,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,yBAAyB,GAC1D,KAAK,GACL,eAAe,GACf,SAAS,GACT,QAAQ,GACR,KAAK,GACL,KAAK,GACL,QAAQ,GACR,iBAAiB,GACjB,MAAM,GACN,WAAW,CAAC;AAEd;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,SAAS,EAAE,KAAK,GAAG,QAAQ,CAAC;IAC5B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACb,IAAI,CAAC,EAAE;QACL,QAAQ,EAAE;YACR;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YACnB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;SACnB,EAAE,CAAC;QACJ,IAAI,EAAE,QAAQ,GAAG,UAAU,GAAG,OAAO,CAAC;KACvC,EAAE,CAAC;IACJ,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,WAAW,CAAC,EAAE,oBAAoB,CAAC;IACnC,MAAM,CAAC,EAAE;QACP,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,oBAAoB,CAAC;QACnC,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,QAAQ,CAAC,EAAE;QACT,IAAI,EAAE,UAAU,CAAC;QACjB,IAAI,EAAE,GAAG,EAAE,CAAC;QACZ,OAAO,EAAE;YACP,UAAU,EAAE,kBAAkB,CAAC;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;aAAE,CAAC,CAAC;SACxD,CAAC;KACH,CAAC;IACF,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,UAAU,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,CAAC,UAAU,GAAG,kBAAkB,CAAC,EAAE,CAAC;AAEtE,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,CAAC,UAAU,GAAG,mBAAmB,GAAG,kBAAkB,CAAC,EAAE,CAAC;CAC/D;AAED,MAAM,WAAW,SAAS;IACxB,UAAU,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAClC,QAAQ,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC9B,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC;IACtB,KAAK,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACxC,OAAO,CAAC,EAAE;QACR,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB,MAAM,CAAC,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAC;KACzC,CAAC;IACF,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,OAAO,CAAC,EAAE;QACR;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QACjB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QACrB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB,CAAC;CACH;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE;QACZ,IAAI,EAAE,oBAAoB,CAAC;QAC3B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,cAAc,CAAC,EAAE,uBAAuB,CAAC;QACzC,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;CACH;AAED,MAAM,WAAW,aAAa;IAC5B,WAAW,CAAC,EAAE;QACZ,IAAI,EAAE,oBAAoB,CAAC;QAC3B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,uBAAuB,CAAC;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,cAAc,CAAC;CACxB"}

package/LICENSE DELETED Viewed

@@ -1,15 +0,0 @@
-Copyright © 2024 Luzmo
-All rights reserved.
-Luzmo Types library (@luzmo/dashboard-content-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.