@ic3/reporting-api 8.0.0-rc.4 → 8.1.0

package/dist/PublicTemplate.d.ts

@@ -1,11 +1,12 @@
 import { ITidyTable } from "./PublicTidyTable";
 import { ITidyTableInteraction } from "./PublicTidyTableInteractions";
 import { IWidgetPublicContext } from "./PublicContext";
-import { FormFieldDef, FormFieldObject, FormFields, IFormColumnChooserFieldDef } from "./PublicTemplateForm";
+import { FormFieldObject, FormFields, IFormColumnChooserFieldDef } from "./PublicTemplateForm";
 import { IWidgetVariantManager } from "./IWidgetVariantManager";
-import { ITidyColumn } from "./PublicTidyColumn";
 import { ReactElement } from "react";
 import { Theme } from "@mui/material/styles";
+import { WidgetTemplateChartOptions, WidgetTemplateIDs } from "./PublicTemplates";
+import { ChartTemplateDataMapping, IFormFieldGranularityItem } from "./PublicTidyTableTypes";
 declare type ChartTemplateWidgetProps = any;
 export declare type IPublicWidgetTemplateDefinition<T extends FormFieldObject> = IPublicWidgetReactTemplateDefinition<T> | IPublicWidgetJsTemplateDefinition<T>;
 export declare enum IWidgetTemplateMdxBuilderAxisPropsConstraint {
@@ -64,15 +65,15 @@ export interface IWidgetTemplateMdxBuilderMapping {
      */
     mdxAxis: Readonly<IWidgetTemplateMdxBuilderAxisProps[]>;
     /**
-     * The generated Mdx is for a filter (the cell values are not of interest)
+     * The generated MDX is for a filter (the cell values are not of interest).
      */
     mdxIsForFilter?: true;
     /**
-     * the cell values are not needed
+     * The cell values are not needed
      */
     withoutCellValues?: true;
     /**
-     * an MDX query if the builder is empty
+     * An MDX query if the builder is empty.
      */
     mdxQueryIfEmpty?: boolean;
 }
@@ -109,9 +110,22 @@ export interface IPublicJsChartTemplate<T extends FormFieldObject> {
  * @see IPublicReactChartTemplate
  * @see FormFieldObject
  */
-export interface IPublicWidgetReactTemplateDefinition<T extends FormFieldObject> extends IPublicCommonWidgetTemplateDefinition {
-    jsCode: (context: IWidgetPublicContext) => IPublicReactChartTemplate<T>;
+export interface IPublicWidgetReactTemplateDefinition<OPTIONS extends FormFieldObject> extends IPublicCommonWidgetTemplateDefinition<OPTIONS> {
+    /**
+     * Actual widget rendering logic.
+     */
+    jsCode: (context: IWidgetPublicContext) => IPublicReactChartTemplate<OPTIONS>;
     reactComponent: true;
+    /**
+     * Only the widget template meta information is required when starting the application.
+     *
+     * This method gives the opportunity for a widget template to load (Webpack) its actual jsCode logic when required.
+     * For example, AmCharts 4 widgets are loading the AmCharts 4 actual JS libraries once their rendering is actually
+     * required.
+     *
+     * @param definitionW a resolved wrapped widget (extending widget).
+     */
+    resolveDefinition?: (definitionW?: IPublicWidgetTemplateDefinition<any>) => Promise<IPublicWidgetTemplateDefinition<OPTIONS>>;
 }
 /**
  * The definition of a widget that renders using plain Javascript/Typescript.
@@ -119,22 +133,27 @@ export interface IPublicWidgetReactTemplateDefinition<T extends FormFieldObject>
  * @see IPublicJsChartTemplate
  * @see FormFieldObject
  */
-export interface IPublicWidgetJsTemplateDefinition<T extends FormFieldObject> extends IPublicCommonWidgetTemplateDefinition {
-    jsCode: (context: IWidgetPublicContext, container: HTMLDivElement) => IPublicJsChartTemplate<T>;
+export interface IPublicWidgetJsTemplateDefinition<OPTIONS extends FormFieldObject> extends IPublicCommonWidgetTemplateDefinition<OPTIONS> {
+    /**
+     * Actual widget rendering logic.
+     */
+    jsCode: (context: IWidgetPublicContext, container: HTMLDivElement) => IPublicJsChartTemplate<OPTIONS>;
     reactComponent?: false;
-}
-/**
- * List of special selection granularities (column selectors)
- */
-export declare enum SelectionGranularityOptions {
-    PivotTableTopHeader = "ic3pivotTableTopHeader",
-    PivotTableLeftHeader = "ic3pivotTableLeftHeader",
-    PivotTableCell = "ic3pivotTableCell"
+    /**
+     * Only the widget template meta information is required when starting the application.
+     *
+     * This method gives the opportunity for a widget template to load (Webpack) its actual jsCode logic when required.
+     * For example, AmCharts 4 widgets are loading the AmCharts 4 actual JS libraries once their rendering is actually
+     * required.
+     *
+     * @param definitionW a resolved wrapped widget (extending widget).
+     */
+    resolveDefinition?: (definitionW?: IPublicWidgetTemplateDefinition<any>) => Promise<IPublicWidgetTemplateDefinition<OPTIONS>>;
 }
 /**
  * Definition - static - of a widget template
  */
-interface IPublicCommonWidgetTemplateDefinition {
+interface IPublicCommonWidgetTemplateDefinition<OPTIONS extends FormFieldObject> {
     /**
      * Determine the widget icon in the widget infos.
      * Used for finding the right documentation.
@@ -155,6 +174,10 @@ interface IPublicCommonWidgetTemplateDefinition {
      * Internal usage: while investigating lazy registration (setup upon registration).
      */
     debug?: string;
+    /**
+     * Internal usage: the wrapped pluginId.templateId (setup upon registration).
+     */
+    wrapped?: string;
     /**
      * Internal usage: pluginId.templateId (setup upon registration).
      */
@@ -273,20 +296,30 @@ interface IPublicCommonWidgetTemplateDefinition {
     eventRoles?: ITemplateEventActionDef;
     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).
+         * The default selection granularity.
          */
-        allowedColumns: (column: ITidyColumn) => boolean;
-        optionValues?: undefined;
-    } | {
-        allowedColumns?: undefined;
-        optionValues?: SelectionGranularityOptions[];
+        defaultGranularityItems?: IFormFieldGranularityItem[];
+        /**
+         * The list of columns/roles that can be part of the selection granularity. The granularity editor shows
+         * when there are 2 or more roles.
+         */
+        granularityItems?: (table: ITidyTable) => IFormFieldGranularityItem[];
     };
     mdxBuilderSettings?: IWidgetTemplateMdxBuilderMapping;
+    /**
+     * Setup how to get default mappings from the table and options for this widget.
+     * If undefined, it uses the default fallback logic.
+     */
+    defaultMapping?: (data: IWidgetTemplateTidyOptions<OPTIONS>) => ChartTemplateDataMapping;
     /**
      * The meta information required for editing the widget options.
      */
-    chartOptionsMeta?: FormFieldDef[] | FormFields<FormFieldObject>;
+    chartOptionsMeta?: FormFields<OPTIONS>;
+    /**
+     * An optional hook that allows for modifying the chart options passed as parameter.
+     * Used when extending existing widget definition.
+     */
+    hookChartOptions?: (options: any) => any;
     /**
      * When registering a variant add the following field editor meta:
      * <pre>
@@ -305,7 +338,16 @@ interface IPublicCommonWidgetTemplateDefinition {
      * Whether or not that component is using React for rendering.
      */
     reactComponent?: boolean;
-    resolveDefinition?: (library: IResolveDefinitionLibrary) => Promise<IPublicWidgetTemplateDefinition<any>>;
+    /**
+     * Only the widget template meta information is required when starting the application.
+     *
+     * This method gives the opportunity for a widget template to load (Webpack) its actual jsCode logic when required.
+     * For example, AmCharts 4 widgets are loading the AmCharts 4 actual JS libraries once their rendering is actually
+     * required.
+     *
+     * @param definitionW a resolved wrapped widget (extending widget).
+     */
+    resolveDefinition?: (definitionW?: IPublicWidgetTemplateDefinition<any>) => Promise<IPublicWidgetTemplateDefinition<OPTIONS>>;
     /**
      * When defining new widgets using amCharts 4, this method registers the icCube license.
      */
@@ -314,6 +356,10 @@ interface IPublicCommonWidgetTemplateDefinition {
      * When opening "Use Global Filter" option on Interaction tab
      */
     enableUseGlobalFilter?: boolean;
+    /**
+     *  Returns true if the widget fires a global event at initialization (start)
+     */
+    firesGlobalEventAtStart?: (options: OPTIONS | undefined, templateDef: IPublicWidgetTemplateDefinition<OPTIONS>) => boolean;
 }
 /**
  * *********************************************************************************************************************
@@ -326,16 +372,13 @@ export declare enum WidgetTemplateDefinitionType {
     Map = "map",
     Misc = "misc"
 }
-export interface IChartVisualizationInput {
+export interface IWidgetTemplateTidyData {
     table: ITidyTable;
     inter: ITidyTableInteraction;
-    options: {
-        [key: string]: any;
-    };
 }
-export interface IWidgetTemplateTidyData {
+export interface IWidgetTemplateTidyOptions<T extends FormFieldObject> {
     table: ITidyTable;
-    inter: ITidyTableInteraction;
+    options: T;
 }
 export interface IChartVisualizationTypedInput<T extends FormFieldObject> {
     table: ITidyTable;
@@ -361,7 +404,7 @@ export declare enum TemplateEventActionNames {
  * Definition of the actions supported by a template
  *
  *
- * ( e.g publish: 'onClick'  )
+ * ( e.g., publish: 'onClick'  )
  */
 export interface ITemplateEventActionDef {
     /**
@@ -385,7 +428,18 @@ export interface ITemplateEventActionDef {
      */
     selectionSubscribe?: string;
 }
-export interface IResolveDefinitionLibrary {
-    wrapTemplateDefinition(id: string): Promise<IPublicWidgetTemplateDefinition<any>>;
+export interface IWrappedWidgetTemplateDefinition<WIDGET extends WidgetTemplateIDs> {
+    /**
+     * Some free text used while registering the wrapper (e.g., error purpose).
+     */
+    readonly registrationInfo: string;
+    /**
+     * e.g., ic3.Table
+     */
+    readonly wrappedWidgetTemplateId: WIDGET;
+    /**
+     * A function generating the widget template definition based on the wrapped widget template definition.
+     */
+    readonly wrapper: (wrapped: IPublicWidgetTemplateDefinition<WidgetTemplateChartOptions[WIDGET]>) => IPublicWidgetTemplateDefinition<FormFieldObject>;
 }
 export {};

package/dist/PublicTemplate.js

@@ -1,21 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TemplateEventActionNames = exports.WidgetTemplateDefinitionType = exports.SelectionGranularityOptions = exports.IWidgetTemplateMdxBuilderAxisPropsConstraint = void 0;
+exports.TemplateEventActionNames = exports.WidgetTemplateDefinitionType = 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":";;;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"}
+{"version":3,"file":"PublicTemplate.js","sourceRoot":"","sources":["../src/PublicTemplate.ts"],"names":[],"mappings":";;;AAeA,IAAY,4CAIX;AAJD,WAAY,4CAA4C;IACpD,qEAAqB,CAAA;IACrB,yEAAyB,CAAA;IACzB,2EAA2B,CAAA;AAC/B,CAAC,EAJW,4CAA4C,GAA5C,oDAA4C,KAA5C,oDAA4C,QAIvD;AAuaD;;;;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/PublicTemplateForm.d.ts

@@ -2,7 +2,11 @@ import { IWidgetEditorPublicContext } from "./PublicContext";
 import { ITidyColumn } from "./PublicTidyColumn";
 import * as React from "react";
 import { AutocompleteRenderInputParams, AutocompleteRenderOptionState } from "@mui/material/Autocomplete/Autocomplete";
-import { TidyColumnsType, TidyTableColumnSelector } from "./PublicTidyTableTypes";
+import { IFormFieldGranularityItem, TidyColumnsType, TidyTableColumnSelector } from "./PublicTidyTableTypes";
+import { ITidyTable } from "./PublicTidyTable";
+export declare type Hook<T> = {
+    hook: (value: T) => void;
+};
 export declare function formFieldIsSelection(field: IFormFieldDef<any>): boolean;
 export interface IFormFieldDef<DEFAULT_VALUE_TYPE> {
     /**
@@ -93,7 +97,7 @@ export declare type FormFields<T extends FormFieldObject> = {
     } | {
         defaultValue?: any;
         mandatory?: false;
-    }) & (Required<T>[key] extends FormFieldObject ? Omit<IFormEmbeddedFieldDef<Required<T>[key]>, 'fieldPath'> : Required<T>[key] extends IPaletteDef ? Omit<IFormPaletteEditorFieldDef, 'fieldPath'> : Required<T>[key] extends IColorDef ? Omit<IFormColorEditorFieldDef, 'fieldPath'> : Required<T>[key] extends TidyTableColumnSelector[] ? Omit<IFormColumnChooserFieldDef, 'fieldPath'> : Required<T>[key] extends TidyTableColumnSelector ? Omit<IFormColumnChooserFieldDef, 'fieldPath'> : Required<T>[key] extends boolean ? Omit<IFormBooleanFieldDef, 'fieldPath'> : Required<T>[key] extends number ? Omit<IFormNumberFieldDef, 'fieldPath'> : Required<T>[key] extends string ? Omit<IFormOptionFieldSingleDef, 'fieldPath'> | Omit<IFormStringFieldDef, 'fieldPath'> | Omit<IFormFormatterPickerFieldDef, 'fieldPath'> | Omit<IFormWidgetVariantFieldDef, 'fieldPath'> | Omit<IFormTidyTableTextExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableTextRowExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableHtmlRowExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableHtmlExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableNumericExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableNumericRowExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableColorRowExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableStringRowExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableScaleRowExprFieldDef, 'fieldPath'> | Omit<IFormJsFieldDef, 'fieldPath'> | Omit<IFormJsonFieldDef, 'fieldPath'> | Omit<IFormMarkdownFieldDef, 'fieldPath'> : Required<T>[key] extends string[] ? Omit<IFormOptionFieldMultipleDef, 'fieldPath'> | Omit<IFormGroupsFieldDef, 'fieldPath'> : never);
+    }) & (Required<T>[key] extends FormFieldObject ? Omit<IFormEmbeddedFieldDef<Required<T>[key]>, 'fieldPath'> : Required<T>[key] extends IPaletteDef ? Omit<IFormPaletteEditorFieldDef, 'fieldPath'> : Required<T>[key] extends IColorDef ? Omit<IFormColorEditorFieldDef, 'fieldPath'> : Required<T>[key] extends TidyTableColumnSelector[] ? Omit<IFormColumnChooserMultipleFieldDef, 'fieldPath'> : Required<T>[key] extends TidyTableColumnSelector ? Omit<IFormColumnChooserSingleFieldDef, 'fieldPath'> : Required<T>[key] extends IFormEventMappingArrayFieldDefType ? Omit<IFormEventMappingArrayFieldDef, 'fieldPath'> : Required<T>[key] extends Hook<any> ? Omit<IFormHookFieldDef<any>, 'fieldPath'> : Required<T>[key] extends boolean ? Omit<IFormBooleanFieldDef, 'fieldPath'> : Required<T>[key] extends number ? Omit<IFormNumberFieldDef, 'fieldPath'> : Required<T>[key] extends string ? Omit<IFormOptionFieldSingleDef, 'fieldPath'> | Omit<IFormStringFieldDef, 'fieldPath'> | Omit<IFormFormatterPickerFieldDef, 'fieldPath'> | Omit<IFormWidgetVariantFieldDef, 'fieldPath'> | Omit<IFormTidyTableTextExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableTextRowExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableHtmlRowExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableHtmlExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableNumericExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableNumericRowExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableColorRowExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableStringRowExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableScaleRowExprFieldDef, 'fieldPath'> | Omit<IFormJsFieldDef, 'fieldPath'> | Omit<IFormJsonFieldDef, 'fieldPath'> | Omit<IFormMarkdownFieldDef, 'fieldPath'> | Omit<IFormOptionFieldReportPathDef, 'fieldPath'> : Required<T>[key] extends string[] ? Omit<IFormOptionFieldMultipleDef, 'fieldPath'> | Omit<IFormGroupsFieldDef, 'fieldPath'> : never);
 };
 export declare enum IFormFieldGroupTypes {
     Selection = "selection",
@@ -125,6 +129,10 @@ export declare type FormFieldType =
  * @see IFormColumnSelectionFieldDef
  */
 "columnSelection" | 
+/**
+ * @see IFormConstantsFieldDef
+ */
+"constants" | 
 /**
  * @see IFormArrayStringRecordsFieldDef
  */
@@ -141,6 +149,10 @@ export declare type FormFieldType =
  * @see IFormFormatterPickerFieldDef
  */
 "formatterPicker" | 
+/**
+ * @see IFormBooleanFieldDef
+ */
+"fixedBoolean" | 
 /**
  * @see IFormBooleanFieldDef
  */
@@ -149,6 +161,10 @@ export declare type FormFieldType =
  * @see IFormGroupsFieldDef
  */
 "groups" | 
+/**
+ * @see IFormFunctionFieldDef
+ */
+"hook" | 
 /**
  * @see IFormJsFieldDef
  */
@@ -229,10 +245,18 @@ export declare type FormFieldType =
  * @see IFormTidyTableTextRowExprFieldDef
  */
 "tidyTableTextRowExpr" | 
+/**
+ * @see IFormUrlFieldDef
+ */
+"url" | 
 /**
  * @see IFormWidgetVariantFieldDef
  */
-"widgetVariant";
+"widgetVariant" | 
+/**
+ * @see IFormGranularitySelectionFieldDef
+ */
+"granularityChooser";
 export declare type FormFieldTidyTableExprType = "tidyTableHtmlExpr" | "tidyTableHtmlRowExpr" | "tidyTableNumericExpr" | "tidyTableNumericRowExpr" | "tidyTableScaleRowExpr" | "tidyTableTextExpr" | "tidyTableTextRowExpr" | "tidyTableStringRowExpr" | "tidyTableColorRowExpr";
 export declare function isTidyTableExpr(type: FormFieldType): type is FormFieldTidyTableExprType;
 export declare function isTidyTableExprTable(type: FormFieldType): boolean;
@@ -304,7 +328,7 @@ export interface IFormAutocompleteFieldDef<OPTION> extends IFormFieldDef<OPTION>
  * @see IFormGroupsFieldDef
  */
 export interface IFormBooleanFieldDef extends IFormFieldDef<boolean> {
-    fieldType: "boolean" | "groupBoolean";
+    fieldType: "boolean" | "fixedBoolean" | "groupBoolean";
 }
 /**
  * @see FormFieldDef
@@ -403,6 +427,15 @@ interface IFormColumnChooserMultipleFieldDef extends IFormFieldDef<TidyTableColu
         alias?: string;
     };
 }
+/**
+ * @see FormFieldDef
+ */
+export interface IFormGranularitySelectionFieldDef extends IFormFieldDef<IFormFieldGranularityItem> {
+    fieldType: "granularityChooser";
+    editorConf: {
+        options: (table: ITidyTable) => IFormFieldGranularityItem[];
+    };
+}
 /**
  * @see FormFieldDef
  */
@@ -416,7 +449,17 @@ export interface IFormColumnSelectionFieldDef extends IFormFieldDef<any> {
 /**
  * @see FormFieldDef
  */
-export interface IFormEventMappingArrayFieldDef extends IFormFieldDef<any> {
+export interface IFormConstantsFieldDef extends IFormFieldDef<any> {
+    fieldType: "constants";
+}
+/**
+ * @see FormFieldDef
+ */
+export declare type IFormEventMappingArrayFieldDefType = {
+    toEvent: string;
+    fromEvent: string;
+}[];
+export interface IFormEventMappingArrayFieldDef extends IFormFieldDef<IFormEventMappingArrayFieldDefType> {
     fieldType: "eventMappingArray";
 }
 /**
@@ -432,11 +475,21 @@ export interface IFormGroupsFieldDef extends IFormFieldDef<string[]> {
     fieldType: "groups";
     groups: string[];
 }
+/**
+ * @see FormFieldDef
+ */
+export interface IFormHookFieldDef<T> extends IFormFieldDef<Hook<T>> {
+    fieldType: "hook";
+}
 /**
  * @see FormFieldDef
  */
 export interface IFormJsFieldDef extends IFormFieldDef<string> {
     fieldType: "js";
+    editorConf?: {
+        helpMdFile: string;
+        doNotCompleteEventNames?: true;
+    };
 }
 /**
  * @see FormFieldDef
@@ -459,6 +512,9 @@ export interface IFormFileUploaderFieldDef extends IFormFieldDef<any> {
  */
 export interface IFormMarkdownFieldDef extends IFormFieldDef<string> {
     fieldType: "markdown";
+    editorConf?: {
+        singleLine: false;
+    };
 }
 export declare type MdxExpressionType = "calcMeasure" | "drilldown";
 /**
@@ -510,6 +566,9 @@ export interface IFormOptionFieldMultipleDef extends IFormFieldDef<string[]> {
         getCaption?: (id: string) => string;
     };
 }
+export interface IFormOptionFieldReportPathDef extends IFormFieldDef<string> {
+    fieldType: "reportPath";
+}
 export interface IFormOptionFieldSingleDef extends IFormFieldDef<string> {
     fieldType: "option";
     editorConf: {
@@ -557,7 +616,7 @@ export interface IFormReportPermaLinkFieldDef extends IFormFieldDef<string> {
  * @see FormFieldDef
  */
 export interface IFormStringFieldDef extends IFormFieldDef<string> {
-    fieldType: "string";
+    fieldType: "string" | "url";
     editorConf?: {
         /**
          * A list of possible strings...
@@ -693,6 +752,5 @@ export interface IFormWidgetVariantFieldDef extends IFormFieldDef<string> {
 export interface IFormFormatterPickerFieldDef extends IFormFieldDef<string> {
     fieldType: "formatterPicker";
 }
-export declare type FormFieldDef = IFormAutocompleteFieldDef<any> | IFormBooleanFieldDef | IFormColorEditorFieldDef | IFormColumnChooserFieldDef | IFormColumnSelectionFieldDef | IFormEventMappingArrayFieldDef | IFormFileUploaderFieldDef | IFormGroupsFieldDef | IFormJsFieldDef | IFormMarkdownFieldDef | IFormMdxFieldDef | IFormNumberFieldDef | IFormOptionFieldDef | IFormOptionFieldSingleDef | IFormOptionFieldMultipleDef | IFormPaletteEditorFieldDef | IFormReportPathFieldDef | IFormReportPermaLinkFieldDef | IFormStringFieldDef | IFormTidyTableHtmlExprFieldDef | IFormTidyTableHtmlRowExprFieldDef | IFormTidyTableNumericExprFieldDef | IFormTidyTableNumericRowExprFieldDef | IFormTidyTableStringRowExprFieldDef | IFormTidyTableColorRowExprFieldDef | IFormTidyTableScaleRowExprFieldDef | IFormTidyTableTextExprFieldDef | IFormTidyTableTextRowExprFieldDef | IFormWidgetVariantFieldDef | IFormFormatterPickerFieldDef;
-export declare function createGroupsMeta(groups: string[]): IFormGroupsFieldDef;
+export declare type FormFieldDef = IFormAutocompleteFieldDef<any> | IFormBooleanFieldDef | IFormColorEditorFieldDef | IFormColumnChooserFieldDef | IFormColumnSelectionFieldDef | IFormConstantsFieldDef | IFormEventMappingArrayFieldDef | IFormFileUploaderFieldDef | IFormGroupsFieldDef | IFormJsFieldDef | IFormMarkdownFieldDef | IFormMdxFieldDef | IFormNumberFieldDef | IFormOptionFieldDef | IFormOptionFieldSingleDef | IFormOptionFieldMultipleDef | IFormPaletteEditorFieldDef | IFormReportPathFieldDef | IFormReportPermaLinkFieldDef | IFormStringFieldDef | IFormTidyTableHtmlExprFieldDef | IFormTidyTableHtmlRowExprFieldDef | IFormTidyTableNumericExprFieldDef | IFormTidyTableNumericRowExprFieldDef | IFormTidyTableStringRowExprFieldDef | IFormTidyTableColorRowExprFieldDef | IFormTidyTableScaleRowExprFieldDef | IFormTidyTableTextExprFieldDef | IFormTidyTableTextRowExprFieldDef | IFormWidgetVariantFieldDef | IFormFormatterPickerFieldDef | IFormGranularitySelectionFieldDef;
 export {};

package/dist/PublicTemplateForm.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createGroupsMeta = exports.isCodeMirrorModeExpr = exports.AutocompleteNoOptionsText = exports.isTidyTableExprScale = exports.isTidyTableExprNumeric = exports.isTidyTableExprTextHtml = exports.isTidyTableExprText = exports.isTidyTableExprRow = exports.isTidyTableExprTable = exports.isTidyTableExpr = exports.IFormFieldGroupTypes = exports.formFieldIsSelection = void 0;
+exports.isCodeMirrorModeExpr = exports.AutocompleteNoOptionsText = exports.isTidyTableExprScale = exports.isTidyTableExprNumeric = exports.isTidyTableExprTextHtml = exports.isTidyTableExprText = exports.isTidyTableExprRow = exports.isTidyTableExprTable = exports.isTidyTableExpr = exports.IFormFieldGroupTypes = exports.formFieldIsSelection = void 0;
 function formFieldIsSelection(field) {
     return field.group === IFormFieldGroupTypes.Selection;
 }
@@ -80,12 +80,4 @@ function isCodeMirrorModeExpr(mode) {
         || mode === "tidyTableColorRowExpr";
 }
 exports.isCodeMirrorModeExpr = isCodeMirrorModeExpr;
-function createGroupsMeta(groups) {
-    return {
-        fieldType: "groups",
-        groups: groups,
-        fieldPath: ""
-    };
-}
-exports.createGroupsMeta = createGroupsMeta;
 //# sourceMappingURL=PublicTemplateForm.js.map

package/dist/PublicTemplateForm.js.map

@@ -1 +1 @@
-{"version":3,"file":"PublicTemplateForm.js","sourceRoot":"","sources":["../src/PublicTemplateForm.ts"],"names":[],"mappings":";;;AAOA,SAAgB,oBAAoB,CAAC,KAAyB;IAC1D,OAAO,KAAK,CAAC,KAAK,KAAK,oBAAoB,CAAC,SAAS,CAAC;AAC1D,CAAC;AAFD,oDAEC;AA8ID,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC5B,+CAAuB,CAAA;IACvB,yEAAiD,CAAA;IACjD,sDAA8B,CAAA;AAClC,CAAC,EAJW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAI/B;AAsJD,SAAgB,eAAe,CAAC,IAAmB;IAC/C,OAAO,IAAI,KAAK,mBAAmB;WAC5B,IAAI,KAAK,sBAAsB;WAC/B,IAAI,KAAK,mBAAmB;WAC5B,IAAI,KAAK,sBAAsB;WAC/B,IAAI,KAAK,sBAAsB;WAC/B,IAAI,KAAK,yBAAyB;WAClC,IAAI,KAAK,wBAAwB;WACjC,IAAI,KAAK,uBAAuB;WAChC,IAAI,KAAK,uBAAuB,CAClC;AACT,CAAC;AAXD,0CAWC;AAED,SAAgB,oBAAoB,CAAC,IAAmB;IACpD,OAAO,IAAI,KAAK,mBAAmB;WAC5B,IAAI,KAAK,mBAAmB;WAC5B,IAAI,KAAK,sBAAsB,CACjC;AACT,CAAC;AALD,oDAKC;AAED,SAAgB,kBAAkB,CAAC,IAAmB;IAClD,OAAO,IAAI,KAAK,sBAAsB;WAC/B,IAAI,KAAK,sBAAsB;WAC/B,IAAI,KAAK,yBAAyB;WAClC,IAAI,KAAK,wBAAwB;WACjC,IAAI,KAAK,uBAAuB;WAChC,IAAI,KAAK,uBAAuB,CAClC;AACT,CAAC;AARD,gDAQC;AAED,SAAgB,mBAAmB,CAAC,IAAmB;IACnD,OAAO,IAAI,KAAK,mBAAmB;WAC5B,IAAI,KAAK,sBAAsB;WAC/B,IAAI,KAAK,mBAAmB;WAC5B,IAAI,KAAK,sBAAsB,CACjC;AACT,CAAC;AAND,kDAMC;AAED,SAAgB,uBAAuB,CAAC,IAAmB;IACvD,OAAO,IAAI,KAAK,mBAAmB;WAC5B,IAAI,KAAK,sBAAsB,CACjC;AACT,CAAC;AAJD,0DAIC;AAED,SAAgB,sBAAsB,CAAC,IAAmB;IACtD,OAAO,IAAI,KAAK,sBAAsB;WAC/B,IAAI,KAAK,yBAAyB,CACpC;AACT,CAAC;AAJD,wDAIC;AAED,SAAgB,oBAAoB,CAAC,IAAmB;IACpD,OAAO,IAAI,KAAK,uBAAuB,CAClC;AACT,CAAC;AAHD,oDAGC;AAED;;;GAGG;AACH,IAAY,yBAGX;AAHD,WAAY,yBAAyB;IACjC,sDAAyB,CAAA;IACzB,gEAAmC,CAAA;AACvC,CAAC,EAHW,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAGpC;AAaD,SAAgB,oBAAoB,CAAC,IAAoB;IACrD,OAAO,IAAI,KAAK,mBAAmB;WAC5B,IAAI,KAAK,sBAAsB;WAC/B,IAAI,KAAK,mBAAmB;WAC5B,IAAI,KAAK,sBAAsB;WAC/B,IAAI,KAAK,sBAAsB;WAC/B,IAAI,KAAK,yBAAyB;WAClC,IAAI,KAAK,uBAAuB;WAChC,IAAI,KAAK,wBAAwB;WACjC,IAAI,KAAK,uBAAuB,CAClC;AACT,CAAC;AAXD,oDAWC;AAupBD,SAAgB,gBAAgB,CAAC,MAAgB;IAC7C,OAAO;QACH,SAAS,EAAE,QAAQ;QACnB,MAAM,EAAE,MAAM;QACd,SAAS,EAAE,EAAE;KAChB,CAAC;AACN,CAAC;AAND,4CAMC"}
+{"version":3,"file":"PublicTemplateForm.js","sourceRoot":"","sources":["../src/PublicTemplateForm.ts"],"names":[],"mappings":";;;AAaA,SAAgB,oBAAoB,CAAC,KAAyB;IAC1D,OAAO,KAAK,CAAC,KAAK,KAAK,oBAAoB,CAAC,SAAS,CAAC;AAC1D,CAAC;AAFD,oDAEC;AAmJD,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC5B,+CAAuB,CAAA;IACvB,yEAAiD,CAAA;IACjD,sDAA8B,CAAA;AAClC,CAAC,EAJW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAI/B;AA0KD,SAAgB,eAAe,CAAC,IAAmB;IAC/C,OAAO,IAAI,KAAK,mBAAmB;WAC5B,IAAI,KAAK,sBAAsB;WAC/B,IAAI,KAAK,mBAAmB;WAC5B,IAAI,KAAK,sBAAsB;WAC/B,IAAI,KAAK,sBAAsB;WAC/B,IAAI,KAAK,yBAAyB;WAClC,IAAI,KAAK,wBAAwB;WACjC,IAAI,KAAK,uBAAuB;WAChC,IAAI,KAAK,uBAAuB,CAClC;AACT,CAAC;AAXD,0CAWC;AAED,SAAgB,oBAAoB,CAAC,IAAmB;IACpD,OAAO,IAAI,KAAK,mBAAmB;WAC5B,IAAI,KAAK,mBAAmB;WAC5B,IAAI,KAAK,sBAAsB,CACjC;AACT,CAAC;AALD,oDAKC;AAED,SAAgB,kBAAkB,CAAC,IAAmB;IAClD,OAAO,IAAI,KAAK,sBAAsB;WAC/B,IAAI,KAAK,sBAAsB;WAC/B,IAAI,KAAK,yBAAyB;WAClC,IAAI,KAAK,wBAAwB;WACjC,IAAI,KAAK,uBAAuB;WAChC,IAAI,KAAK,uBAAuB,CAClC;AACT,CAAC;AARD,gDAQC;AAED,SAAgB,mBAAmB,CAAC,IAAmB;IACnD,OAAO,IAAI,KAAK,mBAAmB;WAC5B,IAAI,KAAK,sBAAsB;WAC/B,IAAI,KAAK,mBAAmB;WAC5B,IAAI,KAAK,sBAAsB,CACjC;AACT,CAAC;AAND,kDAMC;AAED,SAAgB,uBAAuB,CAAC,IAAmB;IACvD,OAAO,IAAI,KAAK,mBAAmB;WAC5B,IAAI,KAAK,sBAAsB,CACjC;AACT,CAAC;AAJD,0DAIC;AAED,SAAgB,sBAAsB,CAAC,IAAmB;IACtD,OAAO,IAAI,KAAK,sBAAsB;WAC/B,IAAI,KAAK,yBAAyB,CACpC;AACT,CAAC;AAJD,wDAIC;AAED,SAAgB,oBAAoB,CAAC,IAAmB;IACpD,OAAO,IAAI,KAAK,uBAAuB,CAClC;AACT,CAAC;AAHD,oDAGC;AAED;;;GAGG;AACH,IAAY,yBAGX;AAHD,WAAY,yBAAyB;IACjC,sDAAyB,CAAA;IACzB,gEAAmC,CAAA;AACvC,CAAC,EAHW,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAGpC;AAaD,SAAgB,oBAAoB,CAAC,IAAoB;IACrD,OAAO,IAAI,KAAK,mBAAmB;WAC5B,IAAI,KAAK,sBAAsB;WAC/B,IAAI,KAAK,mBAAmB;WAC5B,IAAI,KAAK,sBAAsB;WAC/B,IAAI,KAAK,sBAAsB;WAC/B,IAAI,KAAK,yBAAyB;WAClC,IAAI,KAAK,uBAAuB;WAChC,IAAI,KAAK,wBAAwB;WACjC,IAAI,KAAK,uBAAuB,CAClC;AACT,CAAC;AAXD,oDAWC"}

package/dist/PublicTemplates.d.ts

@@ -0,0 +1,61 @@
+import { PivotTableChartOptions } from "./theme/ThemePivotTable";
+import { DatePickerChartOptions } from "./theme/ThemeDatePicker";
+import { ImageChartOptions } from "./theme/ThemeImage";
+import { KpiBoxChartOptions } from "./theme/ThemeKpiBox";
+import { KpiCartChartOptions } from "./theme/ThemeKpiCard";
+import { EmbeddedReportChartOptions } from "./theme/ThemeEmbeddedReport";
+import { MarkdownTextChartOptions } from "./theme/ThemeMarkdownText";
+import { FilterPanelChartOptions } from "./theme/ThemeFilterPanel";
+import { RepetitionWidgetChartOptions } from "./theme/ThemeRepetitionWidget";
+import { GoogleHeatMapChartOptions } from "./theme/ThemeGoogleHeatMap";
+import { GoogleMarkerChartOptions } from "./theme/ThemeGoogleMarker";
+import { GoogleKmlLayerChartOptions } from "./theme/ThemeGoogleKmlLayer";
+import { TableChartOptions } from "./theme/ThemeTable";
+import { FormFieldObject } from "./PublicTemplateForm";
+import { FilterButtonsChartOptions } from "./theme/ThemeFilterButtons";
+import { FilterCheckboxRadioChartOptions } from "./theme/ThemeFilterCheckboxRadio";
+import { FilterSliderChartOptions } from "./theme/ThemeFilterSlider";
+import { FilterAutocompleteChartOptions } from "./theme/ThemeFilterAutocomplete";
+import { FilterTreeChartOptions } from "./theme/ThemeFilterTree";
+import { AmCharts4BubbleChartOptions, AmCharts4ComboChartOptions, AmCharts4DonutChartOptions, AmCharts4GaugeChartOptions, AmCharts4HistogramOptions, AmCharts4RegularAreaChartOptions, AmCharts4RegularBarChartOptions, AmCharts4RegularColumnChartOptions, AmCharts4RegularLineChartOptions, AmCharts4SankeyDiagramOptions, AmCharts4ScatterPlotOptions, AmCharts4StackedAreaChartOptions, AmCharts4StackedBarChartOptions, AmCharts4StackedColumnChartOptions, AmCharts4TreemapOptions, GeoMapChartOptions } from "./theme/ThemeAmCharts4";
+interface IWidgetTemplateChartOptions {
+    "ic3.DatePicker": DatePickerChartOptions;
+    "ic3.EmbeddedReport": EmbeddedReportChartOptions;
+    "ic3.FilterAutocomplete": FilterAutocompleteChartOptions;
+    "ic3.FilterButtons": FilterButtonsChartOptions;
+    "ic3.FilterCheckboxRadio": FilterCheckboxRadioChartOptions;
+    "ic3.FilterPanel": FilterPanelChartOptions;
+    "ic3.FilterSlider": FilterSliderChartOptions;
+    "ic3.FilterTree": FilterTreeChartOptions;
+    "ic3.GoogleHeatMap": GoogleHeatMapChartOptions;
+    "ic3.GoogleKmlLayer": GoogleKmlLayerChartOptions;
+    "ic3.GoogleMarker": GoogleMarkerChartOptions;
+    "ic3.Image": ImageChartOptions;
+    "ic3.KpiBox": KpiBoxChartOptions;
+    "ic3.KpiCard": KpiCartChartOptions;
+    "ic3.MarkdownText": MarkdownTextChartOptions;
+    "ic3.PivotTable": PivotTableChartOptions;
+    "ic3.RepetitionWidget": RepetitionWidgetChartOptions;
+    "ic3.Table": TableChartOptions;
+    "amCharts4.AmCharts4BubbleChart": AmCharts4BubbleChartOptions;
+    "amCharts4.AmCharts4ComboChart": AmCharts4ComboChartOptions;
+    "amCharts4.AmCharts4RegularAreaChart": AmCharts4RegularAreaChartOptions;
+    "amCharts4.AmCharts4RegularBarChart": AmCharts4RegularBarChartOptions;
+    "amCharts4.AmCharts4RegularColumnChart": AmCharts4RegularColumnChartOptions;
+    "amCharts4.AmCharts4RegularLineChart": AmCharts4RegularLineChartOptions;
+    "amCharts4.AmCharts4ScatterPlot": AmCharts4ScatterPlotOptions;
+    "amCharts4.AmCharts4StackedAreaChart": AmCharts4StackedAreaChartOptions;
+    "amCharts4.AmCharts4StackedBarChart": AmCharts4StackedBarChartOptions;
+    "amCharts4.AmCharts4StackedColumnChart": AmCharts4StackedColumnChartOptions;
+    "amCharts4.AmCharts4DonutChart": AmCharts4DonutChartOptions;
+    "amCharts4.AmCharts4GaugeChart": AmCharts4GaugeChartOptions;
+    "amCharts4.AmCharts4Histogram": AmCharts4HistogramOptions;
+    "amCharts4.AmCharts4SankeyDiagram": AmCharts4SankeyDiagramOptions;
+    "amCharts4.AmCharts4TreeMap": AmCharts4TreemapOptions;
+    "amCharts4.AmCharts4GeoMap": GeoMapChartOptions;
+}
+export declare type WidgetTemplateChartOptions = IWidgetTemplateChartOptions & {
+    [key: string]: FormFieldObject;
+};
+export declare type WidgetTemplateIDs = keyof IWidgetTemplateChartOptions;
+export {};

package/dist/{theme/ThemeReportAppMenu.js → PublicTemplates.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=ThemeReportAppMenu.js.map
+//# sourceMappingURL=PublicTemplates.js.map

package/dist/PublicTemplates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PublicTemplates.js","sourceRoot":"","sources":["../src/PublicTemplates.ts"],"names":[],"mappings":""}