@ic3/reporting-api 8.0.0-alpha.9 → 8.0.0-rc.4

package/dist/PublicTheme.d.ts

@@ -1,7 +1,7 @@
 /// <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 } from "./IThemeManager";
@@ -17,10 +17,18 @@ 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, 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";
+import { Components } from "@mui/material/styles/components";
+export interface INoSchemaRendererOptions {
+    missingSchema: string;
+}
 export declare type ThemeTextFormatter = {
     formatReport: ((value: any, locale: string) => string) | string;
     formatExcel?: string;
@@ -117,6 +125,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 {
     /**
@@ -191,29 +205,17 @@ export interface ic3PaletteOptions {
      * Report Application Menu
      */
     reportAppMenu?: Property.Color;
-}
-declare module "@material-ui/core/styles/createPalette" {
-    interface Palette {
-        ic3: ic3Palette;
-    }
-    interface PaletteOptions {
-        ic3?: ic3PaletteOptions;
-    }
+    onHover?: (color: Property.Color) => Property.Color;
 }
 export interface ic3Typography {
     amCharts4: TypographyStyleOptions;
 }
 export interface ic3TypographyOptions {
+    /**
+     * Typography for the amCharts plugin.
+     */
     amCharts4?: TypographyStyleOptions;
 }
-declare module "@material-ui/core/styles/createTypography" {
-    interface Typography {
-        ic3: ic3Typography;
-    }
-    interface TypographyOptions {
-        ic3?: ic3TypographyOptions;
-    }
-}
 export declare enum TableRowHeightOptions {
     standard = "standard",
     compact = "compact"
@@ -222,11 +224,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;
@@ -240,7 +244,6 @@ export interface ic3Theme {
     }>;
     googleMap: {
         options?: google.maps.MapOptions;
-        markerOptions?: google.maps.Symbol;
         markerClustererOptions?: MarkerClustererOptions;
     };
     userMenu: {
@@ -280,11 +283,36 @@ export interface ic3Theme {
      * Default values (e.g., box options, chart options, etc..).
      */
     widgetDefaults?: IThemeWidgetDefaults;
+    /**
+     * Styling for the sparklines in the sparkline transformation and the KPI card
+     */
+    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,8 +347,114 @@ export interface ic3ThemeOptions {
      * The first defined layout is used as the default one.
      */
     layouts: IWidgetLayoutDefinition[];
+    /**
+     * Styling for the sparklines in the sparkline transformation and the KPI card
+     */
+    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;
+}
+interface ic3BaseComponents {
+    AlertDialog?: {
+        styleOverrides?: ComponentsOverrides["AlertDialog"];
+    };
+    App?: {
+        styleOverrides?: ComponentsOverrides["App"];
+    };
+    DrilldownUserSelectMenu?: {
+        styleOverrides?: ComponentsOverrides["DrilldownUserSelectMenu"];
+    };
+    ErrorRenderer?: {
+        styleOverrides?: ComponentsOverrides["ErrorRenderer"];
+    };
+    FilterButtons?: {
+        styleOverrides?: ComponentsOverrides["FilterButtons"];
+        variants?: ComponentsVariants["FilterButtons"];
+    };
+    FilterSlider?: {
+        styleOverrides?: ComponentsOverrides["FilterSlider"];
+        variants?: ComponentsVariants["FilterSlider"];
+    };
+    GoogleMapMarker?: {
+        variants?: ComponentsVariants['GoogleMapMarker'];
+    };
+    HtmlBox?: {
+        styleOverrides?: ComponentsOverrides["HtmlBox"];
+        variants?: ComponentsVariants["HtmlBox"];
+    };
+    Layout?: {
+        styleOverrides?: ComponentsOverrides["Layout"];
+    };
+    LayoutPage?: {
+        styleOverrides?: ComponentsOverrides["LayoutPage"];
+    };
+    PivotTable?: {
+        variants?: ComponentsVariants['PivotTable'];
+        styleOverrides?: ComponentsOverrides["PivotTable"];
+    };
+    ReportAppBar?: {
+        styleOverrides?: ComponentsOverrides["ReportAppBar"];
+    };
+    ReportAppMenu?: {
+        styleOverrides?: ComponentsOverrides["ReportAppMenu"];
+    };
+    Table?: {
+        variants?: ComponentsVariants['Table'];
+        styleOverrides?: ComponentsOverrides["Table"];
+    };
+    WidgetBox?: {
+        variants?: ComponentsVariants['WidgetBox'];
+        styleOverrides?: ComponentsOverrides["WidgetBox"];
+    };
+    WidgetBoxContentMessage?: {
+        styleOverrides?: ComponentsOverrides["WidgetBoxContentMessage"];
+    };
+}
+/**
+ * For Typing purpose extending MUI Theme with ic3 components
+ */
+export interface ic3Components extends ic3BaseComponents, Components {
+}
+/**
+ *
+ * MUI Module augmentation
+ *
+ */
+declare module "@mui/material/styles/createPalette" {
+    interface Palette {
+        ic3: ic3Palette;
+    }
+    interface PaletteOptions {
+        ic3?: ic3PaletteOptions;
+    }
+}
+declare module "@mui/material/styles/createTypography" {
+    interface Typography {
+        ic3: ic3Typography;
+    }
+    interface TypographyOptions {
+        ic3?: ic3TypographyOptions;
+    }
 }
-declare module '@material-ui/core/styles/createTheme' {
+declare module '@mui/material/styles/createTheme' {
     interface Theme {
         ic3: ic3Theme;
     }
@@ -334,54 +468,11 @@ declare module '@material-ui/core/styles/createTheme' {
 /**
  * All Components using Material-UI like variants (using styled)
  */
-declare module '@material-ui/core/styles/components' {
-    interface Components {
-        AlertDialog: {
-            styleOverrides?: ComponentsOverrides["AlertDialog"];
-        };
-        App: {
-            styleOverrides?: ComponentsOverrides["App"];
-        };
-        DrilldownUserSelectMenu: {
-            styleOverrides?: ComponentsOverrides["DrilldownUserSelectMenu"];
-        };
-        ErrorRenderer: {
-            styleOverrides?: ComponentsOverrides["ErrorRenderer"];
-        };
-        HtmlBox: {
-            styleOverrides?: ComponentsOverrides["HtmlBox"];
-            variants?: ComponentsVariants["HtmlBox"];
-        };
-        FilterButtons: {
-            styleOverrides?: ComponentsOverrides["FilterButtons"];
-            variants?: ComponentsVariants["FilterButtons"];
-        };
-        FilterSlider: {
-            styleOverrides?: ComponentsOverrides["FilterSlider"];
-            variants?: ComponentsVariants["FilterSlider"];
-        };
-        Layout: {
-            styleOverrides?: ComponentsOverrides["Layout"];
-        };
-        LayoutPage: {
-            styleOverrides?: ComponentsOverrides["LayoutPage"];
-        };
-        ReportAppBar: {
-            styleOverrides?: ComponentsOverrides["ReportAppBar"];
-        };
-        ReportAppMenu: {
-            styleOverrides?: ComponentsOverrides["ReportAppMenu"];
-        };
-        WidgetBox: {
-            variants?: ComponentsVariants['WidgetBox'];
-            styleOverrides?: ComponentsOverrides["WidgetBox"];
-        };
-        WidgetBoxContentMessage: {
-            styleOverrides?: ComponentsOverrides["WidgetBoxContentMessage"];
-        };
+declare module '@mui/material/styles/components' {
+    interface Components extends ic3BaseComponents {
     }
 }
-declare module '@material-ui/core/styles/overrides' {
+declare module '@mui/material/styles/overrides' {
     interface ComponentNameToClassKey {
         AlertDialog: AlertDialogClassKey;
         App: AppClassKey;
@@ -392,18 +483,23 @@ declare module '@material-ui/core/styles/overrides' {
         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 {
-        HtmlBox: HtmlBoxProps;
-        WidgetBox: Record<never, any>;
         FilterButtons: FilterButtonsProps;
         FilterSlider: FilterSliderProps;
+        GoogleMapMarker: GoogleMapMarkerProps;
+        HtmlBox: HtmlBoxProps;
+        PivotTable: PivotTableProps;
+        Table: TableProps;
+        WidgetBox: Record<never, any>;
     }
 }
 export {};

package/dist/PublicTheme.js.map

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