@singularsystems/neo-react 0.10.64 → 0.10.65

package/dist/Routing/RoutingState.js

@@ -1,11 +1,27 @@
 import { __decorate, __metadata } from "tslib";
 import { injectable } from 'inversify';
-import { observable } from 'mobx';
-import { ViewBase } from '../Views';
+import { computed, observable } from 'mobx';
 var RoutingState = /** @class */ (function () {
     function RoutingState() {
         this.observableRoute = null;
+        this.currentView = null;
     }
+    Object.defineProperty(RoutingState.prototype, "currentViewFullScreen", {
+        get: function () {
+            var _a;
+            return ((_a = this.currentView) === null || _a === void 0 ? void 0 : _a.fullScreen) === true;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(RoutingState.prototype, "taskRunner", {
+        get: function () {
+            var _a;
+            return (_a = this.currentView) === null || _a === void 0 ? void 0 : _a.taskRunner;
+        },
+        enumerable: false,
+        configurable: true
+    });
     RoutingState.prototype.setCurrentRoute = function (routeProps, route) {
         this.currentRouteProps = routeProps;
         this.currentRoute = route;
@@ -14,17 +30,17 @@ var RoutingState = /** @class */ (function () {
         var _a, _b;
         if (this.previousRoute !== this.currentRoute) {
             this.previousRoute = this.currentRoute;
-            this.observableRoute = (_a = this.currentRoute, (_a !== null && _a !== void 0 ? _a : null));
-            if (((_b = ViewBase.currentView) === null || _b === void 0 ? void 0 : _b.constructor) !== this.currentRoute.component) {
-                ViewBase.currentView = null;
+            this.observableRoute = (_a = this.currentRoute) !== null && _a !== void 0 ? _a : null;
+            if (((_b = this.currentView) === null || _b === void 0 ? void 0 : _b.constructor) !== this.currentRoute.component) {
+                this.currentView = null;
             }
             // Scroll back to top as if the browser had actually loaded a new page.
             window.scrollTo(0, 0);
         }
         else {
             // Same route, but parameters must have changed.
-            if (ViewBase.currentView) {
-                ViewBase.currentView.updateViewParams(this.currentRouteProps.match);
+            if (this.currentView) {
+                this.currentView.updateViewParams(this.currentRouteProps.match);
             }
         }
     };
@@ -32,6 +48,20 @@ var RoutingState = /** @class */ (function () {
         observable.ref,
         __metadata("design:type", Object)
     ], RoutingState.prototype, "observableRoute", void 0);
+    __decorate([
+        observable.ref,
+        __metadata("design:type", Object)
+    ], RoutingState.prototype, "currentView", void 0);
+    __decorate([
+        computed,
+        __metadata("design:type", Object),
+        __metadata("design:paramtypes", [])
+    ], RoutingState.prototype, "currentViewFullScreen", null);
+    __decorate([
+        computed,
+        __metadata("design:type", Object),
+        __metadata("design:paramtypes", [])
+    ], RoutingState.prototype, "taskRunner", null);
     RoutingState = __decorate([
         injectable()
     ], RoutingState);

package/dist/Routing/ViewParameter.js

@@ -32,7 +32,7 @@ var ViewParameter = /** @class */ (function () {
                 this.parent.setUrl(this);
             }
         },
-        enumerable: true,
+        enumerable: false,
         configurable: true
     });
     ViewParameter.prototype.reset = function () {
@@ -52,7 +52,7 @@ var ViewParameter = /** @class */ (function () {
             }
             this._description = value;
         },
-        enumerable: true,
+        enumerable: false,
         configurable: true
     });
     ViewParameter.prototype.setDescription = function (description, getPrefixes) {
@@ -104,7 +104,7 @@ var ViewParameter = /** @class */ (function () {
         get: function () {
             return this.hasPendingValue ? this.pendingValue : this._value;
         },
-        enumerable: true,
+        enumerable: false,
         configurable: true
     });
     __decorate([

package/dist/Routing/ViewParameterList.d.ts

@@ -6,6 +6,12 @@ import { IViewBase } from '../Views/ViewBase';
 export declare type TransformParamsType<T> = {
     [P in keyof T]: IViewParameter;
 };
+interface ISetValuesOptions {
+    /** True if the url should be set even if none of the values have changed. */
+    force?: boolean;
+    /** True if the url should be replaced instead of added to the history. This prevents the back button returning the params to the current state. */
+    replace?: boolean;
+}
 export interface IViewParameterList {
     /**
      * Returns the breadcrumb items for all url parameters which have a value.
@@ -16,11 +22,10 @@ export interface IViewParameterListOfT<TParams extends RouteParameterObject<TPar
     /**
      * Set the view params for each of the provided values. Only 1 navigation event will occur.
      * @param values New values.
-     * @param force True if the url should be set even if none of the values have changed.
      */
     setValues(values: {
         [P in keyof TParams]?: number | string | null;
-    }, force?: boolean): void;
+    }, options?: ISetValuesOptions | boolean): void;
 }
 export interface IViewParameterListInternal extends IViewParameterList {
     update(match: match): boolean;
@@ -38,7 +43,7 @@ export declare class ViewParameterList<TParams extends RouteParameterObject<TPar
     private getQueryString;
     setValues(values: {
         [P in keyof TParams]?: number | string | null;
-    }, force?: boolean): void;
+    }, options?: ISetValuesOptions | boolean): void;
     setUrl(viewParameter: ViewParameter | null, replace?: boolean): void;
     /**
      * Updates the parameter values from the values in the url. Returns true if any of the values have changed.
@@ -51,3 +56,4 @@ export declare class ViewParameterList<TParams extends RouteParameterObject<TPar
      */
     static getPathForValues<TParams extends RouteParameterObject<TParams>>(basePath: string, params: TParams, values: {}): string;
 }
+export {};

package/dist/Routing/ViewParameterList.js

@@ -45,7 +45,7 @@ var ViewParameterList = /** @class */ (function () {
                     }
                 }
                 paramPath += viewParam.getParamString(state);
-                if ((_a = viewParam.routeParameter.selection, (_a !== null && _a !== void 0 ? _a : BreadCrumbSelectMode.Default)) === BreadCrumbSelectMode.Default) {
+                if (((_a = viewParam.routeParameter.selection) !== null && _a !== void 0 ? _a : BreadCrumbSelectMode.Default) === BreadCrumbSelectMode.Default) {
                     selectablePath = paramPath;
                 }
                 if (viewParam.description || (upTo && viewParam.latestValue !== null)) {
@@ -69,17 +69,20 @@ var ViewParameterList = /** @class */ (function () {
         }
         return queryPath;
     };
-    ViewParameterList.prototype.setValues = function (values, force) {
-        if (force === void 0) { force = false; }
+    ViewParameterList.prototype.setValues = function (values, options) {
         var _a;
         this.suppressNavigation = true;
         this.hasSuppressedNavigation = false;
+        options !== null && options !== void 0 ? options : (options = {});
+        if (typeof options === "boolean") {
+            options = { force: true }; // parameter used to be named 'force'- backwards compatibility.
+        }
         for (var paramName in values) {
-            this[paramName].value = (_a = values[paramName], (_a !== null && _a !== void 0 ? _a : null));
+            this[paramName].value = (_a = values[paramName]) !== null && _a !== void 0 ? _a : null;
         }
         this.suppressNavigation = false;
-        if (this.hasSuppressedNavigation || force) {
-            this.setUrl(this.params[this.params.length - 1]);
+        if (this.hasSuppressedNavigation || options.force) {
+            this.setUrl(this.params[this.params.length - 1], options.replace);
         }
     };
     ViewParameterList.prototype.setUrl = function (viewParameter, replace) {

package/dist/Services/IDisposeHelper.js

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

package/dist/Views/IViewModel.js

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

package/dist/Views/ViewBase.d.ts

@@ -10,6 +10,7 @@ import EmptyViewModel from './EmptyViewModel';
 import { IRouteChangedProps } from '../Routing/IRouteChangedProps';
 import { valueOrLazy } from './ViewModelBase';
 export interface IViewBase extends Views.IViewBase {
+    readonly fullScreen: boolean;
     viewParams: IViewParameterList;
     updateViewParams(match: match): void;
     getBreadCrumbList(): BreadCrumbItem[];
@@ -21,9 +22,10 @@ export interface IViewBaseConstructor {
     params?: RouteParameterObject<any>;
 }
 export default abstract class ViewBase<TViewModel extends IViewModel = EmptyViewModel, TParams extends RouteParameterObject<TParams> = {}> extends React.Component implements IViewBase {
-    /** Represents the view that is currently being displayed */
-    static currentView: IViewBase | null;
     viewName: string;
+    /** Indicates that the view requests to be displayed full screen. Up to the main layout to accommodate this. */
+    fullScreen: boolean;
+    static get currentView(): IViewBase | null;
     private routingState;
     navigation: import("../Routing").INavigationHelper;
     private breadCrumbStartItems?;

package/dist/Views/ViewBase.js

@@ -18,6 +18,8 @@ var ViewBase = /** @class */ (function (_super) {
     function ViewBase(viewName, viewModel, props) {
         var _this = _super.call(this, props) || this;
         _this.viewName = "";
+        /** Indicates that the view requests to be displayed full screen. Up to the main layout to accommodate this. */
+        _this.fullScreen = false;
         _this.routingState = Misc.Globals.appService.get(NeoReactTypes.Routing.GlobalRoutingState);
         _this.navigation = Misc.Globals.appService.get(NeoReactTypes.Routing.NavigationHelper);
         if (typeof viewName !== "string") {
@@ -25,28 +27,36 @@ var ViewBase = /** @class */ (function (_super) {
         }
         _this.viewName = viewName;
         _this.viewState = _this.getStoredViewState(viewModel);
-        ViewBase.currentView = _this;
+        _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: true,
+        enumerable: false,
         configurable: true
     });
     Object.defineProperty(ViewBase.prototype, "taskRunner", {
         get: function () {
             return this.viewModel.taskRunner;
         },
-        enumerable: true,
+        enumerable: false,
         configurable: true
     });
     Object.defineProperty(ViewBase.prototype, "viewParams", {
         get: function () {
             return this.viewState.viewParams;
         },
-        enumerable: true,
+        enumerable: false,
         configurable: true
     });
     ViewBase.prototype.getStoredViewState = function (viewModel) {
@@ -102,7 +112,6 @@ var ViewBase = /** @class */ (function (_super) {
     /** Gets the parent breadcrumbs, and the breadcrumb for this view. */
     ViewBase.prototype.getBreadCrumbStart = function () {
         var _this = this;
-        var _a;
         var items = [];
         // Get parent items
         var menuRoute = this.routingState.currentRoute;
@@ -113,7 +122,7 @@ var ViewBase = /** @class */ (function (_super) {
         }
         // Add view name
         var firstParam = this.viewState.viewParams.params[0];
-        items.push(new BreadCrumbItem(function () { return _this.viewName; }, ((_a = firstParam) === null || _a === void 0 ? void 0 : _a.routeParameter.required) ? "" : this.navigation.getCurrentViewPath()));
+        items.push(new BreadCrumbItem(function () { return _this.viewName; }, (firstParam === null || firstParam === void 0 ? void 0 : firstParam.routeParameter.required) ? "" : this.navigation.getCurrentViewPath()));
         return items;
     };
     /**
@@ -150,16 +159,14 @@ var ViewBase = /** @class */ (function (_super) {
      */
     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);
+        __metadata("design:type", Boolean)
+    ], ViewBase.prototype, "fullScreen", void 0);
     return ViewBase;
 }(React.Component));
 export default ViewBase;

package/dist/Views/ViewModelBase.d.ts

@@ -1,9 +1,9 @@
 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';
+import { BindableBase } from '@singularsystems/neo-core/dist/Model/BindableBase';
 export declare type valueOrLazy<T> = T | (() => T) | (new () => T);
 export default abstract class ViewModelBase extends ModelBase implements IViewModel {
     taskRunner: ITaskRunner;

package/dist/Views/ViewModelBase.js

@@ -23,9 +23,8 @@ var ViewModelBase = /** @class */ (function (_super) {
         return this.disposeHelper.registerReaction(expression, effect);
     };
     ViewModelBase.prototype.registerViewModel = function (viewModel, options) {
-        var _a;
         var viewModelInstance = ViewModelBase.create(viewModel, this.taskRunner);
-        if ((_a = options) === null || _a === void 0 ? void 0 : _a.initialise) {
+        if (options === null || options === void 0 ? void 0 : options.initialise) {
             viewModelInstance.initialise();
         }
         this.trackedViewModels.push(viewModelInstance);

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@singularsystems/neo-react",
-  "version": "0.10.64",
+  "version": "0.10.65",
   "description": "React application logic and components for the Neo client library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
-    "test": "react-scripts test"
+    "test": "react-scripts test --watchAll=false --runInBand"
   },
   "files": [
     "dist",
@@ -15,25 +15,27 @@
   "author": "Singular Systems",
   "license": "ISC",
   "devDependencies": {
-    "@types/jest": "^24.0.15",
+    "@types/history": "4.7.4",
+    "@types/jest": "29.5.3",
     "@types/memoize-one": "4.1.1",
     "@types/node": "12.0.8",
     "@types/prop-types": "15.7.0",
     "@types/react": "^16.9.51",
     "@types/react-custom-scrollbars": "^4.0.6",
     "@types/react-dom": "^16.9.8",
+    "@types/react-router": "5.1.0",
     "@types/react-router-dom": "5.1.0",
-    "react-scripts": "3.3.0",
+    "react-scripts": "5.0.1",
     "react-testing-library": "^7.0.1",
-    "ts-jest": "26.5.3",
-    "typescript": "3.7.5",
-    "tslib": "2.3.1"
+    "ts-jest": "29.1.1",
+    "tslib": "2.3.1",
+    "typescript": "4.5.5"
   },
   "dependencies": {
+    "@singularsystems/neo-core": "0.10.77",
     "@types/rc-slider": "^8.6.5",
     "@types/react-color": "^3.0.1",
     "@types/react-select": "3.1.0",
-    "@singularsystems/neo-core": "^0.10.75",
     "axios": "^0.21.1",
     "decimal.js-light": "2.5.1",
     "history": "4.10.1",
@@ -44,15 +46,22 @@
     "react": "^16.13.1",
     "react-custom-scrollbars": "^4.2.1",
     "react-dom": "^16.13.1",
+    "react-router": "5.1.0",
     "react-router-dom": "5.1.0"
   },
   "peerDependencies": {
-    "@singularsystems/neo-core": ">=0.10.74",
+    "@singularsystems/neo-core": ">=0.10.77",
     "axios": ">=0.21.1",
     "inversify": ">=5.0.1",
     "react": ">=16.13.1",
     "react-dom": ">=16.13.1",
     "react-router": "^5.0.0",
     "react-router-dom": "^5.0.0"
-  }
+  },
+  "resolutions": {
+    "@singularsystems/neo-core": "portal:../core",
+    "@types/react": "16.9.4",
+    "@types/react-router": "5.1.0"
+  },
+  "packageManager": "yarn@3.6.1"
 }

package/dist/ReactComponents/IconFactory.d.ts

@@ -1,27 +0,0 @@
-import React from "react";
-export interface IconStyle {
-    fixedWidth?: boolean;
-    spin?: boolean;
-}
-export interface IIconFactory {
-    /**
-     * Returns a component that renders an icon.
-     * @param iconOrName If this is a string, it is treated as an icon name. Otherwise it is treated as the icon component.
-     *
-     * The default neo icon factory maps icon names to font-awesome icons.
-     */
-    getIconComponent(iconOrName: any, style?: IconStyle): React.ReactNode | undefined;
-    /**
-     * Returns the original text, or an icon for specific prefixes.
-     * @param textOrIcon If textOrIcon starts with a specific prefix, this will return an icon component, otherwise it will return text.
-     *
-     * By default the neo icon factory will return a font-awesome icon if the prefix is fa- or far-
-     */
-    textOrIcon(textOrIcon: string, style?: IconStyle): React.ReactNode | string;
-}
-export declare class IconFactory implements IIconFactory {
-    getIconComponent(iconOrName: any, style?: IconStyle): import("history").History.PoorMansUnknown;
-    textOrIcon(textOrIcon: string, style?: IconStyle): import("history").History.PoorMansUnknown;
-    protected mapStringToIcon(iconName: string, style?: IconStyle): React.ReactNode;
-    protected createIconComponent(iconDescriptor: any, style?: IconStyle): React.ReactNode;
-}

package/dist/ReactComponents/IconFactory.js

@@ -1,46 +0,0 @@
-import { __decorate } from "tslib";
-import { Utils } from "@singularsystems/neo-core";
-import React from "react";
-import { injectable } from 'inversify';
-var IconFactory = /** @class */ (function () {
-    function IconFactory() {
-    }
-    IconFactory.prototype.getIconComponent = function (iconOrName, style) {
-        if (iconOrName) {
-            if (typeof iconOrName === "string") {
-                return this.mapStringToIcon(iconOrName, style);
-            }
-            else {
-                return this.createIconComponent(iconOrName, style);
-            }
-        }
-        return undefined;
-    };
-    IconFactory.prototype.textOrIcon = function (textOrIcon, style) {
-        if (textOrIcon.indexOf("fa-") === 0 || textOrIcon.indexOf("far-") === 0) {
-            return this.getIconComponent(textOrIcon, style);
-        }
-        else {
-            return textOrIcon;
-        }
-    };
-    IconFactory.prototype.mapStringToIcon = function (iconName, style) {
-        var _a, _b;
-        var className = Utils.getFontAwesomeClass(iconName);
-        if ((_a = style) === null || _a === void 0 ? void 0 : _a.fixedWidth) {
-            className += " fa-fw";
-        }
-        if ((_b = style) === null || _b === void 0 ? void 0 : _b.spin) {
-            className += " fa-spin";
-        }
-        return React.createElement("i", { className: className });
-    };
-    IconFactory.prototype.createIconComponent = function (iconDescriptor, style) {
-        return iconDescriptor;
-    };
-    IconFactory = __decorate([
-        injectable()
-    ], IconFactory);
-    return IconFactory;
-}());
-export { IconFactory };

package/dist/ReactComponents/ReactHelpers.d.ts

@@ -1,5 +0,0 @@
-/// <reference types="react" />
-export declare class ReactHelpers {
-    /** If a string starts with fa- or far-, this will return an 'i' tag with the font-awesome class name. Otherwise it will return the passed in string. */
-    static textOrIcon(textOrIcon: string): string | JSX.Element;
-}

package/dist/ReactComponents/ReactHelpers.js

@@ -1,17 +0,0 @@
-import React from 'react';
-import { Utils } from '@singularsystems/neo-core';
-var ReactHelpers = /** @class */ (function () {
-    function ReactHelpers() {
-    }
-    /** If a string starts with fa- or far-, this will return an 'i' tag with the font-awesome class name. Otherwise it will return the passed in string. */
-    ReactHelpers.textOrIcon = function (textOrIcon) {
-        if (textOrIcon.indexOf("fa-") === 0 || textOrIcon.indexOf("far-") === 0) {
-            return React.createElement("i", { className: Utils.getFontAwesomeClass(textOrIcon) });
-        }
-        else {
-            return textOrIcon;
-        }
-    };
-    return ReactHelpers;
-}());
-export { ReactHelpers };