@singularsystems/neo-core 1.0.0-alpha.2 → 1.0.0-alpha.4

package/dist/Routing/IRoute.d.ts

@@ -1,27 +1,27 @@
-/**
- * Describes a top level component, its bound path, and security information.
- */
-export interface IRoute {
-    /** Name to show in breadcrumb  */
-    name?: string;
-    /** True if the route can be accessed with no authentication. */
-    allowAnonymous?: boolean;
-    /** Role required for this route. */
-    role?: string;
-    /** User must have 1 of these roles to view this route. */
-    anyRoles?: string[];
-    /** Match on exact path? Set this to true if this is a parent route which has sub routes. */
-    exact?: boolean;
-    /** Path on which the route will match.
-     * This is also the path which will be used for links on a menu component.
-     * Do not specify parameters here, they will be added automatically from the components parameters. */
-    path?: string;
-    /** Component to display in route view on master page */
-    component?: any;
-    /** True if this item should be displayed in it's childrens' breadcrumbs. Only applies if name, path and component are also specified. */
-    showInBreadCrumb?: boolean;
-    /** Parent item to show in this item's breadcrumb. */
-    breadCrumbParent?: IRoute;
-    /** Child routes which must not show in a menu. The breadCrumbParent property of each child will be set to this route. */
-    routeChildren?: IRoute[];
-}
+/**
+ * Describes a top level component, its bound path, and security information.
+ */
+export interface IRoute {
+    /** Name to show in breadcrumb  */
+    name?: string;
+    /** True if the route can be accessed with no authentication. */
+    allowAnonymous?: boolean;
+    /** Role required for this route. */
+    role?: string;
+    /** User must have 1 of these roles to view this route. */
+    anyRoles?: string[];
+    /** Match on exact path? Set this to true if this is a parent route which has sub routes. */
+    exact?: boolean;
+    /** Path on which the route will match.
+     * This is also the path which will be used for links on a menu component.
+     * Do not specify parameters here, they will be added automatically from the components parameters. */
+    path?: string;
+    /** Component to display in route view on master page */
+    component?: any;
+    /** True if this item should be displayed in it's childrens' breadcrumbs. Only applies if name, path and component are also specified. */
+    showInBreadCrumb?: boolean;
+    /** Parent item to show in this item's breadcrumb. */
+    breadCrumbParent?: IRoute;
+    /** Child routes which must not show in a menu. The breadCrumbParent property of each child will be set to this route. */
+    routeChildren?: IRoute[];
+}

package/dist/Routing/IRoute.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/Routing/IRouteSecurityService.d.ts

@@ -1,14 +1,14 @@
-import { IRoute } from "./IRoute";
-import { IMenuRoute } from './IMenuRoute';
-export interface IRouteSecurityService {
-    /**
-     * Checks if the route is allowed to render.
-     * @param route Route data.
-     */
-    routeAllowed(route: IRoute): boolean;
-    /**
-     * Checks if the menu item can be displayed.
-     * @param menuItem Menu item.
-     */
-    menuItemAllowed(menuItem: IMenuRoute): boolean;
-}
+import { IRoute } from "./IRoute";
+import { IMenuRoute } from './IMenuRoute';
+export interface IRouteSecurityService {
+    /**
+     * Checks if the route is allowed to render.
+     * @param route Route data.
+     */
+    routeAllowed(route: IRoute): boolean;
+    /**
+     * Checks if the menu item can be displayed.
+     * @param menuItem Menu item.
+     */
+    menuItemAllowed(menuItem: IMenuRoute): boolean;
+}

package/dist/Routing/IRouteSecurityService.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/Routing/MenuItemProvider.d.ts

@@ -1,17 +1,17 @@
-import { IMenuRoute } from './IMenuRoute';
-import { IMenuItemProvider } from './IMenuItemProvider';
-import { IRouteSecurityService } from './IRouteSecurityService';
-export declare class MenuItemProvider<TMenuItem extends IMenuRoute = IMenuRoute> implements IMenuItemProvider<TMenuItem> {
-    protected routeSecurityService: IRouteSecurityService;
-    constructor(routeSecurityService: IRouteSecurityService);
-    /**
-     * Processes a list of routes into a list of menu items for display in a menu component.
-     * @param routeItems List of items from the route provider.
-     * @param defaults Defaults to apply to menu items.
-     */
-    processRoutes(routeItems: TMenuItem[], defaults?: Partial<TMenuItem>): TMenuItem[];
-    /**
-     * Returns true if the menu item can be shown. Does not check children.
-     */
-    protected canShowItem(menuItem: TMenuItem): boolean;
-}
+import { IMenuRoute } from './IMenuRoute';
+import { IMenuItemProvider } from './IMenuItemProvider';
+import { IRouteSecurityService } from './IRouteSecurityService';
+export declare class MenuItemProvider<TMenuItem extends IMenuRoute = IMenuRoute> implements IMenuItemProvider<TMenuItem> {
+    protected routeSecurityService: IRouteSecurityService;
+    constructor(routeSecurityService: IRouteSecurityService);
+    /**
+     * Processes a list of routes into a list of menu items for display in a menu component.
+     * @param routeItems List of items from the route provider.
+     * @param defaults Defaults to apply to menu items.
+     */
+    processRoutes(routeItems: TMenuItem[], defaults?: Partial<TMenuItem>): TMenuItem[];
+    /**
+     * Returns true if the menu item can be shown. Does not check children.
+     */
+    protected canShowItem(menuItem: TMenuItem): boolean;
+}

package/dist/Routing/MenuItemProvider.js

@@ -1,54 +1,53 @@
-import { __assign, __decorate, __metadata, __param } from "tslib";
-import { injectable, inject } from 'inversify';
-import NeoTypes from '../AppServices/NeoTypes';
-var MenuItemProvider = /** @class */ (function () {
-    function MenuItemProvider(routeSecurityService) {
-        this.routeSecurityService = routeSecurityService;
-    }
-    /**
-     * Processes a list of routes into a list of menu items for display in a menu component.
-     * @param routeItems List of items from the route provider.
-     * @param defaults Defaults to apply to menu items.
-     */
-    MenuItemProvider.prototype.processRoutes = function (routeItems, defaults) {
-        if (defaults === void 0) { defaults = { hideWhenEmpty: true, collapseSingle: true }; }
-        var filtered = [];
-        for (var _i = 0, routeItems_1 = routeItems; _i < routeItems_1.length; _i++) {
-            var route = routeItems_1[_i];
-            var menuItem = __assign(__assign({}, defaults), route);
-            var canShow = this.canShowItem(menuItem);
-            if (canShow) {
-                if (menuItem.children) {
-                    menuItem.children = this.processRoutes(menuItem.children);
-                    if (!menuItem.path) {
-                        if (menuItem.children.length === 0 && menuItem.hideWhenEmpty !== false) {
-                            // Hide empty nodes with no path of their own
-                            canShow = false;
-                        }
-                        else if (menuItem.children.length == 1 && menuItem.collapseSingle !== false) {
-                            // Merge single node into parent if parent has no path of it's own.
-                            menuItem = menuItem.children[0];
-                        }
-                    }
-                }
-            }
-            if (canShow) {
-                filtered.push(menuItem);
-            }
-        }
-        return filtered;
-    };
-    /**
-     * Returns true if the menu item can be shown. Does not check children.
-     */
-    MenuItemProvider.prototype.canShowItem = function (menuItem) {
-        return this.routeSecurityService.menuItemAllowed(menuItem);
-    };
-    MenuItemProvider = __decorate([
-        injectable(),
-        __param(0, inject(NeoTypes.Routing.RouteSecurityService.symbol)),
-        __metadata("design:paramtypes", [Object])
-    ], MenuItemProvider);
-    return MenuItemProvider;
-}());
-export { MenuItemProvider };
+import { __assign, __decorate, __metadata, __param } from "tslib";
+import { injectable, inject } from 'inversify';
+import NeoTypes from '../AppServices/NeoTypes';
+export var MenuItemProvider = /** @class */ (function () {
+    function MenuItemProvider(routeSecurityService) {
+        this.routeSecurityService = routeSecurityService;
+    }
+    /**
+     * Processes a list of routes into a list of menu items for display in a menu component.
+     * @param routeItems List of items from the route provider.
+     * @param defaults Defaults to apply to menu items.
+     */
+    MenuItemProvider.prototype.processRoutes = function (routeItems, defaults) {
+        if (defaults === void 0) { defaults = { hideWhenEmpty: true, collapseSingle: true }; }
+        var filtered = [];
+        for (var _i = 0, routeItems_1 = routeItems; _i < routeItems_1.length; _i++) {
+            var route = routeItems_1[_i];
+            var menuItem = __assign(__assign({}, defaults), route);
+            var canShow = this.canShowItem(menuItem);
+            if (canShow) {
+                if (menuItem.children) {
+                    menuItem.children = this.processRoutes(menuItem.children);
+                    if (!menuItem.path) {
+                        if (menuItem.children.length === 0 && menuItem.hideWhenEmpty !== false) {
+                            // Hide empty nodes with no path of their own
+                            canShow = false;
+                        }
+                        else if (menuItem.children.length == 1 && menuItem.collapseSingle !== false) {
+                            // Merge single node into parent if parent has no path of it's own.
+                            menuItem = menuItem.children[0];
+                        }
+                    }
+                }
+            }
+            if (canShow) {
+                filtered.push(menuItem);
+            }
+        }
+        return filtered;
+    };
+    /**
+     * Returns true if the menu item can be shown. Does not check children.
+     */
+    MenuItemProvider.prototype.canShowItem = function (menuItem) {
+        return this.routeSecurityService.menuItemAllowed(menuItem);
+    };
+    MenuItemProvider = __decorate([
+        injectable(),
+        __param(0, inject(NeoTypes.Routing.RouteSecurityService.symbol)),
+        __metadata("design:paramtypes", [Object])
+    ], MenuItemProvider);
+    return MenuItemProvider;
+}());

package/dist/Routing/RouteSecurityService.d.ts

@@ -1,18 +1,18 @@
-import { IAuthorisationService } from '../Security';
-import { IMenuRoute } from "./IMenuRoute";
-import { IRoute } from "./IRoute";
-import { IRouteSecurityService } from "./IRouteSecurityService";
-export declare class RouteSecurityService implements IRouteSecurityService {
-    protected authorisationService: IAuthorisationService;
-    constructor(authorisationService: IAuthorisationService);
-    /**
-     * Checks if the route is allowed to render.
-     * @param route Route data.
-     */
-    routeAllowed(route: IRoute): boolean;
-    /**
-    * Checks if the menu item can be displayed.
-    * @param menuItem Menu item.
-    */
-    menuItemAllowed(menuItem: IMenuRoute): boolean;
-}
+import { IAuthorisationService } from '../Security';
+import { IMenuRoute } from "./IMenuRoute";
+import { IRoute } from "./IRoute";
+import { IRouteSecurityService } from "./IRouteSecurityService";
+export declare class RouteSecurityService implements IRouteSecurityService {
+    protected authorisationService: IAuthorisationService;
+    constructor(authorisationService: IAuthorisationService);
+    /**
+     * Checks if the route is allowed to render.
+     * @param route Route data.
+     */
+    routeAllowed(route: IRoute): boolean;
+    /**
+    * Checks if the menu item can be displayed.
+    * @param menuItem Menu item.
+    */
+    menuItemAllowed(menuItem: IMenuRoute): boolean;
+}

package/dist/Routing/RouteSecurityService.js

@@ -1,36 +1,35 @@
-import { __decorate, __metadata, __param } from "tslib";
-import { inject, injectable } from "inversify";
-import NeoTypes from '../AppServices/NeoTypes';
-var RouteSecurityService = /** @class */ (function () {
-    function RouteSecurityService(authorisationService) {
-        this.authorisationService = authorisationService;
-    }
-    /**
-     * Checks if the route is allowed to render.
-     * @param route Route data.
-     */
-    RouteSecurityService.prototype.routeAllowed = function (route) {
-        var _this = this;
-        if (route.role) {
-            return this.authorisationService.hasRole(route.role);
-        }
-        else if (route.anyRoles) {
-            return route.anyRoles.some(function (role) { return _this.authorisationService.hasRole(role); });
-        }
-        return true;
-    };
-    /**
-    * Checks if the menu item can be displayed.
-    * @param menuItem Menu item.
-    */
-    RouteSecurityService.prototype.menuItemAllowed = function (menuItem) {
-        return this.routeAllowed(menuItem);
-    };
-    RouteSecurityService = __decorate([
-        injectable(),
-        __param(0, inject(NeoTypes.Security.AuthorisationService.symbol)),
-        __metadata("design:paramtypes", [Object])
-    ], RouteSecurityService);
-    return RouteSecurityService;
-}());
-export { RouteSecurityService };
+import { __decorate, __metadata, __param } from "tslib";
+import { inject, injectable } from "inversify";
+import NeoTypes from '../AppServices/NeoTypes';
+export var RouteSecurityService = /** @class */ (function () {
+    function RouteSecurityService(authorisationService) {
+        this.authorisationService = authorisationService;
+    }
+    /**
+     * Checks if the route is allowed to render.
+     * @param route Route data.
+     */
+    RouteSecurityService.prototype.routeAllowed = function (route) {
+        var _this = this;
+        if (route.role) {
+            return this.authorisationService.hasRole(route.role);
+        }
+        else if (route.anyRoles) {
+            return route.anyRoles.some(function (role) { return _this.authorisationService.hasRole(role); });
+        }
+        return true;
+    };
+    /**
+    * Checks if the menu item can be displayed.
+    * @param menuItem Menu item.
+    */
+    RouteSecurityService.prototype.menuItemAllowed = function (menuItem) {
+        return this.routeAllowed(menuItem);
+    };
+    RouteSecurityService = __decorate([
+        injectable(),
+        __param(0, inject(NeoTypes.Security.AuthorisationService.symbol)),
+        __metadata("design:paramtypes", [Object])
+    ], RouteSecurityService);
+    return RouteSecurityService;
+}());

package/dist/Routing/index.d.ts

@@ -1,7 +1,7 @@
-export { IRoute } from './IRoute';
-export { IMenuRoute } from './IMenuRoute';
-export { MenuItemProvider } from './MenuItemProvider';
-export { IMenuItemProvider } from './IMenuItemProvider';
-export { IPageLeaveHandler, NavigateLocation } from './IPageLeaveHandler';
-export { IRouteSecurityService } from './IRouteSecurityService';
-export { RouteSecurityService } from './RouteSecurityService';
+export { IRoute } from './IRoute';
+export { IMenuRoute } from './IMenuRoute';
+export { MenuItemProvider } from './MenuItemProvider';
+export { IMenuItemProvider } from './IMenuItemProvider';
+export { IPageLeaveHandler, NavigateLocation } from './IPageLeaveHandler';
+export { IRouteSecurityService } from './IRouteSecurityService';
+export { RouteSecurityService } from './RouteSecurityService';

package/dist/Routing/index.js

@@ -1,3 +1,3 @@
-export { MenuItemProvider } from './MenuItemProvider';
-export { NavigateLocation } from './IPageLeaveHandler';
-export { RouteSecurityService } from './RouteSecurityService';
+export { MenuItemProvider } from './MenuItemProvider';
+export { NavigateLocation } from './IPageLeaveHandler';
+export { RouteSecurityService } from './RouteSecurityService';

package/dist/Security/IAuthenticationService.d.ts

@@ -1,36 +1,41 @@
-import { IUser } from './IUser';
-import { ISignInResult } from './SignInResult';
-export default interface IAuthenticationService {
-    /**
-     * @deprecated Use loadUserFromSession() instead.
-     */
-    loadUserFromToken(): Promise<IUser | null>;
-    /**
-     * Load a user from session storage if there is a stored token.
-     */
-    loadUserFromSession(): Promise<IUser | null>;
-    /**
-     * Starts the sign in process
-     * @param redirectLocal The path to redirect to after calling endSignIn
-     */
-    beginSignIn(redirectLocal?: string): Promise<any>;
-    /**
-     * Ends the sign in process and returns the path passed in previously to beginSignIn
-     */
-    endSignIn(): Promise<string>;
-    /**
-     * Checks if the login state exists, and logs in the user.
-     * Result.success will be false if an error occurs. Errors will be handled by the service bound to NeoTypes.Security.LoginErrorHandler.
-     */
-    tryCompleteSignIn(): Promise<ISignInResult>;
-    signinSilent(): Promise<any>;
-    endSignInSilent(): Promise<any>;
-    /** Clears the user locally */
-    signOutLocal(): void;
-    beginSignOut(): void;
-    endSignOut(): Promise<any>;
-    /** Returns true if there is a user, and the token has not expired */
-    readonly isAuthenticated: boolean;
-    /** Returns the current user */
-    readonly user: IUser | null;
-}
+import { IUser } from './IUser';
+import { ISignInResult } from './SignInResult';
+export default interface IAuthenticationService {
+    /**
+     * @deprecated Use loadUserFromSession() instead.
+     */
+    loadUserFromToken(): Promise<IUser | null>;
+    /**
+     * Load a user from session storage if there is a stored token.
+     */
+    loadUserFromSession(): Promise<IUser | null>;
+    /**
+     * Checks if the user is signed in, and if not, redirects to login.
+     * Returns true if the user is logged in.
+     */
+    ensureSignedIn(redirectLocal?: string): boolean;
+    /**
+     * Starts the sign in process
+     * @param redirectLocal The path to redirect to after calling endSignIn
+     */
+    beginSignIn(redirectLocal?: string): Promise<any>;
+    /**
+     * Ends the sign in process and returns the path passed in previously to beginSignIn
+     */
+    endSignIn(): Promise<string>;
+    /**
+     * Checks if the login state exists, and logs in the user.
+     * Result.success will be false if an error occurs. Errors will be handled by the service bound to NeoTypes.Security.LoginErrorHandler.
+     */
+    tryCompleteSignIn(): Promise<ISignInResult>;
+    signinSilent(): Promise<any>;
+    endSignInSilent(): Promise<any>;
+    /** Clears the user locally */
+    signOutLocal(): void;
+    beginSignOut(): void;
+    endSignOut(): Promise<any>;
+    /** Returns true if there is a user, and the token has not expired */
+    readonly isAuthenticated: boolean;
+    /** Returns the current user */
+    readonly user: IUser | null;
+}

package/dist/Security/IAuthenticationService.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/Security/IAuthorisationService.d.ts

@@ -1,11 +1,11 @@
-export default interface IAuthorisationService {
-    /**
-     * Returns true if the current user contains the specified role.
-     * @param roleName
-     */
-    hasRole(roleName: string): boolean;
-    /**
-     * Refresh the current roles.
-     */
-    loadRoles(): Promise<void>;
-}
+export default interface IAuthorisationService {
+    /**
+     * Returns true if the current user contains the specified role.
+     * @param roleName
+     */
+    hasRole(roleName: string): boolean;
+    /**
+     * Refresh the current roles.
+     */
+    loadRoles(): Promise<void>;
+}

package/dist/Security/IAuthorisationService.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/Security/ILoginErrorHandler.d.ts

@@ -1,4 +1,4 @@
-export interface ILoginErrorHandler {
-    onMissingLoginState(): void;
-    onException(error: any): void;
-}
+export interface ILoginErrorHandler {
+    onMissingLoginState(): void;
+    onException(error: any): void;
+}

package/dist/Security/ILoginErrorHandler.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/Security/ISecurityService.d.ts

@@ -1,10 +1,10 @@
-import IAuthenticationService from './IAuthenticationService';
-import IAuthorisationService from './IAuthorisationService';
-import { IUser } from './IUser';
-export default interface ISecurityService {
-    authentication: IAuthenticationService;
-    authorisation: IAuthorisationService;
-    readonly isAuthenticated: boolean;
-    readonly user: IUser | null;
-    hasRole(roleName: string): boolean;
-}
+import IAuthenticationService from './IAuthenticationService';
+import IAuthorisationService from './IAuthorisationService';
+import { IUser } from './IUser';
+export default interface ISecurityService {
+    authentication: IAuthenticationService;
+    authorisation: IAuthorisationService;
+    readonly isAuthenticated: boolean;
+    readonly user: IUser | null;
+    hasRole(roleName: string): boolean;
+}

package/dist/Security/ISecurityService.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/Security/IUser.d.ts

@@ -1,10 +1,10 @@
-export interface IUser {
-    /** Unique user name / user id */
-    readonly userName: string;
-    /** Name to display in UI components. */
-    readonly displayName: string;
-    /** True if the access token has expired. */
-    readonly hasExpired: boolean;
-    /** Access token for requesting protected resources. */
-    readonly accessToken: string;
-}
+export interface IUser {
+    /** Unique user name / user id */
+    readonly userName: string;
+    /** Name to display in UI components. */
+    readonly displayName: string;
+    /** True if the access token has expired. */
+    readonly hasExpired: boolean;
+    /** Access token for requesting protected resources. */
+    readonly accessToken: string;
+}

package/dist/Security/IUser.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/Security/IUserRole.d.ts

@@ -1,6 +1,6 @@
-export interface IUserRole {
-    /**
-     * Combined category and role.
-     */
-    roleKey: string;
-}
+export interface IUserRole {
+    /**
+     * Combined category and role.
+     */
+    roleKey: string;
+}

package/dist/Security/IUserRole.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/Security/LoginErrorHandler.d.ts

@@ -1,15 +1,15 @@
-import IAuthenticationService from "./IAuthenticationService";
-import { INavigationHelper } from "../Routing/INavigationHelper";
-import { ILoginErrorHandler } from "./ILoginErrorHandler";
-export declare class NeoLoginErrorHandler implements ILoginErrorHandler {
-    protected authenticationService: IAuthenticationService;
-    protected navigationHelper: INavigationHelper;
-    constructor(authenticationService: IAuthenticationService, navigationHelper: INavigationHelper);
-    onMissingLoginState(): void;
-    onException(error: any): void;
-    protected onAlreadyLoggedIn(): void;
-    protected onNotLoggedIn(): Promise<void>;
-    protected onIncorrectUserClock(): Promise<void>;
-    protected onUnhandledException(errorMessage: string): Promise<void>;
-    protected redirectToHome(): void;
-}
+import IAuthenticationService from "./IAuthenticationService";
+import { INavigationHelper } from "../Routing/INavigationHelper";
+import { ILoginErrorHandler } from "./ILoginErrorHandler";
+export declare class NeoLoginErrorHandler implements ILoginErrorHandler {
+    protected authenticationService: IAuthenticationService;
+    protected navigationHelper: INavigationHelper;
+    constructor(authenticationService: IAuthenticationService, navigationHelper: INavigationHelper);
+    onMissingLoginState(): void;
+    onException(error: any): void;
+    protected onAlreadyLoggedIn(): void;
+    protected onNotLoggedIn(): Promise<void>;
+    protected onIncorrectUserClock(): Promise<void>;
+    protected onUnhandledException(errorMessage: string): Promise<void>;
+    protected redirectToHome(): void;
+}