@steroidsjs/core 3.0.0-beta.7 → 3.0.0-beta.70

package/actions/list.d.ts

@@ -1,25 +1,94 @@
 import { IApiMethod } from '../components/ApiComponent';
 export interface IList {
+    /**
+    * Url, который вернет коллекцию элементов.
+    * @example api/v1/articles
+    */
     action?: string | IApiMethod;
+    /**
+    * Тип HTTP запроса (GET | POST | PUT | DELETE)
+    */
     actionMethod?: string;
+    /**
+    * Функция обратного вызова, вызываемая при получении списка.
+    */
     onFetch?: (list: IList, query: Record<string, unknown>, components: any) => Promise<any>;
+    /**
+     * Обработчик события ошибки выполнения запроса
+     * @param args
+     */
+    onError?: (error: Record<string, any>) => void;
+    /**
+    * Функция условия, используемая для определения поведения списка на основе параметров запроса.
+    */
     condition?: (query: Record<string, unknown>) => any;
+    /**
+    * Массив строк, представляющих область списка.
+    */
     scope?: string[];
+    /**
+    * Общее количество элементов в списке.
+    */
     total?: number;
+    /**
+    * Массив элементов списка.
+    */
     items?: Array<any>;
+    /**
+    * Массив исходных элементов списка.
+    */
     sourceItems?: Array<any>;
+    /**
+    * Логическое значение, указывающее, является ли список удаленным или нет.
+    */
     isRemote?: boolean;
+    /**
+    * Логическое значение, указывающее, можно ли загрузить еще элементы для списка.
+    */
     loadMore?: boolean;
+    /**
+    * Первичный ключ для списка.
+    */
     primaryKey?: string;
+    /**
+    * Идентификатор списка.
+    */
     listId?: string;
+    /**
+    * Идентификатор формы, связанной с данным списком.
+    */
     formId?: string;
+    /**
+    * Атрибут страницы для списка.
+    */
     pageAttribute?: string;
+    /**
+    * Атрибут размера страницы для списка.
+    */
     pageSizeAttribute?: string;
+    /**
+    * Атрибут сортировки для списка.
+    */
     sortAttribute?: string;
+    /**
+    * Атрибут макета для списка.
+    */
     layoutAttribute?: string;
+    /**
+    * Дополнительные метаданные для списка.
+    */
     meta?: any;
+    /**
+    * Логическое значение, указывающее, был ли список получен или нет.
+    */
     isFetched?: boolean;
+    /**
+    * Логическое значение, указывающее, находится ли список в процессе загрузки или нет.
+    */
     isLoading?: boolean;
+    /**
+    * Название макета, связанного с данным списком.
+    */
     layoutName?: null;
 }
 export declare const LIST_INIT = "@list/init";

package/actions/list.js

@@ -43,6 +43,7 @@ var createList = function (listId, props) { return ({
     action: props.action || props.action === '' ? props.action : null,
     actionMethod: props.actionMethod || 'get',
     onFetch: props.onFetch,
+    onError: props.onError,
     condition: props.condition,
     scope: props.scope,
     total: props.total || null,
@@ -74,7 +75,11 @@ var httpFetchHandler = function (list, query, _a) {
     }
     return http
         .send(list.actionMethod, url || window.location.pathname, query)
-        .then(function (response) { return response.data; });
+        .then(function (response) { return response.data; })["catch"](function (error) {
+        if (typeof list.onError === 'function') {
+            list.onError(error);
+        }
+    });
 };
 exports.httpFetchHandler = httpFetchHandler;
 var localFetchHandler = function (list, query) {

package/base/Enum.d.ts

@@ -1,11 +1,11 @@
 export default class Enum {
-    static getLabels(): {};
+    static getLabels(): Record<string, string>;
     static getKeys(): string[];
-    static getLabel(id: any): any;
+    static getLabel(id: any): string;
     static getCssClasses(): {};
     static getCssClass(id: any): any;
     static getDropdownItems(): {
-        label: unknown;
+        label: string;
         id: string;
     }[];
 }

package/components/ClientStorageComponent.js

@@ -53,7 +53,7 @@ var ClientStorageComponent = /** @class */ (function () {
         if (this.sessionStorageAvailable) {
             try {
                 window.sessionStorage.setItem('sessionStorageAvailable', '1');
-                this.sessionStorageAvailable = window.localStorage.getItem('sessionStorageAvailable') === '1';
+                this.sessionStorageAvailable = window.sessionStorage.getItem('sessionStorageAvailable') === '1';
                 window.sessionStorage.removeItem('sessionStorageAvailable');
             }
             catch (e) {

package/components/ResourceComponent.d.ts

@@ -6,21 +6,103 @@ declare global {
         };
     }
 }
+export interface IResourceComponent {
+    /**
+    * Свойство для хранения обратных вызовов.
+    */
+    _callbacks: any;
+    /**
+     * Свойство для хранения компонентов.
+     */
+    _components: any;
+    /**
+     * API-ключ Google для использования Google Maps и других сервисов.
+     */
+    googleApiKey: string;
+    /**
+     * Ключ сайта Google reCAPTCHA.
+     */
+    googleCaptchaSiteKey: string;
+    /**
+     * Языковой код, используемый для загрузки ресурсов.
+     */
+    language: string;
+    /**
+     * URL для загрузки Google Maps API.
+     */
+    readonly RESOURCE_GOOGLE_MAP_API: string;
+    /**
+     * URL для загрузки Yandex Maps API.
+     */
+    readonly RESOURCE_YANDEX_MAP_API: string;
+    /**
+     * URL для загрузки Twitter виджетов.
+     */
+    readonly RESOURCE_TWITTER_WIDGET: string;
+    /**
+     * URL для загрузки Geetest.
+     */
+    readonly RESOURCE_GEETEST_API: string;
+    /**
+     * URL для загрузки Google reCAPTCHA.
+     */
+    readonly RESOURCE_GOOGLE_CAPTCHA: string;
+    /**
+     * Метод для загрузки Google reCAPTCHA.
+     * @returns Промис, который разрешается с объектом window.grecaptcha.
+     */
+    loadGoogleCaptcha(): Promise<any>;
+    /**
+     * Метод для загрузки Google Maps API.
+     * @returns Промис, который разрешается с объектом window.google.maps.
+     */
+    loadGoogleMapApi(): Promise<any>;
+    /**
+     * Метод для загрузки Yandex Maps API.
+     * @returns Промис, который разрешается с объектом window.ymaps.
+     */
+    loadYandexMap(): Promise<any>;
+    /**
+     * Метод для загрузки Twitter виджетов.
+     * @returns Промис, который разрешается с объектом window.twttr.
+     */
+    loadTwitterWidget(): Promise<any>;
+    /**
+     * Метод для загрузки Geetest.
+     * @returns Промис, который разрешается с объектом window.initGeetest.
+     */
+    loadGeetest(): Promise<any>;
+    /**
+     * Метод для загрузки скрипта по указанному URL.
+     * @param url URL скрипта для загрузки.
+     * @param params Параметры запроса для URL скрипта.
+     * @param firstResolver Функция, которая возвращает объект, разрешающий промис.
+     * @returns Промис, который разрешается с результатом первого разрешенного промиса.
+     */
+    loadScript(url: string, params: any, firstResolver: () => any): Promise<any>;
+    /**
+     * Метод для ожидания выполнения определенного условия.
+     * @param condition Условие, которое должно быть выполнено.
+     * @param timeout (Необязательный) Таймаут ожидания в миллисекундах (по умолчанию 5000 мс).
+     * @returns Промис, который разрешается с результатом выполнения условия.
+     */
+    wait(condition: () => boolean, timeout?: number): Promise<any>;
+}
 /**
  * Resource Component
  * Компонент для подгрузки внешних API: Google Maps, Yandex Maps, Twitter, ...
  */
-export default class ResourceComponent {
+export default class ResourceComponent implements IResourceComponent {
     _callbacks: any;
     _components: any;
     googleApiKey: string;
     googleCaptchaSiteKey: string;
     language: string;
-    static RESOURCE_GOOGLE_MAP_API: string;
-    static RESOURCE_YANDEX_MAP_API: string;
-    static RESOURCE_TWITTER_WIDGET: string;
-    static RESOURCE_GEETEST_API: string;
-    static RESOURCE_GOOGLE_CAPTCHA: string;
+    readonly RESOURCE_GOOGLE_MAP_API = "//maps.googleapis.com/maps/api/js";
+    readonly RESOURCE_YANDEX_MAP_API = "https://api-maps.yandex.ru/2.1/";
+    readonly RESOURCE_TWITTER_WIDGET = "https://platform.twitter.com/widgets.js";
+    readonly RESOURCE_GEETEST_API = "//static.geetest.com/static/tools/gt.js";
+    readonly RESOURCE_GOOGLE_CAPTCHA = "https://www.google.com/recaptcha/api.js";
     constructor(components: any, config: any);
     loadGoogleCaptcha(): Promise<any>;
     loadGoogleMapApi(): Promise<any>;

package/components/ResourceComponent.js

@@ -35,8 +35,13 @@ var isArray_1 = __importDefault(require("lodash-es/isArray"));
  */
 var ResourceComponent = /** @class */ (function () {
     function ResourceComponent(components, config) {
+        this.RESOURCE_GOOGLE_MAP_API = '//maps.googleapis.com/maps/api/js';
+        this.RESOURCE_YANDEX_MAP_API = 'https://api-maps.yandex.ru/2.1/';
+        this.RESOURCE_TWITTER_WIDGET = 'https://platform.twitter.com/widgets.js';
+        this.RESOURCE_GEETEST_API = '//static.geetest.com/static/tools/gt.js';
+        this.RESOURCE_GOOGLE_CAPTCHA = 'https://www.google.com/recaptcha/api.js';
         this.googleApiKey = config.googleApiKey || '';
-        this.googleCaptchaSiteKey = config.googleCaptchaSiteKey || '';
+        this.googleCaptchaSiteKey = process.env.APP_RECAPTCHA_SITE_KEY || '';
         this.language = config.language || '';
         this._callbacks = {};
         this._components = components;
@@ -45,7 +50,7 @@ var ResourceComponent = /** @class */ (function () {
         if (window.grecaptcha) {
             return Promise.resolve(window.grecaptcha);
         }
-        return this.loadScript(ResourceComponent.RESOURCE_GOOGLE_CAPTCHA, { render: this.googleCaptchaSiteKey }, function () { return window.grecaptcha; });
+        return this.loadScript(this.RESOURCE_GOOGLE_CAPTCHA, { render: this.googleCaptchaSiteKey }, function () { return window.grecaptcha; });
     };
     ResourceComponent.prototype.loadGoogleMapApi = function () {
         var locale = this._components.locale;
@@ -54,7 +59,7 @@ var ResourceComponent = /** @class */ (function () {
             // @ts-ignore
             return Promise.resolve(window.google.maps);
         }
-        return this.loadScript(ResourceComponent.RESOURCE_GOOGLE_MAP_API, {
+        return this.loadScript(this.RESOURCE_GOOGLE_MAP_API, {
             libraries: 'places,geometry',
             key: this.googleApiKey,
             language: this.language || locale.language
@@ -72,7 +77,7 @@ var ResourceComponent = /** @class */ (function () {
                 return window.ymaps.ready(function () { return resolve(window.ymaps); });
             });
         }
-        return this.loadScript(ResourceComponent.RESOURCE_YANDEX_MAP_API, {
+        return this.loadScript(this.RESOURCE_YANDEX_MAP_API, {
             lang: this.language || locale.language
         }, 
         // @ts-ignore
@@ -84,7 +89,7 @@ var ResourceComponent = /** @class */ (function () {
             // @ts-ignore
             return Promise.resolve(window.twttr);
         }
-        return this.loadScript(ResourceComponent.RESOURCE_TWITTER_WIDGET, {}, 
+        return this.loadScript(this.RESOURCE_TWITTER_WIDGET, {}, 
         // @ts-ignore
         function () { return new Promise(function (resolve) { return window.twttr.ready(function () { return resolve(window.twttr); }); }); });
     };
@@ -94,7 +99,7 @@ var ResourceComponent = /** @class */ (function () {
             // @ts-ignore
             return Promise.resolve(window.initGeetest);
         }
-        return this.loadScript(ResourceComponent.RESOURCE_GEETEST_API + '?_t=' + new Date().getTime(), {}, 
+        return this.loadScript(this.RESOURCE_GEETEST_API + '?_t=' + new Date().getTime(), {}, 
         // @ts-ignore
         function () { return window.initGeetest; });
     };
@@ -147,11 +152,6 @@ var ResourceComponent = /** @class */ (function () {
         };
         return new Promise(checker);
     };
-    ResourceComponent.RESOURCE_GOOGLE_MAP_API = '//maps.googleapis.com/maps/api/js';
-    ResourceComponent.RESOURCE_YANDEX_MAP_API = 'https://api-maps.yandex.ru/2.1/';
-    ResourceComponent.RESOURCE_TWITTER_WIDGET = 'https://platform.twitter.com/widgets.js';
-    ResourceComponent.RESOURCE_GEETEST_API = '//static.geetest.com/static/tools/gt.js';
-    ResourceComponent.RESOURCE_GOOGLE_CAPTCHA = 'https://www.google.com/recaptcha/api.js';
     return ResourceComponent;
 }());
 exports["default"] = ResourceComponent;

package/components/UiComponent.d.ts

@@ -1,10 +1,139 @@
+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;
+    /**
+    * Иконки для использования в приложении.
+    */
+    icons: {
+        [name: string]: string | number | ReactNode;
+    };
+    /**
+    * Компоненты полей формы для использования в приложении.
+    */
+    fields: any;
+    /**
+    * Компоненты форматтеры для использования в приложении.
+    */
+    formatters: any;
+    /**
+    * Зарегистрированные компоненты полей формы.
+    */
+    _registeredFields: any;
+    /**
+    * Элемент портала.
+    */
+    _portalElement: HTMLElement | null;
+    /**
+     * Добавляет компоненты представлений.
+     * @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;
     _components: any;
     _models: any;