@ic3/reporting-api 8.4.13 → 8.4.14

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.
package/dist/ApiUtils.js CHANGED
@@ -8,7 +8,7 @@ const ReportingVersion_1 = __importDefault(require("./ReportingVersion"));
8
8
  class ApiUtils {
9
9
  static makePlugin(definition) {
10
10
  return () => {
11
- return Object.assign({ apiVersion: new ReportingVersion_1.default("8.4.13" || "-", "Thu, 18 Jul 2024 14:16:57 GMT" || "-") }, definition);
11
+ return Object.assign({ apiVersion: new ReportingVersion_1.default("8.4.14" || "-", "Wed, 28 Aug 2024 07:55:59 GMT" || "-") }, definition);
12
12
  };
13
13
  }
14
14
  /**
@@ -42,6 +42,7 @@ export interface IPublicContext {
42
42
  getThemeFormatter(): ThemeFormatters;
43
43
  getUserName(): string;
44
44
  getReportName(): string;
45
+ getReportPath(): string;
45
46
  getReportFolderName(): string;
46
47
  getReportLocale(): string;
47
48
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"PublicContext.js","sourceRoot":"","sources":["../src/PublicContext.ts"],"names":[],"mappings":";;;AAaA,IAAY,wBAGX;AAHD,WAAY,wBAAwB;IAChC,mDAAuB,CAAA;IACvB,iDAAqB,CAAA;AACzB,CAAC,EAHW,wBAAwB,wCAAxB,wBAAwB,QAGnC;AAED,IAAY,qBAGX;AAHD,WAAY,qBAAqB;IAC7B,uEAAO,CAAA;IACP,mEAAK,CAAA;AACT,CAAC,EAHW,qBAAqB,qCAArB,qBAAqB,QAGhC;AAED,IAAY,mBAAkC;AAA9C,WAAY,mBAAmB;IAAG,6DAAI,CAAA;IAAE,+DAAK,CAAA;AAAA,CAAC,EAAlC,mBAAmB,mCAAnB,mBAAmB,QAAe;AA4X7C,CAAC"}
1
+ {"version":3,"file":"PublicContext.js","sourceRoot":"","sources":["../src/PublicContext.ts"],"names":[],"mappings":";;;AAaA,IAAY,wBAGX;AAHD,WAAY,wBAAwB;IAChC,mDAAuB,CAAA;IACvB,iDAAqB,CAAA;AACzB,CAAC,EAHW,wBAAwB,wCAAxB,wBAAwB,QAGnC;AAED,IAAY,qBAGX;AAHD,WAAY,qBAAqB;IAC7B,uEAAO,CAAA;IACP,mEAAK,CAAA;AACT,CAAC,EAHW,qBAAqB,qCAArB,qBAAqB,QAGhC;AAED,IAAY,mBAAkC;AAA9C,WAAY,mBAAmB;IAAG,6DAAI,CAAA;IAAE,+DAAK,CAAA;AAAA,CAAC,EAAlC,mBAAmB,mCAAnB,mBAAmB,QAAe;AA8X7C,CAAC"}
@@ -182,6 +182,9 @@ export interface IWidgetLayoutDefinition {
182
182
  layoutConfigId: string;
183
183
  layoutGroup: string;
184
184
  layoutName: string;
185
+ /**
186
+ * CSS class of the layout.
187
+ */
185
188
  cssClass?: string;
186
189
  /**
187
190
  * The theme is defining a scale (widgetContentPrintScale) applied to the widget content
@@ -590,6 +590,11 @@ export interface ITemplateEventActionDef {
590
590
  * The actions subscribing to the 'selection' channel
591
591
  */
592
592
  selectionSubscribe?: string;
593
+ /**
594
+ * Return true if the widget fires the event on its first render. This forces other widgets that use this event
595
+ * to wait before rendering.
596
+ */
597
+ isEventFiredAtStart?: (roleName: string, options: any) => boolean;
593
598
  }
594
599
  export interface IWrappedWidgetTemplateDefinition<WIDGET extends WidgetTemplateIDs> {
595
600
  /**
@@ -44,6 +44,7 @@ import { Ic3TableCellProps, ThemeIc3TableCellClassesKey } from "./theme/ThemeIc3
44
44
  import { RegexFilterClassesKey, RegexFilterProps } from "./theme/ThemeRegexFilter";
45
45
  import { AIWidgetChatBotClassKey, AIWidgetChatBotStyleProps } from "./theme/ThemeAIWidgetChatBot";
46
46
  import { FilterPanelViewsMenuClassesKey } from "./theme/ThemeFilterPanelViewsMenu";
47
+ import { Ic3TableCellDrilldownProps, ThemeIc3TableCellDrilldownClassesKey } from "./theme/ThemeIc3TableCellDrilldown";
47
48
  export type Ic3ChartVariants = {
48
49
  [Name in keyof WidgetTemplateChartOptions]?: Array<{
49
50
  props: {
@@ -844,6 +845,9 @@ interface ic3BaseComponents {
844
845
  Ic3TableCell?: {
845
846
  styleOverrides?: ComponentsOverrides["Ic3TableCell"];
846
847
  };
848
+ Ic3TableCellDrilldown?: {
849
+ styleOverrides?: ComponentsOverrides["Ic3TableCellDrilldown"];
850
+ };
847
851
  Ic3TableCellError?: {
848
852
  styleOverrides?: ComponentsOverrides["Ic3TableCellError"];
849
853
  };
@@ -975,6 +979,7 @@ declare module '@mui/material/styles/overrides' {
975
979
  CodeMirror: CodeMirrorClassesKey;
976
980
  WidgetBoxFilteredByTooltip: WidgetFilteredByClassesKey;
977
981
  Ic3TableCell: ThemeIc3TableCellClassesKey;
982
+ Ic3TableCellDrilldown: ThemeIc3TableCellDrilldownClassesKey;
978
983
  Ic3TableCellError: ThemeIc3TableCellClassesKey;
979
984
  }
980
985
  }
@@ -1003,6 +1008,7 @@ declare module '@mui/material/styles/props' {
1003
1008
  QueryBuilderNode: QueryBuilderNodeProps;
1004
1009
  PrintButton: StyledPrintButtonDivProps;
1005
1010
  Ic3TableCell: Ic3TableCellProps;
1011
+ Ic3TableCellDrilldown: Ic3TableCellDrilldownProps;
1006
1012
  Ic3TableCellError: Ic3TableCellProps;
1007
1013
  }
1008
1014
  }
@@ -1 +1 @@
1
- {"version":3,"file":"PublicTheme.js","sourceRoot":"","sources":["../src/PublicTheme.ts"],"names":[],"mappings":";;;AA4JA,SAAgB,yBAAyB,CAAC,CAAqE;IAC3G,OAAO,CAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAG,SAAS,CAAC,KAAI,IAAI,CAAC;AAClC,CAAC;AAFD,8DAEC;AA6RD,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAC7B,8CAAqB,CAAA;IACrB,4CAAmB,CAAA;IACnB,wCAAe,CAAA;AACnB,CAAC,EAJW,qBAAqB,qCAArB,qBAAqB,QAIhC"}
1
+ {"version":3,"file":"PublicTheme.js","sourceRoot":"","sources":["../src/PublicTheme.ts"],"names":[],"mappings":";;;AA6JA,SAAgB,yBAAyB,CAAC,CAAqE;IAC3G,OAAO,CAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAG,SAAS,CAAC,KAAI,IAAI,CAAC;AAClC,CAAC;AAFD,8DAEC;AA6RD,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAC7B,8CAAqB,CAAA;IACrB,4CAAmB,CAAA;IACnB,wCAAe,CAAA;AACnB,CAAC,EAJW,qBAAqB,qCAArB,qBAAqB,QAIhC"}
@@ -537,6 +537,10 @@ export interface ITidyBaseColumn<T> extends ITidyBaseColumnReadonly<T> {
537
537
  * @see ITidyColumn.reIndexN
538
538
  */
539
539
  reIndex(index: number[]): void;
540
+ /**
541
+ * Reset the index set using `reIndex`.
542
+ */
543
+ resetIndex(): void;
540
544
  /**
541
545
  * Set the formatted values. Use this if you have the formatted values pre-calculated,
542
546
  * or a function to calculate the formatted values.
@@ -527,4 +527,8 @@ export interface ITidyTable {
527
527
  *
528
528
  */
529
529
  getTopHeaderHierarchyCount(): number;
530
+ /**
531
+ * Clear the index. Use for resetting sorting / filtering.
532
+ */
533
+ resetIndex(): void;
530
534
  }
@@ -173,6 +173,7 @@ export interface ITidyTableDrilldown {
173
173
  handleDrilldown(rowIdx: number, event: TidyEvent | undefined, stopDrillDownDepth?: number): void;
174
174
  hasDrilldown(): boolean;
175
175
  hasNodeDrilldown(nodeInfo: MdxNodeIdentifier, stopDrillDownDepth?: number): boolean;
176
+ hasPivotLikeDrilldown(): boolean;
176
177
  }
177
178
  export interface ITidyTableInteractionEvent {
178
179
  /**
@@ -304,4 +305,9 @@ export interface ITidyTableInteraction extends ITidyTableInteractionSelection, I
304
305
  * Use for publishing app notifications, e.g., print the report.
305
306
  */
306
307
  publishAppNotification(notification: AppNotification): void;
308
+ /**
309
+ * Get a column from the underlying tidy table.
310
+ * @param columnIdx
311
+ */
312
+ getDrilldownColumn(columnIdx: number): ITidyColumn;
307
313
  }
@@ -2,7 +2,7 @@
2
2
  * Tidy Column Types
3
3
  */
4
4
  import { TidyHistogramBucketType } from "./PublicTidyHistogram";
5
- import { ITidyColumn, ITidyColumnAddValueInsert } from "./PublicTidyColumn";
5
+ import { ITidyColumn, ITidyColumnAddValueCopyRow, ITidyColumnAddValueInsert } from "./PublicTidyColumn";
6
6
  import { MdxNodeIdentifier } from "./PublicTidyTable";
7
7
  import { SelectionMode } from "./PublicTidyTableInteractions";
8
8
  export declare enum TidyColumnsType {
@@ -394,7 +394,7 @@ export interface ITotalRowValues {
394
394
  /**
395
395
  * Keys as column names.
396
396
  */
397
- totalTexts: Record<string, ITidyColumnAddValueInsert>;
397
+ totalTexts: Record<string, ITidyColumnAddValueInsert | ITidyColumnAddValueCopyRow>;
398
398
  }
399
399
  /**
400
400
  * If we have (date)times available, then
@@ -14,6 +14,10 @@ export interface BaseTableChartOptions extends FormFieldObject {
14
14
  * If enabled, show tooltips on every cell in the table (excluding renderers). Default = true.
15
15
  */
16
16
  cellTooltips: boolean;
17
+ /**
18
+ * Save the state of the table in the users browsers local storage.
19
+ */
20
+ saveTableStateLocally?: boolean;
17
21
  /**
18
22
  * Row Height.
19
23
  */
@@ -186,6 +186,10 @@ export interface FilterPanelChartOptions extends FormFieldObject {
186
186
  * Allow users to save and load filters. Filters are stored in the users' browser.
187
187
  */
188
188
  enableViews?: boolean;
189
+ /**
190
+ * Max number of views a user can have. Empty means unlimited.
191
+ */
192
+ maxNumberOfViews?: number;
189
193
  /**
190
194
  * If true, grow filter in row direction. If false, grow in column direction.
191
195
  */
@@ -1,5 +1,6 @@
1
1
  export declare class FilterPanelViewsMenuClasses {
2
2
  static readonly save = "ic3FilterPanelViewsMenu-save";
3
3
  static readonly view = "ic3FilterPanelViewsMenu-view";
4
+ static readonly maxViewsReachedText = "ic3FilterPanelViewsMenu-maxViewsReachedText";
4
5
  }
5
6
  export declare type FilterPanelViewsMenuClassesKey = keyof FilterPanelViewsMenuClasses;
@@ -6,4 +6,5 @@ class FilterPanelViewsMenuClasses {
6
6
  exports.FilterPanelViewsMenuClasses = FilterPanelViewsMenuClasses;
7
7
  FilterPanelViewsMenuClasses.save = "ic3FilterPanelViewsMenu-save";
8
8
  FilterPanelViewsMenuClasses.view = "ic3FilterPanelViewsMenu-view";
9
+ FilterPanelViewsMenuClasses.maxViewsReachedText = "ic3FilterPanelViewsMenu-maxViewsReachedText";
9
10
  //# sourceMappingURL=ThemeFilterPanelViewsMenu.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"ThemeFilterPanelViewsMenu.js","sourceRoot":"","sources":["../../src/theme/ThemeFilterPanelViewsMenu.ts"],"names":[],"mappings":";;;AAAA,MAAa,2BAA2B;;AAAxC,kEAMC;AAJmB,gCAAI,GAAG,8BAA8B,CAAC;AAEtC,gCAAI,GAAG,8BAA8B,CAAC"}
1
+ {"version":3,"file":"ThemeFilterPanelViewsMenu.js","sourceRoot":"","sources":["../../src/theme/ThemeFilterPanelViewsMenu.ts"],"names":[],"mappings":";;;AAAA,MAAa,2BAA2B;;AAAxC,kEAQC;AANmB,gCAAI,GAAG,8BAA8B,CAAC;AAEtC,gCAAI,GAAG,8BAA8B,CAAC;AAEtC,+CAAmB,GAAG,6CAA6C,CAAC"}
@@ -0,0 +1,12 @@
1
+ export declare class ThemeIc3TableCellDrilldownClasses {
2
+ static loading: string;
3
+ static normal: string;
4
+ static expanded: string;
5
+ static iconDiv: string;
6
+ }
7
+ export declare type ThemeIc3TableCellDrilldownClassesKey = keyof ThemeIc3TableCellDrilldownClasses;
8
+ export interface Ic3TableCellDrilldownProps {
9
+ levelDepth: number;
10
+ hasRender: boolean;
11
+ hasChildren: boolean;
12
+ }
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ThemeIc3TableCellDrilldownClasses = void 0;
4
+ class ThemeIc3TableCellDrilldownClasses {
5
+ }
6
+ exports.ThemeIc3TableCellDrilldownClasses = ThemeIc3TableCellDrilldownClasses;
7
+ ThemeIc3TableCellDrilldownClasses.loading = "Ic3TableCellDrilldown-loading";
8
+ ThemeIc3TableCellDrilldownClasses.normal = "Ic3TableCellDrilldown-normal";
9
+ ThemeIc3TableCellDrilldownClasses.expanded = "Ic3TableCellDrilldown-expanded";
10
+ ThemeIc3TableCellDrilldownClasses.iconDiv = "Ic3TableCellDrilldown-iconDiv";
11
+ //# sourceMappingURL=ThemeIc3TableCellDrilldown.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ThemeIc3TableCellDrilldown.js","sourceRoot":"","sources":["../../src/theme/ThemeIc3TableCellDrilldown.ts"],"names":[],"mappings":";;;AAAA,MAAa,iCAAiC;;AAA9C,8EAQC;AALiB,yCAAO,GAAG,+BAA+B,CAAC;AAC1C,wCAAM,GAAG,8BAA8B,CAAC;AACxC,0CAAQ,GAAG,gCAAgC,CAAC;AAC5C,yCAAO,GAAG,+BAA+B,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ic3/reporting-api",
3
- "version": "8.4.13",
3
+ "version": "8.4.14",
4
4
  "description": "icCube dashboards API",
5
5
  "homepage": "https://github.com/ic3-software/ic3-reporting-api",
6
6
  "repository": "https://github.com/ic3-software/ic3-reporting-api",
@@ -11,14 +11,14 @@
11
11
  "access": "public"
12
12
  },
13
13
  "dependencies": {
14
- "@mui/material": "5.16.1",
15
- "@mui/system": "5.16.1",
16
- "@emotion/react": "11.11.4",
17
- "@emotion/styled": "11.11.5"
14
+ "@mui/material": "5.16.7",
15
+ "@mui/system": "5.16.7",
16
+ "@emotion/react": "11.13.0",
17
+ "@emotion/styled": "11.13.0"
18
18
  },
19
19
  "devDependencies": {
20
20
  "@types/markerclustererplus": "2.1.33",
21
- "@types/node": "20.14.10",
21
+ "@types/node": "22.3.0",
22
22
  "@types/react": "18.3.3",
23
23
  "del-cli": "5.1.0",
24
24
  "typescript": "5.4.5"