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

package/dist/Routing/ViewParameter.js

@@ -1,95 +1,116 @@
-import { __decorate, __metadata } from "tslib";
-import { observable } from 'mobx';
-var ViewParameter = /** @class */ (function () {
-    function ViewParameter(parent, name, routeParameter) {
-        this.parent = parent;
-        this.name = name;
-        this.routeParameter = routeParameter;
-        this.hasPendingValue = false;
-        this.pendingValue = null;
-        this._value = null;
-        this.description = "";
-    }
-    ViewParameter.prototype.bindTo = function (propertyOrCallback) {
-        var _this = this;
-        if (propertyOrCallback.propertyInfo) {
-            this.parent.view.viewModel.registerReaction(function () { return propertyOrCallback.value; }, function (val) { return _this.value = val; });
-        }
-        else if (propertyOrCallback instanceof Function) {
-            this.parent.view.viewModel.registerReaction(propertyOrCallback, function (val) { return _this.value = val; });
-        }
-    };
-    Object.defineProperty(ViewParameter.prototype, "value", {
-        get: function () {
-            return this._value;
-        },
-        set: function (value) {
-            var stringValue = value ? value.toString() : null;
-            if (stringValue !== this._value) {
-                this.hasPendingValue = true;
-                this.pendingValue = stringValue;
-                this.description = "";
-                this.parent.setUrl(this);
-            }
-        },
-        enumerable: false,
-        configurable: true
-    });
-    ViewParameter.prototype.reset = function () {
-        if (this._value) {
-            this.hasPendingValue = true;
-            this.pendingValue = null;
-            this.parent.setUrl(this, true);
-        }
-    };
-    ViewParameter.prototype.asNullableInt = function () {
-        if (this._value) {
-            return parseInt(this._value, 10);
-        }
-        return null;
-    };
-    ViewParameter.prototype.asString = function () {
-        return this._value || "";
-    };
-    /** Sets the initial value, and returns true if the value changed. */
-    ViewParameter.prototype.setInitial = function (value) {
-        if (value)
-            value = decodeURIComponent(value);
-        if (value != this._value) {
-            this.hasPendingValue = false;
-            this.pendingValue = value;
-            this.description = "";
-            this._value = value;
-            return true;
-        }
-        return false;
-    };
-    ViewParameter.prototype.getParamString = function (state) {
-        var value = this.latestValue;
-        if (value) {
-            value = encodeURIComponent(value);
-            if (this.routeParameter.isQuery) {
-                var hasQuery = state.hasQuery;
-                state.hasQuery = true;
-                return (!hasQuery ? "?" : "&") + this.name + "=" + value;
-            }
-            else {
-                return "/" + value;
-            }
-        }
-        return this.routeParameter.isQuery ? "" : "/";
-    };
-    Object.defineProperty(ViewParameter.prototype, "latestValue", {
-        get: function () {
-            return this.hasPendingValue ? this.pendingValue : this._value;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    __decorate([
-        observable.ref,
-        __metadata("design:type", String)
-    ], ViewParameter.prototype, "description", void 0);
-    return ViewParameter;
-}());
-export { ViewParameter };
+import { __decorate, __metadata } from "tslib";
+import { makeObservable, observable } from 'mobx';
+export var ViewParameter = /** @class */ (function () {
+    function ViewParameter(parent, name, routeParameter) {
+        this.parent = parent;
+        this.name = name;
+        this.routeParameter = routeParameter;
+        this.hasPendingValue = false;
+        this.pendingValue = null;
+        this._value = null;
+        this.prefixes = [];
+        this._description = "";
+        makeObservable(this);
+    }
+    ViewParameter.prototype.bindTo = function (propertyOrCallback) {
+        var _this = this;
+        if (propertyOrCallback.propertyInfo) {
+            this.parent.view.viewModel.registerReaction(function () { return propertyOrCallback.value; }, function (val) { return _this.value = val; });
+        }
+        else if (propertyOrCallback instanceof Function) {
+            this.parent.view.viewModel.registerReaction(propertyOrCallback, function (val) { return _this.value = val; });
+        }
+    };
+    Object.defineProperty(ViewParameter.prototype, "value", {
+        get: function () {
+            return this._value;
+        },
+        set: function (value) {
+            var stringValue = value ? value.toString() : null;
+            if (stringValue !== this._value) {
+                this.hasPendingValue = true;
+                this.pendingValue = stringValue;
+                this.parent.setUrl(this);
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    ViewParameter.prototype.reset = function () {
+        if (this._value) {
+            this.hasPendingValue = true;
+            this.pendingValue = null;
+            this.parent.setUrl(this, true);
+        }
+    };
+    Object.defineProperty(ViewParameter.prototype, "description", {
+        get: function () {
+            return this._description;
+        },
+        set: function (value) {
+            if (this.hasPendingValue) {
+                console.warn("Do not set view parameter description directly after setting value. Description should be set in the viewParamsUpdated() method.");
+            }
+            this._description = value;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    ViewParameter.prototype.setDescription = function (description, getPrefixes) {
+        this.prefixes = getPrefixes ? getPrefixes(this.prefixes) : [];
+        this.description = description;
+    };
+    ViewParameter.prototype.asNullableInt = function () {
+        if (this._value) {
+            return parseInt(this._value, 10);
+        }
+        return null;
+    };
+    ViewParameter.prototype.asString = function () {
+        return this._value || "";
+    };
+    /** Updates the current value, and returns true if the value changed. */
+    ViewParameter.prototype.update = function (value) {
+        if (value) {
+            value = decodeURIComponent(value);
+        }
+        if (value != this._value) {
+            this.hasPendingValue = false;
+            this.pendingValue = value;
+            this._value = value;
+            if (!value) {
+                this._description = "";
+                this.prefixes = [];
+            }
+            return true;
+        }
+        return false;
+    };
+    ViewParameter.prototype.getParamString = function (state) {
+        var value = this.latestValue;
+        if (value) {
+            value = encodeURIComponent(value);
+            if (this.routeParameter.isQuery) {
+                var hasQuery = state.hasQuery;
+                state.hasQuery = true;
+                return (!hasQuery ? "?" : "&") + this.name + "=" + value;
+            }
+            else {
+                return "/" + value;
+            }
+        }
+        return this.routeParameter.isQuery ? "" : "/";
+    };
+    Object.defineProperty(ViewParameter.prototype, "latestValue", {
+        get: function () {
+            return this.hasPendingValue ? this.pendingValue : this._value;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    __decorate([
+        observable.ref,
+        __metadata("design:type", String)
+    ], ViewParameter.prototype, "_description", void 0);
+    return ViewParameter;
+}());

package/dist/Routing/ViewParameterList.d.ts

@@ -1,53 +1,53 @@
-import { ViewParameter, IViewParameter } from './ViewParameter';
-import { RouteParameterObject } from './IRouteParameter';
-import { match } from 'react-router';
-import { BreadCrumbItem } from './BreadCrumbItem';
-import { IViewBase } from '../Views/ViewBase';
-export declare type TransformParamsType<T> = {
-    [P in keyof T]: IViewParameter;
-};
-export interface IViewParameterList {
-    /**
-     * Returns the breadcrumb items for all url parameters which have a value.
-     */
-    getBreadCrumbList(): BreadCrumbItem[];
-}
-export interface IViewParameterListOfT<TParams extends RouteParameterObject<TParams>> extends IViewParameterList {
-    /**
-     * 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;
-}
-export interface IViewParameterListInternal extends IViewParameterList {
-    update(match: match): boolean;
-    setUrl(viewParameter: ViewParameter | null, replace?: boolean): void;
-    view?: IViewBase;
-    readonly params: ViewParameter[];
-}
-export declare class ViewParameterList<TParams extends RouteParameterObject<TParams>> implements IViewParameterListInternal, IViewParameterListOfT<TParams> {
-    readonly view?: IViewBase | undefined;
-    readonly params: ViewParameter[];
-    private suppressNavigation;
-    private hasSuppressedNavigation;
-    constructor(routeParameterObject: TParams, view?: IViewBase | undefined);
-    getBreadCrumbList(upTo?: ViewParameter): BreadCrumbItem[];
-    private getQueryString;
-    setValues(values: {
-        [P in keyof TParams]?: number | string | null;
-    }, force?: 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.
-     */
-    update(match: match): boolean;
-    /**
-     * Gets a url for an object with view params specified.
-     * @param basePath Base path without parameters
-     * @param values Object of param names and values.
-     */
-    static getPathForValues<TParams extends RouteParameterObject<TParams>>(basePath: string, params: TParams, values: {}): string;
-}
+import { ViewParameter, IViewParameter } from './ViewParameter';
+import { RouteParameterObject } from './IRouteParameter';
+import { match } from 'react-router';
+import { BreadCrumbItem } from './BreadCrumbItem';
+import { IViewBase } from '../Views/ViewBase';
+export type TransformParamsType<T> = {
+    [P in keyof T]: IViewParameter;
+};
+export interface IViewParameterList {
+    /**
+     * Returns the breadcrumb items for all url parameters which have a value.
+     */
+    getBreadCrumbList(): BreadCrumbItem[];
+}
+export interface IViewParameterListOfT<TParams extends RouteParameterObject<TParams>> extends IViewParameterList {
+    /**
+     * 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;
+}
+export interface IViewParameterListInternal extends IViewParameterList {
+    update(match: match): boolean;
+    setUrl(viewParameter: ViewParameter | null, replace?: boolean): void;
+    view?: IViewBase;
+    readonly params: ViewParameter[];
+}
+export declare class ViewParameterList<TParams extends RouteParameterObject<TParams>> implements IViewParameterListInternal, IViewParameterListOfT<TParams> {
+    readonly view?: IViewBase | undefined;
+    readonly params: ViewParameter[];
+    private suppressNavigation;
+    private hasSuppressedNavigation;
+    constructor(routeParameterObject: TParams, view?: IViewBase | undefined);
+    getBreadCrumbList(upTo?: ViewParameter): BreadCrumbItem[];
+    private getQueryString;
+    setValues(values: {
+        [P in keyof TParams]?: number | string | null;
+    }, force?: 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.
+     */
+    update(match: match): boolean;
+    /**
+     * Gets a url for an object with view params specified.
+     * @param basePath Base path without parameters
+     * @param values Object of param names and values.
+     */
+    static getPathForValues<TParams extends RouteParameterObject<TParams>>(basePath: string, params: TParams, values: {}): string;
+}

package/dist/Routing/ViewParameterList.js

@@ -1,145 +1,163 @@
-import { ViewParameter } from './ViewParameter';
-import { BreadCrumbSelectMode } from './IRouteParameter';
-import { BreadCrumbItem } from './BreadCrumbItem';
-import { Misc } from '@singularsystems/neo-core';
-import { NeoReactTypes } from '..';
-var ViewParameterList = /** @class */ (function () {
-    function ViewParameterList(routeParameterObject, view) {
-        this.view = view;
-        this.params = [];
-        this.suppressNavigation = false;
-        this.hasSuppressedNavigation = false;
-        if (routeParameterObject) {
-            for (var param in routeParameterObject) {
-                var viewParam = new ViewParameter(this, param, routeParameterObject[param]);
-                this[param] = viewParam;
-                this.params.push(viewParam);
-            }
-        }
-    }
-    ViewParameterList.prototype.getBreadCrumbList = function (upTo) {
-        var _a;
-        var basePath = Misc.Globals.appService.get(NeoReactTypes.Routing.NavigationHelper).getCurrentViewPath();
-        var breadCrumbs = [];
-        var state = { hasQuery: false };
-        var queryPath = this.getQueryString();
-        var paramPath = basePath;
-        var selectablePath = basePath;
-        for (var _i = 0, _b = this.params; _i < _b.length; _i++) {
-            var viewParam = _b[_i];
-            if (!viewParam.routeParameter.isQuery && (viewParam.description || upTo) && viewParam.latestValue !== null) {
-                paramPath += viewParam.getParamString(state);
-                if (((_a = viewParam.routeParameter.selection) !== null && _a !== void 0 ? _a : BreadCrumbSelectMode.Default) === BreadCrumbSelectMode.Default) {
-                    selectablePath = paramPath;
-                }
-                breadCrumbs.push(new BreadCrumbItem(viewParam.description, (!upTo && viewParam.routeParameter.selection === BreadCrumbSelectMode.None) ? "" : (selectablePath + queryPath)));
-            }
-            if (upTo && upTo === viewParam) {
-                break;
-            }
-        }
-        return breadCrumbs;
-    };
-    ViewParameterList.prototype.getQueryString = function () {
-        var state = { hasQuery: false };
-        var queryPath = "";
-        for (var _i = 0, _a = this.params; _i < _a.length; _i++) {
-            var viewParam = _a[_i];
-            if (viewParam.routeParameter.isQuery) {
-                queryPath += viewParam.getParamString(state);
-            }
-        }
-        return queryPath;
-    };
-    ViewParameterList.prototype.setValues = function (values, force) {
-        var _a;
-        if (force === void 0) { force = false; }
-        this.suppressNavigation = true;
-        this.hasSuppressedNavigation = false;
-        for (var paramName in values) {
-            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]);
-        }
-    };
-    ViewParameterList.prototype.setUrl = function (viewParameter, replace) {
-        if (replace === void 0) { replace = false; }
-        if (this.suppressNavigation) {
-            this.hasSuppressedNavigation = true;
-        }
-        else {
-            var navigationHelper = Misc.Globals.appService.get(NeoReactTypes.Routing.NavigationHelper);
-            if (viewParameter) {
-                var allItems = this.getBreadCrumbList(viewParameter);
-                if (allItems.length > 0) {
-                    navigationHelper.navigateInternal(allItems[allItems.length - 1].link, replace);
-                    return;
-                }
-            }
-            navigationHelper.navigateInternal(navigationHelper.getCurrentViewPath(), replace);
-        }
-    };
-    /**
-     * Updates the parameter values from the values in the url. Returns true if any of the values have changed.
-     */
-    ViewParameterList.prototype.update = function (match) {
-        var hasChanged = false;
-        //Get url params
-        for (var param in match.params) {
-            var viewParam = this[param];
-            if (viewParam) {
-                var value = match.params[param];
-                if (value === undefined)
-                    value = null;
-                if (viewParam.setInitial(value))
-                    hasChanged = true;
-            }
-        }
-        //Get query params
-        var queryParams = new URLSearchParams(location.search);
-        for (var _i = 0, _a = this.params; _i < _a.length; _i++) {
-            var viewParam = _a[_i];
-            if (viewParam.routeParameter.isQuery) {
-                if (viewParam.setInitial(queryParams.get(viewParam.name)))
-                    hasChanged = true;
-            }
-        }
-        return hasChanged;
-    };
-    /**
-     * Gets a url for an object with view params specified.
-     * @param basePath Base path without parameters
-     * @param values Object of param names and values.
-     */
-    ViewParameterList.getPathForValues = function (basePath, params, values) {
-        // TODO: This needs a rework.
-        var viewParameterList = new ViewParameterList(params);
-        for (var name_1 in values) {
-            var viewParam = viewParameterList[name_1];
-            if (viewParam) {
-                var value = values[name_1];
-                if (value === undefined)
-                    value = null;
-                if (typeof value === "number") {
-                    value = value.toString();
-                }
-                viewParam.setInitial(value);
-            }
-        }
-        var state = { hasQuery: false };
-        var paramPath = basePath;
-        for (var _i = 0, _a = viewParameterList.params.filter(function (c) { return !c.routeParameter.isQuery; }); _i < _a.length; _i++) {
-            var viewParam = _a[_i];
-            paramPath += viewParam.getParamString(state);
-        }
-        // trim trailing slashes
-        while (paramPath.endsWith("/")) {
-            paramPath = paramPath.substring(0, paramPath.length - 1);
-        }
-        return paramPath + viewParameterList.getQueryString();
-    };
-    return ViewParameterList;
-}());
-export { ViewParameterList };
+import { ViewParameter } from './ViewParameter';
+import { BreadCrumbSelectMode } from './IRouteParameter';
+import { BreadCrumbItem } from './BreadCrumbItem';
+import { Misc } from '@singularsystems/neo-core';
+import { NeoReactTypes } from '..';
+var ViewParameterList = /** @class */ (function () {
+    function ViewParameterList(routeParameterObject, view) {
+        this.view = view;
+        this.params = [];
+        this.suppressNavigation = false;
+        this.hasSuppressedNavigation = false;
+        if (routeParameterObject) {
+            for (var param in routeParameterObject) {
+                var viewParam = new ViewParameter(this, param, routeParameterObject[param]);
+                this[param] = viewParam;
+                this.params.push(viewParam);
+            }
+        }
+    }
+    ViewParameterList.prototype.getBreadCrumbList = function (upTo) {
+        var _a;
+        var basePath = Misc.Globals.appService.get(NeoReactTypes.Routing.NavigationHelper).getCurrentViewPath();
+        var breadCrumbs = [];
+        var state = { hasQuery: false };
+        var queryPath = this.getQueryString();
+        var paramPath = basePath;
+        var selectablePath = basePath;
+        for (var _i = 0, _b = this.params; _i < _b.length; _i++) {
+            var viewParam = _b[_i];
+            if (!viewParam.routeParameter.isQuery) {
+                if (!upTo) {
+                    for (var _c = 0, _d = viewParam.prefixes; _c < _d.length; _c++) {
+                        var prefix = _d[_c];
+                        var breadcrumbItem = new BreadCrumbItem(prefix.label);
+                        if (prefix.onClick) {
+                            breadcrumbItem.onClick = prefix.onClick;
+                        }
+                        else if (prefix.link) {
+                            breadcrumbItem.link = prefix.link;
+                        }
+                        else if (prefix.value) {
+                            breadcrumbItem.link = paramPath + "/" + prefix.value;
+                        }
+                        breadCrumbs.push(breadcrumbItem);
+                    }
+                }
+                paramPath += viewParam.getParamString(state);
+                if (((_a = viewParam.routeParameter.selection) !== null && _a !== void 0 ? _a : BreadCrumbSelectMode.Default) === BreadCrumbSelectMode.Default) {
+                    selectablePath = paramPath;
+                }
+                if (viewParam.description || (upTo && viewParam.latestValue !== null)) {
+                    breadCrumbs.push(new BreadCrumbItem(viewParam.description, (!upTo && viewParam.routeParameter.selection === BreadCrumbSelectMode.None) ? "" : (selectablePath + queryPath)));
+                }
+            }
+            if (upTo && upTo === viewParam) {
+                break;
+            }
+        }
+        return breadCrumbs;
+    };
+    ViewParameterList.prototype.getQueryString = function () {
+        var state = { hasQuery: false };
+        var queryPath = "";
+        for (var _i = 0, _a = this.params; _i < _a.length; _i++) {
+            var viewParam = _a[_i];
+            if (viewParam.routeParameter.isQuery) {
+                queryPath += viewParam.getParamString(state);
+            }
+        }
+        return queryPath;
+    };
+    ViewParameterList.prototype.setValues = function (values, force) {
+        var _a;
+        if (force === void 0) { force = false; }
+        this.suppressNavigation = true;
+        this.hasSuppressedNavigation = false;
+        for (var paramName in values) {
+            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]);
+        }
+    };
+    ViewParameterList.prototype.setUrl = function (viewParameter, replace) {
+        if (replace === void 0) { replace = false; }
+        if (this.suppressNavigation) {
+            this.hasSuppressedNavigation = true;
+        }
+        else {
+            var navigationHelper = Misc.Globals.appService.get(NeoReactTypes.Routing.NavigationHelper);
+            if (viewParameter) {
+                var allItems = this.getBreadCrumbList(viewParameter);
+                if (allItems.length > 0) {
+                    navigationHelper.navigateInternal(allItems[allItems.length - 1].link, replace);
+                    return;
+                }
+            }
+            navigationHelper.navigateInternal(navigationHelper.getCurrentViewPath(), replace);
+        }
+    };
+    /**
+     * Updates the parameter values from the values in the url. Returns true if any of the values have changed.
+     */
+    ViewParameterList.prototype.update = function (match) {
+        var hasChanged = false;
+        //Get url params
+        for (var param in match.params) {
+            var viewParam = this[param];
+            if (viewParam) {
+                var value = match.params[param];
+                if (value === undefined)
+                    value = null;
+                if (viewParam.update(value))
+                    hasChanged = true;
+            }
+        }
+        //Get query params
+        var queryParams = new URLSearchParams(location.search);
+        for (var _i = 0, _a = this.params; _i < _a.length; _i++) {
+            var viewParam = _a[_i];
+            if (viewParam.routeParameter.isQuery) {
+                if (viewParam.update(queryParams.get(viewParam.name)))
+                    hasChanged = true;
+            }
+        }
+        return hasChanged;
+    };
+    /**
+     * Gets a url for an object with view params specified.
+     * @param basePath Base path without parameters
+     * @param values Object of param names and values.
+     */
+    ViewParameterList.getPathForValues = function (basePath, params, values) {
+        // TODO: This needs a rework.
+        var viewParameterList = new ViewParameterList(params);
+        for (var name_1 in values) {
+            var viewParam = viewParameterList[name_1];
+            if (viewParam) {
+                var value = values[name_1];
+                if (value === undefined)
+                    value = null;
+                if (typeof value === "number") {
+                    value = value.toString();
+                }
+                viewParam.update(value);
+            }
+        }
+        var state = { hasQuery: false };
+        var paramPath = basePath;
+        for (var _i = 0, _a = viewParameterList.params.filter(function (c) { return !c.routeParameter.isQuery; }); _i < _a.length; _i++) {
+            var viewParam = _a[_i];
+            paramPath += viewParam.getParamString(state);
+        }
+        // trim trailing slashes
+        while (paramPath.endsWith("/")) {
+            paramPath = paramPath.substring(0, paramPath.length - 1);
+        }
+        return paramPath + viewParameterList.getQueryString();
+    };
+    return ViewParameterList;
+}());
+export { ViewParameterList };