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

package/dist/Routing/index.d.ts

@@ -1,9 +1,9 @@
-export { default as RouteProvider } from './RouteProvider';
-export { default as RouteView } from './RouteView';
-export * from './BreadCrumbItem';
-export { PageLeaveHandler } from './PageLeaveHandler';
-export { IMenuRoute, MenuRoute } from './MenuRoute';
-export { INavigationHelper } from './NavigationHelper';
-export { IViewParameter } from './ViewParameter';
-export { BreadCrumbSelectMode, IRouteParameter, RouteParameters } from './IRouteParameter';
-export { IRouteChangedProps } from './IRouteChangedProps';
+export { default as RouteProvider } from './RouteProvider';
+export { default as RouteView } from './RouteView';
+export * from './BreadCrumbItem';
+export { PageLeaveHandler } from './PageLeaveHandler';
+export { IMenuRoute, MenuRoute } from './MenuRoute';
+export { INavigationHelper } from './NavigationHelper';
+export { IViewParameter } from './ViewParameter';
+export { BreadCrumbSelectMode, IRouteParameter, RouteParameters } from './IRouteParameter';
+export { IRouteChangedProps } from './IRouteChangedProps';

package/dist/Routing/index.js

@@ -1,6 +1,6 @@
-export { default as RouteProvider } from './RouteProvider';
-export { default as RouteView } from './RouteView';
-export * from './BreadCrumbItem';
-export { PageLeaveHandler } from './PageLeaveHandler';
-export { MenuRoute } from './MenuRoute';
-export { BreadCrumbSelectMode } from './IRouteParameter';
+export { default as RouteProvider } from './RouteProvider';
+export { default as RouteView } from './RouteView';
+export * from './BreadCrumbItem';
+export { PageLeaveHandler } from './PageLeaveHandler';
+export { MenuRoute } from './MenuRoute';
+export { BreadCrumbSelectMode } from './IRouteParameter';

package/dist/Services/DisposeHelper.d.ts

@@ -1,15 +1,15 @@
-import { Misc } from "@singularsystems/neo-core";
-import { IReactionDisposer } from "mobx";
-import { IDisposeHelper } from "./IDisposeHelper";
-export declare class DisposeHelper implements IDisposeHelper {
-    private registeredReactions;
-    private registeredDisposables;
-    /**
-     * Registers a mobx reaction, which will be disposed in the dispose() method when the view is unmounted.
-     * @param expression Expression to react to.
-     * @param effect Callback to run when the result of the expression changes.
-     */
-    registerReaction<T>(expression: (vm: this) => T, effect: (value: T) => void): IReactionDisposer;
-    autoDispose<T extends Misc.IDisposable>(disposable: T): T;
-    dispose(): void;
-}
+import { Misc } from "@singularsystems/neo-core";
+import { IReactionDisposer } from "mobx";
+import { IDisposeHelper } from "./IDisposeHelper";
+export declare class DisposeHelper implements IDisposeHelper {
+    private registeredReactions;
+    private registeredDisposables;
+    /**
+     * Registers a mobx reaction, which will be disposed in the dispose() method when the view is unmounted.
+     * @param expression Expression to react to.
+     * @param effect Callback to run when the result of the expression changes.
+     */
+    registerReaction<T>(expression: (vm: this) => T, effect: (value: T) => void): IReactionDisposer;
+    autoDispose<T extends Misc.IDisposable>(disposable: T): T;
+    dispose(): void;
+}

package/dist/Services/DisposeHelper.js

@@ -1,41 +1,40 @@
-import { __decorate } from "tslib";
-import { injectable } from "inversify";
-import { reaction } from "mobx";
-var DisposeHelper = /** @class */ (function () {
-    function DisposeHelper() {
-        this.registeredReactions = [];
-        this.registeredDisposables = [];
-    }
-    /**
-     * Registers a mobx reaction, which will be disposed in the dispose() method when the view is unmounted.
-     * @param expression Expression to react to.
-     * @param effect Callback to run when the result of the expression changes.
-     */
-    DisposeHelper.prototype.registerReaction = function (expression, effect) {
-        var _this = this;
-        var disposer = reaction(function () { return expression(_this); }, effect);
-        this.registeredReactions.push(disposer);
-        return disposer;
-    };
-    DisposeHelper.prototype.autoDispose = function (disposable) {
-        this.registeredDisposables.push(disposable);
-        return disposable;
-    };
-    DisposeHelper.prototype.dispose = function () {
-        for (var _i = 0, _a = this.registeredReactions; _i < _a.length; _i++) {
-            var disposer = _a[_i];
-            disposer();
-        }
-        this.registeredReactions = [];
-        for (var _b = 0, _c = this.registeredDisposables; _b < _c.length; _b++) {
-            var disposable = _c[_b];
-            disposable.dispose();
-        }
-        this.registeredDisposables = [];
-    };
-    DisposeHelper = __decorate([
-        injectable()
-    ], DisposeHelper);
-    return DisposeHelper;
-}());
-export { DisposeHelper };
+import { __decorate } from "tslib";
+import { injectable } from "inversify";
+import { reaction } from "mobx";
+export var DisposeHelper = /** @class */ (function () {
+    function DisposeHelper() {
+        this.registeredReactions = [];
+        this.registeredDisposables = [];
+    }
+    /**
+     * Registers a mobx reaction, which will be disposed in the dispose() method when the view is unmounted.
+     * @param expression Expression to react to.
+     * @param effect Callback to run when the result of the expression changes.
+     */
+    DisposeHelper.prototype.registerReaction = function (expression, effect) {
+        var _this = this;
+        var disposer = reaction(function () { return expression(_this); }, effect);
+        this.registeredReactions.push(disposer);
+        return disposer;
+    };
+    DisposeHelper.prototype.autoDispose = function (disposable) {
+        this.registeredDisposables.push(disposable);
+        return disposable;
+    };
+    DisposeHelper.prototype.dispose = function () {
+        for (var _i = 0, _a = this.registeredReactions; _i < _a.length; _i++) {
+            var disposer = _a[_i];
+            disposer();
+        }
+        this.registeredReactions = [];
+        for (var _b = 0, _c = this.registeredDisposables; _b < _c.length; _b++) {
+            var disposable = _c[_b];
+            disposable.dispose();
+        }
+        this.registeredDisposables = [];
+    };
+    DisposeHelper = __decorate([
+        injectable()
+    ], DisposeHelper);
+    return DisposeHelper;
+}());

package/dist/Services/IDisposeHelper.d.ts

@@ -1,12 +1,12 @@
-import { Misc } from "@singularsystems/neo-core";
-import { IReactionDisposer } from "mobx";
-export interface IDisposeHelper extends Misc.IDisposable {
-    /**
-     * Registers a mobx reaction, which will be disposed in the dispose() method when the view is unmounted.
-     * @param expression Expression to react to.
-     * @param effect Callback to run when the result of the expression changes.
-     */
-    registerReaction<T>(expression: (vm: this) => T, effect: (value: T) => void): IReactionDisposer;
-    autoDispose<T extends Misc.IDisposable>(disposable: T): T;
-    dispose(): void;
-}
+import { Misc } from "@singularsystems/neo-core";
+import { IReactionDisposer } from "mobx";
+export interface IDisposeHelper extends Misc.IDisposable {
+    /**
+     * Registers a mobx reaction, which will be disposed in the dispose() method when the view is unmounted.
+     * @param expression Expression to react to.
+     * @param effect Callback to run when the result of the expression changes.
+     */
+    registerReaction<T>(expression: (vm: this) => T, effect: (value: T) => void): IReactionDisposer;
+    autoDispose<T extends Misc.IDisposable>(disposable: T): T;
+    dispose(): void;
+}

package/dist/Services/IDisposeHelper.js

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

package/dist/Views/EmptyViewModel.d.ts

@@ -1,5 +1,5 @@
-import ViewModelBase from "./ViewModelBase";
-export default class EmptyViewModel extends ViewModelBase {
-    constructor(taskRunner?: import("@singularsystems/neo-core").ITaskRunner);
-    initialise(): void;
-}
+import ViewModelBase from "./ViewModelBase";
+export default class EmptyViewModel extends ViewModelBase {
+    constructor(taskRunner?: import("@singularsystems/neo-core").ITaskRunner);
+    initialise(): void;
+}

package/dist/Views/EmptyViewModel.js

@@ -1,14 +1,14 @@
-import { __extends } from "tslib";
-import ViewModelBase from "./ViewModelBase";
-import { Misc, AppServices } from '@singularsystems/neo-core';
-var EmptyViewModel = /** @class */ (function (_super) {
-    __extends(EmptyViewModel, _super);
-    function EmptyViewModel(taskRunner) {
-        if (taskRunner === void 0) { taskRunner = Misc.Globals.appService.get(AppServices.NeoTypes.TaskRunner); }
-        return _super.call(this, taskRunner) || this;
-    }
-    EmptyViewModel.prototype.initialise = function () {
-    };
-    return EmptyViewModel;
-}(ViewModelBase));
-export default EmptyViewModel;
+import { __extends } from "tslib";
+import ViewModelBase from "./ViewModelBase";
+import { Misc, AppServices } from '@singularsystems/neo-core';
+var EmptyViewModel = /** @class */ (function (_super) {
+    __extends(EmptyViewModel, _super);
+    function EmptyViewModel(taskRunner) {
+        if (taskRunner === void 0) { taskRunner = Misc.Globals.appService.get(AppServices.NeoTypes.TaskRunner); }
+        return _super.call(this, taskRunner) || this;
+    }
+    EmptyViewModel.prototype.initialise = function () {
+    };
+    return EmptyViewModel;
+}(ViewModelBase));
+export default EmptyViewModel;

package/dist/Views/IViewModel.d.ts

@@ -1,16 +1,16 @@
-import { ITaskRunner } from '@singularsystems/neo-core';
-import { IReactionDisposer } from 'mobx';
-export interface IViewModel {
-    taskRunner: ITaskRunner;
-    /**
-     * initialise() is called from componentDidMount().
-     * For persistent views, this is only called once, not every time a user navigates to the view.
-     */
-    initialise(): void | Promise<any>;
-    /**
-     * dispose() is called from componentWillUnmount().
-     * For persistent views, dispose is never called.
-     */
-    dispose(): void;
-    registerReaction<T>(expression: () => T, effect: (value: T) => void): IReactionDisposer;
-}
+import { ITaskRunner } from '@singularsystems/neo-core';
+import { IReactionDisposer } from 'mobx';
+export interface IViewModel {
+    taskRunner: ITaskRunner;
+    /**
+     * initialise() is called from componentDidMount().
+     * For persistent views, this is only called once, not every time a user navigates to the view.
+     */
+    initialise(): void | Promise<any>;
+    /**
+     * dispose() is called from componentWillUnmount().
+     * For persistent views, dispose is never called.
+     */
+    dispose(): void;
+    registerReaction<T>(expression: () => T, effect: (value: T) => void): IReactionDisposer;
+}

package/dist/Views/IViewModel.js

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

package/dist/Views/PersistentViewBase.d.ts

@@ -1,10 +1,10 @@
-import ViewBase from "./ViewBase";
-import { ViewState } from './ViewState';
-import { RouteParameterObject } from '../Routing/IRouteParameter';
-import { IViewModel } from './IViewModel';
-export default abstract class PersistentViewBase<TViewModel extends IViewModel, TParams extends RouteParameterObject<TParams> = {}> extends ViewBase<TViewModel, TParams> {
-    private static storedState;
-    constructor(viewName: string, createViewModel: (() => TViewModel) | (new () => TViewModel), props: any);
-    protected disposeViewModel(): void;
-    getStoredViewState(viewModel: (() => TViewModel) | (new () => TViewModel)): ViewState<TViewModel, TParams>;
-}
+import ViewBase from "./ViewBase";
+import { ViewState } from './ViewState';
+import { RouteParameterObject } from '../Routing/IRouteParameter';
+import { IViewModel } from './IViewModel';
+export default abstract class PersistentViewBase<TViewModel extends IViewModel, TParams extends RouteParameterObject<TParams> = {}> extends ViewBase<TViewModel, TParams> {
+    private static storedState;
+    constructor(viewName: string, createViewModel: (() => TViewModel) | (new () => TViewModel), props: any);
+    protected disposeViewModel(): void;
+    getStoredViewState(viewModel: (() => TViewModel) | (new () => TViewModel)): ViewState<TViewModel, TParams>;
+}

package/dist/Views/PersistentViewBase.js

@@ -1,21 +1,21 @@
-import { __extends } from "tslib";
-import ViewBase from "./ViewBase";
-var PersistentViewBase = /** @class */ (function (_super) {
-    __extends(PersistentViewBase, _super);
-    function PersistentViewBase(viewName, createViewModel, props) {
-        return _super.call(this, viewName, createViewModel, props) || this;
-    }
-    PersistentViewBase.prototype.disposeViewModel = function () {
-    };
-    PersistentViewBase.prototype.getStoredViewState = function (viewModel) {
-        var storedState = PersistentViewBase.storedState[this.constructor.name];
-        if (!storedState) {
-            storedState = this.createViewState(viewModel);
-            PersistentViewBase.storedState[this.constructor.name] = storedState;
-        }
-        return storedState;
-    };
-    PersistentViewBase.storedState = {};
-    return PersistentViewBase;
-}(ViewBase));
-export default PersistentViewBase;
+import { __extends } from "tslib";
+import ViewBase from "./ViewBase";
+var PersistentViewBase = /** @class */ (function (_super) {
+    __extends(PersistentViewBase, _super);
+    function PersistentViewBase(viewName, createViewModel, props) {
+        return _super.call(this, viewName, createViewModel, props) || this;
+    }
+    PersistentViewBase.prototype.disposeViewModel = function () {
+    };
+    PersistentViewBase.prototype.getStoredViewState = function (viewModel) {
+        var storedState = PersistentViewBase.storedState[this.constructor.name];
+        if (!storedState) {
+            storedState = this.createViewState(viewModel);
+            PersistentViewBase.storedState[this.constructor.name] = storedState;
+        }
+        return storedState;
+    };
+    PersistentViewBase.storedState = {};
+    return PersistentViewBase;
+}(ViewBase));
+export default PersistentViewBase;

package/dist/Views/ViewBase.d.ts

@@ -1,70 +1,70 @@
-import React from 'react';
-import { Views, ITaskRunner } from '@singularsystems/neo-core';
-import { RouteParameterObject } from '../Routing/IRouteParameter';
-import { TransformParamsType, IViewParameterList, IViewParameterListOfT } from '../Routing/ViewParameterList';
-import { match } from 'react-router';
-import { ViewState } from './ViewState';
-import { BreadCrumbItem } from '../Routing/BreadCrumbItem';
-import { IViewModel } from './IViewModel';
-import EmptyViewModel from './EmptyViewModel';
-import { IRouteChangedProps } from '../Routing/IRouteChangedProps';
-import { valueOrLazy } from './ViewModelBase';
-export interface IViewBase extends Views.IViewBase {
-    viewParams: IViewParameterList;
-    updateViewParams(match: match): void;
-    getBreadCrumbList(): BreadCrumbItem[];
-    onLeave(): string | undefined;
-    beforeRouteChanged(props: IRouteChangedProps): void;
-    viewModel: IViewModel;
-}
-export interface IViewBaseConstructor {
-    params?: RouteParameterObject<any>;
-}
-export default abstract class ViewBase<TViewModel extends IViewModel = EmptyViewModel, TParams extends RouteParameterObject<TParams> = {}> extends React.Component implements IViewBase {
-    viewName: string;
-    static get currentView(): IViewBase | null;
-    private routingState;
-    navigation: import("../Routing").INavigationHelper;
-    private breadCrumbStartItems?;
-    protected viewState: ViewState<TViewModel, TParams>;
-    /**
-     * Creates a view
-     * @param props React props.
-     * @param viewName Name of the view.
-     * @param viewModel Instance of view model, or view model type, or callback which returns a view model.
-     */
-    constructor(viewName: string, viewModel: valueOrLazy<TViewModel>, props: any);
-    get viewModel(): TViewModel;
-    get taskRunner(): ITaskRunner;
-    get viewParams(): IViewParameterListOfT<TParams> & TransformParamsType<TParams>;
-    protected getStoredViewState(viewModel: valueOrLazy<TViewModel>): ViewState<TViewModel, TParams>;
-    protected createViewState(viewModel: valueOrLazy<TViewModel>): ViewState<TViewModel, TParams>;
-    componentDidMount(): void;
-    componentWillUnmount(): void;
-    updateViewParams(match: match): void;
-    /**
-     * viewParamsUpdated() is called when the component is mounted, and whenever a route parameter or query parameter gets a changed value.
-     */
-    protected viewParamsUpdated(): void;
-    /** Gets the parent breadcrumbs, and the breadcrumb for this view. */
-    protected getBreadCrumbStart(): BreadCrumbItem[];
-    /**
-     * Initialise is called from componentDidMount().
-     * Will only be called once per persistent view for the lifetime of the app.
-     * If overridden, you must call super.initialise() to initialise the ViewModel.
-     */
-    protected initialise(): void | Promise<any>;
-    protected disposeViewModel(): void;
-    getBreadCrumbList(): BreadCrumbItem[];
-    /**
-     * Called when the user navigates to a new view, or when exiting the site.
-     * Return a string to show to the user in a dialog.
-     */
-    onLeave(): string | undefined;
-    /**
-     * Called whenever the route changes. Including navigating to a new view, leaving the site, or changing a route parameter in this view.
-     * Note: if props.leavePrompt is set, onLeave() will not be called.
-     * @param props
-     */
-    beforeRouteChanged(props: IRouteChangedProps): void;
-}
+import React from 'react';
+import { Views, ITaskRunner } from '@singularsystems/neo-core';
+import { RouteParameterObject } from '../Routing/IRouteParameter';
+import { TransformParamsType, IViewParameterList, IViewParameterListOfT } from '../Routing/ViewParameterList';
+import { match } from 'react-router';
+import { ViewState } from './ViewState';
+import { BreadCrumbItem } from '../Routing/BreadCrumbItem';
+import { IViewModel } from './IViewModel';
+import EmptyViewModel from './EmptyViewModel';
+import { IRouteChangedProps } from '../Routing/IRouteChangedProps';
+import { valueOrLazy } from './ViewModelBase';
+export interface IViewBase extends Views.IViewBase {
+    viewParams: IViewParameterList;
+    updateViewParams(match: match): void;
+    getBreadCrumbList(): BreadCrumbItem[];
+    onLeave(): string | undefined;
+    beforeRouteChanged(props: IRouteChangedProps): void;
+    viewModel: IViewModel;
+}
+export interface IViewBaseConstructor {
+    params?: RouteParameterObject<any>;
+}
+export default abstract class ViewBase<TViewModel extends IViewModel = EmptyViewModel, TParams extends RouteParameterObject<TParams> = {}> extends React.Component implements IViewBase {
+    viewName: string;
+    static get currentView(): IViewBase | null;
+    private routingState;
+    navigation: import("../Routing").INavigationHelper;
+    private breadCrumbStartItems?;
+    protected viewState: ViewState<TViewModel, TParams>;
+    /**
+     * Creates a view
+     * @param props React props.
+     * @param viewName Name of the view.
+     * @param viewModel Instance of view model, or view model type, or callback which returns a view model.
+     */
+    constructor(viewName: string, viewModel: valueOrLazy<TViewModel>, props: any);
+    get viewModel(): TViewModel;
+    get taskRunner(): ITaskRunner;
+    get viewParams(): IViewParameterListOfT<TParams> & TransformParamsType<TParams>;
+    protected getStoredViewState(viewModel: valueOrLazy<TViewModel>): ViewState<TViewModel, TParams>;
+    protected createViewState(viewModel: valueOrLazy<TViewModel>): ViewState<TViewModel, TParams>;
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    updateViewParams(match: match): void;
+    /**
+     * viewParamsUpdated() is called when the component is mounted, and whenever a route parameter or query parameter gets a changed value.
+     */
+    protected viewParamsUpdated(): void | Promise<void>;
+    /** Gets the parent breadcrumbs, and the breadcrumb for this view. */
+    protected getBreadCrumbStart(): BreadCrumbItem[];
+    /**
+     * Initialise is called from componentDidMount().
+     * Will only be called once per persistent view for the lifetime of the app.
+     * If overridden, you must call super.initialise() to initialise the ViewModel.
+     */
+    protected initialise(): void | Promise<any>;
+    protected disposeViewModel(): void;
+    getBreadCrumbList(): BreadCrumbItem[];
+    /**
+     * Called when the user navigates to a new view, or when exiting the site.
+     * Return a string to show to the user in a dialog.
+     */
+    onLeave(): string | undefined;
+    /**
+     * Called whenever the route changes. Including navigating to a new view, leaving the site, or changing a route parameter in this view.
+     * Note: if props.leavePrompt is set, onLeave() will not be called.
+     * @param props
+     */
+    beforeRouteChanged(props: IRouteChangedProps): void;
+}