@singularsystems/neo-react 1.0.0-alpha.2 → 1.0.0-beta.0

package/dist/Routing/PageLeaveHandler.js

@@ -1,74 +1,74 @@
-import { __awaiter, __decorate, __generator, __metadata, __param } from "tslib";
-import { Routing, ModalUtils, Misc, AppServices } from '@singularsystems/neo-core';
-import ViewBase from '../Views/ViewBase';
-import { inject, injectable } from 'inversify';
-import { NeoReactTypes } from '../Modules/Types';
-import { RoutingState } from './RoutingState';
-var PageLeaveHandler = /** @class */ (function () {
-    function PageLeaveHandler(routingState) {
-        this.routingState = routingState;
-    }
-    /**
-     * Handler for react-routers BrowserRouter.getUserConfirmation
-     */
-    PageLeaveHandler.showNavigationConfirmation = function (prompt, callback) {
-        return __awaiter(this, void 0, void 0, function () {
-            var result;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, Misc.Globals.appService.get(AppServices.NeoTypes.Routing.PageLeaveHandler).onLeavePage(ViewBase.currentView, prompt, Routing.NavigateLocation.Internal)];
-                    case 1:
-                        result = _a.sent();
-                        callback(result);
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    PageLeaveHandler.prototype.onWindowUnload = function (view, e) {
-        if (view) {
-            var routeView = Misc.Globals.appService.get(NeoReactTypes.Routing.GlobalRoutingState).currentRouteView;
-            var prompt_1 = routeView.beforeLocationChanged(undefined, "PUSH", true);
-            if (prompt_1 || prompt_1 === false || prompt_1 === "") {
-                e.preventDefault();
-                e.returnValue = !prompt_1 ? "Are you sure you want to continue?" : prompt_1;
-            }
-        }
-    };
-    PageLeaveHandler.prototype.onLeavePage = function (view, prompt, location) {
-        if (this.routingState.leavePromise) {
-            var promise_1 = this.routingState.leavePromise;
-            this.routingState.leavePromise = undefined;
-            return new Promise(function (resolve) {
-                promise_1.then(function (result) {
-                    if (result) {
-                        resolve(result === true || result === Misc.ModalResult.Yes);
-                    }
-                    else {
-                        resolve(false);
-                    }
-                });
-            });
-        }
-        else {
-            return this.showDefaultConfirmation(view, prompt, location);
-        }
-    };
-    PageLeaveHandler.prototype.showDefaultConfirmation = function (view, prompt, location) {
-        var title = view ? view.viewName : "Un-saved Changes";
-        return new Promise(function (resolve) {
-            ModalUtils.showModal(title, prompt, {
-                onClose: function () { return resolve(false); },
-                acceptButton: { text: "Leave", onClick: function () { return resolve(true); } },
-                closeButton: { text: "Stay", onClick: function () { return resolve(false); } }
-            });
-        });
-    };
-    PageLeaveHandler = __decorate([
-        injectable(),
-        __param(0, inject(NeoReactTypes.Routing.GlobalRoutingState.symbol)),
-        __metadata("design:paramtypes", [RoutingState])
-    ], PageLeaveHandler);
-    return PageLeaveHandler;
-}());
-export { PageLeaveHandler };
+import { __awaiter, __decorate, __generator, __metadata, __param } from "tslib";
+import { Routing, ModalUtils, Misc, AppServices } from '@singularsystems/neo-core';
+import { inject, injectable } from 'inversify';
+import { NeoReactTypes } from '../Modules/Types';
+import { RoutingState } from './RoutingState';
+export var PageLeaveHandler = /** @class */ (function () {
+    function PageLeaveHandler(routingState) {
+        this.routingState = routingState;
+    }
+    /**
+     * Handler for react-routers BrowserRouter.getUserConfirmation
+     */
+    PageLeaveHandler.showNavigationConfirmation = function (prompt, callback) {
+        return __awaiter(this, void 0, void 0, function () {
+            var pageLeaveHandler, routingState, result;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        pageLeaveHandler = Misc.Globals.appService.get(AppServices.NeoTypes.Routing.PageLeaveHandler), routingState = Misc.Globals.appService.get(NeoReactTypes.Routing.GlobalRoutingState);
+                        return [4 /*yield*/, pageLeaveHandler.onLeavePage(routingState.currentView, prompt, Routing.NavigateLocation.Internal)];
+                    case 1:
+                        result = _a.sent();
+                        callback(result);
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    PageLeaveHandler.prototype.onWindowUnload = function (view, e) {
+        if (view) {
+            var routeView = Misc.Globals.appService.get(NeoReactTypes.Routing.GlobalRoutingState).currentRouteView;
+            var prompt_1 = routeView.beforeLocationChanged(undefined, "PUSH", true);
+            if (prompt_1 || prompt_1 === false || prompt_1 === "") {
+                e.preventDefault();
+                e.returnValue = !prompt_1 ? "Are you sure you want to continue?" : prompt_1;
+            }
+        }
+    };
+    PageLeaveHandler.prototype.onLeavePage = function (view, prompt, location) {
+        if (this.routingState.leavePromise) {
+            var promise_1 = this.routingState.leavePromise;
+            this.routingState.leavePromise = undefined;
+            return new Promise(function (resolve) {
+                promise_1.then(function (result) {
+                    if (result) {
+                        resolve(result === true || result === Misc.ModalResult.Yes);
+                    }
+                    else {
+                        resolve(false);
+                    }
+                });
+            });
+        }
+        else {
+            return this.showDefaultConfirmation(view, prompt, location);
+        }
+    };
+    PageLeaveHandler.prototype.showDefaultConfirmation = function (view, prompt, location) {
+        var title = view ? view.viewName : "Un-saved Changes";
+        return new Promise(function (resolve) {
+            ModalUtils.showModal(title, prompt, {
+                onClose: function () { return resolve(false); },
+                acceptButton: { text: "Leave", onClick: function () { return resolve(true); } },
+                closeButton: { text: "Stay", onClick: function () { return resolve(false); } }
+            });
+        });
+    };
+    PageLeaveHandler = __decorate([
+        injectable(),
+        __param(0, inject(NeoReactTypes.Routing.GlobalRoutingState.symbol)),
+        __metadata("design:paramtypes", [RoutingState])
+    ], PageLeaveHandler);
+    return PageLeaveHandler;
+}());

package/dist/Routing/RouteProvider.d.ts

@@ -1,31 +1,31 @@
-import { Routing } from '@singularsystems/neo-core';
-import React from 'react';
-export interface IProcessedRoute extends Routing.IRoute {
-    key: number;
-    /** Path including parameters */
-    routePath: string;
-}
-export default class RouteProvider {
-    menuRoutes: Routing.IMenuRoute[];
-    pureRoutes?: Routing.IRoute[] | undefined;
-    notFoundRoute?: React.ComponentType<{}> | undefined;
-    private key;
-    private routeIndex;
-    private paramRoutes;
-    flattenedRoutes: IProcessedRoute[];
-    /**
-     * Creates a route provider which provides a list of flattened routes.
-     * @param menuRoutes Routes which appear on the main menu.
-     * @param pureRoutes Routes which don't have a menu item.
-     * @param notFoundRoute Route to render when the url doesn't match any of the above routes.
-     */
-    constructor(menuRoutes: Routing.IMenuRoute[], pureRoutes?: Routing.IRoute[] | undefined, notFoundRoute?: React.ComponentType<{}> | undefined);
-    /** Gets the path the component is bound to. If the component is bound to multiple paths, the first path is returned. */
-    getPathForComponent(component: any): string | undefined;
-    private flatten;
-    /**
-     * Create a copy of the route info, and process it.
-     * Adds a unique key, and adds route parameters extracted from the component static params object.
-     */
-    private processRoute;
-}
+import { Routing } from '@singularsystems/neo-core';
+import React from 'react';
+export interface IProcessedRoute extends Routing.IRoute {
+    key: number;
+    /** Path including parameters */
+    routePath: string;
+}
+export default class RouteProvider {
+    menuRoutes: Routing.IMenuRoute[];
+    pureRoutes?: Routing.IRoute[] | undefined;
+    notFoundRoute?: React.ComponentType<{}> | undefined;
+    private key;
+    private routeIndex;
+    private paramRoutes;
+    flattenedRoutes: IProcessedRoute[];
+    /**
+     * Creates a route provider which provides a list of flattened routes.
+     * @param menuRoutes Routes which appear on the main menu.
+     * @param pureRoutes Routes which don't have a menu item.
+     * @param notFoundRoute Route to render when the url doesn't match any of the above routes.
+     */
+    constructor(menuRoutes: Routing.IMenuRoute[], pureRoutes?: Routing.IRoute[] | undefined, notFoundRoute?: React.ComponentType<{}> | undefined);
+    /** Gets the path the component is bound to. If the component is bound to multiple paths, the first path is returned. */
+    getPathForComponent(component: any): string | undefined;
+    private flatten;
+    /**
+     * Create a copy of the route info, and process it.
+     * Adds a unique key, and adds route parameters extracted from the component static params object.
+     */
+    private processRoute;
+}

package/dist/Routing/RouteProvider.js

@@ -1,92 +1,92 @@
-import { __assign, __spreadArray } from "tslib";
-import { MenuRoute } from './MenuRoute';
-var RouteProvider = /** @class */ (function () {
-    /**
-     * Creates a route provider which provides a list of flattened routes.
-     * @param menuRoutes Routes which appear on the main menu.
-     * @param pureRoutes Routes which don't have a menu item.
-     * @param notFoundRoute Route to render when the url doesn't match any of the above routes.
-     */
-    function RouteProvider(menuRoutes, pureRoutes, notFoundRoute) {
-        var _a;
-        this.menuRoutes = menuRoutes;
-        this.pureRoutes = pureRoutes;
-        this.notFoundRoute = notFoundRoute;
-        this.key = 1;
-        this.routeIndex = {};
-        this.paramRoutes = [];
-        this.flattenedRoutes = [];
-        this.flatten(menuRoutes);
-        if (pureRoutes)
-            this.flatten(pureRoutes);
-        /*
-        Routes with template parameters must be added last so concrete routes resolve first.
-        E.g.
-            /clients/subview - SubViewComponent
-            /clients/:param - ClientsComponent
-
-        If the above was swapped around, ClientsComponent would match instead of SubViewComponent for /clients/subview.
-        */
-        (_a = this.flattenedRoutes).push.apply(_a, this.paramRoutes.sortBy("order", "desc").map(function (c) { return c.route; }));
-        if (notFoundRoute) {
-            this.flattenedRoutes.push({ component: notFoundRoute, key: -1, allowAnonymous: true, routePath: "" });
-        }
-    }
-    /** Gets the path the component is bound to. If the component is bound to multiple paths, the first path is returned. */
-    RouteProvider.prototype.getPathForComponent = function (component) {
-        var _a;
-        return (_a = this.flattenedRoutes.find(function (c) { return c.component === component; })) === null || _a === void 0 ? void 0 : _a.path;
-    };
-    RouteProvider.prototype.flatten = function (routes, parent) {
-        var _a, _b;
-        for (var _i = 0, routes_1 = routes; _i < routes_1.length; _i++) {
-            var route = routes_1[_i];
-            var hasComponent = route.path && route.component;
-            if (hasComponent) {
-                if (parent && !route.breadCrumbParent) {
-                    route.breadCrumbParent = parent;
-                }
-                this.processRoute(route);
-            }
-            var menuRoute = route;
-            var children = __spreadArray(__spreadArray([], ((_a = route.routeChildren) !== null && _a !== void 0 ? _a : []), true), ((_b = menuRoute.children) !== null && _b !== void 0 ? _b : []), true);
-            this.flatten(children, (hasComponent && menuRoute.showInBreadCrumb !== false) ? menuRoute : undefined);
-        }
-    };
-    /**
-     * Create a copy of the route info, and process it.
-     * Adds a unique key, and adds route parameters extracted from the component static params object.
-     */
-    RouteProvider.prototype.processRoute = function (route) {
-        var processed = __assign(__assign({}, route), { routePath: route.path, key: this.key++ });
-        var isParamRoute = false;
-        if (route instanceof MenuRoute) {
-            processed.routePath = route.basePath;
-        }
-        var viewBaseComponent = route.component;
-        if (viewBaseComponent.params) {
-            if (processed.routePath.endsWith("/")) {
-                processed.routePath = processed.routePath.substring(0, processed.routePath.length - 1);
-            }
-            for (var param in viewBaseComponent.params) {
-                var routeParam = viewBaseComponent.params[param];
-                if (!routeParam.isQuery) {
-                    isParamRoute = true;
-                    processed.routePath += "/:" + param + (routeParam.required ? "" : "?");
-                }
-            }
-        }
-        if (!this.routeIndex[processed.routePath]) {
-            this.routeIndex[processed.routePath] = true;
-            if (isParamRoute) {
-                // Must be ordered later by the number of slashes in the path. Root path is a special case.
-                this.paramRoutes.push({ route: processed, order: route.path === "/" ? 0 : (route.path.match(/\//g) || []).length });
-            }
-            else {
-                this.flattenedRoutes.push(processed);
-            }
-        }
-    };
-    return RouteProvider;
-}());
-export default RouteProvider;
+import { __assign, __spreadArray } from "tslib";
+import { MenuRoute } from './MenuRoute';
+var RouteProvider = /** @class */ (function () {
+    /**
+     * Creates a route provider which provides a list of flattened routes.
+     * @param menuRoutes Routes which appear on the main menu.
+     * @param pureRoutes Routes which don't have a menu item.
+     * @param notFoundRoute Route to render when the url doesn't match any of the above routes.
+     */
+    function RouteProvider(menuRoutes, pureRoutes, notFoundRoute) {
+        var _a;
+        this.menuRoutes = menuRoutes;
+        this.pureRoutes = pureRoutes;
+        this.notFoundRoute = notFoundRoute;
+        this.key = 1;
+        this.routeIndex = {};
+        this.paramRoutes = [];
+        this.flattenedRoutes = [];
+        this.flatten(menuRoutes);
+        if (pureRoutes)
+            this.flatten(pureRoutes);
+        /*
+        Routes with template parameters must be added last so concrete routes resolve first.
+        E.g.
+            /clients/subview - SubViewComponent
+            /clients/:param - ClientsComponent
+
+        If the above was swapped around, ClientsComponent would match instead of SubViewComponent for /clients/subview.
+        */
+        (_a = this.flattenedRoutes).push.apply(_a, this.paramRoutes.sortBy("order", "desc").map(function (c) { return c.route; }));
+        if (notFoundRoute) {
+            this.flattenedRoutes.push({ component: notFoundRoute, key: -1, allowAnonymous: true, routePath: "" });
+        }
+    }
+    /** Gets the path the component is bound to. If the component is bound to multiple paths, the first path is returned. */
+    RouteProvider.prototype.getPathForComponent = function (component) {
+        var _a;
+        return (_a = this.flattenedRoutes.find(function (c) { return c.component === component; })) === null || _a === void 0 ? void 0 : _a.path;
+    };
+    RouteProvider.prototype.flatten = function (routes, parent) {
+        var _a, _b;
+        for (var _i = 0, routes_1 = routes; _i < routes_1.length; _i++) {
+            var route = routes_1[_i];
+            var hasComponent = route.path && route.component;
+            if (hasComponent) {
+                if (parent && !route.breadCrumbParent) {
+                    route.breadCrumbParent = parent;
+                }
+                this.processRoute(route);
+            }
+            var menuRoute = route;
+            var children = __spreadArray(__spreadArray([], ((_a = route.routeChildren) !== null && _a !== void 0 ? _a : []), true), ((_b = menuRoute.children) !== null && _b !== void 0 ? _b : []), true);
+            this.flatten(children, (hasComponent && menuRoute.showInBreadCrumb !== false) ? menuRoute : undefined);
+        }
+    };
+    /**
+     * Create a copy of the route info, and process it.
+     * Adds a unique key, and adds route parameters extracted from the component static params object.
+     */
+    RouteProvider.prototype.processRoute = function (route) {
+        var processed = __assign(__assign({}, route), { routePath: route.path, key: this.key++ });
+        var isParamRoute = false;
+        if (route instanceof MenuRoute) {
+            processed.routePath = route.basePath;
+        }
+        var viewBaseComponent = route.component;
+        if (viewBaseComponent.params) {
+            if (processed.routePath.endsWith("/")) {
+                processed.routePath = processed.routePath.substring(0, processed.routePath.length - 1);
+            }
+            for (var param in viewBaseComponent.params) {
+                var routeParam = viewBaseComponent.params[param];
+                if (!routeParam.isQuery) {
+                    isParamRoute = true;
+                    processed.routePath += "/:" + param + (routeParam.required ? "" : "?");
+                }
+            }
+        }
+        if (!this.routeIndex[processed.routePath]) {
+            this.routeIndex[processed.routePath] = true;
+            if (isParamRoute) {
+                // Must be ordered later by the number of slashes in the path. Root path is a special case.
+                this.paramRoutes.push({ route: processed, order: route.path === "/" ? 0 : (route.path.match(/\//g) || []).length });
+            }
+            else {
+                this.flattenedRoutes.push(processed);
+            }
+        }
+    };
+    return RouteProvider;
+}());
+export default RouteProvider;

package/dist/Routing/RouteView.d.ts

@@ -1,50 +1,50 @@
-import * as React from 'react';
-import { RouteComponentProps, Switch, Route } from 'react-router';
-import { Location, Action } from 'history';
-import { Routing } from '@singularsystems/neo-core';
-import RouteProvider from './RouteProvider';
-import { IRouteChangedProps } from './IRouteChangedProps';
-export interface IRouteViewInternal {
-    beforeLocationChanged(location: Location | undefined, action: Action, isUnload?: boolean): string | false | void;
-}
-export default abstract class RouteView extends React.Component<RouteComponentProps> {
-    private historyListenDisposer?;
-    private historyBlockDisposer?;
-    protected switchComponent: typeof Switch;
-    protected routeComponent: typeof Route;
-    protected _routes: RouteProvider;
-    protected getForbiddenComponent: (route: Routing.IRoute) => JSX.Element;
-    protected getSigningInComponent: (route: Routing.IRoute) => JSX.Element;
-    protected securityService: import("@singularsystems/neo-core/dist/Security/ISecurityService").default;
-    protected routeSecurityService: Routing.IRouteSecurityService;
-    protected routingState: import("./RoutingState").RoutingState;
-    constructor(props: RouteComponentProps);
-    get routes(): RouteProvider;
-    set routes(value: RouteProvider);
-    componentDidMount(): void;
-    componentDidUpdate(): void;
-    componentWillUnmount(): void;
-    private beforeLocationChanged;
-    /**
-     * Called when the url changes, before the router renders the new view.
-     * Return a string to block navigation.
-     * @param isNewView True if the view is changing. False if a view parameter value is changing.
-     * @param currentView The current view before change.
-     */
-    protected beforeRouteChanged(props: IRouteChangedProps): void;
-    private getMatch;
-    static isExact(route: Routing.IRoute): boolean;
-    render(): React.CElement<import("react-router").SwitchProps, Switch>;
-    private getRouteComponent;
-    /**
-     * Creates the routes component after authentication and authorisation checks have been done.
-     * This can be used to override all routes to display pages like terms and conditions.
-     * To redirect to a route, return a react router <Redirect to= /> component.
-     */
-    protected getAuthorisedComponent(route: Routing.IRoute, path: string): JSX.Element;
-    /**
-     * Checks if the user is authorised to access this route.
-     * Component from getForbiddenComponent() is returned if not.
-     */
-    protected isAuthorised(route: Routing.IRoute): boolean;
-}
+import * as React from 'react';
+import { RouteComponentProps, Switch, Route } from 'react-router';
+import { Location, Action } from 'history';
+import { Routing } from '@singularsystems/neo-core';
+import RouteProvider from './RouteProvider';
+import { IRouteChangedProps } from './IRouteChangedProps';
+export interface IRouteViewInternal {
+    beforeLocationChanged(location: Location | undefined, action: Action, isUnload?: boolean): string | false | void;
+}
+export default abstract class RouteView extends React.Component<RouteComponentProps> {
+    private historyListenDisposer?;
+    private historyBlockDisposer?;
+    protected switchComponent: typeof Switch;
+    protected routeComponent: typeof Route;
+    protected _routes: RouteProvider;
+    protected getForbiddenComponent: (route: Routing.IRoute) => JSX.Element;
+    protected getSigningInComponent: (route: Routing.IRoute) => JSX.Element;
+    protected securityService: import("@singularsystems/neo-core/dist/Security/ISecurityService").default;
+    protected routeSecurityService: Routing.IRouteSecurityService;
+    protected routingState: import("./RoutingState").RoutingState;
+    constructor(props: RouteComponentProps);
+    get routes(): RouteProvider;
+    set routes(value: RouteProvider);
+    componentDidMount(): void;
+    componentDidUpdate(): void;
+    componentWillUnmount(): void;
+    private beforeLocationChanged;
+    /**
+     * Called when the url changes, before the router renders the new view.
+     * Return a string to block navigation.
+     * @param isNewView True if the view is changing. False if a view parameter value is changing.
+     * @param currentView The current view before change.
+     */
+    protected beforeRouteChanged(props: IRouteChangedProps): void;
+    private getMatch;
+    static isExact(route: Routing.IRoute): boolean;
+    render(): React.CElement<import("react-router").SwitchProps, Switch>;
+    private getRouteComponent;
+    /**
+     * Creates the routes component after authentication and authorisation checks have been done.
+     * This can be used to override all routes to display pages like terms and conditions.
+     * To redirect to a route, return a react router <Redirect to= /> component.
+     */
+    protected getAuthorisedComponent(route: Routing.IRoute, path: string): JSX.Element;
+    /**
+     * Checks if the user is authorised to access this route.
+     * Component from getForbiddenComponent() is returned if not.
+     */
+    protected isAuthorised(route: Routing.IRoute): boolean;
+}