@trullock/page-manager 1.2.1 → 1.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trullock/page-manager",
-  "version": "1.2.1",
+  "version": "1.3.1",
   "description": "Single page app manager",
   "exports": {
     ".": "./src/index.js"
@@ -11,7 +11,7 @@
     "build": "webpack --mode=development",
     "tests": "node ./tests/tests.js"
   },
-  "author": "",
+  "author": "Trullock",
   "license": "ISC",
   "publishConfig": {
     "access": "public"

package/src/index.js

@@ -7,7 +7,7 @@ var pageCache = {},
 
 var manuallyAdjustingHistory = false;
 var handlingBeforeHide = false;
-var lastNavigationDirection = null;
+var beforeHideNavDirection = null;
 
 var goal = null;
 var backData = {};
@@ -25,14 +25,12 @@ export function registerPage(opts) {
 
 	let loadPageClass = opts.pageClass ? (() => opts.pageClass) : opts.loadPageClass;
 	let namedRoutes = opts.namedRoutes || { [opts.name]: opts.route };
-	let auth = opts.auth || null;
 	let cacheMarkupBy = opts.cacheMarkupBy || 'path'
 	let extra = opts.extra || {}
 
 	for (const [name, route] of Object.entries(namedRoutes)) {
 		router.addRoute(name, route, {
 			route,
-			auth,
 			loadPageClass,
 			loadMarkup: opts.loadMarkup,
 			cacheMarkupBy,
@@ -67,8 +65,8 @@ function emitUrlChanged(url)
 function initLoading()
 {
 	var url = router.interpolate(options.loadingPageName, {});
-	var route = router.parse(url);
-	return loadPage(route, {});
+	var routeResult = router.parse(url);
+	return loadPage(routeResult, {});
 }
 
 function showLoading() {
@@ -222,9 +220,19 @@ async function doUpdate(page, data) {
 	document.title = page.title
 }
 
-function handleHistoryAction(event, url, data, page) {
+function getNewUid()
+{
+	let uid = -1;
+
+	for(let i = 0; i < stack.length; i++)
+		uid = Math.max(uid, stack[i].uid)
+
+	return uid + 1;
+}
+
+async function handleHistoryAction(event, url, data, page) {
 	if (event.action == 'push') {
-		let newUid = stack[stackPointer].uid + 1;
+		let newUid = getNewUid()
 
 		window.history.pushState({ uid: newUid }, null, url);
 		emitUrlChanged(url);
@@ -235,19 +243,24 @@ function handleHistoryAction(event, url, data, page) {
 		stack.push({ uid: newUid, data, page });
 		stackPointer++;
 	}
-	else if (event.action == 'replace') {
-		// TODO: this case may be buggy
-
-		// BUG: you can replace the current state with the same url as the previous state, which shouldnt be allowed, 
-		// you cant have the same url in the history twice (next to each other).
-		// Update this to check for such a case and handle it
-
-		let currentUid = stack[stackPointer].uid;
-		window.history.replaceState({ uid: currentUid }, null, url);
-		emitUrlChanged(url);
+	else if (event.action == 'replace') 
+	{
+		if(data.route.url == stack[stackPointer - 1]?.data?.route?.url)
+		{
+			let statesToKeep = [];
+			for (var i = 0; i < stackPointer - 1; i++)
+				statesToKeep.push(stack[i]);
+			statesToKeep.push({ uid: stack[stackPointer - 1].uid, data, page });
 
-		stack.pop();
-		stack.push({ uid: currentUid, data, page });
+			await modifyHistory(statesToKeep);
+		}
+		else
+		{
+			let newId = getNewUid();
+			window.history.replaceState({ uid: newId }, null, url);
+			stack[stackPointer] = { uid: newId, data, page };
+			emitUrlChanged(url);
+		}
 	}
 	else if(event.action == 'back')
 	{
@@ -299,7 +312,6 @@ export async function init(opts) {
 	}
 
 	await initLoading();
-	
 	await showLoading();
 }
 
@@ -312,18 +324,18 @@ export async function ready()
 		
 		if (e instanceof PageShowError)
 		{
-			return showPage(e.url, e.data, { action: 'load', distance: 0 }).then(page => {
+			return showPage(e.url, e.data, { action: 'load', distance: 0 }).then(async page => {
 				if(e.action == 'replace')
-					handleHistoryAction({ action: e.action }, e.url, e.data, page);
+					await handleHistoryAction({ action: e.action }, e.url, e.data, page);
 				return page;
 			});
 		}
 	});
 
-	function handlePopstate(context, direction, distance) {
+	async function handlePopstate(context, direction, distance) {
 
 		if (manuallyAdjustingHistory) {
-			manuallyAdjustingHistory(context, { action: direction, distance });
+			await manuallyAdjustingHistory(context, { action: direction, distance });
 			return;
 		}
 
@@ -343,7 +355,7 @@ export async function ready()
 		})
 	}
 
-	function handleBeforeHidePart1() {
+	function handleBeforeHidePart1(lastNavDirection) {
 		// if we're ignoring beforeHide this navigation
 		if (handlingBeforeHide === 'ignore') {
 			handlingBeforeHide = false;
@@ -352,6 +364,8 @@ export async function ready()
 
 		// if we have a before-unload confirm to show
 		if (stack[stackPointer].page.beforeHide && options.beforeHide && handlingBeforeHide === false) {
+			beforeHideNavDirection = lastNavDirection;
+
 			var interrupt = stack[stackPointer].page.beforeHide();
 			if (interrupt) {
 				handlingBeforeHide = 'step1';
@@ -359,9 +373,9 @@ export async function ready()
 				// do this in a new thread, you cant call history actions from inside a history-aciton-handler
 				window.setTimeout(() => {
 					// undo the navigation so the URL remains correct whilst we show the confirm dialog
-					if (lastNavigationDirection == 'fwd')
+					if (beforeHideNavDirection == 'fwd')
 						history.back();
-					else if (lastNavigationDirection == 'back')
+					else if (beforeHideNavDirection == 'back')
 						history.forward();
 				}, 1);
 
@@ -371,7 +385,10 @@ export async function ready()
 
 		// we've finished beforeHiding
 		if (handlingBeforeHide === 'step2')
+		{
 			handlingBeforeHide = false;
+			beforeHideNavDirection = null;
+		}
 
 		return false;
 	}
@@ -380,20 +397,26 @@ export async function ready()
 		if (handlingBeforeHide !== 'step1')
 			return false;
 
+		if(manuallyAdjustingHistory)
+			return false;
+
 		// do the beforeHide action, then...
 		options.beforeHide(stack[stackPointer].page.beforeHide()).then(result => {
 
 			// if the user confirmed, redo the original action
-			if (result) {
-
+			if (result)
+			{
 				handlingBeforeHide = 'step2';
 
-				if (lastNavigationDirection == 'fwd')
+				if (beforeHideNavDirection == 'fwd')
 					history.forward();
-				else if (lastNavigationDirection == 'back')
+				else if (beforeHideNavDirection == 'back')
 					history.back();
-			} else {
+			}
+			else
+			{
 				handlingBeforeHide = false;
+				beforeHideNavDirection = null;
 			}
 		});
 
@@ -401,23 +424,23 @@ export async function ready()
 	}
 
 	// listen for browser navigations
-	window.addEventListener("popstate", e => {
-		var interrupted = handleBeforeHidePart2();
-		if (interrupted)
-			return;
-
+	window.addEventListener("popstate", async e => {
+		// TODO: is 0 sensible here, or should we call getNewId()?
 		let newUid = e.state?.uid || 0;
 		let previousUid = stack[stackPointer].uid;
-
-		lastNavigationDirection = newUid > previousUid ? 'fwd' : 'back';
+		let lastNavigationDirection = newUid > previousUid ? 'fwd' : 'back';
 		let distance = Math.abs(newUid - previousUid);
 
-		var interrupted = handleBeforeHidePart1();
+		var interrupted = handleBeforeHidePart2();
+		if (interrupted)
+			return;
+
+		var interrupted = handleBeforeHidePart1(lastNavigationDirection);
 		if (interrupted)
 			return;
 
 		var context = findContext(newUid);
-		handlePopstate(context, lastNavigationDirection, distance);
+		await handlePopstate(context, lastNavigationDirection, distance);
 	});
 
 	if(storageAvailable())
@@ -505,30 +528,37 @@ export function printStack() {
 		console.log(stack[i]);
 }
 
-export function removeHistory(predicate)
+function modifyHistory(statesToKeep)
 {
-	let statesToKeep = [];
-	for (var i = 0; i < stack.length; i++)
-	{
-		if (!predicate(stack[i], i))
-			statesToKeep.push(stack[i]);
-	}
-
-	// TODO: ensure we always have at least 1 state to keep - must/can this always be the current page?
+	// BUG: You can't remove the 2nd stack frame. This is because you'd have to go back to -1, to then go forward to 0 (removing frame 1)
+	// For clarity, you can remove (replace) frame 0 (1st), and frame 2+ (3rd+)
+	// As a workaround, we replace the 2nd stack frame, if it is the tail, with the root "/". 
+	// This at least hopefully removes any meaning from it, simply taking you "home" rather than to wherever you were likely trying to remove.
 
 	if (statesToKeep.length == stack.length)
 		return Promise.resolve();
 
+	return new Promise(async (resolve, reject) => {
 
-	return new Promise((resolve, reject) => {
-
-
-		let backsToDo = stackPointer - 1;
-		let currentUid = -1;
+		let backsToDo = stackPointer;
 
 		//  TODO: handle stack pointer not being at the tail when this process starts
+		
+		// see BUG comments at the top of this method
+		let apply2ndFrameHack = statesToKeep.length == 1 && stack.length > 1
+		let secondFrameHackUid = -1
+		let defaultPageRouteResult = null;
+		let defaultPage = null;
+		if(apply2ndFrameHack)
+		{
+			let url = getPath(options.defaultPageName);
+			defaultPageRouteResult = router.parse(url);
+			defaultPage = await loadPage(defaultPageRouteResult, {});
+
+			secondFrameHackUid = getNewUid();
+		}
 
-		manuallyAdjustingHistory = _ => {
+		manuallyAdjustingHistory = async _ => {
 			// rewind to the first history position
 			if(backsToDo > 0)
 			{
@@ -540,36 +570,78 @@ export function removeHistory(predicate)
 			}
 
 			// reset the stack
+			
 			stack = [];
 
 			for (var k = 0; k < statesToKeep.length; k++) {
 				let currentState = statesToKeep[k];
-				currentState.uid = ++currentUid;
 
 				if (k == 0)
-					window.history.replaceState({ uid: currentState.uid }, null, currentState.data.route.url);
+					window.history.replaceState({ uid: currentState.uid }, currentState.page.title, currentState.data.route.url);
 				else
-					window.history.pushState({ uid: currentState.uid }, null, currentState.data.route.url);
+					window.history.pushState({ uid: currentState.uid }, currentState.page.title, currentState.data.route.url);
 				
-				window.dispatchEvent(new CustomEvent('page-manager.url-changed', { 
-					url: currentState.data.route.url
-				}))
-
-					// TODO: this doesnt seem to work when k=0
+				// TODO: this doesnt seem to work when k=0
 				document.title = currentState.page.title;
 
 				stack.push(currentState);
-			}
 
-			stackPointer = stack.length - 1;
+				emitUrlChanged(currentState.data.route.url)
+			}
 
+			// see BUG comments at the top of this method
+			if(apply2ndFrameHack)
+			{
+				stack.push({
+					uid: secondFrameHackUid,
+					data: {
+						route: {
+							url: defaultPageRouteResult.path,
+							path: defaultPageRouteResult.path,
+							name: defaultPageRouteResult.name,
+							params: defaultPageRouteResult.params
+						}
+					},
+					page: defaultPage
+				})
+
+				stackPointer = 0;
+			}
+			else
+			{
+				stackPointer = stack.length - 1;
+			}
+			
 			manuallyAdjustingHistory = false;
+
+			resolve();
 		};
 
+		// see BUG comments at the top of this method
+		if(apply2ndFrameHack && backsToDo == 1)
+		{
+			window.history.replaceState({ uid: secondFrameHackUid }, defaultPage.title, defaultPageRouteResult.path);
+			document.title = defaultPage.title;
+		}
+
+		backsToDo--;
 		history.back();
 	});
 }
 
+
+export function removeHistory(predicate)
+{
+	let statesToKeep = [];
+	for (var i = 0; i < stack.length; i++)
+	{
+		if (!predicate(stack[i], i))
+			statesToKeep.push(stack[i]);
+	}
+
+	return modifyHistory(statesToKeep);
+}
+
 export function purgeCache() {
 	for (const key in pageCache)
 	{

package/tests/dist/index.html

@@ -0,0 +1,20 @@
+<html>
+	<head>
+	<script defer src="/main.js"></script></head>
+	<body style="height: 100%;">
+		<div style="position: fixed; top: 0; background-color: white;">
+			<a href="/page1">Page 1</a>
+			<a href="/page2">Page 2</a>
+			<a href="/page3">Page 3</a>
+			<a href="/page4">Page 4</a>
+			<a href="/page/A">Page A</a>
+			<a href="/page/B">Page B</a>
+			<a href="/404">404</a>
+			<a href="/dont-exist">I dont exist</a>
+			<a href="/show-fail">I fail to show</a>
+		</div>
+		<div>
+			<button class="btnStack">Print stack</button>
+		</div>
+	</body>
+</html>

package/tests/dist/loading.htm

@@ -0,0 +1,3 @@
+<div>
+	Loading
+</div>