@steroidsjs/core 3.0.6 → 3.0.8

package/actions/auth.d.ts

@@ -4,7 +4,7 @@ export declare const AUTH_SET_DATA = "AUTH_SET_DATA";
 export declare const AUTH_ADD_SOCIAL = "AUTH_ADD_SOCIAL";
 export declare const init: (skipInitialized?: boolean) => (dispatch: any, getState: any) => any;
 export declare const reInit: () => (dispatch: any, getState: any) => any;
-export declare const login: (token: any, redirectPageId?: string | boolean, params?: any) => (dispatch: any, getState: any, { http }: {
+export declare const login: (token: any, redirectPageId?: string | boolean, params?: RouteParams) => (dispatch: any, getState: any, { http }: {
     http: any;
 }) => any;
 export declare const addSocial: (social: any) => {
@@ -19,6 +19,6 @@ export declare const setData: (data: any) => {
     type: string;
     data: any;
 };
-export declare const logout: (routeId?: string | boolean, routeParams?: any) => (dispatch: any, getState: any, { http }: {
+export declare const logout: (routeId?: string | boolean, routeParams?: RouteParams) => (dispatch: any, getState: any, { http }: {
     http: any;
 }) => any;

package/actions/list.d.ts

@@ -132,13 +132,13 @@ export declare const listSetLayout: (listId: any, layoutName: any) => {
  * @param listId
  * @param query
  */
-export declare const listFetch: (listId: string, query?: any) => (dispatch: any, getState: any, components: any) => any;
+export declare const listFetch: (listId: string, query?: Record<string, any>) => (dispatch: any, getState: any, components: any) => any;
 /**
  * Lazy update query values and send request
  * @param listId
  * @param query
  */
-export declare const listLazyFetch: (listId: string, query?: any) => (dispatch: any) => void;
+export declare const listLazyFetch: (listId: string, query?: Record<string, any>) => (dispatch: any) => void;
 /**
  * Send request with same query
  * @param listId

package/actions/router.d.ts

@@ -1,4 +1,3 @@
-type TParams = Record<string, any> | null;
 export declare const ROUTER_INIT_ROUTES = "ROUTER_INIT_ROUTES";
 export declare const ROUTER_SET_PARAMS = "ROUTER_SET_PARAMS";
 export declare const ROUTER_SET_DATA = "ROUTER_SET_DATA";
@@ -10,8 +9,7 @@ export declare const initParams: (params: any) => {
     type: string;
     params: any;
 };
-export declare const goToRoute: (routeId: any, params?: TParams, isReplace?: boolean) => (dispatch: any, getState: any, { store }: {
+export declare const goToRoute: (routeId: any, params?: RouteParams, isReplace?: boolean) => (dispatch: any, getState: any, { store }: {
     store: any;
 }) => any;
 export declare const goToParent: (level?: number) => (dispatch: any, getState: any) => any;
-export {};

package/components/HtmlComponent.d.ts

@@ -2,22 +2,24 @@
 export interface IHtmlComponent {
     /**
      * Утилита для создания css-классов по БЭМ
+     * @param blockName Название блока.
      */
     bem(blockName: string): any;
     /**
      * Метод для соединения нескольких classNames
+     * @param names Массив названий классов.
      */
     classNames(...names: string[]): string;
     /**
      * Метод для добавления css-класса к элементу
-     * @param node Элемент, к которому нужно добавить класс
-     * @param className Название класса
+     * @param node Элемент, к которому нужно добавить класс.
+     * @param className Название класса.
      */
     addClass(node: React.ReactNode, className: string): void;
     /**
      * Метод для удаления css-класса у элемента
-     * @param node Элемент, у которого нужно удалить класс
-     * @param className Название класса
+     * @param node Элемент, у которого нужно удалить класс.
+     * @param className Название класса.
      */
     removeClass(node: React.ReactNode, className: string): void;
     closest(element: any, className: string): any;

package/components/HttpComponent.d.ts

@@ -1,6 +1,6 @@
 interface IHttpRequestOptions {
     lazy?: boolean | number;
-    cancelToken?: any;
+    cancelToken?: string;
     onTwoFactor?: (providerName: string) => Promise<any>;
     responseType?: string;
 }
@@ -30,7 +30,7 @@ export interface IHttpComponent extends IHttpComponentConfig {
     getAxiosConfig(): Promise<any>;
     /**
      * Изменение csrf токена
-     * @param {string} value
+     * @param {string} value Значение csrf токена.
      */
     setCsrfToken(value: string): void;
     /**
@@ -39,7 +39,7 @@ export interface IHttpComponent extends IHttpComponentConfig {
     removeAccessToken(): void;
     /**
      * Изменение токена
-     * @param {string} value
+     * @param {string} value Значение токена.
      */
     setAccessToken(value: string): any;
     /**
@@ -57,14 +57,14 @@ export interface IHttpComponent extends IHttpComponentConfig {
     onLogout(): void;
     /**
      * Метод, который можно вызвать при login
-     * @param {{accessToken: string}} params
+     * @param {{accessToken: string}} params Параметры для авторизации (accessToken).
      */
     onLogin(params: {
         accessToken: string;
     }): void;
     /**
      * Получение url по методу
-     * @param {string} method
+     * @param {string} method Метод.
      * @returns {string} url
      */
     getUrl(method: string): string;
@@ -75,22 +75,38 @@ export interface IHttpComponent extends IHttpComponentConfig {
     getAxiosInstance(): Promise<any>;
     /**
      * Вызов метода get
+     * @param url URL для HTTP-запроса.
+     * @param params Параметры для запроса.
+     * @param options Опции для HTTP-запроса, заголовки и т.д.
      */
     get(url: string, params?: Record<string, any>, options?: IHttpRequestOptions): any;
     /**
      * Вызов метода post
+     * @param url URL для HTTP-запроса.
+     * @param params Параметры для запроса.
+     * @param options Опции для HTTP-запроса, заголовки и т.д.
      */
     post(url: string, params?: Record<string, any>, options?: IHttpRequestOptions): any;
     /**
      * Вызов метода delete
+     * @param url URL для HTTP-запроса.
+     * @param params Параметры для запроса.
+     * @param options Опции для HTTP-запроса, заголовки и т.д.
      */
     delete(url: string, params?: Record<string, any>, options?: IHttpRequestOptions): any;
     /**
      * Вызов http-метода
+     * @param method Метод запроса (GET, POST и т.д.).
+     * @param url URL для HTTP-запроса.
+     * @param params Параметры для запроса.
+     * @param options Опции для HTTP-запроса, заголовки и т.д.
      */
     send(method: string, url: string, params?: Record<string, any>, options?: IHttpRequestOptions): any;
     /**
      * Метод, который вызывается после запроса
+     * @param response Ответ, полученный после выполнения HTTP-запроса.
+     * @param config Конфиг запроса.
+     * @param options Опции для HTTP-запроса, заголовки и т.д.
      */
     afterRequest(response: any, config: Record<string, any>, options: IHttpRequestOptions): Promise<any>;
     [key: string]: any;

package/components/LocaleComponent.d.ts

@@ -30,22 +30,22 @@ export interface ILocaleComponentConfig {
 export interface ILocaleComponent extends ILocaleComponentConfig {
     /**
      * Получение экземпляра `dayjs` с учетом временной зоны бекенда
-     * @param date Дата
-     * @param format Формат даты
+     * @param date Дата.
+     * @param format Формат даты.
      * @returns Экземпляр `dayjs`
      */
     dayjs(date?: string, format?: string): dayjs.Dayjs;
     /**
      * Алиас для метода `translate`
-     * @param message Сообщение для перевода
-     * @param params Параметры перевода
+     * @param message Сообщение для перевода.
+     * @param params Параметры перевода.
      * @returns Переведенное сообщение
      */
     t(message: string, params?: Record<string, any>): string;
     /**
      * Перевод сообщения
-     * @param message Сообщение для перевода
-     * @param params Параметры перевода
+     * @param message Сообщение для перевода.
+     * @param params Параметры перевода.
      * @returns Переведенное сообщение
      */
     translate(message: string, params?: Record<string, any>): string;

package/components/MetaComponent.d.ts

@@ -26,26 +26,35 @@ export interface ModelAttribute {
 export interface IMetaComponent {
     /**
      * Изменить модель
+     * @param name Имя модели.
+     * @param item Модель.
      */
     setModel(name: string, item: Model): void;
     /**
      * Получить модель
+     * @param name Имя модели.
      */
     getModel(name: string): Model;
     /**
      * Изменить тип
+     * @param name Имя типа.
+     * @param config Конфиг.
      */
     setType(name: string, config: Record<string, any>): void;
     /**
      * Получить тип
+     * @param name Имя типа.
      */
     getType(name: string): any;
     /**
      * Форматирование названия модели
+     * @param name Имя модели.
      */
     normalizeName(name: string): string;
     /**
      * Форматирование модели модели
+     * @param inputModel Модель.
+     * @param defaultModel Модель по-умолчанию.
      */
     normalizeModel(inputModel: Model, defaultModel: Model | any): Model;
 }

package/components/MetricsComponent.d.ts

@@ -28,7 +28,7 @@ export interface IMetricsComponent {
     unlisten: VoidFunction;
     /**
      * Поменять счетчики
-     * @param values Значения
+     * @param values Значения.
      */
     setCounters(values: any): void;
 }

package/components/SocialComponent.d.ts

@@ -5,7 +5,7 @@ export interface ISocialComponent {
     providers: any;
     /**
      * Старт
-     * @param socialName Название social
+     * @param socialName Название social.
      */
     start(socialName: string): void;
     /**

package/components/StoreComponent.d.ts

@@ -31,29 +31,34 @@ export interface IStoreComponent {
     configurate(): void;
     /**
      * Метод для dispatch
+     * @param action Экшен для изменения состояния.
      */
     dispatch(action: any): void;
     /**
-     * Получение состояние
+     * Получение состояния
      */
     getState(): void;
     /**
      * Подписка
+     * @param handler Обработчик изменения состояния.
      */
     subscribe(handler: any): void;
     /**
      * Добавление редьюсеров
+     * @param asyncReducers Коллекция редьюсеров.
      */
     addReducers(asyncReducers: any): void;
     /**
      * Метод, который вызывается при ошибке
+     * @param error Объект ошибки.
+     * @param action Callback функция вызываемая при ошибке.
      */
     errorHandler(error: any, action: any): void;
     [key: string]: any;
 }
 /**
  * Store Component
- * Обертка над Redux Store со встроенными middleware (thunk, multi, promise..) и react-router
+ * Обертка над Redux Store со встроенными middleware (thunk, multi, promise..) и react-router.
  */
 export default class StoreComponent implements IStoreComponent {
     _asyncReducers: any;

package/components/StoreComponent.js

@@ -23,7 +23,7 @@ var merge_1 = __importDefault(require("lodash-es/merge"));
 var isPlainObject_1 = __importDefault(require("lodash-es/isPlainObject"));
 /**
  * Store Component
- * Обертка над Redux Store со встроенными middleware (thunk, multi, promise..) и react-router
+ * Обертка над Redux Store со встроенными middleware (thunk, multi, promise..) и react-router.
  */
 var StoreComponent = /** @class */ (function () {
     function StoreComponent(components, config, lazyInit) {

package/components/WebSocketComponent.d.ts

@@ -35,6 +35,7 @@ export interface IWebSocketComponentConfig {
 export interface IWebSocketComponent extends IWebSocketComponentConfig {
     /**
      * Открытие websocket соединения
+     * @param closePrevious Флаг для закрытия предыдущего соединения.
      */
     open(closePrevious?: boolean): void;
     /**
@@ -43,18 +44,24 @@ export interface IWebSocketComponent extends IWebSocketComponentConfig {
     close(): void;
     /**
      * Подписка на stream
+     * @param stream Поток, на который нужно подписаться.
+     * @param id Идентификатор потока.
      */
     subscribeStream(stream: TStream, id: string | number): void;
     /**
      * Подписка на streams
+     * @param streams Потоки, на которые нужно подписаться.
      */
     subscribe(streams: TStreams): void;
     /**
      * Отписка от stream
+     * @param stream Поток, от которого нужно подписаться.
+     * @param id Идентификатор потока.
      */
     unsubscribeStream(stream: TStream, id: string | number): void;
     /**
      * Отписка от streams
+     * @param streams Потоки, от которых нужно подписаться.
      */
     unsubscribe(streams: TStreams): void;
 }