@steroidsjs/core 2.3.0-beta.7 → 3.0.0-beta.10

package/ui/nav/Router/ConnectedRouter.js

@@ -1,103 +1,107 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-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]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-exports.__esModule = true;
-var React = __importStar(require("react"));
-var react_router_1 = require("react-router");
-var isEqualWith_1 = __importDefault(require("lodash-es/isEqualWith"));
-var actions_1 = require("connected-react-router/lib/actions");
-var selectors_1 = __importDefault(require("connected-react-router/lib/selectors"));
-var plain_1 = __importDefault(require("connected-react-router/lib/structure/plain"));
-var ConnectedRouter = /** @class */ (function (_super) {
-    __extends(ConnectedRouter, _super);
-    function ConnectedRouter(props) {
-        var _this = _super.call(this, props) || this;
-        var store = props.store, history = props.history, stateCompareFunction = props.stateCompareFunction;
-        _this.inTimeTravelling = false;
-        // Subscribe to store changes to check if we are in time travelling
-        _this.unsubscribe = store.subscribe(function () {
-            // Extract store's location
-            var _a = selectors_1["default"](plain_1["default"]).getLocation(store.getState()), pathnameInStore = _a.pathname, searchInStore = _a.search, hashInStore = _a.hash, stateInStore = _a.state;
-            // Extract history's location
-            var _b = history.location, pathnameInHistory = _b.pathname, searchInHistory = _b.search, hashInHistory = _b.hash, stateInHistory = _b.state;
-            // If we do time travelling, the location in store is changed but location in history is not changed
-            if (props.history.action === 'PUSH'
-                && (pathnameInHistory !== pathnameInStore
-                    || searchInHistory !== searchInStore
-                    || hashInHistory !== hashInStore
-                    || !isEqualWith_1["default"](stateInStore, stateInHistory, stateCompareFunction))) {
-                _this.inTimeTravelling = true;
-                // Update history's location to match store's location
-                history.push({
-                    pathname: pathnameInStore,
-                    search: searchInStore,
-                    hash: hashInStore,
-                    state: stateInStore
-                });
-            }
-        });
-        var handleLocationChange = function (location, action, isFirstRendering) {
-            if (isFirstRendering === void 0) { isFirstRendering = false; }
-            // Dispatch onLocationChanged except when we're in time travelling
-            if (!_this.inTimeTravelling) {
-                _this.props.store.dispatch(actions_1.onLocationChanged(location, action, isFirstRendering));
-            }
-            else {
-                _this.inTimeTravelling = false;
-            }
-        };
-        // Listen to history changes
-        _this.unlisten = history.listen(handleLocationChange);
-        if (!props.noInitialPop) {
-            // Dispatch a location change action for the initial location.
-            // This makes it backward-compatible with react-router-redux.
-            // But, we add `isFirstRendering` to `true` to prevent double-rendering.
-            handleLocationChange(history.location, history.action, true);
-        }
-        return _this;
-    }
-    ConnectedRouter.prototype.componentWillUnmount = function () {
-        this.unlisten();
-        this.unsubscribe();
-    };
-    ConnectedRouter.prototype.render = function () {
-        return (React.createElement(react_router_1.Router, { history: this.props.history }, this.props.children));
-    };
-    return ConnectedRouter;
-}(React.PureComponent));
-exports["default"] = ConnectedRouter;
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = 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];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var React = __importStar(require("react"));
+var react_router_1 = require("react-router");
+var isEqualWith_1 = __importDefault(require("lodash-es/isEqualWith"));
+var actions_1 = require("connected-react-router/lib/actions");
+var selectors_1 = __importDefault(require("connected-react-router/lib/selectors"));
+var plain_1 = __importDefault(require("connected-react-router/lib/structure/plain"));
+var ConnectedRouter = /** @class */ (function (_super) {
+    __extends(ConnectedRouter, _super);
+    function ConnectedRouter(props) {
+        var _this = _super.call(this, props) || this;
+        var store = props.store, history = props.history, stateCompareFunction = props.stateCompareFunction;
+        _this.inTimeTravelling = false;
+        // Subscribe to store changes to check if we are in time travelling
+        _this.unsubscribe = store.subscribe(function () {
+            // Extract store's location
+            var _a = (0, selectors_1["default"])(plain_1["default"]).getLocation(store.getState()), pathnameInStore = _a.pathname, searchInStore = _a.search, hashInStore = _a.hash, stateInStore = _a.state;
+            // Extract history's location
+            var _b = history.location, pathnameInHistory = _b.pathname, searchInHistory = _b.search, hashInHistory = _b.hash, stateInHistory = _b.state;
+            // If we do time travelling, the location in store is changed but location in history is not changed
+            if (props.history.action === 'PUSH'
+                && (pathnameInHistory !== pathnameInStore
+                    || searchInHistory !== searchInStore
+                    || hashInHistory !== hashInStore
+                    || !(0, isEqualWith_1["default"])(stateInStore, stateInHistory, stateCompareFunction))) {
+                _this.inTimeTravelling = true;
+                // Update history's location to match store's location
+                history.push({
+                    pathname: pathnameInStore,
+                    search: searchInStore,
+                    hash: hashInStore,
+                    state: stateInStore
+                });
+            }
+        });
+        var handleLocationChange = function (location, action, isFirstRendering) {
+            if (isFirstRendering === void 0) { isFirstRendering = false; }
+            // Dispatch onLocationChanged except when we're in time travelling
+            if (!_this.inTimeTravelling) {
+                _this.props.store.dispatch((0, actions_1.onLocationChanged)(location, action, isFirstRendering));
+            }
+            else {
+                _this.inTimeTravelling = false;
+            }
+        };
+        // Listen to history changes
+        _this.unlisten = history.listen(handleLocationChange);
+        if (!props.noInitialPop) {
+            // Dispatch a location change action for the initial location.
+            // This makes it backward-compatible with react-router-redux.
+            // But, we add `isFirstRendering` to `true` to prevent double-rendering.
+            handleLocationChange(history.location, history.action, true);
+        }
+        return _this;
+    }
+    ConnectedRouter.prototype.componentWillUnmount = function () {
+        this.unlisten();
+        this.unsubscribe();
+    };
+    ConnectedRouter.prototype.render = function () {
+        return (React.createElement(react_router_1.Router, { history: this.props.history }, this.props.children));
+    };
+    return ConnectedRouter;
+}(React.PureComponent));
+exports["default"] = ConnectedRouter;

package/ui/nav/Router/Router.d.ts

@@ -1,157 +1,157 @@
-import * as React from 'react';
-import { IFetchConfig } from '../../../hooks/useFetch';
-import { IListProps } from '../../list/List/List';
-import { IFetchHocConfigFunc } from '../../../hoc/fetch';
-export declare const ROUTER_ROLE_LOGIN = "login";
-export declare const ROUTER_ROLE_MODAL = "modal";
-export declare const ROUTER_ROLE_404 = "404";
-/**
- * Router
- * Маршрутизатор.
- * Компонент получает общий для приложения шаблон и дерево роутов. Из дерева роутов посредством React Router
- * образуется switch-конструкция, которая в зависимости от текущего пути рендерит соответствующий компонент страницы.
- * Или осуществляет редирект на другую страницу. Все страницы оборачиваются в переданный шаблон.
- */
-export interface IRouteItem {
-    /**
-     * Идентификатор роута
-     * @example 'catalog'
-     */
-    id?: string;
-    /**
-     * Текст, который отобразится на кнопке навигации для данного роута
-     * @example 'Каталог'
-     */
-    label?: string;
-    /**
-     * Заголовок страницы
-     * @example 'Каталог'
-     */
-    title?: string;
-    /**
-     * Путь до роута
-     * @example '/catalog'
-     */
-    path?: string;
-    /**
-     * Если true, то путь должен точно соответствовать location.pathname
-     * @example '/catalog'
-     */
-    exact?: boolean;
-    /**
-     * В свойстве можно передать как путь, на который осуществится редирект, так и булево значение.
-     * Если свойство равно true - то редирект произойдет на первый из вложенных роутов.
-     * @example true
-     */
-    redirectTo?: boolean | string;
-    /**
-     * Компонент страницы, который отобразится, если путь будет соответствовать location.pathname
-     * @example CatalogPage
-     */
-    component?: any;
-    /**
-     * Свойства для компонента страницы
-     */
-    componentProps?: any;
-    /**
-     * Тип шаблона для данного роута
-     * @example 'dark'
-     */
-    layout?: string;
-    /**
-     * Отображать или показывать роут
-     * @example true
-     */
-    isVisible?: boolean;
-    /**
-     * Отображать ссылку или кнопку в навигации для перехода на данный роут
-     * @example false
-     */
-    isNavVisible?: boolean;
-    /**
-     * Название или список с названиями моделей, полученных с бэкенда
-     */
-    models?: string | string[];
-    /**
-     * Название или список с названиями перечислений, полученных с бэкенда
-     */
-    enums?: string | string[];
-    /**
-     * Назначение страницы, указывается, чтобы приложение автоматически могло найти страницу авторизации или 404-ю..
-     * @example 'login'
-     */
-    role?: 'login' | 'modal' | '404' | string;
-    /**
-     * Список с ролями, который показывает, кому из пользователей будет доступен просмотр страницы
-     * @example ['user', 'admin']
-     */
-    roles?: string[];
-    /**
-     * Обработчик, который возвращает конфигурацию для осуществления HTTP-запроса. Запрос происходит каждый раз
-     * перед рендерингом страницы, чтобы получить для неё все необходимые данные
-     * @param {*} props
-     * @return {Object} Например, {url: '/api/v1/some-data', key: 'someData'}
-     */
-    fetch?: IFetchHocConfigFunc;
-    /**
-     * Вложенные роуты
-     */
-    items?: IRouteItem[] | {
-        [key: string]: IRouteItem;
-    };
-    /**
-     * Обработчик, который принимает параметры URL и возвращает массив с пропсами для хука useFetch и компонента
-     * List.
-     * Функция запускается перед рендерингом приложения в режиме SSR и используется для предварительной
-     * загрузки данных, необходимых на текущей странице.
-     * Хук useFetch и компонент List не будут повторно инициализироваться и делать запросы на клиенте,
-     * если подгруженные данные существуют.
-     * @param {Object} match
-     * @return {Array} Например, [{url: '/api/v1/some-data'}, {listId: 'someList', action: '/api/v1/some-list'}]
-     */
-    preloadData?: (match: Record<string, any>) => (IFetchConfig | IListProps)[];
-    [key: string]: any;
-}
-export interface IRouterProps {
-    /**
-     * Общий шаблон, который оборачивает страницы приложения
-     * @example Layout
-     */
-    wrapperView?: any;
-    /**
-     * Свойства шаблона
-     */
-    wrapperProps?: any;
-    /**
-     * Дерево роутов
-     * @example {id: 'root', path: '/', component: IndexPage, items: [...]}
-     */
-    routes?: IRouteItem[] | {
-        [key: string]: IRouteItem;
-    };
-    /**
-     * Если у роута не задано свойство roles, которое определяет, кому из пользователей будет доступен контент
-     * на соответствующей странице, то подставится стандартный список с ролями
-     * @example [null, 'user', 'admin']
-     */
-    defaultRoles?: string[];
-    /**
-     * Прокрутить страницу к началу при смене url
-     * @example true
-     */
-    autoScrollTop?: boolean;
-    /**
-     * Контент, который отобразится под каждой страницей приложения
-     * @example SomeComponent
-     */
-    children?: React.ReactNode;
-}
-export declare const walkRoutesRecursive: (item: any, defaultItem?: any, parentItem?: any) => any;
-export declare const treeToList: (item: any, isRoot?: boolean) => any;
-declare function Router(props: IRouterProps): JSX.Element;
-declare namespace Router {
-    var defaultProps: {
-        autoScrollTop: boolean;
-    };
-}
-export default Router;
+import * as React from 'react';
+import { IFetchConfig } from '../../../hooks/useFetch';
+import { IListProps } from '../../list/List/List';
+import { IFetchHocConfigFunc } from '../../../hoc/fetch';
+export declare const ROUTER_ROLE_LOGIN = "login";
+export declare const ROUTER_ROLE_MODAL = "modal";
+export declare const ROUTER_ROLE_404 = "404";
+/**
+ * Router
+ * Маршрутизатор.
+ * Компонент получает общий для приложения шаблон и дерево роутов. Из дерева роутов посредством React Router
+ * образуется switch-конструкция, которая в зависимости от текущего пути рендерит соответствующий компонент страницы.
+ * Или осуществляет редирект на другую страницу. Все страницы оборачиваются в переданный шаблон.
+ */
+export interface IRouteItem {
+    /**
+     * Идентификатор роута
+     * @example 'catalog'
+     */
+    id?: string;
+    /**
+     * Текст, который отобразится на кнопке навигации для данного роута
+     * @example 'Каталог'
+     */
+    label?: string;
+    /**
+     * Заголовок страницы
+     * @example 'Каталог'
+     */
+    title?: string;
+    /**
+     * Путь до роута
+     * @example '/catalog'
+     */
+    path?: string;
+    /**
+     * Если true, то путь должен точно соответствовать location.pathname
+     * @example '/catalog'
+     */
+    exact?: boolean;
+    /**
+     * В свойстве можно передать как путь, на который осуществится редирект, так и булево значение.
+     * Если свойство равно true - то редирект произойдет на первый из вложенных роутов.
+     * @example true
+     */
+    redirectTo?: boolean | string;
+    /**
+     * Компонент страницы, который отобразится, если путь будет соответствовать location.pathname
+     * @example CatalogPage
+     */
+    component?: any;
+    /**
+     * Свойства для компонента страницы
+     */
+    componentProps?: any;
+    /**
+     * Тип шаблона для данного роута
+     * @example 'dark'
+     */
+    layout?: string;
+    /**
+     * Отображать или показывать роут
+     * @example true
+     */
+    isVisible?: boolean;
+    /**
+     * Отображать ссылку или кнопку в навигации для перехода на данный роут
+     * @example false
+     */
+    isNavVisible?: boolean;
+    /**
+     * Название или список с названиями моделей, полученных с бэкенда
+     */
+    models?: string | string[];
+    /**
+     * Название или список с названиями перечислений, полученных с бэкенда
+     */
+    enums?: string | string[];
+    /**
+     * Назначение страницы, указывается, чтобы приложение автоматически могло найти страницу авторизации или 404-ю..
+     * @example 'login'
+     */
+    role?: 'login' | 'modal' | '404' | string;
+    /**
+     * Список с ролями, который показывает, кому из пользователей будет доступен просмотр страницы
+     * @example ['user', 'admin']
+     */
+    roles?: Array<string | null>;
+    /**
+     * Обработчик, который возвращает конфигурацию для осуществления HTTP-запроса. Запрос происходит каждый раз
+     * перед рендерингом страницы, чтобы получить для неё все необходимые данные
+     * @param {*} props
+     * @return {Object} Например, {url: '/api/v1/some-data', key: 'someData'}
+     */
+    fetch?: IFetchHocConfigFunc;
+    /**
+     * Вложенные роуты
+     */
+    items?: IRouteItem[] | {
+        [key: string]: IRouteItem;
+    };
+    /**
+     * Обработчик, который принимает параметры URL и возвращает массив с пропсами для хука useFetch и компонента
+     * List.
+     * Функция запускается перед рендерингом приложения в режиме SSR и используется для предварительной
+     * загрузки данных, необходимых на текущей странице.
+     * Хук useFetch и компонент List не будут повторно инициализироваться и делать запросы на клиенте,
+     * если подгруженные данные существуют.
+     * @param {Object} match
+     * @return {Array} Например, [{url: '/api/v1/some-data'}, {listId: 'someList', action: '/api/v1/some-list'}]
+     */
+    preloadData?: (match: Record<string, any>) => (IFetchConfig | IListProps)[];
+    [key: string]: any;
+}
+export interface IRouterProps {
+    /**
+     * Общий шаблон, который оборачивает страницы приложения
+     * @example Layout
+     */
+    wrapperView?: any;
+    /**
+     * Свойства шаблона
+     */
+    wrapperProps?: any;
+    /**
+     * Дерево роутов
+     * @example {id: 'root', path: '/', component: IndexPage, items: [...]}
+     */
+    routes?: IRouteItem[] | {
+        [key: string]: IRouteItem;
+    };
+    /**
+     * Если у роута не задано свойство roles, которое определяет, кому из пользователей будет доступен контент
+     * на соответствующей странице, то подставится стандартный список с ролями
+     * @example [null, 'user', 'admin']
+     */
+    defaultRoles?: string[];
+    /**
+     * Прокрутить страницу к началу при смене url
+     * @example true
+     */
+    autoScrollTop?: boolean;
+    /**
+     * Контент, который отобразится под каждой страницей приложения
+     * @example SomeComponent
+     */
+    children?: React.ReactNode;
+}
+export declare const walkRoutesRecursive: (item: any, defaultItem?: any, parentItem?: any) => any;
+export declare const treeToList: (item: any, isRoot?: boolean) => any;
+declare function Router(props: IRouterProps): JSX.Element;
+declare namespace Router {
+    var defaultProps: {
+        autoScrollTop: boolean;
+    };
+}
+export default Router;