@steroidsjs/core 3.0.0-beta.10 → 3.0.0-beta.100

package/components/UiComponent.d.ts

@@ -1,27 +1,148 @@
+import * as React from 'react';
 import { ReactNode } from 'react';
 import { IComponents } from '../providers/ComponentsProvider';
 /**
  * Ui Component
  * Компонент для подгрузки и конфигурации UI компонентов приложения
  */
-export default class UiComponent {
+export interface IUiApplicationComponent {
+    /**
+    * Компоненты приложения.
+    */
     components: IComponents;
-    _components: any;
-    _models: any;
+    /**
+    * Иконки для использования в приложении.
+    */
+    icons: {
+        [name: string]: string | number | ReactNode;
+    };
+    /**
+    * Компоненты полей формы для использования в приложении.
+    */
+    fields: any;
+    /**
+    * Компоненты форматтеры для использования в приложении.
+    */
+    formatters: any;
+    /**
+     * Добавляет компоненты представлений.
+     * @param {any} components - Компоненты представлений.
+     */
+    addViews(components: any): void;
+    /**
+     * Рендерит компонент представления.
+     * @param {any} Component - Компонент или путь к компоненту представления.
+     * @param {any} props - Свойства компонента.
+     * @param {boolean} [forceNode=false] - Флаг, указывающий на принудительное отображение компонента как узла.
+     * @returns {React.ReactElement<any>|null} Возвращает элемент React или null.
+     */
+    renderView(Component: any, props: any, forceNode?: boolean): React.ReactElement<any> | null;
+    /**
+     * Возвращает компонент представления по указанному пути.
+     * @param {string} path - Путь к компоненту представления.
+     * @returns {any} Компонент представления или undefined, если не найден.
+     */
+    getView(path: any): any;
+    /**
+     * Добавляет компоненты полей формы.
+     * @param {any} components - Компоненты полей формы.
+     */
+    addFields(components: any): void;
+    /**
+     * Возвращает компонент поля формы по указанному пути.
+     * @param {string} path - Путь к компоненту поля формы.
+     * @returns {React.ComponentType<any>|undefined} Компонент поля формы или undefined, если не найден.
+     */
+    getField(path: string): React.ComponentType<any> | undefined;
+    /**
+     * Возвращает свойства конфигурации компонента поля формы по указанному пути.
+     * @param {string} path - Путь к компоненту поля формы.
+     * @param {any} model - Модель.
+     * @param {any} attribute - Атрибут.
+     * @returns {any} Свойства конфигурации компонента поля формы.
+     */
+    getFieldProps(path: string, model?: any, attribute?: any): any;
+    /**
+     * Добавляет компоненты форматтеров.
+     * @param {any} components - Компоненты форматтеров.
+     */
+    addFormatters(components: any): void;
+    /**
+     * Возвращает компонент форматтера по указанному пути.
+     * @param {string} path - Путь к компоненту форматтера.
+     * @returns {React.ComponentType<any>|undefined} Компонент форматтера или undefined, если не найден.
+     */
+    getFormatter(path: string): React.ComponentType<any> | undefined;
+    /**
+     * Возвращает свойства конфигурации компонента форматтера по указанному пути.
+     * @param {string} path - Путь к компоненту форматтера.
+     * @returns {any} Свойства конфигурации компонента форматтера.
+     */
+    getFormatterProps(path: string): any;
+    /**
+     * Добавляет иконки.
+     * @param {{ [name: string]: string | ReactNode }} icons - Иконки.
+     */
+    addIcons(icons: {
+        [name: string]: string | ReactNode;
+    }): void;
+    /**
+     * Возвращает иконку по указанному имени.
+     * @param {string} name - Имя иконки.
+     * @returns {string | number | ReactNode | null} Иконка или null, если не найдена.
+     */
+    getIcon(name: string): string | number | ReactNode | null;
+    /**
+     * Добавляет модели.
+     * @param {any} models - Модели.
+     */
+    addModels(models: any): void;
+    /**
+     * Регистрирует поле формы.
+     * @param {string} formId - Идентификатор формы.
+     * @param {string} attribute - Атрибут.
+     * @param {any} type - Тип.
+     */
+    registerField(formId: string, attribute: string, type: any): void;
+    /**
+     * Возвращает зарегистрированные поля формы для указанного идентификатора формы.
+     * @param {string} formId - Идентификатор формы.
+     * @returns {any} Зарегистрированные поля формы.
+     */
+    getRegisteredFields(formId: string): any;
+    /**
+     * Задает элемент портала.
+     * @param {HTMLElement} element - Элемент портала.
+     */
+    setPortalElement(element: HTMLElement): void;
+    /**
+     * Возвращает элемент портала.
+     * @returns {HTMLElement | null} Элемент портала или null, если не задан.
+     */
+    getPortalElement(): HTMLElement | null;
+}
+/**
+ * Ui Component
+ * Компонент для подгрузки и конфигурации UI компонентов приложения
+ */
+export default class UiComponent implements IUiApplicationComponent {
+    components: IComponents;
+    private _components;
+    private _models;
     icons: {
         [name: string]: string | number | ReactNode;
     } | any;
     fields: any;
     formatters: any;
-    _registeredFields: any;
-    _portalElement: HTMLDivElement;
+    private _registeredFields;
+    private _portalElement;
     constructor(components: any);
     addViews(components: any): void;
     renderView(Component: any, props: any, forceNode?: boolean): any;
     getView(path: any): any;
     addFields(components: any): void;
     getField(path: any): any;
-    getFieldProps(path: any, model?: any, attribute?: any): any;
+    getFieldProps(path: string, model?: string, attribute?: string): any;
     addFormatters(components: any): void;
     getFormatter(path: any): any;
     getFormatterProps(path: any): any;
@@ -30,9 +151,9 @@ export default class UiComponent {
     addModels(models: any): void;
     registerField(formId: any, attribute: any, type: any): void;
     getRegisteredFields(formId: any): any;
-    _add(group: any, items: any, defaultNamespace?: any): void;
-    _getComponent(group: any, path: any): any;
-    _getPropsConfig(group: any, path: any): any;
+    private _add;
+    private _getComponent;
+    private _getPropsConfig;
     setPortalElement(element: any): void;
     getPortalElement(): HTMLDivElement;
 }

package/components/WebSocketComponent.d.ts

@@ -4,9 +4,67 @@
  * ответов и токен авторизации
  */
 import { IComponents } from '../providers/ComponentsProvider';
-export default class WebSocketComponent {
+type TStream = string | [string, string | number[]];
+type TStreams = string[] | [string, string | number[]][];
+export interface IWebSocketComponentConfig {
+    /**
+     * url для websocket
+     */
+    wsUrl?: string;
+    /**
+     * Массив streams
+     */
+    streams?: TStreams;
+    /**
+     * Хендлер для авторизации
+     */
+    authHandler?: (components: IComponents) => Promise<string>;
+    /**
+     * Функция, которая вызывается на открытие соединения
+     */
+    onOpen?: (event: any, components: IComponents) => any;
+    /**
+     * Функция, которая вызывается на закрытие соединения
+     */
+    onClose?: (event: any, components: IComponents) => any;
+    /**
+     * Функция, которая вызывается на отправку сообщения
+     */
+    onMessage?: (data: Record<string, unknown>, components: IComponents) => any;
+}
+export interface IWebSocketComponent extends IWebSocketComponentConfig {
+    /**
+     * Открытие websocket соединения
+     */
+    open(closePrevious?: boolean): void;
+    /**
+     * Закрытие websocket соединения
+     */
+    close(): void;
+    /**
+     * Подписка на stream
+     */
+    subscribeStream(stream: TStream, id: string | number): void;
+    /**
+     * Подписка на streams
+     */
+    subscribe(streams: TStreams): void;
+    /**
+     * Отписка от stream
+     */
+    unsubscribeStream(stream: TStream, id: string | number): void;
+    /**
+     * Отписка от streams
+     */
+    unsubscribe(streams: TStreams): void;
+}
+/**
+ * WebSocket Component
+ * Компонент для создания websocket взаимодействия
+ */
+export default class WebSocketComponent implements IWebSocketComponent {
     wsUrl: string;
-    streams: string[] | [string, string | number[]][];
+    streams: TStreams;
     authHandler: (components: IComponents) => Promise<string>;
     onOpen: (event: any, components: IComponents) => any;
     onClose: (event: any, components: IComponents) => any;
@@ -23,9 +81,10 @@ export default class WebSocketComponent {
     subscribe(streams: any): void;
     unsubscribeStream(stream: any, id: any): void;
     unsubscribe(streams: any): void;
-    _connect(): Promise<void>;
-    _reConnect(): void;
-    _onOpen(event: any): void;
-    _onMessage(message: any): void;
-    _onClose(event: any): void;
+    private _connect;
+    private _reConnect;
+    private _onOpen;
+    private _onMessage;
+    private _onClose;
 }
+export {};

package/components/WebSocketComponent.js

@@ -37,6 +37,10 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 exports.__esModule = true;
 var getStreamName = function (stream) { return Array.isArray(stream) ? stream[0] : stream; };
+/**
+ * WebSocket Component
+ * Компонент для создания websocket взаимодействия
+ */
 var WebSocketComponent = /** @class */ (function () {
     function WebSocketComponent(components, config) {
         this.wsUrl = config.wsUrl || null;