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

package/dist/ApiUtils.d.ts

@@ -1,9 +1,19 @@
 import { IPluginDefinition } from "./IPluginDefinition";
 import { IVersionedPluginDefinition } from "./IVersionedPluginDefinition";
+import { IPublicWidgetTemplateDefinition } from "./PublicTemplate";
 export declare class ApiUtils {
     /**
      * Define the form field as being localized.
      */
     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.
+     */
+    static makeWidgetTemplateWrapper<T extends IPublicWidgetTemplateDefinition<any>>(wrappedTemplateId: string, newDefinition: T, transformOptions?: (old: T['chartOptionsMeta']) => void): T;
+    private static resolveTemplateDefinition;
 }

package/dist/ApiUtils.js

@@ -8,9 +8,33 @@ const ReportingVersion_1 = __importDefault(require("./ReportingVersion"));
 class ApiUtils {
     static makePlugin(definition) {
         return () => {
-            return Object.assign({ apiVersion: new ReportingVersion_1.default("8.0.0-alpha.9" || "-", "Fri, 09 Jul 2021 08:23:42 GMT" || "-") }, definition);
+            return Object.assign({ apiVersion: new ReportingVersion_1.default("8.0.0-rc.4" || "-", "Mon, 14 Feb 2022 08:45:05 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.
+     */
+    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 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;
+    }
 }
 exports.ApiUtils = ApiUtils;
 /**

package/dist/ApiUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"ApiUtils.js","sourceRoot":"","sources":["../src/ApiUtils.ts"],"names":[],"mappings":";;;;;;AAEA,0EAAkD;AAElD,MAAa,QAAQ;IAOjB,MAAM,CAAC,UAAU,CAAC,UAA6B;QAE3C,OAAO,GAA+B,EAAE;YAEpC,uBAEI,UAAU,EAAE,IAAI,0BAAgB,CAC5B,eAAe,IAAI,GAAG,EACtB,+BAA+B,IAAI,GAAG,CACzC,IAEE,UAAU,EAEhB;QAEL,CAAC,CAAA;IACL,CAAC;;AAvBL,4BAyBC;AAvBG;;GAEG;AACoB,uBAAc,GAAG,OAAO,CAAC"}
+{"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"}

package/dist/INotification.d.ts

@@ -0,0 +1,33 @@
+import { PaperOrientation, PaperSizeName } from "./ITypes";
+export declare type AppNotificationType = "edit-report" | "print-report-dialog" | "print-report";
+export interface IAppNotification {
+    /**
+     * E.g., print-report.
+     */
+    readonly type: AppNotificationType;
+}
+export interface IAppNotificationWithPayload<PAYLOAD> extends IAppNotification {
+    /**
+     * E.g., print-report.
+     */
+    readonly type: AppNotificationType;
+    /**
+     * E.g., print-report file name.
+     */
+    readonly payload: PAYLOAD;
+}
+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> {
+    readonly type: "print-report";
+}
+export declare type AppNotification = AppEditReportNotification | AppPrintReportDialogNotification | AppPrintReportNotification;

package/dist/INotification.js

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

package/dist/INotification.js.map

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

package/dist/IPluginDefinition.d.ts

@@ -3,7 +3,7 @@ import { IThemeManager } from "./IThemeManager";
 import { IWidgetManager } from "./IWidgetManager";
 import { ITidyTableTransformationManager } from "./ITidyTableTransformationManager";
 import { IWidgetDefaultsManager } from "./IWidgetDefaultsManager";
-import { Theme } from "@material-ui/core/styles";
+import { Theme } from "@mui/material/styles";
 export interface IPluginDefinition {
     /**
      * Keep that id simple (i.e., ASCII letter without any dot, space, separator, etc...) as it will be used
@@ -12,6 +12,9 @@ export interface IPluginDefinition {
      * That name must be unique across all the plugins loaded into an icCube server.
      */
     id: string;
+    /**
+     * When defining new widgets using amCharts 4, this method registers the icCube license.
+     */
     registerAmCharts4?: (callback: (am4core: any) => void) => void;
     registerLocalization?: (manager: ILocalizationManager) => void;
     registerThemes?: (manager: IThemeManager) => void;

package/dist/IReporting.d.ts

@@ -1,18 +1,32 @@
 import ReportingVersion from "./ReportingVersion";
+import { AppNotification } from "./INotification";
 export interface IReportDefinition {
     getName(): string;
     getPath(): string;
     getDefaultSchemaName(): string;
     setDefaultSchemaName(name: string): void;
-    getDefaultCubeName(): string;
+    getDefaultCubeName(): string | undefined;
     setDefaultCubeName(name: string): void;
+    getThemeUID(): string;
+    setThemeUID(uid: string): void;
 }
+export interface IReportAppDefinition {
+}
+export interface IEventContentItem {
+    /**
+     * Localized name or name.
+     */
+    caption: string;
+    name: string;
+    uniqueName: string;
+}
+export declare type IEventContent = IEventContentItem | IEventContentItem[];
 /**
  * Used to setup filter initial selection.
  */
 export interface IReportParam {
     channelName: string;
-    name: string | string[];
+    value: IEventContent;
 }
 export interface IOpenReportOptions {
     embedded?: boolean;
@@ -40,12 +54,37 @@ export interface IOpenReportAppOptions {
      * Full path of the report app. (e.g., shared:/my-report).
      */
     path: string;
+    /**
+     * Called before the application definition is actually applied.
+     * Give the opportunity to change the definition.
+     */
+    onDefinition?: (report: IReportAppDefinition) => void;
+    /**
+     * If the method exist and return true then the default error dispatcher is not
+     * being called. Give the caller the opportunity to render the error.
+     */
+    onError?: (error: any) => boolean;
 }
 /**
  * An instance of icCube reporting application.
  */
 export interface IReporting {
     getVersion(): ReportingVersion;
-    openReport(options: IOpenReportOptions): void;
-    fireEvent(eventName: string, caption: string, mdx: string): void;
+    /**
+     * @param options
+     * @param pushToHistory    defaulted to true
+     * @param keepGlobalFilter defaulted to true
+     */
+    openReport(options: IOpenReportOptions, pushToHistory?: boolean, keepGlobalFilter?: boolean): void;
+    /**
+     * @param options
+     * @param pushToHistory    defaulted to true
+     */
+    openReportApp(options: IOpenReportAppOptions, pushToHistory?: boolean): void;
+    fireEvent(eventName: string, value: IEventContent | null): void;
+    onEvent(eventName: string, callback: (value: IEventContent | null) => void): void;
+    /**
+     * e.g., print-report
+     */
+    fireAppNotification(notification: AppNotification): void;
 }

package/dist/IThemeManager.d.ts

@@ -1,4 +1,4 @@
-import { CSSInterpolation } from "@material-ui/system";
+import { CSSInterpolation } from "@mui/system";
 export declare enum EmbeddedThemeNames {
     Statos = "ic3-statos"
 }

package/dist/ITidyTableTransformation.d.ts

@@ -7,14 +7,33 @@ export interface ILocalizationContext {
     localize(name: string, ...args: any[]): string;
 }
 export interface ITidyTableTransformation<OPTIONS extends FormFieldObject> {
+    /**
+     * The id of the transformation. Use this id to reference the transformation in the localization.
+     */
     id: string;
+    /**
+     * The id of the editor group that the transformation is in.
+     */
     groupId: string;
     /**
      * Internal usage: pluginID.id
      */
     qualifiedId?: string;
+    /**
+     * Return the description to show below the transformation in the 'TRANSFORMATION' tab of the editor
+     * @param context used for accessing localization functions
+     * @param options user-set options for the transformation
+     */
     getDescription?(context: ILocalizationContext, options: OPTIONS): string;
+    /**
+     * Return the field meta for the user-editable options
+     */
     getFieldMeta(): FormFieldDef[] | FormFields<OPTIONS>;
-    validateOptions(options: any): options is OPTIONS;
+    /**
+     * Run the transformation.
+     * @param context public context
+     * @param table modify this table in the transformation. It is mutable.
+     * @param options user-set options for the transformation
+     */
     apply(context: IPublicContext, table: ITidyTable, options: OPTIONS): void;
 }

package/dist/ITypes.d.ts

@@ -0,0 +1,3 @@
+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";

package/dist/ITypes.js

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

package/dist/ITypes.js.map

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

package/dist/IWidgetVariantManager.d.ts

@@ -1,4 +1,4 @@
-import { CSSInterpolation } from "@material-ui/system";
+import { CSSInterpolation } from "@mui/system";
 declare type variantName = string;
 export declare type IThemeRegisterVariant = Record<variantName, {
     /**

package/dist/LazyTreeView.d.ts

@@ -1,5 +1,6 @@
 import { EntityItem, MdxInfo } from "./PublicTidyTableTypes";
 import { ReactElement } from "react";
+import { SelectionMode } from "./PublicTidyTableInteractions";
 /**
  * A copy of MUI TreeItemClasses
  */
@@ -37,6 +38,14 @@ export interface LazyTreeClasses {
     /** Styles applied to the TreeRoot element */
     treeRoot: string;
 }
+/**
+ * Global classes
+ */
+export interface Ic3GlobalClasses {
+    singleSelection: string;
+    multipleSelection: string;
+}
+export declare const ic3GlobalClasses: Ic3GlobalClasses;
 export declare const lazyTreeClasses: LazyTreeClasses;
 export interface ILazyTreeViewLoader {
     /**
@@ -44,11 +53,13 @@ export interface ILazyTreeViewLoader {
      */
     mapTree<T extends ReactElement>(expanded: (index: number) => boolean, factory: (index: number) => T, filter?: (info: MdxInfo) => boolean): T[];
     hasLazyChildren(index: number): boolean;
+    getColumnLevelDepth(index: number): number;
     lazyLoadChildren(index: number): void | number;
     getNodeIdAndCaption(index: number): [string, string];
     setCallbackOnChange(callback: () => void): void;
     toEntityItems(nodeIds: string[]): EntityItem[];
     mapNodeIds<T>(nodeIds: string[], callbackfn: (columnIdx: number) => T | null | undefined): T[];
+    map<T>(callback: (index: number) => T | undefined): T[];
 }
 /**
  * Controlled properties of LazyTreeView (doesn't has to be lazy)
@@ -56,14 +67,45 @@ export interface ILazyTreeViewLoader {
 export interface LazyTreeViewProps {
     lazyLoader: ILazyTreeViewLoader;
     allowEmptySelection?: boolean;
+    /**
+     *
+     */
     addFilterSelected?: boolean;
+    /**
+     * Adds a search input to the tree filter
+     */
     addSearch?: boolean;
-    searchText?: string;
+    /**
+     * Search/Filter text when controlled (addSearch needs to be false)
+     */
+    search?: string;
+    /**
+     * Message for the search/filter when empty
+     */
+    searchPlaceholder?: string;
+    /**
+     * Message for the search/filter component (might be 'compacted' selection)
+     */
+    searchMessage?: string;
     toggleFilterSelected?: string;
     disableSelection?: boolean;
+    /**
+     * if undefined, the selection state is managed by the lazy tree as well
+     */
     selected?: string[];
+    /**
+     * Controlled mode for selection
+     */
     setSelected?: (nodeIdx: string[]) => void;
+    /**
+     * Controlled mode for expanded
+     */
     expanded?: string[];
+    /**
+     * The level depth of initially open nodes ( 0 first level )
+     */
+    openDepthLevel?: number;
+    selectionMode: SelectionMode;
     /**
      * Material-UI tree item classes Partial<TreeItemClasses>
      */

package/dist/LazyTreeView.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.lazyTreeClasses = void 0;
+exports.lazyTreeClasses = exports.ic3GlobalClasses = void 0;
+exports.ic3GlobalClasses = {
+    singleSelection: 'Ic3-SingleSelection',
+    multipleSelection: 'Ic3-MultipleSelection',
+};
 exports.lazyTreeClasses = {
     toolbar: 'Ic3-LazyTreeView-toolbar',
     input: 'Ic3-LazyTreeView-toolbar-input',

package/dist/LazyTreeView.js.map

@@ -1 +1 @@
-{"version":3,"file":"LazyTreeView.js","sourceRoot":"","sources":["../src/LazyTreeView.ts"],"names":[],"mappings":";;;AA+Ca,QAAA,eAAe,GAAoB;IAC5C,OAAO,EAAE,0BAA0B;IACnC,KAAK,EAAE,gCAAgC;IACvC,MAAM,EAAE,iCAAiC;IACzC,sBAAsB,EAAE,mCAAmC;IAC3D,uBAAuB,EAAE,oCAAoC;IAC7D,QAAQ,EAAE,2BAA2B;CACxC,CAAA"}
+{"version":3,"file":"LazyTreeView.js","sourceRoot":"","sources":["../src/LazyTreeView.ts"],"names":[],"mappings":";;;AA0Da,QAAA,gBAAgB,GAAqB;IAC9C,eAAe,EAAE,qBAAqB;IACtC,iBAAiB,EAAE,uBAAuB;CAC7C,CAAA;AAGY,QAAA,eAAe,GAAoB;IAC5C,OAAO,EAAE,0BAA0B;IACnC,KAAK,EAAE,gCAAgC;IACvC,MAAM,EAAE,iCAAiC;IACzC,sBAAsB,EAAE,mCAAmC;IAC3D,uBAAuB,EAAE,oCAAoC;IAC7D,QAAQ,EAAE,2BAA2B;CACxC,CAAA"}

package/dist/Loader.d.ts

@@ -0,0 +1,10 @@
+import { IReporting } from "./IReporting";
+export interface IDashboardsLoaderFrameParams {
+    /**
+     * An unique ID (DOM) that is identifying the icCube dashboards instance.
+     */
+    containerId: string;
+    onReady: (ic3: IReporting) => void;
+    url: string;
+}
+export declare function DashboardsLoaderFrame(params: IDashboardsLoaderFrameParams): void;

package/dist/Loader.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DashboardsLoaderFrame = void 0;
+function DashboardsLoaderFrame(params) {
+    const { containerId, onReady, url } = params;
+    const containerELT = document.getElementById(containerId);
+    if (!containerELT) {
+        throw new Error("[ic3loader] (iFrame) missing container [" + containerId + "]");
+    }
+    console.log("[ic3loader] (iFrame) icCube URL : " + url);
+    console.log("[ic3loader] (iFrame)  container : " + containerId);
+    console.log("[ic3loader] (iFrame)   callback : " + onReady);
+    const wnd = window;
+    wnd.ic3loader = wnd.ic3loader || {};
+    wnd.ic3loader[containerId] = (ic3) => {
+        console.log("[ic3loader] (iFrame)      ready : ", ic3);
+        delete wnd.ic3loader[containerId];
+        onReady && onReady(ic3);
+    };
+    // setup an iFrame passing a url w/   &cb=window.name.of.callback
+    //      window. or parent. then in icCube ...
+    const iFrame = document.createElement('iframe');
+    iFrame.width = "100%";
+    iFrame.height = "100%";
+    iFrame.style.border = "0px none";
+    const sep = url.indexOf("?") === -1 ? "?" : "&";
+    const src = url + sep + "ic3callback=ic3loader." + containerId;
+    iFrame.setAttribute("src", src);
+    console.log("[ic3loader] (iFrame)     iFrame : " + src);
+    containerELT.appendChild(iFrame);
+}
+exports.DashboardsLoaderFrame = DashboardsLoaderFrame;
+//# sourceMappingURL=Loader.js.map

package/dist/Loader.js.map

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

package/dist/PublicContext.d.ts

@@ -2,9 +2,11 @@
 import { LazyTreeViewProps } from "./LazyTreeView";
 import { ITidyTable } from "./PublicTidyTable";
 import { ITidyTableTransformation } from "./ITidyTableTransformation";
-import { Theme } from "@material-ui/core/styles";
+import { Theme } from "@mui/material/styles";
 import { ThemeTextFormatter } from "./PublicTheme";
 import { ITidyColumn } from "./PublicTidyColumn";
+import { IPublicWidgetTemplateDefinition } from "./PublicTemplate";
+import { ITidyMath } from "./PublicTidyMath";
 export declare enum WidgetRenderLayoutStatus {
     RENDERING = "RENDERING",
     RENDERED = "RENDERED"
@@ -22,13 +24,31 @@ export interface IPublicContext {
     getUserName(): string;
     getReportLocale(): string;
     getNumberFormatter(format: ThemeTextFormatter): (value: any | undefined) => string;
+    /**
+     * translate the content of a report (the title of widgets, content of some widgets...). This does use another file
+     *
+     * aka content localization
+     */
+    translateContent(content: string): string;
+    /**
+     * localized report application tags (e.g. edit, write, save.. )
+     */
+    localize(name: string, ...args: any[]): string;
+    /**
+     * localized report application error tags
+     */
+    localizeError(name: string, ...args: any[]): string;
+    /**
+     * Localization for transformations
+     */
     localizeTransformationCaption(template: ITidyTableTransformation<any>): {
         info: string;
         description?: string;
     };
-    localizeError(name: string, ...args: any[]): string;
-    localize(name: string, ...args: any[]): string;
-    translateContent(content: string): string;
+    /**
+     * A bunch of mathematical functions related to the tidy table.
+     */
+    tidyMath(): ITidyMath;
     /**
      * Not in widget public context because of transformation not applied from a widget context always.
      *
@@ -36,7 +56,7 @@ export interface IPublicContext {
      * To prevent usage of the default, pass an "empty" string that makes this method returns
      * undefined.
      */
-    createTableRowTextExprFormatter(field: string, table: ITidyTable, defaultColumn: ITidyColumn | undefined, expression: string | undefined): ((rowIdx: number) => string) | undefined;
+    createTableRowTextExpr(field: string, table: ITidyTable, defaultColumn: ITidyColumn | undefined, expression: string | undefined): ((rowIdx: number) => string) | undefined;
     /**
      * Not in widget public context because of transformation not applied from a widget context always.
      *
@@ -44,7 +64,7 @@ export interface IPublicContext {
      * To prevent usage of the default, pass an "empty" string that makes this method returns
      * undefined.
      */
-    createTableTextExprFormatter(field: string, table: ITidyTable, defaultColumn: ITidyColumn | undefined, expression: string | undefined): (() => string) | undefined;
+    createTableTextExpr(field: string, table: ITidyTable, defaultColumn: ITidyColumn | undefined, expression: string | undefined): (() => string) | undefined;
     /**
      * Not in widget public context because of transformation not applied from a widget context always.
      *
@@ -52,7 +72,7 @@ export interface IPublicContext {
      * To prevent usage of the default, pass an "empty" string that makes this method returns
      * undefined.
      */
-    createTableRowHtmlExprFormatter(field: string, table: ITidyTable, defaultColumn: ITidyColumn | undefined, expression: string | undefined): ((rowIdx: number) => string) | undefined;
+    createTableRowMarkdownExpr(field: string, table: ITidyTable, defaultColumn: ITidyColumn | undefined, expression: string | undefined): ((rowIdx: number) => string) | undefined;
     /**
      * Not in widget public context because of transformation not applied from a widget context always.
      *
@@ -60,7 +80,7 @@ export interface IPublicContext {
      * To prevent usage of the default, pass an "empty" string that makes this method returns
      * undefined.
      */
-    createTableHtmlExprFormatter(field: string, table: ITidyTable, defaultColumn: ITidyColumn | undefined, expression: string | undefined): (() => string) | undefined;
+    createTableMarkdownExpr(field: string, table: ITidyTable, expression: string | undefined): (() => string) | undefined;
     /**
      * Not in widget public context because of transformation not applied from a widget context always.
      *
@@ -69,6 +89,11 @@ export interface IPublicContext {
      * undefined.
      */
     createTableRowNumericExpr(field: string, table: ITidyTable, defaultColumn: ITidyColumn | undefined, expression: string | undefined): ((rowIdx: number) => number | undefined) | undefined;
+    /**
+     * same as  createTableRowNumericExpr but returning a string
+     */
+    createTableRowNumericStringExpr(field: string, table: ITidyTable, defaultColumn: ITidyColumn | undefined, expression: string | undefined): ((rowIdx: number) => string | undefined) | undefined;
+    createTableScaleRowNumericExpr(field: string, table: ITidyTable, defaultColumn: ITidyColumn | undefined, expression: string | undefined): ((rowIdx: number) => number | undefined) | undefined;
     /**
      * Not in widget public context because of transformation not applied from a widget context always.
      *
@@ -79,11 +104,13 @@ export interface IPublicContext {
     createTableNumericExpr(field: string, table: ITidyTable, defaultColumn: ITidyColumn | undefined, expression: string | undefined): (() => number | undefined) | undefined;
 }
 export interface IWidgetPublicContext extends IPublicContext {
-    onWidgetRenderStatusChange(status: WidgetRenderLayoutStatus): void;
     getNsId(): string;
     getWidgetId(): string;
     getTemplateId(): string;
     getWidgetPageId(): string;
+    isPrintingMode(): boolean;
+    getGoogleMapRenderedDelayMS(): number;
+    logInfoWidget(component: string, message: string): void;
     renderWidgetContentMessage(type: IContentMessageType, message: string): any;
     renderLazyTreeView<T>(props: LazyTreeViewProps): T;
     formatDate(value: Date | string | undefined | null, format: ThemeTextFormatter | null | undefined, locale?: string): string;
@@ -104,7 +131,45 @@ 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
+     *
+     * @see ITidyTableInteractionEvent for more
+     */
+    /**
+     * returns true if the actionName in bound to a channel
+     */
+    firesEvent(actionName: string): boolean;
+    /**
+     * actionName if the action is bound to a channel, clears the event (has no value)
+     */
+    fireClearEvent(actionName: string): void;
+    /**
+     * actionName if the action is bound to a channel, send an Mdx Event (value,mdx)
+     */
+    fireMdxEvent(actionName: string, value: string, mdx: string): void;
+    /**
+     * Cypress testing purpose, after a rendering of the chart
+     */
+    incrementWidgetContentRendering(): void;
+    getWidgetTemplateDefinition(qualifiedId: string): IPublicWidgetTemplateDefinition<any>;
+    resolveWidgetTemplateDefinition(definition: IPublicWidgetTemplateDefinition<any>): Promise<IPublicWidgetTemplateDefinition<any>>;
+    /**
+     * React -> combines useReduxOwnProps and setReduxOwnProps with a similar syntax to Redux.useState
+     *
+     * Note it's NOT the initial value but value if undefined
+     */
+    useReduxOwnPropsState<T>(fieldName: string, valueIfUndefined?: T): [T, (newValue: T) => void];
+    /**
+     * React -> useSelector on widgetOwnProps[fieldName]
+     */
+    useReduxOwnProps<T>(fieldName: string): T;
+    /**
+     * Redux -> set in Redux value in widgetOwnProps[fieldName]
+     */
+    setReduxOwnProps(fieldName: string, value: any): void;
 }
 export interface IWidgetEditorPublicContext {
     /**

package/dist/PublicContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"PublicContext.js","sourceRoot":"","sources":["../src/PublicContext.ts"],"names":[],"mappings":";;;AAOA,IAAY,wBAGX;AAHD,WAAY,wBAAwB;IAChC,mDAAuB,CAAA;IACvB,iDAAqB,CAAA;AACzB,CAAC,EAHW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAGnC;AAED,IAAY,mBAAkC;AAA9C,WAAY,mBAAmB;IAAG,6DAAI,CAAA;IAAE,+DAAK,CAAA;AAAA,CAAC,EAAlC,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAAe"}
+{"version":3,"file":"PublicContext.js","sourceRoot":"","sources":["../src/PublicContext.ts"],"names":[],"mappings":";;;AASA,IAAY,wBAGX;AAHD,WAAY,wBAAwB;IAChC,mDAAuB,CAAA;IACvB,iDAAqB,CAAA;AACzB,CAAC,EAHW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAGnC;AAED,IAAY,mBAAkC;AAA9C,WAAY,mBAAmB;IAAG,6DAAI,CAAA;IAAE,+DAAK,CAAA;AAAA,CAAC,EAAlC,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAAe"}