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

package/dist/ApiUtils.d.ts

@@ -1,6 +1,41 @@
 import { IPluginDefinition } from "./IPluginDefinition";
 import { IVersionedPluginDefinition } from "./IVersionedPluginDefinition";
-import { IPublicWidgetTemplateDefinition } from "./PublicTemplate";
+import { FormFieldObject } from "./PublicTemplateForm";
+import { IPublicWidgetJsTemplateDefinition, IPublicWidgetTemplateDefinition, IWrappedWidgetTemplateDefinition } from "./PublicTemplate";
+import { WidgetTemplateIDs } from "./PublicTemplates";
+export interface AmCharts4WrappedDefinition<WIDGET extends WidgetTemplateIDs> {
+    /**
+     * Some free text used while registering the wrapper (e.g., error purpose).
+     */
+    readonly registrationInfo: string;
+    /**
+     * e.g., amCharts4.AmCharts4DonutChart
+     */
+    readonly wrappedWidgetTemplateId: WIDGET;
+    /**
+     * New overall meta-information (e.g., id, groupId, image, etc...).
+     */
+    readonly props: Partial<IPublicWidgetTemplateDefinition<FormFieldObject>>;
+    /**
+     * Meta-information for the editing of the widget options as well as the actual processing of those options
+     * (i.e., AmCharts 4 chart configuration). Lazy-loaded (and the underlying AmCharts 4 library) once required.
+     *
+     * <pre>
+     *      export default {
+     *
+     *          hookChartOptionsMeta: () => {
+     *              ...
+     *          },
+     *
+     *          hookChartOptions: () => {
+     *              ...
+     *          },
+     *
+     *      }
+     * </pre>
+     */
+    readonly hooks: Promise<any>;
+}
 export declare class ApiUtils {
     /**
      * Define the form field as being localized.
@@ -8,12 +43,15 @@ export declare class ApiUtils {
     static readonly TAG_I18N_FIELD = "ic3t_";
     static makePlugin(definition: IPluginDefinition): () => IVersionedPluginDefinition;
     /**
-     * Wrap the template from another widget. The widget can come from a plugin or from the included widgets.
-     * Wrapping means that the template receives its not-defined settings from the template that is wrapped.
-     * @param wrappedTemplateId the unique identifier of the template, e.g., amCharts4.AmCharts4DonutChart.
-     * @param newDefinition definition of the new widget.
-     * @param transformOptions create the available options using the options from the wrapped template.
+     * A helper method to create a widget template using the resolveDefinition method.
+     * Webpack lazy load of dependencies.
+     *
+     * @see IPublicWidgetJsTemplateDefinition#resolveDefinition
+     */
+    static createLazyJsWidgetTemplateDefinition<OPTIONS extends FormFieldObject>(definition: Omit<IPublicWidgetJsTemplateDefinition<OPTIONS>, "jsCode">): IPublicWidgetJsTemplateDefinition<OPTIONS>;
+    static resolveAmCharts4WidgetTemplateDefinition<OPTIONS extends FormFieldObject>(definition: IPublicWidgetTemplateDefinition<OPTIONS>, wrapped: IPublicWidgetTemplateDefinition<any>): IPublicWidgetTemplateDefinition<OPTIONS>;
+    /**
+     * A utility function creating a wrapper widget template definition for existing AmCharts 4 widgets.
      */
-    static makeWidgetTemplateWrapper<T extends IPublicWidgetTemplateDefinition<any>>(wrappedTemplateId: string, newDefinition: T, transformOptions?: (old: T['chartOptionsMeta']) => void): T;
-    private static resolveTemplateDefinition;
+    static makeAmCharts4WrappedWidgetTemplateDefinition<WIDGET extends WidgetTemplateIDs>(props: AmCharts4WrappedDefinition<WIDGET>): IWrappedWidgetTemplateDefinition<WIDGET>;
 }

package/dist/ApiUtils.js

@@ -8,32 +8,48 @@ const ReportingVersion_1 = __importDefault(require("./ReportingVersion"));
 class ApiUtils {
     static makePlugin(definition) {
         return () => {
-            return Object.assign({ apiVersion: new ReportingVersion_1.default("8.0.0-rc.4" || "-", "Mon, 14 Feb 2022 08:45:05 GMT" || "-") }, definition);
+            return Object.assign({ apiVersion: new ReportingVersion_1.default("8.0.0" || "-", "Fri, 08 Apr 2022 12:23:38 GMT" || "-") }, definition);
         };
     }
     /**
-     * Wrap the template from another widget. The widget can come from a plugin or from the included widgets.
-     * Wrapping means that the template receives its not-defined settings from the template that is wrapped.
-     * @param wrappedTemplateId the unique identifier of the template, e.g., amCharts4.AmCharts4DonutChart.
-     * @param newDefinition definition of the new widget.
-     * @param transformOptions create the available options using the options from the wrapped template.
+     * A helper method to create a widget template using the resolveDefinition method.
+     * Webpack lazy load of dependencies.
+     *
+     * @see IPublicWidgetJsTemplateDefinition#resolveDefinition
      */
-    static makeWidgetTemplateWrapper(wrappedTemplateId, newDefinition, transformOptions) {
-        return Object.assign(Object.assign({}, newDefinition), { resolveDefinition: function (lib) {
-                const self = newDefinition;
-                return lib.wrapTemplateDefinition(wrappedTemplateId)
-                    .then(definition => ApiUtils.resolveTemplateDefinition(self, definition, transformOptions));
-            }, jsCode: () => {
-                throw Error("Wrapped widget template " + wrappedTemplateId + ": unexpected jsCode() call!");
-            } });
+    static createLazyJsWidgetTemplateDefinition(definition) {
+        return Object.assign(Object.assign({}, definition), { jsCode: (context, container) => {
+                throw new Error("JS Lazy: unexpected jsCode() call!");
+            }, reactComponent: false, withDrilldownPivotTableLikeAs: false });
     }
-    static resolveTemplateDefinition(self, definition, transformOptions) {
-        const newTemplate = Object.assign(Object.assign(Object.assign({}, definition), self), { resolveDefinition: undefined });
-        // TODO (tom) use deepClone for the optionsMeta.
-        if (transformOptions != null) {
-            transformOptions(newTemplate.chartOptionsMeta);
-        }
-        return newTemplate;
+    static resolveAmCharts4WidgetTemplateDefinition(definition, wrapped) {
+        return Object.assign(Object.assign(Object.assign({}, wrapped), definition), { resolveDefinition: undefined, jsCode: wrapped.jsCode });
+    }
+    /**
+     * A utility function creating a wrapper widget template definition for existing AmCharts 4 widgets.
+     */
+    static makeAmCharts4WrappedWidgetTemplateDefinition(props) {
+        return {
+            registrationInfo: props.registrationInfo,
+            wrappedWidgetTemplateId: props.wrappedWidgetTemplateId,
+            wrapper: (wrapped) => {
+                return Object.assign(Object.assign(Object.assign({}, wrapped /* unresolved */), props.props /* e.g., id, groupId, etc... */), { 
+                    /**
+                     * amCharts 4 widgets are loading the amCharts 4 Javascript library on the fly.
+                     *
+                     * This extended widget has to use the resolveDefinition() mechanism as well to be able to re-use
+                     * the lazy-loaded jsCode (widgets are implemented as IPublicWidgetJsTemplateDefinition).
+                     */
+                    resolveDefinition: function (wrappedR) {
+                        const wrappedResolved = ApiUtils.resolveAmCharts4WidgetTemplateDefinition(this, wrappedR);
+                        return new Promise((resolve, reject) => {
+                            props.hooks.then(definition => resolve(Object.assign(Object.assign({}, wrappedResolved), { 
+                                // our (lazy-loaded) widget meta-information and options hook.
+                                chartOptionsMeta: definition.default.hookChartOptionsMeta(wrappedResolved.chartOptionsMeta), hookChartOptions: definition.default.hookChartOptions }))).catch(err => reject(err));
+                        });
+                    } });
+            }
+        };
     }
 }
 exports.ApiUtils = ApiUtils;

package/dist/ApiUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"ApiUtils.js","sourceRoot":"","sources":["../src/ApiUtils.ts"],"names":[],"mappings":";;;;;;AAEA,0EAAkD;AAGlD,MAAa,QAAQ;IAOjB,MAAM,CAAC,UAAU,CAAC,UAA6B;QAE3C,OAAO,GAA+B,EAAE;YAEpC,uBAEI,UAAU,EAAE,IAAI,0BAAgB,CAC5B,YAAY,IAAI,GAAG,EACnB,+BAA+B,IAAI,GAAG,CACzC,IAEE,UAAU,EAEhB;QAEL,CAAC,CAAA;IACL,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,yBAAyB,CAC5B,iBAAyB,EAAE,aAAgB,EAAE,gBAAuD;QAEpG,uCAGO,aAAa,KAEhB,iBAAiB,EAAE,UAAU,GAA8B;gBACvD,MAAM,IAAI,GAAG,aAAa,CAAC;gBAC3B,OAAO,GAAG,CAAC,sBAAsB,CAAC,iBAAiB,CAAC;qBAC/C,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC,IAAI,EAAE,UAAU,EAAE,gBAAgB,CAAC,CAAC,CAAA;YACnG,CAAC,EAED,MAAM,EAAE,GAAG,EAAE;gBACT,MAAM,KAAK,CAAC,0BAA0B,GAAG,iBAAiB,GAAG,6BAA6B,CAAC,CAAC;YAChG,CAAC,IAEJ;IACL,CAAC;IAEO,MAAM,CAAC,yBAAyB,CACpC,IAAO,EAAE,UAAgD,EAAE,gBAAuD;QAElH,MAAM,WAAW,iDAAO,UAAU,GAAK,IAAI,KAAE,iBAAiB,EAAE,SAAS,GAAC,CAAC;QAC3E,gDAAgD;QAChD,IAAI,gBAAgB,IAAI,IAAI,EAAE;YAC1B,gBAAgB,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;SAClD;QACD,OAAO,WAAW,CAAC;IACvB,CAAC;;AA9DL,4BAgEC;AA9DG;;GAEG;AACoB,uBAAc,GAAG,OAAO,CAAC"}
+{"version":3,"file":"ApiUtils.js","sourceRoot":"","sources":["../src/ApiUtils.ts"],"names":[],"mappings":";;;;;;AAEA,0EAAkD;AAiDlD,MAAa,QAAQ;IAOV,MAAM,CAAC,UAAU,CAAC,UAA6B;QAElD,OAAO,GAA+B,EAAE;YAEpC,uBAEI,UAAU,EAAE,IAAI,0BAAgB,CAC5B,OAAO,IAAI,GAAG,EACd,+BAA+B,IAAI,GAAG,CACzC,IAEE,UAAU,EAEhB;QAEL,CAAC,CAAA;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,oCAAoC,CAAkC,UAAsE;QAEtJ,uCAEO,UAAU,KAEb,MAAM,EAAE,CAAC,OAA6B,EAAE,SAAyB,EAAE,EAAE;gBACjE,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;YAC1D,CAAC,EAED,cAAc,EAAE,KAAK,EAErB,6BAA6B,EAAE,KAAK,IAEvC;IAEL,CAAC;IAEM,MAAM,CAAC,wCAAwC,CAAkC,UAAoD,EAAE,OAA6C;QAEvL,OAAO,8CAEA,OAAO,GACP,UAAU,KAEb,iBAAiB,EAAE,SAAS,EAC5B,MAAM,EAAE,OAAO,CAAC,MAAM,GAEmB,CAAA;IAEjD,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,4CAA4C,CAAmC,KAAyC;QAElI,OAAO;YAEH,gBAAgB,EAAE,KAAK,CAAC,gBAAgB;YACxC,uBAAuB,EAAE,KAAK,CAAC,uBAAuB;YAEtD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE;gBAEjB,qDAEO,OAAO,CAAC,gBAAgB,GAExB,KAAK,CAAC,KAAK,CAAC,+BAA+B;oBAE9C;;;;;uBAKG;oBACH,iBAAiB,EAAE,UAAU,QAAQ;wBAEjC,MAAM,eAAe,GAAG,QAAQ,CAAC,wCAAwC,CAAC,IAAI,EAAE,QAAS,CAAC,CAAC;wBAE3F,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;4BAEnC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,iCAE/B,eAAe;gCAElB,8DAA8D;gCAE9D,gBAAgB,EAAE,UAAU,CAAC,OAAO,CAAC,oBAAoB,CAAC,eAAe,CAAC,gBAAgB,CAAC,EAC3F,gBAAgB,EAAE,UAAU,CAAC,OAAO,CAAC,gBAAgB,IAEvD,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;wBACjC,CAAC,CAAC,CAAC;oBAEP,CAAC,IACJ;YACL,CAAC;SAEwC,CAAC;IAElD,CAAC;;AA/GL,4BAiHC;AA/GG;;GAEG;AACoB,uBAAc,GAAG,OAAO,CAAC"}

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";
+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 interface IAppNotification {
     /**
      * E.g., print-report.
@@ -19,15 +19,35 @@ export interface IAppNotificationWithPayload<PAYLOAD> extends IAppNotification {
 export interface AppEditReportNotification extends IAppNotification {
     readonly type: "edit-report";
 }
-export interface AppPrintReportDialogNotification extends IAppNotification {
-    readonly type: "print-report-dialog";
-}
 export interface AppPrintReportNotificationPayload {
     fileName?: string;
     paperSizeName?: PaperSizeName;
     layout?: PaperOrientation;
 }
-export interface AppPrintReportNotification extends IAppNotificationWithPayload<AppPrintReportNotificationPayload> {
+export interface IAppPrintReportNotification extends IAppNotificationWithPayload<AppPrintReportNotificationPayload> {
+}
+export interface AppPrintReportNotification extends IAppPrintReportNotification {
     readonly type: "print-report";
 }
-export declare type AppNotification = AppEditReportNotification | AppPrintReportDialogNotification | AppPrintReportNotification;
+export interface AppPrintReportWithoutStateNotification extends IAppPrintReportNotification {
+    readonly type: "print-report-without-state";
+}
+export interface AppPrintReportInBrowserNotification extends IAppPrintReportNotification {
+    readonly type: "print-report-in-browser";
+}
+export interface AppPrintReportDialogNotification extends IAppNotification {
+    readonly type: "print-report-dialog";
+}
+export interface SaveStateToLocalStorageNotification extends IAppNotification {
+    readonly type: "save-state-to-localstorage";
+}
+export interface RestoreStateFromLocalStorageNotification extends IAppNotification {
+    readonly type: "restore-state-from-localstorage";
+}
+export interface SaveOwnPropsToLocalStorageNotification extends IAppNotification {
+    readonly type: "save-ownprops-to-localstorage";
+}
+export interface RestoreOwnPropsFromLocalStorageNotification extends IAppNotification {
+    readonly type: "restore-ownprops-from-localstorage";
+}
+export declare type AppNotification = AppEditReportNotification | AppPrintReportDialogNotification | AppPrintReportNotification | AppPrintReportWithoutStateNotification | AppPrintReportInBrowserNotification | SaveStateToLocalStorageNotification | RestoreStateFromLocalStorageNotification | SaveOwnPropsToLocalStorageNotification | RestoreOwnPropsFromLocalStorageNotification;

package/dist/IPluginDefinition.d.ts

@@ -4,6 +4,9 @@ import { IWidgetManager } from "./IWidgetManager";
 import { ITidyTableTransformationManager } from "./ITidyTableTransformationManager";
 import { IWidgetDefaultsManager } from "./IWidgetDefaultsManager";
 import { Theme } from "@mui/material/styles";
+import { WidgetTemplateIDs } from "./PublicTemplates";
+import { FormFieldObject } from "./PublicTemplateForm";
+import { IPublicWidgetTemplateDefinition } from "./PublicTemplate";
 export interface IPluginDefinition {
     /**
      * Keep that id simple (i.e., ASCII letter without any dot, space, separator, etc...) as it will be used
@@ -21,4 +24,10 @@ export interface IPluginDefinition {
     registerWidgets?: (manager: IWidgetManager) => void;
     registerTidyTableTransformations?: (manager: ITidyTableTransformationManager) => void;
     registerWidgetDefaults?: (theme: Theme, manager: IWidgetDefaultsManager) => void;
+    /**
+     * Allows for selecting the available widgets.
+     *
+     * @param id pluginId.widgetId (e.g., ic3.Table)
+     */
+    acceptWidget?: (id: WidgetTemplateIDs | string, widget: IPublicWidgetTemplateDefinition<FormFieldObject>) => boolean;
 }

package/dist/IReporting.d.ts

@@ -73,7 +73,7 @@ export interface IReporting {
     /**
      * @param options
      * @param pushToHistory    defaulted to true
-     * @param keepGlobalFilter defaulted to true
+     * @param keepGlobalFilter defaulted to false
      */
     openReport(options: IOpenReportOptions, pushToHistory?: boolean, keepGlobalFilter?: boolean): void;
     /**

package/dist/IThemeManager.d.ts

@@ -1,35 +1,34 @@
 import { CSSInterpolation } from "@mui/system";
+import { ic3Components } from "./PublicTheme";
 export declare enum EmbeddedThemeNames {
     Statos = "ic3-statos"
 }
 /**
- * Default values (e.g., box options, chart options, etc..).
+ * Default values (e.g., box options, chart options, etc...).
  */
 export interface IThemeWidgetDefaults {
     /**
-     * Default values for widget boxes.
+     * Default values for widget boxes. Lookup order:
      *
      * <pre>
-     *      IWidgetBoxDefinition
+     *      plugin-id.template-id.option
+     *      plugin-id.option
+     *      option
      * </pre>
+     *
+     * @see WidgetBoxOptions (ThemeWidgetBox.ts)
      */
     box?: Record<string, any>;
     /**
-     * Default values for widget chart options.
-     *
-     * <pre>
-     *      IWidgetDefinition
-     *          dataRenderOptions: IWidgetDataRenderDefinition
-     *              chartOptions: IChartTemplateDataRenderDefinition
-     * </pre>
-     *
-     * Lookup order:
+     * Default values for widget chart options. Lookup order:
      *
      * <pre>
      *      plugin-id.template-id.option
      *      plugin-id.option
      *      option
      * </pre>
+     *
+     * @see IWidgetTemplateChartOptions (PublicTemplates.ts)
      */
     options?: Record<string, any>;
 }
@@ -50,8 +49,10 @@ export declare type IThemeWidgetVariant = {
 };
 export interface IThemeManager {
     /**
+     *
      * The theme decorator allows to setup the Theme.components and Theme.ic3 using the theme
      * created from its partial options (e.g., using palette, typography, spacing, etc...)
+     *
      */
-    registerTheme(themeOptions: any, themeDecorator?: (theme: any) => void, baseTheme?: EmbeddedThemeNames): void;
+    registerTheme(themeOptions: any, themeDecorator?: (theme: any) => ic3Components, baseTheme?: EmbeddedThemeNames): void;
 }

package/dist/IThemeManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"IThemeManager.js","sourceRoot":"","sources":["../src/IThemeManager.ts"],"names":[],"mappings":";;;AAEA,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAE1B,2CAAqB,CAAA;AAEzB,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B"}
+{"version":3,"file":"IThemeManager.js","sourceRoot":"","sources":["../src/IThemeManager.ts"],"names":[],"mappings":";;;AAGA,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAE1B,2CAAqB,CAAA;AAEzB,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B"}

package/dist/ITypes.d.ts

@@ -1,3 +1,25 @@
 export declare type PaperSizeName = "A5" | "A4" | "A3" | "B5" | "B4" | "Letter" | "Legal" | "Ledger" | "JIS-B5" | "JIS-B4";
 export declare type PaperOrientation = "portrait" | "landscape";
 export declare type PaperSizeUnits = "px" | "mm" | "cm" | "in";
+export declare enum CompareTextInterpretationType {
+    MORE = "more=better",
+    LESS = "less=better",
+    NONE = "none"
+}
+export declare enum TargetTextPosition {
+    DISABLE = "DISABLE",
+    ALIGN_TOP = "ALIGN_TOP",
+    ALIGN_BOTTOM = "ALIGN_BOTTOM"
+}
+export declare enum TargetTextIconSet {
+    TREND_ICONS = "TREND_ICONS",
+    TRIANGLE_ICONS = "TRIANGLE_ICONS"
+}
+export declare enum SparkChartType {
+    LINE = "line",
+    COLUMN = "column"
+}
+export declare enum SparklinePosition {
+    BELOW_VALUE = "BELOW_VALUE",
+    RIGHT_OF_VALUE = "RIGHT_OF_VALUE"
+}

package/dist/ITypes.js

@@ -1,3 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SparklinePosition = exports.SparkChartType = exports.TargetTextIconSet = exports.TargetTextPosition = exports.CompareTextInterpretationType = void 0;
+var CompareTextInterpretationType;
+(function (CompareTextInterpretationType) {
+    CompareTextInterpretationType["MORE"] = "more=better";
+    CompareTextInterpretationType["LESS"] = "less=better";
+    CompareTextInterpretationType["NONE"] = "none";
+})(CompareTextInterpretationType = exports.CompareTextInterpretationType || (exports.CompareTextInterpretationType = {}));
+var TargetTextPosition;
+(function (TargetTextPosition) {
+    TargetTextPosition["DISABLE"] = "DISABLE";
+    TargetTextPosition["ALIGN_TOP"] = "ALIGN_TOP";
+    TargetTextPosition["ALIGN_BOTTOM"] = "ALIGN_BOTTOM";
+})(TargetTextPosition = exports.TargetTextPosition || (exports.TargetTextPosition = {}));
+var TargetTextIconSet;
+(function (TargetTextIconSet) {
+    TargetTextIconSet["TREND_ICONS"] = "TREND_ICONS";
+    TargetTextIconSet["TRIANGLE_ICONS"] = "TRIANGLE_ICONS";
+})(TargetTextIconSet = exports.TargetTextIconSet || (exports.TargetTextIconSet = {}));
+var SparkChartType;
+(function (SparkChartType) {
+    SparkChartType["LINE"] = "line";
+    SparkChartType["COLUMN"] = "column";
+})(SparkChartType = exports.SparkChartType || (exports.SparkChartType = {}));
+var SparklinePosition;
+(function (SparklinePosition) {
+    SparklinePosition["BELOW_VALUE"] = "BELOW_VALUE";
+    SparklinePosition["RIGHT_OF_VALUE"] = "RIGHT_OF_VALUE";
+})(SparklinePosition = exports.SparklinePosition || (exports.SparklinePosition = {}));
 //# sourceMappingURL=ITypes.js.map

package/dist/ITypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"ITypes.js","sourceRoot":"","sources":["../src/ITypes.ts"],"names":[],"mappings":""}
+{"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"}

package/dist/IWidgetManager.d.ts

@@ -1,4 +1,7 @@
-import { IPublicWidgetTemplateDefinition } from "./PublicTemplate";
+import { IPublicWidgetTemplateDefinition, IWrappedWidgetTemplateDefinition } from "./PublicTemplate";
+import { WidgetTemplateIDs } from "./PublicTemplates";
+import { FormFieldObject } from "./PublicTemplateForm";
 export interface IWidgetManager {
-    registerWidget(widget: IPublicWidgetTemplateDefinition<any>): void;
+    registerWidget<OPTIONS extends FormFieldObject>(widget: IPublicWidgetTemplateDefinition<OPTIONS>): void;
+    registerWrappedWidget<WIDGET extends WidgetTemplateIDs>(widget: IWrappedWidgetTemplateDefinition<WIDGET>): void;
 }

package/dist/LazyTreeView.d.ts

@@ -65,6 +65,7 @@ export interface ILazyTreeViewLoader {
  * Controlled properties of LazyTreeView (doesn't has to be lazy)
  */
 export interface LazyTreeViewProps {
+    logId: string;
     lazyLoader: ILazyTreeViewLoader;
     allowEmptySelection?: boolean;
     /**
@@ -98,9 +99,13 @@ export interface LazyTreeViewProps {
      */
     setSelected?: (nodeIdx: string[]) => void;
     /**
-     * Controlled mode for expanded
+     * Controlled mode for expanded or initial expanded if not controlled
      */
     expanded?: string[];
+    /**
+     * Controlled mode for expanded
+     */
+    setExpanded?: (nodeIdx: string[]) => void;
     /**
      * The level depth of initially open nodes ( 0 first level )
      */

package/dist/PublicContext.d.ts

@@ -45,6 +45,7 @@ export interface IPublicContext {
         info: string;
         description?: string;
     };
+    localizeFormField(pluginId: string, widgetTemplateId: string, name: string, ...args: any[]): [string, string | undefined];
     /**
      * A bunch of mathematical functions related to the tidy table.
      */

package/dist/PublicTemplate.d.ts

@@ -1,11 +1,13 @@
 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 } from "./PublicTidyTableTypes";
 declare type ChartTemplateWidgetProps = any;
 export declare type IPublicWidgetTemplateDefinition<T extends FormFieldObject> = IPublicWidgetReactTemplateDefinition<T> | IPublicWidgetJsTemplateDefinition<T>;
 export declare enum IWidgetTemplateMdxBuilderAxisPropsConstraint {
@@ -64,15 +66,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 +111,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 +134,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 +175,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 +297,35 @@ 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).
+         * If defined, default selection role(s)
+         */
+        defaultRoles?: string[];
+        /**
+         * If defined, returns the roles available
+         *
+         */
+        allowedRoles?: (table: ITidyTable | undefined) => string[];
+        /**
+         * The list of columns that can be part of the selection granularity. The user can select from the roles
+         * of the MDX query if there are 2 or more roles.
          */
-        allowedColumns: (column: ITidyColumn) => boolean;
-        optionValues?: undefined;
-    } | {
-        allowedColumns?: undefined;
-        optionValues?: SelectionGranularityOptions[];
+        allowedColumns?: (column: ITidyColumn, table: ITidyTable) => boolean;
     };
     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 +344,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 +362,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 +378,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 +410,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 +434,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 {};