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

package/README.md

@@ -1,9 +1,26 @@
-# Steroids for React
+# Steroids
 
-Find documentation [here](docs/index.md)
+<p align="center">
+    <img src="https://i.ibb.co/Q9XvtNc/Group-338025.png" alt="Steroids logo" height="120px">
+</p>
 
-## Use package from source in project
+<p align="center">
+    <a href="https://steroids.kozhindev.com/">Steroids site</a> •
+    <a href="https://github.com/steroids/react/issues/new">Submit an Issue</a> •
+    <a href="https://t.me/+R0N4XzKbVSYzOTUy">Contact Us</a>
+</p>
+
+Our Open-Source **Steroids** framework is an ecosystem based on React and Redux with a large set of ready-made components, unique architecture, UI Kit and SSR
+
+## Why Steroids
+
+- **Steroids** contains ready-made project architecture
+
+- **Steroids** provides the ability to customize components, thanks to the separation of core and view parts
+
+- An extensive library of ready-made components with detailed documentation that simplifies integration into the project
+
+- Intuitive design layout of UI components in Figma for quick visualization and adaptation to unique needs
+
+Explore and immerse yourself in the world of rapid development through documentation [Documentation](https://steroids.kozhin.dev/ru/docs/getting-started).
 
-1. Copy `tsconfig-debug.json.sample` to `tsconfig-debug.json`
-2. Replace `outDir` path to node_modules nest path in project
-3. Run from this directory `yarn run watch`

package/actions/auth.js

@@ -32,7 +32,7 @@ var init = function (skipInitialized) {
     };
 };
 exports.init = init;
-var reInit = function () { return exports.init(); };
+var reInit = function () { return (0, exports.init)(); };
 exports.reInit = reInit;
 var login = function (token, redirectPageId, params) {
     if (redirectPageId === void 0) { redirectPageId = 'root'; }
@@ -68,8 +68,8 @@ var logout = function (routeId, routeParams) {
         var http = _a.http;
         http.onLogout();
         return dispatch([
-            exports.setUser(null),
-            routeId && router_1.goToRoute(routeId, routeParams),
+            (0, exports.setUser)(null),
+            routeId && (0, router_1.goToRoute)(routeId, routeParams),
         ].filter(Boolean));
     };
 };

package/actions/list.d.ts

@@ -1,25 +1,93 @@
-import { IApiMethod } from '../components/ApiComponent';
 export interface IList {
-    action?: string | IApiMethod;
+    /**
+    * Url, который вернет коллекцию элементов.
+    * @example api/v1/articles
+    */
+    action?: string;
+    /**
+    * Тип 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";
@@ -33,8 +101,7 @@ export declare const LIST_DESTROY = "@list/destroy";
 export declare const LIST_TOGGLE_ITEM = "@list/toggle_item";
 export declare const LIST_TOGGLE_ALL = "@list/toggle_all";
 export declare const LIST_SET_LAYOUT = "@list/set_layout";
-export declare const httpFetchHandler: (list: IList, query: any, { api, http }: {
-    api: any;
+export declare const httpFetchHandler: (list: IList, query: any, { http }: {
     http: any;
 }) => any;
 export declare const localFetchHandler: (list: IList, query: Record<string, unknown>) => {

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,
@@ -52,21 +53,14 @@ var createList = function (listId, props) { return ({
     loadMore: props._pagination.loadMore,
     primaryKey: props.primaryKey,
     listId: listId,
-    formId: get_1["default"](props, 'searchForm.formId') || listId,
-    pageAttribute: get_1["default"](props, '_pagination.attribute') || null,
-    pageSizeAttribute: get_1["default"](props, '_paginationSize.attribute') || null,
-    sortAttribute: get_1["default"](props, '_sort.attribute') || null,
-    layoutAttribute: get_1["default"](props, '_layout.attribute') || null
+    formId: (0, get_1["default"])(props, 'searchForm.formId') || listId,
+    pageAttribute: (0, get_1["default"])(props, '_pagination.attribute') || null,
+    pageSizeAttribute: (0, get_1["default"])(props, '_paginationSize.attribute') || null,
+    sortAttribute: (0, get_1["default"])(props, '_sort.attribute') || null,
+    layoutAttribute: (0, get_1["default"])(props, '_layout.attribute') || null
 }); };
 var httpFetchHandler = function (list, query, _a) {
-    var api = _a.api, http = _a.http;
-    if (typeof list.action === 'function') {
-        var params = __assign({}, query);
-        if (list.scope) {
-            params.scope = list.scope.join(',');
-        }
-        return list.action(api, params).then(function (response) { return response.data; });
-    }
+    var http = _a.http;
     var url = list.action;
     if (list.scope) {
         url
@@ -74,7 +68,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) {
@@ -93,14 +91,14 @@ var localFetchHandler = function (list, query) {
     var items = [].concat(list.sourceItems || []);
     // Remove null or undefined values from query
     Object.keys(query).forEach(function (key) {
-        if (isNil_1["default"](query[key])) {
+        if ((0, isNil_1["default"])(query[key])) {
             delete query[key];
         }
     });
     // Filter items
-    if (!isEmpty_1["default"](query)) {
-        items = data_1.filterItems(items, list.condition
-            ? (isFunction_1["default"](list.condition) ? list.condition(query) : list.condition)
+    if (!(0, isEmpty_1["default"])(query)) {
+        items = (0, data_1.filterItems)(items, list.condition
+            ? ((0, isFunction_1["default"])(list.condition) ? list.condition(query) : list.condition)
             : query);
     }
     var total = items.length;
@@ -111,9 +109,9 @@ var localFetchHandler = function (list, query) {
     }
     // Sort
     if (sort) {
-        items = orderBy_1["default"](items, sort.map(function (key) { return trimStart_1["default"](key, '-'); }), sort.map(function (key) { return key.indexOf('-') === 0 ? 'desc' : 'asc'; }));
+        items = (0, orderBy_1["default"])(items, sort.map(function (key) { return (0, trimStart_1["default"])(key, '-'); }), sort.map(function (key) { return key.indexOf('-') === 0 ? 'desc' : 'asc'; }));
     }
-    if (isEqual_1["default"](list.items, items)) {
+    if ((0, isEqual_1["default"])(list.items, items)) {
         items = list.items;
     }
     return {
@@ -178,12 +176,12 @@ var listFetch = function (listId, query) {
     if (query === void 0) { query = {}; }
     return function (dispatch, getState, components) {
         var state = getState();
-        var list = get_1["default"](state, ['list', 'lists', listId]);
+        var list = (0, get_1["default"])(state, ['list', 'lists', listId]);
         if (!list || (list.isRemote && !list.action && list.action !== '')) {
             return [];
         }
         var toDispatch = [];
-        var formValues = form_1.formSelector(state, list.formId, function (_a) {
+        var formValues = (0, form_1.formSelector)(state, list.formId, function (_a) {
             var values = _a.values;
             return values;
         }) || {};
@@ -191,7 +189,7 @@ var listFetch = function (listId, query) {
         // Change query
         Object.keys(query || {}).forEach(function (key) {
             formValues[key] = query[key];
-            toDispatch.push(form_2.formChange(list.formId, key, query[key]));
+            toDispatch.push((0, form_2.formChange)(list.formId, key, query[key]));
         });
         if (list.isRemote) {
             // Set `Loading...`
@@ -210,7 +208,7 @@ var listFetch = function (listId, query) {
             if (!getState().list.lists[listId]) {
                 return [];
             }
-            if (isArray_1["default"](data)) {
+            if ((0, isArray_1["default"])(data)) {
                 data = {
                     items: data,
                     total: data.length,
@@ -219,7 +217,7 @@ var listFetch = function (listId, query) {
             }
             return [
                 // Check has errors
-                form_2.formSetErrors(list.formId, data.errors || null),
+                (0, form_2.formSetErrors)(list.formId, data.errors || null),
                 {
                     items: data.items || [],
                     total: data.total || null,
@@ -246,7 +244,7 @@ var listLazyFetch = function (listId, query) {
         if (lazyTimers[listId]) {
             clearTimeout(lazyTimers[listId]);
         }
-        lazyTimers[listId] = setTimeout(function () { return dispatch(exports.listFetch(listId, query)); }, 200);
+        lazyTimers[listId] = setTimeout(function () { return dispatch((0, exports.listFetch)(listId, query)); }, 200);
     };
 };
 exports.listLazyFetch = listLazyFetch;
@@ -254,7 +252,7 @@ exports.listLazyFetch = listLazyFetch;
  * Send request with same query
  * @param listId
  */
-var listRefresh = function (listId) { return exports.listFetch(listId); };
+var listRefresh = function (listId) { return (0, exports.listFetch)(listId); };
 exports.listRefresh = listRefresh;
 /**
  * Destroy list (remove from redux state)

package/actions/modal.js

@@ -12,7 +12,7 @@ var openModal = function (modal, props) {
     if (props === void 0) { props = {}; }
     var id = props ? props.modalId : null;
     if (!id) {
-        modal._modalId = modal._modalId || uniqueId_1["default"]('modal');
+        modal._modalId = modal._modalId || (0, uniqueId_1["default"])('modal');
         id = modal._modalId;
     }
     return {

package/actions/notifications.js

@@ -25,15 +25,15 @@ var showNotification = function (message, level, params) {
     if (params === void 0) { params = showNotificationDefaults; }
     return function (dispatch) {
         var _a = params, position = _a.position, timeOut = _a.timeOut;
-        var id = uniqueId_1["default"]();
+        var id = (0, uniqueId_1["default"])();
         dispatch({ type: exports.NOTIFICATIONS_SHOW, id: id, message: message, level: level || 'success', position: position });
         if (timeOut > 0) {
-            setTimeout(function () { return dispatch(exports.closeNotification(id)); }, timeOut);
+            setTimeout(function () { return dispatch((0, exports.closeNotification)(id)); }, timeOut);
         }
     };
 };
 exports.showNotification = showNotification;
 var setFlashes = function (flashes) { return Object.keys(flashes).map(function (level) { return []
     .concat(flashes[level] || [])
-    .map(function (message) { return exports.showNotification(message, level); }); }); };
+    .map(function (message) { return (0, exports.showNotification)(message, level); }); }); };
 exports.setFlashes = setFlashes;

package/actions/router.d.ts

@@ -1,4 +1,4 @@
-declare type TParams = Record<string, any> | null;
+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";

package/actions/router.js

@@ -43,7 +43,7 @@ var goToParent = function (level) {
         var parentRouteId = parentRoute ? parentRoute.id : null;
         var parentRouteParams = parentRoute ? params : null;
         if (parentRouteId) {
-            return dispatch(exports.goToRoute(parentRouteId, parentRouteParams));
+            return dispatch((0, exports.goToRoute)(parentRouteId, parentRouteParams));
         }
         return [];
     };

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.d.ts

@@ -1,8 +1,44 @@
+export interface IClientStorageComponentConfig {
+    /**
+     * Кастомный домен
+     */
+    domain?: string;
+    /**
+     * Куки для режима ssr
+     */
+    ssrCookie?: any;
+}
+/**
+ * Интерфейс для ClientStorageComponent
+ */
+export interface IClientStorageComponent extends IClientStorageComponentConfig {
+    /**
+     * Получить значение из хранилища.
+     * @param name Имя записи.
+     * @param storageName (Необязательный) Имя хранилища (local, session, или cookie).
+     * @returns Значение записи.
+     */
+    get(name: string, storageName?: 'local' | 'session' | 'cookie'): string | null;
+    /**
+     * Установить значение в хранилище.
+     * @param name Имя записи.
+     * @param value Значение записи.
+     * @param storageName (Необязательный) Имя хранилища (local, session, или cookie).
+     * @param expires (Необязательный) Срок действия записи в днях.
+     */
+    set(name: string, value: string, storageName?: 'local' | 'session' | 'cookie', expires?: number | null): void;
+    /**
+     * Удалить значение из хранилища.
+     * @param name Имя записи.
+     * @param storageName (Необязательный) Имя хранилища (local, session, или cookie).
+     */
+    remove(name: string, storageName?: 'local' | 'session' | 'cookie'): void;
+}
 /**
  * Client Storage Component
  * Слой хранения данных в браузере (cookie, local/session storage) или ReactNative
  */
-export default class ClientStorageComponent {
+export default class ClientStorageComponent implements IClientStorageComponent {
     STORAGE_COOKIE: string;
     STORAGE_LOCAL: any;
     STORAGE_SESSION: any;
@@ -11,24 +47,8 @@ export default class ClientStorageComponent {
     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

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -22,8 +26,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 exports.__esModule = true;
+/* eslint-disable import/no-extraneous-dependencies */
+/* eslint-disable no-unused-expressions */
 var cookie = __importStar(require("js-cookie"));
-var moment_1 = __importDefault(require("moment"));
+var dayjs_1 = __importDefault(require("dayjs"));
 /**
  * Client Storage Component
  * Слой хранения данных в браузере (cookie, local/session storage) или ReactNative
@@ -48,7 +54,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) {
@@ -58,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) {
@@ -74,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;
@@ -96,16 +91,11 @@ var ClientStorageComponent = /** @class */ (function () {
                 domain: this._getDomain()
             };
             if (expires && process.env.IS_SSR) {
-                options.expires = moment_1["default"]().add(options.expires).utc().toDate();
+                options.expires = (0, dayjs_1["default"])().add(options.expires, 'days').utc().toDate();
             }
             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/HtmlComponent.js

@@ -39,7 +39,7 @@ var HtmlComponent = /** @class */ (function () {
             .join(' ');
     };
     HtmlComponent.prototype.addClass = function (node, className) {
-        if (node && isString_1["default"](node.className)) {
+        if (node && (0, isString_1["default"])(node.className)) {
             var classes = node.className.split(' ');
             if (classes.indexOf(className) === -1) {
                 classes.push(className);
@@ -48,7 +48,7 @@ var HtmlComponent = /** @class */ (function () {
         }
     };
     HtmlComponent.prototype.removeClass = function (node, className) {
-        if (node && isString_1["default"](node.className)) {
+        if (node && (0, isString_1["default"])(node.className)) {
             var classes = node.className.split(' ');
             var index = classes.indexOf(className);
             if (index !== -1) {
@@ -58,9 +58,11 @@ var HtmlComponent = /** @class */ (function () {
         }
     };
     HtmlComponent.prototype.closest = function (element, className) {
+        // eslint-disable-next-line no-cond-assign
         while ((element = element.parentElement)
+            // eslint-disable-next-line no-empty
             && !element.classList.contains(className)) {
-        } // eslint-disable-line no-empty
+        }
         return element;
     };
     HtmlComponent.prototype._applyModifiers = function (entity, modifiers) {