1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 | 1× 1× 24× 1× 36× 36× 36× 36× 36× 36× 36× 1× 10× 1× 1× 4× 4× 4× 4× 4× 4× 4× 4× 4× 4× 4× 4× 20× 20× 2× 2× 66× 4× 4× 6× 6× 6× 6× 4× 4× 4× 2× 2× 2× 2× 2× 12× 6× 2× 10× 12× 12× 12× 10× 28× 28× 28× 28× 28× 2× 2× 26× 26× 26× 26× 24× 24× 26× 14× 14× 14× 26× 26× 24× 24× 10× 10× 10× 6× 4× 2× 14× 10× 4× 2× 2× 26× 28× 26× 26× 26× 26× 26× 36× 24× 24× 22× 16× 6× 62× 18× 18× 18× 18× 6× 6× 368× 198× 6× 6× 12× 12× 12× 12× 4× 4× 64× 64× 26× 26× 8× 8× 8× 8× 6× 6× 6× 6× 6× 4× 66× 66× 66× 66× 66× 66× 22× 18× 22× 22× 44× 66× 66× 66× 66× 2× 2× 64× 64× 6× 6× 6× 6× 58× 58× 58× 2× 2× 2× 2× 56× 56× 18× 18× 38× 38× | import RouteNode from 'route-node'; import transition from './transition'; import constants from './constants'; const noop = () => {}; const ifNot = (condition, error) => { if (!condition) throw new Error(error); }; const makeState = (name, params, path, _meta) => { const state = {}; const setProp = (key, value) => Object.defineProperty(state, key, { value, enumerable: true }); setProp('name', name); setProp('params', params); setProp('path', path); if (_meta) setProp('_meta', _meta); return state; }; const addCanActivate = router => route => { if (route.canActivate) router.canActivate(route.name, route.canActivate); }; const toFunction = val => typeof val === 'function' ? val : () => val; /** * Create a new Router5 instance * @class * @param {RouteNode[]|Object[]|RouteNode|Object} routes The router routes * @param {Object} [opts={}] The router options: useHash, defaultRoute and defaultParams can be specified. * @return {Router5} The router instance */ class Router5 { constructor(routes, opts = {}) { this.started = false; this.mware = null; this._cbs = {}; this._canAct = {}; this._canDeact = {}; this.lastStateAttempt = null; this.lastKnownState = null; this.rootNode = routes instanceof RouteNode ? routes : new RouteNode('', '', routes, addCanActivate(this)); this.options = { useHash: false, hashPrefix: '', base: false, trailingSlash: 0, autoCleanUp: true, strictQueryParams: true }; Object.keys(opts).forEach(opt => this.options[opt] = opts[opt]); this.registeredPlugins = {}; this._extraArgs = []; } /** * Set an option value * @param {String} opt The option to set * @param {*} val The option value * @return {Router5} The Router5 instance */ setOption(opt, val) { this.options[opt] = val; return this; } /** * Set additional arguments used in lifecycle functions. * Additional arguments are used in canActivate, canDeactivate and middleware functions in first positions (before `toState`). * @param {Array} args The additional arguments */ setAdditionalArgs(args) { this._extraArgs = Array.isArray(args) ? args : [args]; return this; } /** * Return additional arguments used in lifecycle functions */ getAdditionalArgs() { return this._extraArgs; } /** * Add route(s) * @param {RouteNode[]|Object[]|RouteNode|Object} routes Route(s) to add * @return {Router5} The Router5 instance */ add(routes) { this.rootNode.add(routes, addCanActivate(this)); return this; } /** * Add a route to the router. * @param {String} name The route name * @param {String} path The route path * @param {Function} [canActivate] A function to determine if the route can be activated. * It will be invoked during a transition with `toState` * and `fromState` parameters. * @return {Router5} The Router5 instance */ addNode(name, path, canActivate) { this.rootNode.addNode(name, path); if (canActivate) this._canAct[name] = canActivate; return this; } usePlugin(pluginFactory) { ifNot(typeof pluginFactory === 'function', '[router5.usePlugin] Plugins are now functions, see http://router5.github.io/docs/plugins.html.'); const plugin = pluginFactory(this); const name = plugin.name || pluginFactory.name; ifNot(name, '[router5.usePlugin] Tried to register an unamed plugin.'); const pluginMethods = ['onStart', 'onStop', 'onTransitionSuccess', 'onTransitionStart', 'onTransitionError', 'onTransitionCancel']; const defined = pluginMethods.some(method => plugin[method] !== undefined); ifNot(defined, `[router5.usePlugin] plugin ${plugin.name} has none of the expected methods implemented`); this.registeredPlugins[name] = plugin; pluginMethods.forEach(method => { if (plugin[method]) { this._addListener(method.toLowerCase().replace(/^on/, '$$').replace(/transition/, '$$'), plugin[method]); } }); return this; } /** * Set a transition middleware function `.useMiddleware(fn1, fn2, fn3, ...)` * @param {Function} fn The middleware function */ useMiddleware() { this.mware = Array.prototype.slice.call(arguments).map(m => { const middlewareFn = m(this); ifNot(typeof middlewareFn === 'function', '[router5.usePlugin] Middleware have changed, see http://router5.github.io/docs/middleware.html.'); return middlewareFn; }); return this; } /** * Start the router * @param {String|Object} [startPathOrState] An optional start path or state * (use it for universal applications) * @param {Function} [done] An optional callback which will be called * when starting is done * @return {Router5} The router instance */ start() { const args = Array.prototype.slice.call(arguments); const lastArg = args.slice(-1)[0]; const done = (lastArg instanceof Function) ? lastArg : noop; let startPath, startState; if (this.started) { done({ code: constants.ROUTER_ALREADY_STARTED }); return this; } this.started = true; this._invokeListeners('$start'); const opts = this.options; if (args.length > 0) { if (typeof args[0] === 'string') startPath = args[0]; if (typeof args[0] === 'object') startState = args[0]; } // callback const cb = (err, state, invokeErrCb = true) => { done(err, state); if (!err) this._invokeListeners('$$success', state, null, {replace: true}); if (err && invokeErrCb) this._invokeListeners('$$error', state, null, err); };I // Get start path if (startPath === undefined && startState === undefined && this.getLocation) { startPath = this.getLocation(); } if (!startState) { // If no supplied start state, get start state startState = startPath === undefined ? null : this.matchPath(startPath); // Navigate to default function const navigateToDefault = () => this.navigate(opts.defaultRoute, opts.defaultParams, {replace: true}, (err, state) => done(err, state)); // If matched start path if (startState) { this.lastStateAttempt = startState; this._transition(this.lastStateAttempt, this.lastKnownState, (err, state) => { if (!err) { cb(null, state); } else if (opts.defaultRoute) navigateToDefault(); else cb(err, null, false); }); } else if (opts.defaultRoute) { // If default, navigate to default navigateToDefault(); } else { // No start match, no default => do nothing cb({ code: constants.ROUTE_NOT_FOUND, path: startPath }, null); } } else { // Initialise router with provided start state this.lastKnownState = startState; cb(null, startState); } return this; } /** * Stop the router * @return {Router5} The router instance */ stop() { if (!this.started) return this; this.lastKnownState = null; this.lastStateAttempt = null; this.started = false; this._invokeListeners('$stop'); return this; } /** * Return the current state object * @return {Object} The current state */ getState() { return this.lastKnownState; } /** * Whether or not the given route name with specified params is active. * @param {String} name The route name * @param {Object} [params={}] The route parameters * @param {Boolean} [strictEquality=false] If set to false (default), isActive will return true * if the provided route name and params are descendants * of the active state. * @param {Boolean} [ignoreQueryParams=true] Whether or not to ignore URL query parameters when * comparing the two states together. * query parameters when comparing two states together. * @return {Boolean} Whether nor not the route is active */ isActive(name, params = {}, strictEquality = false, ignoreQueryParams = true) { const activeState = this.getState(); if (!activeState) return false; if (strictEquality || activeState.name === name) { return this.areStatesEqual(makeState(name, params), activeState, ignoreQueryParams); } return this.areStatesDescendants(makeState(name, params), activeState); } /** * @private */ areStatesEqual(state1, state2, ignoreQueryParams = true) { if (state1.name !== state2.name) return false; const getUrlParams = name => this.rootNode .getSegmentsByName(name) .map(segment => segment.parser[ignoreQueryParams ? 'urlParams' : 'params']) .reduce((params, p) => params.concat(p), []); const state1Params = getUrlParams(state1.name); const state2Params = getUrlParams(state2.name); return state1Params.length === state2Params.length && state1Params.every(p => state1.params[p] === state2.params[p]); } /** * Whether two states are descendants * @param {Object} parentState The parent state * @param {Object} childState The child state * @return {Boolean} Whether the two provided states are related */ areStatesDescendants(parentState, childState) { const regex = new RegExp('^' + parentState.name + '\\.(.*)$'); if (!regex.test(childState.name)) return false; // If child state name extends parent state name, and all parent state params // are in child state params. return Object.keys(parentState.params).every(p => parentState.params[p] === childState.params[p]); } /** * @private */ _invokeListeners(name, ...args) { (this._cbs[name] || []).forEach(cb => cb(...args)); } /** * @private */ _addListener(name, cb) { this._cbs[name] = (this._cbs[name] || []).concat(cb); return this; } /** * A function to determine whether or not a segment can be deactivated. * @param {String} name The route segment full name * @param {Boolean} canDeactivate Whether the segment can be deactivated or not * @return {[type]} */ canDeactivate(name, canDeactivate) { this._canDeact[name] = toFunction(canDeactivate); return this; } /** * A function to determine whether or not a segment can be activated. * @param {String} name The route name to register the canActivate method for * @param {Function} canActivate The canActivate function. It should return `true`, `false` * or a promise * @return {Router5} The router instance */ canActivate(name, canActivate) { this._canAct[name] = toFunction(canActivate); return this; } /** * Generates an URL from a route name and route params. * The generated URL will be prefixed by hash if useHash is set to true * @param {String} route The route name * @param {Object} params The route params (key-value pairs) * @return {String} The built URL */ buildUrl(route, params) { return this._buildUrl(this.buildPath(route, params)); } /** * @private */ _buildUrl(path) { return (this.options.base || '') + (this.options.useHash ? '#' + this.options.hashPrefix : '') + path; } /** * Build a path from a route name and route params * The generated URL will be prefixed by hash if useHash is set to true * @param {String} route The route name * @param {Object} params The route params (key-value pairs) * @return {String} The built Path */ buildPath(route, params) { return this.rootNode.buildPath(route, params); } /** * Build a state object from a route name and route params * @param {String} route The route name * @param {Object} params The route params (key-value pairs) * @return {String} The built Path */ buildState(route, params) { return this.rootNode.buildState(route, params); } /** * Match a path against the route tree. * @param {String} path The path to match * @return {Object} The matched state object (null if no match) */ matchPath(path) { const { trailingSlash, strictQueryParams } = this.options; const match = this.rootNode.matchPath(path, { trailingSlash, strictQueryParams }); return match ? makeState(match.name, match.params, path, match._meta) : null; } /** * Parse / extract a path from an url * @param {String} url The URL * @return {String} The extracted path */ urlToPath(url) { const match = url.match(/^(?:http|https)\:\/\/(?:[0-9a-z_\-\.\:]+?)(?=\/)(.*)$/); const path = match ? match[1] : url; const pathParts = path.match(/^(.+?)(#.+?)?(\?.+)?$/); if (!pathParts) throw new Error(`[router5] Could not parse url ${url}`); const pathname = pathParts[1]; const hash = pathParts[2] || ''; const search = pathParts[3] || ''; const opts = this.options; return ( opts.useHash ? hash.replace(new RegExp('^#' + opts.hashPrefix), '') : (opts.base ? pathname.replace(new RegExp('^' + opts.base), '') : pathname) ) + search; } /** * Parse path from an url and match it against the route tree. * @param {String} url The URL to match * @return {Object} The matched state object (null if no match) */ matchUrl(url) { return this.matchPath(this.urlToPath(url)); } /** * @private */ _transition(toState, fromState, done = noop) { // Cancel current transition this.cancel(); this._invokeListeners('$$start', toState, fromState); const tr = transition(this, toState, fromState, (err, state) => { state = state || toState; this._tr = null; if (err) { if (err.code === constants.TRANSITION_CANCELLED) this._invokeListeners('$$cancel', toState, fromState); else this._invokeListeners('$$error', toState, fromState, err); done(err); return; } this.lastKnownState = state; // toState or modified state? done(null, state); }); this._tr = tr; return () => !tr || tr(); } /** * Undocumented for now * @private */ cancel() { if (this._tr) this._tr(); } /** * Navigate to a specific route * @param {String} name The route name * @param {Object} [params={}] The route params * @param {Object} [opts={}] The route options (replace, reload) * @param {Function} done A optional callback(err) to call when transition has been performed * either successfully or unsuccessfully. * @return {Function} A cancellation function */ navigate(name, params = {}, opts = {}, done = noop) { if (!this.started) { done({ code: constants.ROUTER_NOT_STARTED }); return; } const toState = this.buildState(name, params); if (!toState) { const err = { code: constants.ROUTE_NOT_FOUND }; done(err); this._invokeListeners('$$error', null, this.lastKnownState, err); return; } toState.path = this.buildPath(name, params); this.lastStateAttempt = toState; const sameStates = this.lastKnownState ? this.areStatesEqual(this.lastKnownState, this.lastStateAttempt, false) : false; // Do not proceed further if states are the same and no reload // (no desactivation and no callbacks) if (sameStates && !opts.reload) { const err = { code: constants.SAME_STATES }; done(err); this._invokeListeners('$$error', toState, this.lastKnownState, err); return; } const fromState = sameStates ? null : this.lastKnownState; // Transition and amend history return this._transition(toState, sameStates ? null : this.lastKnownState, (err, state) => { if (err) { done(err); return; } this._invokeListeners('$$success', toState, fromState, opts); done(null, state); }); } } export default Router5; |