@ic3/reporting-api 8.0.0-rc.3 → 8.0.1

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.3" || "-", "Fri, 21 Jan 2022 09:28:37 GMT" || "-") }, definition);
+            return Object.assign({ apiVersion: new ReportingVersion_1.default("8.0.1" || "-", "Fri, 22 Apr 2022 04:03:44 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,4 +1,5 @@
-export declare type AppNotificationType = "edit-report" | "print-report-dialog" | "print-report";
+import { PaperOrientation, PaperSizeName } from "./ITypes";
+export declare type AppNotificationType = "edit-report" | "print-report-dialog" | "print-report" | "print-report-without-state" | "print-report-in-browser" | "save-state-to-localstorage" | "restore-state-from-localstorage" | "save-ownprops-to-localstorage" | "restore-ownprops-from-localstorage";
 export interface IAppNotification {
     /**
      * E.g., print-report.
@@ -18,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?: "A5" | "A4" | "A3" | "B5" | "B4" | "Letter" | "Legal" | "Ledger" | "JIS-B5" | "JIS-B4";
-    layout?: "portrait" | "landscape";
+    paperSizeName?: PaperSizeName;
+    layout?: PaperOrientation;
+}
+export interface IAppPrintReportNotification extends IAppNotificationWithPayload<AppPrintReportNotificationPayload> {
 }
-export interface AppPrintReportNotification 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

@@ -7,6 +7,8 @@ export interface IReportDefinition {
     setDefaultSchemaName(name: string): void;
     getDefaultCubeName(): string | undefined;
     setDefaultCubeName(name: string): void;
+    getThemeUID(): string;
+    setThemeUID(uid: string): void;
 }
 export interface IReportAppDefinition {
 }
@@ -69,20 +71,30 @@ export interface IOpenReportAppOptions {
 export interface IReporting {
     getVersion(): ReportingVersion;
     /**
-     * @param options
+     * @param options          path, ...
      * @param pushToHistory    defaulted to true
-     * @param keepGlobalFilter defaulted to true
+     * @param keepGlobalFilter defaulted to false
+     *
+     * @see IOpenReportOptions#onDefinition
      */
     openReport(options: IOpenReportOptions, pushToHistory?: boolean, keepGlobalFilter?: boolean): void;
     /**
-     * @param options
+     * @param options          path, ...
      * @param pushToHistory    defaulted to true
+     *
+     * @see IOpenReportOptions#onDefinition
      */
     openReportApp(options: IOpenReportAppOptions, pushToHistory?: boolean): void;
+    /**
+     * Publish a widget event to the dashboard.
+     */
     fireEvent(eventName: string, value: IEventContent | null): void;
+    /**
+     * Subscribe to a widget event.
+     */
     onEvent(eventName: string, callback: (value: IEventContent | null) => void): void;
     /**
-     * e.g., print-report
+     * Publish a application notification (e.g., print-report).
      */
     fireAppNotification(notification: AppNotification): 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

@@ -0,0 +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

@@ -0,0 +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

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

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/Loader.d.ts

@@ -1,9 +1,18 @@
 import { IReporting } from "./IReporting";
+export declare type AppType = "console" | "viewer" | "editor" | "admin" | "appEditor";
 export interface IDashboardsLoaderFrameParams {
     /**
      * An unique ID (DOM) that is identifying the icCube dashboards instance.
      */
     containerId: string;
+    /**
+     * Optional CSS class of the created iFrame.
+     */
+    className?: string;
+    /**
+     * Optional CSS inline styling of the created iFrame.
+     */
+    style?: Partial<CSSStyleDeclaration>;
     onReady: (ic3: IReporting) => void;
     url: string;
 }

package/dist/Loader.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DashboardsLoaderFrame = void 0;
 function DashboardsLoaderFrame(params) {
-    const { containerId, onReady, url } = params;
+    const { containerId, className, style, onReady, url } = params;
     const containerELT = document.getElementById(containerId);
     if (!containerELT) {
         throw new Error("[ic3loader] (iFrame) missing container [" + containerId + "]");
@@ -20,9 +20,17 @@ function DashboardsLoaderFrame(params) {
     // setup an iFrame passing a url w/   &cb=window.name.of.callback
     //      window. or parent. then in icCube ...
     const iFrame = document.createElement('iframe');
+    className && (iFrame.className = className);
     iFrame.width = "100%";
     iFrame.height = "100%";
-    iFrame.style.border = "0px none";
+    if (style) {
+        for (const property in style) {
+            iFrame.style[property] = style[property];
+        }
+    }
+    else {
+        iFrame.style.border = "0px none";
+    }
     const sep = url.indexOf("?") === -1 ? "?" : "&";
     const src = url + sep + "ic3callback=ic3loader." + containerId;
     iFrame.setAttribute("src", src);

package/dist/Loader.js.map

@@ -1 +1 @@
-{"version":3,"file":"Loader.js","sourceRoot":"","sources":["../src/Loader.ts"],"names":[],"mappings":";;;AAeA,SAAgB,qBAAqB,CAAC,MAAoC;IAEtE,MAAM,EAAC,WAAW,EAAE,OAAO,EAAE,GAAG,EAAC,GAAG,MAAM,CAAC;IAE3C,MAAM,YAAY,GAAG,QAAQ,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAE1D,IAAI,CAAC,YAAY,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,0CAA0C,GAAG,WAAW,GAAG,GAAG,CAAC,CAAA;KAClF;IAED,OAAO,CAAC,GAAG,CAAC,oCAAoC,GAAG,GAAG,CAAC,CAAC;IACxD,OAAO,CAAC,GAAG,CAAC,oCAAoC,GAAG,WAAW,CAAC,CAAC;IAChE,OAAO,CAAC,GAAG,CAAC,oCAAoC,GAAG,OAAO,CAAC,CAAC;IAE5D,MAAM,GAAG,GAAI,MAAc,CAAC;IAE5B,GAAG,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC;IAEpC,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,GAAe,EAAE,EAAE;QAE7C,OAAO,CAAC,GAAG,CAAC,oCAAoC,EAAE,GAAG,CAAC,CAAC;QAEvD,OAAO,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QAClC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAE5B,CAAC,CAAA;IAED,iEAAiE;IACjE,6CAA6C;IAE7C,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAEhD,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC;IACtB,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;IAEvB,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,UAAU,CAAC;IAEjC,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;IAChD,MAAM,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,wBAAwB,GAAG,WAAW,CAAC;IAE/D,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAEhC,OAAO,CAAC,GAAG,CAAC,oCAAoC,GAAG,GAAG,CAAC,CAAC;IAExD,YAAY,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;AAErC,CAAC;AA9CD,sDA8CC"}
+{"version":3,"file":"Loader.js","sourceRoot":"","sources":["../src/Loader.ts"],"names":[],"mappings":";;;AAkCA,SAAgB,qBAAqB,CAAC,MAAoC;IAEtE,MAAM,EAAC,WAAW,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,EAAC,GAAG,MAAM,CAAC;IAE7D,MAAM,YAAY,GAAG,QAAQ,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAE1D,IAAI,CAAC,YAAY,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,0CAA0C,GAAG,WAAW,GAAG,GAAG,CAAC,CAAA;KAClF;IAED,OAAO,CAAC,GAAG,CAAC,oCAAoC,GAAG,GAAG,CAAC,CAAC;IACxD,OAAO,CAAC,GAAG,CAAC,oCAAoC,GAAG,WAAW,CAAC,CAAC;IAChE,OAAO,CAAC,GAAG,CAAC,oCAAoC,GAAG,OAAO,CAAC,CAAC;IAE5D,MAAM,GAAG,GAAI,MAAc,CAAC;IAE5B,GAAG,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC;IAEpC,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,GAAe,EAAE,EAAE;QAE7C,OAAO,CAAC,GAAG,CAAC,oCAAoC,EAAE,GAAG,CAAC,CAAC;QAEvD,OAAO,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QAClC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAE5B,CAAC,CAAA;IAED,iEAAiE;IACjE,6CAA6C;IAE7C,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAEhD,SAAS,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC;IAE5C,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC;IACtB,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;IAEvB,IAAI,KAAK,EAAE;QACP,KAAK,MAAM,QAAQ,IAAI,KAAK,EAAE;YACzB,MAAM,CAAC,KAAa,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;SACrD;KACJ;SAAM;QACH,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,UAAU,CAAC;KACpC;IAED,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;IAChD,MAAM,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,wBAAwB,GAAG,WAAW,CAAC;IAE/D,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAEhC,OAAO,CAAC,GAAG,CAAC,oCAAoC,GAAG,GAAG,CAAC,CAAC;IAExD,YAAY,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;AAErC,CAAC;AAtDD,sDAsDC"}

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.
      */
@@ -131,7 +132,7 @@ export interface IWidgetPublicContext extends IPublicContext {
      * template form fields, FormFieldDef (i.e.  {zoom:14} to set the zoom to 14). If in editing mode,
      * the edited options in the widget editor panel will be updated.
      */
-    onUserMenuAction(userMenuAction: string, callback: (event: any) => Record<string, any> | undefined): void;
+    onUserMenuAction(callback: (userMenuAction: string, event: any) => Record<string, any> | undefined): void;
     onWidgetRenderStatusChange(status: WidgetRenderLayoutStatus): void;
     /**
      * Event methods that do not depend on a Table

package/dist/PublicLayout.d.ts

@@ -1,3 +1,4 @@
+import { PaperOrientation, PaperSizeUnits } from "./ITypes";
 declare type CSSProperties = any;
 /**
  * <pre>
@@ -5,34 +6,17 @@ declare type CSSProperties = any;
  * </pre>
  */
 export declare type PageSize = "known" | "manual" | "unlimited";
-export declare type PageSizeUnit = "px" | "mm" | "cm" | "in";
-export declare type PageOrientation = "portrait" | "landscape";
 export interface IPageSize {
     type: PageSize;
 }
 /**
- * From icCube server print component configuration:
- *
- * <pre>
- *   <paperSize name="A5" unit="in" width="5.8" height="8.3"/>
- *   <paperSize name="A4" unit="in" width="8.3" height="11.7"/>
- *   <paperSize name="A3" unit="in" width="11.7" height="16.5"/>
- *   <paperSize name="B5" unit="in" width="6.9" height="9.8"/>
- *   <paperSize name="B4" unit="in" width="9.8" height="13.9"/>
- *
- *   <paperSize name="JIS-B5" unit="in" width="7.2" height="10.1"/>
- *   <paperSize name="JIS-B4" unit="in" width="10.1" height="14.3"/>
- *
- *   <paperSize name="Letter" unit="in" width="8.5" height="11"/>
- *   <paperSize name="Legal" unit="in" width="8.5" height="14"/>
- *   <paperSize name="Ledger" unit="in" width="11" height="17"/>
- * </pre>
+ * From icCube server print component configuration.
  */
 export interface IKnownPageSize extends IPageSize {
     name: string;
 }
 export interface IManualPageSize extends IPageSize {
-    pageSizeUnits: PageSizeUnit;
+    pageSizeUnits: PaperSizeUnits;
     pageWidth: number;
     pageHeight: number;
 }
@@ -40,11 +24,11 @@ export interface IManualPageSize extends IPageSize {
  * Unlimited in height.
  */
 export interface IUnlimitedPageSize extends IPageSize {
-    pageSizeUnits: PageSizeUnit;
+    pageSizeUnits: PaperSizeUnits;
     pageWidth: number;
 }
 export interface IPageMargin {
-    sizeUnits: PageSizeUnit;
+    sizeUnits: PaperSizeUnits;
     top: number;
     bottom: number;
     left: number;
@@ -98,7 +82,7 @@ export interface IPageHeaderFooterPartDefinition {
     logo?: IPageHeaderFooterLogoDefinition;
 }
 export interface IPageHeaderFooterDefinition {
-    sizeUnits: PageSizeUnit;
+    sizeUnits: PaperSizeUnits;
     height: number;
     style?: CSSProperties;
     left?: IPageHeaderFooterPartDefinition;
@@ -112,7 +96,7 @@ export interface IWidgetLayoutDefinition {
     layoutConfigId: string;
     cssClass?: string;
     pageSize: IKnownPageSize | IManualPageSize | IUnlimitedPageSize;
-    pageOrientation: PageOrientation;
+    pageOrientation: PaperOrientation;
     pageMargin: IPageMargin;
     pageBackgroundColor: string;
     /**