@ic3/reporting-api 9.0.1 → 9.1.1

package/dist/PublicContext.d.ts

@@ -1,389 +0,0 @@
-import { LazyTreeViewProps } from "./LazyTreeView";
-import { ITidyTable } from "./PublicTidyTable";
-import { ITidyTableTransformation } from "./ITidyTableTransformation";
-import { Theme } from "@mui/material/styles";
-import { ThemeFormatters, ThemeTextFormatter } from "./PublicTheme";
-import { ITidyColumn, ITidyNumericColumn } from "./PublicTidyColumn";
-import { IPublicWidgetTemplateDefinition } from "./PublicTemplate";
-import { ITidyMath } from "./PublicTidyMath";
-import { ILogger } from "./Logger";
-import { AppNotification } from "./INotification";
-import { WidgetNotificationHandler } from "./IcEvent";
-import { TidyRowFilter } from "./PublicTidyTableTypes";
-import { FormFieldTidyTableExprType } from "./PublicTemplateForm";
-export declare enum WidgetRenderLayoutStatus {
-    RENDERING = "RENDERING",
-    RENDERED = "RENDERED"
-}
-export declare enum WidgetWarningSeverity {
-    WARNING = 0,
-    ERROR = 1
-}
-export declare enum IContentMessageType {
-    info = 0,
-    error = 1
-}
-export interface IPublicContext {
-    logger(): ILogger;
-    isAppConsole(): boolean;
-    isAppReportViewer(): boolean;
-    isAppReportEditor(): boolean;
-    isAppReportEditorPreview(): boolean;
-    isAppReportAppEditor(): boolean;
-    isAppGadgetEditor(): boolean;
-    /**
-     * React, returns true when loaded
-     */
-    useGoogleMapHook(): boolean | Error;
-    getTheme(): Theme;
-    /**
-     * Return the formatter for the current user's locale.
-     */
-    getThemeFormatter(): ThemeFormatters;
-    getUserName(): string;
-    getReportName(): string;
-    getReportPath(): string;
-    getReportFolderName(): string;
-    getReportLocale(): string;
-    /**
-     * @param format Formatter. Defaults to `defaultNumber` from the theme.
-     */
-    getNumberFormatter(format: ThemeTextFormatter | null | undefined): (value: any | undefined) => string;
-    /**
-     * @param format Formatter. Defaults to `defaultDate` or `defaultDatetime` from the theme.
-     */
-    getDateFormatter(format: ThemeTextFormatter | null | undefined): (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, ...args: any[]): 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;
-    };
-    localizeFormField(pluginId: string, widgetTemplateId: string, name: string, ...args: any[]): [string, string | undefined, string | undefined];
-    /**
-     * markdown to sanitized html
-     */
-    markdownToHtml(markDown: string): string;
-    /**
-     * A bunch of mathematical functions related to the tidy table.
-     */
-    tidyMath(): ITidyMath;
-    /**
-     * Create an expression from a field.
-     *
-     * @param expression typically coming from a widget field so it cannot be null if there is a default value.
-     * To prevent usage of the default, pass a string with a single space to make this method return undefined.
-     * @param selectedColumns get the row of these columns using `_rowOfSelectedColumns` or `_selectedColumns`.
-     * @param isRowSelected function for usage with `totalSelectedOrTotal`. Use tableInter.isSelected(rowIdx).
-     */
-    createExpression<T extends FormFieldTidyTableExprType>(fieldType: T, field: string, table: ITidyTable, currentColumn: ITidyColumn | undefined, expression: string | undefined, selectedColumns: ITidyColumn[] | undefined, isRowSelected?: TidyRowFilter): T extends "tidyTableColorRowExpr" | "tidyTableScaleRowExpr" | "tidyTableHtmlRowExpr" | "tidyTableNumericRowExpr" | "tidyTableStringRowExpr" | "tidyTableTextRowExpr" ? ((rowIdx: number) => string) | undefined : (() => string) | undefined;
-    /**
-     * Not in widget public context because of transformation not applied from a widget context always.
-     *
-     * @param expression typically coming from a widget field so it cannot be null if there is a default value.
-     * To prevent usage of the default, pass an "empty" string that makes this method returns
-     * undefined.
-     * @param selectedColumns get the row of these columns using `_rowOfSelectedColumns` or `_selectedColumns`.
-     * @param isRowSelected function for usage with `totalSelectedOrTotal`. Use tableInter.isSelected(rowIdx).
-     *
-     * @deprecated will be removed in version >=9.1.0. Use `createExpression` instead.
-     */
-    createTableRowTextExpr(field: string, table: ITidyTable, currentColumn: ITidyColumn | undefined, expression: string | undefined, selectedColumns: ITidyColumn[] | undefined, isRowSelected?: TidyRowFilter): ((rowIdx: number) => string) | undefined;
-    /**
-     * Not in widget public context because of transformation not applied from a widget context always.
-     *
-     * @param expression typically coming from a widget field so it cannot be null if there is a default value.
-     * To prevent usage of the default, pass an "empty" string that makes this method returns
-     * undefined.
-     * @param isRowSelected function for usage with `totalSelectedOrTotal`. Use tableInter.isSelected(rowIdx).
-     *
-     * @deprecated will be removed in version >=9.1.0. Use `createExpression` instead.
-     */
-    createTableTextExpr(field: string, table: ITidyTable, currentColumn: ITidyColumn | undefined, expression: string | undefined, isRowSelected?: TidyRowFilter): (() => string) | undefined;
-    /**
-     * Not in widget public context because of transformation not applied from a widget context always.
-     *
-     * @param expression typically coming from a widget field so it cannot be null if there is a default value.
-     * To prevent usage of the default, pass an "empty" string that makes this method returns
-     * undefined.
-     * @param selectedColumns get the row of these columns using `_rowOfSelectedColumns` or `_selectedColumns`.
-     * @param isRowSelected function for usage with `totalSelectedOrTotal`. Use tableInter.isSelected(rowIdx).
-     *
-     * @deprecated will be removed in version >=9.1.0. Use `createExpression` instead.
-     */
-    createTableRowMarkdownExpr(field: string, table: ITidyTable, currentColumn: ITidyColumn | undefined, expression: string | undefined, selectedColumns: ITidyColumn[] | undefined, isRowSelected?: TidyRowFilter): ((rowIdx: number) => string) | undefined;
-    /**
-     * Not in widget public context because of transformation not applied from a widget context always.
-     *
-     * @param expression typically coming from a widget field so it cannot be null if there is a default value.
-     * To prevent usage of the default, pass an "empty" string that makes this method returns
-     * undefined.
-     * @param selectedColumns get the row of these columns using `_rowOfSelectedColumns` or `_selectedColumns`.
-     * @param isRowSelected function for usage with `totalSelectedOrTotal`. Use tableInter.isSelected(rowIdx).
-     *
-     * @deprecated will be removed in version >=9.1.0. Use `createExpression` instead.
-     */
-    createTableMarkdownExpr(field: string, table: ITidyTable, currentColumn: ITidyColumn | undefined, expression: string | undefined, selectedColumns: ITidyColumn[] | undefined, isRowSelected?: TidyRowFilter): (() => string) | undefined;
-    /**
-     * Not in widget public context because of transformation not applied from a widget context always.
-     *
-     * @param expression typically coming from a widget field so it cannot be null if there is a default value.
-     * To prevent usage of the default, pass an "empty" string that makes this method returns
-     * undefined.
-     * @param selectedColumns get the row of these columns using `_rowOfSelectedColumns` or `_selectedColumns`.
-     * @param isRowSelected function for usage with `totalSelectedOrTotal`. Use tableInter.isSelected(rowIdx).
-     *
-     * @deprecated will be removed in version >=9.1.0. Use `createExpression` instead.
-     */
-    createTableRowNumericExpr(field: string, table: ITidyTable, currentColumn: ITidyColumn | undefined, expression: string | undefined, selectedColumns: ITidyColumn[] | undefined, isRowSelected?: TidyRowFilter): ((rowIdx: number) => number | undefined) | undefined;
-    /**
-     * same as  createTableRowNumericExpr but returning a string
-     * @param selectedColumns get the row of these columns using `_rowOfSelectedColumns` or `_selectedColumns`.
-     * @param isRowSelected function for usage with `totalSelectedOrTotal`. Use tableInter.isSelected(rowIdx).
-     *
-     * @deprecated will be removed in version >=9.1.0. Use `createExpression` instead.
-     */
-    createTableRowNumericStringExpr(field: string, table: ITidyTable, currentColumn: ITidyColumn | undefined, expression: string | undefined, selectedColumns: ITidyColumn[] | undefined, isRowSelected?: TidyRowFilter): ((rowIdx: number) => string | undefined) | undefined;
-    /**
-     * @param selectedColumns get the row of these columns using `_rowOfSelectedColumns` or `_selectedColumns`.
-     * @param isRowSelected function for usage with `totalSelectedOrTotal`. Use tableInter.isSelected(rowIdx).
-     *
-     * @deprecated will be removed in version >=9.1.0. Use `createExpression` instead.
-     */
-    createTableScaleRowNumericExpr(field: string, table: ITidyTable, currentColumn: ITidyColumn | undefined, expression: string | undefined, selectedColumns: ITidyColumn[] | undefined, isRowSelected?: TidyRowFilter): ((rowIdx: number) => number | undefined) | undefined;
-    /**
-     * Not in widget public context because of transformation not applied from a widget context always.
-     *
-     * @param expression typically coming from a widget field so it cannot be null if there is a default value.
-     * To prevent usage of the default, pass an "empty" string that makes this method returns
-     * undefined.
-     * @param selectedColumns get the row of these columns using `_rowOfSelectedColumns` or `_selectedColumns`.
-     * @param isRowSelected function for usage with `totalSelectedOrTotal`. Use tableInter.isSelected(rowIdx).
-     *
-     * @deprecated will be removed in version >=9.1.0. Use `createExpression` instead.
-     */
-    createTableNumericExpr(field: string, table: ITidyTable, currentColumn: ITidyColumn | undefined, expression: string | undefined, selectedColumns: ITidyColumn[] | undefined, isRowSelected?: TidyRowFilter): (() => number | undefined) | undefined;
-    /**
-     * same as  createTableNumericExpr but returning a javascript object
-     *
-     * @deprecated will be removed in version >=9.1.0. Use `createExpression` instead.
-     */
-    createTableNumericStringExpr(field: string, table: ITidyTable, currentColumn: ITidyColumn | undefined, expression: string | undefined, selectedColumns: ITidyColumn[] | undefined, isRowSelected?: TidyRowFilter): (() => any | undefined) | undefined;
-    /**
-     * same as  createTableNumericExpr but returning a javascript object
-     *
-     * @deprecated will be removed in version >=9.1.0. Use `createExpression` instead.
-     */
-    createTableNumericJSExpr(field: string, table: ITidyTable, currentColumn: ITidyColumn | undefined, expression: string | undefined, selectedColumns: ITidyColumn[] | undefined, isRowSelected?: TidyRowFilter): (() => any | undefined) | undefined;
-    /**
-     * Event methods that do not depend on a Table
-     *
-     * @see ITidyTableInteractionEvent for more
-     */
-    /**
-     * actionName if the action is bound to a channel, clears the event (has no value)
-     */
-    fireClearEventName(actionName: string): void;
-    /**
-     * actionName if the action is bound to a channel, send an Mdx Event (value,mdx)
-     */
-    fireMdxEventName(actionName: string, value: string, mdx: string): void;
-    /**
-     * Used for publishing app notifications (e.g., print the report).
-     */
-    fireAppNotification(notification: AppNotification): void;
-    formatDate(value: Date | string | undefined | null, format: ThemeTextFormatter | null | undefined, locale?: string): string;
-    formatNumber(value: number | string | undefined | null, format: ThemeTextFormatter | null | undefined, locale?: string): string;
-    /**
-     * A shortcut for formatNumber( theme.formatter.defaultNumber )
-     */
-    formatAmount(value: number | string | undefined | null, locale?: string): string;
-    /**
-     * A shortcut for formatNumber( theme.formatter.defaultPercent )
-     */
-    formatPercent(value: number | string | undefined | null, locale?: string): string;
-}
-export interface IWidgetStableContext extends IPublicContext {
-    getTemplateId(): string;
-    getNsId(): string;
-    getWidgetId(): string;
-    getTemplateId(): string;
-    isPrintingMode(): boolean;
-    renderWidgetContentMessage(type: IContentMessageType, message: string): any;
-    renderLazyTreeView<T>(props: LazyTreeViewProps): T;
-    wrapWithTooltip(tooltip: string | undefined, wrappedElement: React.ReactElement): React.ReactElement;
-    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;
-    fireMdxEvents(events: {
-        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 | undefined) => 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;
-    /**
-     * Google map
-     */
-    /**
-     * React only, like an use function
-     *
-     * Loads Google map library with the API key as set
-     *
-     * return
-     *          true when the google map is ready (lib loaded)
-     *          error when
-     */
-    reactUseGoogleMap(): boolean | Error;
-    /**
-     * React only, like an use function
-     *
-     * reactUseGoogleMap() + rendered the map into the div referenced by ref with mapOptions
-     *
-     * @param mapOptions google.maps.MapOptions
-     * @param ref ref React.RefObject<HTMLDivElement>
-     *
-     * return
-     *          undefined if loading
-     *          {map} google.maps.Map instance when loaded
-     *          {error} if loaded on error
-     */
-    reactUseGoogleMapPlus(mapOptions: any, ref: any): undefined | {
-        map?: any;
-        error?: Error;
-    };
-    /**
-     * Returns latitude and longitude with the same logic as for internal maps
-     *
-     *
-     */
-    getMapCoordinates(table: ITidyTable): [ITidyNumericColumn, ITidyNumericColumn] | [];
-    getGoogleMapRenderedDelayMS(): number;
-    /**
-     * Displays an warning icon in the widget header showing the warning when the user hovers the icon.
-     * Be sure to clear all warnings before rendering using {@see widgetClearWarnings}
-     */
-    addWidgetWarning(warning: string, severity?: WidgetWarningSeverity): void;
-    /**
-     * Clear the warnings in the widget.
-     */
-    widgetClearWarnings(): void;
-    /**
-     * Notification
-     *
-     * like a listener on the components, for React the implementation uses a useEffect, it should
-     * NOT be called conditionally.
-     */
-    useNotification(notifications: WidgetNotificationHandler | WidgetNotificationHandler[], deps: ReadonlyArray<unknown> | undefined): void;
-    useUserMenu(handler: (userMenu: string) => any | void, deps: ReadonlyArray<unknown> | undefined): void;
-    /**
-     * doExport callback is called on each exportToExcel from the userMenu of the widget
-     *
-     * if the callback returns a tidyTable, this table will be exported
-     * if undefined is returned no further action
-     *
-     * disabled === true, the doExport function is not used
-     */
-    onExportToExcel(doExport: undefined | ((fileName: string | undefined) => ITidyTable | undefined | null), disabled?: boolean): void;
-    exportToExcel(table: ITidyTable, asPivotForExcel: boolean, rows: number[] | undefined): void;
-    useUserMenuWidth(): number | undefined;
-    /**
-     * Get the (translated) file name for exporting. Does not include file extension. Method returns 'export-file'
-     * if no file name is found.
-     * @param defaultName if not undefined, method returns this.
-     * @param defaultFileName
-     */
-    getExportFileName(defaultFileName?: string): string;
-    /**
-     * Returns the report name of the report defining this widget (i.e. could be the embedding)
-     */
-    getDefiningReportName(): string;
-    /**
-     * Returns the report path of the report defining this widget (i.e. could be the embedding)
-     */
-    getDefiningReportPath(): string;
-    /**
-     * Returns the report folder name of the report defining this widget (i.e. could be the embedding)
-     */
-    getDefiningReportFolderName(): string;
-}
-export interface IWidgetPublicContext extends IPublicContext {
-    /**
-     * Context unlikely to change during the lifecycle of a widget
-     * more appropriate to use in a React hook context.
-     */
-    getStableContext(): IWidgetStableContext;
-    /**
-     * Get the width of the widget box in pixels.
-     */
-    getWidgetWidth(): number | undefined;
-    /**
-     * Get the height of the widget box in pixels.
-     */
-    getWidgetHeight(): number | undefined;
-    getWidgetPageNb(): number;
-    /**
-     * Returns true if and only if the widgets has a header (from the chart box settings).
-     */
-    widgetHasHeader(): boolean;
-    getBoxSettings(): IPublicWidgetBoxSettings;
-}
-export interface IPublicWidgetBoxSettings {
-    widgetId: string;
-    waitingEventOrResult?: string;
-    emptyResult?: string;
-}
-export interface IWidgetEditorPublicContext {
-    /**
-     * The variants available in the theme for the edited widget.
-     */
-    getWidgetVariantIds(componentName?: string): string[];
-}

package/dist/PublicContext.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IContentMessageType = exports.WidgetWarningSeverity = exports.WidgetRenderLayoutStatus = void 0;
-var WidgetRenderLayoutStatus;
-(function (WidgetRenderLayoutStatus) {
-    WidgetRenderLayoutStatus["RENDERING"] = "RENDERING";
-    WidgetRenderLayoutStatus["RENDERED"] = "RENDERED";
-})(WidgetRenderLayoutStatus || (exports.WidgetRenderLayoutStatus = WidgetRenderLayoutStatus = {}));
-var WidgetWarningSeverity;
-(function (WidgetWarningSeverity) {
-    WidgetWarningSeverity[WidgetWarningSeverity["WARNING"] = 0] = "WARNING";
-    WidgetWarningSeverity[WidgetWarningSeverity["ERROR"] = 1] = "ERROR";
-})(WidgetWarningSeverity || (exports.WidgetWarningSeverity = WidgetWarningSeverity = {}));
-var IContentMessageType;
-(function (IContentMessageType) {
-    IContentMessageType[IContentMessageType["info"] = 0] = "info";
-    IContentMessageType[IContentMessageType["error"] = 1] = "error";
-})(IContentMessageType || (exports.IContentMessageType = IContentMessageType = {}));
-//# sourceMappingURL=PublicContext.js.map

package/dist/PublicContext.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PublicContext.js","sourceRoot":"","sources":["../src/PublicContext.ts"],"names":[],"mappings":";;;AAcA,IAAY,wBAGX;AAHD,WAAY,wBAAwB;IAChC,mDAAuB,CAAA;IACvB,iDAAqB,CAAA;AACzB,CAAC,EAHW,wBAAwB,wCAAxB,wBAAwB,QAGnC;AAED,IAAY,qBAGX;AAHD,WAAY,qBAAqB;IAC7B,uEAAO,CAAA;IACP,mEAAK,CAAA;AACT,CAAC,EAHW,qBAAqB,qCAArB,qBAAqB,QAGhC;AAED,IAAY,mBAAkC;AAA9C,WAAY,mBAAmB;IAAG,6DAAI,CAAA;IAAE,+DAAK,CAAA;AAAA,CAAC,EAAlC,mBAAmB,mCAAnB,mBAAmB,QAAe"}

package/dist/PublicDateShortcutUtils.d.ts

@@ -1,41 +0,0 @@
-type DateType = any;
-export interface PublicDateShortcutUtils<T = DateType> {
-    /**
-     * Get a date. See documentation for `new Date(…)` for the year, month and day arguments.
-     */
-    asDate(year: number, month: number, day: number): T;
-    /**
-     * Return the current datetime.
-     */
-    now(): T;
-    /**
-     * Return the current date. Returns the anchor date if it exists. The date returned has time 00:00:00.
-     * To get the date and time, use `current()`.
-     */
-    currentDate(): T;
-    /**
-     * Return the current datetime. Returns the anchor datetime if it exists.
-     */
-    current(): T;
-    /**
-     * Returns the anchor date.
-     */
-    getAnchorDate(): T | null;
-    /**
-     * Return the date of today with the time 00:00:00. To get the date and time, use `now()`.
-     */
-    today(): T;
-    /**
-     * Get the bottom limit of the allowed date range (included). Returns `null` if no bottom limit.
-     */
-    minAllowedDate(): T | null;
-    /**
-     * Get the upper limit of the allowed date range (included). Returns `null` if no upper limit.
-     */
-    maxAllowedDate(): T | null;
-    /**
-     * Returns intersect of `range` and [minDate, maxDate].
-     */
-    clampDates(range: [T | null, T | null]): [T | null, T | null];
-}
-export {};

package/dist/PublicDateShortcutUtils.js

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

package/dist/PublicDateShortcutUtils.js.map

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

package/dist/PublicI18n.d.ts

@@ -1,8 +0,0 @@
-import { FormFieldType } from "./PublicTemplateForm";
-export interface I18nIFormFieldDef {
-    fieldType?: FormFieldType;
-    fieldPath: string;
-    fieldPrefixTag?: string;
-    fieldDescription?: string;
-    localizationTag?: string;
-}

package/dist/PublicI18n.js

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

package/dist/PublicI18n.js.map

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