@docsvision/webclient 5.17.0-beta.9 → 5.17.0

package/System/IEditOperationStore.d.ts

@@ -0,0 +1,29 @@
+import { IEditOperation } from "@docsvision/webclient/System/IEditOperation";
+/**
+ * Содержит данные и методы хранилища операций редактирования.
+ */
+export interface IEditOperationStore {
+    /**
+     * Проверяет доступность операции редактирования.
+     * @param operation ИД операции редактирования / ИД встроенной операции редактирования / Наименование операции редактирования по умолчанию.
+     * @returns true - операция доступна, false - операция не доступна.
+     */
+    available(operation: string): boolean;
+    /**
+     * Возвращает операцию редактирования с указанным идентификатором.
+     * @param id Идентификатор операции редактирования.
+     * @returns Операция редактирования.
+     * @deprecated Используйте метод resolve(editOperation: string) вместо него.
+     */
+    get(id: string): IEditOperation;
+    /**
+     * Возвращает все операции редактирования, зарегистрированные в *Конструкторе состояний* для текущего вида карточки.
+     * @returns Массив операций редактирования.
+     */
+    getAll(): IEditOperation[];
+    /**
+     * Возвращает операцию редактирования по значению, полученному с сервера
+     * @param editOperation Строковое обозначение операции редактирования, будь то operationId, builtInOperationId или alias
+     */
+    resolve(editOperation: string): IEditOperation;
+}

package/System/IEventArgs.d.ts

@@ -0,0 +1,3 @@
+/** Базовый интерфейс параметров событий. */
+export interface IEventArgs {
+}

package/System/IExtension.d.ts

@@ -0,0 +1,29 @@
+import { IControlDescription } from '@docsvision/webclient/System/IControlDescription';
+import { EventHandlersMap } from '@docsvision/webclient/System/EventHandlersMap';
+import { ILocalizationsMap } from "@docsvision/webclient/System/ILocalizationsMap";
+import { IUrlCollection } from "@docsvision/webclient/System/IUrlCollection";
+import { Service } from "@docsvision/web/core/services";
+/** Интерфейс расширения Web-клиента. */
+export interface IExtension extends Partial<IUrlCollection> {
+    /** Уникальное название расширения, которое будет отображаться в окне About. */
+    readonly name: string;
+    /** Версия расширения в произвольном формате. */
+    readonly version: string;
+    /** Вызывается после инициализации приложения. */
+    initialize?(): any;
+    /** Служит для добавления локализаций в {@link resources} */
+    getLocalizations?(): ILocalizationsMap;
+    /** Контролы, поставляемые с расширением. */
+    readonly controls?: IControlDescription[];
+    /**
+     * Обработчики событий.
+     *
+     * Пример использования:
+     *
+     */
+    readonly globalEventHandlers?: EventHandlersMap[];
+    /** Сервисы, используемые во всем приложении. */
+    readonly globalServices?: Service[];
+    /** Сервисы, имеющие особое поведение в рамках каждой конкретной разметки. */
+    readonly layoutServices?: Service[];
+}

package/System/IExtensionManager.d.ts

@@ -0,0 +1,11 @@
+import { IExtension } from "@docsvision/webclient/System/IExtension";
+/** Класс для управления клиентскими расширениями Web-клиента. */
+export interface IExtensionManager {
+    registerExtension(extension: IExtension): void;
+    loadExtensions(): any;
+    readonly extensions: IExtension[];
+}
+export declare type $ExtensionManager = {
+    extensionManager: IExtensionManager;
+};
+export declare const $ExtensionManager: string | ((model?: $ExtensionManager) => IExtensionManager);

package/System/IFocusEventArgs.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+export interface IFocusEventArgs extends React.FocusEvent<any> {
+}

package/System/IKeyboardEventArgs.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+/** Интерфейс события {@link InputBasedControlParams.inputKeyDown}. */
+export declare type IKeyboardEventArgs = React.KeyboardEvent<any>;

package/System/ILayoutBootstrapperParams.d.ts

@@ -0,0 +1,4 @@
+/** @deprecated */
+export interface ILayoutBootstrapperParams {
+    rootElementId: string;
+}

package/System/ILayoutContainer.d.ts

@@ -0,0 +1,48 @@
+import { GenModels } from "@docsvision/webclient/Generated/DocsVision.WebClient.Models";
+import { ILayout } from "@docsvision/webclient/System/$Layout";
+export interface ILayoutContainer<T extends GenModels.LayoutViewModel> {
+    /**
+     * Возвращает разметку карточки.
+     */
+    layout: ILayout;
+    /**
+     * Скрывать ли диалог подтверждения действия пользователя при изменении маршрута
+     */
+    pageLeaveConfirmationDisabled: boolean;
+    /**
+     * Возвращает родительский контейнер, в котором находится текущий контейнер
+     */
+    readonly parent: ILayoutContainer<GenModels.LayoutViewModel>;
+    /**
+     * Возвращает наименование позиции разметки
+     */
+    readonly positionName: string;
+    /**
+     * Возвращает наименование разметки
+     */
+    readonly name: string;
+    /**
+     * Возвращает наименования дочерних разметок
+     */
+    children: ILayoutContainer<GenModels.LayoutViewModel>[];
+    /**
+     * Возвращает идентификатор корневого элемента, в котором расположена разметка.
+     */
+    readonly rootElementId: string;
+    /**
+     * Возвращает корневой элемент, в котором расположена разметка.
+     */
+    readonly rootElement: HTMLElement;
+    /**
+     *  Модель разметки, поступившая с сервера Web-клиента.
+     */
+    readonly layoutViewModel: T;
+    /**
+     * Перезагрузка разметки с данными, переданными в параметре layoutViewModel
+     */
+    reload(layoutViewModel: T): Promise<void>;
+    /**
+     * Уничтожение разметки.
+     */
+    destroy(): Promise<any>;
+}

package/System/ILayoutContainerInfo.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @internal
+ */
+export interface ILayoutContainerInfo {
+    /**
+     * Уникальный идентификатор разметки в контейнере
+     */
+    id: string;
+    /**
+     * Идентификатор родительской разметки
+     */
+    parentId: string;
+    /**
+     * Идентификаторы дочерних разметок
+     */
+    childrenIds: string[];
+    /**
+     * Скрывать ли диалог подтверждения действия пользователя при изменении маршрута
+     */
+    pageLeaveConfirmationDisabled: boolean;
+}

package/System/ILayoutContainerMap.d.ts

@@ -0,0 +1,5 @@
+import { LayoutContainer } from "@docsvision/webclient/System/LayoutContainer";
+/** @internal */
+export interface ILayoutContainerMap {
+    [id: string]: LayoutContainer<any> | undefined;
+}

package/System/ILayoutContainerParams.d.ts

@@ -0,0 +1,25 @@
+import { GenModels } from "@docsvision/webclient/Generated/DocsVision.WebClient.Models";
+import { LayoutContainer } from '@docsvision/webclient/System/LayoutContainer';
+import { ServiceContainer } from "@docsvision/web/core/services";
+/**
+ * Параметры для создания экземпляра класса {@link LayoutContainer}.
+ */
+export interface ILayoutContainerParams<T extends GenModels.LayoutViewModel> {
+    /** Идентификатор DOM-элемента, в котором необходимо расположить разметку. Вместо этого параметра можно передать сам элемент в {@link rootElement}. */
+    rootElementId?: string;
+    /** DOM-элемент, в котором необходимо расположить разметку. Вместо этого параметра можно передать id элемента в {@link rootElementId}. */
+    rootElement?: HTMLElement;
+    /** Уникальное имя разметки. */
+    name: string;
+    parent?: LayoutContainer<GenModels.LayoutViewModel>;
+    /** Список имён дочерних компонентов. */
+    children: string[];
+    /** Тип разметки (служит для идентификации файла разметки на сервере). */
+    positionName: string;
+    /** Вызывается перед выгрузкой разметки. */
+    unmountCallback: (layoutContainer: LayoutContainer<GenModels.LayoutViewModel>) => void;
+    /** Модель разметки, содержащая описание контролов. */
+    layoutCardModel: T;
+    layoutViewModel: T;
+    services?: ServiceContainer;
+}

package/System/ILayoutManagerParams.d.ts

@@ -0,0 +1,6 @@
+/** @deprecated */
+export interface ILayoutManagerParams {
+    rootElementId: string;
+    applicationTimestamp: number;
+    siteUrl: string;
+}

package/System/ILayoutParams.d.ts

@@ -0,0 +1,48 @@
+import { GenModels } from "@docsvision/webclient/Generated/DocsVision.WebClient.Models";
+import { $StandardControllers } from "@docsvision/webclient/Legacy/StandardControllers";
+import { $StandardServices } from "@docsvision/webclient/StandardServices";
+import { LayoutControl } from '@docsvision/webclient/System/BaseControl';
+import { ILayout, SaveCardOptions } from "@docsvision/webclient/System/$Layout";
+import { SaveControlDataModelEventArgs } from "@docsvision/webclient/System/Layout";
+import { BasicApiEvent, CancelableApiEvent } from "@docsvision/webclient/System/ApiEvent";
+import { ICardStateChangingEventArgs } from "@docsvision/webclient/System/ICardStateChangingEventArgs";
+import { IEventArgs } from "@docsvision/webclient/System/IEventArgs";
+export interface ILayoutSavedEventArgs extends IEventArgs {
+    options: SaveCardOptions;
+    bindings?: Array<GenModels.BindingsWriteRequest>;
+}
+export interface ILayoutPrepareSavingEventArgs extends IEventArgs {
+    options: SaveCardOptions;
+    control?: LayoutControl;
+}
+export declare type ILayoutBeforeSavingEventArgs = ILayoutPrepareSavingEventArgs;
+/**
+ * Публичные свойства для контрола {@link Layout}.
+ */
+export interface ILayoutParams {
+    /** Название разметки. */
+    readonly layoutName: string;
+    /** Владелец разметки. */
+    readonly owner?: ILayout;
+    /** Дочерние разметки. */
+    readonly childLayouts?: ILayout[];
+    /** Событие возникает при открытии карточки. */
+    cardOpening?: CancelableApiEvent<IEventArgs>;
+    /** Событие возникает после открытия карточки. */
+    cardOpened?: BasicApiEvent<IEventArgs>;
+    /** Событие возникает при сохранении карточки после получения значения элементов управления. */
+    cardSaving?: CancelableApiEvent<SaveControlDataModelEventArgs>;
+    /** Событие возникает при сохранении карточки, до получения значения элементов управления. */
+    prepareCardSaving?: CancelableApiEvent<ILayoutPrepareSavingEventArgs>;
+    /** Событие возникает после сохранения карточки. */
+    cardSaved?: CancelableApiEvent<ILayoutSavedEventArgs>;
+    /** Событие возникает, если при сохранении карточки возникли ошибки. */
+    cardSaveFailed?: BasicApiEvent<IEventArgs>;
+    /** Событие возникает перед изменением состояния карточки. */
+    cardStateChanging?: CancelableApiEvent<ICardStateChangingEventArgs>;
+    /** Событие возникает перед изменением разметки карточки. */
+    cardLayoutSwitching?: CancelableApiEvent<IEventArgs>;
+    /** Событие возникает перед изменением разметки карточки. */
+    layoutWillUnmount?: BasicApiEvent<IEventArgs>;
+    services?: $StandardServices & $StandardControllers;
+}

package/System/ILocalizationsMap.d.ts

@@ -0,0 +1,5 @@
+import { IResourcesMap } from "@docsvision/webclient/System/IResourcesMap";
+/** См. {@link BasicExtension.getLocalizations}. */
+export interface ILocalizationsMap {
+    [id: string]: IResourcesMap;
+}

package/System/IMouseOutEventArgs.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+export interface IMouseOutEventArgs extends React.MouseEvent<any> {
+}

package/System/IMouseOverEventArgs.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+export interface IMouseOverEventArgs extends React.MouseEvent<any> {
+}

package/System/INotificationModel.d.ts

@@ -0,0 +1,6 @@
+import { ErrorNotificationType } from "@docsvision/webclient/Legacy/ErrorNotificationType";
+/** @deprecated */
+export interface INotificationModel {
+    type: ErrorNotificationType;
+    text: string;
+}

package/System/IProxyControl.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+/** @internal */
+export interface IProxyControl {
+    isProxyControl: boolean;
+    renderProxyChildren(): React.ReactNode[];
+}

package/System/IRealTimeCommunicationMessage.d.ts

@@ -0,0 +1,17 @@
+/** Сообщение обмена данными с сервером и между вкладками в режиме реального времени. */
+export interface IRealTimeCommunicationMessage<T> {
+    /** Данные сообщения. */
+    Data?: T;
+    /** Уникальный идентификатор типа сообщения. */
+    MessageType: string;
+    /** Уникальный идентификатор экземпляра сообщения. */
+    MessageId?: string;
+    /** Идентификаторы вкладок получателей, или null если сообщение адресовано всем вкладкам. */
+    TargetTabs?: string[];
+    /** Сообщение  направлено к серверу. */
+    TargetServer?: boolean;
+    /** Идентификатор отправленного события. Если сообщение от сервера, то null. */
+    SenderTab?: string;
+    /** Временная метка создания сообщения. */
+    Timestamp?: Date;
+}

package/System/IRealtimeCommunicationHub.d.ts

@@ -0,0 +1,15 @@
+import { IRealTimeCommunicationMessage } from "@docsvision/webclient/System/IRealTimeCommunicationMessage";
+/** @internal */
+export interface IRealtimeCommunicationHub {
+    client: IRealtimeCommunicationHubClient;
+    server: IRealtimeCommunicationHubServer;
+}
+/** @internal */
+export interface IRealtimeCommunicationHubServer {
+    register(employeeId: string, employeeAccountName: string, sessionId: string): Promise<any>;
+    sendMessage(message: IRealTimeCommunicationMessage<string>): Promise<any>;
+}
+/** @internal */
+export interface IRealtimeCommunicationHubClient {
+    sendMessage<T>(message: IRealTimeCommunicationMessage<T>): any;
+}

package/System/IRequestInfo.d.ts

@@ -0,0 +1,5 @@
+/** @internal */
+export declare enum RequestMethods {
+    Post = 0,
+    Get = 1
+}

package/System/IResourcesMap.d.ts

@@ -0,0 +1,4 @@
+/** Словарь локализаций. */
+export interface IResourcesMap {
+    [id: string]: string;
+}

package/System/IRouteFamily.d.ts

@@ -0,0 +1,6 @@
+export interface IRouteFamily {
+    routeTypes: string[];
+    newEdit: string;
+    edit: string;
+    view: string;
+}

package/System/IRouteHandler.d.ts

@@ -0,0 +1,60 @@
+import { RouteHandleResult } from "@docsvision/webclient/System/RouteHandleResult";
+import { RouteType } from "@docsvision/webclient/System/RouteType";
+import { RouteSemantics } from '@docsvision/webclient/System/RouteSemantics';
+/**
+ * Обработчик роута, который собирает и загружает данные роута, а также отображает содержимое в UI.
+ *
+ * При реализации его методов следует учитывать следующие ньюансы:
+ *
+ * 1. Прежде читать значения каких-либо свойств в RouteData, необходимо проверить, что они там есть.
+ * Если их нет (и они критичны для работы хандлера), то следует вернуть RouteHandleResults.MissingRequiredData. Например:
+ *
+ *         if (RouteHelpers.someIsUndefined(routeData.gridModel)) {
+ *             return RouteHandleResults.MissingRequiredData;
+ *         }
+ *
+ * 2. Прежде чем вычислять и записывать какие-то значения в RouteData, необходимо проверить, нет ли их там. Если они уже есть, то нужно ничего не делать.
+ *    Это связано с тем, что хандлер может вызываться многократно, и он не должен выполнять работу, которая уже выполнена.
+ *    Например, у нас уже загружено содержимое грида папки, и мы хотим только поменять заголовок.
+ *    В этом случае запустятся все хандлеры, но загружать данные папки нет необходимости.
+ *    Если нам понадобится обновить содержимое грида, то следует очистить соответствующее свойство в информации о роуте и вызвать setCurrentRoute.
+ *    Тогда соответствующий хандлер увидит, что свойство пустое и заново загрузит эти данные.
+ * 3. Хандлер должен выполнять только одну, как можно меньшую задачу.
+ *    Должно быть легко сформулировать эту задачу в двух словах, она должна быть понятна из названия.
+ *
+ * Регистрируются хандлеры после объявления класса следующим образом:
+ *
+ *       export class MyRouteHandler implements IRouteHandler<IFolderRouteData> {
+ *            ...
+ *       }
+ *
+ *       SammyHelper.RouterInitialization.subscribe((sammy: SammyHelper) => {
+ *           sammy.addHandler(StandardRoutes.AllRoutes, new MyRouteHandler());
+ *       });
+ *
+ * @param T Тип данных роута. Например, {@link IFolderRouteData}.
+ */
+export interface IRouteHandler<T> {
+    /** Имя хандлера для отладочных целей. */
+    name: string;
+    /** Порядок среди других хандлеров.  По умолчанию 1. */
+    order?: number;
+    /**
+     * Подготавливает информацию, которая необходима для загрузки основной информации роута.
+     * Например, при открытии папки в этом обработчике собирается информация о представлении, фильтре, сортировке и т.д.
+     */
+    prepareRouteDataLoad?(routeData: Partial<T>, routeType: RouteType, routeSemantics?: RouteSemantics): Promise<RouteHandleResult>;
+    /** Загружает основную информацию роута. */
+    loadRouteData?(routeData: Partial<T>, routeType: RouteType, routeSemantics?: RouteSemantics): Promise<RouteHandleResult>;
+    /** Делает предварительную обработку загруженной информации, перед тем как ее отображать. */
+    prepareRouteMount?(routeData: T, routeType: RouteType, routeSemantics?: RouteSemantics): Promise<RouteHandleResult>;
+    /** Отображает содержимое роута в UI. */
+    mountRoute?(data: T, routeType: RouteType, routeSemantics?: RouteSemantics): Promise<RouteHandleResult>;
+    /** Очищает UI от содержимого роута, освобождает все занятые ресурсы (таймеры, подписки на события и т.д.). */
+    unmountRoute?(data: T, routeType: RouteType, routeSemantics?: RouteSemantics): Promise<{} | void>;
+    /** Содердит логику отмены выполнения обработчика */
+    cancelRouteProcessing?(): Promise<{}>;
+}
+export declare const AFTER_STANDARD_HANDLERS = 1000;
+export declare const BEFORE_STANDARD_HANDLERS = -1000;
+export declare const STANDARD_HANDLERS_ORDER = 1;

package/System/IRouteInfo.d.ts

@@ -0,0 +1,23 @@
+import { RouteType } from "@docsvision/webclient/System/RouteType";
+import { RouteSemantics } from '@docsvision/webclient/System/RouteSemantics';
+/** Информация о роута и его оперативные данные. */
+export interface IRouteInfo<T> {
+    routeSemantics: RouteSemantics;
+    /** Уникальный идентификатор тип роута, определяющий его структуру данных. */
+    routeType: RouteType;
+    /**
+     * Значение, которое позволяет отличить один роут от другого при одном и том же routeType.
+     * Значение представляет собой некоторую строку, которая вычисляется на основе
+     * существенных параметров роута. Например, в роуте папки существенным параметром
+     * является id папки, т.к. при его смене необходимо закрыть текущую папку и открыть другую.
+     */
+    identity: string;
+    /** Оперативные данные роута. */
+    data: T;
+    /** Флаг, свидетельствующий о том что пользователь запросил отмену обработки роута. */
+    cancelRequested?: boolean;
+    /** Флаг, свидетельствующий о том, что роут был размонтирован. */
+    unmounted?: boolean;
+    /** Если флаг установлен, то роут не будет сохранен в истории браузера. */
+    temporary?: boolean;
+}

package/System/IRouteTypeMapper.d.ts

@@ -0,0 +1,27 @@
+import { IRouteInfo } from "@docsvision/webclient/System/IRouteInfo";
+import { RouteParameters } from "@docsvision/webclient/System/RouteParameters";
+/** Интерфейс для классов, сопоставляющий url на тип роута. Для регистрации маппера используется метод {@link SammyHelper.addRouteTypeMapper} */
+export interface IRouteTypeMapper<T> {
+    /**
+     * Должно возвращать описание [пути роута для SammyJS](http://sammyjs.org/docs/routes).
+     *
+     * При реализации можно использовать методы класса {@link RouteHelpers}, например:
+     *
+     *      // В результате получится #/Folder/:FolderId
+     *      hashPattern = RouteHelpers.makeHashPattern('#/Folder/', [FolderRouteParameters.FolderId]);
+     *
+     */
+    readonly hashPattern: string;
+    /**
+     * При реализации должен анализировать параметры роута и формировать начальный RouteData объект.
+     * Допустим, если у нас роут папки, то мы извлекаем из url id папки, проверяем
+     * что это корректный id, и возвращаем объект {@link IFolderRouteData} с заполненным `folderId`.
+     * @param path Путь текущего роута, включая имя приложения, хэш, и query-параметры.
+     * Например: `/DocsvisionWebClient/#/Folder/5bf0fb94-23fa-4212-80c3-c598e9859901?Color=folder-default`
+     * @param parameters Объединяют в себе как параметры указанные через двоеточие в hashPattern,
+     * так и query-параметры, добавленные через знак вопроса (после #).
+     */
+    resolve(path: string, parameters: RouteParameters): Promise<IRouteInfo<T>> | Promise<undefined>;
+    /** Используется в том случае, если мы вызываем SammyHelper.setCurrentRoute для того, чтобы обновить url в браузере. */
+    tryGetUrl(route: IRouteInfo<T>): string | undefined;
+}

package/System/IServiceActionParameterInfo.d.ts

@@ -0,0 +1,5 @@
+/** @internal */
+export interface IServiceActionParameterInfo {
+    index: number;
+    name: string;
+}

package/System/ISupportEventBubling.d.ts

@@ -0,0 +1,22 @@
+import { IBasicEvent } from "@docsvision/webclient/System/IBasicEvent";
+import { IEventArgs } from "@docsvision/webclient/System/IEventArgs";
+/** @internal */
+export declare enum BubblingEventResult {
+    Continue = 0,
+    StopPropagation = 1
+}
+/** @internal */
+export interface IBubblingEventInfo {
+    name?: string;
+    bubbling: boolean;
+}
+/** @internal */
+export declare type BubblingEventCallback = (actualSender: ISupportEventBubbling, args: IEventArgs) => BubblingEventResult | void;
+/** @internal */
+export interface ISupportEventBubbling {
+    supportEventBubbling: boolean;
+    getEventInfo<T>(event: IBasicEvent<T>): IBubblingEventInfo;
+    triggerBubblingEvent<T>(eventName: string, actualSender: ISupportEventBubbling, args: T): any;
+    subscribeToBubblingEvent(eventName: string, callback: BubblingEventCallback): any;
+    unsubscribeFromBubblingEvent(eventName: string, callback: BubblingEventCallback): any;
+}

package/System/IUrlCollection.d.ts

@@ -0,0 +1,5 @@
+import { IUrlMap } from "@docsvision/webclient/System/IUrlMap";
+import { UrlResolver } from "@docsvision/webclient/System/UrlResolver";
+export interface IUrlCollection {
+    getUrls(urlResolver: UrlResolver): IUrlMap;
+}

package/System/IUrlMap.d.ts

@@ -0,0 +1,3 @@
+export interface IUrlMap {
+    [id: string]: string;
+}

package/System/IValidateEventArgs.d.ts

@@ -0,0 +1,9 @@
+import { LayoutControl } from "@docsvision/webclient/System/BaseControl";
+import { IEventArgs } from "@docsvision/webclient/System/IEventArgs";
+import { IValidationParams } from "@docsvision/webclient/System/IValidationParams";
+import { IValidationResult } from "@docsvision/webclient/System/IValidationResult";
+export interface IValidateEventArgs extends IEventArgs {
+    control: LayoutControl;
+    validationResults: IValidationResult[];
+    params: IValidationParams;
+}

package/System/IValidationParams.d.ts

@@ -0,0 +1,5 @@
+/** Параметры запуска валидации элемента управления. */
+export interface IValidationParams {
+    /** Показывать ли в интерфейсе элемента управления сообщение об ошибке. */
+    ShowErrorMessage: boolean;
+}

package/System/IValidationResult.d.ts

@@ -0,0 +1,11 @@
+/** Результат валидации контрола. */
+export interface IValidationResult {
+    /** Валидация была успешно пройдена. */
+    Passed: boolean;
+    /** Сообщение об ошибке. */
+    Message?: string;
+    /** Имя контрола, сгенерировавшего объект. */
+    ControlName?: string;
+    /** Флаг видимости контрола. */
+    Visibility?: boolean;
+}

package/System/IWebServicesConnection.d.ts

@@ -0,0 +1,14 @@
+import { IWebServicesRequest } from '@docsvision/webclient/System/IWebServicesRequest';
+/** Класс для взаимоедйствия с агентом веб-сервисов через веб-сокеты. {@see IWebServicesService} */
+export interface IWebServicesConnection {
+    /** Наименование роута плагина, с которым открыто соединение. */
+    readonly plugin: string;
+    /** Проверяет, что подключение открыто. */
+    readonly isOpen: boolean;
+    /** Отправляет запрос в агент. */
+    send<T>(message: IWebServicesRequest<T>): void;
+    /** Возвращает ответ агента, после его получения. */
+    waitForMessage<T>(): Promise<T>;
+    /** Закрывает соединение. */
+    close(): void;
+}

package/System/IWebServicesInfo.d.ts

@@ -0,0 +1,3 @@
+export interface IWebServicesInfo {
+    version: string;
+}

package/System/IWebServicesRequest.d.ts

@@ -0,0 +1,10 @@
+export interface IWebServicesRequest<T> {
+    /** Действие плагина, которое необходимо выполнить. */
+    action?: string;
+    /** JavaScript объект, содержащий параметры запроса */
+    data?: T;
+    /** Двухбуквенный ISO-код культуры. */
+    locale: string;
+    /** Закрывать ли DVWebTool после вызова. */
+    exitAfterCall: boolean;
+}

package/System/IWebServicesResponse.d.ts

@@ -0,0 +1,8 @@
+export interface IWebServicesResponse<T> {
+    /** Выполнился ли запрос успешно. */
+    success: boolean;
+    /** Сообщение об ошибке, в случае если {@link success} = false. */
+    errorMessage?: string;
+    /** JavaScript объект, содержащий результаты выполнения запроса */
+    data?: T;
+}

package/System/IWebServicesService.d.ts

@@ -0,0 +1,35 @@
+import { RequestOptions } from '@docsvision/webclient/Legacy/Utils';
+import { IWebServicesConnection } from '@docsvision/webclient/System/IWebServicesConnection';
+import { IWebServicesInfo } from '@docsvision/webclient/System/IWebServicesInfo';
+import { IWebServicesRequest } from '@docsvision/webclient/System/IWebServicesRequest';
+/** Реализует взаимодействие с агентом веб-сервисов. */
+export interface IWebServicesService {
+    /** Пытается подключится к агенту веб-сервисов. В случае неудачи генерирует исключение. */
+    check(): Promise<IWebServicesInfo>;
+    /**
+     * Отправляет сообщение в агент веб-сервисов методом GET, и возвращает полученный ответ.
+     * @param plugin Адрес плагина, для которого предназначено сообщение.
+     * @param action Действие плагина, которое необходимо выполнить. Может быть не задано.
+     * @param message JavaScript объект, содержащий параметры запроса.
+     * @returns JavaScript объект ответа.
+     */
+    get<T>(plugin: string, message: IWebServicesRequest<T>, options?: RequestOptions): Promise<T>;
+    /**
+     * Отправляет сообщение в агент веб-сервисов методом POST, и возвращает полученный ответ.
+     * @param plugin Адрес плагина, для которого предназначено сообщение.
+     * @param action Действие плагина, которое необходимо выполнить. Может быть не задано.
+     * @param message JavaScript объект, содержащий параметры запроса.
+     * @returns JavaScript объект ответа.
+     */
+    post<T>(plugin: string, message: IWebServicesRequest<T>, options?: RequestOptions): Promise<T>;
+    /**
+     * Открывает соединение с плагином агента черзе веб-сокеты.
+     * @param plugin Адрес плагина, с которым планируется начать взаимодействие.
+     * @returns Объект соединения, через который можно отправлять запросы и получать ответы.
+     */
+    connect(plugin: string): Promise<IWebServicesConnection>;
+}
+export declare type $WebServices = {
+    webServices: IWebServicesService;
+};
+export declare const $WebServices: string | ((model?: $WebServices) => IWebServicesService);