@steroidsjs/core 3.0.0-beta.92 → 3.0.0-beta.94

package/components/ClientStorageComponent.d.ts

@@ -1,7 +1,17 @@
+export interface IClientStorageComponentConfig {
+    /**
+     * Кастомный домен
+     */
+    domain?: string;
+    /**
+     * Куки для режима ssr
+     */
+    ssrCookie?: any;
+}
 /**
  * Интерфейс для ClientStorageComponent
  */
-export interface IClientStorageComponent {
+export interface IClientStorageComponent extends IClientStorageComponentConfig {
     /**
      * Получить значение из хранилища.
      * @param name Имя записи.
@@ -14,7 +24,7 @@ export interface IClientStorageComponent {
      * @param name Имя записи.
      * @param value Значение записи.
      * @param storageName (Необязательный) Имя хранилища (local, session, или cookie).
-     * @param expires (Необязательный) Срок действия записи в миллисекундах.
+     * @param expires (Необязательный) Срок действия записи в днях.
      */
     set(name: string, value: string, storageName?: 'local' | 'session' | 'cookie', expires?: number | null): void;
     /**
@@ -37,24 +47,8 @@ export default class ClientStorageComponent implements IClientStorageComponent {
     domain?: string;
     private _ssrCookie;
     constructor(components: any, config: any);
-    /**
-     * @param {string} name
-     * @param {string} [storageName]
-     * @returns {*}
-     */
     get(name: any, storageName: any): any;
-    /**
-     * @param {string} name
-     * @param {*} value
-     * @param {string} [storageName]
-     * @param {number|null} [expires]
-     */
     set(name: any, value: any, storageName: any, expires?: any): void;
-    /**
-     *
-     * @param {string} name
-     * @param {string} [storageName]
-     */
     remove(name: any, storageName: any): void;
     _getDomain(): string;
 }

package/components/ClientStorageComponent.js

@@ -64,11 +64,6 @@ var ClientStorageComponent = /** @class */ (function () {
         this.domain = (config === null || config === void 0 ? void 0 : config.domain) || null;
         this._ssrCookie = config === null || config === void 0 ? void 0 : config.ssrCookie;
     }
-    /**
-     * @param {string} name
-     * @param {string} [storageName]
-     * @returns {*}
-     */
     ClientStorageComponent.prototype.get = function (name, storageName) {
         storageName = storageName || this.STORAGE_LOCAL;
         if (this.localStorageAvailable && storageName === this.STORAGE_LOCAL) {
@@ -80,12 +75,6 @@ var ClientStorageComponent = /** @class */ (function () {
         }
         return process.env.IS_SSR ? this._ssrCookie.get(name) : cookie.get(name);
     };
-    /**
-     * @param {string} name
-     * @param {*} value
-     * @param {string} [storageName]
-     * @param {number|null} [expires]
-     */
     ClientStorageComponent.prototype.set = function (name, value, storageName, expires) {
         if (expires === void 0) { expires = null; }
         storageName = storageName || this.STORAGE_LOCAL;
@@ -107,11 +96,6 @@ var ClientStorageComponent = /** @class */ (function () {
             process.env.IS_SSR ? this._ssrCookie.set(name, value, options) : cookie.set(name, value, options);
         }
     };
-    /**
-     *
-     * @param {string} name
-     * @param {string} [storageName]
-     */
     ClientStorageComponent.prototype.remove = function (name, storageName) {
         storageName = storageName || this.STORAGE_LOCAL;
         if (this.localStorageAvailable && storageName === this.STORAGE_LOCAL) {

package/components/HtmlComponent.d.ts

@@ -1,8 +1,32 @@
+/// <reference types="react" />
+export interface IHtmlComponent {
+    /**
+     * Утилита для создания css-классов по БЭМ
+     */
+    bem(blockName: string): any;
+    /**
+     * Метод для соединения нескольких classNames
+     */
+    classNames(...names: string[]): string;
+    /**
+     * Метод для добавления css-класса к элементу
+     * @param node Элемент, к которому нужно добавить класс
+     * @param className Название класса
+     */
+    addClass(node: React.ReactNode, className: string): void;
+    /**
+     * Метод для удаления css-класса у элемента
+     * @param node Элемент, у которого нужно удалить класс
+     * @param className Название класса
+     */
+    removeClass(node: React.ReactNode, className: string): void;
+    closest(element: any, className: string): any;
+}
 /**
  * Html Component
  * Хелпер для работы с БЭМ классами и DOM элементами
  */
-export default class HtmlComponent {
+export default class HtmlComponent implements IHtmlComponent {
     _instances: any;
     namespace: string;
     constructor(components: any);
@@ -11,5 +35,5 @@ export default class HtmlComponent {
     addClass(node: any, className: any): void;
     removeClass(node: any, className: any): void;
     closest(element: any, className: any): any;
-    _applyModifiers(entity: any, modifiers: any): string;
+    private _applyModifiers;
 }

package/components/HttpComponent.d.ts

@@ -4,11 +4,102 @@ interface IHttpRequestOptions {
     onTwoFactor?: (providerName: string) => Promise<any>;
     responseType?: string;
 }
+export interface IHttpComponentConfig {
+    /**
+     * Url для http запросов
+     */
+    apiUrl?: string;
+    /**
+     * Ключ для хранения токена в куках
+     */
+    accessTokenKey?: string;
+    /**
+     * Имя хранилища для токена (local, session, или cookie)
+     */
+    clientStorageName?: string;
+    /**
+     * Срок хранения токена в хранилище в днях
+     */
+    clientStorageExpiresIn?: number;
+}
+export interface IHttpComponent extends IHttpComponentConfig {
+    /**
+     * Получение конфига для axios
+     * @returns Конфиг для axios
+     */
+    getAxiosConfig(): Promise<any>;
+    /**
+     * Изменение csrf токена
+     * @param {string} value
+     */
+    setCsrfToken(value: string): void;
+    /**
+     * Удаление токена
+     */
+    removeAccessToken(): void;
+    /**
+     * Изменение токена
+     * @param {string} value
+     */
+    setAccessToken(value: string): any;
+    /**
+     * Получение токена
+     * @returns {string}
+     */
+    getAccessToken(): Promise<any>;
+    /**
+     * Сбросить конфиг
+     */
+    resetConfig(): void;
+    /**
+     * Метод, который можно вызвать при logout
+     */
+    onLogout(): void;
+    /**
+     * Метод, который можно вызвать при login
+     * @param {{accessToken: string}} params
+     */
+    onLogin(params: {
+        accessToken: string;
+    }): void;
+    /**
+     * Получение url по методу
+     * @param {string} method
+     * @returns {string} url
+     */
+    getUrl(method: string): string;
+    /**
+     * Получение экземпляра axios
+     * @returns Экземпляр axios
+     */
+    getAxiosInstance(): Promise<any>;
+    /**
+     * Вызов метода get
+     */
+    get(url: string, params?: Record<string, any>, options?: IHttpRequestOptions): any;
+    /**
+     * Вызов метода post
+     */
+    post(url: string, params?: Record<string, any>, options?: IHttpRequestOptions): any;
+    /**
+     * Вызов метода delete
+     */
+    delete(url: string, params?: Record<string, any>, options?: IHttpRequestOptions): any;
+    /**
+     * Вызов http-метода
+     */
+    send(method: string, url: string, params?: Record<string, any>, options?: IHttpRequestOptions): any;
+    /**
+     * Метод, который вызывается после запроса
+     */
+    afterRequest(response: any, config: Record<string, any>, options: IHttpRequestOptions): Promise<any>;
+    [key: string]: any;
+}
 /**
  * Http Component
  * Обертка над Axios для запросов на бекенд. Поддерживает токен авторизации, CSRF и обработку ошибок.
  */
-export default class HttpComponent {
+export default class HttpComponent implements IHttpComponent {
     accessTokenKey: string;
     apiUrl: string;
     clientStorageName: string;
@@ -25,18 +116,9 @@ export default class HttpComponent {
         withCredentials: boolean;
         headers: any;
     }>;
-    /**
-     * @param {string} value
-     */
-    setCsrfToken(value: any): void;
+    setCsrfToken(value: string): void;
     removeAccessToken(): void;
-    /**
-     * @param {string} value
-     */
-    setAccessToken(value: any): void;
-    /**
-     * @returns {string}
-     */
+    setAccessToken(value: string): void;
     getAccessToken(): Promise<any>;
     resetConfig(): void;
     onLogout(): void;
@@ -44,14 +126,14 @@ export default class HttpComponent {
         accessToken: string;
     }): void;
     getAxiosInstance(): Promise<any>;
-    getUrl(method: any): any;
+    getUrl(method: string): string;
     get(url: any, params?: {}, options?: IHttpRequestOptions): any;
     post(url: any, params?: {}, options?: IHttpRequestOptions): any;
     delete(url: any, params?: {}, options?: IHttpRequestOptions): any;
     send(method: any, url: any, params?: {}, options?: IHttpRequestOptions): any;
-    _send(method: any, config: any, options: IHttpRequestOptions): any;
-    _sendAxios(config: any, options: IHttpRequestOptions): any;
+    private _send;
+    private _sendAxios;
     afterRequest(response: any, config: any, options: IHttpRequestOptions): any;
-    _onTwoFactor(providerName: any): Promise<unknown>;
+    private _onTwoFactor;
 }
 export {};

package/components/HttpComponent.js

@@ -133,9 +133,6 @@ var HttpComponent = /** @class */ (function () {
             });
         });
     };
-    /**
-     * @param {string} value
-     */
     HttpComponent.prototype.setCsrfToken = function (value) {
         this._csrfToken = value;
         this.resetConfig();
@@ -145,17 +142,11 @@ var HttpComponent = /** @class */ (function () {
         this.resetConfig();
         this._components.clientStorage.remove(this.accessTokenKey, this.clientStorageName);
     };
-    /**
-     * @param {string} value
-     */
     HttpComponent.prototype.setAccessToken = function (value) {
         this._accessToken = value;
         this.resetConfig();
         this._components.clientStorage.set(this.accessTokenKey, value, this.clientStorageName, this.clientStorageExpiresIn);
     };
-    /**
-     * @returns {string}
-     */
     HttpComponent.prototype.getAccessToken = function () {
         return __awaiter(this, void 0, void 0, function () {
             var _a;

package/components/JwtHttpComponent.d.ts

@@ -1,9 +1,24 @@
 import BaseHttpComponent from '@steroidsjs/core/components/HttpComponent';
-export default class JwtHttpComponent extends BaseHttpComponent {
-    refreshTokenRequest: {
-        url: string;
-        method: string;
-    };
+export interface IRefreshTokenRequest {
+    url: string;
+    method: string;
+}
+export interface IJwtHttpComponentConfig {
+    /**
+     * Запрос на обновление токена авторизации
+     */
+    refreshTokenRequest?: IRefreshTokenRequest;
+    /**
+     * Ключ токена авторизации для локального хранилища
+     */
+    refreshTokenKey?: string;
+}
+/**
+ * JwtHttpComponent
+ * Вариация HttpComponent с функционалом обновления токена авторизации
+ */
+export default class JwtHttpComponent extends BaseHttpComponent implements IJwtHttpComponentConfig {
+    refreshTokenRequest: IRefreshTokenRequest;
     refreshTokenKey: string;
     _refreshToken: any;
     constructor(components: any, config?: any);

package/components/JwtHttpComponent.js

@@ -57,6 +57,10 @@ exports.__esModule = true;
 var axios_1 = __importDefault(require("axios"));
 var HttpComponent_1 = __importDefault(require("@steroidsjs/core/components/HttpComponent"));
 var auth_1 = require("@steroidsjs/core/actions/auth");
+/**
+ * JwtHttpComponent
+ * Вариация HttpComponent с функционалом обновления токена авторизации
+ */
 var JwtHttpComponent = /** @class */ (function (_super) {
     __extends(JwtHttpComponent, _super);
     function JwtHttpComponent(components, config) {

package/components/LocaleComponent.d.ts

@@ -1,31 +1,33 @@
 import dayjs from 'dayjs';
 import 'dayjs/locale/it';
 import 'dayjs/locale/ru';
-/**
- * Интерфейс для LocaleComponent
- */
-export interface ILocaleComponent {
+export interface ILocaleComponentConfig {
     /**
      * Разница времени с бекендом (в микросекундах)
      */
-    backendTimeDiff: null;
+    backendTimeDiff?: null;
     /**
      * Временная зона бекенда
      */
-    backendTimeZone: any;
+    backendTimeZone?: any;
     /**
      * Язык приложения
      * @example ru
      */
-    language: string;
+    language?: string;
     /**
      * Исходный язык
      */
-    sourceLanguage: string;
+    sourceLanguage?: string;
     /**
      * Переводы сообщений
      */
-    translations: any;
+    translations?: any;
+}
+/**
+ * Интерфейс для LocaleComponent
+ */
+export interface ILocaleComponent extends ILocaleComponentConfig {
     /**
      * Получение экземпляра `dayjs` с учетом временной зоны бекенда
      * @param date Дата
@@ -51,8 +53,6 @@ export interface ILocaleComponent {
 /**
  * Locale Component
  * Компонент для локализации приложения. Поддерживает конфигурацию языка и временной зоны
- *
- * Пример строки: `{__('{count} {count, plural, one{день} few{дня} many{дней}}', {count: 2})}`
  */
 export default class LocaleComponent implements ILocaleComponent {
     backendTimeDiff: null;
@@ -73,5 +73,5 @@ export default class LocaleComponent implements ILocaleComponent {
     dayjs(date?: string, format?: string): dayjs.Dayjs;
     t(message: any, params?: {}): any;
     translate(message: any, params?: {}): any;
-    _pasteComponents(message: any, components: any): any;
+    private _pasteComponents;
 }

package/components/LocaleComponent.js

@@ -36,8 +36,6 @@ require("dayjs/locale/ru");
 /**
  * Locale Component
  * Компонент для локализации приложения. Поддерживает конфигурацию языка и временной зоны
- *
- * Пример строки: `{__('{count} {count, plural, one{день} few{дня} many{дней}}', {count: 2})}`
  */
 var LocaleComponent = /** @class */ (function () {
     function LocaleComponent(components, config) {

package/components/MetaComponent.d.ts

@@ -23,11 +23,37 @@ export interface ModelAttribute {
     fromStringConverter?: (value: string, type: string, item: any) => any;
     toStringConverter?: (value: any, type: string, item: any) => string | null;
 }
+export interface IMetaComponent {
+    /**
+     * Изменить модель
+     */
+    setModel(name: string, item: Model): void;
+    /**
+     * Получить модель
+     */
+    getModel(name: string): Model;
+    /**
+     * Изменить тип
+     */
+    setType(name: string, config: Record<string, any>): void;
+    /**
+     * Получить тип
+     */
+    getType(name: string): any;
+    /**
+     * Форматирование названия модели
+     */
+    normalizeName(name: string): string;
+    /**
+     * Форматирование модели модели
+     */
+    normalizeModel(inputModel: Model, defaultModel: Model | any): Model;
+}
 /**
  * Meta Component
  * Компонент для работы с мета-данными моделей и типами приложения (appType)
  */
-export default class MetaComponent {
+export default class MetaComponent implements IMetaComponent {
     defaultPrimaryKey: string;
     defaultAttributeType: string;
     models: any;
@@ -36,101 +62,12 @@ export default class MetaComponent {
     constructor(components: any);
     setModel(name: string, item: Model): void;
     getModel(name: string): any;
-    setType(name: any, config: any): void;
+    setType(name: string, config: Record<string, any>): void;
     getType(name: string): any;
-    normalizeName(name: any): any;
+    normalizeName(name: string): string;
     normalizeModel(inputModel: Model, defaultModel?: Model | any): {
         primaryKey: any;
         attributes: any[];
     };
-    _defaultTypes(): {
-        autoTime: {
-            jsType: string;
-            field: string;
-            formatter: string;
-        };
-        boolean: {
-            jsType: string;
-            field: string;
-            formatter: string;
-        };
-        dateTime: {
-            jsType: string;
-            field: string;
-            formatter: string;
-        };
-        date: {
-            jsType: string;
-            field: string;
-            formatter: string;
-        };
-        double: {
-            jsType: string;
-            field: string;
-        };
-        email: {
-            jsType: string;
-            field: string;
-            fieldProps: {
-                type: string;
-            };
-        };
-        enum: {
-            jsType: string;
-            field: string;
-            formatter: string;
-        };
-        file: {
-            jsType: string;
-            field: string;
-        };
-        files: {
-            jsType: string;
-            field: string;
-            fieldProps: {
-                multiple: boolean;
-            };
-        };
-        html: {
-            jsType: string;
-            field: string;
-        };
-        integer: {
-            jsType: string;
-            field: string;
-        };
-        password: {
-            jsType: string;
-            field: string;
-        };
-        phone: {
-            jsType: string;
-            field: string;
-            fieldProps: {
-                type: string;
-            };
-        };
-        primaryKey: {
-            jsType: string;
-            field: string;
-            fieldProps: {
-                type: string;
-            };
-            searchFieldProps: {
-                type: string;
-            };
-        };
-        string: {
-            jsType: string;
-            field: string;
-        };
-        text: {
-            jsType: string;
-            field: string;
-        };
-        time: {
-            jsType: string;
-            field: string;
-        };
-    };
+    private _defaultTypes;
 }

package/components/MetricsComponent.d.ts

@@ -17,7 +17,26 @@ type ConfigType = {
     };
     enable?: boolean;
 };
-export default class MetricsComponent {
+export interface IMetricsComponent {
+    /**
+     * Отписаться от метрик
+     */
+    unsubscribe: VoidFunction;
+    /**
+     * Отменить прослушивание метрик
+     */
+    unlisten: VoidFunction;
+    /**
+     * Поменять счетчики
+     * @param values Значения
+     */
+    setCounters(values: any): void;
+}
+/**
+ * Metrics Component
+ * Компонент для добавления метрик в приложение (например яндекс метрики)
+ */
+export default class MetricsComponent implements IMetricsComponent {
     _components: any;
     _prevUrl: string;
     _isMetricsInitialized: boolean;

package/components/MetricsComponent.js

@@ -6,6 +6,10 @@ exports.__esModule = true;
 var upperFirst_1 = __importDefault(require("lodash-es/upperFirst"));
 var isEmpty_1 = __importDefault(require("lodash-es/isEmpty"));
 var auth_1 = require("../reducers/auth");
+/**
+ * Metrics Component
+ * Компонент для добавления метрик в приложение (например яндекс метрики)
+ */
 var MetricsComponent = /** @class */ (function () {
     function MetricsComponent(components, config) {
         if (config === void 0) { config = {}; }

package/components/ResourceComponent.d.ts

@@ -6,27 +6,21 @@ declare global {
         };
     }
 }
-export interface IResourceComponent {
+export interface IResourceComponentConfig {
     /**
-    * Свойство для хранения обратных вызовов.
-    */
-    _callbacks: any;
-    /**
-     * Свойство для хранения компонентов.
+     * API-ключ Google для использования Google Maps и других сервисов.
      */
-    _components: any;
+    googleApiKey?: string;
     /**
-     * API-ключ Google для использования Google Maps и других сервисов.
+     * Языковой код, используемый для загрузки ресурсов.
      */
-    googleApiKey: string;
+    language?: string;
+}
+export interface IResourceComponent extends IResourceComponentConfig {
     /**
      * Ключ сайта Google reCAPTCHA.
      */
     googleCaptchaSiteKey: string;
-    /**
-     * Языковой код, используемый для загрузки ресурсов.
-     */
-    language: string;
     /**
      * URL для загрузки Google Maps API.
      */
@@ -93,8 +87,8 @@ export interface IResourceComponent {
  * Компонент для подгрузки внешних API: Google Maps, Yandex Maps, Twitter, ...
  */
 export default class ResourceComponent implements IResourceComponent {
-    _callbacks: any;
-    _components: any;
+    private _callbacks;
+    private _components;
     googleApiKey: string;
     googleCaptchaSiteKey: string;
     language: string;

package/components/SocialComponent.d.ts

@@ -1,8 +1,23 @@
+export interface ISocialComponent {
+    /**
+     * Провайдеры
+     */
+    providers: any;
+    /**
+     * Старт
+     * @param socialName Название social
+     */
+    start(socialName: string): void;
+    /**
+     * Инициализация компонента
+     */
+    init(): void;
+}
 /**
  * Social Component
  * Провайдер для социальных сетей. Обеспечивает вызов окна соц сети для oauth авторизации
  */
-export default class SocialComponent {
+export default class SocialComponent implements ISocialComponent {
     _components: any;
     _initializing: any;
     providers: any;