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

package/dist/PublicTemplate.d.ts

@@ -1,14 +1,81 @@
 import { ITidyTable } from "./PublicTidyTable";
-import { ChartTemplateDataMapping, TidyColumnsType } from "./PublicTidyTableTypes";
 import { ITidyTableInteraction } from "./PublicTidyTableInteractions";
 import { IWidgetPublicContext } from "./PublicContext";
-import { FormFieldDef, FormFieldObject, FormFields } from "./PublicTemplateForm";
+import { FormFieldDef, FormFieldObject, FormFields, IFormColumnChooserFieldDef } from "./PublicTemplateForm";
 import { IWidgetVariantManager } from "./IWidgetVariantManager";
 import { ITidyColumn } from "./PublicTidyColumn";
 import { ReactElement } from "react";
-import { Theme } from "@material-ui/core/styles";
+import { Theme } from "@mui/material/styles";
 declare type ChartTemplateWidgetProps = any;
 export declare type IPublicWidgetTemplateDefinition<T extends FormFieldObject> = IPublicWidgetReactTemplateDefinition<T> | IPublicWidgetJsTemplateDefinition<T>;
+export declare enum IWidgetTemplateMdxBuilderAxisPropsConstraint {
+    DateType = "DateType",
+    GeoLatLong = "GeoLatLong",
+    GeoIso2Code = "GeoIso2Code"
+}
+export interface IWidgetTemplateMdxBuilderAxisProps {
+    /**
+     * Unique name used in the UI and if mdxAxisName not defined for building the query.
+     * If name is 'rows' for example, then in the query it will use 'ON "rows"'.
+     */
+    name: string;
+    /**
+     * The axis can be empty
+     */
+    isOptional?: true;
+    /**
+     * All axes with the same (not null) value for mdxAxisName are put as a tuple on the same axis. And the roles are
+     * comma separated.
+     */
+    mdxAxisName?: string;
+    /**
+     * Disable empty
+     */
+    disableNonEmpty?: true;
+    /**
+     * For filters add lazy load feature to the axis
+     */
+    addLazyLoad?: true;
+    /**
+     * Allow only a single member
+     */
+    singleMember?: true;
+    /**
+     * Allow a multiple hierarchies to build a crossjoin
+     */
+    multipleHierarchy?: true;
+    /**
+     * Additional constraints for the set/members
+     */
+    constraint?: IWidgetTemplateMdxBuilderAxisPropsConstraint;
+    decoration?: {
+        with?: string;
+        set: string;
+    };
+    /**
+     * Show the mdxAxis names in this order in the builder
+     */
+    showOrder?: number;
+}
+export interface IWidgetTemplateMdxBuilderMapping {
+    /**
+     * The order determines the order of the statements in the query. E.g., the first position is ON 0, the second ON 1,
+     * etc., where '0' and '1' are replaced by the name.
+     */
+    mdxAxis: Readonly<IWidgetTemplateMdxBuilderAxisProps[]>;
+    /**
+     * The generated Mdx is for a filter (the cell values are not of interest)
+     */
+    mdxIsForFilter?: true;
+    /**
+     * the cell values are not needed
+     */
+    withoutCellValues?: true;
+    /**
+     * an MDX query if the builder is empty
+     */
+    mdxQueryIfEmpty?: boolean;
+}
 /**
  * A widget that renders using React.
  *
@@ -56,6 +123,14 @@ export interface IPublicWidgetJsTemplateDefinition<T extends FormFieldObject> ex
     jsCode: (context: IWidgetPublicContext, container: HTMLDivElement) => IPublicJsChartTemplate<T>;
     reactComponent?: false;
 }
+/**
+ * List of special selection granularities (column selectors)
+ */
+export declare enum SelectionGranularityOptions {
+    PivotTableTopHeader = "ic3pivotTableTopHeader",
+    PivotTableLeftHeader = "ic3pivotTableLeftHeader",
+    PivotTableCell = "ic3pivotTableCell"
+}
 /**
  * Definition - static - of a widget template
  */
@@ -66,7 +141,7 @@ interface IPublicCommonWidgetTemplateDefinition {
      */
     type: WidgetTemplateDefinitionType;
     /**
-     * Unique within the plugin. Must not contain any dot.
+     * Unique within the plugin. Must not contain any dot (this is NOT the templateId)
      *
      * The widget chooser is using that id to localize its name and description.
      *
@@ -76,6 +151,18 @@ interface IPublicCommonWidgetTemplateDefinition {
      * </pre>
      */
     id: string;
+    /**
+     * Internal usage: while investigating lazy registration (setup upon registration).
+     */
+    debug?: string;
+    /**
+     * Internal usage: pluginId.templateId (setup upon registration).
+     */
+    qualifiedId?: string;
+    /**
+     * Internal usage: pluginId (setup upon registration).
+     */
+    pluginId?: string;
     /**
      * Used for localization right now.
      *
@@ -95,15 +182,23 @@ interface IPublicCommonWidgetTemplateDefinition {
      * in the "Maps" group in the widget chooser.
      */
     groupId: string;
-    /**
-     * Internal usage: pluginID.id
-     */
-    qualifiedId?: string;
     /**
      * A way to ensure we do not display in the widget chooser templates that cannot
      * be used because the rendering depends on a given theme.
      */
     dependsOnTheme?: string;
+    /**
+     * A sort of "preview" of the widget in the widget chooser. Providing an empty string will display a default image.
+     *
+     * <pre>
+     *     import donut from "./images/donut.svg";
+     *
+     *     {
+     *          image: "donut",
+     *     }
+     * </pre>
+     */
+    image: string;
     /**
      * No widget box decoration.
      */
@@ -122,7 +217,13 @@ interface IPublicCommonWidgetTemplateDefinition {
     withoutQuery?: boolean;
     withoutSelection?: boolean;
     withoutDrilldown?: boolean;
+    withoutEvents?: boolean;
     withoutUserMenu?: boolean;
+    withoutGlobalFilter?: boolean;
+    /**
+     * Otherwise the widget box is rendering a floating icon to mention some data errors.
+     */
+    handleCellsOnError?: boolean;
     renderIfNotInViewport?: boolean;
     /**
      * This widget needs to render even if its query has not been executed yet. The default is false.
@@ -138,12 +239,30 @@ interface IPublicCommonWidgetTemplateDefinition {
      * header is repeating on each page.
      */
     withOptionAutoExpandKeepTableHeader?: boolean;
+    /**
+     * If and only if not null, hide option 'Interactions' > 'Drilldown' > 'Pivot Table Like' and set it default value to withDrilldownPivotTableLikeAs.
+     */
+    withDrilldownPivotTableLikeAs?: boolean;
     userMenuOptions?: string[];
+    /**
+     * Additional widget user menu options when in editing mode.
+     */
     userMenuOptionsOnEditing?: string[];
+    /**
+     * Disables the user menu option to switch between selection and drilldown
+     *
+     * E.g a Pivot table can manage both modes
+     */
+    userMenuDisableInteractionMode?: boolean;
     /**
      * @deprecated
      */
     withoutTidyTable?: boolean;
+    /**
+     * This widget knows how to render a result without any data.
+     * (e.g., data picker)
+     */
+    handlesNoData?: boolean;
     /**
      * This widget is responsible to notify its rendered status. Required with asynchronous rendering
      * (e.g., Google maps).
@@ -152,27 +271,32 @@ interface IPublicCommonWidgetTemplateDefinition {
      */
     handlesWidgetStatus?: boolean;
     eventRoles?: ITemplateEventActionDef;
-    /**
-     * The meta information that defined which data column to use in the widget.
-     */
-    dataMappingMeta?: IWidgetTemplateDataMappingDef[];
+    selection?: {
+        /**
+         * The list of columns that can be part of the selection. The end-user can then select the actual
+         * columns from the Interaction/Selection configuration (see Selection Granularity).
+         */
+        allowedColumns: (column: ITidyColumn) => boolean;
+        optionValues?: undefined;
+    } | {
+        allowedColumns?: undefined;
+        optionValues?: SelectionGranularityOptions[];
+    };
+    mdxBuilderSettings?: IWidgetTemplateMdxBuilderMapping;
     /**
      * The meta information required for editing the widget options.
      */
     chartOptionsMeta?: FormFieldDef[] | FormFields<FormFieldObject>;
-    registerVariants?: (theme: Theme, manager: IWidgetVariantManager) => void;
     /**
-     * A sort of "preview" of the widget in the widget chooser. Providing an empty string will display a default image.
-     *
+     * When registering a variant add the following field editor meta:
      * <pre>
-     *     import donut from "./images/donut.svg";
-     *
-     *     {
-     *          image: "donut",
-     *     }
+     * widgetVariant: {
+     *    fieldType: "widgetVariant",
+     *    localizationTag: "variant"   // icCube localization,
+     * },
      * </pre>
      */
-    image: string;
+    registerVariants?: (theme: Theme, manager: IWidgetVariantManager) => void;
     /**
      * e.g., amCharts4.
      * */
@@ -181,9 +305,15 @@ interface IPublicCommonWidgetTemplateDefinition {
      * Whether or not that component is using React for rendering.
      */
     reactComponent?: boolean;
-    selection?: {
-        allowedColumns: (column: ITidyColumn) => boolean;
-    };
+    resolveDefinition?: (library: IResolveDefinitionLibrary) => Promise<IPublicWidgetTemplateDefinition<any>>;
+    /**
+     * When defining new widgets using amCharts 4, this method registers the icCube license.
+     */
+    registerAmCharts4?: (callback: (am4core: any) => void) => void;
+    /**
+     * When opening "Use Global Filter" option on Interaction tab
+     */
+    enableUseGlobalFilter?: boolean;
 }
 /**
  * *********************************************************************************************************************
@@ -197,7 +327,6 @@ export declare enum WidgetTemplateDefinitionType {
     Misc = "misc"
 }
 export interface IChartVisualizationInput {
-    mapping: ChartTemplateDataMapping;
     table: ITidyTable;
     inter: ITidyTableInteraction;
     options: {
@@ -207,47 +336,18 @@ export interface IChartVisualizationInput {
 export interface IWidgetTemplateTidyData {
     table: ITidyTable;
     inter: ITidyTableInteraction;
-    mapping: ChartTemplateDataMapping;
 }
 export interface IChartVisualizationTypedInput<T extends FormFieldObject> {
     table: ITidyTable;
     inter: ITidyTableInteraction;
-    mapping: ChartTemplateDataMapping;
     options: T;
 }
 /**
- * The mapping meta describes the coordinate system of the chart (e.g. axis, groups, values).
- * An error occurs when the columns in the mapping do not uniquely identify each row in the table.
+ * The mapping meta are all the column that the user can select in the chart options. These options are checked for
+ * validity. The widget generates an error if columns are selected that are not in the allowed properties, or if
+ * columns are mandatory but there is no selection or fallback.
  */
-export interface IWidgetTemplateDataMappingDef {
-    /**
-     * The alias for the column.
-     */
-    mappingName: string;
-    /**
-     * When defined, adds the mapping options to a group in the widget editor.
-     */
-    mappingGroup?: string;
-    /**
-     * When defined, the value is added as a prefix to the fieldPath to defined the localization tag.
-     */
-    mappingTag?: string;
-    /**
-     * Only columns of this/these type(s) are allowed.
-     */
-    allowedTypes: TidyColumnsType[] | ((column: ITidyColumn) => boolean);
-    /**
-     * If true, fallback to a column that is both an Mdx axis and has a type that is allowed.
-     * Note, properties of columns are not considered.
-     */
-    fallback?: boolean;
-    /**
-     * A column must be mapped to this alias, either by fallback or by user input.
-     * Throw an error of no column is mapped to this alias.
-     */
-    mandatory?: boolean;
-    isForDrilldown?: boolean;
-}
+export declare type IWidgetTemplateDataMappingDef = IFormColumnChooserFieldDef;
 /**
  * Predefined roles
  */
@@ -285,4 +385,7 @@ export interface ITemplateEventActionDef {
      */
     selectionSubscribe?: string;
 }
+export interface IResolveDefinitionLibrary {
+    wrapTemplateDefinition(id: string): Promise<IPublicWidgetTemplateDefinition<any>>;
+}
 export {};

package/dist/PublicTemplate.js

@@ -1,6 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TemplateEventActionNames = exports.WidgetTemplateDefinitionType = void 0;
+exports.TemplateEventActionNames = exports.WidgetTemplateDefinitionType = exports.SelectionGranularityOptions = exports.IWidgetTemplateMdxBuilderAxisPropsConstraint = void 0;
+var IWidgetTemplateMdxBuilderAxisPropsConstraint;
+(function (IWidgetTemplateMdxBuilderAxisPropsConstraint) {
+    IWidgetTemplateMdxBuilderAxisPropsConstraint["DateType"] = "DateType";
+    IWidgetTemplateMdxBuilderAxisPropsConstraint["GeoLatLong"] = "GeoLatLong";
+    IWidgetTemplateMdxBuilderAxisPropsConstraint["GeoIso2Code"] = "GeoIso2Code";
+})(IWidgetTemplateMdxBuilderAxisPropsConstraint = exports.IWidgetTemplateMdxBuilderAxisPropsConstraint || (exports.IWidgetTemplateMdxBuilderAxisPropsConstraint = {}));
+/**
+ * List of special selection granularities (column selectors)
+ */
+var SelectionGranularityOptions;
+(function (SelectionGranularityOptions) {
+    SelectionGranularityOptions["PivotTableTopHeader"] = "ic3pivotTableTopHeader";
+    SelectionGranularityOptions["PivotTableLeftHeader"] = "ic3pivotTableLeftHeader";
+    SelectionGranularityOptions["PivotTableCell"] = "ic3pivotTableCell";
+})(SelectionGranularityOptions = exports.SelectionGranularityOptions || (exports.SelectionGranularityOptions = {}));
 /**
  * *********************************************************************************************************************
  *                  DO NOT CHANGE THEIR VALUE : USED FOR FINDING THE DOCUMENTATION.

package/dist/PublicTemplate.js.map

@@ -1 +1 @@
-{"version":3,"file":"PublicTemplate.js","sourceRoot":"","sources":["../src/PublicTemplate.ts"],"names":[],"mappings":";;;AAwOA;;;;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;AAuED;;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":";;;AAcA,IAAY,4CAIX;AAJD,WAAY,4CAA4C;IACpD,qEAAqB,CAAA;IACrB,yEAAyB,CAAA;IACzB,2EAA2B,CAAA;AAC/B,CAAC,EAJW,4CAA4C,GAA5C,oDAA4C,KAA5C,oDAA4C,QAIvD;AA8ID;;GAEG;AAEH,IAAY,2BAIX;AAJD,WAAY,2BAA2B;IACnC,6EAA8C,CAAA;IAC9C,+EAAgD,CAAA;IAChD,mEAAoC,CAAA;AACxC,CAAC,EAJW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAItC;AAiOD;;;;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;AAkCD;;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"}