@infomaximum/widget-sdk 3.20.1 → 3.22.0

package/dist/index.d.ts

@@ -63,6 +63,12 @@ interface ICalculator<Input, Output> {
 }
 interface ICalculatorIndicatorInput {
     alias: string;
+    /**
+     * Информация о типе данных:
+     * - Если тип не передан, не производится дополнительной обработки формулы.
+     * - Если передан тип "OTHER", формула дополнительно будет обернута в toString().
+     */
+    dataType?: ESimpleDataType;
     displayConditionFormula?: TNullable<string>;
 }
 interface ICalculatorIndicatorOutput {
@@ -1124,6 +1130,8 @@ declare function bindContentWithIndicator<Output extends ICalculatorIndicatorOut
  */
 declare function bindContentsWithIndicators<Output extends ICalculatorIndicatorOutput, Indicator extends IWidgetIndicator>(outputs: Map<string, Output>, indicators: Indicator[]): TBoundedContentWithIndicator<Output, Indicator>[];
 
+declare const escapeSpecialCharacters: (formula: string) => string;
+
 interface ICalculatorFactory {
     general: () => IGeneralCalculator;
     pie: () => IPieCalculator;
@@ -1134,6 +1142,8 @@ interface ICalculatorFactory {
 }
 
 interface IDefinition<WidgetSettings extends IBaseWidgetSettings, GroupSettings extends IGroupSettings> {
+    /** иконка виджета отображаемая в системе (в base64, svg или png) */
+    icon?: string;
     /** возвращает конфигурацию настроек для отображения */
     createPanelDescription: IPanelDescriptionCreator<WidgetSettings, GroupSettings>;
     /** заполняет настройки значениями по умолчанию */
@@ -1327,15 +1337,18 @@ declare const replaceFiltersBySelection: (filters: ICalculatorFilter[], selectio
  */
 declare const getLocalizedText: <L extends TLocalizationDescription, P extends ILocalizationProps = TExtractLocalizationParams<L>>(language: ELanguages, locObj: L, props?: P | undefined) => string;
 
+type TDefineWidgetOptions = {
+    manifest?: Record<string, unknown>;
+};
 declare global {
     interface Infomaximum {
         /** @deprecated 2402 -  необходимо использовать window.im.widget.defineWidget */
         defineWidget: <WidgetSettings extends IBaseWidgetSettings, GroupSettings extends IGroupSettings>(uuid: string, Widget: IWidgetEntity<WidgetSettings, GroupSettings>) => void;
         widget: {
             currentSdkVersion: number;
-            defineWidget: <WidgetSettings extends IBaseWidgetSettings, GroupSettings extends IGroupSettings>(uuid: string, Widget: IWidgetEntity<WidgetSettings, GroupSettings>) => void;
+            defineWidget: <WidgetSettings extends IBaseWidgetSettings, GroupSettings extends IGroupSettings>(uuid: string, Widget: IWidgetEntity<WidgetSettings, GroupSettings>, options?: TDefineWidgetOptions) => void;
         };
     }
 }
 
-export { ECalculatorFilterMethods, EColorMode, EControlType, EDbType, EDimensionTemplateNames, EDisplayConditionMode, EDurationUnit, EEventMeasureTemplateNames, EFormatTypes, EFormattingPresets, EFormulaFilterFieldKeys, EIndicatorType, ELastTimeUnit, EMeasureTemplateNames, EProcessFilterNames, ESimpleDataType, ESortDirection, ESortingValueModes, ETransitionMeasureTemplateNames, EWidgetActionInputMode, EWidgetFilterMode, EWidgetIndicatorType, EWidgetIndicatorValueModes, type IActionScript, type IAddDurationOfTransitionFilter, type IAddPresenceOfEventFilter, type IAddPresenceOfTransitionFilter, type IAddRepetitionOfEventFilter, type IBaseDimensionsAndMeasuresCalculator, type IBaseDimensionsAndMeasuresCalculatorInput, type IBaseDimensionsAndMeasuresCalculatorOutput, type IBaseWidgetSettings, type ICalculator, type ICalculatorDimensionInput, type ICalculatorDimensionOutput, type ICalculatorFactory, type ICalculatorFilter, type ICalculatorIndicatorInput, type ICalculatorIndicatorOutput, type ICalculatorMeasureInput, type ICalculatorMeasureOutput, type ICalculatorVariable, type ICalculatorVariablesValues, type ICommonColumnIndicator, type IControlRecord, type ICustomAddButtonProps, type ICustomWidgetProps, type IDefinition, type IDimensionSelection, type IDimensionSelectionByFormula, type IDisplayPredicate, type IDivePanelDescription, type IDividerRecord, type IEdge, type IExportColumnOrder, type IFillSettings, type IFormulaFilterValue, type IGeneralCalculator, type IGeneralCalculatorExportInput, type IGeneralCalculatorInput, type IGeneralCalculatorOutput, type IGraphElement, type IGroupSetDescription, type IGroupSetRecord, type IGroupSettings, type IHistogramBin, type IHistogramCalculator, type IHistogramCalculatorInput, type IHistogramCalculatorOutput, type ILens, type IPanelDescription, type IPanelDescriptionCreator, type IPieCalculator, type IPieCalculatorInput, type IPieCalculatorOutput, type IPlacement, type IProcessEventFilterValue, type IProcessEventIndicator, type IProcessGraphCalculator, type IProcessGraphCalculatorInput, type IProcessGraphCalculatorOutput, type IProcessIndicator, type IProcessTransitionFilterValue, type IProcessTransitionIndicator, type IRange, type ISelectOption, type ISortOrder, type ITwoLimitsCalculator, type ITwoLimitsCalculatorExportInput, type ITwoLimitsCalculatorInput, type ITwoLimitsCalculatorOutput, type ITypeCalculator, type ITypeCalculatorInput, type ITypeCalculatorOutput, type IVertex, type IWidget, type IWidgetAction, type IWidgetActionInput, type IWidgetColumnIndicator, type IWidgetDimension, type IWidgetDimensionHierarchy, type IWidgetEntity, type IWidgetFiltration, type IWidgetFormatting, type IWidgetFormulaFilterValue, type IWidgetIndicator, type IWidgetMeasure, type IWidgetPlaceholderController, type IWidgetProcess, type IWidgetProps, type IWidgetSortingIndicator, type IWidgetTable, type IWidgetTableColumn, type IWidgetsContext, type TBoundedContentWithIndicator, type TColor, type TColumnIndicatorValue, type TDisplayCondition, type TDisplayMode, type TEmptyRecord, type TGroupLevelRecord, type TProcessIndicatorValue, type TRecordAccessor, type TSortDirection, type TUpdateSelection, type TValuePath, type TWidgetActionInputValue, type TWidgetFiltering, type TWidgetLevelRecord, type TWidgetSortingValue, type TWidgetSortingValueRelatedWidgetDimension, type TWidgetSortingValueRelatedWidgetIndicator, type TWidgetSortingValueRelatedWidgetMeasure, type TWidgetVariable, bindContentWithIndicator, bindContentsWithIndicators, checkDisplayCondition, dimensionTemplateFormulas, eventMeasureTemplateFormulas, fillTemplateString, formulaFilterMethods, generateColumnFormula, getDimensionFormula, getDisplayConditionFormula, getEventMeasureFormula, getLocalizedText, getMeasureFormula, getTransitionMeasureFormula, isActionValid, isHierarchy, mapDimensionsToInputs, mapEventMeasuresToInputs, mapFormulaFilterToCalculatorInput, mapFormulaFiltersToInputs, mapMeasuresToInputs, mapSortingToInputs, mapTransitionMeasuresToInputs, mapVariablesToInputs, measureTemplateFormulas, prepareValuesForSql, replaceDisplayCondition, replaceFiltersBySelection, replaceHierarchiesWithDimensions, selectDimensionFromHierarchy, transitionMeasureTemplateFormulas, updateDefaultModeSelection, updateMultiModeSelection, updateSingleModeSelection };
+export { ECalculatorFilterMethods, EColorMode, EControlType, EDbType, EDimensionTemplateNames, EDisplayConditionMode, EDurationUnit, EEventMeasureTemplateNames, EFormatTypes, EFormattingPresets, EFormulaFilterFieldKeys, EIndicatorType, ELastTimeUnit, EMeasureTemplateNames, EProcessFilterNames, ESimpleDataType, ESortDirection, ESortingValueModes, ETransitionMeasureTemplateNames, EWidgetActionInputMode, EWidgetFilterMode, EWidgetIndicatorType, EWidgetIndicatorValueModes, type IActionScript, type IAddDurationOfTransitionFilter, type IAddPresenceOfEventFilter, type IAddPresenceOfTransitionFilter, type IAddRepetitionOfEventFilter, type IBaseDimensionsAndMeasuresCalculator, type IBaseDimensionsAndMeasuresCalculatorInput, type IBaseDimensionsAndMeasuresCalculatorOutput, type IBaseWidgetSettings, type ICalculator, type ICalculatorDimensionInput, type ICalculatorDimensionOutput, type ICalculatorFactory, type ICalculatorFilter, type ICalculatorIndicatorInput, type ICalculatorIndicatorOutput, type ICalculatorMeasureInput, type ICalculatorMeasureOutput, type ICalculatorVariable, type ICalculatorVariablesValues, type ICommonColumnIndicator, type IControlRecord, type ICustomAddButtonProps, type ICustomWidgetProps, type IDefinition, type IDimensionSelection, type IDimensionSelectionByFormula, type IDisplayPredicate, type IDivePanelDescription, type IDividerRecord, type IEdge, type IExportColumnOrder, type IFillSettings, type IFormulaFilterValue, type IGeneralCalculator, type IGeneralCalculatorExportInput, type IGeneralCalculatorInput, type IGeneralCalculatorOutput, type IGraphElement, type IGroupSetDescription, type IGroupSetRecord, type IGroupSettings, type IHistogramBin, type IHistogramCalculator, type IHistogramCalculatorInput, type IHistogramCalculatorOutput, type ILens, type IPanelDescription, type IPanelDescriptionCreator, type IPieCalculator, type IPieCalculatorInput, type IPieCalculatorOutput, type IPlacement, type IProcessEventFilterValue, type IProcessEventIndicator, type IProcessGraphCalculator, type IProcessGraphCalculatorInput, type IProcessGraphCalculatorOutput, type IProcessIndicator, type IProcessTransitionFilterValue, type IProcessTransitionIndicator, type IRange, type ISelectOption, type ISortOrder, type ITwoLimitsCalculator, type ITwoLimitsCalculatorExportInput, type ITwoLimitsCalculatorInput, type ITwoLimitsCalculatorOutput, type ITypeCalculator, type ITypeCalculatorInput, type ITypeCalculatorOutput, type IVertex, type IWidget, type IWidgetAction, type IWidgetActionInput, type IWidgetColumnIndicator, type IWidgetDimension, type IWidgetDimensionHierarchy, type IWidgetEntity, type IWidgetFiltration, type IWidgetFormatting, type IWidgetFormulaFilterValue, type IWidgetIndicator, type IWidgetMeasure, type IWidgetPlaceholderController, type IWidgetProcess, type IWidgetProps, type IWidgetSortingIndicator, type IWidgetTable, type IWidgetTableColumn, type IWidgetsContext, type TBoundedContentWithIndicator, type TColor, type TColumnIndicatorValue, type TDefineWidgetOptions, type TDisplayCondition, type TDisplayMode, type TEmptyRecord, type TGroupLevelRecord, type TProcessIndicatorValue, type TRecordAccessor, type TSortDirection, type TUpdateSelection, type TValuePath, type TWidgetActionInputValue, type TWidgetFiltering, type TWidgetLevelRecord, type TWidgetSortingValue, type TWidgetSortingValueRelatedWidgetDimension, type TWidgetSortingValueRelatedWidgetIndicator, type TWidgetSortingValueRelatedWidgetMeasure, type TWidgetVariable, bindContentWithIndicator, bindContentsWithIndicators, checkDisplayCondition, dimensionTemplateFormulas, escapeSpecialCharacters, eventMeasureTemplateFormulas, fillTemplateString, formulaFilterMethods, generateColumnFormula, getDimensionFormula, getDisplayConditionFormula, getEventMeasureFormula, getLocalizedText, getMeasureFormula, getTransitionMeasureFormula, isActionValid, isHierarchy, mapDimensionsToInputs, mapEventMeasuresToInputs, mapFormulaFilterToCalculatorInput, mapFormulaFiltersToInputs, mapMeasuresToInputs, mapSortingToInputs, mapTransitionMeasuresToInputs, mapVariablesToInputs, measureTemplateFormulas, prepareValuesForSql, replaceDisplayCondition, replaceFiltersBySelection, replaceHierarchiesWithDimensions, selectDimensionFromHierarchy, transitionMeasureTemplateFormulas, updateDefaultModeSelection, updateMultiModeSelection, updateSingleModeSelection };

package/dist/index.esm.js

@@ -514,7 +514,9 @@ var replaceDisplayCondition = function (dimension, displayCondition) {
 };
 
 function generateColumnFormula(tableName, columnName) {
-    return "\"".concat(tableName, "\".\"").concat(columnName, "\"");
+    var preparedTableName = escapeSpecialCharacters(tableName);
+    var preparedColumnName = escapeSpecialCharacters(columnName);
+    return "\"".concat(preparedTableName, "\".\"").concat(preparedColumnName, "\"");
 }
 function fillTemplateString(templateString, params) {
     return templateString.replace(/\{(.*?)\}/g, function (_, key) { var _a; return (_a = params[key]) !== null && _a !== void 0 ? _a : ""; });
@@ -738,6 +740,7 @@ function mapMeasureToInput(measure, variables, addFormulas) {
     return {
         alias: String(measure.id),
         mainFormula: mainFormula,
+        dataType: measure.dataType,
         displayConditionFormula: getDisplayConditionFormula(measure.displayCondition),
         additionalFormulas: addFormulas(measure),
     };
@@ -760,6 +763,7 @@ function mapDimensionToInput(dimension, variables) {
     return {
         alias: String(dimension.id),
         formula: formula,
+        dataType: dimension.dataType,
         hideEmpty: dimension.hideEmptyValues,
         displayConditionFormula: getDisplayConditionFormula(dimension.displayCondition),
     };
@@ -783,6 +787,7 @@ function mapTransitionMeasureToInput(indicator, process, variables, addFormulas)
     return {
         alias: String(indicator.id),
         mainFormula: mainFormula,
+        dataType: indicator.dataType,
         displayConditionFormula: getDisplayConditionFormula(indicator.displayCondition),
         additionalFormulas: addFormulas(indicator),
     };
@@ -806,6 +811,7 @@ function mapEventMeasureToInput(indicator, process, variables, addFormulas) {
     return {
         alias: String(indicator.id),
         mainFormula: mainFormula,
+        dataType: indicator.dataType,
         displayConditionFormula: getDisplayConditionFormula(indicator.displayCondition),
         additionalFormulas: addFormulas(indicator),
     };
@@ -907,6 +913,14 @@ function bindContentsWithIndicators(outputs, indicators) {
     });
 }
 
+var escapeSpecialCharacters = function (formula) {
+    return formula
+        .replaceAll("\\", "\\\\")
+        .replaceAll('"', '\\"')
+        .replaceAll("`", "\\`")
+        .replaceAll("-", "\\-");
+};
+
 var EControlType;
 (function (EControlType) {
     EControlType["inputNumber"] = "inputNumber";
@@ -1030,4 +1044,4 @@ var getLocalizedText = function (language, locObj, props) {
     return localization.getLocalized(locObj, props);
 };
 
-export { ECalculatorFilterMethods, EColorMode, EControlType, EDbType, EDimensionTemplateNames, EDisplayConditionMode, EDurationUnit, EEventMeasureTemplateNames, EFormatTypes, EFormattingPresets, EFormulaFilterFieldKeys, EIndicatorType, ELastTimeUnit, EMeasureTemplateNames, EProcessFilterNames, ESimpleDataType, ESortDirection, ESortingValueModes, ETransitionMeasureTemplateNames, EWidgetActionInputMode, EWidgetFilterMode, EWidgetIndicatorType, EWidgetIndicatorValueModes, bindContentWithIndicator, bindContentsWithIndicators, checkDisplayCondition, dimensionTemplateFormulas, eventMeasureTemplateFormulas, fillTemplateString, formulaFilterMethods, generateColumnFormula, getDimensionFormula, getDisplayConditionFormula, getEventMeasureFormula, getLocalizedText, getMeasureFormula, getTransitionMeasureFormula, isActionValid, isHierarchy, mapDimensionsToInputs, mapEventMeasuresToInputs, mapFormulaFilterToCalculatorInput, mapFormulaFiltersToInputs, mapMeasuresToInputs, mapSortingToInputs, mapTransitionMeasuresToInputs, mapVariablesToInputs, measureTemplateFormulas, prepareValuesForSql, replaceDisplayCondition, replaceFiltersBySelection, replaceHierarchiesWithDimensions, selectDimensionFromHierarchy, transitionMeasureTemplateFormulas, updateDefaultModeSelection, updateMultiModeSelection, updateSingleModeSelection };
+export { ECalculatorFilterMethods, EColorMode, EControlType, EDbType, EDimensionTemplateNames, EDisplayConditionMode, EDurationUnit, EEventMeasureTemplateNames, EFormatTypes, EFormattingPresets, EFormulaFilterFieldKeys, EIndicatorType, ELastTimeUnit, EMeasureTemplateNames, EProcessFilterNames, ESimpleDataType, ESortDirection, ESortingValueModes, ETransitionMeasureTemplateNames, EWidgetActionInputMode, EWidgetFilterMode, EWidgetIndicatorType, EWidgetIndicatorValueModes, bindContentWithIndicator, bindContentsWithIndicators, checkDisplayCondition, dimensionTemplateFormulas, escapeSpecialCharacters, eventMeasureTemplateFormulas, fillTemplateString, formulaFilterMethods, generateColumnFormula, getDimensionFormula, getDisplayConditionFormula, getEventMeasureFormula, getLocalizedText, getMeasureFormula, getTransitionMeasureFormula, isActionValid, isHierarchy, mapDimensionsToInputs, mapEventMeasuresToInputs, mapFormulaFilterToCalculatorInput, mapFormulaFiltersToInputs, mapMeasuresToInputs, mapSortingToInputs, mapTransitionMeasuresToInputs, mapVariablesToInputs, measureTemplateFormulas, prepareValuesForSql, replaceDisplayCondition, replaceFiltersBySelection, replaceHierarchiesWithDimensions, selectDimensionFromHierarchy, transitionMeasureTemplateFormulas, updateDefaultModeSelection, updateMultiModeSelection, updateSingleModeSelection };

package/dist/index.js

@@ -515,7 +515,9 @@ var replaceDisplayCondition = function (dimension, displayCondition) {
 };
 
 function generateColumnFormula(tableName, columnName) {
-    return "\"".concat(tableName, "\".\"").concat(columnName, "\"");
+    var preparedTableName = escapeSpecialCharacters(tableName);
+    var preparedColumnName = escapeSpecialCharacters(columnName);
+    return "\"".concat(preparedTableName, "\".\"").concat(preparedColumnName, "\"");
 }
 function fillTemplateString(templateString, params) {
     return templateString.replace(/\{(.*?)\}/g, function (_, key) { var _a; return (_a = params[key]) !== null && _a !== void 0 ? _a : ""; });
@@ -739,6 +741,7 @@ function mapMeasureToInput(measure, variables, addFormulas) {
     return {
         alias: String(measure.id),
         mainFormula: mainFormula,
+        dataType: measure.dataType,
         displayConditionFormula: getDisplayConditionFormula(measure.displayCondition),
         additionalFormulas: addFormulas(measure),
     };
@@ -761,6 +764,7 @@ function mapDimensionToInput(dimension, variables) {
     return {
         alias: String(dimension.id),
         formula: formula,
+        dataType: dimension.dataType,
         hideEmpty: dimension.hideEmptyValues,
         displayConditionFormula: getDisplayConditionFormula(dimension.displayCondition),
     };
@@ -784,6 +788,7 @@ function mapTransitionMeasureToInput(indicator, process, variables, addFormulas)
     return {
         alias: String(indicator.id),
         mainFormula: mainFormula,
+        dataType: indicator.dataType,
         displayConditionFormula: getDisplayConditionFormula(indicator.displayCondition),
         additionalFormulas: addFormulas(indicator),
     };
@@ -807,6 +812,7 @@ function mapEventMeasureToInput(indicator, process, variables, addFormulas) {
     return {
         alias: String(indicator.id),
         mainFormula: mainFormula,
+        dataType: indicator.dataType,
         displayConditionFormula: getDisplayConditionFormula(indicator.displayCondition),
         additionalFormulas: addFormulas(indicator),
     };
@@ -908,6 +914,14 @@ function bindContentsWithIndicators(outputs, indicators) {
     });
 }
 
+var escapeSpecialCharacters = function (formula) {
+    return formula
+        .replaceAll("\\", "\\\\")
+        .replaceAll('"', '\\"')
+        .replaceAll("`", "\\`")
+        .replaceAll("-", "\\-");
+};
+
 exports.EControlType = void 0;
 (function (EControlType) {
     EControlType["inputNumber"] = "inputNumber";
@@ -1043,6 +1057,7 @@ exports.bindContentWithIndicator = bindContentWithIndicator;
 exports.bindContentsWithIndicators = bindContentsWithIndicators;
 exports.checkDisplayCondition = checkDisplayCondition;
 exports.dimensionTemplateFormulas = dimensionTemplateFormulas;
+exports.escapeSpecialCharacters = escapeSpecialCharacters;
 exports.eventMeasureTemplateFormulas = eventMeasureTemplateFormulas;
 exports.fillTemplateString = fillTemplateString;
 exports.formulaFilterMethods = formulaFilterMethods;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infomaximum/widget-sdk",
-  "version": "3.20.1",
+  "version": "3.22.0",
   "main": "./dist/index.js",
   "module": "./dist/index.esm.js",
   "types": "./dist/index.d.ts",