blob: 7ed02d075facb0a6314c398f5a34db7a19d7847a [file] [log] [blame]
Matteo Scandolofb46ae62017-08-08 09:10:50 -07001
2/*
3 * Copyright 2017-present Open Networking Foundation
4
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8
9 * http://www.apache.org/licenses/LICENSE-2.0
10
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18
Matteo Scandoloe0d71ea2016-12-19 11:56:12 -080019/// <reference path="../../../../typings/index.d.ts" />
20
21import * as _ from 'lodash';
Matteo Scandolo828d1e82017-01-17 14:49:38 -080022import {IXosStyleConfig} from '../../../index';
Matteo Scandoloe0d71ea2016-12-19 11:56:12 -080023
Matteo Scandolof2c3ed62016-12-15 14:32:50 -080024export interface IXosNavigationRoute {
25 label: string;
26 state?: string;
27 url?: string;
Matteo Scandoloe0d71ea2016-12-19 11:56:12 -080028 parent?: string;
29 children?: [IXosNavigationRoute];
30 opened?: boolean;
Matteo Scandolof2c3ed62016-12-15 14:32:50 -080031}
32
33export interface IXosNavigationService {
34 query(): IXosNavigationRoute[];
35 add(route: IXosNavigationRoute): void;
36}
37
Matteo Scandolo1aee1982017-02-17 08:33:23 -080038export class IXosNavigationService {
Matteo Scandoloa6487ce2017-02-06 16:42:21 -080039 static $inject = ['$log', 'StyleConfig'];
Matteo Scandolof2c3ed62016-12-15 14:32:50 -080040 private routes: IXosNavigationRoute[];
41
Matteo Scandolo828d1e82017-01-17 14:49:38 -080042 constructor(
Matteo Scandoloa6487ce2017-02-06 16:42:21 -080043 private $log: ng.ILogService,
Matteo Scandolo828d1e82017-01-17 14:49:38 -080044 private StyleConfig: IXosStyleConfig
45 ) {
Matteo Scandoloe0d71ea2016-12-19 11:56:12 -080046 const defaultRoutes = [
47 {
Matteo Scandoloa8a6fbb2016-12-21 16:59:08 -080048 label: 'Home',
49 state: 'xos.dashboard'
50 },
51 {
Matteo Scandoloe0d71ea2016-12-19 11:56:12 -080052 label: 'Core',
53 state: 'xos.core'
Matteo Scandolo16cec702017-11-30 10:11:10 -080054 }
Matteo Scandolof2c3ed62016-12-15 14:32:50 -080055 ];
Matteo Scandoloe0d71ea2016-12-19 11:56:12 -080056 // adding configuration defined routes
Matteo Scandoloa8a6fbb2016-12-21 16:59:08 -080057 // this.routes = StyleConfig.routes.concat(defaultRoutes).reverse();
58 this.routes = defaultRoutes;
Matteo Scandolo828d1e82017-01-17 14:49:38 -080059 this.StyleConfig.routes.forEach(r => {
Matteo Scandoloa8a6fbb2016-12-21 16:59:08 -080060 this.add(r);
61 });
Matteo Scandolof2c3ed62016-12-15 14:32:50 -080062 }
63
64 query() {
65 return this.routes;
66 }
67
Max Chu71b185a2017-09-07 17:50:58 -070068 add(route: IXosNavigationRoute, override: boolean = false) {
Matteo Scandoloa4a47112016-12-16 10:06:13 -080069 if (angular.isDefined(route.state) && angular.isDefined(route.url)) {
70 throw new Error('[XosNavigation] You can\'t provide both state and url');
71 }
Matteo Scandoloe0d71ea2016-12-19 11:56:12 -080072
Matteo Scandolo265c2042017-03-20 10:15:40 -070073 // NOTE factor this out in a separate method an eventually use recursion since we can nest more routes
Max Chu71b185a2017-09-07 17:50:58 -070074 let preExisting = null;
Matteo Scandoloa6487ce2017-02-06 16:42:21 -080075 const routeExist = _.findIndex(this.routes, (r: IXosNavigationRoute) => {
Max Chu71b185a2017-09-07 17:50:58 -070076 if (r.label === route.label && (r.state === route.state || override) && r.parent === route.parent) {
77 preExisting = r;
Matteo Scandoloa6487ce2017-02-06 16:42:21 -080078 return true;
79 }
Matteo Scandolo265c2042017-03-20 10:15:40 -070080 else if (_.findIndex(r.children, route) > -1) {
Max Chu71b185a2017-09-07 17:50:58 -070081 preExisting = r;
Matteo Scandolo265c2042017-03-20 10:15:40 -070082 return true;
83 }
Matteo Scandoloa6487ce2017-02-06 16:42:21 -080084 return false;
85 }) > -1;
86
Max Chu71b185a2017-09-07 17:50:58 -070087 if (routeExist && !override) {
88 this.$log.warn(`[XosNavigation] Route with label: ${route.label}, state: ${route.state} and parent: ${route.parent} already exists`);
Matteo Scandoloa6487ce2017-02-06 16:42:21 -080089 return;
90 }
91
Matteo Scandoloe0d71ea2016-12-19 11:56:12 -080092 if (angular.isDefined(route.parent)) {
93 // route parent should be a state for now
94 const parentRoute = _.find(this.routes, {state: route.parent});
Matteo Scandolo1aee1982017-02-17 08:33:23 -080095 if (angular.isDefined(parentRoute)) {
96 if (angular.isArray(parentRoute.children)) {
Max Chu71b185a2017-09-07 17:50:58 -070097 if (override) {
98 _.remove(parentRoute.children, r => r === preExisting);
99 }
Matteo Scandolo1aee1982017-02-17 08:33:23 -0800100 parentRoute.children.push(route);
101 }
102 else {
103 parentRoute.children = [route];
104 }
Matteo Scandoloe0d71ea2016-12-19 11:56:12 -0800105 }
106 else {
Max Chu71b185a2017-09-07 17:50:58 -0700107 this.$log.warn(`[XosNavigation] Parent State (${route.parent}) for state: ${route.state} does not exist`);
Matteo Scandolo1aee1982017-02-17 08:33:23 -0800108 return;
Matteo Scandoloe0d71ea2016-12-19 11:56:12 -0800109 }
110 }
111 else {
Max Chu71b185a2017-09-07 17:50:58 -0700112 if (override) {
113 _.remove(this.routes, r => r === preExisting);
114 }
Matteo Scandoloe0d71ea2016-12-19 11:56:12 -0800115 this.routes.push(route);
116 }
Matteo Scandolof2c3ed62016-12-15 14:32:50 -0800117 }
118}