@infomaximum/widget-sdk 4.1.0 → 4.2.1

package/dist/index.d.ts

@@ -44,11 +44,13 @@ declare enum EControlType {
 }
 /** Конфигурация элемента управления настройкой */
 interface IControlRecord<Settings extends object, Value, ControlType = EControlType> {
+    /** Ключ, должен быть уникальным в рамках одного уровня вложенности */
     key: string;
-    /** Локализация заголовка настройки */
+    /** Локализация заголовка */
     title?: string;
-    /** Тип используемого элемента управления настройкой из предложенных нашей системой */
+    /** Тип используемого элемента управления из предложенных системой */
     type: ControlType | string;
+    /** Кастомный верхний отступ */
     marginTop?: number;
     /** Объект дополнительных параметров элемента управления */
     props?: object | ((settings: Settings) => object);
@@ -56,9 +58,15 @@ interface IControlRecord<Settings extends object, Value, ControlType = EControlT
     accessor: TRecordAccessor<Settings, Value>;
     /**
      * Рекурсивное определение мета-описания, в элемент управления будет передана функция dive
-     * для погружения на уровень ниже.
+     * для перехода в указанное мета-описание.
+     *
+     * Возможность работает только для элемента управления EControlType.tagSet.
      */
     description?: IDivePanelDescription<Settings>;
+    /**
+     * Предикат, позволяющий скрыть элемент управления.
+     * Предоставлен для удобства разработки. Скрыть элемент можно и условно добавляя его в мета-описание.
+     */
     shouldDisplay?: IDisplayPredicate<Settings>;
 }
 
@@ -421,18 +429,26 @@ interface IStagesFilterValue {
 }
 type TWidgetFilterValue = IFormulaFilterValue | IStagesFilterValue | IProcessEventFilterValue | IProcessTransitionFilterValue;
 interface IWidgetFilter {
-    isReadonly: boolean;
+    /** Значение фильтра */
     filterValue: TWidgetFilterValue;
+    /** Значение фильтра, подготовленное для передачи в вычислитель */
     preparedFilterValue: ICalculatorFilter;
+    /** Информация о возможности менять фильтр из виджета */
+    isReadonly: boolean;
 }
 interface IWidgetFiltration {
-    /** Значения фильтров, подготовленные для передачи в вычислитель */
-    preparedFilterValues: ICalculatorFilter[];
+    /** Информация о внешних фильтрах виджета */
     filters: IWidgetFilter[];
+    /**
+     * Значения внешних фильтров виджета, подготовленные для передачи в вычислитель.
+     * Использует данные из filters, но предоставлено отдельным полем для удобства разработки.
+     */
+    preparedFilterValues: ICalculatorFilter[];
     /** Добавить фильтр по формуле */
     addFormulaFilter(value: TSelectivePartial<IFormulaFilterValue, "format" | "formValues">): void;
     /** Удалить фильтр по формуле */
     removeFormulaFilter(formula: string): void;
+    /** Добавить процессный фильтр */
     addProcessFilter(...args: Parameters<IAddPresenceOfEventFilter> | Parameters<IAddRepetitionOfEventFilter> | Parameters<IAddPresenceOfTransitionFilter> | Parameters<IAddDurationOfTransitionFilter>): void;
     /** Добавить фильтр по этапам */
     addStagesFilter(value: Omit<IStagesFilterValue, "widgetKey">): void;
@@ -496,8 +512,8 @@ interface IWidgetTableColumn {
     /** Тип данных колонки */
     dataType: ESimpleDataType;
 }
-interface IScripField {
-    /** @deprecated удалить после выполнения BI-13602, задача BI-13650 */
+interface IScriptField {
+    /** @deprecated */
     guid: string;
     name: string;
     dataType: ESimpleDataType;
@@ -505,10 +521,10 @@ interface IScripField {
 }
 interface IActionScript {
     key: string;
-    /** @deprecated удалить после выполнения BI-13602, задача BI-13650 */
+    /** @deprecated */
     guid: string;
     name: string;
-    fields: IScripField[];
+    fields: IScriptField[];
 }
 interface IWidgetTable {
     /** Имя таблицы */
@@ -517,7 +533,7 @@ interface IWidgetTable {
     columns: Map<string, IWidgetTableColumn>;
 }
 /**
- * simplified - упрощенный для работы фильтрации в образах открытых в дровере/модальном окне
+ * simplified - упрощенный (для работы фильтрации в образах, открытых в модальном/боковом окне)
  *
  * full - полный
  */
@@ -532,32 +548,46 @@ interface IDisplayRule {
     color: TColor;
 }
 interface IGlobalContext {
-    /** используемый язык в системе */
+    /** Используемый язык системы */
     language: ELanguages;
-    processes: Map<string, IWidgetProcess>;
+    /** Имя отчета */
+    reportName: string;
+    /** Имена образов по их ключу(в текущем отчете) */
+    viewNameByKey: Map<string, string>;
+    /** Режим отображения виджетов */
+    displayMode: TDisplayMode;
+    /** Режим фильтрации виджетов */
+    filtrationMode: TFiltrationMode;
+    /** @deprecated имя группы пространства по ее id */
+    workspaceGroupNameById: Map<number, string>;
+    /** Меры уровня отчета */
     reportMeasures: TNullable<Map<string, ICommonMeasures>>;
+    /** Меры уровня пространства(из модели данных) */
     workspaceMeasures: TNullable<Map<string, Map<string, ICommonMeasures>>>;
+    /** Разрезы уровня отчета */
     reportDimensions: TNullable<Map<string, ICommonDimensions>>;
+    /** Разрезы уровня пространства(из модели данных) */
     workspaceDimensions: TNullable<Map<string, Map<string, ICommonDimensions>>>;
-    /** @deprecated удалить после окончания поддержки миграций BI-13650 */
-    workspaceGroupNameById: Map<number, string>;
-    /** Переменные отчета */
+    /** Правила отображения уровня */
+    reportDisplayRules: Map<string, IDisplayRule>;
+    /** Правила отображения уровня пространства(из модели данных) */
+    workspaceDisplayRules: Map<string, Map<string, IDisplayRule>>;
+    /** Пользовательские переменные уровня отчета */
     variables: Map<string, TWidgetVariable>;
+    /** Метод установки значения пользовательской переменной уровня отчета */
+    setVariableValue(name: string, value: TNullable<string> | string[]): void;
     /** Системные переменные */
     systemVariables: Map<string, TSystemVariable>;
-    /** Метод установки значения переменной отчета */
-    setVariableValue(name: string, value: TNullable<string> | string[]): void;
+    /** Состояния(название сущности) отчета */
     states: Map<string, ICommonState>;
-    reportName: string;
-    /** Режим отображения виджета */
-    displayMode: TDisplayMode;
-    scripts: Map<string, IActionScript>;
+    /** Процессы из модели данных */
+    processes: Map<string, IWidgetProcess>;
+    /** Имена таблиц из модели данных */
     tables: Set<string>;
-    filtrationMode: TFiltrationMode;
-    reportDisplayRules: Map<string, IDisplayRule>;
-    workspaceDisplayRules: Map<string, Map<string, IDisplayRule>>;
-    viewNameByKey: Map<string, string>;
+    /** Функция для запроса информации о колонках таблицы из модели данных */
     fetchColumnsByTableName(tableName: string): Promise<IWidgetTableColumn[] | undefined>;
+    /** Скрипты, доступные для запуска из отчета */
+    scripts: Map<string, IActionScript>;
 }
 
 declare enum EColorMode {
@@ -739,16 +769,6 @@ interface IActionUpdateVariable extends IActionCommon {
     type: EActionTypes.UPDATE_VARIABLE;
     variables: TActionOnClickParameter[];
 }
-type TActionOpenViewMode = {
-    mode: EViewMode.GENERATED_BY_SCRIPT;
-    scriptKey: string;
-    parameters: TActionOnClickParameter[];
-    displayName: string;
-} | {
-    mode: EViewMode.EXISTED_VIEW;
-    viewKey: string;
-    parameters: TActionOnClickParameter[];
-};
 type TActionOpenIn = {
     openIn: EViewOpenIn.DRAWER_WINDOW;
     alignment: EDrawerPlacement;
@@ -762,9 +782,23 @@ type TActionOpenIn = {
 } | {
     openIn: EViewOpenIn.CURRENT_WINDOW;
 };
-type TActionOpenView = {
+type TActionOpenView = IActionCommon & {
     type: EActionTypes.OPEN_VIEW;
-} & TActionOpenViewMode & TActionOpenIn & IActionCommon;
+} & (({
+    mode: EViewMode.GENERATED_BY_SCRIPT;
+    scriptKey: string;
+    parameters: TActionOnClickParameter[];
+    displayName: string;
+} & TActionOpenIn) | ({
+    mode: EViewMode.EXISTED_VIEW;
+    viewKey: string;
+    parameters: TActionOnClickParameter[];
+} & TActionOpenIn) | ({
+    mode: EViewMode.EMPTY;
+    placeholderName: string;
+} & Extract<TActionOpenIn, {
+    openIn: EViewOpenIn.PLACEHOLDER;
+}>));
 type TActionsOnClick = IActionGoToUrl | IActionRunScript | IActionUpdateVariable | TActionOpenView;
 interface IWidgetAction extends IActionCommon {
     filters: TExtendedFormulaFilterValue[];
@@ -775,6 +809,11 @@ interface IWidgetAction extends IActionCommon {
     description: string;
 }
 type TAction = TActionsOnClick | IWidgetAction;
+type TActionValidator = (action: TAction) => boolean;
+/**
+ * @deprecated Функция может работать некорректно и будет удалена в будущих версиях.
+ *  Необходимо использовать {@link IWidgetProps.actionValidator }.
+ */
 declare const isExecuteScriptActionValid: (action: Extract<TAction, {
     type: EActionTypes.EXECUTE_SCRIPT;
 }>, { scripts, tables, variables, systemVariables, }: Pick<IGlobalContext, "scripts" | "tables" | "variables" | "systemVariables">) => boolean;
@@ -862,12 +901,12 @@ declare enum ESortingValueModes {
 }
 interface ICommonState {
     name: string;
-    /** @deprecated удалить после выполнения BI-13602, задача BI-13650 */
+    /** @deprecated */
     guid: string;
 }
 interface ICommonMeasures {
     name: string;
-    /** @deprecated удалить после выполнения BI-13602, задача BI-13650 */
+    /** @deprecated */
     guid: string;
     formula: string;
 }
@@ -955,7 +994,7 @@ type TWidgetVariable = {
     defaultValue: string;
     /** Тип данных */
     dataType: ESimpleDataType;
-    /** @deprecated удалить после выполнения BI-13602, задача BI-13650 */
+    /** @deprecated */
     guid: string;
 } | {
     /** Тип переменной */
@@ -972,7 +1011,7 @@ type TWidgetVariable = {
     dataType: ESimpleDataType.STRING;
     /** Множественный выбор */
     multipleChoice: boolean;
-    /** @deprecated удалить после выполнения BI-13602, задача BI-13650  */
+    /** @deprecated */
     guid: string;
 } | {
     /** Тип переменной */
@@ -991,7 +1030,7 @@ type TWidgetVariable = {
     multipleChoice: boolean;
     /** Фильтры */
     filters: TExtendedFormulaFilterValue[];
-    /** @deprecated удалить после выполнения BI-13602, задача BI-13650  */
+    /** @deprecated */
     guid: string;
 };
 declare function isDimensionsHierarchy(indicator: IWidgetColumnIndicator): indicator is IWidgetDimensionHierarchy;
@@ -1238,12 +1277,53 @@ declare const escapeSpecialCharacters: (formula: string) => string;
 /** Удалить из строки символы экранирования */
 declare function unescapeSpecialCharacters(str: string): string;
 
+/** Фабрика вычислителей */
 interface ICalculatorFactory {
+    /**
+     * Общий вычислитель.
+     * Вычисляет любое(ограничено только ClickHouse) количество разрезов и мер.
+     * Количество строк ограничивается переданным лимитом.
+     *
+     * Подходит для большинства задач, где требуется сделать одну или несколько группировок
+     * и при необходимости посчитать показатель по каждой группе.
+     */
     general: () => IGeneralCalculator;
+    /**
+     * Вычислитель с двумя лимитами.
+     * Для работы требует ровно 2 разреза(для каждого из которых указывается свой лимит) и
+     * любое количеством мер.
+     *
+     * Используется для отображения данных в виде двумерных матриц со значениями разрезов на осях.
+     */
+    twoLimits: () => ITwoLimitsCalculator;
+    /**
+     * Вычислитель круговой диаграммы.
+     * Для работы требует ровно 1 разрез и 1 меру.
+     *
+     * В отличие от других вычислителей, считает итог по мере как сумму значений по всем строкам,
+     * а не как меру по всему объему данных. Такая особенность необходима для расчета
+     * размера оставшегося сектора круговой диаграммы.
+     */
     pie: () => IPieCalculator;
+    /**
+     * Вычислитель, предназначенный для вычисления графа по переданному процессу.
+     * Возвращает информацию о событиях процесса и связях(переходах) между ними.
+     *
+     * Может вычислять любое количество мер, отдельно для событий и переходов.
+     */
     processGraph: () => IProcessGraphCalculator;
+    /**
+     * Вычислитель гистограммы.
+     * Вычисляет "корзины" для переданного разреза.
+     */
     histogram: () => IHistogramCalculator;
-    twoLimits: () => ITwoLimitsCalculator;
+    /**
+     * Вычислитель типа для разрезов и мер.
+     * Принимает любое количество разрезов и мер.
+     *
+     * Под капотом использует general-вычислитель, оборачивая формулы в toTypeName, поэтому
+     * все переданные формулы должны использовать связанные таблицы модели данных.
+     */
     type: () => ITypeCalculator;
 }
 
@@ -1354,7 +1434,14 @@ type TAddButton = {
 };
 interface IGroupSettings extends IAutoIdentifiedArrayItem, Record<string, any> {
 }
-/** Конфигурация набора групп */
+/**
+ * Конфигурация набора групп настроек.
+ *
+ * Набор групп, как правило, представлен в настройках виджета в виде массива объектов.
+ * Каждый объект в массиве - это группа настроек.
+ *
+ * Группа отображается в виде раскрываемой плашки, может представлять из себя разрез, меру, процесс и др.
+ */
 interface IGroupSetDescription<Settings extends object, GroupSettings extends object> {
     /** Заголовок */
     title: string;
@@ -1362,49 +1449,59 @@ interface IGroupSetDescription<Settings extends object, GroupSettings extends ob
     maxCount: number;
     /** Описание доступа к настройкам групп */
     accessor: TRecordAccessor<Settings, GroupSettings[]>;
-    /** Получить тип индикатора */
-    getType?: (settings: IInitialSettings) => EWidgetIndicatorType;
-    /** Кнопки добавления группы в набор */
+    /** Конфигурация кнопок добавления группы в набор */
     addButtons: TAddButton[];
-    /** Создать элементы управления внутри группы (для вкладки настроек данных) */
+    /** Получить название, отображаемое на плашке (по умолчанию используется поле name из группы) */
+    getGroupTitle?(group: IGroupSettings): string;
+    /**
+     * Получить тип показателя для группы, если группа описывает системный показатель.
+     *
+     * Тип будет использоваться для:
+     * - отображения иконки показателя на плашке.
+     * - предустановленного мета-описания показателя.
+     */
+    getType?: (settings: IInitialSettings) => EWidgetIndicatorType;
+    /** Создать конфигурацию группы для вкладки настроек данных */
     createDataRecords?(group: IGroupSettings): TGroupLevelRecord<GroupSettings>[];
-    /** Создать элементы управления внутри группы (для вкладки настроек отображения) */
+    /** Создать конфигурацию группы для вкладки настроек отображения */
     createDisplayRecords?(group: IGroupSettings): TGroupLevelRecord<GroupSettings>[];
-    /** Получить название для плашки */
-    getGroupTitle?(group: IGroupSettings): string;
-    /** Валидная ли группа */
-    isValid?(group: IGroupSettings): boolean;
-    /** Находится ли группа в состоянии загрузки */
+    /** Находится ли группа в состоянии загрузки (по умолчанию false) */
     isLoading?(group: IGroupSettings): boolean;
-    /** Можно ли удалять группу по умолчанию true */
+    /** Является ли группа валидной (по умолчанию true) */
+    isValid?(group: IGroupSettings): boolean;
+    /** Можно ли удалить группу (по умолчанию true) */
     isRemovable?(group: IGroupSettings): boolean;
-    /** Можно ли сортировать группу по умолчанию true */
+    /** Можно ли менять порядок групп (по умолчанию true) */
     isDraggable?: boolean;
-    /** Опциональный верхний отступ для группы */
+    /** Кастомный верхний отступ для набора групп */
     marginTop?: number;
 }
-/** Конфигурация левой панели */
+/** Конфигурация панели настроек виджета */
 interface IPanelDescription<Settings extends object, GroupSettings extends IGroupSettings = IGroupSettings> {
-    /** Добавить заголовок для виджета */
+    /** Добавить поле настройки заголовка */
     useTitle?: boolean;
-    /** Добавить описание для виджета */
+    /** Добавить поле настройки описания */
     useMarkdown?: boolean;
-    /** Конфигурация настроек данных виджета */
+    /** Конфигурация вкладки настроек данных */
     dataRecords?: TWidgetLevelRecord<Settings>[];
-    /** Конфигурация настроек отображения виджета */
+    /** Конфигурация вкладки настроек отображения */
     displayRecords?: TWidgetLevelRecord<Settings>[];
-    /** Конфигурации наборов групп  */
+    /**
+     * Конфигурация наборов(каждый набор по своему ключу) с группами настроек.
+     * Описанный набор групп можно вставить по ключу в нужное место внутри dataRecords и displayRecords.
+     */
     groupSetDescriptions?: Record<string, IGroupSetDescription<Settings, GroupSettings>>;
-    /** Добавить вкладку с действиями (по умолчанию false) */
+    /** Добавить вкладку с настройками действий (по умолчанию false) */
     useActions?: boolean;
-    /** Добавить вкладку с фильтрацией (по умолчанию true) */
+    /** Добавить вкладку с настройками фильтрации (по умолчанию true) */
     useFiltration?: boolean;
-    /** Конфигурация настроек фильтров */
+    /** Конфигурация вкладки настроек фильтрации */
     filtrationRecords?: Exclude<TWidgetLevelRecord<Settings>, IGroupSetRecord>[];
-    /** Режимы фильтрации */
+    /** Доступные для выбора режимы фильтрации (во вкладке настроек фильтрации) */
     filtrationModes?: EWidgetFilterMode[];
 }
 interface IWidgetProcess {
+    /** @deprecated */
     guid: string;
     /** Имя процесса */
     name: string;
@@ -1429,7 +1526,13 @@ interface IWidgetProcess {
 interface IDivePanelDescription<Settings extends object, GroupSettings extends IGroupSettings = IGroupSettings> extends IPanelDescription<Settings, GroupSettings> {
 }
 interface IPanelDescriptionCreator<Settings extends IBaseWidgetSettings, GroupSettings extends IGroupSettings> {
-    (context: IGlobalContext, panelSettings: Settings, calculatorFactory: ICalculatorFactory): IPanelDescription<Settings, GroupSettings>;
+    (
+    /** Глобальный контекст */
+    context: IGlobalContext, 
+    /** Настройки виджета */
+    settings: Settings, 
+    /** Фабрика вычислителей */
+    calculatorFactory: ICalculatorFactory): IPanelDescription<Settings, GroupSettings>;
 }
 declare enum ESystemRecordKey {
     formatting = "formatting"
@@ -1469,16 +1572,24 @@ interface IDefinition<WidgetSettings extends IBaseWidgetSettings, GroupSettings
 }
 
 type TContextMenu = (TContextMenuList | TContextMenuButtonGroup) & {
+    /**
+     * Событие мыши, по которому пользователь открыл меню.
+     * Используется для автоматического определения позиции меню.
+     */
     event?: MouseEvent;
-    placement?: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
-    positionOrigin?: "frame" | "workArea" | HTMLElement;
-    boundingContainer?: HTMLElement;
+    /** Явно указанная позиция меню */
     position?: {
         unitX?: TContextMenuPositionUnit;
         unitY?: TContextMenuPositionUnit;
         x?: number;
         y?: number;
     };
+    /** Относительно чего позиционируется меню */
+    positionOrigin?: "frame" | "workArea" | HTMLElement;
+    /** Каким элементом ограничено расположение меню */
+    boundingContainer?: HTMLElement;
+    /** Положение меню относительно его позиции */
+    placement?: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
 };
 type TContextMenuPositionUnit = "%" | "px";
 type TContextMenuList = {
@@ -1530,14 +1641,20 @@ interface IViewInputValue {
     dataType: ESimpleDataType;
 }
 interface IViewContext {
+    /** Пользовательские переменные уровня образа */
     variables: Map<string, IViewInputValue>;
 }
 
 type TLaunchActionParams = {
+    /** Запускаемое действие */
     action: TAction;
+    /** Callback, вызываемый при успешном запуске действия */
     onSuccess: () => void;
-    filters: ICalculatorFilter[];
+    /** Требуется ли подтверждение о запуске (откроется модальное окно) */
     needConfirmation?: boolean;
+    /** Фильтрация для способов ввода COLUMN и FORMULA */
+    filters: ICalculatorFilter[];
+    /** Выбранные имена событий для способа ввода EVENT, START_EVENT и FINISH_EVENT */
     eventNames?: [string] | [string, string];
 };
 type TWidgetContainer = {
@@ -1551,48 +1668,68 @@ interface IWidgetPersistValue<T extends object = object> {
     set(value: T | null): void;
 }
 interface IWidgetProps<WidgetSettings extends IBaseWidgetSettings = IBaseWidgetSettings> {
-    /** guid виджета */
+    /** @deprecated в качестве guid используется ключ виджета(уникален в рамках образа для каждого экземпляра виджета) */
     guid: string;
     /** Настройки виджета */
     settings: WidgetSettings;
+    /** Фабрика для создания вычислителей */
+    calculatorFactory: ICalculatorFactory;
     /** Объект для взаимодействия с фильтрацией */
     filtration: IWidgetFiltration;
-    /** Функция для подписки на расфокусировку виджета */
-    subscribeOnFocusOut(subscriber: () => void): void;
-    /** Захватить фокус: остальные виджеты будут оповещены о расфокусировке */
-    captureFocus(): void;
-    /** Фабрика вычислителей. */
-    calculatorFactory: ICalculatorFactory;
+    /** Объект для работы с контейнером виджета */
+    widgetContainer: TWidgetContainer;
     /**
-     * Корневой контейнер отчета.
-     * Служит для возможности использования портала внутри виджетов.
+     * Прокручиваемая область, отображающая образ с виджетами.
+     * Служит пространством для размещения и просмотра виджетов как единого документа.
      */
     rootViewContainer: HTMLDivElement;
+    /** Функция для управления контекстными меню */
+    setContextMenu: (key: string, value: TContextMenu | null) => void;
     /** Объект для управления плейсхолдером */
     placeholder: IWidgetPlaceholderController;
     /** Объект для получения значений плейсхолдера */
     placeholderValues: IWidgetPlaceholderValues;
+    /** Функция для подписки на расфокусировку виджета (например, при фокусировке на другом виджете) */
+    subscribeOnFocusOut(subscriber: () => void): void;
+    /** Функция для захвата фокуса виджетом: остальные виджеты будут оповещены о расфокусировке */
+    captureFocus(): void;
     /** Глобальный контекст. Содержит информацию из отчета, пространства и платформы системы */
     globalContext: IGlobalContext;
     /** Контекст образа */
     viewContext: IViewContext;
-    /** Данные о контейнере виджета */
-    widgetContainer: TWidgetContainer;
-    /** Запуск действия */
+    /** Функция для запуска действия */
     launchAction(params: TLaunchActionParams): void;
-    /** Значение, сохраняемое в localStorage и URL */
+    /** Функция валидации действия */
+    actionValidator: TActionValidator;
+    /** Аксессор для persist-значения виджета, хранимого в localStorage и URL */
     persistValue: IWidgetPersistValue;
-    /** функция для управления контекстными меню */
-    setContextMenu: (key: string, value: TContextMenu | null) => void;
+}
+/** Манифест виджета */
+interface IWidgetManifest {
+    /** Уникальный идентификатор формата uuid */
+    uuid: string;
+    /** Локализация названия */
+    name: Partial<{
+        ru: string;
+        en: string;
+    }>;
+    /** Мажорная версия widget-sdk, использованная при разработке виджета */
+    sdk_version: number;
+    /** Путь до js-файла, который является входной точкой виджета */
+    entry: string;
+    /** Путь до иконки(svg или png) */
+    icon?: string;
+    /** Находится ли виджет на beta-стадии разработки */
+    is_beta?: boolean;
 }
 interface ICustomWidgetProps<WidgetSettings extends IBaseWidgetSettings = IBaseWidgetSettings> extends IWidgetProps<WidgetSettings> {
-    /** манифест виджета */
-    manifest: Record<string, any>;
+    /** Манифест виджета */
+    manifest: Partial<IWidgetManifest>;
     /** body DOM элемент родительского приложения */
     bodyElement: HTMLBodyElement;
-    /** Форматирование */
+    /** Объект для форматирования значений */
     formatting: IWidgetFormatting;
-    /** Получить ресурс виджета по имени файла */
+    /** Функция для получения ресурса виджета по имени файла */
     getWidgetAsset: (fileName: string) => Promise<Blob | null>;
 }
 interface IWidget<WidgetSettings extends IBaseWidgetSettings> {
@@ -1753,7 +1890,7 @@ declare const replaceFiltersBySelection: (filters: ICalculatorFilter[], selectio
 declare const getLocalizedText: <L extends TLocalizationDescription, P extends ILocalizationProps = TExtractLocalizationParams<L>>(language: ELanguages, locObj: L, props?: P) => string;
 
 type TDefineWidgetOptions = {
-    manifest?: Record<string, unknown>;
+    manifest?: IWidgetManifest;
 };
 declare global {
     interface Infomaximum {
@@ -1764,4 +1901,4 @@ declare global {
     }
 }
 
-export { EActionTypes, ECalculatorFilterMethods, EColorMode, EControlType, ECustomSelectTemplates, EDbType, EDimensionTemplateNames, EDisplayConditionMode, EDrawerPlacement, EDurationUnit, EEventMeasureTemplateNames, EFontWeight, EFormatTypes, EFormattingPresets, EFormulaFilterFieldKeys, EIndicatorType, ELastTimeUnit, EMarkdownDisplayMode, EMeasureTemplateNames, EProcessFilterNames, ESelectOptionTypes, ESimpleDataType, ESortDirection, ESortingValueModes, ESystemRecordKey, ETransitionMeasureTemplateNames, EUnitMode, EViewMode, EViewOpenIn, EWidgetActionInputMethod, EWidgetFilterMode, EWidgetIndicatorType, EWidgetIndicatorValueModes, type IActionGoToUrl, type IActionRunScript, type IActionScript, type IActionUpdateVariable, type IAddButtonSelectOption, type IAddDurationOfTransitionFilter, type IAddPresenceOfEventFilter, type IAddPresenceOfTransitionFilter, type IAddRepetitionOfEventFilter, type IAppearanceSettings, type IAutoIdentifiedArrayItem, 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 IColoredValue, type ICommonDimensions, type ICommonMeasures, type ICommonState, type IControlRecord, type ICustomAddButtonProps, type ICustomWidgetProps, type IDefinition, type IDimensionSelection, type IDimensionSelectionByFormula, type IDisplayPredicate, type IDisplayRule, type IDivePanelDescription, type IDividerRecord, type IEdge, type IExportColumnOrder, type IFillSettings, type IFormulaFilterValue, type IGeneralCalculator, type IGeneralCalculatorExportInput, type IGeneralCalculatorInput, type IGeneralCalculatorOutput, type IGlobalContext, type IGraphElement, type IGroupSetDescription, type IGroupSetRecord, type IGroupSettings, type IHistogramBin, type IHistogramCalculator, type IHistogramCalculatorInput, type IHistogramCalculatorOutput, type IIndicatorLink, type IInitialSettings, type ILens, type IMarkdownMeasure, type IMeasureAddButtonProps, type IPanelDescription, type IPanelDescriptionCreator, type IPieCalculator, type IPieCalculatorInput, type IPieCalculatorOutput, type IProcessEventFilterValue, type IProcessEventIndicator, type IProcessGraphCalculator, type IProcessGraphCalculatorInput, type IProcessGraphCalculatorOutput, type IProcessIndicator, type IProcessTransitionFilterValue, type IProcessTransitionIndicator, type IRange, type ISelectBranchOption, type ISelectDividerOption, type ISelectGroupOption, type ISelectLeafOption, type ISelectOption, type ISelectSystemOption, type ISortOrder, type ISortingAddButtonProps, type IStagesFilterValue, type ITwoLimitsCalculator, type ITwoLimitsCalculatorExportInput, type ITwoLimitsCalculatorInput, type ITwoLimitsCalculatorOutput, type ITypeCalculator, type ITypeCalculatorInput, type ITypeCalculatorOutput, type ITypeCalculatorOutputItem, type IVertex, type IViewContext, type IViewInputValue, type IWidget, type IWidgetAction, type IWidgetColumnIndicator, type IWidgetDimension, type IWidgetDimensionHierarchy, type IWidgetEntity, type IWidgetFilter, type IWidgetFiltration, type IWidgetFormatting, type IWidgetIndicator, type IWidgetIndicatorAddButtonProps, type IWidgetMeasure, type IWidgetPersistValue, type IWidgetPlaceholderController, type IWidgetPlaceholderValues, type IWidgetProcess, type IWidgetProps, type IWidgetSortingIndicator, type IWidgetTable, type IWidgetTableColumn, type TAction, type TActionOnClickParameter, type TActionOpenView, type TActionsOnClick, type TAddButton, type TBoundedContentWithIndicator, type TColor, type TColorRule, type TColumnIndicatorValue, type TContextMenu, type TContextMenuButton, type TContextMenuButtonActions, type TContextMenuButtonApply, type TContextMenuButtonClose, type TContextMenuButtonCustom, type TContextMenuButtonGroup, type TContextMenuButtonOptions, type TContextMenuList, type TContextMenuPositionUnit, type TContextMenuRow, type TCustomAddButtonSelectOption, type TDefineWidgetOptions, type TDisplayCondition, type TDisplayMode, type TEmptyRecord, type TExtendedFormulaFilterValue, type TFiltrationMode, type TGroupLevelRecord, type TLaunchActionParams, type TMeasureAddButtonSelectOption, type TProcessIndicatorValue, type TRecordAccessor, type TSelectChildOptions, type TSelectFetchOptions, type TSelectivePartial, type TSortDirection, type TSystemVariable, type TUpdateSelection, type TValuePath, type TWidgetActionParameter, type TWidgetContainer, type TWidgetFilterValue, type TWidgetFiltering, type TWidgetLevelRecord, type TWidgetSortingValue, type TWidgetVariable, bindContentWithIndicator, bindContentsWithIndicators, checkDisplayCondition, dashboardLinkRegExp, dimensionTemplateFormulas, escapeSpecialCharacters, eventMeasureTemplateFormulas, fillTemplateString, formattingConfig, formulaFilterMethods, generateColumnFormula, getDimensionFormula, getDisplayConditionFormula, getEventMeasureFormula, getLocalizedText, getMeasureFormula, getRuleColor, getTransitionMeasureFormula, isDimensionsHierarchy, isExecuteScriptActionValid, isFormulaFilterValue, isValidColor, linkNameRegExp, mapDimensionsToInputs, mapEventMeasuresToInputs, mapFormulaFilterToCalculatorInput, mapFormulaFiltersToInputs, mapMeasuresToInputs, mapSortingToInputs, mapTransitionMeasuresToInputs, measureTemplateFormulas, parseIndicatorLink, prepareValuesForSql, replaceDisplayCondition, replaceFiltersBySelection, replaceHierarchiesWithDimensions, selectDimensionFromHierarchy, transitionMeasureTemplateFormulas, unescapeSpecialCharacters, updateDefaultModeSelection, updateMultiModeSelection, updateSingleModeSelection, workspaceLinkRegExp };
+export { EActionTypes, ECalculatorFilterMethods, EColorMode, EControlType, ECustomSelectTemplates, EDbType, EDimensionTemplateNames, EDisplayConditionMode, EDrawerPlacement, EDurationUnit, EEventMeasureTemplateNames, EFontWeight, EFormatTypes, EFormattingPresets, EFormulaFilterFieldKeys, EIndicatorType, ELastTimeUnit, EMarkdownDisplayMode, EMeasureTemplateNames, EProcessFilterNames, ESelectOptionTypes, ESimpleDataType, ESortDirection, ESortingValueModes, ESystemRecordKey, ETransitionMeasureTemplateNames, EUnitMode, EViewMode, EViewOpenIn, EWidgetActionInputMethod, EWidgetFilterMode, EWidgetIndicatorType, EWidgetIndicatorValueModes, type IActionGoToUrl, type IActionRunScript, type IActionScript, type IActionUpdateVariable, type IAddButtonSelectOption, type IAddDurationOfTransitionFilter, type IAddPresenceOfEventFilter, type IAddPresenceOfTransitionFilter, type IAddRepetitionOfEventFilter, type IAppearanceSettings, type IAutoIdentifiedArrayItem, 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 IColoredValue, type ICommonDimensions, type ICommonMeasures, type ICommonState, type IControlRecord, type ICustomAddButtonProps, type ICustomWidgetProps, type IDefinition, type IDimensionSelection, type IDimensionSelectionByFormula, type IDisplayPredicate, type IDisplayRule, type IDivePanelDescription, type IDividerRecord, type IEdge, type IExportColumnOrder, type IFillSettings, type IFormulaFilterValue, type IGeneralCalculator, type IGeneralCalculatorExportInput, type IGeneralCalculatorInput, type IGeneralCalculatorOutput, type IGlobalContext, type IGraphElement, type IGroupSetDescription, type IGroupSetRecord, type IGroupSettings, type IHistogramBin, type IHistogramCalculator, type IHistogramCalculatorInput, type IHistogramCalculatorOutput, type IIndicatorLink, type IInitialSettings, type ILens, type IMarkdownMeasure, type IMeasureAddButtonProps, type IPanelDescription, type IPanelDescriptionCreator, type IPieCalculator, type IPieCalculatorInput, type IPieCalculatorOutput, type IProcessEventFilterValue, type IProcessEventIndicator, type IProcessGraphCalculator, type IProcessGraphCalculatorInput, type IProcessGraphCalculatorOutput, type IProcessIndicator, type IProcessTransitionFilterValue, type IProcessTransitionIndicator, type IRange, type ISelectBranchOption, type ISelectDividerOption, type ISelectGroupOption, type ISelectLeafOption, type ISelectOption, type ISelectSystemOption, type ISortOrder, type ISortingAddButtonProps, type IStagesFilterValue, type ITwoLimitsCalculator, type ITwoLimitsCalculatorExportInput, type ITwoLimitsCalculatorInput, type ITwoLimitsCalculatorOutput, type ITypeCalculator, type ITypeCalculatorInput, type ITypeCalculatorOutput, type ITypeCalculatorOutputItem, type IVertex, type IViewContext, type IViewInputValue, type IWidget, type IWidgetAction, type IWidgetColumnIndicator, type IWidgetDimension, type IWidgetDimensionHierarchy, type IWidgetEntity, type IWidgetFilter, type IWidgetFiltration, type IWidgetFormatting, type IWidgetIndicator, type IWidgetIndicatorAddButtonProps, type IWidgetManifest, type IWidgetMeasure, type IWidgetPersistValue, type IWidgetPlaceholderController, type IWidgetPlaceholderValues, type IWidgetProcess, type IWidgetProps, type IWidgetSortingIndicator, type IWidgetTable, type IWidgetTableColumn, type TAction, type TActionOnClickParameter, type TActionOpenView, type TActionValidator, type TActionsOnClick, type TAddButton, type TBoundedContentWithIndicator, type TColor, type TColorRule, type TColumnIndicatorValue, type TContextMenu, type TContextMenuButton, type TContextMenuButtonActions, type TContextMenuButtonApply, type TContextMenuButtonClose, type TContextMenuButtonCustom, type TContextMenuButtonGroup, type TContextMenuButtonOptions, type TContextMenuList, type TContextMenuPositionUnit, type TContextMenuRow, type TCustomAddButtonSelectOption, type TDefineWidgetOptions, type TDisplayCondition, type TDisplayMode, type TEmptyRecord, type TExtendedFormulaFilterValue, type TFiltrationMode, type TGroupLevelRecord, type TLaunchActionParams, type TMeasureAddButtonSelectOption, type TProcessIndicatorValue, type TRecordAccessor, type TSelectChildOptions, type TSelectFetchOptions, type TSelectivePartial, type TSortDirection, type TSystemVariable, type TUpdateSelection, type TValuePath, type TWidgetActionParameter, type TWidgetContainer, type TWidgetFilterValue, type TWidgetFiltering, type TWidgetLevelRecord, type TWidgetSortingValue, type TWidgetVariable, bindContentWithIndicator, bindContentsWithIndicators, checkDisplayCondition, dashboardLinkRegExp, dimensionTemplateFormulas, escapeSpecialCharacters, eventMeasureTemplateFormulas, fillTemplateString, formattingConfig, formulaFilterMethods, generateColumnFormula, getDimensionFormula, getDisplayConditionFormula, getEventMeasureFormula, getLocalizedText, getMeasureFormula, getRuleColor, getTransitionMeasureFormula, isDimensionsHierarchy, isExecuteScriptActionValid, isFormulaFilterValue, isValidColor, linkNameRegExp, mapDimensionsToInputs, mapEventMeasuresToInputs, mapFormulaFilterToCalculatorInput, mapFormulaFiltersToInputs, mapMeasuresToInputs, mapSortingToInputs, mapTransitionMeasuresToInputs, measureTemplateFormulas, parseIndicatorLink, prepareValuesForSql, replaceDisplayCondition, replaceFiltersBySelection, replaceHierarchiesWithDimensions, selectDimensionFromHierarchy, transitionMeasureTemplateFormulas, unescapeSpecialCharacters, updateDefaultModeSelection, updateMultiModeSelection, updateSingleModeSelection, workspaceLinkRegExp };

package/dist/index.esm.js

@@ -40,6 +40,10 @@ var EDrawerPlacement;
     EDrawerPlacement["LEFT"] = "LEFT";
     EDrawerPlacement["RIGHT"] = "RIGHT";
 })(EDrawerPlacement || (EDrawerPlacement = {}));
+/**
+ * @deprecated Функция может работать некорректно и будет удалена в будущих версиях.
+ *  Необходимо использовать {@link IWidgetProps.actionValidator }.
+ */
 var isExecuteScriptActionValid = function (action, _a) {
     var _b;
     var scripts = _a.scripts, tables = _a.tables, variables = _a.variables, systemVariables = _a.systemVariables;

package/dist/index.js

@@ -41,6 +41,10 @@ exports.EDrawerPlacement = void 0;
     EDrawerPlacement["LEFT"] = "LEFT";
     EDrawerPlacement["RIGHT"] = "RIGHT";
 })(exports.EDrawerPlacement || (exports.EDrawerPlacement = {}));
+/**
+ * @deprecated Функция может работать некорректно и будет удалена в будущих версиях.
+ *  Необходимо использовать {@link IWidgetProps.actionValidator }.
+ */
 var isExecuteScriptActionValid = function (action, _a) {
     var _b;
     var scripts = _a.scripts, tables = _a.tables, variables = _a.variables, systemVariables = _a.systemVariables;

package/package.json

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