swup 4.2.0 → 4.3.0

package/src/modules/plugins.ts

@@ -21,8 +21,8 @@ export type Plugin = {
 };
 
 const isSwupPlugin = (maybeInvalidPlugin: unknown): maybeInvalidPlugin is Plugin => {
-	// @ts-ignore
-	return maybeInvalidPlugin?.isSwupPlugin;
+	// @ts-ignore: this might be anything, object or no
+	return Boolean(maybeInvalidPlugin?.isSwupPlugin);
 };
 
 /** Install a plugin. */
@@ -72,6 +72,6 @@ export function findPlugin(this: Swup, pluginOrName: Plugin | string) {
 		(plugin) =>
 			plugin === pluginOrName ||
 			plugin.name === pluginOrName ||
-			plugin.name === `Swup${pluginOrName}`
+			plugin.name === `Swup${String(pluginOrName)}`
 	);
 }

package/src/modules/renderPage.ts

@@ -47,14 +47,10 @@ export const renderPage = async function (this: Swup, requestedUrl: string, page
 	});
 
 	// scroll into view: either anchor or top of page
+	// @ts-ignore: not returning a promise is intentional to allow users to pause in handler
 	await this.hooks.call('content:scroll', undefined, () => {
 		return this.scrollToContent();
 	});
 
 	await this.hooks.call('page:view', { url: this.currentPageUrl, title: document.title });
-
-	// empty cache if it's disabled (in case preload plugin filled it)
-	if (!this.options.cache) {
-		this.cache.clear();
-	}
 };

package/src/modules/replaceContent.ts

@@ -1,4 +1,5 @@
 import Swup, { Options } from '../Swup.js';
+import { query, queryAll } from '../utils.js';
 import { PageData } from './fetchPage.js';
 
 /**
@@ -20,6 +21,9 @@ export const replaceContent = function (
 	const title = incomingDocument.querySelector('title')?.innerText || '';
 	document.title = title;
 
+	// Save persisted elements
+	const persistedElements = queryAll('[data-swup-persist]:not([data-swup-persist=""])');
+
 	// Update content containers
 	const replaced = containers
 		.map((selector) => {
@@ -39,5 +43,14 @@ export const replaceContent = function (
 		})
 		.filter(Boolean);
 
+	// Restore persisted elements
+	persistedElements.forEach((existing) => {
+		const key = existing.getAttribute('data-swup-persist');
+		const replacement = query(`[data-swup-persist="${key}"]`);
+		if (replacement && replacement !== existing) {
+			replacement.replaceWith(existing);
+		}
+	});
+
 	return replaced.length === containers.length;
 };

package/src/utils/index.ts

@@ -23,18 +23,19 @@ export const nextTick = (): Promise<void> => {
 };
 
 /** Check if an object is a Promise or a Thenable */
-export function isPromise<T>(obj: any): obj is PromiseLike<T> {
+export function isPromise<T>(obj: unknown): obj is PromiseLike<T> {
 	return (
 		!!obj &&
 		(typeof obj === 'object' || typeof obj === 'function') &&
-		typeof obj.then === 'function'
+		typeof (obj as Record<string, unknown>).then === 'function'
 	);
 }
 
 /** Call a function as a Promise. Resolves with the returned Promsise or immediately. */
-export function runAsPromise(func: Function, args: any[] = []): Promise<any> {
+// eslint-disable-next-line @typescript-eslint/ban-types, @typescript-eslint/no-explicit-any
+export function runAsPromise(func: Function, args: unknown[] = []): Promise<unknown> {
 	return new Promise((resolve, reject) => {
-		const result = func(...args);
+		const result: unknown = func(...args);
 		if (isPromise(result)) {
 			result.then(resolve, reject);
 		} else {