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

package/dist/Routing/BreadCrumbItem.d.ts

@@ -1,14 +1,14 @@
-/// <reference types="react" />
-export declare class BreadCrumbItem {
-    /** Text to show in the breadcrumb component. */
-    label: string | (() => string);
-    /** URL to use when the breadcrumb is clicked. */
-    link?: string | undefined;
-    constructor(
-    /** Text to show in the breadcrumb component. */
-    label: string | (() => string), 
-    /** URL to use when the breadcrumb is clicked. */
-    link?: string | undefined);
-    /** Optional callback for when the breadcrumb is clicked. */
-    onClick?: (e: React.MouseEvent) => void;
-}
+/// <reference types="react" />
+export declare class BreadCrumbItem {
+    /** Text to show in the breadcrumb component. */
+    label: string | (() => string);
+    /** URL to use when the breadcrumb is clicked. */
+    link?: string | undefined;
+    constructor(
+    /** Text to show in the breadcrumb component. */
+    label: string | (() => string), 
+    /** URL to use when the breadcrumb is clicked. */
+    link?: string | undefined);
+    /** Optional callback for when the breadcrumb is clicked. */
+    onClick?: (e: React.MouseEvent) => void;
+}

package/dist/Routing/BreadCrumbItem.js

@@ -1,12 +1,12 @@
-var BreadCrumbItem = /** @class */ (function () {
-    function BreadCrumbItem(
-    /** Text to show in the breadcrumb component. */
-    label, 
-    /** URL to use when the breadcrumb is clicked. */
-    link) {
-        this.label = label;
-        this.link = link;
-    }
-    return BreadCrumbItem;
-}());
-export { BreadCrumbItem };
+var BreadCrumbItem = /** @class */ (function () {
+    function BreadCrumbItem(
+    /** Text to show in the breadcrumb component. */
+    label, 
+    /** URL to use when the breadcrumb is clicked. */
+    link) {
+        this.label = label;
+        this.link = link;
+    }
+    return BreadCrumbItem;
+}());
+export { BreadCrumbItem };

package/dist/Routing/IRouteChangedProps.d.ts

@@ -1,31 +1,31 @@
-import { Misc, Routing, Views } from "@singularsystems/neo-core";
-import { match } from "react-router-dom";
-export interface IRouteChangedProps {
-    /**
-     * True if the user is navigating to a new view or leaving the site. False if navigating to a sub route in this view.
-     */
-    readonly isNewView: boolean;
-    /**
-     * True if the window is being unloaded. Either by closing the tab, or navigating to an external site.
-     */
-    readonly isUnload: boolean;
-    /**
-     * The view (if it inherits from ViewBase) currently being rendered.
-     */
-    readonly currentView?: Views.IViewBase;
-    /**
-     * The route being navigated to.
-     */
-    readonly newRoute?: Routing.IRoute;
-    /**
-     * The url match information. Url parameter values can be viewed on this object.
-     */
-    readonly match?: match;
-    /**
-     * A leave prompt to show the user before the location is changed.
-     * If you want to display your own prompt, set this to the promise returned by the modal.
-     * If you want to block navigation (with no option for the user to continue), return false.
-     * Note: if `isUnload` is true, the browser will show a native leave prompt regardless of whether you show a custom prompt.
-     */
-    leavePrompt?: string | false | Promise<boolean> | Promise<Misc.ModalResult> | Promise<void>;
-}
+import { Misc, Routing, Views } from "@singularsystems/neo-core";
+import { match } from "react-router-dom";
+export interface IRouteChangedProps {
+    /**
+     * True if the user is navigating to a new view or leaving the site. False if navigating to a sub route in this view.
+     */
+    readonly isNewView: boolean;
+    /**
+     * True if the window is being unloaded. Either by closing the tab, or navigating to an external site.
+     */
+    readonly isUnload: boolean;
+    /**
+     * The view (if it inherits from ViewBase) currently being rendered.
+     */
+    readonly currentView?: Views.IViewBase;
+    /**
+     * The route being navigated to.
+     */
+    readonly newRoute?: Routing.IRoute;
+    /**
+     * The url match information. Url parameter values can be viewed on this object.
+     */
+    readonly match?: match;
+    /**
+     * A leave prompt to show the user before the location is changed.
+     * If you want to display your own prompt, set this to the promise returned by the modal.
+     * If you want to block navigation (with no option for the user to continue), return false.
+     * Note: if `isUnload` is true, the browser will show a native leave prompt regardless of whether you show a custom prompt.
+     */
+    leavePrompt?: string | false | Promise<boolean> | Promise<Misc.ModalResult> | Promise<void>;
+}

package/dist/Routing/IRouteChangedProps.js

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

package/dist/Routing/IRouteParameter.d.ts

@@ -1,22 +1,22 @@
-export interface IRouteParameter {
-    /** True if the parameter exists in the query string */
-    isQuery?: boolean;
-    /** True if the parameter is required for the route to match. Does not apply to query string parameters. */
-    required?: boolean;
-    /** Behaviour when this node is clicked on in the breadcrumb. Undefined is equivalent to BreadCrumbSelectMode.Default */
-    selection?: BreadCrumbSelectMode;
-}
-export declare enum BreadCrumbSelectMode {
-    /** Default behaviour, clicking this will clear the values of all child params. */
-    Default = 0,
-    /** Breadcrumb is not selectable. */
-    None = 1,
-    /** Clicking on the breadcrumb item will select the parent item. */
-    SelectParent = 2
-}
-export declare type RouteParameters = {
-    [index: string]: IRouteParameter;
-};
-export declare type RouteParameterObject<T> = {
-    [P in keyof T]: IRouteParameter;
-};
+export interface IRouteParameter {
+    /** True if the parameter exists in the query string */
+    isQuery?: boolean;
+    /** True if the parameter is required for the route to match. Does not apply to query string parameters. */
+    required?: boolean;
+    /** Behaviour when this node is clicked on in the breadcrumb. Undefined is equivalent to BreadCrumbSelectMode.Default */
+    selection?: BreadCrumbSelectMode;
+}
+export declare enum BreadCrumbSelectMode {
+    /** Default behaviour, clicking this will clear the values of all child params. */
+    Default = 0,
+    /** Breadcrumb is not selectable. */
+    None = 1,
+    /** Clicking on the breadcrumb item will select the parent item. */
+    SelectParent = 2
+}
+export type RouteParameters = {
+    [index: string]: IRouteParameter;
+};
+export type RouteParameterObject<T> = {
+    [P in keyof T]: IRouteParameter;
+};

package/dist/Routing/IRouteParameter.js

@@ -1,9 +1,9 @@
-export var BreadCrumbSelectMode;
-(function (BreadCrumbSelectMode) {
-    /** Default behaviour, clicking this will clear the values of all child params. */
-    BreadCrumbSelectMode[BreadCrumbSelectMode["Default"] = 0] = "Default";
-    /** Breadcrumb is not selectable. */
-    BreadCrumbSelectMode[BreadCrumbSelectMode["None"] = 1] = "None";
-    /** Clicking on the breadcrumb item will select the parent item. */
-    BreadCrumbSelectMode[BreadCrumbSelectMode["SelectParent"] = 2] = "SelectParent";
-})(BreadCrumbSelectMode || (BreadCrumbSelectMode = {}));
+export var BreadCrumbSelectMode;
+(function (BreadCrumbSelectMode) {
+    /** Default behaviour, clicking this will clear the values of all child params. */
+    BreadCrumbSelectMode[BreadCrumbSelectMode["Default"] = 0] = "Default";
+    /** Breadcrumb is not selectable. */
+    BreadCrumbSelectMode[BreadCrumbSelectMode["None"] = 1] = "None";
+    /** Clicking on the breadcrumb item will select the parent item. */
+    BreadCrumbSelectMode[BreadCrumbSelectMode["SelectParent"] = 2] = "SelectParent";
+})(BreadCrumbSelectMode || (BreadCrumbSelectMode = {}));

package/dist/Routing/MenuRoute.d.ts

@@ -1,24 +1,25 @@
-import ViewBase from '../Views/ViewBase';
-import { Routing } from '@singularsystems/neo-core';
-export interface IMenuRoute extends Routing.IMenuRoute {
-}
-export declare class MenuRoute<TParams> implements IMenuRoute {
-    /**
-     * Creates a menu route with view parameters specified.
-     * @param baseRoute Path and component
-     * @param menuParams Other menu options.
-     * @param viewParams View parameter values.
-     */
-    constructor(baseRoute: {
-        path: string;
-        component: new (...args: any) => ViewBase<any, TParams>;
-    }, menuParams: Routing.IMenuRoute, viewParams?: {
-        [P in keyof TParams]?: number | string | null;
-    });
-    /** Path including view param values. */
-    path: string;
-    /** Path without parameter values or routing template. */
-    basePath: string;
-    /** Name to show in the menu item. */
-    name: string;
-}
+import ViewBase from '../Views/ViewBase';
+import { Routing } from '@singularsystems/neo-core';
+import { RouteParameterObject } from './IRouteParameter';
+export interface IMenuRoute extends Routing.IMenuRoute {
+}
+export declare class MenuRoute<TParams extends RouteParameterObject<TParams>> implements IMenuRoute {
+    /**
+     * Creates a menu route with view parameters specified.
+     * @param baseRoute Path and component
+     * @param menuParams Other menu options.
+     * @param viewParams View parameter values.
+     */
+    constructor(baseRoute: {
+        path: string;
+        component: new (...args: any) => ViewBase<any, TParams>;
+    }, menuParams: Routing.IMenuRoute, viewParams?: {
+        [P in keyof TParams]?: number | string | null;
+    });
+    /** Path including view param values. */
+    path: string;
+    /** Path without parameter values or routing template. */
+    basePath: string;
+    /** Name to show in the menu item. */
+    name: string;
+}

package/dist/Routing/MenuRoute.js

@@ -1,24 +1,24 @@
-import { ViewParameterList } from './ViewParameterList';
-var MenuRoute = /** @class */ (function () {
-    /**
-     * Creates a menu route with view parameters specified.
-     * @param baseRoute Path and component
-     * @param menuParams Other menu options.
-     * @param viewParams View parameter values.
-     */
-    function MenuRoute(baseRoute, menuParams, viewParams) {
-        var _this = this;
-        Object.getOwnPropertyNames(baseRoute).forEach(function (propertyName) {
-            _this[propertyName] = baseRoute[propertyName];
-        });
-        Object.getOwnPropertyNames(menuParams).forEach(function (propertyName) {
-            _this[propertyName] = menuParams[propertyName];
-        });
-        this.basePath = this.path;
-        if (viewParams) {
-            this.path = ViewParameterList.getPathForValues(this.basePath, baseRoute.component.params, viewParams);
-        }
-    }
-    return MenuRoute;
-}());
-export { MenuRoute };
+import { ViewParameterList } from './ViewParameterList';
+var MenuRoute = /** @class */ (function () {
+    /**
+     * Creates a menu route with view parameters specified.
+     * @param baseRoute Path and component
+     * @param menuParams Other menu options.
+     * @param viewParams View parameter values.
+     */
+    function MenuRoute(baseRoute, menuParams, viewParams) {
+        var _this = this;
+        Object.getOwnPropertyNames(baseRoute).forEach(function (propertyName) {
+            _this[propertyName] = baseRoute[propertyName];
+        });
+        Object.getOwnPropertyNames(menuParams).forEach(function (propertyName) {
+            _this[propertyName] = menuParams[propertyName];
+        });
+        this.basePath = this.path;
+        if (viewParams) {
+            this.path = ViewParameterList.getPathForValues(this.basePath, baseRoute.component.params, viewParams);
+        }
+    }
+    return MenuRoute;
+}());
+export { MenuRoute };

package/dist/Routing/NavigationHelper.d.ts

@@ -1,40 +1,41 @@
-import ViewBase from '../Views/ViewBase';
-import { RouteComponentProps } from 'react-router';
-import { RoutingState } from './RoutingState';
-import { INavigationHelper as INeoNavigationHelper } from '@singularsystems/neo-core/dist/Routing/INavigationHelper';
-export declare type ViewConstructor<TParams> = new (...args: any) => ViewBase<any, TParams>;
-export declare type ParamValues<TParams> = {
-    [P in keyof TParams]?: number | string | null;
-};
-export interface INavigationHelper extends INeoNavigationHelper {
-    /**
-     * Navigates to the view, if the view component is found in the routes definition.
-     * If the view is bound to multiple routes, the first one will be used.
-     * @param view View component which inherits from view base.
-     * @param paramValues View params to include in the url to pass to the view.
-     */
-    navigateToView<TParams>(view: ViewConstructor<TParams>, paramValues?: ParamValues<TParams>): void;
-    /**
-     * Gets the full path for a view including view parameter values.
-     * @param view View component which inherits from view base.
-     * @param paramValues View params to include in the url to pass to the view.
-     */
-    getPathForView<TParams>(view: ViewConstructor<TParams>, paramValues?: ParamValues<TParams>): string;
-    /**
-     * Gets the path of the currently rendered view, without parameter components.
-     */
-    getCurrentViewPath(): string;
-    /**
-     * Gets the react-router properties for the current route.
-     */
-    readonly currentRouteProps: RouteComponentProps;
-}
-export default class NavigationHelper implements INavigationHelper {
-    private routingState;
-    constructor(routingState: RoutingState);
-    navigateInternal(url: string, replace?: boolean): void;
-    navigateToView<TParams>(view: ViewConstructor<TParams>, paramValues?: ParamValues<TParams>): void;
-    getPathForView<TParams>(view: ViewConstructor<TParams>, paramValues?: ParamValues<TParams>): string;
-    getCurrentViewPath(): string;
-    get currentRouteProps(): RouteComponentProps<{}, import("react-router").StaticContext, unknown>;
-}
+import ViewBase from '../Views/ViewBase';
+import { RouteComponentProps } from 'react-router';
+import { RoutingState } from './RoutingState';
+import { INavigationHelper as INeoNavigationHelper } from '@singularsystems/neo-core/dist/Routing/INavigationHelper';
+import { RouteParameterObject } from './IRouteParameter';
+export type ViewConstructor<TParams extends RouteParameterObject<TParams>> = new (...args: any) => ViewBase<any, TParams>;
+export type ParamValues<TParams> = {
+    [P in keyof TParams]?: number | string | null;
+};
+export interface INavigationHelper extends INeoNavigationHelper {
+    /**
+     * Navigates to the view, if the view component is found in the routes definition.
+     * If the view is bound to multiple routes, the first one will be used.
+     * @param view View component which inherits from view base.
+     * @param paramValues View params to include in the url to pass to the view.
+     */
+    navigateToView<TParams extends RouteParameterObject<TParams>>(view: ViewConstructor<TParams>, paramValues?: ParamValues<TParams>): void;
+    /**
+     * Gets the full path for a view including view parameter values.
+     * @param view View component which inherits from view base.
+     * @param paramValues View params to include in the url to pass to the view.
+     */
+    getPathForView<TParams extends RouteParameterObject<TParams>>(view: ViewConstructor<TParams>, paramValues?: ParamValues<TParams>): string;
+    /**
+     * Gets the path of the currently rendered view, without parameter components.
+     */
+    getCurrentViewPath(): string;
+    /**
+     * Gets the react-router properties for the current route.
+     */
+    readonly currentRouteProps: RouteComponentProps;
+}
+export default class NavigationHelper implements INavigationHelper {
+    private routingState;
+    constructor(routingState: RoutingState);
+    navigateInternal(url: string, replace?: boolean): void;
+    navigateToView<TParams extends RouteParameterObject<TParams>>(view: ViewConstructor<TParams>, paramValues?: ParamValues<TParams>): void;
+    getPathForView<TParams extends RouteParameterObject<TParams>>(view: ViewConstructor<TParams>, paramValues?: ParamValues<TParams>): string;
+    getCurrentViewPath(): string;
+    get currentRouteProps(): import("react-router").RouteComponentProps<{}, import("react-router").StaticContext, unknown>;
+}

package/dist/Routing/NavigationHelper.js

@@ -1,61 +1,61 @@
-import { __decorate, __metadata, __param } from "tslib";
-import { ViewParameterList } from './ViewParameterList';
-import { injectable, inject } from 'inversify';
-import { NeoReactTypes } from '../Modules/Types';
-import { RoutingState } from './RoutingState';
-var NavigationHelper = /** @class */ (function () {
-    function NavigationHelper(routingState) {
-        this.routingState = routingState;
-    }
-    NavigationHelper.prototype.navigateInternal = function (url, replace) {
-        if (replace === void 0) { replace = false; }
-        if (replace) {
-            this.currentRouteProps.history.replace(url);
-        }
-        else {
-            this.currentRouteProps.history.push(url);
-        }
-    };
-    NavigationHelper.prototype.navigateToView = function (view, paramValues) {
-        this.navigateInternal(this.getPathForView(view, paramValues));
-    };
-    NavigationHelper.prototype.getPathForView = function (view, paramValues) {
-        var basePath = this.routingState.appRouteProvider.getPathForComponent(view);
-        if (basePath) {
-            if (paramValues) {
-                return ViewParameterList.getPathForValues(basePath, view.params, paramValues);
-            }
-            else {
-                return basePath;
-            }
-        }
-        else {
-            throw Error("Cannot find route for component " + view.name);
-        }
-    };
-    NavigationHelper.prototype.getCurrentViewPath = function () {
-        var basePath = this.currentRouteProps.match.path;
-        var paramIndex = basePath.indexOf(":");
-        if (paramIndex > 0) {
-            basePath = basePath.substring(0, paramIndex);
-            if (basePath.endsWith("/")) {
-                basePath = basePath.substring(0, basePath.length - 1);
-            }
-        }
-        return basePath;
-    };
-    Object.defineProperty(NavigationHelper.prototype, "currentRouteProps", {
-        get: function () {
-            return this.routingState.currentRouteProps;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    NavigationHelper = __decorate([
-        injectable(),
-        __param(0, inject(NeoReactTypes.Routing.GlobalRoutingState.symbol)),
-        __metadata("design:paramtypes", [RoutingState])
-    ], NavigationHelper);
-    return NavigationHelper;
-}());
-export default NavigationHelper;
+import { __decorate, __metadata, __param } from "tslib";
+import { ViewParameterList } from './ViewParameterList';
+import { injectable, inject } from 'inversify';
+import { NeoReactTypes } from '../Modules/Types';
+import { RoutingState } from './RoutingState';
+var NavigationHelper = /** @class */ (function () {
+    function NavigationHelper(routingState) {
+        this.routingState = routingState;
+    }
+    NavigationHelper.prototype.navigateInternal = function (url, replace) {
+        if (replace === void 0) { replace = false; }
+        if (replace) {
+            this.currentRouteProps.history.replace(url);
+        }
+        else {
+            this.currentRouteProps.history.push(url);
+        }
+    };
+    NavigationHelper.prototype.navigateToView = function (view, paramValues) {
+        this.navigateInternal(this.getPathForView(view, paramValues));
+    };
+    NavigationHelper.prototype.getPathForView = function (view, paramValues) {
+        var basePath = this.routingState.appRouteProvider.getPathForComponent(view);
+        if (basePath) {
+            if (paramValues) {
+                return ViewParameterList.getPathForValues(basePath, view.params, paramValues);
+            }
+            else {
+                return basePath;
+            }
+        }
+        else {
+            throw Error("Cannot find route for component " + view.name);
+        }
+    };
+    NavigationHelper.prototype.getCurrentViewPath = function () {
+        var basePath = this.currentRouteProps.match.path;
+        var paramIndex = basePath.indexOf(":");
+        if (paramIndex > 0) {
+            basePath = basePath.substring(0, paramIndex);
+            if (basePath.endsWith("/")) {
+                basePath = basePath.substring(0, basePath.length - 1);
+            }
+        }
+        return basePath;
+    };
+    Object.defineProperty(NavigationHelper.prototype, "currentRouteProps", {
+        get: function () {
+            return this.routingState.currentRouteProps;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    NavigationHelper = __decorate([
+        injectable(),
+        __param(0, inject(NeoReactTypes.Routing.GlobalRoutingState.symbol)),
+        __metadata("design:paramtypes", [RoutingState])
+    ], NavigationHelper);
+    return NavigationHelper;
+}());
+export default NavigationHelper;

package/dist/Routing/PageLeaveHandler.d.ts

@@ -1,13 +1,13 @@
-import { Routing, Views } from '@singularsystems/neo-core';
-import { RoutingState } from './RoutingState';
-export declare class PageLeaveHandler implements Routing.IPageLeaveHandler {
-    private routingState;
-    constructor(routingState: RoutingState);
-    /**
-     * Handler for react-routers BrowserRouter.getUserConfirmation
-     */
-    static showNavigationConfirmation(prompt: string, callback: (ok: boolean) => void): Promise<void>;
-    onWindowUnload(view: Views.IViewBase | null, e: BeforeUnloadEvent): void;
-    onLeavePage(view: Views.IViewBase | null, prompt: string, location: Routing.NavigateLocation): Promise<boolean>;
-    protected showDefaultConfirmation(view: Views.IViewBase | null, prompt: string, location: Routing.NavigateLocation): Promise<boolean>;
-}
+import { Routing, Views } from '@singularsystems/neo-core';
+import { RoutingState } from './RoutingState';
+export declare class PageLeaveHandler implements Routing.IPageLeaveHandler {
+    private routingState;
+    constructor(routingState: RoutingState);
+    /**
+     * Handler for react-routers BrowserRouter.getUserConfirmation
+     */
+    static showNavigationConfirmation(prompt: string, callback: (ok: boolean) => void): Promise<void>;
+    onWindowUnload(view: Views.IViewBase | null, e: BeforeUnloadEvent): void;
+    onLeavePage(view: Views.IViewBase | null, prompt: string, location: Routing.NavigateLocation): Promise<boolean>;
+    protected showDefaultConfirmation(view: Views.IViewBase | null, prompt: string, location: Routing.NavigateLocation): Promise<boolean>;
+}