@ic3/reporting-api 8.2.0 → 8.2.1

package/dist/ApiUtils.js

@@ -8,7 +8,7 @@ const ReportingVersion_1 = __importDefault(require("./ReportingVersion"));
 class ApiUtils {
     static makePlugin(definition) {
         return () => {
-            return Object.assign({ apiVersion: new ReportingVersion_1.default("8.2.0" || "-", "Thu, 14 Jul 2022 12:18:27 GMT" || "-") }, definition);
+            return Object.assign({ apiVersion: new ReportingVersion_1.default("8.2.1" || "-", "Wed, 03 Aug 2022 13:20:55 GMT" || "-") }, definition);
         };
     }
     /**

package/dist/INotification.d.ts

@@ -1,5 +1,5 @@
 import { PaperOrientation, PaperSizeName } from "./ITypes";
-export declare type AppNotificationType = "edit-report" | "print-report-dialog" | "print-report" | "print-report-without-state" | "print-report-in-browser" | "save-state-to-localstorage" | "restore-state-from-localstorage" | "save-ownprops-to-localstorage" | "restore-ownprops-from-localstorage";
+export declare type AppNotificationType = "edit-report" | "print-report-dialog" | "print-report" | "print-report-without-state" | "print-report-in-browser" | "save-state-to-localstorage" | "restore-state-from-localstorage" | "save-ownprops-to-localstorage" | "restore-ownprops-from-localstorage" | "save-reportwidgets-ownprops-to-localstorage" | "restore-reportwidgets-ownprops-from-localstorage";
 export interface IAppNotification {
     /**
      * E.g., print-report.
@@ -50,4 +50,10 @@ export interface SaveOwnPropsToLocalStorageNotification extends IAppNotification
 export interface RestoreOwnPropsFromLocalStorageNotification extends IAppNotification {
     readonly type: "restore-ownprops-from-localstorage";
 }
-export declare type AppNotification = AppEditReportNotification | AppPrintReportDialogNotification | AppPrintReportNotification | AppPrintReportWithoutStateNotification | AppPrintReportInBrowserNotification | SaveStateToLocalStorageNotification | RestoreStateFromLocalStorageNotification | SaveOwnPropsToLocalStorageNotification | RestoreOwnPropsFromLocalStorageNotification;
+export interface SaveWidgetOwnPropsToLocalStorageNotification extends IAppNotification {
+    readonly type: "save-reportwidgets-ownprops-to-localstorage";
+}
+export interface RestoreWidgetOwnPropsFromLocalStorageNotification extends IAppNotification {
+    readonly type: "restore-reportwidgets-ownprops-from-localstorage";
+}
+export declare type AppNotification = AppEditReportNotification | AppPrintReportDialogNotification | AppPrintReportNotification | AppPrintReportWithoutStateNotification | AppPrintReportInBrowserNotification | SaveStateToLocalStorageNotification | RestoreStateFromLocalStorageNotification | SaveOwnPropsToLocalStorageNotification | RestoreWidgetOwnPropsFromLocalStorageNotification | SaveWidgetOwnPropsToLocalStorageNotification | RestoreOwnPropsFromLocalStorageNotification;

package/dist/IThemeManager.d.ts

@@ -53,4 +53,9 @@ export interface IThemeManager {
      * created from its partial options (e.g., using palette, typography, spacing, etc...)
      */
     registerTheme(themeOptions: any, themeDecorator?: (theme: any) => ic3Components, baseTheme?: EmbeddedThemeNames): void;
+    /**
+     * Register editor themes. Change the editor theme in ic3report-config.js by setting defaultEditorThemeId to a
+     * themeId from a theme using this method.
+     */
+    registerEditorTheme(themeOptions: any, themeDecorator?: (theme: any) => ic3Components): void;
 }

package/dist/ITypes.d.ts

@@ -23,3 +23,9 @@ export declare enum SparklinePosition {
     BELOW_VALUE = "BELOW_VALUE",
     RIGHT_OF_VALUE = "RIGHT_OF_VALUE"
 }
+export declare enum QueryType {
+    MDX = "mdx",
+    SQL = "sql",
+    EMBEDDED = "embedded",
+    HTTP_CSV = "HTTP_CSV"
+}

package/dist/ITypes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SparklinePosition = exports.SparkChartType = exports.TargetTextIconSet = exports.TargetTextPosition = exports.CompareTextInterpretationType = void 0;
+exports.QueryType = exports.SparklinePosition = exports.SparkChartType = exports.TargetTextIconSet = exports.TargetTextPosition = exports.CompareTextInterpretationType = void 0;
 var CompareTextInterpretationType;
 (function (CompareTextInterpretationType) {
     CompareTextInterpretationType["MORE"] = "more=better";
@@ -28,4 +28,11 @@ var SparklinePosition;
     SparklinePosition["BELOW_VALUE"] = "BELOW_VALUE";
     SparklinePosition["RIGHT_OF_VALUE"] = "RIGHT_OF_VALUE";
 })(SparklinePosition = exports.SparklinePosition || (exports.SparklinePosition = {}));
+var QueryType;
+(function (QueryType) {
+    QueryType["MDX"] = "mdx";
+    QueryType["SQL"] = "sql";
+    QueryType["EMBEDDED"] = "embedded";
+    QueryType["HTTP_CSV"] = "HTTP_CSV";
+})(QueryType = exports.QueryType || (exports.QueryType = {}));
 //# sourceMappingURL=ITypes.js.map

package/dist/ITypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"ITypes.js","sourceRoot":"","sources":["../src/ITypes.ts"],"names":[],"mappings":";;;AAIA,IAAY,6BAIX;AAJD,WAAY,6BAA6B;IACrC,qDAAoB,CAAA;IACpB,qDAAoB,CAAA;IACpB,8CAAa,CAAA;AACjB,CAAC,EAJW,6BAA6B,GAA7B,qCAA6B,KAA7B,qCAA6B,QAIxC;AAED,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC1B,yCAAmB,CAAA;IACnB,6CAAuB,CAAA;IACvB,mDAA6B,CAAA;AACjC,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B;AAED,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IACzB,gDAA2B,CAAA;IAC3B,sDAAiC,CAAA;AACrC,CAAC,EAHW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAG5B;AAED,IAAY,cAGX;AAHD,WAAY,cAAc;IACtB,+BAAa,CAAA;IACb,mCAAiB,CAAA;AACrB,CAAC,EAHW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAGzB;AAED,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IACzB,gDAA2B,CAAA;IAC3B,sDAAiC,CAAA;AACrC,CAAC,EAHW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAG5B"}
+{"version":3,"file":"ITypes.js","sourceRoot":"","sources":["../src/ITypes.ts"],"names":[],"mappings":";;;AAIA,IAAY,6BAIX;AAJD,WAAY,6BAA6B;IACrC,qDAAoB,CAAA;IACpB,qDAAoB,CAAA;IACpB,8CAAa,CAAA;AACjB,CAAC,EAJW,6BAA6B,GAA7B,qCAA6B,KAA7B,qCAA6B,QAIxC;AAED,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC1B,yCAAmB,CAAA;IACnB,6CAAuB,CAAA;IACvB,mDAA6B,CAAA;AACjC,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B;AAED,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IACzB,gDAA2B,CAAA;IAC3B,sDAAiC,CAAA;AACrC,CAAC,EAHW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAG5B;AAED,IAAY,cAGX;AAHD,WAAY,cAAc;IACtB,+BAAa,CAAA;IACb,mCAAiB,CAAA;AACrB,CAAC,EAHW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAGzB;AAED,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IACzB,gDAA2B,CAAA;IAC3B,sDAAiC,CAAA;AACrC,CAAC,EAHW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAG5B;AAED,IAAY,SAKX;AALD,WAAY,SAAS;IACjB,wBAAW,CAAA;IACX,wBAAW,CAAA;IACX,kCAAqB,CAAA;IACrB,kCAAqB,CAAA;AACzB,CAAC,EALW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAKpB"}

package/dist/IcEvent.d.ts

@@ -17,6 +17,10 @@ export interface PublicIcEvent {
      * The MDX version of the events
      */
     readonly mdx: string;
+    /**
+     * If available the key of the MDX member
+     */
+    readonly key?: any | any[];
     /**
      * These two strings together define an unique id for a widget in a report
      */

package/dist/PublicTemplate.d.ts

@@ -8,6 +8,7 @@ import { Theme } from "@mui/material/styles";
 import { WidgetTemplateChartOptions, WidgetTemplateIDs } from "./PublicTemplates";
 import { ChartTemplateDataMapping, IFormFieldGranularityItem } from "./PublicTidyTableTypes";
 import { ResizingConstraintOptions } from "./theme/ThemeWidgetBox";
+import { QueryType } from "./ITypes";
 export interface IRectanglePosition {
     top: number;
     left: number;
@@ -63,9 +64,9 @@ export interface IWidgetTemplateMdxBuilderAxisProps {
      */
     disableNonEmpty?: true;
     /**
-     * For filters add lazy load feature to the axis
+     * For filters add lazy load feature to the axis.
      */
-    addLazyLoad?: true;
+    withLazySearch?: true;
     /**
      * Allow only a single member
      */
@@ -390,6 +391,19 @@ interface IPublicCommonWidgetTemplateDefinition<OPTIONS extends FormFieldObject>
      *  Returns true if the widget fires a global event at initialization (start)
      */
     firesGlobalEventAtStart?: (options: OPTIONS | undefined, templateDef: IPublicWidgetTemplateDefinition<OPTIONS>) => boolean;
+    /**
+     * Limit on the rows of the tidy result to be sure that the browser does not crash during rendering.
+     * Leave to undefined or set to -1 to have no limit.
+     *
+     * Note: can be overridden via Dashboards options (ic3report-config.js).
+     */
+    maxTidyRowCount?: number;
+    /**
+     * List of supported types of query.
+     *
+     * Defaults: all of them.
+     */
+    withQueryTypes?: QueryType[];
 }
 /**
  * *********************************************************************************************************************

package/dist/PublicTemplate.js.map

@@ -1 +1 @@
-{"version":3,"file":"PublicTemplate.js","sourceRoot":"","sources":["../src/PublicTemplate.ts"],"names":[],"mappings":";;;AAyDA,IAAY,4CAIX;AAJD,WAAY,4CAA4C;IACpD,qEAAqB,CAAA;IACrB,yEAAyB,CAAA;IACzB,2EAA2B,CAAA;AAC/B,CAAC,EAJW,4CAA4C,GAA5C,oDAA4C,KAA5C,oDAA4C,QAIvD;AAyaD;;;;GAIG;AACH,IAAY,4BAKX;AALD,WAAY,4BAA4B;IACpC,+CAAe,CAAA;IACf,iDAAiB,CAAA;IACjB,2CAAW,CAAA;IACX,6CAAa,CAAA;AACjB,CAAC,EALW,4BAA4B,GAA5B,oCAA4B,KAA5B,oCAA4B,QAKvC;AA6BD;;GAEG;AACH,IAAY,wBAMX;AAND,WAAY,wBAAwB;IAChC,mDAAuB,CAAA;IAEvB,gBAAgB;IAChB,0DAA8B,CAAA;IAC9B,iEAAqC,CAAA;AACzC,CAAC,EANW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAMnC"}
+{"version":3,"file":"PublicTemplate.js","sourceRoot":"","sources":["../src/PublicTemplate.ts"],"names":[],"mappings":";;;AA0DA,IAAY,4CAIX;AAJD,WAAY,4CAA4C;IACpD,qEAAqB,CAAA;IACrB,yEAAyB,CAAA;IACzB,2EAA2B,CAAA;AAC/B,CAAC,EAJW,4CAA4C,GAA5C,oDAA4C,KAA5C,oDAA4C,QAIvD;AAybD;;;;GAIG;AACH,IAAY,4BAKX;AALD,WAAY,4BAA4B;IACpC,+CAAe,CAAA;IACf,iDAAiB,CAAA;IACjB,2CAAW,CAAA;IACX,6CAAa,CAAA;AACjB,CAAC,EALW,4BAA4B,GAA5B,oCAA4B,KAA5B,oCAA4B,QAKvC;AA6BD;;GAEG;AACH,IAAY,wBAMX;AAND,WAAY,wBAAwB;IAChC,mDAAuB,CAAA;IAEvB,gBAAgB;IAChB,0DAA8B,CAAA;IAC9B,iEAAqC,CAAA;AACzC,CAAC,EANW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAMnC"}

package/dist/PublicTemplates.d.ts

@@ -22,6 +22,7 @@ interface IWidgetTemplateChartOptions {
     "ic3.DatePicker": DatePickerChartOptions;
     "ic3.EmbeddedReport": EmbeddedReportChartOptions;
     "ic3.FilterAutocomplete": FilterAutocompleteChartOptions;
+    "ic3.FilterAutocompleteLazy": FilterAutocompleteChartOptions;
     "ic3.FilterButtons": FilterButtonsChartOptions;
     "ic3.FilterCheckboxRadio": FilterCheckboxRadioChartOptions;
     "ic3.FilterPanel": FilterPanelChartOptions;

package/dist/PublicTheme.d.ts

@@ -354,6 +354,13 @@ export interface ic3Theme {
     };
 }
 export interface ic3ThemeOptions {
+    /**
+     * For editor theme, the id to use in your app-local/ic3report-config.js:
+     *
+     * <pre>
+     *     options.defaultEditorThemeId = ...
+     * </pre>
+     */
     id: string;
     caption: string;
     cssClass?: string;
@@ -421,19 +428,27 @@ export interface ic3ThemeOptions {
      */
     editor?: {
         /**
-         * Editor logo. Defaults to icCubes logo.
+         * Editor logo.
+         *
+         * Default: icCube logo.
          */
         logo?: string;
         /**
-         * Alt text for the logo image. Default = icCube.
+         * Alt text for the logo image.
+         *
+         * Default: "icCube".
          */
         logoAlt?: string;
         /**
-         * Top - Offset of dashboard page to the editor. Default 25.
+         * Top offset of the edited dashboard page in the editor.
+         *
+         * Default: 25.
          */
         viewPortOffsetTop?: number;
         /**
-         * Left - Offset of dashboard page to the editor. Default 25.
+         * Left offset of the edited dashboard page in the editor.
+         *
+         * Default: 25.
          */
         viewPortOffsetLeft?: number;
     };

package/dist/PublicTidyTable.d.ts

@@ -445,7 +445,10 @@ export interface ITidyTable {
      * Add a new index to the existing index, overwriting what already exists.
      */
     addColumnIndex(index: TidyColumnIndex): void;
-    getQueryLimit(): number | undefined;
+    /**
+     * The limit used when lazy search is enabled.
+     */
+    getLazySearchLimit(): number | undefined;
     isTotalRow(rowIdx: number): boolean;
     /**
      * Transform the table to a table where each row is a bucket in the histogram for that group.
@@ -486,4 +489,8 @@ export interface ITidyTable {
      * Utility class for doing maths on columns
      */
     getMath(): ITidyMath;
+    /**
+     * Returns true if and only if the table is truncated by the server (too many rows otherwise).
+     */
+    reachedMaxTidyRowCount(): boolean;
 }

package/dist/PublicTidyTableInteractions.d.ts

@@ -1,4 +1,4 @@
-import { SelectionBehaviour, WidgetTidySelectionOptions } from "./PublicTidyTableTypes";
+import { EntityItem, ITidyTableSelection, SelectionBehaviour, WidgetTidySelectionOptions } from "./PublicTidyTableTypes";
 import { ITidyBaseColumn, ITidyColumn } from "./PublicTidyColumn";
 import { ILazyTreeViewLoader } from "./LazyTreeView";
 import { PublicIcEvent } from "./IcEvent";
@@ -32,9 +32,13 @@ export declare type TidyEvent = MouseEvent | TouchEvent;
 export declare type IWidgetInteractionMode = "drilldown" | "selection";
 export interface ITidyTableInteractionSelection {
     /**
-     * Sets the selection at the creation of the widget
+     * Sets the selection at the creation of the widget.
      */
     initializeSelection(isRangeSelection?: boolean): void;
+    /**
+     * Sets the selection at the creation of the widget: autocomplete-lazy.
+     */
+    initializeLazySelection(items?: EntityItem[]): void;
     /**
      * Returns true if the selection if empty. Returns false otherwise.
      */
@@ -266,10 +270,22 @@ export interface ITidyTableInteraction extends ITidyTableInteractionSelection, I
      */
     isSelectable(col: ITidyColumn): boolean;
     isHierarchyIdxSelectable(hierIndex: number): boolean;
+    /**
+     * Returns the rows of the items currently in the selection. Note, the item must be present in the current tidy
+     * table.
+     */
     getSelectedRows(): number[];
     setSortSelectionToColumnOrder(value: boolean): void;
     /**
      * Returns the widgets selection options.
      */
     getWidgetSelectionOptions(): WidgetTidySelectionOptions;
+    /**
+     * Returns the selection in the interaction object.
+     */
+    getSelectedItems(): ITidyTableSelection[];
+    /**
+     * Add an item to the interactions selection.
+     */
+    setSelection(items: ITidyTableSelection | ITidyTableSelection[]): void;
 }

package/dist/PublicTidyTableTypes.d.ts

@@ -231,7 +231,7 @@ export interface IMdxAxisSeriesInfo {
 }
 export interface EntityItem {
     uniqueName: string;
-    key?: string;
+    key?: any;
     name: string;
     caption: string;
     parentUN?: string;

package/dist/theme/ThemeBaseTable.d.ts

@@ -73,6 +73,12 @@ export interface BaseTableChartOptions extends FormFieldObject {
      * Display the sort options. A list of boolean values: 'true', 'false'. The last value repeats itself.
      */
     columnSortable: string;
+    /**
+     * Column Ordering (CSV).
+     *
+     * A list of boolean values: 'true', 'false'. The last value repeats itself.
+     */
+    columnOrdering: string;
     /**
      * Pinnable (CSV).
      *

package/dist/theme/ThemeFilterAutocomplete.d.ts

@@ -44,4 +44,10 @@ export interface FilterAutocompleteChartOptions extends FilterTidyTableChartOpti
      * Maximum number of items that will be visible when not focused. Set -1 to disable the limit.
      */
     limitTags: number;
+    /**
+     * Limit Chips.
+     *
+     * Maximum number of chips that will be visible
+     */
+    limitChips: number;
 }

package/dist/theme/ThemeKpiBox.d.ts

@@ -1,6 +1,5 @@
 import { FormFieldObject } from "../PublicTemplateForm";
 import { HtmlBoxVariant } from "./ThemeHtmlBox";
-import { TidyTableColumnSelector } from "../PublicTidyTableTypes";
 /**
  * KPI Box Options (fields of the "Chart" tab in the widget editor).
  *
@@ -31,16 +30,4 @@ export interface KpiBoxChartOptions extends FormFieldObject {
      * Expression that returns a markdown text. Evaluated once after row's markdown.
      */
     postMarkdown?: string;
-    /**
-     * Column.
-     *
-     * Default column for the expression and the background color.
-     */
-    column?: TidyTableColumnSelector;
-    /**
-     * Background Color.
-     *
-     * Use the column color to set the background color.
-     */
-    backgroundColorFromQuery: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ic3/reporting-api",
-  "version": "8.2.0",
+  "version": "8.2.1",
   "description": "icCube dashboards API",
   "homepage": "https://github.com/ic3-software/ic3-reporting-api",
   "repository": "https://github.com/ic3-software/ic3-reporting-api",
@@ -14,13 +14,13 @@
     "access": "public"
   },
   "devDependencies": {
-    "@mui/material": "5.8.7",
-    "@mui/system": "5.8.7",
+    "@mui/material": "5.9.3",
+    "@mui/system": "5.9.3",
     "@types/googlemaps": "3.43.3",
     "@types/markerclustererplus": "2.1.33",
-    "@types/node": "18.0.3",
+    "@types/node": "18.6.3",
     "@types/react": "17.0.43",
-    "del-cli": "4.0.1",
+    "del-cli": "5.0.0",
     "typescript": "4.7.4"
   },
   "scripts": {