@ic3/reporting-api 8.0.0-alpha.6 → 8.0.0-rc.3

package/dist/PublicTheme.d.ts

@@ -1,10 +1,10 @@
 /// <reference types="google.maps" />
 /// <reference types="googlemaps" />
 /// <reference types="markerclustererplus" />
-import { ComponentsOverrides, ComponentsVariants } from "@material-ui/core";
+import { ComponentsOverrides, ComponentsVariants } from "@mui/material";
 import { IPublicWidgetTemplateDefinition } from "./PublicTemplate";
 import { IWidgetLayoutDefinition } from "./PublicLayout";
-import { IThemeWidgetDefaults, IThemeWidgetVariant } from "./IThemeManager";
+import { IThemeWidgetDefaults } from "./IThemeManager";
 import { AlertDialogClassKey } from "./theme/ThemeAlertDialog";
 import { AppClassKey } from "./theme/ThemeApp";
 import { DrilldownUserSelectMenuClassKey } from "./theme/ThemeDrilldownUserSelectMenu";
@@ -17,9 +17,17 @@ import { ReportAppMenuClassKey } from "./theme/ThemeReportAppMenu";
 import { WidgetBoxClassKey } from "./theme/ThemeWidgetBox";
 import { WidgetBoxContentMessageClassKey } from "./theme/ThemeWidgetBoxContentMessage";
 import { ReactElement } from "react";
-import { TypographyStyleOptions } from "@material-ui/core/styles/createTypography";
+import { TypographyStyleOptions } from "@mui/material/styles/createTypography";
 import { Property } from "csstype";
-import { FilterButtonsClassKey } from "./theme/ThemeFilterButtons";
+import { FilterButtonsClassKey, FilterButtonsProps } from "./theme/ThemeFilterButtons";
+import { FilterSliderClassKey, FilterSliderProps } from "./theme/ThemeFilterSlider";
+import { GoogleMapMarkerProps } from "./theme/ThemeGoogleMapMarker";
+import { IPublicContext } from "./PublicContext";
+import { TableClassKey, TableProps } from "./theme/ThemeTable";
+import { PivotTableClassKey, PivotTableProps } from "./theme/ThemePivotTable";
+export interface INoSchemaRendererOptions {
+    missingSchema: string;
+}
 export declare type ThemeTextFormatter = {
     formatReport: ((value: any, locale: string) => string) | string;
     formatExcel?: string;
@@ -116,6 +124,12 @@ export interface ic3Palette {
      * Report Application Menu
      */
     reportAppMenu: string;
+    /**
+     * Darkens a color for an onhover effect
+     *
+     * If null or undefined, returns onHover color
+     */
+    onHover: (color?: Property.Color | undefined | null) => Property.Color;
 }
 interface MandatorySingleColors {
     /**
@@ -190,8 +204,9 @@ export interface ic3PaletteOptions {
      * Report Application Menu
      */
     reportAppMenu?: Property.Color;
+    onHover?: (color: Property.Color) => Property.Color;
 }
-declare module "@material-ui/core/styles/createPalette" {
+declare module "@mui/material/styles/createPalette" {
     interface Palette {
         ic3: ic3Palette;
     }
@@ -205,7 +220,7 @@ export interface ic3Typography {
 export interface ic3TypographyOptions {
     amCharts4?: TypographyStyleOptions;
 }
-declare module "@material-ui/core/styles/createTypography" {
+declare module "@mui/material/styles/createTypography" {
     interface Typography {
         ic3: ic3Typography;
     }
@@ -221,11 +236,13 @@ export interface ic3Theme {
     id: string;
     caption: string;
     cssClass: string;
+    loadFonts?: (continuation: () => void) => void;
     formatter: ThemeFormatters;
     /**
      * Icons used in tables and trees
      */
     icons: {
+        none: (className: string) => ReactElement | string;
         expanded: (className: string) => ReactElement | string;
         collapse: (className: string) => ReactElement | string;
         loading: (className: string) => ReactElement | string;
@@ -239,7 +256,6 @@ export interface ic3Theme {
     }>;
     googleMap: {
         options?: google.maps.MapOptions;
-        markerOptions?: google.maps.Symbol;
         markerClustererOptions?: MarkerClustererOptions;
     };
     userMenu: {
@@ -280,18 +296,35 @@ export interface ic3Theme {
      */
     widgetDefaults?: IThemeWidgetDefaults;
     /**
-     * Sort of named set of predefined options.
-     *
-     * <pre>
-     *     [plugin-id.template-id] -> [variant-id]
-     * </pre>
+     * Styling for the sparklines in the sparkline transformation and the KPI card
      */
-    widgetVariants?: Record<string, Record<string, IThemeWidgetVariant>>;
+    sparklineSettings: {
+        /**
+         * The width of the line in the sparkline
+         */
+        lineWidth: number;
+        /**
+         * The cursor when the user hovers over the sparkline
+         */
+        cursor: {
+            color: Property.Color;
+            /**
+             * The radius of the dot when hovering
+             */
+            radius: number;
+            /**
+             * The width of the stroke when hovering
+             */
+            width: number;
+        };
+    };
+    noSchemaRenderer?: (context: IPublicContext, options: INoSchemaRendererOptions) => ReactElement;
 }
 export interface ic3ThemeOptions {
     id: string;
     caption: string;
     cssClass?: string;
+    loadFonts?: (continuation: () => void) => void;
     formatter?: ThemeFormattersOptions;
     icons?: {
         expanded?: (className: string) => ReactElement | string;
@@ -319,50 +352,39 @@ export interface ic3ThemeOptions {
         };
     };
     /**
-     * Default values.
+     * Default values (e.g., box options, chart options, etc..).
+     */
+    widgetDefaults?: IThemeWidgetDefaults;
+    /**
+     * The first defined layout is used as the default one.
+     */
+    layouts: IWidgetLayoutDefinition[];
+    /**
+     * Styling for the sparklines in the sparkline transformation and the KPI card
      */
-    widgetDefaults?: {
+    sparklineSettings?: {
         /**
-         * Default values for widget boxes.
-         *
-         * <pre>
-         *      IWidgetBoxDefinition
-         * </pre>
+         * The width of the line in the sparkline
          */
-        box?: Record<string, any>;
+        lineWidth: number;
         /**
-         * Default values for widget chart options.
-         *
-         * <pre>
-         *      IWidgetDefinition
-         *          dataRenderOptions: IWidgetDataRenderDefinition
-         *              chartOptions: IChartTemplateDataRenderDefinition
-         * </pre>
-         *
-         * Lookup order:
-         *
-         * <pre>
-         *      plugin-id.template-id.option
-         *      plugin-id.option
-         *      option
-         * </pre>
+         * The cursor when the user hovers over the sparkline
          */
-        options?: Record<string, any>;
+        cursor: {
+            color: Property.Color;
+            /**
+             * The radius of the dot when hovering
+             */
+            radius: number;
+            /**
+             * The width of the stroke when hovering
+             */
+            width: number;
+        };
     };
-    /**
-     * Sort of named set of options.
-     *
-     * <pre>
-     *     [plugin-id.template-id] -> [variant-id]
-     * </pre>
-     */
-    widgetVariants?: Record<string, Record<string, IThemeWidgetVariant>>;
-    /**
-     * The first defined layout is used as the default one.
-     */
-    layouts: IWidgetLayoutDefinition[];
+    noSchemaRenderer?: (context: IPublicContext, options: INoSchemaRendererOptions) => ReactElement;
 }
-declare module '@material-ui/core/styles/createTheme' {
+declare module '@mui/material/styles/createTheme' {
     interface Theme {
         ic3: ic3Theme;
     }
@@ -373,70 +395,93 @@ declare module '@material-ui/core/styles/createTheme' {
         ic3: ic3ThemeOptions;
     }
 }
-declare module '@material-ui/core/styles/components' {
+/**
+ * All Components using Material-UI like variants (using styled)
+ */
+declare module '@mui/material/styles/components' {
     interface Components {
-        AlertDialog: {
+        AlertDialog?: {
             styleOverrides?: ComponentsOverrides["AlertDialog"];
         };
-        App: {
+        App?: {
             styleOverrides?: ComponentsOverrides["App"];
         };
-        DrilldownUserSelectMenu: {
+        DrilldownUserSelectMenu?: {
             styleOverrides?: ComponentsOverrides["DrilldownUserSelectMenu"];
         };
-        ErrorRenderer: {
+        ErrorRenderer?: {
             styleOverrides?: ComponentsOverrides["ErrorRenderer"];
         };
-        HtmlBox: {
-            styleOverrides?: ComponentsOverrides["HtmlBox"];
-            variants?: ComponentsVariants["HtmlBox"];
-        };
-        FilterButtons: {
+        FilterButtons?: {
             styleOverrides?: ComponentsOverrides["FilterButtons"];
             variants?: ComponentsVariants["FilterButtons"];
         };
-        Layout: {
+        FilterSlider?: {
+            styleOverrides?: ComponentsOverrides["FilterSlider"];
+            variants?: ComponentsVariants["FilterSlider"];
+        };
+        GoogleMapMarker?: {
+            variants?: ComponentsVariants['GoogleMapMarker'];
+        };
+        HtmlBox?: {
+            styleOverrides?: ComponentsOverrides["HtmlBox"];
+            variants?: ComponentsVariants["HtmlBox"];
+        };
+        Layout?: {
             styleOverrides?: ComponentsOverrides["Layout"];
         };
-        LayoutPage: {
+        LayoutPage?: {
             styleOverrides?: ComponentsOverrides["LayoutPage"];
         };
-        ReportAppBar: {
+        PivotTable?: {
+            styleOverrides?: ComponentsOverrides["PivotTable"];
+        };
+        ReportAppBar?: {
             styleOverrides?: ComponentsOverrides["ReportAppBar"];
         };
-        ReportAppMenu: {
+        ReportAppMenu?: {
             styleOverrides?: ComponentsOverrides["ReportAppMenu"];
         };
-        WidgetBox: {
+        Table?: {
+            styleOverrides?: ComponentsOverrides["Table"];
+        };
+        WidgetBox?: {
             variants?: ComponentsVariants['WidgetBox'];
             styleOverrides?: ComponentsOverrides["WidgetBox"];
         };
-        WidgetBoxContentMessage: {
+        WidgetBoxContentMessage?: {
             styleOverrides?: ComponentsOverrides["WidgetBoxContentMessage"];
         };
     }
 }
-declare module '@material-ui/core/styles/overrides' {
+declare module '@mui/material/styles/overrides' {
     interface ComponentNameToClassKey {
         AlertDialog: AlertDialogClassKey;
         App: AppClassKey;
         DrilldownUserSelectMenu: DrilldownUserSelectMenuClassKey;
         ErrorRenderer: ErrorRendererClassKey;
         FilterButtons: FilterButtonsClassKey;
+        FilterSlider: FilterSliderClassKey;
         HtmlBox: HtmlBoxClassKey;
         Layout: LayoutClassKey;
         LayoutPage: LayoutPageClassKey;
+        PivotTable: PivotTableClassKey;
         ReportAppBar: ReportAppBarClassKey;
         ReportAppMenu: ReportAppMenuClassKey;
+        Table: TableClassKey;
         WidgetBox: WidgetBoxClassKey;
         WidgetBoxContentMessage: WidgetBoxContentMessageClassKey;
     }
 }
-declare module '@material-ui/core/styles/props' {
+declare module '@mui/material/styles/props' {
     interface ComponentsPropsList {
+        FilterButtons: FilterButtonsProps;
+        FilterSlider: FilterSliderProps;
+        GoogleMapMarker: GoogleMapMarkerProps;
         HtmlBox: HtmlBoxProps;
+        PivotTable: PivotTableProps;
+        Table: TableProps;
         WidgetBox: Record<never, any>;
-        FilterButtons: Record<never, any>;
     }
 }
 export {};

package/dist/PublicTheme.js.map

@@ -1 +1 @@
-{"version":3,"file":"PublicTheme.js","sourceRoot":"","sources":["../src/PublicTheme.ts"],"names":[],"mappings":";;;AA6QA,IAAY,qBAGX;AAHD,WAAY,qBAAqB;IAC7B,8CAAqB,CAAA;IACrB,4CAAmB,CAAA;AACvB,CAAC,EAHW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAGhC"}
+{"version":3,"file":"PublicTheme.js","sourceRoot":"","sources":["../src/PublicTheme.ts"],"names":[],"mappings":";;;AAgSA,IAAY,qBAGX;AAHD,WAAY,qBAAqB;IAC7B,8CAAqB,CAAA;IACrB,4CAAmB,CAAA;AACvB,CAAC,EAHW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAGhC"}