-
Notifications
You must be signed in to change notification settings - Fork 0
/
bundle.js
488 lines (427 loc) · 13.5 KB
/
bundle.js
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
'use strict';
Object.defineProperty(exports, '__esModule', { value: true });
function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
var dush = _interopDefault(require('dush'));
var pathToRegexp = require('path-to-regexp');
var Component = _interopDefault(require('brindille-component'));
/**
* Will test if a path is matching a route path
* @param {String} path The path to test
* @param {RegExp} rule The regexp to test path against
*/
function matchRoute(path, rule) {
const matcher = pathToRegexp.match(rule);
return matcher(path)
}
/**
* Adds a slash at the beggining of a string if it does not exists yet
* @param {String} str the string to which we want to add a slash to in the beginning
*/
function safeAddTrailingSlash(str = '') {
if (typeof str !== 'string') {
throw new Error('str should be a string and is a ' + typeof str)
}
return '/' + str.replace(/^\//, '')
}
/**
* Get a route from a path for a given list or existing routes, returns first entry of routes if no match is found
* @param {String} path path to be tested against routes
* @param {Array} routes list of routes that path will be tested against
*/
function getRouteByPath(path, routes = [], baseUrl = '') {
if (baseUrl !== '') {
path = path.replace(baseUrl, '').replace(/\/\//g, '/');
}
path = safeAddTrailingSlash(path);
if (!Array.isArray(routes)) {
throw new Error('Routes param needs to be an array')
}
if (!routes.length) {
throw new Error('You need at lease one entry in routes param')
}
const route = routes.find(r => {
const match = matchRoute(path, r.path);
if (match) {
r.params = match.params;
return true
}
return false
});
if (route) {
return Object.assign({}, route)
}
return false
}
/**
* Get a route from a path for a given list or existing routes, returns first entry of routes if no match is found
* @param {String} path path to be tested against routes
* @param {Array} routes list of routes that path will be tested against
*/
function getRouteById(id, routes = []) {
if (!Array.isArray(routes)) {
throw new Error('Routes param needs to be an array')
}
if (!routes.length) {
throw new Error('You need at lease one entry in routes param')
}
const route = routes.find(r => {
return id === r.id
});
if (route) {
return Object.assign({}, route)
}
return false
}
/**
* Returns a properly structure route array given a list of route
* @param {Array.<String|Object>} routes
*/
function parseRoutes(routes) {
if (!Array.isArray(routes)) {
throw new Error('[Router] routes must be an array')
}
return routes.map(route => {
if (typeof route === 'string') {
return {
id: route,
path: safeAddTrailingSlash(route)
}
}
if (!route || !route.id) {
throw new Error(
'[Router] routes must either be a string or an object with an id'
)
}
return {
id: route.id,
path: safeAddTrailingSlash(route.path || route.id)
}
})
}
const isSpecialKeypressed = e =>
e.which > 1 || e.metaKey || e.ctrlKey || e.shiftKey || e.altKey;
const isIgnoredLink = el => el.hasAttribute('data-router-ignore');
const isDownloadLink = el =>
el.hasAttribute('download') || el.getAttribute('rel') === 'external';
const isBlank = el => el.target !== undefined && el.target === '_blank';
const isDifferentOrigin = (el, win = window) =>
el.protocol !== win.location.protocol || el.hostname !== win.location.hostname;
const isSameLocation = (el, win = window) =>
el.pathname === win.location.pathname && el.search === win.location.search;
const isMailto = el =>
el.href !== undefined && el.href.indexOf('mailto:') > -1;
const isLink = el => el && el.nodeName.toUpperCase() === 'A';
const getLink = el =>
isLink(el) ? el : el.parentNode ? getLink(el.parentNode) : null;
const getUrl = source =>
safeAddTrailingSlash(source.pathname + source.search + (source.hash || ''));
/**
* Check if a clicked link is eligible for routing. If it is it will return the link url. If it isn't it will return false
* @param {Event} e the click event we want to test
* @param {Window} win the window context to use for the test, you probably don't want to use this param
*/
function checkLink(e, win = window) {
// For each click we check if target is link
let el = getLink(e.target);
// If not link or special cases we ignore the link (self explanatory checks)
if (
!el ||
e.defaultPrevented ||
isSpecialKeypressed(e) ||
isDownloadLink(el) ||
isIgnoredLink(el) ||
isBlank(el) ||
isDifferentOrigin(el, win) ||
isMailto(el)
) {
return false
}
// At this point we override browser default behaviour for clicked link
e.preventDefault();
// We still do nothing if link location is same as current location
if (isSameLocation(el, win)) {
return false
}
// Return formatted path for clicked link (in the form of "/home")
return getUrl(el)
}
/**
*
* @param {BrindilleComponent} app An instance of the main brindille component your router will be applied to (usually the body / root component)
* @param {Object} options
* @param {String[]|Object[]} options.routes An array of routes (ex: ["home", "contacts"])
* @param {Function} options.getContent the function that gets your page content, must return a promise that resolves the content of the new page
* @param {Function} options.beforeCompile this function is executed on the dom of a new section before any component instanciation, advanced users only
* @param {Boolean} [options.verbose] If true will log a bunch of stuff for debugging purposes
* @param {Boolean} [options.notFoundHandler] A method that will be called if requested route does not exists
* @param {String} [options.baseUrl] Signals if root of the project is hosted in a subfolder, defaults to an empty string
* @param {String} [options.baseContent] a string that will be passed to your getContent method, can be useful for prepending a string to urls
*/
function createRouter(app, options = {}, win = window) {
if (!app || !app._componentInstances) {
throw new Error(
'First param of createRouter needs to be an instance of brindille component'
)
}
const view = app.findInstance('View');
if (!view) {
throw new Error('There is no View instance in your brindille App')
}
let isFirstRoute = true;
let isTransitionning = false;
const emitter = dush();
const baseUrl = options.baseUrl || '';
const baseContent = options.baseContent || '';
const getContent =
options.getContent || (({ route }) => Promise.resolve(route.id));
const beforeCompile = options.beforeCompile || (dom => Promise.resolve(dom));
const isVerbose = options.verbose && options.verbose === true;
const notFoundHandler =
options.notFoundHandler && typeof options.notFoundHandler === 'function'
? options.notFoundHandler
: false;
const routes = parseRoutes(
Array.isArray(options.routes) && options.routes.length
? options.routes
: ['home']
);
const defaultRoute = routes[0];
let currentRoute = null;
let previousRoute = null;
log('baseUrl = "' + baseUrl + '"');
log('baseContent = "' + baseContent + '"');
routes.forEach(route => {
log('registering route:', route.path);
});
function onClick(e) {
let link = checkLink(e, win);
if (link) {
goTo(link);
}
}
function log(...messages) {
if (isVerbose) {
console.log('[Router]', ...messages);
}
}
/**
* Launches the routing
*/
function start() {
log('start');
win.addEventListener('popstate', onStateUpdate);
win.addEventListener('click', onClick);
onStateUpdate();
}
/**
* Stops the routing
*/
function stop() {
log('stop');
win.removeEventListener('popstate', onStateUpdate);
win.removeEventListener('click', onClick);
}
/**
* Navigates to a given internal URL
* @param {String} url URL to navigate to
*/
function goTo(url) {
win.history.pushState(null, null, url);
onStateUpdate();
}
function goToId(id, params) {
let route = getRouteById(id, routes);
if (route) {
let path = route.path;
if (params) {
Object.keys(params).forEach(key => {
path = path.replace(':' + key, params[key]);
});
}
goTo(path);
}
}
/**
* Destroys the router and cancels any listeners still active
*/
function dispose() {
emitter.off('update');
stop();
}
function onStateUpdate() {
loadRoute(getUrl(win.location));
}
function loadRoute(path) {
let newRoute = getRouteByPath(path, routes, baseUrl);
if (!newRoute) {
if (notFoundHandler) {
return notFoundHandler(path)
} else {
newRoute = defaultRoute;
}
}
// When we start handling the route we tell the app we are busy
isTransitionning = true;
// Shift current and previous routes
previousRoute = currentRoute;
currentRoute = Object.assign({ isFirstRoute }, newRoute);
emitter.emit('start', currentRoute);
log(
'route:',
currentRoute.id,
(isFirstRoute ? '(first) ' : ' ') + JSON.stringify(currentRoute.params)
);
// If current route is first route, the dom is already present, we just need the view to launch transition in of current view
if (isFirstRoute) {
isFirstRoute = false;
view.showFirstPage().then(routeCompleted);
} else {
getContent({ route: currentRoute, base: baseContent, path })
.then(content => {
const p = view.showPage(content, beforeCompile);
emitter.emit('loaded', currentRoute);
return p
})
.then(routeCompleted);
}
}
function routeCompleted() {
isTransitionning = false;
emitter.emit('complete', currentRoute);
emitter.emit('update', currentRoute);
}
return {
start,
stop,
goTo,
goToId,
dispose,
get routes() {
return routes.slice(0)
},
get nbListeners() {
return emitter._allEvents.update ? emitter._allEvents.update.length : 0
},
get baseUrl() {
return baseUrl
},
get baseContent() {
return baseContent
},
get currentRoute() {
return Object.assign({}, currentRoute)
},
get previousRoute() {
return Object.assign({}, previousRoute)
},
get isTransitionning() {
return isTransitionning
},
on: (...opt) => emitter.on(...opt),
off: (...opt) => emitter.off(...opt)
}
}
/**
* Calls a function with callback param if it exists
* or calls callback directly if the function does not exists
*
* @param {Obkect} object context for method to call
* @param {String} methodName name of the method to call on object
* @param {Function} callback the function to be called at the end of method
*/
function safeCallbackedCall(object, methodName, callback) {
if (!callback || typeof callback !== 'function') {
throw new Error('The callback param should be a function')
}
if (
object &&
object[methodName] &&
typeof object[methodName] === 'function'
) {
object[methodName](callback);
} else {
callback();
}
}
class View extends Component {
constructor($el) {
super($el);
this.showPage = this.showPage.bind(this);
this.showFirstPage = this.showFirstPage.bind(this);
}
showFirstPage() {
return new Promise((resolve, reject) => {
this.currentPage = this._componentInstances[0];
safeCallbackedCall(this.currentPage, 'transitionIn', () => {
resolve(true);
});
})
}
showPage(content, beforeCompile) {
this.content = content;
return this.createSection(content, beforeCompile).then(page => {
this.currentPage = page;
return this.transitionOutAndAfterIn()
})
}
transitionOutAndAfterIn() {
return new Promise((resolve, reject) => {
const oldPage = this._componentInstances[
this._componentInstances.length - 1
];
safeCallbackedCall(oldPage, 'transitionOut', resolve);
}).then(() => {
return this.transitionIn()
})
}
transitionIn() {
return new Promise((resolve, reject) => {
this.disposeChildren();
this.addNewPage();
safeCallbackedCall(this.currentPage, 'transitionIn', resolve);
})
}
addNewPage() {
if (!this.currentPage.$el) {
this.$el.appendChild(this.currentPage);
} else {
this._componentInstances.push(this.currentPage);
this.$el.appendChild(this.currentPage.$el);
}
}
getCtor(componentName) {
if (typeof this.definitions === 'function') {
return this.definitions(componentName)
} else if (typeof this.definitions === 'object') {
return this.definitions[componentName]
}
return null
}
createSection(text, beforeCompile) {
const win = this.window || window;
let $node = win.document.createElement('div');
$node.innerHTML = text;
if ($node.firstChild.nodeType === 3) {
return Promise.resolve($node)
}
$node = $node.firstChild;
let componentName = $node.getAttribute('data-component');
let Ctor = this.getCtor(componentName);
$node.removeAttribute('data-component');
if (!beforeCompile || typeof beforeCompile !== 'function') {
beforeCompile = dom => Promise.resolve(dom);
}
return beforeCompile($node).then($node => {
let section = new Ctor($node);
section.init(this.definitions);
section.componentName = componentName;
section.parent = this;
return section
})
}
}
exports.View = View;
exports.createRouter = createRouter;
exports.getRouteById = getRouteById;
exports.getRouteByPath = getRouteByPath;
exports.matchRoute = matchRoute;