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

package/dist/Views/ViewBase.js

@@ -1,153 +1,166 @@
-import { __decorate, __extends, __metadata } from "tslib";
-import React from 'react';
-import { observable } from 'mobx';
-import { Misc } from '@singularsystems/neo-core';
-import { ViewParameterList } from '../Routing/ViewParameterList';
-import { ViewState } from './ViewState';
-import { BreadCrumbItem } from '../Routing/BreadCrumbItem';
-import { NeoReactTypes } from '../Modules/Types';
-import ViewModelBase from './ViewModelBase';
-var ViewBase = /** @class */ (function (_super) {
-    __extends(ViewBase, _super);
-    /**
-     * 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.
-     */
-    function ViewBase(viewName, viewModel, props) {
-        var _this = _super.call(this, props) || this;
-        _this.viewName = "";
-        _this.routingState = Misc.Globals.appService.get(NeoReactTypes.Routing.GlobalRoutingState);
-        _this.navigation = Misc.Globals.appService.get(NeoReactTypes.Routing.NavigationHelper);
-        if (typeof viewName !== "string") {
-            throw "Error: When inheriting ViewBase, you must pass the view name into the base constructor.";
-        }
-        _this.viewName = viewName;
-        _this.viewState = _this.getStoredViewState(viewModel);
-        ViewBase.currentView = _this;
-        return _this;
-    }
-    Object.defineProperty(ViewBase.prototype, "viewModel", {
-        get: function () {
-            return this.viewState.viewModel;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(ViewBase.prototype, "taskRunner", {
-        get: function () {
-            return this.viewModel.taskRunner;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(ViewBase.prototype, "viewParams", {
-        get: function () {
-            return this.viewState.viewParams;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    ViewBase.prototype.getStoredViewState = function (viewModel) {
-        return this.createViewState(viewModel);
-    };
-    ViewBase.prototype.createViewState = function (viewModel) {
-        var params = this.constructor.params;
-        var paramsList = new ViewParameterList(params, this);
-        var viewModelInstance = ViewModelBase.create(viewModel);
-        return new ViewState(paramsList, viewModelInstance);
-    };
-    ViewBase.prototype.componentDidMount = function () {
-        var _this = this;
-        var paramsUpdated = this.navigation.currentRouteProps ? this.viewState.viewParams.update(this.navigation.currentRouteProps.match) : false;
-        var initPromise;
-        if (!this.viewState.hasSetup) {
-            this.viewState.hasSetup = true;
-            initPromise = this.initialise();
-        }
-        if (paramsUpdated) {
-            if (initPromise) {
-                initPromise.then(function () { return _this.viewParamsUpdated(); });
-            }
-            else {
-                this.viewParamsUpdated();
-            }
-        }
-    };
-    ViewBase.prototype.componentWillUnmount = function () {
-        this.disposeViewModel();
-    };
-    ViewBase.prototype.updateViewParams = function (match) {
-        if (this.viewState.viewParams.update(match)) {
-            this.viewParamsUpdated();
-        }
-    };
-    /**
-     * viewParamsUpdated() is called when the component is mounted, and whenever a route parameter or query parameter gets a changed value.
-     */
-    ViewBase.prototype.viewParamsUpdated = function () {
-    };
-    /** Gets the parent breadcrumbs, and the breadcrumb for this view. */
-    ViewBase.prototype.getBreadCrumbStart = function () {
-        var _this = this;
-        var items = [];
-        // Get parent items
-        var menuRoute = this.routingState.currentRoute;
-        var parent = menuRoute.breadCrumbParent;
-        while (parent) {
-            items.splice(0, 0, new BreadCrumbItem(parent.name, parent.path));
-            parent = parent.breadCrumbParent;
-        }
-        // Add view name
-        var firstParam = this.viewState.viewParams.params[0];
-        items.push(new BreadCrumbItem(function () { return _this.viewName; }, (firstParam === null || firstParam === void 0 ? void 0 : firstParam.routeParameter.required) ? "" : this.navigation.getCurrentViewPath()));
-        return items;
-    };
-    /**
-     * 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.
-     */
-    ViewBase.prototype.initialise = function () {
-        return this.viewModel.initialise();
-    };
-    ViewBase.prototype.disposeViewModel = function () {
-        this.viewModel.dispose();
-    };
-    ViewBase.prototype.getBreadCrumbList = function () {
-        var breadCrumbList = [];
-        if (!this.breadCrumbStartItems) {
-            this.breadCrumbStartItems = this.getBreadCrumbStart();
-        }
-        breadCrumbList.push.apply(breadCrumbList, this.breadCrumbStartItems);
-        breadCrumbList.push.apply(breadCrumbList, this.viewParams.getBreadCrumbList());
-        return breadCrumbList;
-    };
-    /**
-     * 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.
-     */
-    ViewBase.prototype.onLeave = function () {
-        return 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
-     */
-    ViewBase.prototype.beforeRouteChanged = function (props) {
-    };
-    /** Represents the view that is currently being displayed */
-    ViewBase.currentView = null;
-    __decorate([
-        observable.ref,
-        __metadata("design:type", String)
-    ], ViewBase.prototype, "viewName", void 0);
-    __decorate([
-        observable.ref,
-        __metadata("design:type", Object)
-    ], ViewBase, "currentView", void 0);
-    return ViewBase;
-}(React.Component));
-export default ViewBase;
+import { __awaiter, __decorate, __extends, __generator, __metadata } from "tslib";
+import React from 'react';
+import { observable, runInAction } from 'mobx';
+import { Misc } from '@singularsystems/neo-core';
+import { ViewParameterList } from '../Routing/ViewParameterList';
+import { ViewState } from './ViewState';
+import { BreadCrumbItem } from '../Routing/BreadCrumbItem';
+import { NeoReactTypes } from '../Modules/Types';
+import ViewModelBase from './ViewModelBase';
+var ViewBase = /** @class */ (function (_super) {
+    __extends(ViewBase, _super);
+    /**
+     * 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.
+     */
+    function ViewBase(viewName, viewModel, props) {
+        var _this = _super.call(this, props) || this;
+        _this.viewName = "";
+        _this.routingState = Misc.Globals.appService.get(NeoReactTypes.Routing.GlobalRoutingState);
+        _this.navigation = Misc.Globals.appService.get(NeoReactTypes.Routing.NavigationHelper);
+        if (typeof viewName !== "string") {
+            throw "Error: When inheriting ViewBase, you must pass the view name into the base constructor.";
+        }
+        _this.viewName = viewName;
+        _this.viewState = _this.getStoredViewState(viewModel);
+        _this.routingState.currentView = _this;
+        return _this;
+    }
+    Object.defineProperty(ViewBase, "currentView", {
+        // For backwards compatibility
+        get: function () {
+            return Misc.Globals.appService.get(NeoReactTypes.Routing.GlobalRoutingState).currentView;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ViewBase.prototype, "viewModel", {
+        get: function () {
+            return this.viewState.viewModel;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ViewBase.prototype, "taskRunner", {
+        get: function () {
+            return this.viewModel.taskRunner;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ViewBase.prototype, "viewParams", {
+        get: function () {
+            return this.viewState.viewParams;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    ViewBase.prototype.getStoredViewState = function (viewModel) {
+        return this.createViewState(viewModel);
+    };
+    ViewBase.prototype.createViewState = function (viewModel) {
+        var params = this.constructor.params;
+        var paramsList = new ViewParameterList(params, this);
+        var viewModelInstance = ViewModelBase.create(viewModel);
+        return new ViewState(paramsList, viewModelInstance);
+    };
+    ViewBase.prototype.componentDidMount = function () {
+        var _this = this;
+        var paramsUpdated = this.navigation.currentRouteProps ? this.viewState.viewParams.update(this.navigation.currentRouteProps.match) : false;
+        var initPromise;
+        if (!this.viewState.hasSetup) {
+            this.viewState.hasSetup = true;
+            initPromise = this.initialise();
+        }
+        if (paramsUpdated) {
+            if (initPromise) {
+                initPromise.then(function () { return _this.viewParamsUpdated(); });
+            }
+            else {
+                this.viewParamsUpdated();
+            }
+        }
+    };
+    ViewBase.prototype.componentWillUnmount = function () {
+        this.disposeViewModel();
+    };
+    ViewBase.prototype.updateViewParams = function (match) {
+        var _this = this;
+        runInAction(function () { return __awaiter(_this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!this.viewState.viewParams.update(match)) return [3 /*break*/, 2];
+                        return [4 /*yield*/, Promise.resolve(this.viewParamsUpdated())];
+                    case 1:
+                        _a.sent();
+                        _a.label = 2;
+                    case 2: return [2 /*return*/];
+                }
+            });
+        }); });
+    };
+    /**
+     * viewParamsUpdated() is called when the component is mounted, and whenever a route parameter or query parameter gets a changed value.
+     */
+    ViewBase.prototype.viewParamsUpdated = function () {
+    };
+    /** Gets the parent breadcrumbs, and the breadcrumb for this view. */
+    ViewBase.prototype.getBreadCrumbStart = function () {
+        var _this = this;
+        var items = [];
+        // Get parent items
+        var menuRoute = this.routingState.currentRoute;
+        var parent = menuRoute.breadCrumbParent;
+        while (parent) {
+            items.splice(0, 0, new BreadCrumbItem(parent.name, parent.path));
+            parent = parent.breadCrumbParent;
+        }
+        // Add view name
+        var firstParam = this.viewState.viewParams.params[0];
+        items.push(new BreadCrumbItem(function () { return _this.viewName; }, (firstParam === null || firstParam === void 0 ? void 0 : firstParam.routeParameter.required) ? "" : this.navigation.getCurrentViewPath()));
+        return items;
+    };
+    /**
+     * 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.
+     */
+    ViewBase.prototype.initialise = function () {
+        return this.viewModel.initialise();
+    };
+    ViewBase.prototype.disposeViewModel = function () {
+        this.viewModel.dispose();
+    };
+    ViewBase.prototype.getBreadCrumbList = function () {
+        var breadCrumbList = [];
+        if (!this.breadCrumbStartItems) {
+            this.breadCrumbStartItems = this.getBreadCrumbStart();
+        }
+        breadCrumbList.push.apply(breadCrumbList, this.breadCrumbStartItems);
+        breadCrumbList.push.apply(breadCrumbList, this.viewParams.getBreadCrumbList());
+        return breadCrumbList;
+    };
+    /**
+     * 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.
+     */
+    ViewBase.prototype.onLeave = function () {
+        return 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
+     */
+    ViewBase.prototype.beforeRouteChanged = function (props) {
+    };
+    __decorate([
+        observable.ref,
+        __metadata("design:type", String)
+    ], ViewBase.prototype, "viewName", void 0);
+    return ViewBase;
+}(React.Component));
+export default ViewBase;

package/dist/Views/ViewComponentBase.d.ts

@@ -1,13 +1,19 @@
-import React from 'react';
-import { ITaskRunner } from '@singularsystems/neo-core';
-import { IViewModel } from './IViewModel';
-interface IComponentProps {
-    taskRunner?: ITaskRunner;
-}
-export default class ViewComponentBase<TProps extends IComponentProps, TViewModel extends IViewModel> extends React.Component<TProps> {
-    constructor(props: TProps, viewModelType: new () => TViewModel);
-    viewModel: TViewModel;
-    componentDidMount(): void;
-    componentWillUnmount(): void;
-}
-export {};
+import React from 'react';
+import { ITaskRunner } from '@singularsystems/neo-core';
+import { IViewModel } from './IViewModel';
+import { valueOrLazy } from './ViewModelBase';
+interface IComponentProps {
+    taskRunner?: ITaskRunner;
+}
+export default class ViewComponentBase<TProps extends IComponentProps, TViewModel extends IViewModel> extends React.Component<TProps> {
+    /**
+     * Creates a view component.
+     * @param props Component props.
+     * @param viewModel Instance of view model, or view model type, or callback which returns a view model. Taskrunner will be set only if passing in VM type.
+     */
+    constructor(props: TProps, viewModel: valueOrLazy<TViewModel>);
+    viewModel: TViewModel;
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+}
+export {};

package/dist/Views/ViewComponentBase.js

@@ -1,21 +1,24 @@
-import { __extends } from "tslib";
-import React from 'react';
-var ViewComponentBase = /** @class */ (function (_super) {
-    __extends(ViewComponentBase, _super);
-    function ViewComponentBase(props, viewModelType) {
-        var _this = _super.call(this, props) || this;
-        _this.viewModel = new viewModelType();
-        if (props.taskRunner) {
-            _this.viewModel.taskRunner = props.taskRunner;
-        }
-        return _this;
-    }
-    ViewComponentBase.prototype.componentDidMount = function () {
-        this.viewModel.initialise();
-    };
-    ViewComponentBase.prototype.componentWillUnmount = function () {
-        this.viewModel.dispose();
-    };
-    return ViewComponentBase;
-}(React.Component));
-export default ViewComponentBase;
+import { __extends } from "tslib";
+import React from 'react';
+import ViewModelBase from './ViewModelBase';
+var ViewComponentBase = /** @class */ (function (_super) {
+    __extends(ViewComponentBase, _super);
+    /**
+     * Creates a view component.
+     * @param props Component props.
+     * @param viewModel Instance of view model, or view model type, or callback which returns a view model. Taskrunner will be set only if passing in VM type.
+     */
+    function ViewComponentBase(props, viewModel) {
+        var _this = _super.call(this, props) || this;
+        _this.viewModel = ViewModelBase.create(viewModel, props.taskRunner);
+        return _this;
+    }
+    ViewComponentBase.prototype.componentDidMount = function () {
+        this.viewModel.initialise();
+    };
+    ViewComponentBase.prototype.componentWillUnmount = function () {
+        this.viewModel.dispose();
+    };
+    return ViewComponentBase;
+}(React.Component));
+export default ViewComponentBase;

package/dist/Views/ViewModelBase.d.ts

@@ -1,56 +1,57 @@
-import { ModelBase, Misc, Model, ITaskRunner } from '@singularsystems/neo-core';
-import { IViewModel } from './IViewModel';
-import { IReactionDisposer } from 'mobx';
-import { BindableBase } from '@singularsystems/neo-core/dist/Model/BindableBase';
-import { AxiosPromise } from 'axios';
-import { WaitForTaskRunnerOptions } from '@singularsystems/neo-core/dist/Components/TaskRunner/TaskRunner';
-export declare type valueOrLazy<T> = T | (() => T) | (new () => T);
-export default abstract class ViewModelBase extends ModelBase implements IViewModel {
-    taskRunner: ITaskRunner;
-    private disposeHelper;
-    private trackedViewModels;
-    constructor(taskRunner?: ITaskRunner, disposeHelper?: import("../Services/IDisposeHelper").IDisposeHelper);
-    initialise(): void;
-    /**
-     * 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: () => T, effect: (value: T) => void): IReactionDisposer;
-    /**
-     * Instantiates, and registers a child view model that will be disposed when this view model is disposed.
-     * The task runner will be passed to the new vm from this one.
-     * @param viewModel View model type.
-     */
-    registerViewModel<TViewModel extends IViewModel>(viewModel: new () => TViewModel, options?: {
-        initialise: boolean;
-    }): TViewModel;
-    /**
-     * Registers a child view model that will be disposed when this view model is disposed.
-     */
-    registerViewModel<TViewModel extends IViewModel>(viewModel: TViewModel): TViewModel;
-    /**
-     * Disposes a child view model and sets the property value to null.
-     * Note: you will need to pass in the VM property like this: (this as MyVM).meta.vmProperty
-     */
-    protected disposeViewModel(vmProperty: Model.IPropertyInstance<IViewModel | null>): void;
-    /**
-     * Uses the task runner to call an api endpoint. The returned data is deserialised into an instance of the provided model type.
-     */
-    waitForModel<T extends BindableBase>(modelType: typeof BindableBase, task: AxiosPromise<Model.PlainTrackedObject<T>>, options?: Partial<WaitForTaskRunnerOptions<Model.PlainTrackedObject<T>>>): Promise<T>;
-    /**
-     * Registers the object for disposal when this viewmodel is disposed.
-     */
-    autoDispose<T extends Misc.IDisposable>(disposable: T): T;
-    /**
-     * Binds a list of functions to the viewmodel instance.
-     */
-    protected bindMethods(...fns: Function[]): void;
-    dispose(): void;
-    /**
-     * Creates a view model instance.
-     * @param viewModel ViewModel instance, callback which returns a ViewModel or ViewModel constructor.
-     * @param taskRunner TaskRunner to set if a constructor is passed in.
-     */
-    static create<TViewModel extends IViewModel>(viewModel: valueOrLazy<TViewModel>, taskRunner?: ITaskRunner): TViewModel;
-}
+import { ModelBase, Misc, Model, ITaskRunner } from '@singularsystems/neo-core';
+import { IViewModel } from './IViewModel';
+import { IReactionDisposer } from 'mobx';
+import { BindableBase } from '@singularsystems/neo-core/dist/Model/BindableBase';
+import { AxiosPromise } from 'axios';
+import { WaitForTaskRunnerOptions } from '@singularsystems/neo-core/dist/Components/TaskRunner/TaskRunner';
+export type valueOrLazy<T> = T | (() => T) | (new () => T);
+export default abstract class ViewModelBase extends ModelBase implements IViewModel {
+    taskRunner: ITaskRunner;
+    private disposeHelper;
+    private trackedViewModels;
+    constructor(taskRunner?: ITaskRunner, disposeHelper?: import("../Services/IDisposeHelper").IDisposeHelper);
+    initialise(): void;
+    /**
+     * 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: () => T, effect: (value: T) => void): IReactionDisposer;
+    /**
+     * Instantiates, and registers a child view model that will be disposed when this view model is disposed.
+     * The task runner will be passed to the new vm from this one.
+     * @param viewModel View model type.
+     */
+    registerViewModel<TViewModel extends IViewModel>(viewModel: new () => TViewModel, options?: {
+        initialise: boolean;
+    }): TViewModel;
+    /**
+     * Registers a child view model that will be disposed when this view model is disposed.
+     * You must manually pass the current VMs task runner to the new viewmodel instance.
+     */
+    registerViewModel<TViewModel extends IViewModel>(viewModel: TViewModel): TViewModel;
+    /**
+     * Disposes a child view model and sets the property value to null.
+     * Note: you will need to pass in the VM property like this: (this as MyVM).meta.vmProperty
+     */
+    protected disposeViewModel(vmProperty: Model.IPropertyInstance<IViewModel | null>): void;
+    /**
+     * Uses the task runner to call an api endpoint. The returned data is deserialised into an instance of the provided model type.
+     */
+    waitForModel<T extends BindableBase>(modelType: typeof BindableBase, task: AxiosPromise<Model.PlainTrackedObject<T>>, options?: Partial<WaitForTaskRunnerOptions<Model.PlainTrackedObject<T>>>): Promise<T>;
+    /**
+     * Registers the object for disposal when this viewmodel is disposed.
+     */
+    autoDispose<T extends Misc.IDisposable>(disposable: T): T;
+    /**
+     * Binds a list of functions to the viewmodel instance.
+     */
+    protected bindMethods(...fns: Function[]): void;
+    dispose(): void;
+    /**
+     * Creates a view model instance.
+     * @param viewModel ViewModel instance, callback which returns a ViewModel or ViewModel constructor.
+     * @param taskRunner TaskRunner to set if a constructor is passed in.
+     */
+    static create<TViewModel extends IViewModel>(viewModel: valueOrLazy<TViewModel>, taskRunner?: ITaskRunner): TViewModel;
+}